onelf 0.5.1

Packer CLI for creating onelf single-binary packages
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
//! Run an AppDir in place for fast dev iteration.
//!
//! If the AppDir has an `onelf.toml`, use it for entrypoint/args/working-dir.
//! Otherwise auto-discover a single binary under `bin/` and run with defaults.
//! Sets environment variables matching the packed runtime and execs directly.
//! No packing, mounting, or extraction involved.

use std::io;
use std::os::unix::process::CommandExt;
use std::path::{Path, PathBuf};
use std::process::Command;

use onelf_format::cache_layout as layout;
use onelf_format::resolve::{self, Request, Resolution};
use onelf_format::{HostLibsPolicy, WorkingDir, drivers};

use crate::bundle;
use crate::pack::HostLibs;
use crate::recipe;

/// Translate the recipe's [bundle] section into bundle-libs invocation.
fn bundle_from_recipe(dir: &Path, r: &recipe::Recipe) -> io::Result<()> {
    if r.bundle.skip {
        return Ok(());
    }
    let search_path: Vec<PathBuf> = r
        .bundle
        .search_paths
        .iter()
        .map(|s| PathBuf::from(s.as_str()))
        .collect();
    bundle::bundle_libs(&bundle::BundleOptions {
        directory: dir.to_path_buf(),
        target: None,
        primary: Some(PathBuf::from(&r.package.command)),
        lib_dir: PathBuf::from("lib"),
        exclude: r.bundle.exclude.clone(),
        include: r.bundle.include.clone(),
        search_path,
        dry_run: false,
        recursive: true,
        gl: r.bundle.gl,
        dri: r.bundle.dri,
        vulkan: r.bundle.vulkan,
        wayland: r.bundle.wayland,
        gtk: r.bundle.gtk,
        no_gl: r.bundle.no_gl,
        no_dri: r.bundle.no_dri,
        no_vulkan: r.bundle.no_vulkan,
        no_wayland: r.bundle.no_wayland,
        no_gtk: r.bundle.no_gtk,
        strip: r.bundle.strip,
        strict_libc: r.bundle.strict_libc,
        scan_dlopen: r.bundle.scan_dlopen,
        dlopen_extra: r.bundle.dlopen.clone(),
        trace_run: r.bundle.trace_run,
        trace_seconds: r.bundle.trace_seconds.unwrap_or(5),
        trace_args: r.bundle.trace_args.clone(),
        sysroot: None,
        sets: Vec::new(),
        platform_pin: None,
    })
}

