blob: c3bc87f21f04c86d676b14ad55e1c69af003eb2b [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));
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000216 if (!temp) {
217 p->error = 1;
218 return;
219 }
Michael W. Hudsondf888462005-06-03 14:41:55 +0000220 PyFloat_AsReprString(buf, temp);
221 Py_DECREF(temp);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000222 n = strlen(buf);
223 w_byte((int)n, p);
224 w_string(buf, (int)n, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000225 temp = (PyFloatObject*)PyFloat_FromDouble(
226 PyComplex_ImagAsDouble(v));
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000227 if (!temp) {
228 p->error = 1;
229 return;
230 }
Michael W. Hudsondf888462005-06-03 14:41:55 +0000231 PyFloat_AsReprString(buf, temp);
232 Py_DECREF(temp);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000233 n = strlen(buf);
234 w_byte((int)n, p);
235 w_string(buf, (int)n, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000236 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000237 }
238#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +0000239 else if (PyString_Check(v)) {
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000240 if (p->strings && PyString_CHECK_INTERNED(v)) {
241 PyObject *o = PyDict_GetItem(p->strings, v);
242 if (o) {
243 long w = PyInt_AsLong(o);
244 w_byte(TYPE_STRINGREF, p);
245 w_long(w, p);
246 goto exit;
247 }
248 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000249 o = PyInt_FromSsize_t(PyDict_Size(p->strings));
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000250 PyDict_SetItem(p->strings, v, o);
251 Py_DECREF(o);
252 w_byte(TYPE_INTERNED, p);
253 }
254 }
255 else {
256 w_byte(TYPE_STRING, p);
257 }
Guido van Rossumc279b532000-03-10 23:03:02 +0000258 n = PyString_GET_SIZE(v);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000259 if (n > INT_MAX) {
260 /* huge strings are not supported */
261 p->depth--;
262 p->error = 1;
263 return;
264 }
Guido van Rossum3a205f71995-02-17 15:10:07 +0000265 w_long((long)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000266 w_string(PyString_AS_STRING(v), (int)n, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000267 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000268#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000269 else if (PyUnicode_Check(v)) {
270 PyObject *utf8;
271 utf8 = PyUnicode_AsUTF8String(v);
272 if (utf8 == NULL) {
Guido van Rossum98626cd2000-06-28 23:24:19 +0000273 p->depth--;
274 p->error = 1;
275 return;
Guido van Rossumc279b532000-03-10 23:03:02 +0000276 }
277 w_byte(TYPE_UNICODE, p);
278 n = PyString_GET_SIZE(utf8);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000279 if (n > INT_MAX) {
280 p->depth--;
281 p->error = 1;
282 return;
283 }
Guido van Rossumc279b532000-03-10 23:03:02 +0000284 w_long((long)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000285 w_string(PyString_AS_STRING(utf8), (int)n, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000286 Py_DECREF(utf8);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000287 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000288#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +0000289 else if (PyTuple_Check(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000290 w_byte(TYPE_TUPLE, p);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000291 n = PyTuple_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 Rossum79f25d91997-04-29 20:08:16 +0000294 w_object(PyTuple_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 (PyList_Check(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000298 w_byte(TYPE_LIST, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000299 n = PyList_GET_SIZE(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000300 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000301 for (i = 0; i < n; i++) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000302 w_object(PyList_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000303 }
304 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000305 else if (PyDict_Check(v)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000306 Py_ssize_t pos;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000307 PyObject *key, *value;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000308 w_byte(TYPE_DICT, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000309 /* This one is NULL object terminated! */
Guido van Rossum25831651993-05-19 14:50:45 +0000310 pos = 0;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000311 while (PyDict_Next(v, &pos, &key, &value)) {
Guido van Rossum25831651993-05-19 14:50:45 +0000312 w_object(key, p);
313 w_object(value, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000314 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000315 w_object((PyObject *)NULL, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000316 }
Raymond Hettingera422c342005-01-11 03:03:27 +0000317 else if (PyAnySet_Check(v)) {
Raymond Hettingera422c342005-01-11 03:03:27 +0000318 PyObject *value, *it;
319
320 if (PyObject_TypeCheck(v, &PySet_Type))
321 w_byte(TYPE_SET, p);
322 else
323 w_byte(TYPE_FROZENSET, p);
324 n = PyObject_Size(v);
325 if (n == -1) {
326 p->depth--;
327 p->error = 1;
328 return;
329 }
330 w_long((long)n, p);
331 it = PyObject_GetIter(v);
332 if (it == NULL) {
333 p->depth--;
334 p->error = 1;
335 return;
336 }
337 while ((value = PyIter_Next(it)) != NULL) {
338 w_object(value, p);
339 Py_DECREF(value);
340 }
341 Py_DECREF(it);
342 if (PyErr_Occurred()) {
343 p->depth--;
344 p->error = 1;
345 return;
346 }
347 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000348 else if (PyCode_Check(v)) {
349 PyCodeObject *co = (PyCodeObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000350 w_byte(TYPE_CODE, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000351 w_long(co->co_argcount, p);
352 w_long(co->co_nlocals, p);
353 w_long(co->co_stacksize, p);
354 w_long(co->co_flags, p);
Guido van Rossumd076c731998-10-07 19:42:25 +0000355 w_object(co->co_code, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000356 w_object(co->co_consts, p);
357 w_object(co->co_names, p);
Guido van Rossum681d79a1995-07-18 14:51:37 +0000358 w_object(co->co_varnames, p);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000359 w_object(co->co_freevars, p);
360 w_object(co->co_cellvars, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000361 w_object(co->co_filename, p);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000362 w_object(co->co_name, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000363 w_long(co->co_firstlineno, p);
Guido van Rossumd031c891997-01-24 03:44:17 +0000364 w_object(co->co_lnotab, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000365 }
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000366 else if (PyObject_CheckReadBuffer(v)) {
Guido van Rossumd076c731998-10-07 19:42:25 +0000367 /* Write unknown buffer-style objects as a string */
368 char *s;
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000369 PyBufferProcs *pb = v->ob_type->tp_as_buffer;
Guido van Rossumd076c731998-10-07 19:42:25 +0000370 w_byte(TYPE_STRING, p);
371 n = (*pb->bf_getreadbuffer)(v, 0, (void **)&s);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000372 if (n > INT_MAX) {
373 p->depth--;
374 p->error = 1;
375 return;
376 }
Guido van Rossumd076c731998-10-07 19:42:25 +0000377 w_long((long)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000378 w_string(s, (int)n, p);
Guido van Rossumd076c731998-10-07 19:42:25 +0000379 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000380 else {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000381 w_byte(TYPE_UNKNOWN, p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000382 p->error = 1;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000383 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000384 exit:
Guido van Rossum98626cd2000-06-28 23:24:19 +0000385 p->depth--;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000386}
387
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000388/* version currently has no effect for writing longs. */
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000389void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000390PyMarshal_WriteLongToFile(long x, FILE *fp, int version)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000391{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000392 WFILE wf;
393 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000394 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000395 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000396 wf.strings = NULL;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000397 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000398 w_long(x, &wf);
399}
400
401void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000402PyMarshal_WriteObjectToFile(PyObject *x, FILE *fp, int version)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000403{
404 WFILE wf;
405 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000406 wf.error = 0;
Guido van Rossum98626cd2000-06-28 23:24:19 +0000407 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000408 wf.strings = (version > 0) ? PyDict_New() : NULL;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000409 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000410 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000411 Py_XDECREF(wf.strings);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000412}
413
414typedef WFILE RFILE; /* Same struct with different invariants */
415
Guido van Rossum8d617a61995-03-09 12:12:11 +0000416#define rs_byte(p) (((p)->ptr != (p)->end) ? (unsigned char)*(p)->ptr++ : EOF)
417
418#define r_byte(p) ((p)->fp ? getc((p)->fp) : rs_byte(p))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000419
420static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000421r_string(char *s, int n, RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000422{
423 if (p->fp != NULL)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000424 /* The result fits into int because it must be <=n. */
425 return (int)fread(s, 1, n, p->fp);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000426 if (p->end - p->ptr < n)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000427 n = (int)(p->end - p->ptr);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000428 memcpy(s, p->ptr, n);
429 p->ptr += n;
430 return n;
431}
432
433static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000434r_short(RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000435{
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000436 register short x;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000437 x = r_byte(p);
438 x |= r_byte(p) << 8;
Tim Peterse84b7402000-09-19 08:54:13 +0000439 /* Sign-extension, in case short greater than 16 bits */
440 x |= -(x & 0x8000);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000441 return x;
442}
443
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000444static long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000445r_long(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000446{
447 register long x;
Guido van Rossum8d617a61995-03-09 12:12:11 +0000448 register FILE *fp = p->fp;
449 if (fp) {
450 x = getc(fp);
451 x |= (long)getc(fp) << 8;
452 x |= (long)getc(fp) << 16;
453 x |= (long)getc(fp) << 24;
454 }
455 else {
456 x = rs_byte(p);
457 x |= (long)rs_byte(p) << 8;
458 x |= (long)rs_byte(p) << 16;
459 x |= (long)rs_byte(p) << 24;
460 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000461#if SIZEOF_LONG > 4
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000462 /* Sign extension for 64-bit machines */
Tim Peterse84b7402000-09-19 08:54:13 +0000463 x |= -(x & 0x80000000L);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000464#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000465 return x;
466}
467
Tim Peters82112372001-08-29 02:28:42 +0000468/* r_long64 deals with the TYPE_INT64 code. On a machine with
469 sizeof(long) > 4, it returns a Python int object, else a Python long
470 object. Note that w_long64 writes out TYPE_INT if 32 bits is enough,
471 so there's no inefficiency here in returning a PyLong on 32-bit boxes
472 for everything written via TYPE_INT64 (i.e., if an int is written via
473 TYPE_INT64, it *needs* more than 32 bits).
474*/
475static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000476r_long64(RFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000477{
Tim Peters82112372001-08-29 02:28:42 +0000478 long lo4 = r_long(p);
479 long hi4 = r_long(p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000480#if SIZEOF_LONG > 4
Tim Peters82112372001-08-29 02:28:42 +0000481 long x = (hi4 << 32) | (lo4 & 0xFFFFFFFFL);
482 return PyInt_FromLong(x);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000483#else
Tim Peters82112372001-08-29 02:28:42 +0000484 unsigned char buf[8];
485 int one = 1;
486 int is_little_endian = (int)*(char*)&one;
487 if (is_little_endian) {
488 memcpy(buf, &lo4, 4);
489 memcpy(buf+4, &hi4, 4);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000490 }
Tim Peters82112372001-08-29 02:28:42 +0000491 else {
492 memcpy(buf, &hi4, 4);
493 memcpy(buf+4, &lo4, 4);
494 }
495 return _PyLong_FromByteArray(buf, 8, is_little_endian, 1);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000496#endif
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000497}
498
Guido van Rossum79f25d91997-04-29 20:08:16 +0000499static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000500r_object(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000501{
Armin Rigo01ab2792004-03-26 15:09:27 +0000502 /* NULL is a valid return value, it does not necessarily means that
503 an exception is set. */
Raymond Hettingera422c342005-01-11 03:03:27 +0000504 PyObject *v, *v2, *v3;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000505 long i, n;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000506 int type = r_byte(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000507
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000508 switch (type) {
Tim Petersd9b9ac82001-01-28 00:27:39 +0000509
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000510 case EOF:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000511 PyErr_SetString(PyExc_EOFError,
512 "EOF read where object expected");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000513 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000514
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000515 case TYPE_NULL:
516 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000517
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000518 case TYPE_NONE:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000519 Py_INCREF(Py_None);
520 return Py_None;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000521
Tim Peters5ca576e2001-06-18 22:08:13 +0000522 case TYPE_STOPITER:
523 Py_INCREF(PyExc_StopIteration);
524 return PyExc_StopIteration;
525
Guido van Rossume449af71996-10-11 16:25:41 +0000526 case TYPE_ELLIPSIS:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000527 Py_INCREF(Py_Ellipsis);
Guido van Rossume449af71996-10-11 16:25:41 +0000528 return Py_Ellipsis;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000529
Guido van Rossum77f6a652002-04-03 22:41:51 +0000530 case TYPE_FALSE:
531 Py_INCREF(Py_False);
532 return Py_False;
533
534 case TYPE_TRUE:
535 Py_INCREF(Py_True);
536 return Py_True;
537
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000538 case TYPE_INT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000539 return PyInt_FromLong(r_long(p));
Tim Petersd9b9ac82001-01-28 00:27:39 +0000540
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000541 case TYPE_INT64:
Tim Peters82112372001-08-29 02:28:42 +0000542 return r_long64(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000543
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000544 case TYPE_LONG:
545 {
546 int size;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000547 PyLongObject *ob;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000548 n = r_long(p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000549 size = n<0 ? -n : n;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000550 ob = _PyLong_New(size);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000551 if (ob == NULL)
552 return NULL;
553 ob->ob_size = n;
Armin Rigo01ab2792004-03-26 15:09:27 +0000554 for (i = 0; i < size; i++) {
555 int digit = r_short(p);
556 if (digit < 0) {
557 Py_DECREF(ob);
558 PyErr_SetString(PyExc_ValueError,
559 "bad marshal data");
560 return NULL;
561 }
562 ob->ob_digit[i] = digit;
563 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000564 return (PyObject *)ob;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000565 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000566
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000567 case TYPE_FLOAT:
568 {
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000569 char buf[256];
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000570 double dx;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000571 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000572 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000573 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000574 "EOF read where object expected");
575 return NULL;
576 }
577 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000578 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000579 dx = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000580 PyFPE_END_PROTECT(dx)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000581 return PyFloat_FromDouble(dx);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000582 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000583
Michael W. Hudsondf888462005-06-03 14:41:55 +0000584 case TYPE_BINARY_FLOAT:
585 {
Brett Cannonc9371d42005-06-25 08:23:41 +0000586 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000587 double x;
Brett Cannonc9371d42005-06-25 08:23:41 +0000588 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000589 PyErr_SetString(PyExc_EOFError,
590 "EOF read where object expected");
591 return NULL;
592 }
593 x = _PyFloat_Unpack8(buf, 1);
594 if (x == -1.0 && PyErr_Occurred()) {
595 return NULL;
596 }
597 return PyFloat_FromDouble(x);
598 }
599
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000600#ifndef WITHOUT_COMPLEX
601 case TYPE_COMPLEX:
602 {
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000603 char buf[256];
Guido van Rossum530956d1996-07-21 02:27:43 +0000604 Py_complex c;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000605 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000606 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000607 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000608 "EOF read where object expected");
609 return NULL;
610 }
611 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000612 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000613 c.real = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000614 PyFPE_END_PROTECT(c)
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000615 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000616 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000617 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000618 "EOF read where object expected");
619 return NULL;
620 }
621 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000622 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000623 c.imag = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000624 PyFPE_END_PROTECT(c)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000625 return PyComplex_FromCComplex(c);
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000626 }
Michael W. Hudsondf888462005-06-03 14:41:55 +0000627
628 case TYPE_BINARY_COMPLEX:
629 {
Brett Cannonc9371d42005-06-25 08:23:41 +0000630 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000631 Py_complex c;
Brett Cannonc9371d42005-06-25 08:23:41 +0000632 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000633 PyErr_SetString(PyExc_EOFError,
634 "EOF read where object expected");
635 return NULL;
636 }
637 c.real = _PyFloat_Unpack8(buf, 1);
638 if (c.real == -1.0 && PyErr_Occurred()) {
639 return NULL;
640 }
Brett Cannonc9371d42005-06-25 08:23:41 +0000641 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000642 PyErr_SetString(PyExc_EOFError,
643 "EOF read where object expected");
644 return NULL;
645 }
646 c.imag = _PyFloat_Unpack8(buf, 1);
647 if (c.imag == -1.0 && PyErr_Occurred()) {
648 return NULL;
649 }
650 return PyComplex_FromCComplex(c);
651 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000652#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000653
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000654 case TYPE_INTERNED:
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000655 case TYPE_STRING:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000656 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000657 if (n < 0) {
658 PyErr_SetString(PyExc_ValueError, "bad marshal data");
659 return NULL;
660 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000661 v = PyString_FromStringAndSize((char *)NULL, n);
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000662 if (v == NULL)
663 return v;
664 if (r_string(PyString_AS_STRING(v), (int)n, p) != n) {
665 Py_DECREF(v);
666 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000667 "EOF read where object expected");
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000668 return NULL;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000669 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000670 if (type == TYPE_INTERNED) {
671 PyString_InternInPlace(&v);
672 PyList_Append(p->strings, v);
673 }
674 return v;
675
676 case TYPE_STRINGREF:
677 n = r_long(p);
Michael W. Hudsonf2ca5af2005-06-13 18:28:46 +0000678 if (n < 0 || n >= PyList_GET_SIZE(p->strings)) {
679 PyErr_SetString(PyExc_ValueError, "bad marshal data");
680 return NULL;
681 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000682 v = PyList_GET_ITEM(p->strings, n);
683 Py_INCREF(v);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000684 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000685
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000686#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000687 case TYPE_UNICODE:
688 {
689 char *buffer;
690
691 n = r_long(p);
692 if (n < 0) {
693 PyErr_SetString(PyExc_ValueError, "bad marshal data");
694 return NULL;
695 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000696 buffer = PyMem_NEW(char, n);
Guido van Rossumc279b532000-03-10 23:03:02 +0000697 if (buffer == NULL)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000698 return PyErr_NoMemory();
Guido van Rossumc279b532000-03-10 23:03:02 +0000699 if (r_string(buffer, (int)n, p) != n) {
Guido van Rossumb18618d2000-05-03 23:44:39 +0000700 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000701 PyErr_SetString(PyExc_EOFError,
702 "EOF read where object expected");
703 return NULL;
704 }
705 v = PyUnicode_DecodeUTF8(buffer, n, NULL);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000706 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000707 return v;
708 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000709#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000710
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000711 case TYPE_TUPLE:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000712 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000713 if (n < 0) {
714 PyErr_SetString(PyExc_ValueError, "bad marshal data");
715 return NULL;
716 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000717 v = PyTuple_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000718 if (v == NULL)
719 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000720 for (i = 0; i < n; i++) {
721 v2 = r_object(p);
722 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000723 if (!PyErr_Occurred())
724 PyErr_SetString(PyExc_TypeError,
725 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000726 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000727 v = NULL;
728 break;
729 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000730 PyTuple_SET_ITEM(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000731 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000732 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000733
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000734 case TYPE_LIST:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000735 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000736 if (n < 0) {
737 PyErr_SetString(PyExc_ValueError, "bad marshal data");
738 return NULL;
739 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000740 v = PyList_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000741 if (v == NULL)
742 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000743 for (i = 0; i < n; i++) {
744 v2 = r_object(p);
745 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000746 if (!PyErr_Occurred())
747 PyErr_SetString(PyExc_TypeError,
748 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000749 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000750 v = NULL;
751 break;
752 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000753 PyList_SetItem(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000754 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000755 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000756
Guido van Rossum64b45521991-06-07 13:58:22 +0000757 case TYPE_DICT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000758 v = PyDict_New();
Guido van Rossum64b45521991-06-07 13:58:22 +0000759 if (v == NULL)
760 return NULL;
761 for (;;) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000762 PyObject *key, *val;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000763 key = r_object(p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000764 if (key == NULL)
Armin Rigo01ab2792004-03-26 15:09:27 +0000765 break;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000766 val = r_object(p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000767 if (val != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000768 PyDict_SetItem(v, key, val);
769 Py_DECREF(key);
770 Py_XDECREF(val);
Guido van Rossum64b45521991-06-07 13:58:22 +0000771 }
Armin Rigo01ab2792004-03-26 15:09:27 +0000772 if (PyErr_Occurred()) {
773 Py_DECREF(v);
774 v = NULL;
775 }
Guido van Rossum64b45521991-06-07 13:58:22 +0000776 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000777
Raymond Hettingera422c342005-01-11 03:03:27 +0000778 case TYPE_SET:
779 case TYPE_FROZENSET:
780 n = r_long(p);
781 if (n < 0) {
782 PyErr_SetString(PyExc_ValueError, "bad marshal data");
783 return NULL;
784 }
785 v = PyTuple_New((int)n);
786 if (v == NULL)
787 return v;
788 for (i = 0; i < n; i++) {
789 v2 = r_object(p);
790 if ( v2 == NULL ) {
791 if (!PyErr_Occurred())
792 PyErr_SetString(PyExc_TypeError,
793 "NULL object in marshal data");
794 Py_DECREF(v);
795 v = NULL;
796 break;
797 }
798 PyTuple_SET_ITEM(v, (int)i, v2);
799 }
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000800 if (v == NULL)
801 return v;
Raymond Hettingera422c342005-01-11 03:03:27 +0000802 if (type == TYPE_SET)
Raymond Hettingerbeb31012005-08-16 03:47:52 +0000803 v3 = PySet_New(v);
Raymond Hettingera422c342005-01-11 03:03:27 +0000804 else
Raymond Hettingerbeb31012005-08-16 03:47:52 +0000805 v3 = PyFrozenSet_New(v);
Raymond Hettingera422c342005-01-11 03:03:27 +0000806 Py_DECREF(v);
807 return v3;
808
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000809 case TYPE_CODE:
Michael W. Hudson80199132001-08-30 14:50:20 +0000810 if (PyEval_GetRestricted()) {
811 PyErr_SetString(PyExc_RuntimeError,
812 "cannot unmarshal code objects in "
813 "restricted execution mode");
814 return NULL;
815 }
816 else {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000817 int argcount;
818 int nlocals;
819 int stacksize;
820 int flags;
821 PyObject *code = NULL;
822 PyObject *consts = NULL;
823 PyObject *names = NULL;
824 PyObject *varnames = NULL;
825 PyObject *freevars = NULL;
826 PyObject *cellvars = NULL;
827 PyObject *filename = NULL;
828 PyObject *name = NULL;
829 int firstlineno;
830 PyObject *lnotab = NULL;
831
832 v = NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000833
Michael W. Hudsondf888462005-06-03 14:41:55 +0000834 argcount = r_long(p);
835 nlocals = r_long(p);
836 stacksize = r_long(p);
837 flags = r_long(p);
838 code = r_object(p);
839 if (code == NULL)
840 goto code_error;
841 consts = r_object(p);
842 if (consts == NULL)
843 goto code_error;
844 names = r_object(p);
845 if (names == NULL)
846 goto code_error;
847 varnames = r_object(p);
848 if (varnames == NULL)
849 goto code_error;
850 freevars = r_object(p);
851 if (freevars == NULL)
852 goto code_error;
853 cellvars = r_object(p);
854 if (cellvars == NULL)
855 goto code_error;
856 filename = r_object(p);
857 if (filename == NULL)
858 goto code_error;
859 name = r_object(p);
860 if (name == NULL)
861 goto code_error;
862 firstlineno = r_long(p);
863 lnotab = r_object(p);
864 if (lnotab == NULL)
865 goto code_error;
866
867 v = (PyObject *) PyCode_New(
Tim Petersd9b9ac82001-01-28 00:27:39 +0000868 argcount, nlocals, stacksize, flags,
Guido van Rossum681d79a1995-07-18 14:51:37 +0000869 code, consts, names, varnames,
Tim Petersd9b9ac82001-01-28 00:27:39 +0000870 freevars, cellvars, filename, name,
871 firstlineno, lnotab);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000872
873 code_error:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000874 Py_XDECREF(code);
875 Py_XDECREF(consts);
876 Py_XDECREF(names);
877 Py_XDECREF(varnames);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000878 Py_XDECREF(freevars);
879 Py_XDECREF(cellvars);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000880 Py_XDECREF(filename);
881 Py_XDECREF(name);
Guido van Rossum6fc06e71997-07-26 23:30:18 +0000882 Py_XDECREF(lnotab);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000883
884 }
885 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000886
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000887 default:
Guido van Rossumf2150601996-06-26 20:41:23 +0000888 /* Bogus data got written, which isn't ideal.
889 This will let you keep working and recover. */
Guido van Rossuma45cb451998-06-08 20:27:29 +0000890 PyErr_SetString(PyExc_ValueError, "bad marshal data");
891 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000892
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000893 }
894}
895
Neal Norwitzd85c4522004-06-13 20:31:49 +0000896static PyObject *
Armin Rigo01ab2792004-03-26 15:09:27 +0000897read_object(RFILE *p)
898{
899 PyObject *v;
900 if (PyErr_Occurred()) {
901 fprintf(stderr, "XXX readobject called with exception set\n");
902 return NULL;
903 }
904 v = r_object(p);
905 if (v == NULL && !PyErr_Occurred())
906 PyErr_SetString(PyExc_TypeError, "NULL object in marshal data");
907 return v;
908}
909
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000910int
911PyMarshal_ReadShortFromFile(FILE *fp)
912{
913 RFILE rf;
Thomas Wouters7f401ef2006-03-01 22:30:47 +0000914 assert(fp);
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000915 rf.fp = fp;
Thomas Wouters7464b432006-03-01 22:34:09 +0000916 rf.strings = NULL;
917 rf.end = rf.ptr = NULL;
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000918 return r_short(&rf);
919}
920
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000921long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000922PyMarshal_ReadLongFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000923{
924 RFILE rf;
925 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000926 rf.strings = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000927 return r_long(&rf);
928}
929
Tim Peters691e0e92001-01-18 04:39:16 +0000930#ifdef HAVE_FSTAT
931/* Return size of file in bytes; < 0 if unknown. */
932static off_t
933getfilesize(FILE *fp)
934{
935 struct stat st;
936 if (fstat(fileno(fp), &st) != 0)
937 return -1;
938 else
939 return st.st_size;
940}
941#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000942
Tim Peters691e0e92001-01-18 04:39:16 +0000943/* If we can get the size of the file up-front, and it's reasonably small,
944 * read it in one gulp and delegate to ...FromString() instead. Much quicker
945 * than reading a byte at a time from file; speeds .pyc imports.
Tim Petersd9b9ac82001-01-28 00:27:39 +0000946 * CAUTION: since this may read the entire remainder of the file, don't
947 * call it unless you know you're done with the file.
Tim Peters691e0e92001-01-18 04:39:16 +0000948 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000949PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000950PyMarshal_ReadLastObjectFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000951{
Tim Peters691e0e92001-01-18 04:39:16 +0000952/* 75% of 2.1's .pyc files can exploit SMALL_FILE_LIMIT.
953 * REASONABLE_FILE_LIMIT is by defn something big enough for Tkinter.pyc.
954 */
955#define SMALL_FILE_LIMIT (1L << 14)
956#define REASONABLE_FILE_LIMIT (1L << 18)
Tim Peters691e0e92001-01-18 04:39:16 +0000957#ifdef HAVE_FSTAT
958 off_t filesize;
959#endif
Tim Peters691e0e92001-01-18 04:39:16 +0000960#ifdef HAVE_FSTAT
961 filesize = getfilesize(fp);
962 if (filesize > 0) {
963 char buf[SMALL_FILE_LIMIT];
964 char* pBuf = NULL;
965 if (filesize <= SMALL_FILE_LIMIT)
966 pBuf = buf;
967 else if (filesize <= REASONABLE_FILE_LIMIT)
968 pBuf = (char *)PyMem_MALLOC(filesize);
969 if (pBuf != NULL) {
970 PyObject* v;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000971 size_t n;
972 /* filesize must fit into an int, because it
973 is smaller than REASONABLE_FILE_LIMIT */
974 n = fread(pBuf, 1, (int)filesize, fp);
Tim Peters691e0e92001-01-18 04:39:16 +0000975 v = PyMarshal_ReadObjectFromString(pBuf, n);
976 if (pBuf != buf)
977 PyMem_FREE(pBuf);
978 return v;
979 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000980
Tim Peters691e0e92001-01-18 04:39:16 +0000981 }
982#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000983 /* We don't have fstat, or we do but the file is larger than
984 * REASONABLE_FILE_LIMIT or malloc failed -- read a byte at a time.
985 */
986 return PyMarshal_ReadObjectFromFile(fp);
987
Tim Peters691e0e92001-01-18 04:39:16 +0000988#undef SMALL_FILE_LIMIT
989#undef REASONABLE_FILE_LIMIT
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000990}
991
Guido van Rossum79f25d91997-04-29 20:08:16 +0000992PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000993PyMarshal_ReadObjectFromFile(FILE *fp)
994{
995 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000996 PyObject *result;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000997 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000998 rf.strings = PyList_New(0);
999 result = r_object(&rf);
1000 Py_DECREF(rf.strings);
1001 return result;
Tim Petersd9b9ac82001-01-28 00:27:39 +00001002}
1003
1004PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001005PyMarshal_ReadObjectFromString(char *str, Py_ssize_t len)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001006{
1007 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001008 PyObject *result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001009 rf.fp = NULL;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001010 rf.ptr = str;
1011 rf.end = str + len;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001012 rf.strings = PyList_New(0);
1013 result = r_object(&rf);
1014 Py_DECREF(rf.strings);
1015 return result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001016}
1017
Guido van Rossum79f25d91997-04-29 20:08:16 +00001018PyObject *
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001019PyMarshal_WriteObjectToString(PyObject *x, int version)
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001020{
1021 WFILE wf;
1022 wf.fp = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001023 wf.str = PyString_FromStringAndSize((char *)NULL, 50);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001024 if (wf.str == NULL)
1025 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001026 wf.ptr = PyString_AS_STRING((PyStringObject *)wf.str);
1027 wf.end = wf.ptr + PyString_Size(wf.str);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001028 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +00001029 wf.depth = 0;
Michael W. Hudsondf888462005-06-03 14:41:55 +00001030 wf.version = version;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001031 wf.strings = (version > 0) ? PyDict_New() : NULL;
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001032 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001033 Py_XDECREF(wf.strings);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001034 if (wf.str != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00001035 _PyString_Resize(&wf.str,
1036 (int) (wf.ptr -
1037 PyString_AS_STRING((PyStringObject *)wf.str)));
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001038 if (wf.error) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001039 Py_XDECREF(wf.str);
Tim Petersd9b9ac82001-01-28 00:27:39 +00001040 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +00001041 (wf.error==1)?"unmarshallable object"
1042 :"object too deeply nested to marshal");
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001043 return NULL;
1044 }
1045 return wf.str;
1046}
1047
Guido van Rossum64b45521991-06-07 13:58:22 +00001048/* And an interface for Python programs... */
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001049
Guido van Rossum79f25d91997-04-29 20:08:16 +00001050static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001051marshal_dump(PyObject *self, PyObject *args)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001052{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001053 WFILE wf;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001054 PyObject *x;
1055 PyObject *f;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001056 int version = Py_MARSHAL_VERSION;
1057 if (!PyArg_ParseTuple(args, "OO|i:dump", &x, &f, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001058 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001059 if (!PyFile_Check(f)) {
1060 PyErr_SetString(PyExc_TypeError,
1061 "marshal.dump() 2nd arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001062 return NULL;
1063 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001064 wf.fp = PyFile_AsFile(f);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001065 wf.str = NULL;
1066 wf.ptr = wf.end = NULL;
Guido van Rossumf2150601996-06-26 20:41:23 +00001067 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +00001068 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001069 wf.strings = (version > 0) ? PyDict_New() : 0;
Neal Norwitzef785292005-11-16 05:04:51 +00001070 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001071 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001072 Py_XDECREF(wf.strings);
Guido van Rossumf2150601996-06-26 20:41:23 +00001073 if (wf.error) {
Tim Petersd9b9ac82001-01-28 00:27:39 +00001074 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +00001075 (wf.error==1)?"unmarshallable object"
1076 :"object too deeply nested to marshal");
Guido van Rossumf2150601996-06-26 20:41:23 +00001077 return NULL;
1078 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001079 Py_INCREF(Py_None);
1080 return Py_None;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001081}
1082
Guido van Rossum79f25d91997-04-29 20:08:16 +00001083static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001084marshal_load(PyObject *self, PyObject *f)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001085{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001086 RFILE rf;
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001087 PyObject *result;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001088 if (!PyFile_Check(f)) {
1089 PyErr_SetString(PyExc_TypeError,
1090 "marshal.load() arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001091 return NULL;
1092 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001093 rf.fp = PyFile_AsFile(f);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001094 rf.strings = PyList_New(0);
1095 result = read_object(&rf);
1096 Py_DECREF(rf.strings);
1097 return result;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001098}
1099
Guido van Rossum79f25d91997-04-29 20:08:16 +00001100static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001101marshal_dumps(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001102{
Guido van Rossum79f25d91997-04-29 20:08:16 +00001103 PyObject *x;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001104 int version = Py_MARSHAL_VERSION;
Armin Rigo2ccea172004-12-20 12:25:57 +00001105 if (!PyArg_ParseTuple(args, "O|i:dumps", &x, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001106 return NULL;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001107 return PyMarshal_WriteObjectToString(x, version);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001108}
1109
Guido van Rossum79f25d91997-04-29 20:08:16 +00001110static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001111marshal_loads(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001112{
1113 RFILE rf;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001114 char *s;
Thomas Wouters695934a2006-03-01 23:49:13 +00001115 Py_ssize_t n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001116 PyObject* result;
Michael W. Hudson01fca112005-06-13 17:50:18 +00001117 if (!PyArg_ParseTuple(args, "s#:loads", &s, &n))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001118 return NULL;
1119 rf.fp = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001120 rf.ptr = s;
1121 rf.end = s + n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001122 rf.strings = PyList_New(0);
1123 result = read_object(&rf);
1124 Py_DECREF(rf.strings);
1125 return result;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001126}
1127
Guido van Rossum79f25d91997-04-29 20:08:16 +00001128static PyMethodDef marshal_methods[] = {
Neal Norwitz031829d2002-03-31 14:37:44 +00001129 {"dump", marshal_dump, METH_VARARGS},
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001130 {"load", marshal_load, METH_O},
Neal Norwitz031829d2002-03-31 14:37:44 +00001131 {"dumps", marshal_dumps, METH_VARARGS},
1132 {"loads", marshal_loads, METH_VARARGS},
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001133 {NULL, NULL} /* sentinel */
1134};
1135
Jason Tishler6bc06ec2003-09-04 11:59:50 +00001136PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001137PyMarshal_Init(void)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001138{
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001139 PyObject *mod = Py_InitModule("marshal", marshal_methods);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00001140 if (mod == NULL)
1141 return;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001142 PyModule_AddIntConstant(mod, "version", Py_MARSHAL_VERSION);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001143}