[apple/xnu.git] / osfmk / mach / kern_return.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code 
 * as defined in and that are subject to the Apple Public Source License 
 * Version 2.0 (the 'License'). You may not use this file except in 
 * compliance with the License.  The rights granted to you under the 
 * License may not be used to create, or enable the creation or 
 * redistribution of, unlawful or unlicensed copies of an Apple operating 
 * system, or to circumvent, violate, or enable the circumvention or 
 * violation of, any terms of an Apple operating system software license 
 * agreement.
 *
 * Please obtain a copy of the License at 
 * http://www.opensource.apple.com/apsl/ and read it before using this 
 * file.
 *
 * The Original Code and all software distributed under the License are 
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
 * Please see the License for the specific language governing rights and 
 * limitations under the License.
 *
 * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */
/*
 *	File:	h/kern_return.h
 *	Author:	Avadis Tevanian, Jr.
 *	Date:	1985
 *
 *	Kernel return codes.
 *
 */

#ifndef	_MACH_KERN_RETURN_H_
#define _MACH_KERN_RETURN_H_

#include <mach/machine/kern_return.h>

#define KERN_SUCCESS			0

#define KERN_INVALID_ADDRESS		1
		/* Specified address is not currently valid.
		 */

#define KERN_PROTECTION_FAILURE		2
		/* Specified memory is valid, but does not permit the
		 * required forms of access.
		 */

#define KERN_NO_SPACE			3
		/* The address range specified is already in use, or
		 * no address range of the size specified could be
		 * found.
		 */

#define KERN_INVALID_ARGUMENT		4
		/* The function requested was not applicable to this
		 * type of argument, or an argument is invalid
		 */

#define KERN_FAILURE			5
		/* The function could not be performed.  A catch-all.
		 */

#define KERN_RESOURCE_SHORTAGE		6
		/* A system resource could not be allocated to fulfill
		 * this request.  This failure may not be permanent.
		 */

#define KERN_NOT_RECEIVER		7
		/* The task in question does not hold receive rights
		 * for the port argument.
		 */

#define KERN_NO_ACCESS			8
		/* Bogus access restriction.
		 */

#define KERN_MEMORY_FAILURE		9
		/* During a page fault, the target address refers to a
		 * memory object that has been destroyed.  This
		 * failure is permanent.
		 */

#define KERN_MEMORY_ERROR		10
		/* During a page fault, the memory object indicated
		 * that the data could not be returned.  This failure
		 * may be temporary; future attempts to access this
		 * same data may succeed, as defined by the memory
		 * object.
		 */

#define	KERN_ALREADY_IN_SET		11
		/* The receive right is already a member of the portset.
		 */

#define KERN_NOT_IN_SET			12
		/* The receive right is not a member of a port set.
		 */

#define KERN_NAME_EXISTS		13
		/* The name already denotes a right in the task.
		 */

#define KERN_ABORTED			14
		/* The operation was aborted.  Ipc code will
		 * catch this and reflect it as a message error.
		 */

#define KERN_INVALID_NAME		15
		/* The name doesn't denote a right in the task.
		 */

#define	KERN_INVALID_TASK		16
		/* Target task isn't an active task.
		 */

#define KERN_INVALID_RIGHT		17
		/* The name denotes a right, but not an appropriate right.
		 */

#define KERN_INVALID_VALUE		18
		/* A blatant range error.
		 */

#define	KERN_UREFS_OVERFLOW		19
		/* Operation would overflow limit on user-references.
		 */

#define	KERN_INVALID_CAPABILITY		20
		/* The supplied (port) capability is improper.
		 */

#define KERN_RIGHT_EXISTS		21
		/* The task already has send or receive rights
		 * for the port under another name.
		 */

#define	KERN_INVALID_HOST		22
		/* Target host isn't actually a host.
		 */

#define KERN_MEMORY_PRESENT		23
		/* An attempt was made to supply "precious" data
		 * for memory that is already present in a
		 * memory object.
		 */

#define KERN_MEMORY_DATA_MOVED		24
		/* A page was requested of a memory manager via
		 * memory_object_data_request for an object using
		 * a MEMORY_OBJECT_COPY_CALL strategy, with the
		 * VM_PROT_WANTS_COPY flag being used to specify
		 * that the page desired is for a copy of the
		 * object, and the memory manager has detected
		 * the page was pushed into a copy of the object
		 * while the kernel was walking the shadow chain
		 * from the copy to the object. This error code
		 * is delivered via memory_object_data_error
		 * and is handled by the kernel (it forces the
		 * kernel to restart the fault). It will not be
		 * seen by users.
		 */

