posix_signal.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 The Zephyr Contributors
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_POSIX_POSIX_SIGNAL_H_
#define ZEPHYR_INCLUDE_POSIX_POSIX_SIGNAL_H_
 
#if defined(_POSIX_C_SOURCE) || defined(__DOXYGEN__)
 
#include <zephyr/kernel/signal.h>
#include <zephyr/toolchain.h>
#include <zephyr/sys/util.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* SIG_DFL must be defined by the libc signal.h */
/* SIG_ERR must be defined by the libc signal.h */
 
#if defined(_XOPEN_SOURCE) || defined(__DOXYGEN__)
#define SIG_HOLD ((void *)-2)
#endif
 
/* SIG_IGN must be defined by the libc signal.h */
 
#if defined(_POSIX_THREADS) || defined(__DOXYGEN__)
 
#if !defined(_PTHREAD_T_DECLARED) && !defined(__pthread_t_defined)
typedef unsigned int pthread_t;
#define _PTHREAD_T_DECLARED
#define __pthread_t_defined
#endif
 
#endif /* defined(_POSIX_THREADS) || defined(__DOXYGEN__) */
 
/* size_t must be defined by the libc stddef.h */
#include <stddef.h>
#include <stdint.h>
 
#if !defined(_UID_T_DECLARED) && !defined(__uid_t_defined)
typedef int uid_t;
#define _UID_T_DECLARED
#define __uid_t_defined
#endif
 
/* time_t must be defined by the libc time.h */
#include <time.h>
 
#if __STDC_VERSION__ >= 201112L
/* struct timespec must be defined in the libc time.h */
#else
#if !defined(_TIMESPEC_DECLARED) && !defined(__timespec_defined)
struct timespec {
    time_t tv_sec;
    long tv_nsec;
};
#define _TIMESPEC_DECLARED
#define __timespec_defined
#endif
#endif
 
/* sig_atomic_t must be defined by the libc signal.h */
 
/*
 * Linux/glibc NPTL: reserve 32 (cancel) and 33; RT signals from 34.
 * The prior value 32 followed Newlib/Picolibc Cygwin targets (compact
 * sigset_t); Zephyr sizes sigset_t from SIGNAL_SET_SIZE_MIN_POSIX_REALTIME.
 */
#ifndef SIGRTMIN
#define SIGRTMIN (CONFIG_THREAD_CANCEL_SIGNAL_NUMBER + 2)
#endif
#if defined(_POSIX_REALTIME_SIGNALS) || defined(__DOXYGEN__)
BUILD_ASSERT(CONFIG_POSIX_RTSIG_MAX >= 0);
BUILD_ASSERT((CONFIG_THREAD_CANCEL_SIGNAL_NUMBER + 2 +
          CONFIG_POSIX_RTSIG_MAX) <= SIGNAL_SET_SIZE);
#ifndef SIGRTMAX
#define SIGRTMAX (SIGRTMIN + CONFIG_POSIX_RTSIG_MAX)
#endif
#else
#ifndef SIGRTMAX
#define SIGRTMAX SIGRTMIN
#endif
#endif
 
#if !defined(_SIGSET_T_DECLARED) && !defined(__sigset_t_defined)
typedef struct {
    unsigned long sig[DIV_ROUND_UP(SIGRTMAX, BITS_PER_LONG)];
} sigset_t;
#define _SIGSET_T_DECLARED
#define __sigset_t_defined
#endif
 
#if !defined(_PID_T_DECLARED) && !defined(__pid_t_defined)
typedef long pid_t;
#define _PID_T_DECLARED
#define __pid_t_defined
#endif
 
#if defined(_POSIX_THREADS) || defined(__DOXYGEN__)
 
/* must be identical to the definition in <sys/_pthreadtypes.h> */
#if !defined(_PTHREAD_ATTR_T_DECLARED) && !defined(__pthread_attr_t_defined)
typedef struct {
    void *stack;
    size_t stacksize;
    size_t guardsize;
    uint32_t details;
} pthread_attr_t;
#define _PTHREAD_ATTR_T_DECLARED
#define __pthread_attr_t_defined
#endif
 
