1use std::{
2 collections::BTreeMap,
3 env,
4 error::Error,
5 ffi::OsString,
6 fmt, fs, io,
7 net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr},
8 path::{Path, PathBuf},
9 process,
10 time::Duration,
11};
12
13use fs4::{FileExt, TryLockError};
14use subc_protocol::PROTOCOL_VERSION;
15pub use subc_transport::user_connection_token;
16use subc_transport::{
17 authenticate_client, connection_file, generate_daemon_id, generate_key, write_atomic,
18 AuthError, ConnectionFileError, ConnectionInfo, Endpoint, SCHEMA_VERSION,
19};
20use tokio::{
21 net::{TcpListener, TcpStream},
22 task::{JoinError, JoinHandle},
23 time::{sleep, timeout},
24};
25use tracing::{error, info, warn};
26
27use crate::{
28 daemon_config::{self, ConfiguredModule, DaemonConfigError},
29 server::{serve_listeners, ServerAuth, ServerError},
30 supervise::HealthConfig,
31 ConnectedClients, ControlHandler, DaemonSelfWatchdog, DaemonSelfWatchdogConfig,
32 ForwardingTable, Registry, RestartPolicy, Router, Supervisor, SupervisorHandle,
33 SupervisorProcessLiveness,
34};
35use std::sync::Arc;
36
37pub const DEFAULT_SUBC_PORT: u16 = 8757;
38pub const SUBC_PORT_ENV: &str = "SUBC_PORT";
39use subc_transport::CONNECTION_FILE_NAME;
40const DAEMON_VERSION: &str = env!("CARGO_PKG_VERSION");
41const CONNECT_TIMEOUT: Duration = Duration::from_secs(2);
42const PROBE_AUTH_DEADLINE: Duration = Duration::from_secs(2);
43const START_LOCK_RETRIES: usize = 40;
44const START_LOCK_RETRY_DELAY: Duration = Duration::from_millis(25);
45
46#[derive(Debug, Clone, Copy, PartialEq, Eq)]
47pub enum ConnectionFileSource {
48 XdgRuntimeDir,
49 TempDirFallback,
50 Explicit,
51}
52
53impl ConnectionFileSource {
54 fn reason(self) -> &'static str {
55 match self {
56 Self::XdgRuntimeDir => "XDG_RUNTIME_DIR set and non-empty",
57 Self::TempDirFallback => "XDG_RUNTIME_DIR unset or empty",
58 Self::Explicit => "configured path",
59 }
60 }
61}
62
63impl fmt::Display for ConnectionFileSource {
64 fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
65 formatter.write_str(match self {
66 Self::XdgRuntimeDir => "xdg_runtime_dir",
67 Self::TempDirFallback => "temp_dir_fallback",
68 Self::Explicit => "explicit",
69 })
70 }
71}
72
73#[derive(Debug, Clone, Default)]
77struct AdmissionFactsConfig {
78 carrier_module_id: Option<String>,
79 targets: Option<Vec<String>>,
80}
81
82#[derive(Debug, Clone, Default, PartialEq, Eq)]
91pub enum CgroupPlacementConfig {
92 #[default]
93 Disabled,
94 Current,
95 Root(PathBuf),
96}
97
98#[derive(Debug, Clone)]
99pub struct BootstrapConfig {
100 pub operator_queue_wait: Duration,
101 pub operator_timeout: Duration,
102 pub operator_stuck_grace: Duration,
103 #[cfg(feature = "test-support")]
104 pub operator_script: Option<PathBuf>,
105 #[cfg(feature = "test-support")]
106 pub operator_events: Option<PathBuf>,
107 pub connection_file_path: PathBuf,
108 pub port: u16,
109 pub daemon_ver: String,
110 configured_modules: Vec<ConfiguredModule>,
111 storage_config: Option<daemon_config::StorageConfig>,
112 admission_facts: AdmissionFactsConfig,
113 scope_authority_owners: Vec<String>,
115 daemon_config_path: Option<PathBuf>,
116 configured_port: Option<u16>,
117 route_bind_relay_default_ms: Option<u64>,
121 reserved_capabilities: BTreeMap<String, String>,
122 watchdog_config: DaemonSelfWatchdogConfig,
123 connection_file_source: ConnectionFileSource,
124 cgroup_placement: CgroupPlacementConfig,
127 capture_logs_dir: Option<PathBuf>,
131 terminal_journal_path: Option<PathBuf>,
139 machine_id_path: Option<PathBuf>,
145 live_children_path: Option<PathBuf>,
153 privacy_trampoline: Option<PathBuf>,
154}
155
156impl BootstrapConfig {
157 pub fn new(connection_file_path: impl Into<PathBuf>, port: u16) -> Self {
158 Self {
159 connection_file_path: connection_file_path.into(),
160 operator_queue_wait: Duration::from_secs(150),
161 operator_timeout: Duration::from_secs(120),
162 operator_stuck_grace: Duration::from_secs(10),
163 #[cfg(feature = "test-support")]
164 operator_script: None,
165 #[cfg(feature = "test-support")]
166 operator_events: None,
167 port,
168 daemon_ver: DAEMON_VERSION.to_owned(),
169 configured_modules: Vec::new(),
170 storage_config: None,
171 admission_facts: AdmissionFactsConfig::default(),
172 scope_authority_owners: daemon_config::default_scope_authority_owners(),
173 daemon_config_path: None,
174 configured_port: None,
175 route_bind_relay_default_ms: None,
176 reserved_capabilities: BTreeMap::new(),
177 watchdog_config: DaemonSelfWatchdogConfig::default(),
178 connection_file_source: ConnectionFileSource::Explicit,
179 cgroup_placement: CgroupPlacementConfig::default(),
180 capture_logs_dir: None,
181 terminal_journal_path: None,
182 machine_id_path: None,
183 live_children_path: None,
184 privacy_trampoline: None,
185 }
186 }
187
188 pub fn with_live_children_record(mut self, path: impl Into<PathBuf>) -> Self {
192 self.live_children_path = Some(path.into());
193 self
194 }
195
196 pub fn with_privacy_trampoline(mut self, path: impl Into<PathBuf>) -> Self {
199 self.privacy_trampoline = Some(path.into());
200 self
201 }
202
203 pub fn with_machine_id_path(mut self, path: impl Into<PathBuf>) -> Self {
207 self.machine_id_path = Some(path.into());
208 self
209 }
210
211 pub fn with_cgroup_placement(mut self, placement: CgroupPlacementConfig) -> Self {
213 self.cgroup_placement = placement;
214 self
215 }
216
217 pub fn with_capture_logs_dir(mut self, dir: impl Into<PathBuf>) -> Self {
221 self.capture_logs_dir = Some(dir.into());
222 self
223 }
224
225 pub fn with_terminal_journal_path(mut self, path: impl Into<PathBuf>) -> Self {
228 self.terminal_journal_path = Some(path.into());
229 self
230 }
231
232 pub fn from_env() -> Result<Self, BootstrapError> {
233 Self::from_env_with_daemon_config_path(daemon_config::default_config_path())
234 }
235
236 pub fn from_env_for_daemon_binary() -> Result<Self, BootstrapError> {
245 let run_dir = daemon_config::daemon_run_dir().map_err(BootstrapError::RunDir)?;
246 let machine_id_path =
247 crate::machine_id::default_machine_id_path().map_err(BootstrapError::MachineId)?;
248 let config = Self::from_env()?
249 .with_capture_logs_dir(run_dir.join("logs"))
250 .with_terminal_journal_path(run_dir.join("terminals.jsonl"))
251 .with_live_children_record(crate::live_children::record_path(&run_dir))
252 .with_machine_id_path(machine_id_path);
253 #[cfg(feature = "test-support")]
254 let config = {
255 let mut config = config;
256 config.operator_script =
257 std::env::var_os("SUBC_TEST_OPERATOR_SCRIPT").map(PathBuf::from);
258 config.operator_events =
259 std::env::var_os("SUBC_TEST_OPERATOR_EVENTS").map(PathBuf::from);
260 for (name, value) in [
261 (
262 "SUBC_TEST_OPERATOR_QUEUE_WAIT_MS",
263 &mut config.operator_queue_wait,
264 ),
265 (
266 "SUBC_TEST_OPERATOR_TIMEOUT_MS",
267 &mut config.operator_timeout,
268 ),
269 (
270 "SUBC_TEST_OPERATOR_STUCK_MS",
271 &mut config.operator_stuck_grace,
272 ),
273 ] {
274 if let Ok(ms) = std::env::var(name) {
275 if let Ok(ms) = ms.parse::<u64>() {
276 *value = Duration::from_millis(ms);
277 }
278 }
279 }
280 config
281 };
282 Ok(config)
283 }
284
285 pub fn from_env_with_daemon_config_path(
286 daemon_config_path: impl AsRef<Path>,
287 ) -> Result<Self, BootstrapError> {
288 let daemon_config_path = daemon_config_path.as_ref().to_path_buf();
289 let daemon_config =
290 daemon_config::load(&daemon_config_path).map_err(BootstrapError::DaemonConfig)?;
291 let config_port = daemon_config.as_ref().and_then(|config| config.port);
292 let storage_config = daemon_config
293 .as_ref()
294 .and_then(|config| config.storage.clone());
295 let admission_facts_carrier_module_id = daemon_config
296 .as_ref()
297 .and_then(|config| config.admission_facts_carrier_module_id.clone());
298 let admission_facts_targets = daemon_config
299 .as_ref()
300 .and_then(|config| config.admission_facts_targets.clone());
301 let scope_authority_owners = daemon_config
302 .as_ref()
303 .map(|config| config.scope_authority_owners.clone())
304 .unwrap_or_else(daemon_config::default_scope_authority_owners);
305 let route_bind_relay_default_ms = daemon_config
306 .as_ref()
307 .and_then(|config| config.route_bind_relay_timeout_ms);
308 let reserved_capabilities = daemon_config
309 .as_ref()
310 .map(|config| config.reserved_capabilities.clone())
311 .unwrap_or_default();
312 let configured_modules = daemon_config
313 .map(|config| config.modules)
314 .unwrap_or_default();
315
316 let port = match env::var(SUBC_PORT_ENV) {
317 Ok(raw) if !raw.trim().is_empty() => {
318 let port = raw
319 .parse::<u16>()
320 .map_err(|source| BootstrapError::InvalidPort { raw, source })?;
321 if let Some(config_port) = config_port {
322 info!(
323 env = SUBC_PORT_ENV,
324 env_port = port,
325 config_port,
326 "SUBC_PORT overrides daemon config port"
327 );
328 }
329 port
330 }
331 Ok(_) | Err(_) => config_port.unwrap_or(DEFAULT_SUBC_PORT),
332 };
333
334 let (connection_file_path, connection_file_source) =
335 connection_file_path_with_source(non_empty_os_var("XDG_RUNTIME_DIR"));
336 Ok(Self::new(connection_file_path, port)
337 .with_configured_modules(configured_modules)
338 .with_storage_config(storage_config)
339 .with_admission_facts_config(admission_facts_carrier_module_id, admission_facts_targets)
340 .with_scope_authority_owners(scope_authority_owners)
341 .with_route_bind_relay_default_ms(route_bind_relay_default_ms)
342 .with_reserved_capabilities(reserved_capabilities)
343 .with_daemon_config_source(daemon_config_path, config_port)
344 .with_connection_file_source(connection_file_source))
345 }
346
347 pub fn with_daemon_config_path(
348 self,
349 daemon_config_path: impl AsRef<Path>,
350 ) -> Result<Self, BootstrapError> {
351 let daemon_config_path = daemon_config_path.as_ref().to_path_buf();
352 let daemon_config =
353 daemon_config::load(&daemon_config_path).map_err(BootstrapError::DaemonConfig)?;
354 let configured_port = daemon_config.as_ref().and_then(|config| config.port);
355 let storage_config = daemon_config
356 .as_ref()
357 .and_then(|config| config.storage.clone());
358 let admission_facts_carrier_module_id = daemon_config
359 .as_ref()
360 .and_then(|config| config.admission_facts_carrier_module_id.clone());
361 let admission_facts_targets = daemon_config
362 .as_ref()
363 .and_then(|config| config.admission_facts_targets.clone());
364 let scope_authority_owners = daemon_config
365 .as_ref()
366 .map(|config| config.scope_authority_owners.clone())
367 .unwrap_or_else(daemon_config::default_scope_authority_owners);
368 let route_bind_relay_default_ms = daemon_config
369 .as_ref()
370 .and_then(|config| config.route_bind_relay_timeout_ms);
371 let reserved_capabilities = daemon_config
372 .as_ref()
373 .map(|config| config.reserved_capabilities.clone())
374 .unwrap_or_default();
375 let configured_modules = daemon_config
376 .map(|config| config.modules)
377 .unwrap_or_default();
378 Ok(self
379 .with_configured_modules(configured_modules)
380 .with_storage_config(storage_config)
381 .with_admission_facts_config(admission_facts_carrier_module_id, admission_facts_targets)
382 .with_scope_authority_owners(scope_authority_owners)
383 .with_route_bind_relay_default_ms(route_bind_relay_default_ms)
384 .with_reserved_capabilities(reserved_capabilities)
385 .with_daemon_config_source(daemon_config_path, configured_port))
386 }
387
388 pub fn with_configured_modules(
389 mut self,
390 modules: impl IntoIterator<Item = ConfiguredModule>,
391 ) -> Self {
392 self.configured_modules = modules.into_iter().collect();
393 self.configured_modules
394 .sort_by(|left, right| left.module_id.cmp(&right.module_id));
395 self
396 }
397
398 pub fn with_storage_config(
399 mut self,
400 storage_config: Option<daemon_config::StorageConfig>,
401 ) -> Self {
402 self.storage_config = storage_config;
403 self
404 }
405
406 pub fn with_admission_facts_config(
407 mut self,
408 carrier_module_id: Option<String>,
409 targets: Option<Vec<String>>,
410 ) -> Self {
411 self.admission_facts = AdmissionFactsConfig {
412 carrier_module_id,
413 targets,
414 };
415 self
416 }
417
418 pub fn with_scope_authority_owners(mut self, owners: Vec<String>) -> Self {
421 self.scope_authority_owners = owners;
422 self
423 }
424
425 pub fn with_route_bind_relay_default_ms(mut self, ms: Option<u64>) -> Self {
430 self.route_bind_relay_default_ms = ms;
431 self
432 }
433
434 pub fn with_reserved_capabilities(
435 mut self,
436 reserved_capabilities: BTreeMap<String, String>,
437 ) -> Self {
438 self.reserved_capabilities = reserved_capabilities;
439 self
440 }
441
442 fn with_daemon_config_source(
443 mut self,
444 daemon_config_path: PathBuf,
445 configured_port: Option<u16>,
446 ) -> Self {
447 self.daemon_config_path = Some(daemon_config_path);
448 self.configured_port = configured_port;
449 self
450 }
451
452 fn with_connection_file_source(mut self, source: ConnectionFileSource) -> Self {
453 self.connection_file_source = source;
454 self
455 }
456
457 pub fn with_watchdog_config(mut self, watchdog_config: DaemonSelfWatchdogConfig) -> Self {
458 self.watchdog_config = watchdog_config;
459 self
460 }
461}
462
463#[allow(clippy::large_enum_variant)]
467#[derive(Debug)]
468pub enum Outcome {
469 AlreadyRunning,
471 Bound(BoundDaemon),
474}
475
476#[derive(Debug)]
477pub struct BoundDaemon {
478 pub listeners: Vec<TcpListener>,
479 pub connection_info: ConnectionInfo,
480 pub connection_file_path: PathBuf,
481 pub connection_file_source: ConnectionFileSource,
482 pub machine_id: Option<crate::machine_id::MachineId>,
485 run_dir_lock: Option<crate::run_dir_lock::RunDirLock>,
489 publication_lock: Option<StartLock>,
495}
496
497pub fn connection_file_path() -> PathBuf {
504 connection_file_path_with_source(non_empty_os_var("XDG_RUNTIME_DIR")).0
505}
506
507fn connection_file_path_with_source(
508 runtime_dir: Option<OsString>,
509) -> (PathBuf, ConnectionFileSource) {
510 if let Some(runtime_dir) = runtime_dir.filter(|value| !value.is_empty()) {
511 return (
512 PathBuf::from(runtime_dir).join(CONNECTION_FILE_NAME),
513 ConnectionFileSource::XdgRuntimeDir,
514 );
515 }
516
517 (
518 env::temp_dir().join(format!("subc-{}.connection.json", user_connection_token())),
519 ConnectionFileSource::TempDirFallback,
520 )
521}
522
523pub async fn run() -> Result<(), BootstrapError> {
529 run_with_config(
532 BootstrapConfig::from_env_for_daemon_binary()?
533 .with_cgroup_placement(CgroupPlacementConfig::Current),
534 )
535 .await
536}
537
538pub async fn run_with_config(config: BootstrapConfig) -> Result<(), BootstrapError> {
562 let forwarding = Arc::new(ForwardingTable::default());
563 forwarding.operator_confirms().configure_bootstrap(&config);
564 let configured_modules = config.configured_modules.clone();
565 let storage_config = config.storage_config.clone();
566 let admission_facts = config.admission_facts.clone();
567 let scope_authority_owners = config.scope_authority_owners.clone();
568 let daemon_config_path = config.daemon_config_path.clone();
569 let configured_port = config.configured_port;
570 let route_bind_relay_default_ms = config.route_bind_relay_default_ms;
571 let reserved_capabilities = config.reserved_capabilities.clone();
572 let watchdog_config = config.watchdog_config.clone();
573 let cgroup_placement_config = config.cgroup_placement.clone();
574 let capture_logs_dir = config.capture_logs_dir.clone();
575 let terminal_journal_path = config.terminal_journal_path.clone();
576 let live_children_path = config.live_children_path.clone();
577 let privacy_trampoline = config.privacy_trampoline.clone();
578 match ensure_singleton_inner(config, false).await? {
579 Outcome::AlreadyRunning => {
580 info!("subc daemon already running");
581 Ok(())
582 }
583 Outcome::Bound(bound) => {
584 #[cfg(target_os = "linux")]
585 let cgroup_placement = prepare_cgroup_placement(&cgroup_placement_config);
586 #[cfg(not(target_os = "linux"))]
587 let _ = cgroup_placement_config;
588 serve_bound_daemon(
589 bound,
590 forwarding,
591 configured_modules,
592 storage_config,
593 admission_facts,
594 scope_authority_owners,
595 daemon_config_path,
596 configured_port,
597 route_bind_relay_default_ms,
598 reserved_capabilities,
599 watchdog_config,
600 capture_logs_dir,
601 terminal_journal_path,
602 live_children_path,
603 privacy_trampoline,
604 #[cfg(target_os = "linux")]
605 cgroup_placement,
606 )
607 .await
608 }
609 }
610}
611
612#[cfg(target_os = "linux")]
613fn prepare_cgroup_placement(config: &CgroupPlacementConfig) -> Option<subc_cgroup::Placement> {
614 let result = match config {
615 CgroupPlacementConfig::Disabled => return None,
616 CgroupPlacementConfig::Current => subc_cgroup::prepare_current(),
617 CgroupPlacementConfig::Root(root) => subc_cgroup::prepare_at(root),
618 };
619
620 match result {
621 Ok(Some(placement)) => Some(placement),
622 Ok(None) => {
623 warn!(
624 placement = ?config,
625 "module cgroup placement is disabled: configured cgroup root is not delegated"
626 );
627 None
628 }
629 Err(error) => {
630 warn!(
631 placement = ?config,
632 error = %error,
633 "module cgroup placement is disabled by an unexpected cgroup probe error"
634 );
635 None
636 }
637 }
638}
639
640#[cfg(unix)]
647const NOFILE_TARGET: u64 = 65536;
648
649#[cfg(unix)]
653fn raise_nofile_limit() {
654 #[cfg(target_os = "macos")]
655 let ceiling = std::process::Command::new("/usr/sbin/sysctl")
656 .args(["-n", "kern.maxfilesperproc"])
657 .output()
658 .ok()
659 .filter(|output| output.status.success())
660 .and_then(|output| String::from_utf8(output.stdout).ok())
661 .and_then(|value| value.trim().parse::<u64>().ok())
662 .filter(|value| *value > 0);
663 #[cfg(not(target_os = "macos"))]
664 let ceiling = None;
665 raise_nofile_limit_with_ceiling(ceiling);
666}
667
668#[cfg(unix)]
669fn raise_nofile_limit_with_ceiling(kernel_ceiling: Option<u64>) {
670 match rlimit::Resource::NOFILE.get() {
671 Ok((soft, hard)) => {
672 let target = NOFILE_TARGET
676 .min(hard)
677 .min(kernel_ceiling.unwrap_or(u64::MAX));
678 if soft >= target {
679 return;
680 }
681 match rlimit::Resource::NOFILE.set(target, hard) {
682 Ok(()) => info!(
683 previous_soft = soft,
684 new_soft = target,
685 hard,
686 "raised open-file soft limit for daemon and module children"
687 ),
688 Err(err) => warn!(
689 soft,
690 hard,
691 error = %err,
692 "could not raise open-file soft limit; multi-root modules may exhaust descriptors"
693 ),
694 }
695 }
696 Err(err) => warn!(error = %err, "could not read open-file limit"),
697 }
698}
699
700#[cfg(windows)]
707fn raise_nofile_limit() {
708 const MAXSTDIO_TARGET: u32 = 8192;
709 let current = rlimit::getmaxstdio();
710 if current >= MAXSTDIO_TARGET {
711 return;
712 }
713 match rlimit::setmaxstdio(MAXSTDIO_TARGET) {
714 Ok(new_max) => info!(
715 previous = current,
716 new_max, "raised CRT stdio-stream limit for daemon"
717 ),
718 Err(err) => warn!(
719 current,
720 error = %err,
721 "could not raise CRT stdio-stream limit"
722 ),
723 }
724}
725
726#[cfg(not(any(unix, windows)))]
727fn raise_nofile_limit() {}
728
729pub async fn run_with_daemon_config_path(
730 config: BootstrapConfig,
731 daemon_config_path: impl AsRef<Path>,
732) -> Result<(), BootstrapError> {
733 run_with_config(config.with_daemon_config_path(daemon_config_path)?).await
734}
735
736#[allow(clippy::too_many_arguments)]
737async fn serve_bound_daemon(
738 bound: BoundDaemon,
739 forwarding: Arc<ForwardingTable>,
740 configured_modules: Vec<ConfiguredModule>,
741 storage_config: Option<daemon_config::StorageConfig>,
742 admission_facts: AdmissionFactsConfig,
743 scope_authority_owners: Vec<String>,
744 daemon_config_path: Option<PathBuf>,
745 configured_port: Option<u16>,
746 route_bind_relay_default_ms: Option<u64>,
747 reserved_capabilities: BTreeMap<String, String>,
748 watchdog_config: DaemonSelfWatchdogConfig,
749 capture_logs_dir: Option<PathBuf>,
750 terminal_journal_path: Option<PathBuf>,
751 live_children_path: Option<PathBuf>,
752 privacy_trampoline: Option<PathBuf>,
753 #[cfg(target_os = "linux")] cgroup_placement: Option<subc_cgroup::Placement>,
754) -> Result<(), BootstrapError> {
755 #[cfg(unix)]
756 let mut terminate = tokio::signal::unix::signal(tokio::signal::unix::SignalKind::terminate())
757 .map_err(BootstrapError::Signal)?;
758 raise_nofile_limit();
761
762 info!(
763 connection_file = %bound.connection_file_path.display(),
764 connection_file_source = %bound.connection_file_source,
765 connection_file_source_reason = bound.connection_file_source.reason(),
766 endpoints = ?bound.connection_info.endpoints,
767 configured_modules = configured_modules.len(),
768 machine_id = bound.machine_id.as_ref().map(|id| id.as_str()).unwrap_or("none"),
769 "subc daemon starting"
770 );
771
772 let run_dir_lock = bound.run_dir_lock;
783 let publication_lock = bound.publication_lock;
784 if let Some(owner) = &run_dir_lock {
785 crate::live_children::sweep_orphans(
786 owner,
787 &crate::live_children::AdoptedPids::none(),
788 crate::live_children::SweepBounds::default(),
789 )
790 .await;
791 }
792
793 let registry = Arc::new(Registry::default());
794 let process_liveness = Arc::new(SupervisorProcessLiveness::new());
795 let supervisor_handle = SupervisorHandle::new();
796 let connected_clients = ConnectedClients::new();
797 let daemon_incarnation = format!(
798 "{:032x}",
799 u128::from_be_bytes(bound.connection_info.daemon_id)
800 );
801 let supervisor = Supervisor::new(Arc::clone(®istry), RestartPolicy::default())
802 .with_process_liveness(process_liveness.clone())
803 .with_forwarding(Arc::clone(&forwarding))
804 .with_handle(supervisor_handle.clone())
805 .with_connection_file_path(bound.connection_file_path.clone())
806 .with_daemon_incarnation(daemon_incarnation.clone());
807 let supervisor = match privacy_trampoline {
808 Some(path) => supervisor.with_privacy_trampoline(path),
809 None => supervisor,
810 };
811 let supervisor = match terminal_journal_path {
848 Some(path) => supervisor.with_terminal_journal(path, daemon_incarnation),
849 None => supervisor,
850 };
851 let supervisor = match capture_logs_dir {
852 Some(dir) => supervisor.with_capture_logs_dir(dir),
853 None => supervisor,
854 };
855 let supervisor = match live_children_path {
856 Some(path) => supervisor.with_live_children_record(path),
857 None => supervisor,
858 };
859 #[cfg(target_os = "linux")]
860 let supervisor = supervisor.with_cgroup_placement(cgroup_placement);
861 let route_bind_relay_timeouts = configured_modules
867 .iter()
868 .filter_map(|module| {
869 module
870 .route_bind_relay_timeout_ms
871 .map(|ms| (module.module_id.clone(), Duration::from_millis(ms)))
872 })
873 .collect::<std::collections::BTreeMap<_, _>>();
874 let control_start_clock = crate::clock::StartClock::capture();
875 let mut control = ControlHandler::with_forwarding(Arc::clone(®istry), forwarding)
876 .with_process_liveness(process_liveness)
877 .with_supervisor(supervisor_handle)
878 .with_connected_clients(connected_clients.clone())
879 .with_storage_config(storage_config)
880 .with_machine_id(bound.machine_id.clone())
881 .with_admission_facts_config(admission_facts.carrier_module_id, admission_facts.targets)
882 .with_scope_authority_owners(scope_authority_owners)
883 .with_route_bind_relay_timeouts(route_bind_relay_timeouts)
884 .with_daemon_provenance(
885 bound.connection_info.pid,
886 control_start_clock.started_at_ms(),
887 std::env::current_exe().ok(),
888 normalized_build_provenance(env!("SUBC_BUILD_GIT_SHA")),
889 normalized_build_provenance(env!("SUBC_BUILD_LOCK_DIGEST")),
890 )
891 .with_daemon_start_clock(control_start_clock)
892 .with_capability_config(
893 configured_modules
894 .iter()
895 .map(|module| (module.module_id.clone(), module.enabled)),
896 reserved_capabilities,
897 );
898 if let Some(ms) = route_bind_relay_default_ms {
899 control = control.with_route_bind_relay_timeout(Duration::from_millis(ms));
902 }
903 if let Some(config_path) = daemon_config_path {
904 control = control.with_supervisor_rescan(supervisor.clone(), config_path, configured_port);
905 }
906 let control = Arc::new(control);
907 let router = Arc::new(Router::with_control_handler(Arc::clone(&control)));
908 let auth = ServerAuth::new(
909 bound.connection_info.key.clone(),
910 bound.connection_info.daemon_id,
911 bound.connection_info.daemon_ver.clone(),
912 )
913 .with_connected_clients(connected_clients);
914
915 let mut serve_task =
916 AbortOnDrop::new(tokio::spawn(serve_listeners(bound.listeners, router, auth)));
917 verify_serving(&bound.connection_info).await?;
918 write_atomic(&bound.connection_file_path, &bound.connection_info).map_err(|source| {
922 BootstrapError::ConnectionFileWrite {
923 path: bound.connection_file_path.clone(),
924 source,
925 }
926 })?;
927 drop(publication_lock);
928 let _clock_step_task = AbortOnDrop::new(crate::watchdog::spawn_clock_step_monitor());
929 #[cfg(target_os = "linux")]
931 let _kill_mode_check = AbortOnDrop::new(tokio::spawn(
932 crate::systemd_kill_mode::warn_if_kill_mode_defeats_ordered_shutdown(),
933 ));
934 let _watchdog_task = AbortOnDrop::new(
935 DaemonSelfWatchdog::new(
936 bound.connection_info.clone(),
937 bound.connection_file_path.clone(),
938 )
939 .with_config(watchdog_config)
940 .spawn(),
941 );
942
943 for configured in configured_modules {
944 let enabled = configured.enabled;
945 let health = configured.health.clone();
946 let module_id = configured.module_id.clone();
947 match supervisor.supervise_configured_with_health(
948 configured.module_spec(),
949 enabled,
950 health.clone(),
951 configured.drain_timeout_ms,
952 configured.restart,
953 ) {
954 Ok(_) => {
955 let default_threshold = HealthConfig::default().failure_threshold;
964 if enabled && health.failure_threshold > default_threshold {
965 warn!(
966 module_id = %module_id,
967 failure_threshold = health.failure_threshold,
968 default_threshold,
969 tolerance_secs = health.cadence.as_secs() * u64::from(health.failure_threshold),
970 "health failure threshold is relaxed above the default; a wedged module stays unflagged for longer"
971 );
972 }
973 info!(module_id = %module_id, enabled, "configured module supervised");
974 }
975 Err(err) => {
976 error!(module_id = %module_id, error = %err, "failed to supervise configured module; continuing daemon startup");
977 }
978 }
979 }
980
981 control.refresh_capability_requirements();
982 Arc::clone(&control).spawn_capability_deadline_loop();
983
984 #[cfg(unix)]
985 {
986 tokio::select! {
987 result = serve_task.join() => {
988 return result.map_err(BootstrapError::ServeJoin)?.map_err(BootstrapError::Serve);
989 }
990 _ = terminate.recv() => {}
991 }
992 supervisor.begin_daemon_shutdown();
997 drop(_watchdog_task);
1001 drop(serve_task);
1004 let escalated = tokio::select! {
1005 biased;
1006 _ = terminate.recv() => {
1007 info!("second SIGTERM: abandoning daemon shutdown wait");
1008 true
1009 }
1010 result = supervisor.drain_for_daemon_shutdown() => {
1011 if let Err(error) = result {
1012 warn!(%error, "daemon shutdown drain failed; exiting anyway");
1013 }
1014 false
1015 }
1016 };
1017 supervisor
1024 .end_children_for_daemon_shutdown(escalated, async {
1025 terminate.recv().await;
1026 })
1027 .await;
1028 Ok(())
1029 }
1030 #[cfg(not(unix))]
1031 serve_task
1032 .join()
1033 .await
1034 .map_err(BootstrapError::ServeJoin)?
1035 .map_err(BootstrapError::Serve)
1036}
1037
1038fn normalized_build_provenance(value: &str) -> Option<String> {
1039 match value.trim() {
1040 "" | "unavailable" => None,
1041 value => Some(value.to_string()),
1042 }
1043}
1044
1045pub async fn ensure_singleton(
1053 connection_file_path: impl AsRef<Path>,
1054 port: u16,
1055) -> Result<Outcome, BootstrapError> {
1056 ensure_singleton_with_config(BootstrapConfig::new(connection_file_path.as_ref(), port)).await
1057}
1058
1059pub async fn ensure_singleton_with_config(
1060 config: BootstrapConfig,
1061) -> Result<Outcome, BootstrapError> {
1062 ensure_singleton_inner(config, true).await
1063}
1064
1065async fn ensure_singleton_inner(
1066 config: BootstrapConfig,
1067 publish: bool,
1068) -> Result<Outcome, BootstrapError> {
1069 let path = config.connection_file_path;
1070
1071 if matches!(probe_existing(&path).await?, Probe::Live) {
1072 return Ok(Outcome::AlreadyRunning);
1073 }
1074
1075 let lock = StartLock::acquire(&path).await?;
1076
1077 if matches!(probe_existing(&path).await?, Probe::Live) {
1081 return Ok(Outcome::AlreadyRunning);
1082 }
1083
1084 let run_dir_lock = config
1090 .live_children_path
1091 .as_deref()
1092 .map(crate::run_dir_lock::RunDirLock::acquire)
1093 .transpose()?;
1094
1095 remove_stale_connection_file_if_present(&path)?;
1096
1097 let machine_id = config
1101 .machine_id_path
1102 .as_deref()
1103 .map(crate::machine_id::load_or_mint)
1104 .transpose()
1105 .map_err(BootstrapError::MachineId)?;
1106
1107 let (listeners, endpoints) = bind_loopback(config.port).await?;
1108 let connection_info = ConnectionInfo {
1109 schema: SCHEMA_VERSION,
1110 wire_version: Some(PROTOCOL_VERSION),
1111 endpoints,
1112 key: generate_key().map_err(BootstrapError::GenerateConnectionFile)?,
1113 daemon_id: generate_daemon_id().map_err(BootstrapError::GenerateConnectionFile)?,
1114 pid: process::id(),
1115 daemon_ver: config.daemon_ver,
1116 };
1117
1118 if publish {
1122 if let Err(source) = write_atomic(&path, &connection_info) {
1123 drop(listeners);
1124 return Err(BootstrapError::ConnectionFileWrite { path, source });
1125 }
1126 }
1127
1128 Ok(Outcome::Bound(BoundDaemon {
1129 listeners,
1130 connection_info,
1131 connection_file_path: path,
1132 connection_file_source: config.connection_file_source,
1133 machine_id,
1134 run_dir_lock,
1135 publication_lock: (!publish).then_some(lock),
1136 }))
1137}
1138
1139#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1140enum Probe {
1141 Live,
1142 StaleOrAbsent,
1143}
1144
1145async fn probe_existing(path: &Path) -> Result<Probe, BootstrapError> {
1146 let info = match connection_file::read(path) {
1147 Ok(info) => info,
1148 Err(source) if is_absent_or_stale_connection_file(&source) => {
1149 return Ok(Probe::StaleOrAbsent)
1150 }
1151 Err(source) => {
1152 return Err(BootstrapError::ConnectionFileRead {
1153 path: path.to_path_buf(),
1154 source,
1155 })
1156 }
1157 };
1158
1159 for endpoint in &info.endpoints {
1160 if matches!(probe_endpoint(&info, endpoint).await, Probe::Live) {
1161 return Ok(Probe::Live);
1162 }
1163 }
1164
1165 Ok(Probe::StaleOrAbsent)
1166}
1167
1168async fn probe_endpoint(info: &ConnectionInfo, endpoint: &Endpoint) -> Probe {
1169 let Ok(ip) = endpoint.host.parse::<IpAddr>() else {
1170 return Probe::StaleOrAbsent;
1171 };
1172 if !ip.is_loopback() {
1173 return Probe::StaleOrAbsent;
1174 }
1175 let addr = SocketAddr::new(ip, endpoint.port);
1176
1177 let mut stream = match timeout(CONNECT_TIMEOUT, TcpStream::connect(addr)).await {
1178 Ok(Ok(stream)) => stream,
1179 Ok(Err(_)) | Err(_) => return Probe::StaleOrAbsent,
1180 };
1181
1182 match authenticate_client(&mut stream, info, PROBE_AUTH_DEADLINE).await {
1183 Ok(()) => Probe::Live,
1184 Err(AuthError::DaemonIdMismatch)
1185 | Err(AuthError::InvalidServerProof)
1186 | Err(AuthError::UnexpectedEof { .. })
1187 | Err(AuthError::Timeout { .. })
1188 | Err(AuthError::JsonEncode { .. })
1189 | Err(AuthError::JsonDecode { .. })
1190 | Err(AuthError::Io { .. })
1191 | Err(AuthError::MessageTooLarge { .. })
1192 | Err(AuthError::KeyTooShort { .. })
1193 | Err(AuthError::Random(_))
1194 | Err(AuthError::InvalidClientAuth) => Probe::StaleOrAbsent,
1195 }
1196}
1197
1198async fn verify_serving(info: &ConnectionInfo) -> Result<(), BootstrapError> {
1199 if let Some(endpoint) = info.endpoints.first() {
1203 if matches!(probe_endpoint(info, endpoint).await, Probe::Live) {
1204 return Ok(());
1205 }
1206 }
1207 Err(BootstrapError::StartupNotServing)
1208}
1209
1210fn is_absent_or_stale_connection_file(err: &ConnectionFileError) -> bool {
1211 match err {
1212 ConnectionFileError::Io { source, .. } if source.kind() == io::ErrorKind::NotFound => true,
1213 ConnectionFileError::JsonRead { .. }
1214 | ConnectionFileError::UnsupportedSchema { .. }
1215 | ConnectionFileError::Invalid { .. }
1216 | ConnectionFileError::KeyTooShort { .. }
1217 | ConnectionFileError::InsecurePermissions { .. } => true,
1221 ConnectionFileError::MissingParent { .. }
1222 | ConnectionFileError::MissingFileName { .. }
1223 | ConnectionFileError::InsecureParentDirectory { .. }
1227 | ConnectionFileError::Io { .. }
1228 | ConnectionFileError::JsonWrite { .. }
1229 | ConnectionFileError::Random(_)
1230 | ConnectionFileError::WireVersionMismatch { .. } => false,
1233 }
1234}
1235
1236fn remove_stale_connection_file_if_present(path: &Path) -> Result<(), BootstrapError> {
1237 match fs::remove_file(path) {
1238 Ok(()) => Ok(()),
1239 Err(err) if err.kind() == io::ErrorKind::NotFound => Ok(()),
1240 Err(source) => Err(BootstrapError::RemoveStale {
1241 path: path.to_path_buf(),
1242 source,
1243 }),
1244 }
1245}
1246
1247async fn bind_loopback(port: u16) -> Result<(Vec<TcpListener>, Vec<Endpoint>), BootstrapError> {
1248 bind_loopback_with(port, |port| TcpListener::bind((Ipv6Addr::LOCALHOST, port))).await
1249}
1250
1251async fn bind_loopback_with<F, Fut>(
1252 port: u16,
1253 mut bind_v6: F,
1254) -> Result<(Vec<TcpListener>, Vec<Endpoint>), BootstrapError>
1255where
1256 F: FnMut(u16) -> Fut,
1257 Fut: std::future::Future<Output = io::Result<TcpListener>>,
1258{
1259 let v4_host = Ipv4Addr::LOCALHOST;
1260 let v4 = TcpListener::bind((v4_host, port))
1261 .await
1262 .map_err(|source| BootstrapError::Bind {
1263 host: v4_host.to_string(),
1264 port,
1265 source,
1266 })?;
1267 let actual_port = v4
1268 .local_addr()
1269 .map_err(|source| BootstrapError::LocalAddr {
1270 host: v4_host.to_string(),
1271 source,
1272 })?
1273 .port();
1274
1275 let mut listeners = vec![v4];
1276 let mut endpoints = vec![Endpoint {
1277 host: v4_host.to_string(),
1278 port: actual_port,
1279 }];
1280
1281 let v6_host = Ipv6Addr::LOCALHOST;
1282 match bind_v6(actual_port).await {
1283 Ok(v6) => {
1284 listeners.push(v6);
1285 endpoints.push(Endpoint {
1286 host: v6_host.to_string(),
1287 port: actual_port,
1288 });
1289 }
1290 Err(err)
1291 if ipv6_loopback_unavailable(&err)
1292 || (port == 0 && err.kind() == io::ErrorKind::AddrInUse) =>
1293 {
1294 warn!(
1295 port = actual_port,
1296 error = %err,
1297 "IPv6 loopback unavailable; serving only IPv4 loopback"
1298 );
1299 }
1300 Err(source) => {
1301 drop(listeners);
1302 return Err(BootstrapError::Bind {
1303 host: v6_host.to_string(),
1304 port: actual_port,
1305 source,
1306 });
1307 }
1308 }
1309
1310 Ok((listeners, endpoints))
1311}
1312
1313fn ipv6_loopback_unavailable(err: &io::Error) -> bool {
1314 matches!(
1315 err.kind(),
1316 io::ErrorKind::AddrNotAvailable | io::ErrorKind::Unsupported
1317 ) || matches!(err.raw_os_error(), Some(47) | Some(49) | Some(97))
1318}
1319
1320struct AbortOnDrop<T> {
1321 handle: JoinHandle<T>,
1322}
1323
1324impl<T> AbortOnDrop<T> {
1325 fn new(handle: JoinHandle<T>) -> Self {
1326 Self { handle }
1327 }
1328
1329 async fn join(&mut self) -> Result<T, JoinError> {
1330 (&mut self.handle).await
1331 }
1332}
1333
1334impl<T> Drop for AbortOnDrop<T> {
1335 fn drop(&mut self) {
1336 if !self.handle.is_finished() {
1337 self.handle.abort();
1338 }
1339 }
1340}
1341
1342#[derive(Debug)]
1343struct StartLock {
1344 _file: fs::File,
1347}
1348
1349impl StartLock {
1350 async fn acquire(connection_file_path: &Path) -> Result<Self, BootstrapError> {
1351 let path = start_lock_path(connection_file_path);
1352 for _ in 0..START_LOCK_RETRIES {
1353 let file = match open_owner_only_lock(&path) {
1354 Ok(file) => file,
1355 Err(source) => return Err(BootstrapError::StartLockCreate { path, source }),
1356 };
1357 match FileExt::try_lock(&file) {
1358 Ok(()) => return Ok(Self { _file: file }),
1359 Err(TryLockError::WouldBlock) => sleep(START_LOCK_RETRY_DELAY).await,
1360 Err(TryLockError::Error(source)) => {
1361 return Err(BootstrapError::StartLockCreate { path, source });
1362 }
1363 }
1364 }
1365
1366 Err(BootstrapError::StartLockBusy {
1367 path,
1368 attempts: START_LOCK_RETRIES,
1369 })
1370 }
1371}
1372
1373pub(crate) fn open_owner_only_lock(path: &Path) -> io::Result<fs::File> {
1374 let mut options = fs::OpenOptions::new();
1375 options.read(true).write(true).create(true);
1376 #[cfg(unix)]
1377 {
1378 use std::os::unix::fs::OpenOptionsExt;
1379 options.mode(0o600);
1380 }
1381 options.open(path)
1382}
1383
1384fn start_lock_path(connection_file_path: &Path) -> PathBuf {
1385 let file_name = connection_file_path
1386 .file_name()
1387 .map(|name| name.to_string_lossy())
1388 .unwrap_or_else(|| CONNECTION_FILE_NAME.into());
1389 let lock_name = format!("{file_name}.start-lock");
1390 connection_file_path
1391 .parent()
1392 .filter(|parent| !parent.as_os_str().is_empty())
1393 .unwrap_or_else(|| Path::new("."))
1394 .join(lock_name)
1395}
1396
1397fn non_empty_os_var(key: &str) -> Option<OsString> {
1398 let value = env::var_os(key)?;
1399 if value.is_empty() {
1400 None
1401 } else {
1402 Some(value)
1403 }
1404}
1405
1406#[derive(Debug)]
1409pub enum BootstrapError {
1410 StartupNotServing,
1412 #[cfg(unix)]
1413 Signal(io::Error),
1414 InvalidPort {
1415 raw: String,
1416 source: std::num::ParseIntError,
1417 },
1418 ConnectionFileRead {
1419 path: PathBuf,
1420 source: ConnectionFileError,
1421 },
1422 ConnectionFileWrite {
1423 path: PathBuf,
1424 source: ConnectionFileError,
1425 },
1426 GenerateConnectionFile(ConnectionFileError),
1427 StartLockCreate {
1428 path: PathBuf,
1429 source: io::Error,
1430 },
1431 StartLockBusy {
1432 path: PathBuf,
1433 attempts: usize,
1434 },
1435 RunDirLockCreate {
1437 path: PathBuf,
1438 source: io::Error,
1439 },
1440 RunDirBusy {
1445 path: PathBuf,
1446 holder_pid: Option<u32>,
1447 },
1448 RemoveStale {
1449 path: PathBuf,
1450 source: io::Error,
1451 },
1452 Bind {
1453 host: String,
1454 port: u16,
1455 source: io::Error,
1456 },
1457 LocalAddr {
1458 host: String,
1459 source: io::Error,
1460 },
1461 DaemonConfig(DaemonConfigError),
1462 MachineId(crate::machine_id::MachineIdFileError),
1465 RunDir(daemon_config::DaemonRunDirError),
1468 Serve(ServerError),
1469 ServeJoin(tokio::task::JoinError),
1470}
1471
1472impl fmt::Display for BootstrapError {
1473 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1474 match self {
1475 Self::StartupNotServing => write!(f, "bound daemon did not authenticate its readiness probe; connection file was not published"),
1476 #[cfg(unix)]
1477 Self::Signal(error) => write!(f, "failed to register SIGTERM handler: {error}"),
1478 Self::InvalidPort { raw, source } => {
1479 write!(f, "invalid {SUBC_PORT_ENV} value '{raw}': {source}")
1480 }
1481 Self::ConnectionFileRead { path, source } => write!(
1482 f,
1483 "failed to read connection file {}: {source}",
1484 path.display()
1485 ),
1486 Self::ConnectionFileWrite { path, source } => write!(
1487 f,
1488 "failed to publish connection file {}: {source}",
1489 path.display()
1490 ),
1491 Self::GenerateConnectionFile(err) => {
1492 write!(f, "failed to generate connection-file auth material: {err}")
1493 }
1494 Self::StartLockCreate { path, source } => {
1495 write!(
1496 f,
1497 "failed to create start lock {}: {source}",
1498 path.display()
1499 )
1500 }
1501 Self::StartLockBusy { path, attempts } => write!(
1502 f,
1503 "start lock {} remained busy after {attempts} attempts",
1504 path.display()
1505 ),
1506 Self::RunDirLockCreate { path, source } => write!(
1507 f,
1508 "refusing to start: failed to lock run directory via {}: {source}",
1509 path.display()
1510 ),
1511 Self::RunDirBusy { path, holder_pid } => {
1512 write!(
1513 f,
1514 "refusing to start: run directory lock {} is held by another daemon",
1515 path.display()
1516 )?;
1517 if let Some(pid) = holder_pid {
1518 write!(f, " (pid {pid})")?;
1519 }
1520 write!(
1521 f,
1522 "; a live daemon owns this data home's run state (typically one started with a different XDG_RUNTIME_DIR)"
1523 )
1524 }
1525 Self::RemoveStale { path, source } => write!(
1526 f,
1527 "failed to remove stale connection file {}: {source}",
1528 path.display()
1529 ),
1530 Self::Bind { host, port, source } if source.kind() == io::ErrorKind::AddrInUse => {
1531 write!(
1532 f,
1533 "port {port} in use on loopback {host}: {source}; set the port in config"
1534 )
1535 }
1536 Self::Bind { host, port, source } => {
1537 write!(f, "failed to bind loopback TCP {host}:{port}: {source}")
1538 }
1539 Self::LocalAddr { host, source } => {
1540 write!(f, "failed to read local address for {host}: {source}")
1541 }
1542 Self::DaemonConfig(err) => write!(f, "failed to load daemon config: {err}"),
1543 Self::MachineId(err) => write!(f, "refusing to start: {err}"),
1544 Self::RunDir(err) => write!(f, "refusing to start: {err}"),
1545 Self::Serve(err) => write!(f, "daemon server failed: {err}"),
1546 Self::ServeJoin(err) => write!(f, "daemon server task failed: {err}"),
1547 }
1548 }
1549}
1550
1551impl Error for BootstrapError {
1552 fn source(&self) -> Option<&(dyn Error + 'static)> {
1553 match self {
1554 Self::StartupNotServing => None,
1555 #[cfg(unix)]
1556 Self::Signal(source) => Some(source),
1557 Self::InvalidPort { source, .. } => Some(source),
1558 Self::ConnectionFileRead { source, .. }
1559 | Self::ConnectionFileWrite { source, .. }
1560 | Self::GenerateConnectionFile(source) => Some(source),
1561 Self::StartLockCreate { source, .. }
1562 | Self::RunDirLockCreate { source, .. }
1563 | Self::RemoveStale { source, .. }
1564 | Self::Bind { source, .. }
1565 | Self::LocalAddr { source, .. } => Some(source),
1566 Self::DaemonConfig(err) => Some(err),
1567 Self::MachineId(err) => Some(err),
1568 Self::RunDir(err) => Some(err),
1569 Self::Serve(err) => Some(err),
1570 Self::ServeJoin(err) => Some(err),
1571 Self::StartLockBusy { .. } | Self::RunDirBusy { .. } => None,
1572 }
1573 }
1574}
1575
1576#[cfg(test)]
1577mod tests {
1578 use super::*;
1579 use crate::server::ServerAuth;
1580 #[cfg(target_os = "linux")]
1581 use std::collections::BTreeSet;
1582 use std::sync::Mutex;
1583 #[cfg(target_os = "linux")]
1584 use subc_control::ModuleProtocol;
1585 use subc_test_support::TestTempDir;
1586 use subc_transport::MIN_KEY_LEN;
1587 use tokio::io::AsyncReadExt;
1588 use tokio::task::JoinHandle;
1589
1590 #[cfg(unix)]
1591 use std::os::unix::fs::PermissionsExt;
1592
1593 static ENV_LOCK: Mutex<()> = Mutex::new(());
1594
1595 #[test]
1596 fn normalized_build_provenance_preserves_real_values() {
1597 assert_eq!(normalized_build_provenance("abc"), Some("abc".to_string()));
1598 }
1599
1600 #[test]
1601 fn normalized_build_provenance_omits_unavailable_and_empty_values() {
1602 assert_eq!(normalized_build_provenance("unavailable"), None);
1603 assert_eq!(normalized_build_provenance(""), None);
1604 }
1605
1606 #[cfg(target_os = "linux")]
1607 fn current_cgroup_path_for_test() -> io::Result<PathBuf> {
1608 let cgroups = fs::read_to_string("/proc/self/cgroup")?;
1609 let relative = cgroups
1610 .lines()
1611 .find_map(|line| line.strip_prefix("0::"))
1612 .ok_or_else(|| {
1613 io::Error::new(io::ErrorKind::Unsupported, "cgroup v2 is unavailable")
1614 })?;
1615 Ok(Path::new("/sys/fs/cgroup").join(relative.trim_start_matches('/')))
1616 }
1617
1618 #[cfg(target_os = "linux")]
1619 fn module_cgroup_directories() -> io::Result<BTreeSet<OsString>> {
1620 let modules = current_cgroup_path_for_test()?.join("subc-modules");
1621 let entries = match fs::read_dir(modules) {
1622 Ok(entries) => entries,
1623 Err(error) if error.kind() == io::ErrorKind::NotFound => return Ok(BTreeSet::new()),
1624 Err(error) => return Err(error),
1625 };
1626 let mut directories = BTreeSet::new();
1627 for entry in entries {
1628 let entry = entry?;
1629 if entry.file_type()?.is_dir() {
1630 directories.insert(entry.file_name());
1631 }
1632 }
1633 Ok(directories)
1634 }
1635
1636 #[cfg(target_os = "linux")]
1637 async fn wait_for_path(path: &Path, task: &JoinHandle<Result<(), BootstrapError>>) {
1638 let deadline = tokio::time::Instant::now() + Duration::from_secs(5);
1639 while !path.exists() && tokio::time::Instant::now() < deadline {
1640 assert!(
1641 !task.is_finished(),
1642 "daemon exited before creating {}",
1643 path.display()
1644 );
1645 sleep(Duration::from_millis(10)).await;
1646 }
1647 assert!(path.exists(), "daemon did not create {}", path.display());
1648 }
1649
1650 #[cfg(target_os = "linux")]
1655 #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
1656 async fn run_with_config_does_not_reconcile_the_ambient_cgroup_by_default() {
1657 let temp = unique_temp_dir("bootstrap-cgroup-default-disabled");
1658 let module_id = format!("cgroup-isolation-probe-{}", process::id());
1659 let before = module_cgroup_directories().expect("read ambient module cgroups before boot");
1660 assert!(
1661 !before.contains(&OsString::from(&module_id)),
1662 "isolation probe cgroup already exists before this daemon starts"
1663 );
1664 let capture = temp.join("logs").join(format!("{module_id}.stderr.log"));
1665 let module = ConfiguredModule {
1666 module_id,
1667 program: PathBuf::from("sh"),
1668 args: vec!["-c".to_string(), "sleep 30".to_string()],
1669 env: Vec::new(),
1670 log: None,
1671 enabled: true,
1672 reserved: false,
1673 reserved_prefixes: Vec::new(),
1674 protocol: ModuleProtocol::None,
1675 overlap: Default::default(),
1676 health: HealthConfig::default(),
1677 drain_timeout_ms: None,
1678 route_bind_relay_timeout_ms: None,
1679 restart: RestartPolicy::default(),
1680 };
1681 let config = BootstrapConfig::new(temp.join("connection.json"), 0)
1682 .with_configured_modules([module])
1683 .with_capture_logs_dir(temp.join("logs"))
1684 .with_terminal_journal_path(temp.join("terminals.jsonl"));
1685 let task = tokio::spawn(run_with_config(config));
1686
1687 wait_for_path(&capture, &task).await;
1688 let after = module_cgroup_directories().expect("read ambient module cgroups after boot");
1689
1690 task.abort();
1691 assert!(task
1692 .await
1693 .expect_err("aborted daemon task must cancel")
1694 .is_cancelled());
1695 assert_eq!(
1696 before, after,
1697 "an in-process daemon must not create or reconcile ambient module cgroups"
1698 );
1699 }
1700
1701 #[cfg(target_os = "linux")]
1702 #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
1703 async fn explicit_cgroup_root_is_prepared_inside_the_fixture_tree() {
1704 let temp = unique_temp_dir("bootstrap-cgroup-explicit-root");
1705 let cgroup_root = temp.join("cgroup");
1706 fs::create_dir(&cgroup_root).expect("create scratch cgroup root");
1707 fs::write(cgroup_root.join("cgroup.procs"), b"").expect("write scratch cgroup marker");
1708 let modules = cgroup_root.join("subc-modules");
1709 let config = BootstrapConfig::new(temp.join("connection.json"), 0)
1710 .with_cgroup_placement(CgroupPlacementConfig::Root(cgroup_root))
1711 .with_terminal_journal_path(temp.join("terminals.jsonl"));
1712 let task = tokio::spawn(run_with_config(config));
1713
1714 wait_for_path(&modules, &task).await;
1715
1716 task.abort();
1717 assert!(task
1718 .await
1719 .expect_err("aborted daemon task must cancel")
1720 .is_cancelled());
1721 assert!(
1722 fs::read_dir(&modules)
1723 .expect("read prepared modules directory")
1724 .next()
1725 .is_none(),
1726 "the delegation probe must clean up after itself"
1727 );
1728 }
1729
1730 struct EnvGuard {
1731 key: &'static str,
1732 previous: Option<OsString>,
1733 }
1734
1735 impl EnvGuard {
1736 fn set(key: &'static str, value: &Path) -> Self {
1737 let previous = env::var_os(key);
1738 env::set_var(key, value);
1739 Self { key, previous }
1740 }
1741
1742 fn set_str(key: &'static str, value: &str) -> Self {
1743 let previous = env::var_os(key);
1744 env::set_var(key, value);
1745 Self { key, previous }
1746 }
1747
1748 fn unset(key: &'static str) -> Self {
1749 let previous = env::var_os(key);
1750 env::remove_var(key);
1751 Self { key, previous }
1752 }
1753 }
1754
1755 impl Drop for EnvGuard {
1756 fn drop(&mut self) {
1757 match &self.previous {
1758 Some(value) => env::set_var(self.key, value),
1759 None => env::remove_var(self.key),
1760 }
1761 }
1762 }
1763
1764 fn unique_temp_dir(name: &str) -> TestTempDir {
1765 TestTempDir::new(name)
1766 }
1767
1768 fn temp_connection_file_path(name: &str) -> (TestTempDir, PathBuf) {
1769 let dir = unique_temp_dir(name);
1770 let path = dir.join("conn.json");
1771 (dir, path)
1772 }
1773
1774 fn auth_for(info: &ConnectionInfo) -> ServerAuth {
1775 ServerAuth::new(info.key.clone(), info.daemon_id, info.daemon_ver.clone())
1776 }
1777
1778 fn start_server(bound: BoundDaemon) -> JoinHandle<Result<(), ServerError>> {
1779 let auth = auth_for(&bound.connection_info);
1780 tokio::spawn(serve_listeners(
1781 bound.listeners,
1782 Arc::new(Router::with_default_self_handler()),
1783 auth,
1784 ))
1785 }
1786
1787 fn expect_bound(outcome: Outcome) -> BoundDaemon {
1788 match outcome {
1789 Outcome::Bound(bound) => bound,
1790 Outcome::AlreadyRunning => panic!("fresh connection file unexpectedly had a daemon"),
1791 }
1792 }
1793
1794 async fn connect_from_info(conn: &ConnectionInfo) -> io::Result<TcpStream> {
1795 let endpoint = conn
1796 .endpoints
1797 .first()
1798 .expect("test connection file should have an endpoint");
1799 let ip: IpAddr = endpoint.host.parse().unwrap();
1800 TcpStream::connect(SocketAddr::new(ip, endpoint.port)).await
1801 }
1802
1803 fn make_connection_info(port: u16) -> ConnectionInfo {
1804 ConnectionInfo {
1805 schema: SCHEMA_VERSION,
1806 wire_version: Some(PROTOCOL_VERSION),
1807 endpoints: vec![Endpoint {
1808 host: "127.0.0.1".to_owned(),
1809 port,
1810 }],
1811 key: generate_key().unwrap(),
1812 daemon_id: generate_daemon_id().unwrap(),
1813 pid: process::id(),
1814 daemon_ver: "test-subc".to_owned(),
1815 }
1816 }
1817
1818 fn write_raw_owner_only_connection_file(path: &Path, contents: &[u8]) {
1819 fs::write(path, contents).unwrap();
1820 #[cfg(unix)]
1821 fs::set_permissions(path, fs::Permissions::from_mode(0o600)).unwrap();
1822 }
1823
1824 fn assert_owner_only_connection_file(path: &Path) {
1825 #[cfg(unix)]
1828 {
1829 let mode = fs::metadata(path).unwrap().permissions().mode() & 0o777;
1830 assert_eq!(mode, 0o600);
1831 }
1832 #[cfg(not(unix))]
1833 let _ = path;
1834 }
1835
1836 #[test]
1837 fn connection_file_path_uses_xdg_runtime_dir_when_set() {
1838 let _env_lock = ENV_LOCK.lock().unwrap();
1839 let runtime_dir = unique_temp_dir("xdg-runtime");
1840 let _xdg = EnvGuard::set("XDG_RUNTIME_DIR", runtime_dir.path());
1841
1842 assert_eq!(
1843 connection_file_path(),
1844 runtime_dir.join(CONNECTION_FILE_NAME)
1845 );
1846 }
1847
1848 #[test]
1849 fn connection_file_path_source_is_xdg_runtime_dir_when_set() {
1850 let runtime_dir = OsString::from("/run/user/1000");
1851
1852 let (path, source) = connection_file_path_with_source(Some(runtime_dir));
1853
1854 assert_eq!(
1855 path,
1856 PathBuf::from("/run/user/1000").join(CONNECTION_FILE_NAME)
1857 );
1858 assert_eq!(source, ConnectionFileSource::XdgRuntimeDir);
1859 }
1860
1861 #[test]
1862 fn connection_file_path_falls_back_to_temp_dir_with_user_token_when_xdg_unset() {
1863 let _env_lock = ENV_LOCK.lock().unwrap();
1864 let _xdg = EnvGuard::unset("XDG_RUNTIME_DIR");
1865
1866 assert_eq!(
1867 connection_file_path(),
1868 env::temp_dir().join(format!("subc-{}.connection.json", user_connection_token()))
1869 );
1870 }
1871
1872 #[test]
1873 fn connection_file_path_source_is_temp_dir_when_xdg_unset() {
1874 let (path, source) = connection_file_path_with_source(None);
1875
1876 assert_eq!(
1877 path,
1878 env::temp_dir().join(format!("subc-{}.connection.json", user_connection_token()))
1879 );
1880 assert_eq!(source, ConnectionFileSource::TempDirFallback);
1881 }
1882
1883 #[test]
1888 fn user_connection_token_is_stable_under_concurrent_callers() {
1889 let expected = user_connection_token();
1890 let workers: Vec<_> = (0..32)
1891 .map(|_| {
1892 std::thread::spawn(|| (0..40).map(|_| user_connection_token()).collect::<Vec<_>>())
1893 })
1894 .collect();
1895 for worker in workers {
1896 for token in worker.join().expect("probe thread") {
1897 assert_eq!(token, expected, "token diverged under concurrent probes");
1898 }
1899 }
1900 }
1901
1902 #[test]
1903 fn connection_file_path_source_is_temp_dir_when_xdg_empty() {
1904 let (path, source) = connection_file_path_with_source(Some(OsString::new()));
1905
1906 assert_eq!(
1907 path,
1908 env::temp_dir().join(format!("subc-{}.connection.json", user_connection_token()))
1909 );
1910 assert_eq!(source, ConnectionFileSource::TempDirFallback);
1911 }
1912
1913 #[test]
1917 fn daemon_binary_config_journals_and_captures_into_the_run_dir() {
1918 let _env_lock = ENV_LOCK.lock().unwrap();
1919 let root = unique_temp_dir("daemon-binary-config");
1920 let data_home = root.join("data");
1921 let _data = EnvGuard::set("XDG_DATA_HOME", &data_home);
1922 let _config = EnvGuard::set("XDG_CONFIG_HOME", &root.join("config"));
1923 let _port = EnvGuard::unset(SUBC_PORT_ENV);
1924
1925 let config = BootstrapConfig::from_env_for_daemon_binary().unwrap();
1926
1927 let run_dir = data_home.join("cortexkit").join("run");
1928 assert_eq!(
1929 config.terminal_journal_path,
1930 Some(run_dir.join("terminals.jsonl"))
1931 );
1932 assert_eq!(config.capture_logs_dir, Some(run_dir.join("logs")));
1933 assert_eq!(
1934 BootstrapConfig::new(root.join("connection.json"), 0).terminal_journal_path,
1935 None,
1936 "an in-process config must not journal anywhere unless asked to"
1937 );
1938 }
1939
1940 #[test]
1941 fn daemon_binary_config_refuses_a_relative_data_home() {
1942 let _env_lock = ENV_LOCK.lock().unwrap();
1943 let root = unique_temp_dir("daemon-binary-relative-data");
1944 let _data = EnvGuard::set_str("XDG_DATA_HOME", "relative-data-home");
1945 let _config = EnvGuard::set("XDG_CONFIG_HOME", &root.join("config"));
1946 let _port = EnvGuard::unset(SUBC_PORT_ENV);
1947
1948 let error = BootstrapConfig::from_env_for_daemon_binary()
1949 .expect_err("a relative data home must refuse the daemon binary's config");
1950 assert!(
1951 matches!(error, BootstrapError::RunDir(_)),
1952 "expected a run-directory refusal, got {error}"
1953 );
1954 assert!(error.to_string().contains("XDG_DATA_HOME"), "{error}");
1955 }
1956
1957 #[test]
1958 fn configured_port_uses_default_config_and_env_override() {
1959 let _env_lock = ENV_LOCK.lock().unwrap();
1960 let (_dir, conn_path) = temp_connection_file_path("daemon-config-port");
1961 let config_path = conn_path.with_file_name("subc.jsonc");
1962
1963 let _port = EnvGuard::unset(SUBC_PORT_ENV);
1964 assert_eq!(
1965 BootstrapConfig::from_env_with_daemon_config_path(&config_path)
1966 .unwrap()
1967 .port,
1968 DEFAULT_SUBC_PORT
1969 );
1970
1971 fs::write(&config_path, r#"{ "version": 1, "port": 8123 }"#).unwrap();
1972 assert_eq!(
1973 BootstrapConfig::from_env_with_daemon_config_path(&config_path)
1974 .unwrap()
1975 .port,
1976 8123
1977 );
1978
1979 let _port = EnvGuard::set_str(SUBC_PORT_ENV, "9012");
1980 assert_eq!(
1981 BootstrapConfig::from_env_with_daemon_config_path(&config_path)
1982 .unwrap()
1983 .port,
1984 9012
1985 );
1986 }
1987
1988 #[tokio::test]
1989 async fn second_singleton_probe_against_served_tcp_daemon_reports_already_running() {
1990 let (_dir, path) = temp_connection_file_path("already-running");
1991
1992 let bound = expect_bound(ensure_singleton(&path, 0).await.unwrap());
1993 let server = start_server(bound);
1994
1995 let second = ensure_singleton(&path, 0).await.unwrap();
1996 assert!(matches!(second, Outcome::AlreadyRunning));
1997
1998 server.abort();
1999 let _ = server.await;
2000 }
2001
2002 #[tokio::test]
2003 async fn daemon_connection_file_publishes_protocol_wire_version() {
2004 let (_dir, path) = temp_connection_file_path("wire-version");
2005 let bound = expect_bound(ensure_singleton(&path, 0).await.unwrap());
2006 assert_eq!(bound.connection_info.wire_version, Some(PROTOCOL_VERSION));
2007 assert_eq!(
2008 connection_file::read(&path).unwrap().wire_version,
2009 Some(PROTOCOL_VERSION)
2010 );
2011
2012 drop(bound.listeners);
2013 }
2014
2015 #[tokio::test]
2016 async fn stale_unbound_connection_file_is_reclaimed() {
2017 let (_dir, path) = temp_connection_file_path("stale-reclaim");
2018 let stale = TcpListener::bind((Ipv4Addr::LOCALHOST, 0)).await.unwrap();
2019 let stale_port = stale.local_addr().unwrap().port();
2020 drop(stale);
2021 let stale_info = make_connection_info(stale_port);
2022 write_atomic(&path, &stale_info).unwrap();
2023
2024 let bound = expect_bound(ensure_singleton(&path, 0).await.unwrap());
2025 assert_ne!(bound.connection_info.key, stale_info.key);
2026 drop(bound.listeners);
2027 }
2028
2029 #[cfg(unix)]
2030 #[tokio::test]
2031 async fn ensure_singleton_reclaims_insecure_connection_file() {
2032 let (_dir, path) = temp_connection_file_path("insecure-reclaim");
2033 let stale = TcpListener::bind((Ipv4Addr::LOCALHOST, 0)).await.unwrap();
2034 let stale_port = stale.local_addr().unwrap().port();
2035 drop(stale);
2036 let stale_info = make_connection_info(stale_port);
2037 write_atomic(&path, &stale_info).unwrap();
2038 fs::set_permissions(&path, fs::Permissions::from_mode(0o644)).unwrap();
2039
2040 let bound = expect_bound(ensure_singleton(&path, 0).await.unwrap());
2041 assert_ne!(bound.connection_info.key, stale_info.key);
2042 assert_ne!(bound.connection_info.daemon_id, stale_info.daemon_id);
2043 assert_owner_only_connection_file(&path);
2044
2045 drop(bound.listeners);
2046 }
2047
2048 #[tokio::test]
2049 async fn ensure_singleton_reclaims_non_loopback_connection_file() {
2050 let (_dir, path) = temp_connection_file_path("non-loopback-reclaim");
2051 let mut stale_info = make_connection_info(8757);
2052 stale_info.endpoints = vec![Endpoint {
2053 host: "192.0.2.10".to_owned(),
2054 port: 8757,
2055 }];
2056 write_atomic(&path, &stale_info).unwrap();
2057
2058 let bound = expect_bound(ensure_singleton(&path, 0).await.unwrap());
2059 assert_ne!(bound.connection_info.key, stale_info.key);
2060 assert_ne!(bound.connection_info.daemon_id, stale_info.daemon_id);
2061 assert!(bound
2062 .connection_info
2063 .endpoints
2064 .iter()
2065 .all(|endpoint| endpoint.host.parse::<IpAddr>().unwrap().is_loopback()));
2066 assert_owner_only_connection_file(&path);
2067
2068 drop(bound.listeners);
2069 }
2070
2071 #[tokio::test]
2072 async fn ensure_singleton_reclaims_invalid_connection_file_shapes() {
2073 let mut unsupported_schema = make_connection_info(8757);
2074 unsupported_schema.schema = SCHEMA_VERSION + 1;
2075
2076 let mut empty_endpoints = make_connection_info(8757);
2077 empty_endpoints.endpoints.clear();
2078
2079 let mut short_key = make_connection_info(8757);
2080 short_key.key = vec![0x5A; MIN_KEY_LEN - 1];
2081
2082 let cases = vec![
2083 (
2084 "unsupported-schema",
2085 serde_json::to_vec(&unsupported_schema).unwrap(),
2086 Some(unsupported_schema),
2087 ),
2088 (
2089 "empty-endpoints",
2090 serde_json::to_vec(&empty_endpoints).unwrap(),
2091 Some(empty_endpoints),
2092 ),
2093 (
2094 "short-key",
2095 serde_json::to_vec(&short_key).unwrap(),
2096 Some(short_key),
2097 ),
2098 ("invalid-json", b"{not valid connection json".to_vec(), None),
2099 ];
2100
2101 for (label, contents, old_info) in cases {
2102 let (_dir, path) = temp_connection_file_path(label);
2103 write_raw_owner_only_connection_file(&path, &contents);
2104
2105 let bound = expect_bound(ensure_singleton(&path, 0).await.unwrap());
2106 if let Some(old_info) = old_info {
2107 assert_ne!(bound.connection_info.key, old_info.key, "{label}");
2108 assert_ne!(
2109 bound.connection_info.daemon_id, old_info.daemon_id,
2110 "{label}"
2111 );
2112 }
2113 assert!(bound.connection_info.key.len() >= MIN_KEY_LEN, "{label}");
2114 assert_ne!(bound.connection_info.daemon_id, [0u8; 16], "{label}");
2115 assert_owner_only_connection_file(&path);
2116
2117 drop(bound.listeners);
2118 }
2119 }
2120
2121 #[tokio::test]
2122 async fn foreign_reused_port_connection_file_is_reclaimed_after_auth_probe_fails() {
2123 let (_dir, path) = temp_connection_file_path("foreign-reclaim");
2124 let foreign = TcpListener::bind((Ipv4Addr::LOCALHOST, 0)).await.unwrap();
2125 let foreign_port = foreign.local_addr().unwrap().port();
2126 write_atomic(&path, &make_connection_info(foreign_port)).unwrap();
2127 let foreign_task = tokio::spawn(async move {
2128 if let Ok((mut stream, _)) = foreign.accept().await {
2129 let mut buf = [0u8; 64];
2130 let _ = stream.read(&mut buf).await;
2131 }
2132 });
2133
2134 let bound = expect_bound(ensure_singleton(&path, 0).await.unwrap());
2135 assert!(bound
2136 .connection_info
2137 .endpoints
2138 .iter()
2139 .all(|endpoint| endpoint.port != foreign_port));
2140
2141 drop(bound.listeners);
2142 let _ = foreign_task.await;
2143 }
2144
2145 #[tokio::test]
2146 async fn stale_start_lock_file_is_reclaimable() {
2147 let (_dir, path) = temp_connection_file_path("start-lock-stale-file");
2148 let lock_path = start_lock_path(&path);
2149 drop(open_owner_only_lock(&lock_path).unwrap());
2150 assert!(lock_path.is_file());
2151
2152 let lock = StartLock::acquire(&path).await.unwrap();
2153 assert!(lock_path.is_file());
2154
2155 drop(lock);
2156 assert!(lock_path.is_file());
2157 }
2158
2159 #[tokio::test]
2160 async fn held_start_lock_blocks_second_acquire_until_release() {
2161 let (_dir, path) = temp_connection_file_path("start-lock-held");
2162 let lock_path = start_lock_path(&path);
2163 let first = StartLock::acquire(&path).await.unwrap();
2164
2165 let err = match StartLock::acquire(&path).await {
2166 Ok(_) => panic!("second acquire while held must stay busy"),
2167 Err(err) => err,
2168 };
2169 assert!(matches!(
2170 err,
2171 BootstrapError::StartLockBusy {
2172 ref path,
2173 attempts: START_LOCK_RETRIES,
2174 } if path == &lock_path
2175 ));
2176
2177 drop(first);
2178
2179 let second = StartLock::acquire(&path)
2180 .await
2181 .expect("released advisory lock should be reclaimable");
2182 drop(second);
2183 }
2184
2185 #[tokio::test]
2186 async fn bind_conflict_on_fixed_port_fails_loud_without_reselecting() {
2187 let (_dir, path) = temp_connection_file_path("bind-conflict");
2188 let occupied = TcpListener::bind((Ipv4Addr::LOCALHOST, 0)).await.unwrap();
2189 let occupied_port = occupied.local_addr().unwrap().port();
2190
2191 let err = ensure_singleton(&path, occupied_port).await.unwrap_err();
2192 assert!(matches!(
2193 err,
2194 BootstrapError::Bind { ref source, .. } if source.kind() == io::ErrorKind::AddrInUse
2195 ));
2196 assert!(err.to_string().contains("set the port in config"));
2197
2198 drop(occupied);
2199 }
2200
2201 #[tokio::test]
2202 async fn ephemeral_ipv6_collision_still_serves_ipv4() {
2203 let (listeners, endpoints) = bind_loopback_with(0, |port| async move {
2204 let occupied = TcpListener::bind((Ipv6Addr::LOCALHOST, port)).await?;
2205 let result = TcpListener::bind((Ipv6Addr::LOCALHOST, port)).await;
2206 drop(occupied);
2207 result
2208 })
2209 .await
2210 .expect("an incidental IPv6 collision must not prevent an ephemeral daemon from starting");
2211 assert_eq!(endpoints.len(), 1);
2212 assert_eq!(endpoints[0].host, "127.0.0.1");
2213 TcpStream::connect((Ipv4Addr::LOCALHOST, endpoints[0].port))
2214 .await
2215 .unwrap();
2216 drop(listeners);
2217 }
2218
2219 #[tokio::test]
2220 async fn unpublished_boot_holds_singleton_lock_until_publication() {
2221 let dir = TestTempDir::new("unpublished-singleton-lock");
2222 let path = dir.join("connection.json");
2223 let bound = expect_bound(
2224 ensure_singleton_inner(BootstrapConfig::new(&path, 0), false)
2225 .await
2226 .unwrap(),
2227 );
2228 assert!(!path.exists());
2229 let contender = open_owner_only_lock(&start_lock_path(&path)).unwrap();
2230 assert!(
2231 matches!(FileExt::try_lock(&contender), Err(TryLockError::WouldBlock)),
2232 "an unpublished boot must keep its singleton claim"
2233 );
2234 drop(bound);
2235 FileExt::try_lock(&contender).unwrap();
2236 }
2237
2238 #[tokio::test]
2239 async fn readiness_probe_requires_an_authenticating_server() {
2240 let dir = TestTempDir::new("unserved-readiness");
2241 let bound = expect_bound(
2242 ensure_singleton_inner(BootstrapConfig::new(dir.join("connection.json"), 0), false)
2243 .await
2244 .unwrap(),
2245 );
2246 assert!(matches!(
2247 verify_serving(&bound.connection_info).await,
2248 Err(BootstrapError::StartupNotServing)
2249 ));
2250 }
2251
2252 #[cfg(unix)]
2253 #[tokio::test]
2254 async fn orphan_sweep_finishes_before_connection_file_publication() {
2255 use crate::live_children::{ExecutableIdentity, LiveChild};
2256 let dir = TestTempDir::new("publish-after-sweep");
2257 let path = dir.join("connection.json");
2258 let record = dir.join("live-children.json");
2259 let ready = dir.join("ready");
2260 let mut child = std::process::Command::new("/bin/sh")
2261 .args([
2262 "-c",
2263 "trap '' TERM; : > \"$0\"; read -r _",
2264 ready.to_str().unwrap(),
2265 ])
2266 .stdin(std::process::Stdio::piped())
2267 .env("XDG_DATA_HOME", dir.path())
2268 .env("XDG_RUNTIME_DIR", dir.path())
2269 .env("XDG_CONFIG_HOME", dir.path())
2270 .spawn()
2271 .unwrap();
2272 timeout(Duration::from_secs(5), async {
2273 while !ready.exists() {
2274 sleep(Duration::from_millis(5)).await;
2275 }
2276 })
2277 .await
2278 .unwrap();
2279 let observed = subc_os::Process::open(child.id())
2280 .unwrap()
2281 .unwrap()
2282 .observe()
2283 .unwrap();
2284 crate::live_children::write_record(
2285 &record,
2286 &[LiveChild {
2287 module_id: "old-sleep".into(),
2288 pid: child.id(),
2289 protocol: subc_control::ModuleProtocol::None,
2290 start_time: Some(observed.start_time),
2291 executable: observed.executable.map(ExecutableIdentity::from),
2292 cgroup_name: None,
2293 }],
2294 )
2295 .unwrap();
2296 let config = BootstrapConfig::new(&path, 0).with_live_children_record(&record);
2297 let daemon = tokio::spawn(run_with_config(config));
2298 timeout(Duration::from_secs(5), async {
2299 while !path.exists() {
2300 sleep(Duration::from_millis(5)).await;
2301 }
2302 })
2303 .await
2304 .unwrap();
2305 assert!(path.exists());
2306 let ended = child.try_wait().unwrap().is_some();
2307 if !ended {
2308 child.kill().unwrap();
2309 }
2310 child.wait().unwrap();
2311 if ended {
2312 assert!(matches!(probe_existing(&path).await.unwrap(), Probe::Live));
2313 }
2314 daemon.abort();
2315 let _ = daemon.await;
2316 assert!(
2317 ended,
2318 "the published daemon must not still owe its orphan sweep"
2319 );
2320 }
2321
2322 #[cfg(target_os = "macos")]
2323 #[test]
2324 fn nofile_raise_worker() {
2325 let Some(path) = std::env::var_os("SUBC_NOFILE_TEST_FILE") else {
2326 return;
2327 };
2328 let (_, hard) = rlimit::Resource::NOFILE.get().unwrap();
2329 rlimit::Resource::NOFILE.set(256, hard).unwrap();
2330 raise_nofile_limit_with_ceiling(Some(10240));
2331 std::fs::write(path, rlimit::Resource::NOFILE.get().unwrap().0.to_string()).unwrap();
2332 }
2333
2334 #[cfg(target_os = "macos")]
2335 #[test]
2336 fn macos_nofile_raise_clamps_to_kernel_ceiling() {
2337 let dir = TestTempDir::new("nofile-ceiling");
2338 let result = dir.join("soft");
2339 let status = std::process::Command::new(std::env::current_exe().unwrap())
2340 .args(["--exact", "bootstrap::tests::nofile_raise_worker"])
2341 .env("SUBC_NOFILE_TEST_FILE", &result)
2342 .env("XDG_DATA_HOME", dir.path())
2343 .env("XDG_RUNTIME_DIR", dir.path())
2344 .env("XDG_CONFIG_HOME", dir.path())
2345 .status()
2346 .unwrap();
2347 assert!(status.success());
2348 let soft: u64 = std::fs::read_to_string(result).unwrap().parse().unwrap();
2349 assert!(
2350 soft > 256 && soft <= 10240,
2351 "the inherited limit must be raised within the kernel ceiling; got {soft}"
2352 );
2353 }
2354
2355 #[tokio::test]
2356 async fn key_rotation_republishes_new_material_and_old_file_fails_auth() {
2357 let (_dir, path) = temp_connection_file_path("key-rotation");
2358 let first = expect_bound(ensure_singleton(&path, 0).await.unwrap());
2359 let old_info = first.connection_info.clone();
2360 let fixed_port = old_info.endpoints[0].port;
2361 drop(first.listeners);
2362
2363 let second = expect_bound(ensure_singleton(&path, fixed_port).await.unwrap());
2364 let new_info = second.connection_info.clone();
2365 assert_ne!(old_info.key, new_info.key);
2366 assert_ne!(old_info.daemon_id, new_info.daemon_id);
2367 let server = start_server(second);
2368
2369 let mut old_stream = connect_from_info(&old_info).await.unwrap();
2370 let old_auth = authenticate_client(&mut old_stream, &old_info, PROBE_AUTH_DEADLINE).await;
2371 assert!(
2372 old_auth.is_err(),
2373 "old key must not authenticate after restart"
2374 );
2375
2376 let reread = connection_file::read(&path).unwrap();
2377 let mut new_stream = connect_from_info(&reread).await.unwrap();
2378 authenticate_client(&mut new_stream, &reread, PROBE_AUTH_DEADLINE)
2379 .await
2380 .unwrap();
2381
2382 server.abort();
2383 let _ = server.await;
2384 }
2385
2386 #[cfg(unix)]
2387 #[tokio::test]
2388 async fn published_connection_file_permissions_are_owner_only() {
2389 let (_dir, path) = temp_connection_file_path("permissions");
2390 let bound = expect_bound(ensure_singleton(&path, 0).await.unwrap());
2391
2392 let mode = fs::metadata(&path).unwrap().permissions().mode() & 0o777;
2393 assert_eq!(mode, 0o600);
2394
2395 drop(bound.listeners);
2396 }
2397}