errors.c 12.4 KB
Newer Older
1

2
/* Error handling */
Guido van Rossum's avatar
Guido van Rossum committed
3

4
#include "Python.h"
5

6
#ifdef macintosh
7
extern char *PyMac_StrError(int);
8
#undef strerror
9 10 11
#define strerror PyMac_StrError
#endif /* macintosh */

Guido van Rossum's avatar
Guido van Rossum committed
12
#ifndef __STDC__
13
#ifndef MS_WINDOWS
14
extern char *strerror(int);
Guido van Rossum's avatar
Guido van Rossum committed
15
#endif
16
#endif
17

18 19 20 21 22
#ifdef MS_WIN32
#include "windows.h"
#include "winbase.h"
#endif

23 24
#include <ctype.h>

Guido van Rossum's avatar
Guido van Rossum committed
25
void
26
PyErr_Restore(PyObject *type, PyObject *value, PyObject *traceback)
Guido van Rossum's avatar
Guido van Rossum committed
27
{
28
	PyThreadState *tstate = PyThreadState_GET();
29 30 31 32 33 34 35
	PyObject *oldtype, *oldvalue, *oldtraceback;

	if (traceback != NULL && !PyTraceBack_Check(traceback)) {
		/* XXX Should never happen -- fatal error instead? */
		Py_DECREF(traceback);
		traceback = NULL;
	}
36

37 38 39 40 41 42 43 44 45 46 47 48 49
	/* Save these in locals to safeguard against recursive
	   invocation through Py_XDECREF */
	oldtype = tstate->curexc_type;
	oldvalue = tstate->curexc_value;
	oldtraceback = tstate->curexc_traceback;

	tstate->curexc_type = type;
	tstate->curexc_value = value;
	tstate->curexc_traceback = traceback;

	Py_XDECREF(oldtype);
	Py_XDECREF(oldvalue);
	Py_XDECREF(oldtraceback);
50 51 52
}

void
53
PyErr_SetObject(PyObject *exception, PyObject *value)
54
{
55 56 57
	Py_XINCREF(exception);
	Py_XINCREF(value);
	PyErr_Restore(exception, value, (PyObject *)NULL);
Guido van Rossum's avatar
Guido van Rossum committed
58 59 60
}

void
61
PyErr_SetNone(PyObject *exception)
Guido van Rossum's avatar
Guido van Rossum committed
62
{
63
	PyErr_SetObject(exception, (PyObject *)NULL);
Guido van Rossum's avatar
Guido van Rossum committed
64 65 66
}

void
67
PyErr_SetString(PyObject *exception, const char *string)
Guido van Rossum's avatar
Guido van Rossum committed
68
{
69 70 71
	PyObject *value = PyString_FromString(string);
	PyErr_SetObject(exception, value);
	Py_XDECREF(value);
Guido van Rossum's avatar
Guido van Rossum committed
72 73
}

74

75
PyObject *
76
PyErr_Occurred(void)
Guido van Rossum's avatar
Guido van Rossum committed
77
{
78 79 80
	PyThreadState *tstate = PyThreadState_Get();

	return tstate->curexc_type;
Guido van Rossum's avatar
Guido van Rossum committed
81 82
}

83 84

int
85
PyErr_GivenExceptionMatches(PyObject *err, PyObject *exc)
86
{
87 88 89 90
	if (err == NULL || exc == NULL) {
		/* maybe caused by "import exceptions" that failed early on */
		return 0;
	}
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
	if (PyTuple_Check(exc)) {
		int i, n;
		n = PyTuple_Size(exc);
		for (i = 0; i < n; i++) {
			/* Test recursively */
		     if (PyErr_GivenExceptionMatches(
			     err, PyTuple_GET_ITEM(exc, i)))
		     {
			     return 1;
		     }
		}
		return 0;
	}
	/* err might be an instance, so check its class. */
	if (PyInstance_Check(err))
		err = (PyObject*)((PyInstanceObject*)err)->in_class;

	if (PyClass_Check(err) && PyClass_Check(exc))
		return PyClass_IsSubclass(err, exc);

	return err == exc;
}
113

