LCOV - code coverage report
Current view: top level - extmod - modutimeq.c (source / functions) Hit Total Coverage
Test: unix_coverage_v1.19.1-722-g1b774b373.info Lines: 89 89 100.0 %
Date: 2022-11-29 09:02:29 Functions: 9 9 100.0 %
Branches: 35 41 85.4 %

           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 Damien P. George
       7                 :            :  * Copyright (c) 2016-2017 Paul Sokolovsky
       8                 :            :  *
       9                 :            :  * Permission is hereby granted, free of charge, to any person obtaining a copy
      10                 :            :  * of this software and associated documentation files (the "Software"), to deal
      11                 :            :  * in the Software without restriction, including without limitation the rights
      12                 :            :  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      13                 :            :  * copies of the Software, and to permit persons to whom the Software is
      14                 :            :  * furnished to do so, subject to the following conditions:
      15                 :            :  *
      16                 :            :  * The above copyright notice and this permission notice shall be included in
      17                 :            :  * all copies or substantial portions of the Software.
      18                 :            :  *
      19                 :            :  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      20                 :            :  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      21                 :            :  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      22                 :            :  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      23                 :            :  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      24                 :            :  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
      25                 :            :  * THE SOFTWARE.
      26                 :            :  */
      27                 :            : 
      28                 :            : #include <string.h>
      29                 :            : 
      30                 :            : #include "py/objlist.h"
      31                 :            : #include "py/runtime.h"
      32                 :            : #include "py/smallint.h"
      33                 :            : 
      34                 :            : #if MICROPY_PY_UTIMEQ
      35                 :            : 
      36                 :            : #define MODULO MICROPY_PY_UTIME_TICKS_PERIOD
      37                 :            : 
      38                 :            : #define DEBUG 0
      39                 :            : 
      40                 :            : // the algorithm here is modelled on CPython's heapq.py
      41                 :            : 
      42                 :            : struct qentry {
      43                 :            :     mp_uint_t time;
      44                 :            :     mp_uint_t id;
      45                 :            :     mp_obj_t callback;
      46                 :            :     mp_obj_t args;
      47                 :            : };
      48                 :            : 
      49                 :            : typedef struct _mp_obj_utimeq_t {
      50                 :            :     mp_obj_base_t base;
      51                 :            :     mp_uint_t alloc;
      52                 :            :     mp_uint_t len;
      53                 :            :     struct qentry items[];
      54                 :            : } mp_obj_utimeq_t;
      55                 :            : 
      56                 :            : STATIC mp_uint_t utimeq_id;
      57                 :            : 
      58                 :        116 : STATIC mp_obj_utimeq_t *utimeq_get_heap(mp_obj_t heap_in) {
      59                 :        116 :     return MP_OBJ_TO_PTR(heap_in);
      60                 :            : }
      61                 :            : 
      62                 :         46 : STATIC bool time_less_than(struct qentry *item, struct qentry *parent) {
      63                 :         46 :     mp_uint_t item_tm = item->time;
      64                 :         46 :     mp_uint_t parent_tm = parent->time;
      65                 :         46 :     mp_uint_t res = parent_tm - item_tm;
      66         [ +  + ]:         46 :     if (res == 0) {
      67                 :            :         // TODO: This actually should use the same "ring" logic
      68                 :            :         // as for time, to avoid artifacts when id's overflow.
      69                 :          2 :         return item->id < parent->id;
      70                 :            :     }
      71         [ +  + ]:         44 :     if ((mp_int_t)res < 0) {
      72                 :         22 :         res += MODULO;
      73                 :            :     }
      74                 :         44 :     return res && res < (MODULO / 2);
      75                 :            : }
      76                 :            : 
      77                 :         28 : STATIC mp_obj_t utimeq_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
      78                 :         28 :     mp_arg_check_num(n_args, n_kw, 1, 1, false);
      79                 :         28 :     mp_uint_t alloc = mp_obj_get_int(args[0]);
      80                 :         28 :     mp_obj_utimeq_t *o = mp_obj_malloc_var(mp_obj_utimeq_t, struct qentry, alloc, type);
      81                 :         28 :     memset(o->items, 0, sizeof(*o->items) * alloc);
      82                 :         28 :     o->alloc = alloc;
      83                 :         28 :     o->len = 0;
      84                 :         28 :     return MP_OBJ_FROM_PTR(o);
      85                 :            : }
      86                 :            : 
      87                 :         84 : STATIC void utimeq_heap_siftdown(mp_obj_utimeq_t *heap, mp_uint_t start_pos, mp_uint_t pos) {
      88                 :         84 :     struct qentry item = heap->items[pos];
      89         [ +  + ]:        100 :     while (pos > start_pos) {
      90                 :         40 :         mp_uint_t parent_pos = (pos - 1) >> 1;
      91                 :         40 :         struct qentry *parent = &heap->items[parent_pos];
      92                 :         40 :         bool lessthan = time_less_than(&item, parent);
      93         [ +  + ]:         40 :         if (lessthan) {
      94                 :         16 :             heap->items[pos] = *parent;
      95                 :         16 :             pos = parent_pos;
      96                 :            :         } else {
      97                 :            :             break;
      98                 :            :         }
      99                 :            :     }
     100                 :         84 :     heap->items[pos] = item;
     101                 :         84 : }
     102                 :            : 
     103                 :         30 : STATIC void utimeq_heap_siftup(mp_obj_utimeq_t *heap, mp_uint_t pos) {
     104                 :         30 :     mp_uint_t start_pos = pos;
     105                 :         30 :     mp_uint_t end_pos = heap->len;
     106                 :         30 :     struct qentry item = heap->items[pos];
     107         [ +  + ]:         38 :     for (mp_uint_t child_pos = 2 * pos + 1; child_pos < end_pos; child_pos = 2 * pos + 1) {
     108                 :            :         // choose right child if it's <= left child
     109         [ +  + ]:          8 :         if (child_pos + 1 < end_pos) {
     110                 :          6 :             bool lessthan = time_less_than(&heap->items[child_pos], &heap->items[child_pos + 1]);
     111         [ +  + ]:          6 :             if (!lessthan) {
     112                 :          4 :                 child_pos += 1;
     113                 :            :             }
     114                 :            :         }
     115                 :            :         // bubble up the smaller child
     116                 :          8 :         heap->items[pos] = heap->items[child_pos];
     117                 :          8 :         pos = child_pos;
     118                 :            :     }
     119                 :         30 :     heap->items[pos] = item;
     120                 :         30 :     utimeq_heap_siftdown(heap, start_pos, pos);
     121                 :         30 : }
     122                 :            : 
     123                 :         56 : STATIC mp_obj_t mod_utimeq_heappush(size_t n_args, const mp_obj_t *args) {
     124                 :         56 :     (void)n_args;
     125                 :         56 :     mp_obj_t heap_in = args[0];
     126                 :         56 :     mp_obj_utimeq_t *heap = utimeq_get_heap(heap_in);
     127         [ +  + ]:         56 :     if (heap->len == heap->alloc) {
     128                 :          2 :         mp_raise_msg(&mp_type_IndexError, MP_ERROR_TEXT("queue overflow"));
     129                 :            :     }
     130                 :         54 :     mp_uint_t l = heap->len;
     131                 :         54 :     heap->items[l].time = MP_OBJ_SMALL_INT_VALUE(args[1]);
     132                 :         54 :     heap->items[l].id = utimeq_id++;
     133                 :         54 :     heap->items[l].callback = args[2];
     134                 :         54 :     heap->items[l].args = args[3];
     135                 :         54 :     utimeq_heap_siftdown(heap, 0, heap->len);
     136                 :         54 :     heap->len++;
     137                 :         54 :     return mp_const_none;
     138                 :            : }
     139                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mod_utimeq_heappush_obj, 4, 4, mod_utimeq_heappush);
     140                 :            : 
     141                 :         56 : STATIC mp_obj_t mod_utimeq_heappop(mp_obj_t heap_in, mp_obj_t list_ref) {
     142                 :         56 :     mp_obj_utimeq_t *heap = utimeq_get_heap(heap_in);
     143         [ +  + ]:         56 :     if (heap->len == 0) {
     144                 :          2 :         mp_raise_msg(&mp_type_IndexError, MP_ERROR_TEXT("empty heap"));
     145                 :            :     }
     146                 :         54 :     mp_obj_list_t *ret = MP_OBJ_TO_PTR(list_ref);
     147   [ -  +  -  +  :         54 :     if (!mp_obj_is_type(list_ref, &mp_type_list) || ret->len < 3) {
          -  +  -  +  +  
             -  +  -  +  
                      + ]
     148                 :          2 :         mp_raise_TypeError(NULL);
     149                 :            :     }
     150                 :            : 
     151                 :         52 :     struct qentry *item = &heap->items[0];
     152                 :         52 :     ret->items[0] = MP_OBJ_NEW_SMALL_INT(item->time);
     153                 :         52 :     ret->items[1] = item->callback;
     154                 :         52 :     ret->items[2] = item->args;
     155                 :         52 :     heap->len -= 1;
     156                 :         52 :     heap->items[0] = heap->items[heap->len];
     157                 :         52 :     heap->items[heap->len].callback = MP_OBJ_NULL; // so we don't retain a pointer
     158                 :         52 :     heap->items[heap->len].args = MP_OBJ_NULL;
     159         [ +  + ]:         52 :     if (heap->len) {
     160                 :         30 :         utimeq_heap_siftup(heap, 0);
     161                 :            :     }
     162                 :         52 :     return mp_const_none;
     163                 :            : }
     164                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_2(mod_utimeq_heappop_obj, mod_utimeq_heappop);
     165                 :            : 
     166                 :          4 : STATIC mp_obj_t mod_utimeq_peektime(mp_obj_t heap_in) {
     167                 :          4 :     mp_obj_utimeq_t *heap = utimeq_get_heap(heap_in);
     168         [ +  + ]:          4 :     if (heap->len == 0) {
     169                 :          2 :         mp_raise_msg(&mp_type_IndexError, MP_ERROR_TEXT("empty heap"));
     170                 :            :     }
     171                 :            : 
     172                 :          2 :     struct qentry *item = &heap->items[0];
     173                 :          2 :     return MP_OBJ_NEW_SMALL_INT(item->time);
     174                 :            : }
     175                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_1(mod_utimeq_peektime_obj, mod_utimeq_peektime);
     176                 :            : 
     177                 :            : #if DEBUG
     178                 :            : STATIC mp_obj_t mod_utimeq_dump(mp_obj_t heap_in) {
     179                 :            :     mp_obj_utimeq_t *heap = utimeq_get_heap(heap_in);
     180                 :            :     for (int i = 0; i < heap->len; i++) {
     181                 :            :         printf(UINT_FMT "\t%p\t%p\n", heap->items[i].time,
     182                 :            :             MP_OBJ_TO_PTR(heap->items[i].callback), MP_OBJ_TO_PTR(heap->items[i].args));
     183                 :            :     }
     184                 :            :     return mp_const_none;
     185                 :            : }
     186                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_1(mod_utimeq_dump_obj, mod_utimeq_dump);
     187                 :            : #endif
     188                 :            : 
     189                 :         72 : STATIC mp_obj_t utimeq_unary_op(mp_unary_op_t op, mp_obj_t self_in) {
     190                 :         72 :     mp_obj_utimeq_t *self = MP_OBJ_TO_PTR(self_in);
     191      [ +  +  + ]:         72 :     switch (op) {
     192                 :         68 :         case MP_UNARY_OP_BOOL:
     193         [ +  + ]:         68 :             return mp_obj_new_bool(self->len != 0);
     194                 :          2 :         case MP_UNARY_OP_LEN:
     195                 :          2 :             return MP_OBJ_NEW_SMALL_INT(self->len);
     196                 :            :         default:
     197                 :            :             return MP_OBJ_NULL;      // op not supported
     198                 :            :     }
     199                 :            : }
     200                 :            : 
     201                 :            : STATIC const mp_rom_map_elem_t utimeq_locals_dict_table[] = {
     202                 :            :     { MP_ROM_QSTR(MP_QSTR_push), MP_ROM_PTR(&mod_utimeq_heappush_obj) },
     203                 :            :     { MP_ROM_QSTR(MP_QSTR_pop), MP_ROM_PTR(&mod_utimeq_heappop_obj) },
     204                 :            :     { MP_ROM_QSTR(MP_QSTR_peektime), MP_ROM_PTR(&mod_utimeq_peektime_obj) },
     205                 :            :     #if DEBUG
     206                 :            :     { MP_ROM_QSTR(MP_QSTR_dump), MP_ROM_PTR(&mod_utimeq_dump_obj) },
     207                 :            :     #endif
     208                 :            : };
     209                 :            : 
     210                 :            : STATIC MP_DEFINE_CONST_DICT(utimeq_locals_dict, utimeq_locals_dict_table);
     211                 :            : 
     212                 :            : STATIC MP_DEFINE_CONST_OBJ_TYPE(
     213                 :            :     utimeq_type,
     214                 :            :     MP_QSTR_utimeq,
     215                 :            :     MP_TYPE_FLAG_NONE,
     216                 :            :     make_new, utimeq_make_new,
     217                 :            :     unary_op, utimeq_unary_op,
     218                 :            :     locals_dict, &utimeq_locals_dict
     219                 :            :     );
     220                 :            : 
     221                 :            : STATIC const mp_rom_map_elem_t mp_module_utimeq_globals_table[] = {
     222                 :            :     { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_utimeq) },
     223                 :            :     { MP_ROM_QSTR(MP_QSTR_utimeq), MP_ROM_PTR(&utimeq_type) },
     224                 :            : };
     225                 :            : 
     226                 :            : STATIC MP_DEFINE_CONST_DICT(mp_module_utimeq_globals, mp_module_utimeq_globals_table);
     227                 :            : 
     228                 :            : const mp_obj_module_t mp_module_utimeq = {
     229                 :            :     .base = { &mp_type_module },
     230                 :            :     .globals = (mp_obj_dict_t *)&mp_module_utimeq_globals,
     231                 :            : };
     232                 :            : 
     233                 :            : MP_REGISTER_MODULE(MP_QSTR_utimeq, mp_module_utimeq);
     234                 :            : 
     235                 :            : #endif // MICROPY_PY_UTIMEQ

Generated by: LCOV version 1.15-5-g462f71d