1 /*
2  * Copyright (c) 2003, 2013, 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_PRIMS_JVMTIREDEFINECLASSESTRACE_HPP
26 #define SHARE_VM_PRIMS_JVMTIREDEFINECLASSESTRACE_HPP
27 
28 // RedefineClasses tracing support via the TraceRedefineClasses
29 // option. A bit is assigned to each group of trace messages.
30 // Groups of messages are individually selectable. We have to use
31 // decimal values on the command line since the command option
32 // parsing logic doesn't like non-decimal numerics. The HEX values
33 // are used in the actual RC_TRACE() calls for sanity. To achieve
34 // the old cumulative behavior, pick the level after the one in
35 // which you are interested and subtract one, e.g., 33554431 will
36 // print every tracing message.
37 //
38 //    0x00000000 |          0 - default; no tracing messages
39 //    0x00000001 |          1 - name each target class before loading, after
40 //                              loading and after redefinition is completed
41 //    0x00000002 |          2 - print info if parsing, linking or
42 //                              verification throws an exception
43 //    0x00000004 |          4 - print timer info for the VM operation
44 //    0x00000008 |          8 - print subclass counter updates
45 //    0x00000010 |         16 - unused
46 //    0x00000020 |         32 - unused
47 //    0x00000040 |         64 - unused
48 //    0x00000080 |        128 - unused
49 //    0x00000100 |        256 - previous class weak reference addition
50 //    0x00000200 |        512 - previous class weak reference mgmt during
51 //                              class unloading checks (GC)
52 //    0x00000400 |       1024 - previous class weak reference mgmt during
53 //                              add previous ops (GC)
54 //    0x00000800 |       2048 - previous class breakpoint mgmt
55 //    0x00001000 |       4096 - detect calls to obsolete methods
56 //    0x00002000 |       8192 - fail a guarantee() in addition to detection
57 //    0x00004000 |      16384 - detect old/obsolete methods in metadata
58 //    0x00008000 |      32768 - old/new method matching/add/delete
59 //    0x00010000 |      65536 - impl details: CP size info
60 //    0x00020000 |     131072 - impl details: CP merge pass info
61 //    0x00040000 |     262144 - impl details: CP index maps
62 //    0x00080000 |     524288 - impl details: modified CP index values
63 //    0x00100000 |    1048576 - impl details: vtable updates
64 //    0x00200000 |    2097152 - impl details: itable updates
65 //    0x00400000 |    4194304 - impl details: constant pool cache updates
66 //    0x00800000 |    8388608 - impl details: methodComparator info
67 //    0x01000000 |   16777216 - impl details: nmethod evolution info
68 //    0x02000000 |   33554432 - impl details: annotation updates
69 //    0x04000000 |   67108864 - impl details: StackMapTable updates
70 //    0x08000000 |  134217728 - impl details: OopMapCache updates
71 //    0x10000000 |  268435456 - unused
72 //    0x20000000 |  536870912 - unused
73 //    0x40000000 | 1073741824 - unused
74 //    0x80000000 | 2147483648 - unused
75 
76 // Macro for checking if TraceRedefineClasses has a specific bit
77 // enabled. Returns true if the bit specified by level is set.
78 #define RC_TRACE_ENABLED(level) ((TraceRedefineClasses & level) != 0)
79 
80 // Macro for checking if TraceRedefineClasses has one or more bits
81 // set in a range of bit values. Returns true if one or more bits
82 // is set in the range from low..high inclusive. Assumes that low
83 // and high are single bit values.
84 //
85 // ((high << 1) - 1)
86 //     Yields a mask that removes bits greater than the high bit value.
87 //     This algorithm doesn't work with highest bit.
88 // ~(low - 1)
89 //     Yields a mask that removes bits lower than the low bit value.
90 #define RC_TRACE_IN_RANGE(low, high) \
91 (((TraceRedefineClasses & ((high << 1) - 1)) & ~(low - 1)) != 0)
92 
93 // Note: The ResourceMark is to cleanup resource allocated args.
94 // The "do {...} while (0)" is so we can use semi-colon at end of RC_TRACE().
95 #define RC_TRACE(level, args) do { \
96   if (RC_TRACE_ENABLED(level)) { \
97     ResourceMark rm; \
98     tty->print("RedefineClasses-0x%x: ", level); \
99     tty->print_cr args; \
100   } \
101 } while (0)
102 
103 #define RC_TRACE_NO_CR(level, args) do { \
104   if (RC_TRACE_ENABLED(level)) { \
105     ResourceMark rm; \
106     tty->print("RedefineClasses-0x%x: ", level); \
107     tty->print args; \
108   } \
109 } while (0)
110 
111 #define RC_TRACE_WITH_THREAD(level, thread, args) do { \
112   if (RC_TRACE_ENABLED(level)) { \
113     ResourceMark rm(thread); \
114     tty->print("RedefineClasses-0x%x: ", level); \
115     tty->print_cr args; \
116   } \
117 } while (0)
118 
119 #define RC_TRACE_MESG(args) do { \
120   ResourceMark rm; \
121   tty->print("RedefineClasses: "); \
122   tty->print_cr args; \
123 } while (0)
124 
125 // Timer support macros. Only do timer operations if timer tracing is enabled.
126 // The "do {...} while (0)" is so we can use semi-colon at end of the macro.
127 #define RC_TIMER_START(t) do { \
128   if (RC_TRACE_ENABLED(0x00000004)) { \
129     t.start(); \
130   } \
131 } while (0)
132 #define RC_TIMER_STOP(t) do { \
133   if (RC_TRACE_ENABLED(0x00000004)) { \
134     t.stop(); \
135   } \
136 } while (0)
137 
138 #endif // SHARE_VM_PRIMS_JVMTIREDEFINECLASSESTRACE_HPP
139