| 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_H_ |
| 21 | #define _LAUNCH_H_ |
| 22 | |
| 23 | #include <mach/mach.h> |
| 24 | #include <sys/cdefs.h> |
| 25 | #include <stddef.h> |
| 26 | #include <stdbool.h> |
| 27 | |
| 28 | #pragma GCC visibility push(default) |
| 29 | |
| 30 | __BEGIN_DECLS |
| 31 | |
| 32 | #ifdef __GNUC__ |
| 33 | #define __ld_normal __attribute__((__nothrow__)) |
| 34 | #define __ld_setter __attribute__((__nothrow__, __nonnull__)) |
| 35 | #define __ld_getter __attribute__((__nothrow__, __nonnull__, __pure__, __warn_unused_result__)) |
| 36 | #define __ld_iterator(x, y) __attribute__((__nonnull__(x, y))) |
| 37 | #define __ld_allocator __attribute__((__nothrow__, __malloc__, __nonnull__, __warn_unused_result__)) |
| 38 | #else |
| 39 | #define __ld_normal |
| 40 | #define __ld_setter |
| 41 | #define __ld_getter |
| 42 | #define __ld_iterator(x, y) |
| 43 | #define __ld_allocator |
| 44 | #endif |
| 45 | |
| 46 | |
| 47 | #define LAUNCH_KEY_SUBMITJOB "SubmitJob" |
| 48 | #define LAUNCH_KEY_REMOVEJOB "RemoveJob" |
| 49 | #define LAUNCH_KEY_STARTJOB "StartJob" |
| 50 | #define LAUNCH_KEY_STOPJOB "StopJob" |
| 51 | #define LAUNCH_KEY_GETJOB "GetJob" |
| 52 | #define LAUNCH_KEY_GETJOBS "GetJobs" |
| 53 | #define LAUNCH_KEY_CHECKIN "CheckIn" |
| 54 | |
| 55 | #define LAUNCH_JOBKEY_LABEL "Label" |
| 56 | #define LAUNCH_JOBKEY_DISABLED "Disabled" |
| 57 | #define LAUNCH_JOBKEY_USERNAME "UserName" |
| 58 | #define LAUNCH_JOBKEY_GROUPNAME "GroupName" |
| 59 | #define LAUNCH_JOBKEY_TIMEOUT "TimeOut" |
| 60 | #define LAUNCH_JOBKEY_EXITTIMEOUT "ExitTimeOut" |
| 61 | #define LAUNCH_JOBKEY_INITGROUPS "InitGroups" |
| 62 | #define LAUNCH_JOBKEY_SOCKETS "Sockets" |
| 63 | #define LAUNCH_JOBKEY_MACHSERVICES "MachServices" |
| 64 | #define LAUNCH_JOBKEY_MACHSERVICELOOKUPPOLICIES "MachServiceLookupPolicies" |
| 65 | #define LAUNCH_JOBKEY_INETDCOMPATIBILITY "inetdCompatibility" |
| 66 | #define LAUNCH_JOBKEY_ENABLEGLOBBING "EnableGlobbing" |
| 67 | #define LAUNCH_JOBKEY_PROGRAMARGUMENTS "ProgramArguments" |
| 68 | #define LAUNCH_JOBKEY_PROGRAM "Program" |
| 69 | #define LAUNCH_JOBKEY_ONDEMAND "OnDemand" |
| 70 | #define LAUNCH_JOBKEY_KEEPALIVE "KeepAlive" |
| 71 | #define LAUNCH_JOBKEY_LIMITLOADTOHOSTS "LimitLoadToHosts" |
| 72 | #define LAUNCH_JOBKEY_LIMITLOADFROMHOSTS "LimitLoadFromHosts" |
| 73 | #define LAUNCH_JOBKEY_LIMITLOADTOSESSIONTYPE "LimitLoadToSessionType" |
| 74 | #define LAUNCH_JOBKEY_LIMITLOADTOHARDWARE "LimitLoadToHardware" |
| 75 | #define LAUNCH_JOBKEY_LIMITLOADFROMHARDWARE "LimitLoadFromHardware" |
| 76 | #define LAUNCH_JOBKEY_RUNATLOAD "RunAtLoad" |
| 77 | #define LAUNCH_JOBKEY_ROOTDIRECTORY "RootDirectory" |
| 78 | #define LAUNCH_JOBKEY_WORKINGDIRECTORY "WorkingDirectory" |
| 79 | #define LAUNCH_JOBKEY_ENVIRONMENTVARIABLES "EnvironmentVariables" |
| 80 | #define LAUNCH_JOBKEY_USERENVIRONMENTVARIABLES "UserEnvironmentVariables" |
| 81 | #define LAUNCH_JOBKEY_UMASK "Umask" |
| 82 | #define LAUNCH_JOBKEY_NICE "Nice" |
| 83 | #define LAUNCH_JOBKEY_HOPEFULLYEXITSFIRST "HopefullyExitsFirst" |
| 84 | #define LAUNCH_JOBKEY_HOPEFULLYEXITSLAST "HopefullyExitsLast" |
| 85 | #define LAUNCH_JOBKEY_LOWPRIORITYIO "LowPriorityIO" |
| 86 | #define LAUNCH_JOBKEY_SESSIONCREATE "SessionCreate" |
| 87 | #define LAUNCH_JOBKEY_STARTONMOUNT "StartOnMount" |
| 88 | #define LAUNCH_JOBKEY_SOFTRESOURCELIMITS "SoftResourceLimits" |
| 89 | #define LAUNCH_JOBKEY_HARDRESOURCELIMITS "HardResourceLimits" |
| 90 | #define LAUNCH_JOBKEY_STANDARDINPATH "StandardInPath" |
| 91 | #define LAUNCH_JOBKEY_STANDARDOUTPATH "StandardOutPath" |
| 92 | #define LAUNCH_JOBKEY_STANDARDERRORPATH "StandardErrorPath" |
| 93 | #define LAUNCH_JOBKEY_DEBUG "Debug" |
| 94 | #define LAUNCH_JOBKEY_WAITFORDEBUGGER "WaitForDebugger" |
| 95 | #define LAUNCH_JOBKEY_QUEUEDIRECTORIES "QueueDirectories" |
| 96 | #define LAUNCH_JOBKEY_WATCHPATHS "WatchPaths" |
| 97 | #define LAUNCH_JOBKEY_STARTINTERVAL "StartInterval" |
| 98 | #define LAUNCH_JOBKEY_STARTCALENDARINTERVAL "StartCalendarInterval" |
| 99 | #define LAUNCH_JOBKEY_BONJOURFDS "BonjourFDs" |
| 100 | #define LAUNCH_JOBKEY_LASTEXITSTATUS "LastExitStatus" |
| 101 | #define LAUNCH_JOBKEY_PID "PID" |
| 102 | #define LAUNCH_JOBKEY_THROTTLEINTERVAL "ThrottleInterval" |
| 103 | #define LAUNCH_JOBKEY_LAUNCHONLYONCE "LaunchOnlyOnce" |
| 104 | #define LAUNCH_JOBKEY_ABANDONPROCESSGROUP "AbandonProcessGroup" |
| 105 | #define LAUNCH_JOBKEY_IGNOREPROCESSGROUPATSHUTDOWN "IgnoreProcessGroupAtShutdown" |
| 106 | #define LAUNCH_JOBKEY_POLICIES "Policies" |
| 107 | #define LAUNCH_JOBKEY_ENABLETRANSACTIONS "EnableTransactions" |
| 108 | |
| 109 | #define LAUNCH_JOBPOLICY_DENYCREATINGOTHERJOBS "DenyCreatingOtherJobs" |
| 110 | |
| 111 | #define LAUNCH_JOBINETDCOMPATIBILITY_WAIT "Wait" |
| 112 | |
| 113 | #define LAUNCH_JOBKEY_MACH_RESETATCLOSE "ResetAtClose" |
| 114 | #define LAUNCH_JOBKEY_MACH_HIDEUNTILCHECKIN "HideUntilCheckIn" |
| 115 | #define LAUNCH_JOBKEY_MACH_DRAINMESSAGESONCRASH "DrainMessagesOnCrash" |
| 116 | #define LAUNCH_JOBKEY_MACH_PINGEVENTUPDATES "PingEventUpdates" |
| 117 | |
| 118 | #define LAUNCH_JOBKEY_KEEPALIVE_SUCCESSFULEXIT "SuccessfulExit" |
| 119 | #define LAUNCH_JOBKEY_KEEPALIVE_NETWORKSTATE "NetworkState" |
| 120 | #define LAUNCH_JOBKEY_KEEPALIVE_PATHSTATE "PathState" |
| 121 | #define LAUNCH_JOBKEY_KEEPALIVE_OTHERJOBACTIVE "OtherJobActive" |
| 122 | #define LAUNCH_JOBKEY_KEEPALIVE_OTHERJOBENABLED "OtherJobEnabled" |
| 123 | #define LAUNCH_JOBKEY_KEEPALIVE_AFTERINITIALDEMAND "AfterInitialDemand" |
| 124 | #define LAUNCH_JOBKEY_KEEPALIVE_CRASHED "Crashed" |
| 125 | |
| 126 | #define LAUNCH_JOBKEY_LAUNCHEVENTS "LaunchEvents" |
| 127 | |
| 128 | #define LAUNCH_JOBKEY_CAL_MINUTE "Minute" |
| 129 | #define LAUNCH_JOBKEY_CAL_HOUR "Hour" |
| 130 | #define LAUNCH_JOBKEY_CAL_DAY "Day" |
| 131 | #define LAUNCH_JOBKEY_CAL_WEEKDAY "Weekday" |
| 132 | #define LAUNCH_JOBKEY_CAL_MONTH "Month" |
| 133 | |
| 134 | #define LAUNCH_JOBKEY_RESOURCELIMIT_CORE "Core" |
| 135 | #define LAUNCH_JOBKEY_RESOURCELIMIT_CPU "CPU" |
| 136 | #define LAUNCH_JOBKEY_RESOURCELIMIT_DATA "Data" |
| 137 | #define LAUNCH_JOBKEY_RESOURCELIMIT_FSIZE "FileSize" |
| 138 | #define LAUNCH_JOBKEY_RESOURCELIMIT_MEMLOCK "MemoryLock" |
| 139 | #define LAUNCH_JOBKEY_RESOURCELIMIT_NOFILE "NumberOfFiles" |
| 140 | #define LAUNCH_JOBKEY_RESOURCELIMIT_NPROC "NumberOfProcesses" |
| 141 | #define LAUNCH_JOBKEY_RESOURCELIMIT_RSS "ResidentSetSize" |
| 142 | #define LAUNCH_JOBKEY_RESOURCELIMIT_STACK "Stack" |
| 143 | |
| 144 | #define LAUNCH_JOBKEY_DISABLED_MACHINETYPE "MachineType" |
| 145 | #define LAUNCH_JOBKEY_DISABLED_MODELNAME "ModelName" |
| 146 | |
| 147 | #define LAUNCH_JOBSOCKETKEY_TYPE "SockType" |
| 148 | #define LAUNCH_JOBSOCKETKEY_PASSIVE "SockPassive" |
| 149 | #define LAUNCH_JOBSOCKETKEY_BONJOUR "Bonjour" |
| 150 | #define LAUNCH_JOBSOCKETKEY_SECUREWITHKEY "SecureSocketWithKey" |
| 151 | #define LAUNCH_JOBSOCKETKEY_PATHNAME "SockPathName" |
| 152 | #define LAUNCH_JOBSOCKETKEY_PATHMODE "SockPathMode" |
| 153 | #define LAUNCH_JOBSOCKETKEY_NODENAME "SockNodeName" |
| 154 | #define LAUNCH_JOBSOCKETKEY_SERVICENAME "SockServiceName" |
| 155 | #define LAUNCH_JOBSOCKETKEY_FAMILY "SockFamily" |
| 156 | #define LAUNCH_JOBSOCKETKEY_PROTOCOL "SockProtocol" |
| 157 | #define LAUNCH_JOBSOCKETKEY_MULTICASTGROUP "MulticastGroup" |
| 158 | |
| 159 | typedef struct _launch_data *launch_data_t; |
| 160 | |
| 161 | typedef enum { |
| 162 | LAUNCH_DATA_DICTIONARY = 1, |
| 163 | LAUNCH_DATA_ARRAY, |
| 164 | LAUNCH_DATA_FD, |
| 165 | LAUNCH_DATA_INTEGER, |
| 166 | LAUNCH_DATA_REAL, |
| 167 | LAUNCH_DATA_BOOL, |
| 168 | LAUNCH_DATA_STRING, |
| 169 | LAUNCH_DATA_OPAQUE, |
| 170 | LAUNCH_DATA_ERRNO, |
| 171 | LAUNCH_DATA_MACHPORT, |
| 172 | } launch_data_type_t; |
| 173 | |
| 174 | launch_data_t launch_data_alloc(launch_data_type_t) __ld_allocator; |
| 175 | launch_data_t launch_data_copy(launch_data_t) __ld_allocator; |
| 176 | launch_data_type_t launch_data_get_type(const launch_data_t) __ld_getter; |
| 177 | void launch_data_free(launch_data_t) __ld_setter; |
| 178 | |
| 179 | /* Generic Dictionaries */ |
| 180 | /* the value should not be changed while iterating */ |
| 181 | bool launch_data_dict_insert(launch_data_t, const launch_data_t, const char *) __ld_setter; |
| 182 | launch_data_t launch_data_dict_lookup(const launch_data_t, const char *) __ld_getter; |
| 183 | bool launch_data_dict_remove(launch_data_t, const char *) __ld_setter; |
| 184 | void launch_data_dict_iterate(const launch_data_t, void (*)(const launch_data_t, const char *, void *), void *) __ld_iterator(1, 2); |
| 185 | size_t launch_data_dict_get_count(const launch_data_t) __ld_getter; |
| 186 | |
| 187 | /* Generic Arrays */ |
| 188 | bool launch_data_array_set_index(launch_data_t, const launch_data_t, size_t) __ld_setter; |
| 189 | launch_data_t launch_data_array_get_index(const launch_data_t, size_t) __ld_getter; |
| 190 | size_t launch_data_array_get_count(const launch_data_t) __ld_getter; |
| 191 | |
| 192 | launch_data_t launch_data_new_fd(int) __ld_allocator; |
| 193 | launch_data_t launch_data_new_machport(mach_port_t) __ld_allocator; |
| 194 | launch_data_t launch_data_new_integer(long long) __ld_allocator; |
| 195 | launch_data_t launch_data_new_bool(bool) __ld_allocator; |
| 196 | launch_data_t launch_data_new_real(double) __ld_allocator; |
| 197 | launch_data_t launch_data_new_string(const char *) __ld_allocator; |
| 198 | launch_data_t launch_data_new_opaque(const void *, size_t) __ld_allocator; |
| 199 | |
| 200 | bool launch_data_set_fd(launch_data_t, int) __ld_setter; |
| 201 | bool launch_data_set_machport(launch_data_t, mach_port_t) __ld_setter; |
| 202 | bool launch_data_set_integer(launch_data_t, long long) __ld_setter; |
| 203 | bool launch_data_set_bool(launch_data_t, bool) __ld_setter; |
| 204 | bool launch_data_set_real(launch_data_t, double) __ld_setter; |
| 205 | bool launch_data_set_string(launch_data_t, const char *) __ld_setter; |
| 206 | bool launch_data_set_opaque(launch_data_t, const void *, size_t) __ld_setter; |
| 207 | |
| 208 | int launch_data_get_fd(const launch_data_t) __ld_getter; |
| 209 | mach_port_t launch_data_get_machport(const launch_data_t) __ld_getter; |
| 210 | long long launch_data_get_integer(const launch_data_t) __ld_getter; |
| 211 | bool launch_data_get_bool(const launch_data_t) __ld_getter; |
| 212 | double launch_data_get_real(const launch_data_t) __ld_getter; |
| 213 | const char * launch_data_get_string(const launch_data_t) __ld_getter; |
| 214 | void * launch_data_get_opaque(const launch_data_t) __ld_getter; |
| 215 | size_t launch_data_get_opaque_size(const launch_data_t) __ld_getter; |
| 216 | int launch_data_get_errno(const launch_data_t) __ld_getter; |
| 217 | |
| 218 | |
| 219 | /* launch_get_fd() |
| 220 | * |
| 221 | * Use this to get the FD if you're doing asynchronous I/O with select(), |
| 222 | * poll() or kevent(). |
| 223 | */ |
| 224 | int launch_get_fd(void) __ld_normal; |
| 225 | |
| 226 | /* launch_msg() |
| 227 | * |
| 228 | * Use this API to send and receive messages. |
| 229 | * Calling launch_msg() with no message to send is a valid way to get |
| 230 | * asynchronously received messages. |
| 231 | * |
| 232 | * If a message was to be sent, it returns NULL and errno on failure. |
| 233 | * |
| 234 | * If no messages were to be sent, it returns NULL and errno is set to zero if |
| 235 | * no more asynchronous messages are available. |
| 236 | */ |
| 237 | launch_data_t launch_msg(const launch_data_t) __ld_normal; |
| 238 | |
| 239 | __END_DECLS |
| 240 | |
| 241 | #pragma GCC visibility pop |
| 242 | |
| 243 | #endif |