#endif
 
/* slightly out of order w.r.t. the specification */
#if !defined(_SIGVAL_DECLARED) && !defined(__sigval_defined)
union sigval {
    int sival_int;   
    void *sival_ptr; 
};
#define _SIGVAL_DECLARED
#define __sigval_defined
#endif
 
/*
 * POSIX.1-2017 defines struct sigevent and the SIGEV_* constants in the base <signal.h>
 * (they are not part of the Realtime Signals option), so they are visible here without
 * _POSIX_REALTIME_SIGNALS.
 */
#if !defined(_SIGEVENT_DECLARED) && !defined(__sigevent_defined)
struct sigevent {
#if defined(_POSIX_THREADS) || defined(__DOXYGEN__)
    pthread_attr_t *sigev_notify_attributes; 
    void (*sigev_notify_function)(union sigval value); 
#endif
    union sigval sigev_value;  
    int sigev_notify;          
    int sigev_signo;           
    pid_t sigev_notify_thread_id;
};
#define _SIGEVENT_DECLARED
#define __sigevent_defined
#endif
 
#define SIGEV_NONE   1
#define SIGEV_SIGNAL 2
#define SIGEV_THREAD 3
#if defined(_GNU_SOURCE) || defined(__ZEPHYR__) || defined(__DOXYGEN__)
#define SIGEV_THREAD_ID 4
#endif
 
/* Signal constants are defined below */
 
/* SIGRTMIN and SIGRTMAX defined above */
 
/* slightly out of order w.r.t. the specification */
#if !defined(_SIGINFO_T_DECLARED) && !defined(__siginfo_t_defined)
typedef struct {
    void *si_addr;           
#if defined(_XOPEN_STREAMS) || defined(__DOXYGEN__)
    long si_band;            
#endif
    union sigval si_value;   
    pid_t si_pid;            
    uid_t si_uid;            
    int si_signo;            
    int si_code;             
#if defined(_XOPEN_SOURCE) || defined(__DOXYGEN__)
    int si_errno;            
#endif
    int si_status;           
} siginfo_t;
#define _SIGINFO_T_DECLARED
#define __siginfo_t_defined
#endif
 
#if !defined(_SIGACTION_DECLARED) && !defined(__sigaction_defined)
struct sigaction {
    union {
        void (*sa_handler)(int sig);                          
        void (*sa_sigaction)(int sig, siginfo_t *info, void *context); 
    };
    sigset_t sa_mask;   
    int sa_flags;       
};
#define _SIGACTION_DECLARED
#define __sigaction_defined
#endif
 
#define SIG_BLOCK   1
#define SIG_UNBLOCK 2
#define SIG_SETMASK 0
 
#if defined(_XOPEN_SOURCE) || defined(__DOXYGEN__)
#define SA_NOCLDSTOP 0x00000001
#define SA_ONSTACK   0x00000002
#endif
#define SA_RESETHAND 0x00000004
#define SA_RESTART   0x00000008
#define SA_SIGINFO   0x00000010
#if defined(_XOPEN_SOURCE) || defined(__DOXYGEN__)
#define SA_NOCLDWAIT 0x00000020
#endif
#define SA_NODEFER  0x00000040
 
#if defined(_XOPEN_SOURCE) || defined(__DOXYGEN__)
 
#define SS_ONSTACK  0x00000001
#define SS_DISABLE  0x00000002
#define MINSIGSTKSZ 4096
#define SIGSTKSZ    4096
 
#if !defined(_MCONTEXT_T_DECLARED) && !defined(__mcontext_t_defined)
typedef struct {
    /* FIXME: there should be a much better Zephyr-specific structure that can be used here */
    unsigned long gregs[32]; 
    unsigned long flags;     
} mcontext_t;
#define _MCONTEXT_T_DECLARED
#define __mcontext_defined
#endif
 
