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