114 115

int
116
PyErr_ExceptionMatches(PyObject *exc)
117 118 119 120 121 122 123 124 125
{
	return PyErr_GivenExceptionMatches(PyErr_Occurred(), exc);
}


/* Used in many places to normalize a raised exception, including in
   eval_code2(), do_raise(), and PyErr_Print()
*/
void
126
PyErr_NormalizeException(PyObject **exc, PyObject **val, PyObject **tb)
127 128 129 130 131
{
	PyObject *type = *exc;
	PyObject *value = *val;
	PyObject *inclass = NULL;

132 133 134 135 136 137
	if (type == NULL) {
		/* This is a bug.  Should never happen.  Don't dump core. */
		PyErr_SetString(PyExc_SystemError,
			"PyErr_NormalizeException() called without exception");
	}

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
	/* If PyErr_SetNone() was used, the value will have been actually
	   set to NULL.
	*/
	if (!value) {
		value = Py_None;
		Py_INCREF(value);
	}

	if (PyInstance_Check(value))
		inclass = (PyObject*)((PyInstanceObject*)value)->in_class;

	/* Normalize the exception so that if the type is a class, the
	   value will be an instance.
	*/
	if (PyClass_Check(type)) {
		/* if the value was not an instance, or is not an instance
		   whose class is (or is derived from) type, then use the
		   value as an argument to instantiation of the type
		   class.
		*/
		if (!inclass || !PyClass_IsSubclass(inclass, type)) {
			PyObject *args, *res;

			if (value == Py_None)
				args = Py_BuildValue("()");
			else if (PyTuple_Check(value)) {
				Py_INCREF(value);
				args = value;
			}
			else
				args = Py_BuildValue("(O)", value);

			if (args == NULL)
				goto finally;
			res = PyEval_CallObject(type, args);
			Py_DECREF(args);
			if (res == NULL)
				goto finally;
			Py_DECREF(value);
			value = res;
		}
179 180 181 182 183 184 185 186
		/* if the class of the instance doesn't exactly match the
		   class of the type, believe the instance
		*/
		else if (inclass != type) {
 			Py_DECREF(type);
			type = inclass;
			Py_INCREF(type);
		}
187 188 189 190 191
	}
	*exc = type;
	*val = value;
	return;
finally:
192 193
	Py_DECREF(type);
	Py_DECREF(value);
194 195 196 197 198 199 200
	Py_XDECREF(*tb);
	PyErr_Fetch(exc, val, tb);
	/* normalize recursively */
	PyErr_NormalizeException(exc, val, tb);
}


Guido van Rossum's avatar
Guido van Rossum committed
201
void
202
PyErr_Fetch(PyObject **p_type, PyObject **p_value, PyObject **p_traceback)
Guido van Rossum's avatar
Guido van Rossum committed
203
{
204 205 206 207 208 209 210 211 212
	PyThreadState *tstate = PyThreadState_Get();

	*p_type = tstate->curexc_type;
	*p_value = tstate->curexc_value;
	*p_traceback = tstate->curexc_traceback;

	tstate->curexc_type = NULL;
	tstate->curexc_value = NULL;
	tstate->curexc_traceback = NULL;
Guido van Rossum's avatar
Guido van Rossum committed
213 214 215
}

void
216
PyErr_Clear(void)
Guido van Rossum's avatar
Guido van Rossum committed
217
{
218
	PyErr_Restore(NULL, NULL, NULL);
Guido van Rossum's avatar
Guido van Rossum committed
219
}
220 221 222 223

/* Convenience functions to set a type error exception and return 0 */

