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

/*
 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_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. 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_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.
 */
/*
 */
/*
 * Mach Interface Generator errors
 *
 */

#ifndef	_MACH_MIG_ERRORS_H_
#define _MACH_MIG_ERRORS_H_

#include <mach/mig.h>
#include <mach/ndr.h>
#include <mach/message.h>
#include <mach/kern_return.h>

#include <sys/cdefs.h>

/*
 *	These error codes should be specified as system 4, subsytem 2.
 *	But alas backwards compatibility makes that impossible.
 *	The problem is old clients of new servers (eg, the kernel)
 *	which get strange large error codes when there is a Mig problem
 *	in the server.  Unfortunately, the IPC system doesn't have
 *	the knowledge to convert the codes in this situation.
 */

#define MIG_TYPE_ERROR		-300	/* client type check failure */
#define MIG_REPLY_MISMATCH	-301	/* wrong reply message ID */
#define MIG_REMOTE_ERROR	-302	/* server detected error */
#define MIG_BAD_ID		-303	/* bad request message ID */
#define MIG_BAD_ARGUMENTS	-304	/* server type check failure */
#define MIG_NO_REPLY		-305	/* no reply should be send */
#define MIG_EXCEPTION		-306	/* server raised exception */
#define MIG_ARRAY_TOO_LARGE	-307	/* array not large enough */
#define MIG_SERVER_DIED		-308	/* server died */
#define MIG_TRAILER_ERROR       -309    /* trailer has an unknown format */

/*
 *	Whenever MIG detects an error, it sends back a generic
 *	mig_reply_error_t format message.  Clients must accept
 *	these in addition to the expected reply message format.
 */
#pragma pack(4)
typedef struct {
	mach_msg_header_t	Head;
	NDR_record_t		NDR;
	kern_return_t		RetCode;
} mig_reply_error_t;
#pragma pack()


__BEGIN_DECLS

#define __NDR_convert__mig_reply_error_t__defined
#if mig_internal
mig_internal
#else
static
#endif
__inline__ void
__NDR_convert__mig_reply_error_t(mig_reply_error_t *x)
{
#if defined(__NDR_convert__int_rep__kern_return_t__defined)
	if (x->NDR.int_rep != NDR_record.int_rep)
		__NDR_convert__int_rep__kern_return_t(&x->RetCode, x->NDR.int_rep);
#endif /* __NDR_convert__int_rep__kern_return_t__defined */
}

__END_DECLS

#endif	/* _MACH_MIG_ERRORS_H_ */
Commit	Line	Data
1c79356b	1	/*
91447636	2	* Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
ff6e181a 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. Please obtain a copy of the License at
	10	* http://www.opensource.apple.com/apsl/ and read it before using this
	11	* file.
e5568f75	12	*
ff6e181a A	13	* The Original Code and all software distributed under the License are
ff6e181a A	14	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	16	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
ff6e181a A	17	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	18	* Please see the License for the specific language governing rights and
	19	* limitations under the License.
1c79356b A	20	*
	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
	23	/*
	24	* @OSF_COPYRIGHT@
	25	*/
	26	/*
	27	* Mach Operating System
	28	* Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
	29	* All Rights Reserved.
	30	*
	31	* Permission to use, copy, modify and distribute this software and its
	32	* documentation is hereby granted, provided that both the copyright
	33	* notice and this permission notice appear in all copies of the
	34	* software, derivative works or modified versions, and any portions
	35	* thereof, and that both notices appear in supporting documentation.
	36	*
	37	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	38	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	39	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	40	*
	41	* Carnegie Mellon requests users of this software to return to
	42	*
	43	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	44	* School of Computer Science
	45	* Carnegie Mellon University
	46	* Pittsburgh PA 15213-3890
	47	*
	48	* any improvements or extensions that they make and grant Carnegie Mellon
	49	* the rights to redistribute these changes.
	50	*/
	51	/*
	52	*/
	53	/*
	54	* Mach Interface Generator errors
	55	*
	56	*/
	57
	58	#ifndef _MACH_MIG_ERRORS_H_
	59	#define _MACH_MIG_ERRORS_H_
	60
9bccf70c A	61	#include <mach/mig.h>
9bccf70c A	62	#include <mach/ndr.h>
1c79356b	63	#include <mach/message.h>
9bccf70c	64	#include <mach/kern_return.h>
1c79356b	65
91447636 A	66	#include <sys/cdefs.h>
91447636 A	67
1c79356b A	68	/*
	69	* These error codes should be specified as system 4, subsytem 2.
	70	* But alas backwards compatibility makes that impossible.
	71	* The problem is old clients of new servers (eg, the kernel)
	72	* which get strange large error codes when there is a Mig problem
	73	* in the server. Unfortunately, the IPC system doesn't have
	74	* the knowledge to convert the codes in this situation.
	75	*/
	76
	77	#define MIG_TYPE_ERROR -300 /* client type check failure */
	78	#define MIG_REPLY_MISMATCH -301 /* wrong reply message ID */
	79	#define MIG_REMOTE_ERROR -302 /* server detected error */
	80	#define MIG_BAD_ID -303 /* bad request message ID */
	81	#define MIG_BAD_ARGUMENTS -304 /* server type check failure */
	82	#define MIG_NO_REPLY -305 /* no reply should be send */
	83	#define MIG_EXCEPTION -306 /* server raised exception */
	84	#define MIG_ARRAY_TOO_LARGE -307 /* array not large enough */
	85	#define MIG_SERVER_DIED -308 /* server died */
	86	#define MIG_TRAILER_ERROR -309 /* trailer has an unknown format */
	87
9bccf70c A	88	/*
	89	* Whenever MIG detects an error, it sends back a generic
	90	* mig_reply_error_t format message. Clients must accept
	91	* these in addition to the expected reply message format.
	92	*/
91447636	93	#pragma pack(4)
1c79356b A	94	typedef struct {
	95	mach_msg_header_t Head;
	96	NDR_record_t NDR;
	97	kern_return_t RetCode;
	98	} mig_reply_error_t;
91447636 A	99	#pragma pack()
	100
	101
	102	__BEGIN_DECLS
1c79356b	103
55e303ae A	104	#define __NDR_convert__mig_reply_error_t__defined
	105	#if mig_internal
	106	mig_internal
	107	#else
	108	static
	109	#endif
	110	__inline__ void
	111	__NDR_convert__mig_reply_error_t(mig_reply_error_t *x)
	112	{
	113	#if defined(__NDR_convert__int_rep__kern_return_t__defined)
	114	if (x->NDR.int_rep != NDR_record.int_rep)
	115	__NDR_convert__int_rep__kern_return_t(&x->RetCode, x->NDR.int_rep);
	116	#endif /* __NDR_convert__int_rep__kern_return_t__defined */
	117	}
	118
91447636	119	__END_DECLS
55e303ae	120
91447636	121	#endif /* _MACH_MIG_ERRORS_H_ */