symforge 8.22.7

SymForge — in-memory code intelligence MCP server for Claude Code, Codex, and Gemini CLI
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
//! Port and PID file management for the HTTP sidecar.
//!
//! All active files live under the process-global control-state `sidecar/`
//! namespace. Legacy fixed filenames remain read-only migration fallbacks.
//! The hook binary reads the sidecar port file to locate the running sidecar.
//!
//! Runtime filenames are OS-tagged (`sidecar.<os>.port`, see
//! [`crate::paths::os_tagged_runtime_file_name`]) so a Windows symforge and a
//! WSL/Linux symforge sharing one control-state root can never read
//! each other's loopback port. The writer (here) and the `symforge hook` reader both
//! derive the tag from the same compile-time `std::env::consts::OS`, so for a given
//! OS they always agree. Legacy un-tagged files are still READ as a fallback for one
//! release so an upgrade does not orphan a sidecar started by the previous binary.

use std::io::{self, Write};
use std::net::TcpStream;
use std::path::{Path, PathBuf};
use std::time::{Duration, Instant};

use crate::domain::ControlStateDir;

pub const DIR_NAME: &str = crate::paths::SYMFORGE_DIR_NAME;
const SIDECAR_CONTROL_DIR: &str = "sidecar";

// Legacy (pre-OS-tag) names. Read-only fallback + cleanup for one release window.
const LEGACY_PORT_FILE: &str = "sidecar.port";
const LEGACY_PID_FILE: &str = "sidecar.pid";
const LEGACY_SESSION_FILE: &str = "sidecar.session";

/// OS-tagged sidecar port filename, e.g. `sidecar.windows.port`.
fn port_file_name() -> String {
    crate::paths::os_tagged_runtime_file_name("sidecar", "port")
}
/// OS-tagged sidecar pid filename, e.g. `sidecar.linux.pid`.
fn pid_file_name() -> String {
    crate::paths::os_tagged_runtime_file_name("sidecar", "pid")
}
/// OS-tagged sidecar session filename, e.g. `sidecar.macos.session`.
fn session_file_name() -> String {
    crate::paths::os_tagged_runtime_file_name("sidecar", "session")
}

/// Read a runtime file under `dir`, preferring the OS-tagged name and falling back
/// to the legacy un-tagged name. Returns the first that exists/parses.
fn read_runtime_file(dir: &Path, tagged: &str, legacy: &str) -> io::Result<String> {
    match std::fs::read_to_string(dir.join(tagged)) {
        Ok(contents) => Ok(contents),
        Err(e) if e.kind() == io::ErrorKind::NotFound => std::fs::read_to_string(dir.join(legacy)),
        Err(e) => Err(e),
    }
}

/// Ensure the process-global sidecar descriptor namespace.
pub fn ensure_symforge_dir(control_state_dir: &ControlStateDir) -> io::Result<PathBuf> {
    crate::paths::ensure_control_state_dir(control_state_dir)?;
    let dir = resolve_symforge_dir(control_state_dir);
    std::fs::create_dir_all(&dir)?;
    Ok(dir)
}

/// Resolve the isolated sidecar namespace without creating it.
fn resolve_symforge_dir(control_state_dir: &ControlStateDir) -> PathBuf {
    crate::paths::control_state_path(control_state_dir, SIDECAR_CONTROL_DIR)
}

/// Write the sidecar port to `.symforge/sidecar.port`.
///
/// The file contains ONLY the port number as ASCII digits, no trailing newline.
/// This is the convention the hook binary relies on.
pub fn write_port_file(port: u16, control_state_dir: &ControlStateDir) -> io::Result<()> {
    let dir = ensure_symforge_dir(control_state_dir)?;
    let path = dir.join(port_file_name());
    let mut file = std::fs::File::create(&path)?;
    write!(file, "{port}")?;
    Ok(())
}

/// Write the sidecar PID to `.symforge/sidecar.<os>.pid`.
///
/// The file contains ONLY the PID as ASCII digits, no trailing newline.
pub fn write_pid_file(pid: u32, control_state_dir: &ControlStateDir) -> io::Result<()> {
    let dir = ensure_symforge_dir(control_state_dir)?;
    let path = dir.join(pid_file_name());
    let mut file = std::fs::File::create(&path)?;
    write!(file, "{pid}")?;
    Ok(())
}

