CSIT-1186: Add srv6 NDRPDR suites
[csit.git] / resources / libraries / robot / performance / performance_utils.robot
index 1de57b9..4cabe56 100644 (file)
 | ... | and PDR.
 
 *** Keywords ***
+| Get Max Rate And Jumbo
+| | [Documentation]
+| | ... | Argument framesize can be either integer in case of a single packet
+| | ... | in stream, or IMIX string defining mix of packets.
+| | ... | For jumbo frames detection, the maximal packet size is relevant.
+| | ... | For maximal transmit rate, the average packet size is relevant.
+| | ... | In both cases, encapsulation overhead (if any) has effect.
+| | ... | The maximal rate is computed from line limit bandwidth,
+| | ... | but NICs also have an independent limit in packet rate.
+| | ... | For some NICs, the limit is not reachable (bps limit is stricter),
+| | ... | in those cases None is used (meaning no limiting).
+| | ...
+| | ... | This keyword returns computed maximal unidirectional transmit rate
+| | ... | and jumbo boolean (some suites need that).
+| | ...
+| | ... | *Arguments:*
+| | ... | - bps_limit - Line rate limit in bps. Type: integer
+| | ... | - framesize - Framesize in bytes or IMIX. Type: integer or string
+| | ... | - overhead - Overhead in bytes. Default: 0. Type: integer
+| | ... | - pps_limit - NIC limit rate value in pps. Type: integer or None
+| | ...
+| | ... | *Returns:*
+| | ... | - 2-tuple, consisting of:
+| | ... |   - Calculated unidirectional maximal transmit rate.
+| | ... |     Type: integer or float
+| | ... |   - Jumbo boolean, true if jumbo packet support has to be enabled.
+| | ... |     Type: boolean
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Get Max Rate And Jumbo | \${10000000} \| IMIX_v4_1 \
+| | ... | \| overhead=\${40} \| pps_limit=\${18750000} \|
+| | ...
+| | [Arguments] | ${bps_limit} | ${framesize}
+| | ... | ${overhead}=${0} | ${pps_limit}=${None}
+| | ...
+| | ${avg_size} = | Set Variable If | '${framesize}' == 'IMIX_v4_1'
+| | ... | ${353.83333} | ${framesize}
+| | ${max_size} = | Set Variable If | '${framesize}' == 'IMIX_v4_1'
+| | ... | ${1518} | ${framesize}
+| | # swo := size_with_overhead
+| | ${avg_swo} = | Evaluate | ${avg_size} + ${overhead}
+| | ${max_swo} = | Evaluate | ${max_size} + ${overhead}
+| | ${jumbo} = | Set Variable If | ${max_swo} < 1522
+| | ... | ${False} | ${True}
+| | # For testing None see: https://groups.google.com/\
+| | #                       forum/#!topic/robotframework-users/XntFz0ocD9E
+| | ${limit_set} = | Set Variable | ${pps_limit != None}
+| | ${rate} = | Evaluate | (${bps_limit}/((${avg_swo}+20)*8)).__trunc__()
+| | ${max_rate} = | Set Variable If | ${limit_set} and ${rate} > ${pps_limit}
+| | ... | ${pps_limit} | ${rate}
+| | Return From Keyword | ${max_rate} | ${jumbo}
+
+| Get Max Rate And Jumbo And Handle Multi Seg
+| | [Documentation]
+| | ... | This keyword adds correct multi seg configuration,
+| | ... | then returns the result of Get Max Rate And Jumbo keyword.
+| | ...
+| | ... | See Documentation of Get Max Rate And Jumbo for more details.
+| | ...
+| | ... | *Arguments:*
+| | ... | - bps_limit - Line rate limit in bps. Type: integer
+| | ... | - framesize - Framesize in bytes. Type: integer or string
+| | ... | - overhead - Overhead in bytes. Default: 0. Type: integer
+| | ... | - pps_limit - NIC limit rate value in pps. Type: integer or None
+| | ...
+| | ... | *Returns:*
+| | ... | - 2-tuple, consisting of:
+| | ... |   - Calculated unidirectional maximal transmit rate.
+| | ... |     Type: integer or float
+| | ... |   - Jumbo boolean, true if jumbo packet support has to be enabled.
+| | ... |     Type: boolean
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Get Max Rate And Jumbo And Handle Multi Seg | \${10000000} \
+| | ... | \| IMIX_v4_1 \| overhead=\${40} \| pps_limit=\${18750000} \|
+| | ...
+| | [Arguments] | ${bps_limit} | ${framesize}
+| | ... | ${overhead}=${0} | ${pps_limit}=${None}
+| | ...
+| | ${max_rate} | ${jumbo} = | Get Max Rate And Jumbo
+| | ... | ${bps_limit} | ${framesize} | ${overhead} | ${pps_limit}
+| | Run Keyword If | not ${jumbo} | Add no multi seg to all DUTs
+| | Return From Keyword | ${max_rate} | ${jumbo}
+
 | Calculate pps
 | | [Documentation]
 | | ... | Calculate pps for given rate and L2 frame size,
 | | ... | additional 20B are added to L2 frame size as padding.
 | | ...
