SchOS/include/schinit.h
Nexoniarz 0def474272 init: a hang is as detectable as a death, and PID 1 comes back
docs/plan/init.md milestones I2 and I3. The rule change.

**I2 -- the heartbeat.** The failure the two-init scheme could not see is that
an init usually does not die, it *hangs*: wait() never returns for a process
that is merely stuck, so a supervisor watching a wedged init reports
everything normal for ever. PID 1 now pings every two seconds and expects an
answer within ten; silence means stuck, and stuck is worth acting on.

Exercised rather than reasoned about, as the plan asks: `sysrq w` wedges
schinitd by making the scheduler pass over it for ever. It stays alive, keeps
its descriptors and appears in every listing -- which is the point.

Two things that only showed up by running it:

  - kill() sets a flag the target checks when it next runs, and the premise
    here is that it is not running. Waiting for a corpse that may never be
    produced turns the recovery path into a second hang. PID 1 replaces the
    supervisor *without waiting*; the old one's socket is closed, so the moment
    it runs again its first write fails and it exits.
  - the replaced supervisor must notice the hangup. poll() reports POLLHUP and
    never POLLIN again, so a loop that only looks for POLLIN sits there
    complaining that PID 1 has stopped pinging it.

**I3 -- proc_reincarnate().** exit() on initproc panicked. Now the kernel
tears down nothing, keeps pid 1, and re-execs /bin/schinit in place with a
generation counter. The pid stays 1, so every orphan the kernel reparented is
still correctly parented; the children survive; the open files survive, which
is why this is the first line of exit() and not the last; and the job table
survives in /proc/schinit, which is what it is there for.

The escalation ladder: generations 2-3 carry on, generation 4 ignores
/etc/schinit and starts a console shell only -- a manifest that kills init
must not kill it for ever -- and generation 5 stops, with PSOGM rendering
INIT_RESURRECTION_FAILED, a call chain and a QR code.

Three bugs found by running it, each a lesson about exec():

  - exec() returns 0 on success; it does not fail to return. The new image
    starts when the kernel returns to userspace through the rewritten
    trapframe. Returning from exit() is the success path.
  - exit() was reached because `killed` was set, and the trap path checks it
    again on the way out. Leaving it set exits the new image before its first
    instruction: five generations in a few microseconds, a resurrection loop
    that looks exactly like the crash it was meant to survive.
  - exec() keeps open files, which is what gives the new image a console --
    and also keeps the previous life's socket, holding the old supervisor's
    channel up so it never sees a hangup.

Verified: `sysrq i`, and the shell being typed into keeps its pid across the
death and rebirth of PID 1, with /proc/schinit byte-identical either side.

schfs-check passes.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VQ7Qx8E1q1M1bbCq8QLHS2
2026-09-13 14:27:22 +02:00

122 lines
4.9 KiB
C

