macros.hpp revision 5944:0f03ff49c720
1/*
2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25#ifndef SHARE_VM_UTILITIES_MACROS_HPP
26#define SHARE_VM_UTILITIES_MACROS_HPP
27
28// Use this to mark code that needs to be cleaned up (for development only)
29#define NEEDS_CLEANUP
30
31// Makes a string of the argument (which is not macro-expanded)
32#define STR(a)  #a
33
34// Makes a string of the macro expansion of a
35#define XSTR(a) STR(a)
36
37// -DINCLUDE_<something>=0 | 1 can be specified on the command line to include
38// or exclude functionality.
39
40#ifndef INCLUDE_JVMTI
41#define INCLUDE_JVMTI 1
42#endif  // INCLUDE_JVMTI
43
44#if INCLUDE_JVMTI
45#define JVMTI_ONLY(x) x
46#define NOT_JVMTI(x)
47#define NOT_JVMTI_RETURN
48#define NOT_JVMTI_RETURN_(code) /* next token must be ; */
49#else
50#define JVMTI_ONLY(x)
51#define NOT_JVMTI(x) x
52#define NOT_JVMTI_RETURN { return; }
53#define NOT_JVMTI_RETURN_(code) { return code; }
54#endif // INCLUDE_JVMTI
55
56#ifndef INCLUDE_FPROF
57#define INCLUDE_FPROF 1
58#endif
59
60#if INCLUDE_FPROF
61#define NOT_FPROF_RETURN        /* next token must be ; */
62#define NOT_FPROF_RETURN_(code) /* next token must be ; */
63#else
64#define NOT_FPROF_RETURN                {}
65#define NOT_FPROF_RETURN_(code) { return code; }
66#endif // INCLUDE_FPROF
67
68#ifndef INCLUDE_VM_STRUCTS
69#define INCLUDE_VM_STRUCTS 1
70#endif
71
72#if INCLUDE_VM_STRUCTS
73#define NOT_VM_STRUCTS_RETURN        /* next token must be ; */
74#define NOT_VM_STRUCTS_RETURN_(code) /* next token must be ; */
75#else
76#define NOT_VM_STRUCTS_RETURN           {}
77#define NOT_VM_STRUCTS_RETURN_(code) { return code; }
78#endif // INCLUDE_VM_STRUCTS
79
80#ifndef INCLUDE_JNI_CHECK
81#define INCLUDE_JNI_CHECK 1
82#endif
83
84#if INCLUDE_JNI_CHECK
85#define NOT_JNI_CHECK_RETURN        /* next token must be ; */
86#define NOT_JNI_CHECK_RETURN_(code) /* next token must be ; */
87#else
88#define NOT_JNI_CHECK_RETURN            {}
89#define NOT_JNI_CHECK_RETURN_(code) { return code; }
90#endif // INCLUDE_JNI_CHECK
91
92#ifndef INCLUDE_SERVICES
93#define INCLUDE_SERVICES 1
94#endif
95
96#if INCLUDE_SERVICES
97#define NOT_SERVICES_RETURN        /* next token must be ; */
98#define NOT_SERVICES_RETURN_(code) /* next token must be ; */
99#else
100#define NOT_SERVICES_RETURN             {}
101#define NOT_SERVICES_RETURN_(code) { return code; }
102#endif // INCLUDE_SERVICES
103
104#ifndef INCLUDE_CDS
105#define INCLUDE_CDS 1
106#endif
107
108#if INCLUDE_CDS
109#define CDS_ONLY(x) x
110#define NOT_CDS(x)
111#define NOT_CDS_RETURN        /* next token must be ; */
112#define NOT_CDS_RETURN_(code) /* next token must be ; */
113#else
114#define CDS_ONLY(x)
115#define NOT_CDS(x) x
116#define NOT_CDS_RETURN          {}
117#define NOT_CDS_RETURN_(code) { return code; }
118#endif // INCLUDE_CDS
119
120#ifndef INCLUDE_MANAGEMENT
121#define INCLUDE_MANAGEMENT 1
122#endif // INCLUDE_MANAGEMENT
123
124#if INCLUDE_MANAGEMENT
125#define NOT_MANAGEMENT_RETURN        /* next token must be ; */
126#define NOT_MANAGEMENT_RETURN_(code) /* next token must be ; */
127#else
128#define NOT_MANAGEMENT_RETURN        {}
129#define NOT_MANAGEMENT_RETURN_(code) { return code; }
130#endif // INCLUDE_MANAGEMENT
131
132/*
133 * When INCLUDE_ALL_GCS is false the only garbage collectors
134 * included in the JVM are defaultNewGeneration and markCompact.
135 *
136 * When INCLUDE_ALL_GCS is true all garbage collectors are
137 * included in the JVM.
138 */
139#ifndef INCLUDE_ALL_GCS
140#define INCLUDE_ALL_GCS 1
141#endif // INCLUDE_ALL_GCS
142
143#if INCLUDE_ALL_GCS
144#define NOT_ALL_GCS_RETURN        /* next token must be ; */
145#define NOT_ALL_GCS_RETURN_(code) /* next token must be ; */
146#else
147#define NOT_ALL_GCS_RETURN        {}
148#define NOT_ALL_GCS_RETURN_(code) { return code; }
149#endif // INCLUDE_ALL_GCS
150
151#ifndef INCLUDE_NMT
152#define INCLUDE_NMT 1
153#endif // INCLUDE_NMT
154
155#if INCLUDE_NMT
156#define NOT_NMT_RETURN        /* next token must be ; */
157#define NOT_NMT_RETURN_(code) /* next token must be ; */
158#else
159#define NOT_NMT_RETURN        {}
160#define NOT_NMT_RETURN_(code) { return code; }
161#endif // INCLUDE_NMT
162
163// COMPILER1 variant
164#ifdef COMPILER1
165#ifdef COMPILER2
166  #define TIERED
167#endif
168#define COMPILER1_PRESENT(code) code
169#else // COMPILER1
170#define COMPILER1_PRESENT(code)
171#endif // COMPILER1
172
173// COMPILER2 variant
174#ifdef COMPILER2
175#define COMPILER2_PRESENT(code) code
176#define NOT_COMPILER2(code)
177#else // COMPILER2
178#define COMPILER2_PRESENT(code)
179#define NOT_COMPILER2(code) code
180#endif // COMPILER2
181
182#ifdef TIERED
183#define TIERED_ONLY(code) code
184#define NOT_TIERED(code)
185#else
186#define TIERED_ONLY(code)
187#define NOT_TIERED(code) code
188#endif // TIERED
189
190
191// PRODUCT variant
192#ifdef PRODUCT
193#define PRODUCT_ONLY(code) code
194#define NOT_PRODUCT(code)
195#define NOT_PRODUCT_ARG(arg)
196#define PRODUCT_RETURN  {}
197#define PRODUCT_RETURN0 { return 0; }
198#define PRODUCT_RETURN_(code) { code }
199#else // PRODUCT
200#define PRODUCT_ONLY(code)
201#define NOT_PRODUCT(code) code
202#define NOT_PRODUCT_ARG(arg) arg,
203#define PRODUCT_RETURN  /*next token must be ;*/
204#define PRODUCT_RETURN0 /*next token must be ;*/
205#define PRODUCT_RETURN_(code)  /*next token must be ;*/
206#endif // PRODUCT
207
208#ifdef CHECK_UNHANDLED_OOPS
209#define CHECK_UNHANDLED_OOPS_ONLY(code) code
210#define NOT_CHECK_UNHANDLED_OOPS(code)
211#else
212#define CHECK_UNHANDLED_OOPS_ONLY(code)
213#define NOT_CHECK_UNHANDLED_OOPS(code)  code
214#endif // CHECK_UNHANDLED_OOPS
215
216#ifdef CC_INTERP
217#define CC_INTERP_ONLY(code) code
218#define NOT_CC_INTERP(code)
219#else
220#define CC_INTERP_ONLY(code)
221#define NOT_CC_INTERP(code) code
222#endif // CC_INTERP
223
224#ifdef ASSERT
225#define DEBUG_ONLY(code) code
226#define NOT_DEBUG(code)
227#define NOT_DEBUG_RETURN  /*next token must be ;*/
228// Historical.
229#define debug_only(code) code
230#else // ASSERT
231#define DEBUG_ONLY(code)
232#define NOT_DEBUG(code) code
233#define NOT_DEBUG_RETURN {}
234#define debug_only(code)
235#endif // ASSERT
236
237#ifdef  _LP64
238#define LP64_ONLY(code) code
239#define NOT_LP64(code)
240#else  // !_LP64
241#define LP64_ONLY(code)
242#define NOT_LP64(code) code
243#endif // _LP64
244
245#ifdef LINUX
246#define LINUX_ONLY(code) code
247#define NOT_LINUX(code)
248#else
249#define LINUX_ONLY(code)
250#define NOT_LINUX(code) code
251#endif
252
253#ifdef SOLARIS
254#define SOLARIS_ONLY(code) code
255#define NOT_SOLARIS(code)
256#else
257#define SOLARIS_ONLY(code)
258#define NOT_SOLARIS(code) code
259#endif
260
261#ifdef _WINDOWS
262#define WINDOWS_ONLY(code) code
263#define NOT_WINDOWS(code)
264#else
265#define WINDOWS_ONLY(code)
266#define NOT_WINDOWS(code) code
267#endif
268
269#if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__APPLE__)
270#define BSD_ONLY(code) code
271#define NOT_BSD(code)
272#else
273#define BSD_ONLY(code)
274#define NOT_BSD(code) code
275#endif
276
277#ifdef _WIN64
278#define WIN64_ONLY(code) code
279#define NOT_WIN64(code)
280#else
281#define WIN64_ONLY(code)
282#define NOT_WIN64(code) code
283#endif
284
285#if defined(ZERO)
286#define ZERO_ONLY(code) code
287#define NOT_ZERO(code)
288#else
289#define ZERO_ONLY(code)
290#define NOT_ZERO(code) code
291#endif
292
293#if defined(SHARK)
294#define SHARK_ONLY(code) code
295#define NOT_SHARK(code)
296#else
297#define SHARK_ONLY(code)
298#define NOT_SHARK(code) code
299#endif
300
301#if defined(IA32) || defined(AMD64)
302#define X86
303#define X86_ONLY(code) code
304#define NOT_X86(code)
305#else
306#undef X86
307#define X86_ONLY(code)
308#define NOT_X86(code) code
309#endif
310
311#ifdef IA32
312#define IA32_ONLY(code) code
313#define NOT_IA32(code)
314#else
315#define IA32_ONLY(code)
316#define NOT_IA32(code) code
317#endif
318
319#ifdef IA64
320#define IA64_ONLY(code) code
321#define NOT_IA64(code)
322#else
323#define IA64_ONLY(code)
324#define NOT_IA64(code) code
325#endif
326
327#ifdef AMD64
328#define AMD64_ONLY(code) code
329#define NOT_AMD64(code)
330#else
331#define AMD64_ONLY(code)
332#define NOT_AMD64(code) code
333#endif
334
335#ifdef SPARC
336#define SPARC_ONLY(code) code
337#define NOT_SPARC(code)
338#else
339#define SPARC_ONLY(code)
340#define NOT_SPARC(code) code
341#endif
342
343#if defined(PPC32) || defined(PPC64)
344#ifndef PPC
345#define PPC
346#endif
347#define PPC_ONLY(code) code
348#define NOT_PPC(code)
349#else
350#undef PPC
351#define PPC_ONLY(code)
352#define NOT_PPC(code) code
353#endif
354
355#ifdef PPC32
356#define PPC32_ONLY(code) code
357#define NOT_PPC32(code)
358#else
359#define PPC32_ONLY(code)
360#define NOT_PPC32(code) code
361#endif
362
363#ifdef PPC64
364#define PPC64_ONLY(code) code
365#define NOT_PPC64(code)
366#else
367#define PPC64_ONLY(code)
368#define NOT_PPC64(code) code
369#endif
370
371#ifdef E500V2
372#define E500V2_ONLY(code) code
373#define NOT_E500V2(code)
374#else
375#define E500V2_ONLY(code)
376#define NOT_E500V2(code) code
377#endif
378
379
380#ifdef ARM
381#define ARM_ONLY(code) code
382#define NOT_ARM(code)
383#else
384#define ARM_ONLY(code)
385#define NOT_ARM(code) code
386#endif
387
388#ifdef JAVASE_EMBEDDED
389#define EMBEDDED_ONLY(code) code
390#define NOT_EMBEDDED(code)
391#else
392#define EMBEDDED_ONLY(code)
393#define NOT_EMBEDDED(code) code
394#endif
395
396#define define_pd_global(type, name, value) const type pd_##name = value;
397
398#endif // SHARE_VM_UTILITIES_MACROS_HPP
399