src/basic/exit-status.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2010 Lennart Poettering
   8 ***/
   9
  10 #include <stdbool.h>
  11
  12 #include "hashmap.h"
  13 #include "macro.h"
  14 #include "set.h"
  15
  16 /* This defines pretty names for the LSB 'start' verb exit codes. Note that they shouldn't be confused with the LSB
  17  * 'status' verb exit codes which are defined very differently. For details see:
  18  *
  19  * https://refspecs.linuxbase.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html
  20  */
  21
  22 enum {
  23         /* EXIT_SUCCESS defined by libc */
  24         /* EXIT_FAILURE defined by libc */
  25         EXIT_INVALIDARGUMENT = 2,
  26         EXIT_NOTIMPLEMENTED = 3,
  27         EXIT_NOPERMISSION = 4,
  28         EXIT_NOTINSTALLED = 5,
  29         EXIT_NOTCONFIGURED = 6,
  30         EXIT_NOTRUNNING = 7,
  31
  32         /* The LSB suggests that error codes >= 200 are "reserved". We
  33          * use them here under the assumption that they hence are
  34          * unused by init scripts. */
  35
  36         EXIT_CHDIR = 200,
  37         EXIT_NICE,
  38         EXIT_FDS,
  39         EXIT_EXEC,
  40         EXIT_MEMORY,
  41         EXIT_LIMITS,
  42         EXIT_OOM_ADJUST,
  43         EXIT_SIGNAL_MASK,
  44         EXIT_STDIN,
  45         EXIT_STDOUT,
  46         EXIT_CHROOT,   /* 210 */
  47         EXIT_IOPRIO,
  48         EXIT_TIMERSLACK,
  49         EXIT_SECUREBITS,
  50         EXIT_SETSCHEDULER,
  51         EXIT_CPUAFFINITY,
  52         EXIT_GROUP,
  53         EXIT_USER,
  54         EXIT_CAPABILITIES,
  55         EXIT_CGROUP,
  56         EXIT_SETSID,   /* 220 */
  57         EXIT_CONFIRM,
  58         EXIT_STDERR,
  59         _EXIT_RESERVED, /* used to be tcpwrap, don't reuse! */
  60         EXIT_PAM,
  61         EXIT_NETWORK,
  62         EXIT_NAMESPACE,
  63         EXIT_NO_NEW_PRIVILEGES,
  64         EXIT_SECCOMP,
  65         EXIT_SELINUX_CONTEXT,
  66         EXIT_PERSONALITY,  /* 230 */
  67         EXIT_APPARMOR_PROFILE,
  68         EXIT_ADDRESS_FAMILIES,
  69         EXIT_RUNTIME_DIRECTORY,
  70         _EXIT_RESERVED2, /* used to be used by kdbus, don't reuse */
  71         EXIT_CHOWN,
  72         EXIT_SMACK_PROCESS_LABEL,
  73         EXIT_KEYRING,
  74         EXIT_STATE_DIRECTORY,
  75         EXIT_CACHE_DIRECTORY,
  76         EXIT_LOGS_DIRECTORY, /* 240 */
  77         EXIT_CONFIGURATION_DIRECTORY,
  78 };
  79
  80 typedef enum ExitStatusLevel {
  81         EXIT_STATUS_MINIMAL,   /* only cover libc EXIT_STATUS/EXIT_FAILURE */
  82         EXIT_STATUS_SYSTEMD,   /* cover libc and systemd's own exit codes */
  83         EXIT_STATUS_LSB,       /* cover libc, systemd's own and LSB exit codes */
  84         EXIT_STATUS_FULL = EXIT_STATUS_LSB
  85 } ExitStatusLevel;
  86
  87 typedef struct ExitStatusSet {
  88         Set *status;
  89         Set *signal;
  90 } ExitStatusSet;
  91
  92 const char* exit_status_to_string(int status, ExitStatusLevel level) _const_;
  93
  94 typedef enum ExitClean {
  95         EXIT_CLEAN_DAEMON,
  96         EXIT_CLEAN_COMMAND,
  97 } ExitClean;
  98
  99 bool is_clean_exit(int code, int status, ExitClean clean, ExitStatusSet *success_status);
 100
 101 void exit_status_set_free(ExitStatusSet *x);
 102 bool exit_status_set_is_empty(ExitStatusSet *x);
 103 bool exit_status_set_test(ExitStatusSet *x, int code, int status);