blob: 226a5d275058cb210ad6e960f770eee7263e2ec8 [file] [log] [blame]
Guido van Rossuma9e20242007-03-08 00:43:48 +00001/* Author: Daniel Stutzbach */
2
3#define PY_SSIZE_T_CLEAN
4#include "Python.h"
Antoine Pitroue033e062010-10-29 10:38:18 +00005#include "structmember.h"
Benjamin Peterson2614cda2010-03-21 22:36:19 +00006#ifdef HAVE_SYS_TYPES_H
Guido van Rossuma9e20242007-03-08 00:43:48 +00007#include <sys/types.h>
Benjamin Peterson2614cda2010-03-21 22:36:19 +00008#endif
9#ifdef HAVE_SYS_STAT_H
Guido van Rossuma9e20242007-03-08 00:43:48 +000010#include <sys/stat.h>
Benjamin Peterson2614cda2010-03-21 22:36:19 +000011#endif
12#ifdef HAVE_FCNTL_H
Guido van Rossuma9e20242007-03-08 00:43:48 +000013#include <fcntl.h>
Benjamin Peterson2614cda2010-03-21 22:36:19 +000014#endif
Guido van Rossuma9e20242007-03-08 00:43:48 +000015#include <stddef.h> /* For offsetof */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000016#include "_iomodule.h"
Guido van Rossuma9e20242007-03-08 00:43:48 +000017
18/*
19 * Known likely problems:
20 *
21 * - Files larger then 2**32-1
22 * - Files with unicode filenames
23 * - Passing numbers greater than 2**32-1 when an integer is expected
24 * - Making it work on Windows and other oddball platforms
25 *
26 * To Do:
27 *
28 * - autoconfify header file inclusion
Guido van Rossuma9e20242007-03-08 00:43:48 +000029 */
30
31#ifdef MS_WINDOWS
32/* can simulate truncate with Win32 API functions; see file_truncate */
Thomas Hellerfdeee3a2007-07-12 11:21:36 +000033#define HAVE_FTRUNCATE
Guido van Rossuma9e20242007-03-08 00:43:48 +000034#define WIN32_LEAN_AND_MEAN
35#include <windows.h>
36#endif
37
Christian Heimesa872de52008-12-05 08:26:55 +000038#if BUFSIZ < (8*1024)
39#define SMALLCHUNK (8*1024)
40#elif (BUFSIZ >= (2 << 25))
41#error "unreasonable BUFSIZ > 64MB defined"
42#else
43#define SMALLCHUNK BUFSIZ
44#endif
45
Guido van Rossuma9e20242007-03-08 00:43:48 +000046typedef struct {
Antoine Pitrouae4b4722010-05-05 16:31:07 +000047 PyObject_HEAD
48 int fd;
Charles-François Natalidc3044c2012-01-09 22:40:02 +010049 unsigned int created : 1;
Antoine Pitrouae4b4722010-05-05 16:31:07 +000050 unsigned int readable : 1;
51 unsigned int writable : 1;
52 signed int seekable : 2; /* -1 means unknown */
53 unsigned int closefd : 1;
Antoine Pitroue033e062010-10-29 10:38:18 +000054 unsigned int deallocating: 1;
Antoine Pitrouae4b4722010-05-05 16:31:07 +000055 PyObject *weakreflist;
56 PyObject *dict;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +000057} fileio;
Guido van Rossuma9e20242007-03-08 00:43:48 +000058
Collin Winteraf334382007-03-08 21:46:15 +000059PyTypeObject PyFileIO_Type;
60
Guido van Rossuma9e20242007-03-08 00:43:48 +000061#define PyFileIO_Check(op) (PyObject_TypeCheck((op), &PyFileIO_Type))
62
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000063int
64_PyFileIO_closed(PyObject *self)
65{
Antoine Pitrouae4b4722010-05-05 16:31:07 +000066 return ((fileio *)self)->fd < 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000067}
Antoine Pitrou08838b62009-01-21 00:55:13 +000068
Antoine Pitroue033e062010-10-29 10:38:18 +000069/* Because this can call arbitrary code, it shouldn't be called when
70 the refcount is 0 (that is, not directly from tp_dealloc unless
71 the refcount has been temporarily re-incremented). */
72static PyObject *
73fileio_dealloc_warn(fileio *self, PyObject *source)
74{
75 if (self->fd >= 0 && self->closefd) {
76 PyObject *exc, *val, *tb;
77 PyErr_Fetch(&exc, &val, &tb);
78 if (PyErr_WarnFormat(PyExc_ResourceWarning, 1,
79 "unclosed file %R", source)) {
80 /* Spurious errors can appear at shutdown */
81 if (PyErr_ExceptionMatches(PyExc_Warning))
82 PyErr_WriteUnraisable((PyObject *) self);
83 }
84 PyErr_Restore(exc, val, tb);
85 }
86 Py_RETURN_NONE;
87}
88
Antoine Pitrou7fb111b2009-03-04 11:14:01 +000089static PyObject *
90portable_lseek(int fd, PyObject *posobj, int whence);
91
Antoine Pitroua28fcfd2009-03-13 23:42:55 +000092static PyObject *portable_lseek(int fd, PyObject *posobj, int whence);
93
Kristján Valur Jónsson19288c22008-12-18 17:15:54 +000094/* Returns 0 on success, -1 with exception set on failure. */
Neal Norwitz88b44da2007-08-12 17:23:54 +000095static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +000096internal_close(fileio *self)
Guido van Rossuma9e20242007-03-08 00:43:48 +000097{
Antoine Pitrouae4b4722010-05-05 16:31:07 +000098 int err = 0;
99 int save_errno = 0;
100 if (self->fd >= 0) {
101 int fd = self->fd;
102 self->fd = -1;
103 /* fd is accessible and someone else may have closed it */
104 if (_PyVerify_fd(fd)) {
105 Py_BEGIN_ALLOW_THREADS
106 err = close(fd);
107 if (err < 0)
108 save_errno = errno;
109 Py_END_ALLOW_THREADS
110 } else {
111 save_errno = errno;
112 err = -1;
113 }
114 }
115 if (err < 0) {
116 errno = save_errno;
117 PyErr_SetFromErrno(PyExc_IOError);
118 return -1;
119 }
120 return 0;
Neal Norwitz88b44da2007-08-12 17:23:54 +0000121}
122
123static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000124fileio_close(fileio *self)
Neal Norwitz88b44da2007-08-12 17:23:54 +0000125{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200126 _Py_IDENTIFIER(close);
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000127 if (!self->closefd) {
128 self->fd = -1;
129 Py_RETURN_NONE;
130 }
Antoine Pitroue033e062010-10-29 10:38:18 +0000131 if (self->deallocating) {
132 PyObject *r = fileio_dealloc_warn(self, (PyObject *) self);
133 if (r)
134 Py_DECREF(r);
135 else
136 PyErr_Clear();
137 }
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000138 errno = internal_close(self);
139 if (errno < 0)
140 return NULL;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000141
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200142 return _PyObject_CallMethodId((PyObject*)&PyRawIOBase_Type,
143 &PyId_close, "O", self);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000144}
145
146static PyObject *
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000147fileio_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000148{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000149 fileio *self;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000150
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000151 assert(type != NULL && type->tp_alloc != NULL);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000152
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000153 self = (fileio *) type->tp_alloc(type, 0);
154 if (self != NULL) {
155 self->fd = -1;
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100156 self->created = 0;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000157 self->readable = 0;
158 self->writable = 0;
159 self->seekable = -1;
160 self->closefd = 1;
161 self->weakreflist = NULL;
162 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000163
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000164 return (PyObject *) self;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000165}
166
167/* On Unix, open will succeed for directories.
168 In Python, there should be no file objects referring to
169 directories, so we need a check. */
170
171static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000172dircheck(fileio* self, const char *name)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000173{
174#if defined(HAVE_FSTAT) && defined(S_IFDIR) && defined(EISDIR)
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000175 struct stat buf;
176 if (self->fd < 0)
177 return 0;
178 if (fstat(self->fd, &buf) == 0 && S_ISDIR(buf.st_mode)) {
179 char *msg = strerror(EISDIR);
180 PyObject *exc;
181 if (internal_close(self))
182 return -1;
Guido van Rossum53807da2007-04-10 19:01:47 +0000183
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000184 exc = PyObject_CallFunction(PyExc_IOError, "(iss)",
185 EISDIR, msg, name);
186 PyErr_SetObject(PyExc_IOError, exc);
187 Py_XDECREF(exc);
188 return -1;
189 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000190#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000191 return 0;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000192}
193
Benjamin Peterson806d4022009-01-19 15:11:51 +0000194static int
195check_fd(int fd)
196{
197#if defined(HAVE_FSTAT)
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000198 struct stat buf;
199 if (!_PyVerify_fd(fd) || (fstat(fd, &buf) < 0 && errno == EBADF)) {
200 PyObject *exc;
201 char *msg = strerror(EBADF);
202 exc = PyObject_CallFunction(PyExc_OSError, "(is)",
203 EBADF, msg);
204 PyErr_SetObject(PyExc_OSError, exc);
205 Py_XDECREF(exc);
206 return -1;
207 }
Benjamin Peterson806d4022009-01-19 15:11:51 +0000208#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000209 return 0;
Benjamin Peterson806d4022009-01-19 15:11:51 +0000210}
211
Guido van Rossuma9e20242007-03-08 00:43:48 +0000212
213static int
214fileio_init(PyObject *oself, PyObject *args, PyObject *kwds)
215{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000216 fileio *self = (fileio *) oself;
Ross Lagerwall59142db2011-10-31 20:34:46 +0200217 static char *kwlist[] = {"file", "mode", "closefd", "opener", NULL};
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000218 const char *name = NULL;
Ross Lagerwall59142db2011-10-31 20:34:46 +0200219 PyObject *nameobj, *stringobj = NULL, *opener = Py_None;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000220 char *mode = "r";
221 char *s;
Thomas Helleraf2be262007-07-12 11:03:13 +0000222#ifdef MS_WINDOWS
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000223 Py_UNICODE *widename = NULL;
Thomas Helleraf2be262007-07-12 11:03:13 +0000224#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000225 int ret = 0;
226 int rwa = 0, plus = 0, append = 0;
227 int flags = 0;
228 int fd = -1;
229 int closefd = 1;
Hynek Schlawack9ed8b4e2012-06-21 20:20:25 +0200230 int fd_is_own = 0;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000231
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000232 assert(PyFileIO_Check(oself));
233 if (self->fd >= 0) {
Hynek Schlawack2cc71562012-05-25 10:05:53 +0200234 if (self->closefd) {
235 /* Have to close the existing file first. */
236 if (internal_close(self) < 0)
237 return -1;
238 }
239 else
240 self->fd = -1;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000241 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000242
Ross Lagerwall59142db2011-10-31 20:34:46 +0200243 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|siO:fileio",
244 kwlist, &nameobj, &mode, &closefd,
245 &opener))
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000246 return -1;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000247
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000248 if (PyFloat_Check(nameobj)) {
249 PyErr_SetString(PyExc_TypeError,
250 "integer argument expected, got float");
251 return -1;
252 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000253
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000254 fd = PyLong_AsLong(nameobj);
255 if (fd < 0) {
256 if (!PyErr_Occurred()) {
257 PyErr_SetString(PyExc_ValueError,
258 "Negative filedescriptor");
259 return -1;
260 }
261 PyErr_Clear();
262 }
Guido van Rossumb0428152007-04-08 17:44:42 +0000263
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +0000264#ifdef MS_WINDOWS
Victor Stinnerfe9a8612011-09-29 23:19:04 +0200265 if (PyUnicode_Check(nameobj)) {
Antoine Pitrou13348842012-01-29 18:36:34 +0100266 int rv = _PyUnicode_HasNULChars(nameobj);
267 if (rv) {
268 if (rv != -1)
269 PyErr_SetString(PyExc_TypeError, "embedded NUL character");
270 return -1;
271 }
Victor Stinnerfe9a8612011-09-29 23:19:04 +0200272 widename = PyUnicode_AsUnicode(nameobj);
273 if (widename == NULL)
274 return -1;
275 } else
Guido van Rossuma9e20242007-03-08 00:43:48 +0000276#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000277 if (fd < 0)
278 {
Antoine Pitrou13348842012-01-29 18:36:34 +0100279 if (!PyUnicode_FSConverter(nameobj, &stringobj)) {
280 return -1;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000281 }
Antoine Pitrou13348842012-01-29 18:36:34 +0100282 name = PyBytes_AS_STRING(stringobj);
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000283 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000284
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000285 s = mode;
286 while (*s) {
287 switch (*s++) {
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100288 case 'x':
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000289 if (rwa) {
290 bad_mode:
291 PyErr_SetString(PyExc_ValueError,
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100292 "Must have exactly one of create/read/write/append "
Georg Brandl28928ae2010-10-21 13:45:52 +0000293 "mode and at most one plus");
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000294 goto error;
295 }
296 rwa = 1;
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100297 self->created = 1;
298 self->writable = 1;
299 flags |= O_EXCL | O_CREAT;
300 break;
301 case 'r':
302 if (rwa)
303 goto bad_mode;
304 rwa = 1;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000305 self->readable = 1;
306 break;
307 case 'w':
308 if (rwa)
309 goto bad_mode;
310 rwa = 1;
311 self->writable = 1;
312 flags |= O_CREAT | O_TRUNC;
313 break;
314 case 'a':
315 if (rwa)
316 goto bad_mode;
317 rwa = 1;
318 self->writable = 1;
319 flags |= O_CREAT;
320 append = 1;
321 break;
322 case 'b':
323 break;
324 case '+':
325 if (plus)
326 goto bad_mode;
327 self->readable = self->writable = 1;
328 plus = 1;
329 break;
330 default:
331 PyErr_Format(PyExc_ValueError,
332 "invalid mode: %.200s", mode);
333 goto error;
334 }
335 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000336
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000337 if (!rwa)
338 goto bad_mode;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000339
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000340 if (self->readable && self->writable)
341 flags |= O_RDWR;
342 else if (self->readable)
343 flags |= O_RDONLY;
344 else
345 flags |= O_WRONLY;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000346
347#ifdef O_BINARY
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000348 flags |= O_BINARY;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000349#endif
350
Walter Dörwald0e411482007-06-06 16:55:38 +0000351#ifdef O_APPEND
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000352 if (append)
353 flags |= O_APPEND;
Walter Dörwald0e411482007-06-06 16:55:38 +0000354#endif
355
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000356 if (fd >= 0) {
357 if (check_fd(fd))
358 goto error;
359 self->fd = fd;
360 self->closefd = closefd;
361 }
362 else {
363 self->closefd = 1;
364 if (!closefd) {
365 PyErr_SetString(PyExc_ValueError,
366 "Cannot use closefd=False with file name");
367 goto error;
368 }
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000369
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000370 errno = 0;
Ross Lagerwall59142db2011-10-31 20:34:46 +0200371 if (opener == Py_None) {
372 Py_BEGIN_ALLOW_THREADS
Thomas Helleraf2be262007-07-12 11:03:13 +0000373#ifdef MS_WINDOWS
Ross Lagerwall59142db2011-10-31 20:34:46 +0200374 if (widename != NULL)
375 self->fd = _wopen(widename, flags, 0666);
376 else
Thomas Helleraf2be262007-07-12 11:03:13 +0000377#endif
Ross Lagerwall59142db2011-10-31 20:34:46 +0200378 self->fd = open(name, flags, 0666);
379 Py_END_ALLOW_THREADS
380 } else {
381 PyObject *fdobj = PyObject_CallFunction(
382 opener, "Oi", nameobj, flags);
383 if (fdobj == NULL)
384 goto error;
385 if (!PyLong_Check(fdobj)) {
386 Py_DECREF(fdobj);
387 PyErr_SetString(PyExc_TypeError,
388 "expected integer from opener");
389 goto error;
390 }
391
392 self->fd = PyLong_AsLong(fdobj);
393 Py_DECREF(fdobj);
394 if (self->fd == -1) {
395 goto error;
396 }
397 }
398
Hynek Schlawack7f59fd72012-06-22 09:32:22 +0200399 fd_is_own = 1;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000400 if (self->fd < 0) {
Christian Heimes0b489542007-10-31 19:20:48 +0000401#ifdef MS_WINDOWS
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000402 if (widename != NULL)
Victor Stinnerfe9a8612011-09-29 23:19:04 +0200403 PyErr_SetFromErrnoWithFilenameObject(PyExc_IOError, nameobj);
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000404 else
Christian Heimes0b489542007-10-31 19:20:48 +0000405#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000406 PyErr_SetFromErrnoWithFilename(PyExc_IOError, name);
407 goto error;
408 }
Benjamin Peterson430d4692010-10-30 23:13:57 +0000409 if (dircheck(self, name) < 0)
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000410 goto error;
411 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000412
Victor Stinner89e34362011-01-07 18:47:22 +0000413#if defined(MS_WINDOWS) || defined(__CYGWIN__)
414 /* don't translate newlines (\r\n <=> \n) */
415 _setmode(self->fd, O_BINARY);
416#endif
417
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000418 if (PyObject_SetAttrString((PyObject *)self, "name", nameobj) < 0)
419 goto error;
Antoine Pitrou08838b62009-01-21 00:55:13 +0000420
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000421 if (append) {
422 /* For consistent behaviour, we explicitly seek to the
423 end of file (otherwise, it might be done only on the
424 first write()). */
425 PyObject *pos = portable_lseek(self->fd, NULL, 2);
Hynek Schlawack9ed8b4e2012-06-21 20:20:25 +0200426 if (pos == NULL)
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000427 goto error;
428 Py_DECREF(pos);
429 }
Antoine Pitrou7fb111b2009-03-04 11:14:01 +0000430
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000431 goto done;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000432
433 error:
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000434 ret = -1;
Hynek Schlawack9ed8b4e2012-06-21 20:20:25 +0200435 if (!fd_is_own)
436 self->fd = -1;
Benjamin Petersonbbb04122010-10-30 23:16:28 +0000437 if (self->fd >= 0)
438 internal_close(self);
Guido van Rossum53807da2007-04-10 19:01:47 +0000439
Guido van Rossuma9e20242007-03-08 00:43:48 +0000440 done:
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000441 Py_CLEAR(stringobj);
442 return ret;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000443}
444
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000445static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000446fileio_traverse(fileio *self, visitproc visit, void *arg)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000447{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000448 Py_VISIT(self->dict);
449 return 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000450}
451
452static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000453fileio_clear(fileio *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000454{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000455 Py_CLEAR(self->dict);
456 return 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000457}
458
Guido van Rossuma9e20242007-03-08 00:43:48 +0000459static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000460fileio_dealloc(fileio *self)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000461{
Antoine Pitroue033e062010-10-29 10:38:18 +0000462 self->deallocating = 1;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000463 if (_PyIOBase_finalize((PyObject *) self) < 0)
464 return;
465 _PyObject_GC_UNTRACK(self);
466 if (self->weakreflist != NULL)
467 PyObject_ClearWeakRefs((PyObject *) self);
468 Py_CLEAR(self->dict);
469 Py_TYPE(self)->tp_free((PyObject *)self);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000470}
471
472static PyObject *
473err_closed(void)
474{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000475 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
476 return NULL;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000477}
478
479static PyObject *
Guido van Rossum53807da2007-04-10 19:01:47 +0000480err_mode(char *action)
481{
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000482 PyErr_Format(IO_STATE->unsupported_operation,
483 "File not open for %s", action);
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000484 return NULL;
Guido van Rossum53807da2007-04-10 19:01:47 +0000485}
486
487static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000488fileio_fileno(fileio *self)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000489{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000490 if (self->fd < 0)
491 return err_closed();
492 return PyLong_FromLong((long) self->fd);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000493}
494
495static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000496fileio_readable(fileio *self)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000497{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000498 if (self->fd < 0)
499 return err_closed();
500 return PyBool_FromLong((long) self->readable);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000501}
502
503static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000504fileio_writable(fileio *self)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000505{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000506 if (self->fd < 0)
507 return err_closed();
508 return PyBool_FromLong((long) self->writable);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000509}
510
511static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000512fileio_seekable(fileio *self)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000513{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000514 if (self->fd < 0)
515 return err_closed();
516 if (self->seekable < 0) {
517 PyObject *pos = portable_lseek(self->fd, NULL, SEEK_CUR);
518 if (pos == NULL) {
519 PyErr_Clear();
520 self->seekable = 0;
521 } else {
522 Py_DECREF(pos);
523 self->seekable = 1;
524 }
525 }
526 return PyBool_FromLong((long) self->seekable);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000527}
528
529static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000530fileio_readinto(fileio *self, PyObject *args)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000531{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000532 Py_buffer pbuf;
Victor Stinnere6edec22011-01-04 00:29:35 +0000533 Py_ssize_t n, len;
Antoine Pitrouc345ce12011-12-16 12:28:32 +0100534 int err;
Guido van Rossum53807da2007-04-10 19:01:47 +0000535
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000536 if (self->fd < 0)
537 return err_closed();
538 if (!self->readable)
539 return err_mode("reading");
Guido van Rossum53807da2007-04-10 19:01:47 +0000540
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000541 if (!PyArg_ParseTuple(args, "w*", &pbuf))
542 return NULL;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000543
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000544 if (_PyVerify_fd(self->fd)) {
Victor Stinnere6edec22011-01-04 00:29:35 +0000545 len = pbuf.len;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000546 Py_BEGIN_ALLOW_THREADS
547 errno = 0;
Victor Stinnere6edec22011-01-04 00:29:35 +0000548#if defined(MS_WIN64) || defined(MS_WINDOWS)
549 if (len > INT_MAX)
550 len = INT_MAX;
551 n = read(self->fd, pbuf.buf, (int)len);
552#else
Victor Stinner72344792011-01-11 00:04:12 +0000553 n = read(self->fd, pbuf.buf, len);
Victor Stinnere6edec22011-01-04 00:29:35 +0000554#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000555 Py_END_ALLOW_THREADS
556 } else
557 n = -1;
Antoine Pitrouc345ce12011-12-16 12:28:32 +0100558 err = errno;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000559 PyBuffer_Release(&pbuf);
560 if (n < 0) {
Antoine Pitrouc345ce12011-12-16 12:28:32 +0100561 if (err == EAGAIN)
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000562 Py_RETURN_NONE;
Antoine Pitrouc345ce12011-12-16 12:28:32 +0100563 errno = err;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000564 PyErr_SetFromErrno(PyExc_IOError);
565 return NULL;
566 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000567
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000568 return PyLong_FromSsize_t(n);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000569}
570
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000571static size_t
Victor Stinnere9d44ccb2011-05-26 00:16:44 +0200572new_buffersize(fileio *self, size_t currentsize
573#ifdef HAVE_FSTAT
Victor Stinnera2a64772011-10-11 22:45:02 +0200574 , Py_off_t pos, Py_off_t end
Victor Stinnere9d44ccb2011-05-26 00:16:44 +0200575#endif
576 )
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000577{
Antoine Pitroua3f44572012-04-17 13:50:58 +0200578 size_t addend;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000579#ifdef HAVE_FSTAT
Victor Stinnera2a64772011-10-11 22:45:02 +0200580 if (end != (Py_off_t)-1) {
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000581 /* Files claiming a size smaller than SMALLCHUNK may
582 actually be streaming pseudo-files. In this case, we
583 apply the more aggressive algorithm below.
584 */
585 if (end >= SMALLCHUNK && end >= pos && pos >= 0) {
586 /* Add 1 so if the file were to grow we'd notice. */
Victor Stinnerc5af7732011-10-11 23:00:31 +0200587 Py_off_t bufsize = currentsize + end - pos + 1;
588 if (bufsize < PY_SSIZE_T_MAX)
589 return (size_t)bufsize;
590 else
591 return PY_SSIZE_T_MAX;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000592 }
593 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000594#endif
Nadeem Vawdad41a98b2011-10-13 13:34:16 +0200595 /* Expand the buffer by an amount proportional to the current size,
Antoine Pitroua3f44572012-04-17 13:50:58 +0200596 giving us amortized linear-time behavior. For bigger sizes, use a
597 less-than-double growth factor to avoid excessive allocation. */
598 if (currentsize > 65536)
599 addend = currentsize >> 3;
600 else
601 addend = 256 + currentsize;
602 if (addend < SMALLCHUNK)
603 /* Avoid tiny read() calls. */
604 addend = SMALLCHUNK;
605 return addend + currentsize;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000606}
607
Guido van Rossum7165cb12007-07-10 06:54:34 +0000608static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000609fileio_readall(fileio *self)
Guido van Rossum7165cb12007-07-10 06:54:34 +0000610{
Victor Stinnere9d44ccb2011-05-26 00:16:44 +0200611#ifdef HAVE_FSTAT
612 struct stat st;
Victor Stinnera2a64772011-10-11 22:45:02 +0200613 Py_off_t pos, end;
Victor Stinnere9d44ccb2011-05-26 00:16:44 +0200614#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000615 PyObject *result;
616 Py_ssize_t total = 0;
617 int n;
Victor Stinnere9d44ccb2011-05-26 00:16:44 +0200618 size_t newsize;
Guido van Rossum7165cb12007-07-10 06:54:34 +0000619
Victor Stinnerb79f28c2011-05-25 22:09:03 +0200620 if (self->fd < 0)
621 return err_closed();
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000622 if (!_PyVerify_fd(self->fd))
623 return PyErr_SetFromErrno(PyExc_IOError);
Kristján Valur Jónssona8abe862009-03-24 15:27:42 +0000624
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000625 result = PyBytes_FromStringAndSize(NULL, SMALLCHUNK);
626 if (result == NULL)
627 return NULL;
Guido van Rossum7165cb12007-07-10 06:54:34 +0000628
Victor Stinnere9d44ccb2011-05-26 00:16:44 +0200629#ifdef HAVE_FSTAT
630#if defined(MS_WIN64) || defined(MS_WINDOWS)
631 pos = _lseeki64(self->fd, 0L, SEEK_CUR);
632#else
633 pos = lseek(self->fd, 0L, SEEK_CUR);
634#endif
635 if (fstat(self->fd, &st) == 0)
636 end = st.st_size;
637 else
Victor Stinnera2a64772011-10-11 22:45:02 +0200638 end = (Py_off_t)-1;
Victor Stinnere9d44ccb2011-05-26 00:16:44 +0200639#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000640 while (1) {
Victor Stinnere9d44ccb2011-05-26 00:16:44 +0200641#ifdef HAVE_FSTAT
642 newsize = new_buffersize(self, total, pos, end);
643#else
644 newsize = new_buffersize(self, total);
645#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000646 if (newsize > PY_SSIZE_T_MAX || newsize <= 0) {
647 PyErr_SetString(PyExc_OverflowError,
648 "unbounded read returned more bytes "
649 "than a Python string can hold ");
650 Py_DECREF(result);
651 return NULL;
652 }
Christian Heimesa872de52008-12-05 08:26:55 +0000653
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000654 if (PyBytes_GET_SIZE(result) < (Py_ssize_t)newsize) {
655 if (_PyBytes_Resize(&result, newsize) < 0) {
656 if (total == 0) {
657 Py_DECREF(result);
658 return NULL;
659 }
660 PyErr_Clear();
661 break;
662 }
663 }
664 Py_BEGIN_ALLOW_THREADS
665 errno = 0;
666 n = read(self->fd,
667 PyBytes_AS_STRING(result) + total,
668 newsize - total);
669 Py_END_ALLOW_THREADS
670 if (n == 0)
671 break;
672 if (n < 0) {
673 if (total > 0)
674 break;
675 if (errno == EAGAIN) {
676 Py_DECREF(result);
677 Py_RETURN_NONE;
678 }
679 Py_DECREF(result);
680 PyErr_SetFromErrno(PyExc_IOError);
681 return NULL;
682 }
683 total += n;
Victor Stinnere9d44ccb2011-05-26 00:16:44 +0200684#ifdef HAVE_FSTAT
685 pos += n;
686#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000687 }
Guido van Rossum7165cb12007-07-10 06:54:34 +0000688
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000689 if (PyBytes_GET_SIZE(result) > total) {
690 if (_PyBytes_Resize(&result, total) < 0) {
691 /* This should never happen, but just in case */
692 Py_DECREF(result);
693 return NULL;
694 }
695 }
696 return result;
Guido van Rossum7165cb12007-07-10 06:54:34 +0000697}
698
Guido van Rossuma9e20242007-03-08 00:43:48 +0000699static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000700fileio_read(fileio *self, PyObject *args)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000701{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000702 char *ptr;
703 Py_ssize_t n;
704 Py_ssize_t size = -1;
705 PyObject *bytes;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000706
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000707 if (self->fd < 0)
708 return err_closed();
709 if (!self->readable)
710 return err_mode("reading");
Guido van Rossuma9e20242007-03-08 00:43:48 +0000711
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000712 if (!PyArg_ParseTuple(args, "|O&", &_PyIO_ConvertSsize_t, &size))
713 return NULL;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000714
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000715 if (size < 0) {
716 return fileio_readall(self);
717 }
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000718
Victor Stinnerc655a722011-07-05 11:31:49 +0200719#if defined(MS_WIN64) || defined(MS_WINDOWS)
720 if (size > INT_MAX)
721 size = INT_MAX;
722#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000723 bytes = PyBytes_FromStringAndSize(NULL, size);
724 if (bytes == NULL)
725 return NULL;
726 ptr = PyBytes_AS_STRING(bytes);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000727
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000728 if (_PyVerify_fd(self->fd)) {
729 Py_BEGIN_ALLOW_THREADS
730 errno = 0;
Victor Stinnerc655a722011-07-05 11:31:49 +0200731#if defined(MS_WIN64) || defined(MS_WINDOWS)
732 n = read(self->fd, ptr, (int)size);
733#else
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000734 n = read(self->fd, ptr, size);
Victor Stinnerc655a722011-07-05 11:31:49 +0200735#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000736 Py_END_ALLOW_THREADS
737 } else
738 n = -1;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000739
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000740 if (n < 0) {
Antoine Pitrouc345ce12011-12-16 12:28:32 +0100741 int err = errno;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000742 Py_DECREF(bytes);
Antoine Pitrouc345ce12011-12-16 12:28:32 +0100743 if (err == EAGAIN)
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000744 Py_RETURN_NONE;
Antoine Pitrouc345ce12011-12-16 12:28:32 +0100745 errno = err;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000746 PyErr_SetFromErrno(PyExc_IOError);
747 return NULL;
748 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000749
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000750 if (n != size) {
751 if (_PyBytes_Resize(&bytes, n) < 0) {
752 Py_DECREF(bytes);
753 return NULL;
754 }
755 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000756
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000757 return (PyObject *) bytes;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000758}
759
760static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000761fileio_write(fileio *self, PyObject *args)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000762{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000763 Py_buffer pbuf;
Victor Stinnere6edec22011-01-04 00:29:35 +0000764 Py_ssize_t n, len;
Antoine Pitrouc345ce12011-12-16 12:28:32 +0100765 int err;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000766
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000767 if (self->fd < 0)
768 return err_closed();
769 if (!self->writable)
770 return err_mode("writing");
Guido van Rossum53807da2007-04-10 19:01:47 +0000771
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000772 if (!PyArg_ParseTuple(args, "y*", &pbuf))
773 return NULL;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000774
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000775 if (_PyVerify_fd(self->fd)) {
776 Py_BEGIN_ALLOW_THREADS
777 errno = 0;
Victor Stinnere6edec22011-01-04 00:29:35 +0000778 len = pbuf.len;
779#if defined(MS_WIN64) || defined(MS_WINDOWS)
Victor Stinnere0daff12011-03-20 23:36:35 +0100780 if (len > 32767 && isatty(self->fd)) {
781 /* Issue #11395: the Windows console returns an error (12: not
782 enough space error) on writing into stdout if stdout mode is
783 binary and the length is greater than 66,000 bytes (or less,
784 depending on heap usage). */
785 len = 32767;
786 }
787 else if (len > INT_MAX)
Victor Stinnere6edec22011-01-04 00:29:35 +0000788 len = INT_MAX;
789 n = write(self->fd, pbuf.buf, (int)len);
790#else
Victor Stinner72344792011-01-11 00:04:12 +0000791 n = write(self->fd, pbuf.buf, len);
Victor Stinnere6edec22011-01-04 00:29:35 +0000792#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000793 Py_END_ALLOW_THREADS
794 } else
795 n = -1;
Antoine Pitrouc345ce12011-12-16 12:28:32 +0100796 err = errno;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000797
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000798 PyBuffer_Release(&pbuf);
Martin v. Löwis423be952008-08-13 15:53:07 +0000799
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000800 if (n < 0) {
Antoine Pitrouc345ce12011-12-16 12:28:32 +0100801 if (err == EAGAIN)
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000802 Py_RETURN_NONE;
Antoine Pitrouc345ce12011-12-16 12:28:32 +0100803 errno = err;
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000804 PyErr_SetFromErrno(PyExc_IOError);
805 return NULL;
806 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000807
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000808 return PyLong_FromSsize_t(n);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000809}
810
Guido van Rossum53807da2007-04-10 19:01:47 +0000811/* XXX Windows support below is likely incomplete */
812
Guido van Rossum53807da2007-04-10 19:01:47 +0000813/* Cribbed from posix_lseek() */
814static PyObject *
815portable_lseek(int fd, PyObject *posobj, int whence)
816{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000817 Py_off_t pos, res;
Guido van Rossum53807da2007-04-10 19:01:47 +0000818
819#ifdef SEEK_SET
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000820 /* Turn 0, 1, 2 into SEEK_{SET,CUR,END} */
821 switch (whence) {
Guido van Rossum53807da2007-04-10 19:01:47 +0000822#if SEEK_SET != 0
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000823 case 0: whence = SEEK_SET; break;
Guido van Rossum53807da2007-04-10 19:01:47 +0000824#endif
825#if SEEK_CUR != 1
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000826 case 1: whence = SEEK_CUR; break;
Guido van Rossum53807da2007-04-10 19:01:47 +0000827#endif
Antoine Pitrou4f7945f2009-01-20 11:42:11 +0000828#if SEEK_END != 2
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000829 case 2: whence = SEEK_END; break;
Guido van Rossum53807da2007-04-10 19:01:47 +0000830#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000831 }
Guido van Rossum53807da2007-04-10 19:01:47 +0000832#endif /* SEEK_SET */
833
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000834 if (posobj == NULL)
835 pos = 0;
836 else {
837 if(PyFloat_Check(posobj)) {
838 PyErr_SetString(PyExc_TypeError, "an integer is required");
839 return NULL;
840 }
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000841#if defined(HAVE_LARGEFILE_SUPPORT)
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000842 pos = PyLong_AsLongLong(posobj);
Guido van Rossum53807da2007-04-10 19:01:47 +0000843#else
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000844 pos = PyLong_AsLong(posobj);
Guido van Rossum53807da2007-04-10 19:01:47 +0000845#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000846 if (PyErr_Occurred())
847 return NULL;
848 }
Guido van Rossum53807da2007-04-10 19:01:47 +0000849
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000850 if (_PyVerify_fd(fd)) {
851 Py_BEGIN_ALLOW_THREADS
Guido van Rossum53807da2007-04-10 19:01:47 +0000852#if defined(MS_WIN64) || defined(MS_WINDOWS)
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000853 res = _lseeki64(fd, pos, whence);
Guido van Rossum53807da2007-04-10 19:01:47 +0000854#else
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000855 res = lseek(fd, pos, whence);
Guido van Rossum53807da2007-04-10 19:01:47 +0000856#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000857 Py_END_ALLOW_THREADS
858 } else
859 res = -1;
860 if (res < 0)
861 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum53807da2007-04-10 19:01:47 +0000862
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000863#if defined(HAVE_LARGEFILE_SUPPORT)
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000864 return PyLong_FromLongLong(res);
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000865#else
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000866 return PyLong_FromLong(res);
Guido van Rossum53807da2007-04-10 19:01:47 +0000867#endif
868}
869
Guido van Rossuma9e20242007-03-08 00:43:48 +0000870static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000871fileio_seek(fileio *self, PyObject *args)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000872{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000873 PyObject *posobj;
874 int whence = 0;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000875
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000876 if (self->fd < 0)
877 return err_closed();
Guido van Rossuma9e20242007-03-08 00:43:48 +0000878
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000879 if (!PyArg_ParseTuple(args, "O|i", &posobj, &whence))
880 return NULL;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000881
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000882 return portable_lseek(self->fd, posobj, whence);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000883}
884
885static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000886fileio_tell(fileio *self, PyObject *args)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000887{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000888 if (self->fd < 0)
889 return err_closed();
Guido van Rossuma9e20242007-03-08 00:43:48 +0000890
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000891 return portable_lseek(self->fd, NULL, 1);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000892}
893
Thomas Hellerc6a55ee2007-07-11 12:45:46 +0000894#ifdef HAVE_FTRUNCATE
Guido van Rossuma9e20242007-03-08 00:43:48 +0000895static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000896fileio_truncate(fileio *self, PyObject *args)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000897{
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000898 PyObject *posobj = NULL; /* the new size wanted by the user */
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000899#ifndef MS_WINDOWS
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000900 Py_off_t pos;
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000901#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000902 int ret;
903 int fd;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000904
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000905 fd = self->fd;
906 if (fd < 0)
907 return err_closed();
908 if (!self->writable)
909 return err_mode("writing");
Guido van Rossuma9e20242007-03-08 00:43:48 +0000910
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000911 if (!PyArg_ParseTuple(args, "|O", &posobj))
912 return NULL;
Guido van Rossum53807da2007-04-10 19:01:47 +0000913
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000914 if (posobj == Py_None || posobj == NULL) {
915 /* Get the current position. */
916 posobj = portable_lseek(fd, NULL, 1);
917 if (posobj == NULL)
918 return NULL;
919 }
920 else {
921 Py_INCREF(posobj);
922 }
Guido van Rossum53807da2007-04-10 19:01:47 +0000923
Thomas Hellerfdeee3a2007-07-12 11:21:36 +0000924#ifdef MS_WINDOWS
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000925 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
926 so don't even try using it. */
927 {
928 PyObject *oldposobj, *tempposobj;
929 HANDLE hFile;
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000930
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000931 /* we save the file pointer position */
932 oldposobj = portable_lseek(fd, NULL, 1);
933 if (oldposobj == NULL) {
934 Py_DECREF(posobj);
935 return NULL;
936 }
Thomas Hellerfdeee3a2007-07-12 11:21:36 +0000937
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000938 /* we then move to the truncation position */
939 tempposobj = portable_lseek(fd, posobj, 0);
940 if (tempposobj == NULL) {
941 Py_DECREF(oldposobj);
942 Py_DECREF(posobj);
943 return NULL;
944 }
945 Py_DECREF(tempposobj);
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000946
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000947 /* Truncate. Note that this may grow the file! */
948 Py_BEGIN_ALLOW_THREADS
949 errno = 0;
950 hFile = (HANDLE)_get_osfhandle(fd);
951 ret = hFile == (HANDLE)-1; /* testing for INVALID_HANDLE value */
952 if (ret == 0) {
953 ret = SetEndOfFile(hFile) == 0;
954 if (ret)
955 errno = EACCES;
956 }
957 Py_END_ALLOW_THREADS
958
959 /* we restore the file pointer position in any case */
960 tempposobj = portable_lseek(fd, oldposobj, 0);
961 Py_DECREF(oldposobj);
962 if (tempposobj == NULL) {
963 Py_DECREF(posobj);
964 return NULL;
965 }
966 Py_DECREF(tempposobj);
967 }
Thomas Hellerfdeee3a2007-07-12 11:21:36 +0000968#else
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000969
970#if defined(HAVE_LARGEFILE_SUPPORT)
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000971 pos = PyLong_AsLongLong(posobj);
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000972#else
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000973 pos = PyLong_AsLong(posobj);
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000974#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000975 if (PyErr_Occurred()){
976 Py_DECREF(posobj);
977 return NULL;
978 }
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000979
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000980 Py_BEGIN_ALLOW_THREADS
981 errno = 0;
982 ret = ftruncate(fd, pos);
983 Py_END_ALLOW_THREADS
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000984
Thomas Hellerfdeee3a2007-07-12 11:21:36 +0000985#endif /* !MS_WINDOWS */
Guido van Rossuma9e20242007-03-08 00:43:48 +0000986
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000987 if (ret != 0) {
988 Py_DECREF(posobj);
989 PyErr_SetFromErrno(PyExc_IOError);
990 return NULL;
991 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000992
Antoine Pitrouae4b4722010-05-05 16:31:07 +0000993 return posobj;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000994}
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000995#endif /* HAVE_FTRUNCATE */
Guido van Rossum53807da2007-04-10 19:01:47 +0000996
997static char *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000998mode_string(fileio *self)
Guido van Rossum53807da2007-04-10 19:01:47 +0000999{
Charles-François Natalidc3044c2012-01-09 22:40:02 +01001000 if (self->created) {
1001 if (self->readable)
1002 return "xb+";
1003 else
1004 return "xb";
1005 }
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001006 if (self->readable) {
1007 if (self->writable)
1008 return "rb+";
1009 else
1010 return "rb";
1011 }
1012 else
1013 return "wb";
Guido van Rossum53807da2007-04-10 19:01:47 +00001014}
Guido van Rossuma9e20242007-03-08 00:43:48 +00001015
1016static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001017fileio_repr(fileio *self)
Guido van Rossuma9e20242007-03-08 00:43:48 +00001018{
Martin v. Löwis767046a2011-10-14 15:35:36 +02001019 _Py_IDENTIFIER(name);
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001020 PyObject *nameobj, *res;
Guido van Rossuma9e20242007-03-08 00:43:48 +00001021
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001022 if (self->fd < 0)
1023 return PyUnicode_FromFormat("<_io.FileIO [closed]>");
Antoine Pitrou716c4442009-05-23 19:04:03 +00001024
Martin v. Löwis767046a2011-10-14 15:35:36 +02001025 nameobj = _PyObject_GetAttrId((PyObject *) self, &PyId_name);
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001026 if (nameobj == NULL) {
1027 if (PyErr_ExceptionMatches(PyExc_AttributeError))
1028 PyErr_Clear();
1029 else
1030 return NULL;
1031 res = PyUnicode_FromFormat("<_io.FileIO fd=%d mode='%s'>",
1032 self->fd, mode_string(self));
1033 }
1034 else {
1035 res = PyUnicode_FromFormat("<_io.FileIO name=%R mode='%s'>",
1036 nameobj, mode_string(self));
1037 Py_DECREF(nameobj);
1038 }
1039 return res;
Guido van Rossuma9e20242007-03-08 00:43:48 +00001040}
1041
1042static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001043fileio_isatty(fileio *self)
Guido van Rossuma9e20242007-03-08 00:43:48 +00001044{
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001045 long res;
Guido van Rossum53807da2007-04-10 19:01:47 +00001046
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001047 if (self->fd < 0)
1048 return err_closed();
1049 Py_BEGIN_ALLOW_THREADS
1050 res = isatty(self->fd);
1051 Py_END_ALLOW_THREADS
1052 return PyBool_FromLong(res);
Guido van Rossuma9e20242007-03-08 00:43:48 +00001053}
1054
Antoine Pitrou243757e2010-11-05 21:15:39 +00001055static PyObject *
1056fileio_getstate(fileio *self)
1057{
1058 PyErr_Format(PyExc_TypeError,
1059 "cannot serialize '%s' object", Py_TYPE(self)->tp_name);
1060 return NULL;
1061}
1062
Guido van Rossuma9e20242007-03-08 00:43:48 +00001063
1064PyDoc_STRVAR(fileio_doc,
Ross Lagerwall59142db2011-10-31 20:34:46 +02001065"file(name: str[, mode: str][, opener: None]) -> file IO object\n"
Guido van Rossuma9e20242007-03-08 00:43:48 +00001066"\n"
Charles-François Natalidc3044c2012-01-09 22:40:02 +01001067"Open a file. The mode can be 'r', 'w', 'x' or 'a' for reading (default),\n"
Charles-François Natalid612de12012-01-14 11:51:00 +01001068"writing, exclusive creation or appending. The file will be created if it\n"
1069"doesn't exist when opened for writing or appending; it will be truncated\n"
1070"when opened for writing. A `FileExistsError` will be raised if it already\n"
Charles-François Natalidc3044c2012-01-09 22:40:02 +01001071"exists when opened for creating. Opening a file for creating implies\n"
1072"writing so this mode behaves in a similar way to 'w'.Add a '+' to the mode\n"
1073"to allow simultaneous reading and writing. A custom opener can be used by\n"
1074"passing a callable as *opener*. The underlying file descriptor for the file\n"
Ross Lagerwall59142db2011-10-31 20:34:46 +02001075"object is then obtained by calling opener with (*name*, *flags*).\n"
Charles-François Natalidc3044c2012-01-09 22:40:02 +01001076"*opener* must return an open file descriptor (passing os.open as *opener*\n"
1077"results in functionality similar to passing None).");
Guido van Rossuma9e20242007-03-08 00:43:48 +00001078
1079PyDoc_STRVAR(read_doc,
1080"read(size: int) -> bytes. read at most size bytes, returned as bytes.\n"
1081"\n"
1082"Only makes one system call, so less data may be returned than requested\n"
Guido van Rossum7165cb12007-07-10 06:54:34 +00001083"In non-blocking mode, returns None if no data is available.\n"
1084"On end-of-file, returns ''.");
1085
1086PyDoc_STRVAR(readall_doc,
1087"readall() -> bytes. read all data from the file, returned as bytes.\n"
1088"\n"
1089"In non-blocking mode, returns as much as is immediately available,\n"
1090"or None if no data is available. On end-of-file, returns ''.");
Guido van Rossuma9e20242007-03-08 00:43:48 +00001091
1092PyDoc_STRVAR(write_doc,
1093"write(b: bytes) -> int. Write bytes b to file, return number written.\n"
1094"\n"
1095"Only makes one system call, so not all of the data may be written.\n"
1096"The number of bytes actually written is returned.");
1097
1098PyDoc_STRVAR(fileno_doc,
1099"fileno() -> int. \"file descriptor\".\n"
1100"\n"
1101"This is needed for lower-level file interfaces, such the fcntl module.");
1102
1103PyDoc_STRVAR(seek_doc,
1104"seek(offset: int[, whence: int]) -> None. Move to new file position.\n"
1105"\n"
1106"Argument offset is a byte count. Optional argument whence defaults to\n"
1107"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1108"(move relative to current position, positive or negative), and 2 (move\n"
1109"relative to end of file, usually negative, although many platforms allow\n"
1110"seeking beyond the end of a file)."
1111"\n"
1112"Note that not all file objects are seekable.");
1113
Thomas Hellerc6a55ee2007-07-11 12:45:46 +00001114#ifdef HAVE_FTRUNCATE
Guido van Rossuma9e20242007-03-08 00:43:48 +00001115PyDoc_STRVAR(truncate_doc,
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001116"truncate([size: int]) -> None. Truncate the file to at most size bytes.\n"
Guido van Rossuma9e20242007-03-08 00:43:48 +00001117"\n"
Alexandre Vassalotti77250f42008-05-06 19:48:38 +00001118"Size defaults to the current file position, as returned by tell()."
1119"The current file position is changed to the value of size.");
Thomas Hellerc6a55ee2007-07-11 12:45:46 +00001120#endif
Guido van Rossuma9e20242007-03-08 00:43:48 +00001121
1122PyDoc_STRVAR(tell_doc,
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001123"tell() -> int. Current file position");
Guido van Rossuma9e20242007-03-08 00:43:48 +00001124
1125PyDoc_STRVAR(readinto_doc,
Benjamin Peterson9a8082f2009-03-05 00:55:56 +00001126"readinto() -> Same as RawIOBase.readinto().");
Guido van Rossuma9e20242007-03-08 00:43:48 +00001127
1128PyDoc_STRVAR(close_doc,
1129"close() -> None. Close the file.\n"
1130"\n"
1131"A closed file cannot be used for further I/O operations. close() may be\n"
1132"called more than once without error. Changes the fileno to -1.");
1133
1134PyDoc_STRVAR(isatty_doc,
1135"isatty() -> bool. True if the file is connected to a tty device.");
1136
Guido van Rossuma9e20242007-03-08 00:43:48 +00001137PyDoc_STRVAR(seekable_doc,
1138"seekable() -> bool. True if file supports random-access.");
1139
1140PyDoc_STRVAR(readable_doc,
1141"readable() -> bool. True if file was opened in a read mode.");
1142
1143PyDoc_STRVAR(writable_doc,
1144"writable() -> bool. True if file was opened in a write mode.");
1145
1146static PyMethodDef fileio_methods[] = {
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001147 {"read", (PyCFunction)fileio_read, METH_VARARGS, read_doc},
1148 {"readall", (PyCFunction)fileio_readall, METH_NOARGS, readall_doc},
1149 {"readinto", (PyCFunction)fileio_readinto, METH_VARARGS, readinto_doc},
1150 {"write", (PyCFunction)fileio_write, METH_VARARGS, write_doc},
1151 {"seek", (PyCFunction)fileio_seek, METH_VARARGS, seek_doc},
1152 {"tell", (PyCFunction)fileio_tell, METH_VARARGS, tell_doc},
Thomas Hellerc6a55ee2007-07-11 12:45:46 +00001153#ifdef HAVE_FTRUNCATE
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001154 {"truncate", (PyCFunction)fileio_truncate, METH_VARARGS, truncate_doc},
Thomas Hellerc6a55ee2007-07-11 12:45:46 +00001155#endif
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001156 {"close", (PyCFunction)fileio_close, METH_NOARGS, close_doc},
1157 {"seekable", (PyCFunction)fileio_seekable, METH_NOARGS, seekable_doc},
1158 {"readable", (PyCFunction)fileio_readable, METH_NOARGS, readable_doc},
1159 {"writable", (PyCFunction)fileio_writable, METH_NOARGS, writable_doc},
1160 {"fileno", (PyCFunction)fileio_fileno, METH_NOARGS, fileno_doc},
1161 {"isatty", (PyCFunction)fileio_isatty, METH_NOARGS, isatty_doc},
Antoine Pitroue033e062010-10-29 10:38:18 +00001162 {"_dealloc_warn", (PyCFunction)fileio_dealloc_warn, METH_O, NULL},
Antoine Pitrou243757e2010-11-05 21:15:39 +00001163 {"__getstate__", (PyCFunction)fileio_getstate, METH_NOARGS, NULL},
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001164 {NULL, NULL} /* sentinel */
Guido van Rossuma9e20242007-03-08 00:43:48 +00001165};
1166
Guido van Rossum53807da2007-04-10 19:01:47 +00001167/* 'closed' and 'mode' are attributes for backwards compatibility reasons. */
1168
Guido van Rossumb0428152007-04-08 17:44:42 +00001169static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001170get_closed(fileio *self, void *closure)
Guido van Rossumb0428152007-04-08 17:44:42 +00001171{
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001172 return PyBool_FromLong((long)(self->fd < 0));
Guido van Rossum53807da2007-04-10 19:01:47 +00001173}
1174
1175static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001176get_closefd(fileio *self, void *closure)
Christian Heimesecc42a22008-11-05 19:30:32 +00001177{
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001178 return PyBool_FromLong((long)(self->closefd));
Christian Heimesecc42a22008-11-05 19:30:32 +00001179}
1180
1181static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001182get_mode(fileio *self, void *closure)
Guido van Rossum53807da2007-04-10 19:01:47 +00001183{
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001184 return PyUnicode_FromString(mode_string(self));
Guido van Rossumb0428152007-04-08 17:44:42 +00001185}
1186
1187static PyGetSetDef fileio_getsetlist[] = {
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001188 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
1189 {"closefd", (getter)get_closefd, NULL,
1190 "True if the file descriptor will be closed"},
1191 {"mode", (getter)get_mode, NULL, "String giving the file mode"},
1192 {NULL},
Guido van Rossumb0428152007-04-08 17:44:42 +00001193};
1194
Guido van Rossuma9e20242007-03-08 00:43:48 +00001195PyTypeObject PyFileIO_Type = {
Antoine Pitrouae4b4722010-05-05 16:31:07 +00001196 PyVarObject_HEAD_INIT(NULL, 0)
1197 "_io.FileIO",
1198 sizeof(fileio),
1199 0,
1200 (destructor)fileio_dealloc, /* tp_dealloc */
1201 0, /* tp_print */
1202 0, /* tp_getattr */
1203 0, /* tp_setattr */
1204 0, /* tp_reserved */
1205 (reprfunc)fileio_repr, /* tp_repr */
1206 0, /* tp_as_number */
1207 0, /* tp_as_sequence */
1208 0, /* tp_as_mapping */
1209 0, /* tp_hash */
1210 0, /* tp_call */
1211 0, /* tp_str */
1212 PyObject_GenericGetAttr, /* tp_getattro */
1213 0, /* tp_setattro */
1214 0, /* tp_as_buffer */
1215 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
1216 | Py_TPFLAGS_HAVE_GC, /* tp_flags */
1217 fileio_doc, /* tp_doc */
1218 (traverseproc)fileio_traverse, /* tp_traverse */
1219 (inquiry)fileio_clear, /* tp_clear */
1220 0, /* tp_richcompare */
1221 offsetof(fileio, weakreflist), /* tp_weaklistoffset */
1222 0, /* tp_iter */
1223 0, /* tp_iternext */
1224 fileio_methods, /* tp_methods */
1225 0, /* tp_members */
1226 fileio_getsetlist, /* tp_getset */
1227 0, /* tp_base */
1228 0, /* tp_dict */
1229 0, /* tp_descr_get */
1230 0, /* tp_descr_set */
1231 offsetof(fileio, dict), /* tp_dictoffset */
1232 fileio_init, /* tp_init */
1233 PyType_GenericAlloc, /* tp_alloc */
1234 fileio_new, /* tp_new */
1235 PyObject_GC_Del, /* tp_free */
Guido van Rossuma9e20242007-03-08 00:43:48 +00001236};