int
224
PyErr_BadArgument(void)
225
{
226 227
	PyErr_SetString(PyExc_TypeError,
			"illegal argument type for built-in operation");
228 229 230
	return 0;
}

231
PyObject *
232
PyErr_NoMemory(void)
233
{
234 235 236 237
	if (PyErr_ExceptionMatches(PyExc_MemoryError))
		/* already current */
		return NULL;

238 239 240 241 242 243 244 245 246
	/* raise the pre-allocated instance if it still exists */
	if (PyExc_MemoryErrorInst)
		PyErr_SetObject(PyExc_MemoryError, PyExc_MemoryErrorInst);
	else
		/* this will probably fail since there's no memory and hee,
		   hee, we have to instantiate this class
		*/
		PyErr_SetNone(PyExc_MemoryError);

247 248 249
	return NULL;
}

250
PyObject *
251
PyErr_SetFromErrnoWithFilename(PyObject *exc, char *filename)
252
{
253
	PyObject *v;
254
	char *s;
255
	int i = errno;
256 257 258
#ifdef MS_WIN32
	char *s_buf = NULL;
#endif
259
#ifdef EINTR
260
	if (i == EINTR && PyErr_CheckSignals())
261
		return NULL;
262
#endif
263 264 265
	if (i == 0)
		s = "Error"; /* Sometimes errno didn't get set */
	else
266
#ifndef MS_WIN32
267
		s = strerror(i);
268 269
#else
	{
270 271 272 273 274
		/* Note that the Win32 errors do not lineup with the
		   errno error.  So if the error is in the MSVC error
		   table, we use it, otherwise we assume it really _is_ 
		   a Win32 error code
		*/
275
		if (i > 0 && i < _sys_nerr) {
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
			s = _sys_errlist[i];
		}
		else {
			int len = FormatMessage(
				FORMAT_MESSAGE_ALLOCATE_BUFFER |
				FORMAT_MESSAGE_FROM_SYSTEM |
				FORMAT_MESSAGE_IGNORE_INSERTS,
				NULL,	/* no message source */
				i,
				MAKELANGID(LANG_NEUTRAL,
					   SUBLANG_DEFAULT),
				           /* Default language */
				(LPTSTR) &s_buf,
				0,	/* size not used */
				NULL);	/* no args */
			s = s_buf;
			/* remove trailing cr/lf and dots */
			while (len > 0 && (s[len-1] <= ' ' || s[len-1] == '.'))
				s[--len] = '\0';
		}
296 297
	}
#endif
298
	if (filename != NULL)
299
		v = Py_BuildValue("(iss)", i, s, filename);
300
	else
301
		v = Py_BuildValue("(is)", i, s);
302
	if (v != NULL) {
303 304
		PyErr_SetObject(exc, v);
		Py_DECREF(v);
305
	}
306
#ifdef MS_WIN32
307
	LocalFree(s_buf);
308
#endif
309 310
	return NULL;
}
311

312 313

PyObject *
314
PyErr_SetFromErrno(PyObject *exc)
315 316 317
{
	return PyErr_SetFromErrnoWithFilename(exc, NULL);
}
Guido van Rossum's avatar
Guido van Rossum committed
318

319 320 321
#ifdef MS_WINDOWS 
/* Windows specific error code handling */
PyObject *PyErr_SetFromWindowsErrWithFilename(
322
	int ierr,
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
	const char *filename)
{
	int len;
	char *s;
	PyObject *v;
	DWORD err = (DWORD)ierr;
	if (err==0) err = GetLastError();
	len = FormatMessage(
		/* Error API error */
		FORMAT_MESSAGE_ALLOCATE_BUFFER |
		FORMAT_MESSAGE_FROM_SYSTEM |
		FORMAT_MESSAGE_IGNORE_INSERTS,
		NULL,	/* no message source */
		err,
		MAKELANGID(LANG_NEUTRAL,
		SUBLANG_DEFAULT), /* Default language */
		(LPTSTR) &s,
		0,	/* size not used */
		NULL);	/* no args */
	/* remove trailing cr/lf and dots */
	while (len > 0 && (s[len-1] <= ' ' || s[len-1] == '.'))
		s[--len] = '\0';
345
	if (filename != NULL)
346 347 348 349
		v = Py_BuildValue("(iss)", err, s, filename);
	else
		v = Py_BuildValue("(is)", err, s);
	if (v != NULL) {
350
		PyErr_SetObject(PyExc_WindowsError, v);
351 352 353 354 355 356 357 358 359 360 361 362
		Py_DECREF(v);
	}
	LocalFree(s);
	return NULL;
}

