marshal.c 17.9 KB
Newer Older
Guido van Rossum's avatar
Guido van Rossum committed
1 2 3 4 5 6

/* Write Python objects to files and read them back.
   This is intended for writing and reading compiled Python code only;
   a true persistent storage facility would be much harder, since
   it would have to take circular links and sharing into account. */

7
#include "Python.h"
Guido van Rossum's avatar
Guido van Rossum committed
8 9 10 11
#include "longintrepr.h"
#include "compile.h"
#include "marshal.h"

12 13 14 15 16 17
/* High water mark to determine when the marshalled object is dangerously deep
 * and risks coring the interpreter.  When the object stack gets this deep,
 * raise an exception instead of continuing.
 */
#define MAX_MARSHAL_STACK_DEPTH 5000

Guido van Rossum's avatar
Guido van Rossum committed
18 19
#define TYPE_NULL	'0'
#define TYPE_NONE	'N'
20
#define TYPE_STOPITER	'S'
21
#define TYPE_ELLIPSIS   '.'
Guido van Rossum's avatar
Guido van Rossum committed
22
#define TYPE_INT	'i'
23
#define TYPE_INT64	'I'
Guido van Rossum's avatar
Guido van Rossum committed
24
#define TYPE_FLOAT	'f'
25
#define TYPE_COMPLEX	'x'
Guido van Rossum's avatar
Guido van Rossum committed
26 27 28 29 30
#define TYPE_LONG	'l'
#define TYPE_STRING	's'
#define TYPE_TUPLE	'('
#define TYPE_LIST	'['
#define TYPE_DICT	'{'
31
#define TYPE_CODE	'c'
32
#define TYPE_UNICODE	'u'
Guido van Rossum's avatar
Guido van Rossum committed
33 34
#define TYPE_UNKNOWN	'?'

35 36
typedef struct {
	FILE *fp;
37
	int error;
38
	int depth;
39
	/* If fp == NULL, the following are valid: */
40
	PyObject *str;
41 42 43
	char *ptr;
	char *end;
} WFILE;
Guido van Rossum's avatar
Guido van Rossum committed
44

45 46 47 48 49
#define w_byte(c, p) if (((p)->fp)) putc((c), (p)->fp); \
		      else if ((p)->ptr != (p)->end) *(p)->ptr++ = (c); \
			   else w_more(c, p)

static void
50
w_more(int c, WFILE *p)
51 52 53 54
{
	int size, newsize;
	if (p->str == NULL)
		return; /* An error already occurred */
55
	size = PyString_Size(p->str);
56
	newsize = size + 1024;
57
	if (_PyString_Resize(&p->str, newsize) != 0) {
58 59 60
		p->ptr = p->end = NULL;
	}
	else {
61 62 63
		p->ptr = PyString_AS_STRING((PyStringObject *)p->str) + size;
		p->end =
			PyString_AS_STRING((PyStringObject *)p->str) + newsize;
64
		*p->ptr++ = Py_SAFE_DOWNCAST(c, int, char);
65 66 67 68
	}
}

static void
69
w_string(char *s, int n, WFILE *p)
70 71 72 73 74 75 76 77 78 79 80 81 82
{
	if (p->fp != NULL) {
		fwrite(s, 1, n, p->fp);
	}
	else {
		while (--n >= 0) {
			w_byte(*s, p);
			s++;
		}
	}
}

static void
83
w_short(int x, WFILE *p)
Guido van Rossum's avatar
Guido van Rossum committed
84
{
85 86
	w_byte((char)( x      & 0xff), p);
	w_byte((char)((x>> 8) & 0xff), p);
Guido van Rossum's avatar
Guido van Rossum committed
87 88
}

89
static void
90
w_long(long x, WFILE *p)
Guido van Rossum's avatar
Guido van Rossum committed
91
{
92 93 94 95
	w_byte((char)( x      & 0xff), p);
	w_byte((char)((x>> 8) & 0xff), p);
	w_byte((char)((x>>16) & 0xff), p);
	w_byte((char)((x>>24) & 0xff), p);
Guido van Rossum's avatar
Guido van Rossum committed
96 97
}

98
#if SIZEOF_LONG > 4
99
static void
100
w_long64(long x, WFILE *p)
101 102
{
	w_long(x, p);
103
	w_long(x>>32, p);
104
}
105
#endif
106

