VirtualBox

source: vbox/trunk/include/VBox/cdefs.h@ 46093

Last change on this file since 46093 was 44528, checked in by vboxsync, 12 years ago

header (C) fixes

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.9 KB
Line 
1/** @file
2 * VirtualBox - Common C and C++ definition.
3 */
4
5/*
6 * Copyright (C) 2006-2013 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_cdefs_h
27#define ___VBox_cdefs_h
28
29#include <iprt/cdefs.h>
30
31
32/** @def VBOX_WITH_STATISTICS
33 * When defined all statistics will be included in the build.
34 * This is enabled by default in all debug builds.
35 */
36#ifndef VBOX_WITH_STATISTICS
37# ifdef DEBUG
38# define VBOX_WITH_STATISTICS
39# endif
40#endif
41
42/** @def VBOX_STRICT
43 * Alias for RT_STRICT.
44 */
45#ifdef RT_STRICT
46# ifndef VBOX_STRICT
47# define VBOX_STRICT
48# endif
49#endif
50
51
52/*
53 * Shut up DOXYGEN warnings and guide it properly thru the code.
54 */
55#ifdef DOXYGEN_RUNNING
56#define VBOX_WITH_STATISTICS
57#define VBOX_STRICT
58#define IN_DBG
59#define IN_DIS
60#define IN_INTNET_R0
61#define IN_INTNET_R3
62#define IN_PCIRAW_R0
63#define IN_PCIRAW_R3
64#define IN_REM_R3
65#define IN_SUP_R0
66#define IN_SUP_R3
67#define IN_SUP_RC
68#define IN_SUP_STATIC
69#define IN_USBLIB
70#define IN_VBOXDDU
71#define IN_VMM_RC
72#define IN_VMM_R0
73#define IN_VMM_R3
74#define IN_VMM_STATIC
75#endif
76
77
78
79
80/** @def VBOXCALL
81 * The standard calling convention for VBOX interfaces.
82 */
83#define VBOXCALL RTCALL
84
85
86
87/** @def IN_DIS
88 * Used to indicate whether we're inside the same link module as the
89 * disassembler.
90 */
91/** @def DISDECL(type)
92 * Disassembly export or import declaration.
93 * @param type The return type of the function declaration.
94 */
95#if defined(IN_DIS)
96# define DISDECL(type) DECLEXPORT(type) VBOXCALL
97#else
98# define DISDECL(type) DECLIMPORT(type) VBOXCALL
99#endif
100
101
102
103/** @def IN_DBG
104 * Used to indicate whether we're inside the same link module as the debugger
105 * console, gui, and related things (ring-3).
106 */
107/** @def DBGDECL(type)
108 * Debugger module export or import declaration.
109 * Functions declared using this exists only in R3 since the
110 * debugger modules is R3 only.
111 * @param type The return type of the function declaration.
112 */
113#if defined(IN_DBG_R3) || defined(IN_DBG)
114# define DBGDECL(type) DECLEXPORT(type) VBOXCALL
115#else
116# define DBGDECL(type) DECLIMPORT(type) VBOXCALL
117#endif
118
119
120
121/** @def IN_INTNET_R3
122 * Used to indicate whether we're inside the same link module as the Ring-3
123 * Internal Networking Service.
124 */
125/** @def INTNETR3DECL(type)
126 * Internal Networking Service export or import declaration.
127 * @param type The return type of the function declaration.
128 */
129#ifdef IN_INTNET_R3
130# define INTNETR3DECL(type) DECLEXPORT(type) VBOXCALL
131#else
132# define INTNETR3DECL(type) DECLIMPORT(type) VBOXCALL
133#endif
134
135/** @def IN_INTNET_R0
136 * Used to indicate whether we're inside the same link module as the R0
137 * Internal Network Service.
138 */
139/** @def INTNETR0DECL(type)
140 * Internal Networking Service export or import declaration.
141 * @param type The return type of the function declaration.
142 */
143#ifdef IN_INTNET_R0
144# define INTNETR0DECL(type) DECLEXPORT(type) VBOXCALL
145#else
146# define INTNETR0DECL(type) DECLIMPORT(type) VBOXCALL
147#endif
148
149
150
151/** @def IN_PCIRAW_R3
152 * Used to indicate whether we're inside the same link module as the Ring-3
153 * PCI passthrough support.
154 */
155/** @def PCIRAWR3DECL(type)
156 * PCI passthrough export or import declaration.
157 * @param type The return type of the function declaration.
158 */
159#ifdef IN_PCIRAW_R3
160# define PCIRAWR3DECL(type) DECLEXPORT(type) VBOXCALL
161#else
162# define PCIRAWR3DECL(type) DECLIMPORT(type) VBOXCALL
163#endif
164
165/** @def IN_PCIRAW_R0
166 * Used to indicate whether we're inside the same link module as the R0
167 * PCI passthrough support.
168 */
169/** @def PCIRAWR0DECL(type)
170 * PCI passthroug export or import declaration.
171 * @param type The return type of the function declaration.
172 */
173#ifdef IN_PCIRAW_R0
174# define PCIRAWR0DECL(type) DECLEXPORT(type) VBOXCALL
175#else
176# define PCIRAWR0DECL(type) DECLIMPORT(type) VBOXCALL
177#endif
178
179
180
181/** @def IN_REM_R3
182 * Used to indicate whether we're inside the same link module as
183 * the HC Ring-3 Recompiled Execution Manager.
184 */
185/** @def REMR3DECL(type)
186 * Recompiled Execution Manager HC Ring-3 export or import declaration.
187 * @param type The return type of the function declaration.
188 */
189#ifdef IN_REM_R3
190# define REMR3DECL(type) DECLEXPORT(type) VBOXCALL
191#else
192# define REMR3DECL(type) DECLIMPORT(type) VBOXCALL
193#endif
194
195
196
197/** @def IN_SUP_R3
198 * Used to indicate whether we're inside the same link module as the Ring-3
199 * Support Library or not.
200 */
201/** @def SUPR3DECL(type)
202 * Support library export or import declaration.
203 * @param type The return type of the function declaration.
204 */
205#ifdef IN_SUP_R3
206# define SUPR3DECL(type) DECLEXPORT(type) VBOXCALL
207#else
208# define SUPR3DECL(type) DECLIMPORT(type) VBOXCALL
209#endif
210
211/** @def IN_SUP_R0
212 * Used to indicate whether we're inside the same link module as the Ring-0
213 * Support Library or not.
214 */
215/** @def IN_SUP_STATIC
216 * Used to indicate that the Support Library is built or used as a static
217 * library.
218 */
219/** @def SUPR0DECL(type)
220 * Support library export or import declaration.
221 * @param type The return type of the function declaration.
222 */
223#ifdef IN_SUP_R0
224# ifdef IN_SUP_STATIC
225# define SUPR0DECL(type) DECLHIDDEN(type) VBOXCALL
226# else
227# define SUPR0DECL(type) DECLEXPORT(type) VBOXCALL
228# endif
229#else
230# ifdef IN_SUP_STATIC
231# define SUPR0DECL(type) DECLHIDDEN(type) VBOXCALL
232# else
233# define SUPR0DECL(type) DECLIMPORT(type) VBOXCALL
234# endif
235#endif
236
237/** @def IN_SUP_RC
238 * Used to indicate whether we're inside the same link module as the RC Support
239 * Library or not.
240 */
241/** @def SUPRCDECL(type)
242 * Support library export or import declaration.
243 * @param type The return type of the function declaration.
244 */
245#ifdef IN_SUP_RC
246# define SUPRCDECL(type) DECLEXPORT(type) VBOXCALL
247#else
248# define SUPRCDECL(type) DECLIMPORT(type) VBOXCALL
249#endif
250
251/** @def IN_SUP_R0
252 * Used to indicate whether we're inside the same link module as the Ring-0
253 * Support Library or not.
254 */
255/** @def SUPR0DECL(type)
256 * Support library export or import declaration.
257 * @param type The return type of the function declaration.
258 */
259#if defined(IN_SUP_R0) || defined(IN_SUP_R3) || defined(IN_SUP_RC)
260# define SUPDECL(type) DECLEXPORT(type) VBOXCALL
261#else
262# define SUPDECL(type) DECLIMPORT(type) VBOXCALL
263#endif
264
265
266
267/** @def IN_USBLIB
268 * Used to indicate whether we're inside the same link module as the USBLib.
269 */
270/** @def USBLIB_DECL
271 * USBLIB export or import declaration.
272 * @param type The return type of the function declaration.
273 */
274#ifdef IN_RING0
275# define USBLIB_DECL(type) type VBOXCALL
276#elif defined(IN_USBLIB)
277# define USBLIB_DECL(type) DECLEXPORT(type) VBOXCALL
278#else
279# define USBLIB_DECL(type) DECLIMPORT(type) VBOXCALL
280#endif
281
282
283
284/** @def IN_VMM_STATIC
285 * Used to indicate that the virtual machine monitor is built or used as a
286 * static library.
287 */
288/** @def IN_VMM_R3
289 * Used to indicate whether we're inside the same link module as the ring 3 part of the
290 * virtual machine monitor or not.
291 */
292/** @def VMMR3DECL
293 * Ring-3 VMM export or import declaration.
294 * @param type The return type of the function declaration.
295 */
296#ifdef IN_VMM_R3
297# ifdef IN_VMM_STATIC
298# define VMMR3DECL(type) DECLHIDDEN(type) VBOXCALL
299# else
300# define VMMR3DECL(type) DECLEXPORT(type) VBOXCALL
301# endif
302#elif defined(IN_RING3)
303# ifdef IN_VMM_STATIC
304# define VMMR3DECL(type) DECLHIDDEN(type) VBOXCALL
305# else
306# define VMMR3DECL(type) DECLIMPORT(type) VBOXCALL
307# endif
308#else
309# define VMMR3DECL(type) DECL_INVALID(type)
310#endif
311
312/** @def IN_VMM_R0
313 * Used to indicate whether we're inside the same link module as the ring-0 part
314 * of the virtual machine monitor or not.
315 */
316/** @def VMMR0DECL
317 * Ring-0 VMM export or import declaration.
318 * @param type The return type of the function declaration.
319 */
320#ifdef IN_VMM_R0
321# define VMMR0DECL(type) DECLEXPORT(type) VBOXCALL
322#elif defined(IN_RING0)
323# define VMMR0DECL(type) DECLIMPORT(type) VBOXCALL
324#else
325# define VMMR0DECL(type) DECL_INVALID(type)
326#endif
327
328/** @def IN_VMM_RC
329 * Used to indicate whether we're inside the same link module as the raw-mode
330 * context part of the virtual machine monitor or not.
331 */
332/** @def VMMRCDECL
333 * Raw-mode context VMM export or import declaration.
334 * @param type The return type of the function declaration.
335 */
336#ifdef IN_VMM_RC
337# define VMMRCDECL(type) DECLEXPORT(type) VBOXCALL
338#elif defined(IN_RC)
339# define VMMRCDECL(type) DECLIMPORT(type) VBOXCALL
340#else
341# define VMMRCDECL(type) DECL_INVALID(type)
342#endif
343
344/** @def VMMRZDECL
345 * Ring-0 and Raw-mode context VMM export or import declaration.
346 * @param type The return type of the function declaration.
347 */
348#if defined(IN_VMM_R0) || defined(IN_VMM_RC)
349# define VMMRZDECL(type) DECLEXPORT(type) VBOXCALL
350#elif defined(IN_RING0) || defined(IN_RZ)
351# define VMMRZDECL(type) DECLIMPORT(type) VBOXCALL
352#else
353# define VMMRZDECL(type) DECL_INVALID(type)
354#endif
355
356/** @def VMMDECL
357 * VMM export or import declaration.
358 * @param type The return type of the function declaration.
359 */
360#ifdef IN_VMM_STATIC
361# define VMMDECL(type) DECLHIDDEN(type) VBOXCALL
362#elif defined(IN_VMM_R3) || defined(IN_VMM_R0) || defined(IN_VMM_RC)
363# define VMMDECL(type) DECLEXPORT(type) VBOXCALL
364#else
365# define VMMDECL(type) DECLIMPORT(type) VBOXCALL
366#endif
367
368/** @def VMM_INT_DECL
369 * VMM internal function.
370 * @param type The return type of the function declaration.
371 */
372#if defined(IN_VMM_R3) || defined(IN_VMM_R0) || defined(IN_VMM_RC)
373# define VMM_INT_DECL(type) DECLHIDDEN(type) VBOXCALL
374#else
375# define VMM_INT_DECL(type) DECL_INVALID(type)
376#endif
377
378/** @def VMMR3_INT_DECL
379 * VMM internal function, ring-3.
380 * @param type The return type of the function declaration.
381 */
382#ifdef IN_VMM_R3
383# define VMMR3_INT_DECL(type) DECLHIDDEN(type) VBOXCALL
384#else
385# define VMMR3_INT_DECL(type) DECL_INVALID(type)
386#endif
387
388/** @def VMMR0_INT_DECL
389 * VMM internal function, ring-0.
390 * @param type The return type of the function declaration.
391 */
392#ifdef IN_VMM_R0
393# define VMMR0_INT_DECL(type) DECLHIDDEN(type) VBOXCALL
394#else
395# define VMMR0_INT_DECL(type) DECL_INVALID(type)
396#endif
397
398/** @def VMMRC_INT_DECL
399 * VMM internal function, raw-mode context.
400 * @param type The return type of the function declaration.
401 */
402#ifdef IN_VMM_RC
403# define VMMRC_INT_DECL(type) DECLHIDDEN(type) VBOXCALL
404#else
405# define VMMRC_INT_DECL(type) DECL_INVALID(type)
406#endif
407
408/** @def VMMRZ_INT_DECL
409 * VMM internal function, ring-0 + raw-mode context.
410 * @param type The return type of the function declaration.
411 */
412#if defined(IN_VMM_RC) || defined(IN_VMM_R0)
413# define VMMRZ_INT_DECL(type) DECLHIDDEN(type) VBOXCALL
414#else
415# define VMMRZ_INT_DECL(type) DECL_INVALID(type)
416#endif
417
418
419
420/** @def IN_VBOXDDU
421 * Used to indicate whether we're inside the VBoxDDU shared object.
422 */
423/** @def VBOXDDU_DECL(type)
424 * VBoxDDU export or import (ring-3).
425 * @param type The return type of the function declaration.
426 */
427#ifdef IN_VBOXDDU
428# ifdef IN_VBOXDDU_STATIC
429# define VBOXDDU_DECL(type) type
430# else
431# define VBOXDDU_DECL(type) DECLEXPORT(type) VBOXCALL
432# endif
433#else
434# define VBOXDDU_DECL(type) DECLIMPORT(type) VBOXCALL
435#endif
436
437
438#endif
439
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