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 <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         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  91         bool ignore;
  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_score_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
 109         ExecInput std_input;
 110         ExecOutput std_output;
 111         ExecOutput std_error;
 112
 113         unsigned long timer_slack_nsec;
 114
 115         char *tcpwrap_name;
 116
 117         char *tty_path;
 118
 119         /* Since resolving these names might might involve socket
 120          * connections and we don't want to deadlock ourselves these
 121          * names are resolved on execution only and in the child
 122          * process. */
 123         char *user;
 124         char *group;
 125         char **supplementary_groups;
 126
 127         char *pam_name;
 128
 129         char **read_write_dirs, **read_only_dirs, **inaccessible_dirs;
 130         unsigned long mount_flags;
 131
 132         uint64_t capability_bounding_set_drop;
 133
 134         /* Not relevant for spawning processes, just for killing */
 135         KillMode kill_mode;
 136         int kill_signal;
 137
 138         cap_t capabilities;
 139         int secure_bits;
 140
 141         int syslog_priority;
 142         char *syslog_identifier;
 143         bool syslog_level_prefix;
 144
 145         bool cpu_sched_reset_on_fork;
 146         bool non_blocking;
 147         bool private_tmp;
 148
 149         /* This is not exposed to the user but available
 150          * internally. We need it to make sure that whenever we spawn
 151          * /bin/mount it is run in the same process group as us so
 152          * that the autofs logic detects that it belongs to us and we
 153          * don't enter a trigger loop. */
 154         bool same_pgrp;
 155
 156         bool oom_score_adjust_set:1;
 157         bool nice_set:1;
 158         bool ioprio_set:1;
 159         bool cpu_sched_set:1;
 160         bool timer_slack_nsec_set:1;
 161 };
 162
 163 int exec_spawn(ExecCommand *command,
 164                char **argv,
 165                const ExecContext *context,
 166                int fds[], unsigned n_fds,
 167                char **environment,
 168                bool apply_permissions,
 169                bool apply_chroot,
 170                bool apply_tty_stdin,
 171                bool confirm_spawn,
 172                struct CGroupBonding *cgroup_bondings,
 173                pid_t *ret);
 174
 175 void exec_command_done(ExecCommand *c);
 176 void exec_command_done_array(ExecCommand *c, unsigned n);
 177
 178 void exec_command_free_list(ExecCommand *c);
 179 void exec_command_free_array(ExecCommand **c, unsigned n);
 180
 181 char *exec_command_line(char **argv);
 182
 183 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 184 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 185 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 186 int exec_command_set(ExecCommand *c, const char *path, ...);
 187
 188 void exec_context_init(ExecContext *c);
 189 void exec_context_done(ExecContext *c);
 190 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 191
 192 void exec_status_start(ExecStatus *s, pid_t pid);
 193 void exec_status_exit(ExecStatus *s, pid_t pid, int code, int status);
 194 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 195
 196 const char* exec_output_to_string(ExecOutput i);
 197 int exec_output_from_string(const char *s);
 198
 199 const char* exec_input_to_string(ExecInput i);
 200 int exec_input_from_string(const char *s);
 201
 202 #endif