OCaml ctypes处理参数的惯用方法

时间:2016-08-16 22:02:32

标签: ocaml

我正在为一些使用out-parameter idiom并返回错误代码的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

1 个答案:

答案 0 :(得分:6)

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

  • 你可以抛出异常。
  • 您可以使用结果类型。如果您这样做,我建议使用“新”内置result类型(已在result包中为旧版OCaml反向移植)。

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

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

  • errno_policy可以实现libc的errno约定。
  • concurrency_policy可以调整C代码,使其对应于给定的并发模型(lwt等)。这不是关于错误约定,而是有些相关。

如果你坚持使用Foreign(这使得你的构建系统比Cstubs更简单),那么我建议你手工完成它,或者如果你有很多类似的功能就提取几个组合器