1 /*
 2  * Copyright (c) 2025, 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_PERIODIC_SAMPLING_JFRSAMPLEREQUEST_HPP
26 #define SHARE_JFR_PERIODIC_SAMPLING_JFRSAMPLEREQUEST_HPP
27 
28 #include "jfr/utilities/jfrTime.hpp"
29 #include "memory/allocation.hpp"
30 #include "utilities/growableArray.hpp"
31 
32 class JavaThread;
33 class JfrThreadLocal;
34 
35 enum JfrSampleResult {
36   THREAD_SUSPENSION_ERROR,
37   WRONG_THREAD_STATE,
38   UNPARSABLE_TOP_FRAME,
39   INVALID_STACK_TRACE,
40   CRASH,
41   NO_LAST_JAVA_FRAME,
42   UNKNOWN,
43   FAIL,
44   SKIP,
45   SAMPLE_NATIVE,
46   SAMPLE_JAVA,
47   NOF_SAMPLING_RESULTS
48 };
49 
50 enum JfrSampleRequestType {
51   NO_SAMPLE,
52   JAVA_SAMPLE,
53   NATIVE_SAMPLE,
54   WAITING_FOR_NATIVE_SAMPLE,
55   NOF_SAMPLE_STATES
56 };
57 
58 struct JfrSampleRequest {
59   void* _sample_sp;
60   void* _sample_pc;
61   void* _sample_bcp;
62   JfrTicks _sample_ticks;
63 
64   JfrSampleRequest() :
65     _sample_sp(nullptr),
66     _sample_pc(nullptr),
67     _sample_bcp(nullptr),
68     _sample_ticks() {}
69 
70   JfrSampleRequest(const JfrTicks& ticks) :
71     _sample_sp(nullptr),
72     _sample_pc(nullptr),
73     _sample_bcp(nullptr),
74     _sample_ticks(ticks) {}
75 };
76 
77 typedef GrowableArrayCHeap<JfrSampleRequest, mtTracing> JfrSampleRequestQueue;
78 
79 class JfrSampleRequestBuilder : AllStatic {
80  public:
81   static JfrSampleResult build_java_sample_request(const void* ucontext,
82                                                    JfrThreadLocal* tl,
83                                                    JavaThread* jt);
84   static void build_cpu_time_sample_request(JfrSampleRequest &request,
85                                             void* ucontext,
86                                             JavaThread* jt,
87                                             JfrThreadLocal* tl,
88                                             JfrTicks& now);
89 };
90 
91 #endif // SHARE_JFR_PERIODIC_SAMPLING_JFRSAMPLEREQUEST_HPP