src/execute.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   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 <linux/types.h>
  30 #include <sys/time.h>
  31 #include <sys/resource.h>
  32 #include <sys/capability.h>
  33 #include <stdbool.h>
  34 #include <stdio.h>
  35 #include <sched.h>
  36
  37 struct CGroupBonding;
  38
  39 #include "list.h"
  40 #include "util.h"
  41
  42 /* Abstract namespace! */
  43 #define LOGGER_SOCKET "/org/freedesktop/systemd1/logger"
  44
  45 /* This doesn't really belong here, but I couldn't find a better place to put this. */
  46 #define SIGNALS_CRASH_HANDLER SIGSEGV,SIGILL,SIGFPE,SIGBUS,SIGQUIT,SIGABRT
  47 #define SIGNALS_IGNORE SIGKILL,SIGPIPE
  48
  49 typedef enum KillMode {
  50         KILL_CONTROL_GROUP = 0,
  51         KILL_PROCESS_GROUP,
  52         KILL_PROCESS,
  53         KILL_NONE,
  54         _KILL_MODE_MAX,
  55         _KILL_MODE_INVALID = -1
  56 } KillMode;
  57
  58 typedef enum KillWho {
  59         KILL_MAIN,
  60         KILL_CONTROL,
  61         KILL_ALL,
  62         _KILL_WHO_MAX,
  63         _KILL_WHO_INVALID = -1
  64 } KillWho;
  65
  66 typedef enum ExecInput {
  67         EXEC_INPUT_NULL,
  68         EXEC_INPUT_TTY,
  69         EXEC_INPUT_TTY_FORCE,
  70         EXEC_INPUT_TTY_FAIL,
  71         EXEC_INPUT_SOCKET,
  72         _EXEC_INPUT_MAX,
  73         _EXEC_INPUT_INVALID = -1
  74 } ExecInput;
  75
  76 typedef enum ExecOutput {
  77         EXEC_OUTPUT_INHERIT,
  78         EXEC_OUTPUT_NULL,
  79         EXEC_OUTPUT_TTY,
  80         EXEC_OUTPUT_SYSLOG,
  81         EXEC_OUTPUT_SYSLOG_AND_CONSOLE,
  82         EXEC_OUTPUT_KMSG,
  83         EXEC_OUTPUT_KMSG_AND_CONSOLE,
  84         EXEC_OUTPUT_SOCKET,
  85         _EXEC_OUTPUT_MAX,
  86         _EXEC_OUTPUT_INVALID = -1
  87 } ExecOutput;
  88
  89 struct ExecStatus {
  90         dual_timestamp start_timestamp;
  91         dual_timestamp exit_timestamp;
  92         pid_t pid;
  93         int code;     /* as in siginfo_t::si_code */
  94         int status;   /* as in sigingo_t::si_status */
  95 };
  96
  97 struct ExecCommand {
  98         char *path;
  99         char **argv;
 100         ExecStatus exec_status;
 101         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
 102         bool ignore;
 103 };
 104
 105 struct ExecContext {
 106         char **environment;
 107         struct rlimit *rlimit[RLIMIT_NLIMITS];
 108         char *working_directory, *root_directory;
 109
 110         mode_t umask;
 111         int oom_score_adjust;
 112         int nice;
 113         int ioprio;
 114         int cpu_sched_policy;
 115         int cpu_sched_priority;
 116
 117         cpu_set_t *cpuset;
 118         unsigned cpuset_ncpus;
 119
 120         ExecInput std_input;
 121         ExecOutput std_output;
 122         ExecOutput std_error;
 123
 124         unsigned long timer_slack_nsec;
 125
 126         char *tcpwrap_name;
 127
 128         char *tty_path;
 129
 130         /* Since resolving these names might might involve socket
 131          * connections and we don't want to deadlock ourselves these
 132          * names are resolved on execution only and in the child
 133          * process. */
 134         char *user;
 135         char *group;
 136         char **supplementary_groups;
 137
 138         char *pam_name;
 139
 140         char *utmp_id;
 141
 142         char **read_write_dirs, **read_only_dirs, **inaccessible_dirs;
 143         unsigned long mount_flags;
 144
 145         uint64_t capability_bounding_set_drop;
 146
 147         /* Not relevant for spawning processes, just for killing */
 148         KillMode kill_mode;
 149         int kill_signal;
 150         bool send_sigkill;
 151
 152         cap_t capabilities;
 153         int secure_bits;
 154
 155         int syslog_priority;
 156         char *syslog_identifier;
 157         bool syslog_level_prefix;
 158
 159         bool cpu_sched_reset_on_fork;
 160         bool non_blocking;
 161         bool private_tmp;
 162
 163         /* This is not exposed to the user but available
 164          * internally. We need it to make sure that whenever we spawn
 165          * /bin/mount it is run in the same process group as us so
 166          * that the autofs logic detects that it belongs to us and we
 167          * don't enter a trigger loop. */
 168         bool same_pgrp;
 169
 170         bool oom_score_adjust_set:1;
 171         bool nice_set:1;
 172         bool ioprio_set:1;
 173         bool cpu_sched_set:1;
 174         bool timer_slack_nsec_set:1;
 175 };
 176
 177 int exec_spawn(ExecCommand *command,
 178                char **argv,
 179                const ExecContext *context,
 180                int fds[], unsigned n_fds,
 181                char **environment,
 182                bool apply_permissions,
 183                bool apply_chroot,
 184                bool apply_tty_stdin,
 185                bool confirm_spawn,
 186                struct CGroupBonding *cgroup_bondings,
 187                pid_t *ret);
 188
 189 void exec_command_done(ExecCommand *c);
 190 void exec_command_done_array(ExecCommand *c, unsigned n);
 191
 192 void exec_command_free_list(ExecCommand *c);
 193 void exec_command_free_array(ExecCommand **c, unsigned n);
 194
 195 char *exec_command_line(char **argv);
 196
 197 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 198 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 199 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 200 int exec_command_set(ExecCommand *c, const char *path, ...);
 201
 202 void exec_context_init(ExecContext *c);
 203 void exec_context_done(ExecContext *c);
 204 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 205
 206 void exec_status_start(ExecStatus *s, pid_t pid);
 207 void exec_status_exit(ExecStatus *s, pid_t pid, int code, int status, const char *utmp_id);
 208 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 209
 210 const char* exec_output_to_string(ExecOutput i);
 211 int exec_output_from_string(const char *s);
 212
 213 const char* exec_input_to_string(ExecInput i);
 214 int exec_input_from_string(const char *s);
 215
 216 const char *kill_mode_to_string(KillMode k);
 217 KillMode kill_mode_from_string(const char *s);
 218
 219 const char *kill_who_to_string(KillWho k);
 220 KillWho kill_who_from_string(const char *s);
 221
 222 #endif