107
static void
108
w_object(PyObject *v, WFILE *p)
Guido van Rossum's avatar
Guido van Rossum committed
109
{
110
	int i, n;
111 112

	p->depth++;
113

114 115
	if (p->depth > MAX_MARSHAL_STACK_DEPTH) {
		p->error = 2;
116
	}
117
	else if (v == NULL) {
118
		w_byte(TYPE_NULL, p);
119 120
	}
	else if (v == Py_None) {
121
		w_byte(TYPE_NONE, p);
122
	}
123 124 125
	else if (v == PyExc_StopIteration) {
		w_byte(TYPE_STOPITER, p);
	}
126 127 128
	else if (v == Py_Ellipsis) {
	        w_byte(TYPE_ELLIPSIS, p);
	}
129 130
	else if (PyInt_Check(v)) {
		long x = PyInt_AS_LONG((PyIntObject *)v);
131
#if SIZEOF_LONG > 4
132
		long y = Py_ARITHMETIC_RIGHT_SHIFT(long, x, 31);
133 134 135 136
		if (y && y != -1) {
			w_byte(TYPE_INT64, p);
			w_long64(x, p);
		}
137 138 139
		else
#endif
			{
140 141 142
			w_byte(TYPE_INT, p);
			w_long(x, p);
		}
Guido van Rossum's avatar
Guido van Rossum committed
143
	}
144 145
	else if (PyLong_Check(v)) {
		PyLongObject *ob = (PyLongObject *)v;
146
		w_byte(TYPE_LONG, p);
Guido van Rossum's avatar
Guido van Rossum committed
147
		n = ob->ob_size;
148
		w_long((long)n, p);
Guido van Rossum's avatar
Guido van Rossum committed
149 150 151
		if (n < 0)
			n = -n;
		for (i = 0; i < n; i++)
152
			w_short(ob->ob_digit[i], p);
Guido van Rossum's avatar
Guido van Rossum committed
153
	}
154
	else if (PyFloat_Check(v)) {
Guido van Rossum's avatar
Guido van Rossum committed
155
		char buf[256]; /* Plenty to format any double */
156
		PyFloat_AsReprString(buf, (PyFloatObject *)v);
Guido van Rossum's avatar
Guido van Rossum committed
157
		n = strlen(buf);
158
		w_byte(TYPE_FLOAT, p);
159 160
		w_byte(n, p);
		w_string(buf, n, p);
Guido van Rossum's avatar
Guido van Rossum committed
161
	}
162
#ifndef WITHOUT_COMPLEX
163
	else if (PyComplex_Check(v)) {
164
		char buf[256]; /* Plenty to format any double */
165
		PyFloatObject *temp;
166
		w_byte(TYPE_COMPLEX, p);
167 168
		temp = (PyFloatObject*)PyFloat_FromDouble(
			PyComplex_RealAsDouble(v));
169
		PyFloat_AsReprString(buf, temp);
170
		Py_DECREF(temp);
171 172 173
		n = strlen(buf);
		w_byte(n, p);
		w_string(buf, n, p);
174 175
		temp = (PyFloatObject*)PyFloat_FromDouble(
			PyComplex_ImagAsDouble(v));
176
		PyFloat_AsReprString(buf, temp);
177
		Py_DECREF(temp);
178 179 180 181 182
		n = strlen(buf);
		w_byte(n, p);
		w_string(buf, n, p);
	}
#endif
183
	else if (PyString_Check(v)) {
184
		w_byte(TYPE_STRING, p);
185
		n = PyString_GET_SIZE(v);
186
		w_long((long)n, p);
187 188
		w_string(PyString_AS_STRING(v), n, p);
	}
189
#ifdef Py_USING_UNICODE
190 191 192 193
	else if (PyUnicode_Check(v)) {
	        PyObject *utf8;
		utf8 = PyUnicode_AsUTF8String(v);
		if (utf8 == NULL) {
194 195 196
			p->depth--;
			p->error = 1;
			return;
197 198 199 200 201 202
		}
		w_byte(TYPE_UNICODE, p);
		n = PyString_GET_SIZE(utf8);
		w_long((long)n, p);
		w_string(PyString_AS_STRING(utf8), n, p);
		Py_DECREF(utf8);
Guido van Rossum's avatar
Guido van Rossum committed
203
	}
204
#endif
205
	else if (PyTuple_Check(v)) {
206
		w_byte(TYPE_TUPLE, p);
207
		n = PyTuple_Size(v);
208
		w_long((long)n, p);
Guido van Rossum's avatar
Guido van Rossum committed
209
		for (i = 0; i < n; i++) {
210
			w_object(PyTuple_GET_ITEM(v, i), p);
Guido van Rossum's avatar
Guido van Rossum committed
211 212
		}
	}
213
	else if (PyList_Check(v)) {
214
		w_byte(TYPE_LIST, p);
215
		n = PyList_GET_SIZE(v);
216
		w_long((long)n, p);
Guido van Rossum's avatar
Guido van Rossum committed
217
		for (i = 0; i < n; i++) {
218
			w_object(PyList_GET_ITEM(v, i), p);
Guido van Rossum's avatar
Guido van Rossum committed
219 220
		}
	}
221
	else if (PyDict_Check(v)) {
222
		int pos;
223
		PyObject *key, *value;
224
		w_byte(TYPE_DICT, p);
225
		/* This one is NULL object terminated! */
226
		pos = 0;
227
		while (PyDict_Next(v, &pos, &key, &value)) {
228 229
			w_object(key, p);
			w_object(value, p);
230
		}
231
		w_object((PyObject *)NULL, p);
232
	}
233 234
	else if (PyCode_Check(v)) {
		PyCodeObject *co = (PyCodeObject *)v;
235
		w_byte(TYPE_CODE, p);
236 237
		w_short(co->co_argcount, p);
		w_short(co->co_nlocals, p);
238
		w_short(co->co_stacksize, p);
239
		w_short(co->co_flags, p);
240
		w_object(co->co_code, p);
241 242
		w_object(co->co_consts, p);
		w_object(co->co_names, p);
243
		w_object(co->co_varnames, p);
Jeremy Hylton's avatar
Jeremy Hylton committed
244 245
		w_object(co->co_freevars, p);
		w_object(co->co_cellvars, p);
246
		w_object(co->co_filename, p);
247
		w_object(co->co_name, p);
248 249
		w_short(co->co_firstlineno, p);
		w_object(co->co_lnotab, p);
Guido van Rossum's avatar
Guido van Rossum committed
250
	}
251
	else if (PyObject_CheckReadBuffer(v)) {
252 253
		/* Write unknown buffer-style objects as a string */
		char *s;
254
		PyBufferProcs *pb = v->ob_type->tp_as_buffer;
255 256 257 258 259
		w_byte(TYPE_STRING, p);
		n = (*pb->bf_getreadbuffer)(v, 0, (void **)&s);
		w_long((long)n, p);
		w_string(s, n, p);
	}
Guido van Rossum's avatar
Guido van Rossum committed
260
	else {
261
		w_byte(TYPE_UNKNOWN, p);
262
		p->error = 1;
Guido van Rossum's avatar
Guido van Rossum committed
263
	}
264 265

	p->depth--;
Guido van Rossum's avatar
Guido van Rossum committed
266 267
}

