start_command/
mod.rs

1//! start-command library
2//!
3//! Provides command execution with isolation, substitution, and failure handling.
4
5// `println!` and friends that drop write errors instead of panicking. Rust
6// ignores SIGPIPE, so printing into a closed pipe (`start --version | head -1`)
7// fails with EPIPE; like the JavaScript edition, start keeps running and exits
8// with its own code (issue #222). Defined before the modules, these shadow the
9// std macros in all of them; the binary imports them from the crate root.
10#[macro_export]
11macro_rules! print {
12    ($($arg:tt)*) => {{
13        use ::std::io::Write as _;
14        let _ = ::std::write!(::std::io::stdout(), $($arg)*);
15    }};
16}
17
18#[macro_export]
19macro_rules! println {
20    ($($arg:tt)*) => {{
21        use ::std::io::Write as _;
22        let _ = ::std::writeln!(::std::io::stdout(), $($arg)*);
23    }};
24}
25
26#[macro_export]
27macro_rules! eprint {
28    ($($arg:tt)*) => {{
29        use ::std::io::Write as _;
30        let _ = ::std::write!(::std::io::stderr(), $($arg)*);
31    }};
32}
33
34#[macro_export]
35macro_rules! eprintln {
36    ($($arg:tt)*) => {{
37        use ::std::io::Write as _;
38        let _ = ::std::writeln!(::std::io::stderr(), $($arg)*);
39    }};
40}
41
42pub mod args_parser;
43pub mod args_parser_queries;
44mod atomic_write;
45pub mod attached_diagnostics;
46pub mod cgroup_memory;
47pub mod container_removal;
48pub mod cpu_penalty;
49pub mod cpu_penalty_monitor;
50pub mod detached_finalize;
51pub mod detached_output;
52pub(crate) mod docker_cleanup;
53pub mod docker_command_handoff;
54pub mod docker_init_option;
55pub mod docker_inspect_batch;
56mod docker_network_lifecycle;
57pub mod docker_post_mortem;
58pub mod docker_recovery_options;
59pub mod docker_resource_limits;
60pub mod docker_resource_options;
61pub mod docker_snapshot_resume;
62pub mod docker_snapshot_safety;
63pub mod execution_attach;
64pub mod execution_attempt;
65pub mod execution_chain;
66pub mod execution_cleanup;
67pub mod execution_control;
68pub mod execution_env;
69pub mod execution_identity;
70pub mod execution_recovery;
71pub mod execution_resume;
72pub mod execution_resume_all;
73pub mod execution_store;
74pub mod exit_evidence;
75pub mod exit_reason;
76pub mod failure_handler;
77pub mod isolation;
78pub mod isolation_metadata;
79pub mod launch_identity;
80pub mod launch_identity_options;
81pub mod launch_owner;
82pub mod log_sanitizer;
83pub mod log_uploader;
84pub mod output_blocks;
85pub mod query_commands;
86pub mod recovery_delay;
87pub mod resume_resources;
88pub mod sequence_parser;
89pub mod session_probe;
90pub mod signal_handler;
91pub mod snapshot_resume_options;
92pub mod status_footer;
93pub mod status_formatter;
94pub mod status_probe;
95pub mod store_decode_cache;
96pub mod store_lock;
97pub mod substitution;
98pub mod usage;
99pub mod user_manager;
100
101mod lino_value_json;
102mod local_hostname;
103
104// Re-export commonly used items
105pub use args_parser::{
106    generate_session_name, generate_uuid, get_effective_mode, has_isolation, is_valid_uuid,
107    parse_args, validate_options, ParsedArgs, WrapperOptions, VALID_BACKENDS, VALID_OUTPUT_FORMATS,
108    VALID_SHELLS,
109};
110pub use detached_finalize::{
111    build_detached_finalize_snippet, finalize_detached_execution, reconcile_finalized_record,
112    run_internal_finalize, DetachedFinalizeFacts, FinalizeOutcome,
113    END_TIME_SOURCE_DOCKER_FINISHED_AT, END_TIME_SOURCE_LOG_FOOTER, END_TIME_SOURCE_OBSERVED_AT,
114    INTERNAL_FINALIZE_FLAG, WATCHER_LOST_CONTAINER,
115};
116pub use docker_cleanup::{
117    build_detached_docker_completion_script, build_detached_docker_completion_script_with,
118    docker_command, DockerContainerCleanupPolicy, DockerWatcherOptions,
119};
120pub use docker_post_mortem::{
121    build_docker_post_mortem_snippet, build_docker_removal_note_snippet,
122    build_docker_running_condition, build_docker_state_snippet,
123    build_docker_still_running_note_snippet, build_docker_wait_for_exit_snippet,
124    format_container_post_mortem, format_container_removal_note, format_lifetime,
125    normalize_docker_timestamp, ContainerPostMortem, DOCKER_RUNNING_INSPECT_FORMAT,
126    DOCKER_STATE_INSPECT_FORMAT, DOCKER_ZERO_TIME, LOG_CAPTURE_STOPPED_NOTE, POST_MORTEM_HEADER,
127    STILL_RUNNING_NOTE,
128};
129pub use execution_attach::{
130    attach_execution, attach_execution_with_runners, build_attach_plan,
131    format_attach_result_as_links_notation, AttachPlan, AttachResultFields, ExecutionAttachResult,
132    InteractiveRunner, SystemInteractiveRunner,
133};
134pub use execution_control::{
135    collect_descendant_pids, collect_descendant_pids_with_runner, collect_process_ids,
136    collect_process_ids_with_runner, control_execution, control_execution_with_runner,
137    format_control_result_as_links_notation, get_control_command, parse_screen_pid,
138    CommandRunOutput, CommandRunner, ControlAction, ControlCommand, ExecutionControlResult,
139    SystemCommandRunner,
140};
141pub use execution_resume::{
142    build_resume_plan, build_resumed_session_name, build_snapshot_image_name, resume_execution,
143    resume_execution_with, ExecutionResumeResult, ResumeHooks, ResumeMode, ResumePlan,
144    ResumeResultFields, SystemResumeHooks,
145};
146pub use execution_resume_all::{
147    format_resume_all, resume_all_executions, resume_all_executions_with, ExecutionResumeAllResult,
148    ResumeAllAction, ResumeAllEntry,
149};
150pub use execution_store::{
151    is_clink_installed, CleanupOptions, CleanupResult, ExecutionRecord, ExecutionRecordOptions,
152    ExecutionStats, ExecutionStatus, ExecutionStore, ExecutionStoreOptions,
153};
154pub use exit_reason::{
155    describe_exit_code, describe_exit_code_str, detect_exit_reason, resolve_exit_reason,
156    signal_name_for_exit_code, ExitCodeDescription,
157};
158pub use failure_handler::{handle_failure, Config as FailureConfig};
159pub use isolation::{
160    append_log_file, build_command_string, build_command_string_with, build_display_command,
161    build_shell_with_args_cmd_args, command_name, create_log_footer, create_log_header,
162    create_log_path, create_log_path_for_execution, docker_image_exists, docker_pull_image,
163    get_default_docker_image, get_timestamp, is_command_available, is_interactive_shell_command,
164    is_shell_invocation_with_args, quote_shell_arg, quote_shell_arg_with, run_as_isolated_user,
165    run_isolated, split_shell_words, split_shell_words_with, to_shell_words, write_log_file,
166    IsolationOptions, IsolationResult, LogHeaderParams, ShellQuotingStyle,
167};
168pub use isolation_metadata::{
169    build_isolation_options_map, docker_runtime_metadata, docker_runtime_status_lines,
170    docker_runtime_status_lines_for_options,
171};
172pub use log_uploader::upload_execution_log;
173#[allow(deprecated)]
174pub use output_blocks::{
175    // Timeline format API (formerly "status spine")
176    create_command_line,
177    create_empty_spine_line, // deprecated, use create_empty_timeline_line
178    create_empty_timeline_line,
179    create_finish_block,
180    create_spine_line, // deprecated, use create_timeline_line
181    create_start_block,
182    create_timeline_line,
183    create_timeline_separator,
184    create_virtual_command_block,
185    create_virtual_command_result,
186    escape_for_links_notation,
187    format_duration,
188    format_value_for_links_notation,
189    generate_isolation_lines,
190    get_result_marker,
191    parse_isolation_metadata,
192    FinishBlockOptions,
193    IsolationMetadata,
194    StartBlockOptions,
195    FAILURE_MARKER,
196    SPINE, // deprecated, use TIMELINE_MARKER
197    SUCCESS_MARKER,
198    TIMELINE_MARKER,
199};
200pub use query_commands::{dispatch_query_command, handle_cleanup, report_result, QueryOutcome};
201pub use session_probe::{probe_session, SessionProbe, SessionState};
202pub use signal_handler::{
203    clear_current_execution, get_signal_exit_code, set_current_execution, setup_signal_handlers,
204    was_signal_received,
205};
206pub use status_footer::{
207    parse_footer_from_tail, parse_footer_timestamp, read_footer_from_log, LogFooter,
208};
209pub use status_formatter::{
210    attach_current_time, enrich_detached_status, format_record, format_record_as_links_notation,
211    format_record_as_links_notation_with_current_time, format_record_as_text,
212    format_record_as_text_with_current_time, format_record_list,
213    format_record_list_as_links_notation, format_record_list_as_text,
214    format_record_with_current_time, list_executions, list_executions_filtered, query_status,
215    read_exit_code_from_log, StatusQueryResult,
216};
217pub use status_probe::is_detached_session_alive;
218pub use substitution::{process_command, ProcessOptions, SubstitutionResult};
219pub use usage::print_usage;
220pub use user_manager::{
221    create_isolated_user, delete_user, get_current_user, get_current_user_groups, has_sudo_access,
222    CreateIsolatedUserOptions, DeleteUserOptions, UserOperationResult,
223};
start_command/mod.rs

start_command/
mod.rs
