ddtrace 0.54.2 → 1.4.0

data/ext/ddtrace_profiling_native_extension/private_vm_api_access.h

@@ -1,3 +1,33 @@
 #pragma once
 
+#include <stdbool.h>
+
+// The private_vm_api_access.c includes the RUBY_MJIT_HEADER which replaces and conflicts with any other Ruby headers;
+// so we use PRIVATE_VM_API_ACCESS_SKIP_RUBY_INCLUDES to be able to include private_vm_api_access.h on that file
+// without also dragging the incompatible includes
+#ifndef PRIVATE_VM_API_ACCESS_SKIP_RUBY_INCLUDES
+  #include <ruby/thread_native.h>
+#endif
+
+#include "extconf.h"
+
 rb_nativethread_id_t pthread_id_for(VALUE thread);
+ptrdiff_t stack_depth_for(VALUE thread);
+VALUE ddtrace_thread_list(void);
+bool is_thread_alive(VALUE thread);
+VALUE thread_name_for(VALUE thread);
+
+int ddtrace_rb_profile_frames(VALUE thread, int start, int limit, VALUE *buff, int *lines, bool* is_ruby_frame);
+
+// Ruby 3.0 finally added support for showing CFUNC frames (frames for methods written using native code)
+// in stack traces gathered via `rb_profile_frames` (https://github.com/ruby/ruby/pull/3299).
+// To access this information on older Rubies, beyond using our custom `ddtrace_rb_profile_frames` above, we also need
+// to backport the Ruby 3.0+ version of `rb_profile_frame_method_name`.
+#ifdef USE_BACKPORTED_RB_PROFILE_FRAME_METHOD_NAME
+  VALUE ddtrace_rb_profile_frame_method_name(VALUE frame);
+#else // Ruby > 3.0, just use the stock functionality
+  #define ddtrace_rb_profile_frame_method_name rb_profile_frame_method_name
+#endif
+
+// 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)
+#define PLACEHOLDER_STACK_IN_NATIVE_CODE -1

data/ext/ddtrace_profiling_native_extension/profiling.c

@@ -1,10 +1,18 @@
 #include <ruby.h>
 
 #include "clock_id.h"
+#include "helpers.h"
+
+// Each class/module here is implemented in their separate file
+void collectors_cpu_and_wall_time_init(VALUE profiling_module);
+void collectors_cpu_and_wall_time_worker_init(VALUE profiling_module);
+void collectors_stack_init(VALUE profiling_module);
+void http_transport_init(VALUE profiling_module);
+void stack_recorder_init(VALUE profiling_module);
 
 static VALUE native_working_p(VALUE self);
 
