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 #include "list.h"
  37 #include "util.h"
  38
  39 /* Abstract namespace! */
  40 #define LOGGER_SOCKET "/org/freedesktop/systemd1/logger"
  41
  42 typedef enum ExecOutput {
  43         EXEC_OUTPUT_CONSOLE,
  44         EXEC_OUTPUT_NULL,
  45         EXEC_OUTPUT_SYSLOG,
  46         EXEC_OUTPUT_KERNEL,
  47         _EXEC_OUTPUT_MAX,
  48         _EXEC_OUTPUT_INVALID = -1
  49 } ExecOutput;
  50
  51 typedef enum ExecInput {
  52         EXEC_INPUT_NULL,
  53         EXEC_INPUT_CONSOLE,
  54         _EXEC_INPUT_MAX,
  55         _EXEC_INPUT_INVALID = -1
  56 } ExecInput;
  57
  58 struct ExecStatus {
  59         pid_t pid;
  60         usec_t timestamp;
  61         int code;     /* as in siginfo_t::si_code */
  62         int status;   /* as in sigingo_t::si_status */
  63 };
  64
  65 struct ExecCommand {
  66         char *path;
  67         char **argv;
  68         ExecStatus exec_status;
  69         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  70 };
  71
  72 struct ExecContext {
  73         char **environment;
  74         mode_t umask;
  75         struct rlimit *rlimit[RLIMIT_NLIMITS];
  76         char *working_directory, *root_directory;
  77         int oom_adjust;
  78         int nice;
  79         int ioprio;
  80         int cpu_sched_policy;
  81         int cpu_sched_priority;
  82         cpu_set_t cpu_affinity;
  83         unsigned long timer_slack_ns;
  84
  85         bool oom_adjust_set:1;
  86         bool nice_set:1;
  87         bool ioprio_set:1;
  88         bool cpu_sched_set:1;
  89         bool cpu_affinity_set:1;
  90         bool timer_slack_ns_set:1;
  91
  92         bool cpu_sched_reset_on_fork;
  93         bool non_blocking;
  94
  95         ExecInput input;
  96         ExecOutput output;
  97         int syslog_priority;
  98         char *syslog_identifier;
  99
 100         cap_t capabilities;
 101         int secure_bits;
 102         uint64_t capability_bounding_set_drop;
 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
 113 typedef enum ExitStatus {
 114         /* EXIT_SUCCESS defined by libc */
 115         /* EXIT_FAILURE defined by libc */
 116         EXIT_INVALIDARGUMENT = 2,
 117         EXIT_NOTIMPLEMENTED = 3,
 118         EXIT_NOPERMISSION = 4,
 119         EXIT_NOTINSTALLED = 5,
 120         EXIT_NOTCONFIGURED = 6,
 121         EXIT_NOTRUNNING = 7,
 122
 123         /* The LSB suggests that error codes >= 200 are "reserved". We
 124          * use them here under the assumption that they hence are
 125          * unused by init scripts.
 126          *
 127          * http://refspecs.freestandards.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html */
 128
 129         EXIT_CHDIR = 200,
 130         EXIT_NICE,
 131         EXIT_FDS,
 132         EXIT_EXEC,
 133         EXIT_MEMORY,
 134         EXIT_LIMITS,
 135         EXIT_OOM_ADJUST,
 136         EXIT_SIGNAL_MASK,
 137         EXIT_INPUT,
 138         EXIT_OUTPUT,
 139         EXIT_CHROOT,   /* 210 */
 140         EXIT_PGID,
 141         EXIT_IOPRIO,
 142         EXIT_TIMERSLACK,
 143         EXIT_SECUREBITS,
 144         EXIT_SETSCHEDULER,
 145         EXIT_CPUAFFINITY,
 146         EXIT_GROUP,
 147         EXIT_USER,
 148         EXIT_CAPABILITIES
 149 } ExitStatus;
 150
 151 int exec_spawn(const ExecCommand *command,
 152                const ExecContext *context,
 153                int *fds, unsigned n_fds,
 154                bool apply_permissions,
 155                bool apply_chroot,
 156                pid_t *ret);
 157
 158 void exec_command_free_list(ExecCommand *c);
 159 void exec_command_free_array(ExecCommand **c, unsigned n);
 160
 161 char *exec_command_line(ExecCommand *c);
 162 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 163 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 164 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 165
 166 void exec_context_init(ExecContext *c);
 167 void exec_context_done(ExecContext *c);
 168 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 169
 170 void exec_status_fill(ExecStatus *s, pid_t pid, int code, int status);
 171
 172 const char* exec_output_to_string(ExecOutput i);
 173 int exec_output_from_string(const char *s);
 174
 175 const char* exec_input_to_string(ExecInput i);
 176 int exec_input_from_string(const char *s);
 177
 178 #endif