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