-void Init_ddtrace_profiling_native_extension(void) {
+void DDTRACE_EXPORT Init_ddtrace_profiling_native_extension(void) {
   VALUE datadog_module = rb_define_module("Datadog");
   VALUE profiling_module = rb_define_module_under(datadog_module, "Profiling");
   VALUE native_extension_module = rb_define_module_under(profiling_module, "NativeExtension");
@@ -13,9 +21,15 @@ void Init_ddtrace_profiling_native_extension(void) {
   rb_funcall(native_extension_module, rb_intern("private_class_method"), 1, ID2SYM(rb_intern("native_working?")));
 
   rb_define_singleton_method(native_extension_module, "clock_id_for", clock_id_for, 1); // from clock_id.h
+
+  collectors_cpu_and_wall_time_init(profiling_module);
+  collectors_cpu_and_wall_time_worker_init(profiling_module);
+  collectors_stack_init(profiling_module);
+  http_transport_init(profiling_module);
+  stack_recorder_init(profiling_module);
 }
 
-static VALUE native_working_p(VALUE self) {
+static VALUE native_working_p(DDTRACE_UNUSED VALUE _self) {
   self_test_clock_id();
 
   return Qtrue;

data/ext/ddtrace_profiling_native_extension/ruby_helpers.c

@@ -0,0 +1,25 @@
+#include "ruby_helpers.h"
+
+void raise_unexpected_type(
+  VALUE value,
+  DDTRACE_UNUSED enum ruby_value_type _type,
+  const char *value_name,
+  const char *type_name,
+  const char *file,
+  int line,
+  const char* function_name
+) {
+  rb_exc_raise(
+    rb_exc_new_str(
+      rb_eTypeError,
+      rb_sprintf("wrong argument %"PRIsVALUE" for '%s' (expected a %s) at %s:%d:in `%s'",
+        rb_inspect(value),
+        value_name,
+        type_name,
+        file,
+        line,
+        function_name
+      )
+    )
+  );
+}

data/ext/ddtrace_profiling_native_extension/ruby_helpers.h

@@ -0,0 +1,65 @@
+#pragma once
+
+#include <ruby.h>
+
+#include "helpers.h"
+
+// Processes any pending interruptions, including exceptions to be raised.
+// If there's an exception to be raised, it raises it. In that case, this function does not return.
+static inline VALUE process_pending_interruptions(DDTRACE_UNUSED VALUE _) {
+  rb_thread_check_ints();
+  return Qnil;
+}
+
+// RB_UNLIKELY is not supported on Ruby 2.2 and 2.3
+#ifndef RB_UNLIKELY
+  #define RB_UNLIKELY(x) x
+#endif
+
+// Calls process_pending_interruptions BUT "rescues" any exceptions to be raised, returning them instead as
+// a non-zero `pending_exception`.
+//
+// Thus, if there's a non-zero `pending_exception`, the caller MUST call `rb_jump_tag(pending_exception)` after any
+// needed clean-ups.
+//
+// Usage example:
+//
+// ```c
+// foo = ruby_xcalloc(...);
+// pending_exception = check_if_pending_exception();
+// if (pending_exception) {
+//   ruby_xfree(foo);
+//   rb_jump_tag(pending_exception); // Re-raises exception
+// }
+// ```
+__attribute__((warn_unused_result))
+static inline int check_if_pending_exception(void) {
+  int pending_exception;
+  rb_protect(process_pending_interruptions, Qnil, &pending_exception);
+  return pending_exception;
+}
+
+#define ADD_QUOTES_HELPER(x) #x
+#define ADD_QUOTES(x) ADD_QUOTES_HELPER(x)
+
+// Ruby has a Check_Type(value, type) that is roughly equivalent to this BUT Ruby's version is rather cryptic when it fails
+// e.g. "wrong argument type nil (expected String)". This is a replacement that prints more information to help debugging.
+#define ENFORCE_TYPE(value, type) \
+  { if (RB_UNLIKELY(!RB_TYPE_P(value, type))) raise_unexpected_type(value, type, ADD_QUOTES(value), ADD_QUOTES(type), __FILE__, __LINE__, __func__); }
+
+// Called by ENFORCE_TYPE; should not be used directly
+NORETURN(void raise_unexpected_type(
+  VALUE value,
+  enum ruby_value_type type,
+  const char *value_name,
+  const char *type_name,
+  const char *file,
+  int line,
+  const char* function_name
+));
+
+// This API is exported as a public symbol by the VM BUT the function header is not defined in any public header, so we
+// repeat it here to be able to use in our code.
+//
+// Queries if the current thread is the owner of the global VM lock.
+int ruby_thread_has_gvl_p(void);

data/ext/ddtrace_profiling_native_extension/stack_recorder.c

@@ -0,0 +1,422 @@
+#include <ruby.h>
+#include <ruby/thread.h>
+#include <pthread.h>
+#include <errno.h>
+#include "helpers.h"
+#include "stack_recorder.h"
+#include "libdatadog_helpers.h"
+#include "ruby_helpers.h"
+
+// Used to wrap a ddprof_ffi_Profile in a Ruby object and expose Ruby-level serialization APIs
+// This file implements the native bits of the Datadog::Profiling::StackRecorder class
+
+// ---
+// ## Synchronization mechanism for safe parallel access design notes
+//
+// The state of the StackRecorder is managed using a set of locks to avoid concurrency issues.
+//
+// This is needed because the state is expected to be accessed, in parallel, by two different threads.
+//
+// 1. The thread that is taking a stack sample and that called `record_sample`, let's call it the **sampler thread**.
+// In the current implementation of the profiler, there can only exist one **sampler thread** at a time; if this
+// constraint changes, we should revise the design of the StackRecorder.
+//
+// 2. The thread that serializes and reports profiles, let's call it the **serializer thread**. We enforce that there
+// cannot be more than one thread attempting to serialize profiles at a time.
+//
+// If both the sampler and serializer threads are trying to access the same `ddprof_ffi_Profile` in parallel, we will
+// have a concurrency issue. Thus, the StackRecorder has an added mechanism to avoid this.
+//
+// As an additional constraint, the **sampler thread** has absolute priority and must never block while
+// recording a sample.
+//
+// ### The solution: Keep two profiles at the same time
+//
+// To solve for the constraints above, the StackRecorder keeps two `ddprof_ffi_Profile` profile instances inside itself.
+// They are called the `slot_one_profile` and `slot_two_profile`.
+//
+// Each profile is paired with its own mutex. `slot_one_profile` is protected by `slot_one_mutex` and `slot_two_profile`
+// is protected by `slot_two_mutex`.
+//
+// We additionally introduce the concept of **active** and **inactive** profile slots. At any point, the sampler thread
+// can probe the mutexes to discover which of the profiles corresponds to the active slot, and then records samples in it.
+// When the serializer thread is ready to serialize data, it flips the active and inactive slots; it reports the data
+// on the previously-active profile slot, and the sampler thread can continue to record in the previously-inactive
+// profile slot.
+//
+// Thus, the sampler and serializer threads never cross paths, avoiding concurrency issues. The sampler thread writes to
+// the active profile slot, and the serializer thread reads from the inactive profile slot.
+//
+// ### Locking protocol, high-level
+//
+// The active profile slot is the slot for which its corresponding mutex **is unlocked**. That is, if the sampler
+// thread can grab a lock for a profile slot, then that slot is the active one. (Here you see where the constraint
+// stated above that only one sampler thread can exist kicks in -- this part would need to be more complex if multiple
+// sampler threads were in play.)
+//
+// As a counterpart, the inactive profile slot mutex is **kept locked** until such time the serializer
+// thread is ready to work and decides to flip the slots.
+//
+// When a new StackRecorder is initialized, the `slot_one_mutex` is unlocked, and the `slot_two_mutex` is kept locked,
+// that is, a new instance always starts with slot one active.
+//
+// Additionally, an `active_slot` field is kept, containing a `1` or `2`; this is only kept for the serializer thread
+// to use as a simplification, as well as for testing and debugging; the **sampler thread must never use the `active_slot`
+// field**.
+//
+// ### Locking protocol, from the sampler thread side
+//
+// When the sampler thread wants to record a sample, it goes through the following steps to discover which is the
+// active profile slot:
+//
+// 1. `pthread_mutex_trylock(slot_one_mutex)`. If it succeeds to grab the lock, this means the active profile slot is
+// slot one. If it fails, we move to the next step.
+//
+// 2. `pthread_mutex_trylock(slot_two_mutex)`. If it succeeds to grab the lock, this means the active profile slot is
+// slot two. If it fails, we move to the next step.
+//
+// 3. What does it mean for the sampler thread to have observed both `slot_one_mutex` as well as `slot_two_mutex` as
+// being locked? There are two options:
+//   a. The sampler thread got really unlucky. When it tried to grab the `slot_one_mutex`, the active profile slot was
+//     the second one BUT then the serializer thread flipped the slots, and by the time the sampler thread probed the
+//     `slot_two_mutex`, that one was taken. Since the serializer thread is expected only to work once a minute,
+//     we retry steps 1. and 2. and should be able to find an active slot.
+//   b. Something is incorrect in the StackRecorder state. In this situation, the sampler thread should give up on
+//     sampling and enter an error state.
+//
+// Note that in the steps above, and because the sampler thread uses `trylock` to probe the mutexes, that the
+// sampler thread never blocks. It either is able to find an active profile slot in a bounded amount of steps or it
+// enters an error state.
+//
+// This guarantees that sampler performance is never constrained by serializer performance.
+//
+// ### Locking protocol, from the serializer thread side
+//
+// When the serializer thread wants to serialize a profile, it first flips the active and inactive profile slots.
+//
+// The flipping action is described below. Consider previously-inactive and previously-active as the state of the slots
+// before the flipping happens.
+//
+// The flipping steps are the following:
+//
+// 1. Release the mutex for the previously-inactive profile slot. That slot, as seen by the sampler thread, is now
+// active.
+//
+// 2. Grab the mutex for the previously-active profile slot. Note that this can lead to the serializer thread blocking,
+// if the sampler thread is holding this mutex. After the mutex is grabbed, the previously-active slot becomes inactive,
+// as seen by the sampler thread.
+//
+// 3. Update `active_slot`.
+//
+// After flipping the profile slots, the serializer thread is now free to serialize the inactive profile slot. The slot
+// is kept inactive until the next time the serializer thread wants to serialize data.
+//
+// Note there can be a brief period between steps 1 and 2 where the serializer thread holds no lock, which means that
+// the sampler thread can pick either slot. This is OK: if the sampler thread picks the previously-inactive slot, the
+// samples will be reported on the next serialization; if the sampler thread picks the previously-active slot, the
+// samples are still included in the current serialization. Either option is correct.
+//
+// ### Additional notes
+//
+// Q: Can the sampler thread and the serializer thread ever be the same thread? (E.g. sampling in interrupt handler)
+// A: No; the current profiler design requires that sampling happens only on the thread that is holding the Global VM
+// Lock (GVL). The serializer thread flipping occurs after the serializer thread releases the GVL, and thus the
+// serializer thread will not be able to host the sampling process.
+//
+// ---
+
+static VALUE ok_symbol = Qnil; // :ok in Ruby
+static VALUE error_symbol = Qnil; // :error in Ruby
+
+static ID ruby_time_from_id; // id of :ruby_time_from in Ruby
+
+static VALUE stack_recorder_class = Qnil;
+
+// Contains native state for each instance
+struct stack_recorder_state {
+  pthread_mutex_t slot_one_mutex;
+  ddprof_ffi_Profile *slot_one_profile;
+
+  pthread_mutex_t slot_two_mutex;
+  ddprof_ffi_Profile *slot_two_profile;
+
+  short active_slot; // MUST NEVER BE ACCESSED FROM record_sample; this is NOT for the sampler thread to use.
+};
+
+// Used to return a pair of values from sampler_lock_active_profile()
+struct active_slot_pair {
+  pthread_mutex_t *mutex;
+  ddprof_ffi_Profile *profile;
+};
+
+struct call_serialize_without_gvl_arguments {
+  // Set by caller
+  struct stack_recorder_state *state;
+
+  // Set by callee
+  ddprof_ffi_Profile *profile;
+  ddprof_ffi_SerializeResult result;
+
+  // Set by both
+  bool serialize_ran;
+};
+
+static VALUE _native_new(VALUE klass);
+static void stack_recorder_typed_data_free(void *data);
+static VALUE _native_serialize(VALUE self, VALUE recorder_instance);
+static VALUE ruby_time_from(ddprof_ffi_Timespec ddprof_time);
+static void *call_serialize_without_gvl(void *call_args);
+static struct active_slot_pair sampler_lock_active_profile();
+static void sampler_unlock_active_profile(struct active_slot_pair active_slot);
+static ddprof_ffi_Profile *serializer_flip_active_and_inactive_slots(struct stack_recorder_state *state);
+static VALUE _native_active_slot(DDTRACE_UNUSED VALUE _self, VALUE recorder_instance);
+static VALUE _native_is_slot_one_mutex_locked(DDTRACE_UNUSED VALUE _self, VALUE recorder_instance);
+static VALUE _native_is_slot_two_mutex_locked(DDTRACE_UNUSED VALUE _self, VALUE recorder_instance);
+static VALUE test_slot_mutex_state(VALUE recorder_instance, int slot);
+
+void stack_recorder_init(VALUE profiling_module) {
+  stack_recorder_class = rb_define_class_under(profiling_module, "StackRecorder", rb_cObject);
+  // Hosts methods used for testing the native code using RSpec
+  VALUE testing_module = rb_define_module_under(stack_recorder_class, "Testing");
+
+  // Instances of the StackRecorder class are "TypedData" objects.
+  // "TypedData" objects are special objects in the Ruby VM that can wrap C structs.
+  // In this case, it wraps the stack_recorder_state.
+  //
+  // Because Ruby doesn't know how to initialize native-level structs, we MUST override the allocation function for objects
+  // of this class so that we can manage this part. Not overriding or disabling the allocation function is a common
+  // gotcha for "TypedData" objects that can very easily lead to VM crashes, see for instance
+  // https://bugs.ruby-lang.org/issues/18007 for a discussion around this.
+  rb_define_alloc_func(stack_recorder_class, _native_new);
+
+  rb_define_singleton_method(stack_recorder_class, "_native_serialize",  _native_serialize, 1);
+  rb_define_singleton_method(testing_module, "_native_active_slot", _native_active_slot, 1);
+  rb_define_singleton_method(testing_module, "_native_slot_one_mutex_locked?", _native_is_slot_one_mutex_locked, 1);
+  rb_define_singleton_method(testing_module, "_native_slot_two_mutex_locked?", _native_is_slot_two_mutex_locked, 1);
+
+  ok_symbol = ID2SYM(rb_intern_const("ok"));
+  error_symbol = ID2SYM(rb_intern_const("error"));
+  ruby_time_from_id = rb_intern_const("ruby_time_from");
+}
+
+// This structure is used to define a Ruby object that stores a pointer to a ddprof_ffi_Profile instance
+// See also https://github.com/ruby/ruby/blob/master/doc/extension.rdoc for how this works
+static const rb_data_type_t stack_recorder_typed_data = {
+  .wrap_struct_name = "Datadog::Profiling::StackRecorder",
+  .function = {
+    .dfree = stack_recorder_typed_data_free,
+    .dsize = NULL, // We don't track profile memory usage (although it'd be cool if we did!)
+    // No need to provide dmark nor dcompact because we don't directly reference Ruby VALUEs from inside this object
+  },
+  .flags = RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+static VALUE _native_new(VALUE klass) {
+  struct stack_recorder_state *state = ruby_xcalloc(1, sizeof(struct stack_recorder_state));
+
+  ddprof_ffi_Slice_value_type sample_types = {.ptr = enabled_value_types, .len = ENABLED_VALUE_TYPES_COUNT};
+
+  state->slot_one_mutex = (pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER;
+  state->slot_two_mutex = (pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER;
+
+  // A newly-created StackRecorder starts with slot one being active for samples, so let's lock slot two
+  int error = pthread_mutex_lock(&state->slot_two_mutex);
+  if (error) rb_syserr_fail(error, "Unexpected failure during pthread_mutex_lock");
+
+  state->active_slot = 1;
+
+  // Note: Don't raise exceptions after this point, since it'll lead to libdatadog memory leaking!
+
+  state->slot_one_profile = ddprof_ffi_Profile_new(sample_types, NULL /* period is optional */, NULL /* start_time is optional */);
+  state->slot_two_profile = ddprof_ffi_Profile_new(sample_types, NULL /* period is optional */, NULL /* start_time is optional */);
+
+  return TypedData_Wrap_Struct(klass, &stack_recorder_typed_data, state);
+}
+
+static void stack_recorder_typed_data_free(void *state_ptr) {
+  struct stack_recorder_state *state = (struct stack_recorder_state *) state_ptr;
+
+  pthread_mutex_destroy(&state->slot_one_mutex);
+  ddprof_ffi_Profile_free(state->slot_one_profile);
+
+  pthread_mutex_destroy(&state->slot_two_mutex);
+  ddprof_ffi_Profile_free(state->slot_two_profile);
+
+  ruby_xfree(state);
+}
+
+static VALUE _native_serialize(DDTRACE_UNUSED VALUE _self, VALUE recorder_instance) {
+  struct stack_recorder_state *state;
+  TypedData_Get_Struct(recorder_instance, struct stack_recorder_state, &stack_recorder_typed_data, state);
+
+  // We'll release the Global VM Lock while we're calling serialize, so that the Ruby VM can continue to work while this
+  // is pending
+  struct call_serialize_without_gvl_arguments args = {.state = state, .serialize_ran = false};
+
+  while (!args.serialize_ran) {
+    // Give the Ruby VM an opportunity to process any pending interruptions (including raising exceptions).
+    // Note that it's OK to do this BEFORE call_serialize_without_gvl runs BUT NOT AFTER because afterwards
+    // there's heap-allocated memory that MUST be cleaned before raising any exception.
+    //
+    // Note that we run this in a loop because `rb_thread_call_without_gvl2` may return multiple times due to
+    // pending interrupts until it actually runs our code.
+    process_pending_interruptions(Qnil);
+
+    // We use rb_thread_call_without_gvl2 here because unlike the regular _gvl variant, gvl2 does not process
+    // interruptions and thus does not raise exceptions after running our code.
+    rb_thread_call_without_gvl2(call_serialize_without_gvl, &args, NULL /* No interruption function needed in this case */, NULL /* Not needed */);
+  }
+
+  ddprof_ffi_SerializeResult serialized_profile = args.result;
+
+  if (serialized_profile.tag == DDPROF_FFI_SERIALIZE_RESULT_ERR) {
+    VALUE err_details = ruby_string_from_vec_u8(serialized_profile.err);
+    ddprof_ffi_SerializeResult_drop(serialized_profile);
+    return rb_ary_new_from_args(2, error_symbol, err_details);
+  }
+
+  VALUE encoded_pprof = ruby_string_from_vec_u8(serialized_profile.ok.buffer);
+
+  ddprof_ffi_Timespec ddprof_start = serialized_profile.ok.start;
+  ddprof_ffi_Timespec ddprof_finish = serialized_profile.ok.end;
+
+  // Clean up libdatadog object to avoid leaking in case ruby_time_from raises an exception
+  ddprof_ffi_SerializeResult_drop(serialized_profile);
+
+  VALUE start = ruby_time_from(ddprof_start);
+  VALUE finish = ruby_time_from(ddprof_finish);
+
+  if (!ddprof_ffi_Profile_reset(args.profile, NULL /* start_time is optional */ )) {
+    return rb_ary_new_from_args(2, error_symbol, rb_str_new_cstr("Failed to reset profile"));
+  }
+
+  return rb_ary_new_from_args(2, ok_symbol, rb_ary_new_from_args(3, start, finish, encoded_pprof));
+}
+
+static VALUE ruby_time_from(ddprof_ffi_Timespec ddprof_time) {
+  #ifndef NO_RB_TIME_TIMESPEC_NEW // Modern Rubies
+    const int utc = INT_MAX - 1; // From Ruby sources
+    struct timespec time = {.tv_sec = ddprof_time.seconds, .tv_nsec = ddprof_time.nanoseconds};
+    return rb_time_timespec_new(&time, utc);
+  #else // Ruby < 2.3
+    return rb_funcall(stack_recorder_class, ruby_time_from_id, 2, LONG2NUM(ddprof_time.seconds), UINT2NUM(ddprof_time.nanoseconds));
+  #endif
+}
+
+void record_sample(VALUE recorder_instance, ddprof_ffi_Sample sample) {
+  struct stack_recorder_state *state;
+  TypedData_Get_Struct(recorder_instance, struct stack_recorder_state, &stack_recorder_typed_data, state);
+
+  struct active_slot_pair active_slot = sampler_lock_active_profile(state);
+
+  ddprof_ffi_Profile_add(active_slot.profile, sample);
+
+  sampler_unlock_active_profile(active_slot);
+}
+
+static void *call_serialize_without_gvl(void *call_args) {
+  struct call_serialize_without_gvl_arguments *args = (struct call_serialize_without_gvl_arguments *) call_args;
+
+  args->profile = serializer_flip_active_and_inactive_slots(args->state);
+  args->result = ddprof_ffi_Profile_serialize(args->profile, NULL /* end_time is optional */, NULL /* duration_nanos is optional */);
+  args->serialize_ran = true;
+
+  return NULL; // Unused
+}
+
+VALUE enforce_recorder_instance(VALUE object) {
+  Check_TypedStruct(object, &stack_recorder_typed_data);
+  return object;
+}
+
+static struct active_slot_pair sampler_lock_active_profile(struct stack_recorder_state *state) {
+  int error;
+
+  for (int attempts = 0; attempts < 2; attempts++) {
+    error = pthread_mutex_trylock(&state->slot_one_mutex);
+    if (error && error != EBUSY) rb_syserr_fail(error, "Unexpected failure during sampler_lock_active_profile for slot_one_mutex");
+
+    // Slot one is active
+    if (!error) return (struct active_slot_pair) {.mutex = &state->slot_one_mutex, .profile = state->slot_one_profile};
+
+    // If we got here, slot one was not active, let's try slot two
+
+    error = pthread_mutex_trylock(&state->slot_two_mutex);
+    if (error && error != EBUSY) rb_syserr_fail(error, "Unexpected failure during sampler_lock_active_profile for slot_two_mutex");
+
+    // Slot two is active
+    if (!error) return (struct active_slot_pair) {.mutex = &state->slot_two_mutex, .profile = state->slot_two_profile};
+  }
+
+  // We already tried both multiple times, and we did not succeed. This is not expected to happen. Let's stop sampling.
+  rb_raise(rb_eRuntimeError, "Failed to grab either mutex in sampler_lock_active_profile");
+}
+
+static void sampler_unlock_active_profile(struct active_slot_pair active_slot) {
+  int error = pthread_mutex_unlock(active_slot.mutex);
+  if (error != 0) rb_syserr_fail(error, "Unexpected failure in sampler_unlock_active_profile");
+}
+
+static ddprof_ffi_Profile *serializer_flip_active_and_inactive_slots(struct stack_recorder_state *state) {
+  int error;
+  int previously_active_slot = state->active_slot;
+
+  if (previously_active_slot != 1 && previously_active_slot != 2) {
+    rb_raise(rb_eRuntimeError, "Unexpected active_slot state %d in serializer_flip_active_and_inactive_slots", previously_active_slot);
+  }
+
+  pthread_mutex_t *previously_active = (previously_active_slot == 1) ? &state->slot_one_mutex : &state->slot_two_mutex;
+  pthread_mutex_t *previously_inactive = (previously_active_slot == 1) ? &state->slot_two_mutex : &state->slot_one_mutex;
+
+  // Release the lock, thus making this slot active
+  error = pthread_mutex_unlock(previously_inactive);
+  if (error) rb_syserr_fail(error, "Unexpected failure during serializer_flip_active_and_inactive_slots for previously_inactive");
+
+  // Grab the lock, thus making this slot inactive
+  error = pthread_mutex_lock(previously_active);
+  if (error) rb_syserr_fail(error, "Unexpected failure during serializer_flip_active_and_inactive_slots for previously_active");
+
+  // Update active_slot
+  state->active_slot = (previously_active_slot == 1) ? 2 : 1;
+
+  // Return profile for previously active slot (now inactive)
+  return (previously_active_slot == 1) ? state->slot_one_profile : state->slot_two_profile;
+}
+
+// This method exists only to enable testing Datadog::Profiling::StackRecorder behavior using RSpec.
+// It SHOULD NOT be used for other purposes.
+static VALUE _native_active_slot(DDTRACE_UNUSED VALUE _self, VALUE recorder_instance) {
+  struct stack_recorder_state *state;
+  TypedData_Get_Struct(recorder_instance, struct stack_recorder_state, &stack_recorder_typed_data, state);
+
+  return INT2NUM(state->active_slot);
+}
+
+// This method exists only to enable testing Datadog::Profiling::StackRecorder behavior using RSpec.
+// It SHOULD NOT be used for other purposes.
+static VALUE _native_is_slot_one_mutex_locked(DDTRACE_UNUSED VALUE _self, VALUE recorder_instance) { return test_slot_mutex_state(recorder_instance, 1); }
+
+// This method exists only to enable testing Datadog::Profiling::StackRecorder behavior using RSpec.
+// It SHOULD NOT be used for other purposes.
+static VALUE _native_is_slot_two_mutex_locked(DDTRACE_UNUSED VALUE _self, VALUE recorder_instance) { return test_slot_mutex_state(recorder_instance, 2); }
+
+static VALUE test_slot_mutex_state(VALUE recorder_instance, int slot) {
+  struct stack_recorder_state *state;
+  TypedData_Get_Struct(recorder_instance, struct stack_recorder_state, &stack_recorder_typed_data, state);
+
+  pthread_mutex_t *slot_mutex = (slot == 1) ? &state->slot_one_mutex : &state->slot_two_mutex;
+
+  // Like Heisenberg's uncertainty principle, we can't observe without affecting...
+  int error = pthread_mutex_trylock(slot_mutex);
+
+  if (error == 0) {
+    // Mutex was unlocked
+    pthread_mutex_unlock(slot_mutex);
+    return Qfalse;
+  } else if (error == EBUSY) {
+    // Mutex was locked
+    return Qtrue;
+  } else {
+    rb_syserr_fail(error, "Unexpected failure when checking mutex state");
+  }
+}

data/ext/ddtrace_profiling_native_extension/stack_recorder.h

@@ -0,0 +1,38 @@
+#pragma once
+
+#include <ddprof/ffi.h>
+
+// Note: Please DO NOT use `VALUE_STRING` anywhere else, instead use `DDPROF_FFI_CHARSLICE_C`.
+// `VALUE_STRING` is only needed because older versions of gcc (4.9.2, used in our Ruby 2.2 CI test images)
+// tripped when compiling `enabled_value_types` using `-std=gnu99` due to the extra cast that is included in
+// `DDPROF_FFI_CHARSLICE_C` with the following error:
+//
+// ```
+// compiling ../../../../ext/ddtrace_profiling_native_extension/stack_recorder.c
+// ../../../../ext/ddtrace_profiling_native_extension/stack_recorder.c:23:1: error: initializer element is not constant
+// static const ddprof_ffi_ValueType enabled_value_types[] = {CPU_TIME_VALUE, CPU_SAMPLES_VALUE, WALL_TIME_VALUE};
+// ^
+// ```
+#define VALUE_STRING(string) {.ptr = "" string, .len = sizeof(string) - 1}
+
+#define CPU_TIME_VALUE          {.type_ = VALUE_STRING("cpu-time"),          .unit = VALUE_STRING("nanoseconds")}
+#define CPU_SAMPLES_VALUE       {.type_ = VALUE_STRING("cpu-samples"),       .unit = VALUE_STRING("count")}
+#define WALL_TIME_VALUE         {.type_ = VALUE_STRING("wall-time"),         .unit = VALUE_STRING("nanoseconds")}
+#define ALLOC_SIZE_VALUE        {.type_ = VALUE_STRING("alloc-size"),        .unit = VALUE_STRING("bytes")}
+#define ALLOC_SAMPLES_VALUE     {.type_ = VALUE_STRING("alloc-samples"),     .unit = VALUE_STRING("count")}
+#define HEAP_LIVE_SIZE_VALUE    {.type_ = VALUE_STRING("heap-live-size"),    .unit = VALUE_STRING("bytes")}
+#define HEAP_LIVE_SAMPLES_VALUE {.type_ = VALUE_STRING("heap-live-samples"), .unit = VALUE_STRING("count")}
+
+static const ddprof_ffi_ValueType enabled_value_types[] = {
+  #define CPU_TIME_VALUE_POS 0
+  CPU_TIME_VALUE,
+  #define CPU_SAMPLES_VALUE_POS 1
+  CPU_SAMPLES_VALUE,
+  #define WALL_TIME_VALUE_POS 2
+  WALL_TIME_VALUE
+};
+
+#define ENABLED_VALUE_TYPES_COUNT (sizeof(enabled_value_types) / sizeof(ddprof_ffi_ValueType))
+
+void record_sample(VALUE recorder_instance, ddprof_ffi_Sample sample);
+VALUE enforce_recorder_instance(VALUE object);