liblaunch/vproc_priv.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_APACHE_LICENSE_HEADER_START@
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * @APPLE_APACHE_LICENSE_HEADER_END@
  19  */
  20
  21 #ifndef __VPROC_PRIVATE_H__
  22 #define __VPROC_PRIVATE_H__
  23
  24 #include <Availability.h>
  25 #include <sys/types.h>
  26 #include <sys/cdefs.h>
  27 #include <sys/syslog.h>
  28 #include <sys/time.h>
  29 #include <stdbool.h>
  30 #include <launch.h>
  31 #include <vproc.h>
  32 #include <uuid/uuid.h>
  33 #include <servers/bootstrap.h>
  34
  35 #ifndef VPROC_HAS_TRANSACTIONS
  36 #define VPROC_HAS_TRANSACTIONS 1
  37 #endif
  38
  39 __BEGIN_DECLS
  40
  41 #define VPROCMGR_SESSION_LOGINWINDOW "LoginWindow"
  42 #define VPROCMGR_SESSION_BACKGROUND "Background"
  43 #define VPROCMGR_SESSION_AQUA "Aqua"
  44 #define VPROCMGR_SESSION_STANDARDIO "StandardIO"
  45 #define VPROCMGR_SESSION_SYSTEM "System"
  46
  47 #define XPC_DOMAIN_TYPE_SYSTEM   "XPCSystem"
  48 #define XPC_DOMAIN_TYPE_PERUSER "XPCPerUser"
  49 #define XPC_DOMAIN_TYPE_PERSESSION "XPCPerSession"
  50 #define XPC_DOMAIN_TYPE_PERAPPLICATION "XPCPerApplication"
  51
  52 #pragma GCC visibility push(default)
  53
  54 /* DO NOT use this. This is a hack for 'launchctl' */
  55 #define VPROC_MAGIC_UNLOAD_SIGNAL 0x4141504C
  56
  57 typedef void (*_vproc_transaction_callout)(void);
  58
  59 typedef enum {
  60         VPROC_GSK_ZERO,
  61         VPROC_GSK_LAST_EXIT_STATUS,
  62         VPROC_GSK_GLOBAL_ON_DEMAND,
  63         VPROC_GSK_MGR_UID,
  64         VPROC_GSK_MGR_PID,
  65         VPROC_GSK_IS_MANAGED,
  66         VPROC_GSK_MGR_NAME,
  67         VPROC_GSK_BASIC_KEEPALIVE,
  68         VPROC_GSK_START_INTERVAL,
  69         VPROC_GSK_IDLE_TIMEOUT,
  70         VPROC_GSK_EXIT_TIMEOUT,
  71         VPROC_GSK_ENVIRONMENT,
  72         VPROC_GSK_ALLJOBS,
  73         VPROC_GSK_GLOBAL_LOG_MASK,
  74         VPROC_GSK_GLOBAL_UMASK,
  75         VPROC_GSK_ABANDON_PROCESS_GROUP,
  76         VPROC_GSK_TRANSACTIONS_ENABLED,
  77         VPROC_GSK_WEIRD_BOOTSTRAP,
  78         VPROC_GSK_WAITFORDEBUGGER,
  79         VPROC_GSK_SECURITYSESSION,
  80         VPROC_GSK_SHUTDOWN_DEBUGGING,
  81         VPROC_GSK_VERBOSE_BOOT,
  82         VPROC_GSK_PERUSER_SUSPEND,
  83         VPROC_GSK_PERUSER_RESUME,
  84         VPROC_GSK_JOB_OVERRIDES_DB,
  85         VPROC_GSK_JOB_CACHE_DB,
  86         VPROC_GSK_EMBEDDEDROOTEQUIVALENT,
  87 } vproc_gsk_t;
  88
  89 typedef unsigned int vproc_flags_t;
  90 /* For _vproc_kickstart_by_label() -- instructs launchd to kickstart the job to stall before exec(2). */
  91 #define VPROCFLAG_STALL_JOB_EXEC        1 << 1
  92
  93 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_0)
  94 vproc_t
  95 vprocmgr_lookup_vproc(const char *label);
  96
  97 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_0)
  98 vproc_t
  99 vproc_retain(vproc_t vp);
 100
 101 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_0)
 102 void
 103 vproc_release(vproc_t vp);
 104
 105 __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0)
 106 vproc_err_t
 107 vproc_swap_integer(vproc_t vp, vproc_gsk_t key,
 108         int64_t *inval, int64_t *outval);
 109
 110 __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0)
 111 vproc_err_t
 112 vproc_swap_complex(vproc_t vp, vproc_gsk_t key,
 113         launch_data_t inval, launch_data_t *outval);
 114
 115 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_4_0)
 116 vproc_err_t
 117 vproc_swap_string(vproc_t vp, vproc_gsk_t key,
 118         const char *instr, char **outstr);
 119
 120 __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_NA)
 121 vproc_err_t
 122 _vproc_get_last_exit_status(int *wstatus);
 123
 124 __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0)
 125 vproc_err_t
 126 _vproc_set_global_on_demand(bool val);
 127
 128 __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0)
 129 vproc_err_t
 130 _vproc_send_signal_by_label(const char *label, int sig);
 131
 132 __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_0)
 133 vproc_err_t
 134 _vproc_kickstart_by_label(const char *label, pid_t *out_pid,
 135         mach_port_t *out_port_name, mach_port_t *out_obsrvr_port,
 136         vproc_flags_t flags);
 137
 138 /* _vprocmgr_log_drain() is specific to syslogd. It is not for general use. */
 139 typedef void (*_vprocmgr_log_drain_callback_t)(struct timeval *when, pid_t
 140         from_pid, pid_t about_pid, uid_t sender_uid, gid_t sender_gid, int priority,
 141         const char *from_name, const char *about_name, const char *session_name,
 142         const char *msg);
 143
 144 vproc_err_t
 145 _vprocmgr_log_drain(vproc_t vp, pthread_mutex_t *optional_mutex_around_callback,
 146         _vprocmgr_log_drain_callback_t func);
 147
 148 __attribute__((format(printf, 2, 3)))
 149 void
 150 _vproc_log(int pri, const char *msg, ...);
 151
 152 __attribute__((format(printf, 2, 3)))
 153 void
 154 _vproc_log_error(int pri, const char *msg, ...);
 155
 156 __attribute__((format(printf, 3, 0)))
 157 void
 158 _vproc_logv(int pri, int err, const char *msg, va_list ap);
 159
 160 /* One day, we'll be able to get rid of this... */
 161 vproc_err_t
 162 _vprocmgr_move_subset_to_user(uid_t target_user, const char *session_type,
 163         uint64_t flags);
 164
 165 vproc_err_t
 166 _vprocmgr_switch_to_session(const char *target_session, vproc_flags_t flags);
 167
 168 vproc_err_t
 169 _vprocmgr_detach_from_console(vproc_flags_t flags);
 170
 171 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_NA)
 172 void
 173 _vproc_standby_begin(void);
 174
 175 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_NA)
 176 void
 177 _vproc_standby_end(void);
 178
 179 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_NA)
 180 size_t
 181 _vproc_standby_count(void);
 182
 183 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_NA)
 184 size_t
 185 _vproc_standby_timeout(void);
 186
 187 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_NA)
 188 kern_return_t
 189 _vproc_transaction_count_for_pid(pid_t p, int32_t *count, bool *condemned);
 190
 191 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_NA)
 192 bool
 193 _vproc_pid_is_managed(pid_t p);
 194
 195 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_NA)
 196 void
 197 _vproc_transaction_try_exit(int status);
 198
 199 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_5_0)
 200 void
 201 _vproc_transaction_begin(void);
 202
 203 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_5_0)
 204 void
 205 _vproc_transaction_end(void);
 206
 207 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_NA)
 208 size_t
 209 _vproc_transaction_count(void);
 210
 211 int32_t *
 212 _vproc_transaction_ptr(void);
 213
 214 void
 215 _vproc_transaction_set_callouts(_vproc_transaction_callout gone2zero, _vproc_transaction_callout gonenonzero);
 216
 217 void
 218 _vproc_transactions_enable(void);
 219
 220 #pragma GCC visibility pop
 221
 222 __END_DECLS
 223
 224 #endif /* __VPROC_PRIVATE_H__ */