VirtualBox

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

Last change on this file since 29491 was 29467, checked in by vboxsync, 15 years ago

New logging group

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.5 KB
Line 
1/** @file
2 * VirtualBox - Logging.
3 */
4
5/*
6 * Copyright (C) 2006-2007 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 /** CFGM group. */
63 LOG_GROUP_CFGM,
64 /** CPUM group. */
65 LOG_GROUP_CPUM,
66 /** CSAM group. */
67 LOG_GROUP_CSAM,
68 /** Debug Console group. */
69 LOG_GROUP_DBGC,
70 /** DBGF group. */
71 LOG_GROUP_DBGF,
72 /** DBGF info group. */
73 LOG_GROUP_DBGF_INFO,
74 /** The debugger gui. */
75 LOG_GROUP_DBGG,
76 /** Generic Device group. */
77 LOG_GROUP_DEV,
78 /** ACPI Device group. */
79 LOG_GROUP_DEV_ACPI,
80 /** AHCI Device group. */
81 LOG_GROUP_DEV_AHCI,
82 /** APIC Device group. */
83 LOG_GROUP_DEV_APIC,
84 /** Audio Device group. */
85 LOG_GROUP_DEV_AUDIO,
86 /** BusLogic SCSI host adapter group. */
87 LOG_GROUP_DEV_BUSLOGIC,
88 /** DMA Controller group. */
89 LOG_GROUP_DEV_DMA,
90 /** Gigabit Ethernet Device group. */
91 LOG_GROUP_DEV_E1000,
92 /** Extensible Firmware Interface Device group. */
93 LOG_GROUP_DEV_EFI,
94 /** Floppy Controller Device group. */
95 LOG_GROUP_DEV_FDC,
96 /** High Precision Event Timer Device group. */
97 LOG_GROUP_DEV_HPET,
98 /** IDE Device group. */
99 LOG_GROUP_DEV_IDE,
100 /** The internal networking IP stack Device group. */
101 LOG_GROUP_DEV_INIP,
102 /** KeyBoard Controller Device group. */
103 LOG_GROUP_DEV_KBD,
104 /** Low Pin Count Device group. */
105 LOG_GROUP_DEV_LPC,
106 /** LsiLogic SCSI controller Device group. */
107 LOG_GROUP_DEV_LSILOGICSCSI,
108 /** NE2000 Device group. */
109 LOG_GROUP_DEV_NE2000,
110 /** Parallel Device group */
111 LOG_GROUP_DEV_PARALLEL,
112 /** PC Device group. */
113 LOG_GROUP_DEV_PC,
114 /** PC Architecture Device group. */
115 LOG_GROUP_DEV_PC_ARCH,
116 /** PC BIOS Device group. */
117 LOG_GROUP_DEV_PC_BIOS,
118 /** PCI Device group. */
119 LOG_GROUP_DEV_PCI,
120 /** PCNet Device group. */
121 LOG_GROUP_DEV_PCNET,
122 /** PIC Device group. */
123 LOG_GROUP_DEV_PIC,
124 /** PIT Device group. */
125 LOG_GROUP_DEV_PIT,
126 /** RTC Device group. */
127 LOG_GROUP_DEV_RTC,
128 /** Serial Device group */
129 LOG_GROUP_DEV_SERIAL,
130 /** System Management Controller Device group. */
131 LOG_GROUP_DEV_SMC,
132 /** USB Device group. */
133 LOG_GROUP_DEV_USB,
134 /** VGA Device group. */
135 LOG_GROUP_DEV_VGA,
136 /** Virtio PCI Device group. */
137 LOG_GROUP_DEV_VIRTIO,
138 /** Virtio Network Device group. */
139 LOG_GROUP_DEV_VIRTIO_NET,
140 /** VMM Device group. */
141 LOG_GROUP_DEV_VMM,
142 /** VMM Device group for backdoor logging. */
143 LOG_GROUP_DEV_VMM_BACKDOOR,
144 /** VMM Device group for logging guest backdoor logging to stderr. */
145 LOG_GROUP_DEV_VMM_STDERR,
146 /** Disassembler group. */
147 LOG_GROUP_DIS,
148 /** Generic driver group. */
149 LOG_GROUP_DRV,
150 /** ACPI driver group */
151 LOG_GROUP_DRV_ACPI,
152 /** Block driver group. */
153 LOG_GROUP_DRV_BLOCK,
154 /** Char driver group. */
155 LOG_GROUP_DRV_CHAR,
156 /** Disk integrity driver group. */
157 LOG_GROUP_DRV_DISK_INTEGRITY,
158 /** Floppy media driver group. */
159 LOG_GROUP_DRV_FLOPPY,
160 /** Host Base block driver group. */
161 LOG_GROUP_DRV_HOST_BASE,
162 /** Host DVD block driver group. */
163 LOG_GROUP_DRV_HOST_DVD,
164 /** Host floppy block driver group. */
165 LOG_GROUP_DRV_HOST_FLOPPY,
166 /** Host Parallel Driver group */
167 LOG_GROUP_DRV_HOST_PARALLEL,
168 /** Host Serial Driver Group */
169 LOG_GROUP_DRV_HOST_SERIAL,
170 /** The internal networking transport driver group. */
171 LOG_GROUP_DRV_INTNET,
172 /** iSCSI Initiator driver group. */
173 LOG_GROUP_DRV_ISCSI,
174 /** iSCSI TCP transport driver group. */
175 LOG_GROUP_DRV_ISCSI_TRANSPORT_TCP,
176 /** ISO (CD/DVD) media driver group. */
177 LOG_GROUP_DRV_ISO,
178 /** Keyboard Queue driver group. */
179 LOG_GROUP_DRV_KBD_QUEUE,
180 /** lwIP IP stack driver group. */
181 LOG_GROUP_DRV_LWIP,
182 /** Mouse Queue driver group. */
183 LOG_GROUP_DRV_MOUSE_QUEUE,
184 /** Named Pipe stream driver group. */
185 LOG_GROUP_DRV_NAMEDPIPE,
186 /** NAT network transport driver group */
187 LOG_GROUP_DRV_NAT,
188 /** Raw image driver group */
189 LOG_GROUP_DRV_RAW_IMAGE,
190 /** SCSI driver group. */
191 LOG_GROUP_DRV_SCSI,
192 /** Host SCSI driver group. */
193 LOG_GROUP_DRV_SCSIHOST,
194 /** Async transport driver group */
195 LOG_GROUP_DRV_TRANSPORT_ASYNC,
196 /** TUN network transport driver group */
197 LOG_GROUP_DRV_TUN,
198 /** USB Proxy driver group. */
199 LOG_GROUP_DRV_USBPROXY,
200 /** VBoxHDD media driver group. */
201 LOG_GROUP_DRV_VBOXHDD,
202 /** VBox HDD container media driver group. */
203 LOG_GROUP_DRV_VD,
204 /** Virtual Switch transport driver group */
205 LOG_GROUP_DRV_VSWITCH,
206 /** VUSB driver group */
207 LOG_GROUP_DRV_VUSB,
208 /** EM group. */
209 LOG_GROUP_EM,
210 /** GMM group. */
211 LOG_GROUP_GMM,
212 /** GUI group. */
213 LOG_GROUP_GUI,
214 /** GVMM group. */
215 LOG_GROUP_GVMM,
216 /** HGCM group */
217 LOG_GROUP_HGCM,
218 /** HWACCM group. */
219 LOG_GROUP_HWACCM,
220 /** IOM group. */
221 LOG_GROUP_IOM,
222 /** XPCOM IPC group. */
223 LOG_GROUP_IPC,
224 /** Main group. */
225 LOG_GROUP_MAIN,
226 /** Misc. group intended for external use only. */
227 LOG_GROUP_MISC,
228 /** MM group. */
229 LOG_GROUP_MM,
230 /** MM group. */
231 LOG_GROUP_MM_HEAP,
232 /** MM group. */
233 LOG_GROUP_MM_HYPER,
234 /** MM Hypervisor Heap group. */
235 LOG_GROUP_MM_HYPER_HEAP,
236 /** MM Physical/Ram group. */
237 LOG_GROUP_MM_PHYS,
238 /** MM Page pool group. */
239 LOG_GROUP_MM_POOL,
240 /** The NAT service group */
241 LOG_GROUP_NAT_SERVICE,
242 /** The network adaptor driver group. */
243 LOG_GROUP_NET_ADP_DRV,
244 /** The network filter driver group. */
245 LOG_GROUP_NET_FLT_DRV,
246 /** The common network service group */
247 LOG_GROUP_NET_SERVICE,
248 /** PATM group. */
249 LOG_GROUP_PATM,
250 /** PDM group. */
251 LOG_GROUP_PDM,
252 /** PDM Async completion group. */
253 LOG_GROUP_PDM_ASYNC_COMPLETION,
254 /** PDM Device group. */
255 LOG_GROUP_PDM_DEVICE,
256 /** PDM Driver group. */
257 LOG_GROUP_PDM_DRIVER,
258 /** PDM Loader group. */
259 LOG_GROUP_PDM_LDR,
260 /** PDM Loader group. */
261 LOG_GROUP_PDM_QUEUE,
262 /** PGM group. */
263 LOG_GROUP_PGM,
264 /** PGM physical group. */
265 LOG_GROUP_PGM_PHYS,
266 /** PGM physical access group. */
267 LOG_GROUP_PGM_PHYS_ACCESS,
268 /** PGM shadow page pool group. */
269 LOG_GROUP_PGM_POOL,
270 /** PGM shared paging group. */
271 LOG_GROUP_PGM_SHARED,
272 /** REM group. */
273 LOG_GROUP_REM,
274 /** REM disassembly handler group. */
275 LOG_GROUP_REM_DISAS,
276 /** REM access handler group. */
277 LOG_GROUP_REM_HANDLER,
278 /** REM I/O port access group. */
279 LOG_GROUP_REM_IOPORT,
280 /** REM MMIO access group. */
281 LOG_GROUP_REM_MMIO,
282 /** REM Printf. */
283 LOG_GROUP_REM_PRINTF,
284 /** REM running group. */
285 LOG_GROUP_REM_RUN,
286 /** SELM group. */
287 LOG_GROUP_SELM,
288 /** Shared clipboard host service group. */
289 LOG_GROUP_SHARED_CLIPBOARD,
290 /** Chromium OpenGL host service group. */
291 LOG_GROUP_SHARED_CROPENGL,
292 /** Shared folders host service group. */
293 LOG_GROUP_SHARED_FOLDERS,
294 /** OpenGL host service group. */
295 LOG_GROUP_SHARED_OPENGL,
296 /** The internal networking service group. */
297 LOG_GROUP_SRV_INTNET,
298 /** SSM group. */
299 LOG_GROUP_SSM,
300 /** STAM group. */
301 LOG_GROUP_STAM,
302 /** SUP group. */
303 LOG_GROUP_SUP,
304 /** SUPport driver group. */
305 LOG_GROUP_SUP_DRV,
306 /** TM group. */
307 LOG_GROUP_TM,
308 /** TRPM group. */
309 LOG_GROUP_TRPM,
310 /** USB driver group. */
311 LOG_GROUP_USB_DRV,
312 /** USBFilter group. */
313 LOG_GROUP_USB_FILTER,
314 /** USB keyboard device group. */
315 LOG_GROUP_USB_KBD,
316 /** MSD USB device group. */
317 LOG_GROUP_USB_MSD,
318 /** Generic virtual disk layer. */
319 LOG_GROUP_VD,
320 /** iSCSI virtual disk backend. */
321 LOG_GROUP_VD_ISCSI,
322 /** Raw virtual disk backend. */
323 LOG_GROUP_VD_RAW,
324 /** VDI virtual disk backend. */
325 LOG_GROUP_VD_VDI,
326 /** VHD virtual disk backend. */
327 LOG_GROUP_VD_VHD,
328 /** VMDK virtual disk backend. */
329 LOG_GROUP_VD_VMDK,
330 /** VM group. */
331 LOG_GROUP_VM,
332 /** VMM group. */
333 LOG_GROUP_VMM,
334 /** VRDP group */
335 LOG_GROUP_VRDP,
336 /** VSCSI group */
337 LOG_GROUP_VSCSI,
338 /** Webservice group. */
339 LOG_GROUP_WEBSERVICE
340 /* !!!ALPHABETICALLY!!! */
341} VBOX_LOGGROUP;
342
343
344/** @def VBOX_LOGGROUP_NAMES
345 * VirtualBox Logging group names.
346 *
347 * Must correspond 100% to LOGGROUP!
348 * Don't forget commas!
349 *
350 * @remark It should be pretty obvious, but just to have
351 * mentioned it, the values are sorted alphabetically (using the
352 * english alphabet) except for _DEFAULT which is always first.
353 *
354 * If anyone might be wondering what the alphabet looks like:
355 * 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
356 */
357#define VBOX_LOGGROUP_NAMES \
358{ \
359 RT_LOGGROUP_NAMES, \
360 "DEFAULT", \
361 "CFGM", \
362 "CPUM", \
363 "CSAM", \
364 "DBGC", \
365 "DBGF", \
366 "DBGF_INFO", \
367 "DBGG", \
368 "DEV", \
369 "DEV_ACPI", \
370 "DEV_AHCI", \
371 "DEV_APIC", \
372 "DEV_AUDIO", \
373 "DEV_BUSLOGIC", \
374 "DEV_DMA", \
375 "DEV_E1000", \
376 "DEV_EFI", \
377 "DEV_FDC", \
378 "DEV_HPET", \
379 "DEV_IDE", \
380 "DEV_INIP", \
381 "DEV_KBD", \
382 "DEV_LPC", \
383 "DEV_LSILOGICSCSI", \
384 "DEV_NE2000", \
385 "DEV_PARALLEL", \
386 "DEV_PC", \
387 "DEV_PC_ARCH", \
388 "DEV_PC_BIOS", \
389 "DEV_PCI", \
390 "DEV_PCNET", \
391 "DEV_PIC", \
392 "DEV_PIT", \
393 "DEV_RTC", \
394 "DEV_SERIAL", \
395 "DEV_SMC", \
396 "DEV_USB", \
397 "DEV_VGA", \
398 "DEV_VIRTIO", \
399 "DEV_VIRTIO_NET", \
400 "DEV_VMM", \
401 "DEV_VMM_BACKDOOR", \
402 "DEV_VMM_STDERR",\
403 "DIS", \
404 "DRV", \
405 "DRV_ACPI", \
406 "DRV_BLOCK", \
407 "DRV_CHAR", \
408 "DRV_DISK_INTEGRITY", \
409 "DRV_FLOPPY", \
410 "DRV_HOST_BASE", \
411 "DRV_HOST_DVD", \
412 "DRV_HOST_FLOPPY", \
413 "DRV_HOST_PARALLEL", \
414 "DRV_HOST_SERIAL", \
415 "DRV_INTNET", \
416 "DRV_ISCSI", \
417 "DRV_ISCSI_TRANSPORT_TCP", \
418 "DRV_ISO", \
419 "DRV_KBD_QUEUE", \
420 "DRV_LWIP", \
421 "DRV_MOUSE_QUEUE", \
422 "DRV_NAMEDPIPE", \
423 "DRV_NAT", \
424 "DRV_RAW_IMAGE", \
425 "DRV_SCSI", \
426 "DRV_SCSIHOST", \
427 "DRV_TRANSPORT_ASYNC", \
428 "DRV_TUN", \
429 "DRV_USBPROXY", \
430 "DRV_VBOXHDD", \
431 "DRV_VD", \
432 "DRV_VSWITCH", \
433 "DRV_VUSB", \
434 "EM", \
435 "GMM", \
436 "GUI", \
437 "GVMM", \
438 "HGCM", \
439 "HWACCM", \
440 "IOM", \
441 "IPC", \
442 "MAIN", \
443 "MISC", \
444 "MM", \
445 "MM_HEAP", \
446 "MM_HYPER", \
447 "MM_HYPER_HEAP",\
448 "MM_PHYS", \
449 "MM_POOL", \
450 "NAT_SERVICE", \
451 "NET_ADP_DRV", \
452 "NET_FLT_DRV", \
453 "NET_SERVICE", \
454 "PATM", \
455 "PDM", \
456 "PDM_ASYNC_COMPLETION", \
457 "PDM_DEVICE", \
458 "PDM_DRIVER", \
459 "PDM_LDR", \
460 "PDM_QUEUE", \
461 "PGM", \
462 "PGM_PHYS", \
463 "PGM_PHYS_ACCESS",\
464 "PGM_POOL", \
465 "PGM_SHARED", \
466 "REM", \
467 "REM_DISAS", \
468 "REM_HANDLER", \
469 "REM_IOPORT", \
470 "REM_MMIO", \
471 "REM_PRINTF", \
472 "REM_RUN", \
473 "SELM", \
474 "SHARED_CLIPBOARD",\
475 "SHARED_CROPENGL",\
476 "SHARED_FOLDERS",\
477 "SHARED_OPENGL",\
478 "SRV_INTNET", \
479 "SSM", \
480 "STAM", \
481 "SUP", \
482 "SUP_DRV", \
483 "TM", \
484 "TRPM", \
485 "USB_DRV", \
486 "USB_FILTER", \
487 "USB_KBD", \
488 "USB_MSD", \
489 "VD", \
490 "VD_ISCSI", \
491 "VD_RAW", \
492 "VD_VDI", \
493 "VD_VHD", \
494 "VD_VMDK", \
495 "VM", \
496 "VMM", \
497 "VRDP", \
498 "VSCSI", \
499 "WEBSERVICE", \
500}
501
502/** @} */
503#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