在C和Fortran中调用代码

Julia函数可以传递给将函数指针作为参数的非托管C函数。 例如，通过这种方式，您可以确保符合以下类型的原型C。

宏 `@cfunction'创建一个c兼容的函数指针来调用Julia函数。 方法 '@cfunction'具有以下参数:

一个典型的例子是来自C标准库的’qsort’函数，声明如下。

'Base’参数是指向长度为`nitems’的数组的指针，其中每个元素的大小为’size’字节。 'compare’是一个回调函数，它接受指向两个元素（a`和`b）的指针，如果元素`a`应该在元素`b`之前或之后（或者如果允许任何顺序为零），则返回大于或小于零的整数。

现在让我们假设Julia有一个值`A`的一维数组，需要使用`qsort`函数（而不是内置的Julia`sort`函数）进行排序。 在调用’qsort’并传递参数之前，您需要编写一个比较函数。:

'qsort’需要一个返回C`int’类型值的比较函数，因此我们将返回的类型注释为’Cint'。

要将此函数传递给C，我们使用宏`@cfunction`获取其地址:

宏 `@cfunction'接受三个参数：Julia函数（'mycompare'），返回类型（'Cint'`和输入参数类型的字面元组，在这种情况下用于排序类型为`Cdouble’的元素数组（'Float64')。

在最终形式中，'qsort’调用如下所示。

如示例所示，原始Julia`A`数组现在已排序。: [-2.7, 1.3, 3.1, 4.4]. 请注意，朱莉娅 执行数组转换为'Ptr{Cdouble}'，以字节为单位计算元素类型的大小等。

为了感兴趣，请尝试将字符串`println("mycompare(a a,b b)")`插入`mycompare'。 这将允许您查看’qsort’函数进行的比较（并检查它是否实际调用传递的Julia函数）。

C和Julia中的类型声明完全匹配是非常重要的。 由于不一致，在一个系统上正常工作的代码可能会失败或在另一个系统上产生不确定的结果。