#define KERN_MEMORY_RESTART_COPY	25
		/* A strategic copy was attempted of an object
		 * upon which a quicker copy is now possible.
		 * The caller should retry the copy using
		 * vm_object_copy_quickly. This error code
		 * is seen only by the kernel.
		 */

#define KERN_INVALID_PROCESSOR_SET	26
		/* An argument applied to assert processor set privilege
		 * was not a processor set control port.
		 */

#define KERN_POLICY_LIMIT		27
		/* The specified scheduling attributes exceed the thread's
		 * limits.
		 */

#define KERN_INVALID_POLICY		28
		/* The specified scheduling policy is not currently
		 * enabled for the processor set.
		 */

#define KERN_INVALID_OBJECT		29
		/* The external memory manager failed to initialize the
		 * memory object.
		 */

#define KERN_ALREADY_WAITING		30
		/* A thread is attempting to wait for an event for which 
		 * there is already a waiting thread.
		 */

#define KERN_DEFAULT_SET		31
		/* An attempt was made to destroy the default processor
		 * set.
		 */

#define KERN_EXCEPTION_PROTECTED	32
		/* An attempt was made to fetch an exception port that is
		 * protected, or to abort a thread while processing a
		 * protected exception.
		 */

#define KERN_INVALID_LEDGER		33
		/* A ledger was required but not supplied.
		 */

#define KERN_INVALID_MEMORY_CONTROL	34
		/* The port was not a memory cache control port.
		 */

#define KERN_INVALID_SECURITY		35
		/* An argument supplied to assert security privilege 	
		 * was not a host security port.
		 */
		
#define KERN_NOT_DEPRESSED		36
		/* thread_depress_abort was called on a thread which
		 * was not currently depressed.
		 */
		
#define KERN_TERMINATED			37
		/* Object has been terminated and is no longer available
		 */

#define KERN_LOCK_SET_DESTROYED		38
		/* Lock set has been destroyed and is no longer available.
		 */

#define KERN_LOCK_UNSTABLE		39
		/* The thread holding the lock terminated before releasing
		 * the lock
		 */

#define KERN_LOCK_OWNED			40
		/* The lock is already owned by another thread
		 */

#define KERN_LOCK_OWNED_SELF		41
		/* The lock is already owned by the calling thread
		 */

#define KERN_SEMAPHORE_DESTROYED	42
		/* Semaphore has been destroyed and is no longer available.
		 */

#define KERN_RPC_SERVER_TERMINATED	43
		/* Return from RPC indicating the target server was 
		 * terminated before it successfully replied 
		 */

#define KERN_RPC_TERMINATE_ORPHAN	44
		/* Terminate an orphaned activation.
		 */

#define KERN_RPC_CONTINUE_ORPHAN	45
		/* Allow an orphaned activation to continue executing.
		 */

#define	KERN_NOT_SUPPORTED		46
		/* Empty thread activation (No thread linked to it)
		 */

#define	KERN_NODE_DOWN			47
		/* Remote node down or inaccessible.
		 */

#define KERN_NOT_WAITING		48
		/* A signalled thread was not actually waiting. */

#define	KERN_OPERATION_TIMED_OUT        49
		/* Some thread-oriented operation (semaphore_wait) timed out
		 */

#define	KERN_RETURN_MAX			0x100
		/* Maximum return value allowable
		 */

#endif	/* _MACH_KERN_RETURN_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
8ad349bb	4	* @APPLE_LICENSE_OSREFERENCE_HEADER_START@
1c79356b	5	*
8ad349bb A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the
	10	* License may not be used to create, or enable the creation or
	11	* redistribution of, unlawful or unlicensed copies of an Apple operating
	12	* system, or to circumvent, violate, or enable the circumvention or
	13	* violation of, any terms of an Apple operating system software license
	14	* agreement.
	15	*
	16	* Please obtain a copy of the License at
	17	* http://www.opensource.apple.com/apsl/ and read it before using this
	18	* file.
	19	*
	20	* The Original Code and all software distributed under the License are
	21	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	22	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	23	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	24	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	25	* Please see the License for the specific language governing rights and
	26	* limitations under the License.
	27	*
	28	* @APPLE_LICENSE_OSREFERENCE_HEADER_END@
