Skip to content
Snippets Groups Projects
  • Paul Sokolovsky's avatar
    096e967a
    Revert "py/nlr: Factor out common NLR code to generic functions." · 096e967a
    Paul Sokolovsky authored
    This reverts commit 6a3a742a.
    
    The above commit has number of faults starting from the motivation down
    to the actual implementation.
    
    1. Faulty implementation.
    
    The original code contained functions like:
    
    NORETURN void nlr_jump(void *val) {
        nlr_buf_t **top_ptr = &MP_STATE_THREAD(nlr_top);
        nlr_buf_t *top = *top_ptr;
    ...
         __asm volatile (
        "mov    %0, %%edx           \n" // %edx points to nlr_buf
        "mov    28(%%edx), %%esi    \n" // load saved %esi
        "mov    24(%%edx), %%edi    \n" // load saved %edi
        "mov    20(%%edx), %%ebx    \n" // load saved %ebx
        "mov    16(%%edx), %%esp    \n" // load saved %esp
        "mov    12(%%edx), %%ebp    \n" // load saved %ebp
        "mov    8(%%edx), %%eax     \n" // load saved %eip
        "mov    %%eax, (%%esp)      \n" // store saved %eip to stack
        "xor    %%eax, %%eax        \n" // clear return register
        "inc    %%al                \n" // increase to make 1, non-local return
         "ret                        \n" // return
        :                               // output operands
        : "r"(top)                      // input operands
        :                               // clobbered registers
         );
    }
    
    Which clearly stated that C-level variable should be a parameter of the
    assembly, whcih then moved it into correct register.
    
    Whereas now it's:
    
    NORETURN void nlr_jump_tail(nlr_buf_t *top) {
        (void)top;
    
        __asm volatile (
        "mov    28(%edx), %esi      \n" // load saved %esi
        "mov    24(%edx), %edi      \n" // load saved %edi
        "mov    20(%edx), %ebx      \n" // load saved %ebx
        "mov    16(%edx), %esp      \n" // load saved %esp
        "mov    12(%edx), %ebp      \n" // load saved %ebp
        "mov    8(%edx), %eax       \n" // load saved %eip
        "mov    %eax, (%esp)        \n" // store saved %eip to stack
        "xor    %eax, %eax          \n" // clear return register
        "inc    %al                 \n" // increase to make 1, non-local return
        "ret                        \n" // return
        );
    
        for (;;); // needed to silence compiler warning
    }
    
    Which just tries to perform operations on a completely random register (edx
    in this case). The outcome is the expected: saving the pure random luck of
    the compiler putting the right value in the random register above, there's
    a crash.
    
    2. Non-critical assessment.
    
    The original commit message says "There is a small overhead introduced
    (typically 1 machine instruction)". That machine instruction is a call
    if a compiler doesn't perform tail optimization (happens regularly), and
    it's 1 instruction only with the broken code shown above, fixing it
    requires adding more. With inefficiencies already presented in the NLR
    code, the overhead becomes "considerable" (several times more than 1%),
    not "small".
    
    The commit message also says "This eliminates duplicated code.". An
    obvious way to eliminate duplication would be to factor out common code
    to macros, not introduce overhead and breakage like above.
    
    3. Faulty motivation.
    
    All this started with a report of warnings/errors happening for a niche
    compiler. It could have been solved in one the direct ways: a) fixing it
    just for affected compiler(s); b) rewriting it in proper assembly (like
    it was before BTW); c) by not doing anything at all, MICROPY_NLR_SETJMP
    exists exactly to address minor-impact cases like thar (where a) or b) are
    not applicable). Instead, a backwards "solution" was put forward, leading
    to all the issues above.
    
    The best action thus appears to be revert and rework, not trying to work
    around what went haywire in the first place.
    096e967a
    History
    Revert "py/nlr: Factor out common NLR code to generic functions."
    Paul Sokolovsky authored
    This reverts commit 6a3a742a.
    
    The above commit has number of faults starting from the motivation down
    to the actual implementation.
    
    1. Faulty implementation.
    
    The original code contained functions like:
    
    NORETURN void nlr_jump(void *val) {
        nlr_buf_t **top_ptr = &MP_STATE_THREAD(nlr_top);
        nlr_buf_t *top = *top_ptr;
    ...
         __asm volatile (
        "mov    %0, %%edx           \n" // %edx points to nlr_buf
        "mov    28(%%edx), %%esi    \n" // load saved %esi
        "mov    24(%%edx), %%edi    \n" // load saved %edi
        "mov    20(%%edx), %%ebx    \n" // load saved %ebx
        "mov    16(%%edx), %%esp    \n" // load saved %esp
        "mov    12(%%edx), %%ebp    \n" // load saved %ebp
        "mov    8(%%edx), %%eax     \n" // load saved %eip
        "mov    %%eax, (%%esp)      \n" // store saved %eip to stack
        "xor    %%eax, %%eax        \n" // clear return register
        "inc    %%al                \n" // increase to make 1, non-local return
         "ret                        \n" // return
        :                               // output operands
        : "r"(top)                      // input operands
        :                               // clobbered registers
         );
    }
    
    Which clearly stated that C-level variable should be a parameter of the
    assembly, whcih then moved it into correct register.
    
    Whereas now it's:
    
    NORETURN void nlr_jump_tail(nlr_buf_t *top) {
        (void)top;
    
        __asm volatile (
        "mov    28(%edx), %esi      \n" // load saved %esi
        "mov    24(%edx), %edi      \n" // load saved %edi
        "mov    20(%edx), %ebx      \n" // load saved %ebx
        "mov    16(%edx), %esp      \n" // load saved %esp
        "mov    12(%edx), %ebp      \n" // load saved %ebp
        "mov    8(%edx), %eax       \n" // load saved %eip
        "mov    %eax, (%esp)        \n" // store saved %eip to stack
        "xor    %eax, %eax          \n" // clear return register
        "inc    %al                 \n" // increase to make 1, non-local return
        "ret                        \n" // return
        );
    
        for (;;); // needed to silence compiler warning
    }
    
    Which just tries to perform operations on a completely random register (edx
    in this case). The outcome is the expected: saving the pure random luck of
    the compiler putting the right value in the random register above, there's
    a crash.
    
    2. Non-critical assessment.
    
    The original commit message says "There is a small overhead introduced
    (typically 1 machine instruction)". That machine instruction is a call
    if a compiler doesn't perform tail optimization (happens regularly), and
    it's 1 instruction only with the broken code shown above, fixing it
    requires adding more. With inefficiencies already presented in the NLR
    code, the overhead becomes "considerable" (several times more than 1%),
    not "small".
    
    The commit message also says "This eliminates duplicated code.". An
    obvious way to eliminate duplication would be to factor out common code
    to macros, not introduce overhead and breakage like above.
    
    3. Faulty motivation.
    
    All this started with a report of warnings/errors happening for a niche
    compiler. It could have been solved in one the direct ways: a) fixing it
    just for affected compiler(s); b) rewriting it in proper assembly (like
    it was before BTW); c) by not doing anything at all, MICROPY_NLR_SETJMP
    exists exactly to address minor-impact cases like thar (where a) or b) are
    not applicable). Instead, a backwards "solution" was put forward, leading
    to all the issues above.
    
    The best action thus appears to be revert and rework, not trying to work
    around what went haywire in the first place.