PyObject *PyErr_SetFromWindowsErr(int ierr)
{
	return PyErr_SetFromWindowsErrWithFilename(ierr, NULL);
}
#endif /* MS_WINDOWS */

363 364 365 366 367 368 369 370 371 372 373
void
_PyErr_BadInternalCall(char *filename, int lineno)
{
	PyErr_Format(PyExc_SystemError,
		     "%s:%d: bad argument to internal function",
		     filename, lineno);
}

/* Remove the preprocessor macro for PyErr_BadInternalCall() so that we can
   export the entry point for existing object code: */
#undef PyErr_BadInternalCall
Guido van Rossum's avatar
Guido van Rossum committed
374
void
375
PyErr_BadInternalCall(void)
Guido van Rossum's avatar
Guido van Rossum committed
376
{
377 378
	PyErr_Format(PyExc_SystemError,
		     "bad argument to internal function");
Guido van Rossum's avatar
Guido van Rossum committed
379
}
380 381
#define PyErr_BadInternalCall() _PyErr_BadInternalCall(__FILE__, __LINE__)

382 383 384 385 386 387


PyObject *
PyErr_Format(PyObject *exception, const char *format, ...)
{
	va_list vargs;
388 389 390 391
	int n, i;
	const char* f;
	char* s;
	PyObject* string;
392

393 394 395
	/* step 1: figure out how large a buffer we need */

#ifdef HAVE_STDARG_PROTOTYPES
396
	va_start(vargs, format);
397 398 399
#else
	va_start(vargs);
#endif
400

401 402 403 404 405 406 407 408
	n = 0;
	for (f = format; *f; f++) {
		if (*f == '%') {
			const char* p = f;
			while (*++f && *f != '%' && !isalpha(*f))
				;
			switch (*f) {
			case 'c':
409
				(void) va_arg(vargs, int);
410 411 412 413 414
				/* fall through... */
			case '%':
				n++;
				break;
			case 'd': case 'i': case 'x':
415
				(void) va_arg(vargs, int);
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
				/* 20 bytes should be enough to hold a 64-bit
				   integer */
				n = n + 20;
				break;
			case 's':
				s = va_arg(vargs, char*);
				n = n + strlen(s);
				break;
			default:
				/* if we stumble upon an unknown
				   formatting code, copy the rest of
				   the format string to the output
				   string. (we cannot just skip the
				   code, since there's no way to know
				   what's in the argument list) */ 
				n = n + strlen(p);
				goto expand;
			}
		} else
			n = n + 1;
	}
	
 expand:
	
	string = PyString_FromStringAndSize(NULL, n);
	if (!string)
		return NULL;
	
#ifdef HAVE_STDARG_PROTOTYPES
	va_start(vargs, format);
#else
	va_start(vargs);
#endif

	/* step 2: fill the buffer */

	s = PyString_AsString(string);

	for (f = format; *f; f++) {
		if (*f == '%') {
			const char* p = f++;
			/* parse the width.precision part (we're only
			   interested in the precision value, if any) */
			n = 0;
			while (isdigit(*f))
				n = (n*10) + *f++ - '0';
			if (*f == '.') {
				f++;
				n = 0;
				while (isdigit(*f))
					n = (n*10) + *f++ - '0';
			}
			while (*f && *f != '%' && !isalpha(*f))
				f++;
			switch (*f) {
			case 'c':
				*s++ = va_arg(vargs, int);
				break;
			case 'd': 
				sprintf(s, "%d", va_arg(vargs, int));
				s = s + strlen(s);
				break;
			case 'i':
				sprintf(s, "%i", va_arg(vargs, int));
				s = s + strlen(s);
				break;
			case 'x':
				sprintf(s, "%x", va_arg(vargs, int));
				s = s + strlen(s);
				break;
			case 's':
				p = va_arg(vargs, char*);
				i = strlen(p);
				if (n > 0 && i > n)
					i = n;
				memcpy(s, p, i);
				s = s + i;
				break;
			case '%':
				*s++ = '%';
				break;
			default:
				strcpy(s, p);
				s = s + strlen(s);
				goto end;
			}
		} else
			*s++ = *f;
	}
	
 end:
	
	_PyString_Resize(&string, s - PyString_AsString(string));
	
	PyErr_SetObject(exception, string);
	Py_XDECREF(string);
	
513 514
	return NULL;
}
515 516 517


