yog-runtime 0.111.0

//! A control channel to whatever launched this game instance — Yog-IDLE or
//! `dev.sh`, though nothing here is specific to either (dev builds only).
//! It answers two things a launcher otherwise can't:
//!
//! - "what's the actual pid to attach a debugger to" — a launcher wrapper
//!   (`./gradlew runClient`) is very often *not* an ancestor of the real
//!   JVM once Gradle's daemon is involved. This tells the client directly.
//! - "hot-reload this mod" — the handler runs inside this process, so it
//!   just calls [`crate::mods::hot_reload::trigger_hot_reload`].
//!
//! Opt-in: it starts only when `YOG_CONTROL_SOCKET` (a loopback address,
//! `127.0.0.1:<port>`) and `YOG_CONTROL_TOKEN` are set. TCP on loopback works
//! on every platform; the token keeps other local processes out: a client's
//! first frame is `Command::Hello` with it and its pid, anything else closes
//! the connection. The protocol (`yog_hot_reload::control`, frames of Yog
//! Data) follows: the runtime answers `hello` with `ready` (its pid, its
//! mods), then each command with its event.

use std::net::{SocketAddr, TcpListener, TcpStream};

use yog_hot_reload::control::{self, Command, Event, ModInfo};

/// Reads `YOG_CONTROL_SOCKET` and `YOG_CONTROL_TOKEN`; with both, listens on
/// the address (loopback only) on a background thread. Call once, after
/// `load_mods` (so `ready`'s mod list is complete) — see `nativeInit`.
pub fn start_if_requested() {
    let (Ok(addr), Ok(token)) = (
        std::env::var(yog_ids::env::CONTROL_SOCKET),
        std::env::var(yog_ids::env::CONTROL_TOKEN),
    ) else {
        return;
    };
    let addr: SocketAddr = match addr.parse() {
        Ok(a) => a,
        Err(e) => {
            yog_logging::error!("control socket: `{addr}` isn't an address ({e})");
            return;
        }
    };
    if !addr.ip().is_loopback() {
        yog_logging::error!("control socket: {addr} isn't a loopback address — not listening");
        return;
    }
    let listener = match TcpListener::bind(addr) {
        Ok(l) => l,
        Err(e) => {
            yog_logging::error!("control socket: failed to bind {addr}: {e}");
            return;
        }
    };
    std::thread::spawn(move || {
        // One client at a time (the launcher); it may reconnect.
        for stream in listener.incoming().flatten() {
            handle_client(stream, &token);
        }
    });
}

/// Lets process `pid` (the client, which proved itself with the token)
/// `ptrace` this one. Yama's default policy (`ptrace_scope = 1`) only allows
/// tracing descendants, and the game usually isn't one of the IDE's
/// (Gradle's daemon launches it) — but a process may name a tracer itself
/// (`PR_SET_PTRACER`), which needs no privileges. Without Yama, `prctl`
/// fails with `EINVAL`: nothing to lift then.
///
/// Returns whether `pid` may now trace us — reported in `ready` as
/// `ptracer`, so the client knows whether an attach can work.
#[cfg(target_os = "linux")]
fn allow_to_trace(pid: u32) -> bool {
    if pid == 0 {
        return false;
    }
    // SAFETY: plain `prctl` call with integer arguments.
    let rc = unsafe { libc::prctl(libc::PR_SET_PTRACER, pid as libc::c_ulong, 0, 0, 0) };
    if rc == 0 {
        return true;
    }
    let err = std::io::Error::last_os_error();
    if err.raw_os_error() == Some(libc::EINVAL) {
        return true;
    }
    yog_logging::warn!("control socket: PR_SET_PTRACER({pid}) failed: {err}");
    false
}

/// `event` to the tool connected; one gone is noticed by the reading loop,
/// which ends the connection.
fn send(stream: &mut TcpStream, event: &Event) {
    let _ = control::send(stream, event);
}

fn mod_list() -> Vec<ModInfo> {
    crate::globals::MOD_INFOS
        .lock()
        .iter()
        .map(|m| ModInfo {
            id: m.id.clone(),
            name: m.name.clone(),
            version: m.version.clone(),
        })
        .collect()
}

fn handle_client(mut stream: TcpStream, token: &str) {
    let first = control::receive(&mut stream).ok().flatten();
    if !greet(&mut stream, first, token) {
        return;
    }
    // Until the client hangs up, or sends what isn't a command.
    while let Ok(Some(cmd)) = control::receive(&mut stream) {
        answer(&mut stream, cmd);
    }
}

/// The client proves it's the launcher first (`hello` with the token); it's
/// answered `ready`: this process, its mods, whether it may trace it.
fn greet(stream: &mut TcpStream, first: Option<Command>, token: &str) -> bool {
    let Some(Command::Hello { token: theirs, pid }) = first else {
        yog_logging::warn!("control socket: a client that didn't say hello — closed");
        return false;
    };
    if theirs != token {
        yog_logging::warn!("control socket: a client without the token — closed");
        return false;
    }
    #[cfg(target_os = "linux")]
    let ptracer = allow_to_trace(pid);
    #[cfg(not(target_os = "linux"))]
    let ptracer = {
        let _ = pid;
        false
    };
    send(
        stream,
        &Event::Ready {
            pid: std::process::id(),
            mods: mod_list(),
            ptracer,
        },
    );
    true
}

/// One command, answered by its event.
fn answer(stream: &mut TcpStream, cmd: Command) {
    let reply = match cmd {
        Command::HotReload {
            mod_id,
            yog_path,
            resources,
        } => {
            let ok = crate::mods::hot_reload::trigger_hot_reload(&mod_id, &yog_path);
            if ok && resources {
                crate::mods::registrations::reload_game_resources();
            }
            Event::HotReloadDone { mod_id, ok }
        }
        // What a new `.yog` registers differently from the game as it
        // started — changes only a restart applies.
        Command::HotReloadCheck { mod_id, yog_path } => {
            let changes = crate::mods::registrations::changes(&mod_id, &yog_path);
            Event::HotReloadCheck { mod_id, changes }
        }
        Command::ReloadResources => {
            crate::mods::registrations::reload_game_resources();
            Event::ResourcesReloaded
        }
        Command::ListMods => Event::Mods { mods: mod_list() },
        Command::Hello { .. } => return,
    };
    send(stream, &reply);
}