libos_signal.c

/* SPDX-License-Identifier: LGPL-3.0-or-later */
/* Copyright (C) 2014 Stony Brook University
 * Copyright (C) 2020 Intel Corporation
 *                    Borys Popławski <borysp@invisiblethingslab.com>
 */

/*
 * This file contains code for handling signals and exceptions passed from PAL.
 */

#include <stddef.h> /* needed by <linux/signal.h> for size_t */

#include <asm/signal.h>
#include <stdnoreturn.h>

#include "cpu.h"
#include "libos_checkpoint.h"
#include "libos_handle.h"
#include "libos_internal.h"
#include "libos_lock.h"
#include "libos_signal.h"
#include "libos_thread.h"
#include "libos_types.h"
#include "libos_utils.h"
#include "libos_vma.h"
#include "pal.h"
#include "toml_utils.h"

static bool g_check_invalid_ptrs = true;

void sigaction_make_defaults(struct __kernel_sigaction* sig_action) {
    sig_action->k_sa_handler = (void*)SIG_DFL;
    sig_action->sa_flags     = 0;
    sig_action->sa_restorer  = NULL;
    __sigemptyset(&sig_action->sa_mask);
}

void thread_sigaction_reset_on_execve(void) {
    struct libos_thread* current = get_cur_thread();

    lock(&current->signal_dispositions->lock);
    for (size_t i = 0; i < ARRAY_SIZE(current->signal_dispositions->actions); i++) {
        struct __kernel_sigaction* sig_action = &current->signal_dispositions->actions[i];

        __sighandler_t handler = sig_action->k_sa_handler;
        if (handler == (void*)SIG_DFL || handler == (void*)SIG_IGN) {
            /* POSIX.1: dispositions of any signals that are ignored or set to the default are left
             * unchanged. On Linux, this rule applies to SIGCHLD as well. */
            continue;
        }

        /* app installed its own signal handler, reset it to default */
        sigaction_make_defaults(sig_action);
    }
    unlock(&current->signal_dispositions->lock);
}

static noreturn void sighandler_kill(int sig) {
    log_debug("killed by signal %d", sig & ~__WCOREDUMP_BIT);
    process_exit(0, sig);
}

static noreturn void sighandler_core(int sig) {
    /* NOTE: This implementation only indicates the core dump for wait4()
     *       and friends. No actual core-dump file is created. */
    sig = __WCOREDUMP_BIT | sig;
    sighandler_kill(sig);
}

typedef enum {
    SIGHANDLER_NONE,
    SIGHANDLER_KILL,
    SIGHANDLER_CORE,
} SIGHANDLER_T;

static const SIGHANDLER_T default_sighandler[SIGS_CNT] = {
    [SIGHUP    - 1] = SIGHANDLER_KILL,
    [SIGINT    - 1] = SIGHANDLER_KILL,
    [SIGQUIT   - 1] = SIGHANDLER_CORE,
    [SIGILL    - 1] = SIGHANDLER_CORE,
    [SIGTRAP   - 1] = SIGHANDLER_CORE,
    [SIGABRT   - 1] = SIGHANDLER_CORE,
    [SIGBUS    - 1] = SIGHANDLER_CORE,
    [SIGFPE    - 1] = SIGHANDLER_CORE,
    [SIGKILL   - 1] = SIGHANDLER_KILL,
    [SIGUSR1   - 1] = SIGHANDLER_KILL,
    [SIGSEGV   - 1] = SIGHANDLER_CORE,
    [SIGUSR2   - 1] = SIGHANDLER_KILL,
    [SIGPIPE   - 1] = SIGHANDLER_KILL,
    [SIGALRM   - 1] = SIGHANDLER_KILL,
    [SIGTERM   - 1] = SIGHANDLER_KILL,
    [SIGSTKFLT - 1] = SIGHANDLER_KILL,
    [SIGCHLD   - 1] = SIGHANDLER_NONE,
    [SIGCONT   - 1] = SIGHANDLER_NONE,
    [SIGSTOP   - 1] = SIGHANDLER_NONE,
    [SIGTSTP   - 1] = SIGHANDLER_NONE,
    [SIGTTIN   - 1] = SIGHANDLER_NONE,
    [SIGTTOU   - 1] = SIGHANDLER_NONE,
    [SIGURG    - 1] = SIGHANDLER_NONE,
    [SIGXCPU   - 1] = SIGHANDLER_CORE,
    [SIGXFSZ   - 1] = SIGHANDLER_CORE,
    [SIGVTALRM - 1] = SIGHANDLER_KILL,
    [SIGPROF   - 1] = SIGHANDLER_KILL,
    [SIGWINCH  - 1] = SIGHANDLER_NONE,
    [SIGIO     - 1] = SIGHANDLER_KILL,
    [SIGPWR    - 1] = SIGHANDLER_KILL,
    [SIGSYS    - 1] = SIGHANDLER_CORE,
};


