含C/C++桩代码的OCaml项目迁移至Dune时的依赖循环问题

尝试将包含C/C++桩代码的开源OCaml应用从Makefile迁移至Dune构建系统，在名为cdk的库中添加仅包含stdio.h头文件的test.c文件，Dune配置如下：

(library
    (name cdk)
    (public_name [...])
    (wrapped false) 
    (modules
[...]
    )
    (libraries IO unix str threads camlp-streams autoconf)
    (flags (:standard -w -32 -w -50 -w -27 -w -35 -w -69))
    (foreign_stubs
        (language c)
        (names test)
        (include_dirs ../../../)
    )
)

构建时出现依赖循环错误：

Error: Dependency cycle between:            
   _build/default/src/utils/cdk/test.o
-> _build/default/src/utils/cdk/libcdk_stubs.a
-> _build/default/src/utils/cdk/cdk.cmxs
-> _build/default/src/utils/cdk/test.o
-> required by alias src/utils/cdk/all
-> required by alias default

无论添加哪个C文件都会触发该问题，询问循环产生的原因及解决方法。

原因 #

这个依赖循环的根源是Dune构建动态模块（.cmxs）的逻辑：当C桩代码和OCaml库放在同一个Dune库配置中时，Dune会把C桩编译打包成libcdk_stubs.a，再将这个归档文件链接到OCaml的动态模块cdk.cmxs里。如果C代码（哪怕是间接的）依赖了cdk.cmxs中的符号，就会形成闭环：

1. 编译test.o需要libcdk_stubs.a
2. libcdk_stubs.a被整合进cdk.cmxs
3. test.o又依赖cdk.cmxs，最终循环往复

另外wrapped false的设置会让OCaml库的符号直接暴露，更容易被C代码误引用，进一步加剧了这个问题。

解决方法 #

1. 将C桩代码拆分为独立库 #

如果C桩仅被OCaml代码调用，自身不依赖当前OCaml库的逻辑，可以把C桩单独做成一个Dune库，让主OCaml库依赖它：

• 新建cdk_stubs库的dune文件：

  (library
    (name cdk_stubs)
    (public_name your_project_stubs)
    (modules empty) ; 无OCaml模块，设为empty
    (foreign_stubs
      (language c)
      (names test)
      (include_dirs ../../../)
    )
  )
  

• 修改主cdk库的配置，添加cdk_stubs到依赖列表，并移除主库的foreign_stubs块：

  (library
      (name cdk)
      (public_name [...])
      (wrapped false) 
      (modules [...])
      (libraries IO unix str threads camlp-streams autoconf cdk_stubs)
      (flags (:standard -w -32 -w -50 -w -27 -w -35 -w -69))
  )
  

2. 检查并清理C代码的不必要引用 #

打开test.c及其包含的头文件，确认是否误引用了当前OCaml库导出的符号（比如自动生成的cdk.h）：

• 若存在不必要的引用，直接删除，确保C代码仅依赖OCaml运行时头文件（如caml/mlvalues.h）
• 若确实需要调用OCaml代码，改用OCaml回调机制，避免直接链接动态模块

3. 强制构建静态模块 #

在主库的Dune配置中添加(modes byte native)，指定仅构建静态链接的字节码和原生模块，跳过动态模块.cmxs的构建，从而避免循环：

(library
    (name cdk)
    (public_name [...])
    (wrapped false) 
    (modules [...])
    (libraries IO unix str threads camlp-streams autoconf)
    (flags (:standard -w -32 -w -50 -w -27 -w -35 -w -69))
    (foreign_stubs
        (language c)
        (names test)
        (include_dirs ../../../)
    )
    (modes byte native)
)

内容的提问来源于stack exchange，提问作者Luca Carlon