请注意，在C中调用函数的过程中不使用C头文件：您负责将Julia调用的类型和签名匹配到C头文件[using https://github.com/ihnorton/Clang.jl [Clang包]，可以根据C头文件自动创建Julia代码]。

让我们从一个返回`Ptr`类型的C shell的简单示例开始:

在https://www.gnu.org/software/gsl /[GNU科学库]（这里假设它可以通过名称`：libgsl`获得）不透明指针`gsl_permutation*被定义为C函数`gsl_permutation_alloc’的返回类型。 由于用户代码不需要访问’gsl_permutation’结构，因此要实现相应的Julia shell，只需声明一个新类型`gsl_permutation`就足够了，它没有内部字段，其唯一目的是在参数中指定类型`Ptr。 对于功能 ccall'返回类型'+Ptr’已被声明{gsl_permutation}+，因为使用`output_ptr’指针分配并指向的内存区域由C环境控制。

输入参数’n`是按值传递的，因此函数输入数据的签名有一个非常简单的形式：::Csize_t'。 不需要’Ref’或’Ptr'。 （如果shell调用Fortran函数，则相应的输入数据签名将是'+::Ref{Csize_t}+，因为Fortran中的变量是通过指针传递的。）而且’n’可以具有可以转换为整数值`Csize_t’的任何类型;函数 ccall'隐式调用 '基地。cconvert(Csize_t,n)。

这里是另一个例子，这个时候对应的析构函数的shell:

下面是传递Julia数组的第三个例子:

包装函数C返回一个整数错误代码，计算Bessel函数J的结果输入Julia’result_array’数组。 此变量声明为'Ref{Cdouble}'，因为为它分配了一个内存块并由Julia代码管理。 隐性挑战 '基。cconvert(Ref{Cdouble},result_array)`将Julia指向Julia数组数据结构的指针解压缩为C可以理解的形式。

在下面的示例中，使用’ccall`，调用Fortran标准库（libBLAS）中的函数来计算标量积。 请注意，这种情况下的参数比较与上面略有不同，因为比较是从Julia到Fortran进行的。 对于每种类型的参数，都指定了’Ref’或’Ptr'。 这种转换约定可能取决于特定的Fortran编译器和操作系统，并且很可能没有反映在文档中。 但是，许多Fortran编译器实现要求将每个参数类型包含在`Ref`（或`Ptr`，如果适用）中:

将数据传输到'@ccall`时，最好不要使用该函数 '指针'。 而是定义一个方法 '基地。cconvert'并将变量直接传递给'@ccall'。 @ccall’自动保护其所有参数免受垃圾回收，直到调用返回控制权。 如果C API将存储对Julia代码分配的内存的引用，则在将控制权返回到'@ccall’调用后，必须确保垃圾收集器可以访问该对象。 推荐的方法是将这些值存储在`Array’类型的全局变量中。{Ref,1}，直到C库通知与他们的工作完成。

每当创建指向Julia数据的指针时，只要该指针正在使用，该数据就必须存在。 Julia中的许多方法，例如 "不安全负荷"及 `String'，创建数据的副本，而不是控制缓冲区。 这允许您安全地从内存中删除（或修改）源数据，以便它不会影响Julia代码的执行。 一个重要的例外是方法 'unsafe_wrap'，出于性能原因，它在共享模式下使用基本缓冲区（换句话说，控制它）。

垃圾收集器不保证对象的任何特定处理顺序。 换句话说，如果对象’a’包含对对象`b`的引用，并且两者都受到垃圾回收，则不能保证对象`b`将在`a`之后被消除。 如果对象’b’必须存在以消除对象’a'，则需要不同的方法。

在某些情况下，所需库的名称或路径事先未知，必须在运行时确定。 在这种情况下，库组件规范可以是函数调用，例如`find_blas()。dgemm'。 调用表达式将在执行`ccall`操作时执行。 然而，假定一旦库位置被确定，它就不改变，因此调用的结果可以被缓存和重用。 因此，表达式可以执行任意次数，并且返回不同的值可以给出不确定的结果。

如果需要更大的灵活性，则可以使用该函数将计算值用作函数名称 'eval'如下。

此表达式使用`string`生成名称，然后将其替换为新表达式`@ccall`，然后对其进行计算。 请注意，'eval’函数是一个高级函数，因此局部变量在此表达式中不可用（除非它们的值被`$`替换）。 出于这个原因，`eval’函数通常用于仅创建顶级定义，例如，在封装包含许多类似函数的库时。 一个类似的例子是可能的宏 '@cfunction'。

但是，这样的代码运行速度非常慢，并且存在内存泄漏，因此请尽量不要使用此选项。 下一节介绍如何使用间接调用实现相同的结果。

'@Ccall’调用中的第一个参数也可以是运行时计算的表达式。 这样一个表达式的结果应该是一个指针`Ptr'，它将被用作被调用的本机函数的地址。 当第一个参数'@ccall’包含对非常量值（如局部变量、函数参数或非常量全局变量）的引用时，会发生此行为。

例如，您可以使用`dlsym`定义函数，然后将其缓存在会话中的共享链接中。 例如:

第一个论点 '@cfunction'可以用符号`$`标记。 在这种情况下，返回值将是一个带有闭包参数的"结构CFunction"对象。 这个返回的对象必须存在，直到它的使用完成。 Cfunction指针的内容和代码将被函数销毁 `finalizer'删除此链接并退出后。 这通常不是必需的，因为在C中没有这样的功能，但是当使用设计不佳的Api时，它可能很有用，这些Api不会为闭包环境提供单独的参数。

有时关闭（卸载）库以便可以再次下载它是有用的。 例如，在编写与Julia一起使用的C代码时，您可能需要编译，从Julia调用C代码，然后关闭库，进行更改，再次编译并上传新的更改。 为此，您可以重新启动Julia，或者使用`Libdl’函数显式管理库，如下所示。

请注意，当将`@ccall’与输入数据一起使用时（例如，@ccall'。/my_lib.so ".my_fcn(...)::Cvoid)库隐式打开，可能不会显式关闭。

要使用可变数量的参数调用C函数，可以用分号（semicolon）将所需的参数与参数列表中可变数量的参数分开。 下面是调用’printf’函数的示例。

这是另一个接口，可以作为`@ccall’的替代品。 它有点不太方便，但它可以让你设置 挑战协议。

方法 'ccall'具有以下参数:

宏和函数接口之间的转换表如下所示。

'Ccall’调用的第二个参数（紧接在返回类型之前）可以是调用协议说明符（目前，@ccall`宏不允许您指定调用协议）。 如果未指定说明符，则使用平台默认采用的c调用约定。 此外，还支持以下约定’stdcall'，'cdecl，`fastcall’和’thiscall'（在64位Windows系统上无效）。 例如，这就是对`gethostname’ccall`函数的调用的样子，类似于上面的函数，但具有正确的windows签名（代码取自`base/libc。jl'):

有关详细信息，请参阅https://llvm.org/docs/LangRef.html#calling-conventions [LLVM语言参考]。

还有一个特殊的呼叫协议 'llvmcall'，它允许您直接将调用插入内部LLVM指令。 这在为gpgpu等不寻常的平台编写代码时特别有用。 例如，对于https://llvm.org/docs/NVPTXUsage.html [CUDA]您可能需要获取流索引。:

与任何ccall调用一样，获取参数的正确签名非常重要。 另外，请注意，与Core提供的Julia函数不同，没有兼容性包装器可以确保内部指令对于当前目的是正确和有效的。本征'。

本机库提供的全局变量可以使用函数按名称访问 'cglobal'。 函数参数 'cglobal'是一个符号规范（与调用相同 'ccall')和变量中存储的值的类型:

结果是指向值的地址的指针。 使用此指针，您可以使用函数对值执行操作 "不安全负荷"及 'unsafe_store！`.

下面介绍的方法是不安全的，因为不正确的指针或类型声明可能导致Julia突然停止工作。

如果指针是'Ptr{T}'，类型’T’的内容，作为一项规则，可以通过调用`unsafe load(ptr,[index])从它引用Julia对象的内存区域复制。 索引参数是可选的（默认情况下它是1），并根据Julia中采用的约定从1索引。 此函数的行为故意使其类似于函数的行为 'getindex'和 'setindex！'（例如，语法匹配[]'`。

返回一个新对象，其中包含指针引用的内存区域内容的副本。 之后，可以安全地释放此存储器区域。

如果`T’的类型是’Any'，则假定内存区域包含对Julia对象的引用（jl_value_t*'）。 结果将是对此对象的引用，并且对象本身不会被复制。 在这种情况下，有必要确保垃圾回收器可以访问该对象（不考虑指针，不像新引用），以便内存不会提前清除。 请注意：如果对象最初不是由Julia代码放置在内存中，则新对象不会被Julia垃圾回收器消除。 如果对象’Ptr’本身是’jl_value_t*'，则可以使用函数将其转换回对Julia对象的引用 'unsafe_pointer_to_objref(ptr)。 （Julia`v’值可以转换为’jl_value_t’指针*'how'Ptr{Cvoid}'通过调用 'pointer_from_objref(v’。)

反向操作（将数据写入'Ptr{T}）可以使用函数执行 'unsafe_store！(ptr,value,[index])'。 目前，此功能仅适用于没有指针（`isbits）的原始类型或其他不可变类型的结构。

如果操作返回错误，则可能尚未实现。 这应该报告，以便我们可以解决问题。

如果指针表示普通数据的数组（基元类型或不可变结构），则函数 'unsafe wrap(Array,ptr,dims,own=false)可能更有用。 如果Julia环境要监视基本缓冲区并在消除返回的`Array`对象后调用`free(ptr)，则必须将最后一个参数设置为true。 如果省略了’own’参数或将其设置为false，则调用方必须确保缓冲区在需要访问时存在。

在Julia中使用类型为`Ptr`的算术运算（例如，+）的执行方式与在c中使用指针的执行方式不同。当在Julia中向`Ptr`添加整数时，指针会移位一定数量的_bytes，而不是元素。 因此，作为具有指针的算术运算的结果而获得的地址值不依赖于指针元素的类型。

一些C库从另一个线程进行回调，并且由于Julia不是线程安全的语言，因此需要采取额外的预防措施。 特别是，您应该设置一个双层系统：C回调应该只安排执行"真正的"回调（通过Julia事件循环）。 为此，请创建一个对象 'AsyncCondition'并将函数应用于它 '等待':

传递给C的回调应该只进行调用 ccall'应用于:uv_async_send’并传递’cond。处理`作为参数。 不应该有内存分配或与Julia运行时的其他交互。

请注意，事件可以组合，以便对`uv_async_send’的多次调用可以导致激活条件的单个通知。

有关将回调传递给C库的更多信息，请参阅https://julialang.org/blog/2013/05/callback [此博客条目]。

创建c绑定的工具++ 可以在包中找到https://github.com/JuliaInterop/CxxWrap.jl [CxxWrap]。