268
void
269
PyMarshal_WriteLongToFile(long x, FILE *fp)
270 271 272
{
	WFILE wf;
	wf.fp = fp;
273
	wf.error = 0;
274
	wf.depth = 0;
275 276
	w_long(x, &wf);
}
Guido van Rossum's avatar
Guido van Rossum committed
277

278
void
279
PyMarshal_WriteObjectToFile(PyObject *x, FILE *fp)
280 281 282
{
	WFILE wf;
	wf.fp = fp;
283
	wf.error = 0;
284
	wf.depth = 0;
285 286 287 288 289
	w_object(x, &wf);
}

typedef WFILE RFILE; /* Same struct with different invariants */

290 291 292
#define rs_byte(p) (((p)->ptr != (p)->end) ? (unsigned char)*(p)->ptr++ : EOF)

#define r_byte(p) ((p)->fp ? getc((p)->fp) : rs_byte(p))
293 294

static int
295
r_string(char *s, int n, RFILE *p)
296 297 298 299 300 301 302 303 304 305 306
{
	if (p->fp != NULL)
		return fread(s, 1, n, p->fp);
	if (p->end - p->ptr < n)
		n = p->end - p->ptr;
	memcpy(s, p->ptr, n);
	p->ptr += n;
	return n;
}

static int
307
r_short(RFILE *p)
Guido van Rossum's avatar
Guido van Rossum committed
308 309
{
	register short x;
310 311
	x = r_byte(p);
	x |= r_byte(p) << 8;
Tim Peters's avatar
Tim Peters committed
312 313
	/* Sign-extension, in case short greater than 16 bits */
	x |= -(x & 0x8000);
Guido van Rossum's avatar
Guido van Rossum committed
314 315 316
	return x;
}

