src/core/execute.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 typedef struct ExecStatus ExecStatus;
  25 typedef struct ExecCommand ExecCommand;
  26 typedef struct ExecContext ExecContext;
  27 typedef struct ExecRuntime ExecRuntime;
  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 #include "list.h"
  38 #include "util.h"
  39 #include "set.h"
  40 #include "fdset.h"
  41
  42 typedef enum ExecInput {
  43         EXEC_INPUT_NULL,
  44         EXEC_INPUT_TTY,
  45         EXEC_INPUT_TTY_FORCE,
  46         EXEC_INPUT_TTY_FAIL,
  47         EXEC_INPUT_SOCKET,
  48         _EXEC_INPUT_MAX,
  49         _EXEC_INPUT_INVALID = -1
  50 } ExecInput;
  51
  52 typedef enum ExecOutput {
  53         EXEC_OUTPUT_INHERIT,
  54         EXEC_OUTPUT_NULL,
  55         EXEC_OUTPUT_TTY,
  56         EXEC_OUTPUT_SYSLOG,
  57         EXEC_OUTPUT_SYSLOG_AND_CONSOLE,
  58         EXEC_OUTPUT_KMSG,
  59         EXEC_OUTPUT_KMSG_AND_CONSOLE,
  60         EXEC_OUTPUT_JOURNAL,
  61         EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
  62         EXEC_OUTPUT_SOCKET,
  63         _EXEC_OUTPUT_MAX,
  64         _EXEC_OUTPUT_INVALID = -1
  65 } ExecOutput;
  66
  67 struct ExecStatus {
  68         dual_timestamp start_timestamp;
  69         dual_timestamp exit_timestamp;
  70         pid_t pid;
  71         int code;     /* as in siginfo_t::si_code */
  72         int status;   /* as in sigingo_t::si_status */
  73 };
  74
  75 struct ExecCommand {
  76         char *path;
  77         char **argv;
  78         ExecStatus exec_status;
  79         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  80         bool ignore;
  81 };
  82
  83 struct ExecRuntime {
  84         int n_ref;
  85
  86         char *tmp_dir;
  87         char *var_tmp_dir;
  88
  89         int netns_storage_socket[2];
  90 };
  91
  92 struct ExecContext {
  93         char **environment;
  94         char **environment_files;
  95
  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         nsec_t timer_slack_nsec;
 114
 115         char *tcpwrap_name;
 116
 117         char *tty_path;
 118
 119         bool tty_reset;
 120         bool tty_vhangup;
 121         bool tty_vt_disallocate;
 122
 123         bool ignore_sigpipe;
 124
 125         /* Since resolving these names might might involve socket
 126          * connections and we don't want to deadlock ourselves these
 127          * names are resolved on execution only and in the child
 128          * process. */
 129         char *user;
 130         char *group;
 131         char **supplementary_groups;
 132
 133         char *pam_name;
 134
 135         char *utmp_id;
 136
 137         bool selinux_context_ignore;
 138         char *selinux_context;
 139
 140         bool apparmor_profile_ignore;
 141         char *apparmor_profile;
 142
 143         char **read_write_dirs, **read_only_dirs, **inaccessible_dirs;
 144         unsigned long mount_flags;
 145
 146         uint64_t capability_bounding_set_drop;
 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         bool private_network;
 159         bool private_devices;
 160
 161         bool no_new_privileges;
 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         unsigned long personality;
 171
 172         Set *syscall_filter;
 173         Set *syscall_archs;
 174         int syscall_errno;
 175         bool syscall_whitelist:1;
 176
 177         Set *address_families;
 178         bool address_families_whitelist:1;
 179
 180         bool oom_score_adjust_set:1;
 181         bool nice_set:1;
 182         bool ioprio_set:1;
 183         bool cpu_sched_set:1;
 184 };
 185
 186 #include "cgroup.h"
 187
 188 int exec_spawn(ExecCommand *command,
 189                char **argv,
 190                ExecContext *context,
 191                int fds[], unsigned n_fds,
 192                char **environment,
 193                bool apply_permissions,
 194                bool apply_chroot,
 195                bool apply_tty_stdin,
 196                bool confirm_spawn,
 197                CGroupControllerMask cgroup_mask,
 198                const char *cgroup_path,
 199                const char *unit_id,
 200                usec_t watchdog_usec,
 201                int pipe_fd[2],
 202                ExecRuntime *runtime,
 203                pid_t *ret);
 204
 205 void exec_command_done(ExecCommand *c);
 206 void exec_command_done_array(ExecCommand *c, unsigned n);
 207
 208 void exec_command_free_list(ExecCommand *c);
 209 void exec_command_free_array(ExecCommand **c, unsigned n);
 210
 211 char *exec_command_line(char **argv);
 212
 213 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 214 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 215 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 216 int exec_command_set(ExecCommand *c, const char *path, ...);
 217
 218 void exec_context_init(ExecContext *c);
 219 void exec_context_done(ExecContext *c);
 220 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 221
 222 int exec_context_load_environment(const ExecContext *c, char ***l);
 223
 224 bool exec_context_may_touch_console(ExecContext *c);
 225
 226 void exec_status_start(ExecStatus *s, pid_t pid);
 227 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 228 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 229
 230 int exec_runtime_make(ExecRuntime **rt, ExecContext *c, const char *id);
 231 ExecRuntime *exec_runtime_ref(ExecRuntime *r);
 232 ExecRuntime *exec_runtime_unref(ExecRuntime *r);
 233
 234 int exec_runtime_serialize(ExecRuntime *rt, Unit *u, FILE *f, FDSet *fds);
 235 int exec_runtime_deserialize_item(ExecRuntime **rt, Unit *u, const char *key, const char *value, FDSet *fds);
 236
 237 void exec_runtime_destroy(ExecRuntime *rt);
 238
 239 const char* exec_output_to_string(ExecOutput i) _const_;
 240 ExecOutput exec_output_from_string(const char *s) _pure_;
 241
 242 const char* exec_input_to_string(ExecInput i) _const_;
 243 ExecInput exec_input_from_string(const char *s) _pure_;