LCOV - code coverage report
Current view: top level - extmod - vfs_posix_file.c (source / functions) Hit Total Coverage
Test: unix_coverage_v1.19.1-724-gfb7d21153.info Lines: 86 96 89.6 %
Date: 2022-12-01 09:37:31 Functions: 8 8 100.0 %
Branches: 27 44 61.4 %

           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                 :     769348 : STATIC void check_fd_is_open(const mp_obj_vfs_posix_file_t *o) {
      51         [ +  + ]:     769348 :     if (o->fd < 0) {
      52                 :          4 :         mp_raise_ValueError(MP_ERROR_TEXT("I/O operation on closed file"));
      53                 :            :     }
      54                 :     769344 : }
      55                 :            : #else
      56                 :            : #define check_fd_is_open(o)
      57                 :            : #endif
      58                 :            : 
      59                 :          2 : STATIC void vfs_posix_file_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
      60                 :          2 :     (void)kind;
      61                 :          2 :     mp_obj_vfs_posix_file_t *self = MP_OBJ_TO_PTR(self_in);
      62                 :          2 :     mp_printf(print, "<io.%s %d>", mp_obj_get_type_str(self_in), self->fd);
      63                 :          2 : }
      64                 :            : 
      65                 :       3482 : 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                 :       3482 :     mp_obj_vfs_posix_file_t *o = m_new_obj_with_finaliser(mp_obj_vfs_posix_file_t);
      67                 :       3482 :     const char *mode_s = mp_obj_str_get_str(mode_in);
      68                 :            : 
      69                 :       3482 :     int mode_rw = 0, mode_x = 0;
      70         [ +  + ]:      10378 :     while (*mode_s) {
      71   [ +  +  +  +  :       6896 :         switch (*mode_s++) {
                +  +  - ]
      72                 :       3430 :             case 'r':
      73                 :       3430 :                 mode_rw = O_RDONLY;
      74                 :       3430 :                 break;
      75                 :         38 :             case 'w':
      76                 :         38 :                 mode_rw = O_WRONLY;
      77                 :         38 :                 mode_x = O_CREAT | O_TRUNC;
      78                 :         38 :                 break;
      79                 :         14 :             case 'a':
      80                 :         14 :                 mode_rw = O_WRONLY;
      81                 :         14 :                 mode_x = O_CREAT | O_APPEND;
      82                 :         14 :                 break;
      83                 :          8 :             case '+':
      84                 :          8 :                 mode_rw = O_RDWR;
      85                 :          8 :                 break;
      86                 :       3400 :             case 'b':
      87                 :       3400 :                 type = &mp_type_vfs_posix_fileio;
      88                 :       3400 :                 break;
      89                 :          6 :             case 't':
      90                 :          6 :                 type = &mp_type_vfs_posix_textio;
      91                 :          6 :                 break;
      92                 :            :         }
      93                 :            :     }
      94                 :            : 
      95                 :       3482 :     o->base.type = type;
      96                 :            : 
      97                 :       3482 :     mp_obj_t fid = file_in;
      98                 :            : 
      99         [ +  + ]:       3482 :     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                 :       3480 :     const char *fname = mp_obj_str_get_str(fid);
     105                 :       3480 :     int fd;
     106   [ +  +  -  + ]:       3480 :     MP_HAL_RETRY_SYSCALL(fd, open(fname, mode_x | mode_rw, 0644), mp_raise_OSError(err));
     107                 :       3476 :     o->fd = fd;
     108                 :       3476 :     return MP_OBJ_FROM_PTR(o);
     109                 :            : }
     110                 :            : 
     111                 :          8 : STATIC mp_obj_t vfs_posix_file_fileno(mp_obj_t self_in) {
     112                 :          8 :     mp_obj_vfs_posix_file_t *self = MP_OBJ_TO_PTR(self_in);
     113                 :          8 :     check_fd_is_open(self);
     114                 :          8 :     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                 :          8 : STATIC mp_obj_t vfs_posix_file___exit__(size_t n_args, const mp_obj_t *args) {
     119                 :          8 :     (void)n_args;
     120                 :          8 :     return mp_stream_close(args[0]);
     121                 :            : }
     122                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(vfs_posix_file___exit___obj, 4, 4, vfs_posix_file___exit__);
     123                 :            : 
     124                 :     161902 : STATIC mp_uint_t vfs_posix_file_read(mp_obj_t o_in, void *buf, mp_uint_t size, int *errcode) {
     125                 :     161902 :     mp_obj_vfs_posix_file_t *o = MP_OBJ_TO_PTR(o_in);
     126                 :     161902 :     check_fd_is_open(o);
     127                 :     161900 :     ssize_t r;
     128   [ +  +  -  + ]:     161900 :     MP_HAL_RETRY_SYSCALL(r, read(o->fd, buf, size), {
     129                 :            :         *errcode = err;
     130                 :            :         return MP_STREAM_ERROR;
     131                 :     161890 :     });
     132                 :     161890 :     return (mp_uint_t)r;
     133                 :            : }
     134                 :            : 
     135                 :     607410 : STATIC mp_uint_t vfs_posix_file_write(mp_obj_t o_in, const void *buf, mp_uint_t size, int *errcode) {
     136                 :     607410 :     mp_obj_vfs_posix_file_t *o = MP_OBJ_TO_PTR(o_in);
     137                 :     607410 :     check_fd_is_open(o);
     138                 :            :     #if MICROPY_PY_OS_DUPTERM
     139                 :            :     if (o->fd <= STDERR_FILENO) {
     140                 :            :         mp_hal_stdout_tx_strn(buf, size);
     141                 :            :         return size;
     142                 :            :     }
     143                 :            :     #endif
     144                 :     607410 :     ssize_t r;
     145   [ +  +  -  + ]:     607410 :     MP_HAL_RETRY_SYSCALL(r, write(o->fd, buf, size), {
     146                 :            :         *errcode = err;
     147                 :            :         return MP_STREAM_ERROR;
     148                 :     607408 :     });
     149                 :     607408 :     return (mp_uint_t)r;
     150                 :            : }
     151                 :            : 
     152                 :       6942 : STATIC mp_uint_t vfs_posix_file_ioctl(mp_obj_t o_in, mp_uint_t request, uintptr_t arg, int *errcode) {
     153                 :       6942 :     mp_obj_vfs_posix_file_t *o = MP_OBJ_TO_PTR(o_in);
     154                 :            : 
     155         [ +  + ]:       6942 :     if (request != MP_STREAM_CLOSE) {
     156                 :         28 :         check_fd_is_open(o);
     157                 :            :     }
     158                 :            : 
     159   [ -  +  -  -  :         26 :     switch (request) {
                      - ]
     160                 :          0 :         case MP_STREAM_FLUSH: {
     161                 :          0 :             int ret;
     162   [ #  #  #  #  :          0 :             MP_HAL_RETRY_SYSCALL(ret, fsync(o->fd), {
             #  #  #  # ]
     163                 :            :                 if (err == EINVAL
     164                 :            :                     && (o->fd == STDIN_FILENO || o->fd == STDOUT_FILENO || o->fd == STDERR_FILENO)) {
     165                 :            :                     // fsync(stdin/stdout/stderr) may fail with EINVAL, but don't propagate that
     166                 :            :                     // error out.  Because data is not buffered by us, and stdin/out/err.flush()
     167                 :            :                     // should just be a no-op.
     168                 :            :                     return 0;
     169                 :            :                 }
     170                 :            :                 *errcode = err;
     171                 :            :                 return MP_STREAM_ERROR;
     172                 :            :             });
     173                 :            :             return 0;
     174                 :            :         }
     175                 :         26 :         case MP_STREAM_SEEK: {
     176                 :         26 :             struct mp_stream_seek_t *s = (struct mp_stream_seek_t *)arg;
     177                 :         26 :             MP_THREAD_GIL_EXIT();
     178                 :         26 :             off_t off = lseek(o->fd, s->offset, s->whence);
     179                 :         26 :             MP_THREAD_GIL_ENTER();
     180         [ -  + ]:         26 :             if (off == (off_t)-1) {
     181                 :          0 :                 *errcode = errno;
     182                 :          0 :                 return MP_STREAM_ERROR;
     183                 :            :             }
     184                 :         26 :             s->offset = off;
     185                 :         26 :             return 0;
     186                 :            :         }
     187                 :       6914 :         case MP_STREAM_CLOSE:
     188         [ +  + ]:       6914 :             if (o->fd >= 0) {
     189                 :       3482 :                 MP_THREAD_GIL_EXIT();
     190                 :       3482 :                 close(o->fd);
     191                 :       6914 :                 MP_THREAD_GIL_ENTER();
     192                 :            :             }
     193                 :       6914 :             o->fd = -1;
     194                 :       6914 :             return 0;
     195                 :          0 :         case MP_STREAM_GET_FILENO:
     196                 :          0 :             return o->fd;
     197                 :            :         #if MICROPY_PY_USELECT
     198                 :            :         case MP_STREAM_POLL: {
     199                 :            :             #ifdef _WIN32
     200                 :            :             mp_raise_NotImplementedError(MP_ERROR_TEXT("poll on file not available on win32"));
     201                 :            :             #else
     202                 :            :             mp_uint_t ret = 0;
     203                 :            :             uint8_t pollevents = 0;
     204                 :            :             if (arg & MP_STREAM_POLL_RD) {
     205                 :            :                 pollevents |= POLLIN;
     206                 :            :             }
     207                 :            :             if (arg & MP_STREAM_POLL_WR) {
     208                 :            :                 pollevents |= POLLOUT;
     209                 :            :             }
     210                 :            :             struct pollfd pfd = { .fd = o->fd, .events = pollevents };
     211                 :            :             if (poll(&pfd, 1, 0) > 0) {
     212                 :            :                 if (pfd.revents & POLLIN) {
     213                 :            :                     ret |= MP_STREAM_POLL_RD;
     214                 :            :                 }
     215                 :            :                 if (pfd.revents & POLLOUT) {
     216                 :            :                     ret |= MP_STREAM_POLL_WR;
     217                 :            :                 }
     218                 :            :             }
     219                 :            :             return ret;
     220                 :            :             #endif
     221                 :            :         }
     222                 :            :         #endif
     223                 :          0 :         default:
     224                 :          0 :             *errcode = EINVAL;
     225                 :          0 :             return MP_STREAM_ERROR;
     226                 :            :     }
     227                 :            : }
     228                 :            : 
     229                 :            : STATIC const mp_rom_map_elem_t vfs_posix_rawfile_locals_dict_table[] = {
     230                 :            :     { MP_ROM_QSTR(MP_QSTR_fileno), MP_ROM_PTR(&vfs_posix_file_fileno_obj) },
     231                 :            :     { MP_ROM_QSTR(MP_QSTR_read), MP_ROM_PTR(&mp_stream_read_obj) },
     232                 :            :     { MP_ROM_QSTR(MP_QSTR_readinto), MP_ROM_PTR(&mp_stream_readinto_obj) },
     233                 :            :     { MP_ROM_QSTR(MP_QSTR_readline), MP_ROM_PTR(&mp_stream_unbuffered_readline_obj) },
     234                 :            :     { MP_ROM_QSTR(MP_QSTR_readlines), MP_ROM_PTR(&mp_stream_unbuffered_readlines_obj) },
     235                 :            :     { MP_ROM_QSTR(MP_QSTR_write), MP_ROM_PTR(&mp_stream_write_obj) },
     236                 :            :     { MP_ROM_QSTR(MP_QSTR_seek), MP_ROM_PTR(&mp_stream_seek_obj) },
     237                 :            :     { MP_ROM_QSTR(MP_QSTR_tell), MP_ROM_PTR(&mp_stream_tell_obj) },
     238                 :            :     { MP_ROM_QSTR(MP_QSTR_flush), MP_ROM_PTR(&mp_stream_flush_obj) },
     239                 :            :     { MP_ROM_QSTR(MP_QSTR_close), MP_ROM_PTR(&mp_stream_close_obj) },
     240                 :            :     { MP_ROM_QSTR(MP_QSTR___del__), MP_ROM_PTR(&mp_stream_close_obj) },
     241                 :            :     { MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&mp_identity_obj) },
     242                 :            :     { MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&vfs_posix_file___exit___obj) },
     243                 :            : };
     244                 :            : 
     245                 :            : STATIC MP_DEFINE_CONST_DICT(vfs_posix_rawfile_locals_dict, vfs_posix_rawfile_locals_dict_table);
     246                 :            : 
     247                 :            : STATIC const mp_stream_p_t vfs_posix_fileio_stream_p = {
     248                 :            :     .read = vfs_posix_file_read,
     249                 :            :     .write = vfs_posix_file_write,
     250                 :            :     .ioctl = vfs_posix_file_ioctl,
     251                 :            : };
     252                 :            : 
     253                 :            : MP_DEFINE_CONST_OBJ_TYPE(
     254                 :            :     mp_type_vfs_posix_fileio,
     255                 :            :     MP_QSTR_FileIO,
     256                 :            :     MP_TYPE_FLAG_ITER_IS_STREAM,
     257                 :            :     print, vfs_posix_file_print,
     258                 :            :     protocol, &vfs_posix_fileio_stream_p,
     259                 :            :     locals_dict, &vfs_posix_rawfile_locals_dict
     260                 :            :     );
     261                 :            : 
     262                 :            : STATIC const mp_stream_p_t vfs_posix_textio_stream_p = {
     263                 :            :     .read = vfs_posix_file_read,
     264                 :            :     .write = vfs_posix_file_write,
     265                 :            :     .ioctl = vfs_posix_file_ioctl,
     266                 :            :     .is_text = true,
     267                 :            : };
     268                 :            : 
     269                 :            : MP_DEFINE_CONST_OBJ_TYPE(
     270                 :            :     mp_type_vfs_posix_textio,
     271                 :            :     MP_QSTR_TextIOWrapper,
     272                 :            :     MP_TYPE_FLAG_ITER_IS_STREAM,
     273                 :            :     print, vfs_posix_file_print,
     274                 :            :     protocol, &vfs_posix_textio_stream_p,
     275                 :            :     locals_dict, &vfs_posix_rawfile_locals_dict
     276                 :            :     );
     277                 :            : 
     278                 :            : const mp_obj_vfs_posix_file_t mp_sys_stdin_obj = {{&mp_type_vfs_posix_textio}, STDIN_FILENO};
     279                 :            : const mp_obj_vfs_posix_file_t mp_sys_stdout_obj = {{&mp_type_vfs_posix_textio}, STDOUT_FILENO};
     280                 :            : const mp_obj_vfs_posix_file_t mp_sys_stderr_obj = {{&mp_type_vfs_posix_textio}, STDERR_FILENO};
     281                 :            : 
     282                 :            : #endif // MICROPY_VFS_POSIX

Generated by: LCOV version 1.15-5-g462f71d