blob: fd1bd72d3b387485c744b3284ee724c8b142f7f0 [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 Rossumddefaf32007-01-14 03:31:43 +0000147 else if (PyLong_Check(v)) {
148 long x = PyLong_AsLong(v);
149 if ((x == -1) && PyErr_Occurred()) {
150 PyLongObject *ob = (PyLongObject *)v;
151 PyErr_Clear();
152 w_byte(TYPE_LONG, p);
153 n = ob->ob_size;
154 w_long((long)n, p);
155 if (n < 0)
156 n = -n;
157 for (i = 0; i < n; i++)
158 w_short(ob->ob_digit[i], p);
159 }
160 else {
Guido van Rossumc1547d91996-12-10 15:39:04 +0000161#if SIZEOF_LONG > 4
Guido van Rossumddefaf32007-01-14 03:31:43 +0000162 long y = Py_ARITHMETIC_RIGHT_SHIFT(long, x, 31);
163 if (y && y != -1) {
164 w_byte(TYPE_INT64, p);
165 w_long64(x, p);
166 }
167 else
Guido van Rossumc1547d91996-12-10 15:39:04 +0000168#endif
169 {
Guido van Rossumddefaf32007-01-14 03:31:43 +0000170 w_byte(TYPE_INT, p);
171 w_long(x, p);
172 }
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000173 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000174 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000175 else if (PyFloat_Check(v)) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000176 if (p->version > 1) {
Brett Cannonc9371d42005-06-25 08:23:41 +0000177 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000178 if (_PyFloat_Pack8(PyFloat_AsDouble(v),
179 buf, 1) < 0) {
180 p->error = 1;
181 return;
182 }
183 w_byte(TYPE_BINARY_FLOAT, p);
Brett Cannonc9371d42005-06-25 08:23:41 +0000184 w_string((char*)buf, 8, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000185 }
186 else {
187 char buf[256]; /* Plenty to format any double */
Neal Norwitz545686b2006-12-28 04:45:06 +0000188 n = _PyFloat_Repr(PyFloat_AS_DOUBLE(v),
189 buf, sizeof(buf));
Michael W. Hudsondf888462005-06-03 14:41:55 +0000190 w_byte(TYPE_FLOAT, p);
Martin v. Löwis67baee62006-02-16 14:37:48 +0000191 w_byte((int)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000192 w_string(buf, (int)n, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000193 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000194 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000195#ifndef WITHOUT_COMPLEX
Guido van Rossum79f25d91997-04-29 20:08:16 +0000196 else if (PyComplex_Check(v)) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000197 if (p->version > 1) {
Brett Cannonc9371d42005-06-25 08:23:41 +0000198 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000199 if (_PyFloat_Pack8(PyComplex_RealAsDouble(v),
200 buf, 1) < 0) {
201 p->error = 1;
202 return;
203 }
204 w_byte(TYPE_BINARY_COMPLEX, p);
Brett Cannonc9371d42005-06-25 08:23:41 +0000205 w_string((char*)buf, 8, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000206 if (_PyFloat_Pack8(PyComplex_ImagAsDouble(v),
207 buf, 1) < 0) {
208 p->error = 1;
209 return;
210 }
Brett Cannonc9371d42005-06-25 08:23:41 +0000211 w_string((char*)buf, 8, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000212 }
213 else {
214 char buf[256]; /* Plenty to format any double */
Michael W. Hudsondf888462005-06-03 14:41:55 +0000215 w_byte(TYPE_COMPLEX, p);
Neal Norwitz545686b2006-12-28 04:45:06 +0000216 n = _PyFloat_Repr(PyComplex_RealAsDouble(v),
217 buf, sizeof(buf));
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);
Neal Norwitz545686b2006-12-28 04:45:06 +0000221 n = _PyFloat_Repr(PyComplex_ImagAsDouble(v),
222 buf, sizeof(buf));
Martin v. Löwis725507b2006-03-07 12:08:51 +0000223 w_byte((int)n, p);
224 w_string(buf, (int)n, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000225 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000226 }
227#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +0000228 else if (PyString_Check(v)) {
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000229 if (p->strings && PyString_CHECK_INTERNED(v)) {
230 PyObject *o = PyDict_GetItem(p->strings, v);
231 if (o) {
232 long w = PyInt_AsLong(o);
233 w_byte(TYPE_STRINGREF, p);
234 w_long(w, p);
235 goto exit;
236 }
237 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000238 o = PyInt_FromSsize_t(PyDict_Size(p->strings));
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000239 PyDict_SetItem(p->strings, v, o);
240 Py_DECREF(o);
241 w_byte(TYPE_INTERNED, p);
242 }
243 }
244 else {
245 w_byte(TYPE_STRING, p);
246 }
Guido van Rossumc279b532000-03-10 23:03:02 +0000247 n = PyString_GET_SIZE(v);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000248 if (n > INT_MAX) {
249 /* huge strings are not supported */
250 p->depth--;
251 p->error = 1;
252 return;
253 }
Guido van Rossum3a205f71995-02-17 15:10:07 +0000254 w_long((long)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000255 w_string(PyString_AS_STRING(v), (int)n, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000256 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000257#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000258 else if (PyUnicode_Check(v)) {
259 PyObject *utf8;
260 utf8 = PyUnicode_AsUTF8String(v);
261 if (utf8 == NULL) {
Guido van Rossum98626cd2000-06-28 23:24:19 +0000262 p->depth--;
263 p->error = 1;
264 return;
Guido van Rossumc279b532000-03-10 23:03:02 +0000265 }
266 w_byte(TYPE_UNICODE, p);
267 n = PyString_GET_SIZE(utf8);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000268 if (n > INT_MAX) {
269 p->depth--;
270 p->error = 1;
271 return;
272 }
Guido van Rossumc279b532000-03-10 23:03:02 +0000273 w_long((long)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000274 w_string(PyString_AS_STRING(utf8), (int)n, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000275 Py_DECREF(utf8);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000276 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000277#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +0000278 else if (PyTuple_Check(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000279 w_byte(TYPE_TUPLE, p);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000280 n = PyTuple_Size(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000281 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000282 for (i = 0; i < n; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000283 w_object(PyTuple_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000284 }
285 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000286 else if (PyList_Check(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000287 w_byte(TYPE_LIST, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000288 n = PyList_GET_SIZE(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000289 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000290 for (i = 0; i < n; i++) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000291 w_object(PyList_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000292 }
293 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000294 else if (PyDict_Check(v)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000295 Py_ssize_t pos;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000296 PyObject *key, *value;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000297 w_byte(TYPE_DICT, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000298 /* This one is NULL object terminated! */
Guido van Rossum25831651993-05-19 14:50:45 +0000299 pos = 0;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000300 while (PyDict_Next(v, &pos, &key, &value)) {
Guido van Rossum25831651993-05-19 14:50:45 +0000301 w_object(key, p);
302 w_object(value, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000303 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000304 w_object((PyObject *)NULL, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000305 }
Raymond Hettingera422c342005-01-11 03:03:27 +0000306 else if (PyAnySet_Check(v)) {
Raymond Hettingera422c342005-01-11 03:03:27 +0000307 PyObject *value, *it;
308
309 if (PyObject_TypeCheck(v, &PySet_Type))
310 w_byte(TYPE_SET, p);
311 else
312 w_byte(TYPE_FROZENSET, p);
313 n = PyObject_Size(v);
314 if (n == -1) {
315 p->depth--;
316 p->error = 1;
317 return;
318 }
319 w_long((long)n, p);
320 it = PyObject_GetIter(v);
321 if (it == NULL) {
322 p->depth--;
323 p->error = 1;
324 return;
325 }
326 while ((value = PyIter_Next(it)) != NULL) {
327 w_object(value, p);
328 Py_DECREF(value);
329 }
330 Py_DECREF(it);
331 if (PyErr_Occurred()) {
332 p->depth--;
333 p->error = 1;
334 return;
335 }
336 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000337 else if (PyCode_Check(v)) {
338 PyCodeObject *co = (PyCodeObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000339 w_byte(TYPE_CODE, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000340 w_long(co->co_argcount, p);
Guido van Rossum4f72a782006-10-27 23:31:49 +0000341 w_long(co->co_kwonlyargcount, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000342 w_long(co->co_nlocals, p);
343 w_long(co->co_stacksize, p);
344 w_long(co->co_flags, p);
Guido van Rossumd076c731998-10-07 19:42:25 +0000345 w_object(co->co_code, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000346 w_object(co->co_consts, p);
347 w_object(co->co_names, p);
Guido van Rossum681d79a1995-07-18 14:51:37 +0000348 w_object(co->co_varnames, p);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000349 w_object(co->co_freevars, p);
350 w_object(co->co_cellvars, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000351 w_object(co->co_filename, p);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000352 w_object(co->co_name, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000353 w_long(co->co_firstlineno, p);
Guido van Rossumd031c891997-01-24 03:44:17 +0000354 w_object(co->co_lnotab, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000355 }
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000356 else if (PyObject_CheckReadBuffer(v)) {
Guido van Rossumd076c731998-10-07 19:42:25 +0000357 /* Write unknown buffer-style objects as a string */
358 char *s;
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000359 PyBufferProcs *pb = v->ob_type->tp_as_buffer;
Guido van Rossumd076c731998-10-07 19:42:25 +0000360 w_byte(TYPE_STRING, p);
361 n = (*pb->bf_getreadbuffer)(v, 0, (void **)&s);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000362 if (n > INT_MAX) {
363 p->depth--;
364 p->error = 1;
365 return;
366 }
Guido van Rossumd076c731998-10-07 19:42:25 +0000367 w_long((long)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000368 w_string(s, (int)n, p);
Guido van Rossumd076c731998-10-07 19:42:25 +0000369 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000370 else {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000371 w_byte(TYPE_UNKNOWN, p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000372 p->error = 1;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000373 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000374 exit:
Guido van Rossum98626cd2000-06-28 23:24:19 +0000375 p->depth--;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000376}
377
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000378/* version currently has no effect for writing longs. */
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000379void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000380PyMarshal_WriteLongToFile(long x, FILE *fp, int version)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000381{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000382 WFILE wf;
383 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000384 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000385 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000386 wf.strings = NULL;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000387 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000388 w_long(x, &wf);
389}
390
391void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000392PyMarshal_WriteObjectToFile(PyObject *x, FILE *fp, int version)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000393{
394 WFILE wf;
395 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000396 wf.error = 0;
Guido van Rossum98626cd2000-06-28 23:24:19 +0000397 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000398 wf.strings = (version > 0) ? PyDict_New() : NULL;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000399 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000400 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000401 Py_XDECREF(wf.strings);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000402}
403
404typedef WFILE RFILE; /* Same struct with different invariants */
405
Guido van Rossum8d617a61995-03-09 12:12:11 +0000406#define rs_byte(p) (((p)->ptr != (p)->end) ? (unsigned char)*(p)->ptr++ : EOF)
407
408#define r_byte(p) ((p)->fp ? getc((p)->fp) : rs_byte(p))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000409
410static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000411r_string(char *s, int n, RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000412{
413 if (p->fp != NULL)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000414 /* The result fits into int because it must be <=n. */
415 return (int)fread(s, 1, n, p->fp);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000416 if (p->end - p->ptr < n)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000417 n = (int)(p->end - p->ptr);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000418 memcpy(s, p->ptr, n);
419 p->ptr += n;
420 return n;
421}
422
423static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000424r_short(RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000425{
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000426 register short x;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000427 x = r_byte(p);
428 x |= r_byte(p) << 8;
Tim Peterse84b7402000-09-19 08:54:13 +0000429 /* Sign-extension, in case short greater than 16 bits */
430 x |= -(x & 0x8000);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000431 return x;
432}
433
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000434static long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000435r_long(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000436{
437 register long x;
Guido van Rossum8d617a61995-03-09 12:12:11 +0000438 register FILE *fp = p->fp;
439 if (fp) {
440 x = getc(fp);
441 x |= (long)getc(fp) << 8;
442 x |= (long)getc(fp) << 16;
443 x |= (long)getc(fp) << 24;
444 }
445 else {
446 x = rs_byte(p);
447 x |= (long)rs_byte(p) << 8;
448 x |= (long)rs_byte(p) << 16;
449 x |= (long)rs_byte(p) << 24;
450 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000451#if SIZEOF_LONG > 4
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000452 /* Sign extension for 64-bit machines */
Tim Peterse84b7402000-09-19 08:54:13 +0000453 x |= -(x & 0x80000000L);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000454#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000455 return x;
456}
457
Tim Peters82112372001-08-29 02:28:42 +0000458/* r_long64 deals with the TYPE_INT64 code. On a machine with
459 sizeof(long) > 4, it returns a Python int object, else a Python long
460 object. Note that w_long64 writes out TYPE_INT if 32 bits is enough,
461 so there's no inefficiency here in returning a PyLong on 32-bit boxes
462 for everything written via TYPE_INT64 (i.e., if an int is written via
463 TYPE_INT64, it *needs* more than 32 bits).
464*/
465static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000466r_long64(RFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000467{
Tim Peters82112372001-08-29 02:28:42 +0000468 long lo4 = r_long(p);
469 long hi4 = r_long(p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000470#if SIZEOF_LONG > 4
Tim Peters82112372001-08-29 02:28:42 +0000471 long x = (hi4 << 32) | (lo4 & 0xFFFFFFFFL);
472 return PyInt_FromLong(x);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000473#else
Tim Peters82112372001-08-29 02:28:42 +0000474 unsigned char buf[8];
475 int one = 1;
476 int is_little_endian = (int)*(char*)&one;
477 if (is_little_endian) {
478 memcpy(buf, &lo4, 4);
479 memcpy(buf+4, &hi4, 4);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000480 }
Tim Peters82112372001-08-29 02:28:42 +0000481 else {
482 memcpy(buf, &hi4, 4);
483 memcpy(buf+4, &lo4, 4);
484 }
485 return _PyLong_FromByteArray(buf, 8, is_little_endian, 1);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000486#endif
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000487}
488
Guido van Rossum79f25d91997-04-29 20:08:16 +0000489static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000490r_object(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000491{
Armin Rigo01ab2792004-03-26 15:09:27 +0000492 /* NULL is a valid return value, it does not necessarily means that
493 an exception is set. */
Raymond Hettingera422c342005-01-11 03:03:27 +0000494 PyObject *v, *v2, *v3;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000495 long i, n;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000496 int type = r_byte(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000497
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000498 switch (type) {
Tim Petersd9b9ac82001-01-28 00:27:39 +0000499
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000500 case EOF:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000501 PyErr_SetString(PyExc_EOFError,
502 "EOF read where object expected");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000503 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000504
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000505 case TYPE_NULL:
506 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000507
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000508 case TYPE_NONE:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000509 Py_INCREF(Py_None);
510 return Py_None;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000511
Tim Peters5ca576e2001-06-18 22:08:13 +0000512 case TYPE_STOPITER:
513 Py_INCREF(PyExc_StopIteration);
514 return PyExc_StopIteration;
515
Guido van Rossume449af71996-10-11 16:25:41 +0000516 case TYPE_ELLIPSIS:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000517 Py_INCREF(Py_Ellipsis);
Guido van Rossume449af71996-10-11 16:25:41 +0000518 return Py_Ellipsis;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000519
Guido van Rossum77f6a652002-04-03 22:41:51 +0000520 case TYPE_FALSE:
521 Py_INCREF(Py_False);
522 return Py_False;
523
524 case TYPE_TRUE:
525 Py_INCREF(Py_True);
526 return Py_True;
527
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000528 case TYPE_INT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000529 return PyInt_FromLong(r_long(p));
Tim Petersd9b9ac82001-01-28 00:27:39 +0000530
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000531 case TYPE_INT64:
Tim Peters82112372001-08-29 02:28:42 +0000532 return r_long64(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000533
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000534 case TYPE_LONG:
535 {
536 int size;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000537 PyLongObject *ob;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000538 n = r_long(p);
Thomas Wouters89f507f2006-12-13 04:49:30 +0000539 if (n < -INT_MAX || n > INT_MAX) {
540 PyErr_SetString(PyExc_ValueError,
541 "bad marshal data");
542 return NULL;
543 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000544 size = n<0 ? -n : n;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000545 ob = _PyLong_New(size);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000546 if (ob == NULL)
547 return NULL;
548 ob->ob_size = n;
Armin Rigo01ab2792004-03-26 15:09:27 +0000549 for (i = 0; i < size; i++) {
550 int digit = r_short(p);
551 if (digit < 0) {
552 Py_DECREF(ob);
553 PyErr_SetString(PyExc_ValueError,
554 "bad marshal data");
555 return NULL;
556 }
557 ob->ob_digit[i] = digit;
558 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000559 return (PyObject *)ob;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000560 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000561
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000562 case TYPE_FLOAT:
563 {
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000564 char buf[256];
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000565 double dx;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000566 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000567 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000568 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000569 "EOF read where object expected");
570 return NULL;
571 }
572 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000573 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000574 dx = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000575 PyFPE_END_PROTECT(dx)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000576 return PyFloat_FromDouble(dx);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000577 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000578
Michael W. Hudsondf888462005-06-03 14:41:55 +0000579 case TYPE_BINARY_FLOAT:
580 {
Brett Cannonc9371d42005-06-25 08:23:41 +0000581 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000582 double x;
Brett Cannonc9371d42005-06-25 08:23:41 +0000583 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000584 PyErr_SetString(PyExc_EOFError,
585 "EOF read where object expected");
586 return NULL;
587 }
588 x = _PyFloat_Unpack8(buf, 1);
589 if (x == -1.0 && PyErr_Occurred()) {
590 return NULL;
591 }
592 return PyFloat_FromDouble(x);
593 }
594
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000595#ifndef WITHOUT_COMPLEX
596 case TYPE_COMPLEX:
597 {
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000598 char buf[256];
Guido van Rossum530956d1996-07-21 02:27:43 +0000599 Py_complex c;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000600 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000601 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000602 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000603 "EOF read where object expected");
604 return NULL;
605 }
606 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000607 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000608 c.real = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000609 PyFPE_END_PROTECT(c)
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000610 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000611 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000612 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000613 "EOF read where object expected");
614 return NULL;
615 }
616 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000617 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000618 c.imag = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000619 PyFPE_END_PROTECT(c)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000620 return PyComplex_FromCComplex(c);
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000621 }
Michael W. Hudsondf888462005-06-03 14:41:55 +0000622
623 case TYPE_BINARY_COMPLEX:
624 {
Brett Cannonc9371d42005-06-25 08:23:41 +0000625 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000626 Py_complex c;
Brett Cannonc9371d42005-06-25 08:23:41 +0000627 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000628 PyErr_SetString(PyExc_EOFError,
629 "EOF read where object expected");
630 return NULL;
631 }
632 c.real = _PyFloat_Unpack8(buf, 1);
633 if (c.real == -1.0 && PyErr_Occurred()) {
634 return NULL;
635 }
Brett Cannonc9371d42005-06-25 08:23:41 +0000636 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000637 PyErr_SetString(PyExc_EOFError,
638 "EOF read where object expected");
639 return NULL;
640 }
641 c.imag = _PyFloat_Unpack8(buf, 1);
642 if (c.imag == -1.0 && PyErr_Occurred()) {
643 return NULL;
644 }
645 return PyComplex_FromCComplex(c);
646 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000647#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000648
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000649 case TYPE_INTERNED:
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000650 case TYPE_STRING:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000651 n = r_long(p);
Thomas Wouters89f507f2006-12-13 04:49:30 +0000652 if (n < 0 || n > INT_MAX) {
Guido van Rossuma45cb451998-06-08 20:27:29 +0000653 PyErr_SetString(PyExc_ValueError, "bad marshal data");
654 return NULL;
655 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000656 v = PyString_FromStringAndSize((char *)NULL, n);
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000657 if (v == NULL)
658 return v;
659 if (r_string(PyString_AS_STRING(v), (int)n, p) != n) {
660 Py_DECREF(v);
661 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000662 "EOF read where object expected");
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000663 return NULL;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000664 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000665 if (type == TYPE_INTERNED) {
666 PyString_InternInPlace(&v);
667 PyList_Append(p->strings, v);
668 }
669 return v;
670
671 case TYPE_STRINGREF:
672 n = r_long(p);
Michael W. Hudsonf2ca5af2005-06-13 18:28:46 +0000673 if (n < 0 || n >= PyList_GET_SIZE(p->strings)) {
674 PyErr_SetString(PyExc_ValueError, "bad marshal data");
675 return NULL;
676 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000677 v = PyList_GET_ITEM(p->strings, n);
678 Py_INCREF(v);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000679 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000680
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000681#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000682 case TYPE_UNICODE:
683 {
684 char *buffer;
685
686 n = r_long(p);
Thomas Wouters89f507f2006-12-13 04:49:30 +0000687 if (n < 0 || n > INT_MAX) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000688 PyErr_SetString(PyExc_ValueError, "bad marshal data");
689 return NULL;
690 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000691 buffer = PyMem_NEW(char, n);
Guido van Rossumc279b532000-03-10 23:03:02 +0000692 if (buffer == NULL)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000693 return PyErr_NoMemory();
Guido van Rossumc279b532000-03-10 23:03:02 +0000694 if (r_string(buffer, (int)n, p) != n) {
Guido van Rossumb18618d2000-05-03 23:44:39 +0000695 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000696 PyErr_SetString(PyExc_EOFError,
697 "EOF read where object expected");
698 return NULL;
699 }
700 v = PyUnicode_DecodeUTF8(buffer, n, NULL);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000701 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000702 return v;
703 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000704#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000705
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000706 case TYPE_TUPLE:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000707 n = r_long(p);
Thomas Wouters89f507f2006-12-13 04:49:30 +0000708 if (n < 0 || n > INT_MAX) {
Guido van Rossuma45cb451998-06-08 20:27:29 +0000709 PyErr_SetString(PyExc_ValueError, "bad marshal data");
710 return NULL;
711 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000712 v = PyTuple_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000713 if (v == NULL)
714 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000715 for (i = 0; i < n; i++) {
716 v2 = r_object(p);
717 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000718 if (!PyErr_Occurred())
719 PyErr_SetString(PyExc_TypeError,
720 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000721 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000722 v = NULL;
723 break;
724 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000725 PyTuple_SET_ITEM(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000726 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000727 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000728
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000729 case TYPE_LIST:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000730 n = r_long(p);
Thomas Wouters89f507f2006-12-13 04:49:30 +0000731 if (n < 0 || n > INT_MAX) {
Guido van Rossuma45cb451998-06-08 20:27:29 +0000732 PyErr_SetString(PyExc_ValueError, "bad marshal data");
733 return NULL;
734 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000735 v = PyList_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000736 if (v == NULL)
737 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000738 for (i = 0; i < n; i++) {
739 v2 = r_object(p);
740 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000741 if (!PyErr_Occurred())
742 PyErr_SetString(PyExc_TypeError,
743 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000744 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000745 v = NULL;
746 break;
747 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000748 PyList_SetItem(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000749 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000750 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000751
Guido van Rossum64b45521991-06-07 13:58:22 +0000752 case TYPE_DICT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000753 v = PyDict_New();
Guido van Rossum64b45521991-06-07 13:58:22 +0000754 if (v == NULL)
755 return NULL;
756 for (;;) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000757 PyObject *key, *val;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000758 key = r_object(p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000759 if (key == NULL)
Armin Rigo01ab2792004-03-26 15:09:27 +0000760 break;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000761 val = r_object(p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000762 if (val != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000763 PyDict_SetItem(v, key, val);
764 Py_DECREF(key);
765 Py_XDECREF(val);
Guido van Rossum64b45521991-06-07 13:58:22 +0000766 }
Armin Rigo01ab2792004-03-26 15:09:27 +0000767 if (PyErr_Occurred()) {
768 Py_DECREF(v);
769 v = NULL;
770 }
Guido van Rossum64b45521991-06-07 13:58:22 +0000771 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000772
Raymond Hettingera422c342005-01-11 03:03:27 +0000773 case TYPE_SET:
774 case TYPE_FROZENSET:
775 n = r_long(p);
776 if (n < 0) {
777 PyErr_SetString(PyExc_ValueError, "bad marshal data");
778 return NULL;
779 }
780 v = PyTuple_New((int)n);
781 if (v == NULL)
782 return v;
783 for (i = 0; i < n; i++) {
784 v2 = r_object(p);
785 if ( v2 == NULL ) {
786 if (!PyErr_Occurred())
787 PyErr_SetString(PyExc_TypeError,
788 "NULL object in marshal data");
789 Py_DECREF(v);
790 v = NULL;
791 break;
792 }
793 PyTuple_SET_ITEM(v, (int)i, v2);
794 }
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000795 if (v == NULL)
796 return v;
Raymond Hettingera422c342005-01-11 03:03:27 +0000797 if (type == TYPE_SET)
Raymond Hettingerbeb31012005-08-16 03:47:52 +0000798 v3 = PySet_New(v);
Raymond Hettingera422c342005-01-11 03:03:27 +0000799 else
Raymond Hettingerbeb31012005-08-16 03:47:52 +0000800 v3 = PyFrozenSet_New(v);
Raymond Hettingera422c342005-01-11 03:03:27 +0000801 Py_DECREF(v);
802 return v3;
803
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000804 case TYPE_CODE:
Michael W. Hudson80199132001-08-30 14:50:20 +0000805 if (PyEval_GetRestricted()) {
806 PyErr_SetString(PyExc_RuntimeError,
807 "cannot unmarshal code objects in "
808 "restricted execution mode");
809 return NULL;
810 }
811 else {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000812 int argcount;
Guido van Rossum4f72a782006-10-27 23:31:49 +0000813 int kwonlyargcount;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000814 int nlocals;
815 int stacksize;
816 int flags;
817 PyObject *code = NULL;
818 PyObject *consts = NULL;
819 PyObject *names = NULL;
820 PyObject *varnames = NULL;
821 PyObject *freevars = NULL;
822 PyObject *cellvars = NULL;
823 PyObject *filename = NULL;
824 PyObject *name = NULL;
825 int firstlineno;
826 PyObject *lnotab = NULL;
827
828 v = NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000829
Thomas Wouters89f507f2006-12-13 04:49:30 +0000830 /* XXX ignore long->int overflows for now */
831 argcount = (int)r_long(p);
832 kwonlyargcount = (int)r_long(p);
833 nlocals = (int)r_long(p);
834 stacksize = (int)r_long(p);
835 flags = (int)r_long(p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000836 code = r_object(p);
837 if (code == NULL)
838 goto code_error;
839 consts = r_object(p);
840 if (consts == NULL)
841 goto code_error;
842 names = r_object(p);
843 if (names == NULL)
844 goto code_error;
845 varnames = r_object(p);
846 if (varnames == NULL)
847 goto code_error;
848 freevars = r_object(p);
849 if (freevars == NULL)
850 goto code_error;
851 cellvars = r_object(p);
852 if (cellvars == NULL)
853 goto code_error;
854 filename = r_object(p);
855 if (filename == NULL)
856 goto code_error;
857 name = r_object(p);
858 if (name == NULL)
859 goto code_error;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000860 firstlineno = (int)r_long(p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000861 lnotab = r_object(p);
862 if (lnotab == NULL)
863 goto code_error;
864
865 v = (PyObject *) PyCode_New(
Guido van Rossum4f72a782006-10-27 23:31:49 +0000866 argcount, kwonlyargcount,
867 nlocals, stacksize, flags,
Guido van Rossum681d79a1995-07-18 14:51:37 +0000868 code, consts, names, varnames,
Tim Petersd9b9ac82001-01-28 00:27:39 +0000869 freevars, cellvars, filename, name,
870 firstlineno, lnotab);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000871
872 code_error:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000873 Py_XDECREF(code);
874 Py_XDECREF(consts);
875 Py_XDECREF(names);
876 Py_XDECREF(varnames);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000877 Py_XDECREF(freevars);
878 Py_XDECREF(cellvars);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000879 Py_XDECREF(filename);
880 Py_XDECREF(name);
Guido van Rossum6fc06e71997-07-26 23:30:18 +0000881 Py_XDECREF(lnotab);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000882
883 }
884 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000885
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000886 default:
Guido van Rossumf2150601996-06-26 20:41:23 +0000887 /* Bogus data got written, which isn't ideal.
888 This will let you keep working and recover. */
Guido van Rossuma45cb451998-06-08 20:27:29 +0000889 PyErr_SetString(PyExc_ValueError, "bad marshal data");
890 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000891
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000892 }
893}
894
Neal Norwitzd85c4522004-06-13 20:31:49 +0000895static PyObject *
Armin Rigo01ab2792004-03-26 15:09:27 +0000896read_object(RFILE *p)
897{
898 PyObject *v;
899 if (PyErr_Occurred()) {
900 fprintf(stderr, "XXX readobject called with exception set\n");
901 return NULL;
902 }
903 v = r_object(p);
904 if (v == NULL && !PyErr_Occurred())
905 PyErr_SetString(PyExc_TypeError, "NULL object in marshal data");
906 return v;
907}
908
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000909int
910PyMarshal_ReadShortFromFile(FILE *fp)
911{
912 RFILE rf;
Thomas Wouters7f401ef2006-03-01 22:30:47 +0000913 assert(fp);
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000914 rf.fp = fp;
Thomas Wouters7464b432006-03-01 22:34:09 +0000915 rf.strings = NULL;
916 rf.end = rf.ptr = NULL;
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000917 return r_short(&rf);
918}
919
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000920long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000921PyMarshal_ReadLongFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000922{
923 RFILE rf;
924 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000925 rf.strings = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000926 return r_long(&rf);
927}
928
Tim Peters691e0e92001-01-18 04:39:16 +0000929#ifdef HAVE_FSTAT
930/* Return size of file in bytes; < 0 if unknown. */
931static off_t
932getfilesize(FILE *fp)
933{
934 struct stat st;
935 if (fstat(fileno(fp), &st) != 0)
936 return -1;
937 else
938 return st.st_size;
939}
940#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000941
Tim Peters691e0e92001-01-18 04:39:16 +0000942/* If we can get the size of the file up-front, and it's reasonably small,
943 * read it in one gulp and delegate to ...FromString() instead. Much quicker
944 * than reading a byte at a time from file; speeds .pyc imports.
Tim Petersd9b9ac82001-01-28 00:27:39 +0000945 * CAUTION: since this may read the entire remainder of the file, don't
946 * call it unless you know you're done with the file.
Tim Peters691e0e92001-01-18 04:39:16 +0000947 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000948PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000949PyMarshal_ReadLastObjectFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000950{
Tim Peters691e0e92001-01-18 04:39:16 +0000951/* 75% of 2.1's .pyc files can exploit SMALL_FILE_LIMIT.
952 * REASONABLE_FILE_LIMIT is by defn something big enough for Tkinter.pyc.
953 */
954#define SMALL_FILE_LIMIT (1L << 14)
955#define REASONABLE_FILE_LIMIT (1L << 18)
Tim Peters691e0e92001-01-18 04:39:16 +0000956#ifdef HAVE_FSTAT
957 off_t filesize;
958#endif
Tim Peters691e0e92001-01-18 04:39:16 +0000959#ifdef HAVE_FSTAT
960 filesize = getfilesize(fp);
961 if (filesize > 0) {
962 char buf[SMALL_FILE_LIMIT];
963 char* pBuf = NULL;
964 if (filesize <= SMALL_FILE_LIMIT)
965 pBuf = buf;
966 else if (filesize <= REASONABLE_FILE_LIMIT)
967 pBuf = (char *)PyMem_MALLOC(filesize);
968 if (pBuf != NULL) {
969 PyObject* v;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000970 size_t n;
971 /* filesize must fit into an int, because it
972 is smaller than REASONABLE_FILE_LIMIT */
973 n = fread(pBuf, 1, (int)filesize, fp);
Tim Peters691e0e92001-01-18 04:39:16 +0000974 v = PyMarshal_ReadObjectFromString(pBuf, n);
975 if (pBuf != buf)
976 PyMem_FREE(pBuf);
977 return v;
978 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000979
Tim Peters691e0e92001-01-18 04:39:16 +0000980 }
981#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000982 /* We don't have fstat, or we do but the file is larger than
983 * REASONABLE_FILE_LIMIT or malloc failed -- read a byte at a time.
984 */
985 return PyMarshal_ReadObjectFromFile(fp);
986
Tim Peters691e0e92001-01-18 04:39:16 +0000987#undef SMALL_FILE_LIMIT
988#undef REASONABLE_FILE_LIMIT
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000989}
990
Guido van Rossum79f25d91997-04-29 20:08:16 +0000991PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000992PyMarshal_ReadObjectFromFile(FILE *fp)
993{
994 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000995 PyObject *result;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000996 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000997 rf.strings = PyList_New(0);
998 result = r_object(&rf);
999 Py_DECREF(rf.strings);
1000 return result;
Tim Petersd9b9ac82001-01-28 00:27:39 +00001001}
1002
1003PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001004PyMarshal_ReadObjectFromString(char *str, Py_ssize_t len)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001005{
1006 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001007 PyObject *result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001008 rf.fp = NULL;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001009 rf.ptr = str;
1010 rf.end = str + len;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001011 rf.strings = PyList_New(0);
1012 result = r_object(&rf);
1013 Py_DECREF(rf.strings);
1014 return result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001015}
1016
Guido van Rossum79f25d91997-04-29 20:08:16 +00001017PyObject *
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001018PyMarshal_WriteObjectToString(PyObject *x, int version)
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001019{
1020 WFILE wf;
1021 wf.fp = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001022 wf.str = PyString_FromStringAndSize((char *)NULL, 50);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001023 if (wf.str == NULL)
1024 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001025 wf.ptr = PyString_AS_STRING((PyStringObject *)wf.str);
1026 wf.end = wf.ptr + PyString_Size(wf.str);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001027 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +00001028 wf.depth = 0;
Michael W. Hudsondf888462005-06-03 14:41:55 +00001029 wf.version = version;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001030 wf.strings = (version > 0) ? PyDict_New() : NULL;
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001031 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001032 Py_XDECREF(wf.strings);
Thomas Wouters89f507f2006-12-13 04:49:30 +00001033 if (wf.str != NULL) {
1034 char *base = PyString_AS_STRING((PyStringObject *)wf.str);
1035 if (wf.ptr - base > PY_SSIZE_T_MAX) {
1036 Py_DECREF(wf.str);
1037 PyErr_SetString(PyExc_OverflowError,
1038 "too much marshall data for a string");
1039 return NULL;
1040 }
1041 _PyString_Resize(&wf.str, (Py_ssize_t)(wf.ptr - base));
1042 }
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001043 if (wf.error) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001044 Py_XDECREF(wf.str);
Tim Petersd9b9ac82001-01-28 00:27:39 +00001045 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +00001046 (wf.error==1)?"unmarshallable object"
1047 :"object too deeply nested to marshal");
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001048 return NULL;
1049 }
1050 return wf.str;
1051}
1052
Guido van Rossum64b45521991-06-07 13:58:22 +00001053/* And an interface for Python programs... */
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001054
Guido van Rossum79f25d91997-04-29 20:08:16 +00001055static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001056marshal_dump(PyObject *self, PyObject *args)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001057{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001058 WFILE wf;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001059 PyObject *x;
1060 PyObject *f;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001061 int version = Py_MARSHAL_VERSION;
1062 if (!PyArg_ParseTuple(args, "OO|i:dump", &x, &f, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001063 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001064 if (!PyFile_Check(f)) {
1065 PyErr_SetString(PyExc_TypeError,
1066 "marshal.dump() 2nd arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001067 return NULL;
1068 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001069 wf.fp = PyFile_AsFile(f);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001070 wf.str = NULL;
1071 wf.ptr = wf.end = NULL;
Guido van Rossumf2150601996-06-26 20:41:23 +00001072 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +00001073 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001074 wf.strings = (version > 0) ? PyDict_New() : 0;
Neal Norwitzef785292005-11-16 05:04:51 +00001075 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001076 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001077 Py_XDECREF(wf.strings);
Guido van Rossumf2150601996-06-26 20:41:23 +00001078 if (wf.error) {
Tim Petersd9b9ac82001-01-28 00:27:39 +00001079 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +00001080 (wf.error==1)?"unmarshallable object"
1081 :"object too deeply nested to marshal");
Guido van Rossumf2150601996-06-26 20:41:23 +00001082 return NULL;
1083 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001084 Py_INCREF(Py_None);
1085 return Py_None;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001086}
1087
Guido van Rossum79f25d91997-04-29 20:08:16 +00001088static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001089marshal_load(PyObject *self, PyObject *f)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001090{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001091 RFILE rf;
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001092 PyObject *result;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001093 if (!PyFile_Check(f)) {
1094 PyErr_SetString(PyExc_TypeError,
1095 "marshal.load() arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001096 return NULL;
1097 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001098 rf.fp = PyFile_AsFile(f);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001099 rf.strings = PyList_New(0);
1100 result = read_object(&rf);
1101 Py_DECREF(rf.strings);
1102 return result;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001103}
1104
Guido van Rossum79f25d91997-04-29 20:08:16 +00001105static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001106marshal_dumps(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001107{
Guido van Rossum79f25d91997-04-29 20:08:16 +00001108 PyObject *x;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001109 int version = Py_MARSHAL_VERSION;
Armin Rigo2ccea172004-12-20 12:25:57 +00001110 if (!PyArg_ParseTuple(args, "O|i:dumps", &x, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001111 return NULL;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001112 return PyMarshal_WriteObjectToString(x, version);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001113}
1114
Guido van Rossum79f25d91997-04-29 20:08:16 +00001115static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001116marshal_loads(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001117{
1118 RFILE rf;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001119 char *s;
Thomas Wouters695934a2006-03-01 23:49:13 +00001120 Py_ssize_t n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001121 PyObject* result;
Michael W. Hudson01fca112005-06-13 17:50:18 +00001122 if (!PyArg_ParseTuple(args, "s#:loads", &s, &n))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001123 return NULL;
1124 rf.fp = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001125 rf.ptr = s;
1126 rf.end = s + n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001127 rf.strings = PyList_New(0);
1128 result = read_object(&rf);
1129 Py_DECREF(rf.strings);
1130 return result;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001131}
1132
Guido van Rossum79f25d91997-04-29 20:08:16 +00001133static PyMethodDef marshal_methods[] = {
Neal Norwitz031829d2002-03-31 14:37:44 +00001134 {"dump", marshal_dump, METH_VARARGS},
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001135 {"load", marshal_load, METH_O},
Neal Norwitz031829d2002-03-31 14:37:44 +00001136 {"dumps", marshal_dumps, METH_VARARGS},
1137 {"loads", marshal_loads, METH_VARARGS},
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001138 {NULL, NULL} /* sentinel */
1139};
1140
Jason Tishler6bc06ec2003-09-04 11:59:50 +00001141PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001142PyMarshal_Init(void)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001143{
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001144 PyObject *mod = Py_InitModule("marshal", marshal_methods);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00001145 if (mod == NULL)
1146 return;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001147 PyModule_AddIntConstant(mod, "version", Py_MARSHAL_VERSION);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001148}