src/hotspot/share/utilities/defaultStream.hpp
author coleenp
Thu, 10 Jan 2019 15:13:51 -0500
changeset 53244 9807daeb47c4
parent 47216 71c04702a3d5
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:
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
     1
/*
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 47216
diff changeset
     2
 * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
489c9b5090e2 Initial load
duke
parents:
diff changeset
     4
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
489c9b5090e2 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
489c9b5090e2 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.
489c9b5090e2 Initial load
duke
parents:
diff changeset
     8
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
489c9b5090e2 Initial load
duke
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
489c9b5090e2 Initial load
duke
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
489c9b5090e2 Initial load
duke
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
489c9b5090e2 Initial load
duke
parents:
diff changeset
    13
 * accompanied this code).
489c9b5090e2 Initial load
duke
parents:
diff changeset
    14
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
489c9b5090e2 Initial load
duke
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
489c9b5090e2 Initial load
duke
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    18
 *
5547
f4b087cbb361 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 1
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f4b087cbb361 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 1
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
f4b087cbb361 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 1
diff changeset
    21
 * questions.
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    22
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
    23
 */
489c9b5090e2 Initial load
duke
parents:
diff changeset
    24
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 47216
diff changeset
    25
#ifndef SHARE_UTILITIES_DEFAULTSTREAM_HPP
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 47216
diff changeset
    26
#define SHARE_UTILITIES_DEFAULTSTREAM_HPP
7397
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    27
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    28
#include "utilities/xmlstream.hpp"
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    29
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    30
class defaultStream : public xmlTextStream {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    31
  friend void ostream_abort();
489c9b5090e2 Initial load
duke
parents:
diff changeset
    32
 public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    33
  enum { NO_WRITER = -1 };
489c9b5090e2 Initial load
duke
parents:
diff changeset
    34
 private:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    35
  bool         _inited;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    36
  fileStream*  _log_file;  // XML-formatted file shared by all threads
489c9b5090e2 Initial load
duke
parents:
diff changeset
    37
  static int   _output_fd;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    38
  static int   _error_fd;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    39
  static FILE* _output_stream;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    40
  static FILE* _error_stream;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    41
489c9b5090e2 Initial load
duke
parents:
diff changeset
    42
  void init();
489c9b5090e2 Initial load
duke
parents:
diff changeset
    43
  void init_log();
28509
56efbcb555fb 8049253: Better GC validation
brutisso
parents: 7397
diff changeset
    44
  fileStream* open_file(const char* log_name);
56efbcb555fb 8049253: Better GC validation
brutisso
parents: 7397
diff changeset
    45
  void start_log();
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    46
  void finish_log();
489c9b5090e2 Initial load
duke
parents:
diff changeset
    47
  void finish_log_on_error(char *buf, int buflen);
489c9b5090e2 Initial load
duke
parents:
diff changeset
    48
 public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    49
  // must defer time stamp due to the fact that os::init() hasn't
489c9b5090e2 Initial load
duke
parents:
diff changeset
    50
  // yet been called and os::elapsed_counter() may not be valid
489c9b5090e2 Initial load
duke
parents:
diff changeset
    51
  defaultStream() {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    52
    _log_file = NULL;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    53
    _inited = false;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    54
    _writer = -1;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    55
    _last_writer = -1;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    56
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    57
489c9b5090e2 Initial load
duke
parents:
diff changeset
    58
  ~defaultStream() {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    59
    if (has_log_file())  finish_log();
489c9b5090e2 Initial load
duke
parents:
diff changeset
    60
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    61
489c9b5090e2 Initial load
duke
parents:
diff changeset
    62
  static inline FILE* output_stream() {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    63
    return DisplayVMOutputToStderr ? _error_stream : _output_stream;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    64
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    65
  static inline FILE* error_stream() {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    66
    return DisplayVMOutputToStdout ? _output_stream : _error_stream;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    67
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    68
  static inline int output_fd() {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    69
    return DisplayVMOutputToStderr ? _error_fd : _output_fd;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    70
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    71
  static inline int error_fd() {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    72
    return DisplayVMOutputToStdout ? _output_fd : _error_fd;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    73
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    74
489c9b5090e2 Initial load
duke
parents:
diff changeset
    75
  virtual void write(const char* s, size_t len);
489c9b5090e2 Initial load
duke
parents:
diff changeset
    76
489c9b5090e2 Initial load
duke
parents:
diff changeset
    77
  void flush() {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    78
    // once we can determine whether we are in a signal handler, we
489c9b5090e2 Initial load
duke
parents:
diff changeset
    79
    // should add the following assert here:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    80
    // assert(xxxxxx, "can not flush buffer inside signal handler");
489c9b5090e2 Initial load
duke
parents:
diff changeset
    81
    xmlTextStream::flush();
489c9b5090e2 Initial load
duke
parents:
diff changeset
    82
    fflush(output_stream());
489c9b5090e2 Initial load
duke
parents:
diff changeset
    83
    if (has_log_file()) _log_file->flush();
489c9b5090e2 Initial load
duke
parents:
diff changeset
    84
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    85
489c9b5090e2 Initial load
duke
parents:
diff changeset
    86
  // advisory lock/unlock of _writer field:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    87
 private:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    88
  intx _writer;    // thread_id with current rights to output
489c9b5090e2 Initial load
duke
parents:
diff changeset
    89
  intx _last_writer;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    90
 public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    91
  intx hold(intx writer_id);
489c9b5090e2 Initial load
duke
parents:
diff changeset
    92
  void release(intx holder);
489c9b5090e2 Initial load
duke
parents:
diff changeset
    93
  intx writer() { return _writer; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    94
  bool has_log_file();
489c9b5090e2 Initial load
duke
parents:
diff changeset
    95
489c9b5090e2 Initial load
duke
parents:
diff changeset
    96
  static defaultStream* instance;  // sole instance
489c9b5090e2 Initial load
duke
parents:
diff changeset
    97
};
7397
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    98
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 47216
diff changeset
    99
#endif // SHARE_UTILITIES_DEFAULTSTREAM_HPP