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->name());
 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 
 175 // ------------------------------------------------------------------
 176 // CompileLog::clear_identities
 177 // Forget which identities have been printed.
 178 void CompileLog::clear_identities() {
 179   _identities_limit = 0;
 180 }
 181 
 182 // ------------------------------------------------------------------
 183 // CompileLog::finish_log_on_error
 184 //
 185 // Note: This function is called after fatal error, avoid unnecessary memory
 186 // or stack allocation, use only async-safe functions. It's possible JVM is
 187 // only partially initialized.
 188 void CompileLog::finish_log_on_error(outputStream* file, char* buf, int buflen) {
 189   static bool called_exit = false;
 190   if (called_exit)  return;
 191   called_exit = true;
 192 
 193   CompileLog* log = _first;
 194   while (log != NULL) {
 195     log->flush();
 196     const char* partial_file = log->file();
 197     int partial_fd = open(partial_file, O_RDONLY);
 198     if (partial_fd != -1) {
 199       // print/print_cr may need to allocate large stack buffer to format
 200       // strings, here we use snprintf() and print_raw() instead.
 201       file->print_raw("<compilation_log thread='");
 202       jio_snprintf(buf, buflen, UINTX_FORMAT, log->thread_id());
 203       file->print_raw(buf);
 204       file->print_raw_cr("'>");
 205 
 206       size_t nr; // number read into buf from partial log
 207       // Copy data up to the end of the last <event> element:
 208       julong to_read = log->_file_end;
 209       while (to_read > 0) {
 210         if (to_read < (julong)buflen)
 211               nr = (size_t)to_read;
 212         else  nr = buflen;
 213         nr = read(partial_fd, buf, (int)nr);
 214         if (nr <= 0)  break;
 215         to_read -= (julong)nr;
 216         file->write(buf, nr);
 217       }
 218 
 219       // Copy any remaining data inside a quote:
 220       bool saw_slop = false;
 221       int end_cdata = 0;  // state machine [0..2] watching for too many "]]"
 222       while ((nr = read(partial_fd, buf, buflen)) > 0) {
 223         if (!saw_slop) {
 224           file->print_raw_cr("<fragment>");
 225           file->print_raw_cr("<![CDATA[");
 226           saw_slop = true;
 227         }
 228         // The rest of this loop amounts to a simple copy operation:
 229         // { file->write(buf, nr); }
 230         // However, it must sometimes output the buffer in parts,
 231         // in case there is a CDATA quote embedded in the fragment.
 232         const char* bufp;  // pointer into buf
 233         size_t nw; // number written in each pass of the following loop:
 234         for (bufp = buf; nr > 0; nr -= nw, bufp += nw) {
 235           // Write up to any problematic CDATA delimiter (usually all of nr).
 236           for (nw = 0; nw < nr; nw++) {
 237             // First, scan ahead into the buf, checking the state machine.
 238             switch (bufp[nw]) {
 239             case ']':
 240               if (end_cdata < 2)   end_cdata += 1;  // saturating counter
 241               continue;  // keep scanning
 242             case '>':
 243               if (end_cdata == 2)  break;  // found CDATA delimiter!
 244               // else fall through:
 245             default:
 246               end_cdata = 0;
 247               continue;  // keep scanning
 248             }
 249             // If we get here, nw is pointing at a bad '>'.
 250             // It is very rare for this to happen.
 251             // However, this code has been tested by introducing
 252             // CDATA sequences into the compilation log.
 253             break;
 254           }
 255           // Now nw is the number of characters to write, usually == nr.
 256           file->write(bufp, nw);
 257           if (nw < nr) {
 258             // We are about to go around the loop again.
 259             // But first, disrupt the ]]> by closing and reopening the quote.
 260             file->print_raw("]]><![CDATA[");
 261             end_cdata = 0;  // reset state machine
 262           }
 263         }
 264       }
 265       if (saw_slop) {
 266         file->print_raw_cr("]]>");
 267         file->print_raw_cr("</fragment>");
 268       }
 269       file->print_raw_cr("</compilation_log>");
 270       close(partial_fd);
 271       unlink(partial_file);
 272     }
 273     CompileLog* next_log = log->_next;
 274     delete log;
 275     log = next_log;
 276   }
 277   _first = NULL;
 278 }
 279 
 280 // ------------------------------------------------------------------
 281 // CompileLog::finish_log
 282 //
 283 // Called during normal shutdown. For now, any clean-up needed in normal
 284 // shutdown is also needed in VM abort, so is covered by finish_log_on_error().
 285 // Just allocate a buffer and call finish_log_on_error().
 286 void CompileLog::finish_log(outputStream* file) {
 287   char buf[4 * K];
 288   finish_log_on_error(file, buf, sizeof(buf));
 289 }
 290 
 291 // ------------------------------------------------------------------
 292 // CompileLog::inline_success
 293 //
 294 // Print about successful method inlining.
 295 void CompileLog::inline_success(const char* reason) {
 296   begin_elem("inline_success reason='");
 297   text(reason);
 298   end_elem("'");
 299 }
 300 
 301 // ------------------------------------------------------------------
 302 // CompileLog::inline_fail
 303 //
 304 // Print about failed method inlining.
 305 void CompileLog::inline_fail(const char* reason) {
 306   begin_elem("inline_fail reason='");
 307   text(reason);
 308   end_elem("'");
 309 }
 310 
 311 // ------------------------------------------------------------------
 312 // CompileLog::set_context
 313 //
 314 // Set XML tag as an optional marker - it is printed only if
 315 // there are other entries after until it is reset.
 316 void CompileLog::set_context(const char* format, ...) {
 317   va_list ap;
 318   va_start(ap, format);
 319   clear_context();
 320   _context.print("<");
 321   _context.vprint(format, ap);
 322   _context.print_cr("/>");
 323   va_end(ap);
 324 }
 325 
 326 // ------------------------------------------------------------------
 327 // CompileLog::code_cache_state
 328 //
 329 // Print code cache state.
 330 void CompileLog::code_cache_state() {
 331   begin_elem("code_cache");
 332   CodeCache::log_state(this);
 333   end_elem("");
 334 }