osfmk/mach/error.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  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@
  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:        mach/error.h
  62  * Purpose:
  63  *      error module definitions
  64  *
  65  */
  66
  67 #ifndef _MACH_ERROR_H_
  68 #define _MACH_ERROR_H_
  69
  70 #include <mach/kern_return.h>
  71
  72 /*
  73  *      error number layout as follows:
  74  *
  75  *      hi                                     lo
  76  *      | system(6) | subsystem(12) | code(14) |
  77  */
  78
  79
  80 #define err_none                (mach_error_t)0
  81 #define ERR_SUCCESS             (mach_error_t)0
  82 #define ERR_ROUTINE_NIL         (mach_error_fn_t)0
  83
  84
  85 #define err_system(x)           (((x)&0x3f)<<26)
  86 #define err_sub(x)              (((x)&0xfff)<<14)
  87
  88 #define err_get_system(err)     (((err)>>26)&0x3f)
  89 #define err_get_sub(err)        (((err)>>14)&0xfff)
  90 #define err_get_code(err)       ((err)&0x3fff)
  91
  92 #define system_emask            (err_system(0x3f))
  93 #define sub_emask               (err_sub(0xfff))
  94 #define code_emask              (0x3fff)
  95
  96
  97 /*      major error systems     */
  98 #define err_kern                err_system(0x0)         /* kernel */
  99 #define err_us                  err_system(0x1)         /* user space library */
 100 #define err_server              err_system(0x2)         /* user space servers */
 101 #define err_ipc                 err_system(0x3)         /* old ipc errors */
 102 #define err_mach_ipc            err_system(0x4)         /* mach-ipc errors */
 103 #define err_dipc                err_system(0x7)         /* distributed ipc */
 104 #define err_local               err_system(0x3e)        /* user defined errors */
 105 #define err_ipc_compat          err_system(0x3f)        /* (compatibility) mach-ipc errors */
 106
 107 #define err_max_system          0x3f
 108
 109
 110 /*      unix errors get lumped into one subsystem  */
 111 #define unix_err(errno)         (err_kern|err_sub(3)|errno)
 112
 113 typedef kern_return_t   mach_error_t;
 114 typedef mach_error_t    (* mach_error_fn_t)( void );
 115
 116 #endif  /* _MACH_ERROR_H_ */