+| | ... | FIXME: Migrate callers to Get Max Rate And Jumbo
+| | ...
 | | ... | *Arguments*
 | | ... | - bps - Rate in bps. Type: integer
 | | ... | - framesize - L2 frame size in Bytes. Type: integer
 | | ... | in stream, or set of packets in case of IMIX type or simmilar.
 | | ... | This keyword returns average framesize.
 | | ...
+| | ... | FIXME: Migrate callers to Get Max Rate And Jumbo
+| | ...
 | | ... | *Arguments:*
 | | ... | - framesize - Framesize. Type: integer or string
 | | ...
 | | ... | Find boundaries for RFC2544 compatible NDR and PDR values
 | | ... | using an optimized search algorithm.
 | | ... | Display results as formatted test message.
-| | ... | Fail if a resulting lower bound has too high drop fraction.
+| | ... | Fail if a resulting lower bound has too high loss fraction.
 | | ... | Proceed with Perform additional measurements based on NDRPDR result.
+| | ... | Input rates are understood as uni-directional,
+| | ... | reported result contains bi-directional rates.
+| | ...
 | | ... | TODO: Should the trial duration of the additional
 | | ... | measurements be configurable?
 | | ...
 | | ... | *Arguments:*
 | | ... | - frame_size - L2 Frame Size [B] or IMIX string. Type: int or str
 | | ... | - topology_type - Topology type. Type: string
-| | ... | - fail_rate - Lower limit of search [pps]. Type: float
-| | ... | - line_rate - Upper limit of search [pps]. Type: float
-| | ... | - allowed_drop_fraction - Accepted loss during search. Type: float
+| | ... | - minimum_transmit_rate - Lower limit of search [pps]. Type: float
+| | ... | - maximum_transmit_rate - Upper limit of search [pps]. Type: float
+| | ... | - packet_loss_ratio - Accepted loss during search. Type: float
 | | ... | - final_relative_width - Maximal width multiple of upper. Type: float
 | | ... | - final_trial_duration - Duration of final trials [s]. Type: float
 | | ... | - initial_trial_duration - Duration of initial trials [s]. Type: float
 | | ...
 | | ... | \| Find NDR and PDR intervals using optimized search \| \${64} \| \
 | | ... | 3-node-IPv4 \| \${100000} \| \${14880952} \| \${0.005} \| \${0.005} \
-| | ... | \| \${30.0} \| \${1.0} \| \${2} \| ${600.0}
-| | ...
-| | [Arguments] | ${frame_size} | ${topology_type} | ${fail_rate} | ${line_rate}
-| | ... | ${allowed_drop_fraction}=${0.005} | ${final_relative_width}=${0.005}
-| | ... | ${final_trial_duration}=${30.0} | ${initial_trial_duration}=${1.0}
-| | ... | ${intermediate_phases}=${2} | ${timeout}=${600.0}
-| | ...
-| | ${result}= | Perform optimized ndrpdr search | ${frame_size}
-| | ... | ${topology_type} | ${fail_rate} | ${line_rate}
-| | ... | ${allowed_drop_fraction} | ${final_relative_width}
-| | ... | ${final_trial_duration} | ${initial_trial_duration}
-| | ... | ${intermediate_phases} | timeout=${timeout}
+| | ... | \| \${30.0} \| \${1.0} \| \${2} \| ${600.0} \|
+| | ...
+| | [Arguments] | ${frame_size} | ${topology_type} | ${minimum_transmit_rate}
+| | ... | ${maximum_transmit_rate} | ${packet_loss_ratio}=${0.005}
+| | ... | ${final_relative_width}=${0.005} | ${final_trial_duration}=${30.0}
+| | ... | ${initial_trial_duration}=${1.0}
+| | ... | ${number_of_intermediate_phases}=${2} | ${timeout}=${720.0}
+| | ...
+| | ${result} = | Perform optimized ndrpdr search | ${frame_size}
+| | ... | ${topology_type} | ${minimum_transmit_rate*2}
+| | ... | ${maximum_transmit_rate*2} | ${packet_loss_ratio}
+| | ... | ${final_relative_width} | ${final_trial_duration}
+| | ... | ${initial_trial_duration} | ${number_of_intermediate_phases}
+| | ... | timeout=${timeout}
 | | Display result of NDRPDR search | ${result} | ${frame_size}
 | | Check NDRPDR interval validity | ${result.pdr_interval}
