libsyscall/mach/errorlib.h

   1 /*
   2  * Copyright (c) 2019 Apple 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 /*
  33  * Mach Operating System
  34  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  35  * All Rights Reserved.
  36  *
  37  * Permission to use, copy, modify and distribute this software and its
  38  * documentation is hereby granted, provided that both the copyright
  39  * notice and this permission notice appear in all copies of the
  40  * software, derivative works or modified versions, and any portions
  41  * thereof, and that both notices appear in supporting documentation.
  42  *
  43  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS
  44  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  45  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  46  *
  47  * Carnegie Mellon requests users of this software to return to
  48  *
  49  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  50  *  School of Computer Science
  51  *  Carnegie Mellon University
  52  *  Pittsburgh PA 15213-3890
  53  *
  54  * any improvements or extensions that they make and grant Carnegie the
  55  * rights to redistribute these changes.
  56  */
  57
  58 /*
  59  *      File:   errorlib.h
  60  *      Author: Douglas Orr, Carnegie Mellon University
  61  *      Date:   Mar. 1988
  62  *
  63  *      Error bases for subsytems errors.
  64  */
  65
  66 #include <stddef.h>
  67
  68 #include <mach/error.h>
  69 #include <mach/boolean.h>
  70
  71 #define MACH_IPC_SEND_MOD       (err_mach_ipc|err_sub(0))
  72 #define MACH_IPC_RCV_MOD        (err_mach_ipc|err_sub(1))
  73 #define MACH_IPC_MIG_MOD        (err_mach_ipc|err_sub(2))
  74
  75 #define IPC_SEND_MOD            (err_ipc|err_sub(0))
  76 #define IPC_RCV_MOD             (err_ipc|err_sub(1))
  77 #define IPC_MIG_MOD             (err_ipc|err_sub(2))
  78
  79 #define SERV_NETNAME_MOD        (err_server|err_sub(0))
  80 #define SERV_ENV_MOD            (err_server|err_sub(1))
  81 #define SERV_EXECD_MOD          (err_server|err_sub(2))
  82
  83
  84 #define NO_SUCH_ERROR           "unknown error code"
  85
  86 struct error_sparse_map {
  87         unsigned                start;
  88         unsigned                end;
  89 };
  90 #define err_sub_map_entry(start, end)  { err_get_sub(start),  err_get_sub(end) }
  91 #define err_code_map_entry(start, end) { err_get_code(start), err_get_code(end) }
  92
  93 struct error_subsystem {
  94         const char                      *subsys_name;
  95         int                             max_code;
  96         const char * const              *codes;
  97         const struct error_sparse_map   *map_table;
  98         int                             map_count;
  99 };
 100 #define errorlib_system_null    { NULL, 0, NULL, NULL, 0 }
 101
 102 struct error_system {
 103         int                             max_sub;
 104         const char                      *bad_sub;
 105         const struct error_subsystem    *subsystem;
 106         const struct error_sparse_map   *map_table;
 107         int                             map_count;
 108 };
 109 #define errorlib_sub_null       { 0, NULL, NULL, NULL, 0 }
 110
 111 extern const struct error_system        _mach_errors[err_max_system + 1];
 112 char *mach_error_string_int(mach_error_t, boolean_t *);
 113
 114 #define errlib_count(s)         (sizeof(s)/sizeof(s[0]))