/// Write the daemon/session proxy identifier to `.symforge/sidecar.<os>.session`.
pub fn write_session_file(session_id: &str, control_state_dir: &ControlStateDir) -> io::Result<()> {
    let dir = ensure_symforge_dir(control_state_dir)?;
    let path = dir.join(session_file_name());
    let mut file = std::fs::File::create(&path)?;
    write!(file, "{session_id}")?;
    Ok(())
}

/// Remove only the daemon/session proxy file, preserving any live local sidecar port/pid files.
pub fn cleanup_session_file(control_state_dir: &ControlStateDir) {
    let dir = resolve_symforge_dir(control_state_dir);
    let _ = std::fs::remove_file(dir.join(session_file_name()));
    let _ = std::fs::remove_file(dir.join(LEGACY_SESSION_FILE));
}

/// Read and parse the port from `.symforge/sidecar.<os>.port` (legacy fallback).
///
/// Returns an error if the file doesn't exist or contains invalid data.
pub fn read_port(control_state_dir: &ControlStateDir) -> io::Result<u16> {
    read_port_at(&resolve_symforge_dir(control_state_dir))
}

fn read_port_at(dir: &Path) -> io::Result<u16> {
    let contents = read_runtime_file(dir, &port_file_name(), LEGACY_PORT_FILE)?;
    contents
        .trim()
        .parse::<u16>()
        .map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))
}

fn read_pid_at(dir: &Path) -> io::Result<u32> {
    let contents = read_runtime_file(dir, &pid_file_name(), LEGACY_PID_FILE)?;
    contents
        .trim()
        .parse::<u32>()
        .map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))
}

// ── Per-adapter session descriptors (Task 8) ──────────────────────────────
//
// The fixed `sidecar.<os>.{port,pid,session}` files are a single slot: with
// two adapters on one project root, the second overwrites the first and one
// adapter's shutdown deletes the other's records. Each adapter now writes ONE
// atomic JSON descriptor keyed by its own PID under `.symforge/sessions/`;
// cleanup removes only the caller's descriptor, and readers scan the
// directory, validate identity, and select the freshest LIVE record. The
// fixed files remain as a read-compatible migration aid only — no longer
// written.

const SESSIONS_DIR: &str = "sessions";
const DESCRIPTOR_SCAN_TIMEOUT: Duration = Duration::from_millis(100);
const SIDECAR_PROBE_TIMEOUT: Duration = Duration::from_millis(200);

/// OS-tagged descriptor filename for one adapter process, e.g.
/// `sidecar.12345.windows.json`.
fn descriptor_file_name(pid: u32) -> String {
    crate::paths::os_tagged_runtime_file_name(&format!("sidecar.{pid}"), "json")
}

fn now_unix_secs() -> u64 {
    std::time::SystemTime::now()
        .duration_since(std::time::SystemTime::UNIX_EPOCH)
        .unwrap_or_default()
        .as_secs()
}

/// One adapter/session runtime record (Task 8).
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub struct SessionDescriptor {
    /// Daemon session id when this adapter proxies a daemon session; `None`
    /// for a purely local sidecar.
    pub session_id: Option<String>,
    /// The project root this adapter serves, for identity validation.
    pub project_root: Option<String>,
    pub pid: u32,
    pub port: u16,
    /// Heartbeat/update time; refreshed on every write.
    pub updated_at_unix_secs: u64,
}

/// Write THIS process's descriptor atomically (temp + rename) under
/// `<dir>/sessions/`. Idempotent: rewriting refreshes `updated_at`.
pub(crate) fn write_descriptor_for_pid_at(
    dir: &Path,
    pid: u32,
    port: u16,
    session_id: Option<&str>,
    project_root: Option<&Path>,
) -> io::Result<()> {
    let sessions = dir.join(SESSIONS_DIR);
    std::fs::create_dir_all(&sessions)?;
    let descriptor = SessionDescriptor {
        session_id: session_id.map(str::to_string),
        project_root: project_root.map(|root| root.display().to_string()),
        pid,
        port,
        updated_at_unix_secs: now_unix_secs(),
    };
    let bytes = serde_json::to_vec_pretty(&descriptor)
        .map_err(|error| io::Error::new(io::ErrorKind::InvalidData, error))?;
    let final_path = sessions.join(descriptor_file_name(pid));
    let tmp_path = sessions.join(format!("{}.tmp", descriptor_file_name(pid)));
    std::fs::write(&tmp_path, &bytes)?;
    match std::fs::rename(&tmp_path, &final_path) {
        Ok(()) => Ok(()),
        Err(error) => {
            let _ = std::fs::remove_file(&tmp_path);
            Err(error)
        }
    }
}

