基于数据包结构自动生成代码

时间:2016-09-23 17:08:26

标签: embedded config code-generation packet

我们有不同结构的数据包。它们应该以不同的语言读/写。例如:

| ClassId | Data |

ClassId = "datapoint" (Data structure):
  temperature - 1bytes
  elevation - 2bytes
  gradient - 1bytes
ClassId = "config" (Data structure):
  frequency - 1bytes
  deviceId - 3bytes
ClassId = "accelerometer" (Data structure):
  time - 2bytes
  x - 2bytes
  y - 2bytes
  z - 2bytes

而不是手动编写基于其类解析每个数据包的代码(这容易出错且耗时),我希望有一个配置文件然后代码(python / c / etc。)是自动生成,可以读写数据包。这些方面的东西:

lib.set(packet, "datapoint", {
  elevation: 933,
  temperature: 18,
  gradient: 20
});
lib.get(packet, "datapoint");
=>
{
  elevation: 933,
  temperature: 18,
  gradient: 20
}
谷歌搜索它没带我到任何地方。任何指针都会非常有用。

1 个答案:

答案 0 :(得分:-1)

您需要一个代码生成系统,它将数据包规范编译成代码来解析/解析数据包。

您可以使用解析器生成器构建一个ad hoc,并编写即席代码以程序性地遍历解析树并吐出相关代码。

或者您可以使用program transformation system (PTS)来处理您的数据包规范(如源代码),并转换为目标语言的源代码。您向PTS解释数据包的语法与解释解析器生成器的语法非常相似。

但是使用PTS,您可以使用表面语法表示法编写转换规则,以识别数据包系统语法并将其映射到目标语言函数语法。这使得编写和维护这样的工具变得更加容易,尤其是在数据包语法发生变化的情况下,和/或您更改目标语言基础结构以便以不同方式解析数据包。

编辑10/3:OP要求一个具体的例子,可能是PTS。

我将展示我们的DMS软件再造工具包的样子(有关DMS的更多信息,请参阅bio)。

首先,您需要与数据包语言(DMS兼容)语法。根据我的看法,这很简单:

Packets = Packet ;
Packets = Packets Packet ; -- allow a list of packet defintions

Packet = 'ClassID' '=' STRING members ;

 members = ;
 members = members member ; -- allow list of members

 member = IDENTIFIER '-' NATURAL 'bytes' ;

我认为这个语法是天真的,因为实际的数据包成员可能有不同的类型(可能是字符串,浮点数,布尔值......); OP的例子只显示了我假设的N字节二进制整数。您还需要各种目标语言的语法。我假设你有这些语法(这是相当的假设);让我们暂时与C合作。 [DMS确实有很多这样的]。

我们还必须假设传输数据的表示。 OP提出了一些建议,但我认为他试图暗示生成的代码(“lib.set ...”)。 相反,我将假设正在从Stream中读取数据包内容,因为二进制字节只是简单地附加在一起;这样可以实现最小的数据包大小,从而实现快速的传输时间。

所以,现在我们指定我们的代码生成器,作为将数据包定义映射到代码的重写规则集。

对于后台,PTS的重写规则通常如下所示:

          if you see *this*, replace it by *that*

所以你基本上用一种结构替换另一种结构。这些通常在AST上运行,但使用 this 的表面语法以便于阅读。

以下是DMS的源重写规则来源;它们看起来像是在文本上运行,但事实上它们是在DMS的解析器生成的AST上运行的。 DMS有自己的规则语法,但它基本上遵循上面的典型样式:

 rule rule_name( pattern_variables ): 
      source_syntax_category -> target_syntax_category =
      " this_pattern "  ->  " that_pattern " ;

源元素和目标模式包含在* metaquotes“;因此,实际的文字引号字符将转义为 \“

对于DMS规则始终是Packet符号的片段,而 始终是我们选择的目标语言(C)的片段。规则头中的模式变量名称具有语法类型,并且只能匹配AST中的相应类型。在元引用中找到的模式变量写为 \ variable 。元功能可以计算派生结果;它们在模式中作为“\ function(args)”调用。有关详细信息,请参阅DMS Rewrite Rules

    source domain Packet; -- the little language we defined
    target domain C; -- what we will generate code for
            -- you'll write one of these rulesets for each target language

    rule top_level(pl: Packets): Packets -> Statements =
      " \pl "
     -> " ReadPacketType(stream, packet_type);
          switch(packet_type) {
              \pl
             default: Panic(\"unrecognized packet type\");
          }"  if  IsRoot(pl); -- do this once [at root of tree]


    rule translate_packet_definitions(p: Packet, pl: packet_list): Packets -> switch_case_list
         " \p  \pl ";

    rule translate_packet_definition(s:STRING, ms: members, pl: Packets): Packets -> switch_case =
       " ClassID = \s \m \pl "
        -> " case \concatenate\(\"enum_\"\,\string_to_identifier\(\s\)\): { 
                \string_to_identifier\(\s\)* p=malloc(sizeof(\string_to_identifier\(\s\)));
                \m
                return p;
             }
            ";

     rule translate_members(m: member, ms: members) : members -> Statements
        = " \m \ms ";

     rule translate_member(i: IDENTIFIER, n: NATURAL) = member -> StatementList =
          " \i - \n bytes " ->
          "  p-> \toCIdentifer\(\i\) = ReadNByteValue(stream,\toCNatural\(\n\)) ; "

这是不完整的(特别是,我需要一套规则来生成包类型集的枚举声明),我怀疑它是否完全正确,但它给出了规则的味道。根据这些规则,OP的示例输入将生成此C代码:

ReadPacketType(stream, packet_type);
switch(packet_type) {
    case enum_datapoint: {
       datapoint* p=malloc(sizeof(datapoint));
       p->temperature=ReadNByteValue(stream,1);
       p->elevation=ReadNByteValue(stream,2);
       p->gradient=ReadNByteValue(stream,2);
       return p;
    }
    case enum_config: {
       config* p=malloc(sizeof(config));
       p->frequency=ReadNByteValue(stream,1);
       p->deviceId=ReadNByteValue(stream,3);
       return p;
    }
    case enum_accelerometer: {
       accelerometer* p=malloc(sizeof(accelerometer)); 
       p-time>=ReadNByteValue(stream,2);
       p->x=ReadNByteValue(stream,2);
       p->y=ReadNByteValue(stream,2);
       p->z=ReadNByteValue(stream,2);
       return p;
     }
     default: Panic(\"unrecognized packet type\");
}