-| | ... | ${allowed_drop_fraction}
+| | ... | ${packet_loss_ratio}
 | | Check NDRPDR interval validity | ${result.ndr_interval}
 | | Perform additional measurements based on NDRPDR result
 | | ... | ${result} | ${frame_size} | ${topology_type}
 | | ... | *Example:*
 | | ...
 | | ... | \| Display single bound \| NDR lower bound \| \${12345.67} \
-| | ... | \| \${64} \| show_latency=\${EMPTY}
+| | ... | \| \${64} \| show_latency=\${EMPTY} \|
 | | ...
 | | [Arguments] | ${text} | ${rate_total} | ${framesize} | ${latency}=${EMPTY}
 | | ...
 | | ...
 | | ... | *Example:*
 | | ...
-| | ... | \| Display result of NDRPDR search \| \${result} \| \${64}
+| | ... | \| Display result of NDRPDR search \| \${result} \| \${64} \|
 | | ...
 | | [Arguments] | ${result} | ${framesize}
 | | ...
 
 | Check NDRPDR interval validity
 | | [Documentation]
-| | ... | Extract drop fraction of lower bound of the interval.
+| | ... | Extract loss ratio of lower bound of the interval.
 | | ... | Fail if it does not reach the allowed value.
 | | ...
 | | ... | *Arguments:*
 | | ... | - interval - Measured interval. Type: ReceiveRateInterval
-| | ... | - allowed_drop_fraction - Accepted loss (0.0 for NDR). Type: float
+| | ... | - packet_loss_ratio - Accepted loss (0.0 for NDR). Type: float
 | | ...
 | | ... | *Example:*
 | | ...
 | | ... | \| Check NDRPDR interval validity \| \${result.pdr_interval} \
-| | ... | \| \${0.005}
+| | ... | \| \${0.005} \|
 | | ...
-| | [Arguments] | ${interval} | ${allowed_drop_fraction}=${0.0}
+| | [Arguments] | ${interval} | ${packet_loss_ratio}=${0.0}
 | | ...
-| | ${lower_bound_df}= | Set Variable | ${interval.measured_low.drop_fraction}
-| | Return From Keyword If | ${lower_bound_df} <= ${allowed_drop_fraction}
-| | ${messagge}= | Catenate | SEPARATOR=${SPACE}
-| | ... | Lower bound fraction ${lower_bound_df}
-| | ... | does not reach ${allowed_drop_fraction}.
+| | ${lower_bound_lf} = | Set Variable | ${interval.measured_low.loss_fraction}
+| | Return From Keyword If | ${lower_bound_lf} <= ${packet_loss_ratio}
+| | ${message}= | Catenate | SEPARATOR=${SPACE}
+| | ... | Minimal rate loss fraction ${lower_bound_lf}
+| | ... | does not reach target ${packet_loss_ratio}.
+| | ${message} = | Set Variable If | ${lower_bound_lf} >= 1.0
+| | ... | ${message}${\n}Zero packets forwarded! | ${message}
 | | Fail | ${message}
 
 | Perform additional measurements based on NDRPDR result
 | | ...
 | | ... | *Example:*
 | | ... | \| Perform additional measurements based on NDRPDR result \
-| | ... | \| \${result} \| ${64} \| 3-node-IPv4
+| | ... | \| \${result} \| ${64} \| 3-node-IPv4 \|
 | | ...
 | | [Arguments] | ${result} | ${framesize} | ${topology_type}
 | | ...
 | | ... | ${\n}LOSS_ACCEPTANCE: ${loss_acceptance} ${loss_acceptance_type}
 | | ... | append=yes
 
-| Display raw results
-| | [Documentation]
-| | ... | Display raw results from TG in total received/send packets over trial
-| | ... | duration in seconds.
-| | ...
-| | ... | *Arguments:*
-| | ... | - framesize - L2 Frame Size [B]. Type: integer
-| | ... | - results - Measured results. Type: string
-| | ...
-| | ... | *Example:*
-| | ...
-| | ... | \| Display raw results \| 64 \| results \|
-| | ...
-| | [Arguments] | ${framesize} | ${results}
-| | ...
-| | ${framesize}= | Get Frame Size | ${framesize}
-| | @{tokens}= | Split String | ${results} | ,
-| | @{received}= | Split String | @{tokens}[1] | =
-| | @{sent}= | Split String | @{tokens}[2] | =
-| | ${total_received} = | Set Variable | @{received}[1]
-| | ${total_sent} = | Set Variable | @{sent}[1]
-| | Set Test Message | MaxReceivedRate_Results [pkts/${perf_trial_duration}sec]:
-| | Set Test Message | tx ${total_sent}, rx ${total_received} | append=yes
-
 | Measure latency pps
 | | [Documentation]
 | | ... | Send traffic at specified rate. Measure min/avg/max latency
 | | ... | Send traffic at maximum rate.
 | | ...
 | | ... | *Arguments:*