/// Public writer: this adapter's descriptor for `port`/`session_id` under the
/// project's runtime `.symforge/` dir.
pub fn write_session_descriptor(
    control_state_dir: &ControlStateDir,
    port: u16,
    session_id: Option<&str>,
    project_root: Option<&Path>,
) -> io::Result<()> {
    let dir = ensure_symforge_dir(control_state_dir)?;
    write_descriptor_for_pid_at(&dir, std::process::id(), port, session_id, project_root)
}

/// Remove exactly one pid's descriptor. Never touches siblings.
pub(crate) fn cleanup_descriptor_for_pid_at(dir: &Path, pid: u32) {
    let _ = std::fs::remove_file(dir.join(SESSIONS_DIR).join(descriptor_file_name(pid)));
    let _ = std::fs::remove_file(
        dir.join(SESSIONS_DIR)
            .join(format!("{}.tmp", descriptor_file_name(pid))),
    );
}

/// Remove ONLY this process's descriptor (Task 8 contract: an adapter's
/// shutdown can never delete or invalidate a sibling adapter's record).
pub fn cleanup_own_descriptor(control_state_dir: &ControlStateDir) {
    cleanup_descriptor_for_pid_at(&resolve_symforge_dir(control_state_dir), std::process::id());
}

/// Same, against an explicit dir (panic hooks cannot rely on CWD).
pub fn cleanup_own_descriptor_at(dir: &Path) {
    cleanup_descriptor_for_pid_at(dir, std::process::id());
}

/// Remove descriptors whose process is gone or whose port no longer answers —
/// the update/repair path's stale-record hygiene. Live descriptors are untouched.
pub fn cleanup_stale_descriptors_at(dir: &Path, bind_host: &str) {
    prune_dead_descriptor_files_at(dir);
    for descriptor in read_descriptors_at(dir) {
        let alive = process_may_be_alive(descriptor.pid)
            && sidecar_port_is_alive(bind_host, descriptor.port).unwrap_or(false);
        if !alive {
            cleanup_descriptor_for_pid_at(dir, descriptor.pid);
        }
    }
}

fn prune_dead_descriptor_files_at(dir: &Path) {
    let os_suffix = format!(".{}.json", std::env::consts::OS);
    let Ok(entries) = std::fs::read_dir(dir.join(SESSIONS_DIR)) else {
        return;
    };
    for entry in entries.flatten() {
        let name = entry.file_name();
        let Some(pid) = name
            .to_str()
            .and_then(|name| name.strip_prefix("sidecar."))
            .and_then(|name| name.strip_suffix(&os_suffix))
            .and_then(|pid| pid.parse::<u32>().ok())
        else {
            continue;
        };
        if !process_may_be_alive(pid) {
            let _ = std::fs::remove_file(entry.path());
        }
    }
}

/// All parseable descriptors for THIS OS under `<dir>/sessions/`.
fn read_descriptors_at(dir: &Path) -> Vec<SessionDescriptor> {
    let os_tag = format!(".{}.json", std::env::consts::OS);
    let mut descriptors = Vec::new();
    let Ok(entries) = std::fs::read_dir(dir.join(SESSIONS_DIR)) else {
        return descriptors;
    };
    for entry in entries.flatten() {
        let name = entry.file_name();
        let Some(name) = name.to_str() else { continue };
        if !name.starts_with("sidecar.") || !name.ends_with(&os_tag) {
            continue;
        }
        if let Ok(contents) = std::fs::read_to_string(entry.path())
            && let Ok(descriptor) = serde_json::from_str::<SessionDescriptor>(&contents)
        {
            descriptors.push(descriptor);
        }
    }
    descriptors
}

/// Select the best descriptor for `dir`: identity-validated (a descriptor
/// naming a DIFFERENT project root than this dir's project is rejected, never
/// "last writer wins"), freshest first with a stable smallest-pid tie break,
/// returning the first live port found inside the fixed hook-time budget.
struct SelectedSidecar {
    status: SidecarStatus,
    session_id: Option<String>,
}