static struct libos_signal_queue g_process_signal_queue = {0};
/* This lock should always be taken after thread lock (if both are needed). */
static struct libos_lock g_process_signal_queue_lock;
/*
 * This is just an optimization, not to have to check the queue for pending signals. This field can
 * be read atomically without any locks, to get approximate value, but to get exact you need to take
 * appropriate lock. Every store should be both atomic and behind a lock.
 */
static uint64_t g_process_pending_signals_cnt = 0;

/*
 * If host signal injection is enabled, this stores the injected signal. Note that we currently
 * support injecting only 1 instance of 1 signal only once, as this feature is meant only for
 * graceful termination of the user application. Note that the only host-injected signal currently
 * supported is SIGTERM; see also `pop_unblocked_signal()`.
 */
static int g_host_injected_signal = 0;
static bool g_inject_host_signal_enabled = false;

static bool is_rt_sq_empty(struct libos_rt_signal_queue* queue) {
    return queue->get_idx == queue->put_idx;
}

static bool has_standard_signal(struct libos_signal* signal_slot) {
    return signal_slot->siginfo.si_signo != 0;
}

static void recalc_pending_mask(struct libos_signal_queue* queue, int sig) {
    if (sig < SIGRTMIN) {
        if (!has_standard_signal(&queue->standard_signals[sig - 1])) {
            __sigdelset(&queue->pending_mask, sig);
        }
    } else {
        if (is_rt_sq_empty(&queue->rt_signal_queues[sig - SIGRTMIN])) {
            __sigdelset(&queue->pending_mask, sig);
        }
    }
}

void get_all_pending_signals(__sigset_t* set) {
    struct libos_thread* current = get_cur_thread();

    __sigemptyset(set);

    if (__atomic_load_n(&current->pending_signals, __ATOMIC_ACQUIRE) == 0
            && __atomic_load_n(&g_process_pending_signals_cnt, __ATOMIC_ACQUIRE) == 0) {
        return;
    }

    lock(&current->lock);
    lock(&g_process_signal_queue_lock);

    __sigorset(set, &current->signal_queue.pending_mask, &g_process_signal_queue.pending_mask);

    unlock(&g_process_signal_queue_lock);
    unlock(&current->lock);
}

bool have_pending_signals(void) {
    struct libos_thread* current = get_cur_thread();
    __sigset_t set;
    get_all_pending_signals(&set);

    lock(&current->lock);
    __signotset(&set, &set, &current->signal_mask);
    unlock(&current->lock);

    return !__sigisemptyset(&set) || __atomic_load_n(&current->time_to_die, __ATOMIC_ACQUIRE);
}

static bool append_standard_signal(struct libos_signal* queue_slot, struct libos_signal* signal) {
    if (has_standard_signal(queue_slot)) {
        return false;
    }

    *queue_slot = *signal;
    return true;
}

static bool append_rt_signal(struct libos_rt_signal_queue* queue, struct libos_signal** signal) {
    assert(queue->get_idx <= queue->put_idx);
    if (queue->get_idx >= ARRAY_SIZE(queue->queue)) {
        queue->get_idx -= ARRAY_SIZE(queue->queue);
        queue->put_idx -= ARRAY_SIZE(queue->queue);
    }

    if (queue->put_idx - queue->get_idx >= ARRAY_SIZE(queue->queue)) {
        return false;
    }

    queue->queue[queue->put_idx % ARRAY_SIZE(queue->queue)] = *signal;
    *signal = NULL;
    queue->put_idx++;
    return true;
}

