为自定义C库分发CFFI包装器



我已经构建了一个封装自定义C代码的库,并考虑了构建作为ASDF加载一部分的共享库的最佳方法。makefile适用于各种操作系统,所以它可以像uiop:run-program ...一样简单,但我想我应该在这里问一下,是否有一个更标准的成语。

因为C代码是特定于这个应用程序的,所以它不能通过包管理器获得,必须为每个用户的机器专门构建。我很乐意为手工构建编写文档,但如果我能让用户更容易上手,我就会这么做。我注意到Python似乎有某种自动的方式来为他们的CFFI构建库,我想知道CL是否有一些东西。

对于我自己的问题的回答:似乎既没有实际的方法来做到这一点(基于对github asd文件的搜索),也没有在ASDF最佳实践中确定的方法,尽管有一些想法可以从该文档中收集。

我将把我的实现作为这个用例的建议习惯用法,以及一些可能的替代方法。希望这里的一些ASDF专家能纠正任何误解。

;; Define a makefile as a type of source file for the system
(defclass makefile (source-file) ((type :initform "m")))
;; tell ASDF how to compile it
(defmethod perform ((o load-op) (c makefile)) t)
(defmethod perform ((o compile-op) (c makefile))
(let* ((lib-dir (system-relative-pathname "cephes" "scipy-cephes"))
(lib (make-pathname :directory `(:relative ,(namestring lib-dir))
:name "libmd"
:type #+unix "so" #+(or windows win32) "dll"))
(built (probe-file (namestring lib))))
(if built
(format *error-output* "Library ~S exists, skipping build" lib)
(format *error-output* "Building ~S~%" lib))
(unless built
(run-program (format nil "cd ~S && make" (namestring lib-dir)) :output t))))
(defsystem "cephes"
:description "Wrapper for the Cephes Mathematical Library"
:version      (:read-file-form "version.sexp")
:license "MS-PL"
:depends-on ("cffi")
:serial t
:components ((:module "libmd"
:components ((:makefile "makefile")))
(:file "package")
(:file "init")
(:file "cephes")))

这在MS Windows和UNIX上都可以正常工作。在perform中添加一个方法似乎是github上最常见的方法。

另一种选择可能是使用build-op,如构建系统中所述。描述

一些系统提供的操作在当前没有加载图像,而不是测试。系统要使用的任何操作与,你可以这样使用:

(asdf:: foobar)

这将调用build-op,而build-op又依赖于系统的构建操作(如果有定义),或者加载操作(如果没有定义)。因此,对于希望您加载它们的普通Lisp系统,以上将等同于(asdf:load-system:foobar),但对于其他Lisp系统,例如创建shell命令行可执行文件的系统,(asdf:make…)会做正确的事,不管那是什么正确的事是。

向我建议,这与构建C库的想法相当接近,并且它可以很好地映射到使用makefile和asdf:make命令的心智模型。我没有发现太多的例子在使用这个,但技术上我们加载C库到现有的图像。

可以重新考虑的另一点是检测现有的共享库以避免重新构建。如果共享库存在,make将避免重新编译,但仍然会再次调用链接器。这会导致错误,因为它不能在使用共享库时写入,至少在MS Windows上是这样。ASDF示例使用Lisp代码来检测库的存在并避免重新编译,但另一种选择可能是使用output-files

ASDF文档对output-files的目的有点混乱,没有例子说明他们的意图,但在创建新操作的手册部分,我们有:

output-files如果你的perform方法有任何输出,你必须定义一个此函数的方法。的输出执行操作。

表示定义共享库(libmd。

如果output-files已经存在,建议使用此方法避免重新编译。

最后,C库可以被认为是一个辅助系统,在本例中是cephes/libmd,它被添加到主系统中的:depends-on子句中。关于其他辅助系统的部分演示了使用build-op以这种方式构建可执行文件。除了这是在构建一个可执行的和硬编码的。exe"它似乎很好地映射到用例:

要构建一个可执行文件,按如下方式定义一个系统(在本例中,它是辅助系统,但也可以是主系统)。你会能够通过计算创建一个可执行文件foobar-命令(asdf:: foobar/执行):

(defsystem "foobar/executable"
:build-operation program-op
:build-pathname "foobar-command" ;; shell name
:entry-point "foobar::start-foobar" ;; thunk
:depends-on ("foobar")
:components ((:file "main")))

build-pathname给出了可执行文件的名称;.exe类型将在Windows上自动添加

我没有使用这种方法,因为次要系统看起来几乎和现在的主要系统一模一样,但会稍微不那么容易理解。

最新更新