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) 2013-2023 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 "py/mpstate.h"
      28                 :            : 
      29                 :            : #if !MICROPY_NLR_SETJMP
      30                 :            : // When not using setjmp, nlr_push_tail is called from inline asm so needs special care
      31                 :            : #if MICROPY_NLR_X86 && MICROPY_NLR_OS_WINDOWS
      32                 :            : // On these 32-bit platforms make sure nlr_push_tail doesn't have a leading underscore
      33                 :            : unsigned int nlr_push_tail(nlr_buf_t *nlr) asm ("nlr_push_tail");
      34                 :            : #else
      35                 :            : // LTO can't see inside inline asm functions so explicitly mark nlr_push_tail as used
      36                 :            : __attribute__((used)) unsigned int nlr_push_tail(nlr_buf_t *nlr);
      37                 :            : #endif
      38                 :            : #endif
      39                 :            : 
      40                 :    8514815 : unsigned int nlr_push_tail(nlr_buf_t *nlr) {
      41                 :    8514815 :     nlr_buf_t **top = &MP_STATE_THREAD(nlr_top);
      42                 :    8690766 :     nlr->prev = *top;
      43                 :    8690766 :     MP_NLR_SAVE_PYSTACK(nlr);
      44                 :    8690766 :     *top = nlr;
      45                 :    8690766 :     return 0; // normal return
      46                 :            : }
      47                 :            : 
      48                 :    8449748 : void nlr_pop(void) {
      49                 :    8449748 :     nlr_buf_t **top = &MP_STATE_THREAD(nlr_top);
      50                 :    8434774 :     *top = (*top)->prev;
      51                 :    8434774 : }
      52                 :            : 
      53                 :       9756 : void nlr_push_jump_callback(nlr_jump_callback_node_t *node, nlr_jump_callback_fun_t fun) {
      54                 :       9756 :     nlr_jump_callback_node_t **top = &MP_STATE_THREAD(nlr_jump_callback_top);
      55                 :       9755 :     node->prev = *top;
      56                 :       9755 :     node->fun = fun;
      57                 :       9755 :     *top = node;
      58                 :       9755 : }
      59                 :            : 
      60                 :       9758 : void nlr_pop_jump_callback(bool run_callback) {
      61                 :       9758 :     nlr_jump_callback_node_t **top = &MP_STATE_THREAD(nlr_jump_callback_top);
      62                 :       9758 :     nlr_jump_callback_node_t *cur = *top;
      63                 :       9758 :     *top = (*top)->prev;
      64         [ +  + ]:       9758 :     if (run_callback) {
      65                 :       8182 :         cur->fun(cur);
      66                 :            :     }
      67                 :       9757 : }
      68                 :            : 
      69                 :            : // This function pops and runs all callbacks that were registered after `nlr`
      70                 :            : // was pushed (via nlr_push).  It assumes:
      71                 :            : //  - a descending C stack,
      72                 :            : //  - that all nlr_jump_callback_node_t's in the linked-list pointed to by
      73                 :            : //    nlr_jump_callback_top are on the C stack
      74                 :            : // It works by popping each node in turn until the next node is NULL or above
      75                 :            : // the `nlr` pointer on the C stack (and so pushed before `nlr` was pushed).
      76                 :     229493 : void nlr_call_jump_callbacks(nlr_buf_t *nlr) {
      77                 :     229493 :     nlr_jump_callback_node_t **top = &MP_STATE_THREAD(nlr_jump_callback_top);
      78   [ +  +  +  + ]:     230267 :     while (*top != NULL && (void *)*top < (void *)nlr) {
      79                 :        774 :         nlr_pop_jump_callback(true);
      80                 :            :     }
      81                 :     229493 : }
      82                 :            : 
      83                 :            : #if MICROPY_ENABLE_VM_ABORT
      84                 :            : NORETURN void nlr_jump_abort(void) {
      85                 :            :     MP_STATE_THREAD(nlr_top) = MP_STATE_VM(nlr_abort);
      86                 :            :     nlr_jump(NULL);
      87                 :            : }
      88                 :            : #endif