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 #ifdef HAVE_SECCOMP
  37 #include <seccomp.h>
  38
  39 #include "set.h"
  40 #endif
  41
  42 #include "list.h"
  43 #include "util.h"
  44 #include "fdset.h"
  45
  46 typedef enum ExecInput {
  47         EXEC_INPUT_NULL,
  48         EXEC_INPUT_TTY,
  49         EXEC_INPUT_TTY_FORCE,
  50         EXEC_INPUT_TTY_FAIL,
  51         EXEC_INPUT_SOCKET,
  52         _EXEC_INPUT_MAX,
  53         _EXEC_INPUT_INVALID = -1
  54 } ExecInput;
  55
  56 typedef enum ExecOutput {
  57         EXEC_OUTPUT_INHERIT,
  58         EXEC_OUTPUT_NULL,
  59         EXEC_OUTPUT_TTY,
  60         EXEC_OUTPUT_SYSLOG,
  61         EXEC_OUTPUT_SYSLOG_AND_CONSOLE,
  62         EXEC_OUTPUT_KMSG,
  63         EXEC_OUTPUT_KMSG_AND_CONSOLE,
  64         EXEC_OUTPUT_JOURNAL,
  65         EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
  66         EXEC_OUTPUT_SOCKET,
  67         _EXEC_OUTPUT_MAX,
  68         _EXEC_OUTPUT_INVALID = -1
  69 } ExecOutput;
  70
  71 struct ExecStatus {
  72         dual_timestamp start_timestamp;
  73         dual_timestamp exit_timestamp;
  74         pid_t pid;
  75         int code;     /* as in siginfo_t::si_code */
  76         int status;   /* as in sigingo_t::si_status */
  77 };
  78
  79 struct ExecCommand {
  80         char *path;
  81         char **argv;
  82         ExecStatus exec_status;
  83         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  84         bool ignore;
  85 };
  86
  87 struct ExecRuntime {
  88         int n_ref;
  89
  90         char *tmp_dir;
  91         char *var_tmp_dir;
  92
  93         int netns_storage_socket[2];
  94 };
  95
  96 struct ExecContext {
  97         char **environment;
  98         char **environment_files;
  99
 100         struct rlimit *rlimit[RLIMIT_NLIMITS];
 101         char *working_directory, *root_directory;
 102
 103         mode_t umask;
 104         int oom_score_adjust;
 105         int nice;
 106         int ioprio;
 107         int cpu_sched_policy;
 108         int cpu_sched_priority;
 109
 110         cpu_set_t *cpuset;
 111         unsigned cpuset_ncpus;
 112
 113         ExecInput std_input;
 114         ExecOutput std_output;
 115         ExecOutput std_error;
 116
 117         nsec_t timer_slack_nsec;
 118
 119         char *tcpwrap_name;
 120
 121         char *tty_path;
 122
 123         bool tty_reset;
 124         bool tty_vhangup;
 125         bool tty_vt_disallocate;
 126
 127         bool ignore_sigpipe;
 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         bool selinux_context_ignore;
 142         char *selinux_context;
 143
 144         char **read_write_dirs, **read_only_dirs, **inaccessible_dirs;
 145         unsigned long mount_flags;
 146
 147         uint64_t capability_bounding_set_drop;
 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         bool private_network;
 160         bool private_devices;
 161
 162         bool no_new_privileges;
 163
 164         /* This is not exposed to the user but available
 165          * internally. We need it to make sure that whenever we spawn
 166          * /bin/mount it is run in the same process group as us so
 167          * that the autofs logic detects that it belongs to us and we
 168          * don't enter a trigger loop. */
 169         bool same_pgrp;
 170
 171         Set *syscall_filter;
 172         Set *syscall_archs;
 173         int syscall_errno;
 174         bool syscall_whitelist:1;
 175
 176         bool oom_score_adjust_set:1;
 177         bool nice_set:1;
 178         bool ioprio_set:1;
 179         bool cpu_sched_set:1;
 180 };
 181
 182 #include "cgroup.h"
 183
 184 int exec_spawn(ExecCommand *command,
 185                char **argv,
 186                ExecContext *context,
 187                int fds[], unsigned n_fds,
 188                char **environment,
 189                bool apply_permissions,
 190                bool apply_chroot,
 191                bool apply_tty_stdin,
 192                bool confirm_spawn,
 193                CGroupControllerMask cgroup_mask,
 194                const char *cgroup_path,
 195                const char *unit_id,
 196                usec_t watchdog_usec,
 197                int pipe_fd[2],
 198                ExecRuntime *runtime,
 199                pid_t *ret);
 200
 201 void exec_command_done(ExecCommand *c);
 202 void exec_command_done_array(ExecCommand *c, unsigned n);
 203
 204 void exec_command_free_list(ExecCommand *c);
 205 void exec_command_free_array(ExecCommand **c, unsigned n);
 206
 207 char *exec_command_line(char **argv);
 208
 209 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 210 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 211 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 212 int exec_command_set(ExecCommand *c, const char *path, ...);
 213
 214 void exec_context_init(ExecContext *c);
 215 void exec_context_done(ExecContext *c);
 216 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 217
 218 int exec_context_load_environment(const ExecContext *c, char ***l);
 219
 220 bool exec_context_may_touch_console(ExecContext *c);
 221
 222 void exec_status_start(ExecStatus *s, pid_t pid);
 223 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 224 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 225
 226 int exec_runtime_make(ExecRuntime **rt, ExecContext *c, const char *id);
 227 ExecRuntime *exec_runtime_ref(ExecRuntime *r);
 228 ExecRuntime *exec_runtime_unref(ExecRuntime *r);
 229
 230 int exec_runtime_serialize(ExecRuntime *rt, Unit *u, FILE *f, FDSet *fds);
 231 int exec_runtime_deserialize_item(ExecRuntime **rt, Unit *u, const char *key, const char *value, FDSet *fds);
 232
 233 void exec_runtime_destroy(ExecRuntime *rt);
 234
 235 const char* exec_output_to_string(ExecOutput i) _const_;
 236 ExecOutput exec_output_from_string(const char *s) _pure_;
 237
 238 const char* exec_input_to_string(ExecInput i) _const_;
 239 ExecInput exec_input_from_string(const char *s) _pure_;