问JNA:如何在结构中指定可变长度(0+)数组？
EN

Stack Overflow用户

提问于 2020-12-13 23:23:08

回答 1查看 370关注 0票数 3

示例结构，其中count是数组中的字节数，可以是0。我希望在Java中分配新实例，并读取本机分配的实例。

    public class VarArray extends Structure {
        public byte dummy0;
        public short dummy1;
        public int count;
        public byte[] array;
    }

在array = new byte[0]中使用Structure是不允许的。

如果计数为0，则声明默认的array = new byte[1]将从未分配的地址读取。

删除array字段可以读取，因为我可以访问指针偏移量Structure.size()编辑:不正确的字节，取决于填充。但是，为了分配一个新实例，我需要手动确定字段大小和对齐填充，以便分配正确的内存大小。

我有一个使用两种类型的解决方案-一种是对本机分配的和0计数的array分配的实例没有array，另一种是带有array for Java分配的1+计数实例的子类型。这似乎相当臃肿，特别是与所需的锅炉板代码。

有更好的办法吗？

或者是一种简单的方法来计算字段大小和对齐方式，这样一种类型就足够了？

import java.util.Arrays;
import java.util.List;
import com.sun.jna.Pointer;
import com.sun.jna.Structure;

public class JnaStructTester {

    /**
     * For native-allocated, and 0-count JNA-allocated instances.
     */
    public static class VarArray extends Structure {
        public byte dummy0;
        public short dummy1;
        public int count;

        public VarArray() {}

        public VarArray(Pointer p) {
            super(p);
        }

        public byte[] getArray() {
            byte[] array = new byte[count];
            if (count > 0) {
                int offset = size();
                getPointer().read(offset, array, 0, count);
            }
            return array;
        }
        
        @Override
        protected List<String> getFieldOrder() {
            return List.of("dummy0", "dummy1", "count");
        }
    }
    
    /**
     * For 1+ count JNA-allocated instances.
     */
    public static class VarArrayX extends VarArray {
        public byte[] array;

        public VarArrayX() {}

        @Override
        public byte[] getArray() {
            return array;
        }
        
        @Override
        protected List<String> getFieldOrder() {
            return List.of("dummy0", "dummy1", "count", "array");
        }
    }
    
    public static void main(String[] args) {
        var va0 = new VarArrayX();
        va0.dummy0 = (byte) 0xef;
        va0.dummy1 = (short) 0xabcd;
        va0.count = 7;
        va0.array = new byte[] { 1, 2, 3, 4, 5, 6, 7 };
        va0.write();
        
        var va1 = new VarArray();
        va1.dummy0 = (byte) 0xab;
        va1.dummy1 = (short) 0xcdef;
        va1.write();
        
        print(new Pointer(Pointer.nativeValue(va0.getPointer())));
        print(new Pointer(Pointer.nativeValue(va1.getPointer())));
    }
    
    private static void print(Pointer p) {
        var va = new VarArray(p);
        va.read();
        System.out.println(va);
        System.out.println("byte[] array=" + Arrays.toString(va.getArray()));
        System.out.println();
    }
}

输出：

JnaStructTester$VarArray(native@0x7fb6835524b0) (8 bytes) {
  byte dummy0@0=ffffffef
  short dummy1@2=ffffabcd
  int count@4=7
}
byte[] array=[1, 2, 3, 4, 5, 6, 7]

JnaStructTester$VarArray(native@0x7fb683551210) (8 bytes) {
  byte dummy0@0=ffffffab
  short dummy1@2=ffffcdef
  int count@4=0
}
byte[] array=[]

(我使用的是相当老的JNA版本4.2.2)

更新(2020-01-07)

感谢Daniel的建议，这里有一个很好的解决方案。

基于数组是否为空，动态修改字段列表是不可能的。当不包括变量数组字段时，布局将静态缓存，因此具有非空数组的未来实例将失败。相反：

该数组在ensureAllocated()中进行调整，以避免空数组错误。
仅当数组为非空时，writeField()才写入该字段。
readField()从count中设置数组大小，它已经被读取，如果计数为0，则跳过读取数组。

通过在readField()中将数组设置为正确的大小，将自动填充完整的数组，无需手动创建。

import java.util.Arrays;
import java.util.List;
import com.sun.jna.Pointer;
import com.sun.jna.Structure;

public class JnaStructTester {

    public static class VarArray extends Structure {
        public short dummy0;
        public int dummy1;
        public byte count;
        public byte[] array = new byte[0];

        public VarArray() {}

        public VarArray(byte[] array) {
            this.count = (byte) array.length;
            this.array = array;
        }

        public VarArray(Pointer p) {
            super(p);
        }

