Fixing Ctrl+C in Rust terminal apps: Child process management

https://www.fiveonefour.com/blog/Fixing-ctrl-c-in-terminal-apps-child-process-management

by Callicles • 12 months ago

110 58 12 months ago

fiveonefour.com

windowshopping• 12 months ago

This title was close to being a garden path sentence, but ultimately avoided it.

abnercoimbre• 12 months ago

Tell more about garden paths in this context, I'm curious!

xoxxala• 12 months ago

I had no idea what a garden path sentence was, too, but wiki to the rescue:

https://en.wikipedia.org/wiki/Garden-path_sentence

impish9208• 12 months ago

Yes, daemonized children must always be killed; preferably by the parent, but any reaper would also work.

oatsandsugar3• 12 months ago

Is that a forking path sentence? If so, whoosh.

alt2275• 12 months ago

I have never undestood why garden path sentences are interesting. They can always be rewritten to make more obvious sense. Its like saying theres a way to take any sentence and remove some words to make its intended meaning confusing. I dont personally find this interesting, just frustrating that the author didnt take more time to use punctuation or more words to convey explicit meaning.

anp• 12 months ago

I’ve definitely seen all of these problems in Rust programs but they certainly aren’t limited to Rust programs. I do think it would be nice if Rust libraries were a bit more misuse-resistant when it came to preserving a coherent terminal.

I also long for a more misuse-resistant terminal but that seems like a bigger problem.

koakuma-chan• 12 months ago

Are you saying that after the main process has exited, child processes can still run and write to stdout/stderr?

Callicles• 12 months ago

I believe I am saying child processes can write to stdout as the main process is shutting down. Also, if the child processes are not shut down properly and are left dangling, and the child processes were set up as 'inherit' to be able to write directly to stdout/stderr then yes.

duped4• 12 months ago

Yes, this is easy to test too:

    #include <stdio.h>
    #include <unistd.h>
    #include <sys/types.h>
    int main() {
        pid_t pid = fork();
        if (pid == 0) {
            sleep(1);
            printf("after parent died!\n");
            return 0;
        }
        return 0;
    }

You'll see the message printed out 1 second after the process ends.

CGamesPlay2• 12 months ago

Child processes are created using, generally, 2 syscalls: fork, then exec. When you fork, all file descriptors the main process has open are copied, and are now open in two places. Then, when the child calls exec (to transform itself into the target program), all file descriptors stay open in the new process (unless a specific fd is explicitly configured otherwise, FD_CLOEXEC).

Standard output are just file descriptors with the number 0, 1, and 2, and you can use the dup2 syscall to assign those numbers to some pipes that you originally created before you fork. Now the standard output of your child process is going to those pipes in your parent process. Or you can close those file descriptors, which will prevent the child process from reading/writing them at all. Or you can do nothing, and the copied file descriptors from the parent still apply.

Conceptually, you think of "spawning a child" as something that is in some kind of container (the parent process), but the underlying mechanics are not like this at all, and processes don't actually exist in a "tree", they just happen to keep a record of their "parent process ID" so the OS knows who to notify when the process dies.

burnt-resistor2• 12 months ago

fork() when followed by exec*() is generally inefficient. That's why vfork(), clone(), and clone3() exist. There's no point in duplicating (even CoW) the entire kernel side and libc internal state of a process if it's going to be replaced with exec*() by a new, unrelated process.

zokier2• 12 months ago

Conceptually, you think of "spawning a child" as something that is in some kind of container (the parent process), but the underlying mechanics are not like this at all,

That is not quite right either, the newly created child processes generally go to the same process group as the parent, the process groups (and sessions) forming those "containers".

Tbh this is one of the many murky areas of UNIX.

vlovich123• 12 months ago

Nothing here is specific to Rust and applies to any terminal app in any language that spawns a child process.

stonogo• 12 months ago

Nothing, that is, except for the examples, the source code, the libraries, and the linked references. But nothing else.

dwattttt3• 12 months ago

Are you suggesting that the examples, source, libraries, and references for Rust make these mistakes, but other languages don't?

alt2275• 12 months ago

So none of this should be fixed in Rust just because others have the same problems?

npalli• 12 months ago

Fearless concurrency with Rust unless you are worried about lifecycle management, threads/co-operation and general ergonomics. Even modern c++ might be better at this (gasp!) with std::jthread

psyclobe• 12 months ago

Heretic!

dwattttt3• 12 months ago

I believe Rust's std::thread::scope is an equivalent.

Unlike non-scoped threads, scoped threads can borrow non-'static data, as the scope guarantees all threads will be joined at the end of the scope.
All threads spawned within the scope that haven’t been manually joined will be automatically joined before this function returns.

tialaramex• 12 months ago

So, std::jthread is basically fixing std::thread. In C++ it's difficult to fix broken standard library features so they just make a new thing and discard the old busted one. Landfill programming.

The fact Rust actually has scoped threads is unrelated, in Rust they can do this because they have working lifetime checking and in C++ such a feature would be meaningless, you're always assumed to have manually ensured the correct lifetimes and they aren't checked.

