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_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/logTag.hpp"
  31 #include "utilities/globalDefinitions.hpp"
  32 
  33 // The tagset represents a combination of tags that occur in a log call somewhere.
  34 // Tagsets are created automatically by the LogTagSetMappings and should never be
  35 // instantiated directly somewhere else.
  36 class LogTagSet VALUE_OBJ_CLASS_SPEC {
  37  private:
  38   static LogTagSet* _list;
  39   static size_t     _ntagsets;
  40 
  41   LogTagSet* const  _next;
  42   size_t            _ntags;
  43   LogTagType        _tag[LogTag::MaxTags];
  44 
  45   LogOutputList     _output_list;
  46   LogDecorators     _decorators;
  47 
  48   // Keep constructor private to prevent incorrect instantiations of this class.
  49   // Only LogTagSetMappings can create/contain instances of this class.
  50   // The constructor links all tagsets together in a global list of tagsets.
  51   // This list is used during configuration to be able to update all tagsets
  52   // and their configurations to reflect the new global log configuration.
  53   LogTagSet(LogTagType t0, LogTagType t1, LogTagType t2, LogTagType t3, LogTagType t4);
  54 
  55   template <LogTagType T0, LogTagType T1, LogTagType T2, LogTagType T3, LogTagType T4>
  56   friend class LogTagSetMapping;
  57 
  58  public:
  59   static LogTagSet* first() {
  60     return _list;
  61   }
  62 
  63   LogTagSet* next() {
  64     return _next;
  65   }
  66 
  67   size_t ntags() const {
  68     return _ntags;
  69   }
  70 
  71   bool contains(LogTagType tag) const {
  72     for (size_t i = 0; _tag[i] != LogTag::__NO_TAG; i++) {
  73       if (tag == _tag[i]) {
  74         return true;
  75       }
  76     }
  77     return false;
  78   }
  79 
  80   void set_output_level(LogOutput* output, LogLevelType level) {
  81     _output_list.set_output_level(output, level);
  82   }
  83 
  84   // Refresh the decorators for this tagset to contain the decorators for all
  85   // of its current outputs combined with the given decorators.
  86   void update_decorators(const LogDecorators& decorator);
  87 
  88   int label(char *buf, size_t len);
  89   bool has_output(const LogOutput* output);
  90   bool is_level(LogLevelType level);
  91   void log(LogLevelType level, const char* msg);
  92 };
  93 
  94 template <LogTagType T0, LogTagType T1 = LogTag::__NO_TAG, LogTagType T2 = LogTag::__NO_TAG,
  95           LogTagType T3 = LogTag::__NO_TAG, LogTagType T4 = LogTag::__NO_TAG>
  96 class LogTagSetMapping : public AllStatic {
  97 private:
  98   static LogTagSet _tagset;
  99 
 100 public:
 101   static LogTagSet& tagset() {
 102     return _tagset;
 103   }
 104 };
 105 
 106 // Instantiate the static field _tagset for all tagsets that are used for logging somewhere.
 107 // (This must be done here rather than the .cpp file because it's a template.)
 108 // Each combination of tags used as template arguments to the Log class somewhere (via macro or not)
 109 // will instantiate the LogTagSetMapping template, which in turn creates the static field for that
 110 // tagset. This _tagset contains the configuration for those tags.
 111 template <LogTagType T0, LogTagType T1, LogTagType T2, LogTagType T3, LogTagType T4>
 112 LogTagSet LogTagSetMapping<T0, T1, T2, T3, T4>::_tagset(T0, T1, T2, T3, T4);
 113 
 114 #endif // SHARE_VM_LOGGING_LOGTAGSET_HPP