1 /*
2 * Copyright (c) 2002, 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 #include "precompiled.hpp"
26 #include "ci/ciMethod.hpp"
27 #include "compiler/compileLog.hpp"
28 #include "memory/allocation.inline.hpp"
29 #include "oops/method.hpp"
30 #include "runtime/mutexLocker.hpp"
31 #include "runtime/os.hpp"
32
33 CompileLog* CompileLog::_first = NULL;
34
35 // ------------------------------------------------------------------
36 // CompileLog::CompileLog
37 CompileLog::CompileLog(const char* file_name, FILE* fp, intx thread_id)
38 : _context(_context_buffer, sizeof(_context_buffer))
39 {
40 initialize(new(ResourceObj::C_HEAP, mtCompiler) fileStream(fp, true));
41 _file_end = 0;
42 _thread_id = thread_id;
43
44 _identities_limit = 0;
45 _identities_capacity = 400;
46 _identities = NEW_C_HEAP_ARRAY(char, _identities_capacity, mtCompiler);
47 _file = NEW_C_HEAP_ARRAY(char, strlen(file_name)+1, mtCompiler);
48 strcpy((char*)_file, file_name);
49
50 // link into the global list
51 { MutexLocker locker(CompileTaskAlloc_lock);
52 _next = _first;
53 _first = this;
54 }
55 }
56
57 CompileLog::~CompileLog() {
58 delete _out;
59 _out = NULL;
60 FREE_C_HEAP_ARRAY(char, _identities, mtCompiler);
61 FREE_C_HEAP_ARRAY(char, _file, mtCompiler);
62 }
63
64
65 // see_tag, pop_tag: Override the default do-nothing methods on xmlStream.
66 // These methods provide a hook for managing the the extra context markup.
67 void CompileLog::see_tag(const char* tag, bool push) {
68 if (_context.size() > 0 && _out != NULL) {
69 _out->write(_context.base(), _context.size());
70 _context.reset();
71 }
72 xmlStream::see_tag(tag, push);
73 }
74 void CompileLog::pop_tag(const char* tag) {
75 _context.reset(); // toss any context info.
76 xmlStream::pop_tag(tag);
77 }
78
79
80 // ------------------------------------------------------------------
81 // CompileLog::identify
82 int CompileLog::identify(ciBaseObject* obj) {
83 if (obj == NULL) return 0;
84 int id = obj->ident();
85 if (id < 0) return id;
86 // If it has already been identified, just return the id.
87 if (id < _identities_limit && _identities[id] != 0) return id;
88 // Lengthen the array, if necessary.
89 if (id >= _identities_capacity) {
90 int new_cap = _identities_capacity * 2;
91 if (new_cap <= id) new_cap = id + 100;
92 _identities = REALLOC_C_HEAP_ARRAY(char, _identities, new_cap, mtCompiler);
93 _identities_capacity = new_cap;
94 }
95 while (id >= _identities_limit) {
96 _identities[_identities_limit++] = 0;
97 }
98 assert(id < _identities_limit, "oob");
99 // Mark this id as processed.
100 // (Be sure to do this before any recursive calls to identify.)
101 _identities[id] = 1; // mark
102
103 // Now, print the object's identity once, in detail.
104 if (obj->is_metadata()) {
105 ciMetadata* mobj = obj->as_metadata();
106 if (mobj->is_klass()) {
107 ciKlass* klass = mobj->as_klass();
108 begin_elem("klass id='%d'", id);
109 name(klass);
110 if (!klass->is_loaded()) {
111 print(" unloaded='1'");
112 } else {
113 print(" flags='%d'", klass->modifier_flags());
114 }
115 end_elem();
116 } else if (mobj->is_method()) {
117 ciMethod* method = mobj->as_method();
118 ciSignature* sig = method->signature();
119 // Pre-identify items that we will need!
120 identify(sig->return_type());
121 for (int i = 0; i < sig->count(); i++) {
122 identify(sig->type_at(i));
123 }
124 begin_elem("method id='%d' holder='%d'",
125 id, identify(method->holder()));
126 name(method->name());
127 print(" return='%d'", identify(sig->return_type()));
128 if (sig->count() > 0) {
129 print(" arguments='");
130 for (int i = 0; i < sig->count(); i++) {
131 print((i == 0) ? "%d" : " %d", identify(sig->type_at(i)));
132 }
133 print("'");
134 }
135 if (!method->is_loaded()) {
136 print(" unloaded='1'");
137 } else {
138 print(" flags='%d'", (jchar) method->flags().as_int());
139 // output a few metrics
140 print(" bytes='%d'", method->code_size());
141 method->log_nmethod_identity(this);
142 //print(" count='%d'", method->invocation_count());
143 //int bec = method->backedge_count();
144 //if (bec != 0) print(" backedge_count='%d'", bec);
145 print(" iicount='%d'", method->interpreter_invocation_count());
146 }
147 end_elem();
148 } else if (mobj->is_type()) {
149 BasicType type = mobj->as_type()->basic_type();
150 elem("type id='%d' name='%s'", id, type2name(type));
151 } else {
152 // Should not happen.
153 elem("unknown id='%d'", id);
154 ShouldNotReachHere();
155 }
156 } else if (obj->is_symbol()) {
157 begin_elem("symbol id='%d'", id);
158 name(obj->as_symbol());
159 end_elem();
160 } else {
161 // Should not happen.
162 elem("unknown id='%d'", id);
163 }
164 return id;
165 }
166
167 void CompileLog::name(ciSymbol* name) {
168 if (name == NULL) return;
169 print(" name='");
170 name->print_symbol_on(text()); // handles quoting conventions
171 print("'");
172 }
173
174 void CompileLog::name(ciKlass* k) {
175 print(" name='");
176 if (!k->is_loaded()) {
177 text()->print(k->name()->as_klass_external_name());
178 } else {
179 text()->print(k->external_name());
180 }
181 print("'");
182 }
183
184 // ------------------------------------------------------------------
185 // CompileLog::clear_identities
186 // Forget which identities have been printed.
187 void CompileLog::clear_identities() {
188 _identities_limit = 0;
189 }
190
191 // ------------------------------------------------------------------
192 // CompileLog::finish_log_on_error
193 //
194 // Note: This function is called after fatal error, avoid unnecessary memory
195 // or stack allocation, use only async-safe functions. It's possible JVM is
196 // only partially initialized.
197 void CompileLog::finish_log_on_error(outputStream* file, char* buf, int buflen) {
198 static bool called_exit = false;
199 if (called_exit) return;
200 called_exit = true;
201
202 CompileLog* log = _first;
203 while (log != NULL) {
204 log->flush();
205 const char* partial_file = log->file();
206 int partial_fd = open(partial_file, O_RDONLY);
207 if (partial_fd != -1) {
208 // print/print_cr may need to allocate large stack buffer to format
209 // strings, here we use snprintf() and print_raw() instead.
210 file->print_raw("<compilation_log thread='");
211 jio_snprintf(buf, buflen, UINTX_FORMAT, log->thread_id());
212 file->print_raw(buf);
213 file->print_raw_cr("'>");
214
215 size_t nr; // number read into buf from partial log
216 // Copy data up to the end of the last <event> element:
217 julong to_read = log->_file_end;
218 while (to_read > 0) {
219 if (to_read < (julong)buflen)
220 nr = (size_t)to_read;
221 else nr = buflen;
222 nr = read(partial_fd, buf, (int)nr);
223 if (nr <= 0) break;
224 to_read -= (julong)nr;
225 file->write(buf, nr);
226 }
227
228 // Copy any remaining data inside a quote:
229 bool saw_slop = false;
230 int end_cdata = 0; // state machine [0..2] watching for too many "]]"
231 while ((nr = read(partial_fd, buf, buflen)) > 0) {
232 if (!saw_slop) {
233 file->print_raw_cr("<fragment>");
234 file->print_raw_cr("<![CDATA[");
235 saw_slop = true;
236 }
237 // The rest of this loop amounts to a simple copy operation:
238 // { file->write(buf, nr); }
239 // However, it must sometimes output the buffer in parts,
240 // in case there is a CDATA quote embedded in the fragment.
241 const char* bufp; // pointer into buf
242 size_t nw; // number written in each pass of the following loop:
243 for (bufp = buf; nr > 0; nr -= nw, bufp += nw) {
244 // Write up to any problematic CDATA delimiter (usually all of nr).
245 for (nw = 0; nw < nr; nw++) {
246 // First, scan ahead into the buf, checking the state machine.
247 switch (bufp[nw]) {
248 case ']':
249 if (end_cdata < 2) end_cdata += 1; // saturating counter
250 continue; // keep scanning
251 case '>':
252 if (end_cdata == 2) break; // found CDATA delimiter!
253 // else fall through:
254 default:
255 end_cdata = 0;
256 continue; // keep scanning
257 }
258 // If we get here, nw is pointing at a bad '>'.
259 // It is very rare for this to happen.
260 // However, this code has been tested by introducing
261 // CDATA sequences into the compilation log.
262 break;
263 }
264 // Now nw is the number of characters to write, usually == nr.
265 file->write(bufp, nw);
266 if (nw < nr) {
267 // We are about to go around the loop again.
268 // But first, disrupt the ]]> by closing and reopening the quote.
269 file->print_raw("]]><![CDATA[");
270 end_cdata = 0; // reset state machine
271 }
272 }
273 }
274 if (saw_slop) {
275 file->print_raw_cr("]]>");
276 file->print_raw_cr("</fragment>");
277 }
278 file->print_raw_cr("</compilation_log>");
279 close(partial_fd);
280 unlink(partial_file);
281 }
282 CompileLog* next_log = log->_next;
283 delete log;
284 log = next_log;
285 }
286 _first = NULL;
287 }
288
289 // ------------------------------------------------------------------
290 // CompileLog::finish_log
291 //
292 // Called during normal shutdown. For now, any clean-up needed in normal
293 // shutdown is also needed in VM abort, so is covered by finish_log_on_error().
294 // Just allocate a buffer and call finish_log_on_error().
295 void CompileLog::finish_log(outputStream* file) {
296 char buf[4 * K];
297 finish_log_on_error(file, buf, sizeof(buf));
298 }
299
300 // ------------------------------------------------------------------
301 // CompileLog::inline_success
302 //
303 // Print about successful method inlining.
304 void CompileLog::inline_success(const char* reason) {
305 begin_elem("inline_success reason='");
306 text(reason);
307 end_elem("'");
308 }
309
310 // ------------------------------------------------------------------
311 // CompileLog::inline_fail
312 //
313 // Print about failed method inlining.
314 void CompileLog::inline_fail(const char* reason) {
315 begin_elem("inline_fail reason='");
316 text(reason);
317 end_elem("'");
318 }
319
320 // ------------------------------------------------------------------
321 // CompileLog::set_context
322 //
323 // Set XML tag as an optional marker - it is printed only if
324 // there are other entries after until it is reset.
325 void CompileLog::set_context(const char* format, ...) {
326 va_list ap;
327 va_start(ap, format);
328 clear_context();
329 _context.print("<");
330 _context.vprint(format, ap);
331 _context.print_cr("/>");
332 va_end(ap);
333 }
334
335 // ------------------------------------------------------------------
336 // CompileLog::code_cache_state
337 //
338 // Print code cache state.
339 void CompileLog::code_cache_state() {
340 begin_elem("code_cache");
341 CodeCache::log_state(this);
342 end_elem("");
343 }