static bool queue_append_signal(struct libos_signal_queue* queue, struct libos_signal** signal) {
    int sig = (*signal)->siginfo.si_signo;

    bool ret = false;
    if (sig < 1 || sig > SIGS_CNT) {
        ret = false;
    } else if (sig < SIGRTMIN) {
        ret = append_standard_signal(&queue->standard_signals[sig - 1], *signal);
    } else {
        ret = append_rt_signal(&queue->rt_signal_queues[sig - SIGRTMIN], signal);
    }

    if (ret) {
        __sigaddset(&queue->pending_mask, sig);
    }

    return ret;
}

static bool append_thread_signal(struct libos_thread* thread, struct libos_signal** signal) {
    lock(&thread->lock);
    bool ret = queue_append_signal(&thread->signal_queue, signal);
    if (ret) {
        (void)__atomic_add_fetch(&thread->pending_signals, 1, __ATOMIC_RELEASE);
    }
    unlock(&thread->lock);
    return ret;
}

static bool append_process_signal(struct libos_signal** signal) {
    lock(&g_process_signal_queue_lock);
    bool ret = queue_append_signal(&g_process_signal_queue, signal);
    if (ret) {
        (void)__atomic_add_fetch(&g_process_pending_signals_cnt, 1, __ATOMIC_RELEASE);
    }
    unlock(&g_process_signal_queue_lock);
    return ret;
}

static bool pop_standard_signal(struct libos_signal* queue_slot, struct libos_signal* signal) {
    if (!has_standard_signal(queue_slot)) {
        return false;
    }

    /* Some signal is set, copy it. */
    *signal = *queue_slot;

    /* Mark slot as empty. */
    queue_slot->siginfo.si_signo = 0;

    return true;
}

static bool pop_rt_signal(struct libos_rt_signal_queue* queue, struct libos_signal** signal) {
    assert(queue->get_idx <= queue->put_idx);

    if (queue->get_idx < queue->put_idx) {
        *signal = queue->queue[queue->get_idx % ARRAY_SIZE(queue->queue)];
        queue->get_idx++;
        return true;
    }
    return false;
}

void free_signal_queue(struct libos_signal_queue* queue) {
    /* We ignore standard signals - they are stored by value. */

    for (int sig = SIGRTMIN; sig <= SIGS_CNT; sig++) {
        struct libos_signal* signal;
        while (pop_rt_signal(&queue->rt_signal_queues[sig - SIGRTMIN], &signal)) {
            free(signal);
        }
    }
}

static void force_signal(siginfo_t* info) {
    struct libos_thread* current = get_cur_thread();

    current->forced_signal.siginfo = *info;
}

static bool have_forced_signal(void) {
    struct libos_thread* current = get_cur_thread();
    return current->forced_signal.siginfo.si_signo != 0;
}

static void get_forced_signal(struct libos_signal* signal) {
    struct libos_thread* current = get_cur_thread();
    *signal = current->forced_signal;
    current->forced_signal.siginfo.si_signo = 0;
}

static bool context_is_libos(PAL_CONTEXT* context) {
    uintptr_t ip = pal_context_get_ip(context);

    return (uintptr_t)&__load_address <= ip && ip < (uintptr_t)&__load_address_end;
}

static noreturn void internal_fault(const char* errstr, uintptr_t addr, PAL_CONTEXT* context) {
    IDTYPE tid = get_cur_tid();
    uintptr_t ip = pal_context_get_ip(context);

    char buf[LOCATION_BUF_SIZE];
    libos_describe_location(ip, buf, sizeof(buf));

    log_error("%s at 0x%08lx (%s, VMID = %u, TID = %u)", errstr, addr, buf,
              g_process_ipc_ids.self_vmid, tid);

    DEBUG_BREAK_ON_FAILURE();
    PalProcessExit(1);
}

