mach/mach_error_string.c

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