datadog 2.21.0 → 2.38.0

data/ext/datadog_profiling_native_extension/clock_id.h

@@ -4,10 +4,18 @@
 #include <time.h>
 #include <ruby.h>
 
+#ifdef __APPLE__
+  #include <mach/mach.h>
+  // On macOS, we use a mach_port_t to identify threads for CPU time queries
+  typedef mach_port_t cpu_time_id_t;
+#else
+  typedef clockid_t cpu_time_id_t;
+#endif
+
 // Contains the operating-system specific identifier needed to fetch CPU-time, and a flag to indicate if we failed to fetch it
 typedef struct {
   bool valid;
-  clockid_t clock_id;
+  cpu_time_id_t clock_id;
 } thread_cpu_time_id;
 
 // Contains the current cpu time, and a flag to indicate if we failed to fetch it

data/ext/datadog_profiling_native_extension/clock_id_from_mach.c

@@ -0,0 +1,66 @@
+#include "extconf.h"
+
+// This file is only compiled on macOS where Mach thread APIs are available;
+// Otherwise we compile clock_id_from_pthread.c (Linux)
+#ifdef HAVE_MACH_THREAD_INFO
+
+#include <pthread.h>
+#include <mach/mach.h>
+#include <mach/thread_info.h>
+
+#include "clock_id.h"
+#include "helpers.h"
+#include "private_vm_api_access.h"
+#include "ruby_helpers.h"
+#include "time_helpers.h"
+
+// Validate that our home-cooked pthread_id_for() matches pthread_self() for the current thread
+void self_test_clock_id(void) {
+  rb_nativethread_id_t expected_pthread_id = pthread_self();
+  rb_nativethread_id_t actual_pthread_id = pthread_id_for(rb_thread_current());
+
+  if (expected_pthread_id != actual_pthread_id) raise_error(rb_eRuntimeError, "pthread_id_for() self-test failed");
+
+  // Also validate that we can get a valid mach thread port for the current thread
+  mach_port_t mach_thread = pthread_mach_thread_np(expected_pthread_id);
+  if (mach_thread == MACH_PORT_NULL) raise_error(rb_eRuntimeError, "pthread_mach_thread_np() self-test failed");
+}
+
+// Safety: This function is assumed never to raise exceptions by callers
+thread_cpu_time_id thread_cpu_time_id_for(VALUE thread) {
+  rb_nativethread_id_t thread_id = pthread_id_for(thread);
+
+  if (thread_id == 0) return (thread_cpu_time_id) {.valid = false};
+
+  mach_port_t mach_thread = pthread_mach_thread_np(thread_id);
+
+  if (mach_thread == MACH_PORT_NULL) {
+    return (thread_cpu_time_id) {.valid = false};
+  }
+
+  return (thread_cpu_time_id) {.valid = true, .clock_id = mach_thread};
+}
+
+thread_cpu_time thread_cpu_time_for(thread_cpu_time_id time_id) {
+  thread_cpu_time error = (thread_cpu_time) {.valid = false};
+
+  if (!time_id.valid) return error;
+
+  // We intentionally use thread_info() for all threads, including the current one, even though
+  // clock_gettime(CLOCK_THREAD_CPUTIME_ID) is ~5x faster for the current thread. Mixing the two
+  // sources causes CPU time to appear to go backwards: thread_info() has microsecond precision
+  // while clock_gettime() has nanosecond precision, and comparing values across sources on
+  // successive samples produces small negative deltas.
+  struct thread_basic_info info;
+  mach_msg_type_number_t count = THREAD_BASIC_INFO_COUNT;
+  kern_return_t kr = thread_info(time_id.clock_id, THREAD_BASIC_INFO, (thread_info_t)&info, &count);
+
+  if (kr != KERN_SUCCESS) return error;
+
+  long user_ns = SECONDS_AS_NS(info.user_time.seconds) + MICROS_AS_NS(info.user_time.microseconds);
+  long system_ns = SECONDS_AS_NS(info.system_time.seconds) + MICROS_AS_NS(info.system_time.microseconds);
+
+  return (thread_cpu_time) {.valid = true, .result_ns = user_ns + system_ns};
+}
+
+#endif

data/ext/datadog_profiling_native_extension/clock_id_from_pthread.c

@@ -1,7 +1,7 @@
 #include "extconf.h"
 
 // This file is only compiled on systems where pthread_getcpuclockid() is available;
-// Otherwise we compile clock_id_noop.c
+// Otherwise we compile clock_id_from_mach.c (macOS)
 #ifdef HAVE_PTHREAD_GETCPUCLOCKID
 
 #include <pthread.h>
@@ -11,6 +11,7 @@
 #include "clock_id.h"
 #include "helpers.h"
 #include "private_vm_api_access.h"
+#include "ruby_helpers.h"
 #include "time_helpers.h"
 
 // Validate that our home-cooked pthread_id_for() matches pthread_self() for the current thread
@@ -18,7 +19,7 @@ void self_test_clock_id(void) {
   rb_nativethread_id_t expected_pthread_id = pthread_self();
   rb_nativethread_id_t actual_pthread_id = pthread_id_for(rb_thread_current());
 
-  if (expected_pthread_id != actual_pthread_id) rb_raise(rb_eRuntimeError, "pthread_id_for() self-test failed");
+  if (expected_pthread_id != actual_pthread_id) raise_error(rb_eRuntimeError, "pthread_id_for() self-test failed");
 }
 
 // Safety: This function is assumed never to raise exceptions by callers