src/hotspot/share/logging/logSelection.hpp
author coleenp
Thu, 10 Jan 2019 15:13:51 -0500
changeset 53244 9807daeb47c4
parent 49188 e9ba8b40ca6f
permissions -rw-r--r--
8216167: Update include guards to reflect correct directories Summary: Use script and some manual fixup to fix directores names in include guards. Reviewed-by: lfoltan, eosterlund, kbarrett
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
49016
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
     1
/*
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 49188
diff changeset
     2
 * Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved.
49016
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
     4
 *
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
     7
 * published by the Free Software Foundation.
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
     8
 *
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    13
 * accompanied this code).
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    14
 *
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    18
 *
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    21
 * questions.
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    22
 *
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    23
 */
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 49188
diff changeset
    24
#ifndef SHARE_LOGGING_LOGSELECTION_HPP
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 49188
diff changeset
    25
#define SHARE_LOGGING_LOGSELECTION_HPP
49016
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    26
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    27
#include "logging/logLevel.hpp"
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    28
#include "logging/logTag.hpp"
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    29
#include "memory/allocation.hpp"
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    30
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    31
class LogTagSet;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    32
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    33
// Class representing a selection of tags with for a given level.
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    34
// Consists of a set of tags, an optional wildcard flag, and a level, e.g. "tag1+tag2*=level".
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    35
class LogSelection : public StackObj {
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    36
  friend class LogSelectionList;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    37
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    38
 private:
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    39
  size_t _ntags;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    40
  LogTagType _tags[LogTag::MaxTags];
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    41
  bool _wildcard;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    42
  LogLevelType _level;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    43
  size_t _tag_sets_selected;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    44
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    45
  LogSelection();
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    46
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    47
 public:
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    48
  static const LogSelection Invalid;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    49
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    50
  static LogSelection parse(const char* str, outputStream* error_stream = NULL);
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    51
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    52
  LogSelection(const LogTagType tags[LogTag::MaxTags], bool wildcard, LogLevelType level);
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    53
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    54
  bool operator==(const LogSelection& ref) const;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    55
  bool operator!=(const LogSelection& ref) const;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    56
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    57
  size_t ntags() const;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    58
  LogLevelType level() const;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    59
  size_t tag_sets_selected() const;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    60
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    61
  bool selects(const LogTagSet& ts) const;
49188
e9ba8b40ca6f 8168722: Unified Logging configuration output needs simplifying
mlarsson
parents: 49180
diff changeset
    62
  bool consists_of(const LogTagType tags[LogTag::MaxTags]) const;
49016
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    63
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    64
  int describe_tags(char* buf, size_t bufsize) const;
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    65
  int describe(char* buf, size_t bufsize) const;
49180
9637557def32 8190346: improve unified JVM logging help message and warnings
mlarsson
parents: 49016
diff changeset
    66
9637557def32 8190346: improve unified JVM logging help message and warnings
mlarsson
parents: 49016
diff changeset
    67
  // List similar selections that matches existing tag sets on the given outputstream
9637557def32 8190346: improve unified JVM logging help message and warnings
mlarsson
parents: 49016
diff changeset
    68
  void suggest_similar_matching(outputStream* out) const;
9637557def32 8190346: improve unified JVM logging help message and warnings
mlarsson
parents: 49016
diff changeset
    69
9637557def32 8190346: improve unified JVM logging help message and warnings
mlarsson
parents: 49016
diff changeset
    70
  // Compute a similarity measure in the range [0, 1], where higher means more similar
9637557def32 8190346: improve unified JVM logging help message and warnings
mlarsson
parents: 49016
diff changeset
    71
  double similarity(const LogSelection& other) const;
49016
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    72
};
ea85eed8b012 8196783: Refactor LogTagLevelExpression into separate classes
mlarsson
parents:
diff changeset
    73
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 49188
diff changeset
    74
#endif // SHARE_LOGGING_LOGSELECTION_HPP