execute.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   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 <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 struct CGroupBonding;
  37
  38 #include "list.h"
  39 #include "util.h"
  40
  41 /* Abstract namespace! */
  42 #define LOGGER_SOCKET "/org/freedesktop/systemd1/logger"
  43
  44 typedef enum ExecInput {
  45         EXEC_INPUT_NULL,
  46         EXEC_INPUT_TTY,
  47         EXEC_INPUT_TTY_FORCE,
  48         EXEC_INPUT_TTY_FAIL,
  49         EXEC_INPUT_SOCKET,
  50         _EXEC_INPUT_MAX,
  51         _EXEC_INPUT_INVALID = -1
  52 } ExecInput;
  53
  54 typedef enum ExecOutput {
  55         EXEC_OUTPUT_INHERIT,
  56         EXEC_OUTPUT_NULL,
  57         EXEC_OUTPUT_TTY,
  58         EXEC_OUTPUT_SYSLOG,
  59         EXEC_OUTPUT_KERNEL,
  60         EXEC_OUTPUT_SOCKET,
  61         _EXEC_OUTPUT_MAX,
  62         _EXEC_OUTPUT_INVALID = -1
  63 } ExecOutput;
  64
  65 struct ExecStatus {
  66         usec_t start_timestamp;
  67         usec_t exit_timestamp;
  68         pid_t pid;
  69         int code;     /* as in siginfo_t::si_code */
  70         int status;   /* as in sigingo_t::si_status */
  71 };
  72
  73 struct ExecCommand {
  74         char *path;
  75         char **argv;
  76         ExecStatus exec_status;
  77         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  78 };
  79
  80 struct ExecContext {
  81         char **environment;
  82         struct rlimit *rlimit[RLIMIT_NLIMITS];
  83         char *working_directory, *root_directory;
  84
  85         mode_t umask;
  86         int oom_adjust;
  87         int nice;
  88         int ioprio;
  89         int cpu_sched_policy;
  90         int cpu_sched_priority;
  91
  92         cpu_set_t cpu_affinity;
  93         unsigned long timer_slack_ns;
  94
  95         ExecInput std_input;
  96         ExecOutput std_output;
  97         ExecOutput std_error;
  98
  99         int syslog_priority;
 100         char *syslog_identifier;
 101
 102         char *tty_path;
 103
 104         /* Since resolving these names might might involve socket
 105          * connections and we don't want to deadlock ourselves these
 106          * names are resolved on execution only and in the child
 107          * process. */
 108         char *user;
 109         char *group;
 110         char **supplementary_groups;
 111
 112         uint64_t capability_bounding_set_drop;
 113
 114         cap_t capabilities;
 115         int secure_bits;
 116
 117         bool cpu_sched_reset_on_fork;
 118         bool non_blocking;
 119
 120         bool oom_adjust_set:1;
 121         bool nice_set:1;
 122         bool ioprio_set:1;
 123         bool cpu_sched_set:1;
 124         bool cpu_affinity_set:1;
 125         bool timer_slack_ns_set:1;
 126
 127         /* This is not exposed to the user but available
 128          * internally. We need it to make sure that whenever we spawn
 129          * /bin/mount it is run in the same process group as us so
 130          * that the autofs logic detects that it belongs to us and we
 131          * don't enter a trigger loop. */
 132         bool no_setsid:1;
 133 };
 134
 135 typedef enum ExitStatus {
 136         /* EXIT_SUCCESS defined by libc */
 137         /* EXIT_FAILURE defined by libc */
 138         EXIT_INVALIDARGUMENT = 2,
 139         EXIT_NOTIMPLEMENTED = 3,
 140         EXIT_NOPERMISSION = 4,
 141         EXIT_NOTINSTALLED = 5,
 142         EXIT_NOTCONFIGURED = 6,
 143         EXIT_NOTRUNNING = 7,
 144
 145         /* The LSB suggests that error codes >= 200 are "reserved". We
 146          * use them here under the assumption that they hence are
 147          * unused by init scripts.
 148          *
 149          * http://refspecs.freestandards.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html */
 150
 151         EXIT_CHDIR = 200,
 152         EXIT_NICE,
 153         EXIT_FDS,
 154         EXIT_EXEC,
 155         EXIT_MEMORY,
 156         EXIT_LIMITS,
 157         EXIT_OOM_ADJUST,
 158         EXIT_SIGNAL_MASK,
 159         EXIT_STDIN,
 160         EXIT_STDOUT,
 161         EXIT_CHROOT,   /* 210 */
 162         EXIT_IOPRIO,
 163         EXIT_TIMERSLACK,
 164         EXIT_SECUREBITS,
 165         EXIT_SETSCHEDULER,
 166         EXIT_CPUAFFINITY,
 167         EXIT_GROUP,
 168         EXIT_USER,
 169         EXIT_CAPABILITIES,
 170         EXIT_CGROUP,
 171         EXIT_SETSID,   /* 220 */
 172         EXIT_CONFIRM,
 173         EXIT_STDERR
 174
 175 } ExitStatus;
 176
 177 int exec_spawn(ExecCommand *command,
 178                char **argv,
 179                const ExecContext *context,
 180                int fds[], unsigned n_fds,
 181                bool apply_permissions,
 182                bool apply_chroot,
 183                bool confirm_spawn,
 184                struct CGroupBonding *cgroup_bondings,
 185                pid_t *ret);
 186
 187 void exec_command_done(ExecCommand *c);
 188 void exec_command_done_array(ExecCommand *c, unsigned n);
 189
 190 void exec_command_free_list(ExecCommand *c);
 191 void exec_command_free_array(ExecCommand **c, unsigned n);
 192
 193 char *exec_command_line(char **argv);
 194
 195 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 196 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 197 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 198 int exec_command_set(ExecCommand *c, const char *path, ...);
 199
 200 void exec_context_init(ExecContext *c);
 201 void exec_context_done(ExecContext *c);
 202 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 203
 204 void exec_status_fill(ExecStatus *s, pid_t pid, int code, int status);
 205 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 206
 207 const char* exec_output_to_string(ExecOutput i);
 208 int exec_output_from_string(const char *s);
 209
 210 const char* exec_input_to_string(ExecInput i);
 211 int exec_input_from_string(const char *s);
 212
 213 const char* exit_status_to_string(ExitStatus status);
 214
 215 #endif