static void arithmetic_error_upcall(bool is_in_pal, uintptr_t addr, PAL_CONTEXT* context) {
    __UNUSED(is_in_pal);
    assert(!is_in_pal);
    assert(context);

    if (is_internal(get_cur_thread()) || context_is_libos(context)) {
        internal_fault("Internal arithmetic fault", addr, context);
    } else {
        log_debug("arithmetic fault at 0x%08lx", pal_context_get_ip(context));
        siginfo_t info = {
            .si_signo = SIGFPE,
            .si_code = FPE_INTDIV,
            .si_addr = (void*)addr,
        };
        force_signal(&info);
        handle_signal(context);
    }
}

static void memfault_upcall(bool is_in_pal, uintptr_t addr, PAL_CONTEXT* context) {
    __UNUSED(is_in_pal);
    assert(!is_in_pal);
    assert(context);

    if (is_internal(get_cur_thread()) || context_is_libos(context)) {
        internal_fault("Internal memory fault", addr, context);
    }

    log_debug("memory fault at 0x%08lx (IP = 0x%08lx)", addr, pal_context_get_ip(context));

    siginfo_t info = {
        .si_addr = (void*)addr,
    };
    struct libos_vma_info vma_info;
    if (!lookup_vma((void*)addr, &vma_info)) {
        if (vma_info.flags & VMA_INTERNAL) {
            internal_fault("Internal memory fault with VMA", addr, context);
        }
        struct libos_handle* file = vma_info.file;
        if (file && file->type == TYPE_CHROOT) {
            /* If the mapping exceeds end of a file then return a SIGBUS. */
            lock(&file->inode->lock);
            file_off_t size = file->inode->size;
            unlock(&file->inode->lock);

            uintptr_t eof_in_vma = (uintptr_t)vma_info.addr + (size - vma_info.file_offset);
            if (addr > eof_in_vma) {
                info.si_signo = SIGBUS;
                info.si_code = BUS_ADRERR;
            } else {
                info.si_signo = SIGSEGV;
                info.si_code = SEGV_ACCERR;
            }
        } else {
            info.si_signo = SIGSEGV;
            info.si_code = SEGV_ACCERR;
        }

        if (file) {
            put_handle(file);
        }
    } else {
        info.si_signo = SIGSEGV;
        info.si_code = SEGV_MAPERR;
    }

    force_signal(&info);
    handle_signal(context);
}

/*
 * Tests whether whole range of memory `[addr; addr+size)` is readable, or, if `writable` is true,
 * writable. The intended usage of this function is checking memory pointers passed to system calls.
 * Note that this does not check the accesses to the memory themselves and is only meant to handle
 * invalid syscall arguments (e.g. LTP test suite checks syscall arguments validation).
 */
static bool test_user_memory(const void* addr, size_t size, bool writable) {
    if (!access_ok(addr, size)) {
        return false;
    }

    return is_in_adjacent_user_vmas(addr, size, writable ? PROT_WRITE : PROT_READ);
}

bool is_user_memory_readable(const void* addr, size_t size) {
    if (!g_check_invalid_ptrs) {
        return true;
    }

    return test_user_memory(addr, size, /*writable=*/false);
}

bool is_user_memory_writable(const void* addr, size_t size) {
    if (!g_check_invalid_ptrs) {
        return true;
    }

    return test_user_memory(addr, size, /*writable=*/true);
}

bool is_user_memory_writable_no_skip(const void* addr, size_t size) {
    return test_user_memory(addr, size, /*writable=*/true);
}

/*
 * Equivalent to `is_user_memory_readable(addr, strlen(addr) + 1)`, but the string length does not
 * need to be known in advance.
 */
bool is_user_string_readable(const char* addr) {
    if (!g_check_invalid_ptrs) {
        return true;
    }

    const char* next_page_addr = (const char*)ALIGN_UP((uintptr_t)addr + 1, PAGE_SIZE);
    assert(next_page_addr != addr);

    /* `next_page_addr` could wrap around which by itself might not be an error, let `access_ok`
     * decide that. Subtracting these two pointers would be illegal in C though, hence the casts. */
    size_t len = (uintptr_t)next_page_addr - (uintptr_t)addr;
    while (1) {
        if (!access_ok(addr, len)) {
            return false;
        }
        if (!is_in_adjacent_user_vmas(addr, len, PROT_READ)) {
            return false;
        }

        if (strnlen(addr, len) != len) {
            /* String ended. */
            return true;
        }

        if (next_page_addr <= addr) {
            /* Do not wrap around address space. */
            return false;
        }

        addr = next_page_addr;
        next_page_addr += PAGE_SIZE;
        len = PAGE_SIZE;
    }
}

