OCaml ctypes 处理输出参数的惯用方式

Question

我正在为一些使用 out-parameter 习惯用法并返回错误代码的 C 函数编写 OCaml 包装器。我一直在使用 Ctypes.allocate_n 在 OCaml 端分配一个 C 数组来包装它们。 .然后将内容复制到 OCaml 类型中。

我觉得我正在解决一个问题 Ctypes或者其他一些模块已经以另一种方式解决了，这里有一个例子。
gethostname(2)具有以下类型:

int gethostname(char *name, size_t len);

这里是 out_parameter.mli为包裹 gethostname功能。

val gethostname : int -> [> `Ok of string | `Error of int];;

这是实现

open Core.Std;;
let (@->) = Ctypes.(@->);;
let returning = Ctypes.returning;;
open Foreign;;

let gethostname size =
  let size' = Unsigned.Size_t.of_int size in
  let c_gethostname =
    foreign "gethostname" (Ctypes.ptr Ctypes.char @-> Ctypes.size_t @-> returning Ctypes.int) in
  let buf = Ctypes.allocate_n Ctypes.char ~count:size in
  let err = c_gethostname buf size' in
  match err with
  | 0 -> (
    `Ok (Ctypes.string_from_ptr buf ~length:size)
    )
  | _ -> `Error err;;

let main () =
  Printf.printf "%s\n" (match gethostname 1000 with
  | `Ok hostname -> hostname
  | `Error _ -> "error getting hostname");;

let () = main ();;

为了完整起见，我编译了 out_parameter.native用这个命令。

$ corebuild -pkg ctypes.foreign out_parameter.native

该代码确实有效并返回主机名，并去除了尾随的空字节。

$ ./out_parameter.native
MY-HOSTNAME

$ ./out_parameter.native | sed -e 's/\x0/@/g'
MY-HOSTNAME

Answer 1

看起来您的代码有效并且是惯用的。有两种表示错误的方法:

你可以抛出一个异常。

您可以使用结果类型。如果你这样做，我建议使用"new"内置 result类型(已在 result 包中为旧版本的 OCaml 向后移植)。

一般来说，您负责编写支持该错误约定的代码(代码中的 match err 部分)。通常可以编写几个组合器来减少样板。

但是， ctypes 提供了一些快捷方式。如果您使用 Cstubs (代码生成):

errno_policy 可以实现libc的errno惯例。

concurrency_policy 可以调整 C 代码，使其与给定的并发模型(lwt 等)相对应。这与错误约定无关，但有些相关。

如果你坚持 Foreign (这使您的构建系统比 Cstubs 更简单)，那么我建议您手动完成，或者如果您有很多类似的功能，请提取几个组合器。