调用C和Fortran代码

可以将Julia函数传递给接受函数指针参数的本机C函数。 例如，要匹配表单的c原型:

宏 @cfunction为调用Julia函数生成与C兼容的函数指针。 的论点 @cfunction是:

一个典型的例子是标准C库 qsort,qsort 函数，声明为:

该 基地 参数是指向长度数组的指针 n.尼特斯，与元素 大小 个字节。 比较一下 是一个回调函数，它接受指向两个元素的指针 a 和 b 并返回一个整数小于/大于零，如果 a 应该出现在之前/之后 b （如果允许任何订单，则为零）。

现在，假设我们有一个1-d数组 A 我们要使用Julia中的值进行排序 qsort,qsort 功能（而不是Julia的内置 排序 功能）。 在我们考虑打电话之前 qsort,qsort 和传递参数，我们需要写一个比较函数:

qsort,qsort 期望一个返回C的比较函数 int型，所以我们将返回类型注释为 辛特.

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

@cfunction需要三个参数：Julia函数（[医]麦康柏），返回类型（辛特），以及输入参数类型的字面元组，在这种情况下对 Cdouble/Cdouble (漂浮64)元素。

最后的召唤 qsort,qsort 看起来像这样:

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

为了好玩，尝试插入一个 println("mycompare($a,b b)") 排队进入 [医]麦康柏，这将让你看到比较 qsort,qsort 正在执行（并验证它是否真的在调用您传递给它的Julia函数）。

将声明的C类型与其在Julia中的声明完全匹配至关重要。 不一致会导致在一个系统上正常工作的代码失败或在另一个系统上产生不确定的结果。

请注意，在调用C函数的过程中，任何地方都没有使用C头文件：您有责任确保您的Julia类型和调用签名准确地反映C头文件中的那些。脚注：2[Clang包可用于从C头文件自动生成Julia代码。]

让我们从一个简单的C包装器的例子开始，它返回一个 Ptr 类型:

该https://www.gnu.org/software/gsl/[GNU科学图书馆]（这里假设可以通过 ：libgsl)定义不透明指针, gsl_截肢 *，作为C函数的返回类型 gsl_permutation_alloc. 由于用户代码永远不必查看 gsl_截肢 struct，相应的Julia包装器只需要一个新的类型声明, gsl_截肢，它没有内部字段，其唯一目的是放在a的类型参数中 Ptr 类型。 的返回类型 ccall声明为 Ptr{gsl_permutation}，由于由分配和指向的内存 输出_ptr 被C控制。

输入 n 通过值传递，因此函数的输入签名被简单地声明为 :：Csize_t 没有任何 参考书 或 Ptr 有必要。 （如果包装器调用的是Fortran函数，则相应的函数输入签名将是 ::Ref{Csize_t}，因为Fortran变量是通过指针传递的。)此外, n 可以是可转换为 Csize_t 整数； ccall隐式调用 基地。cconvert（Csize_t，n）.

下面是包装相应析构函数的第二个例子:

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

C函数wrapped返回一个整数错误代码;bessel J函数的实际评估结果填充Julia数组 结果_阵列. 此变量声明为 参考{Cdouble}，因为它的内存是由Julia分配和管理的。 隐式调用 基地。cconvert(Ref{Cdouble},result_array)将指向Julia数组数据结构的Julia指针解压缩为C可以理解的形式。

以下示例使用 ccall 调用通用Fortran库（libBLAS）中的函数来计算点积。 请注意，这里的参数映射与上面的有点不同，因为我们需要从Julia映射到Fortran。 在每个参数类型上，我们指定 参考书 或 Ptr. 此mangling约定可能特定于您的Fortran编译器和操作系统，并且可能未记录。 但是，将每个包裹在 参考书 （或 Ptr，其中等价）是Fortran编译器实现的常见要求:

当将数据传递给 @ccall，最好避免使用 指针功能。 而是定义一个 基地。[医转换]方法并将变量直接传递给 @ccall. @ccall 自动安排它的所有参数将从垃圾回收中保留，直到调用返回。 如果C API将存储对Julia分配的内存的引用，则在 @ccall 返回，您必须确保对象对垃圾回收器保持可见。 建议的方法是创建一个类型的全局变量 向量{Ref} 以保持这些值，直到C库通知您完成它们。