/* input: 
 *     context --> This holds the context for the exception that has occurred.
 * This function checks if the rip on which the exception is occuring is a valid 
 * opcode for in or out instruction.
 */
static bool is_in_out(PAL_CONTEXT* context) {
    unsigned char opcodes[] = {0xe4, 0xe5, 0xec, 0xed, 0xe6, 0xe7,
                               0xee, 0xef, 0x6c, 0x6d, 0x6e, 0x6f};
    int num_opcodes = sizeof(opcodes)/sizeof(opcodes[0]);
    uint8_t* rip = (uint8_t*)context->rip;
    for(int i=0;i<num_opcodes;i++) {
        if (rip[0] == opcodes[i]) {
            return true;
        }
    }
    return false;
}

static void illegal_upcall(bool is_in_pal, uintptr_t addr, PAL_CONTEXT* context) {
    __UNUSED(is_in_pal);
    assert(!is_in_pal);
    assert(context);

    struct libos_vma_info vma_info = {.file = NULL};
    if (is_internal(get_cur_thread()) || context_is_libos(context)
            || lookup_vma((void*)addr, &vma_info) || (vma_info.flags & VMA_INTERNAL)) {
        internal_fault("Illegal instruction during Gramine internal execution", addr, context);
    }

    if (vma_info.file) {
        put_handle(vma_info.file);
    }

    /* Emulate syscall instruction, which is prohibited in Linux-SGX PAL and raises a SIGILL. */
    if (!maybe_emulate_syscall(context)) {
        /* IN/OUT instruction aren't allowed in SGX enclaves. Usually #GP hardware exception
         * causes SIGSEGV and not SIGILL. This is required for lscpu to run. lscpu
         * executes in/out and expects SIGSEGV. lscpu is sometimes required in applications
         * that tries to get various information about cpus. This was required 
         * in some tensorflow application and that made it necessary to support
         * lscpu.
         */
        int signo;
        int si_code;
        if (is_in_out(context)) {
            signo = SIGSEGV;
            si_code = SEGV_MAPERR;
        } else {
            signo = SIGILL;
            si_code = ILL_ILLOPC;
        }
        void* rip = (void*)pal_context_get_ip(context);
        log_debug("Illegal instruction (or legal but unsupported instruction "\
                  "inside enclave) during app execution at %p; delivering to app", rip);
        siginfo_t info = {
            .si_signo = signo,
            .si_code = si_code,
            .si_addr = (void*)addr,
        };
        force_signal(&info);
        handle_signal(context);
    }
    /* else syscall was emulated. */
}

static void quit_upcall(bool is_in_pal, uintptr_t addr, PAL_CONTEXT* context) {
    __UNUSED(addr);

    if (!g_inject_host_signal_enabled) {
        return;
    }

    int sig = 0;
    static_assert(SAME_TYPE(g_host_injected_signal, sig), "types must match");
    if (!__atomic_compare_exchange_n(&g_host_injected_signal, &sig, SIGTERM,
                                     /*weak=*/false, __ATOMIC_RELAXED, __ATOMIC_RELAXED)) {
        /* We already have 1 injected signal, bail out. */
        return;
    }

    /* "quit" signal may occur during LibOS thread initialization (at which point `cur == NULL`) */
    struct libos_thread* cur = get_cur_thread();
    if (!cur || is_internal(cur) || context_is_libos(context) || is_in_pal) {
        return;
    }
    handle_signal(context);
}

static void interrupted_upcall(bool is_in_pal, uintptr_t addr, PAL_CONTEXT* context) {
    __UNUSED(addr);

    /* "interrupted" signal may occur during LibOS thread initialization (at which point
     * `cur == NULL`) */
    struct libos_thread* cur = get_cur_thread();
    if (!cur || is_internal(cur) || context_is_libos(context) || is_in_pal) {
        return;
    }
    handle_signal(context);
}

