xref: /xnu-10063.101.15/libsyscall/mach/mach_error_string.c (revision 94d3b452840153a99b38a3a9659680b2a006908e)
1*94d3b452SApple OSS Distributions /*
2*94d3b452SApple OSS Distributions  * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
3*94d3b452SApple OSS Distributions  *
4*94d3b452SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*94d3b452SApple OSS Distributions  *
6*94d3b452SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*94d3b452SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*94d3b452SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*94d3b452SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*94d3b452SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*94d3b452SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*94d3b452SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*94d3b452SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*94d3b452SApple OSS Distributions  *
15*94d3b452SApple OSS Distributions  * Please obtain a copy of the License at
16*94d3b452SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*94d3b452SApple OSS Distributions  *
18*94d3b452SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*94d3b452SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*94d3b452SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*94d3b452SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*94d3b452SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*94d3b452SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*94d3b452SApple OSS Distributions  * limitations under the License.
25*94d3b452SApple OSS Distributions  *
26*94d3b452SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*94d3b452SApple OSS Distributions  */
28*94d3b452SApple OSS Distributions /*
29*94d3b452SApple OSS Distributions  * @OSF_COPYRIGHT@
30*94d3b452SApple OSS Distributions  */
31*94d3b452SApple OSS Distributions /*
32*94d3b452SApple OSS Distributions  * Mach Operating System
33*94d3b452SApple OSS Distributions  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
34*94d3b452SApple OSS Distributions  * All Rights Reserved.
35*94d3b452SApple OSS Distributions  *
36*94d3b452SApple OSS Distributions  * Permission to use, copy, modify and distribute this software and its
37*94d3b452SApple OSS Distributions  * documentation is hereby granted, provided that both the copyright
38*94d3b452SApple OSS Distributions  * notice and this permission notice appear in all copies of the
39*94d3b452SApple OSS Distributions  * software, derivative works or modified versions, and any portions
40*94d3b452SApple OSS Distributions  * thereof, and that both notices appear in supporting documentation.
41*94d3b452SApple OSS Distributions  *
42*94d3b452SApple OSS Distributions  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43*94d3b452SApple OSS Distributions  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44*94d3b452SApple OSS Distributions  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45*94d3b452SApple OSS Distributions  *
46*94d3b452SApple OSS Distributions  * Carnegie Mellon requests users of this software to return to
47*94d3b452SApple OSS Distributions  *
48*94d3b452SApple OSS Distributions  *  Software Distribution Coordinator  or  [email protected]
49*94d3b452SApple OSS Distributions  *  School of Computer Science
50*94d3b452SApple OSS Distributions  *  Carnegie Mellon University
51*94d3b452SApple OSS Distributions  *  Pittsburgh PA 15213-3890
52*94d3b452SApple OSS Distributions  *
53*94d3b452SApple OSS Distributions  * any improvements or extensions that they make and grant Carnegie Mellon
54*94d3b452SApple OSS Distributions  * the rights to redistribute these changes.
55*94d3b452SApple OSS Distributions  */
56*94d3b452SApple OSS Distributions 
57*94d3b452SApple OSS Distributions #include <limits.h>
58*94d3b452SApple OSS Distributions 
59*94d3b452SApple OSS Distributions #include <mach/boolean.h>
60*94d3b452SApple OSS Distributions #include <mach/error.h>
61*94d3b452SApple OSS Distributions #include <mach/mach_error.h>
62*94d3b452SApple OSS Distributions 
63*94d3b452SApple OSS Distributions #include "errorlib.h"
64*94d3b452SApple OSS Distributions #include "externs.h"
65*94d3b452SApple OSS Distributions 
66*94d3b452SApple OSS Distributions static void do_compat(mach_error_t *);
67*94d3b452SApple OSS Distributions 
68*94d3b452SApple OSS Distributions static void
do_compat(mach_error_t * org_err)69*94d3b452SApple OSS Distributions do_compat(mach_error_t *org_err)
70*94d3b452SApple OSS Distributions {
71*94d3b452SApple OSS Distributions 	mach_error_t            err = *org_err;
72*94d3b452SApple OSS Distributions 
73*94d3b452SApple OSS Distributions 	/*
74*94d3b452SApple OSS Distributions 	 * map old error numbers to
75*94d3b452SApple OSS Distributions 	 * to new error sys & subsystem
76*94d3b452SApple OSS Distributions 	 */
77*94d3b452SApple OSS Distributions 
78*94d3b452SApple OSS Distributions 	if ((-200 < err) && (err <= -100)) {
79*94d3b452SApple OSS Distributions 		err = -(err + 100) | IPC_SEND_MOD;
80*94d3b452SApple OSS Distributions 	} else if ((-300 < err) && (err <= -200)) {
81*94d3b452SApple OSS Distributions 		err = -(err + 200) | IPC_RCV_MOD;
82*94d3b452SApple OSS Distributions 	} else if ((-400 < err) && (err <= -300)) {
83*94d3b452SApple OSS Distributions 		err = -(err + 300) | MACH_IPC_MIG_MOD;
84*94d3b452SApple OSS Distributions 	} else if ((1000 <= err) && (err < 1100)) {
85*94d3b452SApple OSS Distributions 		err = (err - 1000) | SERV_NETNAME_MOD;
86*94d3b452SApple OSS Distributions 	} else if ((1600 <= err) && (err < 1700)) {
87*94d3b452SApple OSS Distributions 		err = (err - 1600) | SERV_ENV_MOD;
88*94d3b452SApple OSS Distributions 	} else if ((27600 <= err) && (err < 27700)) {
89*94d3b452SApple OSS Distributions 		err = (err - 27600) | SERV_EXECD_MOD;
90*94d3b452SApple OSS Distributions 	}
91*94d3b452SApple OSS Distributions 
92*94d3b452SApple OSS Distributions 	*org_err = err;
93*94d3b452SApple OSS Distributions }
94*94d3b452SApple OSS Distributions 
95*94d3b452SApple OSS Distributions static int
err_sparse_mapit(int old,const struct error_sparse_map * map_table,int mapcnt)96*94d3b452SApple OSS Distributions err_sparse_mapit(int old, const struct error_sparse_map *map_table, int mapcnt)
97*94d3b452SApple OSS Distributions {
98*94d3b452SApple OSS Distributions 	boolean_t found = FALSE;
99*94d3b452SApple OSS Distributions 	int ret = 0, i;
100*94d3b452SApple OSS Distributions 
101*94d3b452SApple OSS Distributions 	for (i = 0; i < mapcnt; i++) {
102*94d3b452SApple OSS Distributions 		struct error_sparse_map entry = map_table[i];
103*94d3b452SApple OSS Distributions 
104*94d3b452SApple OSS Distributions 		if (entry.start <= old && old <= entry.end) {
105*94d3b452SApple OSS Distributions 			ret += old - entry.start;
106*94d3b452SApple OSS Distributions 			found = TRUE;
107*94d3b452SApple OSS Distributions 			break;
108*94d3b452SApple OSS Distributions 		}
109*94d3b452SApple OSS Distributions 		ret += entry.end - entry.start + 1;
110*94d3b452SApple OSS Distributions 	}
111*94d3b452SApple OSS Distributions 
112*94d3b452SApple OSS Distributions 	return (found)? ret : INT_MAX;
113*94d3b452SApple OSS Distributions }
114*94d3b452SApple OSS Distributions 
115*94d3b452SApple OSS Distributions char *
mach_error_type(mach_error_t err)116*94d3b452SApple OSS Distributions mach_error_type(mach_error_t err)
117*94d3b452SApple OSS Distributions {
118*94d3b452SApple OSS Distributions 	const struct error_system *sys_p;
119*94d3b452SApple OSS Distributions 	int sub, system;
120*94d3b452SApple OSS Distributions 
121*94d3b452SApple OSS Distributions 	do_compat( &err );
122*94d3b452SApple OSS Distributions 
123*94d3b452SApple OSS Distributions 	system = err_get_system(err);
124*94d3b452SApple OSS Distributions 	sys_p = &_mach_errors[system];
125*94d3b452SApple OSS Distributions 	sub = err_get_sub(err);
126*94d3b452SApple OSS Distributions 
127*94d3b452SApple OSS Distributions 	if (system <= err_max_system && sys_p->map_table) {
128*94d3b452SApple OSS Distributions 		sub = err_sparse_mapit(sub, sys_p->map_table, sys_p->map_count);
129*94d3b452SApple OSS Distributions 	}
130*94d3b452SApple OSS Distributions 
131*94d3b452SApple OSS Distributions 	if (system > err_max_system || sub >= sys_p->max_sub) {
132*94d3b452SApple OSS Distributions 		return (char *)"(?/?)";
133*94d3b452SApple OSS Distributions 	}
134*94d3b452SApple OSS Distributions 	return (char *) (sys_p->subsystem[sub].subsys_name);
135*94d3b452SApple OSS Distributions }
136*94d3b452SApple OSS Distributions 
137*94d3b452SApple OSS Distributions boolean_t mach_error_full_diag = FALSE;
138*94d3b452SApple OSS Distributions 
139*94d3b452SApple OSS Distributions __private_extern__ char *
mach_error_string_int(mach_error_t err,boolean_t * diag)140*94d3b452SApple OSS Distributions mach_error_string_int(mach_error_t err, boolean_t *diag)
141*94d3b452SApple OSS Distributions {
142*94d3b452SApple OSS Distributions 	const struct error_system *sys_p;
143*94d3b452SApple OSS Distributions 	const struct error_subsystem *sub_p;
144*94d3b452SApple OSS Distributions 	int sub, system, code;
145*94d3b452SApple OSS Distributions 
146*94d3b452SApple OSS Distributions 	do_compat( &err );
147*94d3b452SApple OSS Distributions 
148*94d3b452SApple OSS Distributions 	system = err_get_system(err);
149*94d3b452SApple OSS Distributions 	sys_p = &_mach_errors[system];
150*94d3b452SApple OSS Distributions 	sub = err_get_sub(err);
151*94d3b452SApple OSS Distributions 	code = err_get_code(err);
152*94d3b452SApple OSS Distributions 
153*94d3b452SApple OSS Distributions 	*diag = TRUE;
154*94d3b452SApple OSS Distributions 
155*94d3b452SApple OSS Distributions 	if (system > err_max_system) {
156*94d3b452SApple OSS Distributions 		return (char *)"(?/?) unknown error system";
157*94d3b452SApple OSS Distributions 	} else if (sys_p->map_table) {
158*94d3b452SApple OSS Distributions 		sub = err_sparse_mapit(sub, sys_p->map_table, sys_p->map_count);
159*94d3b452SApple OSS Distributions 	}
160*94d3b452SApple OSS Distributions 
161*94d3b452SApple OSS Distributions 	if (sub >= sys_p->max_sub) {
162*94d3b452SApple OSS Distributions 		return (char *)sys_p->bad_sub;
163*94d3b452SApple OSS Distributions 	}
164*94d3b452SApple OSS Distributions 
165*94d3b452SApple OSS Distributions 	sub_p = &sys_p->subsystem[sub];
166*94d3b452SApple OSS Distributions 	if (sub_p->map_table) {
167*94d3b452SApple OSS Distributions 		code = err_sparse_mapit(code, sub_p->map_table, sub_p->map_count);
168*94d3b452SApple OSS Distributions 	}
169*94d3b452SApple OSS Distributions 	if (code >= sub_p->max_code) {
170*94d3b452SApple OSS Distributions 		return (char *)NO_SUCH_ERROR;
171*94d3b452SApple OSS Distributions 	}
172*94d3b452SApple OSS Distributions 
173*94d3b452SApple OSS Distributions 	*diag = mach_error_full_diag;
174*94d3b452SApple OSS Distributions 	return (char *)sub_p->codes[code];
175*94d3b452SApple OSS Distributions }
176*94d3b452SApple OSS Distributions 
177*94d3b452SApple OSS Distributions char *
mach_error_string(mach_error_t err)178*94d3b452SApple OSS Distributions mach_error_string(mach_error_t err)
179*94d3b452SApple OSS Distributions {
180*94d3b452SApple OSS Distributions 	boolean_t diag;
181*94d3b452SApple OSS Distributions 
182*94d3b452SApple OSS Distributions 	return mach_error_string_int( err, &diag );
183*94d3b452SApple OSS Distributions }
184*94d3b452SApple OSS Distributions 
185*94d3b452SApple OSS Distributions /* vim: set ts=4: */
186