Replace --unstable-presymbolicate with --presymbolicate.

Author: mstange

samply/src/cli.rs

@@ -324,13 +324,12 @@ pub struct ProfileCreationArgs {
     #[arg(long, default_value = "0", num_args=0..=1, require_equals = true, default_missing_value = "100")]
     pub include_args: usize,
 
-    /// Emit .syms.json sidecar file containing gathered symbol info for all frames referenced by
-    /// this profile. With this file along with the profile, samply can load the profile
-    /// and provide symbols to the front end without needing debug files to be
-    /// available. (Unstable: will probably change to include the full information
-    /// in the profile.json, instead of a sidecar file.)
+    /// Generate a symbolicated profile file by looking up symbol information before writing out the file.
+    ///
+    /// This is off by default because symbol resolution can take a long time, so
+    /// the default behavior is to have the front-end apply symbols asynchronously.
     #[arg(long)]
-    pub unstable_presymbolicate: bool,
+    pub presymbolicate: bool,
 
     /// Emit markers for any unknown ETW events that are encountered.
     #[cfg(target_os = "windows")]
@@ -530,7 +529,7 @@ impl ProfileCreationArgs {
             create_per_cpu_threads: self.per_cpu_threads,
             arg_count_to_include_in_process_name: self.include_args,
             override_arch: None,
-            unstable_presymbolicate: self.unstable_presymbolicate,
+            presymbolicate: self.presymbolicate,
             should_emit_jit_markers: self.jit_markers,
             should_emit_cswitch_markers: self.cswitch_markers,
             coreclr: self.coreclr_profile_props(),

samply/src/main.rs

@@ -88,10 +88,10 @@ fn do_import_action(import_args: cli::ImportArgs) {
     };
 
     let import_props = import_args.import_props();
-    let unstable_presymbolicate = import_props.profile_creation_props.unstable_presymbolicate;
+    let presymbolicate = import_props.profile_creation_props.presymbolicate;
     let mut profile = convert_file_to_profile(&input_file, input_path, import_props);
 
-    if unstable_presymbolicate {
+    if presymbolicate {
         eprintln!("Symbolicating...");
         let symbol_info = crate::shared::presymbolicate::get_presymbolicate_info(
             &profile,
@@ -125,7 +125,7 @@ fn do_record_action(record_args: cli::RecordArgs) {
     let recording_props = record_args.recording_props();
     let recording_mode = record_args.recording_mode();
     let profile_creation_props = record_args.profile_creation_props();
-    let unstable_presymbolicate = profile_creation_props.unstable_presymbolicate;
+    let presymbolicate = profile_creation_props.presymbolicate;
 
     let (mut profile, exit_status) =
         match profiler::run(recording_mode, recording_props, profile_creation_props) {
@@ -136,7 +136,7 @@ fn do_record_action(record_args: cli::RecordArgs) {
             }
         };
 
-    if unstable_presymbolicate {
+    if presymbolicate {
         eprintln!("Symbolicating...");
         let symbol_info = crate::shared::presymbolicate::get_presymbolicate_info(
             &profile,

samply/src/shared/prop_types.rs

@@ -87,8 +87,8 @@ pub struct ProfileCreationProps {
     /// Override system architecture.
     #[allow(dead_code)]
     pub override_arch: Option<String>,
-    /// Dump presymbolication info.
-    pub unstable_presymbolicate: bool,
+    /// Output symbolicated profiles.
+    pub presymbolicate: bool,
     /// CoreCLR specific properties.
     #[allow(dead_code)]
     pub coreclr: CoreClrProfileProps,