317
static long
318
r_long(RFILE *p)
Guido van Rossum's avatar
Guido van Rossum committed
319 320
{
	register long x;
321 322 323 324 325 326 327 328 329 330 331 332 333
	register FILE *fp = p->fp;
	if (fp) {
		x = getc(fp);
		x |= (long)getc(fp) << 8;
		x |= (long)getc(fp) << 16;
		x |= (long)getc(fp) << 24;
	}
	else {
		x = rs_byte(p);
		x |= (long)rs_byte(p) << 8;
		x |= (long)rs_byte(p) << 16;
		x |= (long)rs_byte(p) << 24;
	}
334
#if SIZEOF_LONG > 4
335
	/* Sign extension for 64-bit machines */
Tim Peters's avatar
Tim Peters committed
336
	x |= -(x & 0x80000000L);
337
#endif
338 339 340
	return x;
}

341 342 343 344 345 346 347 348
/* r_long64 deals with the TYPE_INT64 code.  On a machine with
   sizeof(long) > 4, it returns a Python int object, else a Python long
   object.  Note that w_long64 writes out TYPE_INT if 32 bits is enough,
   so there's no inefficiency here in returning a PyLong on 32-bit boxes
   for everything written via TYPE_INT64 (i.e., if an int is written via
   TYPE_INT64, it *needs* more than 32 bits).
*/
static PyObject *
349
r_long64(RFILE *p)
350
{
351 352
	long lo4 = r_long(p);
	long hi4 = r_long(p);
353
#if SIZEOF_LONG > 4
354 355
	long x = (hi4 << 32) | (lo4 & 0xFFFFFFFFL);
	return PyInt_FromLong(x);
356
#else
357 358 359 360 361 362
	unsigned char buf[8];
	int one = 1;
	int is_little_endian = (int)*(char*)&one;
	if (is_little_endian) {
		memcpy(buf, &lo4, 4);
		memcpy(buf+4, &hi4, 4);
363
	}
364 365 366 367 368
	else {
		memcpy(buf, &hi4, 4);
		memcpy(buf+4, &lo4, 4);
	}
	return _PyLong_FromByteArray(buf, 8, is_little_endian, 1);
369
#endif
Guido van Rossum's avatar
Guido van Rossum committed
370 371
}

