LCOV - code coverage report
Current view: top level - extmod - vfs.c (source / functions) Hit Total Coverage
Test: unix_coverage_v1.24.0-414-g35d4d2d06.info Lines: 252 268 94.0 %
Date: 2025-03-26 18:21:16 Functions: 20 21 95.2 %
Branches: 118 134 88.1 %

           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) 2017 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 <stdint.h>
      28                 :            : #include <string.h>
      29                 :            : 
      30                 :            : #include "py/runtime.h"
      31                 :            : #include "py/objstr.h"
      32                 :            : #include "py/mperrno.h"
      33                 :            : #include "extmod/vfs.h"
      34                 :            : 
      35                 :            : #if MICROPY_VFS
      36                 :            : 
      37                 :            : #if MICROPY_VFS_FAT
      38                 :            : #include "extmod/vfs_fat.h"
      39                 :            : #endif
      40                 :            : 
      41                 :            : #if MICROPY_VFS_LFS1 || MICROPY_VFS_LFS2
      42                 :            : #include "extmod/vfs_lfs.h"
      43                 :            : #endif
      44                 :            : 
      45                 :            : #if MICROPY_VFS_POSIX
      46                 :            : #include "extmod/vfs_posix.h"
      47                 :            : #endif
      48                 :            : 
      49                 :            : #if MICROPY_VFS_ROM && MICROPY_VFS_ROM_IOCTL
      50                 :            : #include "extmod/vfs_rom.h"
      51                 :            : #endif
      52                 :            : 
      53                 :            : // For mp_vfs_proxy_call, the maximum number of additional args that can be passed.
      54                 :            : // A fixed maximum size is used to avoid the need for a costly variable array.
      55                 :            : #define PROXY_MAX_ARGS (2)
      56                 :            : 
      57                 :            : // path is the path to lookup and *path_out holds the path within the VFS
      58                 :            : // object (starts with / if an absolute path).
      59                 :            : // Returns MP_VFS_ROOT for root dir (and then path_out is undefined) and
      60                 :            : // MP_VFS_NONE for path not found.
      61                 :      24272 : mp_vfs_mount_t *mp_vfs_lookup_path(const char *path, const char **path_out) {
      62   [ +  +  +  + ]:      24272 :     if (*path == '/' || MP_STATE_VM(vfs_cur) == MP_VFS_ROOT) {
      63                 :            :         // an absolute path, or the current volume is root, so search root dir
      64                 :      18070 :         bool is_abs = 0;
      65         [ +  + ]:      18070 :         if (*path == '/') {
      66                 :      17984 :             ++path;
      67                 :      17984 :             is_abs = 1;
      68                 :            :         }
      69         [ +  + ]:      18070 :         if (*path == '\0') {
      70                 :            :             // path is "" or "/" so return virtual root
      71                 :            :             return MP_VFS_ROOT;
      72                 :            :         }
      73         [ +  + ]:      25950 :         for (mp_vfs_mount_t *vfs = MP_STATE_VM(vfs_mount_table); vfs != NULL; vfs = vfs->next) {
      74                 :      22466 :             size_t len = vfs->len - 1;
      75         [ +  + ]:      22466 :             if (len == 0) {
      76                 :      10710 :                 *path_out = path - is_abs;
      77                 :      10710 :                 return vfs;
      78                 :            :             }
      79         [ +  + ]:      11756 :             if (strncmp(path, vfs->str + 1, len) == 0) {
      80         [ +  + ]:        376 :                 if (path[len] == '/') {
      81                 :        312 :                     *path_out = path + len;
      82                 :        312 :                     return vfs;
      83         [ +  + ]:         64 :                 } else if (path[len] == '\0') {
      84                 :         42 :                     *path_out = "/";
      85                 :         42 :                     return vfs;
      86                 :            :                 }
      87                 :            :             }
      88                 :            :         }
      89                 :            : 
      90                 :            :         // if we get here then there's nothing mounted on /, so the path doesn't exist
      91                 :            :         return MP_VFS_NONE;
      92                 :            :     }
      93                 :            : 
      94                 :            :     // a relative path within a mounted device
      95                 :       6202 :     *path_out = path;
      96                 :       6202 :     return MP_STATE_VM(vfs_cur);
      97                 :            : }
      98                 :            : 
      99                 :            : // Version of mp_vfs_lookup_path that takes and returns uPy string objects.
     100                 :       4305 : static mp_vfs_mount_t *lookup_path(mp_obj_t path_in, mp_obj_t *path_out) {
     101                 :       4305 :     const char *path = mp_obj_str_get_str(path_in);
     102                 :       4305 :     const char *p_out;
     103                 :       4305 :     mp_vfs_mount_t *vfs = mp_vfs_lookup_path(path, &p_out);
     104         [ +  + ]:       4305 :     if (vfs != MP_VFS_NONE && vfs != MP_VFS_ROOT) {
     105                 :       4209 :         *path_out = mp_obj_new_str_of_type(mp_obj_get_type(path_in),
     106                 :            :             (const byte *)p_out, strlen(p_out));
     107                 :            :     } else {
     108                 :         96 :         *path_out = MP_OBJ_NULL;
     109                 :            :     }
     110                 :       4305 :     return vfs;
     111                 :            : }
     112                 :            : 
     113                 :      11455 : static mp_obj_t mp_vfs_proxy_call(mp_vfs_mount_t *vfs, qstr meth_name, size_t n_args, const mp_obj_t *args) {
     114         [ -  + ]:      11455 :     assert(n_args <= PROXY_MAX_ARGS);
     115         [ +  + ]:      11455 :     if (vfs == MP_VFS_NONE) {
     116                 :            :         // mount point not found
     117                 :         26 :         mp_raise_OSError(MP_ENODEV);
     118                 :            :     }
     119         [ -  + ]:      11429 :     if (vfs == MP_VFS_ROOT) {
     120                 :            :         // can't do operation on root dir
     121                 :          0 :         mp_raise_OSError(MP_EPERM);
     122                 :            :     }
     123                 :      11429 :     mp_obj_t meth[2 + PROXY_MAX_ARGS];
     124                 :      11429 :     mp_load_method(vfs->obj, meth_name, meth);
     125         [ +  + ]:      11429 :     if (args != NULL) {
     126                 :      11309 :         memcpy(meth + 2, args, n_args * sizeof(*args));
     127                 :            :     }
     128                 :      11429 :     return mp_call_method_n_kw(n_args, 0, meth);
     129                 :            : }
     130                 :            : 
     131                 :      12995 : mp_import_stat_t mp_vfs_import_stat(const char *path) {
     132                 :      12995 :     const char *path_out;
     133                 :      12995 :     mp_vfs_mount_t *vfs = mp_vfs_lookup_path(path, &path_out);
     134         [ +  - ]:      12995 :     if (vfs == MP_VFS_NONE || vfs == MP_VFS_ROOT) {
     135                 :            :         return MP_IMPORT_STAT_NO_EXIST;
     136                 :            :     }
     137                 :            : 
     138                 :            :     // If the mounted object has the VFS protocol, call its import_stat helper
     139                 :      12995 :     const mp_obj_type_t *type = mp_obj_get_type(vfs->obj);
     140         [ +  + ]:      12995 :     if (MP_OBJ_TYPE_HAS_SLOT(type, protocol)) {
     141                 :      12885 :         const mp_vfs_proto_t *proto = MP_OBJ_TYPE_GET_SLOT(type, protocol);
     142                 :      12885 :         return proto->import_stat(MP_OBJ_TO_PTR(vfs->obj), path_out);
     143                 :            :     }
     144                 :            : 
     145                 :            :     // delegate to vfs.stat() method
     146                 :        110 :     mp_obj_t path_o = mp_obj_new_str_from_cstr(path_out);
     147                 :        110 :     mp_obj_t stat;
     148                 :        110 :     nlr_buf_t nlr;
     149         [ +  + ]:        110 :     if (nlr_push(&nlr) == 0) {
     150                 :        110 :         stat = mp_vfs_proxy_call(vfs, MP_QSTR_stat, 1, &path_o);
     151                 :         40 :         nlr_pop();
     152                 :            :     } else {
     153                 :            :         // assume an exception means that the path is not found
     154                 :            :         return MP_IMPORT_STAT_NO_EXIST;
     155                 :            :     }
     156                 :         40 :     mp_obj_t *items;
     157                 :         40 :     mp_obj_get_array_fixed_n(stat, 10, &items);
     158                 :         40 :     mp_int_t st_mode = mp_obj_get_int(items[0]);
     159         [ +  - ]:         40 :     if (st_mode & MP_S_IFDIR) {
     160                 :            :         return MP_IMPORT_STAT_DIR;
     161                 :            :     } else {
     162                 :         40 :         return MP_IMPORT_STAT_FILE;
     163                 :            :     }
     164                 :            : }
     165                 :            : 
     166                 :         14 : static mp_obj_t mp_vfs_autodetect(mp_obj_t bdev_obj) {
     167                 :            :     #if MICROPY_VFS_LFS1 || MICROPY_VFS_LFS2
     168                 :         14 :     nlr_buf_t nlr;
     169         [ +  + ]:         14 :     if (nlr_push(&nlr) == 0) {
     170                 :            :         // The superblock for littlefs is in both block 0 and 1, but block 0 may be erased
     171                 :            :         // or partially written, so search both blocks 0 and 1 for the littlefs signature.
     172                 :         14 :         mp_vfs_blockdev_t blockdev;
     173                 :         14 :         mp_vfs_blockdev_init(&blockdev, bdev_obj);
     174                 :         14 :         uint8_t buf[44];
     175         [ +  + ]:         24 :         for (size_t block_num = 0; block_num <= 1; ++block_num) {
     176                 :         20 :             mp_vfs_blockdev_read_ext(&blockdev, block_num, 8, sizeof(buf), buf);
     177                 :            :             #if MICROPY_VFS_LFS1
     178         [ +  + ]:         16 :             if (memcmp(&buf[32], "littlefs", 8) == 0) {
     179                 :            :                 // LFS1
     180                 :          2 :                 mp_obj_t vfs = MP_OBJ_TYPE_GET_SLOT(&mp_type_vfs_lfs1, make_new)(&mp_type_vfs_lfs1, 1, 0, &bdev_obj);
     181                 :          2 :                 nlr_pop();
     182                 :          6 :                 return vfs;
     183                 :            :             }
     184                 :            :             #endif
     185                 :            :             #if MICROPY_VFS_LFS2
     186         [ +  + ]:         14 :             if (memcmp(&buf[0], "littlefs", 8) == 0) {
     187                 :            :                 // LFS2
     188                 :          4 :                 mp_obj_t vfs = MP_OBJ_TYPE_GET_SLOT(&mp_type_vfs_lfs2, make_new)(&mp_type_vfs_lfs2, 1, 0, &bdev_obj);
     189                 :          4 :                 nlr_pop();
     190                 :          4 :                 return vfs;
     191                 :            :             }
     192                 :            :             #endif
     193                 :            :         }
     194                 :          4 :         nlr_pop();
     195                 :            :     } else {
     196                 :            :         // Ignore exception (eg block device doesn't support extended readblocks)
     197                 :          8 :     }
     198                 :            :     #endif
     199                 :            : 
     200                 :            :     #if MICROPY_VFS_FAT
     201                 :          8 :     return MP_OBJ_TYPE_GET_SLOT(&mp_fat_vfs_type, make_new)(&mp_fat_vfs_type, 1, 0, &bdev_obj);
     202                 :            :     #endif
     203                 :            : 
     204                 :            :     // no filesystem found
     205                 :            :     mp_raise_OSError(MP_ENODEV);
     206                 :            : }
     207                 :            : 
     208                 :       6976 : mp_obj_t mp_vfs_mount(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     209                 :       6976 :     enum { ARG_readonly, ARG_mkfs };
     210                 :       6976 :     static const mp_arg_t allowed_args[] = {
     211                 :            :         { MP_QSTR_readonly, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_rom_obj = MP_ROM_FALSE} },
     212                 :            :         { MP_QSTR_mkfs, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_rom_obj = MP_ROM_FALSE} },
     213                 :            :     };
     214                 :            : 
     215                 :            :     // parse args
     216                 :       6976 :     mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
     217                 :       6976 :     mp_arg_parse_all(n_args - 2, pos_args + 2, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
     218                 :            : 
     219                 :            :     // get the mount point
     220                 :       6976 :     size_t mnt_len;
     221                 :       6976 :     const char *mnt_str = mp_obj_str_get_data(pos_args[1], &mnt_len);
     222                 :            : 
     223                 :            :     // see if we need to auto-detect and create the filesystem
     224                 :       6976 :     mp_obj_t vfs_obj = pos_args[0];
     225                 :       6976 :     mp_obj_t dest[2];
     226                 :       6976 :     mp_load_method_maybe(vfs_obj, MP_QSTR_mount, dest);
     227         [ +  + ]:       6976 :     if (dest[0] == MP_OBJ_NULL) {
     228                 :            :         // Input object has no mount method, assume it's a block device and try to
     229                 :            :         // auto-detect the filesystem and create the corresponding VFS entity.
     230                 :         14 :         vfs_obj = mp_vfs_autodetect(vfs_obj);
     231                 :            :     }
     232                 :            : 
     233                 :            :     // create new object
     234                 :       6976 :     mp_vfs_mount_t *vfs = m_new_obj(mp_vfs_mount_t);
     235                 :       6976 :     vfs->str = mnt_str;
     236                 :       6976 :     vfs->len = mnt_len;
     237                 :       6976 :     vfs->obj = vfs_obj;
     238                 :       6976 :     vfs->next = NULL;
     239                 :            : 
     240                 :            :     // call the underlying object to do any mounting operation
     241                 :       6976 :     mp_vfs_proxy_call(vfs, MP_QSTR_mount, 2, (mp_obj_t *)&args);
     242                 :            : 
     243                 :            :     // check that the destination mount point is unused
     244                 :       6972 :     const char *path_out;
     245                 :       6972 :     mp_vfs_mount_t *existing_mount = mp_vfs_lookup_path(mp_obj_str_get_str(pos_args[1]), &path_out);
     246         [ +  + ]:       6972 :     if (existing_mount != MP_VFS_NONE && existing_mount != MP_VFS_ROOT) {
     247   [ +  -  +  + ]:         62 :         if (vfs->len != 1 && existing_mount->len == 1) {
     248                 :            :             // if root dir is mounted, still allow to mount something within a subdir of root
     249                 :            :         } else {
     250                 :            :             // mount point in use
     251                 :          2 :             mp_raise_OSError(MP_EPERM);
     252                 :            :         }
     253                 :            :     }
     254                 :            : 
     255                 :            :     // insert the vfs into the mount table
     256                 :            :     mp_vfs_mount_t **vfsp = &MP_STATE_VM(vfs_mount_table);
     257         [ +  + ]:      10478 :     while (*vfsp != NULL) {
     258         [ +  + ]:       3568 :         if ((*vfsp)->len == 1) {
     259                 :            :             // make sure anything mounted at the root stays at the end of the list
     260                 :         60 :             vfs->next = *vfsp;
     261                 :         60 :             break;
     262                 :            :         }
     263                 :       3508 :         vfsp = &(*vfsp)->next;
     264                 :            :     }
     265                 :       6970 :     *vfsp = vfs;
     266                 :            : 
     267                 :       6970 :     return mp_const_none;
     268                 :            : }
     269                 :            : MP_DEFINE_CONST_FUN_OBJ_KW(mp_vfs_mount_obj, 2, mp_vfs_mount);
     270                 :            : 
     271                 :         82 : mp_obj_t mp_vfs_umount(mp_obj_t mnt_in) {
     272                 :            :     // remove vfs from the mount table
     273                 :         82 :     mp_vfs_mount_t *vfs = NULL;
     274                 :         82 :     size_t mnt_len;
     275                 :         82 :     const char *mnt_str = NULL;
     276   [ +  +  +  -  :         82 :     if (mp_obj_is_str(mnt_in)) {
                   -  + ]
     277                 :         74 :         mnt_str = mp_obj_str_get_data(mnt_in, &mnt_len);
     278                 :            :     }
     279         [ +  + ]:        146 :     for (mp_vfs_mount_t **vfsp = &MP_STATE_VM(vfs_mount_table); *vfsp != NULL; vfsp = &(*vfsp)->next) {
     280   [ +  +  +  +  :        144 :         if ((mnt_str != NULL && mnt_len == (*vfsp)->len && !memcmp(mnt_str, (*vfsp)->str, mnt_len)) || (*vfsp)->obj == mnt_in) {
             +  +  +  + ]
     281                 :         80 :             vfs = *vfsp;
     282                 :         80 :             *vfsp = (*vfsp)->next;
     283                 :         80 :             break;
     284                 :            :         }
     285                 :            :     }
     286                 :            : 
     287         [ +  + ]:         82 :     if (vfs == NULL) {
     288                 :          2 :         mp_raise_OSError(MP_EINVAL);
     289                 :            :     }
     290                 :            : 
     291                 :            :     // if we unmounted the current device then set current to root
     292         [ +  + ]:         80 :     if (MP_STATE_VM(vfs_cur) == vfs) {
     293                 :         18 :         MP_STATE_VM(vfs_cur) = MP_VFS_ROOT;
     294                 :            :     }
     295                 :            : 
     296                 :            :     // call the underlying object to do any unmounting operation
     297                 :         80 :     mp_vfs_proxy_call(vfs, MP_QSTR_umount, 0, NULL);
     298                 :            : 
     299                 :         80 :     return mp_const_none;
     300                 :            : }
     301                 :            : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_umount_obj, mp_vfs_umount);
     302                 :            : 
     303                 :            : // Note: buffering and encoding args are currently ignored
     304                 :       3923 : mp_obj_t mp_vfs_open(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     305                 :       3923 :     enum { ARG_file, ARG_mode, ARG_encoding };
     306                 :       3923 :     static const mp_arg_t allowed_args[] = {
     307                 :            :         { MP_QSTR_file, MP_ARG_OBJ | MP_ARG_REQUIRED, {.u_rom_obj = MP_ROM_NONE} },
     308                 :            :         { MP_QSTR_mode, MP_ARG_OBJ, {.u_rom_obj = MP_ROM_QSTR(MP_QSTR_r)} },
     309                 :            :         { MP_QSTR_buffering, MP_ARG_INT, {.u_int = -1} },
     310                 :            :         { MP_QSTR_encoding, MP_ARG_OBJ, {.u_rom_obj = MP_ROM_NONE} },
     311                 :            :     };
     312                 :            : 
     313                 :            :     // parse args
     314                 :       3923 :     mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
     315                 :       3923 :     mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
     316                 :            : 
     317                 :            :     #if MICROPY_VFS_POSIX
     318                 :            :     // If the file is an integer then delegate straight to the POSIX handler
     319         [ +  + ]:       3923 :     if (mp_obj_is_small_int(args[ARG_file].u_obj)) {
     320                 :          2 :         return mp_vfs_posix_file_open(&mp_type_vfs_posix_textio, args[ARG_file].u_obj, args[ARG_mode].u_obj);
     321                 :            :     }
     322                 :            :     #endif
     323                 :            : 
     324                 :       3921 :     mp_vfs_mount_t *vfs = lookup_path(args[ARG_file].u_obj, &args[ARG_file].u_obj);
     325                 :       3921 :     return mp_vfs_proxy_call(vfs, MP_QSTR_open, 2, (mp_obj_t *)&args);
     326                 :            : }
     327                 :            : MP_DEFINE_CONST_FUN_OBJ_KW(mp_vfs_open_obj, 0, mp_vfs_open);
     328                 :            : 
     329                 :         82 : mp_obj_t mp_vfs_chdir(mp_obj_t path_in) {
     330                 :         82 :     mp_obj_t path_out;
     331                 :         82 :     mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
     332         [ +  + ]:         82 :     if (vfs == MP_VFS_ROOT) {
     333                 :            :         // If we change to the root dir and a VFS is mounted at the root then
     334                 :            :         // we must change that VFS's current dir to the root dir so that any
     335                 :            :         // subsequent relative paths begin at the root of that VFS.
     336         [ +  - ]:         16 :         for (vfs = MP_STATE_VM(vfs_mount_table); vfs != NULL; vfs = vfs->next) {
     337         [ +  + ]:         16 :             if (vfs->len == 1) {
     338                 :          8 :                 mp_obj_t root = MP_OBJ_NEW_QSTR(MP_QSTR__slash_);
     339                 :          8 :                 mp_vfs_proxy_call(vfs, MP_QSTR_chdir, 1, &root);
     340                 :          8 :                 break;
     341                 :            :             }
     342                 :            :         }
     343                 :            :         vfs = MP_VFS_ROOT;
     344                 :            :     } else {
     345                 :         74 :         mp_vfs_proxy_call(vfs, MP_QSTR_chdir, 1, &path_out);
     346                 :            :     }
     347                 :         72 :     MP_STATE_VM(vfs_cur) = vfs;
     348                 :         72 :     return mp_const_none;
     349                 :            : }
     350                 :            : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_chdir_obj, mp_vfs_chdir);
     351                 :            : 
     352                 :         54 : mp_obj_t mp_vfs_getcwd(void) {
     353         [ +  + ]:         54 :     if (MP_STATE_VM(vfs_cur) == MP_VFS_ROOT) {
     354                 :            :         return MP_OBJ_NEW_QSTR(MP_QSTR__slash_);
     355                 :            :     }
     356                 :         40 :     mp_obj_t cwd_o = mp_vfs_proxy_call(MP_STATE_VM(vfs_cur), MP_QSTR_getcwd, 0, NULL);
     357         [ +  + ]:         38 :     if (MP_STATE_VM(vfs_cur)->len == 1) {
     358                 :            :         // don't prepend "/" for vfs mounted at root
     359                 :            :         return cwd_o;
     360                 :            :     }
     361                 :         10 :     const char *cwd = mp_obj_str_get_str(cwd_o);
     362                 :         10 :     vstr_t vstr;
     363                 :         10 :     vstr_init(&vstr, MP_STATE_VM(vfs_cur)->len + strlen(cwd) + 1);
     364                 :         10 :     vstr_add_strn(&vstr, MP_STATE_VM(vfs_cur)->str, MP_STATE_VM(vfs_cur)->len);
     365   [ +  +  +  - ]:         10 :     if (!(cwd[0] == '/' && cwd[1] == 0)) {
     366                 :         10 :         vstr_add_str(&vstr, cwd);
     367                 :            :     }
     368                 :         10 :     return mp_obj_new_str_from_vstr(&vstr);
     369                 :            : }
     370                 :            : MP_DEFINE_CONST_FUN_OBJ_0(mp_vfs_getcwd_obj, mp_vfs_getcwd);
     371                 :            : 
     372                 :            : typedef struct _mp_vfs_ilistdir_it_t {
     373                 :            :     mp_obj_base_t base;
     374                 :            :     mp_fun_1_t iternext;
     375                 :            :     union {
     376                 :            :         mp_vfs_mount_t *vfs;
     377                 :            :         mp_obj_t iter;
     378                 :            :     } cur;
     379                 :            :     bool is_str;
     380                 :            :     bool is_iter;
     381                 :            : } mp_vfs_ilistdir_it_t;
     382                 :            : 
     383                 :        146 : static mp_obj_t mp_vfs_ilistdir_it_iternext(mp_obj_t self_in) {
     384                 :        146 :     mp_vfs_ilistdir_it_t *self = MP_OBJ_TO_PTR(self_in);
     385         [ +  + ]:        146 :     if (self->is_iter) {
     386                 :            :         // continue delegating to root dir
     387                 :         72 :         return mp_iternext(self->cur.iter);
     388         [ +  + ]:         74 :     } else if (self->cur.vfs == NULL) {
     389                 :            :         // finished iterating mount points and no root dir is mounted
     390                 :            :         return MP_OBJ_STOP_ITERATION;
     391                 :            :     } else {
     392                 :            :         // continue iterating mount points
     393                 :         54 :         mp_vfs_mount_t *vfs = self->cur.vfs;
     394                 :         54 :         self->cur.vfs = vfs->next;
     395         [ +  + ]:         54 :         if (vfs->len == 1) {
     396                 :            :             // vfs is mounted at root dir, delegate to it
     397                 :         26 :             mp_obj_t root = MP_OBJ_NEW_QSTR(MP_QSTR__slash_);
     398                 :         26 :             self->is_iter = true;
     399                 :         26 :             self->cur.iter = mp_vfs_proxy_call(vfs, MP_QSTR_ilistdir, 1, &root);
     400                 :         26 :             return mp_iternext(self->cur.iter);
     401                 :            :         } else {
     402                 :            :             // a mounted directory
     403                 :         28 :             mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(3, NULL));
     404                 :         28 :             t->items[0] = mp_obj_new_str_of_type(
     405                 :         28 :                 self->is_str ? &mp_type_str : &mp_type_bytes,
     406         [ -  + ]:         28 :                 (const byte *)vfs->str + 1, vfs->len - 1);
     407                 :         28 :             t->items[1] = MP_OBJ_NEW_SMALL_INT(MP_S_IFDIR);
     408                 :         28 :             t->items[2] = MP_OBJ_NEW_SMALL_INT(0); // no inode number
     409                 :         28 :             return MP_OBJ_FROM_PTR(t);
     410                 :            :         }
     411                 :            :     }
     412                 :            : }
     413                 :            : 
     414                 :         96 : mp_obj_t mp_vfs_ilistdir(size_t n_args, const mp_obj_t *args) {
     415                 :         96 :     mp_obj_t path_in;
     416         [ +  + ]:         96 :     if (n_args == 1) {
     417                 :         52 :         path_in = args[0];
     418                 :            :     } else {
     419                 :            :         path_in = MP_OBJ_NEW_QSTR(MP_QSTR_);
     420                 :            :     }
     421                 :            : 
     422                 :         96 :     mp_obj_t path_out;
     423                 :         96 :     mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
     424                 :            : 
     425         [ +  + ]:         96 :     if (vfs == MP_VFS_ROOT) {
     426                 :            :         // list the root directory
     427                 :         44 :         mp_vfs_ilistdir_it_t *iter = mp_obj_malloc(mp_vfs_ilistdir_it_t, &mp_type_polymorph_iter);
     428                 :         44 :         iter->iternext = mp_vfs_ilistdir_it_iternext;
     429                 :         44 :         iter->cur.vfs = MP_STATE_VM(vfs_mount_table);
     430                 :         44 :         iter->is_str = mp_obj_get_type(path_in) == &mp_type_str;
     431                 :         44 :         iter->is_iter = false;
     432                 :         44 :         return MP_OBJ_FROM_PTR(iter);
     433                 :            :     }
     434                 :            : 
     435                 :         52 :     return mp_vfs_proxy_call(vfs, MP_QSTR_ilistdir, 1, &path_out);
     436                 :            : }
     437                 :            : MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_vfs_ilistdir_obj, 0, 1, mp_vfs_ilistdir);
     438                 :            : 
     439                 :         94 : mp_obj_t mp_vfs_listdir(size_t n_args, const mp_obj_t *args) {
     440                 :         94 :     mp_obj_t iter = mp_vfs_ilistdir(n_args, args);
     441                 :         90 :     mp_obj_t dir_list = mp_obj_new_list(0, NULL);
     442                 :         90 :     mp_obj_t next;
     443         [ +  + ]:       1484 :     while ((next = mp_iternext(iter)) != MP_OBJ_STOP_ITERATION) {
     444                 :       1394 :         mp_obj_list_append(dir_list, mp_obj_subscr(next, MP_OBJ_NEW_SMALL_INT(0), MP_OBJ_SENTINEL));
     445                 :            :     }
     446                 :         90 :     return dir_list;
     447                 :            : }
     448                 :            : MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_vfs_listdir_obj, 0, 1, mp_vfs_listdir);
     449                 :            : 
     450                 :            : #if MICROPY_VFS_WRITABLE
     451                 :            : 
     452                 :         44 : mp_obj_t mp_vfs_mkdir(mp_obj_t path_in) {
     453                 :         44 :     mp_obj_t path_out;
     454                 :         44 :     mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
     455   [ +  +  +  +  :         44 :     if (vfs == MP_VFS_ROOT || (vfs != MP_VFS_NONE && !strcmp(mp_obj_str_get_str(path_out), "/"))) {
                   +  + ]
     456                 :          6 :         mp_raise_OSError(MP_EEXIST);
     457                 :            :     }
     458                 :         38 :     return mp_vfs_proxy_call(vfs, MP_QSTR_mkdir, 1, &path_out);
     459                 :            : }
     460                 :            : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_mkdir_obj, mp_vfs_mkdir);
     461                 :            : 
     462                 :         32 : mp_obj_t mp_vfs_remove(mp_obj_t path_in) {
     463                 :         32 :     mp_obj_t path_out;
     464                 :         32 :     mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
     465                 :         32 :     return mp_vfs_proxy_call(vfs, MP_QSTR_remove, 1, &path_out);
     466                 :            : }
     467                 :            : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_remove_obj, mp_vfs_remove);
     468                 :            : 
     469                 :         18 : mp_obj_t mp_vfs_rename(mp_obj_t old_path_in, mp_obj_t new_path_in) {
     470                 :         18 :     mp_obj_t args[2];
     471                 :         18 :     mp_vfs_mount_t *old_vfs = lookup_path(old_path_in, &args[0]);
     472                 :         18 :     mp_vfs_mount_t *new_vfs = lookup_path(new_path_in, &args[1]);
     473         [ +  + ]:         18 :     if (old_vfs != new_vfs) {
     474                 :            :         // can't rename across filesystems
     475                 :          2 :         mp_raise_OSError(MP_EPERM);
     476                 :            :     }
     477                 :         16 :     return mp_vfs_proxy_call(old_vfs, MP_QSTR_rename, 2, args);
     478                 :            : }
     479                 :            : MP_DEFINE_CONST_FUN_OBJ_2(mp_vfs_rename_obj, mp_vfs_rename);
     480                 :            : 
     481                 :         38 : mp_obj_t mp_vfs_rmdir(mp_obj_t path_in) {
     482                 :         38 :     mp_obj_t path_out;
     483                 :         38 :     mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
     484                 :         38 :     return mp_vfs_proxy_call(vfs, MP_QSTR_rmdir, 1, &path_out);
     485                 :            : }
     486                 :            : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_rmdir_obj, mp_vfs_rmdir);
     487                 :            : 
     488                 :            : #endif // MICROPY_VFS_WRITABLE
     489                 :            : 
     490                 :         50 : mp_obj_t mp_vfs_stat(mp_obj_t path_in) {
     491                 :         50 :     mp_obj_t path_out;
     492                 :         50 :     mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
     493         [ +  + ]:         50 :     if (vfs == MP_VFS_ROOT) {
     494                 :         10 :         mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(10, NULL));
     495                 :         10 :         t->items[0] = MP_OBJ_NEW_SMALL_INT(MP_S_IFDIR); // st_mode
     496         [ +  + ]:        100 :         for (int i = 1; i <= 9; ++i) {
     497                 :         90 :             t->items[i] = MP_OBJ_NEW_SMALL_INT(0); // dev, nlink, uid, gid, size, atime, mtime, ctime
     498                 :            :         }
     499                 :            :         return MP_OBJ_FROM_PTR(t);
     500                 :            :     }
     501                 :         40 :     return mp_vfs_proxy_call(vfs, MP_QSTR_stat, 1, &path_out);
     502                 :            : }
     503                 :            : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_stat_obj, mp_vfs_stat);
     504                 :            : 
     505                 :          6 : mp_obj_t mp_vfs_statvfs(mp_obj_t path_in) {
     506                 :          6 :     mp_obj_t path_out;
     507                 :          6 :     mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
     508         [ +  + ]:          6 :     if (vfs == MP_VFS_ROOT) {
     509                 :            :         // statvfs called on the root directory, see if there's anything mounted there
     510         [ +  + ]:          4 :         for (vfs = MP_STATE_VM(vfs_mount_table); vfs != NULL; vfs = vfs->next) {
     511         [ -  + ]:          2 :             if (vfs->len == 1) {
     512                 :            :                 break;
     513                 :            :             }
     514                 :            :         }
     515                 :            : 
     516                 :            :         // If there's nothing mounted at root then return a mostly-empty tuple
     517         [ +  + ]:          4 :         if (vfs == NULL) {
     518                 :          2 :             mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(10, NULL));
     519                 :            : 
     520                 :            :             // fill in: bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flags
     521         [ +  + ]:         20 :             for (int i = 0; i <= 8; ++i) {
     522                 :         18 :                 t->items[i] = MP_OBJ_NEW_SMALL_INT(0);
     523                 :            :             }
     524                 :            : 
     525                 :            :             // Put something sensible in f_namemax
     526                 :          2 :             t->items[9] = MP_OBJ_NEW_SMALL_INT(MICROPY_ALLOC_PATH_MAX);
     527                 :            : 
     528                 :          2 :             return MP_OBJ_FROM_PTR(t);
     529                 :            :         }
     530                 :            : 
     531                 :            :         // VFS mounted at root so delegate the call to it
     532                 :          2 :         path_out = MP_OBJ_NEW_QSTR(MP_QSTR__slash_);
     533                 :            :     }
     534                 :          4 :     return mp_vfs_proxy_call(vfs, MP_QSTR_statvfs, 1, &path_out);
     535                 :            : }
     536                 :            : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_statvfs_obj, mp_vfs_statvfs);
     537                 :            : 
     538                 :            : // This is a C-level helper function for ports to use if needed.
     539                 :          0 : int mp_vfs_mount_and_chdir_protected(mp_obj_t bdev, mp_obj_t mount_point) {
     540                 :          0 :     nlr_buf_t nlr;
     541                 :          0 :     mp_int_t ret = -MP_EIO;
     542         [ #  # ]:          0 :     if (nlr_push(&nlr) == 0) {
     543                 :          0 :         mp_obj_t args[] = { bdev, mount_point };
     544                 :          0 :         mp_vfs_mount(2, args, (mp_map_t *)&mp_const_empty_map);
     545                 :          0 :         mp_vfs_chdir(mount_point);
     546                 :          0 :         ret = 0; // success
     547                 :          0 :         nlr_pop();
     548                 :            :     } else {
     549                 :          0 :         mp_obj_base_t *exc = nlr.ret_val;
     550         [ #  # ]:          0 :         if (mp_obj_is_subclass_fast(MP_OBJ_FROM_PTR(exc->type), MP_OBJ_FROM_PTR(&mp_type_OSError))) {
     551                 :          0 :             mp_obj_t v = mp_obj_exception_get_value(MP_OBJ_FROM_PTR(exc));
     552                 :          0 :             mp_obj_get_int_maybe(v, &ret); // get errno value
     553                 :          0 :             ret = -ret;
     554                 :            :         }
     555                 :            :     }
     556                 :          0 :     return ret;
     557                 :            : }
     558                 :            : 
     559                 :            : #if MICROPY_VFS_ROM && MICROPY_VFS_ROM_IOCTL
     560                 :            : 
     561                 :       3448 : int mp_vfs_mount_romfs_protected(void) {
     562                 :       3448 :     int ret;
     563                 :       3448 :     nlr_buf_t nlr;
     564         [ +  - ]:       3448 :     if (nlr_push(&nlr) == 0) {
     565                 :       3448 :         mp_obj_t args[2] = { MP_OBJ_NEW_SMALL_INT(MP_VFS_ROM_IOCTL_GET_SEGMENT), MP_OBJ_NEW_SMALL_INT(0) };
     566                 :       3448 :         mp_obj_t rom = mp_vfs_rom_ioctl(2, args);
     567                 :       3448 :         mp_obj_t romfs = mp_call_function_1(MP_OBJ_FROM_PTR(&mp_type_vfs_rom), rom);
     568                 :       3448 :         mp_obj_t mount_point = MP_OBJ_NEW_QSTR(MP_QSTR__slash_rom);
     569                 :       3448 :         mp_call_function_2(MP_OBJ_FROM_PTR(&mp_vfs_mount_obj), romfs, mount_point);
     570                 :            :         #if MICROPY_PY_SYS_PATH_ARGV_DEFAULTS
     571                 :            :         // Add "/rom" and "/rom/lib" to `sys.path`.
     572                 :            :         mp_obj_list_append(mp_sys_path, MP_OBJ_NEW_QSTR(MP_QSTR__slash_rom));
     573                 :            :         mp_obj_list_append(mp_sys_path, MP_OBJ_NEW_QSTR(MP_QSTR__slash_rom_slash_lib));
     574                 :            :         #endif
     575                 :       3448 :         ret = 0; // success
     576                 :       3448 :         nlr_pop();
     577                 :            :     } else {
     578                 :            :         ret = -MP_EIO;
     579                 :            :     }
     580                 :       3448 :     return ret;
     581                 :            : }
     582                 :            : 
     583                 :            : #endif
     584                 :            : 
     585                 :            : MP_REGISTER_ROOT_POINTER(struct _mp_vfs_mount_t *vfs_cur);
     586                 :            : MP_REGISTER_ROOT_POINTER(struct _mp_vfs_mount_t *vfs_mount_table);
     587                 :            : 
     588                 :            : #endif // MICROPY_VFS

Generated by: LCOV version 1.15-5-g462f71d