        @Override
        protected void ensureAllocated() {
            if (count == 0) array = new byte[1];
            super.ensureAllocated();
            if (count == 0) array = new byte[0];
        }

        @Override
        protected void writeField(StructField structField) {
            if (structField.name.equals("array") && count == 0) return;
            super.writeField(structField);
        }

        @Override
        protected Object readField(StructField structField) {
            if (structField.name.equals("array")) {
                array = new byte[count];
                if (count == 0) return null;
            }
            return super.readField(structField);
        }

        @Override
        protected List<String> getFieldOrder() {
            return List.of("dummy0", "dummy1", "count", "array");
        }
    }

    public static void main(String[] args) {
        var va0 = new VarArray(new byte[] { 1, 2, 3, 4, 5, 6, 7 });
        va0.dummy0 = 0x4321;
        va0.dummy1 = 0xabcdef;
        va0.write();

        var va1 = new VarArray();
        va1.dummy0 = 0x4321;
        va1.dummy1 = 0xabcdef;
        va1.write();
        
        print(new Pointer(Pointer.nativeValue(va0.getPointer())));
        print(new Pointer(Pointer.nativeValue(va1.getPointer())));
    }

    private static void print(Pointer p) {
        var va = new VarArray(p);
        va.read();
        System.out.println(va);
        System.out.println("byte[] array=" + Arrays.toString(va.array));
        System.out.println();
    }
}

输出：

JnaStructTester$VarArray(native@0x7fd85cf1ffb0) (12 bytes) {
  short dummy0@0=4321
  int dummy1@4=abcdef
  byte count@8=7
  byte array[7]@9=[B@4f2410ac
}
byte[] array=[1, 2, 3, 4, 5, 6, 7]

JnaStructTester$VarArray(native@0x7fd85cf20690) (12 bytes) {
  short dummy0@0=4321
  int dummy1@4=abcdef
  byte count@8=0
  byte array[0]@9=[B@722c41f4
}
byte[] array=[]

我只在我的狭隘用例中测试过这一点，如果在Structure上调用其他方法，它可能无法工作。

arrays

structure

jna

java

回答 1

Stack Overflow用户

回答已采纳

发布于 2020-12-14 08:59:35

我确实认为有两个结构的解决方案是一个合理的解决方案，数组版本扩展了另一个结构，但简单地添加新字段。您对“样板膨胀”的关注大大减少了JNA5.X，它有一个@FieldOrder注释，这大大减少了样板。您的结构将相当简单：

@FieldOrder({"dummy0", "dummy1", "count"})
public class VarArray extends Structure {
    public byte dummy0;
    public short dummy1;
    public int count;
}

@FieldOrder({"dummy0", "dummy1", "count", "array"})
public class VarArrayX extends VarArray  {
    public byte[] array = new byte[1];

    public VarArrayX(int arraySize) {
        array = new byte[arraySize];
        super.count = arraySize;
        allocateMemory();
    }
}

除了添加构造函数(如果要使用指针进行初始化)之外，这应该足够了。

但是，您可以通过对FieldOrder进行相同的修改来执行单一结构版本。JNA的内存分配取决于使用getFieldList()和getFieldOrder()方法定义的字段顺序(新注释删除了模板要求)。

可以将数组分配保留在结构中，但更改getFieldOrder()覆盖以跳过定义数组的字段，在数组为零的情况下，对getFieldList()也是如此。在JNA的Linux映射中编写Sysinfo结构时，我必须处理这种情况。主要结构包括这一领域：

public byte[] _f = new byte[PADDING_SIZE];

但是，getFieldList()覆盖包括：

if (PADDING_SIZE == 0) {
    Iterator<Field> fieldIterator = fields.iterator();
    while (fieldIterator.hasNext()) {
        Field field = fieldIterator.next();
        if ("_f".equals(field.getName())) {
            fieldIterator.remove();
        }
    }
}

getFieldOrder()包括：

if (PADDING_SIZE == 0) {
    fieldOrder.remove("_f");
}

类似的条件将删除同一文件中的_f_unused结构中的Statvfs字段。

在您的结构中，只要您在实例化结构之前知道count，这样的东西就可以工作(未经测试)：

public static class VarArray extends Structure {
    public byte dummy0;
    public short dummy1;
    public int count;
    public byte[] array = new byte[1];

    public VarArray(int arraySize) {
        array = new byte[arraySize];
        count = arraySize;
        allocateMemory();
    }

    @Override
    protected List<String> getFieldOrder() {
        if (count == 0) {
            return List.of("dummy0", "dummy1", "count");
        } else {
            return List.of("dummy0", "dummy1", "count", "array");
        }
    }

    // do the same for getFieldList()
}