VirtualBox

source: vbox/trunk/include/VBox/log.h@ 39798

Last change on this file since 39798 was 38736, checked in by vboxsync, 13 years ago

*: Please don NOT redefine logger macros.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.6 KB
Line 
1/** @file
2 * VirtualBox - Logging.
3 */
4
5/*
6 * Copyright (C) 2006-2011 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___VBox_log_h
27#define ___VBox_log_h
28
29/*
30 * Set the default loggroup.
31 */
32#ifndef LOG_GROUP
33# define LOG_GROUP LOG_GROUP_DEFAULT
34#endif
35
36#include <iprt/log.h>
37
38
39/** @defgroup grp_rt_vbox_log VirtualBox Logging
40 * @ingroup grp_rt_vbox
41 * @{
42 */
43
44/** PC port for debug output */
45#define RTLOG_DEBUG_PORT 0x504
46
47/**
48 * VirtualBox Logging Groups.
49 * (Remember to update LOGGROUP_NAMES!)
50 *
51 * @remark It should be pretty obvious, but just to have
52 * mentioned it, the values are sorted alphabetically (using the
53 * english alphabet) except for _DEFAULT which is always first.
54 *
55 * If anyone might be wondering what the alphabet looks like:
56 * A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _
57 */
58typedef enum LOGGROUP
59{
60 /** The default VBox group. */
61 LOG_GROUP_DEFAULT = RTLOGGROUP_FIRST_USER,
62 /** Auto-logon group. */
63 LOG_GROUP_AUTOLOGON,
64 /** CFGM group. */
65 LOG_GROUP_CFGM,
66 /** CPUM group. */
67 LOG_GROUP_CPUM,
68 /** CSAM group. */
69 LOG_GROUP_CSAM,
70 /** Debug Console group. */
71 LOG_GROUP_DBGC,
72 /** DBGF group. */
73 LOG_GROUP_DBGF,
74 /** DBGF info group. */
75 LOG_GROUP_DBGF_INFO,
76 /** The debugger gui. */
77 LOG_GROUP_DBGG,
78 /** Generic Device group. */
79 LOG_GROUP_DEV,
80 /** ACPI Device group. */
81 LOG_GROUP_DEV_ACPI,
82 /** AHCI Device group. */
83 LOG_GROUP_DEV_AHCI,
84 /** APIC Device group. */
85 LOG_GROUP_DEV_APIC,
86 /** Audio Device group. */
87 LOG_GROUP_DEV_AUDIO,
88 /** BusLogic SCSI host adapter group. */
89 LOG_GROUP_DEV_BUSLOGIC,
90 /** DMA Controller group. */
91 LOG_GROUP_DEV_DMA,
92 /** Gigabit Ethernet Device group. */
93 LOG_GROUP_DEV_E1000,
94 /** Extensible Firmware Interface Device group. */
95 LOG_GROUP_DEV_EFI,
96 /** Floppy Controller Device group. */
97 LOG_GROUP_DEV_FDC,
98 /** High Precision Event Timer Device group. */
99 LOG_GROUP_DEV_HPET,
100 /** IDE Device group. */
101 LOG_GROUP_DEV_IDE,
102 /** The internal networking IP stack Device group. */
103 LOG_GROUP_DEV_INIP,
104 /** KeyBoard Controller Device group. */
105 LOG_GROUP_DEV_KBD,
106 /** Low Pin Count Device group. */
107 LOG_GROUP_DEV_LPC,
108 /** LsiLogic SCSI controller Device group. */
109 LOG_GROUP_DEV_LSILOGICSCSI,
110 /** NE2000 Device group. */
111 LOG_GROUP_DEV_NE2000,
112 /** Parallel Device group */
113 LOG_GROUP_DEV_PARALLEL,
114 /** PC Device group. */
115 LOG_GROUP_DEV_PC,
116 /** PC Architecture Device group. */
117 LOG_GROUP_DEV_PC_ARCH,
118 /** PC BIOS Device group. */
119 LOG_GROUP_DEV_PC_BIOS,
120 /** PCI Device group. */
121 LOG_GROUP_DEV_PCI,
122 /** PCI Raw Device group. */
123 LOG_GROUP_DEV_PCI_RAW,
124 /** PCNet Device group. */
125 LOG_GROUP_DEV_PCNET,
126 /** PIC Device group. */
127 LOG_GROUP_DEV_PIC,
128 /** PIT Device group. */
129 LOG_GROUP_DEV_PIT,
130 /** RTC Device group. */
131 LOG_GROUP_DEV_RTC,
132 /** Serial Device group */
133 LOG_GROUP_DEV_SERIAL,
134 /** System Management Controller Device group. */
135 LOG_GROUP_DEV_SMC,
136 /** USB Device group. */
137 LOG_GROUP_DEV_USB,
138 /** VGA Device group. */
139 LOG_GROUP_DEV_VGA,
140 /** Virtio PCI Device group. */
141 LOG_GROUP_DEV_VIRTIO,
142 /** Virtio Network Device group. */
143 LOG_GROUP_DEV_VIRTIO_NET,
144 /** VMM Device group. */
145 LOG_GROUP_DEV_VMM,
146 /** VMM Device group for backdoor logging. */
147 LOG_GROUP_DEV_VMM_BACKDOOR,
148 /** VMM Device group for logging guest backdoor logging to stderr. */
149 LOG_GROUP_DEV_VMM_STDERR,
150 /** Disassembler group. */
151 LOG_GROUP_DIS,
152 /** Generic driver group. */
153 LOG_GROUP_DRV,
154 /** ACPI driver group */
155 LOG_GROUP_DRV_ACPI,
156 /** Block driver group. */
157 LOG_GROUP_DRV_BLOCK,
158 /** Char driver group. */
159 LOG_GROUP_DRV_CHAR,
160 /** Disk integrity driver group. */
161 LOG_GROUP_DRV_DISK_INTEGRITY,
162 /** Video Display driver group. */
163 LOG_GROUP_DRV_DISPLAY,
164 /** Floppy media driver group. */
165 LOG_GROUP_DRV_FLOPPY,
166 /** Host Base block driver group. */
167 LOG_GROUP_DRV_HOST_BASE,
168 /** Host DVD block driver group. */
169 LOG_GROUP_DRV_HOST_DVD,
170 /** Host floppy block driver group. */
171 LOG_GROUP_DRV_HOST_FLOPPY,
172 /** Host Parallel Driver group */
173 LOG_GROUP_DRV_HOST_PARALLEL,
174 /** Host Serial Driver Group */
175 LOG_GROUP_DRV_HOST_SERIAL,
176 /** The internal networking transport driver group. */
177 LOG_GROUP_DRV_INTNET,
178 /** ISO (CD/DVD) media driver group. */
179 LOG_GROUP_DRV_ISO,
180 /** Keyboard Queue driver group. */
181 LOG_GROUP_DRV_KBD_QUEUE,
182 /** lwIP IP stack driver group. */
183 LOG_GROUP_DRV_LWIP,
184 /** Video Miniport driver group. */
185 LOG_GROUP_DRV_MINIPORT,
186 /** Mouse driver group. */
187 LOG_GROUP_DRV_MOUSE,
188 /** Mouse Queue driver group. */
189 LOG_GROUP_DRV_MOUSE_QUEUE,
190 /** Named Pipe stream driver group. */
191 LOG_GROUP_DRV_NAMEDPIPE,
192 /** NAT network transport driver group */
193 LOG_GROUP_DRV_NAT,
194 /** Raw image driver group */
195 LOG_GROUP_DRV_RAW_IMAGE,
196 /** SCSI driver group. */
197 LOG_GROUP_DRV_SCSI,
198 /** Host SCSI driver group. */
199 LOG_GROUP_DRV_SCSIHOST,
200 /** Async transport driver group */
201 LOG_GROUP_DRV_TRANSPORT_ASYNC,
202 /** TUN network transport driver group */
203 LOG_GROUP_DRV_TUN,
204 /** UDP tunnet network transport driver group. */
205 LOG_GROUP_DRV_UDPTUNNEL,
206 /** USB Proxy driver group. */
207 LOG_GROUP_DRV_USBPROXY,
208 /** VBoxHDD media driver group. */
209 LOG_GROUP_DRV_VBOXHDD,
210 /** VBox HDD container media driver group. */
211 LOG_GROUP_DRV_VD,
212 /** Virtual Switch transport driver group */
213 LOG_GROUP_DRV_VSWITCH,
214 /** VUSB driver group */
215 LOG_GROUP_DRV_VUSB,
216 /** EM group. */
217 LOG_GROUP_EM,
218 /** FTM group. */
219 LOG_GROUP_FTM,
220 /** GMM group. */
221 LOG_GROUP_GMM,
222 /** GUI group. */
223 LOG_GROUP_GUI,
224 /** GVMM group. */
225 LOG_GROUP_GVMM,
226 /** HGCM group */
227 LOG_GROUP_HGCM,
228 /** HGSMI group */
229 LOG_GROUP_HGSMI,
230 /** HWACCM group. */
231 LOG_GROUP_HWACCM,
232 /** IEM group. */
233 LOG_GROUP_IEM,
234 /** IOM group. */
235 LOG_GROUP_IOM,
236 /** XPCOM IPC group. */
237 LOG_GROUP_IPC,
238 /** Main group. */
239 LOG_GROUP_MAIN,
240 /** Misc. group intended for external use only. */
241 LOG_GROUP_MISC,
242 /** MM group. */
243 LOG_GROUP_MM,
244 /** MM group. */
245 LOG_GROUP_MM_HEAP,
246 /** MM group. */
247 LOG_GROUP_MM_HYPER,
248 /** MM Hypervisor Heap group. */
249 LOG_GROUP_MM_HYPER_HEAP,
250 /** MM Physical/Ram group. */
251 LOG_GROUP_MM_PHYS,
252 /** MM Page pool group. */
253 LOG_GROUP_MM_POOL,
254 /** The NAT service group */
255 LOG_GROUP_NAT_SERVICE,
256 /** The network adaptor driver group. */
257 LOG_GROUP_NET_ADP_DRV,
258 /** The network filter driver group. */
259 LOG_GROUP_NET_FLT_DRV,
260 /** The common network service group */
261 LOG_GROUP_NET_SERVICE,
262 /** PATM group. */
263 LOG_GROUP_PATM,
264 /** PDM group. */
265 LOG_GROUP_PDM,
266 /** PDM Async completion group. */
267 LOG_GROUP_PDM_ASYNC_COMPLETION,
268 /** PDM Block cache group. */
269 LOG_GROUP_PDM_BLK_CACHE,
270 /** PDM Device group. */
271 LOG_GROUP_PDM_DEVICE,
272 /** PDM Driver group. */
273 LOG_GROUP_PDM_DRIVER,
274 /** PDM Loader group. */
275 LOG_GROUP_PDM_LDR,
276 /** PDM Loader group. */
277 LOG_GROUP_PDM_QUEUE,
278 /** PGM group. */
279 LOG_GROUP_PGM,
280 /** PGM dynamic mapping group. */
281 LOG_GROUP_PGM_DYNMAP,
282 /** PGM physical group. */
283 LOG_GROUP_PGM_PHYS,
284 /** PGM physical access group. */
285 LOG_GROUP_PGM_PHYS_ACCESS,
286 /** PGM shadow page pool group. */
287 LOG_GROUP_PGM_POOL,
288 /** PGM shared paging group. */
289 LOG_GROUP_PGM_SHARED,
290 /** REM group. */
291 LOG_GROUP_REM,
292 /** REM disassembly handler group. */
293 LOG_GROUP_REM_DISAS,
294 /** REM access handler group. */
295 LOG_GROUP_REM_HANDLER,
296 /** REM I/O port access group. */
297 LOG_GROUP_REM_IOPORT,
298 /** REM MMIO access group. */
299 LOG_GROUP_REM_MMIO,
300 /** REM Printf. */
301 LOG_GROUP_REM_PRINTF,
302 /** REM running group. */
303 LOG_GROUP_REM_RUN,
304 /** SELM group. */
305 LOG_GROUP_SELM,
306 /** Shared clipboard host service group. */
307 LOG_GROUP_SHARED_CLIPBOARD,
308 /** Chromium OpenGL host service group. */
309 LOG_GROUP_SHARED_CROPENGL,
310 /** Shared folders host service group. */
311 LOG_GROUP_SHARED_FOLDERS,
312 /** OpenGL host service group. */
313 LOG_GROUP_SHARED_OPENGL,
314 /** The internal networking service group. */
315 LOG_GROUP_SRV_INTNET,
316 /** SSM group. */
317 LOG_GROUP_SSM,
318 /** STAM group. */
319 LOG_GROUP_STAM,
320 /** SUP group. */
321 LOG_GROUP_SUP,
322 /** SUPport driver group. */
323 LOG_GROUP_SUP_DRV,
324 /** TM group. */
325 LOG_GROUP_TM,
326 /** TRPM group. */
327 LOG_GROUP_TRPM,
328 /** USB cardreader group. */
329 LOG_GROUP_USB_CARDREADER,
330 /** USB driver group. */
331 LOG_GROUP_USB_DRV,
332 /** USBFilter group. */
333 LOG_GROUP_USB_FILTER,
334 /** USB keyboard device group. */
335 LOG_GROUP_USB_KBD,
336 /** MSD USB device group. */
337 LOG_GROUP_USB_MSD,
338 /** USB webcam. */
339 LOG_GROUP_USB_WEBCAM,
340 /** Generic virtual disk layer. */
341 LOG_GROUP_VD,
342 /** DMG virtual disk backend. */
343 LOG_GROUP_VD_DMG,
344 /** iSCSI virtual disk backend. */
345 LOG_GROUP_VD_ISCSI,
346 /** Parallels HDD virtual disk backend. */
347 LOG_GROUP_VD_PARALLELS,
348 /** QCOW virtual disk backend. */
349 LOG_GROUP_VD_QCOW,
350 /** QED virtual disk backend. */
351 LOG_GROUP_VD_QED,
352 /** Raw virtual disk backend. */
353 LOG_GROUP_VD_RAW,
354 /** VDI virtual disk backend. */
355 LOG_GROUP_VD_VDI,
356 /** VHD virtual disk backend. */
357 LOG_GROUP_VD_VHD,
358 /** VMDK virtual disk backend. */
359 LOG_GROUP_VD_VMDK,
360 /** VM group. */
361 LOG_GROUP_VM,
362 /** VMM group. */
363 LOG_GROUP_VMM,
364 /** VRDP group */
365 LOG_GROUP_VRDP,
366 /** VSCSI group */
367 LOG_GROUP_VSCSI,
368 /** Webservice group. */
369 LOG_GROUP_WEBSERVICE
370 /* !!!ALPHABETICALLY!!! */
371} VBOX_LOGGROUP;
372
373
374/** @def VBOX_LOGGROUP_NAMES
375 * VirtualBox Logging group names.
376 *
377 * Must correspond 100% to LOGGROUP!
378 * Don't forget commas!
379 *
380 * @remark It should be pretty obvious, but just to have
381 * mentioned it, the values are sorted alphabetically (using the
382 * english alphabet) except for _DEFAULT which is always first.
383 *
384 * If anyone might be wondering what the alphabet looks like:
385 * a b c d e f g h i j k l m n o p q r s t u v w x y z
386 */
387#define VBOX_LOGGROUP_NAMES \
388{ \
389 RT_LOGGROUP_NAMES, \
390 "DEFAULT", \
391 "AUTOLOGON", \
392 "CFGM", \
393 "CPUM", \
394 "CSAM", \
395 "DBGC", \
396 "DBGF", \
397 "DBGF_INFO", \
398 "DBGG", \
399 "DEV", \
400 "DEV_ACPI", \
401 "DEV_AHCI", \
402 "DEV_APIC", \
403 "DEV_AUDIO", \
404 "DEV_BUSLOGIC", \
405 "DEV_DMA", \
406 "DEV_E1000", \
407 "DEV_EFI", \
408 "DEV_FDC", \
409 "DEV_HPET", \
410 "DEV_IDE", \
411 "DEV_INIP", \
412 "DEV_KBD", \
413 "DEV_LPC", \
414 "DEV_LSILOGICSCSI", \
415 "DEV_NE2000", \
416 "DEV_PARALLEL", \
417 "DEV_PC", \
418 "DEV_PC_ARCH", \
419 "DEV_PC_BIOS", \
420 "DEV_PCI", \
421 "DEV_PCI_RAW", \
422 "DEV_PCNET", \
423 "DEV_PIC", \
424 "DEV_PIT", \
425 "DEV_RTC", \
426 "DEV_SERIAL", \
427 "DEV_SMC", \
428 "DEV_USB", \
429 "DEV_VGA", \
430 "DEV_VIRTIO", \
431 "DEV_VIRTIO_NET", \
432 "DEV_VMM", \
433 "DEV_VMM_BACKDOOR", \
434 "DEV_VMM_STDERR",\
435 "DIS", \
436 "DRV", \
437 "DRV_ACPI", \
438 "DRV_BLOCK", \
439 "DRV_CHAR", \
440 "DRV_DISK_INTEGRITY", \
441 "DRV_DISPLAY", \
442 "DRV_FLOPPY", \
443 "DRV_HOST_BASE", \
444 "DRV_HOST_DVD", \
445 "DRV_HOST_FLOPPY", \
446 "DRV_HOST_PARALLEL", \
447 "DRV_HOST_SERIAL", \
448 "DRV_INTNET", \
449 "DRV_ISO", \
450 "DRV_KBD_QUEUE", \
451 "DRV_LWIP", \
452 "DRV_MINIPORT", \
453 "DRV_MOUSE", \
454 "DRV_MOUSE_QUEUE", \
455 "DRV_NAMEDPIPE", \
456 "DRV_NAT", \
457 "DRV_RAW_IMAGE", \
458 "DRV_SCSI", \
459 "DRV_SCSIHOST", \
460 "DRV_TRANSPORT_ASYNC", \
461 "DRV_TUN", \
462 "DRV_UDPTUNNEL", \
463 "DRV_USBPROXY", \
464 "DRV_VBOXHDD", \
465 "DRV_VD", \
466 "DRV_VSWITCH", \
467 "DRV_VUSB", \
468 "EM", \
469 "FTM", \
470 "GMM", \
471 "GUI", \
472 "GVMM", \
473 "HGCM", \
474 "HGSMI", \
475 "HWACCM", \
476 "IEM", \
477 "IOM", \
478 "IPC", \
479 "MAIN", \
480 "MISC", \
481 "MM", \
482 "MM_HEAP", \
483 "MM_HYPER", \
484 "MM_HYPER_HEAP",\
485 "MM_PHYS", \
486 "MM_POOL", \
487 "NAT_SERVICE", \
488 "NET_ADP_DRV", \
489 "NET_FLT_DRV", \
490 "NET_SERVICE", \
491 "PATM", \
492 "PDM", \
493 "PDM_ASYNC_COMPLETION", \
494 "PDM_BLK_CACHE", \
495 "PDM_DEVICE", \
496 "PDM_DRIVER", \
497 "PDM_LDR", \
498 "PDM_QUEUE", \
499 "PGM", \
500 "PGM_DYNMAP", \
501 "PGM_PHYS", \
502 "PGM_PHYS_ACCESS",\
503 "PGM_POOL", \
504 "PGM_SHARED", \
505 "REM", \
506 "REM_DISAS", \
507 "REM_HANDLER", \
508 "REM_IOPORT", \
509 "REM_MMIO", \
510 "REM_PRINTF", \
511 "REM_RUN", \
512 "SELM", \
513 "SHARED_CLIPBOARD",\
514 "SHARED_CROPENGL",\
515 "SHARED_FOLDERS",\
516 "SHARED_OPENGL",\
517 "SRV_INTNET", \
518 "SSM", \
519 "STAM", \
520 "SUP", \
521 "SUP_DRV", \
522 "TM", \
523 "TRPM", \
524 "USB_CARDREADER",\
525 "USB_DRV", \
526 "USB_FILTER", \
527 "USB_KBD", \
528 "USB_MSD", \
529 "USB_WEBCAM", \
530 "VD", \
531 "VD_DMG", \
532 "VD_ISCSI", \
533 "VD_PARALLELS", \
534 "VD_QCOW", \
535 "VD_QED", \
536 "VD_RAW", \
537 "VD_VDI", \
538 "VD_VHD", \
539 "VD_VMDK", \
540 "VM", \
541 "VMM", \
542 "VRDP", \
543 "VSCSI", \
544 "WEBSERVICE", \
545}
546
547/** @} */
548#endif
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette