diff options
| author |   Billy O'Mahony <billy.o.mahony@intel.com> | 2015-10-08 11:47:03 +0100 |
|---|---|---|
| committer |   Maryam Tahhan <maryam.tahhan@intel.com> | 2015-10-12 11:50:15 +0000 |
| commit | f8b7dd0a2611061fed7134474ae10ab85e80cf3d (patch) | |
| tree | dd450a4a92ffdd4ceb88b2f37ee07858ef1175db /docs/msc/traffic_controller.msc | |
| parent | 32d4bf344c538c7d9a17906994e34a8e431721bd (diff) | |
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<billy.o.mahony@intel.com>
Reviewed-by: Al Morton <acmorton@att.com>
Reviewed-by: Eugene Snider <Eugene.Snider@huawei.com>
Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com>
Reviewed-by: Gurpreet Singh <gurpreet.singh@spirent.com>
Reviewed-by: Brian Castelli <brian.castelli@spirent.com>
Change-Id: I33f57fba85710ab4cfc72d0a5d06db6f653545d6
Diffstat (limited to 'docs/msc/traffic_controller.msc')
| -rwxr-xr-x | docs/msc/traffic_controller.msc | 30 |
1 files changed, 30 insertions, 0 deletions
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 |