pf2 0.5.2 → 0.7.0

data/crates/backtrace-sys2/src/libbacktrace/sort.c

@@ -1,5 +1,5 @@
 /* sort.c -- Sort without allocating memory
-   Copyright (C) 2012-2021 Free Software Foundation, Inc.
+   Copyright (C) 2012-2024 Free Software Foundation, Inc.
    Written by Ian Lance Taylor, Google.
 
 Redistribution and use in source and binary forms, with or without

data/crates/backtrace-sys2/src/libbacktrace/state.c

@@ -1,5 +1,5 @@
 /* state.c -- Create the backtrace state.
-   Copyright (C) 2012-2021 Free Software Foundation, Inc.
+   Copyright (C) 2012-2024 Free Software Foundation, Inc.
    Written by Ian Lance Taylor, Google.
 
 Redistribution and use in source and binary forms, with or without

data/crates/backtrace-sys2/src/libbacktrace/stest.c

@@ -1,5 +1,5 @@
 /* stest.c -- Test for libbacktrace internal sort function
-   Copyright (C) 2012-2021 Free Software Foundation, Inc.
+   Copyright (C) 2012-2024 Free Software Foundation, Inc.
    Written by Ian Lance Taylor, Google.
 
 Redistribution and use in source and binary forms, with or without

data/crates/backtrace-sys2/src/libbacktrace/test_format.c

@@ -1,5 +1,5 @@
 /* test_format.c -- Test for libbacktrace library
-   Copyright (C) 2018-2021 Free Software Foundation, Inc.
+   Copyright (C) 2018-2024 Free Software Foundation, Inc.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

data/crates/backtrace-sys2/src/libbacktrace/testlib.c

@@ -1,5 +1,5 @@
 /* testlib.c -- test functions for libbacktrace library
-   Copyright (C) 2012-2021 Free Software Foundation, Inc.
+   Copyright (C) 2012-2024 Free Software Foundation, Inc.
    Written by Ian Lance Taylor, Google.
 
 Redistribution and use in source and binary forms, with or without

data/crates/backtrace-sys2/src/libbacktrace/testlib.h

@@ -1,5 +1,5 @@
 /* testlib.h -- Header for test functions for libbacktrace library
-   Copyright (C) 2012-2021 Free Software Foundation, Inc.
+   Copyright (C) 2012-2024 Free Software Foundation, Inc.
    Written by Ian Lance Taylor, Google.
 
 Redistribution and use in source and binary forms, with or without

data/crates/backtrace-sys2/src/libbacktrace/ttest.c

@@ -1,5 +1,5 @@
 /* ttest.c -- Test for libbacktrace library
-   Copyright (C) 2017-2021 Free Software Foundation, Inc.
+   Copyright (C) 2017-2024 Free Software Foundation, Inc.
    Written by Ian Lance Taylor, Google.
 
 Redistribution and use in source and binary forms, with or without

data/crates/backtrace-sys2/src/libbacktrace/unittest.c

@@ -1,5 +1,5 @@
 /* unittest.c -- Test for libbacktrace library
-   Copyright (C) 2018-2021 Free Software Foundation, Inc.
+   Copyright (C) 2018-2024 Free Software Foundation, Inc.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

data/crates/backtrace-sys2/src/libbacktrace/unknown.c

@@ -1,5 +1,5 @@
 /* unknown.c -- used when backtrace configury does not know file format.
-   Copyright (C) 2012-2021 Free Software Foundation, Inc.
+   Copyright (C) 2012-2024 Free Software Foundation, Inc.
    Written by Ian Lance Taylor, Google.
 
 Redistribution and use in source and binary forms, with or without

data/crates/backtrace-sys2/src/libbacktrace/xcoff.c

@@ -1,5 +1,5 @@
 /* xcoff.c -- Get debug data from an XCOFF file for backtraces.
-   Copyright (C) 2012-2021 Free Software Foundation, Inc.
+   Copyright (C) 2012-2024 Free Software Foundation, Inc.
    Adapted from elf.c.
 
 Redistribution and use in source and binary forms, with or without
@@ -133,6 +133,7 @@ typedef struct {
 #define SSUBTYP_DWARNGE	0x50000	/* DWARF aranges section.  */
 #define SSUBTYP_DWABREV	0x60000	/* DWARF abbreviation section.  */
 #define SSUBTYP_DWSTR	0x70000	/* DWARF strings section.  */
