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 "fdset.h"
  40
  41 typedef enum ExecInput {
  42         EXEC_INPUT_NULL,
  43         EXEC_INPUT_TTY,
  44         EXEC_INPUT_TTY_FORCE,
  45         EXEC_INPUT_TTY_FAIL,
  46         EXEC_INPUT_SOCKET,
  47         _EXEC_INPUT_MAX,
  48         _EXEC_INPUT_INVALID = -1
  49 } ExecInput;
  50
  51 typedef enum ExecOutput {
  52         EXEC_OUTPUT_INHERIT,
  53         EXEC_OUTPUT_NULL,
  54         EXEC_OUTPUT_TTY,
  55         EXEC_OUTPUT_SYSLOG,
  56         EXEC_OUTPUT_SYSLOG_AND_CONSOLE,
  57         EXEC_OUTPUT_KMSG,
  58         EXEC_OUTPUT_KMSG_AND_CONSOLE,
  59         EXEC_OUTPUT_JOURNAL,
  60         EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
  61         EXEC_OUTPUT_SOCKET,
  62         _EXEC_OUTPUT_MAX,
  63         _EXEC_OUTPUT_INVALID = -1
  64 } ExecOutput;
  65
  66 struct ExecStatus {
  67         dual_timestamp start_timestamp;
  68         dual_timestamp exit_timestamp;
  69         pid_t pid;
  70         int code;     /* as in siginfo_t::si_code */
  71         int status;   /* as in sigingo_t::si_status */
  72 };
  73
  74 struct ExecCommand {
  75         char *path;
  76         char **argv;
  77         ExecStatus exec_status;
  78         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  79         bool ignore;
  80 };
  81
  82 struct ExecRuntime {
  83         int n_ref;
  84
  85         char *tmp_dir;
  86         char *var_tmp_dir;
  87
  88         int netns_storage_socket[2];
  89 };
  90
  91 struct ExecContext {
  92         char **environment;
  93         char **environment_files;
  94
  95         struct rlimit *rlimit[RLIMIT_NLIMITS];
  96         char *working_directory, *root_directory;
  97
  98         mode_t umask;
  99         int oom_score_adjust;
 100         int nice;
 101         int ioprio;
 102         int cpu_sched_policy;
 103         int cpu_sched_priority;
 104
 105         cpu_set_t *cpuset;
 106         unsigned cpuset_ncpus;
 107
 108         ExecInput std_input;
 109         ExecOutput std_output;
 110         ExecOutput std_error;
 111
 112         nsec_t timer_slack_nsec;
 113
 114         char *tcpwrap_name;
 115
 116         char *tty_path;
 117
 118         bool tty_reset;
 119         bool tty_vhangup;
 120         bool tty_vt_disallocate;
 121
 122         bool ignore_sigpipe;
 123
 124         /* Since resolving these names might might involve socket
 125          * connections and we don't want to deadlock ourselves these
 126          * names are resolved on execution only and in the child
 127          * process. */
 128         char *user;
 129         char *group;
 130         char **supplementary_groups;
 131
 132         char *pam_name;
 133
 134         char *utmp_id;
 135
 136         char *selinux_context;
 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         cap_t capabilities;
 144         int secure_bits;
 145
 146         int syslog_priority;
 147         char *syslog_identifier;
 148         bool syslog_level_prefix;
 149
 150         bool cpu_sched_reset_on_fork;
 151         bool non_blocking;
 152         bool private_tmp;
 153         bool private_network;
 154         bool private_devices;
 155
 156         bool no_new_privileges;
 157
 158         /* This is not exposed to the user but available
 159          * internally. We need it to make sure that whenever we spawn
 160          * /bin/mount it is run in the same process group as us so
 161          * that the autofs logic detects that it belongs to us and we
 162          * don't enter a trigger loop. */
 163         bool same_pgrp;
 164
 165         uint32_t *syscall_filter;
 166
 167         bool oom_score_adjust_set:1;
 168         bool nice_set:1;
 169         bool ioprio_set:1;
 170         bool cpu_sched_set:1;
 171 };
 172
 173 #include "cgroup.h"
 174
 175 int exec_spawn(ExecCommand *command,
 176                char **argv,
 177                ExecContext *context,
 178                int fds[], unsigned n_fds,
 179                char **environment,
 180                bool apply_permissions,
 181                bool apply_chroot,
 182                bool apply_tty_stdin,
 183                bool confirm_spawn,
 184                CGroupControllerMask cgroup_mask,
 185                const char *cgroup_path,
 186                const char *unit_id,
 187                usec_t watchdog_usec,
 188                int pipe_fd[2],
 189                ExecRuntime *runtime,
 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
 209 int exec_context_load_environment(const ExecContext *c, char ***l);
 210
 211 bool exec_context_may_touch_console(ExecContext *c);
 212
 213 void exec_status_start(ExecStatus *s, pid_t pid);
 214 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 215 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 216
 217 int exec_runtime_make(ExecRuntime **rt, ExecContext *c, const char *id);
 218 ExecRuntime *exec_runtime_ref(ExecRuntime *r);
 219 ExecRuntime *exec_runtime_unref(ExecRuntime *r);
 220
 221 int exec_runtime_serialize(ExecRuntime *rt, Unit *u, FILE *f, FDSet *fds);
 222 int exec_runtime_deserialize_item(ExecRuntime **rt, Unit *u, const char *key, const char *value, FDSet *fds);
 223
 224 void exec_runtime_destroy(ExecRuntime *rt);
 225
 226 const char* exec_output_to_string(ExecOutput i) _const_;
 227 ExecOutput exec_output_from_string(const char *s) _pure_;
 228
 229 const char* exec_input_to_string(ExecInput i) _const_;
 230 ExecInput exec_input_from_string(const char *s) _pure_;