/* slightly out of order w.r.t. the specification */
#if !defined(_STACK_T_DECLARED) && !defined(__stack_t_defined)
typedef struct {
    void *ss_sp;      
    size_t ss_size;   
    int ss_flags;     
} stack_t;
#define _STACK_T_DECLARED
#define __stack_t_defined
#endif
 
#if !defined(_UCONTEXT_T_DECLARED) && !defined(__ucontext_t_defined)
typedef struct {
    struct ucontext *uc_link;  
    sigset_t uc_sigmask;       
    stack_t uc_stack;          
    mcontext_t uc_mcontext;    
} ucontext_t;
#define _UCONTEXT_T_DECLARED
#define __ucontext_defined
#endif
 
#endif /* defined(_XOPEN_SOURCE) || defined(__DOXYGEN__) */
 
/* Siginfo codes are defined below */
 
#if !defined(_SIGHANDLER_T_DECLARED) && !defined(__sighandler_t_defined)
typedef void (*sighandler_t)(int sig);
#define _SIGHANDLER_T_DECLARED
#define __sighandler_t_defined
#endif
 
int kill(pid_t pid, int sig);
 
#if defined(_XOPEN_SOURCE) || defined(__DOXYGEN__)
int killpg(pid_t pgrp, int sig);
#endif
 
void psiginfo(const siginfo_t *info, const char *message);
 
void psignal(int sig, const char *message);
 
#if defined(_POSIX_THREADS) || defined(__DOXYGEN__)
int pthread_kill(pthread_t thread, int sig);
 
int pthread_sigmask(int how, const sigset_t *ZRESTRICT set, sigset_t *ZRESTRICT oset);
#endif
 
TOOLCHAIN_DISABLE_WARNING(TOOLCHAIN_WARNING_SHADOW);
int sigaction(int sig, const struct sigaction *ZRESTRICT act, struct sigaction *ZRESTRICT oact);
TOOLCHAIN_ENABLE_WARNING(TOOLCHAIN_WARNING_SHADOW);
 
int sigaddset(sigset_t *set, int sig);
 
#if defined(_XOPEN_SOURCE) || defined(__DOXYGEN__)
int sigaltstack(const stack_t *ZRESTRICT ss, stack_t *ZRESTRICT oss);
#endif
 
int sigdelset(sigset_t *set, int sig);
 
int sigemptyset(sigset_t *set);
 
int sigfillset(sigset_t *set);
 
#if defined(_XOPEN_SOURCE) || defined(__DOXYGEN__)
int sighold(int sig);
 
int sigignore(int sig);
 
int siginterrupt(int sig, int flag);
#endif
 
int sigismember(const sigset_t *set, int sig);
 
#if defined(_XOPEN_SOURCE) || defined(__DOXYGEN__)
int sigpause(int sig);
#endif
 
int sigpending(sigset_t *set);
 
int sigprocmask(int how, const sigset_t *ZRESTRICT set, sigset_t *ZRESTRICT oset);
 
#if defined(_POSIX_REALTIME_SIGNALS) || defined(__DOXYGEN__)
int sigqueue(pid_t pid, int sig, union sigval value);
#endif
 
#if defined(_XOPEN_SOURCE) || defined(__DOXYGEN__)
int sigrelse(int sig);
 
sighandler_t sigset(int sig, sighandler_t disp);
#endif
 
int sigsuspend(const sigset_t *set);
 
#if defined(_POSIX_REALTIME_SIGNALS) || defined(__DOXYGEN__)
int sigtimedwait(const sigset_t *ZRESTRICT set, siginfo_t *ZRESTRICT info,
         const struct timespec *ZRESTRICT timeout);
#endif
 
int sigwait(const sigset_t *ZRESTRICT set, int *ZRESTRICT sig);
 
#if defined(_POSIX_REALTIME_SIGNALS) || defined(__DOXYGEN__)
int sigwaitinfo(const sigset_t *ZRESTRICT set, siginfo_t *ZRESTRICT info);
#endif
 
