如何编写自定义解码
编写自定义解码器时,必须创建一个名为 <decoder_name>.ets.c 的解码器文件,将其编译并包含在共享对象库中。这个 C 文件需要实现一个初始化函数、一个加载函数,以及执行解码所用的各回调函数(通常是创建摘要行和详情行的回调)。
编写自定义解码器时使用的主要数据结构是 AceT_Decoder_Plugin 类型。该数据结构定义于 ace_client_api.h,由 Transaction Analyzer 的解码管理器创建,并传入解码器的初始化函数(init_proc),在其中填入你的自定义回调函数和列表。该数据结构的详细内容见下表。
表 1:AceT_Decoder_Plugin 数据元素
| 元素 | 数据类型 | 说明 |
|---|---|---|
protocols_lptr |
PrgT_List * |
该解码器插件所处理的协议名称列表。 |
prior_protocols_lptr |
PrgT_List * |
未使用。 |
preproc_proc |
AceT_Decoder_Preproc_Proc |
用于预处理(pre-processing)的回调函数。 |
can_decode_proc |
AceT_Decoder_Can_Decode_Proc |
未使用。 |
decode_proc |
AceT_Decoder_Decode_Proc |
用于生成摘要行的回调函数。 |
details_proc |
AceT_Decoder_Details_Proc |
用于生成详情行的回调函数。 |
delete_proc |
AceT_Decoder_Delete_Proc |
用于释放 load_proc 所分配内存的回调函数。 |
done_proc |
AceT_Decoder_Done_Proc |
用于后处理(post-processing)的回调函数,例如向日志写入消息。 |
自定义解码器要求在 <decoder_name>.ets.c 文件中至少定义四个过程。这些过程对应以下四项活动:
- 初始化自定义解码器。
- 加载所需的各种信息。
- 创建摘要行。
- 创建详情行。
初始化
Riverbed 分析软件初始化 Transaction Analyzer 时,也会初始化在 ace_decoder_config.gdf 文件中指定的各自定义解码器。为此,它对每个解码器调用其 init_proc。init_proc 是定义在解码器共享对象库中的回调。该回调的详情见 AceT_Decoder_Plugin_Init_Proc。
每个 init_proc 被调用一次,用于初始化实现其自定义解码器所需的回调函数和列表。该回调通过填充与该自定义解码器关联的解码器插件数据结构(见表 1)来完成这一初始化。大多数自定义解码器只需要该数据结构中的三个元素:decode_proc 回调、details_proc 回调和 protocols_lptr 列表。例如:
plugin_ptr->decode_proc = (AceT_Decoder_Decode_Proc) op_http_decoder_decode;
plugin_ptr->details_proc = (AceT_Decoder_Details_Proc) op_http_decoder_details;
plugin_ptr->protocols_lptr = prg_list_create ();
prg_list_strings_append (plugin_ptr->protocols_lptr, "HTTP", VOSC_NIL);
加载
初始化自定义解码器之后,Riverbed 分析软件会调用为该解码器定义的 load_proc。该回调定义在解码器的共享对象库中,负责加载解码器所需的任何信息。例如,它可以分配状态内存、建立状态指针,或读入一个文件。该回调的详情见 AceT_Decoder_Plugin_Load_Proc
通常,load_proc 接收一个 AceT_Import_Handle,并负责设置解码器所使用的状态信息。导入句柄(import handle)是由 Riverbed 分析软件传入的不透明数据结构,为解码操作提供上下文。大多数 load_proc 实现只需要一行代码,例如:
*client_state_pptr = import_handle_ptr;
创建摘要行
当用户在 Protocol Decode Viewer 中展开一个帧时,Transaction Analyzer 调用若干函数,为帧中的每个协议创建摘要行。对于不由内置解码器处理的每个协议,Transaction Analyzer 会查找该协议的 decode_proc,并在其已定义时调用它。decode_proc 读取数据、解析数据、创建摘要行文本,并将摘要行添加到一个 AceT_Pk_Protocol_Info 数据结构中。
关于 decode_proc 回调的说明与示例,参见 AceT_Decoder_Decode_Proc。
创建详情行
当用户在 Protocol Decode Viewer 中展开一条摘要行时,Transaction Analyzer 调用一个函数来创建该协议的详情行。对于自定义协议,这将是该协议的 AceT_Decoder_Plugin 数据结构中指定的 details_proc。details_proc 获取被解码协议的数据、解析数据、创建详情行,并以列表形式返回这些详情行。
关于 details_proc 回调的说明与示例,参见 AceT_Decoder_Details_Proc。