fn select_descriptor_status(
    dir: &Path,
    bind_host: &str,
    expected_project_root: Option<&Path>,
) -> Option<SelectedSidecar> {
    let scan_started = Instant::now();
    prune_dead_descriptor_files_at(dir);
    let expected_root = expected_project_root.map(|root| root.display().to_string());
    let mut candidates = Vec::new();
    let mut rejected = 0usize;
    for descriptor in read_descriptors_at(dir) {
        if let (Some(declared), Some(expected)) =
            (descriptor.project_root.as_deref(), expected_root.as_deref())
            && !same_root_identity(declared, expected)
        {
            rejected += 1;
            continue;
        }
        if !process_may_be_alive(descriptor.pid) {
            continue;
        }
        candidates.push(descriptor);
    }
    if candidates.is_empty() {
        return (rejected > 0).then(|| SelectedSidecar {
            status: SidecarStatus {
                pid: None,
                port: None,
                liveness: SidecarLiveness::NoSidecar,
                detail: Some(format!(
                    "{rejected} descriptor(s) rejected: project-root identity mismatch"
                )),
            },
            session_id: None,
        });
    }

    candidates.sort_by(|a, b| {
        b.updated_at_unix_secs
            .cmp(&a.updated_at_unix_secs)
            .then(a.pid.cmp(&b.pid))
    });

    let selected = |best: &SessionDescriptor, liveness| SelectedSidecar {
        status: SidecarStatus {
            pid: Some(best.pid),
            port: Some(best.port),
            liveness,
            detail: Some(format!(
                "descriptor sidecar.{} ({} candidate(s){})",
                best.pid,
                candidates.len(),
                if rejected > 0 {
                    format!(", {rejected} identity-rejected")
                } else {
                    String::new()
                }
            )),
        },
        session_id: best.session_id.clone(),
    };

    let mut probed = 0usize;
    for candidate in &candidates {
        let remaining = DESCRIPTOR_SCAN_TIMEOUT.saturating_sub(scan_started.elapsed());
        if remaining.is_zero() {
            break;
        }
        let alive = sidecar_port_is_alive_with_timeout(bind_host, candidate.port, remaining)
            .unwrap_or(false);
        probed += 1;
        if alive {
            return Some(selected(candidate, SidecarLiveness::Alive));
        }
    }

    if let Some(unprobed) = candidates.get(probed) {
        Some(selected(unprobed, SidecarLiveness::Unknown))
    } else {
        Some(selected(&candidates[0], SidecarLiveness::Dead))
    }
}

#[cfg(windows)]
#[allow(unsafe_code)]
fn process_may_be_alive(pid: u32) -> bool {
    use windows::Win32::Foundation::{CloseHandle, ERROR_INVALID_PARAMETER, WAIT_OBJECT_0};
    use windows::Win32::System::Threading::{
        OpenProcess, PROCESS_SYNCHRONIZE, WaitForSingleObject,
    };

    if pid == 0 {
        return false;
    }

    // SAFETY: OpenProcess receives a PID from a parsed descriptor and requests
    // synchronization-only access. Access-denied remains conservatively alive.
    let handle = match unsafe { OpenProcess(PROCESS_SYNCHRONIZE, false, pid) } {
        Ok(handle) => handle,
        Err(error) => {
            return error.code() != windows::core::HRESULT::from_win32(ERROR_INVALID_PARAMETER.0);
        }
    };
    // SAFETY: `handle` is valid and was opened with synchronization access.
    let wait = unsafe { WaitForSingleObject(handle, 0) };
    // SAFETY: this is the single paired close for the handle opened above.
    unsafe {
        let _ = CloseHandle(handle);
    }
    wait != WAIT_OBJECT_0
}

#[cfg(unix)]
#[allow(unsafe_code)]
fn process_may_be_alive(pid: u32) -> bool {
    if pid == 0 {
        return false;
    }
    let Ok(pid) = libc::pid_t::try_from(pid) else {
        return false;
    };
    // SAFETY: signal 0 performs existence/permission checking only and does not
    // deliver a signal. ESRCH is the sole definitive "process is gone" result.
    let result = unsafe { libc::kill(pid, 0) };
    result == 0 || io::Error::last_os_error().raw_os_error() != Some(libc::ESRCH)
}

#[cfg(not(any(unix, windows)))]
fn process_may_be_alive(_pid: u32) -> bool {
    true
}

