Skip to content

Lightpanda: the headless browser designed for AI and automation

6.2 KB
Raw Blame
// Copyright (C) 2023-2025  Lightpanda (Selecy SAS)
//
// Francis Bouvier <[email protected]>
// Pierre Tachoire <[email protected]>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

//! This structure processes operating system signals (SIGINT, SIGTERM)
//! and runs callbacks to clean up the system gracefully.
//!
//! The structure does not clear the memory allocated in the arena,
//! clear the entire arena when exiting the program.
const std = @import("std");
const lp = @import("lightpanda");

const log = lp.log;
const assert = std.debug.assert;
const Allocator = std.mem.Allocator;

const SigHandler = @This();

arena: Allocator,

sigset: std.posix.sigset_t = undefined,
handle_thread: ?std.Thread = null,

attempt: u32 = 0,
mutex: std.Io.Mutex = .init,
listeners: std.ArrayList(Listener) = .empty,
/// Set by long-running interactive modes (e.g. the agent REPL) to opt out
/// of the second-tap hard-exit. Ctrl-C then behaves like Python's REPL:
/// listeners fire, the process never dies from signals — `/quit` exits.
no_hard_exit: bool = false,

const Listener = struct {
    args: []const u8,
    start: *const fn (context: *const anyopaque) void,
};

pub fn install(self: *SigHandler) !void {
    // Block these signals for the current thread and all created from it.
    // SIGALRM is included so arm() can wake the sighandler thread on a deadline.
    self.sigset = std.posix.sigemptyset();
    std.posix.sigaddset(&self.sigset, std.posix.SIG.INT);
    std.posix.sigaddset(&self.sigset, std.posix.SIG.TERM);
    std.posix.sigaddset(&self.sigset, std.posix.SIG.QUIT);
    std.posix.sigaddset(&self.sigset, std.posix.SIG.ALRM);
    std.posix.sigprocmask(std.posix.SIG.BLOCK, &self.sigset, null);

    self.handle_thread = try std.Thread.spawn(.{ .allocator = self.arena }, SigHandler.sighandle, .{self});
    self.handle_thread.?.detach();
}

const itimerval = extern struct {
    interval: std.c.timeval,
    value: std.c.timeval,
};
const ITIMER_REAL: c_int = 0;
extern "c" fn setitimer(which: c_int, new_value: *const itimerval, old_value: ?*itimerval) c_int;

/// Schedule a SIGALRM after `ms` milliseconds, which wakes the sighandler
/// thread and runs the registered listeners. Used to enforce --terminate-ms.
pub fn deadline(_: *SigHandler, ms: u32) !void {
    const it = itimerval{
        .interval = .{ .sec = 0, .usec = 0 },
        .value = .{
            .sec = @intCast(ms / std.time.ms_per_s),
            .usec = @intCast((ms % std.time.ms_per_s) * std.time.us_per_ms),
        },
    };
    if (setitimer(ITIMER_REAL, &it, null) != 0) {
        return error.SetItimerFailed;
    }
}

pub fn on(self: *SigHandler, func: anytype, args: std.meta.ArgsTuple(@TypeOf(func))) !void {
    assert(@typeInfo(@TypeOf(func)).@"fn".return_type.? == void);

    const Args = @TypeOf(args);
    const TypeErased = struct {
        fn start(context: *const anyopaque) void {
            const args_casted: *const Args = @ptrCast(@alignCast(context));
            @call(.auto, func, args_casted.*);
        }
    };

    const buffer = try self.arena.alignedAlloc(u8, .of(Args), @sizeOf(Args));
    errdefer self.arena.free(buffer);

    const bytes: []const u8 = @ptrCast((&args)[0..1]);
    @memcpy(buffer, bytes);

    self.mutex.lockUncancelable(lp.io);
    defer self.mutex.unlock(lp.io);

    try self.listeners.append(self.arena, .{
        .args = buffer,
        .start = TypeErased.start,
    });

    // If a termination signal arrived before this listener was registered,
    // the sighandler thread had nothing to call. Fire the new listener now
    // so the shutdown isn't lost — otherwise main proceeds into the network
    // run loop and the process becomes an orphan that ignores the signal.
    if (self.attempt > 0) {
        const item = &self.listeners.items[self.listeners.items.len - 1];
        item.start(item.args.ptr);
    }
}

fn sighandle(self: *SigHandler) noreturn {
    while (true) {
        var sig: c_int = 0;

        const rc = std.c.sigwait(&self.sigset, &sig);
        if (rc != 0) {
            log.err(.app, "Unable to process signal {}", .{rc});
            std.process.exit(1);
        }

        switch (@as(std.posix.SIG, @fromBackingInt(@intCast(sig)))) {
            .INT, .TERM => {
                self.mutex.lockUncancelable(lp.io);
                if (self.attempt > 1 and !self.no_hard_exit) {
                    self.mutex.unlock(lp.io);
                    std.process.exit(1);
                }
                // While `no_hard_exit` is set, cap the counter so a later
                // flip back to false (e.g. agent-suspend/resume) doesn't
                // immediately hard-exit on the next signal.
                if (self.no_hard_exit) self.attempt = 1 else self.attempt += 1;

                log.info(.app, "Received termination signal...", .{});
                for (self.listeners.items) |*item| {
                    item.start(item.args.ptr);
                }
                self.mutex.unlock(lp.io);
                continue;
            },
            .ALRM => {
                // Deadline tripped (e.g. --terminate-ms). Run the same listeners,
                // but don't bump `attempt` — a subsequent ctrl-c should still get
                // the normal first-attempt graceful path before hard-exiting.
                self.mutex.lockUncancelable(lp.io);
                defer self.mutex.unlock(lp.io);
                log.info(.app, "Deadline reached ", .{});
                for (self.listeners.items) |*item| {
                    item.start(item.args.ptr);
                }
                continue;
            },
            else => continue,
        }
    }
}