release_notes.asciidoc revision e3bcdec7
1:author: hhaim 
2:email: <hhaim@cisco.com> 
3
4
5ifndef::backend-docbook[]
6++++++++++++++
7<div id="header-pic"   style="padding:50px;margin-top:0px;position:absolute;left:0px;width:100%;">
8    <img src="images/trex_logo.png" alt="Smiley face" height="80" width="270"/>
9</div>
10<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>
11++++++++++++++
12
13include::trex_ga.asciidoc[]
14
15
16== TRex release notes ==
17endif::backend-docbook[]
18
19ifdef::backend-docbook[]
20
21== TRex release notes  ==
22:numbered:
23
24endif::backend-docbook[]
25
26== Release 2.14 ==
27
28* Another performance improvement for stateful case with high active flows. There are less less burstiness. 
29* Scapy server - warning in case of permissions errors 
30* Maximum supported ports is 16 (instead on 12)
31* ConnectX-4 DPDK driver is based on 16.11 (from 16.07) - better performance is some cases.
32* Early support for Intel XL710/X710/599 VF support [TBD add pointer for more info]
33* Fix Cluster mode breakage (v2.12-v2.13)
34* Stateless GUI v3.0 works with this version
35
36=== fix issues: ===
37
38* link:https://trex-tgn.cisco.com/youtrack/issue/trex-319[trex-319]
39* link:https://trex-tgn.cisco.com/youtrack/issue/trex-322[trex-322]
40* link:https://trex-tgn.cisco.com/youtrack/issue/trex-326[trex-326]
41* link:https://trex-tgn.cisco.com/youtrack/issue/trex-330[trex-330]
42* link:https://trex-tgn.cisco.com/youtrack/issue/trex-329[trex-329]
43
44
45== Release 2.13 ==
46
47* Significantly improve performance and scale for stateful case with high active flows (70%-300% better)  see here link:trex_manual.html#_more_active_flows[More active flows]
48* Stateful with low active repeatable flows - an optimization was removed, for example `cap2/imix_fast_1g.yaml`. users that want to get this in high performance are adviced to move to Stateles mode. Removing this support improved the common case.
49* Support NAT without IPv4.option and UDP flows- for ASA  link:https://trex-tgn.cisco.com/youtrack/issue/trex-274[trex-274]
50* Scapy server is restart automatically - for future Stateless GUI link:https://trex-tgn.cisco.com/youtrack/issue/trex-291[trex-291]
51* Add minimum ipg for remote pcap link:https://trex-tgn.cisco.com/youtrack/issue/trex-281[trex-281]
52* Console port commands works on VIC and ConnectX-4
53* RPC API version is 3.0 - New stateless GUI is required
54
55
56=== fix issues: ===
57
58* link:https://trex-tgn.cisco.com/youtrack/issue/trex-317[trex-317]
59* link:https://trex-tgn.cisco.com/youtrack/issue/trex-282[trex-282]
60* link:https://trex-tgn.cisco.com/youtrack/issue/trex-190[trex-190]
61* link:https://trex-tgn.cisco.com/youtrack/issue/trex-279[trex-279]
62* link:https://trex-tgn.cisco.com/youtrack/issue/trex-313[trex-313]
63* link:https://trex-tgn.cisco.com/youtrack/issue/trex-312[trex-312]
64* link:https://trex-tgn.cisco.com/youtrack/issue/trex-310[trex-310]
65* link:https://trex-tgn.cisco.com/youtrack/issue/trex-191[trex-191]
66* link:https://trex-tgn.cisco.com/youtrack/issue/trex-306[trex-306]
67* link:https://trex-tgn.cisco.com/youtrack/issue/trex-234[trex-234]
68* link:https://trex-tgn.cisco.com/youtrack/issue/trex-308[trex-308]
69* link:https://trex-tgn.cisco.com/youtrack/issue/trex-283[trex-283]
70
71
72== Release 2.12 ==
73
74* Improve support for Mellanox ConnectX-4 cards (100/50/25GbE) 
75** Only CentOs/RedHat 7.2 and up is supported due to OFED issues
76** Improve 64Byte Stateleess performance 
77* Cisco VIC is fully supported 
78* Stateless L2/L3 configuration mode for ports - link:trex_stateless.html#_port_layer_mode_configuration[Port Layer Mode Configuration]
79* Stateless neighboring protocols infra and first protocols support/Python API - link:trex_stateless.html#_neighboring_protocols[Neighboring Protocols]
80* Stateful - ARP support for Client clustering mode (a.k.a APIC-EM) see here link:trex_manual.html#_client_clustering_configuration[Client Clustering]
81* Added Stateless performance trend document link:trex_analytics.html[trex performance trend]
82
83
84[IMPORTANT]
85=====================================
86Change of behavior - trex config file (/trex/cfg.yaml) should include a distinct MAC address or distinct IP address. 
87Not setting the port information :
88  before v2.12  :  src MAC addr == 00:00:00:01:00:00 
89  v2.12 and up  :  src MAC addr == HW MAC address 
90===========================
91
92
93=== fix issues: ===
94
95* link:https://trex-tgn.cisco.com/youtrack/issue/trex-257[trex-257]
96* link:https://trex-tgn.cisco.com/youtrack/issue/trex-265[trex-265]
97* link:https://trex-tgn.cisco.com/youtrack/issue/trex-280[trex-280]
98* link:https://trex-tgn.cisco.com/youtrack/issue/trex-277[trex-277]
99* link:https://trex-tgn.cisco.com/youtrack/issue/trex-278[trex-278]
100* link:https://trex-tgn.cisco.com/youtrack/issue/trex-199[trex-199]
101
102
103== Release 2.11 ==
104
105* Early support for Mellanox ConnectX-4 cards (100/50/25GbE) - based on contributions from Mellanox DPDK team see here for more info link:trex_manual.html#_mellanox_connectx_4_support[Mellanox ConnectX-4 Support]
106* Add support for Cisco VIC 1300 series adapter (40GbE)-  based on Cisco VIC DPDK team see link:trex_manual.html#_cisco_vic_support[Cisco VIC Support]
107
108=== fix issues: ===
109
110* link:https://trex-tgn.cisco.com/youtrack/issue/trex-268[trex-268]
111* link:https://trex-tgn.cisco.com/youtrack/issue/trex-267[trex-267]
112* link:https://trex-tgn.cisco.com/youtrack/issue/trex-195[trex-195]
113* link:https://trex-tgn.cisco.com/youtrack/issue/trex-271[trex-271]
114* link:https://trex-tgn.cisco.com/youtrack/issue/trex-255[trex-255]
115* link:https://trex-tgn.cisco.com/youtrack/issue/trex-249[trex-249]
116
117
118== Release 2.10 ==
119
120* Added support for IP based configuration files (As opposed to MAC based used until now), with the ability of TRex to send
121ARP requests for default gateway, and gratitues ARP for its own addresses.
122See link:trex_manual.html#_configuration_yaml_parameter_of_cfg_option[here] and link:trex_config_guide.html[here] for details.
123* Added commands/API to Stateless client/console:
124** Getting extended counters of port for improved debug purposes. See example: link:trex_stateless.html#_stats[stats]
125** Changing of port attributes and getting async feedback on the changed status. See example: link:trex_stateless.html#_portattr[portattr]
126* For developers - added/updated RPC commands (which can be used for GUI etc.):
127** Getting system info added new options, for example description of interface: link:trex_rpc_server_spec.html#_get_system_info[get_system_info]
128** Setting port attributes added new options: link:trex_rpc_server_spec.html#_setting_port_attributes[set_port_attr]
129** Getting xstats names (can be polled once and then combined with updated values): link:trex_rpc_server_spec.html#_get_xstat_names[get_port_xstats_names]
130** Getting xstats values: link:trex_rpc_server_spec.html#_get_xstat_values[get_port_xstats_values]
131
132=== fix issues: ===
133
134* link:https://trex-tgn.cisco.com/youtrack/issue/trex-253[trex-253]
135* link:https://trex-tgn.cisco.com/youtrack/issue/trex-212[trex-212]
136* link:https://trex-tgn.cisco.com/youtrack/issue/trex-251[trex-251]
137
138== Release 2.09 ==
139
140* Stateless, split to core algorithm is more accurate and simple see link:trex_stateless.html#_tutorial_field_engine_split_to_core[split_to_core] 
141* Add repeatable random instruction see an example link:https://github.com/cisco-system-traffic-generator/trex-core/tree/master/scripts/stl/udp_1pkt_repeat_random.py[stl/udp_1pkt_repeat_random.py] link:cp_stl_docs/api/field_engine.html#stlvmflowvarrepetablerandom[repetable_random] and link:trex_rpc_server_spec.html#_repetable_random[repetable_random_spec]
142* Add TCP/UDP checksum fix instruction see an example link:https://github.com/cisco-system-traffic-generator/trex-core/tree/master/scripts/stl/syn_attack_fix_cs_hw.py[stl/syn_attack_fix_cs_hw.py] link:cp_stl_docs/api/field_engine.html#stlvmfixchecksumhw[fix checksum] and link:trex_rpc_server_spec.html#_fix_checksum_hw[fix_checksum_hw_spec]
143* Improve Stateless Field Engine (FE) performance
144* Support dual mode for push pcap/remote Python API. see here link:cp_stl_docs/api/client_code.html#trex_stl_lib.trex_stl_client.STLClient.push_remote[push_remote] and link:cp_stl_docs/api/client_code.html#trex_stl_lib.trex_stl_client.STLClient.push_pcap[push_pcap] Using this feature pcap can be splited to client/server ports
145* Add infra for L2 emulation support 
146
147=== fix issues: ===
148
149* link:http://trex-tgn.cisco.com/youtrack/issue/trex-243[trex-243] 
150* link:http://trex-tgn.cisco.com/youtrack/issue/trex-247[trex-247] 
151* link:http://trex-tgn.cisco.com/youtrack/issue/trex-244[trex-244] 
152* link:http://trex-tgn.cisco.com/youtrack/issue/trex-249[trex-249] 
153
154== Release 2.08  ==
155
156* Scapy JSON-RPC server for GUI packet crafting, see  link:trex_scapy_rpc_server.html[trex_scapy_rpc_server]
157* Client.start Python API supports Core mask  - significantly improve the Stateless performance. link:cp_stl_docs/_modules/trex_stl_lib/trex_stl_client.html#STLClient.start[start API],  and link:trex_stateless.html#_core_masking_per_interface[core_masking]
158* Upgrade the ./dpdk_setup_ports.py script. It simplifies the way to create first time *optimized* config file (/etc/trex_cfg.yaml). More info at the manual: link:trex_manual.html#_script_for_creating_config_file[Script for creating config file]
159
160[source,bash]
161----
162$sudo ./dpdk_setup_ports.py -t            # show the list of ports
163$sudo ./dpdk_setup_ports.py -l            # return DPDK interfaces to Linux (if there is proper Linux driver)
164$sudo ./dpdk_setup_ports.py -i            # interactive creation of config file
165$sudo ./dpdk_setup_ports.py -c 03:00.0 03:00.1 -o /etc/trex_cfg.yaml # create optimum /etc/trex_cfg.yaml file
166----
167
168* Preliminary Cisco VIC support. Advanced Stateless/Stateful functionality is still not supported.
169* Enforce latest firmware for XL710/X710 (5.04)
170* Add a way to stop/close NICS at TRex termination (link would be down) `-close-at-end`
171* IPv6 XL710 ICMP packets are supported now
172
173=== fix issues: ===
174
175* link:http://trex-tgn.cisco.com/youtrack/issue/trex-240[trex-240] 
176* link:http://trex-tgn.cisco.com/youtrack/issue/trex-242[trex-242]
177* link:http://trex-tgn.cisco.com/youtrack/issue/trex-246[trex-246] 
178
179== Release 2.07  ==
180
181* DPDK 16.07 
182* ASYNC ZMQ is compressed by default. It improves response time see link:http://trex-tgn.cisco.com/youtrack/issue/trex-232[trex-232] 
183** You will need to update the GUI
184* Support Ubuntu 16.01 - Stateful serverr is Python 3.0 and Python 3.5 for ZMQ library 
185* XL710/X710 low latency was improved -  see link:http://trex-tgn.cisco.com/youtrack/issue/trex-214[trex-214] 
186* Support graceful shutdown command 
187* Console -  support L1 BPS  using `-m 10bpsl1` see link:http://trex-tgn.cisco.com/youtrack/issue/trex-230[trex-230] 
188* Improve TUI refresh time 
189* Support IPV6 latency streams (support is available for all interface types except 82599) see link:trex_stateless.html#_tutorial_per_stream_latency_jitter_packet_errors[IPV6 latency]
190
191[IMPORTANT]
192=====================================
193For XL710/X710 there is a need to upgrade the firmware to 5.04 (or later)
194=====================================
195
196=== fix issues: ===
197
198* link:http://trex-tgn.cisco.com/youtrack/issue/trex-214[trex-214] 
199* link:http://trex-tgn.cisco.com/youtrack/issue/trex-223[trex-223] 
200* link:http://trex-tgn.cisco.com/youtrack/issue/trex-226[trex-226] 
201* link:http://trex-tgn.cisco.com/youtrack/issue/trex-224[trex-224] 
202* link:http://trex-tgn.cisco.com/youtrack/issue/trex-235[trex-235] 
203* link:http://trex-tgn.cisco.com/youtrack/issue/trex-236[trex-236] 
204* link:http://trex-tgn.cisco.com/youtrack/issue/trex-238[trex-238] 
205* link:http://trex-tgn.cisco.com/youtrack/issue/trex-233[trex-233] 
206* link:http://trex-tgn.cisco.com/youtrack/issue/trex-231[trex-231] 
207
208
209== Release 2.06  ==
210
211* Support APIC-EM scale Stateful VLAN/IP/MAC mapping.
212* TCP SYN Randomization learning support for advanced ASA stateful testing - link:trex_manual.html#_nat_support[here] and link:trex_manual.html#_trex_with_asa_5585[here]
213* Advanced to latest DPDK 16.07RC3 - fix some XL710 driver performance issues
214
215=== fix issues: ===
216
217* link:http://trex-tgn.cisco.com/youtrack/issue/trex-229[trex-229] 
218* link:http://trex-tgn.cisco.com/youtrack/issue/trex-227[trex-227] 
219
220
221== Release 2.05  ==
222
223
224=== fix issues: ===
225
226* link:http://trex-tgn.cisco.com/youtrack/issue/trex-221[trex-221] 
227* link:http://trex-tgn.cisco.com/youtrack/issue/trex-220[trex-220] 
228* link:http://trex-tgn.cisco.com/youtrack/issue/trex-219[trex-219] 
229* link:http://trex-tgn.cisco.com/youtrack/issue/trex-218[trex-218] 
230* link:http://trex-tgn.cisco.com/youtrack/issue/trex-217[trex-217] 
231* link:http://trex-tgn.cisco.com/youtrack/issue/trex-216[trex-216] 
232
233
234== Release 2.04  ==
235
236* Watchdog support
237* Ability to export core file 
238* Optimized the case of Latency stream, Field Engine and 9K template packets 
239
240=== fix issues: ===
241
242* XL710/X710 present high latency with 9K packets  link:http://trex-tgn.cisco.com/youtrack/issue/trex-214[trex-214] 
243* The latency seq number gets out of sync link:http://trex-tgn.cisco.com/youtrack/issue/trex-215[trex-215]
244* Port/Latency stats should be with FCS  link:http://trex-tgn.cisco.com/youtrack/issue/trex-213[trex-213]
245* Stateless Unicode is not accepted for multiplier API see  link:https://github.com/cisco-system-traffic-generator/trex-core/issues/15[github-issue15]
246
247
248== Release 2.03  ==
249
250* More accurate stateless latency/more TUI support
251* Speedup DPDK XL710 fdir driver
252
253=== fix issues: ===
254
255* Disconnect issue link:http://trex-tgn.cisco.com/youtrack/issue/trex-210[trex-210]
256
257
258== Release 2.02  ==
259
260* The python latency statistic is compatible to JSON for easy manipulation 
261* Add latency minimum value Python API taken from histogram 
262
263=== fix issues: ===
264
265* Fix corruption of mbuf in case of with high rate latency stream. 
266
267== Release 2.01  ==
268
269* First release of latency/jitter per stream see link:trex_stateless.html#_tutorial_per_stream_latency_jitter_packet_errors[here] 
270* Ability to send server side pcap file - unlimited pcap file size see link:/cp_stl_docs/_modules/trex_stl_lib/trex_stl_client.html#STLClient.push_remote[here] and link:trex_stateless.html#_pcap_based_traffic_tutorials[PCAP tutorial]
271* Significatly improve performance for both Stateful and Stateless - in some cases up to x2 due to Scheduler/CPU utilization rewrite 
272* CPU utilization estimation is done differently 
273* Ability to significatly improve performance for Stateless profile with Field engine (up to x5, 22MPPS) see link:trex_stateless.html#_tutorial_field_engine_significantly_improve_performance[here]
274* Add documentation index link:index.html[index]
275* Fix documentation Table of Content javascript 
276* Update Stateless presentation link:http://www.slideshare.net/HanochHaim/trex-realistic-traffic-generator-stateless-support[Statelss presenation]
277* Stateful Python server API - Add support for iterator of remote file for Stateful GUI
278
279=== fix issues: ===
280
281* Performance issue, link:http://trex-tgn.cisco.com/youtrack/issue/trex-207[trex-207]
282* Sporadic timeout on wait_on_traffic() API see link:http://trex-tgn.cisco.com/youtrack/issue/trex-209[trex-209] 
283
284== Release 2.00  ==
285
286* Console 
287** Support partial port acquire using new CLI switch `-a ACQUIRE` (first phase)
288** Add tx/rx graphs 
289* Python API: add an API for reading events as warning/errors
290* HLTAPI support for per stream stats  
291* support VALN mode for per stream stats for 82599 using `--vlan` switch at server invocation
292* A peek into TRex stateless GUI version for evaluation still without many features like packet builder, advance packet builder, per stream stats link:https://www.dropbox.com/s/vs9gojtdc5ewv05/setupCiscoTrex1.96-SNAPSHOT.exe?dl=0[TRex Stateless GUI Download]
293** Only pcap file packet builder is supported in this version 
294
295image::images/trex_stl_gui.png[title="TRex Stateless GUI",align="left",width=600, link="images/trex_stl_gui.png"]
296
297=== fix issues: ===
298
299* X710/XL710 per stream hardware stats 
300** link:http://trex-tgn.cisco.com/youtrack/issue/trex-199[trex-199]
301** Fix issue of RX bytes 
302** Fix issue with mbuf leak
303* Packet Memory shortage fix link:http://trex-tgn.cisco.com/youtrack/issue/trex-197[trex-197]
304* Python Examples - move all examples to be 16.0.0.x/48.0.0.x for some refactor 
305
306
307== Release 1.99  ==
308
309
310* The Client package includes Console/examples 
311* Client API verification mechanism. The client should match the server version range 
312
313=== fix issues: ===
314
315* link:http://trex-tgn.cisco.com/youtrack/issue/trex-193[trex-193]
316* Python2/Python3 client API hardening 
317* Per stream statistics in software hardening - add support for wait on rx packets
318
319
320== Release 1.98  ==
321
322* Minor Console issue 
323* [red]*Image is broken* see link:http://trex-tgn.cisco.com/youtrack/issue/trex-193[trex-193]  
324
325== Release 1.97  ==
326
327* Support pyATS with Python 3/32bit
328* Per stream statistic supported by software for I350/82559/VXNET3 
329* [red]*Image is broken* see link:http://trex-tgn.cisco.com/youtrack/issue/trex-193[trex-193]  
330
331== Release 1.96  ==
332
333* Support pyATS/32bit/Python2.x for TCL 
334* Traffic profile direction/port directive works see link:draft_trex_stateless.html#_tutorial_advance_traffic_profile[here]
335* Documentation 
336** Add Python API documentation link:cp_stl_docs/index.html[here]
337** Add pyATS2.0 support link:cp_stl_docs/index.html[here]
338** Update per stream statistic documentation see link:draft_trex_stateless.html#_tutorial_per_stream_statistics[per stream statistic] 
339** Update HLTAPI arguments link:draft_trex_stateless.html#_hlt_supported_arguments_a_id_altapi_support_a[HLTAPI] 
340
341=== fix issues: ===
342
343* Per stream statistic - Fix High speed of start/stop of  giving zero in statistics
344* Fix E1000 DPDK driver prints with ESXi
345
346
347== Release 1.95  ==
348
349* TUI support per stream stats (press s to get to this window)
350* per stream statistic API examples 
351* Add Python API automatic documentation scripts 
352* Fix issue with a packet smaller than 64 bytes
353
354=== Known issue 
355
356* High speed of start/stop of per stream stats give zero in statistics
357 
358
359== Release 1.94  ==
360
361* Fix Python API stop/sync issue. Now TX counters are synced in case of stop API 
362* Improve performance of Python API, ~2000 cycles/sec of load/start/stop
363* Add per stream Tx/Rx statistics for XL710/X710 NICS work in flow-director hardware
364
365[source,python]
366----
367class STLS1(object):
368
369    def get_streams (self, direction = 0):
370        return [STLStream(packet = 
371                          STLPktBuilder(
372                          pkt ="stl/yaml/udp_64B_no_crc.pcap"), 
373                          mode = STLTXCont(pps=10),
374                          rx_stats = STLRxStats(user_id = 7))   <1> 
375               ]
376----
377<1> Configure this stream to be count on all RX ports as user_id=7
378
379* Add HTLAPI full example (examples `examples/hlt_udp_simple.py`)
380* Add user manual draft for Stateless functionality link:draft_trex_stateless.html[here]
381
382
383== Release 1.93  ==
384
385* Support port attribute API and Console command.  See `$portattr -a --prom`
386* Support random seed per Stream attribute - see specification for more info
387* Add more sample/profiles (stl/hlt) from real use cases
388* Enhance Field Engine with new instructions
389* TUI now shows L1 and L2 bandwidth. Console support L1 and L2 and %%
390* Stream rate can be configured with PPS/bps_L1/bps_L2/port_percentage 
391* Update Stateless JSON-RPC specification  
392* HLT fixes and support split_by variable 
393* First phase of per stream rx/tx statistic - XL710/X710 hardware support
394
395=== fix issues: ===
396
397* Fix some typo in Python API stl/example folder 
398* Fix Field Engine IPv4 checksum issue with big packet size  
399* Fix Field Engine issue with random variables 
400* Fix `streams -a` crash 
401* Fix X710 issue. Now return speed of 10gb instead of 40gb for Stateless port speed 
402
403
404== Release 1.92  ==
405
406** Stream can set static Source/Destination MAC-Address as oppose to the default (TRex port from /etc/trex_config.yaml)
407
408[source,python]
409----
410def create_stream (self):
411 base_pkt =  Ether(src="00:00:dd:dd:00:01")/IP()/UDP() 
412 pad = max(0, size - len(base_pkt)) * 'x'
413----
414
415** Stream support action_count. Loop of streams can end after action_count number. The push command uses this new feature to import pcap to streams and stop after x iteration. 
416
417[source,python]
418----
419STLStream(  self_start = False, 
420            name   ='S2',
421            packet = STLPktBuilder(pkt = base_pkt2/pad),
422            mode = STLTXSingleBurst( pps = 10, total_pkts = 3 ),
423            action_count = 2, # loop 2 times 
424            next    = 'S0' 
425           )
426----
427
428** Support new Field-Engine instructions (variable with step and write with mask). See new sample folder and specification for more info
429
430[source,python]
431----
432def create_stream (self):
433
434    # 2 MPLS label the internal with  s=1 (last one)
435    pkt =  Ether()/MPLS(label=17,cos=1,s=0,ttl=255)/MPLS(label=0,cos=1,s=1,ttl=12)/IP()/UDP()/('x'*20)
436
437    vm = CTRexScRaw( [ STLVmFlowVar(name="mlabel", min_value=1, max_value=2000, size=2, op="inc"), 
438                       STLVmWrMaskFlowVar(fv_name="mlabel", pkt_offset= "MPLS:1.label",pkt_cast_size=4, mask=0xFFFFF000,shift=12) # write mask
439                      ]
440                   )
441----
442
443[source,python]
444----
445 vm = CTRexScRaw( [ STLVmFlowVar(name="mac_src", min_value=1, max_value=30, size=1, op="dec",step=7), # step 
446                STLVmWrFlowVar(fv_name="mac_src", pkt_offset= 11) 
447               ]
448            )
449----
450
451** More profile samples (native/hlt)
452
453
454== Release 1.91  ==
455
456* Convert Stateless traffic profile to Scapy see `stl/*.py` sample folder
457* Add HLTAPI tests and profile `stl/hlt/*.py`
458* Fix simulator path issue fix
459* The Stateless python library is not self-contained.  in `automation/trex_control_plane/stl/` library is `automation/trex_control_plane/stl/trex_stl_lib/` (import trex_stl_lib)
460
461How to run the simulator 
462[source,bash]
463----
464./stl-sim -f stl/udp_1pkt_range_clients_split.py -o b.pcap -l 100 -c 2
465----
466
467* Add push command to convert pcap to streams 
468
469-------------------
470TRex > push --help
471usage: push [-h] -f FILE [--port PORTS [PORTS ...] | -a] [-d TIME]
472            [-i IPG_USEC] [-s SPEEDUP] [--force]
473
474optional arguments:
475  -h, --help            show this help message and exit
476  -f FILE               File path to load
477  --port PORTS [PORTS ...]
478                        A list of ports on which to apply the command
479  -a                    Set this flag to apply the command on all available
480                        ports
481  -d TIME               Set duration time for job.
482  -i IPG_USEC, --ipg IPG_USEC
483                        IPG value in usec between packets. default will be
484                        from the pcap
485  -s SPEEDUP, --speedup SPEEDUP
486                        Factor to accelerate the injection. effectively means
487                        IPG = IPG / SPEEDUP
488  --force               Set if you want to stop active ports before appyling
489                        command.
490TRex >push -f cap2/dns.pcap  --port 0 -i 10  
491-------------------
492
493
494
495== Release 1.90  ==
496
497* Missing file in the pkg
498
499== Release 1.89  ==
500
501* Integrate Scapy as a packet builder see `stl/profiles` folder 
502* Improve Python API, samples can be seen link:https://github.com/cisco-system-traffic-generator/trex-core/tree/master/scripts/api/stl/examples[here] 
503* Add Stateless simulator into the package 
504
505Example how to run 
506[source,bash]
507----
508./stl-sim -f stl/profiles/udp_1pkt.py -l 10 -o a.pcap            #<1>
509./stl-sim -f stl/profiles/udp_1pkt_tuple_gen.py -l 20 -o a.pcap  #<2>
510./stl-sim -f stl/profiles/imix.py -l 100 -o a.pcap  --json       #<3>
511----
512<1> Limit the number of packets to 10 
513<2> Tuple generator example 
514<3> imix 
515
516The simulator takes Stateless profile,YAML or Py and output pcap file or json  
517
518* Console can load the new Python profile 
519
520[source,bash]
521----
522TRex > start -f stl/profiles/udp_1pkt.py -a -m 1mbps 
523----
524
525* Basic Python HLTAPI support 
526
527=== fix issues: ===
528
529* Dependent streams (e.g. `stl/burst_1000_pkt.yaml`) can be loaded 
530
531== Release 1.88  ==
532
533* Add the Python API to the package 
534* Remove mock support 
535
536== Release 1.87  ==
537
538* Fix some 82599 ierror in case of high rate 
539* First Stateless API examples under api folder (not part of the package)
540
541
542== Release 1.86  ==
543
544* NAT Cisco ASA support 
545** Add support for learning using TCP-ACK field see more here link:trex_manual.html#_nat_support[here] and link:trex_manual.html#_trex_with_asa_5585[here]
546* More stateless support 
547
548== Release 1.85  ==
549
550* Upgrade to DPDK 2.2.0  
551** Some XL710/X710 NIC phy issues solved
552** VMXNET3 driver is optimized 
553** Cisco VIC should be supported, not tested yet
554* Jumbo packet size is supported for 1/10/40 Intel NIC  up to 9K for both stateless and stateful 
555* youTrack is public now, can be seen here link:http://trex-tgn.cisco.com/youtrack[here] 
556* More stateless support 
557** Support random packet size trim instruction - see stl/udp_rand_size_9k.yaml for an example
558** Move Python Regression to trex-core 
559** Add Coverity scripts 
560** Console/Python API can be call from Cisco CEL now (ZMQ Python library is compiled to an old glibc)
561** Add simulator for stateless 
562
563=== fix issues: ===
564
565* The infamous DPDK error is not seen in case of a wrong core argument see here link:http://trex-tgn.cisco.com/youtrack/issue/trex-147[trex-147] 
566
567== Release 1.84  ==
568
569* more stateless support
570** Add splitter range support see "split_by_var" in style/imix_1pkt_vm. yaml
571** Add more samples see stl/syn_attack_sample.yaml. Improve random performance 
572** more improvement with TUI window
573
574
575== Release 1.83  ==
576
577* more stateless support
578** Add basic Packet Field engine see stl/imin_1pkt_vm.yaml
579** some improvement with TUI window. Can be run in parallel with --tui option
580
581== Release 1.82  ==
582
583* more stateless support
584** console stats/tui function works now 
585** R/W support. only one client has R/W capability 
586* XL710/X710 support ICMP filter 
587
588=== fix issues: ===
589
590* link:http://trex-tgn.cisco.com/youtrack/trex-110[trex-110]
591
592
593== Release 1.81  ==
594
595* more stateless support and fixes 
596** change the JSON-RPC result format 
597* Support for specifying different modes for the packets used for latency measurement. Details link:trex_manual.html#_measure_jitter_latency[here].
598
599=== fix issues: ===
600
601* link:http://trex-tgn.cisco.com/youtrack/issue/trex-149[trex-149]
602
603== Release 1.80  ==
604
605* more stateless support
606** All type of streams are supported (Continues/Burst/Multi-burst)
607** Stream can call to other streams
608** start/stop/pause/resume work from the Console
609** -m[rate] is supported for example -m10gbps or -m10kpps from console 
610** update XL710 installation support 
611
612== Release 1.79  ==
613
614* Initial support for stateless 
615** Only continues streams are supported 
616** more info how to enable the interactive shell link:trex_console.html[here]
617
618== Release 1.78  ==
619
620* some clean up in tuple generator 
621* trex stateles console works with trex-mock
622
623=== fix issues: ===
624
625Python API fixup see here  
626
627* link:http://trex-tgn.cisco.com/youtrack/issue/trex-126[trex-126] 
628* link:http://trex-tgn.cisco.com/youtrack/issue/trex-123[trex-122] 
629
630Check for 64bit Kernel
631
632* link:http://trex-tgn.cisco.com/youtrack/issue/trex-123[trex-123] 
633
634== Release 1.77  ==
635
636* improve tuple generator capability now it is more flexiable see more link:trex_manual.html#_clients_servers_ip_allocation_scheme[here]
637
638== Release 1.76  ==
639
640=== fix issues: ===
641
642* minor pcap loader issues  
643* plugin cleanup 
644                 
645
646== Release 1.75  ==
647
648=== fix issues: ===
649
650* First version that works from GitHub/Git - init script are in the output package 
651
652== Release 1.72  ==
653
654
655