pub fn run(
    app_spec: &Path,
    command_override: Option<&str>,
    entrypoint: Option<&str>,
    run_bundle: bool,
    passthrough_args: &[String],
) -> io::Result<()> {
    // Figure out the AppDir: user's spec is either the directory or a recipe file.
    let (dir, recipe) = resolve_app(app_spec)?;
    let dir = dir.canonicalize()?;

    if run_bundle {
        match recipe.as_ref() {
            Some(r) => bundle_from_recipe(&dir, r)?,
            None => eprintln!("onelf run: --bundle skipped: no recipe found in AppDir"),
        }
    }

    let (ep_name, ep_path, ep_args, working_dir) =
        resolve_entrypoint(&recipe, &dir, command_override, entrypoint)?;

    let target = dir.join(&ep_path);
    if !target.exists() {
        return Err(io::Error::new(
            io::ErrorKind::NotFound,
            format!("entrypoint target not found: {}", target.display()),
        ));
    }

    // Detect lib dirs in the AppDir (same rule as pack: any dir containing .so files,
    // excluding .onelf/, share/, bin/, etc).
    let lib_dirs = detect_lib_dirs(&dir);
    let lib_paths: Vec<String> = lib_dirs
        .iter()
        .map(|p| dir.join(p).to_string_lossy().into_owned())
        .collect();
    let lib_paths_str = lib_paths.join(":");
    let target_is_elf = is_elf_file_at(&target);

    // The same decision the packed runtime makes: what the host supplies is
    // chosen per library, and no host directory goes on the search path.
    // The AppDir is the developer's own tree and there is no namespace to
    // mount in, so a host copy cannot be placed over a bundled one here;
    // the farm still reaches everything the bundle does not carry. That
    // rules out the host's glibc, which only runs once its copy replaces
    // the bundled one.
    let policy = match recipe.as_ref().and_then(|r| r.package.host_libs) {
        Some(spec) => match HostLibs::from(spec) {
            HostLibs::Always => HostLibsPolicy::Always,
            HostLibs::Never => HostLibsPolicy::Never,
            HostLibs::Auto => HostLibsPolicy::Auto,
        },
        None => HostLibsPolicy::Auto,
    };
    let disabled = std::env::var_os("ONELF_NO_RESOLVER").is_some_and(|v| !v.is_empty() && v != "0");
    let lib_dir_strs: Vec<&str> = lib_dirs.iter().filter_map(|p| p.to_str()).collect();
    let resolution = match run_store(&dir) {
        Some(store) if target_is_elf && !lib_dirs.is_empty() && !disabled => {
            resolve::resolve(&Request {
                pkg_root: &dir,
                lib_dirs: &lib_dir_strs,
                policy,
                store: &store,
                ld_cache: &drivers::cache_file(),
                icd_dirs: resolve::ICD_DIRS,
                extra_root: None,
                set_roots: &[],
                host_libc: false,
            })
        }
        _ => Resolution::default(),
    };
    for name in &resolution.incomparable {
        eprintln!("onelf run: resolver: cannot order {name}; keeping the bundled copy");
    }
    let mut search: Vec<String> = Vec::new();
    if let Some(farm) = &resolution.farm {
        search.push(farm.to_string_lossy().into_owned());
    }
    if !lib_paths_str.is_empty() {
        search.push(lib_paths_str.clone());
    }
    let search_str = search.join(":");

    let requested_cwd = match working_dir {
        WorkingDir::PackageRoot => Some(dir.clone()),
        WorkingDir::EntrypointParent => target.parent().map(Path::to_path_buf),
        WorkingDir::Inherit => None,
    };

    // As the packed runtime does: the target's own path, unless the
    // entrypoint is named apart from it and a multicall binary needs
    // the name.
    let argv0 = match target.to_str() {
        Some(path) if target.file_name() == Some(ep_name.as_ref()) => path,
        _ => ep_name.as_str(),
    };
    let mut cmd = build_exec_command(
        &target,
        &dir,
        &search_str,
        argv0,
        resolution.host_interp.as_deref(),
    )?;
    cmd.args(&ep_args);
    cmd.args(passthrough_args);

    if let Some(c) = requested_cwd {
        cmd.env(
            "ONELF_USER_CWD",
            std::env::current_dir().unwrap_or_else(|_| PathBuf::from("/")),
        );
        cmd.current_dir(c);
    }

    cmd.env("ONELF_DIR", &dir);
    cmd.env("ONELF_ACTIVE_MODE", "dev");
    cmd.env("ONELF_ARGV0", &ep_name);
    cmd.env("ONELF_EXEC", &target);
    cmd.env("ONELF_ENTRYPOINT", &ep_name);
    cmd.env("ONELF_ENTRYPOINT_EXPORTED", &ep_name);

    if !lib_paths_str.is_empty() {
        // Only set LD_LIBRARY_PATH for ELF targets. When the entrypoint
        // is a script the kernel hands it to a host interpreter
        // (/bin/sh, /usr/bin/python3, ...) linked against the host
        // glibc. If our bundled lib dir comes first on LD_LIBRARY_PATH,
        // the host ld would load our bundled libc, mixing two glibc
        // versions in one process and crashing before main. Let the
        // script export LD_LIBRARY_PATH itself before exec'ing bundled
        // ELFs.
        if target_is_elf {
            let existing = std::env::var("LD_LIBRARY_PATH").unwrap_or_default();
            let mut parts: Vec<String> = vec![search_str.clone()];
            if !existing.is_empty() {
                parts.push(existing);
            }
            cmd.env("LD_LIBRARY_PATH", parts.join(":"));
        }

        // Auto-set GPU/driver paths if the usual subdirs exist.
        let dri_paths: Vec<String> = lib_paths
            .iter()
            .map(|p| Path::new(p).join("dri").to_string_lossy().into_owned())
            .filter(|p| Path::new(p).is_dir())
            .collect();
        if !dri_paths.is_empty() {
            let joined = dri_paths.join(":");
            cmd.env("LIBGL_DRIVERS_PATH", &joined);
            cmd.env("LIBVA_DRIVERS_PATH", &joined);
        }

        let gbm_paths: Vec<String> = lib_paths
            .iter()
            .map(|p| Path::new(p).join("gbm").to_string_lossy().into_owned())
            .filter(|p| Path::new(p).is_dir())
            .collect();
        if !gbm_paths.is_empty() {
            cmd.env("GBM_BACKENDS_PATH", gbm_paths.join(":"));
        }
    }

    let share = dir.join("share");
    if share.is_dir() {
        let existing = std::env::var("XDG_DATA_DIRS").unwrap_or_default();
        let base = share.to_string_lossy();
        let new_val = if existing.is_empty() {
            format!("{base}:/usr/local/share:/usr/share")
        } else {
            format!("{base}:{existing}")
        };
        cmd.env("XDG_DATA_DIRS", new_val);
    }

    // exec never returns on success.
    let err = cmd.exec();
    Err(io::Error::other(format!("exec failed: {err}")))
}

