1 /*
2  * Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.
8  *
9  * This code is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * version 2 for more details (a copy is included in the LICENSE file that
13  * accompanied this code).
14  *
15  * You should have received a copy of the GNU General Public License version
16  * 2 along with this work; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20  * or visit www.oracle.com if you need additional information or have any
21  * questions.
22  *
23  */
24 
25 #ifndef SHARE_JFR_RECORDER_CHECKPOINT_JFRCHECKPOINTWRITER_HPP
26 #define SHARE_JFR_RECORDER_CHECKPOINT_JFRCHECKPOINTWRITER_HPP
27 
28 #include "jfr/recorder/storage/jfrBuffer.hpp"
29 #include "jfr/utilities/jfrBlob.hpp"
30 #include "jfr/utilities/jfrTime.hpp"
31 #include "jfr/utilities/jfrTypes.hpp"
32 #include "jfr/writers/jfrEventWriterHost.inline.hpp"
33 #include "jfr/writers/jfrMemoryWriterHost.inline.hpp"
34 #include "jfr/writers/jfrStorageAdapter.hpp"
35 
36 class Thread;
37 
38 class JfrCheckpointFlush : public StackObj {
39  public:
40   typedef JfrBuffer Type;
41   JfrCheckpointFlush(Type* old, size_t used, size_t requested, Thread* t);
result()42   Type* result() { return _result; }
43  private:
44   Type* _result;
45 };
46 
47 typedef Adapter<JfrCheckpointFlush> JfrCheckpointAdapter;
48 typedef AcquireReleaseMemoryWriterHost<JfrCheckpointAdapter, StackObj > JfrTransactionalCheckpointWriter;
49 typedef EventWriterHost<BigEndianEncoder, CompressedIntegerEncoder, JfrTransactionalCheckpointWriter> JfrCheckpointWriterBase;
50 
51 struct JfrCheckpointContext {
52   int64_t offset;
53   u4 count;
54 };
55 
56 class JfrCheckpointWriter : public JfrCheckpointWriterBase {
57   friend class JfrCheckpointManager;
58   friend class JfrSerializerRegistration;
59   friend class JfrTypeManager;
60  private:
61   JfrTicks _time;
62   int64_t _offset;
63   u4 _count;
64   JfrCheckpointType _type;
65   bool _header;
66 
67   u4 count() const;
68   void set_count(u4 count);
69   void increment();
70   const u1* session_data(size_t* size, bool move = false, const JfrCheckpointContext* ctx = NULL);
71   void release();
72   JfrCheckpointWriter(bool previous_epoch, Thread* thread, JfrCheckpointType type = GENERIC);
73  public:
74   JfrCheckpointWriter(JfrCheckpointType type = GENERIC);
75   JfrCheckpointWriter(Thread* thread, bool header = true, JfrCheckpointType mode = GENERIC, bool global_lease = true);
76   ~JfrCheckpointWriter();
77   void write_type(JfrTypeId type_id);
78   void write_count(u4 nof_entries);
79   void write_count(u4 nof_entries, int64_t offset);
80   void write_key(u8 key);
81   const JfrCheckpointContext context() const;
82   void set_context(const JfrCheckpointContext ctx);
83   bool has_data() const;
84   JfrBlobHandle copy(const JfrCheckpointContext* ctx = NULL);
85   JfrBlobHandle move(const JfrCheckpointContext* ctx = NULL);
86 };
87 
88 #endif // SHARE_JFR_RECORDER_CHECKPOINT_JFRCHECKPOINTWRITER_HPP
89