From 6872d2ac2adce7a6c871814e7dc636cc8e848e59 Mon Sep 17 00:00:00 2001 From: JT <547158+jntrnr@users.noreply.github.com> Date: Sun, 26 Mar 2023 06:12:57 +1300 Subject: [PATCH] Speed up tight loop benchmarks (#8609) # Description This does a few speedups for tight loops: * Caches the DeclId for `table` so we don't look it up. This means users can't easily replace the default one, we might want to talk about this tradeoff. The lookup for finding `table` in a tight loop is currently pretty heavy. Might be another way to speed this up. * `table` no longer pre-calculates the width. Instead, it only calculates the width when printing a table or record. * Use more efficient way of collecting the block of each loop * When printing output, only get the config when needed Combined, this drops the runtime from a million loop tight iteration from 1sec 8ms to 236ms. # User-Facing Changes _(List of all changes that impact the user experience here. This helps us keep track of breaking changes.)_ # Tests + Formatting Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` # After Submitting If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. --- crates/nu-cmd-lang/src/core_commands/for_.rs | 3 +- .../nu-cmd-lang/src/core_commands/while_.rs | 2 +- crates/nu-command/src/default_context.rs | 4 +++ crates/nu-command/src/viewers/table.rs | 33 ++++++++++--------- crates/nu-protocol/src/engine/engine_state.rs | 2 ++ crates/nu-protocol/src/pipeline_data.rs | 6 ++-- 6 files changed, 30 insertions(+), 20 deletions(-) diff --git a/crates/nu-cmd-lang/src/core_commands/for_.rs b/crates/nu-cmd-lang/src/core_commands/for_.rs index bc88ba6f49..3e73fdd208 100644 --- a/crates/nu-cmd-lang/src/core_commands/for_.rs +++ b/crates/nu-cmd-lang/src/core_commands/for_.rs @@ -162,7 +162,8 @@ impl Command for For { return Err(err); } Ok(pipeline) => { - let exit_code = pipeline.print(&engine_state, stack, false, false)?; + let exit_code = + pipeline.print_not_formatted(&engine_state, false, false)?; if exit_code != 0 { break; } diff --git a/crates/nu-cmd-lang/src/core_commands/while_.rs b/crates/nu-cmd-lang/src/core_commands/while_.rs index d5bf71202e..34aaa40218 100644 --- a/crates/nu-cmd-lang/src/core_commands/while_.rs +++ b/crates/nu-cmd-lang/src/core_commands/while_.rs @@ -78,7 +78,7 @@ impl Command for While { } Ok(pipeline) => { let exit_code = - pipeline.print(engine_state, stack, false, false)?; + pipeline.print_not_formatted(engine_state, false, false)?; if exit_code != 0 { break; } diff --git a/crates/nu-command/src/default_context.rs b/crates/nu-command/src/default_context.rs index 1e1a6de8fd..a5395be84a 100644 --- a/crates/nu-command/src/default_context.rs +++ b/crates/nu-command/src/default_context.rs @@ -462,5 +462,9 @@ pub fn create_default_context() -> EngineState { eprintln!("Error creating default context: {err:?}"); } + // Cache the table decl id so we don't have to look it up later + let table_decl_id = engine_state.find_decl("table".as_bytes(), &[]); + engine_state.table_decl_id = table_decl_id; + engine_state } diff --git a/crates/nu-command/src/viewers/table.rs b/crates/nu-command/src/viewers/table.rs index e87bd28fd7..7d2e73320a 100644 --- a/crates/nu-command/src/viewers/table.rs +++ b/crates/nu-command/src/viewers/table.rs @@ -110,7 +110,6 @@ impl Command for Table { let list: bool = call.has_flag("list"); let width_param: Option = call.get_flag(engine_state, stack, "width")?; - let term_width = get_width_param(width_param); let expand: bool = call.has_flag("expand"); let expand_limit: Option = call.get_flag(engine_state, stack, "expand-deep")?; @@ -152,7 +151,7 @@ impl Command for Table { input, row_offset, table_view, - term_width, + width_param, ) } @@ -232,7 +231,7 @@ fn handle_table_command( input: PipelineData, row_offset: usize, table_view: TableView, - term_width: usize, + term_width: Option, ) -> Result { let ctrlc = engine_state.ctrlc.clone(); let config = engine_state.get_config(); @@ -278,18 +277,22 @@ fn handle_table_command( ctrlc, metadata, ), - PipelineData::Value(Value::Record { cols, vals, span }, ..) => handle_record( - cols, - vals, - span, - engine_state, - stack, - call, - table_view, - term_width, - ctrlc, - config, - ), + PipelineData::Value(Value::Record { cols, vals, span }, ..) => { + let term_width = get_width_param(term_width); + + handle_record( + cols, + vals, + span, + engine_state, + stack, + call, + table_view, + term_width, + ctrlc, + config, + ) + } PipelineData::Value(Value::LazyRecord { val, .. }, ..) => { let collected = val.collect()?.into_pipeline_data(); handle_table_command( diff --git a/crates/nu-protocol/src/engine/engine_state.rs b/crates/nu-protocol/src/engine/engine_state.rs index 2765deef6b..a768db654f 100644 --- a/crates/nu-protocol/src/engine/engine_state.rs +++ b/crates/nu-protocol/src/engine/engine_state.rs @@ -126,6 +126,7 @@ pub struct EngineState { pub config: Config, pub pipeline_externals_state: Arc<(AtomicU32, AtomicU32)>, pub repl_buffer_state: Arc>, + pub table_decl_id: Option, // A byte position, as `EditCommand::MoveToPosition` is also a byte position pub repl_cursor_pos: Arc>, #[cfg(feature = "plugin")] @@ -180,6 +181,7 @@ impl EngineState { pipeline_externals_state: Arc::new((AtomicU32::new(0), AtomicU32::new(0))), repl_buffer_state: Arc::new(Mutex::new("".to_string())), repl_cursor_pos: Arc::new(Mutex::new(0)), + table_decl_id: None, #[cfg(feature = "plugin")] plugin_signatures: None, #[cfg(not(windows))] diff --git a/crates/nu-protocol/src/pipeline_data.rs b/crates/nu-protocol/src/pipeline_data.rs index 804eff9675..4d961dd9a3 100644 --- a/crates/nu-protocol/src/pipeline_data.rs +++ b/crates/nu-protocol/src/pipeline_data.rs @@ -704,7 +704,7 @@ impl PipelineData { return print_if_stream(stream, stderr_stream, to_stderr, exit_code); } - if let Some(decl_id) = engine_state.find_decl("table".as_bytes(), &[]) { + if let Some(decl_id) = engine_state.table_decl_id { let command = engine_state.get_decl(decl_id); if command.get_block_id().is_some() { return self.write_all_and_flush(engine_state, config, no_newline, to_stderr); @@ -734,8 +734,6 @@ impl PipelineData { no_newline: bool, to_stderr: bool, ) -> Result { - let config = engine_state.get_config(); - if let PipelineData::ExternalStream { stdout: stream, stderr: stderr_stream, @@ -745,6 +743,7 @@ impl PipelineData { { print_if_stream(stream, stderr_stream, to_stderr, exit_code) } else { + let config = engine_state.get_config(); self.write_all_and_flush(engine_state, config, no_newline, to_stderr) } } @@ -835,6 +834,7 @@ pub fn print_if_stream( ) -> Result { // NOTE: currently we don't need anything from stderr // so we just consume and throw away `stderr_stream` to make sure the pipe doesn't fill up + thread::Builder::new() .name("stderr consumer".to_string()) .spawn(move || stderr_stream.map(|x| x.into_bytes()))