/// Case-tolerant, separator-tolerant root comparison (Windows paths).
fn same_root_identity(a: &str, b: &str) -> bool {
    let canon = |raw: &str| {
        let normalized = raw.replace('\\', "/");
        let trimmed = normalized.trim_end_matches('/').to_string();
        if cfg!(windows) {
            trimmed.to_lowercase()
        } else {
            trimmed
        }
    };
    canon(a) == canon(b)
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SidecarLiveness {
    Alive,
    Dead,
    Unknown,
    NoSidecar,
}

impl SidecarLiveness {
    pub fn as_str(self) -> &'static str {
        match self {
            Self::Alive => "alive",
            Self::Dead => "dead",
            Self::Unknown => "unknown",
            Self::NoSidecar => "none",
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SidecarStatus {
    pub pid: Option<u32>,
    pub port: Option<u16>,
    pub liveness: SidecarLiveness,
    pub detail: Option<String>,
}

impl SidecarStatus {
    pub(crate) fn no_sidecar() -> Self {
        Self {
            pid: None,
            port: None,
            liveness: SidecarLiveness::NoSidecar,
            detail: None,
        }
    }
}

fn sidecar_files_exist(dir: &Path) -> bool {
    dir.join(port_file_name()).exists()
        || dir.join(pid_file_name()).exists()
        || dir.join(session_file_name()).exists()
        || dir.join(LEGACY_PORT_FILE).exists()
        || dir.join(LEGACY_PID_FILE).exists()
        || dir.join(LEGACY_SESSION_FILE).exists()
}

fn sidecar_socket_addr(bind_host: &str, port: u16) -> io::Result<std::net::SocketAddr> {
    let addr = if bind_host.contains(':') {
        format!("[{bind_host}]:{port}")
    } else {
        format!("{bind_host}:{port}")
    };
    addr.parse()
        .map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))
}

fn sidecar_port_is_alive(bind_host: &str, port: u16) -> io::Result<bool> {
    sidecar_port_is_alive_with_timeout(bind_host, port, SIDECAR_PROBE_TIMEOUT)
}

fn sidecar_port_is_alive_with_timeout(
    bind_host: &str,
    port: u16,
    timeout: Duration,
) -> io::Result<bool> {
    let sock_addr = sidecar_socket_addr(bind_host, port)?;
    Ok(TcpStream::connect_timeout(&sock_addr, timeout).is_ok())
}

fn read_sidecar_status_for_root_at(
    symforge_dir: &Path,
    bind_host: &str,
    expected_project_root: Option<&Path>,
) -> SidecarStatus {
    // Task 8: per-adapter descriptors are authoritative; the fixed files below
    // are only a read-compatible migration aid for records written by older
    // binaries.
    if let Some(selected) = select_descriptor_status(symforge_dir, bind_host, expected_project_root)
    {
        return selected.status;
    }
    if !sidecar_files_exist(symforge_dir) {
        return SidecarStatus::no_sidecar();
    }

    let mut details = Vec::new();
    let pid = match read_pid_at(symforge_dir) {
        Ok(pid) => Some(pid),
        Err(error) if error.kind() == io::ErrorKind::NotFound => {
            details.push("sidecar.pid missing".to_string());
            None
        }
        Err(error) => {
            details.push(format!("sidecar.pid invalid: {error}"));
            None
        }
    };
    let port = match read_port_at(symforge_dir) {
        Ok(port) => Some(port),
        Err(error) if error.kind() == io::ErrorKind::NotFound => {
            details.push("sidecar.port missing".to_string());
            None
        }
        Err(error) => {
            details.push(format!("sidecar.port invalid: {error}"));
            None
        }
    };

    let liveness = match port {
        Some(port) => match sidecar_port_is_alive(bind_host, port) {
            Ok(true) => SidecarLiveness::Alive,
            Ok(false) => SidecarLiveness::Dead,
            Err(error) => {
                details.push(format!("sidecar port probe unavailable: {error}"));
                SidecarLiveness::Unknown
            }
        },
        None => SidecarLiveness::Unknown,
    };

    SidecarStatus {
        pid,
        port,
        liveness,
        detail: (!details.is_empty()).then(|| details.join("; ")),
    }
}

pub fn read_sidecar_status_at(symforge_dir: &Path, bind_host: &str) -> SidecarStatus {
    read_sidecar_status_for_root_at(symforge_dir, bind_host, symforge_dir.parent())
}

pub fn read_sidecar_status(
    control_state_dir: &ControlStateDir,
    bind_host: &str,
    expected_project_root: Option<&Path>,
) -> SidecarStatus {
    read_sidecar_status_for_root_at(
        &resolve_symforge_dir(control_state_dir),
        bind_host,
        expected_project_root,
    )
}

/// Resolve the best project-matching sidecar descriptor for hook routing.
pub fn read_sidecar_endpoint(
    control_state_dir: &ControlStateDir,
    bind_host: &str,
    expected_project_root: Option<&Path>,
) -> io::Result<(u16, Option<String>)> {
    let dir = resolve_symforge_dir(control_state_dir);
    if let Some(selected) = select_descriptor_status(&dir, bind_host, expected_project_root)
        && let Some(port) = selected.status.port
    {
        return Ok((port, selected.session_id));
    }

    let port = read_port_at(&dir)?;
    let session_id = read_runtime_file(&dir, &session_file_name(), LEGACY_SESSION_FILE)
        .ok()
        .map(|contents| contents.trim().to_string());
    Ok((port, session_id))
}

/// Remove both port and PID files. Ignores all errors.
///
/// Called during sidecar shutdown — it is safe to call even if files don't exist.
pub fn cleanup_files(control_state_dir: &ControlStateDir) {
    cleanup_files_at(&resolve_symforge_dir(control_state_dir));
}

pub fn cleanup_stale_descriptors(control_state_dir: &ControlStateDir, bind_host: &str) {
    cleanup_stale_descriptors_at(&resolve_symforge_dir(control_state_dir), bind_host);
}

/// Remove port/PID/session files from a specific directory (both the OS-tagged names
/// and the legacy un-tagged names, so a dead old-binary file cannot shadow a fresh one).
/// Used by the panic hook which cannot rely on CWD.
pub fn cleanup_files_at(dir: &std::path::Path) {
    let _ = std::fs::remove_file(dir.join(port_file_name()));
    let _ = std::fs::remove_file(dir.join(pid_file_name()));
    let _ = std::fs::remove_file(dir.join(session_file_name()));
    let _ = std::fs::remove_file(dir.join(LEGACY_PORT_FILE));
    let _ = std::fs::remove_file(dir.join(LEGACY_PID_FILE));
    let _ = std::fs::remove_file(dir.join(LEGACY_SESSION_FILE));
}

/// Check whether the port/PID files are stale (i.e., the old sidecar is no longer running).
///
/// If no port file exists, there is nothing stale — returns `false`.
/// If a port file exists, attempts a blocking TCP connect to `{bind_host}:{port}` with a
/// 200 ms timeout. If the connection succeeds the sidecar is alive and returns `false`.
/// If the connection is refused or times out, the files are stale: calls `cleanup_files()`
/// and returns `true`.
pub fn check_stale(
    control_state_dir: &ControlStateDir,
    bind_host: &str,
    expected_project_root: Option<&Path>,
) -> bool {
    match read_sidecar_status(control_state_dir, bind_host, expected_project_root).liveness {
        SidecarLiveness::Alive | SidecarLiveness::NoSidecar => false,
        SidecarLiveness::Dead => {
            cleanup_stale_descriptors(control_state_dir, bind_host);
            cleanup_files(control_state_dir);
            true
        }
        SidecarLiveness::Unknown => false,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use tempfile::TempDir;

    fn with_temp_control(f: impl FnOnce(&ControlStateDir, &Path)) {
        let tmp = TempDir::new().unwrap();
        let control = ControlStateDir::new(tmp.path().join("control"));
        let sidecar_dir = resolve_symforge_dir(&control);
        f(&control, &sidecar_dir);
    }

    /// Task 8 (recovered finding): closing one adapter must not delete or
    /// invalidate a sibling adapter's runtime record on the same root.
    #[test]
    fn test_per_session_descriptors_do_not_delete_siblings() {
        let tmp = TempDir::new().unwrap();
        let dir = tmp.path();
        {
            write_descriptor_for_pid_at(dir, 111, 40001, Some("session-a"), None)
                .expect("write descriptor A");
            write_descriptor_for_pid_at(dir, 222, 40002, Some("session-b"), None)
                .expect("write descriptor B");
            assert_eq!(read_descriptors_at(dir).len(), 2, "both descriptors exist");

            cleanup_descriptor_for_pid_at(dir, 111);

            let remaining = read_descriptors_at(dir);
            assert_eq!(
                remaining.len(),
                1,
                "only the caller's descriptor is removed"
            );
            assert_eq!(remaining[0].pid, 222, "sibling descriptor survives");
            assert_eq!(remaining[0].session_id.as_deref(), Some("session-b"));
        }
    }

    #[test]
    fn test_reader_removes_dead_pid_descriptors_before_socket_probe() {
        let tmp = TempDir::new().unwrap();
        let dir = tmp.path();
        let listener =
            std::net::TcpListener::bind("127.0.0.1:0").expect("bind recycled probe port");
        listener
            .set_nonblocking(true)
            .expect("make recycled probe listener nonblocking");
        let recycled_port = listener.local_addr().expect("recycled probe addr").port();

        for offset in 0..200 {
            write_descriptor_for_pid_at(
                dir,
                u32::MAX - offset,
                recycled_port,
                Some("stale-session"),
                None,
            )
            .expect("write dead-pid descriptor");
        }

        let scan_started = Instant::now();
        let selected = select_descriptor_status(dir, "127.0.0.1", None);
        let scan_elapsed = scan_started.elapsed();
        assert!(
            selected.is_none(),
            "a reachable recycled port must not revive dead-pid descriptors"
        );
        assert!(
            scan_elapsed < Duration::from_millis(300),
            "200 dead-pid descriptors must remain inside the hook budget: {scan_elapsed:?}"
        );
        assert!(
            read_descriptors_at(dir).is_empty(),
            "dead-pid descriptors must be removed opportunistically"
        );
        let accept_error = listener
            .accept()
            .expect_err("dead-pid descriptors must be rejected before any socket probe");
        assert_eq!(accept_error.kind(), io::ErrorKind::WouldBlock);
    }

    /// Task 8: the reader selects a LIVE descriptor over a fresher dead one,
    /// and rejects a descriptor whose project-root identity does not match
    /// this directory's project instead of choosing last-writer.
    #[test]
    fn test_reader_selects_live_descriptor_and_rejects_foreign_root() {
        let tmp = TempDir::new().unwrap();
        let dir = tmp.path();
        {
            // A live port: keep the listener open for the duration.
            let listener =
                std::net::TcpListener::bind("127.0.0.1:0").expect("bind live probe port");
            let live_port = listener.local_addr().expect("live addr").port();
            // A dead port: bind then release.
            let dead_port = {
                let l = std::net::TcpListener::bind("127.0.0.1:0").expect("bind dead port");
                l.local_addr().expect("dead addr").port()
            };
            let live_pid = std::process::id();
            let dead_pid = u32::MAX;

            write_descriptor_for_pid_at(dir, live_pid, live_port, Some("session-live"), None)
                .expect("write live descriptor");
            write_descriptor_for_pid_at(dir, dead_pid, dead_port, Some("session-dead"), None)
                .expect("write dead descriptor");
            // The dead one is FRESHER (rewrite bumps updated_at); force order by
            // rewriting it after the live one.
            std::thread::sleep(std::time::Duration::from_millis(1100));
            write_descriptor_for_pid_at(dir, dead_pid, dead_port, Some("session-dead"), None)
                .expect("refresh dead descriptor");

            let status = read_sidecar_status_at(dir, "127.0.0.1");
            assert_eq!(status.liveness, SidecarLiveness::Alive);
            assert_eq!(
                status.pid,
                Some(live_pid),
                "live beats fresher-but-dead: {status:?}"
            );
            assert_eq!(status.port, Some(live_port));

            // Identity validation: a descriptor claiming a DIFFERENT project
            // root is rejected, not last-writer-selected.
            cleanup_descriptor_for_pid_at(dir, live_pid);
            cleanup_descriptor_for_pid_at(dir, dead_pid);
            write_descriptor_for_pid_at(
                dir,
                live_pid,
                live_port,
                Some("session-foreign"),
                Some(std::path::Path::new("/somewhere/else/entirely")),
            )
            .expect("write foreign descriptor");
            let status = read_sidecar_status_at(dir, "127.0.0.1");
            assert_ne!(
                status.pid,
                Some(live_pid),
                "foreign-root descriptor must be identity-rejected: {status:?}"
            );
            drop(listener);
        }
    }

    #[test]
    fn test_write_read_port_roundtrip() {
        with_temp_control(|control, _| {
            write_port_file(12345, control).expect("write_port_file should succeed");
            let port = read_port(control).expect("read_port should succeed after write");
            assert_eq!(port, 12345, "port roundtrip must preserve value");
        });
    }

    #[test]
    fn test_write_port_file_no_trailing_newline() {
        with_temp_control(|control, dir| {
            write_port_file(8080, control).expect("write_port_file should succeed");
            let port_path = dir.join(port_file_name());
            let bytes = std::fs::read(&port_path).unwrap();
            assert_eq!(
                bytes, b"8080",
                "port file must contain ONLY the digits, no newline"
            );
        });
    }

    #[test]
    fn test_write_is_os_tagged_only() {
        with_temp_control(|control, dir| {
            write_port_file(8080, control).expect("write_port_file should succeed");
            // Writer is tag-pure: the OS-tagged file exists, the legacy name does NOT.
            assert!(
                dir.join(port_file_name()).exists(),
                "OS-tagged port file must exist after write"
            );
            assert!(
                !dir.join(LEGACY_PORT_FILE).exists(),
                "writer must NOT create a legacy un-tagged port file (would re-open cross-OS collision)"
            );
            assert!(
                port_file_name().contains(std::env::consts::OS),
                "tagged name must carry this OS"
            );
        });
    }

    #[test]
    fn test_read_falls_back_to_legacy_untagged() {
        with_temp_control(|control, _| {
            // Simulate a sidecar started by an OLD (pre-tag) binary.
            let dir = ensure_symforge_dir(control).expect("dir");
            std::fs::write(dir.join(LEGACY_PORT_FILE), b"7777").unwrap();
            let port = read_port(control).expect("read_port must fall back to legacy file");
            assert_eq!(port, 7777, "legacy fallback must read the un-tagged port");
        });
    }

    #[test]
    fn test_tagged_wins_over_legacy() {
        with_temp_control(|control, _| {
            let dir = ensure_symforge_dir(control).expect("dir");
            std::fs::write(dir.join(LEGACY_PORT_FILE), b"1111").unwrap();
            std::fs::write(dir.join(port_file_name()), b"2222").unwrap();
            let port = read_port(control).expect("read_port should succeed");
            assert_eq!(
                port, 2222,
                "OS-tagged file must take precedence over legacy"
            );
        });
    }

    #[test]
    fn test_cleanup_removes_files() {
        with_temp_control(|control, dir| {
            write_port_file(9000, control).expect("write should succeed");
            write_pid_file(12345, control).expect("write should succeed");
            // Also drop legacy files to prove cleanup removes BOTH.
            std::fs::write(dir.join(LEGACY_PORT_FILE), b"9000").unwrap();
            std::fs::write(dir.join(LEGACY_PID_FILE), b"12345").unwrap();

            assert!(
                dir.join(port_file_name()).exists(),
                "tagged port file should exist before cleanup"
            );
            assert!(
                dir.join(pid_file_name()).exists(),
                "tagged pid file should exist before cleanup"
            );

            cleanup_files(control);

            for name in [
                port_file_name(),
                pid_file_name(),
                LEGACY_PORT_FILE.to_string(),
                LEGACY_PID_FILE.to_string(),
            ] {
                assert!(
                    !dir.join(&name).exists(),
                    "{name} should be gone after cleanup (tagged + legacy)"
                );
            }
        });
    }

    #[test]
    fn test_cleanup_is_noop_when_no_files() {
        with_temp_control(|control, _| {
            // Should not panic even if files don't exist.
            cleanup_files(control);
        });
    }

    #[test]
    fn test_read_port_missing_returns_error() {
        with_temp_control(|control, _| {
            let result = read_port(control);
            assert!(
                result.is_err(),
                "read_port should return error when file is missing"
            );
        });
    }

    #[test]
    fn test_ensure_symforge_dir_creates_directory() {
        with_temp_control(|control, _| {
            let dir = ensure_symforge_dir(control).expect("ensure_symforge_dir should succeed");
            assert!(
                dir.exists(),
                ".symforge directory should exist after ensure_symforge_dir"
            );
            assert!(dir.is_dir(), "path should be a directory");
        });
    }

    #[test]
    fn test_ensure_symforge_dir_idempotent() {
        with_temp_control(|control, _| {
            ensure_symforge_dir(control).expect("first call should succeed");
            ensure_symforge_dir(control).expect("second call should also succeed (idempotent)");
        });
    }
    #[test]
    fn test_check_stale_returns_false_when_no_port_file() {
        with_temp_control(|control, _| {
            let is_stale = check_stale(control, "127.0.0.1", None);
            assert!(!is_stale, "no port file means nothing is stale");
        });
    }

    #[test]
    fn test_check_stale_cleans_up_when_port_is_closed() {
        with_temp_control(|control, dir| {
            // Write a port that is very unlikely to have anything listening.
            write_port_file(19999, control).expect("write should succeed");
            write_pid_file(99999, control).expect("write should succeed");

            let is_stale = check_stale(control, "127.0.0.1", None);
            assert!(
                is_stale,
                "port 19999 should be detected as stale (nothing listening)"
            );

            // Cleanup should have been called.
            assert!(
                !dir.join(port_file_name()).exists(),
                "port file cleaned up after stale detection"
            );
        });
    }
}