使用SWIG

时间:2015-06-05 17:29:06

标签: java c++ swig

我正在使用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中创建一个Dataray的jarray,并用从库返回的DataStruct结构初始化的DataStruct对象填充它,最后释放已分配的ppdata指向的内存。

我一直试图绕过SWIG字体图一段时间,我现在看到的唯一解决方案是使用%native指令并完全手动创建JNI实现。在这种情况下,我能从SWIG获得至少一些帮助吗?

1 个答案:

答案 0 :(得分:3)

您在这里寻找的主要内容是版式地图的两个功能。首先,您希望多参数类型映射能够使用逻辑分组的参数。其次,您希望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信息有点棘手,因此这是一个很好的折衷方案。 (这也意味着如果您在将来切换到例如链接列表时只需做很小的更改,相同的代码就可以工作。)
  4. 有了这个,我可以运行我的测试:

    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