-| | ... | - duration - Duration of traffic run [s]. Type: integer
 | | ... | - rate - Rate for sending packets. Type: string
 | | ... | - framesize - L2 Frame Size [B] or IMIX_v4_1. Type: integer/string
 | | ... | - topology_type - Topology type. Type: string
-| | ... | Type: boolean
+| | ... | - subsamples - How many trials in this measurement. Type:int
+| | ... | - trial_duration - Duration of single trial [s]. Type: float
+| | ... | - fail_no_traffic - Whether to fail on zero receive count. Type: boolean
 | | ...
 | | ... | *Example:*
 | | ...
-| | ... | \| Traffic should pass with no loss \| 10 \| 4.0mpps \| 64 \
-| | ... | \| 3-node-IPv4 \|
+| | ... | \| Traffic should pass with maximum rate \| 4.0mpps \| 64 \
+| | ... | \| 3-node-IPv4 \| ${1} \| ${10.0} | ${False} \|
 | | ...
-| | [Arguments] | ${duration} | ${rate} | ${framesize} | ${topology_type}
+| | [Arguments] | ${rate} | ${framesize} | ${topology_type}
+| | ... | ${trial_duration}=${perf_trial_duration} | ${fail_no_traffic}=${True}
+| | ... | ${subsamples}=${perf_trial_multiplicity}
 | | ...
-| | ${results}= | Send traffic at specified rate | ${duration} | ${rate}
-| | ... | ${framesize} | ${topology_type}
-| | Display raw results | ${framesize} | ${results}
+| | ${results} = | Send traffic at specified rate | ${trial_duration} | ${rate}
+| | ... | ${framesize} | ${topology_type} | ${subsamples}
+| | Set Test Message | ${\n}Maximum Receive Rate trial results
+| | Set Test Message | in packets per second: ${results}
+| | ... | append=yes
+| | # TODO: Should we also report the percentage relative to transmit rate,
+| | # so that people looking at console can decide how close to 100% it is?
+| | Run Keyword If | ${fail_no_traffic} | Fail if no traffic forwarded
 
 | Send traffic at specified rate
 | | [Documentation]
 | | ... | Send traffic at specified rate.
+| | ... | Return list of measured receive rates.
 | | ...
 | | ... | *Arguments:*
-| | ... | - duration - Duration of traffic run [s]. Type: integer
+| | ... | - trial_duration - Duration of single trial [s]. Type: float
 | | ... | - rate - Rate for sending packets. Type: string
 | | ... | - framesize - L2 Frame Size [B]. Type: integer/string
 | | ... | - topology_type - Topology type. Type: string
-| | ... | Type: boolean
+| | ... | - subsamples - How many trials in this measurement. Type: int
 | | ...
 | | ... | *Example:*
 | | ...
-| | ... | \| Send traffic at specific rate \| 10 \| 4.0mpps \| 64 \
-| | ... | \| 3-node-IPv4 \|
+| | ... | \| Send traffic at specified rate \| ${1.0} \| 4.0mpps \| 64 \
+| | ... | \| 3-node-IPv4 \| ${10} \|
 | | ...
-| | [Arguments] | ${duration} | ${rate} | ${framesize} | ${topology_type}
+| | [Arguments] | ${trial_duration} | ${rate} | ${framesize}
+| | ... | ${topology_type} | ${subsamples}=${1}
 | | ...
-| | Clear and show runtime counters with running traffic | ${duration}
+| | Clear and show runtime counters with running traffic | ${trial_duration}
 | | ... | ${rate} | ${framesize} | ${topology_type}
 | | Run Keyword If | ${dut_stats}==${True} | Clear all counters on all DUTs
 | | Run Keyword If | ${dut_stats}==${True} and ${pkt_trace}==${True}
 | | ... | VPP Enable Traces On All DUTs | ${nodes}
-| | ${results} = | Send traffic on tg | ${duration} | ${rate} | ${framesize}
-| | ... | ${topology_type} | warmup_time=0
-| | Run Keyword If | ${dut_stats}==${True} | Show statistics on all DUTs | ${nodes}
+| | ${results} = | Create List
+| | :FOR | ${i} | IN RANGE | ${subsamples}
+| | | Send traffic on tg | ${trial_duration} | ${rate} | ${framesize}
+| | | ... | ${topology_type} | warmup_time=0
+| | | ${rx} = | Get Received
+| | | ${rr} = | Evaluate | ${rx} / ${trial_duration}
+| | | Append To List | ${results} | ${rr}
+| | Run Keyword If | ${dut_stats}==${True} | Show statistics on all DUTs
+| | ... | ${nodes}
 | | Run Keyword If | ${dut_stats}==${True} and ${pkt_trace}==${True}
 | | ... | Show Packet Trace On All Duts | ${nodes} | maximum=${100}
 | | Return From Keyword | ${results}