LCOV - code coverage report
Current view: top level - extmod - vfs_fat_file.c (source / functions) Hit Total Coverage
Test: unix_coverage_v1.19.1-722-g1b774b373.info Lines: 89 93 95.7 %
Date: 2022-11-29 09:02:29 Functions: 6 6 100.0 %
Branches: 32 36 88.9 %

           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, 2014 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/mpconfig.h"
      28                 :            : #if MICROPY_VFS && MICROPY_VFS_FAT
      29                 :            : 
      30                 :            : #include <stdio.h>
      31                 :            : 
      32                 :            : #include "py/runtime.h"
      33                 :            : #include "py/stream.h"
      34                 :            : #include "py/mperrno.h"
      35                 :            : #include "lib/oofatfs/ff.h"
      36                 :            : #include "extmod/vfs_fat.h"
      37                 :            : 
      38                 :            : // this table converts from FRESULT to POSIX errno
      39                 :            : const byte fresult_to_errno_table[20] = {
      40                 :            :     [FR_OK] = 0,
      41                 :            :     [FR_DISK_ERR] = MP_EIO,
      42                 :            :     [FR_INT_ERR] = MP_EIO,
      43                 :            :     [FR_NOT_READY] = MP_EBUSY,
      44                 :            :     [FR_NO_FILE] = MP_ENOENT,
      45                 :            :     [FR_NO_PATH] = MP_ENOENT,
      46                 :            :     [FR_INVALID_NAME] = MP_EINVAL,
      47                 :            :     [FR_DENIED] = MP_EACCES,
      48                 :            :     [FR_EXIST] = MP_EEXIST,
      49                 :            :     [FR_INVALID_OBJECT] = MP_EINVAL,
      50                 :            :     [FR_WRITE_PROTECTED] = MP_EROFS,
      51                 :            :     [FR_INVALID_DRIVE] = MP_ENODEV,
      52                 :            :     [FR_NOT_ENABLED] = MP_ENODEV,
      53                 :            :     [FR_NO_FILESYSTEM] = MP_ENODEV,
      54                 :            :     [FR_MKFS_ABORTED] = MP_EIO,
      55                 :            :     [FR_TIMEOUT] = MP_EIO,
      56                 :            :     [FR_LOCKED] = MP_EIO,
      57                 :            :     [FR_NOT_ENOUGH_CORE] = MP_ENOMEM,
      58                 :            :     [FR_TOO_MANY_OPEN_FILES] = MP_EMFILE,
      59                 :            :     [FR_INVALID_PARAMETER] = MP_EINVAL,
      60                 :            : };
      61                 :            : 
      62                 :            : typedef struct _pyb_file_obj_t {
      63                 :            :     mp_obj_base_t base;
      64                 :            :     FIL fp;
      65                 :            : } pyb_file_obj_t;
      66                 :            : 
      67                 :          4 : STATIC void file_obj_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
      68                 :          4 :     (void)kind;
      69                 :          4 :     mp_printf(print, "<io.%s %p>", mp_obj_get_type_str(self_in), MP_OBJ_TO_PTR(self_in));
      70                 :          4 : }
      71                 :            : 
      72                 :         56 : STATIC mp_uint_t file_obj_read(mp_obj_t self_in, void *buf, mp_uint_t size, int *errcode) {
      73                 :         56 :     pyb_file_obj_t *self = MP_OBJ_TO_PTR(self_in);
      74                 :         56 :     UINT sz_out;
      75                 :         56 :     FRESULT res = f_read(&self->fp, buf, size, &sz_out);
      76         [ +  + ]:         56 :     if (res != FR_OK) {
      77                 :          2 :         *errcode = fresult_to_errno_table[res];
      78                 :          2 :         return MP_STREAM_ERROR;
      79                 :            :     }
      80                 :         54 :     return sz_out;
      81                 :            : }
      82                 :            : 
      83                 :         54 : STATIC mp_uint_t file_obj_write(mp_obj_t self_in, const void *buf, mp_uint_t size, int *errcode) {
      84                 :         54 :     pyb_file_obj_t *self = MP_OBJ_TO_PTR(self_in);
      85                 :         54 :     UINT sz_out;
      86                 :         54 :     FRESULT res = f_write(&self->fp, buf, size, &sz_out);
      87         [ +  + ]:         54 :     if (res != FR_OK) {
      88                 :          2 :         *errcode = fresult_to_errno_table[res];
      89                 :          2 :         return MP_STREAM_ERROR;
      90                 :            :     }
      91         [ +  + ]:         52 :     if (sz_out != size) {
      92                 :            :         // The FatFS documentation says that this means disk full.
      93                 :          2 :         *errcode = MP_ENOSPC;
      94                 :          2 :         return MP_STREAM_ERROR;
      95                 :            :     }
      96                 :            :     return sz_out;
      97                 :            : }
      98                 :            : 
      99                 :            : 
     100                 :         34 : STATIC mp_obj_t file_obj___exit__(size_t n_args, const mp_obj_t *args) {
     101                 :         34 :     (void)n_args;
     102                 :         34 :     return mp_stream_close(args[0]);
     103                 :            : }
     104                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(file_obj___exit___obj, 4, 4, file_obj___exit__);
     105                 :            : 
     106                 :        172 : STATIC mp_uint_t file_obj_ioctl(mp_obj_t o_in, mp_uint_t request, uintptr_t arg, int *errcode) {
     107                 :        172 :     pyb_file_obj_t *self = MP_OBJ_TO_PTR(o_in);
     108                 :            : 
     109         [ +  + ]:        172 :     if (request == MP_STREAM_SEEK) {
     110                 :         10 :         struct mp_stream_seek_t *s = (struct mp_stream_seek_t *)(uintptr_t)arg;
     111                 :            : 
     112   [ +  +  +  - ]:         10 :         switch (s->whence) {
     113                 :          2 :             case 0: // SEEK_SET
     114                 :          2 :                 f_lseek(&self->fp, s->offset);
     115                 :          2 :                 break;
     116                 :            : 
     117                 :          6 :             case 1: // SEEK_CUR
     118                 :          6 :                 f_lseek(&self->fp, f_tell(&self->fp) + s->offset);
     119                 :          6 :                 break;
     120                 :            : 
     121                 :          2 :             case 2: // SEEK_END
     122                 :          2 :                 f_lseek(&self->fp, f_size(&self->fp) + s->offset);
     123                 :          2 :                 break;
     124                 :            :         }
     125                 :            : 
     126                 :         10 :         s->offset = f_tell(&self->fp);
     127                 :         10 :         return 0;
     128                 :            : 
     129         [ +  + ]:        162 :     } else if (request == MP_STREAM_FLUSH) {
     130                 :          4 :         FRESULT res = f_sync(&self->fp);
     131         [ +  + ]:          4 :         if (res != FR_OK) {
     132                 :          2 :             *errcode = fresult_to_errno_table[res];
     133                 :          2 :             return MP_STREAM_ERROR;
     134                 :            :         }
     135                 :            :         return 0;
     136                 :            : 
     137         [ +  - ]:        158 :     } else if (request == MP_STREAM_CLOSE) {
     138                 :            :         // if fs==NULL then the file is closed and in that case this method is a no-op
     139         [ +  + ]:        158 :         if (self->fp.obj.fs != NULL) {
     140                 :         82 :             FRESULT res = f_close(&self->fp);
     141         [ -  + ]:         82 :             if (res != FR_OK) {
     142                 :          0 :                 *errcode = fresult_to_errno_table[res];
     143                 :          0 :                 return MP_STREAM_ERROR;
     144                 :            :             }
     145                 :            :         }
     146                 :        158 :         return 0;
     147                 :            : 
     148                 :            :     } else {
     149                 :          0 :         *errcode = MP_EINVAL;
     150                 :          0 :         return MP_STREAM_ERROR;
     151                 :            :     }
     152                 :            : }
     153                 :            : 
     154                 :            : // TODO gc hook to close the file if not already closed
     155                 :            : 
     156                 :            : STATIC const mp_rom_map_elem_t vfs_fat_rawfile_locals_dict_table[] = {
     157                 :            :     { MP_ROM_QSTR(MP_QSTR_read), MP_ROM_PTR(&mp_stream_read_obj) },
     158                 :            :     { MP_ROM_QSTR(MP_QSTR_readinto), MP_ROM_PTR(&mp_stream_readinto_obj) },
     159                 :            :     { MP_ROM_QSTR(MP_QSTR_readline), MP_ROM_PTR(&mp_stream_unbuffered_readline_obj) },
     160                 :            :     { MP_ROM_QSTR(MP_QSTR_readlines), MP_ROM_PTR(&mp_stream_unbuffered_readlines_obj) },
     161                 :            :     { MP_ROM_QSTR(MP_QSTR_write), MP_ROM_PTR(&mp_stream_write_obj) },
     162                 :            :     { MP_ROM_QSTR(MP_QSTR_flush), MP_ROM_PTR(&mp_stream_flush_obj) },
     163                 :            :     { MP_ROM_QSTR(MP_QSTR_close), MP_ROM_PTR(&mp_stream_close_obj) },
     164                 :            :     { MP_ROM_QSTR(MP_QSTR_seek), MP_ROM_PTR(&mp_stream_seek_obj) },
     165                 :            :     { MP_ROM_QSTR(MP_QSTR_tell), MP_ROM_PTR(&mp_stream_tell_obj) },
     166                 :            :     { MP_ROM_QSTR(MP_QSTR___del__), MP_ROM_PTR(&mp_stream_close_obj) },
     167                 :            :     { MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&mp_identity_obj) },
     168                 :            :     { MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&file_obj___exit___obj) },
     169                 :            : };
     170                 :            : 
     171                 :            : STATIC MP_DEFINE_CONST_DICT(vfs_fat_rawfile_locals_dict, vfs_fat_rawfile_locals_dict_table);
     172                 :            : 
     173                 :            : STATIC const mp_stream_p_t vfs_fat_fileio_stream_p = {
     174                 :            :     .read = file_obj_read,
     175                 :            :     .write = file_obj_write,
     176                 :            :     .ioctl = file_obj_ioctl,
     177                 :            : };
     178                 :            : 
     179                 :            : MP_DEFINE_CONST_OBJ_TYPE(
     180                 :            :     mp_type_vfs_fat_fileio,
     181                 :            :     MP_QSTR_FileIO,
     182                 :            :     MP_TYPE_FLAG_ITER_IS_STREAM,
     183                 :            :     print, file_obj_print,
     184                 :            :     protocol, &vfs_fat_fileio_stream_p,
     185                 :            :     locals_dict, &vfs_fat_rawfile_locals_dict
     186                 :            :     );
     187                 :            : 
     188                 :            : STATIC const mp_stream_p_t vfs_fat_textio_stream_p = {
     189                 :            :     .read = file_obj_read,
     190                 :            :     .write = file_obj_write,
     191                 :            :     .ioctl = file_obj_ioctl,
     192                 :            :     .is_text = true,
     193                 :            : };
     194                 :            : 
     195                 :            : MP_DEFINE_CONST_OBJ_TYPE(
     196                 :            :     mp_type_vfs_fat_textio,
     197                 :            :     MP_QSTR_TextIOWrapper,
     198                 :            :     MP_TYPE_FLAG_ITER_IS_STREAM,
     199                 :            :     print, file_obj_print,
     200                 :            :     protocol, &vfs_fat_textio_stream_p,
     201                 :            :     locals_dict, &vfs_fat_rawfile_locals_dict
     202                 :            :     );
     203                 :            : 
     204                 :            : // Factory function for I/O stream classes
     205                 :         86 : STATIC mp_obj_t fat_vfs_open(mp_obj_t self_in, mp_obj_t path_in, mp_obj_t mode_in) {
     206                 :         86 :     fs_user_mount_t *self = MP_OBJ_TO_PTR(self_in);
     207                 :            : 
     208                 :         86 :     const mp_obj_type_t *type = &mp_type_vfs_fat_textio;
     209                 :         86 :     int mode = 0;
     210                 :         86 :     const char *mode_s = mp_obj_str_get_str(mode_in);
     211                 :            :     // TODO make sure only one of r, w, x, a, and b, t are specified
     212         [ +  + ]:        188 :     while (*mode_s) {
     213   [ +  +  +  +  :        102 :         switch (*mode_s++) {
             +  +  +  - ]
     214                 :         26 :             case 'r':
     215                 :         26 :                 mode |= FA_READ;
     216                 :         26 :                 break;
     217                 :         56 :             case 'w':
     218                 :         56 :                 mode |= FA_WRITE | FA_CREATE_ALWAYS;
     219                 :         56 :                 break;
     220                 :          2 :             case 'x':
     221                 :          2 :                 mode |= FA_WRITE | FA_CREATE_NEW;
     222                 :          2 :                 break;
     223                 :          2 :             case 'a':
     224                 :          2 :                 mode |= FA_WRITE | FA_OPEN_ALWAYS;
     225                 :          2 :                 break;
     226                 :          4 :             case '+':
     227                 :          4 :                 mode |= FA_READ | FA_WRITE;
     228                 :          4 :                 break;
     229                 :          6 :             case 'b':
     230                 :          6 :                 type = &mp_type_vfs_fat_fileio;
     231                 :          6 :                 break;
     232                 :          6 :             case 't':
     233                 :          6 :                 type = &mp_type_vfs_fat_textio;
     234                 :          6 :                 break;
     235                 :            :         }
     236                 :            :     }
     237                 :            : 
     238                 :         86 :     pyb_file_obj_t *o = m_new_obj_with_finaliser(pyb_file_obj_t);
     239                 :         84 :     o->base.type = type;
     240                 :            : 
     241                 :         84 :     const char *fname = mp_obj_str_get_str(path_in);
     242                 :         84 :     FRESULT res = f_open(&self->fatfs, &o->fp, fname, mode);
     243         [ +  + ]:         84 :     if (res != FR_OK) {
     244                 :          2 :         m_del_obj(pyb_file_obj_t, o);
     245                 :          2 :         mp_raise_OSError(fresult_to_errno_table[res]);
     246                 :            :     }
     247                 :            : 
     248                 :            :     // for 'a' mode, we must begin at the end of the file
     249         [ +  + ]:         82 :     if ((mode & FA_OPEN_ALWAYS) != 0) {
     250                 :          2 :         f_lseek(&o->fp, f_size(&o->fp));
     251                 :            :     }
     252                 :            : 
     253                 :         82 :     return MP_OBJ_FROM_PTR(o);
     254                 :            : }
     255                 :            : MP_DEFINE_CONST_FUN_OBJ_3(fat_vfs_open_obj, fat_vfs_open);
     256                 :            : 
     257                 :            : #endif // MICROPY_VFS && MICROPY_VFS_FAT

Generated by: LCOV version 1.15-5-g462f71d