ddtrace 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +4 -16
- data/CHANGELOG.md +31 -2
- data/LICENSE-3rdparty.csv +3 -2
- data/README.md +2 -2
- data/ddtrace.gemspec +12 -3
- data/docs/GettingStarted.md +19 -2
- data/docs/ProfilingDevelopment.md +8 -8
- data/docs/UpgradeGuide.md +3 -3
- data/ext/ddtrace_profiling_loader/ddtrace_profiling_loader.c +118 -0
- data/ext/ddtrace_profiling_loader/extconf.rb +53 -0
- data/ext/ddtrace_profiling_native_extension/NativeExtensionDesign.md +31 -5
- data/ext/ddtrace_profiling_native_extension/clock_id_from_pthread.c +0 -8
- data/ext/ddtrace_profiling_native_extension/collectors_stack.c +278 -0
- data/ext/ddtrace_profiling_native_extension/extconf.rb +70 -100
- data/ext/ddtrace_profiling_native_extension/libddprof_helpers.h +13 -0
- data/ext/ddtrace_profiling_native_extension/native_extension_helpers.rb +186 -0
- data/ext/ddtrace_profiling_native_extension/private_vm_api_access.c +579 -7
- data/ext/ddtrace_profiling_native_extension/private_vm_api_access.h +30 -0
- data/ext/ddtrace_profiling_native_extension/profiling.c +7 -0
- data/ext/ddtrace_profiling_native_extension/stack_recorder.c +139 -0
- data/ext/ddtrace_profiling_native_extension/stack_recorder.h +28 -0
- data/lib/datadog/appsec/autoload.rb +2 -2
- data/lib/datadog/appsec/configuration/settings.rb +19 -0
- data/lib/datadog/appsec/configuration.rb +8 -0
- data/lib/datadog/appsec/contrib/rack/gateway/watcher.rb +76 -33
- data/lib/datadog/appsec/contrib/rack/integration.rb +1 -0
- data/lib/datadog/appsec/contrib/rack/patcher.rb +0 -1
- data/lib/datadog/appsec/contrib/rack/reactive/request_body.rb +64 -0
- data/lib/datadog/appsec/contrib/rack/request.rb +6 -0
- data/lib/datadog/appsec/contrib/rack/request_body_middleware.rb +41 -0
- data/lib/datadog/appsec/contrib/rack/request_middleware.rb +60 -5
- data/lib/datadog/appsec/contrib/rails/gateway/watcher.rb +81 -0
- data/lib/datadog/appsec/contrib/rails/patcher.rb +34 -1
- data/lib/datadog/appsec/contrib/rails/reactive/action.rb +68 -0
- data/lib/datadog/appsec/contrib/rails/request.rb +33 -0
- data/lib/datadog/appsec/contrib/sinatra/gateway/watcher.rb +124 -0
- data/lib/datadog/appsec/contrib/sinatra/patcher.rb +69 -2
- data/lib/datadog/appsec/contrib/sinatra/reactive/routed.rb +63 -0
- data/lib/datadog/appsec/event.rb +33 -18
- data/lib/datadog/appsec/extensions.rb +0 -3
- data/lib/datadog/appsec/processor.rb +45 -2
- data/lib/datadog/appsec/rate_limiter.rb +5 -0
- data/lib/datadog/appsec/reactive/operation.rb +0 -1
- data/lib/datadog/ci/ext/environment.rb +21 -7
- data/lib/datadog/core/configuration/agent_settings_resolver.rb +1 -1
- data/lib/datadog/core/configuration/components.rb +22 -4
- data/lib/datadog/core/configuration/settings.rb +3 -3
- data/lib/datadog/core/configuration.rb +7 -5
- data/lib/datadog/core/environment/cgroup.rb +3 -1
- data/lib/datadog/core/environment/container.rb +2 -1
- data/lib/datadog/core/environment/variable_helpers.rb +26 -2
- data/lib/datadog/core/logging/ext.rb +11 -0
- data/lib/datadog/core/metrics/client.rb +15 -5
- data/lib/datadog/core/runtime/metrics.rb +1 -1
- data/lib/datadog/core/workers/async.rb +3 -1
- data/lib/datadog/core/workers/runtime_metrics.rb +0 -3
- data/lib/datadog/core.rb +6 -0
- data/lib/datadog/kit/enable_core_dumps.rb +50 -0
- data/lib/datadog/kit/identity.rb +63 -0
- data/lib/datadog/kit.rb +11 -0
- data/lib/datadog/opentracer/tracer.rb +0 -2
- data/lib/datadog/profiling/collectors/old_stack.rb +298 -0
- data/lib/datadog/profiling/collectors/stack.rb +6 -287
- data/lib/datadog/profiling/encoding/profile.rb +0 -1
- data/lib/datadog/profiling/ext.rb +1 -1
- data/lib/datadog/profiling/flush.rb +1 -1
- data/lib/datadog/profiling/load_native_extension.rb +22 -0
- data/lib/datadog/profiling/recorder.rb +1 -1
- data/lib/datadog/profiling/scheduler.rb +1 -1
- data/lib/datadog/profiling/stack_recorder.rb +33 -0
- data/lib/datadog/profiling/tag_builder.rb +48 -0
- data/lib/datadog/profiling/tasks/exec.rb +2 -2
- data/lib/datadog/profiling/tasks/setup.rb +6 -4
- data/lib/datadog/profiling.rb +29 -27
- data/lib/datadog/tracing/buffer.rb +9 -3
- data/lib/datadog/tracing/contrib/action_view/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/active_record/configuration/resolver.rb +2 -2
- data/lib/datadog/tracing/contrib/active_record/utils.rb +1 -1
- data/lib/datadog/tracing/contrib/active_record/vendor/connection_specification.rb +1 -1
- data/lib/datadog/tracing/contrib/active_support/notifications/subscription.rb +4 -2
- data/lib/datadog/tracing/contrib/concurrent_ruby/context_composite_executor_service.rb +10 -3
- data/lib/datadog/tracing/contrib/dalli/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/delayed_job/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/elasticsearch/integration.rb +9 -3
- data/lib/datadog/tracing/contrib/elasticsearch/patcher.rb +38 -2
- data/lib/datadog/tracing/contrib/ethon/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/extensions.rb +0 -2
- data/lib/datadog/tracing/contrib/faraday/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/grape/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/graphql/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/grpc/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/kafka/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/lograge/instrumentation.rb +2 -1
- data/lib/datadog/tracing/contrib/qless/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/que/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/racecar/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/rails/log_injection.rb +3 -16
- data/lib/datadog/tracing/contrib/rake/instrumentation.rb +2 -2
- data/lib/datadog/tracing/contrib/rake/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/redis/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/resque/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/rest_client/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/semantic_logger/instrumentation.rb +2 -1
- data/lib/datadog/tracing/contrib/sidekiq/configuration/settings.rb +1 -0
- data/lib/datadog/tracing/contrib/sidekiq/server_tracer.rb +20 -1
- data/lib/datadog/tracing/contrib/sinatra/framework.rb +11 -0
- data/lib/datadog/tracing/contrib/sinatra/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/sneakers/patcher.rb +0 -1
- data/lib/datadog/tracing/contrib/sucker_punch/patcher.rb +0 -1
- data/lib/datadog/tracing/event.rb +2 -1
- data/lib/datadog/tracing/sampling/priority_sampler.rb +4 -5
- data/lib/datadog/tracing/sampling/rule.rb +12 -6
- data/lib/datadog/tracing/sampling/rule_sampler.rb +3 -5
- data/lib/datadog/tracing/span_operation.rb +2 -3
- data/lib/datadog/tracing/trace_operation.rb +0 -1
- data/lib/ddtrace/transport/http/client.rb +2 -1
- data/lib/ddtrace/transport/http/response.rb +34 -4
- data/lib/ddtrace/transport/io/client.rb +3 -1
- data/lib/ddtrace/version.rb +1 -1
- data/lib/ddtrace.rb +1 -0
- metadata +43 -6
@@ -8,14 +8,18 @@
|
|
8
8
|
//
|
9
9
|
// In the meanwhile, be very careful when changing things here :)
|
10
10
|
|
11
|
-
#ifdef
|
12
|
-
// Pick up internal structures from the private Ruby MJIT header file
|
13
|
-
#include RUBY_MJIT_HEADER
|
11
|
+
#ifdef RUBY_MJIT_HEADER
|
12
|
+
// Pick up internal structures from the private Ruby MJIT header file
|
13
|
+
#include RUBY_MJIT_HEADER
|
14
14
|
#else
|
15
|
-
// On older Rubies, use a copy of the VM internal headers shipped in the debase-ruby_core_source gem
|
16
|
-
#include <vm_core.h>
|
15
|
+
// On older Rubies, use a copy of the VM internal headers shipped in the debase-ruby_core_source gem
|
16
|
+
#include <vm_core.h>
|
17
|
+
#include <iseq.h>
|
17
18
|
#endif
|
18
19
|
|
20
|
+
#define PRIVATE_VM_API_ACCESS_SKIP_RUBY_INCLUDES
|
21
|
+
#include "private_vm_api_access.h"
|
22
|
+
|
19
23
|
// MRI has a similar rb_thread_ptr() function which we can't call it directly
|
20
24
|
// because Ruby does not expose the thread_data_type publicly.
|
21
25
|
// Instead, we have our own version of that function, and we lazily initialize the thread_data_type pointer
|
@@ -23,13 +27,581 @@
|
|
23
27
|
//
|
24
28
|
// Note that beyond returning the rb_thread_struct*, rb_check_typeddata() raises an exception
|
25
29
|
// if the argument passed in is not actually a `Thread` instance.
|
26
|
-
static inline
|
30
|
+
static inline rb_thread_t *thread_struct_from_object(VALUE thread) {
|
27
31
|
static const rb_data_type_t *thread_data_type = NULL;
|
28
32
|
if (thread_data_type == NULL) thread_data_type = RTYPEDDATA_TYPE(rb_thread_current());
|
29
33
|
|
30
|
-
return (
|
34
|
+
return (rb_thread_t *) rb_check_typeddata(thread, thread_data_type);
|
31
35
|
}
|
32
36
|
|
33
37
|
rb_nativethread_id_t pthread_id_for(VALUE thread) {
|
34
38
|
return thread_struct_from_object(thread)->thread_id;
|
35
39
|
}
|
40
|
+
|
41
|
+
// Returns the stack depth by using the same approach as rb_profile_frames and backtrace_each: get the positions
|
42
|
+
// of the end and current frame pointers and subtracting them.
|
43
|
+
ptrdiff_t stack_depth_for(VALUE thread) {
|
44
|
+
#ifndef USE_THREAD_INSTEAD_OF_EXECUTION_CONTEXT // Modern Rubies
|
45
|
+
const rb_execution_context_t *ec = thread_struct_from_object(thread)->ec;
|
46
|
+
#else // Ruby < 2.5
|
47
|
+
const rb_thread_t *ec = thread_struct_from_object(thread);
|
48
|
+
#endif
|
49
|
+
|
50
|
+
const rb_control_frame_t *cfp = ec->cfp, *end_cfp = RUBY_VM_END_CONTROL_FRAME(ec);
|
51
|
+
|
52
|
+
if (end_cfp == NULL) return 0;
|
53
|
+
|
54
|
+
// Skip dummy frame, as seen in `backtrace_each` (`vm_backtrace.c`) and our custom rb_profile_frames
|
55
|
+
// ( https://github.com/ruby/ruby/blob/4bd38e8120f2fdfdd47a34211720e048502377f1/vm_backtrace.c#L890-L914 )
|
56
|
+
end_cfp = RUBY_VM_NEXT_CONTROL_FRAME(end_cfp);
|
57
|
+
|
58
|
+
return end_cfp <= cfp ? 0 : end_cfp - cfp - 1;
|
59
|
+
}
|
60
|
+
|
61
|
+
// -----------------------------------------------------------------------------
|
62
|
+
// The sources below are modified versions of code extracted from the Ruby project.
|
63
|
+
// Each function is annotated with its origin, why we imported it, and the changes made.
|
64
|
+
//
|
65
|
+
// The Ruby project copyright and license follow:
|
66
|
+
// -----------------------------------------------------------------------------
|
67
|
+
// Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
|
68
|
+
//
|
69
|
+
// Redistribution and use in source and binary forms, with or without
|
70
|
+
// modification, are permitted provided that the following conditions
|
71
|
+
// are met:
|
72
|
+
// 1. Redistributions of source code must retain the above copyright
|
73
|
+
// notice, this list of conditions and the following disclaimer.
|
74
|
+
// 2. Redistributions in binary form must reproduce the above copyright
|
75
|
+
// notice, this list of conditions and the following disclaimer in the
|
76
|
+
// documentation and/or other materials provided with the distribution.
|
77
|
+
//
|
78
|
+
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
79
|
+
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
80
|
+
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
81
|
+
// ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
82
|
+
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
83
|
+
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
84
|
+
// OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
85
|
+
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
86
|
+
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
87
|
+
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
88
|
+
// SUCH DAMAGE.
|
89
|
+
|
90
|
+
#ifndef USE_LEGACY_RB_PROFILE_FRAMES // Modern Rubies
|
91
|
+
|
92
|
+
// Taken from upstream vm_core.h at commit 5f10bd634fb6ae8f74a4ea730176233b0ca96954 (March 2022, Ruby 3.2 trunk)
|
93
|
+
// Copyright (C) 2004-2007 Koichi Sasada
|
94
|
+
// to support our custom rb_profile_frames (see below)
|
95
|
+
// Modifications: None
|
96
|
+
#define ISEQ_BODY(iseq) ((iseq)->body)
|
97
|
+
|
98
|
+
// Taken from upstream vm_backtrace.c at commit 5f10bd634fb6ae8f74a4ea730176233b0ca96954 (March 2022, Ruby 3.2 trunk)
|
99
|
+
// Copyright (C) 1993-2012 Yukihiro Matsumoto
|
100
|
+
// to support our custom rb_profile_frames (see below)
|
101
|
+
// Modifications: None
|
102
|
+
inline static int
|
103
|
+
calc_pos(const rb_iseq_t *iseq, const VALUE *pc, int *lineno, int *node_id)
|
104
|
+
{
|
105
|
+
VM_ASSERT(iseq);
|
106
|
+
VM_ASSERT(ISEQ_BODY(iseq));
|
107
|
+
VM_ASSERT(ISEQ_BODY(iseq)->iseq_encoded);
|
108
|
+
VM_ASSERT(ISEQ_BODY(iseq)->iseq_size);
|
109
|
+
if (! pc) {
|
110
|
+
if (ISEQ_BODY(iseq)->type == ISEQ_TYPE_TOP) {
|
111
|
+
VM_ASSERT(! ISEQ_BODY(iseq)->local_table);
|
112
|
+
VM_ASSERT(! ISEQ_BODY(iseq)->local_table_size);
|
113
|
+
return 0;
|
114
|
+
}
|
115
|
+
if (lineno) *lineno = FIX2INT(ISEQ_BODY(iseq)->location.first_lineno);
|
116
|
+
#ifdef USE_ISEQ_NODE_ID
|
117
|
+
if (node_id) *node_id = -1;
|
118
|
+
#endif
|
119
|
+
return 1;
|
120
|
+
}
|
121
|
+
else {
|
122
|
+
ptrdiff_t n = pc - ISEQ_BODY(iseq)->iseq_encoded;
|
123
|
+
VM_ASSERT(n <= ISEQ_BODY(iseq)->iseq_size);
|
124
|
+
VM_ASSERT(n >= 0);
|
125
|
+
ASSUME(n >= 0);
|
126
|
+
size_t pos = n; /* no overflow */
|
127
|
+
if (LIKELY(pos)) {
|
128
|
+
/* use pos-1 because PC points next instruction at the beginning of instruction */
|
129
|
+
pos--;
|
130
|
+
}
|
131
|
+
#if VMDEBUG && defined(HAVE_BUILTIN___BUILTIN_TRAP)
|
132
|
+
else {
|
133
|
+
/* SDR() is not possible; that causes infinite loop. */
|
134
|
+
rb_print_backtrace();
|
135
|
+
__builtin_trap();
|
136
|
+
}
|
137
|
+
#endif
|
138
|
+
if (lineno) *lineno = rb_iseq_line_no(iseq, pos);
|
139
|
+
#ifdef USE_ISEQ_NODE_ID
|
140
|
+
if (node_id) *node_id = rb_iseq_node_id(iseq, pos);
|
141
|
+
#endif
|
142
|
+
return 1;
|
143
|
+
}
|
144
|
+
}
|
145
|
+
|
146
|
+
// Taken from upstream vm_backtrace.c at commit 5f10bd634fb6ae8f74a4ea730176233b0ca96954 (March 2022, Ruby 3.2 trunk)
|
147
|
+
// Copyright (C) 1993-2012 Yukihiro Matsumoto
|
148
|
+
// to support our custom rb_profile_frames (see below)
|
149
|
+
// Modifications: None
|
150
|
+
inline static int
|
151
|
+
calc_lineno(const rb_iseq_t *iseq, const VALUE *pc)
|
152
|
+
{
|
153
|
+
int lineno;
|
154
|
+
if (calc_pos(iseq, pc, &lineno, NULL)) return lineno;
|
155
|
+
return 0;
|
156
|
+
}
|
157
|
+
|
158
|
+
// Taken from upstream vm_backtrace.c at commit 5f10bd634fb6ae8f74a4ea730176233b0ca96954 (March 2022, Ruby 3.2 trunk)
|
159
|
+
// Copyright (C) 1993-2012 Yukihiro Matsumoto
|
160
|
+
// Modifications:
|
161
|
+
// * Renamed rb_profile_frames => ddtrace_rb_profile_frames
|
162
|
+
// * Add thread argument
|
163
|
+
// * Add is_ruby_frame argument
|
164
|
+
// * Removed `if (lines)` tests -- require/assume that like `buff`, `lines` is always specified
|
165
|
+
// * Support Ruby < 2.5 by using rb_thread_t instead of rb_execution_context_t (which did not exist and was just
|
166
|
+
// part of rb_thread_t)
|
167
|
+
// * Support Ruby < 2.4 by using `RUBY_VM_NORMAL_ISEQ_P(cfp->iseq)` instead of `VM_FRAME_RUBYFRAME_P(cfp)`.
|
168
|
+
// Given that the Ruby 2.3 version of `rb_profile_frames` did not support native methods and thus did not need this
|
169
|
+
// check, how did I figure out what to replace it with? I did it by looking at other places in the VM code where the
|
170
|
+
// code looks exactly the same but Ruby 2.4 uses `VM_FRAME_RUBYFRAME_P` whereas Ruby 2.3 used `RUBY_VM_NORMAL_ISEQ_P`.
|
171
|
+
// Examples of these are `errinfo_place` in `eval.c`, `rb_vm_get_ruby_level_next_cfp` (among others) in `vm.c`, etc.
|
172
|
+
// * Skip dummy frame that shows up in main thread
|
173
|
+
// * Add `end_cfp == NULL` and `end_cfp <= cfp` safety checks. These are used in a bunch of places in
|
174
|
+
// `vm_backtrace.c` (`backtrace_each`, `backtrace_size`, `rb_ec_partial_backtrace_object`) but are conspicuously
|
175
|
+
// absent from `rb_profile_frames`. Oversight?
|
176
|
+
// * Distinguish between `end_cfp == NULL` (dead thread or some other error, returns 0) and `end_cfp <= cfp`
|
177
|
+
// (alive thread which may just be executing native code and has not pushed anything on the Ruby stack, returns
|
178
|
+
// PLACEHOLDER_STACK_IN_NATIVE_CODE). See comments on `record_placeholder_stack_in_native_code` for more details.
|
179
|
+
// * Skip frames where `cfp->iseq && !cfp->pc`. These seem to be internal and are skipped by `backtrace_each` in
|
180
|
+
// `vm_backtrace.c`.
|
181
|
+
// * Check thread status and do not sample if thread has been killed.
|
182
|
+
// * Match Ruby reference stack trace APIs that use the iseq instead of the callable method entry to get information
|
183
|
+
// for iseqs created from calls to `eval` and `instance_eval`. This makes it so that `rb_profile_frame_path` on
|
184
|
+
// the `VALUE` returned by rb_profile_frames returns `(eval)` instead of the path of the file where the `eval`
|
185
|
+
// was called from.
|
186
|
+
//
|
187
|
+
// **IMPORTANT: WHEN CHANGING THIS FUNCTION, CONSIDER IF THE SAME CHANGE ALSO NEEDS TO BE MADE TO THE VARIANT FOR
|
188
|
+
// RUBY 2.2 AND BELOW WHICH IS ALSO PRESENT ON THIS FILE**
|
189
|
+
//
|
190
|
+
// What is rb_profile_frames?
|
191
|
+
// `rb_profile_frames` is a Ruby VM debug API added for use by profilers for sampling the stack trace of a Ruby thread.
|
192
|
+
// Its main other user is the stackprof profiler: https://github.com/tmm1/stackprof .
|
193
|
+
//
|
194
|
+
// Why do we need a custom version of rb_profile_frames?
|
195
|
+
//
|
196
|
+
// There are a few reasons:
|
197
|
+
// 1. To backport improved behavior to older Rubies. Prior to Ruby 3.0 (https://github.com/ruby/ruby/pull/3299),
|
198
|
+
// rb_profile_frames skipped CFUNC frames, aka frames that are implemented with native code, and thus the resulting
|
199
|
+
// stacks were quite incomplete as a big part of the Ruby standard library is implemented with native code.
|
200
|
+
//
|
201
|
+
// 2. To extend this function to work with any thread. The upstream rb_profile_frames function only targets the current
|
202
|
+
// thread, and to support wall-clock profiling we require sampling other threads. This is only safe because of the
|
203
|
+
// Global VM Lock. (We don't yet support sampling Ractors beyond the main one; we'll need to find a way to do it
|
204
|
+
// safely first.)
|
205
|
+
//
|
206
|
+
// 3. To get more information out of the Ruby VM. The Ruby VM has a lot more information than is exposed through
|
207
|
+
// rb_profile_frames, and by making our own copy of this function we can extract more of this information.
|
208
|
+
// See for backtracie gem (https://github.com/ivoanjo/backtracie) for an exploration of what can potentially be done.
|
209
|
+
//
|
210
|
+
// 4. Because we haven't yet submitted patches to upstream Ruby. As with any changes on the `private_vm_api_access.c`,
|
211
|
+
// our medium/long-term plan is to contribute upstream changes and make it so that we don't need any of this
|
212
|
+
// on modern Rubies.
|
213
|
+
//
|
214
|
+
// 5. To make rb_profile_frames behave more like the Ruby-level reference stack trace APIs (`Thread#backtrace_locations`
|
215
|
+
// and friends). We've found quite a few situations where the data from rb_profile_frames and the reference APIs
|
216
|
+
// disagree, and quite a few of them seem oversights/bugs (speculation from my part) rather than deliberate
|
217
|
+
// decisions.
|
218
|
+
int ddtrace_rb_profile_frames(VALUE thread, int start, int limit, VALUE *buff, int *lines, bool* is_ruby_frame)
|
219
|
+
{
|
220
|
+
int i;
|
221
|
+
// Modified from upstream: Instead of using `GET_EC` to collect info from the current thread,
|
222
|
+
// support sampling any thread (including the current) passed as an argument
|
223
|
+
rb_thread_t *th = thread_struct_from_object(thread);
|
224
|
+
#ifndef USE_THREAD_INSTEAD_OF_EXECUTION_CONTEXT // Modern Rubies
|
225
|
+
const rb_execution_context_t *ec = th->ec;
|
226
|
+
#else // Ruby < 2.5
|
227
|
+
const rb_thread_t *ec = th;
|
228
|
+
#endif
|
229
|
+
const rb_control_frame_t *cfp = ec->cfp, *end_cfp = RUBY_VM_END_CONTROL_FRAME(ec);
|
230
|
+
const rb_callable_method_entry_t *cme;
|
231
|
+
|
232
|
+
// `vm_backtrace.c` includes this check in several methods, and I think this happens on either dead or newly-created
|
233
|
+
// threads, but I'm not entirely sure
|
234
|
+
if (end_cfp == NULL) return 0;
|
235
|
+
|
236
|
+
// Avoid sampling dead threads
|
237
|
+
if (th->status == THREAD_KILLED) return 0;
|
238
|
+
|
239
|
+
// Fix: Skip dummy frame that shows up in main thread.
|
240
|
+
//
|
241
|
+
// According to a comment in `backtrace_each` (`vm_backtrace.c`), there's two dummy frames that we should ignore
|
242
|
+
// at the base of every thread's stack.
|
243
|
+
// (see https://github.com/ruby/ruby/blob/4bd38e8120f2fdfdd47a34211720e048502377f1/vm_backtrace.c#L890-L914 )
|
244
|
+
//
|
245
|
+
// One is being pointed to by `RUBY_VM_END_CONTROL_FRAME(ec)`, and so we need to advance to the next one, and
|
246
|
+
// reaching it will be used as a condition to break out of the loop below.
|
247
|
+
//
|
248
|
+
// Note that in `backtrace_each` there's two calls to `RUBY_VM_NEXT_CONTROL_FRAME`, but the loop bounds there
|
249
|
+
// are computed in a different way, so the two calls really are equivalent to one here.
|
250
|
+
end_cfp = RUBY_VM_NEXT_CONTROL_FRAME(end_cfp);
|
251
|
+
|
252
|
+
// See comment on `record_placeholder_stack_in_native_code` for a full explanation of what this means (and why we don't just return 0)
|
253
|
+
if (end_cfp <= cfp) return PLACEHOLDER_STACK_IN_NATIVE_CODE;
|
254
|
+
|
255
|
+
for (i=0; i<limit && cfp != end_cfp;) {
|
256
|
+
if (cfp->iseq && !cfp->pc) {
|
257
|
+
// Fix: Do nothing -- this frame should not be used
|
258
|
+
//
|
259
|
+
// rb_profile_frames does not do this check, but `backtrace_each` (`vm_backtrace.c`) does. This frame is not
|
260
|
+
// exposed by the Ruby backtrace APIs and for now we want to match its behavior 1:1
|
261
|
+
}
|
262
|
+
#ifndef USE_ISEQ_P_INSTEAD_OF_RUBYFRAME_P // Modern Rubies
|
263
|
+
else if (VM_FRAME_RUBYFRAME_P(cfp)) {
|
264
|
+
#else // Ruby < 2.4
|
265
|
+
else if (RUBY_VM_NORMAL_ISEQ_P(cfp->iseq)) {
|
266
|
+
#endif
|
267
|
+
if (start > 0) {
|
268
|
+
start--;
|
269
|
+
continue;
|
270
|
+
}
|
271
|
+
|
272
|
+
/* record frame info */
|
273
|
+
cme = rb_vm_frame_method_entry(cfp);
|
274
|
+
|
275
|
+
if (cme && cme->def->type == VM_METHOD_TYPE_ISEQ &&
|
276
|
+
// Fix: Do not use callable method entry when iseq is for an eval.
|
277
|
+
// TL;DR: This fix is needed for us to match the Ruby reference API information in the
|
278
|
+
// "when sampling an eval/instance eval inside an object" spec.
|
279
|
+
//
|
280
|
+
// Longer note:
|
281
|
+
// When a frame is a ruby frame (VM_FRAME_RUBYFRAME_P above), we can get information about it
|
282
|
+
// by introspecting both the callable method entry, as well as the iseq directly.
|
283
|
+
// Often they match... but sometimes they provide different info (as in the "iseq for an eval" situation
|
284
|
+
// here).
|
285
|
+
// If my reading of vm_backtrace.c is correct, the actual Ruby stack trace API **never** uses the
|
286
|
+
// callable method entry for Ruby frames, but only for VM_METHOD_TYPE_CFUNC (see `backtrace_each` method
|
287
|
+
// on that file).
|
288
|
+
// So... why does `rb_profile_frames` do something different? Is it a bug? Is it because it exposes
|
289
|
+
// more information than the Ruby stack frame API?
|
290
|
+
// As a final note, the `backtracie` gem (https://github.com/ivoanjo/backtracie) can be used to introspect
|
291
|
+
// the full metadata provided by both the callable method entry as well as the iseq, and is really useful
|
292
|
+
// to debug and learn more about these differences.
|
293
|
+
cfp->iseq->body->type != ISEQ_TYPE_EVAL) {
|
294
|
+
buff[i] = (VALUE)cme;
|
295
|
+
}
|
296
|
+
else {
|
297
|
+
buff[i] = (VALUE)cfp->iseq;
|
298
|
+
}
|
299
|
+
|
300
|
+
lines[i] = calc_lineno(cfp->iseq, cfp->pc);
|
301
|
+
is_ruby_frame[i] = true;
|
302
|
+
i++;
|
303
|
+
}
|
304
|
+
else {
|
305
|
+
cme = rb_vm_frame_method_entry(cfp);
|
306
|
+
if (cme && cme->def->type == VM_METHOD_TYPE_CFUNC) {
|
307
|
+
buff[i] = (VALUE)cme;
|
308
|
+
lines[i] = 0;
|
309
|
+
is_ruby_frame[i] = false;
|
310
|
+
i++;
|
311
|
+
}
|
312
|
+
}
|
313
|
+
cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
|
314
|
+
}
|
315
|
+
|
316
|
+
return i;
|
317
|
+
}
|
318
|
+
|
319
|
+
#ifdef USE_BACKPORTED_RB_PROFILE_FRAME_METHOD_NAME
|
320
|
+
|
321
|
+
// Taken from upstream vm_backtrace.c at commit 5f10bd634fb6ae8f74a4ea730176233b0ca96954 (March 2022, Ruby 3.2 trunk)
|
322
|
+
// Copyright (C) 1993-2012 Yukihiro Matsumoto
|
323
|
+
// to support our custom rb_profile_frame_method_name (see below)
|
324
|
+
// Modifications: None
|
325
|
+
static VALUE
|
326
|
+
id2str(ID id)
|
327
|
+
{
|
328
|
+
VALUE str = rb_id2str(id);
|
329
|
+
if (!str) return Qnil;
|
330
|
+
return str;
|
331
|
+
}
|
332
|
+
#define rb_id2str(id) id2str(id)
|
333
|
+
|
334
|
+
// Taken from upstream vm_backtrace.c at commit 5f10bd634fb6ae8f74a4ea730176233b0ca96954 (March 2022, Ruby 3.2 trunk)
|
335
|
+
// Copyright (C) 1993-2012 Yukihiro Matsumoto
|
336
|
+
// to support our custom rb_profile_frame_method_name (see below)
|
337
|
+
// Modifications: None
|
338
|
+
static const rb_iseq_t *
|
339
|
+
frame2iseq(VALUE frame)
|
340
|
+
{
|
341
|
+
if (NIL_P(frame)) return NULL;
|
342
|
+
|
343
|
+
if (RB_TYPE_P(frame, T_IMEMO)) {
|
344
|
+
switch (imemo_type(frame)) {
|
345
|
+
case imemo_iseq:
|
346
|
+
return (const rb_iseq_t *)frame;
|
347
|
+
case imemo_ment:
|
348
|
+
{
|
349
|
+
const rb_callable_method_entry_t *cme = (rb_callable_method_entry_t *)frame;
|
350
|
+
switch (cme->def->type) {
|
351
|
+
case VM_METHOD_TYPE_ISEQ:
|
352
|
+
return cme->def->body.iseq.iseqptr;
|
353
|
+
default:
|
354
|
+
return NULL;
|
355
|
+
}
|
356
|
+
}
|
357
|
+
default:
|
358
|
+
break;
|
359
|
+
}
|
360
|
+
}
|
361
|
+
rb_bug("frame2iseq: unreachable");
|
362
|
+
}
|
363
|
+
|
364
|
+
// Taken from upstream vm_backtrace.c at commit 5f10bd634fb6ae8f74a4ea730176233b0ca96954 (March 2022, Ruby 3.2 trunk)
|
365
|
+
// Copyright (C) 1993-2012 Yukihiro Matsumoto
|
366
|
+
// to support our custom rb_profile_frame_method_name (see below)
|
367
|
+
// Modifications: None
|
368
|
+
static const rb_callable_method_entry_t *
|
369
|
+
cframe(VALUE frame)
|
370
|
+
{
|
371
|
+
if (NIL_P(frame)) return NULL;
|
372
|
+
|
373
|
+
if (RB_TYPE_P(frame, T_IMEMO)) {
|
374
|
+
switch (imemo_type(frame)) {
|
375
|
+
case imemo_ment:
|
376
|
+
{
|
377
|
+
const rb_callable_method_entry_t *cme = (rb_callable_method_entry_t *)frame;
|
378
|
+
switch (cme->def->type) {
|
379
|
+
case VM_METHOD_TYPE_CFUNC:
|
380
|
+
return cme;
|
381
|
+
default:
|
382
|
+
return NULL;
|
383
|
+
}
|
384
|
+
}
|
385
|
+
default:
|
386
|
+
return NULL;
|
387
|
+
}
|
388
|
+
}
|
389
|
+
|
390
|
+
return NULL;
|
391
|
+
}
|
392
|
+
|
393
|
+
// Taken from upstream vm_backtrace.c at commit 5f10bd634fb6ae8f74a4ea730176233b0ca96954 (March 2022, Ruby 3.2 trunk)
|
394
|
+
// Copyright (C) 1993-2012 Yukihiro Matsumoto
|
395
|
+
//
|
396
|
+
// Ruby 3.0 finally added support for showing CFUNC frames (frames for methods written using native code)
|
397
|
+
// in stack traces gathered via `rb_profile_frames` (https://github.com/ruby/ruby/pull/3299).
|
398
|
+
// To access this information on older Rubies, beyond using our custom `ddtrace_rb_profile_frames` above, we also need
|
399
|
+
// to backport the Ruby 3.0+ version of `rb_profile_frame_method_name`.
|
400
|
+
//
|
401
|
+
// Modifications:
|
402
|
+
// * Renamed rb_profile_frame_method_name => ddtrace_rb_profile_frame_method_name
|
403
|
+
VALUE
|
404
|
+
ddtrace_rb_profile_frame_method_name(VALUE frame)
|
405
|
+
{
|
406
|
+
const rb_callable_method_entry_t *cme = cframe(frame);
|
407
|
+
if (cme) {
|
408
|
+
ID mid = cme->def->original_id;
|
409
|
+
return id2str(mid);
|
410
|
+
}
|
411
|
+
const rb_iseq_t *iseq = frame2iseq(frame);
|
412
|
+
return iseq ? rb_iseq_method_name(iseq) : Qnil;
|
413
|
+
}
|
414
|
+
|
415
|
+
#endif // USE_BACKPORTED_RB_PROFILE_FRAME_METHOD_NAME
|
416
|
+
|
417
|
+
// Support code for older Rubies that cannot use the MJIT header
|
418
|
+
#ifndef RUBY_MJIT_HEADER
|
419
|
+
|
420
|
+
#define MJIT_STATIC // No-op on older Rubies
|
421
|
+
|
422
|
+
// Taken from upstream include/ruby/backward/2/bool.h at commit 5f10bd634fb6ae8f74a4ea730176233b0ca96954 (March 2022, Ruby 3.2 trunk)
|
423
|
+
// Copyright (C) Ruby developers <ruby-core@ruby-lang.org>
|
424
|
+
// to support our custom rb_profile_frames (see above)
|
425
|
+
// Modifications: None
|
426
|
+
#ifndef FALSE
|
427
|
+
# define FALSE false
|
428
|
+
#elif FALSE
|
429
|
+
# error FALSE must be false
|
430
|
+
#endif
|
431
|
+
|
432
|
+
#ifndef TRUE
|
433
|
+
# define TRUE true
|
434
|
+
#elif ! TRUE
|
435
|
+
# error TRUE must be true
|
436
|
+
#endif
|
437
|
+
|
438
|
+
// Taken from upstream vm_insnhelper.c at commit 5f10bd634fb6ae8f74a4ea730176233b0ca96954 (March 2022, Ruby 3.2 trunk)
|
439
|
+
// Copyright (C) 2007 Koichi Sasada
|
440
|
+
// to support our custom rb_profile_frames (see above)
|
441
|
+
// Modifications: None
|
442
|
+
static rb_callable_method_entry_t *
|
443
|
+
check_method_entry(VALUE obj, int can_be_svar)
|
444
|
+
{
|
445
|
+
if (obj == Qfalse) return NULL;
|
446
|
+
|
447
|
+
#if VM_CHECK_MODE > 0
|
448
|
+
if (!RB_TYPE_P(obj, T_IMEMO)) rb_bug("check_method_entry: unknown type: %s", rb_obj_info(obj));
|
449
|
+
#endif
|
450
|
+
|
451
|
+
switch (imemo_type(obj)) {
|
452
|
+
case imemo_ment:
|
453
|
+
return (rb_callable_method_entry_t *)obj;
|
454
|
+
case imemo_cref:
|
455
|
+
return NULL;
|
456
|
+
case imemo_svar:
|
457
|
+
if (can_be_svar) {
|
458
|
+
return check_method_entry(((struct vm_svar *)obj)->cref_or_me, FALSE);
|
459
|
+
}
|
460
|
+
default:
|
461
|
+
#if VM_CHECK_MODE > 0
|
462
|
+
rb_bug("check_method_entry: svar should not be there:");
|
463
|
+
#endif
|
464
|
+
return NULL;
|
465
|
+
}
|
466
|
+
}
|
467
|
+
|
468
|
+
#ifndef USE_LEGACY_RB_VM_FRAME_METHOD_ENTRY
|
469
|
+
// Taken from upstream vm_insnhelper.c at commit 5f10bd634fb6ae8f74a4ea730176233b0ca96954 (March 2022, Ruby 3.2 trunk)
|
470
|
+
// Copyright (C) 2007 Koichi Sasada
|
471
|
+
// to support our custom rb_profile_frames (see above)
|
472
|
+
//
|
473
|
+
// While older Rubies may have this function, the symbol is not exported which leads to dynamic loader issues, e.g.
|
474
|
+
// `dyld: lazy symbol binding failed: Symbol not found: _rb_vm_frame_method_entry`.
|
475
|
+
//
|
476
|
+
// Modifications: None
|
477
|
+
MJIT_STATIC const rb_callable_method_entry_t *
|
478
|
+
rb_vm_frame_method_entry(const rb_control_frame_t *cfp)
|
479
|
+
{
|
480
|
+
const VALUE *ep = cfp->ep;
|
481
|
+
rb_callable_method_entry_t *me;
|
482
|
+
|
483
|
+
while (!VM_ENV_LOCAL_P(ep)) {
|
484
|
+
if ((me = check_method_entry(ep[VM_ENV_DATA_INDEX_ME_CREF], FALSE)) != NULL) return me;
|
485
|
+
ep = VM_ENV_PREV_EP(ep);
|
486
|
+
}
|
487
|
+
|
488
|
+
return check_method_entry(ep[VM_ENV_DATA_INDEX_ME_CREF], TRUE);
|
489
|
+
}
|
490
|
+
#else
|
491
|
+
// Taken from upstream vm_insnhelper.c at commit 556e9f726e2b80f6088982c6b43abfe68bfad591 (October 2018, ruby_2_3 branch)
|
492
|
+
// Copyright (C) 2007 Koichi Sasada
|
493
|
+
// to support our custom rb_profile_frames (see above)
|
494
|
+
//
|
495
|
+
// Quite a few macros in this function changed after Ruby 2.3. Rather than trying to fix the Ruby 3.2 version to work
|
496
|
+
// with 2.3 constants, I decided to import the Ruby 2.3 version.
|
497
|
+
//
|
498
|
+
// Modifications: None
|
499
|
+
const rb_callable_method_entry_t *
|
500
|
+
rb_vm_frame_method_entry(const rb_control_frame_t *cfp)
|
501
|
+
{
|
502
|
+
VALUE *ep = cfp->ep;
|
503
|
+
rb_callable_method_entry_t *me;
|
504
|
+
|
505
|
+
while (!VM_EP_LEP_P(ep)) {
|
506
|
+
if ((me = check_method_entry(ep[-1], FALSE)) != NULL) return me;
|
507
|
+
ep = VM_EP_PREV_EP(ep);
|
508
|
+
}
|
509
|
+
|
510
|
+
return check_method_entry(ep[-1], TRUE);
|
511
|
+
}
|
512
|
+
#endif // USE_LEGACY_RB_VM_FRAME_METHOD_ENTRY
|
513
|
+
|
514
|
+
#endif // RUBY_MJIT_HEADER
|
515
|
+
|
516
|
+
#else // USE_LEGACY_RB_PROFILE_FRAMES, Ruby < 2.3
|
517
|
+
|
518
|
+
// Taken from upstream vm_backtrace.c at commit bbda1a027475bf7ce5e1a9583a7b55d0be71c8fe (March 2018, ruby_2_2 branch)
|
519
|
+
// Copyright (C) 1993-2012 Yukihiro Matsumoto
|
520
|
+
// to support our custom rb_profile_frames (see below)
|
521
|
+
// Modifications: None
|
522
|
+
inline static int
|
523
|
+
calc_lineno(const rb_iseq_t *iseq, const VALUE *pc)
|
524
|
+
{
|
525
|
+
return rb_iseq_line_no(iseq, pc - iseq->iseq_encoded);
|
526
|
+
}
|
527
|
+
|
528
|
+
// Taken from upstream vm_backtrace.c at commit bbda1a027475bf7ce5e1a9583a7b55d0be71c8fe (March 2018, ruby_2_2 branch)
|
529
|
+
// Copyright (C) 1993-2012 Yukihiro Matsumoto
|
530
|
+
// Modifications:
|
531
|
+
// * Renamed rb_profile_frames => ddtrace_rb_profile_frames
|
532
|
+
// * Add thread argument
|
533
|
+
// * Add is_ruby_frame argument
|
534
|
+
// * Removed `if (lines)` tests -- require/assume that like `buff`, `lines` is always specified
|
535
|
+
// * Added support for getting the name from native methods by getting inspiration from `backtrace_each` in
|
536
|
+
// `vm_backtrace.c`. Note that unlike the `rb_profile_frames` for modern Rubies, this version actually returns the
|
537
|
+
// method name as as `VALUE` containing a Ruby string in the `buff`.
|
538
|
+
// * Skip dummy frame that shows up in main thread
|
539
|
+
// * Add `end_cfp == NULL` and `end_cfp <= cfp` safety checks. These are used in a bunch of places in
|
540
|
+
// `vm_backtrace.c` (`backtrace_each`, `backtrace_size`, `rb_ec_partial_backtrace_object`) but are conspicuously
|
541
|
+
// absent from `rb_profile_frames`. Oversight?
|
542
|
+
// * Distinguish between `end_cfp == NULL` (dead thread or some other error, returns 0) and `end_cfp <= cfp`
|
543
|
+
// (alive thread which may just be executing native code and has not pushed anything on the Ruby stack, returns
|
544
|
+
// PLACEHOLDER_STACK_IN_NATIVE_CODE). See comments on `record_placeholder_stack_in_native_code` for more details.
|
545
|
+
// * Check thread status and do not sample if thread has been killed.
|
546
|
+
//
|
547
|
+
// The `rb_profile_frames` function changed quite a bit between Ruby 2.2 and 2.3. Since the change was quite complex
|
548
|
+
// I opted not to try to extend support to Ruby 2.2 and below using the same custom function, and instead I started
|
549
|
+
// anew from the Ruby 2.2 version of the function, applying some of the same fixes that we have for the modern version.
|
550
|
+
int ddtrace_rb_profile_frames(VALUE thread, int start, int limit, VALUE *buff, int *lines, bool* is_ruby_frame)
|
551
|
+
{
|
552
|
+
// **IMPORTANT: THIS IS A CUSTOM RB_PROFILE_FRAMES JUST FOR RUBY 2.2 AND BELOW;
|
553
|
+
// SEE ABOVE FOR THE FUNCTION THAT GETS USED FOR MODERN RUBIES**
|
554
|
+
|
555
|
+
int i;
|
556
|
+
rb_thread_t *th = thread_struct_from_object(thread);
|
557
|
+
rb_control_frame_t *cfp = th->cfp, *end_cfp = RUBY_VM_END_CONTROL_FRAME(th);
|
558
|
+
|
559
|
+
// `vm_backtrace.c` includes this check in several methods, and I think this happens on either dead or newly-created
|
560
|
+
// threads, but I'm not entirely sure
|
561
|
+
if (end_cfp == NULL) return 0;
|
562
|
+
|
563
|
+
// Avoid sampling dead threads
|
564
|
+
if (th->status == THREAD_KILLED) return 0;
|
565
|
+
|
566
|
+
// Fix: Skip dummy frame that shows up in main thread.
|
567
|
+
//
|
568
|
+
// According to a comment in `backtrace_each` (`vm_backtrace.c`), there's two dummy frames that we should ignore
|
569
|
+
// at the base of every thread's stack.
|
570
|
+
// (see https://github.com/ruby/ruby/blob/4bd38e8120f2fdfdd47a34211720e048502377f1/vm_backtrace.c#L890-L914 )
|
571
|
+
//
|
572
|
+
// One is being pointed to by `RUBY_VM_END_CONTROL_FRAME(ec)`, and so we need to advance to the next one, and
|
573
|
+
// reaching it will be used as a condition to break out of the loop below.
|
574
|
+
//
|
575
|
+
// Note that in `backtrace_each` there's two calls to `RUBY_VM_NEXT_CONTROL_FRAME`, but the loop bounds there
|
576
|
+
// are computed in a different way, so the two calls really are equivalent to one here.
|
577
|
+
end_cfp = RUBY_VM_NEXT_CONTROL_FRAME(end_cfp);
|
578
|
+
|
579
|
+
// See comment on `record_placeholder_stack_in_native_code` for a full explanation of what this means (and why we don't just return 0)
|
580
|
+
if (end_cfp <= cfp) return PLACEHOLDER_STACK_IN_NATIVE_CODE;
|
581
|
+
|
582
|
+
for (i=0; i<limit && cfp != end_cfp;) {
|
583
|
+
if (cfp->iseq && cfp->pc) { /* should be NORMAL_ISEQ */
|
584
|
+
if (start > 0) {
|
585
|
+
start--;
|
586
|
+
continue;
|
587
|
+
}
|
588
|
+
|
589
|
+
/* record frame info */
|
590
|
+
buff[i] = cfp->iseq->self;
|
591
|
+
lines[i] = calc_lineno(cfp->iseq, cfp->pc);
|
592
|
+
is_ruby_frame[i] = true;
|
593
|
+
i++;
|
594
|
+
} else if (RUBYVM_CFUNC_FRAME_P(cfp)) {
|
595
|
+
ID mid = cfp->me->def ? cfp->me->def->original_id : cfp->me->called_id;
|
596
|
+
buff[i] = rb_id2str(mid);
|
597
|
+
lines[i] = 0;
|
598
|
+
is_ruby_frame[i] = false;
|
599
|
+
i++;
|
600
|
+
}
|
601
|
+
cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
|
602
|
+
}
|
603
|
+
|
604
|
+
return i;
|
605
|
+
}
|
606
|
+
|
607
|
+
#endif // USE_LEGACY_RB_PROFILE_FRAMES
|
@@ -1,3 +1,33 @@
|
|
1
1
|
#pragma once
|
2
2
|
|
3
|
+
#include <stdbool.h>
|
4
|
+
|
5
|
+
// The private_vm_api_access.c includes the RUBY_MJIT_HEADER which replaces and conflicts with any other Ruby headers;
|
6
|
+
// so we use PRIVATE_VM_API_ACCESS_SKIP_RUBY_INCLUDES to be able to include private_vm_api_access.h on that file
|
7
|
+
// without also dragging the incompatible includes
|
8
|
+
#ifndef PRIVATE_VM_API_ACCESS_SKIP_RUBY_INCLUDES
|
9
|
+
#ifdef RUBY_2_1_WORKAROUND
|
10
|
+
#include <thread_native.h>
|
11
|
+
#else
|
12
|
+
#include <ruby/thread_native.h>
|
13
|
+
#endif
|
14
|
+
#endif
|
15
|
+
|
16
|
+
#include "extconf.h"
|
17
|
+
|
3
18
|
rb_nativethread_id_t pthread_id_for(VALUE thread);
|
19
|
+
ptrdiff_t stack_depth_for(VALUE thread);
|
20
|
+
int ddtrace_rb_profile_frames(VALUE thread, int start, int limit, VALUE *buff, int *lines, bool* is_ruby_frame);
|
21
|
+
|
22
|
+
// Ruby 3.0 finally added support for showing CFUNC frames (frames for methods written using native code)
|
23
|
+
// in stack traces gathered via `rb_profile_frames` (https://github.com/ruby/ruby/pull/3299).
|
24
|
+
// To access this information on older Rubies, beyond using our custom `ddtrace_rb_profile_frames` above, we also need
|
25
|
+
// to backport the Ruby 3.0+ version of `rb_profile_frame_method_name`.
|
26
|
+
#ifdef USE_BACKPORTED_RB_PROFILE_FRAME_METHOD_NAME
|
27
|
+
VALUE ddtrace_rb_profile_frame_method_name(VALUE frame);
|
28
|
+
#else // Ruby > 3.0, just use the stock functionality
|
29
|
+
#define ddtrace_rb_profile_frame_method_name rb_profile_frame_method_name
|
30
|
+
#endif
|
31
|
+
|
32
|
+
// See comment on `record_placeholder_stack_in_native_code` for a full explanation of what this means (and why we don't just return 0)
|
33
|
+
#define PLACEHOLDER_STACK_IN_NATIVE_CODE -1
|
@@ -2,6 +2,10 @@
|
|
2
2
|
|
3
3
|
#include "clock_id.h"
|
4
4
|
|
5
|
+
// Each class/module here is implemented in their separate file
|
6
|
+
void collectors_stack_init(VALUE profiling_module);
|
7
|
+
void stack_recorder_init(VALUE profiling_module);
|
8
|
+
|
5
9
|
static VALUE native_working_p(VALUE self);
|
6
10
|
|
7
11
|
#define DDTRACE_EXPORT __attribute__ ((visibility ("default")))
|
@@ -15,6 +19,9 @@ void DDTRACE_EXPORT Init_ddtrace_profiling_native_extension(void) {
|
|
15
19
|
rb_funcall(native_extension_module, rb_intern("private_class_method"), 1, ID2SYM(rb_intern("native_working?")));
|
16
20
|
|
17
21
|
rb_define_singleton_method(native_extension_module, "clock_id_for", clock_id_for, 1); // from clock_id.h
|
22
|
+
|
23
|
+
collectors_stack_init(profiling_module);
|
24
|
+
stack_recorder_init(profiling_module);
|
18
25
|
}
|
19
26
|
|
20
27
|
static VALUE native_working_p(VALUE self) {
|