/// Build a Command for executing the target binary. Handles the cross-libc
/// case where the target's PT_INTERP doesn't exist on the host but a matching
/// interpreter is bundled in the AppDir's lib directories.
/// Locate the AppDir root and an optional recipe from a user-supplied path.
/// Accepts a directory (with or without onelf.toml) or a `.toml` file.
fn resolve_app(spec: &Path) -> io::Result<(PathBuf, Option<recipe::Recipe>)> {
    if spec.is_dir() {
        let toml = spec.join("onelf.toml");
        let recipe = if toml.is_file() {
            Some(recipe::load(&toml)?)
        } else {
            None
        };
        return Ok((spec.to_path_buf(), recipe));
    }
    if spec.is_file() && spec.extension().and_then(|s| s.to_str()) == Some("toml") {
        let recipe = recipe::load(spec)?;
        let dir = spec
            .parent()
            .map(Path::to_path_buf)
            .unwrap_or_else(|| PathBuf::from("."));
        return Ok((dir, Some(recipe)));
    }
    Err(io::Error::new(
        io::ErrorKind::InvalidInput,
        format!(
            "{}: expected an AppDir (directory) or an onelf.toml file",
            spec.display()
        ),
    ))
}

/// Pick the entrypoint and its args, consulting (in order): `--command`
/// override, the recipe's named entrypoints, the recipe's default command,
/// or an auto-detected binary under `<dir>/bin/`.
fn resolve_entrypoint(
    recipe: &Option<recipe::Recipe>,
    dir: &Path,
    command_override: Option<&str>,
    entrypoint: Option<&str>,
) -> io::Result<(String, String, Vec<String>, WorkingDir)> {
    let working_dir: WorkingDir = recipe
        .as_ref()
        .map(|r| r.package.working_dir.into())
        .unwrap_or(WorkingDir::Inherit);

    if let Some(cmd) = command_override {
        let name = Path::new(cmd)
            .file_name()
            .and_then(|n| n.to_str())
            .unwrap_or("app")
            .to_string();
        return Ok((name, cmd.to_string(), Vec::new(), working_dir));
    }

    if let Some(r) = recipe {
        if let Some(name) = entrypoint {
            let ep = r
                .entrypoint
                .iter()
                .find(|e| e.name == name)
                .ok_or_else(|| {
                    io::Error::new(
                        io::ErrorKind::NotFound,
                        format!("entrypoint '{name}' not defined in recipe"),
                    )
                })?;
            return Ok((
                ep.name.clone(),
                ep.path.clone(),
                ep.args.clone(),
                working_dir,
            ));
        }
        if let Some(ep) = r.entrypoint.iter().find(|e| e.default) {
            return Ok((
                ep.name.clone(),
                ep.path.clone(),
                ep.args.clone(),
                working_dir,
            ));
        }
        let name = r.package.name.clone().unwrap_or_else(|| {
            r.package
                .command
                .rsplit('/')
                .next()
                .unwrap_or("app")
                .to_string()
        });
        return Ok((name, r.package.command.clone(), Vec::new(), working_dir));
    }

    if entrypoint.is_some() {
        return Err(io::Error::new(
            io::ErrorKind::InvalidInput,
            "--entrypoint requires an onelf.toml in the AppDir",
        ));
    }

    // No recipe, no override: find a single executable under bin/.
    let bin = dir.join("bin");
    if !bin.is_dir() {
        return Err(io::Error::new(
            io::ErrorKind::NotFound,
            format!(
                "{}: no onelf.toml and no bin/ subdirectory; pass --command PATH",
                dir.display()
            ),
        ));
    }
    let entries: Vec<PathBuf> = std::fs::read_dir(&bin)?
        .filter_map(Result::ok)
        .map(|e| e.path())
        .filter(|p| p.is_file())
        .collect();
    if entries.is_empty() {
        return Err(io::Error::new(
            io::ErrorKind::NotFound,
            format!("{}: no executables found", bin.display()),
        ));
    }
    if entries.len() > 1 {
        let names: Vec<String> = entries
            .iter()
            .filter_map(|p| p.file_name().and_then(|n| n.to_str()).map(String::from))
            .collect();
        return Err(io::Error::new(
            io::ErrorKind::InvalidInput,
            format!(
                "{}: multiple binaries found; pass --command bin/NAME (have: {})",
                bin.display(),
                names.join(", ")
            ),
        ));
    }
    let bin_path = &entries[0];
    let name = bin_path
        .file_name()
        .and_then(|n| n.to_str())
        .unwrap_or("app")
        .to_string();
    let rel = format!("bin/{name}");
    Ok((name, rel, Vec::new(), working_dir))
}

