hotspot/src/share/vm/logging/logOutput.hpp
author mlarsson
Mon, 11 Apr 2016 12:22:09 +0200
changeset 37465 1d5551f466ee
parent 35230 a528ea8203ec
child 38263 a7488329ad27
permissions -rw-r--r--
8146879: Add option for handling existing log files in UL Reviewed-by: dsamersoff, gziemski, rehn
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33097
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
     1
/*
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
     2
 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
     4
 *
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
     7
 * published by the Free Software Foundation.
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
     8
 *
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    13
 * accompanied this code).
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    14
 *
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    18
 *
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    21
 * questions.
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    22
 *
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    23
 */
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    24
#ifndef SHARE_VM_LOGGING_LOGOUTPUT_HPP
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    25
#define SHARE_VM_LOGGING_LOGOUTPUT_HPP
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    26
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    27
#include "logging/logDecorators.hpp"
34316
4d876653d940 8142952: Unified Logging framework does not allow multiple -Xlog: arguments.
mlarsson
parents: 33097
diff changeset
    28
#include "logging/logLevel.hpp"
33097
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    29
#include "memory/allocation.hpp"
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    30
#include "utilities/globalDefinitions.hpp"
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    31
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    32
class LogDecorations;
34316
4d876653d940 8142952: Unified Logging framework does not allow multiple -Xlog: arguments.
mlarsson
parents: 33097
diff changeset
    33
class LogTagSet;
33097
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    34
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    35
// The base class/interface for log outputs.
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    36
// Keeps track of the latest configuration string,
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    37
// and its selected decorators.
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    38
class LogOutput : public CHeapObj<mtLogging> {
35228
e7bbfb90fd31 8145083: Use semaphore instead of mutex for synchronization of Unified Logging configuration
mlarsson
parents: 34637
diff changeset
    39
  // Make LogConfiguration a friend to allow it to modify the configuration string.
e7bbfb90fd31 8145083: Use semaphore instead of mutex for synchronization of Unified Logging configuration
mlarsson
parents: 34637
diff changeset
    40
  friend class LogConfiguration;
e7bbfb90fd31 8145083: Use semaphore instead of mutex for synchronization of Unified Logging configuration
mlarsson
parents: 34637
diff changeset
    41
34316
4d876653d940 8142952: Unified Logging framework does not allow multiple -Xlog: arguments.
mlarsson
parents: 33097
diff changeset
    42
 private:
4d876653d940 8142952: Unified Logging framework does not allow multiple -Xlog: arguments.
mlarsson
parents: 33097
diff changeset
    43
  static const size_t InitialConfigBufferSize = 256;
4d876653d940 8142952: Unified Logging framework does not allow multiple -Xlog: arguments.
mlarsson
parents: 33097
diff changeset
    44
  char* _config_string;
4d876653d940 8142952: Unified Logging framework does not allow multiple -Xlog: arguments.
mlarsson
parents: 33097
diff changeset
    45
  size_t _config_string_buffer_size;
4d876653d940 8142952: Unified Logging framework does not allow multiple -Xlog: arguments.
mlarsson
parents: 33097
diff changeset
    46
33097
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    47
 protected:
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    48
  LogDecorators _decorators;
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    49
35228
e7bbfb90fd31 8145083: Use semaphore instead of mutex for synchronization of Unified Logging configuration
mlarsson
parents: 34637
diff changeset
    50
  // Clears any previous config description in preparation of reconfiguration.
e7bbfb90fd31 8145083: Use semaphore instead of mutex for synchronization of Unified Logging configuration
mlarsson
parents: 34637
diff changeset
    51
  void clear_config_string();
e7bbfb90fd31 8145083: Use semaphore instead of mutex for synchronization of Unified Logging configuration
mlarsson
parents: 34637
diff changeset
    52
  // Adds the tagset on the given level to the config description (e.g. "tag1+tag2=level").
e7bbfb90fd31 8145083: Use semaphore instead of mutex for synchronization of Unified Logging configuration
mlarsson
parents: 34637
diff changeset
    53
  void add_to_config_string(const LogTagSet* ts, LogLevelType level);
e7bbfb90fd31 8145083: Use semaphore instead of mutex for synchronization of Unified Logging configuration
mlarsson
parents: 34637
diff changeset
    54
  // Replaces the current config description with the given string.
e7bbfb90fd31 8145083: Use semaphore instead of mutex for synchronization of Unified Logging configuration
mlarsson
parents: 34637
diff changeset
    55
  void set_config_string(const char* string);
e7bbfb90fd31 8145083: Use semaphore instead of mutex for synchronization of Unified Logging configuration
mlarsson
parents: 34637
diff changeset
    56
33097
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    57
 public:
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    58
  static LogOutput* const Stdout;
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    59
  static LogOutput* const Stderr;
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    60
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    61
  void set_decorators(const LogDecorators &decorators) {
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    62
    _decorators = decorators;
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    63
  }
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    64
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    65
  const LogDecorators& decorators() const {
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    66
    return _decorators;
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    67
  }
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    68
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    69
  const char* config_string() const {
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    70
    return _config_string;
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    71
  }
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    72
34316
4d876653d940 8142952: Unified Logging framework does not allow multiple -Xlog: arguments.
mlarsson
parents: 33097
diff changeset
    73
  LogOutput() : _config_string(NULL), _config_string_buffer_size(0) {
33097
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    74
  }
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    75
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    76
  virtual ~LogOutput();
34316
4d876653d940 8142952: Unified Logging framework does not allow multiple -Xlog: arguments.
mlarsson
parents: 33097
diff changeset
    77
35230
a528ea8203ec 8145294: TestLogRotation.java triggers a race in the UL framework
mlarsson
parents: 35228
diff changeset
    78
  // If the output can be rotated, trigger a forced rotation, otherwise do nothing.
a528ea8203ec 8145294: TestLogRotation.java triggers a race in the UL framework
mlarsson
parents: 35228
diff changeset
    79
  // Log outputs with rotation capabilities should override this.
a528ea8203ec 8145294: TestLogRotation.java triggers a race in the UL framework
mlarsson
parents: 35228
diff changeset
    80
  virtual void force_rotate() {
a528ea8203ec 8145294: TestLogRotation.java triggers a race in the UL framework
mlarsson
parents: 35228
diff changeset
    81
    // Do nothing by default.
a528ea8203ec 8145294: TestLogRotation.java triggers a race in the UL framework
mlarsson
parents: 35228
diff changeset
    82
  }
a528ea8203ec 8145294: TestLogRotation.java triggers a race in the UL framework
mlarsson
parents: 35228
diff changeset
    83
33097
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    84
  virtual const char* name() const = 0;
37465
1d5551f466ee 8146879: Add option for handling existing log files in UL
mlarsson
parents: 35230
diff changeset
    85
  virtual bool initialize(const char* options, outputStream* errstream) = 0;
33097
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    86
  virtual int write(const LogDecorations &decorations, const char* msg) = 0;
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    87
};
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    88
96e348cb0442 8046148: JEP 158: Unified JVM Logging
mlarsson
parents:
diff changeset
    89
#endif // SHARE_VM_LOGGING_LOGOUTPUT_HPP