【问题标题】:Executing the assembly generated by Numba执行 Numba 生成的程序集
【发布时间】:2020-08-23 22:56:00
【问题描述】:

在一个奇怪的事件中,我最终陷入了以下困境,我使用以下 Python 代码将 Numba 生成的程序集写入文件:

@jit(nopython=True, nogil=True)
def six():
    return 6

with open("six.asm", "w") as f:
    for k, v in six.inspect_asm().items():
        f.write(v)

汇编代码已成功写入文件,但我不知道如何执行它。我尝试了以下方法:

$ as -o six.o six.asm
$ ld six.o -o six.bin
$ chmod +x six.bin
$ ./six.bin

但是,链接步骤失败并显示以下内容:

ld: warning: cannot find entry symbol _start; defaulting to 00000000004000f0
six.o: In function `cpython::__main__::six$241':
<string>:(.text+0x20): undefined reference to `PyArg_UnpackTuple'
<string>:(.text+0x47): undefined reference to `PyEval_SaveThread'
<string>:(.text+0x53): undefined reference to `PyEval_RestoreThread'
<string>:(.text+0x62): undefined reference to `PyLong_FromLongLong'
<string>:(.text+0x74): undefined reference to `PyExc_RuntimeError'
<string>:(.text+0x88): undefined reference to `PyErr_SetString'

我怀疑 Numba 和/或 Python 标准库需要动态链接到生成的目标文件才能成功运行,但我不确定如何完成(如果它甚至可以完成首先)。

我还尝试了以下方法,将中间 LLVM 代码写入文件而不是程序集:

with open("six.ll", "w") as f:
    for k, v in six.inspect_llvm().items():
        f.write(v)

然后

$ lli six.ll

但这也失败了,并出现以下错误:

'main' function not found in module.

更新:

事实证明,有一个实用程序可以找到相关标志以传递给ld 命令以动态链接 Python 标准库。

$ python3-config --ldflags

返回

-L/Users/rayan/anaconda3/lib/python3.7/config-3.7m-darwin -lpython3.7m -ldl -framework CoreFoundation 

再次运行以下命令,这次使用正确的标志:

$ as -o six.o six.asm
$ ld six.o -o six.bin -L/Users/rayan/anaconda3/lib/python3.7/config-3.7m-darwin -lpython3.7m -ldl -framework CoreFoundation 
$ chmod +x six.bin
$ ./six.bin

我现在得到了

ld: warning: No version-min specified on command line
ld: entry point (_main) undefined. for inferred architecture x86_64

我尝试在程序集文件中添加_main 标签,但这似乎没有任何作用。关于如何定义入口点的任何想法?

更新 2:

这是有用的汇编代码,目标函数似乎是带有标签_ZN8__main__7six$241E的函数:

    .text
    .file   "<string>"
    .globl  _ZN8__main__7six$241E
    .p2align    4, 0x90
    .type   _ZN8__main__7six$241E,@function
_ZN8__main__7six$241E:
    movq    $6, (%rdi)
    xorl    %eax, %eax
    retq
.Lfunc_end0:
    .size   _ZN8__main__7six$241E, .Lfunc_end0-_ZN8__main__7six$241E

    .globl  _ZN7cpython8__main__7six$241E
    .p2align    4, 0x90
    .type   _ZN7cpython8__main__7six$241E,@function
_ZN7cpython8__main__7six$241E:
    .cfi_startproc
    pushq   %rax
    .cfi_def_cfa_offset 16
    movq    %rsi, %rdi
    movabsq $.const.six, %rsi
    movabsq $PyArg_UnpackTuple, %r8
    xorl    %edx, %edx
    xorl    %ecx, %ecx
    xorl    %eax, %eax
    callq   *%r8
    testl   %eax, %eax
    je  .LBB1_3
    movabsq $_ZN08NumbaEnv8__main__7six$241E, %rax
    cmpq    $0, (%rax)
    je  .LBB1_2
    movabsq $PyEval_SaveThread, %rax
    callq   *%rax
    movabsq $PyEval_RestoreThread, %rcx
    movq    %rax, %rdi
    callq   *%rcx
    movabsq $PyLong_FromLongLong, %rax
    movl    $6, %edi
    popq    %rcx
    .cfi_def_cfa_offset 8
    jmpq    *%rax
.LBB1_2:
    .cfi_def_cfa_offset 16
    movabsq $PyExc_RuntimeError, %rdi
    movabsq $".const.missing Environment", %rsi
    movabsq $PyErr_SetString, %rax
    callq   *%rax
.LBB1_3:
    xorl    %eax, %eax
    popq    %rcx
    .cfi_def_cfa_offset 8
    retq
.Lfunc_end1:
    .size   _ZN7cpython8__main__7six$241E, .Lfunc_end1-_ZN7cpython8__main__7six$241E
    .cfi_endproc

    .globl  cfunc._ZN8__main__7six$241E
    .p2align    4, 0x90
    .type   cfunc._ZN8__main__7six$241E,@function
cfunc._ZN8__main__7six$241E:
    movl    $6, %eax
    retq
.Lfunc_end2:
    .size   cfunc._ZN8__main__7six$241E, .Lfunc_end2-cfunc._ZN8__main__7six$241E

    .type   _ZN08NumbaEnv8__main__7six$241E,@object
    .comm   _ZN08NumbaEnv8__main__7six$241E,8,8
    .type   .const.six,@object
    .section    .rodata,"a",@progbits
.const.six:
    .asciz  "six"
    .size   .const.six, 4

    .type   ".const.missing Environment",@object
    .p2align    4
.const.missing Environment:
    .asciz  "missing Environment"
    .size   ".const.missing Environment", 20


    .section    ".note.GNU-stack","",@progbits

【问题讨论】:

  • 我能问一下如何你最终需要这样做吗? :D
  • 我必须承认,这听起来很危险,而且充满了极端情况。
  • 您收到main not defined 错误,因为您需要一个入口点。 numba 所做的是,它生成 asm,然后用 ctypes 包装它——所以 numba 不需要在那里定义 main。长话短说,没有入口点你的asm 是没有用的,除非你用ctypes 包装它,或者你做一些事情,比如将它与具有入口点(main) 的C 程序链接。
  • 您发布的汇编代码看起来不像一个完整的程序。相反,它看起来像是可以用作程序一部分的单个函数。当您将此代码作为程序执行时,您期望会发生什么?

标签: python assembly linker numba


【解决方案1】:

在浏览[PyData.Numba]: Numba docs,以及一些调试、试验和错误之后,我得出了一个结论:你似乎偏离了你的追求的道路(正如在厘米)。

NumbaPython 代码(函数)转换为机器代码(原因很明显:速度)。它在运行过程中执行所有操作(转换、构建、插入到运行过程中),程序员只需将函数修饰为 例如 @numba.jit ([PyData.Numba]: Just-in-Time compilation)。

您遇到的行为是正确的Dispatcher 对象(用于装饰 six 函数)只为函数本身生成(汇编)代码(那里没有 main,因为代码正在当前进程中执行(Python 解释器的 main 函数)。因此,链接器抱怨没有 main 符号是正常的。这就像写一个 C 文件,只包含:

int six() {
    return 6;
}

为了让事情正常工作,您必须:

  1. .asm 文件构建成 .o(对象)文件(完成)

  2. #1. 中的 .o 文件包含到一个库中,该库可以是

    • 静态
    • 动态


    该库将在(最终)可执行文件中链接。此步骤是可选的,因为您可以直接使用 .o 文件

  3. 构建另一个定义 main 的文件(并调用 six - 我认为这是整个目的)到 .o 文件中。由于我对汇编不是很满意,所以我用 C

    编写了它
  4. 将 2 个实体(来自 #2. (#1.) 和 #3.)链接在一起

作为替代方案,您可以查看[PyData.Numba]: Compiling code ahead of time,但请记住,它会生成一个Python(扩展)模块。

回到当前的问题。在 Ubuntu 18.04 64bit 上进行了测试。

code00.py

#!/usr/bin/env python

import sys
import math
import numba


@numba.jit(nopython=True, nogil=True)
def six():
    return 6


def main(*argv):
    six()  # Call the function(s), otherwise `inspect_asm()` would return empty dict
    speed_funcs = [
        (six, numba.int32()),
    ]
    for func, _ in speed_funcs:
        file_name_asm = "numba_{0:s}_{1:s}_{2:03d}_{3:02d}{4:02d}{5:02d}.asm".format(func.__name__, sys.platform, int(round(math.log2(sys.maxsize))) + 1, *sys.version_info[:3])
        asm = func.inspect_asm()
        print("Writing to {0:s}:".format(file_name_asm))
        with open(file_name_asm, "wb") as fout:
            for k, v in asm.items():
                print("    {0:}".format(k))
                fout.write(v.encode())


if __name__ == "__main__":
    print("Python {0:s} {1:d}bit on {2:s}\n".format(" ".join(item.strip() for item in sys.version.split("\n")), 64 if sys.maxsize > 0x100000000 else 32, sys.platform))
    main(*sys.argv[1:])
    print("\nDone.")

main00.c

#include <stdio.h>
#include <dlfcn.h>

//#define SYMBOL_SIX "_ZN8__main__7six$241E"
#define SYMBOL_SIX "cfunc._ZN8__main__7six$241E"

typedef int (*SixFuncPtr)();

int main() {
    void *pMod = dlopen("./libnumba_six_linux.so", RTLD_LAZY);
    if (!pMod) {
        printf("Error (%s) loading module\n", dlerror());
        return -1;
    }
    SixFuncPtr pSixFunc = dlsym(pMod, SYMBOL_SIX);
    if (!pSixFunc)
    {
        printf("Error (%s) loading function\n", dlerror());
        dlclose(pMod);
         return -2;
    }
    printf("six() returned: %d\n", (*pSixFunc)());
    dlclose(pMod);
    return 0;
}

build.sh

CC=gcc

LIB_BASE_NAME=numba_six_linux

FLAG_LD_LIB_NUMBALINUX="-Wl,-L. -Wl,-l${LIB_BASE_NAME}"
FLAG_LD_LIB_PYTHON="-Wl,-L/usr/lib/python3.7/config-3.7m-x86_64-linux-gnu -Wl,-lpython3.7m"

rm -f *.asm *.o *.a *.so *.exe

echo Generate .asm
python3 code00.py

echo Assemble
as -o ${LIB_BASE_NAME}.o ${LIB_BASE_NAME}_064_030705.asm

echo Link library
LIB_NUMBA="./lib${LIB_BASE_NAME}.so"
#ar -scr ${LIB_NUMBA} ${LIB_BASE_NAME}.o
${CC} -o ${LIB_NUMBA} -shared ${LIB_BASE_NAME}.o ${FLAG_LD_LIB_PYTHON}

echo Dump library contents
nm -S ${LIB_NUMBA}
#objdump -t ${LIB_NUMBA}

echo Compile and link executable
${CC} -o main00.exe main00.c -ldl

echo Exit script

输出

(py_venv_pc064_03.07.05_test0) [cfati@cfati-ubtu-18-064-00:~/Work/Dev/StackOverflow/q061678226]> ~/sopr.sh
*** Set shorter prompt to better fit when pasted in StackOverflow (or other) pages ***

[064bit prompt]>
[064bit prompt]> ls
build.sh  code00.py  main00.c
[064bit prompt]>
[064bit prompt]> ./build.sh
Generate .asm
Python 3.7.5 (default, Nov  7 2019, 10:50:52) [GCC 8.3.0] 64bit on linux

Writing to numba_six_linux_064_030705.asm:
    ()

Done.
Assemble
Link library
Dump library contents
0000000000201020 B __bss_start
00000000000008b0 0000000000000006 T cfunc._ZN8__main__7six$241E
0000000000201020 0000000000000001 b completed.7698
00000000000008e0 0000000000000014 r .const.missing Environment
00000000000008d0 0000000000000004 r .const.six
                 w __cxa_finalize
0000000000000730 t deregister_tm_clones
00000000000007c0 t __do_global_dtors_aux
0000000000200e58 t __do_global_dtors_aux_fini_array_entry
0000000000201018 d __dso_handle
0000000000200e60 d _DYNAMIC
0000000000201020 D _edata
0000000000201030 B _end
00000000000008b8 T _fini
0000000000000800 t frame_dummy
0000000000200e50 t __frame_dummy_init_array_entry
0000000000000990 r __FRAME_END__
0000000000201000 d _GLOBAL_OFFSET_TABLE_
                 w __gmon_start__
00000000000008f4 r __GNU_EH_FRAME_HDR
00000000000006f0 T _init
                 w _ITM_deregisterTMCloneTable
                 w _ITM_registerTMCloneTable
                 U PyArg_UnpackTuple
                 U PyErr_SetString
                 U PyEval_RestoreThread
                 U PyEval_SaveThread
                 U PyExc_RuntimeError
                 U PyLong_FromLongLong
0000000000000770 t register_tm_clones
0000000000201020 d __TMC_END__
0000000000201028 0000000000000008 B _ZN08NumbaEnv8__main__7six$241E
0000000000000820 0000000000000086 T _ZN7cpython8__main__7six$241E
0000000000000810 000000000000000a T _ZN8__main__7six$241E
Compile and link executable
Exit script
[064bit prompt]>
[064bit prompt]> ls
build.sh  code00.py  libnumba_six_linux.so  main00.c  main00.exe  numba_six_linux_064_030705.asm  numba_six_linux.o
[064bit prompt]>
[064bit prompt]> # Run the executable
[064bit prompt]>
[064bit prompt]> ./main00.exe
six() returned: 6
[064bit prompt]>

同时发布(因为它很重要)numba_six_linux_064_030705.asm

    .text
    .file   "<string>"
    .globl  _ZN8__main__7six$241E
    .p2align    4, 0x90
    .type   _ZN8__main__7six$241E,@function
_ZN8__main__7six$241E:
    movq    $6, (%rdi)
    xorl    %eax, %eax
    retq
.Lfunc_end0:
    .size   _ZN8__main__7six$241E, .Lfunc_end0-_ZN8__main__7six$241E

    .globl  _ZN7cpython8__main__7six$241E
    .p2align    4, 0x90
    .type   _ZN7cpython8__main__7six$241E,@function
_ZN7cpython8__main__7six$241E:
    .cfi_startproc
    pushq   %rax
    .cfi_def_cfa_offset 16
    movq    %rsi, %rdi
    movabsq $.const.six, %rsi
    movabsq $PyArg_UnpackTuple, %r8
    xorl    %edx, %edx
    xorl    %ecx, %ecx
    xorl    %eax, %eax
    callq   *%r8
    testl   %eax, %eax
    je  .LBB1_3
    movabsq $_ZN08NumbaEnv8__main__7six$241E, %rax
    cmpq    $0, (%rax)
    je  .LBB1_2
    movabsq $PyEval_SaveThread, %rax
    callq   *%rax
    movabsq $PyEval_RestoreThread, %rcx
    movq    %rax, %rdi
    callq   *%rcx
    movabsq $PyLong_FromLongLong, %rax
    movl    $6, %edi
    popq    %rcx
    .cfi_def_cfa_offset 8
    jmpq    *%rax
.LBB1_2:
    .cfi_def_cfa_offset 16
    movabsq $PyExc_RuntimeError, %rdi
    movabsq $".const.missing Environment", %rsi
    movabsq $PyErr_SetString, %rax
    callq   *%rax
.LBB1_3:
    xorl    %eax, %eax
    popq    %rcx
    .cfi_def_cfa_offset 8
    retq
.Lfunc_end1:
    .size   _ZN7cpython8__main__7six$241E, .Lfunc_end1-_ZN7cpython8__main__7six$241E
    .cfi_endproc

    .globl  cfunc._ZN8__main__7six$241E
    .p2align    4, 0x90
    .type   cfunc._ZN8__main__7six$241E,@function
cfunc._ZN8__main__7six$241E:
    movl    $6, %eax
    retq
.Lfunc_end2:
    .size   cfunc._ZN8__main__7six$241E, .Lfunc_end2-cfunc._ZN8__main__7six$241E

    .type   _ZN08NumbaEnv8__main__7six$241E,@object
    .comm   _ZN08NumbaEnv8__main__7six$241E,8,8
    .type   .const.six,@object
    .section    .rodata,"a",@progbits
.const.six:
    .asciz  "six"
    .size   .const.six, 4

    .type   ".const.missing Environment",@object
    .p2align    4
".const.missing Environment":
    .asciz  "missing Environment"
    .size   ".const.missing Environment", 20


    .section    ".note.GNU-stack","",@progbits

注意事项

  • numba_six_linux_064_030705.asm(以及从它派生的所有内容)包含 six 函数的代码。其实有一堆符号(在OSX上,你也可以使用原生的otool -T),比如:

    1. cfunc._ZN8__main__7six$241E - (C) 函数本身

    2. _ZN7cpython8__main__7six$241E - Python 包装器:

      1. 执行 C Python 转换(通过 Python API 函数,如 PyArg_UnpackTuple
      2. 由于 #1. 它需要(取决于)libpython3.7m
      3. 因此,nopython=True 在这种情况下无效

    此外,这些符号中的 main 部分不是指可执行入口点(main 函数),而是指 Python 模块的顶级命名空间 (__main__)。毕竟,这段代码应该是从 Python

    运行的
  • 由于 C 普通函数的名称中包含 dot (.),我不能直接从 C 调用它(因为它是一个无效的标识符名称),所以我必须 load.so 和) 手动调用函数 (dlopen / dlsym),导致代码比简单调用函数更多。
    我没有尝试过,但我认为对生成的 .asm 文件进行以下(手动)更改会简化工作:

    • 重命名普通的 C 函数名(改名为 __six 或任何其他有效的 C 标识符,且不会与另一个标识符冲突(显式或内部)名称)在 .asm 文件中组装它之前,会使函数直接从 C 调用
    • 删除 Python 包装器 (#2.) 也会删除 #22.


更新#0

感谢@PeterCordes,他分享了我遗漏的确切信息 ([GNU.GCC]: Controlling Names Used in Assembler Code),这是一个更简单的版本。

main01.c

#include <stdio.h>

extern int six() asm ("cfunc._ZN8__main__7six$241E");

int main() {
    printf("six() returned: %d\n", six());
}

输出

[064bit prompt]> # Resume from previous point + main01.c
[064bit prompt]>
[064bit prompt]> ls
build.sh  code00.py  libnumba_six_linux.so  main00.c  main00.exe  main01.c  numba_six_linux_064_030705.asm  numba_six_linux.o
[064bit prompt]>
[064bit prompt]> ar -scr libnumba_six_linux.a numba_six_linux.o
[064bit prompt]>
[064bit prompt]> gcc -o main01.exe main01.c ./libnumba_six_linux.a -Wl,-L/usr/lib/python3.7/config-3.7m-x86_64-linux-gnu -Wl,-lpython3.7m
[064bit prompt]>
[064bit prompt]> ls
build.sh  code00.py  libnumba_six_linux.a  libnumba_six_linux.so  main00.c  main00.exe  main01.c  main01.exe  numba_six_linux_064_030705.asm  numba_six_linux.o
[064bit prompt]>
[064bit prompt]> ./main01.exe
six() returned: 6
[064bit prompt]>

【讨论】:

  • GNU C 扩展可以绕过 asm 名称中的 .:将其声明为 void foo(stuff) asm("foo.bar") 以将 asm 符号名称与常规规则分开设置:gcc.gnu.org/onlinedocs/gcc/Asm-Labels.html。应该与 GCC/clang/ICC 一起使用。或者是的,更改 asm 源文件以在任何地方将 foo.bar 替换为 foo_bar 也应该有效。 (不仅在标签上,还在.globl foo.bar 指令和其他参考资料上。)
  • @PeterCordes:我搜索了大约一个小时!试一试。谢谢!!! :)
  • 请注意,以_Z 开头的符号会按照 GNU C++ ABI 约定进行修改。例如_ZN7cpython8__main__7six$241E 将分解为cpython::__main__::six$241。标识符中仍然有一个美元符号 ($),但至少一些 C++ 编译器允许它作为扩展名。顺便提一句。请不要创建“更新”或“编辑”部分,只需将您的添加和更正合并到您的帖子中,就好像它们一直在那里一样。任何想查看您的帖子如何更改的人都可以查看编辑历史记录。
  • 有点惊讶它在没有初始化 Python 解释器的情况下工作,如果没有它最终会出现问题。
  • @ead:不是真的。我调用了简单的 C 函数(如果您查看程序集,它只有 3 条指令长)。因此没有调用 Python API 函数,因此不需要 Py_Initialize*
猜你喜欢
  • 1970-01-01
  • 2021-02-14
  • 1970-01-01
  • 2017-04-29
  • 2010-10-17
  • 1970-01-01
  • 1970-01-01
  • 2017-06-11
  • 1970-01-01
相关资源
最近更新 更多