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
  28 #include <linux/types.h>
  29 #include <sys/time.h>
  30 #include <sys/resource.h>
  31 #include <sys/capability.h>
  32 #include <stdbool.h>
  33 #include <stdio.h>
  34 #include <sched.h>
  35
  36 #include "list.h"
  37 #include "util.h"
  38
  39 typedef struct Unit Unit;
  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 ExecContext {
  83         char **environment;
  84         char **environment_files;
  85
  86         struct rlimit *rlimit[RLIMIT_NLIMITS];
  87         char *working_directory, *root_directory;
  88
  89         mode_t umask;
  90         int oom_score_adjust;
  91         int nice;
  92         int ioprio;
  93         int cpu_sched_policy;
  94         int cpu_sched_priority;
  95
  96         cpu_set_t *cpuset;
  97         unsigned cpuset_ncpus;
  98
  99         ExecInput std_input;
 100         ExecOutput std_output;
 101         ExecOutput std_error;
 102
 103         nsec_t timer_slack_nsec;
 104
 105         char *tcpwrap_name;
 106
 107         char *tty_path;
 108
 109         bool tty_reset;
 110         bool tty_vhangup;
 111         bool tty_vt_disallocate;
 112
 113         bool ignore_sigpipe;
 114
 115         /* Since resolving these names might might involve socket
 116          * connections and we don't want to deadlock ourselves these
 117          * names are resolved on execution only and in the child
 118          * process. */
 119         char *user;
 120         char *group;
 121         char **supplementary_groups;
 122
 123         char *pam_name;
 124
 125         char *utmp_id;
 126
 127         char **read_write_dirs, **read_only_dirs, **inaccessible_dirs;
 128         unsigned long mount_flags;
 129
 130         uint64_t capability_bounding_set_drop;
 131
 132         cap_t capabilities;
 133         int secure_bits;
 134
 135         int syslog_priority;
 136         char *syslog_identifier;
 137         bool syslog_level_prefix;
 138
 139         bool cpu_sched_reset_on_fork;
 140         bool non_blocking;
 141         bool private_tmp;
 142         bool private_network;
 143         char *tmp_dir;
 144         char *var_tmp_dir;
 145
 146         bool no_new_privileges;
 147
 148         /* This is not exposed to the user but available
 149          * internally. We need it to make sure that whenever we spawn
 150          * /bin/mount it is run in the same process group as us so
 151          * that the autofs logic detects that it belongs to us and we
 152          * don't enter a trigger loop. */
 153         bool same_pgrp;
 154
 155         uint32_t *syscall_filter;
 156
 157         bool oom_score_adjust_set:1;
 158         bool nice_set:1;
 159         bool ioprio_set:1;
 160         bool cpu_sched_set:1;
 161 };
 162
 163 #include "cgroup.h"
 164
 165 int exec_spawn(ExecCommand *command,
 166                char **argv,
 167                ExecContext *context,
 168                int fds[], unsigned n_fds,
 169                char **environment,
 170                bool apply_permissions,
 171                bool apply_chroot,
 172                bool apply_tty_stdin,
 173                bool confirm_spawn,
 174                CGroupControllerMask cgroup_mask,
 175                const char *cgroup_path,
 176                const char *unit_id,
 177                int pipe_fd[2],
 178                pid_t *ret);
 179
 180 void exec_command_done(ExecCommand *c);
 181 void exec_command_done_array(ExecCommand *c, unsigned n);
 182
 183 void exec_command_free_list(ExecCommand *c);
 184 void exec_command_free_array(ExecCommand **c, unsigned n);
 185
 186 char *exec_command_line(char **argv);
 187
 188 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 189 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 190 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 191 int exec_command_set(ExecCommand *c, const char *path, ...);
 192
 193 void exec_context_init(ExecContext *c);
 194 void exec_context_done(ExecContext *c, bool reloading_or_reexecuting);
 195 void exec_context_tmp_dirs_done(ExecContext *c);
 196 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 197 void exec_context_tty_reset(const ExecContext *context);
 198
 199 int exec_context_load_environment(const ExecContext *c, char ***l);
 200
 201 bool exec_context_may_touch_console(ExecContext *c);
 202 void exec_context_serialize(const ExecContext *c, Unit *u, FILE *f);
 203
 204 void exec_status_start(ExecStatus *s, pid_t pid);
 205 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 206 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 207
 208 const char* exec_output_to_string(ExecOutput i) _const_;
 209 ExecOutput exec_output_from_string(const char *s) _pure_;
 210
 211 const char* exec_input_to_string(ExecInput i) _const_;
 212 ExecInput exec_input_from_string(const char *s) _pure_;