372
static PyObject *
373
r_object(RFILE *p)
Guido van Rossum's avatar
Guido van Rossum committed
374
{
375
	PyObject *v, *v2;
Guido van Rossum's avatar
Guido van Rossum committed
376
	long i, n;
377
	int type = r_byte(p);
378

Guido van Rossum's avatar
Guido van Rossum committed
379
	switch (type) {
380

Guido van Rossum's avatar
Guido van Rossum committed
381
	case EOF:
382 383
		PyErr_SetString(PyExc_EOFError,
				"EOF read where object expected");
Guido van Rossum's avatar
Guido van Rossum committed
384
		return NULL;
385

Guido van Rossum's avatar
Guido van Rossum committed
386 387
	case TYPE_NULL:
		return NULL;
388

Guido van Rossum's avatar
Guido van Rossum committed
389
	case TYPE_NONE:
390 391
		Py_INCREF(Py_None);
		return Py_None;
392

393 394 395 396
	case TYPE_STOPITER:
		Py_INCREF(PyExc_StopIteration);
		return PyExc_StopIteration;

397
	case TYPE_ELLIPSIS:
398
		Py_INCREF(Py_Ellipsis);
399
		return Py_Ellipsis;
400

Guido van Rossum's avatar
Guido van Rossum committed
401
	case TYPE_INT:
402
		return PyInt_FromLong(r_long(p));
403

404
	case TYPE_INT64:
405
		return r_long64(p);
406

Guido van Rossum's avatar
Guido van Rossum committed
407 408 409
	case TYPE_LONG:
		{
			int size;
410
			PyLongObject *ob;
411
			n = r_long(p);
Guido van Rossum's avatar
Guido van Rossum committed
412
			size = n<0 ? -n : n;
413
			ob = _PyLong_New(size);
Guido van Rossum's avatar
Guido van Rossum committed
414 415 416 417
			if (ob == NULL)
				return NULL;
			ob->ob_size = n;
			for (i = 0; i < size; i++)
418
				ob->ob_digit[i] = r_short(p);
419
			return (PyObject *)ob;
Guido van Rossum's avatar
Guido van Rossum committed
420
		}
421

Guido van Rossum's avatar
Guido van Rossum committed
422 423 424
	case TYPE_FLOAT:
		{
			char buf[256];
425
			double dx;
426 427
			n = r_byte(p);
			if (r_string(buf, (int)n, p) != n) {
428
				PyErr_SetString(PyExc_EOFError,
Guido van Rossum's avatar
Guido van Rossum committed
429 430 431 432
					"EOF read where object expected");
				return NULL;
			}
			buf[n] = '\0';
433 434
			PyFPE_START_PROTECT("atof", return 0)
			dx = atof(buf);
435
			PyFPE_END_PROTECT(dx)
436
			return PyFloat_FromDouble(dx);
Guido van Rossum's avatar
Guido van Rossum committed
437
		}
438

439 440 441 442
#ifndef WITHOUT_COMPLEX
	case TYPE_COMPLEX:
		{
			char buf[256];
443
			Py_complex c;
444 445
			n = r_byte(p);
			if (r_string(buf, (int)n, p) != n) {
446
				PyErr_SetString(PyExc_EOFError,
447 448 449 450
					"EOF read where object expected");
				return NULL;
			}
			buf[n] = '\0';
451
			PyFPE_START_PROTECT("atof", return 0)
452
			c.real = atof(buf);
453
			PyFPE_END_PROTECT(c)
454 455
			n = r_byte(p);
			if (r_string(buf, (int)n, p) != n) {
456
				PyErr_SetString(PyExc_EOFError,
457 458 459 460
					"EOF read where object expected");
				return NULL;
			}
			buf[n] = '\0';
461
			PyFPE_START_PROTECT("atof", return 0)
462
			c.imag = atof(buf);
463
			PyFPE_END_PROTECT(c)
464
			return PyComplex_FromCComplex(c);
465 466
		}
#endif
467

Guido van Rossum's avatar
Guido van Rossum committed
468
	case TYPE_STRING:
469
		n = r_long(p);
470 471 472 473
		if (n < 0) {
			PyErr_SetString(PyExc_ValueError, "bad marshal data");
			return NULL;
		}
474
		v = PyString_FromStringAndSize((char *)NULL, n);
Guido van Rossum's avatar
Guido van Rossum committed
475
		if (v != NULL) {
476
			if (r_string(PyString_AS_STRING(v), (int)n, p) != n) {
477
				Py_DECREF(v);
Guido van Rossum's avatar
Guido van Rossum committed
478
				v = NULL;
479
				PyErr_SetString(PyExc_EOFError,
Guido van Rossum's avatar
Guido van Rossum committed
480 481 482 483
					"EOF read where object expected");
			}
		}
		return v;
484

485
#ifdef Py_USING_UNICODE
486 487 488 489 490 491 492 493 494
	case TYPE_UNICODE:
	    {
		char *buffer;

		n = r_long(p);
		if (n < 0) {
			PyErr_SetString(PyExc_ValueError, "bad marshal data");
			return NULL;
		}
495
		buffer = PyMem_NEW(char, n);
496
		if (buffer == NULL)
497
			return PyErr_NoMemory();
498
		if (r_string(buffer, (int)n, p) != n) {
499
			PyMem_DEL(buffer);
500 501 502 503 504
			PyErr_SetString(PyExc_EOFError,
				"EOF read where object expected");
			return NULL;
		}
		v = PyUnicode_DecodeUTF8(buffer, n, NULL);
505
		PyMem_DEL(buffer);
506 507
		return v;
	    }
508
#endif
509

Guido van Rossum's avatar
Guido van Rossum committed
510
	case TYPE_TUPLE:
511
		n = r_long(p);
512 513 514 515
		if (n < 0) {
			PyErr_SetString(PyExc_ValueError, "bad marshal data");
			return NULL;
		}
516
		v = PyTuple_New((int)n);
Guido van Rossum's avatar
Guido van Rossum committed
517 518
		if (v == NULL)
			return v;
519 520 521
		for (i = 0; i < n; i++) {
			v2 = r_object(p);
			if ( v2 == NULL ) {
522
				Py_DECREF(v);
523 524 525
				v = NULL;
				break;
			}
526
			PyTuple_SET_ITEM(v, (int)i, v2);
527
		}
Guido van Rossum's avatar
Guido van Rossum committed
528
		return v;
529

Guido van Rossum's avatar
Guido van Rossum committed
530
	case TYPE_LIST:
531
		n = r_long(p);
532 533 534 535
		if (n < 0) {
			PyErr_SetString(PyExc_ValueError, "bad marshal data");
			return NULL;
		}
536
		v = PyList_New((int)n);
Guido van Rossum's avatar
Guido van Rossum committed
537 538
		if (v == NULL)
			return v;
539 540 541
		for (i = 0; i < n; i++) {
			v2 = r_object(p);
			if ( v2 == NULL ) {
542
				Py_DECREF(v);
543 544 545
				v = NULL;
				break;
			}
546
			PyList_SetItem(v, (int)i, v2);
547
		}
Guido van Rossum's avatar
Guido van Rossum committed
548
		return v;
549

550
	case TYPE_DICT:
551
		v = PyDict_New();
552 553 554
		if (v == NULL)
			return NULL;
		for (;;) {
555
			PyObject *key, *val;
556
			key = r_object(p);
557
			if (key == NULL)
558
				break; /* XXX Assume TYPE_NULL, not an error */
559
			val = r_object(p);
560
			if (val != NULL)
561 562 563
				PyDict_SetItem(v, key, val);
			Py_DECREF(key);
			Py_XDECREF(val);
564 565
		}
		return v;
566

Guido van Rossum's avatar
Guido van Rossum committed
567
	case TYPE_CODE:
568 569 570 571 572 573 574
		if (PyEval_GetRestricted()) {
			PyErr_SetString(PyExc_RuntimeError,
				"cannot unmarshal code objects in "
				"restricted execution mode");
			return NULL;
		}
		else {
575 576
			int argcount = r_short(p);
			int nlocals = r_short(p);
577
			int stacksize = r_short(p);
578
			int flags = r_short(p);
579 580 581 582
			PyObject *code = NULL;
			PyObject *consts = NULL;
			PyObject *names = NULL;
			PyObject *varnames = NULL;
Jeremy Hylton's avatar
Jeremy Hylton committed
583 584
			PyObject *freevars = NULL;
			PyObject *cellvars = NULL;
585 586
			PyObject *filename = NULL;
			PyObject *name = NULL;
Guido van Rossum's avatar
Guido van Rossum committed
587
			int firstlineno = 0;
588
			PyObject *lnotab = NULL;
589

590 591 592 593
			code = r_object(p);
			if (code) consts = r_object(p);
			if (consts) names = r_object(p);
			if (names) varnames = r_object(p);
Jeremy Hylton's avatar
Jeremy Hylton committed
594 595 596
			if (varnames) freevars = r_object(p);
			if (freevars) cellvars = r_object(p);
			if (cellvars) filename = r_object(p);
597
			if (filename) name = r_object(p);
598 599 600 601
			if (name) {
				firstlineno = r_short(p);
				lnotab = r_object(p);
			}
602

603 604
			if (!PyErr_Occurred()) {
				v = (PyObject *) PyCode_New(
605
					argcount, nlocals, stacksize, flags,
606
					code, consts, names, varnames,
607 608
					freevars, cellvars, filename, name,
					firstlineno, lnotab);
Guido van Rossum's avatar
Guido van Rossum committed
609 610 611
			}
			else
				v = NULL;
612 613 614 615
			Py_XDECREF(code);
			Py_XDECREF(consts);
			Py_XDECREF(names);
			Py_XDECREF(varnames);
Jeremy Hylton's avatar
Jeremy Hylton committed
616 617
			Py_XDECREF(freevars);
			Py_XDECREF(cellvars);
618 619
			Py_XDECREF(filename);
			Py_XDECREF(name);
620
			Py_XDECREF(lnotab);
Guido van Rossum's avatar
Guido van Rossum committed
621 622 623

		}
		return v;
624

Guido van Rossum's avatar
Guido van Rossum committed
625
	default:
626 627
		/* Bogus data got written, which isn't ideal.
		   This will let you keep working and recover. */
628 629
		PyErr_SetString(PyExc_ValueError, "bad marshal data");
		return NULL;
630

Guido van Rossum's avatar
Guido van Rossum committed
631 632 633
	}
}

