1 /* 2 * Copyright (c) 2015, 2016, 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 a given prefix. 31 // These prefixes are written before the log message but after the log decorations. 32 // 33 // A prefix is defined as a function that takes a buffer (with some size) as argument. 34 // This function will be called for each log message, and should write the prefix 35 // to the given buffer. The function should return how many characters it wrote, 36 // which should never exceed the given size. 37 // 38 // List of prefixes for specific tags and/or tagsets. 39 // Syntax: LOG_PREFIX(<name of prefixer function>, LOG_TAGS(<chosen log tags>)) 40 // Where the prefixer function matches the following signature: size_t (*)(char*, size_t) 41 42 // Prefix function for internal vm test 43 DEBUG_ONLY(size_t Test_log_prefix_prefixer(char* buf, size_t len);) 44 45 #define LOG_PREFIX_LIST \ 46 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc)) \ 47 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, age)) \ 48 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, alloc)) \ 49 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, alloc, region)) \ 50 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, barrier)) \ 51 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, classhisto)) \ 52 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, compaction)) \ 53 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, cpu)) \ 54 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ergo)) \ 55 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ergo, cset)) \ 56 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ergo, heap)) \ 57 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ergo, ihop)) \ 58 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, heap)) \ 59 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, heap, region)) \ 60 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, freelist)) \ 61 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ihop)) \ 62 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, liveness)) \ 63 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, marking)) \ 64 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, metaspace)) \ 65 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, phases)) \ 66 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, phases, start)) \ 67 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, phases, task)) \ 68 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, plab)) \ 69 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, region)) \ 70 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, remset)) \ 71 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ref)) \ 72 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ref, start)) \ 73 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, start)) \ 74 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, sweep)) \ 75 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, task)) \ 76 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, task, start)) \ 77 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, task, stats)) \ 78 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, task, time)) \ 79 DEBUG_ONLY(LOG_PREFIX(Test_log_prefix_prefixer, LOG_TAGS(logging, test))) \ 80 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, tlab)) 81 82 83 // The empty prefix, used when there's no prefix defined. 84 template <LogTagType T0, LogTagType T1, LogTagType T2, LogTagType T3, LogTagType T4, LogTagType GuardTag = LogTag::__NO_TAG> 85 struct LogPrefix : public AllStatic { 86 STATIC_ASSERT(GuardTag == LogTag::__NO_TAG); 87 static size_t prefix(char* buf, size_t len) { 88 return 0; 89 } 90 }; 91 92 #define LOG_PREFIX(fn, ...) \ 93 template <> struct LogPrefix<__VA_ARGS__> { \ 94 static size_t prefix(char* buf, size_t len) { \ 95 DEBUG_ONLY(buf[0] = '\0';) \ 96 size_t ret = fn(buf, len); \ 97 /* Either prefix did fit (strlen(buf) == ret && ret < len) */ \ 98 /* or the prefix didn't fit in buffer (ret > len && strlen(buf) < len) */ \ 99 assert(strlen(buf) < len, "Buffer overrun by prefix function."); \ 100 assert(strlen(buf) == ret || ret >= len, "Prefix function should return length of prefix written," \ 101 " or the intended length of prefix if the buffer was too small."); \ 102 return ret; \ 103 } \ 104 }; 105 LOG_PREFIX_LIST 106 #undef LOG_PREFIX 107 108 #endif // SHARE_VM_LOGGING_LOGPREFIX_HPP