logTagSet.hpp revision 11209:c84a6ce067ad 
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_LOGTAGSET_HPP
25#define SHARE_VM_LOGGING_LOGTAGSET_HPP
26
27#include "logging/logDecorators.hpp"
28#include "logging/logLevel.hpp"
29#include "logging/logOutputList.hpp"
30#include "logging/logPrefix.hpp"
31#include "logging/logTag.hpp"
32#include "utilities/globalDefinitions.hpp"
33
34class LogMessageBuffer;
35
36// The tagset represents a combination of tags that occur in a log call somewhere.
37// Tagsets are created automatically by the LogTagSetMappings and should never be
38// instantiated directly somewhere else.
39class LogTagSet VALUE_OBJ_CLASS_SPEC {
40 private:
41  static LogTagSet* _list;
42  static size_t     _ntagsets;
43
44  LogTagSet* const  _next;
45  size_t            _ntags;
46  LogTagType        _tag[LogTag::MaxTags];
47
48  LogOutputList     _output_list;
49  LogDecorators     _decorators;
50
51  typedef size_t (*PrefixWriter)(char* buf, size_t size);
52  PrefixWriter      _write_prefix;
53
54  // Keep constructor private to prevent incorrect instantiations of this class.
55  // Only LogTagSetMappings can create/contain instances of this class.
56  // The constructor links all tagsets together in a global list of tagsets.
57  // This list is used during configuration to be able to update all tagsets
58  // and their configurations to reflect the new global log configuration.
59  LogTagSet(PrefixWriter prefix_writer, LogTagType t0, LogTagType t1, LogTagType t2, LogTagType t3, LogTagType t4);
60
61  template <LogTagType T0, LogTagType T1, LogTagType T2, LogTagType T3, LogTagType T4, LogTagType GuardTag>
62  friend class LogTagSetMapping;
63
64 public:
65  static LogTagSet* first() {
66    return _list;
67  }
68
69  static size_t ntagsets() {
70    return _ntagsets;
71  }
72
73  LogTagSet* next() {
74    return _next;
75  }
76
77  size_t ntags() const {
78    return _ntags;
79  }
80
81  LogTagType tag(size_t idx) const {
82    return _tag[idx];
83  }
84
85  bool contains(LogTagType tag) const {
86    for (size_t i = 0; _tag[i] != LogTag::__NO_TAG; i++) {
87      if (tag == _tag[i]) {
88        return true;
89      }
90    }
91    return false;
92  }
93
94  LogLevelType level_for(const LogOutput* output) const {
95    return _output_list.level_for(output);
96  }
97
98  void set_output_level(LogOutput* output, LogLevelType level) {
99    _output_list.set_output_level(output, level);
100  }
101
102  // Refresh the decorators for this tagset to contain the decorators for all
103  // of its current outputs combined with the given decorators.
104  void update_decorators(const LogDecorators& decorator = LogDecorators::None);
105
106  int label(char *buf, size_t len, const char* separator = ",") const;
107  bool has_output(const LogOutput* output);
108
109  // The implementation of this function is put here to ensure
110  // that it is inline:able by the log_is_enabled(level, ...) macro.
111  bool is_level(LogLevelType level) const {
112    return _output_list.is_level(level);
113  }
114  void log(LogLevelType level, const char* msg);
115  void log(const LogMessageBuffer& msg);
116
117  ATTRIBUTE_PRINTF(3, 4)
118  void write(LogLevelType level, const char* fmt, ...);
119
120  template <LogLevelType Level>
121  ATTRIBUTE_PRINTF(2, 3)
122  void write(const char* fmt, ...) {
123    va_list args;
124    va_start(args, fmt);
125    vwrite(Level, fmt, args);
126    va_end(args);
127  }
128
129  ATTRIBUTE_PRINTF(3, 0)
130  void vwrite(LogLevelType level, const char* fmt, va_list args);
131};
132
133template <LogTagType T0, LogTagType T1 = LogTag::__NO_TAG, LogTagType T2 = LogTag::__NO_TAG,
134          LogTagType T3 = LogTag::__NO_TAG, LogTagType T4 = LogTag::__NO_TAG,
135          LogTagType GuardTag = LogTag::__NO_TAG>
136class LogTagSetMapping : public AllStatic {
137private:
138  // Verify number of logging tags does not exceed maximum supported.
139  STATIC_ASSERT(GuardTag == LogTag::__NO_TAG);
140  static LogTagSet _tagset;
141
142public:
143  static LogTagSet& tagset() {
144    return _tagset;
145  }
146};
147
148// Instantiate the static field _tagset for all tagsets that are used for logging somewhere.
149// (This must be done here rather than the .cpp file because it's a template.)
150// Each combination of tags used as template arguments to the Log class somewhere (via macro or not)
151// will instantiate the LogTagSetMapping template, which in turn creates the static field for that
152// tagset. This _tagset contains the configuration for those tags.
153template <LogTagType T0, LogTagType T1, LogTagType T2, LogTagType T3, LogTagType T4, LogTagType GuardTag>
154LogTagSet LogTagSetMapping<T0, T1, T2, T3, T4, GuardTag>::_tagset(&LogPrefix<T0, T1, T2, T3, T4>::prefix, T0, T1, T2, T3, T4);
155
156#endif // SHARE_VM_LOGGING_LOGTAGSET_HPP
157