1 /*
   2  * Copyright (c) 2015, 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 #ifndef SHARE_VM_LOGGING_LOGPREFIX_HPP
  25 #define SHARE_VM_LOGGING_LOGPREFIX_HPP
  26 
  27 #include "gc/shared/gcId.hpp"
  28 #include "logging/logTag.hpp"
  29 
  30 // Prefixes prepend each log message for a specified tagset with the given prefix.
  31 // A prefix consists of a format string and a value or callback. Prefixes are added
  32 // after the decorations but before the log message.
  33 //
  34 // List of prefixes for specific tags and/or tagsets.
  35 // Syntax: LOG_PREFIX(<printf format>, <value/callback for value>, LOG_TAGS(<chosen log tags>))
  36 #define LOG_PREFIX_LIST \
  37   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc)) \
  38   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, age)) \
  39   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, alloc)) \
  40   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, barrier)) \
  41   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, compaction)) \
  42   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, compaction, phases)) \
  43   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, cpu)) \
  44   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ergo)) \
  45   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ergo, conc)) \
  46   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ergo, cset)) \
  47   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ergo, heap)) \
  48   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, heap)) \
  49   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, freelist)) \
  50   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, liveness)) \
  51   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, metaspace)) \
  52   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, phases)) \
  53   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, phases, start)) \
  54   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, plab)) \
  55   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, region)) \
  56   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, remset)) \
  57   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ref)) \
  58   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ref, start)) \
  59   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, start)) \
  60   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, task)) \
  61   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, task, start)) \
  62   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, task, stats)) \
  63   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, task, time)) \
  64   LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, tlab))
  65 
  66 // The empty prefix, used when there's no prefix defined.
  67 template <LogTagType T0, LogTagType T1, LogTagType T2, LogTagType T3, LogTagType T4, LogTagType GuardTag = LogTag::__NO_TAG>
  68 struct LogPrefix : public AllStatic {
  69   STATIC_ASSERT(GuardTag == LogTag::__NO_TAG);
  70   static size_t prefix(char* buf, size_t len) {
  71     return 0;
  72   }
  73 };
  74 
  75 #define LOG_PREFIX(fn, ...) \
  76 template <> struct LogPrefix<__VA_ARGS__> { \
  77   static size_t prefix(char* buf, size_t len) { \
  78     DEBUG_ONLY(buf[0] = '\0'); \
  79     size_t ret = fn(buf, len); \
  80     assert(ret == strlen(buf), "Length mismatch ret (" SIZE_FORMAT ") != buf length (" SIZE_FORMAT ")", ret, strlen(buf)); \
  81     return ret; \
  82   } \
  83 };
  84 LOG_PREFIX_LIST
  85 #undef LOG_PREFIX
  86 
  87 #endif // SHARE_VM_LOGGING_LOGPREFIX_HPP