+#define SSUBTYP_DWRNGES	0x80000	/* DWARF ranges section.  */
 
 /* XCOFF symbol.  */
 
@@ -384,7 +385,7 @@ struct xcoff_fileline_data
   size_t linenos_size;
   uint64_t lnnoptr0;
   /* Loader address.  */
-  uintptr_t base_address;
+  struct libbacktrace_base_address base_address;
 };
 
 /* Information we gather for the DWARF sections we care about.  */
@@ -585,8 +586,7 @@ xcoff_symname (const b_xcoff_syment *asym,
 
 static int
 xcoff_initialize_syminfo (struct backtrace_state *state,
-			  uintptr_t base_address,
-			  const b_xcoff_scnhdr *sects,
+			  struct libbacktrace_base_address base_address,
 			  const b_xcoff_syment *syms, size_t nsyms,
 			  const unsigned char *strtab, size_t strtab_size,
 			  backtrace_error_callback error_callback, void *data,
@@ -628,8 +628,8 @@ xcoff_initialize_syminfo (struct backtrace_state *state,
 	{
 	  const b_xcoff_auxent *aux = (const b_xcoff_auxent *) (asym + 1);
 	  xcoff_symbols[j].name = xcoff_symname (asym, strtab, strtab_size);
-	  xcoff_symbols[j].address = base_address + asym->n_value
-				   - sects[asym->n_scnum - 1].s_paddr;
+	  xcoff_symbols[j].address =
+	    libbacktrace_add_base (asym->n_value, base_address);
 	  /* x_fsize will be 0 if there is no debug information.  */
 	  xcoff_symbols[j].size = aux->x_fcn.x_fsize;
 	  ++j;
@@ -767,7 +767,8 @@ xcoff_lookup_pc (struct backtrace_state *state ATTRIBUTE_UNUSED,
       lineno = (const b_xcoff_lineno *) lineptr;
       if (lineno->l_lnno == 0)
 	break;
-      if (pc <= fdata->base_address + lineno->l_addr.l_paddr - fn->sect_base)
+      if (pc <= libbacktrace_add_base (lineno->l_addr.l_paddr,
+				       fdata->base_address))
 	break;
       match = lnnoptr;
       lnno = lineno->l_lnno;
@@ -861,7 +862,7 @@ xcoff_fileline (struct backtrace_state *state, uintptr_t pc,
 
 static int
 xcoff_initialize_fileline (struct backtrace_state *state,
-			   uintptr_t base_address,
+			   struct libbacktrace_base_address base_address,
 			   const b_xcoff_scnhdr *sects,
 			   const b_xcoff_syment *syms, size_t nsyms,
 			   const unsigned char *strtab, size_t strtab_size,
@@ -1002,7 +1003,7 @@ xcoff_initialize_fileline (struct backtrace_state *state,
 	    fn->name = xcoff_symname (fsym, strtab, strtab_size);
 	    fn->filename = filename;
 	    fn->sect_base = sects[fsym->n_scnum - 1].s_paddr;
-	    fn->pc = base_address + fsym->n_value - fn->sect_base;
+	    fn->pc = libbacktrace_add_base (fsym->n_value, base_address);
 	    fn->size = fsize;
 	    fn->lnno = lnno;
 	    fn->lnnoptr = lnnoptr;
@@ -1071,7 +1072,8 @@ fail:
 
 static int
 xcoff_add (struct backtrace_state *state, int descriptor, off_t offset,
-	   uintptr_t base_address, backtrace_error_callback error_callback,
+	   struct libbacktrace_base_address base_address,
+	   backtrace_error_callback error_callback,
 	   void *data, fileline *fileline_fn, int *found_sym, int exe)
 {
   struct backtrace_view fhdr_view;
@@ -1153,8 +1155,16 @@ xcoff_add (struct backtrace_state *state, int descriptor, off_t offset,
 
   stext = &sects[i];
 
-  /* AIX ldinfo_textorg includes the XCOFF headers.  */
-  base_address = (exe ? XCOFF_AIX_TEXTBASE : base_address) + stext->s_scnptr;
+  /* base_address represents the difference between the
+     virtual memory address of the shared object or a loaded
+     executable and the offset of that object in the file
+     from which it was loaded.
+     On AIX, virtual address is either fixed for executable
+     or given by ldinfo.  This address will include the XCOFF
+     headers.  */
+  base_address.m = ((exe ? XCOFF_AIX_TEXTBASE : base_address.m)
+		    + stext->s_scnptr
+		    - stext->s_paddr);
 
   lnnoptr = stext->s_lnnoptr;
   nlnno = stext->s_nlnno;
@@ -1193,7 +1203,9 @@ xcoff_add (struct backtrace_state *state, int descriptor, off_t offset,
 	goto fail;
       syms_view_valid = 1;
 
-      memcpy (&str_size, syms_view.data + syms_size, 4);
+      memcpy (&str_size,
+	      (const unsigned char *) syms_view.data + syms_size,
+	      4);
 
       str_off = fhdr.f_symptr + syms_size;
 
@@ -1212,7 +1224,7 @@ xcoff_add (struct backtrace_state *state, int descriptor, off_t offset,
       if (sdata == NULL)
 	goto fail;
 
-      if (!xcoff_initialize_syminfo (state, base_address, sects,
+      if (!xcoff_initialize_syminfo (state, base_address,
 				     syms_view.data, fhdr.f_nsyms,
 				     str_view.data, str_size,
 				     error_callback, data, sdata))
@@ -1252,7 +1264,7 @@ xcoff_add (struct backtrace_state *state, int descriptor, off_t offset,
 	  case SSUBTYP_DWABREV:
 	    idx = DEBUG_ABBREV;
 	    break;
-	  case SSUBTYP_DWARNGE:
+	  case SSUBTYP_DWRNGES:
 	    idx = DEBUG_RANGES;
 	    break;
 	  case SSUBTYP_DWSTR:
@@ -1290,13 +1302,7 @@ xcoff_add (struct backtrace_state *state, int descriptor, off_t offset,
 
       dwarf_sections.data[DEBUG_INFO] = dwsect[DEBUG_INFO].data;
       dwarf_sections.size[DEBUG_INFO] = dwsect[DEBUG_INFO].size;
-#if BACKTRACE_XCOFF_SIZE == 32
-      /* XXX workaround for broken lineoff */
-      dwarf_sections.data[DEBUG_LINE] = dwsect[DEBUG_LINE].data - 4;
-#else
-      /* XXX workaround for broken lineoff */
-      dwarf_sections.data[DEBUG_LINE] = dwsect[DEBUG_LINE].data - 12;
-#endif
+      dwarf_sections.data[DEBUG_LINE] = dwsect[DEBUG_LINE].data;
       dwarf_sections.size[DEBUG_LINE] = dwsect[DEBUG_LINE].size;
       dwarf_sections.data[DEBUG_ABBREV] = dwsect[DEBUG_ABBREV].data;
       dwarf_sections.size[DEBUG_ABBREV] = dwsect[DEBUG_ABBREV].size;
@@ -1305,7 +1311,7 @@ xcoff_add (struct backtrace_state *state, int descriptor, off_t offset,
       dwarf_sections.data[DEBUG_STR] = dwsect[DEBUG_STR].data;
       dwarf_sections.size[DEBUG_STR] = dwsect[DEBUG_STR].size;
 
-      if (!backtrace_dwarf_add (state, 0, &dwarf_sections,
+      if (!backtrace_dwarf_add (state, base_address, &dwarf_sections,
 				1, /* big endian */
 				NULL, /* altlink */
 				error_callback, data, fileline_fn,
@@ -1390,9 +1396,9 @@ xcoff_parse_decimal (const char *buf, size_t size, off_t *off)
 
 static int
 xcoff_armem_add (struct backtrace_state *state, int descriptor,
-		 uintptr_t base_address, const char *member,
-		 backtrace_error_callback error_callback, void *data,
-		 fileline *fileline_fn, int *found_sym)
+		 struct libbacktrace_base_address base_address,
+		 const char *member, backtrace_error_callback error_callback,
+		 void *data, fileline *fileline_fn, int *found_sym)
 {
   struct backtrace_view view;
   b_ar_fl_hdr fl_hdr;
@@ -1513,6 +1519,8 @@ xcoff_add_shared_libs (struct backtrace_state *state,
   ldinfo = (const struct ld_info *) buf;
   while ((const char *) ldinfo < (const char *) buf + buflen)
     {
+      struct libbacktrace_base_address base_address;
+
       if (*ldinfo->ldinfo_filename != '/')
 	goto next;
 
@@ -1524,16 +1532,17 @@ xcoff_add_shared_libs (struct backtrace_state *state,
       /* Check if it is an archive (member name not empty).  */
 
       member = ldinfo->ldinfo_filename + strlen (ldinfo->ldinfo_filename) + 1;
+      memset (&base_address, 0, sizeof base_address);
+      base_address.m = (uintptr_t) ldinfo->ldinfo_textorg;
       if (*member)
 	{
-	  xcoff_armem_add (state, descriptor,
-			   (uintptr_t) ldinfo->ldinfo_textorg, member,
+	  xcoff_armem_add (state, descriptor, base_address, member,
 			   error_callback, data, fileline_fn, &lib_found_sym);
 	}
       else
 	{
-	  xcoff_add (state, descriptor, 0, (uintptr_t) ldinfo->ldinfo_textorg,
-		     error_callback, data, fileline_fn, &lib_found_sym, 0);
+	  xcoff_add (state, descriptor, 0, base_address, error_callback, data,
+		     fileline_fn, &lib_found_sym, 0);
 	}
       if (lib_found_sym)
 	*found_sym = 1;
@@ -1558,12 +1567,14 @@ backtrace_initialize (struct backtrace_state *state,
 		      backtrace_error_callback error_callback,
 		      void *data, fileline *fileline_fn)
 {
+  struct libbacktrace_base_address zero_base_address;
   int ret;
   int found_sym;
   fileline xcoff_fileline_fn = xcoff_nodebug;
 
-  ret = xcoff_add (state, descriptor, 0, 0, error_callback, data,
-		   &xcoff_fileline_fn, &found_sym, 1);
+  memset (&zero_base_address, 0, sizeof zero_base_address);
+  ret = xcoff_add (state, descriptor, 0, zero_base_address,
+		   error_callback, data, &xcoff_fileline_fn, &found_sym, 1);
   if (!ret)
     return 0;
 

data/crates/backtrace-sys2/src/libbacktrace/xztest.c

@@ -1,5 +1,5 @@
 /* xztest.c -- Test for libbacktrace LZMA decoder.
-   Copyright (C) 2020-2021 Free Software Foundation, Inc.
+   Copyright (C) 2020-2024 Free Software Foundation, Inc.
    Written by Ian Lance Taylor, Google.
 
 Redistribution and use in source and binary forms, with or without
@@ -172,7 +172,7 @@ test_samples (struct backtrace_state *state)
 		       tests[i].name, uncompressed_len, v);
 	      ++failures;
 	    }
-	  else if (memcmp (tests[i].uncompressed, uncompressed, v) != 0)
+	  else if (v > 0 && memcmp (tests[i].uncompressed, uncompressed, v) != 0)
 	    {
 	      size_t j;
 

data/crates/backtrace-sys2/src/libbacktrace/zstdtest.c

@@ -1,5 +1,5 @@
 /* ztest.c -- Test for libbacktrace zstd code.
-   Copyright (C) 2022 Free Software Foundation, Inc.
+   Copyright (C) 2022-2024 Free Software Foundation, Inc.
    Written by Ian Lance Taylor, Google.
 
 Redistribution and use in source and binary forms, with or without

data/crates/backtrace-sys2/src/libbacktrace/ztest.c

@@ -1,5 +1,5 @@
 /* ztest.c -- Test for libbacktrace inflate code.
-   Copyright (C) 2017-2021 Free Software Foundation, Inc.
+   Copyright (C) 2017-2024 Free Software Foundation, Inc.
    Written by Ian Lance Taylor, Google.
 
 Redistribution and use in source and binary forms, with or without

data/ext/pf2/Cargo.toml

@@ -13,7 +13,7 @@ backtrace-sys2 = { path = "../../crates/backtrace-sys2" }
 env_logger = { version = "0.11.0", optional = true }
 libc = "0.2.149"
 log = "0.4.20"
-rb-sys = { version = "0.9.82", features = ["stable-api", "stable-api-compiled-testing"] } # using stable-api-compiled-testing for generating bindings from Ruby source
+rb-sys = { version = "0.9.105", features = ["stable-api"] }
 serde = "1.0.189"
 serde_derive = "1.0.189"
 serde_json = "1.0.107"

data/ext/pf2/src/lib.rs

@@ -10,6 +10,7 @@ mod profile_serializer;
 mod ringbuffer;
 mod sample;
 mod scheduler;
+mod serialization;
 mod session;
 #[cfg(target_os = "linux")]
 mod signal_scheduler;

data/ext/pf2/src/profile.rs

@@ -1,4 +1,4 @@
-use std::time::Instant;
+use std::time::{Instant, SystemTime};
 use std::{collections::HashSet, ptr::null_mut};
 
 use rb_sys::*;
@@ -15,7 +15,9 @@ const DEFAULT_RINGBUFFER_CAPACITY: usize = 320;
 
 #[derive(Debug)]
 pub struct Profile {
-    pub start_timestamp: Instant,
+    pub start_timestamp: SystemTime,
+    pub start_instant: Instant,
+    pub end_instant: Option<Instant>,
     pub samples: Vec<Sample>,
     pub temporary_sample_buffer: Ringbuffer,
     pub backtrace_state: BacktraceState,
@@ -35,7 +37,9 @@ impl Profile {
         };
 
         Self {
-            start_timestamp: Instant::now(),
+            start_timestamp: SystemTime::now(),
+            start_instant: Instant::now(),
+            end_instant: None,
             samples: vec![],
             temporary_sample_buffer: Ringbuffer::new(DEFAULT_RINGBUFFER_CAPACITY),
             backtrace_state,

data/ext/pf2/src/profile_serializer.rs

@@ -29,11 +29,7 @@ impl ThreadProfile {
         ThreadProfile {
             thread_id,
             // The root node
-            stack_tree: StackTreeNode {
-                children: HashMap::new(),
-                node_id: 0,
-                frame_id: 0,
-            },
+            stack_tree: StackTreeNode { children: HashMap::new(), node_id: 0, frame_id: 0 },
             frame_table: HashMap::new(),
             samples: vec![],
         }
@@ -91,9 +87,7 @@ impl ProfileSerializer {
     pub fn serialize(profile: &Profile) -> String {
         let mut sequence = 1;
 
-        let mut serializer = ProfileSerializer {
-            threads: HashMap::new(),
-        };
+        let mut serializer = ProfileSerializer { threads: HashMap::new() };
 
         unsafe {
             // Process each sample
@@ -221,11 +215,10 @@ impl ProfileSerializer {
 
                     if merged_stack.is_empty() {
                         // This is the leaf node, record a Sample
-                        let elapsed_ns = (sample.timestamp - profile.start_timestamp).as_nanos();
-                        thread_serializer.samples.push(ProfileSample {
-                            elapsed_ns,
-                            stack_tree_id: stack_tree.node_id,
-                        });
+                        let elapsed_ns = (sample.timestamp - profile.start_instant).as_nanos();
+                        thread_serializer
+                            .samples
+                            .push(ProfileSample { elapsed_ns, stack_tree_id: stack_tree.node_id });
                     }
 
                     // Register frame metadata to frame table, if not registered yet

data/ext/pf2/src/ringbuffer.rs

@@ -17,9 +17,7 @@ impl Ringbuffer {
     pub fn new(capacity: usize) -> Self {
         Self {
             capacity,
-            buffer: std::iter::repeat_with(|| None)
-                .take(capacity + 1)
-                .collect::<Vec<_>>(),
+            buffer: std::iter::repeat_with(|| None).take(capacity + 1).collect::<Vec<_>>(),
             read_index: 0,
             write_index: 0,
         }

data/ext/pf2/src/ruby_init.rs

@@ -10,10 +10,7 @@ use crate::util::*;
 extern "C" fn Init_pf2() {
     #[cfg(feature = "debug")]
     {
-        env_logger::builder()
-            .format_timestamp(None)
-            .format_module_path(false)
-            .init();
+        env_logger::builder().format_timestamp(None).format_module_path(false).init();
     }
 
     unsafe {

data/ext/pf2/src/sample.rs

@@ -14,6 +14,7 @@ pub struct Sample {
     pub line_count: i32,
     pub frames: [VALUE; MAX_STACK_DEPTH],
     pub linenos: [i32; MAX_STACK_DEPTH],
+    /// First element represents the backtrace depth.
     pub c_backtrace_pcs: [usize; MAX_C_STACK_DEPTH + 1],
 }
 

data/ext/pf2/src/serialization/profile.rs

@@ -0,0 +1,47 @@
+#[derive(Clone, Deserialize, Serialize)]
+pub struct Profile {
+    pub samples: Vec<Sample>,
+    pub locations: Vec<Location>,
+    pub functions: Vec<Function>,
+    pub start_timestamp_ns: u128,
+    pub duration_ns: u128,
+}
+
+pub type LocationIndex = usize;
+pub type FunctionIndex = usize;
+
+/// Sample
+#[derive(Clone, Serialize, Deserialize)]
+pub struct Sample {
+    /// The stack leading to this sample.
+    /// The leaf node will be stored at `stack[0]`.
+    pub stack: Vec<LocationIndex>,
+    pub native_stack: Vec<LocationIndex>,
+    pub ruby_thread_id: Option<u64>,
+}
+
+/// Location represents a location (line) in the source code when a sample was captured.
+#[derive(Clone, PartialEq, Serialize, Deserialize)]
+pub struct Location {
+    pub function_index: FunctionIndex,
+    pub lineno: i32,
+    pub address: Option<usize>,
+}
+
+/// Function represents a Ruby method or a C function in the profile.
+#[derive(Clone, PartialEq, Serialize, Deserialize)]
+pub struct Function {
+    pub implementation: FunctionImplementation,
+    pub name: Option<String>, // unique key
+    pub filename: Option<String>,
+    /// The first line number in the method/function definition.
+    /// For the actual location (line) which was hit during sample capture, refer to `Location.lineno`.
+    pub start_lineno: Option<i32>,
+    pub start_address: Option<usize>,
+}
+
+#[derive(Clone, PartialEq, Serialize, Deserialize)]
+pub enum FunctionImplementation {
+    Ruby,
+    Native,
+}