634 635 636 637 638 639 640 641
int
PyMarshal_ReadShortFromFile(FILE *fp)
{
	RFILE rf;
	rf.fp = fp;
	return r_short(&rf);
}

642
long
643
PyMarshal_ReadLongFromFile(FILE *fp)
644 645 646 647 648 649
{
	RFILE rf;
	rf.fp = fp;
	return r_long(&rf);
}

650 651 652 653 654 655 656 657 658 659 660 661
#ifdef HAVE_FSTAT
/* Return size of file in bytes; < 0 if unknown. */
static off_t
getfilesize(FILE *fp)
{
	struct stat st;
	if (fstat(fileno(fp), &st) != 0)
		return -1;
	else
		return st.st_size;
}
#endif
662

663 664 665
/* If we can get the size of the file up-front, and it's reasonably small,
 * read it in one gulp and delegate to ...FromString() instead.  Much quicker
 * than reading a byte at a time from file; speeds .pyc imports.
666 667
 * CAUTION:  since this may read the entire remainder of the file, don't
 * call it unless you know you're done with the file.
668
 */
669
PyObject *
670
PyMarshal_ReadLastObjectFromFile(FILE *fp)
671
{
672 673 674 675 676 677 678 679
/* 75% of 2.1's .pyc files can exploit SMALL_FILE_LIMIT.
 * REASONABLE_FILE_LIMIT is by defn something big enough for Tkinter.pyc.
 */
#define SMALL_FILE_LIMIT (1L << 14)
#define REASONABLE_FILE_LIMIT (1L << 18)
#ifdef HAVE_FSTAT
	off_t filesize;
#endif
680
	if (PyErr_Occurred()) {
681 682 683
		fprintf(stderr, "XXX rd_object called with exception set\n");
		return NULL;
	}
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
#ifdef HAVE_FSTAT
	filesize = getfilesize(fp);
	if (filesize > 0) {
		char buf[SMALL_FILE_LIMIT];
		char* pBuf = NULL;
		if (filesize <= SMALL_FILE_LIMIT)
			pBuf = buf;
		else if (filesize <= REASONABLE_FILE_LIMIT)
			pBuf = (char *)PyMem_MALLOC(filesize);
		if (pBuf != NULL) {
			PyObject* v;
			size_t n = fread(pBuf, 1, filesize, fp);
			v = PyMarshal_ReadObjectFromString(pBuf, n);
			if (pBuf != buf)
				PyMem_FREE(pBuf);
			return v;
		}
701

702 703
	}
#endif
704 705 706 707 708
	/* We don't have fstat, or we do but the file is larger than
	 * REASONABLE_FILE_LIMIT or malloc failed -- read a byte at a time.
	 */
	return PyMarshal_ReadObjectFromFile(fp);

709 710
#undef SMALL_FILE_LIMIT
#undef REASONABLE_FILE_LIMIT
711 712
}