1c79356b A	29	*/
	30	/*
	31	* @OSF_COPYRIGHT@
	32	*/
	33	/*
	34	* Mach Operating System
	35	* Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
	36	* All Rights Reserved.
	37	*
	38	* Permission to use, copy, modify and distribute this software and its
	39	* documentation is hereby granted, provided that both the copyright
	40	* notice and this permission notice appear in all copies of the
	41	* software, derivative works or modified versions, and any portions
	42	* thereof, and that both notices appear in supporting documentation.
	43	*
	44	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	45	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	46	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	47	*
	48	* Carnegie Mellon requests users of this software to return to
	49	*
	50	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	51	* School of Computer Science
	52	* Carnegie Mellon University
	53	* Pittsburgh PA 15213-3890
	54	*
	55	* any improvements or extensions that they make and grant Carnegie Mellon
	56	* the rights to redistribute these changes.
	57	*/
	58	/*
	59	*/
	60	/*
	61	* File: h/kern_return.h
	62	* Author: Avadis Tevanian, Jr.
	63	* Date: 1985
	64	*
	65	* Kernel return codes.
	66	*
	67	*/
	68
	69	#ifndef _MACH_KERN_RETURN_H_
	70	#define _MACH_KERN_RETURN_H_
	71
	72	#include <mach/machine/kern_return.h>
	73
