1#[cfg(unix)]
2use std::ffi::CString;
3use std::ffi::{OsStr, OsString};
4use std::fs::{self, File, OpenOptions};
5use std::io::{self, Read, Seek, SeekFrom, Write};
6#[cfg(unix)]
7use std::os::fd::{AsRawFd, FromRawFd, RawFd};
8#[cfg(unix)]
9use std::os::unix::ffi::{OsStrExt, OsStringExt};
10#[cfg(unix)]
11use std::os::unix::fs::{MetadataExt, OpenOptionsExt, PermissionsExt};
12#[cfg(windows)]
13use std::os::windows::fs::{MetadataExt, OpenOptionsExt};
14#[cfg(windows)]
15use std::os::windows::io::AsRawHandle;
16use std::path::{Path, PathBuf};
17use std::sync::Arc;
18use std::time::{SystemTime, UNIX_EPOCH};
19
20use serde::{Deserialize, Serialize};
21
22use crate::backup::hash_session;
23use crate::bash_permissions::PermissionAsk;
24use crate::db::bash_tasks::BashTaskRow;
25
26use super::process::LiveDescendant;
27use super::BgTaskStatus;
28
29pub const SCHEMA_VERSION: u32 = 6;
30const CONTROL_DIR: &str = "control";
31const IO_DIR: &str = "io";
32const METADATA_FILE: &str = "metadata.json";
33pub const COMMAND_FILE: &str = "command.sh";
34pub const WRAPPER_FILE: &str = "wrapper.sh";
35pub const ENVIRONMENT_FILE: &str = "environment.bin";
36pub const MANIFEST_FILE: &str = "manifest.blake3";
37pub const SANDBOX_PROFILE_FILE: &str = "sandbox-profile.json";
38
39#[derive(Debug, Clone, Copy, PartialEq, Eq)]
40pub enum TaskLayout {
41 Flat,
42 Directory,
43}
44
45#[derive(Debug, Clone)]
46pub struct TaskPaths {
47 pub layout: TaskLayout,
48 pub task_id: String,
49 pub session_dir: PathBuf,
50 pub dir: PathBuf,
53 pub control_dir: PathBuf,
54 pub io_dir: PathBuf,
55 pub json: PathBuf,
56 pub stdout: PathBuf,
57 pub stderr: PathBuf,
58 pub exit: PathBuf,
59 pub pipeline_status: PathBuf,
60 pub pty: PathBuf,
61 pub sandbox_unavailable: PathBuf,
62 pub command: PathBuf,
63 pub wrapper: PathBuf,
64 pub environment: PathBuf,
65 pub manifest: PathBuf,
66 pub sandbox_profile: PathBuf,
67}
68
69impl TaskPaths {
70 fn directory(session_dir: PathBuf, task_id: &str) -> Self {
71 let dir = session_dir.join(task_id);
72 let control_dir = dir.join(CONTROL_DIR);
73 let io_dir = dir.join(IO_DIR);
74 Self {
75 layout: TaskLayout::Directory,
76 task_id: task_id.to_string(),
77 session_dir,
78 dir,
79 json: control_dir.join(METADATA_FILE),
80 stdout: io_dir.join(TaskArtifact::Stdout.file_name()),
81 stderr: io_dir.join(TaskArtifact::Stderr.file_name()),
82 exit: io_dir.join(TaskArtifact::Exit.file_name()),
83 pipeline_status: io_dir.join(TaskArtifact::PipelineStatus.file_name()),
84 pty: io_dir.join(TaskArtifact::Pty.file_name()),
85 sandbox_unavailable: io_dir.join(TaskArtifact::SandboxUnavailable.file_name()),
86 command: control_dir.join(COMMAND_FILE),
87 wrapper: control_dir.join(WRAPPER_FILE),
88 environment: control_dir.join(ENVIRONMENT_FILE),
89 manifest: control_dir.join(MANIFEST_FILE),
90 sandbox_profile: control_dir.join(SANDBOX_PROFILE_FILE),
91 control_dir,
92 io_dir,
93 }
94 }
95
96 fn flat(session_dir: PathBuf, task_id: &str) -> Self {
97 let prefix = |extension: &str| session_dir.join(format!("{task_id}.{extension}"));
98 Self {
99 layout: TaskLayout::Flat,
100 task_id: task_id.to_string(),
101 dir: session_dir.clone(),
102 control_dir: session_dir.clone(),
103 io_dir: session_dir.clone(),
104 json: prefix("json"),
105 stdout: prefix("stdout"),
106 stderr: prefix("stderr"),
107 exit: prefix("exit"),
108 pipeline_status: prefix("pipeline-status"),
109 pty: prefix("pty"),
110 sandbox_unavailable: prefix("sandbox-unavailable"),
111 command: prefix("sh"),
112 wrapper: prefix("wrapper.sh"),
113 environment: prefix("env"),
114 manifest: prefix("manifest"),
115 sandbox_profile: prefix("sandbox-profile.json"),
116 session_dir,
117 }
118 }
119
120 pub fn artifact_path(&self, artifact: TaskArtifact) -> &Path {
121 match artifact {
122 TaskArtifact::Stdout => &self.stdout,
123 TaskArtifact::Stderr => &self.stderr,
124 TaskArtifact::Exit => &self.exit,
125 TaskArtifact::PipelineStatus => &self.pipeline_status,
126 TaskArtifact::Pty => &self.pty,
127 TaskArtifact::SandboxUnavailable => &self.sandbox_unavailable,
128 }
129 }
130
131 fn artifact_name(&self, artifact: TaskArtifact) -> OsString {
132 match self.layout {
133 TaskLayout::Directory => OsString::from(artifact.file_name()),
134 TaskLayout::Flat => {
135 OsString::from(format!("{}.{}", self.task_id, artifact.flat_extension()))
136 }
137 }
138 }
139}
140
141#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
142pub enum TaskArtifact {
143 Stdout,
144 Stderr,
145 Exit,
146 PipelineStatus,
147 Pty,
148 SandboxUnavailable,
149}
150
151impl TaskArtifact {
152 pub const ALL: [Self; 6] = [
153 Self::Stdout,
154 Self::Stderr,
155 Self::Exit,
156 Self::PipelineStatus,
157 Self::Pty,
158 Self::SandboxUnavailable,
159 ];
160
161 pub fn file_name(self) -> &'static str {
162 match self {
163 Self::Stdout => "stdout",
164 Self::Stderr => "stderr",
165 Self::Exit => "exit",
166 Self::PipelineStatus => "pipeline-status",
167 Self::Pty => "pty",
168 Self::SandboxUnavailable => "sandbox-unavailable",
169 }
170 }
171
172 fn flat_extension(self) -> &'static str {
173 match self {
174 Self::Stdout => "stdout",
175 Self::Stderr => "stderr",
176 Self::Exit => "exit",
177 Self::PipelineStatus => "pipeline-status",
178 Self::Pty => "pty",
179 Self::SandboxUnavailable => "sandbox-unavailable",
180 }
181 }
182}
183
184#[derive(Debug)]
185pub struct PinnedDir {
186 file: File,
187 path: PathBuf,
188}
189
190impl PinnedDir {
191 pub fn open(path: &Path) -> io::Result<Self> {
192 #[cfg(unix)]
193 let file = OpenOptions::new()
194 .read(true)
195 .custom_flags(libc::O_DIRECTORY | libc::O_NOFOLLOW | libc::O_CLOEXEC)
196 .open(path)?;
197 #[cfg(windows)]
198 let file = OpenOptions::new()
199 .read(true)
200 .custom_flags(FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS)
201 .open(path)?;
202 validate_directory_handle(&file)?;
203 Ok(Self {
204 file,
205 path: path.to_path_buf(),
206 })
207 }
208
209 pub fn path(&self) -> &Path {
210 &self.path
211 }
212
213 fn modified(&self) -> io::Result<SystemTime> {
214 self.file.metadata()?.modified()
215 }
216
217 fn same_identity(&self, other: &Self) -> io::Result<bool> {
218 #[cfg(unix)]
219 {
220 let left = self.file.metadata()?;
221 let right = other.file.metadata()?;
222 Ok(left.dev() == right.dev() && left.ino() == right.ino())
223 }
224 #[cfg(windows)]
225 {
226 let left = windows_file_information(&self.file)?;
227 let right = windows_file_information(&other.file)?;
228 Ok(left.volume_serial_number == right.volume_serial_number
229 && left.file_index_high == right.file_index_high
230 && left.file_index_low == right.file_index_low)
231 }
232 }
233
234 #[cfg(unix)]
235 fn open_dir_at(&self, name: &OsStr) -> io::Result<Self> {
236 let file = openat_file(
237 self.file.as_raw_fd(),
238 name,
239 libc::O_RDONLY | libc::O_DIRECTORY | libc::O_NOFOLLOW | libc::O_CLOEXEC,
240 0,
241 )?;
242 validate_directory_handle(&file)?;
243 Ok(Self {
244 file,
245 path: self.path.join(name),
246 })
247 }
248
249 #[cfg(windows)]
250 fn open_dir_at(&self, name: &OsStr) -> io::Result<Self> {
251 self.ensure_current_identity()?;
252 let child = Self::open(&self.path.join(name))?;
253 self.ensure_current_identity()?;
254 Ok(child)
255 }
256
257 #[cfg(unix)]
258 fn create_dir_at(&self, name: &OsStr) -> io::Result<Self> {
259 let name = os_cstring(name)?;
260 let result = unsafe { libc::mkdirat(self.file.as_raw_fd(), name.as_ptr(), 0o700) };
261 if result != 0 {
262 return Err(io::Error::last_os_error());
263 }
264 self.open_dir_at(OsStr::from_bytes(name.as_bytes()))
265 }
266
267 #[cfg(windows)]
268 fn create_dir_at(&self, name: &OsStr) -> io::Result<Self> {
269 self.ensure_current_identity()?;
270 let path = self.path.join(name);
271 fs::create_dir(&path)?;
272 self.ensure_current_identity()?;
273 Self::open(&path)
274 }
275
276 pub fn open_new_file(&self, name: &OsStr) -> io::Result<File> {
277 #[cfg(unix)]
278 let file = openat_file(
279 self.file.as_raw_fd(),
280 name,
281 libc::O_RDWR | libc::O_CREAT | libc::O_EXCL | libc::O_NOFOLLOW | libc::O_CLOEXEC,
282 0o600,
283 )?;
284 #[cfg(windows)]
285 self.ensure_current_identity()?;
286 #[cfg(windows)]
287 let file = OpenOptions::new()
288 .read(true)
289 .write(true)
290 .create_new(true)
291 .custom_flags(FILE_FLAG_OPEN_REPARSE_POINT)
292 .open(self.path.join(name))?;
293 validate_regular_handle(&file)?;
294 #[cfg(windows)]
295 self.ensure_current_identity()?;
296 Ok(file)
297 }
298
299 pub fn open_file(&self, name: &OsStr, write: bool) -> io::Result<File> {
300 #[cfg(unix)]
301 let file = openat_file(
302 self.file.as_raw_fd(),
303 name,
304 (if write {
305 libc::O_RDWR
306 } else {
307 libc::O_RDONLY | libc::O_NONBLOCK
308 }) | libc::O_NOFOLLOW
309 | libc::O_CLOEXEC,
310 0,
311 )?;
312 #[cfg(windows)]
313 self.ensure_current_identity()?;
314 #[cfg(windows)]
315 let file = OpenOptions::new()
316 .read(true)
317 .write(write)
318 .custom_flags(FILE_FLAG_OPEN_REPARSE_POINT)
319 .open(self.path.join(name))?;
320 validate_regular_handle(&file)?;
321 #[cfg(unix)]
322 if !write {
323 clear_nonblocking(&file)?;
324 }
325 #[cfg(windows)]
326 self.ensure_current_identity()?;
327 Ok(file)
328 }
329
330 pub fn list_names(&self) -> io::Result<Vec<OsString>> {
331 #[cfg(unix)]
332 {
333 let dot = b".\0";
334 let fresh = unsafe {
335 libc::openat(
336 self.file.as_raw_fd(),
337 dot.as_ptr().cast(),
338 libc::O_RDONLY | libc::O_DIRECTORY | libc::O_CLOEXEC | libc::O_NOFOLLOW,
339 )
340 };
341 if fresh < 0 {
342 return Err(io::Error::last_os_error());
343 }
344 let directory = unsafe { libc::fdopendir(fresh) };
345 if directory.is_null() {
346 let error = io::Error::last_os_error();
347 unsafe { libc::close(fresh) };
348 return Err(error);
349 }
350 let mut names = Vec::new();
351 loop {
352 let entry = unsafe { libc::readdir(directory) };
353 if entry.is_null() {
354 break;
355 }
356 let bytes = unsafe {
357 std::ffi::CStr::from_ptr((*entry).d_name.as_ptr())
358 .to_bytes()
359 .to_vec()
360 };
361 if bytes != b"." && bytes != b".." {
362 names.push(OsString::from_vec(bytes));
363 }
364 }
365 unsafe { libc::closedir(directory) };
366 Ok(names)
367 }
368 #[cfg(windows)]
369 {
370 self.ensure_current_identity()?;
371 let names = fs::read_dir(&self.path)?
372 .map(|entry| entry.map(|entry| entry.file_name()))
373 .collect::<io::Result<Vec<_>>>()?;
374 self.ensure_current_identity()?;
375 Ok(names)
376 }
377 }
378
379 fn rename(&self, from: &OsStr, to: &OsStr) -> io::Result<()> {
380 self.rename_to(from, self, to)
381 }
382
383 fn rename_to(&self, from: &OsStr, target: &PinnedDir, to: &OsStr) -> io::Result<()> {
384 #[cfg(unix)]
385 {
386 let from = os_cstring(from)?;
387 let to = os_cstring(to)?;
388 let result = unsafe {
389 libc::renameat(
390 self.file.as_raw_fd(),
391 from.as_ptr(),
392 target.file.as_raw_fd(),
393 to.as_ptr(),
394 )
395 };
396 if result != 0 {
397 return Err(io::Error::last_os_error());
398 }
399 Ok(())
400 }
401 #[cfg(windows)]
402 {
403 self.ensure_current_identity()?;
404 target.ensure_current_identity()?;
405 fs::rename(self.path.join(from), target.path.join(to))?;
406 self.ensure_current_identity()?;
407 target.ensure_current_identity()
408 }
409 }
410
411 #[cfg(windows)]
412 fn ensure_current_identity(&self) -> io::Result<()> {
413 let current = OpenOptions::new()
414 .read(true)
415 .custom_flags(FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS)
416 .open(&self.path)?;
417 validate_directory_handle(¤t)?;
418 let held = windows_file_information(&self.file)?;
419 let observed = windows_file_information(¤t)?;
420 if held.volume_serial_number != observed.volume_serial_number
421 || held.file_index_high != observed.file_index_high
422 || held.file_index_low != observed.file_index_low
423 {
424 return Err(io::Error::new(
425 io::ErrorKind::PermissionDenied,
426 "pinned directory path identity changed",
427 ));
428 }
429 Ok(())
430 }
431
432 fn remove_file(&self, name: &OsStr) -> io::Result<()> {
433 #[cfg(unix)]
434 {
435 let name = os_cstring(name)?;
436 let result = unsafe { libc::unlinkat(self.file.as_raw_fd(), name.as_ptr(), 0) };
437 if result != 0 {
438 return Err(io::Error::last_os_error());
439 }
440 Ok(())
441 }
442 #[cfg(windows)]
443 {
444 self.ensure_current_identity()?;
445 fs::remove_file(self.path.join(name))?;
446 self.ensure_current_identity()
447 }
448 }
449}
450
451#[derive(Debug)]
452pub struct TaskDirs {
453 pub session: Arc<PinnedDir>,
454 pub task: Arc<PinnedDir>,
455 pub control: Arc<PinnedDir>,
456 pub io: Arc<PinnedDir>,
457}
458
459impl Clone for TaskDirs {
460 fn clone(&self) -> Self {
461 Self {
462 session: Arc::clone(&self.session),
463 task: Arc::clone(&self.task),
464 control: Arc::clone(&self.control),
465 io: Arc::clone(&self.io),
466 }
467 }
468}
469
470#[derive(Debug)]
471pub struct ResolvedTask {
472 pub paths: TaskPaths,
473 pub dirs: TaskDirs,
474}
475
476#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
477#[serde(rename_all = "lowercase")]
478pub enum BgMode {
479 #[default]
480 Pipes,
481 Pty,
482}
483
484#[derive(Debug, Clone, Serialize, Deserialize)]
485pub struct PersistedTask {
486 pub schema_version: u32,
487 pub task_id: String,
488 pub session_id: String,
489 pub command: String,
490 #[serde(default, skip_serializing_if = "Vec::is_empty")]
493 pub pipeline_segments: Vec<String>,
494 #[serde(default, skip_serializing_if = "Option::is_none")]
495 pub pipeline_status_unavailable: Option<String>,
496 #[serde(default)]
497 pub mode: BgMode,
498 pub workdir: PathBuf,
499 #[serde(default)]
500 pub project_root: Option<PathBuf>,
501 pub status: BgTaskStatus,
502 pub started_at: u64,
503 pub finished_at: Option<u64>,
504 pub duration_ms: Option<u64>,
505 pub timeout_ms: Option<u64>,
506 pub exit_code: Option<i32>,
507 pub child_pid: Option<u32>,
508 pub pgid: Option<i32>,
509 #[serde(default, skip_serializing_if = "Option::is_none")]
512 pub live_descendants: Option<Vec<LiveDescendant>>,
513 #[serde(default, skip_serializing_if = "is_zero")]
514 pub live_descendants_omitted: usize,
515 pub completion_delivered: bool,
516 #[serde(default = "default_notify_on_completion")]
517 pub notify_on_completion: bool,
518 #[serde(default = "default_compressed")]
519 pub compressed: bool,
520 #[serde(default)]
521 pub pty_rows: Option<u16>,
522 #[serde(default)]
523 pub pty_cols: Option<u16>,
524 #[serde(default, skip_serializing_if = "Vec::is_empty")]
525 pub scanner_report: Vec<PermissionAsk>,
526 #[serde(default)]
527 pub sandbox_native: bool,
528 #[serde(default, skip_serializing_if = "Option::is_none")]
529 pub sandbox_temp_dir: Option<PathBuf>,
530 pub status_reason: Option<String>,
531}
532
533fn default_notify_on_completion() -> bool {
534 true
535}
536
537fn default_compressed() -> bool {
538 true
539}
540
541fn is_zero(value: &usize) -> bool {
542 *value == 0
543}
544
545#[derive(Debug, Clone, PartialEq, Eq)]
546pub enum ExitMarker {
547 Code(i32),
548 Killed,
549}
550
551impl PersistedTask {
552 #[allow(clippy::too_many_arguments)]
553 pub fn starting(
554 task_id: String,
555 session_id: String,
556 command: String,
557 workdir: PathBuf,
558 project_root: Option<PathBuf>,
559 timeout_ms: Option<u64>,
560 notify_on_completion: bool,
561 compressed: bool,
562 ) -> Self {
563 Self {
564 schema_version: SCHEMA_VERSION,
565 task_id,
566 session_id,
567 command,
568 pipeline_segments: Vec::new(),
569 pipeline_status_unavailable: None,
570 mode: BgMode::Pipes,
571 workdir,
572 project_root,
573 status: BgTaskStatus::Starting,
574 started_at: unix_millis(),
575 finished_at: None,
576 duration_ms: None,
577 timeout_ms,
578 exit_code: None,
579 child_pid: None,
580 pgid: None,
581 live_descendants: None,
582 live_descendants_omitted: 0,
583 completion_delivered: !notify_on_completion,
584 notify_on_completion,
585 compressed,
586 pty_rows: None,
587 pty_cols: None,
588 scanner_report: Vec::new(),
589 sandbox_native: false,
590 sandbox_temp_dir: None,
591 status_reason: None,
592 }
593 }
594
595 pub fn is_terminal(&self) -> bool {
596 self.status.is_terminal()
597 }
598
599 pub fn mark_running(&mut self, child_pid: u32, pgid: i32) {
600 self.status = BgTaskStatus::Running;
601 self.child_pid = Some(child_pid);
602 self.pgid = Some(pgid);
603 }
604
605 pub fn mark_terminal(
606 &mut self,
607 status: BgTaskStatus,
608 exit_code: Option<i32>,
609 reason: Option<String>,
610 ) {
611 let finished_at = unix_millis();
612 self.status = status;
613 self.exit_code = exit_code;
614 self.finished_at = Some(finished_at);
615 self.duration_ms = Some(finished_at.saturating_sub(self.started_at));
616 self.child_pid = None;
617 self.status_reason = reason;
618 self.completion_delivered = !self.notify_on_completion;
619 }
620
621 pub fn to_bash_task_row(
622 &self,
623 harness: &str,
624 paths: &TaskPaths,
625 ) -> Result<BashTaskRow, serde_json::Error> {
626 let project_root = self.project_root.as_deref().unwrap_or(&self.workdir);
627 let output_bytes = capture_output_bytes(&self.mode, paths);
628 let stdout_path = match self.mode {
629 BgMode::Pipes => Some(paths.stdout.display().to_string()),
630 BgMode::Pty => Some(paths.pty.display().to_string()),
631 };
632 let stderr_path = match self.mode {
633 BgMode::Pipes => Some(paths.stderr.display().to_string()),
634 BgMode::Pty => None,
635 };
636 let mut metadata = self.clone();
637 metadata.schema_version = SCHEMA_VERSION;
638 Ok(BashTaskRow {
639 harness: harness.to_string(),
640 session_id: self.session_id.clone(),
641 task_id: self.task_id.clone(),
642 project_key: crate::path_identity::project_scope_key(project_root),
643 command: self.command.clone(),
644 cwd: self.workdir.display().to_string(),
645 status: status_name(&self.status).to_string(),
646 exit_code: self.exit_code,
647 pid: self.child_pid.map(i64::from),
648 pgid: self.pgid.map(i64::from),
649 started_at: self.started_at as i64,
650 completed_at: self.finished_at.map(|value| value as i64),
651 stdout_path,
652 stderr_path,
653 compressed: self.compressed,
654 timeout_ms: self.timeout_ms.map(|value| value as i64),
655 completion_delivered: self.completion_delivered,
656 output_bytes,
657 metadata: serde_json::to_string(&metadata)?,
658 })
659 }
660}
661
662impl From<BashTaskRow> for PersistedTask {
663 fn from(row: BashTaskRow) -> Self {
664 if let Ok(task) = serde_json::from_str::<PersistedTask>(&row.metadata) {
665 return task;
666 }
667 let status = match row.status.as_str() {
668 "starting" => BgTaskStatus::Starting,
669 "running" => BgTaskStatus::Running,
670 "killing" => BgTaskStatus::Killing,
671 "completed" => BgTaskStatus::Completed,
672 "failed" => BgTaskStatus::Failed,
673 "killed" => BgTaskStatus::Killed,
674 "timed_out" => BgTaskStatus::TimedOut,
675 "fate_unknown" => BgTaskStatus::FateUnknown,
676 _ => BgTaskStatus::Failed,
677 };
678 let started_at = u64::try_from(row.started_at).unwrap_or_default();
679 let finished_at = row.completed_at.and_then(|value| u64::try_from(value).ok());
680 Self {
681 schema_version: SCHEMA_VERSION,
682 task_id: row.task_id,
683 session_id: row.session_id,
684 command: row.command,
685 pipeline_segments: Vec::new(),
686 pipeline_status_unavailable: None,
687 mode: BgMode::Pipes,
688 workdir: PathBuf::from(row.cwd),
689 project_root: None,
690 status,
691 started_at,
692 finished_at,
693 duration_ms: finished_at.map(|finished_at| finished_at.saturating_sub(started_at)),
694 timeout_ms: row.timeout_ms.and_then(|value| u64::try_from(value).ok()),
695 exit_code: row.exit_code,
696 child_pid: row.pid.and_then(|value| u32::try_from(value).ok()),
697 pgid: row.pgid.and_then(|value| i32::try_from(value).ok()),
698 live_descendants: None,
699 live_descendants_omitted: 0,
700 completion_delivered: row.completion_delivered,
701 notify_on_completion: !row.completion_delivered,
702 compressed: row.compressed,
703 pty_rows: None,
704 pty_cols: None,
705 scanner_report: Vec::new(),
706 sandbox_native: false,
707 sandbox_temp_dir: None,
708 status_reason: None,
709 }
710 }
711}
712
713fn status_name(status: &BgTaskStatus) -> &'static str {
714 match status {
715 BgTaskStatus::Starting => "starting",
716 BgTaskStatus::Running => "running",
717 BgTaskStatus::Killing => "killing",
718 BgTaskStatus::Completed => "completed",
719 BgTaskStatus::Failed => "failed",
720 BgTaskStatus::Killed => "killed",
721 BgTaskStatus::TimedOut => "timed_out",
722 BgTaskStatus::FateUnknown => "fate_unknown",
723 }
724}
725
726fn capture_output_bytes(mode: &BgMode, paths: &TaskPaths) -> Option<i64> {
727 let len = |artifact| {
728 open_task_artifact(paths, artifact)
729 .ok()
730 .and_then(|file| file.len().ok())
731 };
732 match mode {
733 BgMode::Pipes => match (len(TaskArtifact::Stdout), len(TaskArtifact::Stderr)) {
734 (Some(stdout), Some(stderr)) => Some(stdout.saturating_add(stderr) as i64),
735 (Some(bytes), None) | (None, Some(bytes)) => Some(bytes as i64),
736 (None, None) => None,
737 },
738 BgMode::Pty => len(TaskArtifact::Pty).map(|bytes| bytes as i64),
739 }
740}
741
742pub fn validate_task_id(task_id: &str) -> io::Result<()> {
743 let bytes = task_id.as_bytes();
744 if bytes.len() == 21
745 && bytes.starts_with(b"bash-")
746 && bytes[5..]
747 .iter()
748 .all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(byte))
749 {
750 Ok(())
751 } else {
752 Err(io::Error::new(
753 io::ErrorKind::InvalidInput,
754 "background task id must match ^bash-[0-9a-f]{16}$",
755 ))
756 }
757}
758
759pub fn session_tasks_dir(storage_dir: &Path, session_id: &str) -> PathBuf {
760 let session_hash = hash_session(session_id);
761 let direct = storage_dir.join("bash-tasks").join(&session_hash);
762 if direct.exists() {
763 return direct;
764 }
765 let mut harness_matches = ["opencode", "pi"]
766 .into_iter()
767 .map(|harness| {
768 storage_dir
769 .join(harness)
770 .join("bash-tasks")
771 .join(&session_hash)
772 })
773 .filter(|path| path.exists())
774 .collect::<Vec<_>>();
775 if harness_matches.len() == 1 {
776 return harness_matches.remove(0);
777 }
778 direct
779}
780
781pub fn task_paths(storage_dir: &Path, session_id: &str, task_id: &str) -> io::Result<TaskPaths> {
782 validate_task_id(task_id)?;
783 Ok(TaskPaths::flat(
784 session_tasks_dir(storage_dir, session_id),
785 task_id,
786 ))
787}
788
789pub fn allocate_task_layout(storage_dir: &Path, session_id: &str) -> io::Result<ResolvedTask> {
790 let session_dir = session_tasks_dir(storage_dir, session_id);
791 create_private_task_store(&session_dir)?;
792 let session = Arc::new(PinnedDir::open(&session_dir)?);
793 for _ in 0..32 {
794 let task_id = random_task_id()?;
795 match create_task_layout_from_session(Arc::clone(&session), &task_id) {
796 Ok(task) => return Ok(task),
797 Err(error) if error.kind() == io::ErrorKind::AlreadyExists => continue,
798 Err(error) => return Err(error),
799 }
800 }
801 Err(io::Error::new(
802 io::ErrorKind::AlreadyExists,
803 "failed to allocate unique background task id after 32 attempts",
804 ))
805}
806
807pub fn create_task_layout(
808 storage_dir: &Path,
809 session_id: &str,
810 task_id: &str,
811) -> io::Result<ResolvedTask> {
812 validate_task_id(task_id)?;
813 let session_dir = session_tasks_dir(storage_dir, session_id);
814 create_private_task_store(&session_dir)?;
815 create_task_layout_from_session(Arc::new(PinnedDir::open(&session_dir)?), task_id)
816}
817
818fn create_private_task_store(session_dir: &Path) -> io::Result<()> {
819 fs::create_dir_all(session_dir)?;
820 #[cfg(unix)]
821 {
822 let parent = session_dir.parent().ok_or_else(|| {
823 io::Error::new(
824 io::ErrorKind::InvalidInput,
825 "session task directory has no bash-tasks parent",
826 )
827 })?;
828 fs::set_permissions(parent, fs::Permissions::from_mode(0o700))?;
829 fs::set_permissions(session_dir, fs::Permissions::from_mode(0o700))?;
830 }
831 Ok(())
832}
833
834fn create_task_layout_from_session(
835 session: Arc<PinnedDir>,
836 task_id: &str,
837) -> io::Result<ResolvedTask> {
838 validate_task_id(task_id)?;
839 let task = session.create_dir_at(OsStr::new(task_id))?;
840 let control = task.create_dir_at(OsStr::new(CONTROL_DIR))?;
841 let io_dir = task.create_dir_at(OsStr::new(IO_DIR))?;
842 let paths = TaskPaths::directory(session.path.clone(), task_id);
843 Ok(ResolvedTask {
844 paths,
845 dirs: TaskDirs {
846 session,
847 task: Arc::new(task),
848 control: Arc::new(control),
849 io: Arc::new(io_dir),
850 },
851 })
852}
853
854pub fn resolve_task_layout(session_dir: &Path, task_id: &str) -> io::Result<ResolvedTask> {
855 let task = resolve_uninitialized_task_layout(session_dir, task_id)?;
856 let metadata = read_task_at(&task)?;
857 if metadata.task_id != task_id {
858 return Err(io::Error::new(
859 io::ErrorKind::InvalidData,
860 "background task metadata identity mismatch",
861 ));
862 }
863 Ok(task)
864}
865
866pub fn resolve_uninitialized_task_layout(
867 session_dir: &Path,
868 task_id: &str,
869) -> io::Result<ResolvedTask> {
870 validate_task_id(task_id)?;
871 let session = Arc::new(PinnedDir::open(session_dir)?);
872 let directory = session.open_dir_at(OsStr::new(task_id));
873 let flat_name = OsString::from(format!("{task_id}.json"));
874 let flat = session.open_file(&flat_name, false);
875 let has_directory = match &directory {
876 Ok(_) => true,
877 Err(error) if error.kind() == io::ErrorKind::NotFound => false,
878 Err(error) => {
879 return Err(io::Error::new(
880 error.kind(),
881 format!("invalid task directory: {error}"),
882 ))
883 }
884 };
885 let has_flat = match &flat {
886 Ok(_) => true,
887 Err(error) if error.kind() == io::ErrorKind::NotFound => false,
888 Err(error) => {
889 return Err(io::Error::new(
890 error.kind(),
891 format!("invalid flat task metadata: {error}"),
892 ))
893 }
894 };
895 if has_directory && has_flat {
896 return Err(io::Error::new(
897 io::ErrorKind::InvalidData,
898 "duplicate flat and directory background task layouts",
899 ));
900 }
901 if has_directory {
902 let task = directory.expect("directory result checked");
903 let control = task.open_dir_at(OsStr::new(CONTROL_DIR))?;
904 let io_dir = task.open_dir_at(OsStr::new(IO_DIR))?;
905 let paths = TaskPaths::directory(session_dir.to_path_buf(), task_id);
906 return Ok(ResolvedTask {
907 paths,
908 dirs: TaskDirs {
909 session,
910 task: Arc::new(task),
911 control: Arc::new(control),
912 io: Arc::new(io_dir),
913 },
914 });
915 }
916 if has_flat {
917 let paths = TaskPaths::flat(session_dir.to_path_buf(), task_id);
918 return Ok(ResolvedTask {
919 paths,
920 dirs: TaskDirs {
921 session: Arc::clone(&session),
922 task: Arc::clone(&session),
923 control: Arc::clone(&session),
924 io: session,
925 },
926 });
927 }
928 Err(io::Error::new(
929 io::ErrorKind::NotFound,
930 "background task layout not found",
931 ))
932}
933
934pub fn resolve_task(
935 storage_dir: &Path,
936 session_id: &str,
937 task_id: &str,
938) -> io::Result<ResolvedTask> {
939 resolve_task_layout(&session_tasks_dir(storage_dir, session_id), task_id)
940}
941
942pub fn discover_task_ids(session_dir: &Path) -> io::Result<(Vec<String>, Vec<OsString>)> {
943 let session = PinnedDir::open(session_dir)?;
944 let mut ids = std::collections::BTreeSet::new();
945 let mut invalid = Vec::new();
946 for name in session.list_names()? {
947 let Some(text) = name.to_str() else {
948 invalid.push(name);
949 continue;
950 };
951 if validate_task_id(text).is_ok() {
952 ids.insert(text.to_string());
953 continue;
954 }
955 if let Some((task_id, _suffix)) = text.split_once('.') {
956 if validate_task_id(task_id).is_ok() {
957 ids.insert(task_id.to_string());
958 } else if task_id.starts_with("bash-") {
959 invalid.push(name);
960 }
961 } else if text.starts_with("bash-") {
962 invalid.push(name);
963 }
964 }
965 Ok((ids.into_iter().collect(), invalid))
966}
967
968pub fn uninitialized_layout_is_recent(
969 session_dir: &Path,
970 task_id: &str,
971 grace: std::time::Duration,
972) -> io::Result<bool> {
973 let task = match resolve_uninitialized_task_layout(session_dir, task_id) {
980 Ok(task) => task,
981 Err(_) => {
982 let modified = session_dir.join(task_id).metadata()?.modified()?;
987 let age = SystemTime::now()
988 .duration_since(modified)
989 .unwrap_or_default();
990 return Ok(age < grace);
991 }
992 };
993 let modified = match task.paths.layout {
994 TaskLayout::Directory => task.dirs.control.modified()?,
995 TaskLayout::Flat => task
996 .dirs
997 .session
998 .open_file(&task.paths.artifact_name(TaskArtifact::Exit), false)
999 .and_then(|file| file.metadata()?.modified())
1000 .or_else(|_| {
1001 task.dirs
1002 .session
1003 .open_file(OsStr::new(&format!("{task_id}.json")), false)
1004 .and_then(|file| file.metadata()?.modified())
1005 })?,
1006 };
1007 Ok(SystemTime::now()
1008 .duration_since(modified)
1009 .unwrap_or_default()
1010 < grace)
1011}
1012
1013pub fn quarantine_task_layout(
1014 storage_dir: &Path,
1015 session_dir: &Path,
1016 task_id: &str,
1017 reason: &str,
1018) -> io::Result<()> {
1019 validate_task_id(task_id)?;
1020 let session = PinnedDir::open(session_dir)?;
1021 let names = session.list_names()?;
1022 let flat_prefix = format!("{task_id}.");
1023 let selected = names
1024 .into_iter()
1025 .filter(|name| {
1026 name == OsStr::new(task_id)
1027 || name
1028 .to_str()
1029 .is_some_and(|name| name.starts_with(&flat_prefix))
1030 })
1031 .collect::<Vec<_>>();
1032 quarantine_names(storage_dir, session_dir, &session, selected, reason)
1033}
1034
1035pub fn quarantine_invalid_entry(
1036 storage_dir: &Path,
1037 session_dir: &Path,
1038 entry: &OsStr,
1039) -> io::Result<()> {
1040 let session = PinnedDir::open(session_dir)?;
1041 quarantine_names(
1042 storage_dir,
1043 session_dir,
1044 &session,
1045 vec![entry.to_os_string()],
1046 "invalid",
1047 )
1048}
1049
1050fn quarantine_names(
1051 storage_dir: &Path,
1052 session_dir: &Path,
1053 session: &PinnedDir,
1054 names: Vec<OsString>,
1055 reason: &str,
1056) -> io::Result<()> {
1057 if names.is_empty() {
1058 return Ok(());
1059 }
1060 let session_hash = session_dir.file_name().ok_or_else(|| {
1061 io::Error::new(io::ErrorKind::InvalidInput, "session dir has no identity")
1062 })?;
1063 let quarantine_path = storage_dir.join("bash-tasks-quarantine").join(session_hash);
1064 fs::create_dir_all(&quarantine_path)?;
1065 let quarantine = PinnedDir::open(&quarantine_path)?;
1066 for name in names {
1067 let mut random = [0_u8; 8];
1068 getrandom::fill(&mut random).map_err(io::Error::other)?;
1069 let target = OsString::from(format!(
1070 "{}.{}-{}",
1071 name.to_string_lossy(),
1072 reason,
1073 hex_lower(&random)
1074 ));
1075 session.rename_to(&name, &quarantine, &target)?;
1076 }
1077 Ok(())
1078}
1079
1080fn hex_lower(bytes: &[u8]) -> String {
1081 bytes.iter().map(|byte| format!("{byte:02x}")).collect()
1082}
1083
1084pub fn read_task(path: &Path) -> io::Result<PersistedTask> {
1085 let mut file = open_validated_path(path, false)?;
1086 read_task_file(&mut file)
1087}
1088
1089pub fn read_task_at(task: &ResolvedTask) -> io::Result<PersistedTask> {
1090 let name = match task.paths.layout {
1091 TaskLayout::Directory => OsString::from(METADATA_FILE),
1092 TaskLayout::Flat => OsString::from(format!("{}.json", task.paths.task_id)),
1093 };
1094 let mut file = task.dirs.control.open_file(&name, false)?;
1095 let metadata = read_task_file(&mut file)?;
1096 if metadata.task_id != task.paths.task_id {
1097 return Err(io::Error::new(
1098 io::ErrorKind::InvalidData,
1099 "background task metadata identity does not match its layout name",
1100 ));
1101 }
1102 Ok(metadata)
1103}
1104
1105fn read_task_file(file: &mut File) -> io::Result<PersistedTask> {
1106 file.seek(SeekFrom::Start(0))?;
1107 let mut content = String::new();
1108 file.read_to_string(&mut content)?;
1109 let task: PersistedTask = serde_json::from_str(&content).map_err(io::Error::other)?;
1110 if !matches!(task.schema_version, 2 | 3 | 4 | 5 | SCHEMA_VERSION) {
1111 return Err(io::Error::new(
1112 io::ErrorKind::InvalidData,
1113 format!(
1114 "unsupported background task schema_version {} (expected 2, 3, 4, 5, or {SCHEMA_VERSION})",
1115 task.schema_version
1116 ),
1117 ));
1118 }
1119 validate_task_id(&task.task_id)?;
1120 Ok(task)
1121}
1122
1123pub fn write_task(path: &Path, task: &PersistedTask) -> io::Result<()> {
1124 validate_task_id(&task.task_id)?;
1125 if let Some(parent) = path.parent() {
1126 fs::create_dir_all(parent)?;
1127 }
1128 let parent = path.parent().unwrap_or_else(|| Path::new("."));
1129 let dir = PinnedDir::open(parent)?;
1130 let name = path
1131 .file_name()
1132 .ok_or_else(|| io::Error::new(io::ErrorKind::InvalidInput, "metadata path has no name"))?;
1133 write_task_in_dir(&dir, name, task)
1134}
1135
1136pub fn write_task_at(task: &ResolvedTask, metadata: &PersistedTask) -> io::Result<()> {
1137 if metadata.task_id != task.paths.task_id {
1138 return Err(io::Error::new(
1139 io::ErrorKind::InvalidInput,
1140 "refusing to write metadata under a different task identity",
1141 ));
1142 }
1143 let name = match task.paths.layout {
1144 TaskLayout::Directory => OsString::from(METADATA_FILE),
1145 TaskLayout::Flat => OsString::from(format!("{}.json", task.paths.task_id)),
1146 };
1147 write_task_in_dir(&task.dirs.control, &name, metadata)
1148}
1149
1150fn write_task_in_dir(dir: &PinnedDir, name: &OsStr, task: &PersistedTask) -> io::Result<()> {
1151 let mut upgraded = task.clone();
1152 upgraded.schema_version = SCHEMA_VERSION;
1153 let content = serde_json::to_vec_pretty(&upgraded).map_err(io::Error::other)?;
1154 randomized_atomic_replace(dir, name, &content)
1155}
1156
1157pub fn update_task_at<F>(task: &ResolvedTask, update: F) -> io::Result<PersistedTask>
1158where
1159 F: FnOnce(&mut PersistedTask),
1160{
1161 let mut metadata = read_task_at(task)?;
1162 let original_terminal = metadata.is_terminal();
1163 let original = metadata.clone();
1164 update(&mut metadata);
1165 metadata.schema_version = SCHEMA_VERSION;
1166 if original_terminal {
1167 let completion_delivered = metadata.completion_delivered;
1168 metadata = original;
1169 metadata.completion_delivered = completion_delivered;
1170 metadata.schema_version = SCHEMA_VERSION;
1171 }
1172 write_task_at(task, &metadata)?;
1173 Ok(metadata)
1174}
1175
1176pub fn delete_task_bundle(paths: &TaskPaths) -> io::Result<()> {
1177 validate_task_id(&paths.task_id)?;
1178 let resolved = resolve_task_layout(&paths.session_dir, &paths.task_id)?;
1179 if resolved.paths.layout != paths.layout {
1180 return Err(io::Error::new(
1181 io::ErrorKind::InvalidData,
1182 "background task layout changed before deletion",
1183 ));
1184 }
1185 delete_resolved_task(&resolved)
1186}
1187
1188pub fn delete_resolved_task(task: &ResolvedTask) -> io::Result<()> {
1189 validate_task_id(&task.paths.task_id)?;
1190 match task.paths.layout {
1191 TaskLayout::Flat => {
1192 for path in task_bundle_files(&task.paths) {
1193 let Some(name) = path.file_name() else {
1194 continue;
1195 };
1196 match task.dirs.session.remove_file(name) {
1197 Ok(()) => {}
1198 Err(error) if error.kind() == io::ErrorKind::NotFound => {}
1199 Err(error) => return Err(error),
1200 }
1201 }
1202 Ok(())
1203 }
1204 TaskLayout::Directory => remove_directory_task(task),
1205 }
1206}
1207
1208fn remove_directory_task(task: &ResolvedTask) -> io::Result<()> {
1209 let current = task
1210 .dirs
1211 .session
1212 .open_dir_at(OsStr::new(&task.paths.task_id))?;
1213 if !current.same_identity(&task.dirs.task)? {
1214 return Err(io::Error::new(
1215 io::ErrorKind::PermissionDenied,
1216 "task directory identity changed before deletion",
1217 ));
1218 }
1219 #[cfg(unix)]
1220 let tombstone = rename_task_to_tombstone(task)?;
1221 for name in task.dirs.control.list_names()? {
1222 task.dirs.control.remove_file(&name)?;
1223 }
1224 remove_tree_contents(&task.dirs.io)?;
1225 #[cfg(unix)]
1226 {
1227 remove_dir_entry(&task.dirs.task, IO_DIR)?;
1228 remove_dir_entry(&task.dirs.task, CONTROL_DIR)?;
1229 let name = os_cstring(&tombstone)?;
1230 let result = unsafe {
1231 libc::unlinkat(
1232 task.dirs.session.file.as_raw_fd(),
1233 name.as_ptr(),
1234 libc::AT_REMOVEDIR,
1235 )
1236 };
1237 if result != 0 {
1238 return Err(io::Error::last_os_error());
1239 }
1240 Ok(())
1241 }
1242 #[cfg(windows)]
1243 {
1244 task.dirs.io.ensure_current_identity()?;
1245 task.dirs.control.ensure_current_identity()?;
1246 task.dirs.session.ensure_current_identity()?;
1247 fs::remove_dir(task.dirs.io.path())?;
1248 fs::remove_dir(task.dirs.control.path())?;
1249 fs::remove_dir(&task.paths.dir)?;
1250 task.dirs.session.ensure_current_identity()
1251 }
1252}
1253
1254fn remove_tree_contents(dir: &PinnedDir) -> io::Result<()> {
1255 for name in dir.list_names()? {
1256 match dir.open_dir_at(&name) {
1257 Ok(child) => {
1258 remove_tree_contents(&child)?;
1259 #[cfg(unix)]
1260 {
1261 let name = os_cstring(&name)?;
1262 let result = unsafe {
1263 libc::unlinkat(dir.file.as_raw_fd(), name.as_ptr(), libc::AT_REMOVEDIR)
1264 };
1265 if result != 0 {
1266 return Err(io::Error::last_os_error());
1267 }
1268 }
1269 #[cfg(windows)]
1270 fs::remove_dir(child.path())?;
1271 }
1272 Err(error) if error.kind() == io::ErrorKind::NotADirectory => {
1273 dir.remove_file(&name)?;
1274 }
1275 Err(error) => return Err(error),
1276 }
1277 }
1278 Ok(())
1279}
1280
1281#[cfg(unix)]
1282fn rename_task_to_tombstone(task: &ResolvedTask) -> io::Result<OsString> {
1283 for _ in 0..32 {
1284 let tombstone = random_temp_name()?;
1285 match task.dirs.session.open_dir_at(&tombstone) {
1286 Ok(_) => continue,
1287 Err(error) if error.kind() == io::ErrorKind::NotFound => {}
1288 Err(error) => return Err(error),
1289 }
1290 task.dirs
1291 .session
1292 .rename(OsStr::new(&task.paths.task_id), &tombstone)?;
1293 let moved = task.dirs.session.open_dir_at(&tombstone)?;
1294 if !moved.same_identity(&task.dirs.task)? {
1295 return Err(io::Error::new(
1296 io::ErrorKind::PermissionDenied,
1297 "task directory identity changed during deletion",
1298 ));
1299 }
1300 return Ok(tombstone);
1301 }
1302 Err(io::Error::new(
1303 io::ErrorKind::AlreadyExists,
1304 "failed to allocate randomized task deletion name",
1305 ))
1306}
1307
1308#[cfg(unix)]
1309fn remove_dir_entry(task: &PinnedDir, child: &str) -> io::Result<()> {
1310 let child = os_cstring(OsStr::new(child))?;
1311 let result =
1312 unsafe { libc::unlinkat(task.file.as_raw_fd(), child.as_ptr(), libc::AT_REMOVEDIR) };
1313 if result != 0 {
1314 return Err(io::Error::last_os_error());
1315 }
1316 Ok(())
1317}
1318
1319pub fn task_bundle_files(paths: &TaskPaths) -> Vec<PathBuf> {
1320 if paths.layout == TaskLayout::Directory {
1321 return vec![paths.dir.clone()];
1322 }
1323 vec![
1324 paths.json.clone(),
1325 paths.stdout.clone(),
1326 paths.stderr.clone(),
1327 paths.exit.clone(),
1328 paths.pipeline_status.clone(),
1329 paths.pty.clone(),
1330 paths.sandbox_unavailable.clone(),
1331 paths.command.clone(),
1332 paths.wrapper.clone(),
1333 paths.environment.clone(),
1334 paths.manifest.clone(),
1335 paths.sandbox_profile.clone(),
1336 paths.dir.join(format!("{}.ps1", paths.task_id)),
1337 paths.dir.join(format!("{}.bat", paths.task_id)),
1338 ]
1339}
1340
1341pub fn write_kill_marker_if_absent(paths: &TaskPaths) -> io::Result<()> {
1342 let mut attempts = 0;
1347 loop {
1348 attempts += 1;
1349 let result = match open_task_artifact(paths, TaskArtifact::Exit) {
1350 Ok(file) if file.len()? > 0 => Ok(()),
1351 Ok(mut file) => file.replace_contents(b"killed"),
1352 Err(error) if error.kind() == io::ErrorKind::NotFound => {
1353 let resolved = resolve_task_layout(&paths.session_dir, &paths.task_id)?;
1354 randomized_atomic_replace(
1355 &resolved.dirs.io,
1356 &resolved.paths.artifact_name(TaskArtifact::Exit),
1357 b"killed",
1358 )
1359 }
1360 Err(error) => Err(error),
1361 };
1362 match result {
1363 Err(error)
1364 if attempts < 3
1365 && error.kind() == io::ErrorKind::Interrupted
1366 && error.to_string().contains(ARTIFACT_CONCURRENTLY_REPLACED) => {}
1367 other => return other,
1368 }
1369 }
1370}
1371
1372pub fn read_exit_marker(paths: &TaskPaths) -> io::Result<Option<ExitMarker>> {
1373 let mut file = match open_task_artifact(paths, TaskArtifact::Exit) {
1374 Ok(file) => file,
1375 Err(error) if error.kind() == io::ErrorKind::NotFound => return Ok(None),
1376 Err(error) => return Err(error),
1377 };
1378 let mut content = String::new();
1379 file.read_to_string(&mut content)?;
1380 let content = content.trim();
1381 if content.is_empty() {
1382 return Ok(None);
1383 }
1384 if content == "killed" {
1385 return Ok(Some(ExitMarker::Killed));
1386 }
1387 Ok(content.parse::<i32>().ok().map(ExitMarker::Code))
1388}
1389
1390pub fn randomized_atomic_replace(dir: &PinnedDir, name: &OsStr, content: &[u8]) -> io::Result<()> {
1391 for _ in 0..32 {
1392 let temporary = random_temp_name()?;
1393 let mut file = match dir.open_new_file(&temporary) {
1394 Ok(file) => file,
1395 Err(error) if error.kind() == io::ErrorKind::AlreadyExists => continue,
1396 Err(error) => return Err(error),
1397 };
1398 let result = (|| {
1399 file.write_all(content)?;
1400 file.sync_all()?;
1401 validate_regular_handle(&file)?;
1402 dir.rename(&temporary, name)
1403 })();
1404 if result.is_err() {
1405 let _ = dir.remove_file(&temporary);
1406 }
1407 return result;
1408 }
1409 Err(io::Error::new(
1410 io::ErrorKind::AlreadyExists,
1411 "failed to allocate a randomized atomic-write name",
1412 ))
1413}
1414
1415pub fn create_control_file(dirs: &TaskDirs, name: &str, content: &[u8]) -> io::Result<File> {
1416 let mut file = dirs.control.open_new_file(OsStr::new(name))?;
1417 file.write_all(content)?;
1418 file.sync_all()?;
1419 file.seek(SeekFrom::Start(0))?;
1420 validate_regular_handle(&file)?;
1421 Ok(file)
1422}
1423
1424pub fn open_control_file(task: &ResolvedTask, name: &str) -> io::Result<File> {
1425 if name.is_empty() || name.contains('/') || name.contains('\\') || name == "." || name == ".." {
1426 return Err(io::Error::new(
1427 io::ErrorKind::InvalidInput,
1428 "invalid control file name",
1429 ));
1430 }
1431 task.dirs.control.open_file(OsStr::new(name), false)
1432}
1433
1434#[derive(Debug)]
1435pub struct ValidatedArtifact {
1436 file: File,
1437}
1438
1439impl ValidatedArtifact {
1440 fn new(file: File) -> io::Result<Self> {
1441 validate_regular_handle(&file)?;
1442 Ok(Self { file })
1443 }
1444
1445 pub fn len(&self) -> io::Result<u64> {
1446 validate_regular_handle(&self.file)?;
1447 Ok(self.file.metadata()?.len())
1448 }
1449
1450 pub fn rewind(&mut self) -> io::Result<()> {
1451 self.file.seek(SeekFrom::Start(0)).map(|_| ())
1452 }
1453
1454 pub fn tail(&mut self, max_bytes: usize) -> io::Result<(Vec<u8>, bool)> {
1455 let len = self.len()?;
1456 let read_len = len.min(max_bytes as u64);
1457 self.file
1458 .seek(SeekFrom::Start(len.saturating_sub(read_len)))?;
1459 let mut bytes = Vec::with_capacity(read_len as usize);
1460 Read::by_ref(&mut self.file)
1461 .take(read_len)
1462 .read_to_end(&mut bytes)?;
1463 Ok((bytes, len > max_bytes as u64))
1464 }
1465
1466 pub fn read_range(&mut self, start: u64, len: u64) -> io::Result<Vec<u8>> {
1467 self.file.seek(SeekFrom::Start(start))?;
1468 let mut bytes = Vec::with_capacity(len.min(usize::MAX as u64) as usize);
1469 Read::by_ref(&mut self.file)
1470 .take(len)
1471 .read_to_end(&mut bytes)?;
1472 Ok(bytes)
1473 }
1474
1475 pub fn read_all(&mut self) -> io::Result<Vec<u8>> {
1476 self.rewind()?;
1477 let mut bytes = Vec::new();
1478 self.file.read_to_end(&mut bytes)?;
1479 Ok(bytes)
1480 }
1481
1482 pub fn replace_contents(&mut self, content: &[u8]) -> io::Result<()> {
1483 validate_regular_handle(&self.file)?;
1484 self.file.set_len(0)?;
1485 self.file.seek(SeekFrom::Start(0))?;
1486 self.file.write_all(content)?;
1487 self.file.sync_all()
1488 }
1489
1490 pub fn try_clone_file(&self) -> io::Result<File> {
1491 validate_regular_handle(&self.file)?;
1492 self.file.try_clone()
1493 }
1494}
1495
1496impl Read for ValidatedArtifact {
1497 fn read(&mut self, buffer: &mut [u8]) -> io::Result<usize> {
1498 self.file.read(buffer)
1499 }
1500}
1501
1502impl Seek for ValidatedArtifact {
1503 fn seek(&mut self, position: SeekFrom) -> io::Result<u64> {
1504 self.file.seek(position)
1505 }
1506}
1507
1508pub fn open_task_artifact(
1509 paths: &TaskPaths,
1510 artifact: TaskArtifact,
1511) -> io::Result<ValidatedArtifact> {
1512 validate_task_id(&paths.task_id)?;
1513 let resolved = resolve_task_layout(&paths.session_dir, &paths.task_id)?;
1514 if resolved.paths.layout != paths.layout {
1515 return Err(io::Error::new(
1516 io::ErrorKind::InvalidData,
1517 "background task layout identity changed",
1518 ));
1519 }
1520 let metadata = read_task_at(&resolved)?;
1521 if metadata.task_id != paths.task_id {
1522 return Err(io::Error::new(
1523 io::ErrorKind::InvalidData,
1524 "background task metadata identity mismatch",
1525 ));
1526 }
1527 let file = resolved
1528 .dirs
1529 .io
1530 .open_file(&resolved.paths.artifact_name(artifact), false)?;
1531 ValidatedArtifact::new(file)
1532}
1533
1534pub fn replace_artifact_with_tail(
1535 paths: &TaskPaths,
1536 artifact: TaskArtifact,
1537 retain_bytes: u64,
1538) -> io::Result<u64> {
1539 let mut source = open_task_artifact(paths, artifact)?;
1540 let len = source.len()?;
1541 if len <= retain_bytes {
1542 return Ok(0);
1543 }
1544 let mut tail = source.read_range(len.saturating_sub(retain_bytes), retain_bytes)?;
1545 align_tail_start(&mut tail);
1546 let resolved = resolve_task_layout(&paths.session_dir, &paths.task_id)?;
1547 randomized_atomic_replace(
1548 &resolved.dirs.io,
1549 &resolved.paths.artifact_name(artifact),
1550 &tail,
1551 )?;
1552 Ok(len.saturating_sub(tail.len() as u64))
1553}
1554
1555#[derive(Debug)]
1556pub struct TaskIoHandles {
1557 pub dirs: TaskDirs,
1558 stdout: Option<File>,
1559 stderr: Option<File>,
1560 exit: File,
1561 pty: Option<File>,
1562 pipeline_status: Option<File>,
1563 sandbox_unavailable: File,
1564}
1565
1566impl TaskIoHandles {
1567 pub fn create(
1568 task: &ResolvedTask,
1569 mode: BgMode,
1570 capture_pipeline_status: bool,
1571 ) -> io::Result<Self> {
1572 if task.paths.layout != TaskLayout::Directory {
1573 return Err(io::Error::new(
1574 io::ErrorKind::InvalidInput,
1575 "new task output handles require the directory layout",
1576 ));
1577 }
1578 let (stdout, stderr, pty) = match mode {
1579 BgMode::Pipes => (
1580 Some(
1581 task.dirs
1582 .io
1583 .open_new_file(OsStr::new(TaskArtifact::Stdout.file_name()))?,
1584 ),
1585 Some(
1586 task.dirs
1587 .io
1588 .open_new_file(OsStr::new(TaskArtifact::Stderr.file_name()))?,
1589 ),
1590 None,
1591 ),
1592 BgMode::Pty => (
1593 None,
1594 None,
1595 Some(
1596 task.dirs
1597 .io
1598 .open_new_file(OsStr::new(TaskArtifact::Pty.file_name()))?,
1599 ),
1600 ),
1601 };
1602 Ok(Self {
1603 dirs: task.dirs.clone(),
1604 stdout,
1605 stderr,
1606 exit: task
1607 .dirs
1608 .io
1609 .open_new_file(OsStr::new(TaskArtifact::Exit.file_name()))?,
1610 pipeline_status: capture_pipeline_status
1611 .then(|| {
1612 task.dirs
1613 .io
1614 .open_new_file(OsStr::new(TaskArtifact::PipelineStatus.file_name()))
1615 })
1616 .transpose()?,
1617 pty,
1618 sandbox_unavailable: task
1619 .dirs
1620 .io
1621 .open_new_file(OsStr::new(TaskArtifact::SandboxUnavailable.file_name()))?,
1622 })
1623 }
1624
1625 pub fn clone_file(&self, artifact: TaskArtifact) -> io::Result<File> {
1626 let file = match artifact {
1627 TaskArtifact::Stdout => self.stdout.as_ref(),
1628 TaskArtifact::Stderr => self.stderr.as_ref(),
1629 TaskArtifact::Exit => Some(&self.exit),
1630 TaskArtifact::PipelineStatus => self.pipeline_status.as_ref(),
1631 TaskArtifact::Pty => self.pty.as_ref(),
1632 TaskArtifact::SandboxUnavailable => Some(&self.sandbox_unavailable),
1633 }
1634 .ok_or_else(|| {
1635 io::Error::new(io::ErrorKind::NotFound, "task artifact is not pre-opened")
1636 })?;
1637 validate_regular_handle(file)?;
1638 file.try_clone()
1639 }
1640
1641 #[cfg(unix)]
1642 pub fn inheritable_file(&self, artifact: TaskArtifact) -> io::Result<File> {
1643 let file = self.clone_file(artifact)?;
1644 set_close_on_exec(file.as_raw_fd(), false)?;
1645 Ok(file)
1646 }
1647
1648 pub fn write(&mut self, artifact: TaskArtifact, content: &[u8]) -> io::Result<()> {
1649 let file = match artifact {
1650 TaskArtifact::Stdout => self.stdout.as_mut(),
1651 TaskArtifact::Stderr => self.stderr.as_mut(),
1652 TaskArtifact::Exit => Some(&mut self.exit),
1653 TaskArtifact::PipelineStatus => self.pipeline_status.as_mut(),
1654 TaskArtifact::Pty => self.pty.as_mut(),
1655 TaskArtifact::SandboxUnavailable => Some(&mut self.sandbox_unavailable),
1656 }
1657 .ok_or_else(|| {
1658 io::Error::new(io::ErrorKind::NotFound, "task artifact is not pre-opened")
1659 })?;
1660 validate_regular_handle(file)?;
1661 file.set_len(0)?;
1662 file.seek(SeekFrom::Start(0))?;
1663 file.write_all(content)?;
1664 file.sync_all()
1665 }
1666
1667 pub fn artifact_len(&self, artifact: TaskArtifact) -> io::Result<u64> {
1668 let file = match artifact {
1669 TaskArtifact::Stdout => self.stdout.as_ref(),
1670 TaskArtifact::Stderr => self.stderr.as_ref(),
1671 TaskArtifact::Exit => Some(&self.exit),
1672 TaskArtifact::PipelineStatus => self.pipeline_status.as_ref(),
1673 TaskArtifact::Pty => self.pty.as_ref(),
1674 TaskArtifact::SandboxUnavailable => Some(&self.sandbox_unavailable),
1675 }
1676 .ok_or_else(|| {
1677 io::Error::new(io::ErrorKind::NotFound, "task artifact is not pre-opened")
1678 })?;
1679 validate_regular_handle(file)?;
1680 Ok(file.metadata()?.len())
1681 }
1682}
1683
1684pub fn repin_task_io(paths: &TaskPaths) -> io::Result<TaskDirs> {
1685 let resolved = resolve_task_layout(&paths.session_dir, &paths.task_id)?;
1686 let metadata = read_task_at(&resolved)?;
1687 if metadata.task_id != paths.task_id {
1688 return Err(io::Error::new(
1689 io::ErrorKind::InvalidData,
1690 "background task metadata identity mismatch",
1691 ));
1692 }
1693 Ok(resolved.dirs)
1694}
1695
1696pub fn unix_millis() -> u64 {
1697 SystemTime::now()
1698 .duration_since(UNIX_EPOCH)
1699 .map(|duration| duration.as_millis() as u64)
1700 .unwrap_or(0)
1701}
1702
1703fn random_task_id() -> io::Result<String> {
1704 let mut bytes = [0_u8; 8];
1705 getrandom::fill(&mut bytes).map_err(io::Error::other)?;
1706 Ok(format!(
1707 "bash-{}",
1708 bytes
1709 .iter()
1710 .map(|byte| format!("{byte:02x}"))
1711 .collect::<String>()
1712 ))
1713}
1714
1715fn random_temp_name() -> io::Result<OsString> {
1716 let mut bytes = [0_u8; 16];
1717 getrandom::fill(&mut bytes).map_err(io::Error::other)?;
1718 Ok(OsString::from(format!(
1719 ".aft-tmp-{}",
1720 bytes
1721 .iter()
1722 .map(|byte| format!("{byte:02x}"))
1723 .collect::<String>()
1724 )))
1725}
1726
1727#[cfg(test)]
1728pub(crate) fn open_unregistered_artifact(path: &Path) -> io::Result<ValidatedArtifact> {
1729 ValidatedArtifact::new(open_validated_path(path, false)?)
1730}
1731
1732#[cfg(test)]
1733pub(crate) fn replace_unregistered_with_tail(path: &Path, retain_bytes: u64) -> io::Result<u64> {
1734 let mut source = open_unregistered_artifact(path)?;
1735 let len = source.len()?;
1736 if len <= retain_bytes {
1737 return Ok(0);
1738 }
1739 let mut tail = source.read_range(len.saturating_sub(retain_bytes), retain_bytes)?;
1740 align_tail_start(&mut tail);
1741 let parent = PinnedDir::open(path.parent().unwrap_or_else(|| Path::new(".")))?;
1742 let name = path
1743 .file_name()
1744 .ok_or_else(|| io::Error::new(io::ErrorKind::InvalidInput, "path has no file name"))?;
1745 randomized_atomic_replace(&parent, name, &tail)?;
1746 Ok(len.saturating_sub(tail.len() as u64))
1747}
1748
1749fn align_tail_start(bytes: &mut Vec<u8>) {
1750 let prefix = bytes
1751 .iter()
1752 .take_while(|byte| **byte & 0xc0 == 0x80)
1753 .count();
1754 if prefix > 0 {
1755 bytes.drain(..prefix);
1756 }
1757}
1758
1759#[cfg(unix)]
1760fn clear_nonblocking(file: &File) -> io::Result<()> {
1761 let flags = unsafe { libc::fcntl(file.as_raw_fd(), libc::F_GETFL) };
1762 if flags == -1 {
1763 return Err(io::Error::last_os_error());
1764 }
1765 if flags & libc::O_NONBLOCK != 0 {
1766 let result =
1767 unsafe { libc::fcntl(file.as_raw_fd(), libc::F_SETFL, flags & !libc::O_NONBLOCK) };
1768 if result == -1 {
1769 return Err(io::Error::last_os_error());
1770 }
1771 }
1772 Ok(())
1773}
1774
1775fn open_validated_path(path: &Path, write: bool) -> io::Result<File> {
1776 let parent = path.parent().unwrap_or_else(|| Path::new("."));
1777 let name = path
1778 .file_name()
1779 .ok_or_else(|| io::Error::new(io::ErrorKind::InvalidInput, "path has no file name"))?;
1780 PinnedDir::open(parent)?.open_file(name, write)
1781}
1782
1783#[cfg(unix)]
1784fn openat_file(dirfd: RawFd, name: &OsStr, flags: i32, mode: libc::mode_t) -> io::Result<File> {
1785 let name = os_cstring(name)?;
1786 let fd = unsafe { libc::openat(dirfd, name.as_ptr(), flags, libc::c_uint::from(mode)) };
1787 if fd < 0 {
1788 return Err(io::Error::last_os_error());
1789 }
1790 Ok(unsafe { File::from_raw_fd(fd) })
1791}
1792
1793#[cfg(unix)]
1794fn os_cstring(value: &OsStr) -> io::Result<CString> {
1795 CString::new(value.as_bytes())
1796 .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "path contains a NUL byte"))
1797}
1798
1799fn validate_directory_handle(file: &File) -> io::Result<()> {
1800 let metadata = file.metadata()?;
1801 if !metadata.is_dir() {
1802 return Err(io::Error::new(
1803 io::ErrorKind::InvalidData,
1804 "expected a non-reparse directory handle",
1805 ));
1806 }
1807 #[cfg(windows)]
1808 validate_windows_handle(file, true)?;
1809 Ok(())
1810}
1811
1812fn validate_regular_handle(file: &File) -> io::Result<()> {
1813 let metadata = file.metadata()?;
1814 if !metadata.is_file() {
1815 return Err(io::Error::new(
1816 io::ErrorKind::InvalidData,
1817 "task artifact is not a regular file",
1818 ));
1819 }
1820 #[cfg(unix)]
1827 match metadata.nlink() {
1828 1 => {}
1829 0 => {
1830 return Err(io::Error::new(
1831 io::ErrorKind::Interrupted,
1832 ARTIFACT_CONCURRENTLY_REPLACED,
1833 ));
1834 }
1835 _ => {
1836 return Err(io::Error::new(
1837 io::ErrorKind::InvalidData,
1838 "task artifact has multiple hard links",
1839 ));
1840 }
1841 }
1842 #[cfg(windows)]
1843 validate_windows_handle(file, false)?;
1844 Ok(())
1845}
1846
1847pub(crate) const ARTIFACT_CONCURRENTLY_REPLACED: &str = "task artifact was concurrently replaced";
1850
1851#[cfg(unix)]
1852pub fn set_close_on_exec(fd: RawFd, enabled: bool) -> io::Result<()> {
1853 let flags = unsafe { libc::fcntl(fd, libc::F_GETFD) };
1854 if flags < 0 {
1855 return Err(io::Error::last_os_error());
1856 }
1857 let flags = if enabled {
1858 flags | libc::FD_CLOEXEC
1859 } else {
1860 flags & !libc::FD_CLOEXEC
1861 };
1862 if unsafe { libc::fcntl(fd, libc::F_SETFD, flags) } < 0 {
1863 return Err(io::Error::last_os_error());
1864 }
1865 Ok(())
1866}
1867
1868#[cfg(windows)]
1869const FILE_FLAG_OPEN_REPARSE_POINT: u32 = 0x0020_0000;
1870#[cfg(windows)]
1871const FILE_FLAG_BACKUP_SEMANTICS: u32 = 0x0200_0000;
1872#[cfg(windows)]
1873const FILE_ATTRIBUTE_REPARSE_POINT: u32 = 0x0000_0400;
1874#[cfg(windows)]
1875const FILE_TYPE_DISK: u32 = 0x0001;
1876#[cfg(windows)]
1877const HANDLE_FLAG_INHERIT: u32 = 0x0000_0001;
1878
1879#[cfg(windows)]
1880fn windows_file_information(file: &File) -> io::Result<ByHandleFileInformation> {
1881 let mut information = std::mem::MaybeUninit::<ByHandleFileInformation>::zeroed();
1882 if unsafe { GetFileInformationByHandle(file.as_raw_handle(), information.as_mut_ptr()) } == 0 {
1883 return Err(io::Error::last_os_error());
1884 }
1885 Ok(unsafe { information.assume_init() })
1886}
1887
1888#[cfg(windows)]
1889fn validate_windows_handle(file: &File, directory: bool) -> io::Result<()> {
1890 if file.metadata()?.file_attributes() & FILE_ATTRIBUTE_REPARSE_POINT != 0 {
1891 return Err(io::Error::new(
1892 io::ErrorKind::InvalidData,
1893 "task path is a reparse point",
1894 ));
1895 }
1896 let handle = file.as_raw_handle();
1897 let file_type = unsafe { GetFileType(handle) };
1898 if file_type != FILE_TYPE_DISK {
1899 return Err(io::Error::new(
1900 io::ErrorKind::InvalidData,
1901 "task artifact is not a regular disk file",
1902 ));
1903 }
1904 let information = windows_file_information(file)?;
1905 if !directory && information.number_of_links == 0 {
1906 return Err(io::Error::new(
1910 io::ErrorKind::Interrupted,
1911 ARTIFACT_CONCURRENTLY_REPLACED,
1912 ));
1913 }
1914 if !directory && information.number_of_links > 1 {
1915 return Err(io::Error::new(
1916 io::ErrorKind::InvalidData,
1917 "task artifact has multiple hard links",
1918 ));
1919 }
1920 if unsafe { SetHandleInformation(handle, HANDLE_FLAG_INHERIT, 0) } == 0 {
1921 return Err(io::Error::last_os_error());
1922 }
1923 let mut flags = 0_u32;
1924 if unsafe { GetHandleInformation(handle, &mut flags) } == 0 {
1925 return Err(io::Error::last_os_error());
1926 }
1927 if flags & HANDLE_FLAG_INHERIT != 0 {
1928 return Err(io::Error::new(
1929 io::ErrorKind::PermissionDenied,
1930 "validated task handles must not be inherited",
1931 ));
1932 }
1933 Ok(())
1934}
1935
1936#[cfg(windows)]
1937#[repr(C)]
1938struct ByHandleFileInformation {
1939 file_attributes: u32,
1940 creation_time: [u32; 2],
1941 last_access_time: [u32; 2],
1942 last_write_time: [u32; 2],
1943 volume_serial_number: u32,
1944 file_size_high: u32,
1945 file_size_low: u32,
1946 number_of_links: u32,
1947 file_index_high: u32,
1948 file_index_low: u32,
1949}
1950
1951#[cfg(windows)]
1952#[link(name = "kernel32")]
1953extern "system" {
1954 fn GetFileType(file: std::os::windows::io::RawHandle) -> u32;
1955 fn GetFileInformationByHandle(
1956 file: std::os::windows::io::RawHandle,
1957 information: *mut ByHandleFileInformation,
1958 ) -> i32;
1959 fn SetHandleInformation(object: std::os::windows::io::RawHandle, mask: u32, flags: u32) -> i32;
1960 fn GetHandleInformation(object: std::os::windows::io::RawHandle, flags: *mut u32) -> i32;
1961}
1962
1963#[cfg(test)]
1964mod tests {
1965 use super::*;
1966
1967 fn valid_id(suffix: u64) -> String {
1968 format!("bash-{suffix:016x}")
1969 }
1970
1971 #[test]
1972 fn task_id_validation_is_exact() {
1973 assert!(validate_task_id("bash-0123456789abcdef").is_ok());
1974 for invalid in [
1975 "bash-0123456789abcde",
1976 "bash-0123456789abcdef0",
1977 "bash-0123456789ABCDEf",
1978 "bash-0123456789abcdeg",
1979 "../bash-0123456789abcdef",
1980 ] {
1981 assert!(validate_task_id(invalid).is_err(), "accepted {invalid}");
1982 }
1983 }
1984
1985 #[test]
1986 fn new_layout_separates_control_and_io() {
1987 let storage = tempfile::tempdir().unwrap();
1988 let task = create_task_layout(storage.path(), "session", &valid_id(1)).unwrap();
1989 assert_eq!(
1990 task.paths.json.parent(),
1991 Some(task.paths.control_dir.as_path())
1992 );
1993 assert_eq!(
1994 task.paths.stdout.parent(),
1995 Some(task.paths.io_dir.as_path())
1996 );
1997 assert_ne!(task.paths.control_dir, task.paths.io_dir);
1998 }
1999
2000 #[cfg(unix)]
2001 #[test]
2002 fn task_layout_directories_are_private() {
2003 use std::os::unix::fs::PermissionsExt;
2004
2005 let storage = tempfile::tempdir().unwrap();
2006 let task = create_task_layout(storage.path(), "session", &valid_id(5)).unwrap();
2007 for path in [
2008 &task.paths.session_dir,
2009 &task.paths.dir,
2010 &task.paths.control_dir,
2011 &task.paths.io_dir,
2012 ] {
2013 let mode = fs::metadata(path).unwrap().permissions().mode() & 0o777;
2014 assert_eq!(mode, 0o700, "unexpected permissions for {}", path.display());
2015 }
2016 let bash_tasks = task.paths.session_dir.parent().unwrap();
2017 let mode = fs::metadata(bash_tasks).unwrap().permissions().mode() & 0o777;
2018 assert_eq!(
2019 mode,
2020 0o700,
2021 "unexpected permissions for {}",
2022 bash_tasks.display()
2023 );
2024 }
2025
2026 #[test]
2027 fn resolver_refuses_duplicate_layouts() {
2028 let storage = tempfile::tempdir().unwrap();
2029 let task = create_task_layout(storage.path(), "session", &valid_id(2)).unwrap();
2030 let flat = task
2031 .paths
2032 .session_dir
2033 .join(format!("{}.json", task.paths.task_id));
2034 fs::write(flat, b"{}").unwrap();
2035 let error = resolve_task_layout(&task.paths.session_dir, &task.paths.task_id).unwrap_err();
2036 assert_eq!(error.kind(), io::ErrorKind::InvalidData);
2037 }
2038
2039 #[test]
2040 fn resolver_rejects_metadata_identity_mismatch() {
2041 let storage = tempfile::tempdir().unwrap();
2042 let task = create_task_layout(storage.path(), "session", &valid_id(30)).unwrap();
2043 let metadata = PersistedTask::starting(
2044 valid_id(31),
2045 "session".into(),
2046 "true".into(),
2047 storage.path().into(),
2048 None,
2049 None,
2050 true,
2051 false,
2052 );
2053 fs::write(&task.paths.json, serde_json::to_vec(&metadata).unwrap()).unwrap();
2054 let error = resolve_task_layout(&task.paths.session_dir, &task.paths.task_id).unwrap_err();
2055 assert_eq!(error.kind(), io::ErrorKind::InvalidData);
2056 }
2057
2058 #[cfg(unix)]
2067 #[test]
2068 fn deletion_refuses_replaced_task_directory_without_touching_victim() {
2069 let storage = tempfile::tempdir().unwrap();
2070 let first = create_task_layout(storage.path(), "session", &valid_id(40)).unwrap();
2071 let second = create_task_layout(storage.path(), "session", &valid_id(41)).unwrap();
2072 let victim = second.paths.control_dir.join("victim");
2073 fs::write(&victim, b"victim-bytes").unwrap();
2074 let moved_first = first.paths.session_dir.join("moved-first");
2075 fs::rename(&first.paths.dir, &moved_first).unwrap();
2076 fs::rename(&second.paths.dir, &first.paths.dir).unwrap();
2077
2078 assert!(delete_resolved_task(&first).is_err());
2079 assert_eq!(
2080 fs::read(first.paths.control_dir.join("victim")).unwrap(),
2081 b"victim-bytes"
2082 );
2083 }
2084
2085 #[cfg(windows)]
2090 #[test]
2091 fn deletion_refuses_replaced_task_directory_without_touching_victim() {
2092 let storage = tempfile::tempdir().unwrap();
2093 let first = create_task_layout(storage.path(), "session", &valid_id(40)).unwrap();
2094 let second = create_task_layout(storage.path(), "session", &valid_id(41)).unwrap();
2095 let victim = second.paths.control_dir.join("victim");
2096 fs::write(&victim, b"victim-bytes").unwrap();
2097
2098 let moved_first = first.paths.session_dir.join("moved-first");
2101 let refusal = fs::rename(&first.paths.dir, &moved_first)
2102 .expect_err("open pinned-dir handle must block the task-dir rename on Windows");
2103 assert_eq!(refusal.kind(), io::ErrorKind::PermissionDenied);
2104
2105 assert_eq!(fs::read(&victim).unwrap(), b"victim-bytes");
2107 }
2108
2109 #[test]
2110 fn legacy_flat_layout_is_readable_and_deleted_as_a_bundle() {
2111 let storage = tempfile::tempdir().unwrap();
2112 let task_id = valid_id(32);
2113 let paths = task_paths(storage.path(), "session", &task_id).unwrap();
2114 fs::create_dir_all(&paths.session_dir).unwrap();
2115 let metadata = PersistedTask::starting(
2116 task_id.clone(),
2117 "session".into(),
2118 "true".into(),
2119 storage.path().into(),
2120 None,
2121 None,
2122 true,
2123 false,
2124 );
2125 write_task(&paths.json, &metadata).unwrap();
2126 fs::write(&paths.stdout, b"legacy").unwrap();
2127 fs::write(&paths.stderr, b"").unwrap();
2128 assert_eq!(
2129 resolve_task_layout(&paths.session_dir, &task_id)
2130 .unwrap()
2131 .paths
2132 .layout,
2133 TaskLayout::Flat
2134 );
2135 assert_eq!(
2136 open_task_artifact(&paths, TaskArtifact::Stdout)
2137 .unwrap()
2138 .read_all()
2139 .unwrap(),
2140 b"legacy"
2141 );
2142 delete_task_bundle(&paths).unwrap();
2143 assert!(!paths.json.exists());
2144 assert!(!paths.stdout.exists());
2145 }
2146
2147 #[cfg(unix)]
2148 #[test]
2149 fn live_output_creation_and_later_writes_refuse_link_attacks() {
2150 use std::os::unix::fs::symlink;
2151
2152 let storage = tempfile::tempdir().unwrap();
2153 let task = create_task_layout(storage.path(), "session", &valid_id(33)).unwrap();
2154 let metadata = PersistedTask::starting(
2155 task.paths.task_id.clone(),
2156 "session".into(),
2157 "true".into(),
2158 storage.path().into(),
2159 None,
2160 None,
2161 true,
2162 false,
2163 );
2164 write_task_at(&task, &metadata).unwrap();
2165 let victim = storage.path().join("victim");
2166 fs::write(&victim, b"victim-bytes").unwrap();
2167
2168 symlink(&victim, &task.paths.stdout).unwrap();
2169 assert!(TaskIoHandles::create(&task, BgMode::Pipes, false).is_err());
2170 assert_eq!(fs::read(&victim).unwrap(), b"victim-bytes");
2171 fs::remove_file(&task.paths.stdout).unwrap();
2172
2173 let mut handles = TaskIoHandles::create(&task, BgMode::Pipes, false).unwrap();
2174 fs::hard_link(&task.paths.stdout, task.paths.io_dir.join("linked-stdout")).unwrap();
2175 assert!(handles
2176 .write(TaskArtifact::Stdout, b"daemon-write")
2177 .is_err());
2178 assert_eq!(fs::read(&victim).unwrap(), b"victim-bytes");
2179
2180 fs::remove_file(&task.paths.stdout).unwrap();
2181 symlink(&victim, &task.paths.stdout).unwrap();
2182 assert!(replace_artifact_with_tail(&task.paths, TaskArtifact::Stdout, 1).is_err());
2183 assert_eq!(fs::read(&victim).unwrap(), b"victim-bytes");
2184 }
2185
2186 #[test]
2187 fn registered_artifact_consumers_do_not_reopen_paths_directly() {
2188 let rust_sources = [
2189 include_str!("buffer.rs"),
2190 include_str!("registry.rs"),
2191 include_str!("process.rs"),
2192 include_str!("pty_process.rs"),
2193 include_str!("watches.rs"),
2194 include_str!("watchdog.rs"),
2195 include_str!("../commands/bash_status.rs"),
2196 ];
2197 for source in rust_sources {
2198 let production = source
2199 .split("#[cfg(test)]\nmod tests")
2200 .next()
2201 .unwrap_or(source);
2202 for forbidden in [
2203 "File::open(&task.paths",
2204 "fs::read(&task.paths",
2205 "fs::read_to_string(&task.paths",
2206 "File::open(path)?",
2207 ] {
2208 assert!(
2209 !production.contains(forbidden),
2210 "registered artifact consumer contains raw path read: {forbidden}"
2211 );
2212 }
2213 }
2214 for source in [
2215 include_str!("../../../../packages/opencode-plugin/src/tools/bash.ts"),
2216 include_str!("../../../../packages/opencode-plugin/src/tools/bash_watch.ts"),
2217 include_str!("../../../../packages/pi-plugin/src/tools/bash.ts"),
2218 ] {
2219 for forbidden in [
2220 "fs.readFile(outputPath)",
2221 "fs.readFile(details.output_path)",
2222 "fs.open(outputPath",
2223 ] {
2224 assert!(
2225 !source.contains(forbidden),
2226 "plugin artifact consumer contains raw path read: {forbidden}"
2227 );
2228 }
2229 }
2230 }
2231
2232 #[cfg(unix)]
2233 #[test]
2234 fn validated_artifact_refuses_symlink_hardlink_and_fifo() {
2235 use std::os::unix::fs::symlink;
2236
2237 let storage = tempfile::tempdir().unwrap();
2238 let task = create_task_layout(storage.path(), "session", &valid_id(3)).unwrap();
2239 let metadata = PersistedTask::starting(
2240 task.paths.task_id.clone(),
2241 "session".into(),
2242 "true".into(),
2243 storage.path().into(),
2244 None,
2245 None,
2246 true,
2247 false,
2248 );
2249 write_task_at(&task, &metadata).unwrap();
2250 let canary = storage.path().join("canary");
2251 fs::write(&canary, b"secret").unwrap();
2252
2253 symlink(&canary, &task.paths.stdout).unwrap();
2254 assert!(open_task_artifact(&task.paths, TaskArtifact::Stdout).is_err());
2255 fs::remove_file(&task.paths.stdout).unwrap();
2256
2257 fs::hard_link(&canary, &task.paths.stdout).unwrap();
2258 assert!(open_task_artifact(&task.paths, TaskArtifact::Stdout).is_err());
2259 fs::remove_file(&task.paths.stdout).unwrap();
2260
2261 let path = CString::new(task.paths.stdout.as_os_str().as_bytes()).unwrap();
2262 assert_eq!(unsafe { libc::mkfifo(path.as_ptr(), 0o600) }, 0);
2263 assert!(open_task_artifact(&task.paths, TaskArtifact::Stdout).is_err());
2264 }
2265}