logDecorators.hpp revision 10272:b0cdcfe42ebf 
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_LOGDECORATORS_HPP
25#define SHARE_VM_LOGGING_LOGDECORATORS_HPP
26
27#include "memory/allocation.hpp"
28#include "utilities/globalDefinitions.hpp"
29
30// The list of available decorators:
31// time         - Current time and date in ISO-8601 format
32// uptime       - Time since the start of the JVM in seconds and milliseconds (e.g., 6.567s)
33// timemillis   - The same value as generated by System.currentTimeMillis()
34// uptimemillis - Milliseconds since the JVM started
35// timenanos    - The same value as generated by System.nanoTime()
36// uptimenanos  - Nanoseconds since the JVM started
37// hostname     - The hostname
38// pid          - The process identifier
39// tid          - The thread identifier
40// level        - The level associated with the log message
41// tags         - The tag-set associated with the log message
42#define DECORATOR_LIST          \
43  DECORATOR(time,         t)    \
44  DECORATOR(uptime,       u)    \
45  DECORATOR(timemillis,   tm)   \
46  DECORATOR(uptimemillis, um)   \
47  DECORATOR(timenanos,    tn)   \
48  DECORATOR(uptimenanos,  un)   \
49  DECORATOR(hostname,     hn)   \
50  DECORATOR(pid,          p)    \
51  DECORATOR(tid,          ti)   \
52  DECORATOR(level,        l)    \
53  DECORATOR(tags,         tg)
54
55// LogDecorators represents a selection of decorators that should be prepended to
56// each log message for a given output. Decorators are always prepended in the order
57// declared above. For example, logging with 'uptime, level, tags' decorators results in:
58// [0,943s][info   ][logging] message.
59class LogDecorators VALUE_OBJ_CLASS_SPEC {
60 public:
61  enum Decorator {
62#define DECORATOR(name, abbr) name##_decorator,
63    DECORATOR_LIST
64#undef DECORATOR
65    Count,
66    Invalid
67  };
68
69 private:
70  uint _decorators;
71  static const char* _name[][2];
72  static const uint DefaultDecoratorsMask = (1 << uptime_decorator) | (1 << level_decorator) | (1 << tags_decorator);
73
74  static uint mask(LogDecorators::Decorator decorator) {
75    return 1 << decorator;
76  }
77
78  LogDecorators(uint mask) : _decorators(mask) {
79  }
80
81 public:
82  static const LogDecorators None;
83
84  LogDecorators() : _decorators(DefaultDecoratorsMask) {
85  };
86
87  void clear() {
88    _decorators = 0;
89  }
90
91  static const char* name(LogDecorators::Decorator decorator) {
92    return _name[decorator][0];
93  }
94
95  static const char* abbreviation(LogDecorators::Decorator decorator) {
96    return _name[decorator][1];
97  }
98
99  static LogDecorators::Decorator from_string(const char* str);
100
101  void combine_with(const LogDecorators &source) {
102    _decorators |= source._decorators;
103  }
104
105  bool is_decorator(LogDecorators::Decorator decorator) const {
106    return (_decorators & mask(decorator)) != 0;
107  }
108
109  bool parse(const char* decorator_args, outputStream* errstream = NULL);
110};
111
112#endif // SHARE_VM_LOGGING_LOGDECORATORS_HPP
113