1c79356b A	74	#define KERN_SUCCESS 0
	75
	76	#define KERN_INVALID_ADDRESS 1
	77	/* Specified address is not currently valid.
	78	*/
	79
	80	#define KERN_PROTECTION_FAILURE 2
	81	/* Specified memory is valid, but does not permit the
	82	* required forms of access.
	83	*/
	84
	85	#define KERN_NO_SPACE 3
	86	/* The address range specified is already in use, or
	87	* no address range of the size specified could be
	88	* found.
	89	*/
	90
	91	#define KERN_INVALID_ARGUMENT 4
	92	/* The function requested was not applicable to this
	93	* type of argument, or an argument is invalid
	94	*/
	95
	96	#define KERN_FAILURE 5
	97	/* The function could not be performed. A catch-all.
	98	*/
	99
	100	#define KERN_RESOURCE_SHORTAGE 6
	101	/* A system resource could not be allocated to fulfill
	102	* this request. This failure may not be permanent.
	103	*/
	104
	105	#define KERN_NOT_RECEIVER 7
	106	/* The task in question does not hold receive rights
	107	* for the port argument.
	108	*/
	109
	110	#define KERN_NO_ACCESS 8
	111	/* Bogus access restriction.
	112	*/
	113
	114	#define KERN_MEMORY_FAILURE 9
	115	/* During a page fault, the target address refers to a
	116	* memory object that has been destroyed. This
	117	* failure is permanent.
	118	*/
	119
	120	#define KERN_MEMORY_ERROR 10
	121	/* During a page fault, the memory object indicated
	122	* that the data could not be returned. This failure
	123	* may be temporary; future attempts to access this
	124	* same data may succeed, as defined by the memory
	125	* object.
	126	*/
	127
	128	#define KERN_ALREADY_IN_SET 11
	129	/* The receive right is already a member of the portset.
	130	*/
	131
	132	#define KERN_NOT_IN_SET 12
	133	/* The receive right is not a member of a port set.
	134	*/
	135
	136	#define KERN_NAME_EXISTS 13
	137	/* The name already denotes a right in the task.
138	*/
139
140	#define KERN_ABORTED 14
141	/* The operation was aborted. Ipc code will
142	* catch this and reflect it as a message error.
143	*/
144
145	#define KERN_INVALID_NAME 15
146	/* The name doesn't denote a right in the task.
147	*/
148
149	#define KERN_INVALID_TASK 16
150	/* Target task isn't an active task.
151	*/
152
153	#define KERN_INVALID_RIGHT 17
154	/* The name denotes a right, but not an appropriate right.
155	*/
156
157	#define KERN_INVALID_VALUE 18
158	/* A blatant range error.
159	*/
160
161	#define KERN_UREFS_OVERFLOW 19
162	/* Operation would overflow limit on user-references.
163	*/
164
165	#define KERN_INVALID_CAPABILITY 20
166	/* The supplied (port) capability is improper.
167	*/
168
169	#define KERN_RIGHT_EXISTS 21
170	/* The task already has send or receive rights
171	* for the port under another name.
172	*/
173
174	#define KERN_INVALID_HOST 22
175	/* Target host isn't actually a host.
176	*/
177
178	#define KERN_MEMORY_PRESENT 23
179	/* An attempt was made to supply "precious" data
180	* for memory that is already present in a
181	* memory object.
182	*/
183
184	#define KERN_MEMORY_DATA_MOVED 24
185	/* A page was requested of a memory manager via
186	* memory_object_data_request for an object using
187	* a MEMORY_OBJECT_COPY_CALL strategy, with the
188	* VM_PROT_WANTS_COPY flag being used to specify
189	* that the page desired is for a copy of the
190	* object, and the memory manager has detected
191	* the page was pushed into a copy of the object
192	* while the kernel was walking the shadow chain
193	* from the copy to the object. This error code
194	* is delivered via memory_object_data_error
195	* and is handled by the kernel (it forces the
196	* kernel to restart the fault). It will not be
197	* seen by users.
198	*/
199
200	#define KERN_MEMORY_RESTART_COPY 25
201	/* A strategic copy was attempted of an object
202	* upon which a quicker copy is now possible.
203	* The caller should retry the copy using
204	* vm_object_copy_quickly. This error code
205	* is seen only by the kernel.
206	*/
207
208	#define KERN_INVALID_PROCESSOR_SET 26
209	/* An argument applied to assert processor set privilege
210	* was not a processor set control port.
211	*/
212
213	#define KERN_POLICY_LIMIT 27
214	/* The specified scheduling attributes exceed the thread's
215	* limits.
216	*/
217
218	#define KERN_INVALID_POLICY 28
219	/* The specified scheduling policy is not currently
220	* enabled for the processor set.
221	*/
222
223	#define KERN_INVALID_OBJECT 29
224	/* The external memory manager failed to initialize the
225	* memory object.
226	*/
227
228	#define KERN_ALREADY_WAITING 30
229	/* A thread is attempting to wait for an event for which
230	* there is already a waiting thread.
231	*/
232
233	#define KERN_DEFAULT_SET 31
234	/* An attempt was made to destroy the default processor
235	* set.
236	*/
237
238	#define KERN_EXCEPTION_PROTECTED 32
239	/* An attempt was made to fetch an exception port that is
240	* protected, or to abort a thread while processing a
241	* protected exception.
242	*/
243
244	#define KERN_INVALID_LEDGER 33
245	/* A ledger was required but not supplied.
246	*/
247
248	#define KERN_INVALID_MEMORY_CONTROL 34
249	/* The port was not a memory cache control port.
250	*/
251
252	#define KERN_INVALID_SECURITY 35
253	/* An argument supplied to assert security privilege
254	* was not a host security port.
255	*/
256
257	#define KERN_NOT_DEPRESSED 36
258	/* thread_depress_abort was called on a thread which
259	* was not currently depressed.
260	*/
261
262	#define KERN_TERMINATED 37
263	/* Object has been terminated and is no longer available
264	*/
265
266	#define KERN_LOCK_SET_DESTROYED 38
267	/* Lock set has been destroyed and is no longer available.
268	*/
269
270	#define KERN_LOCK_UNSTABLE 39
271	/* The thread holding the lock terminated before releasing
272	* the lock
273	*/
274
275	#define KERN_LOCK_OWNED 40
276	/* The lock is already owned by another thread
277	*/
278
279	#define KERN_LOCK_OWNED_SELF 41
280	/* The lock is already owned by the calling thread
281	*/
282
283	#define KERN_SEMAPHORE_DESTROYED 42
284	/* Semaphore has been destroyed and is no longer available.
285	*/
286
287	#define KERN_RPC_SERVER_TERMINATED 43
288	/* Return from RPC indicating the target server was
289	* terminated before it successfully replied
290	*/
291
292	#define KERN_RPC_TERMINATE_ORPHAN 44
293	/* Terminate an orphaned activation.
294	*/
295
296	#define KERN_RPC_CONTINUE_ORPHAN 45
297	/* Allow an orphaned activation to continue executing.
298	*/
299
300	#define KERN_NOT_SUPPORTED 46
301	/* Empty thread activation (No thread linked to it)
302	*/
303
304	#define KERN_NODE_DOWN 47
305	/* Remote node down or inaccessible.
306	*/
307
308	#define KERN_NOT_WAITING 48
309	/* A signalled thread was not actually waiting. */
310
311	#define KERN_OPERATION_TIMED_OUT 49
312	/* Some thread-oriented operation (semaphore_wait) timed out
313	*/
314
315	#define KERN_RETURN_MAX 0x100
316	/* Maximum return value allowable
317	*/
318
319	#endif /* _MACH_KERN_RETURN_H_ */