blob: d0fcac729699a58ce2a00283d55d24e929ed3274 [file] [log] [blame]
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001
2/* Write Python objects to files and read them back.
3 This is intended for writing and reading compiled Python code only;
4 a true persistent storage facility would be much harder, since
5 it would have to take circular links and sharing into account. */
6
Guido van Rossum79f25d91997-04-29 20:08:16 +00007#include "Python.h"
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00008#include "longintrepr.h"
9#include "compile.h"
10#include "marshal.h"
11
Fred Drake6da0b912000-06-28 18:47:56 +000012/* High water mark to determine when the marshalled object is dangerously deep
13 * and risks coring the interpreter. When the object stack gets this deep,
14 * raise an exception instead of continuing.
15 */
16#define MAX_MARSHAL_STACK_DEPTH 5000
17
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000018#define TYPE_NULL '0'
19#define TYPE_NONE 'N'
Guido van Rossum77f6a652002-04-03 22:41:51 +000020#define TYPE_FALSE 'F'
21#define TYPE_TRUE 'T'
Tim Peters5ca576e2001-06-18 22:08:13 +000022#define TYPE_STOPITER 'S'
Guido van Rossume449af71996-10-11 16:25:41 +000023#define TYPE_ELLIPSIS '.'
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000024#define TYPE_INT 'i'
Guido van Rossumb0c168c1996-12-05 23:15:02 +000025#define TYPE_INT64 'I'
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000026#define TYPE_FLOAT 'f'
Guido van Rossum8a5c5d21996-01-12 01:09:56 +000027#define TYPE_COMPLEX 'x'
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000028#define TYPE_LONG 'l'
29#define TYPE_STRING 's'
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000030#define TYPE_INTERNED 't'
31#define TYPE_STRINGREF 'R'
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000032#define TYPE_TUPLE '('
33#define TYPE_LIST '['
34#define TYPE_DICT '{'
Guido van Rossum681d79a1995-07-18 14:51:37 +000035#define TYPE_CODE 'c'
Guido van Rossumc279b532000-03-10 23:03:02 +000036#define TYPE_UNICODE 'u'
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000037#define TYPE_UNKNOWN '?'
Raymond Hettingera422c342005-01-11 03:03:27 +000038#define TYPE_SET '<'
39#define TYPE_FROZENSET '>'
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000040
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000041typedef struct {
42 FILE *fp;
Guido van Rossumf2150601996-06-26 20:41:23 +000043 int error;
Fred Drake6da0b912000-06-28 18:47:56 +000044 int depth;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000045 /* If fp == NULL, the following are valid: */
Guido van Rossum79f25d91997-04-29 20:08:16 +000046 PyObject *str;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000047 char *ptr;
48 char *end;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000049 PyObject *strings; /* dict on marshal, list on unmarshal */
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000050} WFILE;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000051
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000052#define w_byte(c, p) if (((p)->fp)) putc((c), (p)->fp); \
53 else if ((p)->ptr != (p)->end) *(p)->ptr++ = (c); \
54 else w_more(c, p)
55
56static void
Fredrik Lundh11534382000-07-23 18:24:06 +000057w_more(int c, WFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000058{
59 int size, newsize;
60 if (p->str == NULL)
61 return; /* An error already occurred */
Guido van Rossum79f25d91997-04-29 20:08:16 +000062 size = PyString_Size(p->str);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000063 newsize = size + 1024;
Guido van Rossum79f25d91997-04-29 20:08:16 +000064 if (_PyString_Resize(&p->str, newsize) != 0) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000065 p->ptr = p->end = NULL;
66 }
67 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +000068 p->ptr = PyString_AS_STRING((PyStringObject *)p->str) + size;
69 p->end =
70 PyString_AS_STRING((PyStringObject *)p->str) + newsize;
Tim Peters8315ea52000-07-23 19:28:35 +000071 *p->ptr++ = Py_SAFE_DOWNCAST(c, int, char);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000072 }
73}
74
75static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000076w_string(char *s, int n, WFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000077{
78 if (p->fp != NULL) {
79 fwrite(s, 1, n, p->fp);
80 }
81 else {
82 while (--n >= 0) {
83 w_byte(*s, p);
84 s++;
85 }
86 }
87}
88
89static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000090w_short(int x, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000091{
Thomas Heller3e1c18a2002-07-30 11:40:57 +000092 w_byte((char)( x & 0xff), p);
93 w_byte((char)((x>> 8) & 0xff), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000094}
95
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000096static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000097w_long(long x, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000098{
Thomas Heller37d5a152002-07-30 11:44:44 +000099 w_byte((char)( x & 0xff), p);
100 w_byte((char)((x>> 8) & 0xff), p);
101 w_byte((char)((x>>16) & 0xff), p);
102 w_byte((char)((x>>24) & 0xff), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000103}
104
Guido van Rossumc1547d91996-12-10 15:39:04 +0000105#if SIZEOF_LONG > 4
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000106static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000107w_long64(long x, WFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000108{
109 w_long(x, p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000110 w_long(x>>32, p);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000111}
Guido van Rossumc1547d91996-12-10 15:39:04 +0000112#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000113
114static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000115w_object(PyObject *v, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000116{
Guido van Rossum3a205f71995-02-17 15:10:07 +0000117 int i, n;
Fred Drake6da0b912000-06-28 18:47:56 +0000118
119 p->depth++;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000120
Fred Drake6da0b912000-06-28 18:47:56 +0000121 if (p->depth > MAX_MARSHAL_STACK_DEPTH) {
122 p->error = 2;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000123 }
Fred Drake6da0b912000-06-28 18:47:56 +0000124 else if (v == NULL) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000125 w_byte(TYPE_NULL, p);
Guido van Rossum730806d1998-04-10 22:27:42 +0000126 }
127 else if (v == Py_None) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000128 w_byte(TYPE_NONE, p);
Guido van Rossum730806d1998-04-10 22:27:42 +0000129 }
Tim Peters5ca576e2001-06-18 22:08:13 +0000130 else if (v == PyExc_StopIteration) {
131 w_byte(TYPE_STOPITER, p);
132 }
Guido van Rossum730806d1998-04-10 22:27:42 +0000133 else if (v == Py_Ellipsis) {
134 w_byte(TYPE_ELLIPSIS, p);
135 }
Guido van Rossum77f6a652002-04-03 22:41:51 +0000136 else if (v == Py_False) {
137 w_byte(TYPE_FALSE, p);
138 }
139 else if (v == Py_True) {
140 w_byte(TYPE_TRUE, p);
141 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000142 else if (PyInt_Check(v)) {
143 long x = PyInt_AS_LONG((PyIntObject *)v);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000144#if SIZEOF_LONG > 4
Tim Peters44714002001-04-10 05:02:52 +0000145 long y = Py_ARITHMETIC_RIGHT_SHIFT(long, x, 31);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000146 if (y && y != -1) {
147 w_byte(TYPE_INT64, p);
148 w_long64(x, p);
149 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000150 else
151#endif
152 {
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000153 w_byte(TYPE_INT, p);
154 w_long(x, p);
155 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000156 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000157 else if (PyLong_Check(v)) {
158 PyLongObject *ob = (PyLongObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000159 w_byte(TYPE_LONG, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000160 n = ob->ob_size;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000161 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000162 if (n < 0)
163 n = -n;
164 for (i = 0; i < n; i++)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000165 w_short(ob->ob_digit[i], p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000166 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000167 else if (PyFloat_Check(v)) {
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000168 char buf[256]; /* Plenty to format any double */
Tim Peters72f98e92001-05-08 15:19:57 +0000169 PyFloat_AsReprString(buf, (PyFloatObject *)v);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000170 n = strlen(buf);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000171 w_byte(TYPE_FLOAT, p);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000172 w_byte(n, p);
173 w_string(buf, n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000174 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000175#ifndef WITHOUT_COMPLEX
Guido van Rossum79f25d91997-04-29 20:08:16 +0000176 else if (PyComplex_Check(v)) {
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000177 char buf[256]; /* Plenty to format any double */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000178 PyFloatObject *temp;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000179 w_byte(TYPE_COMPLEX, p);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000180 temp = (PyFloatObject*)PyFloat_FromDouble(
181 PyComplex_RealAsDouble(v));
Tim Peters72f98e92001-05-08 15:19:57 +0000182 PyFloat_AsReprString(buf, temp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000183 Py_DECREF(temp);
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000184 n = strlen(buf);
185 w_byte(n, p);
186 w_string(buf, n, p);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000187 temp = (PyFloatObject*)PyFloat_FromDouble(
188 PyComplex_ImagAsDouble(v));
Tim Peters72f98e92001-05-08 15:19:57 +0000189 PyFloat_AsReprString(buf, temp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000190 Py_DECREF(temp);
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000191 n = strlen(buf);
192 w_byte(n, p);
193 w_string(buf, n, p);
194 }
195#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +0000196 else if (PyString_Check(v)) {
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000197 if (p->strings && PyString_CHECK_INTERNED(v)) {
198 PyObject *o = PyDict_GetItem(p->strings, v);
199 if (o) {
200 long w = PyInt_AsLong(o);
201 w_byte(TYPE_STRINGREF, p);
202 w_long(w, p);
203 goto exit;
204 }
205 else {
206 o = PyInt_FromLong(PyDict_Size(p->strings));
207 PyDict_SetItem(p->strings, v, o);
208 Py_DECREF(o);
209 w_byte(TYPE_INTERNED, p);
210 }
211 }
212 else {
213 w_byte(TYPE_STRING, p);
214 }
Guido van Rossumc279b532000-03-10 23:03:02 +0000215 n = PyString_GET_SIZE(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000216 w_long((long)n, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000217 w_string(PyString_AS_STRING(v), n, p);
218 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000219#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000220 else if (PyUnicode_Check(v)) {
221 PyObject *utf8;
222 utf8 = PyUnicode_AsUTF8String(v);
223 if (utf8 == NULL) {
Guido van Rossum98626cd2000-06-28 23:24:19 +0000224 p->depth--;
225 p->error = 1;
226 return;
Guido van Rossumc279b532000-03-10 23:03:02 +0000227 }
228 w_byte(TYPE_UNICODE, p);
229 n = PyString_GET_SIZE(utf8);
230 w_long((long)n, p);
231 w_string(PyString_AS_STRING(utf8), n, p);
232 Py_DECREF(utf8);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000233 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000234#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +0000235 else if (PyTuple_Check(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000236 w_byte(TYPE_TUPLE, p);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000237 n = PyTuple_Size(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000238 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000239 for (i = 0; i < n; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000240 w_object(PyTuple_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000241 }
242 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000243 else if (PyList_Check(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000244 w_byte(TYPE_LIST, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000245 n = PyList_GET_SIZE(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000246 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000247 for (i = 0; i < n; i++) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000248 w_object(PyList_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000249 }
250 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000251 else if (PyDict_Check(v)) {
Guido van Rossum25831651993-05-19 14:50:45 +0000252 int pos;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000253 PyObject *key, *value;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000254 w_byte(TYPE_DICT, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000255 /* This one is NULL object terminated! */
Guido van Rossum25831651993-05-19 14:50:45 +0000256 pos = 0;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000257 while (PyDict_Next(v, &pos, &key, &value)) {
Guido van Rossum25831651993-05-19 14:50:45 +0000258 w_object(key, p);
259 w_object(value, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000260 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000261 w_object((PyObject *)NULL, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000262 }
Raymond Hettingera422c342005-01-11 03:03:27 +0000263 else if (PyAnySet_Check(v)) {
Raymond Hettingera422c342005-01-11 03:03:27 +0000264 PyObject *value, *it;
265
266 if (PyObject_TypeCheck(v, &PySet_Type))
267 w_byte(TYPE_SET, p);
268 else
269 w_byte(TYPE_FROZENSET, p);
270 n = PyObject_Size(v);
271 if (n == -1) {
272 p->depth--;
273 p->error = 1;
274 return;
275 }
276 w_long((long)n, p);
277 it = PyObject_GetIter(v);
278 if (it == NULL) {
279 p->depth--;
280 p->error = 1;
281 return;
282 }
283 while ((value = PyIter_Next(it)) != NULL) {
284 w_object(value, p);
285 Py_DECREF(value);
286 }
287 Py_DECREF(it);
288 if (PyErr_Occurred()) {
289 p->depth--;
290 p->error = 1;
291 return;
292 }
293 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000294 else if (PyCode_Check(v)) {
295 PyCodeObject *co = (PyCodeObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000296 w_byte(TYPE_CODE, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000297 w_long(co->co_argcount, p);
298 w_long(co->co_nlocals, p);
299 w_long(co->co_stacksize, p);
300 w_long(co->co_flags, p);
Guido van Rossumd076c731998-10-07 19:42:25 +0000301 w_object(co->co_code, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000302 w_object(co->co_consts, p);
303 w_object(co->co_names, p);
Guido van Rossum681d79a1995-07-18 14:51:37 +0000304 w_object(co->co_varnames, p);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000305 w_object(co->co_freevars, p);
306 w_object(co->co_cellvars, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000307 w_object(co->co_filename, p);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000308 w_object(co->co_name, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000309 w_long(co->co_firstlineno, p);
Guido van Rossumd031c891997-01-24 03:44:17 +0000310 w_object(co->co_lnotab, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000311 }
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000312 else if (PyObject_CheckReadBuffer(v)) {
Guido van Rossumd076c731998-10-07 19:42:25 +0000313 /* Write unknown buffer-style objects as a string */
314 char *s;
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000315 PyBufferProcs *pb = v->ob_type->tp_as_buffer;
Guido van Rossumd076c731998-10-07 19:42:25 +0000316 w_byte(TYPE_STRING, p);
317 n = (*pb->bf_getreadbuffer)(v, 0, (void **)&s);
318 w_long((long)n, p);
319 w_string(s, n, p);
320 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000321 else {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000322 w_byte(TYPE_UNKNOWN, p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000323 p->error = 1;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000324 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000325 exit:
Guido van Rossum98626cd2000-06-28 23:24:19 +0000326 p->depth--;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000327}
328
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000329/* version currently has no effect for writing longs. */
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000330void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000331PyMarshal_WriteLongToFile(long x, FILE *fp, int version)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000332{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000333 WFILE wf;
334 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000335 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000336 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000337 wf.strings = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000338 w_long(x, &wf);
339}
340
341void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000342PyMarshal_WriteObjectToFile(PyObject *x, FILE *fp, int version)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000343{
344 WFILE wf;
345 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000346 wf.error = 0;
Guido van Rossum98626cd2000-06-28 23:24:19 +0000347 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000348 wf.strings = (version > 0) ? PyDict_New() : NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000349 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000350 Py_XDECREF(wf.strings);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000351}
352
353typedef WFILE RFILE; /* Same struct with different invariants */
354
Guido van Rossum8d617a61995-03-09 12:12:11 +0000355#define rs_byte(p) (((p)->ptr != (p)->end) ? (unsigned char)*(p)->ptr++ : EOF)
356
357#define r_byte(p) ((p)->fp ? getc((p)->fp) : rs_byte(p))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000358
359static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000360r_string(char *s, int n, RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000361{
362 if (p->fp != NULL)
363 return fread(s, 1, n, p->fp);
364 if (p->end - p->ptr < n)
365 n = p->end - p->ptr;
366 memcpy(s, p->ptr, n);
367 p->ptr += n;
368 return n;
369}
370
371static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000372r_short(RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000373{
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000374 register short x;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000375 x = r_byte(p);
376 x |= r_byte(p) << 8;
Tim Peterse84b7402000-09-19 08:54:13 +0000377 /* Sign-extension, in case short greater than 16 bits */
378 x |= -(x & 0x8000);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000379 return x;
380}
381
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000382static long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000383r_long(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000384{
385 register long x;
Guido van Rossum8d617a61995-03-09 12:12:11 +0000386 register FILE *fp = p->fp;
387 if (fp) {
388 x = getc(fp);
389 x |= (long)getc(fp) << 8;
390 x |= (long)getc(fp) << 16;
391 x |= (long)getc(fp) << 24;
392 }
393 else {
394 x = rs_byte(p);
395 x |= (long)rs_byte(p) << 8;
396 x |= (long)rs_byte(p) << 16;
397 x |= (long)rs_byte(p) << 24;
398 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000399#if SIZEOF_LONG > 4
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000400 /* Sign extension for 64-bit machines */
Tim Peterse84b7402000-09-19 08:54:13 +0000401 x |= -(x & 0x80000000L);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000402#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000403 return x;
404}
405
Tim Peters82112372001-08-29 02:28:42 +0000406/* r_long64 deals with the TYPE_INT64 code. On a machine with
407 sizeof(long) > 4, it returns a Python int object, else a Python long
408 object. Note that w_long64 writes out TYPE_INT if 32 bits is enough,
409 so there's no inefficiency here in returning a PyLong on 32-bit boxes
410 for everything written via TYPE_INT64 (i.e., if an int is written via
411 TYPE_INT64, it *needs* more than 32 bits).
412*/
413static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000414r_long64(RFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000415{
Tim Peters82112372001-08-29 02:28:42 +0000416 long lo4 = r_long(p);
417 long hi4 = r_long(p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000418#if SIZEOF_LONG > 4
Tim Peters82112372001-08-29 02:28:42 +0000419 long x = (hi4 << 32) | (lo4 & 0xFFFFFFFFL);
420 return PyInt_FromLong(x);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000421#else
Tim Peters82112372001-08-29 02:28:42 +0000422 unsigned char buf[8];
423 int one = 1;
424 int is_little_endian = (int)*(char*)&one;
425 if (is_little_endian) {
426 memcpy(buf, &lo4, 4);
427 memcpy(buf+4, &hi4, 4);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000428 }
Tim Peters82112372001-08-29 02:28:42 +0000429 else {
430 memcpy(buf, &hi4, 4);
431 memcpy(buf+4, &lo4, 4);
432 }
433 return _PyLong_FromByteArray(buf, 8, is_little_endian, 1);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000434#endif
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000435}
436
Guido van Rossum79f25d91997-04-29 20:08:16 +0000437static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000438r_object(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000439{
Armin Rigo01ab2792004-03-26 15:09:27 +0000440 /* NULL is a valid return value, it does not necessarily means that
441 an exception is set. */
Raymond Hettingera422c342005-01-11 03:03:27 +0000442 PyObject *v, *v2, *v3;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000443 long i, n;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000444 int type = r_byte(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000445
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000446 switch (type) {
Tim Petersd9b9ac82001-01-28 00:27:39 +0000447
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000448 case EOF:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000449 PyErr_SetString(PyExc_EOFError,
450 "EOF read where object expected");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000451 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000452
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000453 case TYPE_NULL:
454 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000455
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000456 case TYPE_NONE:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000457 Py_INCREF(Py_None);
458 return Py_None;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000459
Tim Peters5ca576e2001-06-18 22:08:13 +0000460 case TYPE_STOPITER:
461 Py_INCREF(PyExc_StopIteration);
462 return PyExc_StopIteration;
463
Guido van Rossume449af71996-10-11 16:25:41 +0000464 case TYPE_ELLIPSIS:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000465 Py_INCREF(Py_Ellipsis);
Guido van Rossume449af71996-10-11 16:25:41 +0000466 return Py_Ellipsis;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000467
Guido van Rossum77f6a652002-04-03 22:41:51 +0000468 case TYPE_FALSE:
469 Py_INCREF(Py_False);
470 return Py_False;
471
472 case TYPE_TRUE:
473 Py_INCREF(Py_True);
474 return Py_True;
475
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000476 case TYPE_INT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000477 return PyInt_FromLong(r_long(p));
Tim Petersd9b9ac82001-01-28 00:27:39 +0000478
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000479 case TYPE_INT64:
Tim Peters82112372001-08-29 02:28:42 +0000480 return r_long64(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000481
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000482 case TYPE_LONG:
483 {
484 int size;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000485 PyLongObject *ob;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000486 n = r_long(p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000487 size = n<0 ? -n : n;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000488 ob = _PyLong_New(size);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000489 if (ob == NULL)
490 return NULL;
491 ob->ob_size = n;
Armin Rigo01ab2792004-03-26 15:09:27 +0000492 for (i = 0; i < size; i++) {
493 int digit = r_short(p);
494 if (digit < 0) {
495 Py_DECREF(ob);
496 PyErr_SetString(PyExc_ValueError,
497 "bad marshal data");
498 return NULL;
499 }
500 ob->ob_digit[i] = digit;
501 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000502 return (PyObject *)ob;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000503 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000504
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000505 case TYPE_FLOAT:
506 {
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000507 char buf[256];
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000508 double dx;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000509 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000510 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000511 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000512 "EOF read where object expected");
513 return NULL;
514 }
515 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000516 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000517 dx = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000518 PyFPE_END_PROTECT(dx)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000519 return PyFloat_FromDouble(dx);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000520 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000521
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000522#ifndef WITHOUT_COMPLEX
523 case TYPE_COMPLEX:
524 {
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000525 char buf[256];
Guido van Rossum530956d1996-07-21 02:27:43 +0000526 Py_complex c;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000527 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000528 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000529 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000530 "EOF read where object expected");
531 return NULL;
532 }
533 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000534 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000535 c.real = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000536 PyFPE_END_PROTECT(c)
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000537 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000538 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000539 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000540 "EOF read where object expected");
541 return NULL;
542 }
543 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000544 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000545 c.imag = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000546 PyFPE_END_PROTECT(c)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000547 return PyComplex_FromCComplex(c);
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000548 }
549#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000550
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000551 case TYPE_INTERNED:
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000552 case TYPE_STRING:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000553 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000554 if (n < 0) {
555 PyErr_SetString(PyExc_ValueError, "bad marshal data");
556 return NULL;
557 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000558 v = PyString_FromStringAndSize((char *)NULL, n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000559 if (v != NULL) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000560 if (r_string(PyString_AS_STRING(v), (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000561 Py_DECREF(v);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000562 v = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000563 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000564 "EOF read where object expected");
565 }
566 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000567 if (type == TYPE_INTERNED) {
568 PyString_InternInPlace(&v);
569 PyList_Append(p->strings, v);
570 }
571 return v;
572
573 case TYPE_STRINGREF:
574 n = r_long(p);
575 v = PyList_GET_ITEM(p->strings, n);
576 Py_INCREF(v);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000577 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000578
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000579#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000580 case TYPE_UNICODE:
581 {
582 char *buffer;
583
584 n = r_long(p);
585 if (n < 0) {
586 PyErr_SetString(PyExc_ValueError, "bad marshal data");
587 return NULL;
588 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000589 buffer = PyMem_NEW(char, n);
Guido van Rossumc279b532000-03-10 23:03:02 +0000590 if (buffer == NULL)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000591 return PyErr_NoMemory();
Guido van Rossumc279b532000-03-10 23:03:02 +0000592 if (r_string(buffer, (int)n, p) != n) {
Guido van Rossumb18618d2000-05-03 23:44:39 +0000593 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000594 PyErr_SetString(PyExc_EOFError,
595 "EOF read where object expected");
596 return NULL;
597 }
598 v = PyUnicode_DecodeUTF8(buffer, n, NULL);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000599 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000600 return v;
601 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000602#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000603
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000604 case TYPE_TUPLE:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000605 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000606 if (n < 0) {
607 PyErr_SetString(PyExc_ValueError, "bad marshal data");
608 return NULL;
609 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000610 v = PyTuple_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000611 if (v == NULL)
612 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000613 for (i = 0; i < n; i++) {
614 v2 = r_object(p);
615 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000616 if (!PyErr_Occurred())
617 PyErr_SetString(PyExc_TypeError,
618 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000619 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000620 v = NULL;
621 break;
622 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000623 PyTuple_SET_ITEM(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000624 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000625 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000626
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000627 case TYPE_LIST:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000628 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000629 if (n < 0) {
630 PyErr_SetString(PyExc_ValueError, "bad marshal data");
631 return NULL;
632 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000633 v = PyList_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000634 if (v == NULL)
635 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000636 for (i = 0; i < n; i++) {
637 v2 = r_object(p);
638 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000639 if (!PyErr_Occurred())
640 PyErr_SetString(PyExc_TypeError,
641 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000642 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000643 v = NULL;
644 break;
645 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000646 PyList_SetItem(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000647 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000648 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000649
Guido van Rossum64b45521991-06-07 13:58:22 +0000650 case TYPE_DICT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000651 v = PyDict_New();
Guido van Rossum64b45521991-06-07 13:58:22 +0000652 if (v == NULL)
653 return NULL;
654 for (;;) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000655 PyObject *key, *val;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000656 key = r_object(p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000657 if (key == NULL)
Armin Rigo01ab2792004-03-26 15:09:27 +0000658 break;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000659 val = r_object(p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000660 if (val != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000661 PyDict_SetItem(v, key, val);
662 Py_DECREF(key);
663 Py_XDECREF(val);
Guido van Rossum64b45521991-06-07 13:58:22 +0000664 }
Armin Rigo01ab2792004-03-26 15:09:27 +0000665 if (PyErr_Occurred()) {
666 Py_DECREF(v);
667 v = NULL;
668 }
Guido van Rossum64b45521991-06-07 13:58:22 +0000669 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000670
Raymond Hettingera422c342005-01-11 03:03:27 +0000671 case TYPE_SET:
672 case TYPE_FROZENSET:
673 n = r_long(p);
674 if (n < 0) {
675 PyErr_SetString(PyExc_ValueError, "bad marshal data");
676 return NULL;
677 }
678 v = PyTuple_New((int)n);
679 if (v == NULL)
680 return v;
681 for (i = 0; i < n; i++) {
682 v2 = r_object(p);
683 if ( v2 == NULL ) {
684 if (!PyErr_Occurred())
685 PyErr_SetString(PyExc_TypeError,
686 "NULL object in marshal data");
687 Py_DECREF(v);
688 v = NULL;
689 break;
690 }
691 PyTuple_SET_ITEM(v, (int)i, v2);
692 }
693 if (type == TYPE_SET)
694 v3 = PyObject_CallFunctionObjArgs(
695 (PyObject *)&PySet_Type, v, NULL);
696 else
697 v3 = PyObject_CallFunctionObjArgs(
698 (PyObject *)&PyFrozenSet_Type, v, NULL);
699 Py_DECREF(v);
700 return v3;
701
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000702 case TYPE_CODE:
Michael W. Hudson80199132001-08-30 14:50:20 +0000703 if (PyEval_GetRestricted()) {
704 PyErr_SetString(PyExc_RuntimeError,
705 "cannot unmarshal code objects in "
706 "restricted execution mode");
707 return NULL;
708 }
709 else {
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000710 int argcount = r_long(p);
711 int nlocals = r_long(p);
712 int stacksize = r_long(p);
713 int flags = r_long(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000714 PyObject *code = r_object(p);
715 PyObject *consts = r_object(p);
716 PyObject *names = r_object(p);
717 PyObject *varnames = r_object(p);
718 PyObject *freevars = r_object(p);
719 PyObject *cellvars = r_object(p);
720 PyObject *filename = r_object(p);
721 PyObject *name = r_object(p);
722 int firstlineno = r_long(p);
723 PyObject *lnotab = r_object(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000724
Guido van Rossum79f25d91997-04-29 20:08:16 +0000725 if (!PyErr_Occurred()) {
726 v = (PyObject *) PyCode_New(
Tim Petersd9b9ac82001-01-28 00:27:39 +0000727 argcount, nlocals, stacksize, flags,
Guido van Rossum681d79a1995-07-18 14:51:37 +0000728 code, consts, names, varnames,
Tim Petersd9b9ac82001-01-28 00:27:39 +0000729 freevars, cellvars, filename, name,
730 firstlineno, lnotab);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000731 }
732 else
733 v = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000734 Py_XDECREF(code);
735 Py_XDECREF(consts);
736 Py_XDECREF(names);
737 Py_XDECREF(varnames);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000738 Py_XDECREF(freevars);
739 Py_XDECREF(cellvars);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000740 Py_XDECREF(filename);
741 Py_XDECREF(name);
Guido van Rossum6fc06e71997-07-26 23:30:18 +0000742 Py_XDECREF(lnotab);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000743
744 }
745 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000746
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000747 default:
Guido van Rossumf2150601996-06-26 20:41:23 +0000748 /* Bogus data got written, which isn't ideal.
749 This will let you keep working and recover. */
Guido van Rossuma45cb451998-06-08 20:27:29 +0000750 PyErr_SetString(PyExc_ValueError, "bad marshal data");
751 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000752
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000753 }
754}
755
Neal Norwitzd85c4522004-06-13 20:31:49 +0000756static PyObject *
Armin Rigo01ab2792004-03-26 15:09:27 +0000757read_object(RFILE *p)
758{
759 PyObject *v;
760 if (PyErr_Occurred()) {
761 fprintf(stderr, "XXX readobject called with exception set\n");
762 return NULL;
763 }
764 v = r_object(p);
765 if (v == NULL && !PyErr_Occurred())
766 PyErr_SetString(PyExc_TypeError, "NULL object in marshal data");
767 return v;
768}
769
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000770int
771PyMarshal_ReadShortFromFile(FILE *fp)
772{
773 RFILE rf;
774 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000775 rf.strings = NULL;
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000776 return r_short(&rf);
777}
778
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000779long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000780PyMarshal_ReadLongFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000781{
782 RFILE rf;
783 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000784 rf.strings = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000785 return r_long(&rf);
786}
787
Tim Peters691e0e92001-01-18 04:39:16 +0000788#ifdef HAVE_FSTAT
789/* Return size of file in bytes; < 0 if unknown. */
790static off_t
791getfilesize(FILE *fp)
792{
793 struct stat st;
794 if (fstat(fileno(fp), &st) != 0)
795 return -1;
796 else
797 return st.st_size;
798}
799#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000800
Tim Peters691e0e92001-01-18 04:39:16 +0000801/* If we can get the size of the file up-front, and it's reasonably small,
802 * read it in one gulp and delegate to ...FromString() instead. Much quicker
803 * than reading a byte at a time from file; speeds .pyc imports.
Tim Petersd9b9ac82001-01-28 00:27:39 +0000804 * CAUTION: since this may read the entire remainder of the file, don't
805 * call it unless you know you're done with the file.
Tim Peters691e0e92001-01-18 04:39:16 +0000806 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000807PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000808PyMarshal_ReadLastObjectFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000809{
Tim Peters691e0e92001-01-18 04:39:16 +0000810/* 75% of 2.1's .pyc files can exploit SMALL_FILE_LIMIT.
811 * REASONABLE_FILE_LIMIT is by defn something big enough for Tkinter.pyc.
812 */
813#define SMALL_FILE_LIMIT (1L << 14)
814#define REASONABLE_FILE_LIMIT (1L << 18)
Tim Peters691e0e92001-01-18 04:39:16 +0000815#ifdef HAVE_FSTAT
816 off_t filesize;
817#endif
Tim Peters691e0e92001-01-18 04:39:16 +0000818#ifdef HAVE_FSTAT
819 filesize = getfilesize(fp);
820 if (filesize > 0) {
821 char buf[SMALL_FILE_LIMIT];
822 char* pBuf = NULL;
823 if (filesize <= SMALL_FILE_LIMIT)
824 pBuf = buf;
825 else if (filesize <= REASONABLE_FILE_LIMIT)
826 pBuf = (char *)PyMem_MALLOC(filesize);
827 if (pBuf != NULL) {
828 PyObject* v;
829 size_t n = fread(pBuf, 1, filesize, fp);
830 v = PyMarshal_ReadObjectFromString(pBuf, n);
831 if (pBuf != buf)
832 PyMem_FREE(pBuf);
833 return v;
834 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000835
Tim Peters691e0e92001-01-18 04:39:16 +0000836 }
837#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000838 /* We don't have fstat, or we do but the file is larger than
839 * REASONABLE_FILE_LIMIT or malloc failed -- read a byte at a time.
840 */
841 return PyMarshal_ReadObjectFromFile(fp);
842
Tim Peters691e0e92001-01-18 04:39:16 +0000843#undef SMALL_FILE_LIMIT
844#undef REASONABLE_FILE_LIMIT
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000845}
846
Guido van Rossum79f25d91997-04-29 20:08:16 +0000847PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000848PyMarshal_ReadObjectFromFile(FILE *fp)
849{
850 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000851 PyObject *result;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000852 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000853 rf.strings = PyList_New(0);
854 result = r_object(&rf);
855 Py_DECREF(rf.strings);
856 return result;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000857}
858
859PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000860PyMarshal_ReadObjectFromString(char *str, int len)
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000861{
862 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000863 PyObject *result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000864 rf.fp = NULL;
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000865 rf.ptr = str;
866 rf.end = str + len;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000867 rf.strings = PyList_New(0);
868 result = r_object(&rf);
869 Py_DECREF(rf.strings);
870 return result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000871}
872
Guido van Rossum79f25d91997-04-29 20:08:16 +0000873PyObject *
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000874PyMarshal_WriteObjectToString(PyObject *x, int version)
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000875{
876 WFILE wf;
877 wf.fp = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000878 wf.str = PyString_FromStringAndSize((char *)NULL, 50);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000879 if (wf.str == NULL)
880 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000881 wf.ptr = PyString_AS_STRING((PyStringObject *)wf.str);
882 wf.end = wf.ptr + PyString_Size(wf.str);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000883 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000884 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000885 wf.strings = (version > 0) ? PyDict_New() : NULL;
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000886 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000887 Py_XDECREF(wf.strings);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000888 if (wf.str != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000889 _PyString_Resize(&wf.str,
890 (int) (wf.ptr -
891 PyString_AS_STRING((PyStringObject *)wf.str)));
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000892 if (wf.error) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000893 Py_XDECREF(wf.str);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000894 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +0000895 (wf.error==1)?"unmarshallable object"
896 :"object too deeply nested to marshal");
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000897 return NULL;
898 }
899 return wf.str;
900}
901
Guido van Rossum64b45521991-06-07 13:58:22 +0000902/* And an interface for Python programs... */
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000903
Guido van Rossum79f25d91997-04-29 20:08:16 +0000904static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000905marshal_dump(PyObject *self, PyObject *args)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000906{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000907 WFILE wf;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000908 PyObject *x;
909 PyObject *f;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000910 int version = Py_MARSHAL_VERSION;
911 if (!PyArg_ParseTuple(args, "OO|i:dump", &x, &f, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000912 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000913 if (!PyFile_Check(f)) {
914 PyErr_SetString(PyExc_TypeError,
915 "marshal.dump() 2nd arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000916 return NULL;
917 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000918 wf.fp = PyFile_AsFile(f);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000919 wf.str = NULL;
920 wf.ptr = wf.end = NULL;
Guido van Rossumf2150601996-06-26 20:41:23 +0000921 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000922 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000923 wf.strings = (version > 0) ? PyDict_New() : 0;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000924 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000925 Py_XDECREF(wf.strings);
Guido van Rossumf2150601996-06-26 20:41:23 +0000926 if (wf.error) {
Tim Petersd9b9ac82001-01-28 00:27:39 +0000927 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +0000928 (wf.error==1)?"unmarshallable object"
929 :"object too deeply nested to marshal");
Guido van Rossumf2150601996-06-26 20:41:23 +0000930 return NULL;
931 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000932 Py_INCREF(Py_None);
933 return Py_None;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000934}
935
Guido van Rossum79f25d91997-04-29 20:08:16 +0000936static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000937marshal_load(PyObject *self, PyObject *args)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000938{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000939 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000940 PyObject *f, *result;
Guido van Rossum2efa3692000-03-31 00:37:41 +0000941 if (!PyArg_ParseTuple(args, "O:load", &f))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000942 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000943 if (!PyFile_Check(f)) {
944 PyErr_SetString(PyExc_TypeError,
945 "marshal.load() arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000946 return NULL;
947 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000948 rf.fp = PyFile_AsFile(f);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000949 rf.strings = PyList_New(0);
950 result = read_object(&rf);
951 Py_DECREF(rf.strings);
952 return result;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000953}
954
Guido van Rossum79f25d91997-04-29 20:08:16 +0000955static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000956marshal_dumps(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000957{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000958 PyObject *x;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000959 int version = Py_MARSHAL_VERSION;
Armin Rigo2ccea172004-12-20 12:25:57 +0000960 if (!PyArg_ParseTuple(args, "O|i:dumps", &x, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000961 return NULL;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000962 return PyMarshal_WriteObjectToString(x, version);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000963}
964
Guido van Rossum79f25d91997-04-29 20:08:16 +0000965static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000966marshal_loads(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000967{
968 RFILE rf;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000969 char *s;
970 int n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000971 PyObject* result;
972 if (!PyArg_ParseTuple(args, "s#|i:loads", &s, &n))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000973 return NULL;
974 rf.fp = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000975 rf.ptr = s;
976 rf.end = s + n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000977 rf.strings = PyList_New(0);
978 result = read_object(&rf);
979 Py_DECREF(rf.strings);
980 return result;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000981}
982
Guido van Rossum79f25d91997-04-29 20:08:16 +0000983static PyMethodDef marshal_methods[] = {
Neal Norwitz031829d2002-03-31 14:37:44 +0000984 {"dump", marshal_dump, METH_VARARGS},
985 {"load", marshal_load, METH_VARARGS},
986 {"dumps", marshal_dumps, METH_VARARGS},
987 {"loads", marshal_loads, METH_VARARGS},
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000988 {NULL, NULL} /* sentinel */
989};
990
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000991PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000992PyMarshal_Init(void)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000993{
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000994 PyObject *mod = Py_InitModule("marshal", marshal_methods);
995 PyModule_AddIntConstant(mod, "version", Py_MARSHAL_VERSION);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000996}