blob: e0f138de49baf3cdb31dd680dc622c24728db3cd [file] [log] [blame]
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001
2/* Write Python objects to files and read them back.
3 This is intended for writing and reading compiled Python code only;
4 a true persistent storage facility would be much harder, since
5 it would have to take circular links and sharing into account. */
6
Guido van Rossum79f25d91997-04-29 20:08:16 +00007#include "Python.h"
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00008#include "longintrepr.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00009#include "code.h"
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000010#include "marshal.h"
11
Fred Drake6da0b912000-06-28 18:47:56 +000012/* High water mark to determine when the marshalled object is dangerously deep
13 * and risks coring the interpreter. When the object stack gets this deep,
14 * raise an exception instead of continuing.
15 */
16#define MAX_MARSHAL_STACK_DEPTH 5000
17
Michael W. Hudsondf888462005-06-03 14:41:55 +000018#define TYPE_NULL '0'
19#define TYPE_NONE 'N'
20#define TYPE_FALSE 'F'
21#define TYPE_TRUE 'T'
22#define TYPE_STOPITER 'S'
23#define TYPE_ELLIPSIS '.'
24#define TYPE_INT 'i'
25#define TYPE_INT64 'I'
26#define TYPE_FLOAT 'f'
27#define TYPE_BINARY_FLOAT 'g'
28#define TYPE_COMPLEX 'x'
29#define TYPE_BINARY_COMPLEX 'y'
30#define TYPE_LONG 'l'
31#define TYPE_STRING 's'
32#define TYPE_INTERNED 't'
33#define TYPE_STRINGREF 'R'
34#define TYPE_TUPLE '('
35#define TYPE_LIST '['
36#define TYPE_DICT '{'
37#define TYPE_CODE 'c'
38#define TYPE_UNICODE 'u'
39#define TYPE_UNKNOWN '?'
40#define TYPE_SET '<'
41#define TYPE_FROZENSET '>'
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000042
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000043typedef struct {
44 FILE *fp;
Guido van Rossumf2150601996-06-26 20:41:23 +000045 int error;
Fred Drake6da0b912000-06-28 18:47:56 +000046 int depth;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000047 /* If fp == NULL, the following are valid: */
Guido van Rossum79f25d91997-04-29 20:08:16 +000048 PyObject *str;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000049 char *ptr;
50 char *end;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000051 PyObject *strings; /* dict on marshal, list on unmarshal */
Michael W. Hudsondf888462005-06-03 14:41:55 +000052 int version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000053} WFILE;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000054
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000055#define w_byte(c, p) if (((p)->fp)) putc((c), (p)->fp); \
56 else if ((p)->ptr != (p)->end) *(p)->ptr++ = (c); \
57 else w_more(c, p)
58
59static void
Fredrik Lundh11534382000-07-23 18:24:06 +000060w_more(int c, WFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000061{
Martin v. Löwis18e16552006-02-15 17:27:45 +000062 Py_ssize_t size, newsize;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000063 if (p->str == NULL)
64 return; /* An error already occurred */
Guido van Rossum79f25d91997-04-29 20:08:16 +000065 size = PyString_Size(p->str);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000066 newsize = size + 1024;
Guido van Rossum79f25d91997-04-29 20:08:16 +000067 if (_PyString_Resize(&p->str, newsize) != 0) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000068 p->ptr = p->end = NULL;
69 }
70 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +000071 p->ptr = PyString_AS_STRING((PyStringObject *)p->str) + size;
72 p->end =
73 PyString_AS_STRING((PyStringObject *)p->str) + newsize;
Tim Peters8315ea52000-07-23 19:28:35 +000074 *p->ptr++ = Py_SAFE_DOWNCAST(c, int, char);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000075 }
76}
77
78static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000079w_string(char *s, int n, WFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000080{
81 if (p->fp != NULL) {
82 fwrite(s, 1, n, p->fp);
83 }
84 else {
85 while (--n >= 0) {
86 w_byte(*s, p);
87 s++;
88 }
89 }
90}
91
92static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000093w_short(int x, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000094{
Thomas Heller3e1c18a2002-07-30 11:40:57 +000095 w_byte((char)( x & 0xff), p);
96 w_byte((char)((x>> 8) & 0xff), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000097}
98
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000099static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000100w_long(long x, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000101{
Thomas Heller37d5a152002-07-30 11:44:44 +0000102 w_byte((char)( x & 0xff), p);
103 w_byte((char)((x>> 8) & 0xff), p);
104 w_byte((char)((x>>16) & 0xff), p);
105 w_byte((char)((x>>24) & 0xff), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000106}
107
Guido van Rossumc1547d91996-12-10 15:39:04 +0000108#if SIZEOF_LONG > 4
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000109static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000110w_long64(long x, WFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000111{
112 w_long(x, p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000113 w_long(x>>32, p);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000114}
Guido van Rossumc1547d91996-12-10 15:39:04 +0000115#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000116
117static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000118w_object(PyObject *v, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000119{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000120 Py_ssize_t i, n;
Fred Drake6da0b912000-06-28 18:47:56 +0000121
122 p->depth++;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000123
Fred Drake6da0b912000-06-28 18:47:56 +0000124 if (p->depth > MAX_MARSHAL_STACK_DEPTH) {
125 p->error = 2;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000126 }
Fred Drake6da0b912000-06-28 18:47:56 +0000127 else if (v == NULL) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000128 w_byte(TYPE_NULL, p);
Guido van Rossum730806d1998-04-10 22:27:42 +0000129 }
130 else if (v == Py_None) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000131 w_byte(TYPE_NONE, p);
Guido van Rossum730806d1998-04-10 22:27:42 +0000132 }
Tim Peters5ca576e2001-06-18 22:08:13 +0000133 else if (v == PyExc_StopIteration) {
134 w_byte(TYPE_STOPITER, p);
135 }
Guido van Rossum730806d1998-04-10 22:27:42 +0000136 else if (v == Py_Ellipsis) {
137 w_byte(TYPE_ELLIPSIS, p);
138 }
Guido van Rossum77f6a652002-04-03 22:41:51 +0000139 else if (v == Py_False) {
140 w_byte(TYPE_FALSE, p);
141 }
142 else if (v == Py_True) {
143 w_byte(TYPE_TRUE, p);
144 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000145 else if (PyInt_Check(v)) {
146 long x = PyInt_AS_LONG((PyIntObject *)v);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000147#if SIZEOF_LONG > 4
Tim Peters44714002001-04-10 05:02:52 +0000148 long y = Py_ARITHMETIC_RIGHT_SHIFT(long, x, 31);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000149 if (y && y != -1) {
150 w_byte(TYPE_INT64, p);
151 w_long64(x, p);
152 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000153 else
154#endif
155 {
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000156 w_byte(TYPE_INT, p);
157 w_long(x, p);
158 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000159 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000160 else if (PyLong_Check(v)) {
161 PyLongObject *ob = (PyLongObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000162 w_byte(TYPE_LONG, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000163 n = ob->ob_size;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000164 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000165 if (n < 0)
166 n = -n;
167 for (i = 0; i < n; i++)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000168 w_short(ob->ob_digit[i], p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000169 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000170 else if (PyFloat_Check(v)) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000171 if (p->version > 1) {
Brett Cannonc9371d42005-06-25 08:23:41 +0000172 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000173 if (_PyFloat_Pack8(PyFloat_AsDouble(v),
174 buf, 1) < 0) {
175 p->error = 1;
176 return;
177 }
178 w_byte(TYPE_BINARY_FLOAT, p);
Brett Cannonc9371d42005-06-25 08:23:41 +0000179 w_string((char*)buf, 8, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000180 }
181 else {
182 char buf[256]; /* Plenty to format any double */
183 PyFloat_AsReprString(buf, (PyFloatObject *)v);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000184 n = (int)strlen(buf);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000185 w_byte(TYPE_FLOAT, p);
186 w_byte(n, p);
187 w_string(buf, n, p);
188 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000189 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000190#ifndef WITHOUT_COMPLEX
Guido van Rossum79f25d91997-04-29 20:08:16 +0000191 else if (PyComplex_Check(v)) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000192 if (p->version > 1) {
Brett Cannonc9371d42005-06-25 08:23:41 +0000193 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000194 if (_PyFloat_Pack8(PyComplex_RealAsDouble(v),
195 buf, 1) < 0) {
196 p->error = 1;
197 return;
198 }
199 w_byte(TYPE_BINARY_COMPLEX, p);
Brett Cannonc9371d42005-06-25 08:23:41 +0000200 w_string((char*)buf, 8, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000201 if (_PyFloat_Pack8(PyComplex_ImagAsDouble(v),
202 buf, 1) < 0) {
203 p->error = 1;
204 return;
205 }
Brett Cannonc9371d42005-06-25 08:23:41 +0000206 w_string((char*)buf, 8, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000207 }
208 else {
209 char buf[256]; /* Plenty to format any double */
210 PyFloatObject *temp;
211 w_byte(TYPE_COMPLEX, p);
212 temp = (PyFloatObject*)PyFloat_FromDouble(
213 PyComplex_RealAsDouble(v));
214 PyFloat_AsReprString(buf, temp);
215 Py_DECREF(temp);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000216 n = (int)strlen(buf);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000217 w_byte(n, p);
218 w_string(buf, n, p);
219 temp = (PyFloatObject*)PyFloat_FromDouble(
220 PyComplex_ImagAsDouble(v));
221 PyFloat_AsReprString(buf, temp);
222 Py_DECREF(temp);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000223 n = (int)strlen(buf);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000224 w_byte(n, p);
225 w_string(buf, n, p);
226 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000227 }
228#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +0000229 else if (PyString_Check(v)) {
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000230 if (p->strings && PyString_CHECK_INTERNED(v)) {
231 PyObject *o = PyDict_GetItem(p->strings, v);
232 if (o) {
233 long w = PyInt_AsLong(o);
234 w_byte(TYPE_STRINGREF, p);
235 w_long(w, p);
236 goto exit;
237 }
238 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000239 o = PyInt_FromSsize_t(PyDict_Size(p->strings));
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000240 PyDict_SetItem(p->strings, v, o);
241 Py_DECREF(o);
242 w_byte(TYPE_INTERNED, p);
243 }
244 }
245 else {
246 w_byte(TYPE_STRING, p);
247 }
Guido van Rossumc279b532000-03-10 23:03:02 +0000248 n = PyString_GET_SIZE(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000249 w_long((long)n, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000250 w_string(PyString_AS_STRING(v), n, p);
251 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000252#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000253 else if (PyUnicode_Check(v)) {
254 PyObject *utf8;
255 utf8 = PyUnicode_AsUTF8String(v);
256 if (utf8 == NULL) {
Guido van Rossum98626cd2000-06-28 23:24:19 +0000257 p->depth--;
258 p->error = 1;
259 return;
Guido van Rossumc279b532000-03-10 23:03:02 +0000260 }
261 w_byte(TYPE_UNICODE, p);
262 n = PyString_GET_SIZE(utf8);
263 w_long((long)n, p);
264 w_string(PyString_AS_STRING(utf8), n, p);
265 Py_DECREF(utf8);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000266 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000267#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +0000268 else if (PyTuple_Check(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000269 w_byte(TYPE_TUPLE, p);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000270 n = PyTuple_Size(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000271 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000272 for (i = 0; i < n; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000273 w_object(PyTuple_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000274 }
275 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000276 else if (PyList_Check(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000277 w_byte(TYPE_LIST, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000278 n = PyList_GET_SIZE(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000279 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000280 for (i = 0; i < n; i++) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000281 w_object(PyList_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000282 }
283 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000284 else if (PyDict_Check(v)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000285 Py_ssize_t pos;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000286 PyObject *key, *value;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000287 w_byte(TYPE_DICT, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000288 /* This one is NULL object terminated! */
Guido van Rossum25831651993-05-19 14:50:45 +0000289 pos = 0;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000290 while (PyDict_Next(v, &pos, &key, &value)) {
Guido van Rossum25831651993-05-19 14:50:45 +0000291 w_object(key, p);
292 w_object(value, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000293 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000294 w_object((PyObject *)NULL, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000295 }
Raymond Hettingera422c342005-01-11 03:03:27 +0000296 else if (PyAnySet_Check(v)) {
Raymond Hettingera422c342005-01-11 03:03:27 +0000297 PyObject *value, *it;
298
299 if (PyObject_TypeCheck(v, &PySet_Type))
300 w_byte(TYPE_SET, p);
301 else
302 w_byte(TYPE_FROZENSET, p);
303 n = PyObject_Size(v);
304 if (n == -1) {
305 p->depth--;
306 p->error = 1;
307 return;
308 }
309 w_long((long)n, p);
310 it = PyObject_GetIter(v);
311 if (it == NULL) {
312 p->depth--;
313 p->error = 1;
314 return;
315 }
316 while ((value = PyIter_Next(it)) != NULL) {
317 w_object(value, p);
318 Py_DECREF(value);
319 }
320 Py_DECREF(it);
321 if (PyErr_Occurred()) {
322 p->depth--;
323 p->error = 1;
324 return;
325 }
326 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000327 else if (PyCode_Check(v)) {
328 PyCodeObject *co = (PyCodeObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000329 w_byte(TYPE_CODE, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000330 w_long(co->co_argcount, p);
331 w_long(co->co_nlocals, p);
332 w_long(co->co_stacksize, p);
333 w_long(co->co_flags, p);
Guido van Rossumd076c731998-10-07 19:42:25 +0000334 w_object(co->co_code, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000335 w_object(co->co_consts, p);
336 w_object(co->co_names, p);
Guido van Rossum681d79a1995-07-18 14:51:37 +0000337 w_object(co->co_varnames, p);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000338 w_object(co->co_freevars, p);
339 w_object(co->co_cellvars, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000340 w_object(co->co_filename, p);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000341 w_object(co->co_name, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000342 w_long(co->co_firstlineno, p);
Guido van Rossumd031c891997-01-24 03:44:17 +0000343 w_object(co->co_lnotab, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000344 }
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000345 else if (PyObject_CheckReadBuffer(v)) {
Guido van Rossumd076c731998-10-07 19:42:25 +0000346 /* Write unknown buffer-style objects as a string */
347 char *s;
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000348 PyBufferProcs *pb = v->ob_type->tp_as_buffer;
Guido van Rossumd076c731998-10-07 19:42:25 +0000349 w_byte(TYPE_STRING, p);
350 n = (*pb->bf_getreadbuffer)(v, 0, (void **)&s);
351 w_long((long)n, p);
352 w_string(s, n, p);
353 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000354 else {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000355 w_byte(TYPE_UNKNOWN, p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000356 p->error = 1;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000357 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000358 exit:
Guido van Rossum98626cd2000-06-28 23:24:19 +0000359 p->depth--;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000360}
361
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000362/* version currently has no effect for writing longs. */
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000363void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000364PyMarshal_WriteLongToFile(long x, FILE *fp, int version)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000365{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000366 WFILE wf;
367 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000368 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000369 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000370 wf.strings = NULL;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000371 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000372 w_long(x, &wf);
373}
374
375void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000376PyMarshal_WriteObjectToFile(PyObject *x, FILE *fp, int version)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000377{
378 WFILE wf;
379 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000380 wf.error = 0;
Guido van Rossum98626cd2000-06-28 23:24:19 +0000381 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000382 wf.strings = (version > 0) ? PyDict_New() : NULL;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000383 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000384 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000385 Py_XDECREF(wf.strings);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000386}
387
388typedef WFILE RFILE; /* Same struct with different invariants */
389
Guido van Rossum8d617a61995-03-09 12:12:11 +0000390#define rs_byte(p) (((p)->ptr != (p)->end) ? (unsigned char)*(p)->ptr++ : EOF)
391
392#define r_byte(p) ((p)->fp ? getc((p)->fp) : rs_byte(p))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000393
394static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000395r_string(char *s, int n, RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000396{
397 if (p->fp != NULL)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000398 /* The result fits into int because it must be <=n. */
399 return (int)fread(s, 1, n, p->fp);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000400 if (p->end - p->ptr < n)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000401 n = (int)(p->end - p->ptr);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000402 memcpy(s, p->ptr, n);
403 p->ptr += n;
404 return n;
405}
406
407static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000408r_short(RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000409{
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000410 register short x;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000411 x = r_byte(p);
412 x |= r_byte(p) << 8;
Tim Peterse84b7402000-09-19 08:54:13 +0000413 /* Sign-extension, in case short greater than 16 bits */
414 x |= -(x & 0x8000);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000415 return x;
416}
417
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000418static long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000419r_long(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000420{
421 register long x;
Guido van Rossum8d617a61995-03-09 12:12:11 +0000422 register FILE *fp = p->fp;
423 if (fp) {
424 x = getc(fp);
425 x |= (long)getc(fp) << 8;
426 x |= (long)getc(fp) << 16;
427 x |= (long)getc(fp) << 24;
428 }
429 else {
430 x = rs_byte(p);
431 x |= (long)rs_byte(p) << 8;
432 x |= (long)rs_byte(p) << 16;
433 x |= (long)rs_byte(p) << 24;
434 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000435#if SIZEOF_LONG > 4
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000436 /* Sign extension for 64-bit machines */
Tim Peterse84b7402000-09-19 08:54:13 +0000437 x |= -(x & 0x80000000L);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000438#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000439 return x;
440}
441
Tim Peters82112372001-08-29 02:28:42 +0000442/* r_long64 deals with the TYPE_INT64 code. On a machine with
443 sizeof(long) > 4, it returns a Python int object, else a Python long
444 object. Note that w_long64 writes out TYPE_INT if 32 bits is enough,
445 so there's no inefficiency here in returning a PyLong on 32-bit boxes
446 for everything written via TYPE_INT64 (i.e., if an int is written via
447 TYPE_INT64, it *needs* more than 32 bits).
448*/
449static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000450r_long64(RFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000451{
Tim Peters82112372001-08-29 02:28:42 +0000452 long lo4 = r_long(p);
453 long hi4 = r_long(p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000454#if SIZEOF_LONG > 4
Tim Peters82112372001-08-29 02:28:42 +0000455 long x = (hi4 << 32) | (lo4 & 0xFFFFFFFFL);
456 return PyInt_FromLong(x);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000457#else
Tim Peters82112372001-08-29 02:28:42 +0000458 unsigned char buf[8];
459 int one = 1;
460 int is_little_endian = (int)*(char*)&one;
461 if (is_little_endian) {
462 memcpy(buf, &lo4, 4);
463 memcpy(buf+4, &hi4, 4);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000464 }
Tim Peters82112372001-08-29 02:28:42 +0000465 else {
466 memcpy(buf, &hi4, 4);
467 memcpy(buf+4, &lo4, 4);
468 }
469 return _PyLong_FromByteArray(buf, 8, is_little_endian, 1);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000470#endif
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000471}
472
Guido van Rossum79f25d91997-04-29 20:08:16 +0000473static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000474r_object(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000475{
Armin Rigo01ab2792004-03-26 15:09:27 +0000476 /* NULL is a valid return value, it does not necessarily means that
477 an exception is set. */
Raymond Hettingera422c342005-01-11 03:03:27 +0000478 PyObject *v, *v2, *v3;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000479 long i, n;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000480 int type = r_byte(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000481
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000482 switch (type) {
Tim Petersd9b9ac82001-01-28 00:27:39 +0000483
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000484 case EOF:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000485 PyErr_SetString(PyExc_EOFError,
486 "EOF read where object expected");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000487 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000488
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000489 case TYPE_NULL:
490 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000491
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000492 case TYPE_NONE:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000493 Py_INCREF(Py_None);
494 return Py_None;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000495
Tim Peters5ca576e2001-06-18 22:08:13 +0000496 case TYPE_STOPITER:
497 Py_INCREF(PyExc_StopIteration);
498 return PyExc_StopIteration;
499
Guido van Rossume449af71996-10-11 16:25:41 +0000500 case TYPE_ELLIPSIS:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000501 Py_INCREF(Py_Ellipsis);
Guido van Rossume449af71996-10-11 16:25:41 +0000502 return Py_Ellipsis;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000503
Guido van Rossum77f6a652002-04-03 22:41:51 +0000504 case TYPE_FALSE:
505 Py_INCREF(Py_False);
506 return Py_False;
507
508 case TYPE_TRUE:
509 Py_INCREF(Py_True);
510 return Py_True;
511
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000512 case TYPE_INT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000513 return PyInt_FromLong(r_long(p));
Tim Petersd9b9ac82001-01-28 00:27:39 +0000514
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000515 case TYPE_INT64:
Tim Peters82112372001-08-29 02:28:42 +0000516 return r_long64(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000517
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000518 case TYPE_LONG:
519 {
520 int size;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000521 PyLongObject *ob;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000522 n = r_long(p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000523 size = n<0 ? -n : n;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000524 ob = _PyLong_New(size);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000525 if (ob == NULL)
526 return NULL;
527 ob->ob_size = n;
Armin Rigo01ab2792004-03-26 15:09:27 +0000528 for (i = 0; i < size; i++) {
529 int digit = r_short(p);
530 if (digit < 0) {
531 Py_DECREF(ob);
532 PyErr_SetString(PyExc_ValueError,
533 "bad marshal data");
534 return NULL;
535 }
536 ob->ob_digit[i] = digit;
537 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000538 return (PyObject *)ob;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000539 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000540
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000541 case TYPE_FLOAT:
542 {
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000543 char buf[256];
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000544 double dx;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000545 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000546 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000547 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000548 "EOF read where object expected");
549 return NULL;
550 }
551 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000552 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000553 dx = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000554 PyFPE_END_PROTECT(dx)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000555 return PyFloat_FromDouble(dx);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000556 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000557
Michael W. Hudsondf888462005-06-03 14:41:55 +0000558 case TYPE_BINARY_FLOAT:
559 {
Brett Cannonc9371d42005-06-25 08:23:41 +0000560 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000561 double x;
Brett Cannonc9371d42005-06-25 08:23:41 +0000562 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000563 PyErr_SetString(PyExc_EOFError,
564 "EOF read where object expected");
565 return NULL;
566 }
567 x = _PyFloat_Unpack8(buf, 1);
568 if (x == -1.0 && PyErr_Occurred()) {
569 return NULL;
570 }
571 return PyFloat_FromDouble(x);
572 }
573
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000574#ifndef WITHOUT_COMPLEX
575 case TYPE_COMPLEX:
576 {
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000577 char buf[256];
Guido van Rossum530956d1996-07-21 02:27:43 +0000578 Py_complex c;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000579 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000580 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000581 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000582 "EOF read where object expected");
583 return NULL;
584 }
585 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000586 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000587 c.real = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000588 PyFPE_END_PROTECT(c)
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000589 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000590 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000591 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000592 "EOF read where object expected");
593 return NULL;
594 }
595 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000596 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000597 c.imag = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000598 PyFPE_END_PROTECT(c)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000599 return PyComplex_FromCComplex(c);
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000600 }
Michael W. Hudsondf888462005-06-03 14:41:55 +0000601
602 case TYPE_BINARY_COMPLEX:
603 {
Brett Cannonc9371d42005-06-25 08:23:41 +0000604 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000605 Py_complex c;
Brett Cannonc9371d42005-06-25 08:23:41 +0000606 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000607 PyErr_SetString(PyExc_EOFError,
608 "EOF read where object expected");
609 return NULL;
610 }
611 c.real = _PyFloat_Unpack8(buf, 1);
612 if (c.real == -1.0 && PyErr_Occurred()) {
613 return NULL;
614 }
Brett Cannonc9371d42005-06-25 08:23:41 +0000615 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000616 PyErr_SetString(PyExc_EOFError,
617 "EOF read where object expected");
618 return NULL;
619 }
620 c.imag = _PyFloat_Unpack8(buf, 1);
621 if (c.imag == -1.0 && PyErr_Occurred()) {
622 return NULL;
623 }
624 return PyComplex_FromCComplex(c);
625 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000626#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000627
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000628 case TYPE_INTERNED:
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000629 case TYPE_STRING:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000630 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000631 if (n < 0) {
632 PyErr_SetString(PyExc_ValueError, "bad marshal data");
633 return NULL;
634 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000635 v = PyString_FromStringAndSize((char *)NULL, n);
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000636 if (v == NULL)
637 return v;
638 if (r_string(PyString_AS_STRING(v), (int)n, p) != n) {
639 Py_DECREF(v);
640 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000641 "EOF read where object expected");
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000642 return NULL;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000643 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000644 if (type == TYPE_INTERNED) {
645 PyString_InternInPlace(&v);
646 PyList_Append(p->strings, v);
647 }
648 return v;
649
650 case TYPE_STRINGREF:
651 n = r_long(p);
Michael W. Hudsonf2ca5af2005-06-13 18:28:46 +0000652 if (n < 0 || n >= PyList_GET_SIZE(p->strings)) {
653 PyErr_SetString(PyExc_ValueError, "bad marshal data");
654 return NULL;
655 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000656 v = PyList_GET_ITEM(p->strings, n);
657 Py_INCREF(v);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000658 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000659
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000660#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000661 case TYPE_UNICODE:
662 {
663 char *buffer;
664
665 n = r_long(p);
666 if (n < 0) {
667 PyErr_SetString(PyExc_ValueError, "bad marshal data");
668 return NULL;
669 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000670 buffer = PyMem_NEW(char, n);
Guido van Rossumc279b532000-03-10 23:03:02 +0000671 if (buffer == NULL)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000672 return PyErr_NoMemory();
Guido van Rossumc279b532000-03-10 23:03:02 +0000673 if (r_string(buffer, (int)n, p) != n) {
Guido van Rossumb18618d2000-05-03 23:44:39 +0000674 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000675 PyErr_SetString(PyExc_EOFError,
676 "EOF read where object expected");
677 return NULL;
678 }
679 v = PyUnicode_DecodeUTF8(buffer, n, NULL);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000680 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000681 return v;
682 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000683#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000684
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000685 case TYPE_TUPLE:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000686 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000687 if (n < 0) {
688 PyErr_SetString(PyExc_ValueError, "bad marshal data");
689 return NULL;
690 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000691 v = PyTuple_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000692 if (v == NULL)
693 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000694 for (i = 0; i < n; i++) {
695 v2 = r_object(p);
696 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000697 if (!PyErr_Occurred())
698 PyErr_SetString(PyExc_TypeError,
699 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000700 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000701 v = NULL;
702 break;
703 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000704 PyTuple_SET_ITEM(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000705 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000706 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000707
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000708 case TYPE_LIST:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000709 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000710 if (n < 0) {
711 PyErr_SetString(PyExc_ValueError, "bad marshal data");
712 return NULL;
713 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000714 v = PyList_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000715 if (v == NULL)
716 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000717 for (i = 0; i < n; i++) {
718 v2 = r_object(p);
719 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000720 if (!PyErr_Occurred())
721 PyErr_SetString(PyExc_TypeError,
722 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000723 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000724 v = NULL;
725 break;
726 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000727 PyList_SetItem(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000728 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000729 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000730
Guido van Rossum64b45521991-06-07 13:58:22 +0000731 case TYPE_DICT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000732 v = PyDict_New();
Guido van Rossum64b45521991-06-07 13:58:22 +0000733 if (v == NULL)
734 return NULL;
735 for (;;) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000736 PyObject *key, *val;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000737 key = r_object(p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000738 if (key == NULL)
Armin Rigo01ab2792004-03-26 15:09:27 +0000739 break;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000740 val = r_object(p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000741 if (val != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000742 PyDict_SetItem(v, key, val);
743 Py_DECREF(key);
744 Py_XDECREF(val);
Guido van Rossum64b45521991-06-07 13:58:22 +0000745 }
Armin Rigo01ab2792004-03-26 15:09:27 +0000746 if (PyErr_Occurred()) {
747 Py_DECREF(v);
748 v = NULL;
749 }
Guido van Rossum64b45521991-06-07 13:58:22 +0000750 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000751
Raymond Hettingera422c342005-01-11 03:03:27 +0000752 case TYPE_SET:
753 case TYPE_FROZENSET:
754 n = r_long(p);
755 if (n < 0) {
756 PyErr_SetString(PyExc_ValueError, "bad marshal data");
757 return NULL;
758 }
759 v = PyTuple_New((int)n);
760 if (v == NULL)
761 return v;
762 for (i = 0; i < n; i++) {
763 v2 = r_object(p);
764 if ( v2 == NULL ) {
765 if (!PyErr_Occurred())
766 PyErr_SetString(PyExc_TypeError,
767 "NULL object in marshal data");
768 Py_DECREF(v);
769 v = NULL;
770 break;
771 }
772 PyTuple_SET_ITEM(v, (int)i, v2);
773 }
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000774 if (v == NULL)
775 return v;
Raymond Hettingera422c342005-01-11 03:03:27 +0000776 if (type == TYPE_SET)
Raymond Hettingerbeb31012005-08-16 03:47:52 +0000777 v3 = PySet_New(v);
Raymond Hettingera422c342005-01-11 03:03:27 +0000778 else
Raymond Hettingerbeb31012005-08-16 03:47:52 +0000779 v3 = PyFrozenSet_New(v);
Raymond Hettingera422c342005-01-11 03:03:27 +0000780 Py_DECREF(v);
781 return v3;
782
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000783 case TYPE_CODE:
Michael W. Hudson80199132001-08-30 14:50:20 +0000784 if (PyEval_GetRestricted()) {
785 PyErr_SetString(PyExc_RuntimeError,
786 "cannot unmarshal code objects in "
787 "restricted execution mode");
788 return NULL;
789 }
790 else {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000791 int argcount;
792 int nlocals;
793 int stacksize;
794 int flags;
795 PyObject *code = NULL;
796 PyObject *consts = NULL;
797 PyObject *names = NULL;
798 PyObject *varnames = NULL;
799 PyObject *freevars = NULL;
800 PyObject *cellvars = NULL;
801 PyObject *filename = NULL;
802 PyObject *name = NULL;
803 int firstlineno;
804 PyObject *lnotab = NULL;
805
806 v = NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000807
Michael W. Hudsondf888462005-06-03 14:41:55 +0000808 argcount = r_long(p);
809 nlocals = r_long(p);
810 stacksize = r_long(p);
811 flags = r_long(p);
812 code = r_object(p);
813 if (code == NULL)
814 goto code_error;
815 consts = r_object(p);
816 if (consts == NULL)
817 goto code_error;
818 names = r_object(p);
819 if (names == NULL)
820 goto code_error;
821 varnames = r_object(p);
822 if (varnames == NULL)
823 goto code_error;
824 freevars = r_object(p);
825 if (freevars == NULL)
826 goto code_error;
827 cellvars = r_object(p);
828 if (cellvars == NULL)
829 goto code_error;
830 filename = r_object(p);
831 if (filename == NULL)
832 goto code_error;
833 name = r_object(p);
834 if (name == NULL)
835 goto code_error;
836 firstlineno = r_long(p);
837 lnotab = r_object(p);
838 if (lnotab == NULL)
839 goto code_error;
840
841 v = (PyObject *) PyCode_New(
Tim Petersd9b9ac82001-01-28 00:27:39 +0000842 argcount, nlocals, stacksize, flags,
Guido van Rossum681d79a1995-07-18 14:51:37 +0000843 code, consts, names, varnames,
Tim Petersd9b9ac82001-01-28 00:27:39 +0000844 freevars, cellvars, filename, name,
845 firstlineno, lnotab);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000846
847 code_error:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000848 Py_XDECREF(code);
849 Py_XDECREF(consts);
850 Py_XDECREF(names);
851 Py_XDECREF(varnames);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000852 Py_XDECREF(freevars);
853 Py_XDECREF(cellvars);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000854 Py_XDECREF(filename);
855 Py_XDECREF(name);
Guido van Rossum6fc06e71997-07-26 23:30:18 +0000856 Py_XDECREF(lnotab);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000857
858 }
859 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000860
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000861 default:
Guido van Rossumf2150601996-06-26 20:41:23 +0000862 /* Bogus data got written, which isn't ideal.
863 This will let you keep working and recover. */
Guido van Rossuma45cb451998-06-08 20:27:29 +0000864 PyErr_SetString(PyExc_ValueError, "bad marshal data");
865 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000866
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000867 }
868}
869
Neal Norwitzd85c4522004-06-13 20:31:49 +0000870static PyObject *
Armin Rigo01ab2792004-03-26 15:09:27 +0000871read_object(RFILE *p)
872{
873 PyObject *v;
874 if (PyErr_Occurred()) {
875 fprintf(stderr, "XXX readobject called with exception set\n");
876 return NULL;
877 }
878 v = r_object(p);
879 if (v == NULL && !PyErr_Occurred())
880 PyErr_SetString(PyExc_TypeError, "NULL object in marshal data");
881 return v;
882}
883
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000884int
885PyMarshal_ReadShortFromFile(FILE *fp)
886{
887 RFILE rf;
888 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000889 rf.strings = NULL;
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000890 return r_short(&rf);
891}
892
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000893long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000894PyMarshal_ReadLongFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000895{
896 RFILE rf;
897 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000898 rf.strings = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000899 return r_long(&rf);
900}
901
Tim Peters691e0e92001-01-18 04:39:16 +0000902#ifdef HAVE_FSTAT
903/* Return size of file in bytes; < 0 if unknown. */
904static off_t
905getfilesize(FILE *fp)
906{
907 struct stat st;
908 if (fstat(fileno(fp), &st) != 0)
909 return -1;
910 else
911 return st.st_size;
912}
913#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000914
Tim Peters691e0e92001-01-18 04:39:16 +0000915/* If we can get the size of the file up-front, and it's reasonably small,
916 * read it in one gulp and delegate to ...FromString() instead. Much quicker
917 * than reading a byte at a time from file; speeds .pyc imports.
Tim Petersd9b9ac82001-01-28 00:27:39 +0000918 * CAUTION: since this may read the entire remainder of the file, don't
919 * call it unless you know you're done with the file.
Tim Peters691e0e92001-01-18 04:39:16 +0000920 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000921PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000922PyMarshal_ReadLastObjectFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000923{
Tim Peters691e0e92001-01-18 04:39:16 +0000924/* 75% of 2.1's .pyc files can exploit SMALL_FILE_LIMIT.
925 * REASONABLE_FILE_LIMIT is by defn something big enough for Tkinter.pyc.
926 */
927#define SMALL_FILE_LIMIT (1L << 14)
928#define REASONABLE_FILE_LIMIT (1L << 18)
Tim Peters691e0e92001-01-18 04:39:16 +0000929#ifdef HAVE_FSTAT
930 off_t filesize;
931#endif
Tim Peters691e0e92001-01-18 04:39:16 +0000932#ifdef HAVE_FSTAT
933 filesize = getfilesize(fp);
934 if (filesize > 0) {
935 char buf[SMALL_FILE_LIMIT];
936 char* pBuf = NULL;
937 if (filesize <= SMALL_FILE_LIMIT)
938 pBuf = buf;
939 else if (filesize <= REASONABLE_FILE_LIMIT)
940 pBuf = (char *)PyMem_MALLOC(filesize);
941 if (pBuf != NULL) {
942 PyObject* v;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000943 size_t n;
944 /* filesize must fit into an int, because it
945 is smaller than REASONABLE_FILE_LIMIT */
946 n = fread(pBuf, 1, (int)filesize, fp);
Tim Peters691e0e92001-01-18 04:39:16 +0000947 v = PyMarshal_ReadObjectFromString(pBuf, n);
948 if (pBuf != buf)
949 PyMem_FREE(pBuf);
950 return v;
951 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000952
Tim Peters691e0e92001-01-18 04:39:16 +0000953 }
954#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000955 /* We don't have fstat, or we do but the file is larger than
956 * REASONABLE_FILE_LIMIT or malloc failed -- read a byte at a time.
957 */
958 return PyMarshal_ReadObjectFromFile(fp);
959
Tim Peters691e0e92001-01-18 04:39:16 +0000960#undef SMALL_FILE_LIMIT
961#undef REASONABLE_FILE_LIMIT
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000962}
963
Guido van Rossum79f25d91997-04-29 20:08:16 +0000964PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000965PyMarshal_ReadObjectFromFile(FILE *fp)
966{
967 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000968 PyObject *result;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000969 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000970 rf.strings = PyList_New(0);
971 result = r_object(&rf);
972 Py_DECREF(rf.strings);
973 return result;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000974}
975
976PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000977PyMarshal_ReadObjectFromString(char *str, Py_ssize_t len)
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000978{
979 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000980 PyObject *result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000981 rf.fp = NULL;
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000982 rf.ptr = str;
983 rf.end = str + len;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000984 rf.strings = PyList_New(0);
985 result = r_object(&rf);
986 Py_DECREF(rf.strings);
987 return result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000988}
989
Guido van Rossum79f25d91997-04-29 20:08:16 +0000990PyObject *
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000991PyMarshal_WriteObjectToString(PyObject *x, int version)
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000992{
993 WFILE wf;
994 wf.fp = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000995 wf.str = PyString_FromStringAndSize((char *)NULL, 50);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000996 if (wf.str == NULL)
997 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000998 wf.ptr = PyString_AS_STRING((PyStringObject *)wf.str);
999 wf.end = wf.ptr + PyString_Size(wf.str);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001000 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +00001001 wf.depth = 0;
Michael W. Hudsondf888462005-06-03 14:41:55 +00001002 wf.version = version;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001003 wf.strings = (version > 0) ? PyDict_New() : NULL;
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001004 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001005 Py_XDECREF(wf.strings);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001006 if (wf.str != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00001007 _PyString_Resize(&wf.str,
1008 (int) (wf.ptr -
1009 PyString_AS_STRING((PyStringObject *)wf.str)));
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001010 if (wf.error) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001011 Py_XDECREF(wf.str);
Tim Petersd9b9ac82001-01-28 00:27:39 +00001012 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +00001013 (wf.error==1)?"unmarshallable object"
1014 :"object too deeply nested to marshal");
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001015 return NULL;
1016 }
1017 return wf.str;
1018}
1019
Guido van Rossum64b45521991-06-07 13:58:22 +00001020/* And an interface for Python programs... */
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001021
Guido van Rossum79f25d91997-04-29 20:08:16 +00001022static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001023marshal_dump(PyObject *self, PyObject *args)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001024{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001025 WFILE wf;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001026 PyObject *x;
1027 PyObject *f;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001028 int version = Py_MARSHAL_VERSION;
1029 if (!PyArg_ParseTuple(args, "OO|i:dump", &x, &f, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001030 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001031 if (!PyFile_Check(f)) {
1032 PyErr_SetString(PyExc_TypeError,
1033 "marshal.dump() 2nd arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001034 return NULL;
1035 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001036 wf.fp = PyFile_AsFile(f);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001037 wf.str = NULL;
1038 wf.ptr = wf.end = NULL;
Guido van Rossumf2150601996-06-26 20:41:23 +00001039 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +00001040 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001041 wf.strings = (version > 0) ? PyDict_New() : 0;
Neal Norwitzef785292005-11-16 05:04:51 +00001042 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001043 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001044 Py_XDECREF(wf.strings);
Guido van Rossumf2150601996-06-26 20:41:23 +00001045 if (wf.error) {
Tim Petersd9b9ac82001-01-28 00:27:39 +00001046 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +00001047 (wf.error==1)?"unmarshallable object"
1048 :"object too deeply nested to marshal");
Guido van Rossumf2150601996-06-26 20:41:23 +00001049 return NULL;
1050 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001051 Py_INCREF(Py_None);
1052 return Py_None;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001053}
1054
Guido van Rossum79f25d91997-04-29 20:08:16 +00001055static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001056marshal_load(PyObject *self, PyObject *args)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001057{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001058 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001059 PyObject *f, *result;
Guido van Rossum2efa3692000-03-31 00:37:41 +00001060 if (!PyArg_ParseTuple(args, "O:load", &f))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001061 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001062 if (!PyFile_Check(f)) {
1063 PyErr_SetString(PyExc_TypeError,
1064 "marshal.load() arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001065 return NULL;
1066 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001067 rf.fp = PyFile_AsFile(f);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001068 rf.strings = PyList_New(0);
1069 result = read_object(&rf);
1070 Py_DECREF(rf.strings);
1071 return result;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001072}
1073
Guido van Rossum79f25d91997-04-29 20:08:16 +00001074static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001075marshal_dumps(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001076{
Guido van Rossum79f25d91997-04-29 20:08:16 +00001077 PyObject *x;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001078 int version = Py_MARSHAL_VERSION;
Armin Rigo2ccea172004-12-20 12:25:57 +00001079 if (!PyArg_ParseTuple(args, "O|i:dumps", &x, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001080 return NULL;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001081 return PyMarshal_WriteObjectToString(x, version);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001082}
1083
Guido van Rossum79f25d91997-04-29 20:08:16 +00001084static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001085marshal_loads(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001086{
1087 RFILE rf;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001088 char *s;
1089 int n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001090 PyObject* result;
Michael W. Hudson01fca112005-06-13 17:50:18 +00001091 if (!PyArg_ParseTuple(args, "s#:loads", &s, &n))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001092 return NULL;
1093 rf.fp = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001094 rf.ptr = s;
1095 rf.end = s + n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001096 rf.strings = PyList_New(0);
1097 result = read_object(&rf);
1098 Py_DECREF(rf.strings);
1099 return result;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001100}
1101
Guido van Rossum79f25d91997-04-29 20:08:16 +00001102static PyMethodDef marshal_methods[] = {
Neal Norwitz031829d2002-03-31 14:37:44 +00001103 {"dump", marshal_dump, METH_VARARGS},
1104 {"load", marshal_load, METH_VARARGS},
1105 {"dumps", marshal_dumps, METH_VARARGS},
1106 {"loads", marshal_loads, METH_VARARGS},
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001107 {NULL, NULL} /* sentinel */
1108};
1109
Jason Tishler6bc06ec2003-09-04 11:59:50 +00001110PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001111PyMarshal_Init(void)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001112{
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001113 PyObject *mod = Py_InitModule("marshal", marshal_methods);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00001114 if (mod == NULL)
1115 return;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001116 PyModule_AddIntConstant(mod, "version", Py_MARSHAL_VERSION);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001117}