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#ifndef SHARE_LOGGING_LOGPREFIX_HPP
25#define SHARE_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
43DEBUG_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, ergo, refine)) \
59 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, heap)) \
60 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, heap, region)) \
61 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, freelist)) \
62 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, humongous)) \
63 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ihop)) \
64 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, liveness)) \
65 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, load)) \
66 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, marking)) \
67 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, metaspace)) \
68 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, mmu)) \
69 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, nmethod)) \
70 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, phases)) \
71 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, phases, ref)) \
72 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, phases, start)) \
73 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, phases, task)) \
74 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, phases, verify)) \
75 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, phases, verify, start)) \
76 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, plab)) \
77 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, promotion)) \
78 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, region)) \
79 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, remset)) \
80 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, remset, tracking)) \
81 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ref)) \
82 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, ref, start)) \
83 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, reloc)) \
84 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, start)) \
85 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, symboltable)) \
86 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, sweep)) \
87 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, task)) \
88 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, task, start)) \
89 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, task, stats)) \
90 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, task, time)) \
91 DEBUG_ONLY(LOG_PREFIX(Test_log_prefix_prefixer, LOG_TAGS(logging, test))) \
92 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, tlab)) \
93 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, verify)) \
94 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, verify, start)) \
95 LOG_PREFIX(GCId::print_prefix, LOG_TAGS(gc, workgang))
96
97
98// The empty prefix, used when there's no prefix defined.
99template <LogTagType T0, LogTagType T1, LogTagType T2, LogTagType T3, LogTagType T4, LogTagType GuardTag = LogTag::__NO_TAG>
100struct LogPrefix : public AllStatic {
101 STATIC_ASSERT(GuardTag == LogTag::__NO_TAG);
102 static size_t prefix(char* buf, size_t len) {
103 return 0;
104 }
105};
106
107#define LOG_PREFIX(fn, ...) \
108template <> struct LogPrefix<__VA_ARGS__> { \
109 static size_t prefix(char* buf, size_t len) { \
110 size_t ret = fn(buf, len); \
111 /* Either prefix did fit (strlen(buf) == ret && ret < len) */ \
112 /* or the prefix didn't fit in buffer (ret > len && strlen(buf) < len) */ \
113 assert(ret == 0 || strlen(buf) < len, \
114 "Buffer overrun by prefix function."); \
115 assert(ret == 0 || strlen(buf) == ret || ret >= len, \
116 "Prefix function should return length of prefix written," \
117 " or the intended length of prefix if the buffer was too small."); \
118 return ret; \
119 } \
120};
121LOG_PREFIX_LIST
122#undef LOG_PREFIX
123
124#endif // SHARE_LOGGING_LOGPREFIX_HPP
125