LCOV - code coverage report
Current view: top level - extmod - moduzlib.c (source / functions) Hit Total Coverage
Test: unix_coverage_v1.19.1-724-gfb7d21153.info Lines: 88 91 96.7 %
Date: 2022-12-01 09:37:31 Functions: 4 4 100.0 %
Branches: 26 30 86.7 %

           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) 2014-2016 Paul Sokolovsky
       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 <string.h>
      29                 :            : 
      30                 :            : #include "py/runtime.h"
      31                 :            : #include "py/stream.h"
      32                 :            : #include "py/mperrno.h"
      33                 :            : 
      34                 :            : #if MICROPY_PY_UZLIB
      35                 :            : 
      36                 :            : #include "lib/uzlib/tinf.h"
      37                 :            : 
      38                 :            : #if 0 // print debugging info
      39                 :            : #define DEBUG_printf DEBUG_printf
      40                 :            : #else // don't print debugging info
      41                 :            : #define DEBUG_printf(...) (void)0
      42                 :            : #endif
      43                 :            : 
      44                 :            : typedef struct _mp_obj_decompio_t {
      45                 :            :     mp_obj_base_t base;
      46                 :            :     mp_obj_t src_stream;
      47                 :            :     TINF_DATA decomp;
      48                 :            :     bool eof;
      49                 :            : } mp_obj_decompio_t;
      50                 :            : 
      51                 :        292 : STATIC int read_src_stream(TINF_DATA *data) {
      52                 :        292 :     byte *p = (void *)data;
      53                 :        292 :     p -= offsetof(mp_obj_decompio_t, decomp);
      54                 :        292 :     mp_obj_decompio_t *self = (mp_obj_decompio_t *)p;
      55                 :            : 
      56                 :        292 :     const mp_stream_p_t *stream = mp_get_stream(self->src_stream);
      57                 :        292 :     int err;
      58                 :        292 :     byte c;
      59                 :        292 :     mp_uint_t out_sz = stream->read(self->src_stream, &c, 1, &err);
      60         [ -  + ]:        292 :     if (out_sz == MP_STREAM_ERROR) {
      61                 :          0 :         mp_raise_OSError(err);
      62                 :            :     }
      63         [ -  + ]:        292 :     if (out_sz == 0) {
      64                 :          0 :         mp_raise_type(&mp_type_EOFError);
      65                 :            :     }
      66                 :        292 :     return c;
      67                 :            : }
      68                 :            : 
      69                 :         16 : STATIC mp_obj_t decompio_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
      70                 :         16 :     mp_arg_check_num(n_args, n_kw, 1, 2, false);
      71                 :         16 :     mp_get_stream_raise(args[0], MP_STREAM_OP_READ);
      72                 :         16 :     mp_obj_decompio_t *o = mp_obj_malloc(mp_obj_decompio_t, type);
      73                 :         16 :     memset(&o->decomp, 0, sizeof(o->decomp));
      74                 :         16 :     o->decomp.readSource = read_src_stream;
      75                 :         16 :     o->src_stream = args[0];
      76                 :         16 :     o->eof = false;
      77                 :            : 
      78                 :         16 :     mp_int_t dict_opt = 0;
      79                 :         16 :     uint dict_sz;
      80         [ +  + ]:         16 :     if (n_args > 1) {
      81                 :         12 :         dict_opt = mp_obj_get_int(args[1]);
      82                 :            :     }
      83                 :            : 
      84         [ +  + ]:         12 :     if (dict_opt >= 16) {
      85                 :         10 :         int st = uzlib_gzip_parse_header(&o->decomp);
      86         [ +  + ]:         10 :         if (st != TINF_OK) {
      87                 :          2 :             goto header_error;
      88                 :            :         }
      89                 :          8 :         dict_sz = 1 << (dict_opt - 16);
      90         [ +  + ]:          6 :     } else if (dict_opt >= 0) {
      91                 :          4 :         dict_opt = uzlib_zlib_parse_header(&o->decomp);
      92         [ -  + ]:          4 :         if (dict_opt < 0) {
      93                 :          0 :         header_error:
      94                 :          2 :             mp_raise_ValueError(MP_ERROR_TEXT("compression header"));
      95                 :            :         }
      96                 :            :         // RFC 1950 section 2.2:
      97                 :            :         // CINFO is the base-2 logarithm of the LZ77 window size,
      98                 :            :         // minus eight (CINFO=7 indicates a 32K window size)
      99                 :          4 :         dict_sz = 1 << (dict_opt + 8);
     100                 :            :     } else {
     101                 :          2 :         dict_sz = 1 << -dict_opt;
     102                 :            :     }
     103                 :            : 
     104                 :         14 :     uzlib_uncompress_init(&o->decomp, m_new(byte, dict_sz), dict_sz);
     105                 :         14 :     return MP_OBJ_FROM_PTR(o);
     106                 :            : }
     107                 :            : 
     108                 :         42 : STATIC mp_uint_t decompio_read(mp_obj_t o_in, void *buf, mp_uint_t size, int *errcode) {
     109                 :         42 :     mp_obj_decompio_t *o = MP_OBJ_TO_PTR(o_in);
     110         [ +  + ]:         42 :     if (o->eof) {
     111                 :            :         return 0;
     112                 :            :     }
     113                 :            : 
     114                 :         24 :     o->decomp.dest = buf;
     115                 :         24 :     o->decomp.dest_limit = (byte *)buf + size;
     116                 :         24 :     int st = uzlib_uncompress_chksum(&o->decomp);
     117         [ +  + ]:         24 :     if (st == TINF_DONE) {
     118                 :         10 :         o->eof = true;
     119                 :            :     }
     120         [ +  + ]:         24 :     if (st < 0) {
     121                 :          4 :         DEBUG_printf("uncompress error=" INT_FMT "\n", st);
     122                 :          4 :         *errcode = MP_EINVAL;
     123                 :          4 :         return MP_STREAM_ERROR;
     124                 :            :     }
     125                 :         20 :     return o->decomp.dest - (byte *)buf;
     126                 :            : }
     127                 :            : 
     128                 :            : #if !MICROPY_ENABLE_DYNRUNTIME
     129                 :            : STATIC const mp_rom_map_elem_t decompio_locals_dict_table[] = {
     130                 :            :     { MP_ROM_QSTR(MP_QSTR_read), MP_ROM_PTR(&mp_stream_read_obj) },
     131                 :            :     { MP_ROM_QSTR(MP_QSTR_readinto), MP_ROM_PTR(&mp_stream_readinto_obj) },
     132                 :            :     { MP_ROM_QSTR(MP_QSTR_readline), MP_ROM_PTR(&mp_stream_unbuffered_readline_obj) },
     133                 :            : };
     134                 :            : 
     135                 :            : STATIC MP_DEFINE_CONST_DICT(decompio_locals_dict, decompio_locals_dict_table);
     136                 :            : #endif
     137                 :            : 
     138                 :            : STATIC const mp_stream_p_t decompio_stream_p = {
     139                 :            :     .read = decompio_read,
     140                 :            : };
     141                 :            : 
     142                 :            : #if !MICROPY_ENABLE_DYNRUNTIME
     143                 :            : STATIC MP_DEFINE_CONST_OBJ_TYPE(
     144                 :            :     decompio_type,
     145                 :            :     MP_QSTR_DecompIO,
     146                 :            :     MP_TYPE_FLAG_NONE,
     147                 :            :     make_new, decompio_make_new,
     148                 :            :     protocol, &decompio_stream_p,
     149                 :            :     locals_dict, &decompio_locals_dict
     150                 :            :     );
     151                 :            : #endif
     152                 :            : 
     153                 :         22 : STATIC mp_obj_t mod_uzlib_decompress(size_t n_args, const mp_obj_t *args) {
     154                 :         22 :     mp_obj_t data = args[0];
     155                 :         22 :     mp_buffer_info_t bufinfo;
     156                 :         22 :     mp_get_buffer_raise(data, &bufinfo, MP_BUFFER_READ);
     157                 :            : 
     158                 :         22 :     TINF_DATA *decomp = m_new_obj(TINF_DATA);
     159                 :         22 :     memset(decomp, 0, sizeof(*decomp));
     160                 :         22 :     DEBUG_printf("sizeof(TINF_DATA)=" UINT_FMT "\n", sizeof(*decomp));
     161                 :         22 :     uzlib_uncompress_init(decomp, NULL, 0);
     162                 :         22 :     mp_uint_t dest_buf_size = (bufinfo.len + 15) & ~15;
     163                 :         22 :     byte *dest_buf = m_new(byte, dest_buf_size);
     164                 :            : 
     165                 :         22 :     decomp->dest = dest_buf;
     166                 :         22 :     decomp->dest_limit = dest_buf + dest_buf_size;
     167                 :         22 :     DEBUG_printf("uzlib: Initial out buffer: " UINT_FMT " bytes\n", dest_buf_size);
     168                 :         22 :     decomp->source = bufinfo.buf;
     169                 :         22 :     decomp->source_limit = (byte *)bufinfo.buf + bufinfo.len;
     170                 :            : 
     171                 :         22 :     int st;
     172                 :         22 :     bool is_zlib = true;
     173                 :            : 
     174   [ +  +  -  + ]:         22 :     if (n_args > 1 && MP_OBJ_SMALL_INT_VALUE(args[1]) < 0) {
     175                 :            :         is_zlib = false;
     176                 :            :     }
     177                 :            : 
     178                 :            :     if (is_zlib) {
     179                 :         16 :         st = uzlib_zlib_parse_header(decomp);
     180         [ +  + ]:         16 :         if (st < 0) {
     181                 :          2 :             goto error;
     182                 :            :         }
     183                 :            :     }
     184                 :            : 
     185                 :         24 :     while (1) {
     186                 :         22 :         st = uzlib_uncompress_chksum(decomp);
     187         [ +  + ]:         22 :         if (st < 0) {
     188                 :          2 :             goto error;
     189                 :            :         }
     190         [ +  + ]:         20 :         if (st == TINF_DONE) {
     191                 :            :             break;
     192                 :            :         }
     193                 :          2 :         size_t offset = decomp->dest - dest_buf;
     194                 :          2 :         dest_buf = m_renew(byte, dest_buf, dest_buf_size, dest_buf_size + 256);
     195                 :          2 :         dest_buf_size += 256;
     196                 :          2 :         decomp->dest = dest_buf + offset;
     197                 :          2 :         decomp->dest_limit = decomp->dest + 256;
     198                 :            :     }
     199                 :            : 
     200                 :         18 :     mp_uint_t final_sz = decomp->dest - dest_buf;
     201                 :         18 :     DEBUG_printf("uzlib: Resizing from " UINT_FMT " to final size: " UINT_FMT " bytes\n", dest_buf_size, final_sz);
     202                 :         18 :     dest_buf = (byte *)m_renew(byte, dest_buf, dest_buf_size, final_sz);
     203                 :         18 :     mp_obj_t res = mp_obj_new_bytearray_by_ref(final_sz, dest_buf);
     204                 :         18 :     m_del_obj(TINF_DATA, decomp);
     205                 :         18 :     return res;
     206                 :            : 
     207                 :          4 : error:
     208                 :          4 :     mp_raise_type_arg(&mp_type_ValueError, MP_OBJ_NEW_SMALL_INT(st));
     209                 :            : }
     210                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mod_uzlib_decompress_obj, 1, 3, mod_uzlib_decompress);
     211                 :            : 
     212                 :            : #if !MICROPY_ENABLE_DYNRUNTIME
     213                 :            : STATIC const mp_rom_map_elem_t mp_module_uzlib_globals_table[] = {
     214                 :            :     { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_uzlib) },
     215                 :            :     { MP_ROM_QSTR(MP_QSTR_decompress), MP_ROM_PTR(&mod_uzlib_decompress_obj) },
     216                 :            :     { MP_ROM_QSTR(MP_QSTR_DecompIO), MP_ROM_PTR(&decompio_type) },
     217                 :            : };
     218                 :            : 
     219                 :            : STATIC MP_DEFINE_CONST_DICT(mp_module_uzlib_globals, mp_module_uzlib_globals_table);
     220                 :            : 
     221                 :            : const mp_obj_module_t mp_module_uzlib = {
     222                 :            :     .base = { &mp_type_module },
     223                 :            :     .globals = (mp_obj_dict_t *)&mp_module_uzlib_globals,
     224                 :            : };
     225                 :            : 
     226                 :            : 
     227                 :            : MP_REGISTER_MODULE(MP_QSTR_uzlib, mp_module_uzlib);
     228                 :            : #endif
     229                 :            : 
     230                 :            : // Source files #include'd here to make sure they're compiled in
     231                 :            : // only if module is enabled by config setting.
     232                 :            : 
     233                 :            : #include "lib/uzlib/tinflate.c"
     234                 :            : #include "lib/uzlib/tinfzlib.c"
     235                 :            : #include "lib/uzlib/tinfgzip.c"
     236                 :            : #include "lib/uzlib/adler32.c"
     237                 :            : #include "lib/uzlib/crc32.c"
     238                 :            : 
     239                 :            : #endif // MICROPY_PY_UZLIB

Generated by: LCOV version 1.15-5-g462f71d