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

/*
 * Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 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>

/*
 *	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.
 */
typedef struct {
	mach_msg_header_t	Head;
	NDR_record_t		NDR;
	kern_return_t		RetCode;
} mig_reply_error_t;

#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 */
}

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