PyObject *
518
PyErr_NewException(char *name, PyObject *base, PyObject *dict)
519
{
520 521 522 523 524
	char *dot;
	PyObject *modulename = NULL;
	PyObject *classname = NULL;
	PyObject *mydict = NULL;
	PyObject *bases = NULL;
525
	PyObject *result = NULL;
526 527 528 529
	dot = strrchr(name, '.');
	if (dot == NULL) {
		PyErr_SetString(PyExc_SystemError,
			"PyErr_NewException: name must be module.class");
530
		return NULL;
531 532 533 534 535 536 537
	}
	if (base == NULL)
		base = PyExc_Exception;
	if (!PyClass_Check(base)) {
		/* Must be using string-based standard exceptions (-X) */
		return PyString_FromString(name);
	}
538
	if (dict == NULL) {
539
		dict = mydict = PyDict_New();
540 541 542
		if (dict == NULL)
			goto failure;
	}
543 544 545 546 547 548 549 550 551 552 553 554
	if (PyDict_GetItemString(dict, "__module__") == NULL) {
		modulename = PyString_FromStringAndSize(name, (int)(dot-name));
		if (modulename == NULL)
			goto failure;
		if (PyDict_SetItemString(dict, "__module__", modulename) != 0)
			goto failure;
	}
	classname = PyString_FromString(dot+1);
	if (classname == NULL)
		goto failure;
	bases = Py_BuildValue("(O)", base);
	if (bases == NULL)
555
		goto failure;
556
	result = PyClass_New(bases, dict, classname);
557
  failure:
558 559 560 561
	Py_XDECREF(bases);
	Py_XDECREF(mydict);
	Py_XDECREF(classname);
	Py_XDECREF(modulename);
562 563
	return result;
}
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590

/* Call when an exception has occurred but there is no way for Python
   to handle it.  Examples: exception in __del__ or during GC. */
void
PyErr_WriteUnraisable(PyObject *obj)
{
	PyObject *f, *t, *v, *tb;
	PyErr_Fetch(&t, &v, &tb);
	f = PySys_GetObject("stderr");
	if (f != NULL) {
		PyFile_WriteString("Exception ", f);
		if (t) {
			PyFile_WriteObject(t, f, Py_PRINT_RAW);
			if (v && v != Py_None) {
				PyFile_WriteString(": ", f);
				PyFile_WriteObject(v, f, 0);
			}
		}
		PyFile_WriteString(" in ", f);
		PyFile_WriteObject(obj, f, 0);
		PyFile_WriteString(" ignored\n", f);
		PyErr_Clear(); /* Just in case */
	}
	Py_XDECREF(t);
	Py_XDECREF(v);
	Py_XDECREF(tb);
}