1/*
2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
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 License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/*
29 * @OSF_COPYRIGHT@
30 */
31/*
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
34 * All Rights Reserved.
35 *
36 * Permission to use, copy, modify and distribute this software and its
37 * documentation is hereby granted, provided that both the copyright
38 * notice and this permission notice appear in all copies of the
39 * software, derivative works or modified versions, and any portions
40 * thereof, and that both notices appear in supporting documentation.
41 *
42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45 *
46 * Carnegie Mellon requests users of this software to return to
47 *
48 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
49 *  School of Computer Science
50 *  Carnegie Mellon University
51 *  Pittsburgh PA 15213-3890
52 *
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
55 */
56/*
57 */
58/*
59 * File:	mach/error.h
60 * Purpose:
61 *	error module definitions
62 *
63 */
64
65#ifndef	_MACH_ERROR_H_
66#define	_MACH_ERROR_H_
67
68#include <mach/kern_return.h>
69
70/*
71 *	error number layout as follows:
72 *
73 *	hi		 		       lo
74 *	| system(6) | subsystem(12) | code(14) |
75 */
76
77
78#define	err_none		(mach_error_t)0
79#define ERR_SUCCESS		(mach_error_t)0
80#define	ERR_ROUTINE_NIL		(mach_error_fn_t)0
81
82
83#define	err_system(x)		(((x)&0x3f)<<26)
84#define err_sub(x)		(((x)&0xfff)<<14)
85
86#define err_get_system(err)	(((err)>>26)&0x3f)
87#define err_get_sub(err)	(((err)>>14)&0xfff)
88#define err_get_code(err)	((err)&0x3fff)
89
90#define system_emask		(err_system(0x3f))
91#define sub_emask		(err_sub(0xfff))
92#define code_emask		(0x3fff)
93
94
95/*	major error systems	*/
96#define	err_kern		err_system(0x0)		/* kernel */
97#define	err_us			err_system(0x1)		/* user space library */
98#define	err_server		err_system(0x2)		/* user space servers */
99#define	err_ipc			err_system(0x3)		/* old ipc errors */
100#define err_mach_ipc		err_system(0x4)		/* mach-ipc errors */
101#define	err_dipc		err_system(0x7)		/* distributed ipc */
102#define err_local		err_system(0x3e)	/* user defined errors */
103#define	err_ipc_compat		err_system(0x3f)	/* (compatibility) mach-ipc errors */
104
105#define	err_max_system		0x3f
106
107
108/*	unix errors get lumped into one subsystem  */
109#define	unix_err(errno)		(err_kern|err_sub(3)|errno)
110
111typedef	kern_return_t	mach_error_t;
112typedef mach_error_t	(* mach_error_fn_t)( void );
113
114#endif	/* _MACH_ERROR_H_ */
115