blob: 52d22573d3de7ddd3dd5e5689fe1cee34e3f7e0a [file] [log] [blame]
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001
2/* Write Python objects to files and read them back.
3 This is intended for writing and reading compiled Python code only;
4 a true persistent storage facility would be much harder, since
5 it would have to take circular links and sharing into account. */
6
Thomas Wouters695934a2006-03-01 23:49:13 +00007#define PY_SSIZE_T_CLEAN
8
Guido van Rossum79f25d91997-04-29 20:08:16 +00009#include "Python.h"
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000010#include "longintrepr.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000011#include "code.h"
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000012#include "marshal.h"
13
Fred Drake6da0b912000-06-28 18:47:56 +000014/* High water mark to determine when the marshalled object is dangerously deep
15 * and risks coring the interpreter. When the object stack gets this deep,
16 * raise an exception instead of continuing.
17 */
Neal Norwitzf6b0e4d2007-05-17 07:04:46 +000018#define MAX_MARSHAL_STACK_DEPTH 2000
Fred Drake6da0b912000-06-28 18:47:56 +000019
Michael W. Hudsondf888462005-06-03 14:41:55 +000020#define TYPE_NULL '0'
21#define TYPE_NONE 'N'
22#define TYPE_FALSE 'F'
23#define TYPE_TRUE 'T'
24#define TYPE_STOPITER 'S'
25#define TYPE_ELLIPSIS '.'
26#define TYPE_INT 'i'
27#define TYPE_INT64 'I'
28#define TYPE_FLOAT 'f'
29#define TYPE_BINARY_FLOAT 'g'
30#define TYPE_COMPLEX 'x'
31#define TYPE_BINARY_COMPLEX 'y'
32#define TYPE_LONG 'l'
33#define TYPE_STRING 's'
34#define TYPE_INTERNED 't'
35#define TYPE_STRINGREF 'R'
36#define TYPE_TUPLE '('
37#define TYPE_LIST '['
38#define TYPE_DICT '{'
39#define TYPE_CODE 'c'
40#define TYPE_UNICODE 'u'
41#define TYPE_UNKNOWN '?'
42#define TYPE_SET '<'
43#define TYPE_FROZENSET '>'
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000044
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000045typedef struct {
46 FILE *fp;
Guido van Rossumf2150601996-06-26 20:41:23 +000047 int error;
Fred Drake6da0b912000-06-28 18:47:56 +000048 int depth;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000049 /* If fp == NULL, the following are valid: */
Guido van Rossum79f25d91997-04-29 20:08:16 +000050 PyObject *str;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000051 char *ptr;
52 char *end;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000053 PyObject *strings; /* dict on marshal, list on unmarshal */
Michael W. Hudsondf888462005-06-03 14:41:55 +000054 int version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000055} WFILE;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000056
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000057#define w_byte(c, p) if (((p)->fp)) putc((c), (p)->fp); \
58 else if ((p)->ptr != (p)->end) *(p)->ptr++ = (c); \
59 else w_more(c, p)
60
61static void
Fredrik Lundh11534382000-07-23 18:24:06 +000062w_more(int c, WFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000063{
Martin v. Löwis18e16552006-02-15 17:27:45 +000064 Py_ssize_t size, newsize;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000065 if (p->str == NULL)
66 return; /* An error already occurred */
Gregory P. Smithdd96db62008-06-09 04:58:54 +000067 size = PyString_Size(p->str);
Andrew M. Kuchling6c029162008-05-11 13:33:56 +000068 newsize = size + size + 1024;
69 if (newsize > 32*1024*1024) {
Raymond Hettinger305480c2008-06-16 01:42:40 +000070 newsize = size + (size >> 3); /* 12.5% overallocation */
Andrew M. Kuchling6c029162008-05-11 13:33:56 +000071 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +000072 if (_PyString_Resize(&p->str, newsize) != 0) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000073 p->ptr = p->end = NULL;
74 }
75 else {
Gregory P. Smithdd96db62008-06-09 04:58:54 +000076 p->ptr = PyString_AS_STRING((PyStringObject *)p->str) + size;
Guido van Rossum79f25d91997-04-29 20:08:16 +000077 p->end =
Gregory P. Smithdd96db62008-06-09 04:58:54 +000078 PyString_AS_STRING((PyStringObject *)p->str) + newsize;
Tim Peters8315ea52000-07-23 19:28:35 +000079 *p->ptr++ = Py_SAFE_DOWNCAST(c, int, char);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000080 }
81}
82
83static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000084w_string(char *s, int n, WFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +000085{
86 if (p->fp != NULL) {
87 fwrite(s, 1, n, p->fp);
88 }
89 else {
90 while (--n >= 0) {
91 w_byte(*s, p);
92 s++;
93 }
94 }
95}
96
97static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000098w_short(int x, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +000099{
Thomas Heller3e1c18a2002-07-30 11:40:57 +0000100 w_byte((char)( x & 0xff), p);
101 w_byte((char)((x>> 8) & 0xff), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000102}
103
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000104static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000105w_long(long x, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000106{
Thomas Heller37d5a152002-07-30 11:44:44 +0000107 w_byte((char)( x & 0xff), p);
108 w_byte((char)((x>> 8) & 0xff), p);
109 w_byte((char)((x>>16) & 0xff), p);
110 w_byte((char)((x>>24) & 0xff), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000111}
112
Guido van Rossumc1547d91996-12-10 15:39:04 +0000113#if SIZEOF_LONG > 4
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000114static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000115w_long64(long x, WFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000116{
117 w_long(x, p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000118 w_long(x>>32, p);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000119}
Guido van Rossumc1547d91996-12-10 15:39:04 +0000120#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000121
122static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000123w_object(PyObject *v, WFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000124{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000125 Py_ssize_t i, n;
Fred Drake6da0b912000-06-28 18:47:56 +0000126
127 p->depth++;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000128
Fred Drake6da0b912000-06-28 18:47:56 +0000129 if (p->depth > MAX_MARSHAL_STACK_DEPTH) {
130 p->error = 2;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000131 }
Fred Drake6da0b912000-06-28 18:47:56 +0000132 else if (v == NULL) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000133 w_byte(TYPE_NULL, p);
Guido van Rossum730806d1998-04-10 22:27:42 +0000134 }
135 else if (v == Py_None) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000136 w_byte(TYPE_NONE, p);
Guido van Rossum730806d1998-04-10 22:27:42 +0000137 }
Tim Peters5ca576e2001-06-18 22:08:13 +0000138 else if (v == PyExc_StopIteration) {
139 w_byte(TYPE_STOPITER, p);
140 }
Guido van Rossum730806d1998-04-10 22:27:42 +0000141 else if (v == Py_Ellipsis) {
142 w_byte(TYPE_ELLIPSIS, p);
143 }
Guido van Rossum77f6a652002-04-03 22:41:51 +0000144 else if (v == Py_False) {
145 w_byte(TYPE_FALSE, p);
146 }
147 else if (v == Py_True) {
148 w_byte(TYPE_TRUE, p);
149 }
Raymond Hettinger12e94202007-11-07 01:13:09 +0000150 else if (PyInt_CheckExact(v)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000151 long x = PyInt_AS_LONG((PyIntObject *)v);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000152#if SIZEOF_LONG > 4
Tim Peters44714002001-04-10 05:02:52 +0000153 long y = Py_ARITHMETIC_RIGHT_SHIFT(long, x, 31);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000154 if (y && y != -1) {
155 w_byte(TYPE_INT64, p);
156 w_long64(x, p);
157 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000158 else
159#endif
160 {
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000161 w_byte(TYPE_INT, p);
162 w_long(x, p);
163 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000164 }
Raymond Hettinger12e94202007-11-07 01:13:09 +0000165 else if (PyLong_CheckExact(v)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000166 PyLongObject *ob = (PyLongObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000167 w_byte(TYPE_LONG, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000168 n = ob->ob_size;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000169 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000170 if (n < 0)
171 n = -n;
172 for (i = 0; i < n; i++)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000173 w_short(ob->ob_digit[i], p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000174 }
Raymond Hettinger12e94202007-11-07 01:13:09 +0000175 else if (PyFloat_CheckExact(v)) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000176 if (p->version > 1) {
Brett Cannonc9371d42005-06-25 08:23:41 +0000177 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000178 if (_PyFloat_Pack8(PyFloat_AsDouble(v),
179 buf, 1) < 0) {
180 p->error = 1;
181 return;
182 }
183 w_byte(TYPE_BINARY_FLOAT, p);
Brett Cannonc9371d42005-06-25 08:23:41 +0000184 w_string((char*)buf, 8, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000185 }
186 else {
187 char buf[256]; /* Plenty to format any double */
188 PyFloat_AsReprString(buf, (PyFloatObject *)v);
Martin v. Löwis67baee62006-02-16 14:37:48 +0000189 n = strlen(buf);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000190 w_byte(TYPE_FLOAT, p);
Martin v. Löwis67baee62006-02-16 14:37:48 +0000191 w_byte((int)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000192 w_string(buf, (int)n, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000193 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000194 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000195#ifndef WITHOUT_COMPLEX
Raymond Hettinger12e94202007-11-07 01:13:09 +0000196 else if (PyComplex_CheckExact(v)) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000197 if (p->version > 1) {
Brett Cannonc9371d42005-06-25 08:23:41 +0000198 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000199 if (_PyFloat_Pack8(PyComplex_RealAsDouble(v),
200 buf, 1) < 0) {
201 p->error = 1;
202 return;
203 }
204 w_byte(TYPE_BINARY_COMPLEX, p);
Brett Cannonc9371d42005-06-25 08:23:41 +0000205 w_string((char*)buf, 8, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000206 if (_PyFloat_Pack8(PyComplex_ImagAsDouble(v),
207 buf, 1) < 0) {
208 p->error = 1;
209 return;
210 }
Brett Cannonc9371d42005-06-25 08:23:41 +0000211 w_string((char*)buf, 8, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000212 }
213 else {
214 char buf[256]; /* Plenty to format any double */
215 PyFloatObject *temp;
216 w_byte(TYPE_COMPLEX, p);
217 temp = (PyFloatObject*)PyFloat_FromDouble(
218 PyComplex_RealAsDouble(v));
Neal Norwitzedb21682006-08-12 01:47:59 +0000219 if (!temp) {
220 p->error = 1;
221 return;
222 }
Michael W. Hudsondf888462005-06-03 14:41:55 +0000223 PyFloat_AsReprString(buf, temp);
224 Py_DECREF(temp);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000225 n = strlen(buf);
226 w_byte((int)n, p);
227 w_string(buf, (int)n, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000228 temp = (PyFloatObject*)PyFloat_FromDouble(
229 PyComplex_ImagAsDouble(v));
Neal Norwitzedb21682006-08-12 01:47:59 +0000230 if (!temp) {
231 p->error = 1;
232 return;
233 }
Michael W. Hudsondf888462005-06-03 14:41:55 +0000234 PyFloat_AsReprString(buf, temp);
235 Py_DECREF(temp);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000236 n = strlen(buf);
237 w_byte((int)n, p);
238 w_string(buf, (int)n, p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000239 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000240 }
241#endif
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000242 else if (PyString_CheckExact(v)) {
243 if (p->strings && PyString_CHECK_INTERNED(v)) {
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000244 PyObject *o = PyDict_GetItem(p->strings, v);
245 if (o) {
246 long w = PyInt_AsLong(o);
247 w_byte(TYPE_STRINGREF, p);
248 w_long(w, p);
249 goto exit;
250 }
251 else {
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000252 int ok;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000253 o = PyInt_FromSsize_t(PyDict_Size(p->strings));
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000254 ok = o &&
255 PyDict_SetItem(p->strings, v, o) >= 0;
256 Py_XDECREF(o);
257 if (!ok) {
258 p->depth--;
259 p->error = 1;
260 return;
261 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000262 w_byte(TYPE_INTERNED, p);
263 }
264 }
265 else {
266 w_byte(TYPE_STRING, p);
267 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000268 n = PyString_GET_SIZE(v);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000269 if (n > INT_MAX) {
270 /* huge strings are not supported */
271 p->depth--;
272 p->error = 1;
273 return;
274 }
Guido van Rossum3a205f71995-02-17 15:10:07 +0000275 w_long((long)n, p);
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000276 w_string(PyString_AS_STRING(v), (int)n, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000277 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000278#ifdef Py_USING_UNICODE
Raymond Hettinger12e94202007-11-07 01:13:09 +0000279 else if (PyUnicode_CheckExact(v)) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000280 PyObject *utf8;
281 utf8 = PyUnicode_AsUTF8String(v);
282 if (utf8 == NULL) {
Guido van Rossum98626cd2000-06-28 23:24:19 +0000283 p->depth--;
284 p->error = 1;
285 return;
Guido van Rossumc279b532000-03-10 23:03:02 +0000286 }
287 w_byte(TYPE_UNICODE, p);
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000288 n = PyString_GET_SIZE(utf8);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000289 if (n > INT_MAX) {
290 p->depth--;
291 p->error = 1;
292 return;
293 }
Guido van Rossumc279b532000-03-10 23:03:02 +0000294 w_long((long)n, p);
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000295 w_string(PyString_AS_STRING(utf8), (int)n, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000296 Py_DECREF(utf8);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000297 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000298#endif
Raymond Hettinger12e94202007-11-07 01:13:09 +0000299 else if (PyTuple_CheckExact(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000300 w_byte(TYPE_TUPLE, p);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000301 n = PyTuple_Size(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000302 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000303 for (i = 0; i < n; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000304 w_object(PyTuple_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000305 }
306 }
Raymond Hettinger12e94202007-11-07 01:13:09 +0000307 else if (PyList_CheckExact(v)) {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000308 w_byte(TYPE_LIST, p);
Guido van Rossumc279b532000-03-10 23:03:02 +0000309 n = PyList_GET_SIZE(v);
Guido van Rossum3a205f71995-02-17 15:10:07 +0000310 w_long((long)n, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000311 for (i = 0; i < n; i++) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000312 w_object(PyList_GET_ITEM(v, i), p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000313 }
314 }
Raymond Hettinger12e94202007-11-07 01:13:09 +0000315 else if (PyDict_CheckExact(v)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000316 Py_ssize_t pos;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000317 PyObject *key, *value;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000318 w_byte(TYPE_DICT, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000319 /* This one is NULL object terminated! */
Guido van Rossum25831651993-05-19 14:50:45 +0000320 pos = 0;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000321 while (PyDict_Next(v, &pos, &key, &value)) {
Guido van Rossum25831651993-05-19 14:50:45 +0000322 w_object(key, p);
323 w_object(value, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000324 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000325 w_object((PyObject *)NULL, p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000326 }
Raymond Hettinger12e94202007-11-07 01:13:09 +0000327 else if (PyAnySet_CheckExact(v)) {
Raymond Hettingera422c342005-01-11 03:03:27 +0000328 PyObject *value, *it;
329
330 if (PyObject_TypeCheck(v, &PySet_Type))
331 w_byte(TYPE_SET, p);
332 else
333 w_byte(TYPE_FROZENSET, p);
334 n = PyObject_Size(v);
335 if (n == -1) {
336 p->depth--;
337 p->error = 1;
338 return;
339 }
340 w_long((long)n, p);
341 it = PyObject_GetIter(v);
342 if (it == NULL) {
343 p->depth--;
344 p->error = 1;
345 return;
346 }
347 while ((value = PyIter_Next(it)) != NULL) {
348 w_object(value, p);
349 Py_DECREF(value);
350 }
351 Py_DECREF(it);
352 if (PyErr_Occurred()) {
353 p->depth--;
354 p->error = 1;
355 return;
356 }
357 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000358 else if (PyCode_Check(v)) {
359 PyCodeObject *co = (PyCodeObject *)v;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000360 w_byte(TYPE_CODE, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000361 w_long(co->co_argcount, p);
362 w_long(co->co_nlocals, p);
363 w_long(co->co_stacksize, p);
364 w_long(co->co_flags, p);
Guido van Rossumd076c731998-10-07 19:42:25 +0000365 w_object(co->co_code, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000366 w_object(co->co_consts, p);
367 w_object(co->co_names, p);
Guido van Rossum681d79a1995-07-18 14:51:37 +0000368 w_object(co->co_varnames, p);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000369 w_object(co->co_freevars, p);
370 w_object(co->co_cellvars, p);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000371 w_object(co->co_filename, p);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000372 w_object(co->co_name, p);
Neal Norwitz7fdcb412002-06-14 01:07:39 +0000373 w_long(co->co_firstlineno, p);
Guido van Rossumd031c891997-01-24 03:44:17 +0000374 w_object(co->co_lnotab, p);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000375 }
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000376 else if (PyObject_CheckReadBuffer(v)) {
Guido van Rossumd076c731998-10-07 19:42:25 +0000377 /* Write unknown buffer-style objects as a string */
378 char *s;
Jeremy Hylton9f64caa2001-11-09 22:02:48 +0000379 PyBufferProcs *pb = v->ob_type->tp_as_buffer;
Guido van Rossumd076c731998-10-07 19:42:25 +0000380 w_byte(TYPE_STRING, p);
381 n = (*pb->bf_getreadbuffer)(v, 0, (void **)&s);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000382 if (n > INT_MAX) {
383 p->depth--;
384 p->error = 1;
385 return;
386 }
Guido van Rossumd076c731998-10-07 19:42:25 +0000387 w_long((long)n, p);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000388 w_string(s, (int)n, p);
Guido van Rossumd076c731998-10-07 19:42:25 +0000389 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000390 else {
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000391 w_byte(TYPE_UNKNOWN, p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000392 p->error = 1;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000393 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000394 exit:
Guido van Rossum98626cd2000-06-28 23:24:19 +0000395 p->depth--;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000396}
397
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000398/* version currently has no effect for writing longs. */
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000399void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000400PyMarshal_WriteLongToFile(long x, FILE *fp, int version)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000401{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000402 WFILE wf;
403 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000404 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +0000405 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000406 wf.strings = NULL;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000407 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000408 w_long(x, &wf);
409}
410
411void
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000412PyMarshal_WriteObjectToFile(PyObject *x, FILE *fp, int version)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000413{
414 WFILE wf;
415 wf.fp = fp;
Guido van Rossumf2150601996-06-26 20:41:23 +0000416 wf.error = 0;
Guido van Rossum98626cd2000-06-28 23:24:19 +0000417 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000418 wf.strings = (version > 0) ? PyDict_New() : NULL;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000419 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000420 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000421 Py_XDECREF(wf.strings);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000422}
423
424typedef WFILE RFILE; /* Same struct with different invariants */
425
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000426#define rs_byte(p) (((p)->ptr < (p)->end) ? (unsigned char)*(p)->ptr++ : EOF)
Guido van Rossum8d617a61995-03-09 12:12:11 +0000427
428#define r_byte(p) ((p)->fp ? getc((p)->fp) : rs_byte(p))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000429
430static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000431r_string(char *s, int n, RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000432{
433 if (p->fp != NULL)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000434 /* The result fits into int because it must be <=n. */
435 return (int)fread(s, 1, n, p->fp);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000436 if (p->end - p->ptr < n)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000437 n = (int)(p->end - p->ptr);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000438 memcpy(s, p->ptr, n);
439 p->ptr += n;
440 return n;
441}
442
443static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000444r_short(RFILE *p)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000445{
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000446 register short x;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000447 x = r_byte(p);
448 x |= r_byte(p) << 8;
Tim Peterse84b7402000-09-19 08:54:13 +0000449 /* Sign-extension, in case short greater than 16 bits */
450 x |= -(x & 0x8000);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000451 return x;
452}
453
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000454static long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000455r_long(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000456{
457 register long x;
Guido van Rossum8d617a61995-03-09 12:12:11 +0000458 register FILE *fp = p->fp;
459 if (fp) {
460 x = getc(fp);
461 x |= (long)getc(fp) << 8;
462 x |= (long)getc(fp) << 16;
463 x |= (long)getc(fp) << 24;
464 }
465 else {
466 x = rs_byte(p);
467 x |= (long)rs_byte(p) << 8;
468 x |= (long)rs_byte(p) << 16;
469 x |= (long)rs_byte(p) << 24;
470 }
Guido van Rossumc1547d91996-12-10 15:39:04 +0000471#if SIZEOF_LONG > 4
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000472 /* Sign extension for 64-bit machines */
Tim Peterse84b7402000-09-19 08:54:13 +0000473 x |= -(x & 0x80000000L);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000474#endif
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000475 return x;
476}
477
Tim Peters82112372001-08-29 02:28:42 +0000478/* r_long64 deals with the TYPE_INT64 code. On a machine with
479 sizeof(long) > 4, it returns a Python int object, else a Python long
480 object. Note that w_long64 writes out TYPE_INT if 32 bits is enough,
481 so there's no inefficiency here in returning a PyLong on 32-bit boxes
482 for everything written via TYPE_INT64 (i.e., if an int is written via
483 TYPE_INT64, it *needs* more than 32 bits).
484*/
485static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000486r_long64(RFILE *p)
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000487{
Tim Peters82112372001-08-29 02:28:42 +0000488 long lo4 = r_long(p);
489 long hi4 = r_long(p);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000490#if SIZEOF_LONG > 4
Tim Peters82112372001-08-29 02:28:42 +0000491 long x = (hi4 << 32) | (lo4 & 0xFFFFFFFFL);
492 return PyInt_FromLong(x);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000493#else
Tim Peters82112372001-08-29 02:28:42 +0000494 unsigned char buf[8];
495 int one = 1;
496 int is_little_endian = (int)*(char*)&one;
497 if (is_little_endian) {
498 memcpy(buf, &lo4, 4);
499 memcpy(buf+4, &hi4, 4);
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000500 }
Tim Peters82112372001-08-29 02:28:42 +0000501 else {
502 memcpy(buf, &hi4, 4);
503 memcpy(buf+4, &lo4, 4);
504 }
505 return _PyLong_FromByteArray(buf, 8, is_little_endian, 1);
Guido van Rossumc1547d91996-12-10 15:39:04 +0000506#endif
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000507}
508
Guido van Rossum79f25d91997-04-29 20:08:16 +0000509static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000510r_object(RFILE *p)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000511{
Armin Rigo01ab2792004-03-26 15:09:27 +0000512 /* NULL is a valid return value, it does not necessarily means that
513 an exception is set. */
Christian Heimes67ac0662008-01-30 11:46:00 +0000514 PyObject *v, *v2;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000515 long i, n;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000516 int type = r_byte(p);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000517 PyObject *retval;
518
519 p->depth++;
520
521 if (p->depth > MAX_MARSHAL_STACK_DEPTH) {
522 p->depth--;
523 PyErr_SetString(PyExc_ValueError, "recursion limit exceeded");
524 return NULL;
525 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000526
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000527 switch (type) {
Tim Petersd9b9ac82001-01-28 00:27:39 +0000528
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000529 case EOF:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000530 PyErr_SetString(PyExc_EOFError,
531 "EOF read where object expected");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000532 retval = NULL;
533 break;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000534
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000535 case TYPE_NULL:
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000536 retval = NULL;
537 break;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000538
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000539 case TYPE_NONE:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000540 Py_INCREF(Py_None);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000541 retval = Py_None;
542 break;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000543
Tim Peters5ca576e2001-06-18 22:08:13 +0000544 case TYPE_STOPITER:
545 Py_INCREF(PyExc_StopIteration);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000546 retval = PyExc_StopIteration;
547 break;
Tim Peters5ca576e2001-06-18 22:08:13 +0000548
Guido van Rossume449af71996-10-11 16:25:41 +0000549 case TYPE_ELLIPSIS:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000550 Py_INCREF(Py_Ellipsis);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000551 retval = Py_Ellipsis;
552 break;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000553
Guido van Rossum77f6a652002-04-03 22:41:51 +0000554 case TYPE_FALSE:
555 Py_INCREF(Py_False);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000556 retval = Py_False;
557 break;
Guido van Rossum77f6a652002-04-03 22:41:51 +0000558
559 case TYPE_TRUE:
560 Py_INCREF(Py_True);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000561 retval = Py_True;
562 break;
Guido van Rossum77f6a652002-04-03 22:41:51 +0000563
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000564 case TYPE_INT:
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000565 retval = PyInt_FromLong(r_long(p));
566 break;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000567
Guido van Rossumb0c168c1996-12-05 23:15:02 +0000568 case TYPE_INT64:
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000569 retval = r_long64(p);
570 break;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000571
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000572 case TYPE_LONG:
573 {
574 int size;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000575 PyLongObject *ob;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000576 n = r_long(p);
Armin Rigo7ccbca92006-10-04 12:17:45 +0000577 if (n < -INT_MAX || n > INT_MAX) {
578 PyErr_SetString(PyExc_ValueError,
579 "bad marshal data");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000580 retval = NULL;
581 break;
Armin Rigo7ccbca92006-10-04 12:17:45 +0000582 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000583 size = n<0 ? -n : n;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000584 ob = _PyLong_New(size);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000585 if (ob == NULL) {
586 retval = NULL;
587 break;
588 }
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000589 ob->ob_size = n;
Armin Rigo01ab2792004-03-26 15:09:27 +0000590 for (i = 0; i < size; i++) {
591 int digit = r_short(p);
592 if (digit < 0) {
593 Py_DECREF(ob);
594 PyErr_SetString(PyExc_ValueError,
595 "bad marshal data");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000596 ob = NULL;
597 break;
Armin Rigo01ab2792004-03-26 15:09:27 +0000598 }
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000599 if (ob != NULL)
600 ob->ob_digit[i] = digit;
Armin Rigo01ab2792004-03-26 15:09:27 +0000601 }
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000602 retval = (PyObject *)ob;
603 break;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000604 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000605
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000606 case TYPE_FLOAT:
607 {
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000608 char buf[256];
Guido van Rossum0ae748d1997-02-14 22:58:07 +0000609 double dx;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000610 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000611 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000612 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000613 "EOF read where object expected");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000614 retval = NULL;
615 break;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000616 }
617 buf[n] = '\0';
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000618 retval = NULL;
619 PyFPE_START_PROTECT("atof", break)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000620 dx = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000621 PyFPE_END_PROTECT(dx)
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000622 retval = PyFloat_FromDouble(dx);
623 break;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000624 }
Tim Petersd9b9ac82001-01-28 00:27:39 +0000625
Michael W. Hudsondf888462005-06-03 14:41:55 +0000626 case TYPE_BINARY_FLOAT:
627 {
Brett Cannonc9371d42005-06-25 08:23:41 +0000628 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000629 double x;
Brett Cannonc9371d42005-06-25 08:23:41 +0000630 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000631 PyErr_SetString(PyExc_EOFError,
632 "EOF read where object expected");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000633 retval = NULL;
634 break;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000635 }
636 x = _PyFloat_Unpack8(buf, 1);
637 if (x == -1.0 && PyErr_Occurred()) {
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000638 retval = NULL;
639 break;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000640 }
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000641 retval = PyFloat_FromDouble(x);
642 break;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000643 }
644
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000645#ifndef WITHOUT_COMPLEX
646 case TYPE_COMPLEX:
647 {
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000648 char buf[256];
Guido van Rossum530956d1996-07-21 02:27:43 +0000649 Py_complex c;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000650 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000651 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000652 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000653 "EOF read where object expected");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000654 retval = NULL;
655 break;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000656 }
657 buf[n] = '\0';
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000658 retval = NULL;
659 PyFPE_START_PROTECT("atof", break;)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000660 c.real = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000661 PyFPE_END_PROTECT(c)
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000662 n = r_byte(p);
Armin Rigo01ab2792004-03-26 15:09:27 +0000663 if (n == EOF || r_string(buf, (int)n, p) != n) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000664 PyErr_SetString(PyExc_EOFError,
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000665 "EOF read where object expected");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000666 retval = NULL;
667 break;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000668 }
669 buf[n] = '\0';
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000670 PyFPE_START_PROTECT("atof", break)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000671 c.imag = PyOS_ascii_atof(buf);
Guido van Rossum45b83911997-03-14 04:32:50 +0000672 PyFPE_END_PROTECT(c)
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000673 retval = PyComplex_FromCComplex(c);
674 break;
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000675 }
Michael W. Hudsondf888462005-06-03 14:41:55 +0000676
677 case TYPE_BINARY_COMPLEX:
678 {
Brett Cannonc9371d42005-06-25 08:23:41 +0000679 unsigned char buf[8];
Michael W. Hudsondf888462005-06-03 14:41:55 +0000680 Py_complex c;
Brett Cannonc9371d42005-06-25 08:23:41 +0000681 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000682 PyErr_SetString(PyExc_EOFError,
683 "EOF read where object expected");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000684 retval = NULL;
685 break;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000686 }
687 c.real = _PyFloat_Unpack8(buf, 1);
688 if (c.real == -1.0 && PyErr_Occurred()) {
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000689 retval = NULL;
690 break;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000691 }
Brett Cannonc9371d42005-06-25 08:23:41 +0000692 if (r_string((char*)buf, 8, p) != 8) {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000693 PyErr_SetString(PyExc_EOFError,
694 "EOF read where object expected");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000695 retval = NULL;
696 break;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000697 }
698 c.imag = _PyFloat_Unpack8(buf, 1);
699 if (c.imag == -1.0 && PyErr_Occurred()) {
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000700 retval = NULL;
701 break;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000702 }
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000703 retval = PyComplex_FromCComplex(c);
704 break;
Michael W. Hudsondf888462005-06-03 14:41:55 +0000705 }
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000706#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000707
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000708 case TYPE_INTERNED:
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000709 case TYPE_STRING:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000710 n = r_long(p);
Armin Rigo7ccbca92006-10-04 12:17:45 +0000711 if (n < 0 || n > INT_MAX) {
Guido van Rossuma45cb451998-06-08 20:27:29 +0000712 PyErr_SetString(PyExc_ValueError, "bad marshal data");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000713 retval = NULL;
714 break;
Guido van Rossuma45cb451998-06-08 20:27:29 +0000715 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000716 v = PyString_FromStringAndSize((char *)NULL, n);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000717 if (v == NULL) {
718 retval = NULL;
719 break;
720 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000721 if (r_string(PyString_AS_STRING(v), (int)n, p) != n) {
Michael W. Hudson6d6917b2005-06-03 15:17:16 +0000722 Py_DECREF(v);
723 PyErr_SetString(PyExc_EOFError,
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000724 "EOF read where object expected");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000725 retval = NULL;
726 break;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000727 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000728 if (type == TYPE_INTERNED) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000729 PyString_InternInPlace(&v);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000730 if (PyList_Append(p->strings, v) < 0) {
731 retval = NULL;
732 break;
733 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000734 }
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000735 retval = v;
736 break;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000737
738 case TYPE_STRINGREF:
739 n = r_long(p);
Michael W. Hudsonf2ca5af2005-06-13 18:28:46 +0000740 if (n < 0 || n >= PyList_GET_SIZE(p->strings)) {
741 PyErr_SetString(PyExc_ValueError, "bad marshal data");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000742 retval = NULL;
743 break;
Michael W. Hudsonf2ca5af2005-06-13 18:28:46 +0000744 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000745 v = PyList_GET_ITEM(p->strings, n);
746 Py_INCREF(v);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000747 retval = v;
748 break;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000749
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000750#ifdef Py_USING_UNICODE
Guido van Rossumc279b532000-03-10 23:03:02 +0000751 case TYPE_UNICODE:
752 {
753 char *buffer;
754
755 n = r_long(p);
Armin Rigo7ccbca92006-10-04 12:17:45 +0000756 if (n < 0 || n > INT_MAX) {
Guido van Rossumc279b532000-03-10 23:03:02 +0000757 PyErr_SetString(PyExc_ValueError, "bad marshal data");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000758 retval = NULL;
759 break;
Guido van Rossumc279b532000-03-10 23:03:02 +0000760 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000761 buffer = PyMem_NEW(char, n);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000762 if (buffer == NULL) {
763 retval = PyErr_NoMemory();
764 break;
765 }
Guido van Rossumc279b532000-03-10 23:03:02 +0000766 if (r_string(buffer, (int)n, p) != n) {
Guido van Rossumb18618d2000-05-03 23:44:39 +0000767 PyMem_DEL(buffer);
Guido van Rossumc279b532000-03-10 23:03:02 +0000768 PyErr_SetString(PyExc_EOFError,
769 "EOF read where object expected");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000770 retval = NULL;
771 break;
Guido van Rossumc279b532000-03-10 23:03:02 +0000772 }
773 v = PyUnicode_DecodeUTF8(buffer, n, NULL);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000774 PyMem_DEL(buffer);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000775 retval = v;
776 break;
Guido van Rossumc279b532000-03-10 23:03:02 +0000777 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000778#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +0000779
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000780 case TYPE_TUPLE:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000781 n = r_long(p);
Armin Rigo7ccbca92006-10-04 12:17:45 +0000782 if (n < 0 || n > INT_MAX) {
Guido van Rossuma45cb451998-06-08 20:27:29 +0000783 PyErr_SetString(PyExc_ValueError, "bad marshal data");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000784 retval = NULL;
785 break;
Guido van Rossuma45cb451998-06-08 20:27:29 +0000786 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000787 v = PyTuple_New((int)n);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000788 if (v == NULL) {
789 retval = NULL;
790 break;
791 }
Jack Jansen9513f2c1995-10-27 13:21:28 +0000792 for (i = 0; i < n; i++) {
793 v2 = r_object(p);
794 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000795 if (!PyErr_Occurred())
796 PyErr_SetString(PyExc_TypeError,
797 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000798 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000799 v = NULL;
800 break;
801 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000802 PyTuple_SET_ITEM(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000803 }
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000804 retval = v;
805 break;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000806
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000807 case TYPE_LIST:
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000808 n = r_long(p);
Armin Rigo7ccbca92006-10-04 12:17:45 +0000809 if (n < 0 || n > INT_MAX) {
Guido van Rossuma45cb451998-06-08 20:27:29 +0000810 PyErr_SetString(PyExc_ValueError, "bad marshal data");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000811 retval = NULL;
812 break;
Guido van Rossuma45cb451998-06-08 20:27:29 +0000813 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000814 v = PyList_New((int)n);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000815 if (v == NULL) {
816 retval = NULL;
817 break;
818 }
Jack Jansen9513f2c1995-10-27 13:21:28 +0000819 for (i = 0; i < n; i++) {
820 v2 = r_object(p);
821 if ( v2 == NULL ) {
Armin Rigo01ab2792004-03-26 15:09:27 +0000822 if (!PyErr_Occurred())
823 PyErr_SetString(PyExc_TypeError,
824 "NULL object in marshal data");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000825 Py_DECREF(v);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000826 v = NULL;
827 break;
828 }
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000829 PyList_SET_ITEM(v, (int)i, v2);
Jack Jansen9513f2c1995-10-27 13:21:28 +0000830 }
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000831 retval = v;
832 break;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000833
Guido van Rossum64b45521991-06-07 13:58:22 +0000834 case TYPE_DICT:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000835 v = PyDict_New();
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000836 if (v == NULL) {
837 retval = NULL;
838 break;
839 }
Guido van Rossum64b45521991-06-07 13:58:22 +0000840 for (;;) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000841 PyObject *key, *val;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000842 key = r_object(p);
Guido van Rossum64b45521991-06-07 13:58:22 +0000843 if (key == NULL)
Armin Rigo01ab2792004-03-26 15:09:27 +0000844 break;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +0000845 val = r_object(p);
Guido van Rossumf2150601996-06-26 20:41:23 +0000846 if (val != NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000847 PyDict_SetItem(v, key, val);
848 Py_DECREF(key);
849 Py_XDECREF(val);
Guido van Rossum64b45521991-06-07 13:58:22 +0000850 }
Armin Rigo01ab2792004-03-26 15:09:27 +0000851 if (PyErr_Occurred()) {
852 Py_DECREF(v);
853 v = NULL;
854 }
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000855 retval = v;
856 break;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000857
Raymond Hettingera422c342005-01-11 03:03:27 +0000858 case TYPE_SET:
859 case TYPE_FROZENSET:
860 n = r_long(p);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000861 if (n < 0 || n > INT_MAX) {
Raymond Hettingera422c342005-01-11 03:03:27 +0000862 PyErr_SetString(PyExc_ValueError, "bad marshal data");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000863 retval = NULL;
864 break;
Raymond Hettingera422c342005-01-11 03:03:27 +0000865 }
Raymond Hettinger52716c92008-01-28 21:34:30 +0000866 v = (type == TYPE_SET) ? PySet_New(NULL) : PyFrozenSet_New(NULL);
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000867 if (v == NULL) {
868 retval = NULL;
869 break;
870 }
Raymond Hettingera422c342005-01-11 03:03:27 +0000871 for (i = 0; i < n; i++) {
872 v2 = r_object(p);
873 if ( v2 == NULL ) {
874 if (!PyErr_Occurred())
875 PyErr_SetString(PyExc_TypeError,
876 "NULL object in marshal data");
877 Py_DECREF(v);
878 v = NULL;
879 break;
880 }
Raymond Hettinger52716c92008-01-28 21:34:30 +0000881 if (PySet_Add(v, v2) == -1) {
882 Py_DECREF(v);
883 Py_DECREF(v2);
884 v = NULL;
885 break;
886 }
Neal Norwitzfb43d1e2008-02-01 07:22:59 +0000887 Py_DECREF(v2);
Raymond Hettingera422c342005-01-11 03:03:27 +0000888 }
Raymond Hettingerbf3d1d52008-01-28 21:51:25 +0000889 retval = v;
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000890 break;
Raymond Hettingera422c342005-01-11 03:03:27 +0000891
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000892 case TYPE_CODE:
Michael W. Hudson80199132001-08-30 14:50:20 +0000893 if (PyEval_GetRestricted()) {
894 PyErr_SetString(PyExc_RuntimeError,
895 "cannot unmarshal code objects in "
896 "restricted execution mode");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000897 retval = NULL;
898 break;
Michael W. Hudson80199132001-08-30 14:50:20 +0000899 }
900 else {
Michael W. Hudsondf888462005-06-03 14:41:55 +0000901 int argcount;
902 int nlocals;
903 int stacksize;
904 int flags;
905 PyObject *code = NULL;
906 PyObject *consts = NULL;
907 PyObject *names = NULL;
908 PyObject *varnames = NULL;
909 PyObject *freevars = NULL;
910 PyObject *cellvars = NULL;
911 PyObject *filename = NULL;
912 PyObject *name = NULL;
913 int firstlineno;
914 PyObject *lnotab = NULL;
915
916 v = NULL;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000917
Armin Rigo7ccbca92006-10-04 12:17:45 +0000918 /* XXX ignore long->int overflows for now */
919 argcount = (int)r_long(p);
920 nlocals = (int)r_long(p);
921 stacksize = (int)r_long(p);
922 flags = (int)r_long(p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000923 code = r_object(p);
924 if (code == NULL)
925 goto code_error;
926 consts = r_object(p);
927 if (consts == NULL)
928 goto code_error;
929 names = r_object(p);
930 if (names == NULL)
931 goto code_error;
932 varnames = r_object(p);
933 if (varnames == NULL)
934 goto code_error;
935 freevars = r_object(p);
936 if (freevars == NULL)
937 goto code_error;
938 cellvars = r_object(p);
939 if (cellvars == NULL)
940 goto code_error;
941 filename = r_object(p);
942 if (filename == NULL)
943 goto code_error;
944 name = r_object(p);
945 if (name == NULL)
946 goto code_error;
Armin Rigo7ccbca92006-10-04 12:17:45 +0000947 firstlineno = (int)r_long(p);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000948 lnotab = r_object(p);
949 if (lnotab == NULL)
950 goto code_error;
951
952 v = (PyObject *) PyCode_New(
Tim Petersd9b9ac82001-01-28 00:27:39 +0000953 argcount, nlocals, stacksize, flags,
Guido van Rossum681d79a1995-07-18 14:51:37 +0000954 code, consts, names, varnames,
Tim Petersd9b9ac82001-01-28 00:27:39 +0000955 freevars, cellvars, filename, name,
956 firstlineno, lnotab);
Michael W. Hudsondf888462005-06-03 14:41:55 +0000957
958 code_error:
Guido van Rossum79f25d91997-04-29 20:08:16 +0000959 Py_XDECREF(code);
960 Py_XDECREF(consts);
961 Py_XDECREF(names);
962 Py_XDECREF(varnames);
Jeremy Hylton64949cb2001-01-25 20:06:59 +0000963 Py_XDECREF(freevars);
964 Py_XDECREF(cellvars);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000965 Py_XDECREF(filename);
966 Py_XDECREF(name);
Guido van Rossum6fc06e71997-07-26 23:30:18 +0000967 Py_XDECREF(lnotab);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000968
969 }
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000970 retval = v;
971 break;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000972
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000973 default:
Guido van Rossumf2150601996-06-26 20:41:23 +0000974 /* Bogus data got written, which isn't ideal.
975 This will let you keep working and recover. */
Guido van Rossuma45cb451998-06-08 20:27:29 +0000976 PyErr_SetString(PyExc_ValueError, "bad marshal data");
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000977 retval = NULL;
978 break;
Tim Petersd9b9ac82001-01-28 00:27:39 +0000979
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000980 }
Neal Norwitzb1a9b372007-05-16 20:05:11 +0000981 p->depth--;
982 return retval;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +0000983}
984
Neal Norwitzd85c4522004-06-13 20:31:49 +0000985static PyObject *
Armin Rigo01ab2792004-03-26 15:09:27 +0000986read_object(RFILE *p)
987{
988 PyObject *v;
989 if (PyErr_Occurred()) {
990 fprintf(stderr, "XXX readobject called with exception set\n");
991 return NULL;
992 }
993 v = r_object(p);
994 if (v == NULL && !PyErr_Occurred())
995 PyErr_SetString(PyExc_TypeError, "NULL object in marshal data");
996 return v;
997}
998
Guido van Rossumb8cf3e62001-10-19 01:46:21 +0000999int
1000PyMarshal_ReadShortFromFile(FILE *fp)
1001{
1002 RFILE rf;
Thomas Wouters7f401ef2006-03-01 22:30:47 +00001003 assert(fp);
Guido van Rossumb8cf3e62001-10-19 01:46:21 +00001004 rf.fp = fp;
Thomas Wouters7464b432006-03-01 22:34:09 +00001005 rf.strings = NULL;
1006 rf.end = rf.ptr = NULL;
Guido van Rossumb8cf3e62001-10-19 01:46:21 +00001007 return r_short(&rf);
1008}
1009
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001010long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001011PyMarshal_ReadLongFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001012{
1013 RFILE rf;
1014 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001015 rf.strings = NULL;
Neal Norwitz15f26612007-10-12 03:05:19 +00001016 rf.ptr = rf.end = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001017 return r_long(&rf);
1018}
1019
Tim Peters691e0e92001-01-18 04:39:16 +00001020#ifdef HAVE_FSTAT
1021/* Return size of file in bytes; < 0 if unknown. */
1022static off_t
1023getfilesize(FILE *fp)
1024{
1025 struct stat st;
1026 if (fstat(fileno(fp), &st) != 0)
1027 return -1;
1028 else
1029 return st.st_size;
1030}
1031#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +00001032
Tim Peters691e0e92001-01-18 04:39:16 +00001033/* If we can get the size of the file up-front, and it's reasonably small,
1034 * read it in one gulp and delegate to ...FromString() instead. Much quicker
1035 * than reading a byte at a time from file; speeds .pyc imports.
Tim Petersd9b9ac82001-01-28 00:27:39 +00001036 * CAUTION: since this may read the entire remainder of the file, don't
1037 * call it unless you know you're done with the file.
Tim Peters691e0e92001-01-18 04:39:16 +00001038 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001039PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +00001040PyMarshal_ReadLastObjectFromFile(FILE *fp)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001041{
Tim Peters691e0e92001-01-18 04:39:16 +00001042/* 75% of 2.1's .pyc files can exploit SMALL_FILE_LIMIT.
1043 * REASONABLE_FILE_LIMIT is by defn something big enough for Tkinter.pyc.
1044 */
1045#define SMALL_FILE_LIMIT (1L << 14)
1046#define REASONABLE_FILE_LIMIT (1L << 18)
Tim Peters691e0e92001-01-18 04:39:16 +00001047#ifdef HAVE_FSTAT
1048 off_t filesize;
1049#endif
Tim Peters691e0e92001-01-18 04:39:16 +00001050#ifdef HAVE_FSTAT
1051 filesize = getfilesize(fp);
1052 if (filesize > 0) {
1053 char buf[SMALL_FILE_LIMIT];
1054 char* pBuf = NULL;
1055 if (filesize <= SMALL_FILE_LIMIT)
1056 pBuf = buf;
1057 else if (filesize <= REASONABLE_FILE_LIMIT)
1058 pBuf = (char *)PyMem_MALLOC(filesize);
1059 if (pBuf != NULL) {
1060 PyObject* v;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001061 size_t n;
1062 /* filesize must fit into an int, because it
1063 is smaller than REASONABLE_FILE_LIMIT */
1064 n = fread(pBuf, 1, (int)filesize, fp);
Tim Peters691e0e92001-01-18 04:39:16 +00001065 v = PyMarshal_ReadObjectFromString(pBuf, n);
1066 if (pBuf != buf)
1067 PyMem_FREE(pBuf);
1068 return v;
1069 }
Tim Petersd9b9ac82001-01-28 00:27:39 +00001070
Tim Peters691e0e92001-01-18 04:39:16 +00001071 }
1072#endif
Tim Petersd9b9ac82001-01-28 00:27:39 +00001073 /* We don't have fstat, or we do but the file is larger than
1074 * REASONABLE_FILE_LIMIT or malloc failed -- read a byte at a time.
1075 */
1076 return PyMarshal_ReadObjectFromFile(fp);
1077
Tim Peters691e0e92001-01-18 04:39:16 +00001078#undef SMALL_FILE_LIMIT
1079#undef REASONABLE_FILE_LIMIT
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001080}
1081
Guido van Rossum79f25d91997-04-29 20:08:16 +00001082PyObject *
Tim Petersd9b9ac82001-01-28 00:27:39 +00001083PyMarshal_ReadObjectFromFile(FILE *fp)
1084{
1085 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001086 PyObject *result;
Tim Petersd9b9ac82001-01-28 00:27:39 +00001087 rf.fp = fp;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001088 rf.strings = PyList_New(0);
Neal Norwitzb1a9b372007-05-16 20:05:11 +00001089 rf.depth = 0;
Neal Norwitz15f26612007-10-12 03:05:19 +00001090 rf.ptr = rf.end = NULL;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001091 result = r_object(&rf);
1092 Py_DECREF(rf.strings);
1093 return result;
Tim Petersd9b9ac82001-01-28 00:27:39 +00001094}
1095
1096PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001097PyMarshal_ReadObjectFromString(char *str, Py_ssize_t len)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001098{
1099 RFILE rf;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001100 PyObject *result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001101 rf.fp = NULL;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001102 rf.ptr = str;
1103 rf.end = str + len;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001104 rf.strings = PyList_New(0);
Neal Norwitzb1a9b372007-05-16 20:05:11 +00001105 rf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001106 result = r_object(&rf);
1107 Py_DECREF(rf.strings);
1108 return result;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001109}
1110
Guido van Rossum79f25d91997-04-29 20:08:16 +00001111PyObject *
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001112PyMarshal_WriteObjectToString(PyObject *x, int version)
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001113{
1114 WFILE wf;
1115 wf.fp = NULL;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001116 wf.str = PyString_FromStringAndSize((char *)NULL, 50);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001117 if (wf.str == NULL)
1118 return NULL;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001119 wf.ptr = PyString_AS_STRING((PyStringObject *)wf.str);
1120 wf.end = wf.ptr + PyString_Size(wf.str);
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001121 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +00001122 wf.depth = 0;
Michael W. Hudsondf888462005-06-03 14:41:55 +00001123 wf.version = version;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001124 wf.strings = (version > 0) ? PyDict_New() : NULL;
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001125 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001126 Py_XDECREF(wf.strings);
Armin Rigo7ccbca92006-10-04 12:17:45 +00001127 if (wf.str != NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001128 char *base = PyString_AS_STRING((PyStringObject *)wf.str);
Armin Rigo7ccbca92006-10-04 12:17:45 +00001129 if (wf.ptr - base > PY_SSIZE_T_MAX) {
1130 Py_DECREF(wf.str);
1131 PyErr_SetString(PyExc_OverflowError,
1132 "too much marshall data for a string");
1133 return NULL;
1134 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001135 _PyString_Resize(&wf.str, (Py_ssize_t)(wf.ptr - base));
Armin Rigo7ccbca92006-10-04 12:17:45 +00001136 }
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001137 if (wf.error) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001138 Py_XDECREF(wf.str);
Tim Petersd9b9ac82001-01-28 00:27:39 +00001139 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +00001140 (wf.error==1)?"unmarshallable object"
1141 :"object too deeply nested to marshal");
Guido van Rossum3f3bb3d1996-08-19 22:07:17 +00001142 return NULL;
1143 }
1144 return wf.str;
1145}
1146
Guido van Rossum64b45521991-06-07 13:58:22 +00001147/* And an interface for Python programs... */
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001148
Guido van Rossum79f25d91997-04-29 20:08:16 +00001149static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001150marshal_dump(PyObject *self, PyObject *args)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001151{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001152 WFILE wf;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001153 PyObject *x;
1154 PyObject *f;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001155 int version = Py_MARSHAL_VERSION;
1156 if (!PyArg_ParseTuple(args, "OO|i:dump", &x, &f, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001157 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001158 if (!PyFile_Check(f)) {
1159 PyErr_SetString(PyExc_TypeError,
1160 "marshal.dump() 2nd arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001161 return NULL;
1162 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001163 wf.fp = PyFile_AsFile(f);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001164 wf.str = NULL;
1165 wf.ptr = wf.end = NULL;
Guido van Rossumf2150601996-06-26 20:41:23 +00001166 wf.error = 0;
Fred Drake6da0b912000-06-28 18:47:56 +00001167 wf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001168 wf.strings = (version > 0) ? PyDict_New() : 0;
Neal Norwitzef785292005-11-16 05:04:51 +00001169 wf.version = version;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001170 w_object(x, &wf);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001171 Py_XDECREF(wf.strings);
Guido van Rossumf2150601996-06-26 20:41:23 +00001172 if (wf.error) {
Tim Petersd9b9ac82001-01-28 00:27:39 +00001173 PyErr_SetString(PyExc_ValueError,
Fred Drake6da0b912000-06-28 18:47:56 +00001174 (wf.error==1)?"unmarshallable object"
1175 :"object too deeply nested to marshal");
Guido van Rossumf2150601996-06-26 20:41:23 +00001176 return NULL;
1177 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001178 Py_INCREF(Py_None);
1179 return Py_None;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001180}
1181
R. David Murray666f1832009-05-13 01:08:35 +00001182PyDoc_STRVAR(dump_doc,
1183"dump(value, file[, version])\n\
1184\n\
1185Write the value on the open file. The value must be a supported type.\n\
1186The file must be an open file object such as sys.stdout or returned by\n\
1187open() or os.popen(). It must be opened in binary mode ('wb' or 'w+b').\n\
1188\n\
1189If the value has (or contains an object that has) an unsupported type, a\n\
1190ValueError exception is raised but garbage data will also be written\n\
1191to the file. The object will not be properly read back by load()\n\
1192\n\
1193New in version 2.4: The version argument indicates the data format that\n\
1194dump should use.");
1195
Guido van Rossum79f25d91997-04-29 20:08:16 +00001196static PyObject *
Georg Brandlbf92f462006-05-29 21:58:42 +00001197marshal_load(PyObject *self, PyObject *f)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001198{
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001199 RFILE rf;
Georg Brandlbf92f462006-05-29 21:58:42 +00001200 PyObject *result;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001201 if (!PyFile_Check(f)) {
1202 PyErr_SetString(PyExc_TypeError,
1203 "marshal.load() arg must be file");
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001204 return NULL;
1205 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001206 rf.fp = PyFile_AsFile(f);
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001207 rf.strings = PyList_New(0);
Neal Norwitzb1a9b372007-05-16 20:05:11 +00001208 rf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001209 result = read_object(&rf);
1210 Py_DECREF(rf.strings);
1211 return result;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001212}
1213
R. David Murray666f1832009-05-13 01:08:35 +00001214PyDoc_STRVAR(load_doc,
1215"load(file)\n\
1216\n\
1217Read one value from the open file and return it. If no valid value is\n\
1218read (e.g. because the data has a different Python versions\n\
1219incompatible marshal format), raise EOFError, ValueError or TypeError.\n\
1220The file must be an open file object opened in binary mode ('rb' or\n\
1221'r+b').\n\
1222\n\
1223Note: If an object containing an unsupported type was marshalled with\n\
1224dump(), load() will substitute None for the unmarshallable type.");
1225
1226
Guido van Rossum79f25d91997-04-29 20:08:16 +00001227static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001228marshal_dumps(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001229{
Guido van Rossum79f25d91997-04-29 20:08:16 +00001230 PyObject *x;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001231 int version = Py_MARSHAL_VERSION;
Armin Rigo2ccea172004-12-20 12:25:57 +00001232 if (!PyArg_ParseTuple(args, "O|i:dumps", &x, &version))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001233 return NULL;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001234 return PyMarshal_WriteObjectToString(x, version);
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001235}
1236
R. David Murray666f1832009-05-13 01:08:35 +00001237PyDoc_STRVAR(dumps_doc,
1238"dumps(value[, version])\n\
1239\n\
1240Return the string that would be written to a file by dump(value, file).\n\
1241The value must be a supported type. Raise a ValueError exception if\n\
1242value has (or contains an object that has) an unsupported type.\n\
1243\n\
1244New in version 2.4: The version argument indicates the data format that\n\
R. David Murray98c78792009-05-13 13:13:18 +00001245dumps should use.");
R. David Murray666f1832009-05-13 01:08:35 +00001246
1247
Guido van Rossum79f25d91997-04-29 20:08:16 +00001248static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001249marshal_loads(PyObject *self, PyObject *args)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001250{
1251 RFILE rf;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001252 char *s;
Thomas Wouters695934a2006-03-01 23:49:13 +00001253 Py_ssize_t n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001254 PyObject* result;
Michael W. Hudson01fca112005-06-13 17:50:18 +00001255 if (!PyArg_ParseTuple(args, "s#:loads", &s, &n))
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001256 return NULL;
1257 rf.fp = NULL;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00001258 rf.ptr = s;
1259 rf.end = s + n;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001260 rf.strings = PyList_New(0);
Neal Norwitzb1a9b372007-05-16 20:05:11 +00001261 rf.depth = 0;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001262 result = read_object(&rf);
1263 Py_DECREF(rf.strings);
1264 return result;
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001265}
1266
R. David Murray666f1832009-05-13 01:08:35 +00001267PyDoc_STRVAR(loads_doc,
1268"loads(string)\n\
1269\n\
1270Convert the string to a value. If no valid value is found, raise\n\
1271EOFError, ValueError or TypeError. Extra characters in the string are\n\
1272ignored.");
1273
Guido van Rossum79f25d91997-04-29 20:08:16 +00001274static PyMethodDef marshal_methods[] = {
R. David Murray666f1832009-05-13 01:08:35 +00001275 {"dump", marshal_dump, METH_VARARGS, dump_doc},
1276 {"load", marshal_load, METH_O, load_doc},
1277 {"dumps", marshal_dumps, METH_VARARGS, dumps_doc},
1278 {"loads", marshal_loads, METH_VARARGS, loads_doc},
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001279 {NULL, NULL} /* sentinel */
1280};
1281
R. David Murray666f1832009-05-13 01:08:35 +00001282PyDoc_STRVAR(marshal_doc,
1283"This module contains functions that can read and write Python values in\n\
1284a binary format. The format is specific to Python, but independent of\n\
1285machine architecture issues.\n\
1286\n\
1287Not all Python object types are supported; in general, only objects\n\
1288whose value is independent from a particular invocation of Python can be\n\
1289written and read by this module. The following types are supported:\n\
1290None, integers, long integers, floating point numbers, strings, Unicode\n\
1291objects, tuples, lists, sets, dictionaries, and code objects, where it\n\
1292should be understood that tuples, lists and dictionaries are only\n\
1293supported as long as the values contained therein are themselves\n\
1294supported; and recursive lists and dictionaries should not be written\n\
1295(they will cause infinite loops).\n\
1296\n\
1297Variables:\n\
1298\n\
1299version -- indicates the format that the module uses. Version 0 is the\n\
1300 historical format, version 1 (added in Python 2.4) shares interned\n\
1301 strings and version 2 (added in Python 2.5) uses a binary format for\n\
1302 floating point numbers. (New in version 2.4)\n\
1303\n\
1304Functions:\n\
1305\n\
1306dump() -- write value to a file\n\
1307load() -- read value from a file\n\
1308dumps() -- write value to a string\n\
1309loads() -- read value from a string");
1310
1311
Jason Tishler6bc06ec2003-09-04 11:59:50 +00001312PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001313PyMarshal_Init(void)
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001314{
R. David Murray666f1832009-05-13 01:08:35 +00001315 PyObject *mod = Py_InitModule3("marshal", marshal_methods,
1316 marshal_doc);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00001317 if (mod == NULL)
1318 return;
Martin v. Löwisef82d2f2004-06-27 16:51:46 +00001319 PyModule_AddIntConstant(mod, "version", Py_MARSHAL_VERSION);
Guido van Rossumdce2e3d1991-06-04 19:42:30 +00001320}