2017-01-27 04:10:09 +00:00
|
|
|
/*
|
|
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
|
|
*
|
|
|
|
* The MIT License (MIT)
|
|
|
|
*
|
|
|
|
* Copyright (c) 2013-2017 Damien P. George
|
|
|
|
*
|
|
|
|
* 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 <stdio.h>
|
|
|
|
#include <string.h>
|
2023-10-31 04:14:05 +00:00
|
|
|
#include <stdlib.h>
|
2017-01-27 04:10:09 +00:00
|
|
|
|
2017-03-14 00:16:31 +00:00
|
|
|
#include "py/runtime.h"
|
2017-01-27 04:10:09 +00:00
|
|
|
#include "py/stream.h"
|
|
|
|
#include "py/reader.h"
|
|
|
|
#include "extmod/vfs.h"
|
|
|
|
|
|
|
|
#if MICROPY_READER_VFS
|
|
|
|
|
2023-10-31 04:14:05 +00:00
|
|
|
#ifndef MICROPY_READER_VFS_DEFAULT_BUFFER_SIZE
|
|
|
|
#define MICROPY_READER_VFS_DEFAULT_BUFFER_SIZE (2 * MICROPY_BYTES_PER_GC_BLOCK - offsetof(mp_reader_vfs_t, buf))
|
|
|
|
#endif
|
|
|
|
#define MICROPY_READER_VFS_MIN_BUFFER_SIZE (MICROPY_BYTES_PER_GC_BLOCK - offsetof(mp_reader_vfs_t, buf))
|
|
|
|
#define MICROPY_READER_VFS_MAX_BUFFER_SIZE (255)
|
|
|
|
|
2017-01-27 04:10:09 +00:00
|
|
|
typedef struct _mp_reader_vfs_t {
|
|
|
|
mp_obj_t file;
|
2023-10-31 04:14:05 +00:00
|
|
|
uint8_t bufpos;
|
|
|
|
uint8_t buflen;
|
|
|
|
uint8_t bufsize;
|
|
|
|
byte buf[];
|
2017-01-27 04:10:09 +00:00
|
|
|
} mp_reader_vfs_t;
|
|
|
|
|
2024-02-27 04:32:29 +00:00
|
|
|
static mp_uint_t mp_reader_vfs_readbyte(void *data) {
|
2020-02-27 04:36:53 +00:00
|
|
|
mp_reader_vfs_t *reader = (mp_reader_vfs_t *)data;
|
2023-10-31 04:14:05 +00:00
|
|
|
if (reader->bufpos >= reader->buflen) {
|
|
|
|
if (reader->buflen < reader->bufsize) {
|
2017-01-27 04:10:09 +00:00
|
|
|
return MP_READER_EOF;
|
|
|
|
} else {
|
|
|
|
int errcode;
|
2023-10-31 04:14:05 +00:00
|
|
|
reader->buflen = mp_stream_rw(reader->file, reader->buf, reader->bufsize, &errcode, MP_STREAM_RW_READ | MP_STREAM_RW_ONCE);
|
2017-01-27 04:10:09 +00:00
|
|
|
if (errcode != 0) {
|
|
|
|
// TODO handle errors properly
|
|
|
|
return MP_READER_EOF;
|
|
|
|
}
|
2023-10-31 04:14:05 +00:00
|
|
|
if (reader->buflen == 0) {
|
2017-01-27 04:10:09 +00:00
|
|
|
return MP_READER_EOF;
|
|
|
|
}
|
2023-10-31 04:14:05 +00:00
|
|
|
reader->bufpos = 0;
|
2017-01-27 04:10:09 +00:00
|
|
|
}
|
|
|
|
}
|
2023-10-31 04:14:05 +00:00
|
|
|
return reader->buf[reader->bufpos++];
|
2017-01-27 04:10:09 +00:00
|
|
|
}
|
|
|
|
|
2024-02-27 04:32:29 +00:00
|
|
|
static void mp_reader_vfs_close(void *data) {
|
2020-02-27 04:36:53 +00:00
|
|
|
mp_reader_vfs_t *reader = (mp_reader_vfs_t *)data;
|
2017-01-27 04:10:09 +00:00
|
|
|
mp_stream_close(reader->file);
|
|
|
|
m_del_obj(mp_reader_vfs_t, reader);
|
|
|
|
}
|
|
|
|
|
2023-09-27 03:43:50 +00:00
|
|
|
void mp_reader_new_file(mp_reader_t *reader, qstr filename) {
|
extmod/vfs_reader: Fix mp_reader_new_file to open file in "rb" mode.
mp_reader_new_file() is used to read in files for importing, either .py or
.mpy files, for the lexer and persistent code loader respectively. In both
cases the file should be opened in raw bytes mode: the lexer handles
unicode characters itself, and .mpy files contain 8-bit bytes by nature.
Before this commit importing was working correctly because, although the
file was opened in text mode, all native filesystem implementations (POSIX,
FAT, LFS) would access the file in raw bytes mode via mp_stream_rw()
calling mp_stream_p_t.read(). So it was only an issue for non-native
filesystems, such as those implemented in Python. For Python-based
filesystem implementations, a call to mp_stream_rw() would go via IOBase
and then to readinto() at the Python level, and readinto() is only defined
on files opened in raw bytes mode.
Signed-off-by: Damien George <damien@micropython.org>
2020-08-08 05:39:56 +00:00
|
|
|
mp_obj_t args[2] = {
|
2023-09-27 03:43:50 +00:00
|
|
|
MP_OBJ_NEW_QSTR(filename),
|
extmod/vfs_reader: Fix mp_reader_new_file to open file in "rb" mode.
mp_reader_new_file() is used to read in files for importing, either .py or
.mpy files, for the lexer and persistent code loader respectively. In both
cases the file should be opened in raw bytes mode: the lexer handles
unicode characters itself, and .mpy files contain 8-bit bytes by nature.
Before this commit importing was working correctly because, although the
file was opened in text mode, all native filesystem implementations (POSIX,
FAT, LFS) would access the file in raw bytes mode via mp_stream_rw()
calling mp_stream_p_t.read(). So it was only an issue for non-native
filesystems, such as those implemented in Python. For Python-based
filesystem implementations, a call to mp_stream_rw() would go via IOBase
and then to readinto() at the Python level, and readinto() is only defined
on files opened in raw bytes mode.
Signed-off-by: Damien George <damien@micropython.org>
2020-08-08 05:39:56 +00:00
|
|
|
MP_OBJ_NEW_QSTR(MP_QSTR_rb),
|
|
|
|
};
|
2023-10-31 04:14:05 +00:00
|
|
|
mp_obj_t file = mp_vfs_open(MP_ARRAY_SIZE(args), &args[0], (mp_map_t *)&mp_const_empty_map);
|
|
|
|
|
|
|
|
const mp_stream_p_t *stream_p = mp_get_stream(file);
|
|
|
|
int errcode = 0;
|
|
|
|
mp_uint_t bufsize = stream_p->ioctl(file, MP_STREAM_GET_BUFFER_SIZE, 0, &errcode);
|
|
|
|
if (bufsize == MP_STREAM_ERROR || bufsize == 0) {
|
|
|
|
// bufsize == 0 is included here to support mpremote v1.21 and older where mount file ioctl
|
|
|
|
// returned 0 by default.
|
|
|
|
bufsize = MICROPY_READER_VFS_DEFAULT_BUFFER_SIZE;
|
|
|
|
} else {
|
|
|
|
bufsize = MIN(MICROPY_READER_VFS_MAX_BUFFER_SIZE, MAX(MICROPY_READER_VFS_MIN_BUFFER_SIZE, bufsize));
|
|
|
|
}
|
|
|
|
|
|
|
|
mp_reader_vfs_t *rf = m_new_obj_var(mp_reader_vfs_t, buf, byte, bufsize);
|
|
|
|
rf->file = file;
|
|
|
|
rf->bufsize = bufsize;
|
|
|
|
rf->buflen = mp_stream_rw(rf->file, rf->buf, rf->bufsize, &errcode, MP_STREAM_RW_READ | MP_STREAM_RW_ONCE);
|
2017-03-14 00:16:31 +00:00
|
|
|
if (errcode != 0) {
|
|
|
|
mp_raise_OSError(errcode);
|
2017-01-27 04:10:09 +00:00
|
|
|
}
|
2023-10-31 04:14:05 +00:00
|
|
|
rf->bufpos = 0;
|
2017-01-27 04:10:09 +00:00
|
|
|
reader->data = rf;
|
|
|
|
reader->readbyte = mp_reader_vfs_readbyte;
|
|
|
|
reader->close = mp_reader_vfs_close;
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif // MICROPY_READER_VFS
|