java - 返回对成员变量的引用时的 SWIG-Java 内存管理

Question

我正在使用 SWIG 从 Java 访问 C++ 代码。

C++ 中的 getter 通常返回 const 引用:

class B
{
public:
  const A& getA() const { return a_; }
private:
  A a_;
};

生成 SWIG 包装器。 Java 中的 B::getA 按预期返回引用。然而 JVM 并不知道这个引用与 class B 相关联。这可能会导致引用损坏:

public A createA() {
    B b = new B();
    return b.getA();
}

一旦垃圾收集器销毁 B b 并且 JVM 对此一无所知，从 createA 返回的对象将无效。

SWIG 提供了解决此问题的文档:references and swig .然而，这意味着我需要手动添加所有这些引用。

我提出了以下解决方案，它在 SWIG 生成的代码中返回拷贝而不是 const 引用:

%typemap(out) const SWIGTYPE&
{
  *($&1_ltype)&$result = new $1_basetype(($1_type)*$1);
}
%typemap(javaout) const SWIGTYPE&
{
  return new $javaclassname($jnicall, true);
}

我有两个问题:

1. 这种方法安全吗？我是不是忘记了什么？
2. 有没有更好的解决方案来解决这个问题而不需要编写太多代码？

感谢任何帮助。

Answer 1

这看起来很合理，但我不建议使用它。

就目前而言，如果您强制每个案例都成为拷贝，您将失去 return by const reference 的语义。这也会影响其他东西的 SWIG 包装(例如标准库容器)。

与 native 库相比，它有可能对包装代码的性能产生不利影响。但更严重的是，它在某些情况下也会从根本上改变行为。例如考虑以下 SWIG 示例:

%module test

%typemap(out) const SWIGTYPE&
{
  *($&1_ltype)&$result = new $1_basetype(($1_type)*$1);
}
%typemap(javaout) const SWIGTYPE&
{
  return new $javaclassname($jnicall, true);
}

%inline %{
struct A {
    int v;
    A() : v(0) {}
};

class B
{
public:
  B() { }
  const A& getA() const { return a_; }
  void counter() {
    a_.v++;
  }
  int test() const { return a_.v; }
private:
  A a_;
};

%}

如果我们像这样从 Java 使用它:

public class run {
    public static void main(String[] argv) {
        System.loadLibrary("test");
        A a = test(); 
        System.out.println("A.v = " + a.getV());
    }

    private static A test() {
        B b = new B();
        A result = b.getA();
        System.out.println("A.v = " + b.test() + " (test)");
        b.counter();
        System.out.println("A.v = " + result.getV());
        return result;
    }
}

结果是 v 总是(意外地)为 0:

A.v = 0 (test)
A.v = 0
A.v = 0

将其与相同(正确的)C++ 行为进行对比:

#include <iostream>

struct A {
    int v;
    A() : v(0) {}
};

class B
{
public:
  B() { }
  const A& getA() const { return a_; }
  void counter() {
    a_.v++;
  }
  int test() const { return a_.v; }
private:
  A a_;
};

static A test();

int main() {
    const A& a = test(); 
    std::cout << "A.v = " << a.v << "\n";
}

static A test() {
    B b;
    const A& result = b.getA();
    std::cout << "A.v = " << b.test() << " (test)" << "\n";
    b.counter();
    std::cout << "A.v = " << result.v << "\n";
    return result;
}

哪个正确返回:

A.v = 0 (test)
A.v = 1
A.v = 1

这种不自然的语义对我来说是个阻碍。

我的建议是跳过复制构造函数计划并将文档中的示例改编为通用的:

%module test

%typemap(javabody,noblock=1) SWIGTYPE {
  private long swigCPtr;
  protected boolean swigCMemOwn;

  protected $javaclassname(long cPtr, boolean cMemoryOwn) {
    swigCMemOwn = cMemoryOwn;
    swigCPtr = cPtr;
  }

  protected $javaclassname(long cPtr, boolean cMemoryOwn, Object cParent) {
    this(cPtr, cMemoryOwn);
    swigCParent = cParent;
  }

  protected static long getCPtr($javaclassname obj) {
    return (obj == null) ? 0 : obj.swigCPtr;
  }

  private Object swigCParent;
}

%typemap(javaout) SWIGTYPE const & {
    return new $javaclassname($jnicall, $owner, this);
  }

%inline %{
struct A {
    int v;
    A() : v(0) {}
};

class B
{
public:
  B() { }
  const A& getA() const { return a_; }
  void counter() {
    a_.v++;
  }
  int test() const { return a_.v; }
private:
  A a_;
};

%}

对于每个类自动插入和管理的一个额外对象引用，它现在的行为类似于 C++ 等价物。

如果你想让静态和非静态方法自动工作，我们需要使用一些技巧，因为不幸的是，没有办法指定类型映射应该只应用于非静态方法。我用的trick有详细解释on another question .通过这个技巧，我们可以修改 SWIG 界面以添加:

%pragma(java) moduleimports=%{
  import java.lang.reflect.Field;
%}

%pragma(java) modulecode=%{
  static Object getThisOrNull(final Object o, final Class c) {
    for (Field f: o.getClass().getDeclaredFields()) {
      if (f.getType().equals(c)) {
        try {
          return f.get(o);
        }
        catch (IllegalAccessException e) {
          // Omm nom nom...
        }
      }
    }
    return null;
  }
%}

并将 javaout 类型映射更改为:

%typemap(javaout) SWIGTYPE const & {
    return new $javaclassname($jnicall, $owner, $module.getThisOrNull(new Object(){}, $javaclassname.class));
  }

接口(interface)的其余部分如前所述，但如果没有父级(即静态方法)，此修改现在会导致 swigCParent 为 null。