Kaitai Struct:通过一些字段来实现容错

时间:2016-07-22 01:37:26

标签: java kaitai-struct

在解析Kaitai Struct中的截断日志时,有没有办法传递一些字段? 因为如果它读取一个字段(类型指定为枚举)但值不在那里,则会引发 NullPointer异常
所以我想询问是否有任何方法可以实现这一点,就像python库Construct中的default: pass属性一样

这是我的ksy文件:

meta:
  id: btsnoop
  endian: be
seq:
  - id: header
    type: header
  - id: packets
    type: packet
    repeat: eos
types:
  header:
    seq:
      - id: iden
        size: 8
      - id: version
        type: u4
      - id: datalink_type
        type: u4
        enum: linktype
  packet:
    seq:
      - id: ori_len
        type: u4
      - id: include_len
        type: u4
      - id: pkt_flags
        type: u4
      - id: cumu_drop
        type: u4
      - id: timestamp
        type: s8
      - id: data
        size: include_len
        type: frame
  frame:
    seq:
      - id: pkt_type
        type: u1
        enum: pkttype
      - id: cmd
        type: cmd
        if: pkt_type == pkttype::cmd_pkt
      - id: acl
        type: acl
        if: pkt_type == pkttype::acl_pkt
      - id: evt
        type: evt
        if: pkt_type == pkttype::evt_pkt  
  cmd:
    seq:
      - id: opcode
        type: u2le
      - id: params_len
        type: u1
      - id: params
        size: params_len
  acl:
    seq:
      - id: handle
        type: u2le
  evt:
    seq:
      - id: status
        type: u1
        enum: status
      - id: total_length
        type: u1
      - id: params
        size-eos: true
enums:  <-- I need to list all possible option in every enum?
  linktype:
    0x03E9: unencapsulated_hci
    0x03EA: hci_uart
    0x03EB: hci_bscp
    0x03EC: hci_serial
  pkttype:
    1: cmd_pkt
    2: acl_pkt
    4: evt_pkt
  status:
    0x0D: complete_D
    0x0E: complete_E
    0xFF: vendor_specific

感谢您的回复:)

1 个答案:

答案 0 :(得分:3)

这里仍然有两个问题:)

解析部分/截断/损坏的数据

这里的主要问题是,通常Kaitai Struct会将.ksy编译成一个代码,该代码在类构造函数中进行实际的解析。这意味着如果出现问题,繁荣,你根本没有任何对象。在大多数用例中,它是理想的行为,因为它实际上允许您确保对象已完全初始化。当格式想要读取下一个原语时,问题通常是EOFException,但是流中没有数据,或者在一些更复杂的情况下,还有其他内容。

然而,正如您所提到的那样,有一些用例,其中包括&#34;尽力而为&#34;解析会有所帮助 - 即你可以使用半满的对象。另一个流行的用例是可视化工具:它有助于展示&#34;尽力而为&#34;也有,因为它可以更好地显示用户半解析结果(帮助定位错误)而不是根本没有结果(并让用户进行猜测)。

在Kaitai Struct中有一个简单的解决方案 - 您可以使用--debug选项编译您的课程。这样,您将获得一个将对象创建和解析分开的类,解析将只是对象的另一种方法(void _read())。但是,这意味着您必须手动调用解析方法。例如,如果您的原始代码是:

Btssnoop b = Btssnoop.fromFile("/path/to/file.bin");
System.out.println(b.packets.size());

在您使用--debug对其进行编译后,您将不得不采取额外步骤:

Btssnoop b = Btssnoop.fromFile("/path/to/file.bin");
b._read();
System.out.println(b.packets.size());

然后你可以将它包装在try / catch块中,并在获得IOException之后实际继续处理:

Btssnoop b = Btssnoop.fromFile("/path/to/file.bin");
try {
    b._read();
} catch (IOException e) {
    System.out.println("warning: truncated packets");
}
System.out.println(b.packets.size());

但有一些捕获:

    截至发行版v0.3,
  • --debug尚未用于Java目标;实际上,它现在甚至不在公共git存储库中,我希望我能尽快推出它。
  • --debug还做了一些额外的事情,比如写下每个属性的位置,这会造成相当严厉的性能/内存损失。告诉我你是否需要一个开关来编译&#34;单独的构造函数/解析&#34;没有剩余--debug功能的功能 - 我可以想到额外的开关来启用它。
  • 如果您需要在传入数据包到达时对其进行连续解析,那么将它们全部存储在内存中并在每次更新时重新解析所有数据包可能是个坏主意。我们正在考虑基于事件的解析模型,请告诉我您是否对该感兴趣。

缺少枚举值和NPE

当前的Java实现将枚举转换为类似

的内容
this.pet1 = Animal.byId(_io.readU4le());

将Animal.byId翻译成:

private static final Map<Long, Animal> byId = new HashMap<Long, Animal>(3);
static {
    for (Animal e : Animal.values())
        byId.put(e.id(), e);
}
public static Animal byId(long id) { return byId.get(id); }

当地图中未找到任何值时,Java Map会按合约返回null。您应该能够将null与某些内容(即其他枚举值)进行比较,并获得正确的true或false。你能告诉我你究竟有NPE问题的地方,即你的代码,生成的代码和堆栈跟踪吗?