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 #ifndef SHARE_VM_COMPILER_COMPILELOG_HPP
  26 #define SHARE_VM_COMPILER_COMPILELOG_HPP
  27 
  28 #include "utilities/xmlstream.hpp"
  29 
  30 class ciBaseObject;
  31 class ciObject;
  32 class ciMetadata;
  33 class ciSymbol;
  34 
  35 // CompileLog
  36 //
  37 // An open stream for logging information about activities in a
  38 // compiler thread.  There is exactly one per CompilerThread,
  39 // if the +LogCompilation switch is enabled.
  40 class CompileLog : public xmlStream {
  41  private:
  42   const char*   _file;           // name of file where XML goes
  43   julong        _file_end;       // last good end of file
  44   intx          _thread_id;      // which compile thread
  45 
  46   stringStream  _context;        // optional, killable context marker
  47   char          _context_buffer[100];
  48 
  49   char*         _identities;     // array of boolean
  50   int           _identities_limit;
  51   int           _identities_capacity;
  52 
  53   CompileLog*   _next;           // static chain of all logs
  54 
  55   static CompileLog* _first;     // head of static chain
  56 
  57   void va_tag(bool push, const char* format, va_list ap);
  58 
  59  public:
  60   CompileLog(const char* file_name, FILE* fp, intx thread_id);
  61   ~CompileLog();
  62 
  63   intx          thread_id()                      { return _thread_id; }
  64   const char*   file()                           { return _file; }
  65 
  66   // Optional context marker, to help place actions that occur during
  67   // parsing. If there is no log output until the next context string
  68   // or reset, context string will be silently ignored
  69   stringStream* context()                        { return &_context; }
  70   void    clear_context()                        { context()->reset(); }
  71   void      set_context(const char* format, ...);
  72 
  73   void          name(ciSymbol* s);               // name='s'
  74   void          name(Symbol* s)                  { xmlStream::name(s); }
  75 
  76   // Output an object description, return obj->ident().
  77   int           identify(ciBaseObject* obj);
  78   void          clear_identities();
  79 
  80   void inline_fail   (const char* reason);
  81   void inline_success(const char* reason);
  82 
  83   // virtuals
  84   virtual void see_tag(const char* tag, bool push);
  85   virtual void pop_tag(const char* tag);
  86 
  87   // make a provisional end of log mark
  88   void mark_file_end() { _file_end = out()->count(); }
  89 
  90   // Print code cache statistics
  91   void code_cache_state();
  92 
  93   // copy all logs to the given stream
  94   static void finish_log(outputStream* out);
  95   static void finish_log_on_error(outputStream* out, char *buf, int buflen);
  96 };
  97 
  98 #endif // SHARE_VM_COMPILER_COMPILELOG_HPP