1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
/*
* $Header$
*
* Copyright 2006 Massachusetts Institute of Technology.
* All Rights Reserved.
*
* Export of this software from the United States of America may
* require a specific license from the United States Government.
* It is the responsibility of any person or organization contemplating
* export to obtain such a license before exporting.
*
* WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
* distribute this software and its documentation for any purpose and
* without fee is hereby granted, provided that the above copyright
* notice appear in all copies and that both that copyright notice and
* this permission notice appear in supporting documentation, and that
* the name of M.I.T. not be used in advertising or publicity pertaining
* to distribution of the software without specific, written prior
* permission. Furthermore if you modify this software you must label
* your software as modified software and not distribute it in such a
* fashion that it might be confused with the original M.I.T. software.
* M.I.T. makes no representations about the suitability of
* this software for any purpose. It is provided "as is" without express
* or implied warranty.
*/
#include "kim_private.h"
#include <com_err.h>
#include <CredentialsCache.h>
struct kim_error_opaque {
kim_error_code code;
kim_string message;
};
struct kim_error_opaque kim_no_memory_error_struct = { KIM_OUT_OF_MEMORY_ECODE, NULL, };
kim_error kim_no_memory_error = &kim_no_memory_error_struct;
struct kim_error_opaque kim_error_initializer = { KIM_NO_ERROR_ECODE, NULL };
/* ------------------------------------------------------------------------ */
static inline kim_error kim_error_allocate (kim_error *out_error,
kim_error_code in_code)
{
kim_error err = KIM_NO_ERROR;
kim_error error = NULL;
/* short circuit out of memory errors so we don't loop */
switch (in_code) {
case 0:
return KIM_NO_ERROR;
case KIM_OUT_OF_MEMORY_ECODE:
case ENOMEM:
case KRB5_CC_NOMEM:
case ccErrNoMem:
// case klMemFullErr:
// case memFullErr:
return kim_no_memory_error;
}
if (!err) {
error = malloc (sizeof (*error));
if (!error) {
err = kim_no_memory_error;
} else {
*error = kim_error_initializer;
}
}
if (!err) {
error->code = in_code;
*out_error = error;
error = NULL;
}
kim_error_free (&error);
return check_error (err);
}
/* ------------------------------------------------------------------------ */
static kim_boolean kim_error_is_builtin (kim_error in_error)
{
return (in_error == KIM_NO_ERROR ||
in_error == kim_no_memory_error);
}
#pragma mark -- Helper Functions --
/* These helper functions exist so we get type checking on common errors */
/* ------------------------------------------------------------------------ */
kim_error _kim_error_create_for_param (kim_string in_function,
unsigned int in_argument_position,
kim_string in_argument_name,
kim_string in_invalid_value)
{
return kim_error_create_from_code (KIM_PARAMETER_ECODE,
in_function,
in_argument_position,
in_argument_name,
in_invalid_value);
}
#pragma mark -- Generic Functions --
/* ------------------------------------------------------------------------ */
kim_error kim_error_create_from_code (kim_error_code in_code,
...)
{
kim_error err = KIM_NO_ERROR;
va_list args;
va_start (args, in_code);
err = kim_error_create_from_code_va (in_code, args);
va_end (args);
return check_error (err);
}
/* ------------------------------------------------------------------------ */
kim_error kim_error_create_from_code_va (kim_error_code in_code,
va_list in_args)
{
kim_error err = KIM_NO_ERROR;
kim_error error = KIM_NO_ERROR;
if (!err) {
err = kim_error_allocate (&error, in_code);
}
if (!err && !kim_error_is_builtin (error)) {
err = kim_string_create_from_format_va_retcode (&error->message,
error_message (in_code),
in_args);
}
if (!err) {
err = error;
error = NULL; /* take ownership */
}
kim_error_free (&error);
return err;
}
/* ------------------------------------------------------------------------ */
kim_error kim_error_create_from_krb5_error (krb5_context in_context,
krb5_error_code in_code)
{
kim_error err = KIM_NO_ERROR;
kim_error error = KIM_NO_ERROR;
if (!err) {
err = kim_error_allocate (&error, in_code);
}
if (!err && !kim_error_is_builtin (error)) {
const char *message = krb5_get_error_message (in_context, in_code);
err = kim_string_copy (&error->message, message);
if (message) { krb5_free_error_message (in_context, message); }
}
if (!err) {
err = error;
error = NULL; /* take ownership */
}
kim_error_free (&error);
return err;
}
/* ------------------------------------------------------------------------ */
kim_error kim_error_copy (kim_error *out_error,
kim_error in_error)
{
kim_error err = KIM_NO_ERROR;
kim_error error = KIM_NO_ERROR;
if (!err && !out_error) { err = param_error (1, "out_error", "NULL"); }
if (!err && !in_error ) { err = param_error (2, "in_error", "NULL"); }
if (!err) {
if (kim_error_is_builtin (in_error)) {
error = in_error;
} else {
err = kim_error_allocate (&error, in_error->code);
if (!err && in_error->message) {
err = kim_string_copy (&error->message, in_error->message);
}
}
}
if (!err) {
*out_error = error;
error = KIM_NO_ERROR;
}
kim_error_free (&error);
return check_error (err);
}
/* ------------------------------------------------------------------------ */
kim_error_code kim_error_get_code (kim_error in_error)
{
if (!in_error) { /* KIM_NO_ERROR */
return KIM_NO_ERROR_ECODE;
} else {
return in_error->code;
}
}
/* ------------------------------------------------------------------------ */
kim_string kim_error_get_display_string (kim_error in_error)
{
if (!in_error) { /* KIM_NO_ERROR */
return error_message (KIM_NO_ERROR_ECODE);
} else if (in_error->message) {
return in_error->message;
} else {
/* Note: kim_no_memory_error will get here because its string is NULL */
return error_message (in_error->code);
}
}
/* ------------------------------------------------------------------------ */
void kim_error_free (kim_error *io_error)
{
if (io_error && *io_error) {
if (kim_error_is_builtin (*io_error)) {
kim_string_free (&(*io_error)->message);
free (*io_error);
*io_error = KIM_NO_ERROR;
}
}
}
#pragma mark -- Debugging Functions --
/* ------------------------------------------------------------------------ */
kim_error _check_error (kim_error in_err,
kim_string in_function,
kim_string in_file,
int in_line)
{
if (in_err) {
kim_error_code code = kim_error_get_code (in_err);
kim_string message = kim_error_get_display_string (in_err);
kim_debug_printf ("%s(): got %d ('%s') at %s: %d",
in_function, code, message, in_file, in_line);
}
return in_err;
}
|
