src/hotspot/share/jfr/recorder/repository/jfrRepository.hpp
author mgronlun
Wed, 30 Oct 2019 19:43:52 +0100
changeset 58863 c16ac7a2eba4
parent 53897 0abec72a3ac2
child 59226 a0f39cc47387
permissions -rw-r--r--
8226511: Implement JFR Event Streaming Reviewed-by: egahlin, mseledtsov, mgronlun Contributed-by: erik.gahlin@oracle.com, mikhailo.seledtsov@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
/*
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 50113
diff changeset
     2
 * Copyright (c) 2012, 2019, Oracle and/or its affiliates. All rights reserved.
50113
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
 */
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 50113
diff changeset
    24
#ifndef SHARE_JFR_RECORDER_REPOSITORY_JFRREPOSITORY_HPP
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 50113
diff changeset
    25
#define SHARE_JFR_RECORDER_REPOSITORY_JFRREPOSITORY_HPP
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    26
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
#include "jni.h"
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
#include "jfr/utilities/jfrAllocation.hpp"
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
class JfrChunkWriter;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
class JfrPostBox;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
//
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
// Represents the location on disk where internal files, "chunks", are stored.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
//
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
// A "chunk" is a self-contained file artifact storing events and metadata that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
// has been moved out of process memory.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
//
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
// Chunk files are associated with recordings and are managed at a higher level in Java.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
// Java continously keeps the VM informed about new chunk locations via set_chunk_path().
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
//
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
// A JfrChunkWriter will open the next chunk file which it maintains as the current chunk.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
// There is a rotation scheme in place for creating new chunks at certain intervals.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
//
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
class JfrRepository : public JfrCHeapObj {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
  friend class JfrRecorder;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
  friend class JfrRecorderService;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
 private:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
  char* _path;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
  JfrPostBox& _post_box;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
  JfrRepository(JfrPostBox& post_box);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
  ~JfrRepository();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
  bool set_path(const char* path);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
  void set_chunk_path(const char* path);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
  bool open_chunk(bool vm_error = false);
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 53897
diff changeset
    58
  size_t close_chunk();
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 53897
diff changeset
    59
  size_t flush_chunk();
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
  void on_vm_error();
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 53897
diff changeset
    61
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
  static void notify_on_new_chunk_path();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
  static JfrChunkWriter& chunkwriter();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
  static JfrRepository& instance();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
  static JfrRepository* create(JfrPostBox& post_box);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
  bool initialize();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
  static void destroy();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
  static void set_path(jstring location, JavaThread* jt);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
  static void set_chunk_path(jstring path, JavaThread* jt);
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 53897
diff changeset
    73
  static void flush(JavaThread* jt);
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 53897
diff changeset
    74
  static jlong current_chunk_start_nanos();
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 50113
diff changeset
    77
#endif // SHARE_JFR_RECORDER_REPOSITORY_JFRREPOSITORY_HPP