blob: 2f0a6427a6ae933420ee40f9b88b6505fee2173a [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)) {
264 int pos;
265 PyObject *value, *it;
266
267 if (PyObject_TypeCheck(v, &PySet_Type))
268 w_byte(TYPE_SET, p);
269 else
270 w_byte(TYPE_FROZENSET, p);
271 n = PyObject_Size(v);
272 if (n == -1) {
273 p->depth--;
274 p->error = 1;
275 return;
276 }
277 w_long((long)n, p);
278 it = PyObject_GetIter(v);
279 if (it == NULL) {
280 p->depth--;
281 p->error = 1;
282 return;
283 }
284 while ((value = PyIter_Next(it)) != NULL) {
285 w_object(value, p);
286 Py_DECREF(value);
287 }
288 Py_DECREF(it);
289 if (PyErr_Occurred()) {
290 p->depth--;
291 p->error = 1;
292 return;
293 }
294 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000295 else if (PyCode_Check(v)) {
296 PyCodeObject *co = (PyCodeObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000297 w_byte(TYPE_CODE, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000298 w_long(co->co_argcount, p);
299 w_long(co->co_nlocals, p);
300 w_long(co->co_stacksize, p);
301 w_long(co->co_flags, p);
Guido van Rossumd076c731998-10-07 19:42:25 +0000302 w_object(co->co_code, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000303 w_object(co->co_consts, p);
304 w_object(co->co_names, p);
Guido van Rossum681d79a1995-07-18 14:51:37 +0000305 w_object(co->co_varnames, p);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000306 w_object(co->co_freevars, p);
307 w_object(co->co_cellvars, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000308 w_object(co->co_filename, p);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000309 w_object(co->co_name, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000310 w_long(co->co_firstlineno, p);
Guido van Rossumd031c891997-01-24 03:44:17 +0000311 w_object(co->co_lnotab, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000312 }
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000313 else if (PyObject_CheckReadBuffer(v)) {
Guido van Rossumd076c731998-10-07 19:42:25 +0000314 /* Write unknown buffer-style objects as a string */
315 char *s;
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000316 PyBufferProcs *pb = v->ob_type->tp_as_buffer;
Guido van Rossumd076c731998-10-07 19:42:25 +0000317 w_byte(TYPE_STRING, p);
318 n = (*pb->bf_getreadbuffer)(v, 0, (void **)&s);
319 w_long((long)n, p);
320 w_string(s, n, p);
321 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000322 else {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000323 w_byte(TYPE_UNKNOWN, p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000324 p->error = 1;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000325 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000326 exit:
Guido van Rossum98626cd2000-06-28 23:24:19 +0000327 p->depth--;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000328}
329
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000330/* version currently has no effect for writing longs. */
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000331void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000332PyMarshal_WriteLongToFile(long x, FILE *fp, int version)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000333{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000334 WFILE wf;
335 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000336 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000337 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000338 wf.strings = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000339 w_long(x, &wf);
340}
341
342void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000343PyMarshal_WriteObjectToFile(PyObject *x, FILE *fp, int version)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000344{
345 WFILE wf;
346 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000347 wf.error = 0;
Guido van Rossum98626cd2000-06-28 23:24:19 +0000348 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000349 wf.strings = (version > 0) ? PyDict_New() : NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000350 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000351 Py_XDECREF(wf.strings);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000352}
353
354typedef WFILE RFILE; /* Same struct with different invariants */
355
Guido van Rossum8d617a61995-03-09 12:12:11 +0000356#define rs_byte(p) (((p)->ptr != (p)->end) ? (unsigned char)*(p)->ptr++ : EOF)
357
358#define r_byte(p) ((p)->fp ? getc((p)->fp) : rs_byte(p))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000359
360static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000361r_string(char *s, int n, RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000362{
363 if (p->fp != NULL)
364 return fread(s, 1, n, p->fp);
365 if (p->end - p->ptr < n)
366 n = p->end - p->ptr;
367 memcpy(s, p->ptr, n);
368 p->ptr += n;
369 return n;
370}
371
372static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000373r_short(RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000374{
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000375 register short x;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000376 x = r_byte(p);
377 x |= r_byte(p) << 8;
Tim Peterse84b7402000-09-19 08:54:13 +0000378 /* Sign-extension, in case short greater than 16 bits */
379 x |= -(x & 0x8000);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000380 return x;
381}
382
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000383static long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000384r_long(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000385{
386 register long x;
Guido van Rossum8d617a61995-03-09 12:12:11 +0000387 register FILE *fp = p->fp;
388 if (fp) {
389 x = getc(fp);
390 x |= (long)getc(fp) << 8;
391 x |= (long)getc(fp) << 16;
392 x |= (long)getc(fp) << 24;
393 }
394 else {
395 x = rs_byte(p);
396 x |= (long)rs_byte(p) << 8;
397 x |= (long)rs_byte(p) << 16;
398 x |= (long)rs_byte(p) << 24;
399 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000400#if SIZEOF_LONG > 4
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000401 /* Sign extension for 64-bit machines */
Tim Peterse84b7402000-09-19 08:54:13 +0000402 x |= -(x & 0x80000000L);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000403#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000404 return x;
405}
406
Tim Peters82112372001-08-29 02:28:42 +0000407/* r_long64 deals with the TYPE_INT64 code. On a machine with
408 sizeof(long) > 4, it returns a Python int object, else a Python long
409 object. Note that w_long64 writes out TYPE_INT if 32 bits is enough,
410 so there's no inefficiency here in returning a PyLong on 32-bit boxes
411 for everything written via TYPE_INT64 (i.e., if an int is written via
412 TYPE_INT64, it *needs* more than 32 bits).
413*/
414static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000415r_long64(RFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000416{
Tim Peters82112372001-08-29 02:28:42 +0000417 long lo4 = r_long(p);
418 long hi4 = r_long(p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000419#if SIZEOF_LONG > 4
Tim Peters82112372001-08-29 02:28:42 +0000420 long x = (hi4 << 32) | (lo4 & 0xFFFFFFFFL);
421 return PyInt_FromLong(x);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000422#else
Tim Peters82112372001-08-29 02:28:42 +0000423 unsigned char buf[8];
424 int one = 1;
425 int is_little_endian = (int)*(char*)&one;
426 if (is_little_endian) {
427 memcpy(buf, &lo4, 4);
428 memcpy(buf+4, &hi4, 4);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000429 }
Tim Peters82112372001-08-29 02:28:42 +0000430 else {
431 memcpy(buf, &hi4, 4);
432 memcpy(buf+4, &lo4, 4);
433 }
434 return _PyLong_FromByteArray(buf, 8, is_little_endian, 1);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000435#endif
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000436}
437
Guido van Rossum79f25d91997-04-29 20:08:16 +0000438static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000439r_object(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000440{
Armin Rigo01ab2792004-03-26 15:09:27 +0000441 /* NULL is a valid return value, it does not necessarily means that
442 an exception is set. */
Raymond Hettingera422c342005-01-11 03:03:27 +0000443 PyObject *v, *v2, *v3;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000444 long i, n;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000445 int type = r_byte(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000446
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000447 switch (type) {
Tim Petersd9b9ac82001-01-28 00:27:39 +0000448
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000449 case EOF:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000450 PyErr_SetString(PyExc_EOFError,
451 "EOF read where object expected");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000452 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000453
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000454 case TYPE_NULL:
455 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000456
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000457 case TYPE_NONE:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000458 Py_INCREF(Py_None);
459 return Py_None;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000460
Tim Peters5ca576e2001-06-18 22:08:13 +0000461 case TYPE_STOPITER:
462 Py_INCREF(PyExc_StopIteration);
463 return PyExc_StopIteration;
464
Guido van Rossume449af71996-10-11 16:25:41 +0000465 case TYPE_ELLIPSIS:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000466 Py_INCREF(Py_Ellipsis);
Guido van Rossume449af71996-10-11 16:25:41 +0000467 return Py_Ellipsis;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000468
Guido van Rossum77f6a652002-04-03 22:41:51 +0000469 case TYPE_FALSE:
470 Py_INCREF(Py_False);
471 return Py_False;
472
473 case TYPE_TRUE:
474 Py_INCREF(Py_True);
475 return Py_True;
476
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000477 case TYPE_INT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000478 return PyInt_FromLong(r_long(p));
Tim Petersd9b9ac82001-01-28 00:27:39 +0000479
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000480 case TYPE_INT64:
Tim Peters82112372001-08-29 02:28:42 +0000481 return r_long64(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000482
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000483 case TYPE_LONG:
484 {
485 int size;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000486 PyLongObject *ob;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000487 n = r_long(p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000488 size = n<0 ? -n : n;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000489 ob = _PyLong_New(size);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000490 if (ob == NULL)
491 return NULL;
492 ob->ob_size = n;
Armin Rigo01ab2792004-03-26 15:09:27 +0000493 for (i = 0; i < size; i++) {
494 int digit = r_short(p);
495 if (digit < 0) {
496 Py_DECREF(ob);
497 PyErr_SetString(PyExc_ValueError,
498 "bad marshal data");
499 return NULL;
500 }
501 ob->ob_digit[i] = digit;
502 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000503 return (PyObject *)ob;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000504 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000505
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000506 case TYPE_FLOAT:
507 {
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000508 char buf[256];
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000509 double dx;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000510 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000511 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000512 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000513 "EOF read where object expected");
514 return NULL;
515 }
516 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000517 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000518 dx = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000519 PyFPE_END_PROTECT(dx)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000520 return PyFloat_FromDouble(dx);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000521 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000522
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000523#ifndef WITHOUT_COMPLEX
524 case TYPE_COMPLEX:
525 {
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000526 char buf[256];
Guido van Rossum530956d1996-07-21 02:27:43 +0000527 Py_complex c;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000528 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000529 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000530 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000531 "EOF read where object expected");
532 return NULL;
533 }
534 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000535 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000536 c.real = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000537 PyFPE_END_PROTECT(c)
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000538 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000539 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000540 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000541 "EOF read where object expected");
542 return NULL;
543 }
544 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000545 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000546 c.imag = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000547 PyFPE_END_PROTECT(c)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000548 return PyComplex_FromCComplex(c);
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000549 }
550#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000551
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000552 case TYPE_INTERNED:
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000553 case TYPE_STRING:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000554 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000555 if (n < 0) {
556 PyErr_SetString(PyExc_ValueError, "bad marshal data");
557 return NULL;
558 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000559 v = PyString_FromStringAndSize((char *)NULL, n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000560 if (v != NULL) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000561 if (r_string(PyString_AS_STRING(v), (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000562 Py_DECREF(v);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000563 v = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000564 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000565 "EOF read where object expected");
566 }
567 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000568 if (type == TYPE_INTERNED) {
569 PyString_InternInPlace(&v);
570 PyList_Append(p->strings, v);
571 }
572 return v;
573
574 case TYPE_STRINGREF:
575 n = r_long(p);
576 v = PyList_GET_ITEM(p->strings, n);
577 Py_INCREF(v);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000578 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000579
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000580#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000581 case TYPE_UNICODE:
582 {
583 char *buffer;
584
585 n = r_long(p);
586 if (n < 0) {
587 PyErr_SetString(PyExc_ValueError, "bad marshal data");
588 return NULL;
589 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000590 buffer = PyMem_NEW(char, n);
Guido van Rossumc279b532000-03-10 23:03:02 +0000591 if (buffer == NULL)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000592 return PyErr_NoMemory();
Guido van Rossumc279b532000-03-10 23:03:02 +0000593 if (r_string(buffer, (int)n, p) != n) {
Guido van Rossumb18618d2000-05-03 23:44:39 +0000594 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000595 PyErr_SetString(PyExc_EOFError,
596 "EOF read where object expected");
597 return NULL;
598 }
599 v = PyUnicode_DecodeUTF8(buffer, n, NULL);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000600 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000601 return v;
602 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000603#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000604
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000605 case TYPE_TUPLE:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000606 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000607 if (n < 0) {
608 PyErr_SetString(PyExc_ValueError, "bad marshal data");
609 return NULL;
610 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000611 v = PyTuple_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000612 if (v == NULL)
613 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000614 for (i = 0; i < n; i++) {
615 v2 = r_object(p);
616 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000617 if (!PyErr_Occurred())
618 PyErr_SetString(PyExc_TypeError,
619 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000620 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000621 v = NULL;
622 break;
623 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000624 PyTuple_SET_ITEM(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000625 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000626 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000627
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000628 case TYPE_LIST:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000629 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000630 if (n < 0) {
631 PyErr_SetString(PyExc_ValueError, "bad marshal data");
632 return NULL;
633 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000634 v = PyList_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000635 if (v == NULL)
636 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000637 for (i = 0; i < n; i++) {
638 v2 = r_object(p);
639 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000640 if (!PyErr_Occurred())
641 PyErr_SetString(PyExc_TypeError,
642 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000643 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000644 v = NULL;
645 break;
646 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000647 PyList_SetItem(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000648 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000649 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000650
Guido van Rossum64b45521991-06-07 13:58:22 +0000651 case TYPE_DICT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000652 v = PyDict_New();
Guido van Rossum64b45521991-06-07 13:58:22 +0000653 if (v == NULL)
654 return NULL;
655 for (;;) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000656 PyObject *key, *val;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000657 key = r_object(p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000658 if (key == NULL)
Armin Rigo01ab2792004-03-26 15:09:27 +0000659 break;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000660 val = r_object(p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000661 if (val != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000662 PyDict_SetItem(v, key, val);
663 Py_DECREF(key);
664 Py_XDECREF(val);
Guido van Rossum64b45521991-06-07 13:58:22 +0000665 }
Armin Rigo01ab2792004-03-26 15:09:27 +0000666 if (PyErr_Occurred()) {
667 Py_DECREF(v);
668 v = NULL;
669 }
Guido van Rossum64b45521991-06-07 13:58:22 +0000670 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000671
Raymond Hettingera422c342005-01-11 03:03:27 +0000672 case TYPE_SET:
673 case TYPE_FROZENSET:
674 n = r_long(p);
675 if (n < 0) {
676 PyErr_SetString(PyExc_ValueError, "bad marshal data");
677 return NULL;
678 }
679 v = PyTuple_New((int)n);
680 if (v == NULL)
681 return v;
682 for (i = 0; i < n; i++) {
683 v2 = r_object(p);
684 if ( v2 == NULL ) {
685 if (!PyErr_Occurred())
686 PyErr_SetString(PyExc_TypeError,
687 "NULL object in marshal data");
688 Py_DECREF(v);
689 v = NULL;
690 break;
691 }
692 PyTuple_SET_ITEM(v, (int)i, v2);
693 }
694 if (type == TYPE_SET)
695 v3 = PyObject_CallFunctionObjArgs(
696 (PyObject *)&PySet_Type, v, NULL);
697 else
698 v3 = PyObject_CallFunctionObjArgs(
699 (PyObject *)&PyFrozenSet_Type, v, NULL);
700 Py_DECREF(v);
701 return v3;
702
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000703 case TYPE_CODE:
Michael W. Hudson80199132001-08-30 14:50:20 +0000704 if (PyEval_GetRestricted()) {
705 PyErr_SetString(PyExc_RuntimeError,
706 "cannot unmarshal code objects in "
707 "restricted execution mode");
708 return NULL;
709 }
710 else {
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000711 int argcount = r_long(p);
712 int nlocals = r_long(p);
713 int stacksize = r_long(p);
714 int flags = r_long(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000715 PyObject *code = r_object(p);
716 PyObject *consts = r_object(p);
717 PyObject *names = r_object(p);
718 PyObject *varnames = r_object(p);
719 PyObject *freevars = r_object(p);
720 PyObject *cellvars = r_object(p);
721 PyObject *filename = r_object(p);
722 PyObject *name = r_object(p);
723 int firstlineno = r_long(p);
724 PyObject *lnotab = r_object(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000725
Guido van Rossum79f25d91997-04-29 20:08:16 +0000726 if (!PyErr_Occurred()) {
727 v = (PyObject *) PyCode_New(
Tim Petersd9b9ac82001-01-28 00:27:39 +0000728 argcount, nlocals, stacksize, flags,
Guido van Rossum681d79a1995-07-18 14:51:37 +0000729 code, consts, names, varnames,
Tim Petersd9b9ac82001-01-28 00:27:39 +0000730 freevars, cellvars, filename, name,
731 firstlineno, lnotab);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000732 }
733 else
734 v = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000735 Py_XDECREF(code);
736 Py_XDECREF(consts);
737 Py_XDECREF(names);
738 Py_XDECREF(varnames);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000739 Py_XDECREF(freevars);
740 Py_XDECREF(cellvars);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000741 Py_XDECREF(filename);
742 Py_XDECREF(name);
Guido van Rossum6fc06e71997-07-26 23:30:18 +0000743 Py_XDECREF(lnotab);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000744
745 }
746 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000747
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000748 default:
Guido van Rossumf2150601996-06-26 20:41:23 +0000749 /* Bogus data got written, which isn't ideal.
750 This will let you keep working and recover. */
Guido van Rossuma45cb451998-06-08 20:27:29 +0000751 PyErr_SetString(PyExc_ValueError, "bad marshal data");
752 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000753
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000754 }
755}
756
Neal Norwitzd85c4522004-06-13 20:31:49 +0000757static PyObject *
Armin Rigo01ab2792004-03-26 15:09:27 +0000758read_object(RFILE *p)
759{
760 PyObject *v;
761 if (PyErr_Occurred()) {
762 fprintf(stderr, "XXX readobject called with exception set\n");
763 return NULL;
764 }
765 v = r_object(p);
766 if (v == NULL && !PyErr_Occurred())
767 PyErr_SetString(PyExc_TypeError, "NULL object in marshal data");
768 return v;
769}
770
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000771int
772PyMarshal_ReadShortFromFile(FILE *fp)
773{
774 RFILE rf;
775 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000776 rf.strings = NULL;
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000777 return r_short(&rf);
778}
779
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000780long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000781PyMarshal_ReadLongFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000782{
783 RFILE rf;
784 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000785 rf.strings = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000786 return r_long(&rf);
787}
788
Tim Peters691e0e92001-01-18 04:39:16 +0000789#ifdef HAVE_FSTAT
790/* Return size of file in bytes; < 0 if unknown. */
791static off_t
792getfilesize(FILE *fp)
793{
794 struct stat st;
795 if (fstat(fileno(fp), &st) != 0)
796 return -1;
797 else
798 return st.st_size;
799}
800#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000801
Tim Peters691e0e92001-01-18 04:39:16 +0000802/* If we can get the size of the file up-front, and it's reasonably small,
803 * read it in one gulp and delegate to ...FromString() instead. Much quicker
804 * than reading a byte at a time from file; speeds .pyc imports.
Tim Petersd9b9ac82001-01-28 00:27:39 +0000805 * CAUTION: since this may read the entire remainder of the file, don't
806 * call it unless you know you're done with the file.
Tim Peters691e0e92001-01-18 04:39:16 +0000807 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000808PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000809PyMarshal_ReadLastObjectFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000810{
Tim Peters691e0e92001-01-18 04:39:16 +0000811/* 75% of 2.1's .pyc files can exploit SMALL_FILE_LIMIT.
812 * REASONABLE_FILE_LIMIT is by defn something big enough for Tkinter.pyc.
813 */
814#define SMALL_FILE_LIMIT (1L << 14)
815#define REASONABLE_FILE_LIMIT (1L << 18)
Tim Peters691e0e92001-01-18 04:39:16 +0000816#ifdef HAVE_FSTAT
817 off_t filesize;
818#endif
Tim Peters691e0e92001-01-18 04:39:16 +0000819#ifdef HAVE_FSTAT
820 filesize = getfilesize(fp);
821 if (filesize > 0) {
822 char buf[SMALL_FILE_LIMIT];
823 char* pBuf = NULL;
824 if (filesize <= SMALL_FILE_LIMIT)
825 pBuf = buf;
826 else if (filesize <= REASONABLE_FILE_LIMIT)
827 pBuf = (char *)PyMem_MALLOC(filesize);
828 if (pBuf != NULL) {
829 PyObject* v;
830 size_t n = fread(pBuf, 1, filesize, fp);
831 v = PyMarshal_ReadObjectFromString(pBuf, n);
832 if (pBuf != buf)
833 PyMem_FREE(pBuf);
834 return v;
835 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000836
Tim Peters691e0e92001-01-18 04:39:16 +0000837 }
838#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000839 /* We don't have fstat, or we do but the file is larger than
840 * REASONABLE_FILE_LIMIT or malloc failed -- read a byte at a time.
841 */
842 return PyMarshal_ReadObjectFromFile(fp);
843
Tim Peters691e0e92001-01-18 04:39:16 +0000844#undef SMALL_FILE_LIMIT
845#undef REASONABLE_FILE_LIMIT
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000846}
847
Guido van Rossum79f25d91997-04-29 20:08:16 +0000848PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000849PyMarshal_ReadObjectFromFile(FILE *fp)
850{
851 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000852 PyObject *result;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000853 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000854 rf.strings = PyList_New(0);
855 result = r_object(&rf);
856 Py_DECREF(rf.strings);
857 return result;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000858}
859
860PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000861PyMarshal_ReadObjectFromString(char *str, int len)
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000862{
863 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000864 PyObject *result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000865 rf.fp = NULL;
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000866 rf.ptr = str;
867 rf.end = str + len;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000868 rf.strings = PyList_New(0);
869 result = r_object(&rf);
870 Py_DECREF(rf.strings);
871 return result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000872}
873
Guido van Rossum79f25d91997-04-29 20:08:16 +0000874PyObject *
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000875PyMarshal_WriteObjectToString(PyObject *x, int version)
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000876{
877 WFILE wf;
878 wf.fp = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000879 wf.str = PyString_FromStringAndSize((char *)NULL, 50);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000880 if (wf.str == NULL)
881 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000882 wf.ptr = PyString_AS_STRING((PyStringObject *)wf.str);
883 wf.end = wf.ptr + PyString_Size(wf.str);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000884 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000885 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000886 wf.strings = (version > 0) ? PyDict_New() : NULL;
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000887 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000888 Py_XDECREF(wf.strings);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000889 if (wf.str != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000890 _PyString_Resize(&wf.str,
891 (int) (wf.ptr -
892 PyString_AS_STRING((PyStringObject *)wf.str)));
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000893 if (wf.error) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000894 Py_XDECREF(wf.str);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000895 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +0000896 (wf.error==1)?"unmarshallable object"
897 :"object too deeply nested to marshal");
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000898 return NULL;
899 }
900 return wf.str;
901}
902
Guido van Rossum64b45521991-06-07 13:58:22 +0000903/* And an interface for Python programs... */
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000904
Guido van Rossum79f25d91997-04-29 20:08:16 +0000905static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000906marshal_dump(PyObject *self, PyObject *args)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000907{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000908 WFILE wf;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000909 PyObject *x;
910 PyObject *f;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000911 int version = Py_MARSHAL_VERSION;
912 if (!PyArg_ParseTuple(args, "OO|i:dump", &x, &f, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000913 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000914 if (!PyFile_Check(f)) {
915 PyErr_SetString(PyExc_TypeError,
916 "marshal.dump() 2nd arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000917 return NULL;
918 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000919 wf.fp = PyFile_AsFile(f);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000920 wf.str = NULL;
921 wf.ptr = wf.end = NULL;
Guido van Rossumf2150601996-06-26 20:41:23 +0000922 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000923 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000924 wf.strings = (version > 0) ? PyDict_New() : 0;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000925 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000926 Py_XDECREF(wf.strings);
Guido van Rossumf2150601996-06-26 20:41:23 +0000927 if (wf.error) {
Tim Petersd9b9ac82001-01-28 00:27:39 +0000928 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +0000929 (wf.error==1)?"unmarshallable object"
930 :"object too deeply nested to marshal");
Guido van Rossumf2150601996-06-26 20:41:23 +0000931 return NULL;
932 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000933 Py_INCREF(Py_None);
934 return Py_None;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000935}
936
Guido van Rossum79f25d91997-04-29 20:08:16 +0000937static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000938marshal_load(PyObject *self, PyObject *args)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000939{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000940 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000941 PyObject *f, *result;
Guido van Rossum2efa3692000-03-31 00:37:41 +0000942 if (!PyArg_ParseTuple(args, "O:load", &f))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000943 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000944 if (!PyFile_Check(f)) {
945 PyErr_SetString(PyExc_TypeError,
946 "marshal.load() arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000947 return NULL;
948 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000949 rf.fp = PyFile_AsFile(f);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000950 rf.strings = PyList_New(0);
951 result = read_object(&rf);
952 Py_DECREF(rf.strings);
953 return result;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000954}
955
Guido van Rossum79f25d91997-04-29 20:08:16 +0000956static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000957marshal_dumps(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000958{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000959 PyObject *x;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000960 int version = Py_MARSHAL_VERSION;
Armin Rigo2ccea172004-12-20 12:25:57 +0000961 if (!PyArg_ParseTuple(args, "O|i:dumps", &x, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000962 return NULL;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000963 return PyMarshal_WriteObjectToString(x, version);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000964}
965
Guido van Rossum79f25d91997-04-29 20:08:16 +0000966static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000967marshal_loads(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000968{
969 RFILE rf;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000970 char *s;
971 int n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000972 PyObject* result;
973 if (!PyArg_ParseTuple(args, "s#|i:loads", &s, &n))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000974 return NULL;
975 rf.fp = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000976 rf.ptr = s;
977 rf.end = s + n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000978 rf.strings = PyList_New(0);
979 result = read_object(&rf);
980 Py_DECREF(rf.strings);
981 return result;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000982}
983
Guido van Rossum79f25d91997-04-29 20:08:16 +0000984static PyMethodDef marshal_methods[] = {
Neal Norwitz031829d2002-03-31 14:37:44 +0000985 {"dump", marshal_dump, METH_VARARGS},
986 {"load", marshal_load, METH_VARARGS},
987 {"dumps", marshal_dumps, METH_VARARGS},
988 {"loads", marshal_loads, METH_VARARGS},
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000989 {NULL, NULL} /* sentinel */
990};
991
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000992PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000993PyMarshal_Init(void)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000994{
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000995 PyObject *mod = Py_InitModule("marshal", marshal_methods);
996 PyModule_AddIntConstant(mod, "version", Py_MARSHAL_VERSION);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000997}