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 : 24402 : mp_vfs_mount_t *mp_vfs_lookup_path(const char *path, const char **path_out) {
62 [ + + + + ]: 24402 : 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 : 18186 : bool is_abs = 0;
65 [ + + ]: 18186 : if (*path == '/') {
66 : 18100 : ++path;
67 : 18100 : is_abs = 1;
68 : : }
69 [ + + ]: 18186 : if (*path == '\0') {
70 : : // path is "" or "/" so return virtual root
71 : : return MP_VFS_ROOT;
72 : : }
73 [ + + ]: 26150 : for (mp_vfs_mount_t *vfs = MP_STATE_VM(vfs_mount_table); vfs != NULL; vfs = vfs->next) {
74 : 22652 : size_t len = vfs->len - 1;
75 [ + + ]: 22652 : if (len == 0) {
76 : 10800 : *path_out = path - is_abs;
77 : 10800 : return vfs;
78 : : }
79 [ + + ]: 11852 : 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 : 6216 : *path_out = path;
96 : 6216 : return MP_STATE_VM(vfs_cur);
97 : : }
98 : :
99 : : // Version of mp_vfs_lookup_path that takes and returns uPy string objects.
100 : 4315 : static mp_vfs_mount_t *lookup_path(mp_obj_t path_in, mp_obj_t *path_out) {
101 : 4315 : const char *path = mp_obj_str_get_str(path_in);
102 : 4315 : const char *p_out;
103 : 4315 : mp_vfs_mount_t *vfs = mp_vfs_lookup_path(path, &p_out);
104 [ + + ]: 4315 : if (vfs != MP_VFS_NONE && vfs != MP_VFS_ROOT) {
105 : 4217 : *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 : 98 : *path_out = MP_OBJ_NULL;
109 : : }
110 : 4315 : return vfs;
111 : : }
112 : :
113 : 11497 : 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 [ - + ]: 11497 : assert(n_args <= PROXY_MAX_ARGS);
115 [ + + ]: 11497 : if (vfs == MP_VFS_NONE) {
116 : : // mount point not found
117 : 26 : mp_raise_OSError(MP_ENODEV);
118 : : }
119 [ - + ]: 11471 : if (vfs == MP_VFS_ROOT) {
120 : : // can't do operation on root dir
121 : 0 : mp_raise_OSError(MP_EPERM);
122 : : }
123 : 11471 : mp_obj_t meth[2 + PROXY_MAX_ARGS];
124 : 11471 : mp_load_method(vfs->obj, meth_name, meth);
125 [ + + ]: 11471 : if (args != NULL) {
126 : 11341 : memcpy(meth + 2, args, n_args * sizeof(*args));
127 : : }
128 : 11471 : return mp_call_method_n_kw(n_args, 0, meth);
129 : : }
130 : :
131 : 13091 : mp_import_stat_t mp_vfs_import_stat(const char *path) {
132 : 13091 : const char *path_out;
133 : 13091 : mp_vfs_mount_t *vfs = mp_vfs_lookup_path(path, &path_out);
134 [ + - ]: 13091 : 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 : 13091 : const mp_obj_type_t *type = mp_obj_get_type(vfs->obj);
140 [ + + ]: 13091 : if (MP_OBJ_TYPE_HAS_SLOT(type, protocol)) {
141 : 12981 : const mp_vfs_proto_t *proto = MP_OBJ_TYPE_GET_SLOT(type, protocol);
142 : 12981 : 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 : 7012 : mp_obj_t mp_vfs_mount(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
209 [ + + ]: 7012 : if (n_args == 0) {
210 : : // zero-args, output a table of all current mountpoints
211 : 12 : mp_obj_t mount_list = mp_obj_new_list(0, NULL);
212 : 12 : mp_vfs_mount_t *vfsp = MP_STATE_VM(vfs_mount_table);
213 [ + + ]: 34 : while (vfsp != NULL) {
214 : 22 : mp_obj_t items[] = { vfsp->obj, mp_obj_new_str(vfsp->str, vfsp->len) };
215 : 22 : mp_obj_list_append(mount_list, mp_obj_new_tuple(MP_ARRAY_SIZE(items), items));
216 : 22 : vfsp = vfsp->next;
217 : : }
218 : : return mount_list;
219 : : }
220 : :
221 : 7000 : enum { ARG_fsobj, ARG_mount_point, ARG_readonly, ARG_mkfs };
222 : 7000 : static const mp_arg_t allowed_args[] = {
223 : : { MP_QSTR_, MP_ARG_REQUIRED | MP_ARG_OBJ, {.u_obj = MP_OBJ_NULL} },
224 : : { MP_QSTR_, MP_ARG_REQUIRED | MP_ARG_OBJ, {.u_obj = MP_OBJ_NULL} },
225 : : { MP_QSTR_readonly, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_rom_obj = MP_ROM_FALSE} },
226 : : { MP_QSTR_mkfs, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_rom_obj = MP_ROM_FALSE} },
227 : : };
228 : :
229 : : // parse args
230 : 7000 : mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
231 : 7000 : mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
232 : :
233 : : // get the mount point
234 : 7000 : size_t mnt_len;
235 : 7000 : const char *mnt_str = mp_obj_str_get_data(args[ARG_mount_point].u_obj, &mnt_len);
236 : :
237 : : // see if we need to auto-detect and create the filesystem
238 : 7000 : mp_obj_t vfs_obj = args[ARG_fsobj].u_obj;
239 : 7000 : mp_obj_t dest[2];
240 : 7000 : mp_load_method_maybe(vfs_obj, MP_QSTR_mount, dest);
241 [ + + ]: 7000 : if (dest[0] == MP_OBJ_NULL) {
242 : : // Input object has no mount method, assume it's a block device and try to
243 : : // auto-detect the filesystem and create the corresponding VFS entity.
244 : 14 : vfs_obj = mp_vfs_autodetect(vfs_obj);
245 : : }
246 : :
247 : : // create new object
248 : 7000 : mp_vfs_mount_t *vfs = m_new_obj(mp_vfs_mount_t);
249 : 7000 : vfs->str = mnt_str;
250 : 7000 : vfs->len = mnt_len;
251 : 7000 : vfs->obj = vfs_obj;
252 : 7000 : vfs->next = NULL;
253 : :
254 : : // call the underlying object to do any mounting operation
255 : 7000 : mp_arg_val_t *proxy_args = &args[ARG_readonly];
256 : 7000 : size_t proxy_args_len = MP_ARRAY_SIZE(args) - ARG_readonly;
257 : 7000 : mp_vfs_proxy_call(vfs, MP_QSTR_mount, proxy_args_len, (mp_obj_t *)proxy_args);
258 : :
259 : : // check that the destination mount point is unused
260 : 6996 : const char *path_out;
261 : 6996 : mp_vfs_mount_t *existing_mount = mp_vfs_lookup_path(mp_obj_str_get_str(args[ARG_mount_point].u_obj), &path_out);
262 [ + + ]: 6996 : if (existing_mount != MP_VFS_NONE && existing_mount != MP_VFS_ROOT) {
263 [ + - + + ]: 62 : if (vfs->len != 1 && existing_mount->len == 1) {
264 : : // if root dir is mounted, still allow to mount something within a subdir of root
265 : : } else {
266 : : // mount point in use
267 : 2 : mp_raise_OSError(MP_EPERM);
268 : : }
269 : : }
270 : :
271 : : // insert the vfs into the mount table
272 : : mp_vfs_mount_t **vfsp = &MP_STATE_VM(vfs_mount_table);
273 [ + + ]: 10520 : while (*vfsp != NULL) {
274 [ + + ]: 3586 : if ((*vfsp)->len == 1) {
275 : : // make sure anything mounted at the root stays at the end of the list
276 : 60 : vfs->next = *vfsp;
277 : 60 : break;
278 : : }
279 : 3526 : vfsp = &(*vfsp)->next;
280 : : }
281 : 6994 : *vfsp = vfs;
282 : :
283 : 6994 : return mp_const_none;
284 : : }
285 : : MP_DEFINE_CONST_FUN_OBJ_KW(mp_vfs_mount_obj, 0, mp_vfs_mount);
286 : :
287 : 88 : mp_obj_t mp_vfs_umount(mp_obj_t mnt_in) {
288 : : // remove vfs from the mount table
289 : 88 : mp_vfs_mount_t *vfs = NULL;
290 : 88 : size_t mnt_len;
291 : 88 : const char *mnt_str = NULL;
292 [ + + + - : 88 : if (mp_obj_is_str(mnt_in)) {
- + ]
293 : 80 : mnt_str = mp_obj_str_get_data(mnt_in, &mnt_len);
294 : : }
295 [ + + ]: 156 : for (mp_vfs_mount_t **vfsp = &MP_STATE_VM(vfs_mount_table); *vfsp != NULL; vfsp = &(*vfsp)->next) {
296 [ + + + + : 154 : if ((mnt_str != NULL && mnt_len == (*vfsp)->len && !memcmp(mnt_str, (*vfsp)->str, mnt_len)) || (*vfsp)->obj == mnt_in) {
+ + + + ]
297 : 86 : vfs = *vfsp;
298 : 86 : *vfsp = (*vfsp)->next;
299 : 86 : break;
300 : : }
301 : : }
302 : :
303 [ + + ]: 88 : if (vfs == NULL) {
304 : 2 : mp_raise_OSError(MP_EINVAL);
305 : : }
306 : :
307 : : // if we unmounted the current device then set current to root
308 [ + + ]: 86 : if (MP_STATE_VM(vfs_cur) == vfs) {
309 : 20 : MP_STATE_VM(vfs_cur) = MP_VFS_ROOT;
310 : : }
311 : :
312 : : // call the underlying object to do any unmounting operation
313 : 86 : mp_vfs_proxy_call(vfs, MP_QSTR_umount, 0, NULL);
314 : :
315 : 86 : return mp_const_none;
316 : : }
317 : : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_umount_obj, mp_vfs_umount);
318 : :
319 : : // Note: buffering and encoding args are currently ignored
320 : 3931 : mp_obj_t mp_vfs_open(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
321 : 3931 : enum { ARG_file, ARG_mode, ARG_encoding };
322 : 3931 : static const mp_arg_t allowed_args[] = {
323 : : { MP_QSTR_file, MP_ARG_OBJ | MP_ARG_REQUIRED, {.u_rom_obj = MP_ROM_NONE} },
324 : : { MP_QSTR_mode, MP_ARG_OBJ, {.u_rom_obj = MP_ROM_QSTR(MP_QSTR_r)} },
325 : : { MP_QSTR_buffering, MP_ARG_INT, {.u_int = -1} },
326 : : { MP_QSTR_encoding, MP_ARG_OBJ, {.u_rom_obj = MP_ROM_NONE} },
327 : : };
328 : :
329 : : // parse args
330 : 3931 : mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
331 : 3931 : mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
332 : :
333 : : #if MICROPY_VFS_POSIX
334 : : // If the file is an integer then delegate straight to the POSIX handler
335 [ + + ]: 3931 : if (mp_obj_is_small_int(args[ARG_file].u_obj)) {
336 : 2 : return mp_vfs_posix_file_open(&mp_type_vfs_posix_textio, args[ARG_file].u_obj, args[ARG_mode].u_obj);
337 : : }
338 : : #endif
339 : :
340 : 3929 : mp_vfs_mount_t *vfs = lookup_path(args[ARG_file].u_obj, &args[ARG_file].u_obj);
341 : 3929 : return mp_vfs_proxy_call(vfs, MP_QSTR_open, 2, (mp_obj_t *)&args);
342 : : }
343 : : MP_DEFINE_CONST_FUN_OBJ_KW(mp_vfs_open_obj, 0, mp_vfs_open);
344 : :
345 : 82 : mp_obj_t mp_vfs_chdir(mp_obj_t path_in) {
346 : 82 : mp_obj_t path_out;
347 : 82 : mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
348 [ + + ]: 82 : if (vfs == MP_VFS_ROOT) {
349 : : // If we change to the root dir and a VFS is mounted at the root then
350 : : // we must change that VFS's current dir to the root dir so that any
351 : : // subsequent relative paths begin at the root of that VFS.
352 [ + - ]: 16 : for (vfs = MP_STATE_VM(vfs_mount_table); vfs != NULL; vfs = vfs->next) {
353 [ + + ]: 16 : if (vfs->len == 1) {
354 : 8 : mp_obj_t root = MP_OBJ_NEW_QSTR(MP_QSTR__slash_);
355 : 8 : mp_vfs_proxy_call(vfs, MP_QSTR_chdir, 1, &root);
356 : 8 : break;
357 : : }
358 : : }
359 : : vfs = MP_VFS_ROOT;
360 : : } else {
361 : 74 : mp_vfs_proxy_call(vfs, MP_QSTR_chdir, 1, &path_out);
362 : : }
363 : 72 : MP_STATE_VM(vfs_cur) = vfs;
364 : 72 : return mp_const_none;
365 : : }
366 : : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_chdir_obj, mp_vfs_chdir);
367 : :
368 : 58 : mp_obj_t mp_vfs_getcwd(void) {
369 [ + + ]: 58 : if (MP_STATE_VM(vfs_cur) == MP_VFS_ROOT) {
370 : : return MP_OBJ_NEW_QSTR(MP_QSTR__slash_);
371 : : }
372 : 44 : mp_obj_t cwd_o = mp_vfs_proxy_call(MP_STATE_VM(vfs_cur), MP_QSTR_getcwd, 0, NULL);
373 [ + + ]: 42 : if (MP_STATE_VM(vfs_cur)->len == 1) {
374 : : // don't prepend "/" for vfs mounted at root
375 : : return cwd_o;
376 : : }
377 : 14 : const char *cwd = mp_obj_str_get_str(cwd_o);
378 : 14 : vstr_t vstr;
379 : 14 : vstr_init(&vstr, MP_STATE_VM(vfs_cur)->len + strlen(cwd) + 1);
380 : 14 : vstr_add_strn(&vstr, MP_STATE_VM(vfs_cur)->str, MP_STATE_VM(vfs_cur)->len);
381 [ + + + - ]: 14 : if (!(cwd[0] == '/' && cwd[1] == 0)) {
382 : 14 : vstr_add_str(&vstr, cwd);
383 : : }
384 : 14 : return mp_obj_new_str_from_vstr(&vstr);
385 : : }
386 : : MP_DEFINE_CONST_FUN_OBJ_0(mp_vfs_getcwd_obj, mp_vfs_getcwd);
387 : :
388 : : typedef struct _mp_vfs_ilistdir_it_t {
389 : : mp_obj_base_t base;
390 : : mp_fun_1_t iternext;
391 : : union {
392 : : mp_vfs_mount_t *vfs;
393 : : mp_obj_t iter;
394 : : } cur;
395 : : bool is_str;
396 : : bool is_iter;
397 : : } mp_vfs_ilistdir_it_t;
398 : :
399 : 150 : static mp_obj_t mp_vfs_ilistdir_it_iternext(mp_obj_t self_in) {
400 : 150 : mp_vfs_ilistdir_it_t *self = MP_OBJ_TO_PTR(self_in);
401 [ + + ]: 150 : if (self->is_iter) {
402 : : // continue delegating to root dir
403 : 72 : return mp_iternext(self->cur.iter);
404 [ + + ]: 78 : } else if (self->cur.vfs == NULL) {
405 : : // finished iterating mount points and no root dir is mounted
406 : : return MP_OBJ_STOP_ITERATION;
407 : : } else {
408 : : // continue iterating mount points
409 : 56 : mp_vfs_mount_t *vfs = self->cur.vfs;
410 : 56 : self->cur.vfs = vfs->next;
411 [ + + ]: 56 : if (vfs->len == 1) {
412 : : // vfs is mounted at root dir, delegate to it
413 : 26 : mp_obj_t root = MP_OBJ_NEW_QSTR(MP_QSTR__slash_);
414 : 26 : self->is_iter = true;
415 : 26 : self->cur.iter = mp_vfs_proxy_call(vfs, MP_QSTR_ilistdir, 1, &root);
416 : 26 : return mp_iternext(self->cur.iter);
417 : : } else {
418 : : // a mounted directory
419 : 30 : mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(3, NULL));
420 : 30 : t->items[0] = mp_obj_new_str_of_type(
421 : 30 : self->is_str ? &mp_type_str : &mp_type_bytes,
422 [ - + ]: 30 : (const byte *)vfs->str + 1, vfs->len - 1);
423 : 30 : t->items[1] = MP_OBJ_NEW_SMALL_INT(MP_S_IFDIR);
424 : 30 : t->items[2] = MP_OBJ_NEW_SMALL_INT(0); // no inode number
425 : 30 : return MP_OBJ_FROM_PTR(t);
426 : : }
427 : : }
428 : : }
429 : :
430 : 98 : mp_obj_t mp_vfs_ilistdir(size_t n_args, const mp_obj_t *args) {
431 : 98 : mp_obj_t path_in;
432 [ + + ]: 98 : if (n_args == 1) {
433 : 54 : path_in = args[0];
434 : : } else {
435 : : path_in = MP_OBJ_NEW_QSTR(MP_QSTR_);
436 : : }
437 : :
438 : 98 : mp_obj_t path_out;
439 : 98 : mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
440 : :
441 [ + + ]: 98 : if (vfs == MP_VFS_ROOT) {
442 : : // list the root directory
443 : 46 : mp_vfs_ilistdir_it_t *iter = mp_obj_malloc(mp_vfs_ilistdir_it_t, &mp_type_polymorph_iter);
444 : 46 : iter->iternext = mp_vfs_ilistdir_it_iternext;
445 : 46 : iter->cur.vfs = MP_STATE_VM(vfs_mount_table);
446 : 46 : iter->is_str = mp_obj_get_type(path_in) == &mp_type_str;
447 : 46 : iter->is_iter = false;
448 : 46 : return MP_OBJ_FROM_PTR(iter);
449 : : }
450 : :
451 : 52 : return mp_vfs_proxy_call(vfs, MP_QSTR_ilistdir, 1, &path_out);
452 : : }
453 : : MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_vfs_ilistdir_obj, 0, 1, mp_vfs_ilistdir);
454 : :
455 : 96 : mp_obj_t mp_vfs_listdir(size_t n_args, const mp_obj_t *args) {
456 : 96 : mp_obj_t iter = mp_vfs_ilistdir(n_args, args);
457 : 92 : mp_obj_t dir_list = mp_obj_new_list(0, NULL);
458 : 92 : mp_obj_t next;
459 [ + + ]: 1504 : while ((next = mp_iternext(iter)) != MP_OBJ_STOP_ITERATION) {
460 : 1412 : mp_obj_list_append(dir_list, mp_obj_subscr(next, MP_OBJ_NEW_SMALL_INT(0), MP_OBJ_SENTINEL));
461 : : }
462 : 92 : return dir_list;
463 : : }
464 : : MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_vfs_listdir_obj, 0, 1, mp_vfs_listdir);
465 : :
466 : : #if MICROPY_VFS_WRITABLE
467 : :
468 : 44 : mp_obj_t mp_vfs_mkdir(mp_obj_t path_in) {
469 : 44 : mp_obj_t path_out;
470 : 44 : mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
471 [ + + + + : 44 : if (vfs == MP_VFS_ROOT || (vfs != MP_VFS_NONE && !strcmp(mp_obj_str_get_str(path_out), "/"))) {
+ + ]
472 : 6 : mp_raise_OSError(MP_EEXIST);
473 : : }
474 : 38 : return mp_vfs_proxy_call(vfs, MP_QSTR_mkdir, 1, &path_out);
475 : : }
476 : : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_mkdir_obj, mp_vfs_mkdir);
477 : :
478 : 32 : mp_obj_t mp_vfs_remove(mp_obj_t path_in) {
479 : 32 : mp_obj_t path_out;
480 : 32 : mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
481 : 32 : return mp_vfs_proxy_call(vfs, MP_QSTR_remove, 1, &path_out);
482 : : }
483 : : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_remove_obj, mp_vfs_remove);
484 : :
485 : 18 : mp_obj_t mp_vfs_rename(mp_obj_t old_path_in, mp_obj_t new_path_in) {
486 : 18 : mp_obj_t args[2];
487 : 18 : mp_vfs_mount_t *old_vfs = lookup_path(old_path_in, &args[0]);
488 : 18 : mp_vfs_mount_t *new_vfs = lookup_path(new_path_in, &args[1]);
489 [ + + ]: 18 : if (old_vfs != new_vfs) {
490 : : // can't rename across filesystems
491 : 2 : mp_raise_OSError(MP_EPERM);
492 : : }
493 : 16 : return mp_vfs_proxy_call(old_vfs, MP_QSTR_rename, 2, args);
494 : : }
495 : : MP_DEFINE_CONST_FUN_OBJ_2(mp_vfs_rename_obj, mp_vfs_rename);
496 : :
497 : 38 : mp_obj_t mp_vfs_rmdir(mp_obj_t path_in) {
498 : 38 : mp_obj_t path_out;
499 : 38 : mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
500 : 38 : return mp_vfs_proxy_call(vfs, MP_QSTR_rmdir, 1, &path_out);
501 : : }
502 : : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_rmdir_obj, mp_vfs_rmdir);
503 : :
504 : : #endif // MICROPY_VFS_WRITABLE
505 : :
506 : 50 : mp_obj_t mp_vfs_stat(mp_obj_t path_in) {
507 : 50 : mp_obj_t path_out;
508 : 50 : mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
509 [ + + ]: 50 : if (vfs == MP_VFS_ROOT) {
510 : 10 : mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(10, NULL));
511 : 10 : t->items[0] = MP_OBJ_NEW_SMALL_INT(MP_S_IFDIR); // st_mode
512 [ + + ]: 100 : for (int i = 1; i <= 9; ++i) {
513 : 90 : t->items[i] = MP_OBJ_NEW_SMALL_INT(0); // dev, nlink, uid, gid, size, atime, mtime, ctime
514 : : }
515 : : return MP_OBJ_FROM_PTR(t);
516 : : }
517 : 40 : return mp_vfs_proxy_call(vfs, MP_QSTR_stat, 1, &path_out);
518 : : }
519 : : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_stat_obj, mp_vfs_stat);
520 : :
521 : 6 : mp_obj_t mp_vfs_statvfs(mp_obj_t path_in) {
522 : 6 : mp_obj_t path_out;
523 : 6 : mp_vfs_mount_t *vfs = lookup_path(path_in, &path_out);
524 [ + + ]: 6 : if (vfs == MP_VFS_ROOT) {
525 : : // statvfs called on the root directory, see if there's anything mounted there
526 [ + + ]: 4 : for (vfs = MP_STATE_VM(vfs_mount_table); vfs != NULL; vfs = vfs->next) {
527 [ - + ]: 2 : if (vfs->len == 1) {
528 : : break;
529 : : }
530 : : }
531 : :
532 : : // If there's nothing mounted at root then return a mostly-empty tuple
533 [ + + ]: 4 : if (vfs == NULL) {
534 : 2 : mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(10, NULL));
535 : :
536 : : // fill in: bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flags
537 [ + + ]: 20 : for (int i = 0; i <= 8; ++i) {
538 : 18 : t->items[i] = MP_OBJ_NEW_SMALL_INT(0);
539 : : }
540 : :
541 : : // Put something sensible in f_namemax
542 : 2 : t->items[9] = MP_OBJ_NEW_SMALL_INT(MICROPY_ALLOC_PATH_MAX);
543 : :
544 : 2 : return MP_OBJ_FROM_PTR(t);
545 : : }
546 : :
547 : : // VFS mounted at root so delegate the call to it
548 : 2 : path_out = MP_OBJ_NEW_QSTR(MP_QSTR__slash_);
549 : : }
550 : 4 : return mp_vfs_proxy_call(vfs, MP_QSTR_statvfs, 1, &path_out);
551 : : }
552 : : MP_DEFINE_CONST_FUN_OBJ_1(mp_vfs_statvfs_obj, mp_vfs_statvfs);
553 : :
554 : : // This is a C-level helper function for ports to use if needed.
555 : 0 : int mp_vfs_mount_and_chdir_protected(mp_obj_t bdev, mp_obj_t mount_point) {
556 : 0 : nlr_buf_t nlr;
557 : 0 : mp_int_t ret = -MP_EIO;
558 [ # # ]: 0 : if (nlr_push(&nlr) == 0) {
559 : 0 : mp_obj_t args[] = { bdev, mount_point };
560 : 0 : mp_vfs_mount(2, args, (mp_map_t *)&mp_const_empty_map);
561 : 0 : mp_vfs_chdir(mount_point);
562 : 0 : ret = 0; // success
563 : 0 : nlr_pop();
564 : : } else {
565 : 0 : mp_obj_base_t *exc = nlr.ret_val;
566 [ # # ]: 0 : if (mp_obj_is_subclass_fast(MP_OBJ_FROM_PTR(exc->type), MP_OBJ_FROM_PTR(&mp_type_OSError))) {
567 : 0 : mp_obj_t v = mp_obj_exception_get_value(MP_OBJ_FROM_PTR(exc));
568 : 0 : mp_obj_get_int_maybe(v, &ret); // get errno value
569 : 0 : ret = -ret;
570 : : }
571 : : }
572 : 0 : return ret;
573 : : }
574 : :
575 : : #if MICROPY_VFS_ROM && MICROPY_VFS_ROM_IOCTL
576 : :
577 : 3456 : int mp_vfs_mount_romfs_protected(void) {
578 : 3456 : int ret;
579 : 3456 : nlr_buf_t nlr;
580 [ + - ]: 3456 : if (nlr_push(&nlr) == 0) {
581 : 3456 : mp_obj_t args[2] = { MP_OBJ_NEW_SMALL_INT(MP_VFS_ROM_IOCTL_GET_SEGMENT), MP_OBJ_NEW_SMALL_INT(0) };
582 : 3456 : mp_obj_t rom = mp_vfs_rom_ioctl(2, args);
583 : 3456 : mp_obj_t romfs = mp_call_function_1(MP_OBJ_FROM_PTR(&mp_type_vfs_rom), rom);
584 : 3456 : mp_obj_t mount_point = MP_OBJ_NEW_QSTR(MP_QSTR__slash_rom);
585 : 3456 : mp_call_function_2(MP_OBJ_FROM_PTR(&mp_vfs_mount_obj), romfs, mount_point);
586 : : #if MICROPY_PY_SYS_PATH_ARGV_DEFAULTS
587 : : // Add "/rom" and "/rom/lib" to `sys.path`.
588 : : mp_obj_list_append(mp_sys_path, MP_OBJ_NEW_QSTR(MP_QSTR__slash_rom));
589 : : mp_obj_list_append(mp_sys_path, MP_OBJ_NEW_QSTR(MP_QSTR__slash_rom_slash_lib));
590 : : #endif
591 : 3456 : ret = 0; // success
592 : 3456 : nlr_pop();
593 : : } else {
594 : : ret = -MP_EIO;
595 : : }
596 : 3456 : return ret;
597 : : }
598 : :
599 : : #endif
600 : :
601 : : MP_REGISTER_ROOT_POINTER(struct _mp_vfs_mount_t *vfs_cur);
602 : : MP_REGISTER_ROOT_POINTER(struct _mp_vfs_mount_t *vfs_mount_table);
603 : :
604 : : #endif // MICROPY_VFS
|
