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