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_KMSG,
  82         EXEC_OUTPUT_SOCKET,
  83         _EXEC_OUTPUT_MAX,
  84         _EXEC_OUTPUT_INVALID = -1
  85 } ExecOutput;
  86
  87 struct ExecStatus {
  88         dual_timestamp start_timestamp;
  89         dual_timestamp exit_timestamp;
  90         pid_t pid;
  91         int code;     /* as in siginfo_t::si_code */
  92         int status;   /* as in sigingo_t::si_status */
  93 };
  94
  95 struct ExecCommand {
  96         char *path;
  97         char **argv;
  98         ExecStatus exec_status;
  99         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
 100         bool ignore;
 101 };
 102
 103 struct ExecContext {
 104         char **environment;
 105         struct rlimit *rlimit[RLIMIT_NLIMITS];
 106         char *working_directory, *root_directory;
 107
 108         mode_t umask;
 109         int oom_score_adjust;
 110         int nice;
 111         int ioprio;
 112         int cpu_sched_policy;
 113         int cpu_sched_priority;
 114
 115         cpu_set_t *cpuset;
 116         unsigned cpuset_ncpus;
 117
 118         ExecInput std_input;
 119         ExecOutput std_output;
 120         ExecOutput std_error;
 121
 122         unsigned long timer_slack_nsec;
 123
 124         char *tcpwrap_name;
 125
 126         char *tty_path;
 127
 128         /* Since resolving these names might might involve socket
 129          * connections and we don't want to deadlock ourselves these
 130          * names are resolved on execution only and in the child
 131          * process. */
 132         char *user;
 133         char *group;
 134         char **supplementary_groups;
 135
 136         char *pam_name;
 137
 138         char *utmp_id;
 139
 140         char **read_write_dirs, **read_only_dirs, **inaccessible_dirs;
 141         unsigned long mount_flags;
 142
 143         uint64_t capability_bounding_set_drop;
 144
 145         /* Not relevant for spawning processes, just for killing */
 146         KillMode kill_mode;
 147         int kill_signal;
 148
 149         cap_t capabilities;
 150         int secure_bits;
 151
 152         int syslog_priority;
 153         char *syslog_identifier;
 154         bool syslog_level_prefix;
 155
 156         bool cpu_sched_reset_on_fork;
 157         bool non_blocking;
 158         bool private_tmp;
 159
 160         /* This is not exposed to the user but available
 161          * internally. We need it to make sure that whenever we spawn
 162          * /bin/mount it is run in the same process group as us so
 163          * that the autofs logic detects that it belongs to us and we
 164          * don't enter a trigger loop. */
 165         bool same_pgrp;
 166
 167         bool oom_score_adjust_set:1;
 168         bool nice_set:1;
 169         bool ioprio_set:1;
 170         bool cpu_sched_set:1;
 171         bool timer_slack_nsec_set:1;
 172 };
 173
 174 int exec_spawn(ExecCommand *command,
 175                char **argv,
 176                const ExecContext *context,
 177                int fds[], unsigned n_fds,
 178                char **environment,
 179                bool apply_permissions,
 180                bool apply_chroot,
 181                bool apply_tty_stdin,
 182                bool confirm_spawn,
 183                struct CGroupBonding *cgroup_bondings,
 184                pid_t *ret);
 185
 186 void exec_command_done(ExecCommand *c);
 187 void exec_command_done_array(ExecCommand *c, unsigned n);
 188
 189 void exec_command_free_list(ExecCommand *c);
 190 void exec_command_free_array(ExecCommand **c, unsigned n);
 191
 192 char *exec_command_line(char **argv);
 193
 194 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 195 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 196 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 197 int exec_command_set(ExecCommand *c, const char *path, ...);
 198
 199 void exec_context_init(ExecContext *c);
 200 void exec_context_done(ExecContext *c);
 201 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 202
 203 void exec_status_start(ExecStatus *s, pid_t pid);
 204 void exec_status_exit(ExecStatus *s, pid_t pid, int code, int status, const char *utmp_id);
 205 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 206
 207 const char* exec_output_to_string(ExecOutput i);
 208 int exec_output_from_string(const char *s);
 209
 210 const char* exec_input_to_string(ExecInput i);
 211 int exec_input_from_string(const char *s);
 212
 213 const char *kill_mode_to_string(KillMode k);
 214 KillMode kill_mode_from_string(const char *s);
 215
 216 const char *kill_who_to_string(KillWho k);
 217 KillWho kill_who_from_string(const char *s);
 218
 219 #endif