From f8b7dd0a2611061fed7134474ae10ab85e80cf3d Mon Sep 17 00:00:00 2001 From: Billy O'Mahony Date: Thu, 8 Oct 2015 11:47:03 +0100 Subject: docs: Add overview of the structure of vsperf code Text & sequence diagrams as both source and png. JIRA: VSPERF-106 Signed-off-by: Billy O'Mahony Reviewed-by: Al Morton Reviewed-by: Eugene Snider Reviewed-by: Maryam Tahhan Reviewed-by: Gurpreet Singh Reviewed-by: Brian Castelli Change-Id: I33f57fba85710ab4cfc72d0a5d06db6f653545d6 --- docs/msc/traffic_controller.msc | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100755 docs/msc/traffic_controller.msc (limited to 'docs/msc/traffic_controller.msc') diff --git a/docs/msc/traffic_controller.msc b/docs/msc/traffic_controller.msc new file mode 100755 index 00000000..bd66cce1 --- /dev/null +++ b/docs/msc/traffic_controller.msc @@ -0,0 +1,30 @@ + +# mscgen file +msc { + #Options + hscale = "1.5"; + + #Entities + testcase, traffic_ctlr, traffic_gen, traffic_defaults, HwSwTrafficGen; + + #Arcs + HwSwTrafficGen note HwSwTrafficGen [ label = "Ixia, Spirent, Xena, Moongen, etc."]; + testcase => traffic_ctlr [ label = "create(traffic_gen_class)" ]; + traffic_ctlr => traffic_gen [label = "create()"]; + traffic_ctlr => traffic_gen [label = "connect()"]; + testcase => traffic_ctlr [ label = "send_traffic(traffic)" ]; + --- [ label = "foreach packet_size in configuration"]; + traffic_ctlr note traffic_ctlr [ label = "invokes send_rfc2544_back2back/tput or send_cont based on traffic['traffic_type']; Also fetches duration/trials from config" ]; + traffic_ctlr => traffic_gen [ label = "send_rfc2544_tput(traffic, ...)" ]; + traffic_gen -> traffic_gen [ label = "start_rfc2544_tput(traffic)" ]; + traffic_gen => traffic_defaults [ label = "default_traffic_params = read()" ]; + traffic_gen note traffic_gen [ label = "merge traffic with default_traffic_params)" ]; + traffic_gen note traffic_gen [ label = "Actual test starts here. Details of interactions between traffic_gen class actual traffic generator (HwSwTrafficGen) are hidden to vsperf"]; + traffic_gen <=> HwSwTrafficGen [ label = "..."]; + traffic_gen => traffic_gen [ label = "wait_rfc2544_throughput()"]; + traffic_ctlr << traffic_gen [ label = "results (string/value pairs)"]; + traffic_ctlr note traffic_ctlr [ label = "store_results()" ]; + --- [ label = "end foreach"]; + testcase => traffic_ctlr [label = "get_results()"]; + testcase => testcase [label = "write_results_to_file"]; +} \ No newline at end of file -- cgit 1.2.3-korg