From 7b5337d08ec2c5dda98e91d32c1471e7779291c1 Mon Sep 17 00:00:00 2001 From: Hanoh Haim Date: Thu, 24 Dec 2015 17:10:17 +0200 Subject: [PATCH] v1.84 --- trex_rpc_server_spec.asciidoc | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/trex_rpc_server_spec.asciidoc b/trex_rpc_server_spec.asciidoc index 5ffb8a1c..46ff734c 100755 --- a/trex_rpc_server_spec.asciidoc +++ b/trex_rpc_server_spec.asciidoc @@ -28,7 +28,9 @@ The TRex RPC Server | 1.2 | Hanoch Haim (hhaim) | - add tuple generator command - +| 1.3 | Hanoch Haim (hhaim) +| +- update VM instructions |================= @@ -576,7 +578,7 @@ The format of that object is as follows: | next_stream_id | int | next stream to start after this stream. -1 means stop after this stream | packet | object | object of type xref:packet_obj['packet'] | mode | object | object of type xref:mode_obj['mode'] -| vm | array | array of objects of type xref:vm_obj['vm'] +| vm | object | array of objects of type xref:vm_obj['vm'] | rx_stats | object | object of type xref:rx_stats_obj['rx_stats'] |================= @@ -623,8 +625,20 @@ mode object can be 'one' of the following objects: |================= ===== Object type 'vm' anchor:vm_obj[] -Array of VM instruction objects to be used with this stream +an Object that include instructions array and properties of the field engine program + +.Object type 'packet' +[options="header",cols="1,1,3"] +|================= +| Field | Type | Description +| Instructions | array | list of instructional objects +| split_by_var | string | name of the field by which to split into threads +| Restart | boolean | restart the field engine program when stream moving from inactive->active +|================= + + +Array of VM instruction objects to be used with this stream Any element in the array can be one of the following object types: .Object type 'vm - fix_checksum_ipv4' @@ -643,9 +657,9 @@ Any element in the array can be one of the following object types: | name | string | flow var name - this should be a unique identifier | size | [1,2,4,8] | size of the flow var in bytes | op | ['inc', 'dec', 'random'] | operation type to perform on the field -| init value | uint64_t as string | init value for the field -| min value | uint64_t as string | minimum value for the field -| max value | uint64_t as string | maximum value for the field +| init_value | uint64_t as string | init value for the field +| min_value | uint64_t as string | minimum value for the field +| max_value | uint64_t as string | maximum value for the field |================= .Object type 'vm - write_flow_var' -- 2.16.6