blob: 151e04cac2c7176ee17d1155376b8bbd596ce41a [file] [log] [blame]
Damien George6b239c22016-11-16 16:04:57 +11001/*
2 * This file is part of the MicroPython project, http://micropython.org/
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) 2013-2016 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 <stdio.h>
28#include <assert.h>
29
Damien George18310342017-03-14 11:16:31 +110030#include "py/runtime.h"
Damien George6b239c22016-11-16 16:04:57 +110031#include "py/mperrno.h"
David Lechner62537a12020-01-24 11:50:31 -060032#include "py/mpthread.h"
Damien George6b239c22016-11-16 16:04:57 +110033#include "py/reader.h"
34
35typedef struct _mp_reader_mem_t {
36 size_t free_len; // if >0 mem is freed on close by: m_free(beg, free_len)
37 const byte *beg;
38 const byte *cur;
39 const byte *end;
40} mp_reader_mem_t;
41
Angus Grattondecf8e62024-02-27 15:32:29 +110042static mp_uint_t mp_reader_mem_readbyte(void *data) {
Damien George69661f32020-02-27 15:36:53 +110043 mp_reader_mem_t *reader = (mp_reader_mem_t *)data;
Damien George6b239c22016-11-16 16:04:57 +110044 if (reader->cur < reader->end) {
45 return *reader->cur++;
46 } else {
47 return MP_READER_EOF;
48 }
49}
50
Angus Grattondecf8e62024-02-27 15:32:29 +110051static void mp_reader_mem_close(void *data) {
Damien George69661f32020-02-27 15:36:53 +110052 mp_reader_mem_t *reader = (mp_reader_mem_t *)data;
Damien George6b239c22016-11-16 16:04:57 +110053 if (reader->free_len > 0) {
Damien George69661f32020-02-27 15:36:53 +110054 m_del(char, (char *)reader->beg, reader->free_len);
Damien George6b239c22016-11-16 16:04:57 +110055 }
56 m_del_obj(mp_reader_mem_t, reader);
57}
58
Damien George18310342017-03-14 11:16:31 +110059void mp_reader_new_mem(mp_reader_t *reader, const byte *buf, size_t len, size_t free_len) {
60 mp_reader_mem_t *rm = m_new_obj(mp_reader_mem_t);
Damien George6b239c22016-11-16 16:04:57 +110061 rm->free_len = free_len;
62 rm->beg = buf;
63 rm->cur = buf;
64 rm->end = buf + len;
65 reader->data = rm;
66 reader->readbyte = mp_reader_mem_readbyte;
67 reader->close = mp_reader_mem_close;
Damien George6b239c22016-11-16 16:04:57 +110068}
69
70#if MICROPY_READER_POSIX
71
72#include <sys/stat.h>
73#include <fcntl.h>
74#include <unistd.h>
Damien George6b239c22016-11-16 16:04:57 +110075
76typedef struct _mp_reader_posix_t {
77 bool close_fd;
78 int fd;
79 size_t len;
80 size_t pos;
81 byte buf[20];
82} mp_reader_posix_t;
83
Angus Grattondecf8e62024-02-27 15:32:29 +110084static mp_uint_t mp_reader_posix_readbyte(void *data) {
Damien George69661f32020-02-27 15:36:53 +110085 mp_reader_posix_t *reader = (mp_reader_posix_t *)data;
Damien George6b239c22016-11-16 16:04:57 +110086 if (reader->pos >= reader->len) {
87 if (reader->len == 0) {
88 return MP_READER_EOF;
89 } else {
David Lechner62537a12020-01-24 11:50:31 -060090 MP_THREAD_GIL_EXIT();
Damien George6b239c22016-11-16 16:04:57 +110091 int n = read(reader->fd, reader->buf, sizeof(reader->buf));
David Lechner62537a12020-01-24 11:50:31 -060092 MP_THREAD_GIL_ENTER();
Damien George6b239c22016-11-16 16:04:57 +110093 if (n <= 0) {
94 reader->len = 0;
95 return MP_READER_EOF;
96 }
97 reader->len = n;
98 reader->pos = 0;
99 }
100 }
101 return reader->buf[reader->pos++];
102}
103
Angus Grattondecf8e62024-02-27 15:32:29 +1100104static void mp_reader_posix_close(void *data) {
Damien George69661f32020-02-27 15:36:53 +1100105 mp_reader_posix_t *reader = (mp_reader_posix_t *)data;
Damien George6b239c22016-11-16 16:04:57 +1100106 if (reader->close_fd) {
David Lechner62537a12020-01-24 11:50:31 -0600107 MP_THREAD_GIL_EXIT();
Damien George6b239c22016-11-16 16:04:57 +1100108 close(reader->fd);
David Lechner62537a12020-01-24 11:50:31 -0600109 MP_THREAD_GIL_ENTER();
Damien George6b239c22016-11-16 16:04:57 +1100110 }
111 m_del_obj(mp_reader_posix_t, reader);
112}
113
Damien George18310342017-03-14 11:16:31 +1100114void mp_reader_new_file_from_fd(mp_reader_t *reader, int fd, bool close_fd) {
115 mp_reader_posix_t *rp = m_new_obj(mp_reader_posix_t);
Damien George6b239c22016-11-16 16:04:57 +1100116 rp->close_fd = close_fd;
117 rp->fd = fd;
David Lechner62537a12020-01-24 11:50:31 -0600118 MP_THREAD_GIL_EXIT();
Damien George6b239c22016-11-16 16:04:57 +1100119 int n = read(rp->fd, rp->buf, sizeof(rp->buf));
120 if (n == -1) {
121 if (close_fd) {
122 close(fd);
123 }
David Lechner62537a12020-01-24 11:50:31 -0600124 MP_THREAD_GIL_ENTER();
Damien George18310342017-03-14 11:16:31 +1100125 mp_raise_OSError(errno);
Damien George6b239c22016-11-16 16:04:57 +1100126 }
David Lechner62537a12020-01-24 11:50:31 -0600127 MP_THREAD_GIL_ENTER();
Damien George6b239c22016-11-16 16:04:57 +1100128 rp->len = n;
129 rp->pos = 0;
130 reader->data = rp;
131 reader->readbyte = mp_reader_posix_readbyte;
132 reader->close = mp_reader_posix_close;
Damien George6b239c22016-11-16 16:04:57 +1100133}
134
Damien Georgea93144c2018-06-06 13:12:05 +1000135#if !MICROPY_VFS_POSIX
136// If MICROPY_VFS_POSIX is defined then this function is provided by the VFS layer
Jim Mussared50157792023-09-27 13:43:50 +1000137void mp_reader_new_file(mp_reader_t *reader, qstr filename) {
David Lechner62537a12020-01-24 11:50:31 -0600138 MP_THREAD_GIL_EXIT();
Jim Mussared50157792023-09-27 13:43:50 +1000139 int fd = open(qstr_str(filename), O_RDONLY, 0644);
David Lechner62537a12020-01-24 11:50:31 -0600140 MP_THREAD_GIL_ENTER();
Damien George6b239c22016-11-16 16:04:57 +1100141 if (fd < 0) {
Jim Mussared50157792023-09-27 13:43:50 +1000142 mp_raise_OSError_with_filename(errno, qstr_str(filename));
Damien George6b239c22016-11-16 16:04:57 +1100143 }
Damien George18310342017-03-14 11:16:31 +1100144 mp_reader_new_file_from_fd(reader, fd, true);
Damien George6b239c22016-11-16 16:04:57 +1100145}
Damien Georgea93144c2018-06-06 13:12:05 +1000146#endif
Damien George6b239c22016-11-16 16:04:57 +1100147
148#endif