src/execute.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   2
   3 #ifndef fooexecutehfoo
   4 #define fooexecutehfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU General Public License as published by
  13   the Free Software Foundation; either version 2 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 typedef struct ExecStatus ExecStatus;
  26 typedef struct ExecCommand ExecCommand;
  27 typedef struct ExecContext ExecContext;
  28
  29 #include <sys/time.h>
  30 #include <sys/resource.h>
  31 #include <sys/capability.h>
  32 #include <stdbool.h>
  33 #include <stdio.h>
  34 #include <sched.h>
  35
  36 struct CGroupBonding;
  37
  38 #include "list.h"
  39 #include "util.h"
  40
  41 /* Abstract namespace! */
  42 #define LOGGER_SOCKET "/org/freedesktop/systemd1/logger"
  43
  44 /* This doesn't really belong here, but I couldn't find a better place to put this. */
  45 #define SIGNALS_CRASH_HANDLER SIGSEGV,SIGILL,SIGFPE,SIGBUS,SIGQUIT,SIGABRT
  46 #define SIGNALS_IGNORE SIGKILL,SIGPIPE
  47
  48 typedef enum ExecInput {
  49         EXEC_INPUT_NULL,
  50         EXEC_INPUT_TTY,
  51         EXEC_INPUT_TTY_FORCE,
  52         EXEC_INPUT_TTY_FAIL,
  53         EXEC_INPUT_SOCKET,
  54         _EXEC_INPUT_MAX,
  55         _EXEC_INPUT_INVALID = -1
  56 } ExecInput;
  57
  58 typedef enum ExecOutput {
  59         EXEC_OUTPUT_INHERIT,
  60         EXEC_OUTPUT_NULL,
  61         EXEC_OUTPUT_TTY,
  62         EXEC_OUTPUT_SYSLOG,
  63         EXEC_OUTPUT_KMSG,
  64         EXEC_OUTPUT_SOCKET,
  65         _EXEC_OUTPUT_MAX,
  66         _EXEC_OUTPUT_INVALID = -1
  67 } ExecOutput;
  68
  69 struct ExecStatus {
  70         usec_t start_timestamp;
  71         usec_t exit_timestamp;
  72         pid_t pid;
  73         int code;     /* as in siginfo_t::si_code */
  74         int status;   /* as in sigingo_t::si_status */
  75 };
  76
  77 struct ExecCommand {
  78         char *path;
  79         char **argv;
  80         ExecStatus exec_status;
  81         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  82 };
  83
  84 struct ExecContext {
  85         char **environment;
  86         struct rlimit *rlimit[RLIMIT_NLIMITS];
  87         char *working_directory, *root_directory;
  88
  89         mode_t umask;
  90         int oom_adjust;
  91         int nice;
  92         int ioprio;
  93         int cpu_sched_policy;
  94         int cpu_sched_priority;
  95
  96         cpu_set_t cpu_affinity;
  97         unsigned long timer_slack_ns;
  98
  99         ExecInput std_input;
 100         ExecOutput std_output;
 101         ExecOutput std_error;
 102
 103         int syslog_priority;
 104         char *syslog_identifier;
 105         bool syslog_no_prefix;
 106
 107         char *tcpwrap_name;
 108
 109         char *tty_path;
 110
 111         /* Since resolving these names might might involve socket
 112          * connections and we don't want to deadlock ourselves these
 113          * names are resolved on execution only and in the child
 114          * process. */
 115         char *user;
 116         char *group;
 117         char **supplementary_groups;
 118
 119         char **read_write_dirs, **read_only_dirs, **inaccessible_dirs;
 120         unsigned long mount_flags;
 121
 122         uint64_t capability_bounding_set_drop;
 123
 124         cap_t capabilities;
 125         int secure_bits;
 126
 127         bool cpu_sched_reset_on_fork;
 128         bool non_blocking;
 129         bool private_tmp;
 130
 131         bool oom_adjust_set:1;
 132         bool nice_set:1;
 133         bool ioprio_set:1;
 134         bool cpu_sched_set:1;
 135         bool cpu_affinity_set:1;
 136         bool timer_slack_ns_set:1;
 137
 138         /* This is not exposed to the user but available
 139          * internally. We need it to make sure that whenever we spawn
 140          * /bin/mount it is run in the same process group as us so
 141          * that the autofs logic detects that it belongs to us and we
 142          * don't enter a trigger loop. */
 143         bool no_setsid:1;
 144 };
 145
 146 typedef enum ExitStatus {
 147         /* EXIT_SUCCESS defined by libc */
 148         /* EXIT_FAILURE defined by libc */
 149         EXIT_INVALIDARGUMENT = 2,
 150         EXIT_NOTIMPLEMENTED = 3,
 151         EXIT_NOPERMISSION = 4,
 152         EXIT_NOTINSTALLED = 5,
 153         EXIT_NOTCONFIGURED = 6,
 154         EXIT_NOTRUNNING = 7,
 155
 156         /* The LSB suggests that error codes >= 200 are "reserved". We
 157          * use them here under the assumption that they hence are
 158          * unused by init scripts.
 159          *
 160          * http://refspecs.freestandards.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html */
 161
 162         EXIT_CHDIR = 200,
 163         EXIT_NICE,
 164         EXIT_FDS,
 165         EXIT_EXEC,
 166         EXIT_MEMORY,
 167         EXIT_LIMITS,
 168         EXIT_OOM_ADJUST,
 169         EXIT_SIGNAL_MASK,
 170         EXIT_STDIN,
 171         EXIT_STDOUT,
 172         EXIT_CHROOT,   /* 210 */
 173         EXIT_IOPRIO,
 174         EXIT_TIMERSLACK,
 175         EXIT_SECUREBITS,
 176         EXIT_SETSCHEDULER,
 177         EXIT_CPUAFFINITY,
 178         EXIT_GROUP,
 179         EXIT_USER,
 180         EXIT_CAPABILITIES,
 181         EXIT_CGROUP,
 182         EXIT_SETSID,   /* 220 */
 183         EXIT_CONFIRM,
 184         EXIT_STDERR,
 185         EXIT_TCPWRAP
 186
 187 } ExitStatus;
 188
 189 int exec_spawn(ExecCommand *command,
 190                char **argv,
 191                const ExecContext *context,
 192                int fds[], unsigned n_fds,
 193                char **environment,
 194                bool apply_permissions,
 195                bool apply_chroot,
 196                bool confirm_spawn,
 197                struct CGroupBonding *cgroup_bondings,
 198                pid_t *ret);
 199
 200 void exec_command_done(ExecCommand *c);
 201 void exec_command_done_array(ExecCommand *c, unsigned n);
 202
 203 void exec_command_free_list(ExecCommand *c);
 204 void exec_command_free_array(ExecCommand **c, unsigned n);
 205
 206 char *exec_command_line(char **argv);
 207
 208 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 209 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 210 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 211 int exec_command_set(ExecCommand *c, const char *path, ...);
 212
 213 void exec_context_init(ExecContext *c);
 214 void exec_context_done(ExecContext *c);
 215 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 216
 217 void exec_status_fill(ExecStatus *s, pid_t pid, int code, int status);
 218 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 219
 220 const char* exec_output_to_string(ExecOutput i);
 221 int exec_output_from_string(const char *s);
 222
 223 const char* exec_input_to_string(ExecInput i);
 224 int exec_input_from_string(const char *s);
 225
 226 const char* exit_status_to_string(ExitStatus status);
 227
 228 #endif