Branch data Line data Source code
1 : : /*
2 : : * This file is part of the MicroPython project, http://micropython.org/
3 : : *
4 : : * The MIT License (MIT)
5 : : *
6 : : * Copyright (c) 2013-2018 Damien P. George
7 : : *
8 : : * Permission is hereby granted, free of charge, to any person obtaining a copy
9 : : * of this software and associated documentation files (the "Software"), to deal
10 : : * in the Software without restriction, including without limitation the rights
11 : : * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 : : * copies of the Software, and to permit persons to whom the Software is
13 : : * furnished to do so, subject to the following conditions:
14 : : *
15 : : * The above copyright notice and this permission notice shall be included in
16 : : * all copies or substantial portions of the Software.
17 : : *
18 : : * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 : : * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 : : * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 : : * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 : : * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 : : * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 : : * THE SOFTWARE.
25 : : */
26 : :
27 : : #include "py/mphal.h"
28 : : #include "py/mpthread.h"
29 : : #include "py/runtime.h"
30 : : #include "py/stream.h"
31 : : #include "extmod/vfs_posix.h"
32 : :
33 : : #if MICROPY_VFS_POSIX
34 : :
35 : : #include <fcntl.h>
36 : : #include <unistd.h>
37 : :
38 : : #ifdef _WIN32
39 : : #define fsync _commit
40 : : #else
41 : : #include <poll.h>
42 : : #endif
43 : :
44 : : typedef struct _mp_obj_vfs_posix_file_t {
45 : : mp_obj_base_t base;
46 : : int fd;
47 : : } mp_obj_vfs_posix_file_t;
48 : :
49 : : #if MICROPY_CPYTHON_COMPAT
50 : 725703 : static void check_fd_is_open(const mp_obj_vfs_posix_file_t *o) {
51 [ + + ]: 725703 : if (o->fd < 0) {
52 : 4 : mp_raise_ValueError(MP_ERROR_TEXT("I/O operation on closed file"));
53 : : }
54 : 725699 : }
55 : : #else
56 : : #define check_fd_is_open(o)
57 : : #endif
58 : :
59 : 26 : static void vfs_posix_file_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
60 : 26 : (void)kind;
61 : 26 : mp_obj_vfs_posix_file_t *self = MP_OBJ_TO_PTR(self_in);
62 : 26 : mp_printf(print, "<io.%s %d>", mp_obj_get_type_str(self_in), self->fd);
63 : 26 : }
64 : :
65 : 3785 : mp_obj_t mp_vfs_posix_file_open(const mp_obj_type_t *type, mp_obj_t file_in, mp_obj_t mode_in) {
66 : 3785 : const char *mode_s = mp_obj_str_get_str(mode_in);
67 : :
68 : 3785 : int mode_rw = 0, mode_x = 0;
69 [ + + ]: 11279 : while (*mode_s) {
70 [ + + + + : 7494 : switch (*mode_s++) {
+ + - ]
71 : 3729 : case 'r':
72 : 3729 : mode_rw = O_RDONLY;
73 : 3729 : break;
74 : 42 : case 'w':
75 : 42 : mode_rw = O_WRONLY;
76 : 42 : mode_x = O_CREAT | O_TRUNC;
77 : 42 : break;
78 : 14 : case 'a':
79 : 14 : mode_rw = O_WRONLY;
80 : 14 : mode_x = O_CREAT | O_APPEND;
81 : 14 : break;
82 : 8 : case '+':
83 : 8 : mode_rw = O_RDWR;
84 : 8 : break;
85 : 3695 : case 'b':
86 : 3695 : type = &mp_type_vfs_posix_fileio;
87 : 3695 : break;
88 : 6 : case 't':
89 : 6 : type = &mp_type_vfs_posix_textio;
90 : 6 : break;
91 : : }
92 : : }
93 : :
94 : 3785 : mp_obj_vfs_posix_file_t *o = mp_obj_malloc_with_finaliser(mp_obj_vfs_posix_file_t, type);
95 : 3785 : o->fd = -1; // In case open() fails below, initialise this as a "closed" file object.
96 : :
97 : 3785 : mp_obj_t fid = file_in;
98 : :
99 [ + + ]: 3785 : if (mp_obj_is_small_int(fid)) {
100 : 2 : o->fd = MP_OBJ_SMALL_INT_VALUE(fid);
101 : 2 : return MP_OBJ_FROM_PTR(o);
102 : : }
103 : :
104 : 3783 : const char *fname = mp_obj_str_get_str(fid);
105 : 3783 : int fd;
106 [ + + - + ]: 3783 : MP_HAL_RETRY_SYSCALL(fd, open(fname, mode_x | mode_rw, 0644), mp_raise_OSError(err));
107 : 3779 : o->fd = fd;
108 : 3779 : return MP_OBJ_FROM_PTR(o);
109 : : }
110 : :
111 : 16 : static mp_obj_t vfs_posix_file_fileno(mp_obj_t self_in) {
112 : 16 : mp_obj_vfs_posix_file_t *self = MP_OBJ_TO_PTR(self_in);
113 : 16 : check_fd_is_open(self);
114 : 16 : return MP_OBJ_NEW_SMALL_INT(self->fd);
115 : : }
116 : : static MP_DEFINE_CONST_FUN_OBJ_1(vfs_posix_file_fileno_obj, vfs_posix_file_fileno);
117 : :
118 : 86454 : static mp_uint_t vfs_posix_file_read(mp_obj_t o_in, void *buf, mp_uint_t size, int *errcode) {
119 : 86454 : mp_obj_vfs_posix_file_t *o = MP_OBJ_TO_PTR(o_in);
120 : 86454 : check_fd_is_open(o);
121 : 86452 : ssize_t r;
122 [ + + - + ]: 86452 : MP_HAL_RETRY_SYSCALL(r, read(o->fd, buf, size), {
123 : : *errcode = err;
124 : : return MP_STREAM_ERROR;
125 : 86442 : });
126 : 86442 : return (mp_uint_t)r;
127 : : }
128 : :
129 : 635534 : static mp_uint_t vfs_posix_file_write(mp_obj_t o_in, const void *buf, mp_uint_t size, int *errcode) {
130 : 635534 : mp_obj_vfs_posix_file_t *o = MP_OBJ_TO_PTR(o_in);
131 : 635534 : check_fd_is_open(o);
132 : : #if MICROPY_PY_OS_DUPTERM
133 : : if (o->fd <= STDERR_FILENO) {
134 : : mp_hal_stdout_tx_strn(buf, size);
135 : : return size;
136 : : }
137 : : #endif
138 : 635534 : ssize_t r;
139 [ + + - + ]: 635534 : MP_HAL_RETRY_SYSCALL(r, write(o->fd, buf, size), {
140 : : *errcode = err;
141 : : return MP_STREAM_ERROR;
142 : 635532 : });
143 : 635532 : return (mp_uint_t)r;
144 : : }
145 : :
146 : 11219 : static mp_uint_t vfs_posix_file_ioctl(mp_obj_t o_in, mp_uint_t request, uintptr_t arg, int *errcode) {
147 : 11219 : mp_obj_vfs_posix_file_t *o = MP_OBJ_TO_PTR(o_in);
148 : :
149 [ + + ]: 11219 : if (request != MP_STREAM_CLOSE) {
150 : 3699 : check_fd_is_open(o);
151 : : }
152 : :
153 [ + + - + : 3697 : switch (request) {
+ ]
154 : 8 : case MP_STREAM_FLUSH: {
155 : 8 : int ret;
156 : : // fsync(stdin/stdout/stderr) may fail with EINVAL (or ENOTSUP on macos or EBADF
157 : : // on windows), because the OS doesn't buffer these except for instance when they
158 : : // are redirected from/to file, but don't propagate that error out. Because data
159 : : // is not buffered by us, and stdin/out/err.flush() should just be a no-op.
160 : : #if defined(__APPLE__)
161 : : #define VFS_POSIX_STREAM_STDIO_ERR_CATCH (err == EINVAL || err == ENOTSUP)
162 : : #elif defined(_MSC_VER)
163 : : // In debug builds fsync (i.e. _commit on windows) will generate a debug report via _ASSERTE when
164 : : // called with non-redirected stdin/stdout/stderr (i.e. _isatty) handles because FlushFileBuffers,
165 : : // which it calls internally, will fail since console output is not buffered.
166 : : // In release builds it also fails, but merely returns an error which is handled appropriately below.
167 : : // The check for the handle being stdin/stdout/stderr is added explicitly because according to
168 : : // the documentation _isatty is also true for serial ports for instance.
169 : : #ifdef _DEBUG
170 : : if ((o->fd == STDIN_FILENO || o->fd == STDOUT_FILENO || o->fd == STDERR_FILENO) && _isatty(o->fd)) {
171 : : return 0;
172 : : }
173 : : #endif
174 : : #define VFS_POSIX_STREAM_STDIO_ERR_CATCH (err == EINVAL || err == EBADF)
175 : : #else
176 : : #define VFS_POSIX_STREAM_STDIO_ERR_CATCH (err == EINVAL)
177 : : #endif
178 [ + - - + : 8 : MP_HAL_RETRY_SYSCALL(ret, fsync(o->fd), {
+ - - + ]
179 : : if (VFS_POSIX_STREAM_STDIO_ERR_CATCH
180 : : // Note: comparing fd against the standard FILENOs is technically not correct, for example:
181 : : // sys.stderr.close() in Python code results in close(STDERR_FILENO) here, but because
182 : : // open() uses the next available file descriptor, opening an arbitrary file with
183 : : // fd = open('/some/file') means that fd becomes STDERR_FILENO.
184 : : && (o->fd == STDIN_FILENO || o->fd == STDOUT_FILENO || o->fd == STDERR_FILENO)) {
185 : : return 0;
186 : : }
187 : : *errcode = err;
188 : : return MP_STREAM_ERROR;
189 : : });
190 : : return 0;
191 : : }
192 : 26 : case MP_STREAM_SEEK: {
193 : 26 : struct mp_stream_seek_t *s = (struct mp_stream_seek_t *)arg;
194 : 26 : MP_THREAD_GIL_EXIT();
195 : 26 : off_t off = lseek(o->fd, s->offset, s->whence);
196 : 26 : MP_THREAD_GIL_ENTER();
197 [ - + ]: 26 : if (off == (off_t)-1) {
198 : 0 : *errcode = errno;
199 : 0 : return MP_STREAM_ERROR;
200 : : }
201 : 26 : s->offset = off;
202 : 26 : return 0;
203 : : }
204 : 7520 : case MP_STREAM_CLOSE:
205 [ + + ]: 7520 : if (o->fd >= 0) {
206 : 3781 : MP_THREAD_GIL_EXIT();
207 : 3781 : close(o->fd);
208 : 7520 : MP_THREAD_GIL_ENTER();
209 : : }
210 : 7520 : o->fd = -1;
211 : 7520 : return 0;
212 : 2 : case MP_STREAM_GET_FILENO:
213 : 2 : return o->fd;
214 : : #if MICROPY_PY_SELECT && !MICROPY_PY_SELECT_POSIX_OPTIMISATIONS
215 : : case MP_STREAM_POLL: {
216 : : #ifdef _WIN32
217 : : mp_raise_NotImplementedError(MP_ERROR_TEXT("poll on file not available on win32"));
218 : : #else
219 : : mp_uint_t ret = 0;
220 : : uint8_t pollevents = 0;
221 : : if (arg & MP_STREAM_POLL_RD) {
222 : : pollevents |= POLLIN;
223 : : }
224 : : if (arg & MP_STREAM_POLL_WR) {
225 : : pollevents |= POLLOUT;
226 : : }
227 : : struct pollfd pfd = { .fd = o->fd, .events = pollevents };
228 : : if (poll(&pfd, 1, 0) > 0) {
229 : : if (pfd.revents & POLLIN) {
230 : : ret |= MP_STREAM_POLL_RD;
231 : : }
232 : : if (pfd.revents & POLLOUT) {
233 : : ret |= MP_STREAM_POLL_WR;
234 : : }
235 : : if (pfd.revents & POLLERR) {
236 : : ret |= MP_STREAM_POLL_ERR;
237 : : }
238 : : if (pfd.revents & POLLHUP) {
239 : : ret |= MP_STREAM_POLL_HUP;
240 : : }
241 : : if (pfd.revents & POLLNVAL) {
242 : : ret |= MP_STREAM_POLL_NVAL;
243 : : }
244 : : }
245 : : return ret;
246 : : #endif
247 : : }
248 : : #endif
249 : 3661 : default:
250 : 3661 : *errcode = EINVAL;
251 : 3661 : return MP_STREAM_ERROR;
252 : : }
253 : : }
254 : :
255 : : static const mp_rom_map_elem_t vfs_posix_rawfile_locals_dict_table[] = {
256 : : { MP_ROM_QSTR(MP_QSTR_fileno), MP_ROM_PTR(&vfs_posix_file_fileno_obj) },
257 : : { MP_ROM_QSTR(MP_QSTR_read), MP_ROM_PTR(&mp_stream_read_obj) },
258 : : { MP_ROM_QSTR(MP_QSTR_readinto), MP_ROM_PTR(&mp_stream_readinto_obj) },
259 : : { MP_ROM_QSTR(MP_QSTR_readline), MP_ROM_PTR(&mp_stream_unbuffered_readline_obj) },
260 : : { MP_ROM_QSTR(MP_QSTR_readlines), MP_ROM_PTR(&mp_stream_unbuffered_readlines_obj) },
261 : : { MP_ROM_QSTR(MP_QSTR_write), MP_ROM_PTR(&mp_stream_write_obj) },
262 : : { MP_ROM_QSTR(MP_QSTR_seek), MP_ROM_PTR(&mp_stream_seek_obj) },
263 : : { MP_ROM_QSTR(MP_QSTR_tell), MP_ROM_PTR(&mp_stream_tell_obj) },
264 : : { MP_ROM_QSTR(MP_QSTR_flush), MP_ROM_PTR(&mp_stream_flush_obj) },
265 : : { MP_ROM_QSTR(MP_QSTR_close), MP_ROM_PTR(&mp_stream_close_obj) },
266 : : { MP_ROM_QSTR(MP_QSTR___del__), MP_ROM_PTR(&mp_stream_close_obj) },
267 : : { MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&mp_identity_obj) },
268 : : { MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&mp_stream___exit___obj) },
269 : : };
270 : :
271 : : static MP_DEFINE_CONST_DICT(vfs_posix_rawfile_locals_dict, vfs_posix_rawfile_locals_dict_table);
272 : :
273 : : static const mp_stream_p_t vfs_posix_fileio_stream_p = {
274 : : .read = vfs_posix_file_read,
275 : : .write = vfs_posix_file_write,
276 : : .ioctl = vfs_posix_file_ioctl,
277 : : };
278 : :
279 : : MP_DEFINE_CONST_OBJ_TYPE(
280 : : mp_type_vfs_posix_fileio,
281 : : MP_QSTR_FileIO,
282 : : MP_TYPE_FLAG_ITER_IS_STREAM,
283 : : print, vfs_posix_file_print,
284 : : protocol, &vfs_posix_fileio_stream_p,
285 : : locals_dict, &vfs_posix_rawfile_locals_dict
286 : : );
287 : :
288 : : static const mp_stream_p_t vfs_posix_textio_stream_p = {
289 : : .read = vfs_posix_file_read,
290 : : .write = vfs_posix_file_write,
291 : : .ioctl = vfs_posix_file_ioctl,
292 : : .is_text = true,
293 : : };
294 : :
295 : : #if MICROPY_PY_SYS_STDIO_BUFFER
296 : :
297 : : mp_obj_vfs_posix_file_t mp_sys_stdin_buffer_obj = {{&mp_type_vfs_posix_fileio}, STDIN_FILENO};
298 : : mp_obj_vfs_posix_file_t mp_sys_stdout_buffer_obj = {{&mp_type_vfs_posix_fileio}, STDOUT_FILENO};
299 : : mp_obj_vfs_posix_file_t mp_sys_stderr_buffer_obj = {{&mp_type_vfs_posix_fileio}, STDERR_FILENO};
300 : :
301 : : // Forward declarations.
302 : : mp_obj_vfs_posix_file_t mp_sys_stdin_obj;
303 : : mp_obj_vfs_posix_file_t mp_sys_stdout_obj;
304 : : mp_obj_vfs_posix_file_t mp_sys_stderr_obj;
305 : :
306 : 332 : static void vfs_posix_textio_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
307 [ + - ]: 332 : if (dest[0] != MP_OBJ_NULL) {
308 : : // These objects are read-only.
309 : : return;
310 : : }
311 : :
312 [ + + ]: 332 : if (attr == MP_QSTR_buffer) {
313 : : // Implement the `buffer` attribute only on std{in,out,err} instances.
314 [ + + ]: 56 : if (MP_OBJ_TO_PTR(self_in) == &mp_sys_stdin_obj) {
315 : 16 : dest[0] = MP_OBJ_FROM_PTR(&mp_sys_stdin_buffer_obj);
316 : 16 : return;
317 : : }
318 [ + + ]: 40 : if (MP_OBJ_TO_PTR(self_in) == &mp_sys_stdout_obj) {
319 : 20 : dest[0] = MP_OBJ_FROM_PTR(&mp_sys_stdout_buffer_obj);
320 : 20 : return;
321 : : }
322 [ + - ]: 20 : if (MP_OBJ_TO_PTR(self_in) == &mp_sys_stderr_obj) {
323 : 20 : dest[0] = MP_OBJ_FROM_PTR(&mp_sys_stderr_buffer_obj);
324 : 20 : return;
325 : : }
326 : : }
327 : :
328 : : // Any other attribute - forward to locals dict.
329 : 276 : dest[1] = MP_OBJ_SENTINEL;
330 : : };
331 : :
332 : : #define VFS_POSIX_TEXTIO_TYPE_ATTR attr, vfs_posix_textio_attr,
333 : :
334 : : #else
335 : :
336 : : #define VFS_POSIX_TEXTIO_TYPE_ATTR
337 : :
338 : : #endif // MICROPY_PY_SYS_STDIO_BUFFER
339 : :
340 : : MP_DEFINE_CONST_OBJ_TYPE(
341 : : mp_type_vfs_posix_textio,
342 : : MP_QSTR_TextIOWrapper,
343 : : MP_TYPE_FLAG_ITER_IS_STREAM,
344 : : print, vfs_posix_file_print,
345 : : protocol, &vfs_posix_textio_stream_p,
346 : : VFS_POSIX_TEXTIO_TYPE_ATTR
347 : : locals_dict, &vfs_posix_rawfile_locals_dict
348 : : );
349 : :
350 : : mp_obj_vfs_posix_file_t mp_sys_stdin_obj = {{&mp_type_vfs_posix_textio}, STDIN_FILENO};
351 : : mp_obj_vfs_posix_file_t mp_sys_stdout_obj = {{&mp_type_vfs_posix_textio}, STDOUT_FILENO};
352 : : mp_obj_vfs_posix_file_t mp_sys_stderr_obj = {{&mp_type_vfs_posix_textio}, STDERR_FILENO};
353 : :
354 : : #endif // MICROPY_VFS_POSIX
|
