blob: 10a6c0c1d7ae1bd11d1328c8cafbffacb2f59f3e [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
Thomas Wouters695934a2006-03-01 23:49:13 +00007#define PY_SSIZE_T_CLEAN
8
Guido van Rossum79f25d91997-04-29 20:08:16 +00009#include "Python.h"
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000010#include "longintrepr.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000011#include "code.h"
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000012#include "marshal.h"
13
Fred Drake6da0b912000-06-28 18:47:56 +000014/* High water mark to determine when the marshalled object is dangerously deep
15 * and risks coring the interpreter. When the object stack gets this deep,
16 * raise an exception instead of continuing.
17 */
18#define MAX_MARSHAL_STACK_DEPTH 5000
19
Michael W. Hudsondf888462005-06-03 14:41:55 +000020#define TYPE_NULL '0'
21#define TYPE_NONE 'N'
22#define TYPE_FALSE 'F'
23#define TYPE_TRUE 'T'
24#define TYPE_STOPITER 'S'
25#define TYPE_ELLIPSIS '.'
26#define TYPE_INT 'i'
27#define TYPE_INT64 'I'
28#define TYPE_FLOAT 'f'
29#define TYPE_BINARY_FLOAT 'g'
30#define TYPE_COMPLEX 'x'
31#define TYPE_BINARY_COMPLEX 'y'
32#define TYPE_LONG 'l'
33#define TYPE_STRING 's'
34#define TYPE_INTERNED 't'
35#define TYPE_STRINGREF 'R'
36#define TYPE_TUPLE '('
37#define TYPE_LIST '['
38#define TYPE_DICT '{'
39#define TYPE_CODE 'c'
40#define TYPE_UNICODE 'u'
41#define TYPE_UNKNOWN '?'
42#define TYPE_SET '<'
43#define TYPE_FROZENSET '>'
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000044
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000045typedef struct {
46 FILE *fp;
Guido van Rossumf2150601996-06-26 20:41:23 +000047 int error;
Fred Drake6da0b912000-06-28 18:47:56 +000048 int depth;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000049 /* If fp == NULL, the following are valid: */
Guido van Rossum79f25d91997-04-29 20:08:16 +000050 PyObject *str;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000051 char *ptr;
52 char *end;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000053 PyObject *strings; /* dict on marshal, list on unmarshal */
Michael W. Hudsondf888462005-06-03 14:41:55 +000054 int version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000055} WFILE;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000056
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000057#define w_byte(c, p) if (((p)->fp)) putc((c), (p)->fp); \
58 else if ((p)->ptr != (p)->end) *(p)->ptr++ = (c); \
59 else w_more(c, p)
60
61static void
Fredrik Lundh11534382000-07-23 18:24:06 +000062w_more(int c, WFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000063{
Martin v. Löwis18e16552006-02-15 17:27:45 +000064 Py_ssize_t size, newsize;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000065 if (p->str == NULL)
66 return; /* An error already occurred */
Guido van Rossum79f25d91997-04-29 20:08:16 +000067 size = PyString_Size(p->str);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000068 newsize = size + 1024;
Guido van Rossum79f25d91997-04-29 20:08:16 +000069 if (_PyString_Resize(&p->str, newsize) != 0) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000070 p->ptr = p->end = NULL;
71 }
72 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +000073 p->ptr = PyString_AS_STRING((PyStringObject *)p->str) + size;
74 p->end =
75 PyString_AS_STRING((PyStringObject *)p->str) + newsize;
Tim Peters8315ea52000-07-23 19:28:35 +000076 *p->ptr++ = Py_SAFE_DOWNCAST(c, int, char);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000077 }
78}
79
80static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000081w_string(char *s, int n, WFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000082{
83 if (p->fp != NULL) {
84 fwrite(s, 1, n, p->fp);
85 }
86 else {
87 while (--n >= 0) {
88 w_byte(*s, p);
89 s++;
90 }
91 }
92}
93
94static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000095w_short(int x, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000096{
Thomas Heller3e1c18a2002-07-30 11:40:57 +000097 w_byte((char)( x & 0xff), p);
98 w_byte((char)((x>> 8) & 0xff), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000099}
100
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000101static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000102w_long(long x, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000103{
Thomas Heller37d5a152002-07-30 11:44:44 +0000104 w_byte((char)( x & 0xff), p);
105 w_byte((char)((x>> 8) & 0xff), p);
106 w_byte((char)((x>>16) & 0xff), p);
107 w_byte((char)((x>>24) & 0xff), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000108}
109
Guido van Rossumc1547d91996-12-10 15:39:04 +0000110#if SIZEOF_LONG > 4
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000111static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000112w_long64(long x, WFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000113{
114 w_long(x, p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000115 w_long(x>>32, p);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000116}
Guido van Rossumc1547d91996-12-10 15:39:04 +0000117#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000118
119static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000120w_object(PyObject *v, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000121{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000122 Py_ssize_t i, n;
Fred Drake6da0b912000-06-28 18:47:56 +0000123
124 p->depth++;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000125
Fred Drake6da0b912000-06-28 18:47:56 +0000126 if (p->depth > MAX_MARSHAL_STACK_DEPTH) {
127 p->error = 2;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000128 }
Fred Drake6da0b912000-06-28 18:47:56 +0000129 else if (v == NULL) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000130 w_byte(TYPE_NULL, p);
Guido van Rossum730806d1998-04-10 22:27:42 +0000131 }
132 else if (v == Py_None) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000133 w_byte(TYPE_NONE, p);
Guido van Rossum730806d1998-04-10 22:27:42 +0000134 }
Tim Peters5ca576e2001-06-18 22:08:13 +0000135 else if (v == PyExc_StopIteration) {
136 w_byte(TYPE_STOPITER, p);
137 }
Guido van Rossum730806d1998-04-10 22:27:42 +0000138 else if (v == Py_Ellipsis) {
139 w_byte(TYPE_ELLIPSIS, p);
140 }
Guido van Rossum77f6a652002-04-03 22:41:51 +0000141 else if (v == Py_False) {
142 w_byte(TYPE_FALSE, p);
143 }
144 else if (v == Py_True) {
145 w_byte(TYPE_TRUE, p);
146 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000147 else if (PyInt_Check(v)) {
148 long x = PyInt_AS_LONG((PyIntObject *)v);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000149#if SIZEOF_LONG > 4
Tim Peters44714002001-04-10 05:02:52 +0000150 long y = Py_ARITHMETIC_RIGHT_SHIFT(long, x, 31);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000151 if (y && y != -1) {
152 w_byte(TYPE_INT64, p);
153 w_long64(x, p);
154 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000155 else
156#endif
157 {
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000158 w_byte(TYPE_INT, p);
159 w_long(x, p);
160 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000161 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000162 else if (PyLong_Check(v)) {
163 PyLongObject *ob = (PyLongObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000164 w_byte(TYPE_LONG, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000165 n = ob->ob_size;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000166 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000167 if (n < 0)
168 n = -n;
169 for (i = 0; i < n; i++)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000170 w_short(ob->ob_digit[i], p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000171 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000172 else if (PyFloat_Check(v)) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000173 if (p->version > 1) {
Brett Cannonc9371d42005-06-25 08:23:41 +0000174 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000175 if (_PyFloat_Pack8(PyFloat_AsDouble(v),
176 buf, 1) < 0) {
177 p->error = 1;
178 return;
179 }
180 w_byte(TYPE_BINARY_FLOAT, p);
Brett Cannonc9371d42005-06-25 08:23:41 +0000181 w_string((char*)buf, 8, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000182 }
183 else {
184 char buf[256]; /* Plenty to format any double */
185 PyFloat_AsReprString(buf, (PyFloatObject *)v);
Martin v. Löwis67baee62006-02-16 14:37:48 +0000186 n = strlen(buf);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000187 w_byte(TYPE_FLOAT, p);
Martin v. Löwis67baee62006-02-16 14:37:48 +0000188 w_byte((int)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000189 w_string(buf, (int)n, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000190 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000191 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000192#ifndef WITHOUT_COMPLEX
Guido van Rossum79f25d91997-04-29 20:08:16 +0000193 else if (PyComplex_Check(v)) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000194 if (p->version > 1) {
Brett Cannonc9371d42005-06-25 08:23:41 +0000195 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000196 if (_PyFloat_Pack8(PyComplex_RealAsDouble(v),
197 buf, 1) < 0) {
198 p->error = 1;
199 return;
200 }
201 w_byte(TYPE_BINARY_COMPLEX, p);
Brett Cannonc9371d42005-06-25 08:23:41 +0000202 w_string((char*)buf, 8, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000203 if (_PyFloat_Pack8(PyComplex_ImagAsDouble(v),
204 buf, 1) < 0) {
205 p->error = 1;
206 return;
207 }
Brett Cannonc9371d42005-06-25 08:23:41 +0000208 w_string((char*)buf, 8, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000209 }
210 else {
211 char buf[256]; /* Plenty to format any double */
212 PyFloatObject *temp;
213 w_byte(TYPE_COMPLEX, p);
214 temp = (PyFloatObject*)PyFloat_FromDouble(
215 PyComplex_RealAsDouble(v));
216 PyFloat_AsReprString(buf, temp);
217 Py_DECREF(temp);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000218 n = strlen(buf);
219 w_byte((int)n, p);
220 w_string(buf, (int)n, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000221 temp = (PyFloatObject*)PyFloat_FromDouble(
222 PyComplex_ImagAsDouble(v));
223 PyFloat_AsReprString(buf, temp);
224 Py_DECREF(temp);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000225 n = strlen(buf);
226 w_byte((int)n, p);
227 w_string(buf, (int)n, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000228 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000229 }
230#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +0000231 else if (PyString_Check(v)) {
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000232 if (p->strings && PyString_CHECK_INTERNED(v)) {
233 PyObject *o = PyDict_GetItem(p->strings, v);
234 if (o) {
235 long w = PyInt_AsLong(o);
236 w_byte(TYPE_STRINGREF, p);
237 w_long(w, p);
238 goto exit;
239 }
240 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000241 o = PyInt_FromSsize_t(PyDict_Size(p->strings));
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000242 PyDict_SetItem(p->strings, v, o);
243 Py_DECREF(o);
244 w_byte(TYPE_INTERNED, p);
245 }
246 }
247 else {
248 w_byte(TYPE_STRING, p);
249 }
Guido van Rossumc279b532000-03-10 23:03:02 +0000250 n = PyString_GET_SIZE(v);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000251 if (n > INT_MAX) {
252 /* huge strings are not supported */
253 p->depth--;
254 p->error = 1;
255 return;
256 }
Guido van Rossum3a205f71995-02-17 15:10:07 +0000257 w_long((long)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000258 w_string(PyString_AS_STRING(v), (int)n, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000259 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000260#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000261 else if (PyUnicode_Check(v)) {
262 PyObject *utf8;
263 utf8 = PyUnicode_AsUTF8String(v);
264 if (utf8 == NULL) {
Guido van Rossum98626cd2000-06-28 23:24:19 +0000265 p->depth--;
266 p->error = 1;
267 return;
Guido van Rossumc279b532000-03-10 23:03:02 +0000268 }
269 w_byte(TYPE_UNICODE, p);
270 n = PyString_GET_SIZE(utf8);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000271 if (n > INT_MAX) {
272 p->depth--;
273 p->error = 1;
274 return;
275 }
Guido van Rossumc279b532000-03-10 23:03:02 +0000276 w_long((long)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000277 w_string(PyString_AS_STRING(utf8), (int)n, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000278 Py_DECREF(utf8);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000279 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000280#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +0000281 else if (PyTuple_Check(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000282 w_byte(TYPE_TUPLE, p);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000283 n = PyTuple_Size(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000284 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000285 for (i = 0; i < n; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000286 w_object(PyTuple_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000287 }
288 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000289 else if (PyList_Check(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000290 w_byte(TYPE_LIST, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000291 n = PyList_GET_SIZE(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000292 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000293 for (i = 0; i < n; i++) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000294 w_object(PyList_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000295 }
296 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000297 else if (PyDict_Check(v)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000298 Py_ssize_t pos;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000299 PyObject *key, *value;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000300 w_byte(TYPE_DICT, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000301 /* This one is NULL object terminated! */
Guido van Rossum25831651993-05-19 14:50:45 +0000302 pos = 0;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000303 while (PyDict_Next(v, &pos, &key, &value)) {
Guido van Rossum25831651993-05-19 14:50:45 +0000304 w_object(key, p);
305 w_object(value, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000306 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000307 w_object((PyObject *)NULL, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000308 }
Raymond Hettingera422c342005-01-11 03:03:27 +0000309 else if (PyAnySet_Check(v)) {
Raymond Hettingera422c342005-01-11 03:03:27 +0000310 PyObject *value, *it;
311
312 if (PyObject_TypeCheck(v, &PySet_Type))
313 w_byte(TYPE_SET, p);
314 else
315 w_byte(TYPE_FROZENSET, p);
316 n = PyObject_Size(v);
317 if (n == -1) {
318 p->depth--;
319 p->error = 1;
320 return;
321 }
322 w_long((long)n, p);
323 it = PyObject_GetIter(v);
324 if (it == NULL) {
325 p->depth--;
326 p->error = 1;
327 return;
328 }
329 while ((value = PyIter_Next(it)) != NULL) {
330 w_object(value, p);
331 Py_DECREF(value);
332 }
333 Py_DECREF(it);
334 if (PyErr_Occurred()) {
335 p->depth--;
336 p->error = 1;
337 return;
338 }
339 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000340 else if (PyCode_Check(v)) {
341 PyCodeObject *co = (PyCodeObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000342 w_byte(TYPE_CODE, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000343 w_long(co->co_argcount, p);
344 w_long(co->co_nlocals, p);
345 w_long(co->co_stacksize, p);
346 w_long(co->co_flags, p);
Guido van Rossumd076c731998-10-07 19:42:25 +0000347 w_object(co->co_code, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000348 w_object(co->co_consts, p);
349 w_object(co->co_names, p);
Guido van Rossum681d79a1995-07-18 14:51:37 +0000350 w_object(co->co_varnames, p);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000351 w_object(co->co_freevars, p);
352 w_object(co->co_cellvars, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000353 w_object(co->co_filename, p);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000354 w_object(co->co_name, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000355 w_long(co->co_firstlineno, p);
Guido van Rossumd031c891997-01-24 03:44:17 +0000356 w_object(co->co_lnotab, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000357 }
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000358 else if (PyObject_CheckReadBuffer(v)) {
Guido van Rossumd076c731998-10-07 19:42:25 +0000359 /* Write unknown buffer-style objects as a string */
360 char *s;
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000361 PyBufferProcs *pb = v->ob_type->tp_as_buffer;
Guido van Rossumd076c731998-10-07 19:42:25 +0000362 w_byte(TYPE_STRING, p);
363 n = (*pb->bf_getreadbuffer)(v, 0, (void **)&s);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000364 if (n > INT_MAX) {
365 p->depth--;
366 p->error = 1;
367 return;
368 }
Guido van Rossumd076c731998-10-07 19:42:25 +0000369 w_long((long)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000370 w_string(s, (int)n, p);
Guido van Rossumd076c731998-10-07 19:42:25 +0000371 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000372 else {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000373 w_byte(TYPE_UNKNOWN, p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000374 p->error = 1;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000375 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000376 exit:
Guido van Rossum98626cd2000-06-28 23:24:19 +0000377 p->depth--;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000378}
379
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000380/* version currently has no effect for writing longs. */
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000381void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000382PyMarshal_WriteLongToFile(long x, FILE *fp, int version)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000383{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000384 WFILE wf;
385 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000386 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000387 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000388 wf.strings = NULL;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000389 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000390 w_long(x, &wf);
391}
392
393void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000394PyMarshal_WriteObjectToFile(PyObject *x, FILE *fp, int version)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000395{
396 WFILE wf;
397 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000398 wf.error = 0;
Guido van Rossum98626cd2000-06-28 23:24:19 +0000399 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000400 wf.strings = (version > 0) ? PyDict_New() : NULL;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000401 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000402 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000403 Py_XDECREF(wf.strings);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000404}
405
406typedef WFILE RFILE; /* Same struct with different invariants */
407
Guido van Rossum8d617a61995-03-09 12:12:11 +0000408#define rs_byte(p) (((p)->ptr != (p)->end) ? (unsigned char)*(p)->ptr++ : EOF)
409
410#define r_byte(p) ((p)->fp ? getc((p)->fp) : rs_byte(p))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000411
412static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000413r_string(char *s, int n, RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000414{
415 if (p->fp != NULL)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000416 /* The result fits into int because it must be <=n. */
417 return (int)fread(s, 1, n, p->fp);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000418 if (p->end - p->ptr < n)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000419 n = (int)(p->end - p->ptr);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000420 memcpy(s, p->ptr, n);
421 p->ptr += n;
422 return n;
423}
424
425static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000426r_short(RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000427{
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000428 register short x;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000429 x = r_byte(p);
430 x |= r_byte(p) << 8;
Tim Peterse84b7402000-09-19 08:54:13 +0000431 /* Sign-extension, in case short greater than 16 bits */
432 x |= -(x & 0x8000);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000433 return x;
434}
435
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000436static long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000437r_long(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000438{
439 register long x;
Guido van Rossum8d617a61995-03-09 12:12:11 +0000440 register FILE *fp = p->fp;
441 if (fp) {
442 x = getc(fp);
443 x |= (long)getc(fp) << 8;
444 x |= (long)getc(fp) << 16;
445 x |= (long)getc(fp) << 24;
446 }
447 else {
448 x = rs_byte(p);
449 x |= (long)rs_byte(p) << 8;
450 x |= (long)rs_byte(p) << 16;
451 x |= (long)rs_byte(p) << 24;
452 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000453#if SIZEOF_LONG > 4
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000454 /* Sign extension for 64-bit machines */
Tim Peterse84b7402000-09-19 08:54:13 +0000455 x |= -(x & 0x80000000L);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000456#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000457 return x;
458}
459
Tim Peters82112372001-08-29 02:28:42 +0000460/* r_long64 deals with the TYPE_INT64 code. On a machine with
461 sizeof(long) > 4, it returns a Python int object, else a Python long
462 object. Note that w_long64 writes out TYPE_INT if 32 bits is enough,
463 so there's no inefficiency here in returning a PyLong on 32-bit boxes
464 for everything written via TYPE_INT64 (i.e., if an int is written via
465 TYPE_INT64, it *needs* more than 32 bits).
466*/
467static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000468r_long64(RFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000469{
Tim Peters82112372001-08-29 02:28:42 +0000470 long lo4 = r_long(p);
471 long hi4 = r_long(p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000472#if SIZEOF_LONG > 4
Tim Peters82112372001-08-29 02:28:42 +0000473 long x = (hi4 << 32) | (lo4 & 0xFFFFFFFFL);
474 return PyInt_FromLong(x);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000475#else
Tim Peters82112372001-08-29 02:28:42 +0000476 unsigned char buf[8];
477 int one = 1;
478 int is_little_endian = (int)*(char*)&one;
479 if (is_little_endian) {
480 memcpy(buf, &lo4, 4);
481 memcpy(buf+4, &hi4, 4);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000482 }
Tim Peters82112372001-08-29 02:28:42 +0000483 else {
484 memcpy(buf, &hi4, 4);
485 memcpy(buf+4, &lo4, 4);
486 }
487 return _PyLong_FromByteArray(buf, 8, is_little_endian, 1);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000488#endif
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000489}
490
Guido van Rossum79f25d91997-04-29 20:08:16 +0000491static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000492r_object(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000493{
Armin Rigo01ab2792004-03-26 15:09:27 +0000494 /* NULL is a valid return value, it does not necessarily means that
495 an exception is set. */
Raymond Hettingera422c342005-01-11 03:03:27 +0000496 PyObject *v, *v2, *v3;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000497 long i, n;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000498 int type = r_byte(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000499
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000500 switch (type) {
Tim Petersd9b9ac82001-01-28 00:27:39 +0000501
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000502 case EOF:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000503 PyErr_SetString(PyExc_EOFError,
504 "EOF read where object expected");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000505 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000506
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000507 case TYPE_NULL:
508 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000509
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000510 case TYPE_NONE:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000511 Py_INCREF(Py_None);
512 return Py_None;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000513
Tim Peters5ca576e2001-06-18 22:08:13 +0000514 case TYPE_STOPITER:
515 Py_INCREF(PyExc_StopIteration);
516 return PyExc_StopIteration;
517
Guido van Rossume449af71996-10-11 16:25:41 +0000518 case TYPE_ELLIPSIS:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000519 Py_INCREF(Py_Ellipsis);
Guido van Rossume449af71996-10-11 16:25:41 +0000520 return Py_Ellipsis;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000521
Guido van Rossum77f6a652002-04-03 22:41:51 +0000522 case TYPE_FALSE:
523 Py_INCREF(Py_False);
524 return Py_False;
525
526 case TYPE_TRUE:
527 Py_INCREF(Py_True);
528 return Py_True;
529
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000530 case TYPE_INT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000531 return PyInt_FromLong(r_long(p));
Tim Petersd9b9ac82001-01-28 00:27:39 +0000532
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000533 case TYPE_INT64:
Tim Peters82112372001-08-29 02:28:42 +0000534 return r_long64(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000535
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000536 case TYPE_LONG:
537 {
538 int size;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000539 PyLongObject *ob;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000540 n = r_long(p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000541 size = n<0 ? -n : n;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000542 ob = _PyLong_New(size);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000543 if (ob == NULL)
544 return NULL;
545 ob->ob_size = n;
Armin Rigo01ab2792004-03-26 15:09:27 +0000546 for (i = 0; i < size; i++) {
547 int digit = r_short(p);
548 if (digit < 0) {
549 Py_DECREF(ob);
550 PyErr_SetString(PyExc_ValueError,
551 "bad marshal data");
552 return NULL;
553 }
554 ob->ob_digit[i] = digit;
555 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000556 return (PyObject *)ob;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000557 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000558
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000559 case TYPE_FLOAT:
560 {
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000561 char buf[256];
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000562 double dx;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000563 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000564 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000565 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000566 "EOF read where object expected");
567 return NULL;
568 }
569 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000570 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000571 dx = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000572 PyFPE_END_PROTECT(dx)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000573 return PyFloat_FromDouble(dx);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000574 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000575
Michael W. Hudsondf888462005-06-03 14:41:55 +0000576 case TYPE_BINARY_FLOAT:
577 {
Brett Cannonc9371d42005-06-25 08:23:41 +0000578 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000579 double x;
Brett Cannonc9371d42005-06-25 08:23:41 +0000580 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000581 PyErr_SetString(PyExc_EOFError,
582 "EOF read where object expected");
583 return NULL;
584 }
585 x = _PyFloat_Unpack8(buf, 1);
586 if (x == -1.0 && PyErr_Occurred()) {
587 return NULL;
588 }
589 return PyFloat_FromDouble(x);
590 }
591
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000592#ifndef WITHOUT_COMPLEX
593 case TYPE_COMPLEX:
594 {
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000595 char buf[256];
Guido van Rossum530956d1996-07-21 02:27:43 +0000596 Py_complex c;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000597 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000598 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000599 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000600 "EOF read where object expected");
601 return NULL;
602 }
603 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000604 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000605 c.real = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000606 PyFPE_END_PROTECT(c)
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000607 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000608 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000609 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000610 "EOF read where object expected");
611 return NULL;
612 }
613 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000614 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000615 c.imag = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000616 PyFPE_END_PROTECT(c)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000617 return PyComplex_FromCComplex(c);
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000618 }
Michael W. Hudsondf888462005-06-03 14:41:55 +0000619
620 case TYPE_BINARY_COMPLEX:
621 {
Brett Cannonc9371d42005-06-25 08:23:41 +0000622 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000623 Py_complex c;
Brett Cannonc9371d42005-06-25 08:23:41 +0000624 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000625 PyErr_SetString(PyExc_EOFError,
626 "EOF read where object expected");
627 return NULL;
628 }
629 c.real = _PyFloat_Unpack8(buf, 1);
630 if (c.real == -1.0 && PyErr_Occurred()) {
631 return NULL;
632 }
Brett Cannonc9371d42005-06-25 08:23:41 +0000633 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000634 PyErr_SetString(PyExc_EOFError,
635 "EOF read where object expected");
636 return NULL;
637 }
638 c.imag = _PyFloat_Unpack8(buf, 1);
639 if (c.imag == -1.0 && PyErr_Occurred()) {
640 return NULL;
641 }
642 return PyComplex_FromCComplex(c);
643 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000644#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000645
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000646 case TYPE_INTERNED:
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000647 case TYPE_STRING:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000648 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000649 if (n < 0) {
650 PyErr_SetString(PyExc_ValueError, "bad marshal data");
651 return NULL;
652 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000653 v = PyString_FromStringAndSize((char *)NULL, n);
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000654 if (v == NULL)
655 return v;
656 if (r_string(PyString_AS_STRING(v), (int)n, p) != n) {
657 Py_DECREF(v);
658 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000659 "EOF read where object expected");
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000660 return NULL;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000661 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000662 if (type == TYPE_INTERNED) {
663 PyString_InternInPlace(&v);
664 PyList_Append(p->strings, v);
665 }
666 return v;
667
668 case TYPE_STRINGREF:
669 n = r_long(p);
Michael W. Hudsonf2ca5af2005-06-13 18:28:46 +0000670 if (n < 0 || n >= PyList_GET_SIZE(p->strings)) {
671 PyErr_SetString(PyExc_ValueError, "bad marshal data");
672 return NULL;
673 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000674 v = PyList_GET_ITEM(p->strings, n);
675 Py_INCREF(v);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000676 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000677
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000678#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000679 case TYPE_UNICODE:
680 {
681 char *buffer;
682
683 n = r_long(p);
684 if (n < 0) {
685 PyErr_SetString(PyExc_ValueError, "bad marshal data");
686 return NULL;
687 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000688 buffer = PyMem_NEW(char, n);
Guido van Rossumc279b532000-03-10 23:03:02 +0000689 if (buffer == NULL)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000690 return PyErr_NoMemory();
Guido van Rossumc279b532000-03-10 23:03:02 +0000691 if (r_string(buffer, (int)n, p) != n) {
Guido van Rossumb18618d2000-05-03 23:44:39 +0000692 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000693 PyErr_SetString(PyExc_EOFError,
694 "EOF read where object expected");
695 return NULL;
696 }
697 v = PyUnicode_DecodeUTF8(buffer, n, NULL);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000698 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000699 return v;
700 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000701#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000702
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000703 case TYPE_TUPLE:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000704 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000705 if (n < 0) {
706 PyErr_SetString(PyExc_ValueError, "bad marshal data");
707 return NULL;
708 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000709 v = PyTuple_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000710 if (v == NULL)
711 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000712 for (i = 0; i < n; i++) {
713 v2 = r_object(p);
714 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000715 if (!PyErr_Occurred())
716 PyErr_SetString(PyExc_TypeError,
717 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000718 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000719 v = NULL;
720 break;
721 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000722 PyTuple_SET_ITEM(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000723 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000724 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000725
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000726 case TYPE_LIST:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000727 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000728 if (n < 0) {
729 PyErr_SetString(PyExc_ValueError, "bad marshal data");
730 return NULL;
731 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000732 v = PyList_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000733 if (v == NULL)
734 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000735 for (i = 0; i < n; i++) {
736 v2 = r_object(p);
737 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000738 if (!PyErr_Occurred())
739 PyErr_SetString(PyExc_TypeError,
740 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000741 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000742 v = NULL;
743 break;
744 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000745 PyList_SetItem(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000746 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000747 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000748
Guido van Rossum64b45521991-06-07 13:58:22 +0000749 case TYPE_DICT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000750 v = PyDict_New();
Guido van Rossum64b45521991-06-07 13:58:22 +0000751 if (v == NULL)
752 return NULL;
753 for (;;) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000754 PyObject *key, *val;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000755 key = r_object(p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000756 if (key == NULL)
Armin Rigo01ab2792004-03-26 15:09:27 +0000757 break;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000758 val = r_object(p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000759 if (val != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000760 PyDict_SetItem(v, key, val);
761 Py_DECREF(key);
762 Py_XDECREF(val);
Guido van Rossum64b45521991-06-07 13:58:22 +0000763 }
Armin Rigo01ab2792004-03-26 15:09:27 +0000764 if (PyErr_Occurred()) {
765 Py_DECREF(v);
766 v = NULL;
767 }
Guido van Rossum64b45521991-06-07 13:58:22 +0000768 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000769
Raymond Hettingera422c342005-01-11 03:03:27 +0000770 case TYPE_SET:
771 case TYPE_FROZENSET:
772 n = r_long(p);
773 if (n < 0) {
774 PyErr_SetString(PyExc_ValueError, "bad marshal data");
775 return NULL;
776 }
777 v = PyTuple_New((int)n);
778 if (v == NULL)
779 return v;
780 for (i = 0; i < n; i++) {
781 v2 = r_object(p);
782 if ( v2 == NULL ) {
783 if (!PyErr_Occurred())
784 PyErr_SetString(PyExc_TypeError,
785 "NULL object in marshal data");
786 Py_DECREF(v);
787 v = NULL;
788 break;
789 }
790 PyTuple_SET_ITEM(v, (int)i, v2);
791 }
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000792 if (v == NULL)
793 return v;
Raymond Hettingera422c342005-01-11 03:03:27 +0000794 if (type == TYPE_SET)
Raymond Hettingerbeb31012005-08-16 03:47:52 +0000795 v3 = PySet_New(v);
Raymond Hettingera422c342005-01-11 03:03:27 +0000796 else
Raymond Hettingerbeb31012005-08-16 03:47:52 +0000797 v3 = PyFrozenSet_New(v);
Raymond Hettingera422c342005-01-11 03:03:27 +0000798 Py_DECREF(v);
799 return v3;
800
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000801 case TYPE_CODE:
Michael W. Hudson80199132001-08-30 14:50:20 +0000802 if (PyEval_GetRestricted()) {
803 PyErr_SetString(PyExc_RuntimeError,
804 "cannot unmarshal code objects in "
805 "restricted execution mode");
806 return NULL;
807 }
808 else {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000809 int argcount;
810 int nlocals;
811 int stacksize;
812 int flags;
813 PyObject *code = NULL;
814 PyObject *consts = NULL;
815 PyObject *names = NULL;
816 PyObject *varnames = NULL;
817 PyObject *freevars = NULL;
818 PyObject *cellvars = NULL;
819 PyObject *filename = NULL;
820 PyObject *name = NULL;
821 int firstlineno;
822 PyObject *lnotab = NULL;
823
824 v = NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000825
Michael W. Hudsondf888462005-06-03 14:41:55 +0000826 argcount = r_long(p);
827 nlocals = r_long(p);
828 stacksize = r_long(p);
829 flags = r_long(p);
830 code = r_object(p);
831 if (code == NULL)
832 goto code_error;
833 consts = r_object(p);
834 if (consts == NULL)
835 goto code_error;
836 names = r_object(p);
837 if (names == NULL)
838 goto code_error;
839 varnames = r_object(p);
840 if (varnames == NULL)
841 goto code_error;
842 freevars = r_object(p);
843 if (freevars == NULL)
844 goto code_error;
845 cellvars = r_object(p);
846 if (cellvars == NULL)
847 goto code_error;
848 filename = r_object(p);
849 if (filename == NULL)
850 goto code_error;
851 name = r_object(p);
852 if (name == NULL)
853 goto code_error;
854 firstlineno = r_long(p);
855 lnotab = r_object(p);
856 if (lnotab == NULL)
857 goto code_error;
858
859 v = (PyObject *) PyCode_New(
Tim Petersd9b9ac82001-01-28 00:27:39 +0000860 argcount, nlocals, stacksize, flags,
Guido van Rossum681d79a1995-07-18 14:51:37 +0000861 code, consts, names, varnames,
Tim Petersd9b9ac82001-01-28 00:27:39 +0000862 freevars, cellvars, filename, name,
863 firstlineno, lnotab);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000864
865 code_error:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000866 Py_XDECREF(code);
867 Py_XDECREF(consts);
868 Py_XDECREF(names);
869 Py_XDECREF(varnames);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000870 Py_XDECREF(freevars);
871 Py_XDECREF(cellvars);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000872 Py_XDECREF(filename);
873 Py_XDECREF(name);
Guido van Rossum6fc06e71997-07-26 23:30:18 +0000874 Py_XDECREF(lnotab);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000875
876 }
877 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000878
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000879 default:
Guido van Rossumf2150601996-06-26 20:41:23 +0000880 /* Bogus data got written, which isn't ideal.
881 This will let you keep working and recover. */
Guido van Rossuma45cb451998-06-08 20:27:29 +0000882 PyErr_SetString(PyExc_ValueError, "bad marshal data");
883 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000884
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000885 }
886}
887
Neal Norwitzd85c4522004-06-13 20:31:49 +0000888static PyObject *
Armin Rigo01ab2792004-03-26 15:09:27 +0000889read_object(RFILE *p)
890{
891 PyObject *v;
892 if (PyErr_Occurred()) {
893 fprintf(stderr, "XXX readobject called with exception set\n");
894 return NULL;
895 }
896 v = r_object(p);
897 if (v == NULL && !PyErr_Occurred())
898 PyErr_SetString(PyExc_TypeError, "NULL object in marshal data");
899 return v;
900}
901
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000902int
903PyMarshal_ReadShortFromFile(FILE *fp)
904{
905 RFILE rf;
Thomas Wouters7f401ef2006-03-01 22:30:47 +0000906 assert(fp);
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000907 rf.fp = fp;
Thomas Wouters7464b432006-03-01 22:34:09 +0000908 rf.strings = NULL;
909 rf.end = rf.ptr = NULL;
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000910 return r_short(&rf);
911}
912
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000913long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000914PyMarshal_ReadLongFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000915{
916 RFILE rf;
917 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000918 rf.strings = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000919 return r_long(&rf);
920}
921
Tim Peters691e0e92001-01-18 04:39:16 +0000922#ifdef HAVE_FSTAT
923/* Return size of file in bytes; < 0 if unknown. */
924static off_t
925getfilesize(FILE *fp)
926{
927 struct stat st;
928 if (fstat(fileno(fp), &st) != 0)
929 return -1;
930 else
931 return st.st_size;
932}
933#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000934
Tim Peters691e0e92001-01-18 04:39:16 +0000935/* If we can get the size of the file up-front, and it's reasonably small,
936 * read it in one gulp and delegate to ...FromString() instead. Much quicker
937 * than reading a byte at a time from file; speeds .pyc imports.
Tim Petersd9b9ac82001-01-28 00:27:39 +0000938 * CAUTION: since this may read the entire remainder of the file, don't
939 * call it unless you know you're done with the file.
Tim Peters691e0e92001-01-18 04:39:16 +0000940 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000941PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000942PyMarshal_ReadLastObjectFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000943{
Tim Peters691e0e92001-01-18 04:39:16 +0000944/* 75% of 2.1's .pyc files can exploit SMALL_FILE_LIMIT.
945 * REASONABLE_FILE_LIMIT is by defn something big enough for Tkinter.pyc.
946 */
947#define SMALL_FILE_LIMIT (1L << 14)
948#define REASONABLE_FILE_LIMIT (1L << 18)
Tim Peters691e0e92001-01-18 04:39:16 +0000949#ifdef HAVE_FSTAT
950 off_t filesize;
951#endif
Tim Peters691e0e92001-01-18 04:39:16 +0000952#ifdef HAVE_FSTAT
953 filesize = getfilesize(fp);
954 if (filesize > 0) {
955 char buf[SMALL_FILE_LIMIT];
956 char* pBuf = NULL;
957 if (filesize <= SMALL_FILE_LIMIT)
958 pBuf = buf;
959 else if (filesize <= REASONABLE_FILE_LIMIT)
960 pBuf = (char *)PyMem_MALLOC(filesize);
961 if (pBuf != NULL) {
962 PyObject* v;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000963 size_t n;
964 /* filesize must fit into an int, because it
965 is smaller than REASONABLE_FILE_LIMIT */
966 n = fread(pBuf, 1, (int)filesize, fp);
Tim Peters691e0e92001-01-18 04:39:16 +0000967 v = PyMarshal_ReadObjectFromString(pBuf, n);
968 if (pBuf != buf)
969 PyMem_FREE(pBuf);
970 return v;
971 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000972
Tim Peters691e0e92001-01-18 04:39:16 +0000973 }
974#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000975 /* We don't have fstat, or we do but the file is larger than
976 * REASONABLE_FILE_LIMIT or malloc failed -- read a byte at a time.
977 */
978 return PyMarshal_ReadObjectFromFile(fp);
979
Tim Peters691e0e92001-01-18 04:39:16 +0000980#undef SMALL_FILE_LIMIT
981#undef REASONABLE_FILE_LIMIT
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000982}
983
Guido van Rossum79f25d91997-04-29 20:08:16 +0000984PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000985PyMarshal_ReadObjectFromFile(FILE *fp)
986{
987 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000988 PyObject *result;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000989 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000990 rf.strings = PyList_New(0);
991 result = r_object(&rf);
992 Py_DECREF(rf.strings);
993 return result;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000994}
995
996PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000997PyMarshal_ReadObjectFromString(char *str, Py_ssize_t len)
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000998{
999 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001000 PyObject *result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001001 rf.fp = NULL;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001002 rf.ptr = str;
1003 rf.end = str + len;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001004 rf.strings = PyList_New(0);
1005 result = r_object(&rf);
1006 Py_DECREF(rf.strings);
1007 return result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001008}
1009
Guido van Rossum79f25d91997-04-29 20:08:16 +00001010PyObject *
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001011PyMarshal_WriteObjectToString(PyObject *x, int version)
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001012{
1013 WFILE wf;
1014 wf.fp = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001015 wf.str = PyString_FromStringAndSize((char *)NULL, 50);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001016 if (wf.str == NULL)
1017 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001018 wf.ptr = PyString_AS_STRING((PyStringObject *)wf.str);
1019 wf.end = wf.ptr + PyString_Size(wf.str);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001020 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +00001021 wf.depth = 0;
Michael W. Hudsondf888462005-06-03 14:41:55 +00001022 wf.version = version;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001023 wf.strings = (version > 0) ? PyDict_New() : NULL;
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001024 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001025 Py_XDECREF(wf.strings);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001026 if (wf.str != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00001027 _PyString_Resize(&wf.str,
1028 (int) (wf.ptr -
1029 PyString_AS_STRING((PyStringObject *)wf.str)));
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001030 if (wf.error) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001031 Py_XDECREF(wf.str);
Tim Petersd9b9ac82001-01-28 00:27:39 +00001032 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +00001033 (wf.error==1)?"unmarshallable object"
1034 :"object too deeply nested to marshal");
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001035 return NULL;
1036 }
1037 return wf.str;
1038}
1039
Guido van Rossum64b45521991-06-07 13:58:22 +00001040/* And an interface for Python programs... */
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001041
Guido van Rossum79f25d91997-04-29 20:08:16 +00001042static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001043marshal_dump(PyObject *self, PyObject *args)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001044{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001045 WFILE wf;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001046 PyObject *x;
1047 PyObject *f;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001048 int version = Py_MARSHAL_VERSION;
1049 if (!PyArg_ParseTuple(args, "OO|i:dump", &x, &f, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001050 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001051 if (!PyFile_Check(f)) {
1052 PyErr_SetString(PyExc_TypeError,
1053 "marshal.dump() 2nd arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001054 return NULL;
1055 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001056 wf.fp = PyFile_AsFile(f);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001057 wf.str = NULL;
1058 wf.ptr = wf.end = NULL;
Guido van Rossumf2150601996-06-26 20:41:23 +00001059 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +00001060 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001061 wf.strings = (version > 0) ? PyDict_New() : 0;
Neal Norwitzef785292005-11-16 05:04:51 +00001062 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001063 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001064 Py_XDECREF(wf.strings);
Guido van Rossumf2150601996-06-26 20:41:23 +00001065 if (wf.error) {
Tim Petersd9b9ac82001-01-28 00:27:39 +00001066 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +00001067 (wf.error==1)?"unmarshallable object"
1068 :"object too deeply nested to marshal");
Guido van Rossumf2150601996-06-26 20:41:23 +00001069 return NULL;
1070 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001071 Py_INCREF(Py_None);
1072 return Py_None;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001073}
1074
Guido van Rossum79f25d91997-04-29 20:08:16 +00001075static PyObject *
Georg Brandlbf92f462006-05-29 21:58:42 +00001076marshal_load(PyObject *self, PyObject *f)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001077{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001078 RFILE rf;
Georg Brandlbf92f462006-05-29 21:58:42 +00001079 PyObject *result;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001080 if (!PyFile_Check(f)) {
1081 PyErr_SetString(PyExc_TypeError,
1082 "marshal.load() arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001083 return NULL;
1084 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001085 rf.fp = PyFile_AsFile(f);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001086 rf.strings = PyList_New(0);
1087 result = read_object(&rf);
1088 Py_DECREF(rf.strings);
1089 return result;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001090}
1091
Guido van Rossum79f25d91997-04-29 20:08:16 +00001092static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001093marshal_dumps(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001094{
Guido van Rossum79f25d91997-04-29 20:08:16 +00001095 PyObject *x;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001096 int version = Py_MARSHAL_VERSION;
Armin Rigo2ccea172004-12-20 12:25:57 +00001097 if (!PyArg_ParseTuple(args, "O|i:dumps", &x, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001098 return NULL;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001099 return PyMarshal_WriteObjectToString(x, version);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001100}
1101
Guido van Rossum79f25d91997-04-29 20:08:16 +00001102static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001103marshal_loads(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001104{
1105 RFILE rf;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001106 char *s;
Thomas Wouters695934a2006-03-01 23:49:13 +00001107 Py_ssize_t n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001108 PyObject* result;
Michael W. Hudson01fca112005-06-13 17:50:18 +00001109 if (!PyArg_ParseTuple(args, "s#:loads", &s, &n))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001110 return NULL;
1111 rf.fp = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001112 rf.ptr = s;
1113 rf.end = s + n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001114 rf.strings = PyList_New(0);
1115 result = read_object(&rf);
1116 Py_DECREF(rf.strings);
1117 return result;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001118}
1119
Guido van Rossum79f25d91997-04-29 20:08:16 +00001120static PyMethodDef marshal_methods[] = {
Neal Norwitz031829d2002-03-31 14:37:44 +00001121 {"dump", marshal_dump, METH_VARARGS},
Georg Brandlbf92f462006-05-29 21:58:42 +00001122 {"load", marshal_load, METH_O},
Neal Norwitz031829d2002-03-31 14:37:44 +00001123 {"dumps", marshal_dumps, METH_VARARGS},
1124 {"loads", marshal_loads, METH_VARARGS},
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001125 {NULL, NULL} /* sentinel */
1126};
1127
Jason Tishler6bc06ec2003-09-04 11:59:50 +00001128PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001129PyMarshal_Init(void)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001130{
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001131 PyObject *mod = Py_InitModule("marshal", marshal_methods);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00001132 if (mod == NULL)
1133 return;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001134 PyModule_AddIntConstant(mod, "version", Py_MARSHAL_VERSION);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001135}