/// Result of choosing how to exec the target.
///
/// When the target's PT_INTERP was patched to a relative path that
/// resolves under `app_dir` (i.e. `bundle-libs` did its job), we can
/// execve the target directly and let the kernel load the bundled ld.
/// That keeps `/proc/self/exe` pointing at the real binary, which is
/// what Python, Electron and friends read to find their resources.
///
/// Falls back to invoking the bundled loader explicitly when we have
/// one but PT_INTERP wasn't patched, or to a bare exec if nothing is
/// bundled (the host must have the right loader).
fn build_exec_command(
    target: &Path,
    app_dir: &Path,
    lib_path: &str,
    argv0: &str,
    host_interp: Option<&Path>,
) -> io::Result<Command> {
    let interp = read_elf_interp(target);

    // The host's glibc won, so the bundled loader must not run at all. A
    // bootstrap-injected binary carries no PT_INTERP and maps its loader
    // itself; ONELF_INTERP redirects it, and every re-exec inherits that.
    // Anything else is handed to the host loader directly.
    if let Some(host_interp) = host_interp {
        if interp.is_none() {
            let mut cmd = Command::new(target);
            cmd.arg0(argv0).env("ONELF_INTERP", host_interp);
            return Ok(cmd);
        }
        let mut cmd = Command::new(host_interp);
        cmd.arg("--inhibit-cache");
        if !lib_path.is_empty() {
            cmd.arg("--library-path").arg(lib_path);
        }
        cmd.arg("--argv0").arg(argv0).arg(target);
        return Ok(cmd);
    }

    if let Some(interp) = interp {
        let interp_path = Path::new(&interp);

        if let Some(bundled) = find_bundled_interp(&interp, app_dir) {
            let is_musl = interp_path
                .file_name()
                .and_then(|n| n.to_str())
                .is_some_and(|n| n.starts_with("ld-musl-"));
            let mut cmd = Command::new(&bundled);
            if !is_musl {
                cmd.arg("--inhibit-cache");
            }
            if !lib_path.is_empty() {
                cmd.arg("--library-path").arg(lib_path);
            }
            cmd.arg("--argv0").arg(argv0).arg(target);
            return Ok(cmd);
        }

        if !interp_path.exists() {
            eprintln!(
                "warning: ELF interpreter {} not found on host and no bundled \
                 equivalent in the AppDir; exec will likely fail",
                interp
            );
        }
    }

    let mut cmd = Command::new(target);
    cmd.arg0(argv0);
    Ok(cmd)
}

