/* * This file is part of the Micro Python project, http://micropython.org/ * * The MIT License (MIT) * * Copyright (c) 2013, 2014 Damien P. George * Copyright (c) 2015 Daniel Campora * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ #include #include #include "py/mpconfig.h" #include "py/nlr.h" #include "py/obj.h" #include "py/objtuple.h" #include "py/objstr.h" #include "genhdr/mpversion.h" #include "ff.h" #include "diskio.h" #include "sflash_diskio.h" #include "file.h" #include "random.h" #include "pybsd.h" #include "mpexception.h" #include "version.h" #include "timeutils.h" /// \module os - basic "operating system" services /// /// The `os` module contains functions for filesystem access and `urandom`. /// /// The filesystem has `/` as the root directory, and the available physical /// drives are accessible from here. They are currently: /// /// /flash -- the serial flash filesystem /// /sd -- the SD card (if it exists) /// /// On boot up, the current directory is `/flash` if no SD card is inserted, /// otherwise it is `/sd`. /****************************************************************************** DEFINE PRIVATE FUNCTIONS ******************************************************************************/ /******************************************************************************/ // Micro Python bindings // STATIC const qstr os_uname_info_fields[] = { MP_QSTR_sysname, MP_QSTR_nodename, MP_QSTR_release, MP_QSTR_version, MP_QSTR_machine }; STATIC const MP_DEFINE_STR_OBJ(os_uname_info_sysname_obj, MICROPY_PY_SYS_PLATFORM); STATIC const MP_DEFINE_STR_OBJ(os_uname_info_nodename_obj, MICROPY_PY_SYS_PLATFORM); STATIC const MP_DEFINE_STR_OBJ(os_uname_info_release_obj, WIPY_SW_VERSION_NUMBER); STATIC const MP_DEFINE_STR_OBJ(os_uname_info_version_obj, MICROPY_GIT_TAG " on " MICROPY_BUILD_DATE); STATIC const MP_DEFINE_STR_OBJ(os_uname_info_machine_obj, MICROPY_HW_BOARD_NAME " with " MICROPY_HW_MCU_NAME); STATIC MP_DEFINE_ATTRTUPLE( os_uname_info_obj, os_uname_info_fields, 5, (mp_obj_t)&os_uname_info_sysname_obj, (mp_obj_t)&os_uname_info_nodename_obj, (mp_obj_t)&os_uname_info_release_obj, (mp_obj_t)&os_uname_info_version_obj, (mp_obj_t)&os_uname_info_machine_obj ); STATIC mp_obj_t os_uname(void) { return (mp_obj_t)&os_uname_info_obj; } STATIC MP_DEFINE_CONST_FUN_OBJ_0(os_uname_obj, os_uname); /// \function chdir(path) /// Change current directory. STATIC mp_obj_t os_chdir(mp_obj_t path_in) { const char *path; path = mp_obj_str_get_str(path_in); FRESULT res = f_chdrive(path); if (res == FR_OK) { res = f_chdir(path); } if (res != FR_OK) { nlr_raise(mp_obj_new_exception_msg(&mp_type_OSError, mpexception_os_operation_failed)); } return mp_const_none; } STATIC MP_DEFINE_CONST_FUN_OBJ_1(os_chdir_obj, os_chdir); /// \function getcwd() /// Get the current directory. STATIC mp_obj_t os_getcwd(void) { char buf[MICROPY_ALLOC_PATH_MAX + 1]; FRESULT res = f_getcwd(buf, sizeof buf); if (res != FR_OK) { nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, MP_OBJ_NEW_SMALL_INT(fresult_to_errno_table[res]))); } return mp_obj_new_str(buf, strlen(buf), false); } STATIC MP_DEFINE_CONST_FUN_OBJ_0(os_getcwd_obj, os_getcwd); /// \function listdir([dir]) /// With no argument, list the current directory. Otherwise list the given directory. STATIC mp_obj_t os_listdir(mp_uint_t n_args, const mp_obj_t *args) { bool is_str_type = true; const char *path; if (n_args == 1) { if (mp_obj_get_type(args[0]) == &mp_type_bytes) { is_str_type = false; } path = mp_obj_str_get_str(args[0]); } else { path = ""; } // "hack" to list root directory if (path[0] == '/' && path[1] == '\0') { mp_obj_t dir_list = mp_obj_new_list(0, NULL); mp_obj_list_append(dir_list, MP_OBJ_NEW_QSTR(MP_QSTR_flash)); #if MICROPY_HW_HAS_SDCARD if (pybsd_is_mounted()) { mp_obj_list_append(dir_list, MP_OBJ_NEW_QSTR(MP_QSTR_sd)); } #endif return dir_list; } FRESULT res; DIR dir; FILINFO fno; #if _USE_LFN char lfn_buf[_MAX_LFN + 1]; fno.lfname = lfn_buf; fno.lfsize = sizeof(lfn_buf); #endif res = f_opendir(&dir, path); /* Open the directory */ if (res != FR_OK) { nlr_raise(mp_obj_new_exception_msg(&mp_type_OSError, mpexception_os_operation_failed)); } mp_obj_t dir_list = mp_obj_new_list(0, NULL); for (;;) { res = f_readdir(&dir, &fno); /* Read a directory item */ if (res != FR_OK || fno.fname[0] == 0) break; /* Break on error or end of dir */ if (fno.fname[0] == '.' && fno.fname[1] == 0) continue; /* Ignore . entry */ if (fno.fname[0] == '.' && fno.fname[1] == '.' && fno.fname[2] == 0) continue; /* Ignore .. entry */ #if _USE_LFN char *fn = *fno.lfname ? fno.lfname : fno.fname; #else char *fn = fno.fname; #endif // make a string object for this entry mp_obj_t entry_o; if (is_str_type) { entry_o = mp_obj_new_str(fn, strlen(fn), false); } else { entry_o = mp_obj_new_bytes((const byte*)fn, strlen(fn)); } // add the entry to the list mp_obj_list_append(dir_list, entry_o); } f_closedir(&dir); return dir_list; } STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(os_listdir_obj, 0, 1, os_listdir); /// \function mkdir(path) /// Create a new directory. STATIC mp_obj_t os_mkdir(mp_obj_t path_o) { const char *path = mp_obj_str_get_str(path_o); FRESULT res = f_mkdir(path); switch (res) { case FR_OK: return mp_const_none; case FR_EXIST: nlr_raise(mp_obj_new_exception_msg(&mp_type_OSError, mpexception_os_request_not_possible)); break; default: nlr_raise(mp_obj_new_exception_msg(&mp_type_OSError, mpexception_os_operation_failed)); } } STATIC MP_DEFINE_CONST_FUN_OBJ_1(os_mkdir_obj, os_mkdir); /// \function rename(old_path, new_path) /// Rename a file STATIC mp_obj_t os_rename(mp_obj_t path_in, mp_obj_t path_out) { const char *old_path = mp_obj_str_get_str(path_in); const char *new_path = mp_obj_str_get_str(path_out); FRESULT res = f_rename(old_path, new_path); switch (res) { case FR_OK: return mp_const_none; default: nlr_raise(mp_obj_new_exception_msg(&mp_type_OSError, mpexception_os_operation_failed)); } } STATIC MP_DEFINE_CONST_FUN_OBJ_2(os_rename_obj, os_rename); /// \function remove(path) /// Remove a file or a directory STATIC mp_obj_t os_remove(mp_obj_t path_o) { const char *path = mp_obj_str_get_str(path_o); FRESULT res = f_unlink(path); switch (res) { case FR_OK: return mp_const_none; default: nlr_raise(mp_obj_new_exception_msg(&mp_type_OSError, mpexception_os_operation_failed)); } } STATIC MP_DEFINE_CONST_FUN_OBJ_1(os_remove_obj, os_remove); // Checks for path equality, ignoring trailing slashes: // path_equal(/, /) -> true // path_equal(/flash//, /flash) -> true // second argument must be in canonical form (meaning no trailing slash, unless it's just /) STATIC bool path_equal(const char *path, const char *path_canonical) { for (; *path_canonical != '\0' && *path == *path_canonical; ++path, ++path_canonical) { } if (*path_canonical != '\0') { return false; } for (; *path == '/'; ++path) { } return *path == '\0'; } /// \function stat(path) /// Get the status of a file or directory. STATIC mp_obj_t os_stat(mp_obj_t path_in) { const char *path = mp_obj_str_get_str(path_in); FRESULT res; FILINFO fno; #if _USE_LFN fno.lfname = NULL; fno.lfsize = 0; #endif if (path_equal(path, "/") || path_equal(path, "/flash") || path_equal(path, "/sd")) { // stat built-in directory #if MICROPY_HW_HAS_SDCARD if (path[1] == 's' && !pybsd_is_mounted()) { #else if (path[1] == 's') { #endif // no /sd directory res = FR_NO_PATH; goto error; } fno.fsize = 0; fno.fdate = 0; fno.ftime = 0; fno.fattrib = AM_DIR; } else { res = f_stat(path, &fno); if (res != FR_OK) { goto error; } } mp_obj_tuple_t *t = mp_obj_new_tuple(10, NULL); mp_int_t mode = 0; if (fno.fattrib & AM_DIR) { mode |= 0x4000; // stat.S_IFDIR } else { mode |= 0x8000; // stat.S_IFREG } mp_int_t seconds = timeutils_seconds_since_2000( 1980 + ((fno.fdate >> 9) & 0x7f), (fno.fdate >> 5) & 0x0f, fno.fdate & 0x1f, (fno.ftime >> 11) & 0x1f, (fno.ftime >> 5) & 0x3f, 2 * (fno.ftime & 0x1f) ); t->items[0] = mp_obj_new_int(mode); // st_mode t->items[1] = MP_OBJ_NEW_SMALL_INT(0); // st_ino t->items[2] = MP_OBJ_NEW_SMALL_INT(0); // st_dev t->items[3] = MP_OBJ_NEW_SMALL_INT(0); // st_nlink t->items[4] = MP_OBJ_NEW_SMALL_INT(0); // st_uid t->items[5] = MP_OBJ_NEW_SMALL_INT(0); // st_gid t->items[6] = mp_obj_new_int(fno.fsize); // st_size t->items[7] = mp_obj_new_int(seconds); // st_atime t->items[8] = t->items[7]; // st_mtime t->items[9] = t->items[7]; // st_ctime return t; error: nlr_raise(mp_obj_new_exception_arg1(&mp_type_OSError, MP_OBJ_NEW_SMALL_INT(fresult_to_errno_table[res]))); } STATIC MP_DEFINE_CONST_FUN_OBJ_1(os_stat_obj, os_stat); /// \function sync() /// Sync all filesystems. STATIC mp_obj_t os_sync(void) { sflash_disk_flush(); return mp_const_none; } STATIC MP_DEFINE_CONST_FUN_OBJ_0(os_sync_obj, os_sync); #if MICROPY_HW_ENABLE_RNG /// \function urandom(n) /// Return a bytes object with n random bytes, generated by the hardware /// random number generator. STATIC mp_obj_t os_urandom(mp_obj_t num) { mp_int_t n = mp_obj_get_int(num); vstr_t vstr; vstr_init_len(&vstr, n); for (int i = 0; i < n; i++) { vstr.buf[i] = rng_get(); } return mp_obj_new_str_from_vstr(&mp_type_bytes, &vstr); } STATIC MP_DEFINE_CONST_FUN_OBJ_1(os_urandom_obj, os_urandom); #endif /// \function mkfs('drive') /// Formats the selected drive, useful when the filesystem has been damaged beyond repair. /// Path must be either '/sd' or '/flash' STATIC mp_obj_t os_mkfs(mp_obj_t path_o) { const char *path = mp_obj_str_get_str(path_o); uint8_t sfd; if (!strcmp(path, "/flash")) { sfd = 1; } else if (!strcmp(path, "/sd")) { sfd = 0; } else { nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, mpexception_value_invalid_arguments)); } if (FR_OK != f_mkfs(path, sfd, 0)) { nlr_raise(mp_obj_new_exception_msg(&mp_type_OSError, mpexception_os_operation_failed)); } return mp_const_none; } STATIC MP_DEFINE_CONST_FUN_OBJ_1(os_mkfs_obj, os_mkfs); STATIC const mp_map_elem_t os_module_globals_table[] = { { MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR_uos) }, { MP_OBJ_NEW_QSTR(MP_QSTR_uname), (mp_obj_t)&os_uname_obj }, { MP_OBJ_NEW_QSTR(MP_QSTR_chdir), (mp_obj_t)&os_chdir_obj }, { MP_OBJ_NEW_QSTR(MP_QSTR_getcwd), (mp_obj_t)&os_getcwd_obj }, { MP_OBJ_NEW_QSTR(MP_QSTR_listdir), (mp_obj_t)&os_listdir_obj }, { MP_OBJ_NEW_QSTR(MP_QSTR_mkdir), (mp_obj_t)&os_mkdir_obj }, { MP_OBJ_NEW_QSTR(MP_QSTR_rename), (mp_obj_t)&os_rename_obj}, { MP_OBJ_NEW_QSTR(MP_QSTR_remove), (mp_obj_t)&os_remove_obj }, { MP_OBJ_NEW_QSTR(MP_QSTR_rmdir), (mp_obj_t)&os_remove_obj }, // rmdir aliases to remove { MP_OBJ_NEW_QSTR(MP_QSTR_stat), (mp_obj_t)&os_stat_obj }, { MP_OBJ_NEW_QSTR(MP_QSTR_unlink), (mp_obj_t)&os_remove_obj }, // unlink aliases to remove { MP_OBJ_NEW_QSTR(MP_QSTR_sync), (mp_obj_t)&os_sync_obj }, #if MICROPY_HW_ENABLE_RNG { MP_OBJ_NEW_QSTR(MP_QSTR_urandom), (mp_obj_t)&os_urandom_obj }, #endif { MP_OBJ_NEW_QSTR(MP_QSTR_mkfs), (mp_obj_t)&os_mkfs_obj }, /// \constant sep - separation character used in paths { MP_OBJ_NEW_QSTR(MP_QSTR_sep), MP_OBJ_NEW_QSTR(MP_QSTR__slash_) }, }; STATIC MP_DEFINE_CONST_DICT(os_module_globals, os_module_globals_table); const mp_obj_module_t mp_module_uos = { .base = { &mp_type_module }, .name = MP_QSTR_uos, .globals = (mp_obj_dict_t*)&os_module_globals, };