python - 如何将 C 函数编译成 numpy ufunc 并动态加载它？

Question

我有一些自动生成 C 函数的 Python 代码。此函数将一些 double 作为输入并返回一个 double ，并在此过程中调用 C 标准库中的各种函数。

我想用它做的一件事是将它编译成一个 numpy ufunc 并将它加载到正在运行的 Python 进程中。我只希望该函数以合理的速度在其输入 numpy 数组上按元素运行，例如 numpy 的 minimum。

令我惊讶的是，我找不到明确的说明或示例如何执行此操作。 Numpy 有关于编写扩展的明确说明，但不清楚如何将它们加载到当前的 Python 进程中。使用 ctypes 我可以编译我的函数并加载它，没问题，但不清楚如何使它成为一个 ufunc 而不是一个普通的 Python 函数。 Cython 也可以做到这一点，如果我使用 pyximport，它甚至会为我构建共享库，这是理想的，因为这样我就可以分发它而不必担心如何在另一个系统上构建 C 代码。但是同样不清楚如何制作 ufunc 而不是普通函数。

TL;DR:我怎样才能将一个简单的 C 函数编译成一个 ufunc，然后动态加载它？越简单，样板越少越好。

Answer 1

一个想法可能是将 numba 用于 creating ufuncs和 cffi用于编译 C 代码。

例如，如果我们想将 numpy 数组中每个元素的值加倍，即将以下 C 函数作为字符串:

double f(double a){
    return 2.0*a;
}

一个可能的解决方案是以下原型(prototype):

import numba as nb
import cffi

def create_ufunc(code):
    # 1. step: compile the C-code and load the resulting extension
    ffibuilder = cffi.FFI()
    ffibuilder.cdef("double f(double a);", override=True)
    built_module=ffibuilder.verify(source=code)
    fun = built_module.f

    # 2. step: create an ufunc out of the compiled C-function
    @nb.vectorize([nb.float64(nb.float64)])
    def f(x):
      return fun(x)
    return f

现在:

import numpy as np
a=np.arange(6).astype(np.float64)
my_f1=create_ufunc("double f(double a){return 2.0*a;}")
my_f1(a)
# array([  0.,   2.,   4.,   6.,   8.,  10.])

或者如果我们想乘以 10.0 :

my_f2=create_ufunc("double f(double a){return 10.0*a;}")
# array([  0.,  10.,  20.,  30.,  40.,  50.])

显然，在展示可能性的同时，这个原型(prototype)还需要一些润色。例如虽然紧凑， verify 已弃用并调用 create_ufunc两次使用相同的代码将导致警告。

另一个问题:尽管 cffi-functions are supported by numba 没有在 nopython 模式下编译以上版本。 .不确定这里出了什么问题？请参阅下面的解决方法:以 nopython 模式构建的更复杂的版本。

但是，这可能仍然是一个很好的起点。

---

如果我们使用 out-of-line，似乎可以在 nopython 模式下编译 numba ( compile ) 而不是 in-line ( verify ) API 模式:

import numba as nb
import cffi
import zlib
import importlib
import numba.cffi_support as nbcffi

def create_ufunc(code):
    # 1. step: compile the C-code and load the resulting extension
    # create a different so/dll for different codes
    # and load it
    module_name="myufunc"+str(zlib.adler32(code.encode('ascii')))
    ffibuilder = cffi.FFI()
    ffibuilder.cdef("double f(double a);", override=True)
    ffibuilder.set_source(module_name=module_name,source=code)
    ffibuilder.compile(verbose=True)
    loaded = importlib.import_module(module_name)


    # 2. step: create an ufunc out of the compiled C-function
    # out-of-line modules must be registered in numba:      
    nbcffi.register_module(loaded)
    fun = loaded.lib.f

    @nb.vectorize([nb.float64(nb.float64)], nopython=True)
    def f(x):
      return fun(x)
    return f

重要细节:

• 每个code 都有一个新的扩展名(so/pyd 文件) .我们通过传递的 code 的哈希值来区分它们.
• 随着时间的推移会有相当多的myufuncXXXX.so - 周围的文件，可以考虑实现类似于 cffi.verify 使用的基础设施.
• ffibuilder.compile(verbose=True)仅用于调试目的，可能是 verbose=False在发布时更有意义。