1 /*
   2  * Copyright (c) 2015, 2019, 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 #include "precompiled.hpp"
  25 #include "jvm.h"
  26 #include "logging/logConfiguration.hpp"
  27 #include "logging/logDecorations.hpp"
  28 #include "runtime/atomic.hpp"
  29 #include "runtime/orderAccess.hpp"
  30 #include "runtime/os.inline.hpp"
  31 #include "runtime/thread.inline.hpp"
  32 #include "services/management.hpp"
  33 
  34 jlong LogDecorations::_vm_start_time_millis = 0;
  35 const char* volatile LogDecorations::_host_name = NULL;
  36 
  37 LogDecorations::LogDecorations(LogLevelType level, const LogTagSet &tagset, const LogDecorators &decorators)
  38     : _level(level), _tagset(tagset), _millis(-1) {
  39   create_decorations(decorators);
  40 }
  41 
  42 void LogDecorations::initialize(jlong vm_start_time) {
  43   _vm_start_time_millis = vm_start_time;
  44 }
  45 
  46 const char* LogDecorations::host_name() {
  47   const char* host_name = OrderAccess::load_acquire(&_host_name);
  48   if (host_name == NULL) {
  49     char buffer[1024];
  50     if (os::get_host_name(buffer, sizeof(buffer))) {
  51       host_name = os::strdup_check_oom(buffer);
  52       const char* old_value = Atomic::cmpxchg(host_name, &_host_name, (const char*)NULL);
  53       if (old_value != NULL) {
  54         os::free((void *) host_name);
  55         host_name = old_value;
  56       }
  57     }
  58   }
  59   return host_name;
  60 }
  61 
  62 void LogDecorations::create_decorations(const LogDecorators &decorators) {
  63   char* position = _decorations_buffer;
  64   #define DECORATOR(full_name, abbr) \
  65   if (decorators.is_decorator(LogDecorators::full_name##_decorator)) { \
  66     _decoration_offset[LogDecorators::full_name##_decorator] = position; \
  67     position = create_##full_name##_decoration(position) + 1; \
  68   } else { \
  69     _decoration_offset[LogDecorators::full_name##_decorator] = NULL; \
  70   }
  71   DECORATOR_LIST
  72 #undef DECORATOR
  73 }
  74 
  75 jlong LogDecorations::java_millis() {
  76   if (_millis < 0) {
  77     _millis = os::javaTimeMillis();
  78   }
  79   return _millis;
  80 }
  81 
  82 #define ASSERT_AND_RETURN(written, pos) \
  83     assert(written >= 0, "Decorations buffer overflow"); \
  84     return pos + written;
  85 
  86 char* LogDecorations::create_time_decoration(char* pos) {
  87   char* buf = os::iso8601_time(pos, 29);
  88   int written = buf == NULL ? -1 : 29;
  89   ASSERT_AND_RETURN(written, pos)
  90 }
  91 
  92 char* LogDecorations::create_utctime_decoration(char* pos) {
  93   char* buf = os::iso8601_time(pos, 29, true);
  94   int written = buf == NULL ? -1 : 29;
  95   ASSERT_AND_RETURN(written, pos)
  96 }
  97 
  98 char * LogDecorations::create_uptime_decoration(char* pos) {
  99   int written = jio_snprintf(pos, DecorationsBufferSize - (pos - _decorations_buffer), "%.3fs", os::elapsedTime());
 100   ASSERT_AND_RETURN(written, pos)
 101 }
 102 
 103 char * LogDecorations::create_timemillis_decoration(char* pos) {
 104   int written = jio_snprintf(pos, DecorationsBufferSize - (pos - _decorations_buffer), INT64_FORMAT "ms", java_millis());
 105   ASSERT_AND_RETURN(written, pos)
 106 }
 107 
 108 char * LogDecorations::create_uptimemillis_decoration(char* pos) {
 109   int written = jio_snprintf(pos, DecorationsBufferSize - (pos - _decorations_buffer),
 110                              INT64_FORMAT "ms", java_millis() - _vm_start_time_millis);
 111   ASSERT_AND_RETURN(written, pos)
 112 }
 113 
 114 char * LogDecorations::create_timenanos_decoration(char* pos) {
 115   int written = jio_snprintf(pos, DecorationsBufferSize - (pos - _decorations_buffer), INT64_FORMAT "ns", os::javaTimeNanos());
 116   ASSERT_AND_RETURN(written, pos)
 117 }
 118 
 119 char * LogDecorations::create_uptimenanos_decoration(char* pos) {
 120   int written = jio_snprintf(pos, DecorationsBufferSize - (pos - _decorations_buffer), INT64_FORMAT "ns", os::elapsed_counter());
 121   ASSERT_AND_RETURN(written, pos)
 122 }
 123 
 124 char * LogDecorations::create_pid_decoration(char* pos) {
 125   int written = jio_snprintf(pos, DecorationsBufferSize - (pos - _decorations_buffer), "%d", os::current_process_id());
 126   ASSERT_AND_RETURN(written, pos)
 127 }
 128 
 129 char * LogDecorations::create_tid_decoration(char* pos) {
 130   int written = jio_snprintf(pos, DecorationsBufferSize - (pos - _decorations_buffer),
 131                              INTX_FORMAT, os::current_thread_id());
 132   ASSERT_AND_RETURN(written, pos)
 133 }
 134 
 135 char* LogDecorations::create_level_decoration(char* pos) {
 136   // Avoid generating the level decoration because it may change.
 137   // The decoration() method has a special case for level decorations.
 138   return pos;
 139 }
 140 
 141 char* LogDecorations::create_tags_decoration(char* pos) {
 142   int written = _tagset.label(pos, DecorationsBufferSize - (pos - _decorations_buffer));
 143   ASSERT_AND_RETURN(written, pos)
 144 }
 145 
 146 char* LogDecorations::create_hostname_decoration(char* pos) {
 147   int written = jio_snprintf(pos, DecorationsBufferSize - (pos - _decorations_buffer), "%s", host_name());
 148   ASSERT_AND_RETURN(written, pos)
 149 }
 150