src/hotspot/share/jfr/utilities/jfrLogTagSets.hpp
author egahlin
Tue, 15 May 2018 20:24:34 +0200
changeset 50113 caf115bb98ad
child 50745 a390cbb82d47
permissions -rw-r--r--
8199712: Flight Recorder Reviewed-by: coleenp, ihse, erikj, dsamersoff, mseledtsov, egahlin, mgronlun Contributed-by: erik.gahlin@oracle.com, markus.gronlund@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     1
/*
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     2
 * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     4
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     7
 * published by the Free Software Foundation.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     8
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    13
 * accompanied this code).
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    14
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    18
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    21
 * questions.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    22
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    23
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    24
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    25
#ifndef SHARE_VM_JFR_UTILITIES_JFRLOGTAGSETS_HPP
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    26
#define SHARE_VM_JFR_UTILITIES_JFRLOGTAGSETS_HPP
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
#include "logging/logTag.hpp"
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
/*
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
 * This file declares the Unified Logging (UL) tag sets for JFR.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
 * The JFR_LOG_TAG_SET_LIST macro will generate an enum
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
 * (zero-based ordinals) for these log tag sets.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
 * Log tag set order (enum ordinals) is important
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
 * because we need to mirror this order in Java.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
 * Adding a new log tag set:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
 * 1. Ensure the log tag primitive which you attempt to use in your new log tag set is defined to UL.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
 *    UL log tags are defined in logging/logTag.hpp.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
 * 2. Append the new log tag set to the JFR_LOG_TAG_SET_LIST macro in this file.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
 * 3. Make the corresponding change in Java by updating jdk.jfr.internal.LogTag.java
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
 *    to add another enum instance with a corresponding tag id ordinal.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
#define JFR_LOG_TAG_SET_LIST \
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
  JFR_LOG_TAG(jfr) \
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
  JFR_LOG_TAG(jfr, system) \
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
  JFR_LOG_TAG(jfr, system, event) \
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
  JFR_LOG_TAG(jfr, system, setting) \
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
  JFR_LOG_TAG(jfr, system, bytecode) \
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
  JFR_LOG_TAG(jfr, system, parser) \
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
  JFR_LOG_TAG(jfr, system, metadata) \
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
  JFR_LOG_TAG(jfr, metadata) \
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
  JFR_LOG_TAG(jfr, event) \
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
  JFR_LOG_TAG(jfr, setting)
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
  /* NEW TAGS, DONT FORGET TO UPDATE JAVA SIDE */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
#endif // SHARE_VM_JFR_UTILITIES_JFRLOGTAGSETS_HPP