int init_signal_handling(void) {
    if (!create_lock(&g_process_signal_queue_lock)) {
        return -ENOMEM;
    }

    int ret = toml_bool_in(g_manifest_root, "sys.enable_sigterm_injection", /*defaultval=*/false,
                           &g_inject_host_signal_enabled);
    if (ret < 0) {
        log_error("Cannot parse 'sys.enable_sigterm_injection' (the value must be `true` or "
                  "`false`)");
        return -EINVAL;
    }

    ret = toml_bool_in(g_manifest_root, "libos.check_invalid_pointers", /*defaultval=*/true,
                       &g_check_invalid_ptrs);
    if (ret < 0) {
        log_error("Cannot parse 'libos.check_invalid_pointers' (the value must be `true` or "
                  "`false`)");
        return -EINVAL;
    }

    PalSetExceptionHandler(&arithmetic_error_upcall, PAL_EVENT_ARITHMETIC_ERROR);
    PalSetExceptionHandler(&memfault_upcall,         PAL_EVENT_MEMFAULT);
    PalSetExceptionHandler(&illegal_upcall,          PAL_EVENT_ILLEGAL);
    PalSetExceptionHandler(&quit_upcall,             PAL_EVENT_QUIT);
    PalSetExceptionHandler(&interrupted_upcall,      PAL_EVENT_INTERRUPTED);
    return 0;
}

void clear_illegal_signals(__sigset_t* set) {
    __sigdelset(set, SIGKILL);
    __sigdelset(set, SIGSTOP);
}

void get_sig_mask(struct libos_thread* thread, __sigset_t* mask) {
    assert(thread);

    *mask = thread->signal_mask;
}

void set_sig_mask(struct libos_thread* thread, const __sigset_t* set) {
    assert(thread);
    assert(set);
    assert(locked(&thread->lock));
    assert(thread == get_cur_thread() || !thread->pal_handle);

    thread->signal_mask = *set;
}

int set_user_sigmask(const __sigset_t* mask_ptr, size_t setsize) {
    if (!mask_ptr) {
        return 0;
    }
    if (setsize != sizeof(*mask_ptr)) {
        return -EINVAL;
    }
    if (!is_user_memory_readable(mask_ptr, sizeof(*mask_ptr))) {
        return -EFAULT;
    }

    __sigset_t mask = *mask_ptr;
    clear_illegal_signals(&mask);

    struct libos_thread* current = get_cur_thread();
    lock(&current->lock);
    assert(!current->has_saved_sigmask);
    current->saved_sigmask = current->signal_mask;
    current->has_saved_sigmask = true;
    set_sig_mask(current, &mask);
    unlock(&current->lock);

    return 0;
}

/* XXX: This function assumes that the stack is growing towards lower addresses. */
bool is_on_altstack(uintptr_t sp, stack_t* alt_stack) {
    uintptr_t alt_sp = (uintptr_t)alt_stack->ss_sp;
    uintptr_t alt_sp_end = alt_sp + alt_stack->ss_size;
    /*
     * If `alt_sp == sp` then either the alternative stack is full or we have another stack
     * allocated just above it (at lower address), which is empty and about to be used. Let's
     * pretend it is always the second case: overflowing the alternative stack is undefined behavior
     * and chances for reaching exactly the top of the stack without overflowing it are minimal.
     */
    if (alt_sp < sp && sp <= alt_sp_end) {
        return true;
    }
    return false;
}

/* XXX: This function assumes that the stack is growing towards lower addresses. */
uintptr_t get_stack_for_sighandler(uintptr_t sp, bool use_altstack) {
    struct libos_thread* current = get_cur_thread();
    stack_t* alt_stack = &current->signal_altstack;

    if (!use_altstack || alt_stack->ss_flags & SS_DISABLE || alt_stack->ss_size == 0) {
        /* No alternative stack. */
        return sp - RED_ZONE_SIZE;
    }

    if (is_on_altstack(sp, alt_stack)) {
        /* We are currently running on alternative stack - just reuse it. */
        return sp - RED_ZONE_SIZE;
    }

    return (uintptr_t)alt_stack->ss_sp + alt_stack->ss_size;
}