713 714 715 716 717 718 719 720 721 722 723 724
PyObject *
PyMarshal_ReadObjectFromFile(FILE *fp)
{
	RFILE rf;
	if (PyErr_Occurred()) {
		fprintf(stderr, "XXX rd_object called with exception set\n");
		return NULL;
	}
	rf.fp = fp;
	return r_object(&rf);
}

725
PyObject *
726
PyMarshal_ReadObjectFromString(char *str, int len)
727 728
{
	RFILE rf;
729
	if (PyErr_Occurred()) {
730 731 732
		fprintf(stderr, "XXX rds_object called with exception set\n");
		return NULL;
	}
733 734 735 736 737 738 739
	rf.fp = NULL;
	rf.str = NULL;
	rf.ptr = str;
	rf.end = str + len;
	return r_object(&rf);
}

740
PyObject *
741
PyMarshal_WriteObjectToString(PyObject *x) /* wrs_object() */
742 743 744
{
	WFILE wf;
	wf.fp = NULL;
745
	wf.str = PyString_FromStringAndSize((char *)NULL, 50);
746 747
	if (wf.str == NULL)
		return NULL;
748 749
	wf.ptr = PyString_AS_STRING((PyStringObject *)wf.str);
	wf.end = wf.ptr + PyString_Size(wf.str);
750
	wf.error = 0;
751
	wf.depth = 0;
752 753
	w_object(x, &wf);
	if (wf.str != NULL)
754 755 756
		_PyString_Resize(&wf.str,
		    (int) (wf.ptr -
			   PyString_AS_STRING((PyStringObject *)wf.str)));
757
	if (wf.error) {
758
		Py_XDECREF(wf.str);
759
		PyErr_SetString(PyExc_ValueError,
760 761
				(wf.error==1)?"unmarshallable object"
				:"object too deeply nested to marshal");
762 763 764 765 766
		return NULL;
	}
	return wf.str;
}

