blob: 590e1ca3911faa4ddc4f16d6cc483be2d0010f92 [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 '?'
38
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000039typedef struct {
40 FILE *fp;
Guido van Rossumf2150601996-06-26 20:41:23 +000041 int error;
Fred Drake6da0b912000-06-28 18:47:56 +000042 int depth;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000043 /* If fp == NULL, the following are valid: */
Guido van Rossum79f25d91997-04-29 20:08:16 +000044 PyObject *str;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000045 char *ptr;
46 char *end;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000047 PyObject *strings; /* dict on marshal, list on unmarshal */
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000048} WFILE;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000049
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000050#define w_byte(c, p) if (((p)->fp)) putc((c), (p)->fp); \
51 else if ((p)->ptr != (p)->end) *(p)->ptr++ = (c); \
52 else w_more(c, p)
53
54static void
Fredrik Lundh11534382000-07-23 18:24:06 +000055w_more(int c, WFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000056{
57 int size, newsize;
58 if (p->str == NULL)
59 return; /* An error already occurred */
Guido van Rossum79f25d91997-04-29 20:08:16 +000060 size = PyString_Size(p->str);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000061 newsize = size + 1024;
Guido van Rossum79f25d91997-04-29 20:08:16 +000062 if (_PyString_Resize(&p->str, newsize) != 0) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000063 p->ptr = p->end = NULL;
64 }
65 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +000066 p->ptr = PyString_AS_STRING((PyStringObject *)p->str) + size;
67 p->end =
68 PyString_AS_STRING((PyStringObject *)p->str) + newsize;
Tim Peters8315ea52000-07-23 19:28:35 +000069 *p->ptr++ = Py_SAFE_DOWNCAST(c, int, char);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000070 }
71}
72
73static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000074w_string(char *s, int n, WFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000075{
76 if (p->fp != NULL) {
77 fwrite(s, 1, n, p->fp);
78 }
79 else {
80 while (--n >= 0) {
81 w_byte(*s, p);
82 s++;
83 }
84 }
85}
86
87static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000088w_short(int x, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000089{
Thomas Heller3e1c18a2002-07-30 11:40:57 +000090 w_byte((char)( x & 0xff), p);
91 w_byte((char)((x>> 8) & 0xff), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000092}
93
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000094static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000095w_long(long x, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000096{
Thomas Heller37d5a152002-07-30 11:44:44 +000097 w_byte((char)( x & 0xff), p);
98 w_byte((char)((x>> 8) & 0xff), p);
99 w_byte((char)((x>>16) & 0xff), p);
100 w_byte((char)((x>>24) & 0xff), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000101}
102
Guido van Rossumc1547d91996-12-10 15:39:04 +0000103#if SIZEOF_LONG > 4
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000104static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000105w_long64(long x, WFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000106{
107 w_long(x, p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000108 w_long(x>>32, p);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000109}
Guido van Rossumc1547d91996-12-10 15:39:04 +0000110#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000111
112static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000113w_object(PyObject *v, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000114{
Guido van Rossum3a205f71995-02-17 15:10:07 +0000115 int i, n;
Fred Drake6da0b912000-06-28 18:47:56 +0000116
117 p->depth++;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000118
Fred Drake6da0b912000-06-28 18:47:56 +0000119 if (p->depth > MAX_MARSHAL_STACK_DEPTH) {
120 p->error = 2;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000121 }
Fred Drake6da0b912000-06-28 18:47:56 +0000122 else if (v == NULL) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000123 w_byte(TYPE_NULL, p);
Guido van Rossum730806d1998-04-10 22:27:42 +0000124 }
125 else if (v == Py_None) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000126 w_byte(TYPE_NONE, p);
Guido van Rossum730806d1998-04-10 22:27:42 +0000127 }
Tim Peters5ca576e2001-06-18 22:08:13 +0000128 else if (v == PyExc_StopIteration) {
129 w_byte(TYPE_STOPITER, p);
130 }
Guido van Rossum730806d1998-04-10 22:27:42 +0000131 else if (v == Py_Ellipsis) {
132 w_byte(TYPE_ELLIPSIS, p);
133 }
Guido van Rossum77f6a652002-04-03 22:41:51 +0000134 else if (v == Py_False) {
135 w_byte(TYPE_FALSE, p);
136 }
137 else if (v == Py_True) {
138 w_byte(TYPE_TRUE, p);
139 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000140 else if (PyInt_Check(v)) {
141 long x = PyInt_AS_LONG((PyIntObject *)v);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000142#if SIZEOF_LONG > 4
Tim Peters44714002001-04-10 05:02:52 +0000143 long y = Py_ARITHMETIC_RIGHT_SHIFT(long, x, 31);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000144 if (y && y != -1) {
145 w_byte(TYPE_INT64, p);
146 w_long64(x, p);
147 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000148 else
149#endif
150 {
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000151 w_byte(TYPE_INT, p);
152 w_long(x, p);
153 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000154 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000155 else if (PyLong_Check(v)) {
156 PyLongObject *ob = (PyLongObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000157 w_byte(TYPE_LONG, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000158 n = ob->ob_size;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000159 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000160 if (n < 0)
161 n = -n;
162 for (i = 0; i < n; i++)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000163 w_short(ob->ob_digit[i], p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000164 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000165 else if (PyFloat_Check(v)) {
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000166 char buf[256]; /* Plenty to format any double */
Tim Peters72f98e92001-05-08 15:19:57 +0000167 PyFloat_AsReprString(buf, (PyFloatObject *)v);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000168 n = strlen(buf);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000169 w_byte(TYPE_FLOAT, p);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000170 w_byte(n, p);
171 w_string(buf, n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000172 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000173#ifndef WITHOUT_COMPLEX
Guido van Rossum79f25d91997-04-29 20:08:16 +0000174 else if (PyComplex_Check(v)) {
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000175 char buf[256]; /* Plenty to format any double */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000176 PyFloatObject *temp;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000177 w_byte(TYPE_COMPLEX, p);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000178 temp = (PyFloatObject*)PyFloat_FromDouble(
179 PyComplex_RealAsDouble(v));
Tim Peters72f98e92001-05-08 15:19:57 +0000180 PyFloat_AsReprString(buf, temp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000181 Py_DECREF(temp);
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000182 n = strlen(buf);
183 w_byte(n, p);
184 w_string(buf, n, p);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000185 temp = (PyFloatObject*)PyFloat_FromDouble(
186 PyComplex_ImagAsDouble(v));
Tim Peters72f98e92001-05-08 15:19:57 +0000187 PyFloat_AsReprString(buf, temp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000188 Py_DECREF(temp);
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000189 n = strlen(buf);
190 w_byte(n, p);
191 w_string(buf, n, p);
192 }
193#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +0000194 else if (PyString_Check(v)) {
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000195 if (p->strings && PyString_CHECK_INTERNED(v)) {
196 PyObject *o = PyDict_GetItem(p->strings, v);
197 if (o) {
198 long w = PyInt_AsLong(o);
199 w_byte(TYPE_STRINGREF, p);
200 w_long(w, p);
201 goto exit;
202 }
203 else {
204 o = PyInt_FromLong(PyDict_Size(p->strings));
205 PyDict_SetItem(p->strings, v, o);
206 Py_DECREF(o);
207 w_byte(TYPE_INTERNED, p);
208 }
209 }
210 else {
211 w_byte(TYPE_STRING, p);
212 }
Guido van Rossumc279b532000-03-10 23:03:02 +0000213 n = PyString_GET_SIZE(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000214 w_long((long)n, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000215 w_string(PyString_AS_STRING(v), n, p);
216 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000217#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000218 else if (PyUnicode_Check(v)) {
219 PyObject *utf8;
220 utf8 = PyUnicode_AsUTF8String(v);
221 if (utf8 == NULL) {
Guido van Rossum98626cd2000-06-28 23:24:19 +0000222 p->depth--;
223 p->error = 1;
224 return;
Guido van Rossumc279b532000-03-10 23:03:02 +0000225 }
226 w_byte(TYPE_UNICODE, p);
227 n = PyString_GET_SIZE(utf8);
228 w_long((long)n, p);
229 w_string(PyString_AS_STRING(utf8), n, p);
230 Py_DECREF(utf8);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000231 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000232#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +0000233 else if (PyTuple_Check(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000234 w_byte(TYPE_TUPLE, p);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000235 n = PyTuple_Size(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000236 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000237 for (i = 0; i < n; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000238 w_object(PyTuple_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000239 }
240 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000241 else if (PyList_Check(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000242 w_byte(TYPE_LIST, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000243 n = PyList_GET_SIZE(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000244 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000245 for (i = 0; i < n; i++) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000246 w_object(PyList_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000247 }
248 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000249 else if (PyDict_Check(v)) {
Guido van Rossum25831651993-05-19 14:50:45 +0000250 int pos;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000251 PyObject *key, *value;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000252 w_byte(TYPE_DICT, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000253 /* This one is NULL object terminated! */
Guido van Rossum25831651993-05-19 14:50:45 +0000254 pos = 0;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000255 while (PyDict_Next(v, &pos, &key, &value)) {
Guido van Rossum25831651993-05-19 14:50:45 +0000256 w_object(key, p);
257 w_object(value, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000258 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000259 w_object((PyObject *)NULL, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000260 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000261 else if (PyCode_Check(v)) {
262 PyCodeObject *co = (PyCodeObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000263 w_byte(TYPE_CODE, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000264 w_long(co->co_argcount, p);
265 w_long(co->co_nlocals, p);
266 w_long(co->co_stacksize, p);
267 w_long(co->co_flags, p);
Guido van Rossumd076c731998-10-07 19:42:25 +0000268 w_object(co->co_code, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000269 w_object(co->co_consts, p);
270 w_object(co->co_names, p);
Guido van Rossum681d79a1995-07-18 14:51:37 +0000271 w_object(co->co_varnames, p);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000272 w_object(co->co_freevars, p);
273 w_object(co->co_cellvars, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000274 w_object(co->co_filename, p);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000275 w_object(co->co_name, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000276 w_long(co->co_firstlineno, p);
Guido van Rossumd031c891997-01-24 03:44:17 +0000277 w_object(co->co_lnotab, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000278 }
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000279 else if (PyObject_CheckReadBuffer(v)) {
Guido van Rossumd076c731998-10-07 19:42:25 +0000280 /* Write unknown buffer-style objects as a string */
281 char *s;
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000282 PyBufferProcs *pb = v->ob_type->tp_as_buffer;
Guido van Rossumd076c731998-10-07 19:42:25 +0000283 w_byte(TYPE_STRING, p);
284 n = (*pb->bf_getreadbuffer)(v, 0, (void **)&s);
285 w_long((long)n, p);
286 w_string(s, n, p);
287 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000288 else {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000289 w_byte(TYPE_UNKNOWN, p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000290 p->error = 1;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000291 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000292 exit:
Guido van Rossum98626cd2000-06-28 23:24:19 +0000293 p->depth--;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000294}
295
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000296/* version currently has no effect for writing longs. */
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000297void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000298PyMarshal_WriteLongToFile(long x, FILE *fp, int version)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000299{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000300 WFILE wf;
301 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000302 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000303 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000304 wf.strings = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000305 w_long(x, &wf);
306}
307
308void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000309PyMarshal_WriteObjectToFile(PyObject *x, FILE *fp, int version)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000310{
311 WFILE wf;
312 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000313 wf.error = 0;
Guido van Rossum98626cd2000-06-28 23:24:19 +0000314 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000315 wf.strings = (version > 0) ? PyDict_New() : NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000316 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000317 Py_XDECREF(wf.strings);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000318}
319
320typedef WFILE RFILE; /* Same struct with different invariants */
321
Guido van Rossum8d617a61995-03-09 12:12:11 +0000322#define rs_byte(p) (((p)->ptr != (p)->end) ? (unsigned char)*(p)->ptr++ : EOF)
323
324#define r_byte(p) ((p)->fp ? getc((p)->fp) : rs_byte(p))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000325
326static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000327r_string(char *s, int n, RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000328{
329 if (p->fp != NULL)
330 return fread(s, 1, n, p->fp);
331 if (p->end - p->ptr < n)
332 n = p->end - p->ptr;
333 memcpy(s, p->ptr, n);
334 p->ptr += n;
335 return n;
336}
337
338static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000339r_short(RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000340{
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000341 register short x;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000342 x = r_byte(p);
343 x |= r_byte(p) << 8;
Tim Peterse84b7402000-09-19 08:54:13 +0000344 /* Sign-extension, in case short greater than 16 bits */
345 x |= -(x & 0x8000);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000346 return x;
347}
348
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000349static long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000350r_long(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000351{
352 register long x;
Guido van Rossum8d617a61995-03-09 12:12:11 +0000353 register FILE *fp = p->fp;
354 if (fp) {
355 x = getc(fp);
356 x |= (long)getc(fp) << 8;
357 x |= (long)getc(fp) << 16;
358 x |= (long)getc(fp) << 24;
359 }
360 else {
361 x = rs_byte(p);
362 x |= (long)rs_byte(p) << 8;
363 x |= (long)rs_byte(p) << 16;
364 x |= (long)rs_byte(p) << 24;
365 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000366#if SIZEOF_LONG > 4
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000367 /* Sign extension for 64-bit machines */
Tim Peterse84b7402000-09-19 08:54:13 +0000368 x |= -(x & 0x80000000L);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000369#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000370 return x;
371}
372
Tim Peters82112372001-08-29 02:28:42 +0000373/* r_long64 deals with the TYPE_INT64 code. On a machine with
374 sizeof(long) > 4, it returns a Python int object, else a Python long
375 object. Note that w_long64 writes out TYPE_INT if 32 bits is enough,
376 so there's no inefficiency here in returning a PyLong on 32-bit boxes
377 for everything written via TYPE_INT64 (i.e., if an int is written via
378 TYPE_INT64, it *needs* more than 32 bits).
379*/
380static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000381r_long64(RFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000382{
Tim Peters82112372001-08-29 02:28:42 +0000383 long lo4 = r_long(p);
384 long hi4 = r_long(p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000385#if SIZEOF_LONG > 4
Tim Peters82112372001-08-29 02:28:42 +0000386 long x = (hi4 << 32) | (lo4 & 0xFFFFFFFFL);
387 return PyInt_FromLong(x);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000388#else
Tim Peters82112372001-08-29 02:28:42 +0000389 unsigned char buf[8];
390 int one = 1;
391 int is_little_endian = (int)*(char*)&one;
392 if (is_little_endian) {
393 memcpy(buf, &lo4, 4);
394 memcpy(buf+4, &hi4, 4);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000395 }
Tim Peters82112372001-08-29 02:28:42 +0000396 else {
397 memcpy(buf, &hi4, 4);
398 memcpy(buf+4, &lo4, 4);
399 }
400 return _PyLong_FromByteArray(buf, 8, is_little_endian, 1);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000401#endif
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000402}
403
Guido van Rossum79f25d91997-04-29 20:08:16 +0000404static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000405r_object(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000406{
Armin Rigo01ab2792004-03-26 15:09:27 +0000407 /* NULL is a valid return value, it does not necessarily means that
408 an exception is set. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000409 PyObject *v, *v2;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000410 long i, n;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000411 int type = r_byte(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000412
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000413 switch (type) {
Tim Petersd9b9ac82001-01-28 00:27:39 +0000414
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000415 case EOF:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000416 PyErr_SetString(PyExc_EOFError,
417 "EOF read where object expected");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000418 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000419
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000420 case TYPE_NULL:
421 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000422
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000423 case TYPE_NONE:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000424 Py_INCREF(Py_None);
425 return Py_None;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000426
Tim Peters5ca576e2001-06-18 22:08:13 +0000427 case TYPE_STOPITER:
428 Py_INCREF(PyExc_StopIteration);
429 return PyExc_StopIteration;
430
Guido van Rossume449af71996-10-11 16:25:41 +0000431 case TYPE_ELLIPSIS:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000432 Py_INCREF(Py_Ellipsis);
Guido van Rossume449af71996-10-11 16:25:41 +0000433 return Py_Ellipsis;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000434
Guido van Rossum77f6a652002-04-03 22:41:51 +0000435 case TYPE_FALSE:
436 Py_INCREF(Py_False);
437 return Py_False;
438
439 case TYPE_TRUE:
440 Py_INCREF(Py_True);
441 return Py_True;
442
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000443 case TYPE_INT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000444 return PyInt_FromLong(r_long(p));
Tim Petersd9b9ac82001-01-28 00:27:39 +0000445
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000446 case TYPE_INT64:
Tim Peters82112372001-08-29 02:28:42 +0000447 return r_long64(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000448
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000449 case TYPE_LONG:
450 {
451 int size;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000452 PyLongObject *ob;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000453 n = r_long(p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000454 size = n<0 ? -n : n;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000455 ob = _PyLong_New(size);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000456 if (ob == NULL)
457 return NULL;
458 ob->ob_size = n;
Armin Rigo01ab2792004-03-26 15:09:27 +0000459 for (i = 0; i < size; i++) {
460 int digit = r_short(p);
461 if (digit < 0) {
462 Py_DECREF(ob);
463 PyErr_SetString(PyExc_ValueError,
464 "bad marshal data");
465 return NULL;
466 }
467 ob->ob_digit[i] = digit;
468 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000469 return (PyObject *)ob;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000470 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000471
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000472 case TYPE_FLOAT:
473 {
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000474 char buf[256];
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000475 double dx;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000476 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000477 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000478 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000479 "EOF read where object expected");
480 return NULL;
481 }
482 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000483 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000484 dx = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000485 PyFPE_END_PROTECT(dx)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000486 return PyFloat_FromDouble(dx);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000487 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000488
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000489#ifndef WITHOUT_COMPLEX
490 case TYPE_COMPLEX:
491 {
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000492 char buf[256];
Guido van Rossum530956d1996-07-21 02:27:43 +0000493 Py_complex c;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000494 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000495 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000496 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000497 "EOF read where object expected");
498 return NULL;
499 }
500 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000501 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000502 c.real = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000503 PyFPE_END_PROTECT(c)
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000504 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000505 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000506 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000507 "EOF read where object expected");
508 return NULL;
509 }
510 buf[n] = '\0';
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000511 PyFPE_START_PROTECT("atof", return 0)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000512 c.imag = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000513 PyFPE_END_PROTECT(c)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000514 return PyComplex_FromCComplex(c);
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000515 }
516#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000517
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000518 case TYPE_INTERNED:
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000519 case TYPE_STRING:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000520 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000521 if (n < 0) {
522 PyErr_SetString(PyExc_ValueError, "bad marshal data");
523 return NULL;
524 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000525 v = PyString_FromStringAndSize((char *)NULL, n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000526 if (v != NULL) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000527 if (r_string(PyString_AS_STRING(v), (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000528 Py_DECREF(v);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000529 v = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000530 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000531 "EOF read where object expected");
532 }
533 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000534 if (type == TYPE_INTERNED) {
535 PyString_InternInPlace(&v);
536 PyList_Append(p->strings, v);
537 }
538 return v;
539
540 case TYPE_STRINGREF:
541 n = r_long(p);
542 v = PyList_GET_ITEM(p->strings, n);
543 Py_INCREF(v);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000544 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000545
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000546#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000547 case TYPE_UNICODE:
548 {
549 char *buffer;
550
551 n = r_long(p);
552 if (n < 0) {
553 PyErr_SetString(PyExc_ValueError, "bad marshal data");
554 return NULL;
555 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000556 buffer = PyMem_NEW(char, n);
Guido van Rossumc279b532000-03-10 23:03:02 +0000557 if (buffer == NULL)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000558 return PyErr_NoMemory();
Guido van Rossumc279b532000-03-10 23:03:02 +0000559 if (r_string(buffer, (int)n, p) != n) {
Guido van Rossumb18618d2000-05-03 23:44:39 +0000560 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000561 PyErr_SetString(PyExc_EOFError,
562 "EOF read where object expected");
563 return NULL;
564 }
565 v = PyUnicode_DecodeUTF8(buffer, n, NULL);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000566 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000567 return v;
568 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000569#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000570
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000571 case TYPE_TUPLE:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000572 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000573 if (n < 0) {
574 PyErr_SetString(PyExc_ValueError, "bad marshal data");
575 return NULL;
576 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000577 v = PyTuple_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000578 if (v == NULL)
579 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000580 for (i = 0; i < n; i++) {
581 v2 = r_object(p);
582 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000583 if (!PyErr_Occurred())
584 PyErr_SetString(PyExc_TypeError,
585 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000586 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000587 v = NULL;
588 break;
589 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000590 PyTuple_SET_ITEM(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000591 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000592 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000593
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000594 case TYPE_LIST:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000595 n = r_long(p);
Guido van Rossuma45cb451998-06-08 20:27:29 +0000596 if (n < 0) {
597 PyErr_SetString(PyExc_ValueError, "bad marshal data");
598 return NULL;
599 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000600 v = PyList_New((int)n);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000601 if (v == NULL)
602 return v;
Jack Jansen9513f2c1995-10-27 13:21:28 +0000603 for (i = 0; i < n; i++) {
604 v2 = r_object(p);
605 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000606 if (!PyErr_Occurred())
607 PyErr_SetString(PyExc_TypeError,
608 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000609 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000610 v = NULL;
611 break;
612 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000613 PyList_SetItem(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000614 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000615 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000616
Guido van Rossum64b45521991-06-07 13:58:22 +0000617 case TYPE_DICT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000618 v = PyDict_New();
Guido van Rossum64b45521991-06-07 13:58:22 +0000619 if (v == NULL)
620 return NULL;
621 for (;;) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000622 PyObject *key, *val;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000623 key = r_object(p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000624 if (key == NULL)
Armin Rigo01ab2792004-03-26 15:09:27 +0000625 break;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000626 val = r_object(p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000627 if (val != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000628 PyDict_SetItem(v, key, val);
629 Py_DECREF(key);
630 Py_XDECREF(val);
Guido van Rossum64b45521991-06-07 13:58:22 +0000631 }
Armin Rigo01ab2792004-03-26 15:09:27 +0000632 if (PyErr_Occurred()) {
633 Py_DECREF(v);
634 v = NULL;
635 }
Guido van Rossum64b45521991-06-07 13:58:22 +0000636 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000637
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000638 case TYPE_CODE:
Michael W. Hudson80199132001-08-30 14:50:20 +0000639 if (PyEval_GetRestricted()) {
640 PyErr_SetString(PyExc_RuntimeError,
641 "cannot unmarshal code objects in "
642 "restricted execution mode");
643 return NULL;
644 }
645 else {
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000646 int argcount = r_long(p);
647 int nlocals = r_long(p);
648 int stacksize = r_long(p);
649 int flags = r_long(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000650 PyObject *code = r_object(p);
651 PyObject *consts = r_object(p);
652 PyObject *names = r_object(p);
653 PyObject *varnames = r_object(p);
654 PyObject *freevars = r_object(p);
655 PyObject *cellvars = r_object(p);
656 PyObject *filename = r_object(p);
657 PyObject *name = r_object(p);
658 int firstlineno = r_long(p);
659 PyObject *lnotab = r_object(p);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000660
Guido van Rossum79f25d91997-04-29 20:08:16 +0000661 if (!PyErr_Occurred()) {
662 v = (PyObject *) PyCode_New(
Tim Petersd9b9ac82001-01-28 00:27:39 +0000663 argcount, nlocals, stacksize, flags,
Guido van Rossum681d79a1995-07-18 14:51:37 +0000664 code, consts, names, varnames,
Tim Petersd9b9ac82001-01-28 00:27:39 +0000665 freevars, cellvars, filename, name,
666 firstlineno, lnotab);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000667 }
668 else
669 v = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000670 Py_XDECREF(code);
671 Py_XDECREF(consts);
672 Py_XDECREF(names);
673 Py_XDECREF(varnames);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000674 Py_XDECREF(freevars);
675 Py_XDECREF(cellvars);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000676 Py_XDECREF(filename);
677 Py_XDECREF(name);
Guido van Rossum6fc06e71997-07-26 23:30:18 +0000678 Py_XDECREF(lnotab);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000679
680 }
681 return v;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000682
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000683 default:
Guido van Rossumf2150601996-06-26 20:41:23 +0000684 /* Bogus data got written, which isn't ideal.
685 This will let you keep working and recover. */
Guido van Rossuma45cb451998-06-08 20:27:29 +0000686 PyErr_SetString(PyExc_ValueError, "bad marshal data");
687 return NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000688
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000689 }
690}
691
Neal Norwitzd85c4522004-06-13 20:31:49 +0000692static PyObject *
Armin Rigo01ab2792004-03-26 15:09:27 +0000693read_object(RFILE *p)
694{
695 PyObject *v;
696 if (PyErr_Occurred()) {
697 fprintf(stderr, "XXX readobject called with exception set\n");
698 return NULL;
699 }
700 v = r_object(p);
701 if (v == NULL && !PyErr_Occurred())
702 PyErr_SetString(PyExc_TypeError, "NULL object in marshal data");
703 return v;
704}
705
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000706int
707PyMarshal_ReadShortFromFile(FILE *fp)
708{
709 RFILE rf;
710 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000711 rf.strings = NULL;
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000712 return r_short(&rf);
713}
714
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000715long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000716PyMarshal_ReadLongFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000717{
718 RFILE rf;
719 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000720 rf.strings = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000721 return r_long(&rf);
722}
723
Tim Peters691e0e92001-01-18 04:39:16 +0000724#ifdef HAVE_FSTAT
725/* Return size of file in bytes; < 0 if unknown. */
726static off_t
727getfilesize(FILE *fp)
728{
729 struct stat st;
730 if (fstat(fileno(fp), &st) != 0)
731 return -1;
732 else
733 return st.st_size;
734}
735#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000736
Tim Peters691e0e92001-01-18 04:39:16 +0000737/* If we can get the size of the file up-front, and it's reasonably small,
738 * read it in one gulp and delegate to ...FromString() instead. Much quicker
739 * than reading a byte at a time from file; speeds .pyc imports.
Tim Petersd9b9ac82001-01-28 00:27:39 +0000740 * CAUTION: since this may read the entire remainder of the file, don't
741 * call it unless you know you're done with the file.
Tim Peters691e0e92001-01-18 04:39:16 +0000742 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000743PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000744PyMarshal_ReadLastObjectFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000745{
Tim Peters691e0e92001-01-18 04:39:16 +0000746/* 75% of 2.1's .pyc files can exploit SMALL_FILE_LIMIT.
747 * REASONABLE_FILE_LIMIT is by defn something big enough for Tkinter.pyc.
748 */
749#define SMALL_FILE_LIMIT (1L << 14)
750#define REASONABLE_FILE_LIMIT (1L << 18)
Tim Peters691e0e92001-01-18 04:39:16 +0000751#ifdef HAVE_FSTAT
752 off_t filesize;
753#endif
Tim Peters691e0e92001-01-18 04:39:16 +0000754#ifdef HAVE_FSTAT
755 filesize = getfilesize(fp);
756 if (filesize > 0) {
757 char buf[SMALL_FILE_LIMIT];
758 char* pBuf = NULL;
759 if (filesize <= SMALL_FILE_LIMIT)
760 pBuf = buf;
761 else if (filesize <= REASONABLE_FILE_LIMIT)
762 pBuf = (char *)PyMem_MALLOC(filesize);
763 if (pBuf != NULL) {
764 PyObject* v;
765 size_t n = fread(pBuf, 1, filesize, fp);
766 v = PyMarshal_ReadObjectFromString(pBuf, n);
767 if (pBuf != buf)
768 PyMem_FREE(pBuf);
769 return v;
770 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000771
Tim Peters691e0e92001-01-18 04:39:16 +0000772 }
773#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000774 /* We don't have fstat, or we do but the file is larger than
775 * REASONABLE_FILE_LIMIT or malloc failed -- read a byte at a time.
776 */
777 return PyMarshal_ReadObjectFromFile(fp);
778
Tim Peters691e0e92001-01-18 04:39:16 +0000779#undef SMALL_FILE_LIMIT
780#undef REASONABLE_FILE_LIMIT
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000781}
782
Guido van Rossum79f25d91997-04-29 20:08:16 +0000783PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +0000784PyMarshal_ReadObjectFromFile(FILE *fp)
785{
786 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000787 PyObject *result;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000788 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000789 rf.strings = PyList_New(0);
790 result = r_object(&rf);
791 Py_DECREF(rf.strings);
792 return result;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000793}
794
795PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000796PyMarshal_ReadObjectFromString(char *str, int len)
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000797{
798 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000799 PyObject *result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000800 rf.fp = NULL;
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000801 rf.ptr = str;
802 rf.end = str + len;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000803 rf.strings = PyList_New(0);
804 result = r_object(&rf);
805 Py_DECREF(rf.strings);
806 return result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000807}
808
Guido van Rossum79f25d91997-04-29 20:08:16 +0000809PyObject *
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000810PyMarshal_WriteObjectToString(PyObject *x, int version)
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000811{
812 WFILE wf;
813 wf.fp = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000814 wf.str = PyString_FromStringAndSize((char *)NULL, 50);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000815 if (wf.str == NULL)
816 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000817 wf.ptr = PyString_AS_STRING((PyStringObject *)wf.str);
818 wf.end = wf.ptr + PyString_Size(wf.str);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000819 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000820 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000821 wf.strings = (version > 0) ? PyDict_New() : NULL;
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000822 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000823 Py_XDECREF(wf.strings);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000824 if (wf.str != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000825 _PyString_Resize(&wf.str,
826 (int) (wf.ptr -
827 PyString_AS_STRING((PyStringObject *)wf.str)));
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000828 if (wf.error) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000829 Py_XDECREF(wf.str);
Tim Petersd9b9ac82001-01-28 00:27:39 +0000830 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +0000831 (wf.error==1)?"unmarshallable object"
832 :"object too deeply nested to marshal");
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +0000833 return NULL;
834 }
835 return wf.str;
836}
837
Guido van Rossum64b45521991-06-07 13:58:22 +0000838/* And an interface for Python programs... */
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000839
Guido van Rossum79f25d91997-04-29 20:08:16 +0000840static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000841marshal_dump(PyObject *self, PyObject *args)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000842{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000843 WFILE wf;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000844 PyObject *x;
845 PyObject *f;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000846 int version = Py_MARSHAL_VERSION;
847 if (!PyArg_ParseTuple(args, "OO|i:dump", &x, &f, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000848 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000849 if (!PyFile_Check(f)) {
850 PyErr_SetString(PyExc_TypeError,
851 "marshal.dump() 2nd arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000852 return NULL;
853 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000854 wf.fp = PyFile_AsFile(f);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000855 wf.str = NULL;
856 wf.ptr = wf.end = NULL;
Guido van Rossumf2150601996-06-26 20:41:23 +0000857 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000858 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000859 wf.strings = (version > 0) ? PyDict_New() : 0;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000860 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000861 Py_XDECREF(wf.strings);
Guido van Rossumf2150601996-06-26 20:41:23 +0000862 if (wf.error) {
Tim Petersd9b9ac82001-01-28 00:27:39 +0000863 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +0000864 (wf.error==1)?"unmarshallable object"
865 :"object too deeply nested to marshal");
Guido van Rossumf2150601996-06-26 20:41:23 +0000866 return NULL;
867 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000868 Py_INCREF(Py_None);
869 return Py_None;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000870}
871
Guido van Rossum79f25d91997-04-29 20:08:16 +0000872static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000873marshal_load(PyObject *self, PyObject *args)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000874{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000875 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000876 PyObject *f, *result;
Guido van Rossum2efa3692000-03-31 00:37:41 +0000877 if (!PyArg_ParseTuple(args, "O:load", &f))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000878 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000879 if (!PyFile_Check(f)) {
880 PyErr_SetString(PyExc_TypeError,
881 "marshal.load() arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000882 return NULL;
883 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000884 rf.fp = PyFile_AsFile(f);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000885 rf.strings = PyList_New(0);
886 result = read_object(&rf);
887 Py_DECREF(rf.strings);
888 return result;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000889}
890
Guido van Rossum79f25d91997-04-29 20:08:16 +0000891static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000892marshal_dumps(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000893{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000894 PyObject *x;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000895 int version = Py_MARSHAL_VERSION;
896 if (!PyArg_ParseTuple(args, "O|i:dumps", &x, version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000897 return NULL;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000898 return PyMarshal_WriteObjectToString(x, version);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000899}
900
Guido van Rossum79f25d91997-04-29 20:08:16 +0000901static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000902marshal_loads(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000903{
904 RFILE rf;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000905 char *s;
906 int n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000907 PyObject* result;
908 if (!PyArg_ParseTuple(args, "s#|i:loads", &s, &n))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000909 return NULL;
910 rf.fp = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000911 rf.ptr = s;
912 rf.end = s + n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000913 rf.strings = PyList_New(0);
914 result = read_object(&rf);
915 Py_DECREF(rf.strings);
916 return result;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000917}
918
Guido van Rossum79f25d91997-04-29 20:08:16 +0000919static PyMethodDef marshal_methods[] = {
Neal Norwitz031829d2002-03-31 14:37:44 +0000920 {"dump", marshal_dump, METH_VARARGS},
921 {"load", marshal_load, METH_VARARGS},
922 {"dumps", marshal_dumps, METH_VARARGS},
923 {"loads", marshal_loads, METH_VARARGS},
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000924 {NULL, NULL} /* sentinel */
925};
926
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000927PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000928PyMarshal_Init(void)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000929{
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000930 PyObject *mod = Py_InitModule("marshal", marshal_methods);
931 PyModule_AddIntConstant(mod, "version", Py_MARSHAL_VERSION);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000932}