void pop_unblocked_signal(__sigset_t* mask, struct libos_signal* signal) {
    assert(signal);
    signal->siginfo.si_signo = 0;

    struct libos_thread* current = get_cur_thread();
    assert(current);

    if (__atomic_load_n(&current->pending_signals, __ATOMIC_ACQUIRE)
            || __atomic_load_n(&g_process_pending_signals_cnt, __ATOMIC_ACQUIRE)) {
        lock(&current->lock);
        lock(&g_process_signal_queue_lock);
        for (int sig = 1; sig <= SIGS_CNT; sig++) {
            if (!__sigismember(mask ? : &current->signal_mask, sig)) {
                bool got = false;
                bool was_process = false;
                /* First try to handle signals targeted at this thread, then processwide. */
                if (sig < SIGRTMIN) {
                    got = pop_standard_signal(&current->signal_queue.standard_signals[sig - 1],
                                              signal);
                    if (!got) {
                        got = pop_standard_signal(&g_process_signal_queue.standard_signals[sig - 1],
                                                  signal);
                        was_process = true;
                    }
                } else {
                    struct libos_signal* signal_ptr = NULL;
                    got = pop_rt_signal(&current->signal_queue.rt_signal_queues[sig - SIGRTMIN],
                                        &signal_ptr);
                    if (!got) {
                        assert(signal_ptr == NULL);
                        got =
                            pop_rt_signal(&g_process_signal_queue.rt_signal_queues[sig - SIGRTMIN],
                                          &signal_ptr);
                        was_process = true;
                    }
                    if (signal_ptr) {
                        assert(got);
                        *signal = *signal_ptr;
                        free(signal_ptr);
                    }
                }

                if (got) {
                    if (was_process) {
                        (void)__atomic_sub_fetch(&g_process_pending_signals_cnt, 1,
                                                 __ATOMIC_RELEASE);
                        recalc_pending_mask(&g_process_signal_queue, sig);
                    } else {
                        (void)__atomic_sub_fetch(&current->pending_signals, 1, __ATOMIC_RELEASE);
                        recalc_pending_mask(&current->signal_queue, sig);
                    }
                    break;
                }
            }
        }
        unlock(&g_process_signal_queue_lock);
        unlock(&current->lock);
    } else if (__atomic_load_n(&g_host_injected_signal, __ATOMIC_RELAXED) != 0) {
        static_assert(SIGS_CNT < 0xff, "This code requires 0xff to be an invalid signal number");
        lock(&current->lock);
        if (!__sigismember(mask ? : &current->signal_mask, SIGTERM)) {
            int sig = __atomic_exchange_n(&g_host_injected_signal, 0xff, __ATOMIC_RELAXED);
            if (sig != 0xff) {
                signal->siginfo.si_signo = sig;
                signal->siginfo.si_code = SI_USER;
            }
        }
        unlock(&current->lock);
    }
}

/*
 * XXX(borysp): This function handles one pending, non-blocked, non-ignored signal at a time, while,
 * I believe, normal Linux creates sigframes for all pending, non-blocked, non-ignored signals at
 * once.
 * Note: each signal handler (at least on Linux x86_64) issues a `rt_sigreturn` syscall to return
 * back to the normal context; upon intercepting this syscall by LibOS, `handle_signal` will be
 * called again. This way all pending, non-blocked, non-ignored signals will be handled one by one,
 * unless the user app changes context in any other way (e.g. `swapcontext`), in which case the next
 * signal might be delayed until the next issued syscall.
 */
