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