使用 SWIG 返回一个 java 对象数组

Question

我正在使用 SWIG 为 C++ 库编写 JNI 包装器。 库中的一种方法在分配的内存中返回一个结构数组：

typedef struct {
    int id;
    double x;
    double y;
} DataStruct;

int get_all_data ( long ref, DataStruct **ppdata, size_t *psize ) {
    // ... prepare the data by the ref
    *ppdata = (DataStruct*) malloc(sizeof(DataStruct) * size);
    *psize = size;
    return 0;
}

java中的方法签名应该是这样的：

 native DataStruct[] get_all_data(long ref);

因此，我期望 SWIG 在 java 中生成 java DataStruct 和调用库方法的包装器，然后在 JVM 中创建一个 DataStruct 的 jarray 并用从库返回的 DataStruct 结构初始化的 DataStruct 对象填充它，最后释放分配的ppdata指向的内存。

一段时间以来，我一直在尝试围绕 SWIG 类型映射进行思考，目前我看到的唯一解决方案是使用 %native 指令并完全手动创建 JNI 实现。在这种情况下，我至少可以从 SWIG 获得一些帮助吗？

Answer 1

您在这里寻找的主要内容是类型映射的两个功能。首先，您希望多参数类型映射能够处理逻辑分组的参数。其次，您希望 argout 类型映射有机会将参数转换为输出。

在 SWIG 中编写此类接口有几种不同的方法，主要权衡涉及需要编写的 C (JNI) 与实际 Java 的数量。我整理了一个完整的例子：

%module test

%{
#include <assert.h>
%}

%typemap(in,numinputs=0) (DataStruct **ppdata, size_t *psize) (size_t tempsize, DataStruct *tempdata) %{
  $2 = &tempsize;
  $1 = &tempdata;
%}

%typemap(jtype) int get_all_data "long[]";
%typemap(jstype) int get_all_data "DataStruct[]";
%typemap(javaout) int get_all_data {
    final long[] arr = $jnicall;
    DataStruct[] ret = new DataStruct[arr.length];
    for (int i = 0; i < arr.length; ++i) {
      ret[i] = new DataStruct(arr[i], false);
    }
    return ret;
  }

%typemap(jni) int get_all_data "jlongArray";

%typemap(out) int get_all_data %{
  // Handle errors in the int return value ($1)
  assert(!$1);
%}

%typemap(argout) (DataStruct **ppdata, size_t *psize) {
  $result = JCALL1(NewLongArray, jenv, *$2);
  jlong temparr[*$2];
  for (size_t i = 0; i < *$2; ++i) {
    *(DataStruct**)&temparr[i] = &((*$1)[i]);
  }
  JCALL4(SetLongArrayRegion, jenv, $result, 0, *$2, temparr);
}

%inline %{
typedef struct {
    int id;
    double x;
    double y;
} DataStruct;

int get_all_data ( long ref, DataStruct **ppdata, size_t *psize ) {
    static const size_t size = 4;
    *ppdata = (DataStruct*) malloc(sizeof(DataStruct) * size);
    *psize = size;
    for (size_t  i = 0; i < size; ++i) {
      DataStruct val = {i,i,i};
      (*ppdata)[i] = val;
    }
    return 0;
}
%}

这会做一些事情：

1. 将get_all_data 的返回类型转换为数组。在内部，它是一个 long 数组，表示指向 DataStruct 实例的指针，但它的可见部分是构造的 DataStruct 对象数组。
2. 输入类型映射创建临时变量，用作输出参数的占位符。
3. 一旦调用实际发生，我们将遍历数组并将成员的地址存储到 Java 数组中。这很重要，因为数组是对象数组，而不是指针数组。 SWIG 生成的代理对象函数与指向单个对象的指针相关，因此我们需要从某个地方获取这些对象。我们也无法在 Java 中计算它们，因为仅从原始输出指针公开正确执行此操作所需的 sizeof 信息有些棘手，因此这是一个很好的折衷方案。 （这也意味着如果您将来切换到例如链接列表，只需进行少量更改，相同的代码也可以工作）。

有了它，我就可以运行我的测试了：

public class run {
  public static void main(String[] argv) {
    System.loadLibrary("test");
    DataStruct[] result = test.get_all_data(0);
    for (int i = 0; i < result.length; ++i) {
      System.out.println(result[i].getId());
    }
  }
}

运行如下：

swig2.0 -Wall -java -c++ test.i
gcc -Wall -Wextra -shared -o libtest.so -I/usr/lib/jvm/default-java/include -I/usr/lib/jvm/default-java/include/linux test_wrap.cxx
javac run.java
LD_LIBRARY_PATH=. java run
0
1
2
3