767
/* And an interface for Python programs... */
Guido van Rossum's avatar
Guido van Rossum committed
768

769
static PyObject *
770
marshal_dump(PyObject *self, PyObject *args)
Guido van Rossum's avatar
Guido van Rossum committed
771
{
772
	WFILE wf;
773 774
	PyObject *x;
	PyObject *f;
775
	if (!PyArg_ParseTuple(args, "OO:dump", &x, &f))
Guido van Rossum's avatar
Guido van Rossum committed
776
		return NULL;
777 778 779
	if (!PyFile_Check(f)) {
		PyErr_SetString(PyExc_TypeError,
				"marshal.dump() 2nd arg must be file");
Guido van Rossum's avatar
Guido van Rossum committed
780 781
		return NULL;
	}
782
	wf.fp = PyFile_AsFile(f);
783 784
	wf.str = NULL;
	wf.ptr = wf.end = NULL;
785
	wf.error = 0;
786
	wf.depth = 0;
787
	w_object(x, &wf);
788
	if (wf.error) {
789
		PyErr_SetString(PyExc_ValueError,
790 791
				(wf.error==1)?"unmarshallable object"
				:"object too deeply nested to marshal");
792 793
		return NULL;
	}
794 795
	Py_INCREF(Py_None);
	return Py_None;
Guido van Rossum's avatar
Guido van Rossum committed
796 797
}

798
static PyObject *
799
marshal_load(PyObject *self, PyObject *args)
Guido van Rossum's avatar
Guido van Rossum committed
800
{
801
	RFILE rf;
802 803
	PyObject *f;
	PyObject *v;
804
	if (!PyArg_ParseTuple(args, "O:load", &f))
805
		return NULL;
806 807 808
	if (!PyFile_Check(f)) {
		PyErr_SetString(PyExc_TypeError,
				"marshal.load() arg must be file");
Guido van Rossum's avatar
Guido van Rossum committed
809 810
		return NULL;
	}
811
	rf.fp = PyFile_AsFile(f);
812 813
	rf.str = NULL;
	rf.ptr = rf.end = NULL;
814
	PyErr_Clear();
815
	v = r_object(&rf);
816 817
	if (PyErr_Occurred()) {
		Py_XDECREF(v);
818 819 820 821 822
		v = NULL;
	}
	return v;
}

823
static PyObject *
824
marshal_dumps(PyObject *self, PyObject *args)
825
{
826
	PyObject *x;
827
	if (!PyArg_ParseTuple(args, "O:dumps", &x))
828
		return NULL;
829
	return PyMarshal_WriteObjectToString(x);
830 831
}

832
static PyObject *
833
marshal_loads(PyObject *self, PyObject *args)
834 835
{
	RFILE rf;
836
	PyObject *v;
837 838
	char *s;
	int n;
839
	if (!PyArg_ParseTuple(args, "s#:loads", &s, &n))
840 841 842 843 844
		return NULL;
	rf.fp = NULL;
	rf.str = args;
	rf.ptr = s;
	rf.end = s + n;
845
	PyErr_Clear();
846
	v = r_object(&rf);
847 848
	if (PyErr_Occurred()) {
		Py_XDECREF(v);
Guido van Rossum's avatar
Guido van Rossum committed
849 850 851 852 853
		v = NULL;
	}
	return v;
}

854
static PyMethodDef marshal_methods[] = {
855 856 857 858
	{"dump",	marshal_dump,	1},
	{"load",	marshal_load,	1},
	{"dumps",	marshal_dumps,	1},
	{"loads",	marshal_loads,	1},
Guido van Rossum's avatar
Guido van Rossum committed
859 860 861 862
	{NULL,		NULL}		/* sentinel */
};

void
863
PyMarshal_Init(void)
Guido van Rossum's avatar
Guido van Rossum committed
864
{
865
	(void) Py_InitModule("marshal", marshal_methods);
Guido van Rossum's avatar
Guido van Rossum committed
866
}