Generously you could say they're gesturing at the fact C++ decided to bolt the stop flag mechanic to jthreads, so you can have the old broken threads or this newer non-broken threads which also has built-in stop flags. But that's less choice, it's not as though you can't have a stop flag in Rust.

duped4• 12 months ago

Are there any languages that provide for or care about lifecycle management across address space boundaries? After fork() you're usually fucked and need explicit controls.

zokier2• 12 months ago

Pythons multiprocessing comes to mind

jeffbee• 12 months ago

Yes, and if you update to a version of LLVM that was released literally a week ago, jthread exists.

imtringued• 12 months ago

Ok, but I am literally getting filtered by installing C++ libraries. I haven't accomplished anything in the last 5 days other than determine that the previous libraries are not usable.

duped4• 12 months ago

The graceful shutdown stuff is good, but always piping the output of child processes is not necessarily the right thing to do. Some processes need stdin (what if it's a shell?) and some processes will be checking if stdout is a tty. What you should do (and Rust doesn't make this easy) is allocate a new pty for your child processes if your own stdout is a tty. Some programs default to this (eg: ssh), others make it configurable (eg: docker).

You're also missing the standard techniques for managing and reaping your children, which I don't see mentioned. You don't need to maintain a registry of child processes for example, at least on Linux there are a few things you can do for this without any global state (PR_SET_PDEATHSIG, PR_SET_CHILD_SUBREAPER, PID namespaces). On MacOS you can write a routine to reap children like a linux init() process would. The registry approach is also fragile: what if library code spawns children?

Also, if the terminal is in raw mode then you'll never get ctrl+C. This is really about signal handling. You also can't gracefully shutdown if you get a SIGKILL, which is why PR_SET_PDEATHSIG and PID namespaces are very nice - they guarantee descendants get killed.

wpollock• 12 months ago

Also, if the terminal is in raw mode then you'll never get ctrl+C.

The process/thread/task won't receive SIGINT, true. But I believe it will see the character ETX (ASCII 3). Programs that use raw mode input need to do their own keystroke processing.

duped4• 12 months ago

If you're in raw mode, whether ^C is SIGINT is open for interpretation

mmastrac• 12 months ago

Don't use PR_SET_PDEATHSIG. That way lies pain.

rendaw• 12 months ago

I hate to be the guy, but I could barely see the code snippets. Is contrast an issue for anyone else? Reader mode improves thins slightly but at the cost of code being unhighlighted and wrapping like crazy.

burnt-resistor2• 12 months ago

LGTM on a MBP + Brave browser.

dxdm• 12 months ago

Yes, the contrast of the code examples is not great. Grey on grey, light pastels and orange does not combine into an easy-to-read color palette for me.

chrismorgan• 12 months ago

The highlighting is clearly designed for a dark background but has been given a light background in light mode. Change the bg-neutral-100 to bg-neutral-900 and it’s fine—still not magnificent, but fine.

(But as for barely… if you don’t run JS, then you just don’t see the code snippets, because for some inscrutable reason, unlike the rest of the document, they’re only rendered client-side.)

mook• 12 months ago

I believe the real fun is when doing this on Windows, because it doesn't use Unix signals (and generally speaking you only get the equivalent of SIGKILL but not SIGTERM, but you can opt into ~SIGINT). I was hoping this would actually deal with that…

silon42• 12 months ago

It seems wrong that the app would be responsible for cleanup... Shouldn't this be solved in the shell / terminal ? What if kill -9?

pjerem3• 12 months ago

When you use ctrl+c, you are not killing the program, you are sending it a SIGTERM signal which essentially means « could you please stop yourself ? » so the program have a chance to clean things before exiting.

kill -9 is sending a SIGKILL signal which, well, kills the program immediately.

Vogtinator• 12 months ago

ctrl-c sends SIGINT.

sfoley• 12 months ago

SIGINT, not SIGTERM.

mprovost3• 12 months ago

Handling SIGINT (ctrl-c) with child processes is tricky, but a more pervasive problem for Rust CLI programs is handling SIGPIPE. For historical reasons the compiler adds a signal handler before calling main() which ignores SIGPIPE. It means when you pipe your Rust CLI program's output to something like head, instead of being killed by the signal sent when head closes the pipe, you get a write error and usually print an error message instead of silently dying. You can match on the type of write error and skip printing a message when it's from a broken pipe, but a more subtle problem is that the shell sets the exit status of a program killed by a signal to 128 + the signal number, so 141 in the case of a broken pipe. You can emulate this behaviour by checking for a broken pipe and explicitly exiting with a 141 status code, but it's not possible to fully reproduce being killed by a signal. There's been an issue to make this configurable (the latest proposal is via a compiler flag) for years.

aidenn02• 12 months ago

That's good to know; ysh[1] will treat pipelines with a SIGPIPE indicative exit code as successful to allow e.g.

  foo |head -n2

to be treated as successful. I haven't seen anyone complaining yet about rust programs breaking this idiom, but I'll keep an eye out for it.

1: https://oils.pub/release/latest/doc/ysh-tour.html

mprovost3• 12 months ago

In other shells, the status of the pipeline is the exit status of the last process, so in this case that would be head which exits with 0.

Fixing Ctrl+C in Rust terminal apps: Child process management

Related Stories