launchd/src/launch_priv.h

   1 /*
   2  * Copyright (c) 2005 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 #ifndef _LAUNCH_PRIV_H_
  21 #define _LAUNCH_PRIV_H_
  22
  23 #include <launch.h>
  24
  25 __BEGIN_DECLS
  26
  27 #define LAUNCH_KEY_GETUSERENVIRONMENT   "GetUserEnvironment"
  28 #define LAUNCH_KEY_SETUSERENVIRONMENT   "SetUserEnvironment"
  29 #define LAUNCH_KEY_UNSETUSERENVIRONMENT "UnsetUserEnvironment"
  30 #define LAUNCH_KEY_SETSTDOUT            "SetStandardOut"
  31 #define LAUNCH_KEY_SETSTDERR            "SetStandardError"
  32 #define LAUNCH_KEY_SHUTDOWN             "Shutdown"
  33 #define LAUNCH_KEY_SINGLEUSER           "SingleUser"
  34 #define LAUNCH_KEY_GETRESOURCELIMITS    "GetResourceLimits"
  35 #define LAUNCH_KEY_SETRESOURCELIMITS    "SetResourceLimits"
  36 #define LAUNCH_KEY_RELOADTTYS           "ReloadTTYS"
  37 #define LAUNCH_KEY_SETLOGMASK           "SetLogMask"
  38 #define LAUNCH_KEY_GETLOGMASK           "GetLogMask"
  39 #define LAUNCH_KEY_SETUMASK             "SetUmask"
  40 #define LAUNCH_KEY_GETUMASK             "GetUmask"
  41 #define LAUNCH_KEY_GETRUSAGESELF        "GetResourceUsageSelf"
  42 #define LAUNCH_KEY_GETRUSAGECHILDREN    "GetResourceUsageChildren"
  43
  44 #define LAUNCHD_SOCKET_ENV              "LAUNCHD_SOCKET"
  45 #define LAUNCHD_SOCK_PREFIX             "/var/tmp/launchd"
  46 #define LAUNCHD_TRUSTED_FD_ENV          "__LAUNCHD_FD"
  47 #define LAUNCHD_ASYNC_MSG_KEY           "_AsyncMessage"
  48 #define LAUNCH_KEY_BATCHCONTROL         "BatchControl"
  49 #define LAUNCH_KEY_BATCHQUERY           "BatchQuery"
  50
  51 #define LAUNCH_JOBKEY_MACH_KUNCSERVER   "kUNCServer"
  52 #define LAUNCH_JOBKEY_MACH_EXCEPTIONSERVER      "ExceptionServer"
  53 #define LAUNCH_JOBKEY_MACH_TASKSPECIALPORT      "TaskSpecialPort"
  54 #define LAUNCH_JOBKEY_MACH_HOSTSPECIALPORT      "HostSpecialPort"
  55
  56 typedef struct _launch *launch_t;
  57
  58 launch_t launchd_fdopen(int);
  59 int launchd_getfd(launch_t);
  60 void launchd_close(launch_t);
  61
  62 launch_data_t   launch_data_new_errno(int);
  63 bool            launch_data_set_errno(launch_data_t, int);
  64
  65 int launchd_msg_send(launch_t, launch_data_t);
  66 int launchd_msg_recv(launch_t, void (*)(launch_data_t, void *), void *);
  67
  68 /* For LoginWindow.
  69  *
  70  * After this call, the task's bootstrap port is set to the per session launchd.
  71  *
  72  * This returns the PID on of the per session launchd, and -1 on failure.
  73  *
  74  * If launchd terminates, loginwindow should exit.
  75  * If loginwindow terminates, launchd will exit.
  76  */
  77 #define LOAD_ONLY_SAFEMODE_LAUNCHAGENTS 1
  78 pid_t create_and_switch_to_per_session_launchd(const char *login, int flags, ...);
  79
  80 /* batch jobs will be implicity re-enabled when the last application who
  81  * disabled them exits.
  82  *
  83  * This API is really a hack to work around the lack of real-time APIs
  84  * at the VFS layer.
  85  */
  86 void launchd_batch_enable(bool);
  87 bool launchd_batch_query(void);
  88
  89 /* For CoreProcesses
  90  */
  91
  92 #define SPAWN_VIA_LAUNCHD_STOPPED       0x0001
  93 #define SPAWN_VIA_LAUNCHD_FORCE_PPC     0x0002
  94
  95 struct spawn_via_launchd_attr {
  96         uint64_t                spawn_flags;
  97         const char *            spawn_path;
  98         const char *            spawn_chdir;
  99         const char *const *     spawn_env;
 100         const mode_t *          spawn_umask;
 101         mach_port_t *           spawn_observer_port;
 102 };
 103
 104 #define spawn_via_launchd(a, b, c) _spawn_via_launchd(a, b, c, 0)
 105 pid_t _spawn_via_launchd(
 106                 const char *label,
 107                 const char *const *argv,
 108                 const struct spawn_via_launchd_attr *spawn_attrs,
 109                 int struct_version);
 110
 111 kern_return_t mpm_wait(mach_port_t ajob, int *wstatus);
 112
 113 kern_return_t mpm_uncork_fork(mach_port_t ajob);
 114
 115
 116 __END_DECLS
 117
 118 #endif