mach/mach_error_string.c

   1 /*
   2  * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  * @OSF_COPYRIGHT@
  27  */
  28 /*
  29  * Mach Operating System
  30  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  31  * All Rights Reserved.
  32  *
  33  * Permission to use, copy, modify and distribute this software and its
  34  * documentation is hereby granted, provided that both the copyright
  35  * notice and this permission notice appear in all copies of the
  36  * software, derivative works or modified versions, and any portions
  37  * thereof, and that both notices appear in supporting documentation.
  38  *
  39  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  40  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  41  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  42  *
  43  * Carnegie Mellon requests users of this software to return to
  44  *
  45  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  46  *  School of Computer Science
  47  *  Carnegie Mellon University
  48  *  Pittsburgh PA 15213-3890
  49  *
  50  * any improvements or extensions that they make and grant Carnegie Mellon
  51  * the rights to redistribute these changes.
  52  */
  53
  54 #include <mach/boolean.h>
  55 #include <mach/error.h>
  56 #include <mach/mach_error.h>
  57
  58 #include "errorlib.h"
  59 #include "externs.h"
  60
  61 static void do_compat(mach_error_t *);
  62
  63 static void
  64 do_compat(mach_error_t *org_err)
  65 {
  66         mach_error_t            err = *org_err;
  67
  68         /*
  69          * map old error numbers to
  70          * to new error sys & subsystem
  71          */
  72
  73         if ((-200 < err) && (err <= -100))
  74                 err = -(err + 100) | IPC_SEND_MOD;
  75         else if ((-300 < err) && (err <= -200))
  76                 err = -(err + 200) | IPC_RCV_MOD;
  77         else if ((-400 < err) && (err <= -300))
  78                 err = -(err + 300) | MACH_IPC_MIG_MOD;
  79         else if ((1000 <= err) && (err < 1100))
  80                 err = (err - 1000) | SERV_NETNAME_MOD;
  81         else if ((1600 <= err) && (err < 1700))
  82                 err = (err - 1600) | SERV_ENV_MOD;
  83         else if ((27600 <= err) && (err < 27700))
  84                 err = (err - 27600) | SERV_EXECD_MOD;
  85
  86         *org_err = err;
  87 }
  88
  89 char *
  90 mach_error_type(mach_error_t err)
  91 {
  92         int sub, system;
  93
  94         do_compat( &err );
  95
  96         sub = err_get_sub(err);
  97         system = err_get_system(err);
  98
  99         if (system > err_max_system || sub >= _mach_errors[system].max_sub)
 100             return((char *)"(?/?)");
 101         return(_mach_errors[system].subsystem[sub].subsys_name);
 102 }
 103
 104 boolean_t mach_error_full_diag = FALSE;
 105
 106 __private_extern__ char *
 107 mach_error_string_int(mach_error_t err, boolean_t *diag)
 108 {
 109         int sub, system, code;
 110
 111         do_compat( &err );
 112
 113         sub = err_get_sub(err);
 114         system = err_get_system(err);
 115         code = err_get_code(err);
 116
 117         *diag = TRUE;
 118
 119         if (system > err_max_system)
 120             return((char *)"(?/?) unknown error system");
 121         if (sub >= _mach_errors[system].max_sub)
 122             return(_mach_errors[system].bad_sub);
 123         if (code >= _mach_errors[system].subsystem[sub].max_code)
 124             return ((char *)NO_SUCH_ERROR);
 125
 126         *diag = mach_error_full_diag;
 127         return( _mach_errors[system].subsystem[sub].codes[code] );
 128 }
 129
 130 char *
 131 mach_error_string(mach_error_t err)
 132 {
 133         boolean_t diag;
 134
 135         return mach_error_string_int( err, &diag );
 136
 137 }