每当您创建了一个指向Julia数据的指针时，您必须确保原始数据存在，直到您完成使用该指针。 Julia中的许多方法如 卸载/卸载和 字符串制作数据副本，而不是获取缓冲区的所有权，以便在不影响Julia的情况下释放（或更改）原始数据是安全的。 一个值得注意的例外是 unsafe_wrap出于性能原因，共享（或可以被告知获得所有权）基础缓冲区。

垃圾回收器不保证任何定稿顺序。 也就是说，如果 a 载有对 b 两者兼而有之 a 和 b 是由于垃圾收集，没有保证 b 将在之后最终确定 a. 如果适当的定稿 a 取决于 b 为有效，则必须以其他方式处理。

在某些情况下，所需库的确切名称或路径并不预先知道，必须在运行时计算。 为了处理这种情况，库组件规范可以是函数调用，例如 find_blas()。dgemm. 调用表达式将在 ccall 本身被执行。 然而，假定库位置一旦确定就不改变，因此调用的结果可以被缓存和重用。 因此，表达式执行的次数是未指定的，并且为多个调用返回不同的值会导致未指定的行为。

如果需要更大的灵活性，可以通过以下方式使用计算值作为函数名 埃瓦尔如下:

此表达式使用 字符串，然后将此名称替换为新的 @ccall 表达式，然后对其进行评估。 记住这一点 埃瓦尔 仅在顶层操作，因此在此表达式中，局部变量将不可用（除非它们的值被替换为 $). 为此原因, 埃瓦尔 通常仅用于形成顶级定义，例如在包装包含许多类似函数的库时。 类似的例子可以被构造用于 @cfunction.

但是，这样做也会非常缓慢并泄漏内存，因此您通常应该避免这种情况，而是继续阅读。 下一节讨论如何使用间接调用来有效地实现类似的效果。

第一个论点 @ccall 也可以是运行时计算的表达式。 在这种情况下，表达式必须计算为 Ptr，其将作为本机函数的地址来调用。 此行为发生在第一 @ccall argument包含对非常量的引用，例如局部变量、函数参数或非常量全局变量。

例如，您可以通过以下方式查找函数 [医]dlsym，然后将其缓存在该会话的共享引用中。 例如:

第一个论点 @cfunction可以用一个 $，在这种情况下，返回值将改为 结构,结构 这结束了争论。 您必须确保此返回对象保持活动状态，直到完成对其的所有使用。 Cfunction指针上的内容和代码将通过 终结器,终结器当这个引用被删除和atexit。 这通常是不需要的，因为这个功能在C中不存在，但是对于处理不提供单独闭包环境参数的设计不良的Api很有用。

有时关闭（卸载）库以便可以重新加载它是有用的。 例如，在开发与Julia一起使用的C代码时，可能需要编译，从Julia调用C代码，然后关闭库，进行编辑，重新编译并加载新的更改。 可以重新启动Julia或使用 Libdl的 显式管理库的函数，例如:

注意使用时 @ccall 与输入（例如, @ccall"。/my_lib.so".my_fcn(...)::Cvoid），库是隐式打开的，可能不会显式关闭。

调用变分C函数a 分号 可以在参数列表中用于将所需参数与可变参数分开。 一个例子与 printf打印 功能如下所示:

还有另一种替代接口 @ccall. 这个接口稍微不太方便，但它确实允许一个人指定一个 调用约定。

的论点 ccall是:

下面给出了宏和函数接口之间的转换表。

第二个论点 ccall （紧接在返回类型之前）可以选择是调用约定说明符（ @ccall 宏目前不支持给出调用约定）。 如果没有任何说明符，则使用平台默认的c调用约定。 其他支持的约定有: stdcall, cdecl, 快车道，而 这个球 （64位Windows上的no-op）。 例如（从 基/libc。jl 我们看到的是一样的 [医]盖斯特名``ccall 如上所述，但具有适用于Windows的正确签名:

如需更多资料，请参阅https://llvm.org/docs/LangRef.html#calling-conventions[LLVM语言参考]。

还有一个额外的特殊调用约定 n.有限责任公司，它允许直接插入对LLVM内部函数的调用。 这在针对Gpgpu等不寻常平台时特别有用。 例如，对于https://llvm.org/docs/NVPTXUsage.html[CUDA]，我们需要能够读取线程索引:

与任何 ccall，获得参数签名完全正确至关重要。 另外，请注意，不像下面公开的等效Julia函数那样，没有兼容层可以确保内部有意义并在当前目标上工作 核心。内在函数.

本地库导出的全局变量可以使用 [医全球]功能。 的论点 [医全球]是与所使用的符号规范相同的符号规范 ccall，以及描述存储在变量中的值的类型:

结果是一个指针给出值的地址。 该值可以通过此指针操作，使用 卸载/卸载和 unsafe_store！.

以下方法被描述为"不安全"，因为错误的指针或类型声明可能导致Julia突然终止。

给定一个 Ptr{T}，类型的内容 T 通常可以从引用的内存复制到Julia对象中，使用 unsafe_load(ptr,[索引]). 索引参数是可选的（默认值为1），并遵循基于1的索引的Julia约定。 此函数故意类似于 getindex,getindex和 setindex！（例如 [] 访问语法）。

返回值将是一个初始化为包含引用内存内容副本的新对象。 引用的内存可以安全地释放或释放。

如果 T 是 任何，则假设内存包含对Julia对象的引用（a jl_value_t*），结果将是对此对象的引用，并且不会复制该对象。 在这种情况下，您必须小心，以确保该对象始终对垃圾回收器可见（指针不计算在内，但新引用不计算在内），以确保内存不会过早释放。 请注意，如果对象最初不是由Julia分配的，那么新对象将永远不会被Julia的垃圾收集器最终确定。 如果 Ptr 本身实际上是一个 jl_value_t*，它可以通过以下方式转换回Julia对象引用 unsafe_pointer_to_objref（ptr）. （朱莉娅价值观 v 可以转换为 jl_value_t* 指针，如 Ptr{Cvoid}，通过调用 pointer_from_objref（v）.)

反向操作（将数据写入 Ptr{T}），可以使用 unsafe_store！(ptr,值,[索引]). 目前，这只支持原始类型或其他无指针（轨道,轨道）不可变的结构类型。

任何引发错误的操作可能目前都没有实现，应该作为一个错误发布，以便可以解决它。

如果感兴趣的指针是纯数据数组（原始类型或不可变结构），则函数 unsafe_wrap(Array,ptr,dims,own=false)可能更有用。 如果Julia应该"拥有"底层缓冲区并调用，则最终参数应该为true 免费(ptr) 当返回 阵列 对象最终确定。 如果 自己的 参数被省略或为false，调用方必须确保缓冲区保持存在，直到所有访问完成。

算术上的 Ptr 输入Julia（例如使用 +）的行为与C的指针算术不同。 将整数添加到a Ptr 在Julia中，指针总是移动一些_bytes_，而不是元素。 这样，从指针算术获得的地址值不依赖于指针的元素类型。

一些C库从不同的线程执行它们的回调，并且由于Julia不是线程安全的，因此您需要采取一些额外的预防措施。 特别是，你需要建立一个两层的系统：C回调应该只_schedule_（通过Julia的事件循环）执行你的"真实"回调。 要做到这一点，创建一个 异步控制对象和 等等！就可以了:

你传递给C的回调应该只执行一个 ccall到 ：uv_async_send，通过 康德。手柄 作为参数，注意避免与Julia运行时的任何分配或其他交互。

请注意，事件可能会合并，因此多次调用 uv_async_发送 可能导致一个单一的唤醒通知的条件。

有关如何将回调传递给C库的更多详细信息，请参阅以下内容https://julialang.org/blog/2013/05/callback[博客文章]。

用于创建C的工具++ 绑定，请参阅https://github.com/JuliaInterop/CxxWrap.jl[CxxWrap]包。