// SPDX-License-Identifier: Apache-2.0
//
// The protocol between PID 1 and the supervisor.
//
// docs/plan/init.md §"What it costs" warns about this file specifically: two
// processes that must agree is a compatibility surface where there was none,
// and docs/plan/schapi.md §3 is about how those go wrong. So the rules are
// written here rather than assumed.
//
// **Fixed-size messages.** Every message is exactly one struct, and PID 1
// reads sizeof(struct) or nothing. No length prefix to get wrong, no
// partial-parse state to be caught in, and -- the reason that matters --
// **PID 1 never allocates**. A supervisor that has gone mad cannot make PID 1
// allocate, block on a malloc, or run a parser.
//
// **Versioned in the first message.** SCHINIT_PROTO travels in the hello. A
// mismatch is a refusal, not a best-effort interpretation.
//
// **Entirely internal.** This is not SchAPI. Nothing but schinit and
// schinitd may speak it, and it may change shape whenever both change
// together, which is what keeping it in one header is for.
//
// The asymmetry is the design, not an accident: the supervisor *asks*, PID 1
// *acts*. Every job on the machine is therefore a child of PID 1 at all times,
// so a supervisor that dies orphans nothing and reparents nothing.
#ifndef SCHINIT_H
#define SCHINIT_H
#define SCHINIT_PROTO 1
#define SCHINIT_MAXARGS 16
#define SCHINIT_MAXENVV 16
#define SCHINIT_MAXLABEL 64
#define SCHINIT_MAXPATH 128
// One flat buffer for argv and envp strings, copied whole. Pointers cannot
// cross a process boundary, so the spec carries text and PID 1 rebuilds the
// arrays on its own stack after exec'ing -- which is the only place they are
// ever valid.
#define SCHINIT_STRBUF 1024
// supervisor -> PID 1
#define SCHINIT_HELLO 1 // struct schinit_hello
#define SCHINIT_SPAWN 2 // struct schinit_spawn
#define SCHINIT_PONG 3 // struct schinit_hello -- answer to a PING
// PID 1 -> supervisor
#define SCHINIT_WELCOME 128 // struct schinit_hello, echoed with PID 1's version
#define SCHINIT_SPAWNED 129 // struct schinit_reply -- pid, or negative on failure
#define SCHINIT_EXITED 130 // struct schinit_reply -- a child has been reaped
#define SCHINIT_PING 131 // struct schinit_hello -- answer within the deadline
// The heartbeat.
//
// docs/plan/init.md part 3, and the failure the two-init scheme could not see:
// **the common way an init breaks is not dying, it is hanging.** wait() never
// returns for a process that is merely stuck, so a supervisor watching a
// wedged PID 1 -- or PID 1 watching a wedged supervisor -- reports everything
// normal forever.
//
// So each must be heard from. PID 1 sends a PING every interval and expects a
// PONG; silence past the deadline means the other end is stuck rather than
// busy, and stuck is the case worth acting on.
//
// Measured in seconds of uptime(), which counts ticks. Ticks can be *lost*
// when interrupts are off too long -- see kernel/core/time.c -- which makes a
// tick-measured deadline longer in real time than it looks, never shorter.
// That is the safe direction: a machine under load waits longer before
// declaring a hang, rather than declaring one that has not happened.
#define SCHINIT_PING_SECS 2
#define SCHINIT_DEADLINE_SECS 10
struct schinit_hello {
unsigned int op;
unsigned int proto;
unsigned int generation; // how many times PID 1 has been re-exec'd
unsigned int reserved;
};
// A job, flattened. `args` and `envs` index into `strbuf`, which holds
// NUL-terminated strings back to back.
struct schinit_spawn {
unsigned int op;
unsigned int cookie; // echoed in the reply, so the supervisor
// can match a spawn to the job it asked for
char label[SCHINIT_MAXLABEL];
char program[SCHINIT_MAXPATH];
char stdin_path[SCHINIT_MAXPATH];
char stdout_path[SCHINIT_MAXPATH];
char stderr_path[SCHINIT_MAXPATH];
unsigned int own_tty; // claim the terminal as controlling
unsigned int nargs;
unsigned int nenvs;
unsigned short args[SCHINIT_MAXARGS]; // offsets into strbuf
unsigned short envs[SCHINIT_MAXENVV];
char strbuf[SCHINIT_STRBUF];
};
struct schinit_reply {
unsigned int op;
unsigned int cookie;
int pid; // SPAWNED: the child, or negative errno
int status; // EXITED: wait status
};
// The largest message, which is what a reader must have room for. PID 1 reads
// into one of these on its own stack and never anywhere else.
union schinit_msg {
unsigned int op;
struct schinit_hello hello;
struct schinit_spawn spawn;
struct schinit_reply reply;
};
// The descriptor the supervisor inherits. Fixed rather than passed, because
// the supervisor is exec'd by PID 1 and there is nowhere to pass it -- and a
// well-known number is one less thing for the two to disagree about.
#define SCHINIT_SOCK_FD 3
#endif // SCHINIT_H