/* Note: only ANSI / ISO C signals are guarded below */
 
#define SIGHUP 1 
#if !defined(SIGINT) || defined(__DOXYGEN__)
#define SIGINT 2 
#endif
#define SIGQUIT 3 
#if !defined(SIGILL) || defined(__DOXYGEN__)
#define SIGILL 4 
#endif
#define SIGTRAP 5 
#if !defined(SIGABRT) || defined(__DOXYGEN__)
#define SIGABRT 6 
#endif
#define SIGBUS 7 
#if !defined(SIGFPE) || defined(__DOXYGEN__)
#define SIGFPE 8 
#endif
#define SIGKILL 9  
#define SIGUSR1 10 
#if !defined(SIGSEGV) || defined(__DOXYGEN__)
#define SIGSEGV 11 
#endif
#define SIGUSR2 12 
#define SIGPIPE 13 
#define SIGALRM 14 
#if !defined(SIGTERM) || defined(__DOXYGEN__)
#define SIGTERM 15 
#endif
/* 16 not used */
#define SIGCHLD   17 
#define SIGCONT   18 
#define SIGSTOP   19 
#define SIGTSTP   20 
#define SIGTTIN   21 
#define SIGTTOU   22 
#define SIGURG    23 
#define SIGXCPU   24 
#define SIGXFSZ   25 
#define SIGVTALRM 26 
#define SIGPROF   27 
/* 28 not used */
#define SIGPOLL   29 
/* 30 not used */
#define SIGSYS    31 
#if defined(_POSIX_REALTIME_SIGNALS) || defined(__DOXYGEN__)
 
/* SIGILL */
#define ILL_ILLOPC 1 
#define ILL_ILLOPN 2 
#define ILL_ILLADR 3 
#define ILL_ILLTRP 4 
#define ILL_PRVOPC 5 
#define ILL_PRVREG 6 
#define ILL_COPROC 7 
#define ILL_BADSTK 8 
/* SIGFPE */
#define FPE_INTDIV 9  
#define FPE_INTOVF 10 
#define FPE_FLTDIV 11 
#define FPE_FLTOVF 12 
#define FPE_FLTUND 13 
#define FPE_FLTRES 15 
#define FPE_FLTINV 16 
#define FPE_FLTSUB 17 
/* SIGSEGV */
#define SEGV_MAPERR 18 
#define SEGV_ACCERR 19 
/* SIGBUS */
#define BUS_ADRALN 20 
#define BUS_ADRERR 21 
#define BUS_OBJERR 22 
#if defined(_XOPEN_SOURCE) || defined(__DOXYGEN__)
/* SIGTRAP */
#define TRAP_BRKPT 23 
#define TRAP_TRACE 24 
#endif
 
/* SIGCHLD si_code values */
#define CLD_EXITED    K_SI_CLD_EXITED    
#define CLD_KILLED    K_SI_CLD_KILLED    
#define CLD_DUMPED    K_SI_CLD_DUMPED    
#define CLD_TRAPPED   K_SI_CLD_TRAPPED   
#define CLD_STOPPED   K_SI_CLD_STOPPED   
#define CLD_CONTINUED K_SI_CLD_CONTINUED 
#if defined(_XOPEN_STREAMS) || defined(__DOXYGEN__)
/* SIGPOLL */
#define POLL_IN  31 
#define POLL_OUT 32 
#define POLL_MSG 33 
#define POLL_ERR 34 
#define POLL_PRI 35 
#define POLL_HUP 36 
#endif
 
/* Any */
#define SI_USER    37 
#define SI_QUEUE   38 
#define SI_TIMER   39 
#define SI_ASYNCIO 40 
#define SI_MESGQ   41 
#endif
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* defined(_POSIX_C_SOURCE) || defined(__DOXYGEN__) */
 
#endif /* ZEPHYR_INCLUDE_POSIX_POSIX_SIGNAL_H_ */