bool handle_signal(PAL_CONTEXT* context) {
    struct libos_thread* current = get_cur_thread();
    assert(current);
    assert(!is_internal(current));
    assert(!context_is_libos(context)
           || pal_context_get_ip(context) == (uint64_t)&libos_syscall_entry);

    if (__atomic_load_n(&current->time_to_die, __ATOMIC_ACQUIRE)) {
        thread_exit(/*error_code=*/0, /*term_signal=*/0);
    }

    struct libos_signal signal = { 0 };
    if (have_forced_signal()) {
        get_forced_signal(&signal);
    } else {
        pop_unblocked_signal(/*mask=*/NULL, &signal);
    }

    int sig = signal.siginfo.si_signo;
    if (!sig) {
        return false;
    }

    bool ret = false;
    lock(&current->signal_dispositions->lock);
    struct __kernel_sigaction* sa = &current->signal_dispositions->actions[sig - 1];

    void* handler = sa->k_sa_handler;
    if (handler == SIG_DFL) {
        if (default_sighandler[sig - 1] == SIGHANDLER_KILL) {
            unlock(&current->signal_dispositions->lock);
            sighandler_kill(sig);
            /* Unreachable. */
        } else if (default_sighandler[sig - 1] == SIGHANDLER_CORE) {
            unlock(&current->signal_dispositions->lock);
            sighandler_core(sig);
            /* Unreachable. */
        }
        assert(default_sighandler[sig - 1] == SIGHANDLER_NONE);
        handler = SIG_IGN;
    }
    if (handler != SIG_IGN) {
        /* User provided handler. */
        long sysnr = libos_get_tcb()->context.syscall_nr;
        if (sysnr >= 0) {
            switch (pal_context_get_retval(context)) {
                case -ERESTARTNOHAND:
                    pal_context_set_retval(context, -EINTR);
                    break;
                case -ERESTARTSYS:
                    if (!(sa->sa_flags & SA_RESTART)) {
                        pal_context_set_retval(context, -EINTR);
                        break;
                    }
                    /* Fallthrough */
                case -ERESTARTNOINTR:
                    restart_syscall(context, (uint64_t)sysnr);
                    break;
                default:
                    break;
            }
        }

        __sigset_t new_mask = sa->sa_mask;
        if (!(sa->sa_flags & SA_NODEFER)) {
            __sigaddset(&new_mask, sig);
        }
        clear_illegal_signals(&new_mask);

        __sigset_t old_mask;
        lock(&current->lock);
        if (current->has_saved_sigmask) {
            old_mask = current->saved_sigmask;
            current->has_saved_sigmask = false;
        } else {
            get_sig_mask(current, &old_mask);
        }
        set_sig_mask(current, &new_mask);
        unlock(&current->lock);

        prepare_sigframe(context, &signal.siginfo, handler,
                         sa->sa_flags & SA_RESTORER ? sa->sa_restorer : NULL,
                         !!(sa->sa_flags & SA_ONSTACK), &old_mask);

        if (sa->sa_flags & SA_RESETHAND) {
            /* borysp: In my opinion it should be `sigaction_make_defaults(sa);`, but Linux does
             * this and LTP explicitly tests for this ... */
            sa->k_sa_handler = SIG_DFL;
        }

        ret = true;
    }
    unlock(&current->signal_dispositions->lock);

    if (!ret) {
        /* We have seen an ignored signal, retry. */
        return handle_signal(context);
    }

    return true;
}

int append_signal(struct libos_thread* thread, siginfo_t* info) {
    assert(info);

    // TODO: ignore SIGCHLD even if it's masked, when handler is set to SIG_IGN (probably not here)

    /* For real-time signal we save a pointer to a signal object, so we need to allocate it here.
     * If this is a standard signal, this will be freed at return from this function. */
    struct libos_signal* signal = malloc(sizeof(*signal));
    if (!signal) {
        return -ENOMEM;
    }

    signal->siginfo = *info;

    if (thread) {
        if (append_thread_signal(thread, &signal)) {
            goto out;
        }
    } else {
        if (append_process_signal(&signal)) {
            goto out;
        }
    }

    if (thread) {
        log_debug("Signal %d queue of thread %u is full, dropping incoming signal",
                  info->si_signo, thread->tid);
    } else {
        log_debug("Signal %d queue of process is full, dropping incoming signal", info->si_signo);
    }
    /* This is counter-intuitive, but we report success here: after all signal was successfully
     * delivered, just the queue was full. */
out:
    free(signal);
    return 0;
}

bool is_eintr_like(int ret) {
    assert(ret <= 0);
    switch (ret) {
        case -EINTR:
        case -ERESTARTSYS:
        case -ERESTARTNOINTR:
        case -ERESTARTNOHAND:
            return true;
        default:
            return false;
    }
}