/// Read PT_INTERP from an ELF file. Returns None for non-ELF or missing interp.
/// Strips trailing NULs introduced by our PT_INTERP patching, which pads the
/// slot with zero bytes rather than shrinking p_filesz.
fn read_elf_interp(path: &Path) -> Option<String> {
    let data = std::fs::read(path).ok()?;
    goblin::elf::Elf::parse(&data)
        .ok()?
        .interpreter
        .map(|s| s.trim_end_matches('\0').to_string())
}

/// Look in the AppDir's lib dirs for a file matching the PT_INTERP basename.
fn find_bundled_interp(interp: &str, app_dir: &Path) -> Option<PathBuf> {
    let name = Path::new(interp).file_name()?.to_os_string();
    for rel in detect_lib_dirs(app_dir) {
        let candidate = app_dir.join(&rel).join(&name);
        if candidate.exists() {
            return Some(candidate);
        }
    }
    None
}

/// True if `path` is an ELF file (first four bytes `\x7fELF`). Scripts
/// (shebang `#!`) and missing files return false. Used to decide
/// whether it's safe to set `LD_LIBRARY_PATH` in the child's env:
/// scripts get handed to a host interpreter linked against the host's
/// glibc, and pointing it at our bundled libc mixes versions and
/// crashes before main.
fn is_elf_file_at(path: &Path) -> bool {
    use std::io::Read;
    let Ok(mut f) = std::fs::File::open(path) else {
        return false;
    };
    let mut buf = [0u8; 4];
    matches!(f.read(&mut buf), Ok(4)) && buf == *b"\x7fELF"
}

/// Where the resolver keeps its link farm and recorded decision for the
/// AppDir at `dir`: under the cache root, keyed by the directory's path,
/// so repeated dev runs of the same tree reuse it.
fn run_store(dir: &Path) -> Option<PathBuf> {
    let root = layout::resolve_root(rustix::process::getuid().as_raw(), None)?;
    let id = blake3::hash(dir.as_os_str().as_encoded_bytes()).to_hex();
    Some(root.join("run").join(&id[..16]))
}

/// Find subdirectories of `dir` that contain `.so*` files, skipping obvious
/// non-lib roots. Mirrors the heuristic in pack.rs's auto_detect_lib_dirs.
fn detect_lib_dirs(dir: &Path) -> Vec<PathBuf> {
    let mut lib_dirs: Vec<PathBuf> = Vec::new();
    for entry in jwalk::WalkDir::new(dir).skip_hidden(false).sort(true) {
        let Ok(entry) = entry else { continue };
        if !entry.file_type().is_file() {
            continue;
        }
        let path = entry.path();
        let name = path.file_name().and_then(|n| n.to_str()).unwrap_or("");
        if !name.contains(".so") {
            continue;
        }
        let Some(parent) = path.parent() else {
            continue;
        };
        let Ok(rel) = parent.strip_prefix(dir) else {
            continue;
        };
        let rel_str = rel.to_string_lossy();
        if rel_str.is_empty()
            || rel_str.starts_with(".onelf")
            || rel_str.starts_with("share/")
            || rel_str == "bin"
            || rel_str.starts_with("bin/")
            || rel_str.starts_with("etc/")
        {
            continue;
        }
        let rel_path = rel.to_path_buf();
        if !lib_dirs.contains(&rel_path) {
            lib_dirs.push(rel_path);
        }
    }
    lib_dirs
}