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 KillMode {
  49         KILL_CONTROL_GROUP = 0,
  50         KILL_PROCESS_GROUP,
  51         KILL_PROCESS,
  52         KILL_NONE,
  53         _KILL_MODE_MAX,
  54         _KILL_MODE_INVALID = -1
  55 } KillMode;
  56
  57 typedef enum ExecInput {
  58         EXEC_INPUT_NULL,
  59         EXEC_INPUT_TTY,
  60         EXEC_INPUT_TTY_FORCE,
  61         EXEC_INPUT_TTY_FAIL,
  62         EXEC_INPUT_SOCKET,
  63         _EXEC_INPUT_MAX,
  64         _EXEC_INPUT_INVALID = -1
  65 } ExecInput;
  66
  67 typedef enum ExecOutput {
  68         EXEC_OUTPUT_INHERIT,
  69         EXEC_OUTPUT_NULL,
  70         EXEC_OUTPUT_TTY,
  71         EXEC_OUTPUT_SYSLOG,
  72         EXEC_OUTPUT_KMSG,
  73         EXEC_OUTPUT_SOCKET,
  74         _EXEC_OUTPUT_MAX,
  75         _EXEC_OUTPUT_INVALID = -1
  76 } ExecOutput;
  77
  78 struct ExecStatus {
  79         dual_timestamp start_timestamp;
  80         dual_timestamp exit_timestamp;
  81         pid_t pid;
  82         int code;     /* as in siginfo_t::si_code */
  83         int status;   /* as in sigingo_t::si_status */
  84 };
  85
  86 struct ExecCommand {
  87         char *path;
  88         char **argv;
  89         ExecStatus exec_status;
  90         bool ignore;
  91         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  92 };
  93
  94 struct ExecContext {
  95         char **environment;
  96         struct rlimit *rlimit[RLIMIT_NLIMITS];
  97         char *working_directory, *root_directory;
  98
  99         mode_t umask;
 100         int oom_adjust;
 101         int nice;
 102         int ioprio;
 103         int cpu_sched_policy;
 104         int cpu_sched_priority;
 105
 106         cpu_set_t *cpuset;
 107         unsigned cpuset_ncpus;
 108         unsigned long timer_slack_nsec;
 109
 110         ExecInput std_input;
 111         ExecOutput std_output;
 112         ExecOutput std_error;
 113
 114         int syslog_priority;
 115         char *syslog_identifier;
 116         bool syslog_level_prefix;
 117
 118         char *tcpwrap_name;
 119
 120         char *tty_path;
 121
 122         /* Since resolving these names might might involve socket
 123          * connections and we don't want to deadlock ourselves these
 124          * names are resolved on execution only and in the child
 125          * process. */
 126         char *user;
 127         char *group;
 128         char **supplementary_groups;
 129
 130         char *pam_name;
 131
 132         char **read_write_dirs, **read_only_dirs, **inaccessible_dirs;
 133         unsigned long mount_flags;
 134
 135         uint64_t capability_bounding_set_drop;
 136
 137         cap_t capabilities;
 138         int secure_bits;
 139
 140         bool cpu_sched_reset_on_fork;
 141         bool non_blocking;
 142         bool private_tmp;
 143
 144         bool oom_adjust_set:1;
 145         bool nice_set:1;
 146         bool ioprio_set:1;
 147         bool cpu_sched_set:1;
 148         bool timer_slack_nsec_set:1;
 149
 150         /* This is not exposed to the user but available
 151          * internally. We need it to make sure that whenever we spawn
 152          * /bin/mount it is run in the same process group as us so
 153          * that the autofs logic detects that it belongs to us and we
 154          * don't enter a trigger loop. */
 155         bool same_pgrp;
 156
 157         /* Not relevant for spawning processes, just for killing */
 158         KillMode kill_mode;
 159         int kill_signal;
 160 };
 161
 162 typedef enum ExitStatus {
 163         /* EXIT_SUCCESS defined by libc */
 164         /* EXIT_FAILURE defined by libc */
 165         EXIT_INVALIDARGUMENT = 2,
 166         EXIT_NOTIMPLEMENTED = 3,
 167         EXIT_NOPERMISSION = 4,
 168         EXIT_NOTINSTALLED = 5,
 169         EXIT_NOTCONFIGURED = 6,
 170         EXIT_NOTRUNNING = 7,
 171
 172         /* The LSB suggests that error codes >= 200 are "reserved". We
 173          * use them here under the assumption that they hence are
 174          * unused by init scripts.
 175          *
 176          * http://refspecs.freestandards.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html */
 177
 178         EXIT_CHDIR = 200,
 179         EXIT_NICE,
 180         EXIT_FDS,
 181         EXIT_EXEC,
 182         EXIT_MEMORY,
 183         EXIT_LIMITS,
 184         EXIT_OOM_ADJUST,
 185         EXIT_SIGNAL_MASK,
 186         EXIT_STDIN,
 187         EXIT_STDOUT,
 188         EXIT_CHROOT,   /* 210 */
 189         EXIT_IOPRIO,
 190         EXIT_TIMERSLACK,
 191         EXIT_SECUREBITS,
 192         EXIT_SETSCHEDULER,
 193         EXIT_CPUAFFINITY,
 194         EXIT_GROUP,
 195         EXIT_USER,
 196         EXIT_CAPABILITIES,
 197         EXIT_CGROUP,
 198         EXIT_SETSID,   /* 220 */
 199         EXIT_CONFIRM,
 200         EXIT_STDERR,
 201         EXIT_TCPWRAP,
 202         EXIT_PAM
 203
 204 } ExitStatus;
 205
 206 int exec_spawn(ExecCommand *command,
 207                char **argv,
 208                const ExecContext *context,
 209                int fds[], unsigned n_fds,
 210                char **environment,
 211                bool apply_permissions,
 212                bool apply_chroot,
 213                bool apply_tty_stdin,
 214                bool confirm_spawn,
 215                struct CGroupBonding *cgroup_bondings,
 216                pid_t *ret);
 217
 218 void exec_command_done(ExecCommand *c);
 219 void exec_command_done_array(ExecCommand *c, unsigned n);
 220
 221 void exec_command_free_list(ExecCommand *c);
 222 void exec_command_free_array(ExecCommand **c, unsigned n);
 223
 224 char *exec_command_line(char **argv);
 225
 226 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 227 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 228 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 229 int exec_command_set(ExecCommand *c, const char *path, ...);
 230
 231 void exec_context_init(ExecContext *c);
 232 void exec_context_done(ExecContext *c);
 233 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 234
 235 void exec_status_start(ExecStatus *s, pid_t pid);
 236 void exec_status_exit(ExecStatus *s, pid_t pid, int code, int status);
 237 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 238
 239 const char* exec_output_to_string(ExecOutput i);
 240 int exec_output_from_string(const char *s);
 241
 242 const char* exec_input_to_string(ExecInput i);
 243 int exec_input_from_string(const char *s);
 244
 245 const char* exit_status_to_string(ExitStatus status);
 246
 247 #endif