T-Rex: Add advanced stateful mode
[csit.git] / resources / libraries / robot / performance / performance_utils.robot
index 1ed7a14..f14d7bd 100644 (file)
@@ -15,6 +15,7 @@
 | Library | Collections
 | Library | resources.libraries.python.topology.Topology
 | Library | resources.libraries.python.NodePath
+| Library | resources.libraries.python.PerfUtil
 | Library | resources.libraries.python.InterfaceUtil
 | Library | resources.libraries.python.TrafficGenerator
 | Library | resources.libraries.python.TrafficGenerator.OptimizedSearch
 | Documentation
 | ... | Performance suite keywords - utilities to find and verify NDR and PDR.
 
+*** Variables ***
+| ${trial_duration}= | ${PERF_TRIAL_DURATION}
+| ${trial_multiplicity}= | ${PERF_TRIAL_MULTIPLICITY}
+| ${extended_debug}= | ${EXTENDED_DEBUG}
+
 *** Keywords ***
 | Find NDR and PDR intervals using optimized search
 | | [Documentation]
 | | ... | Fail if a resulting lower bound has too high loss fraction.
 | | ... | Input rates are understood as uni-directional,
 | | ... | reported result contains aggregate rates.
-| | ... | Currently, the min_rate value is hardcoded to match test teardowns.
+| | ... | Additional latency measurements are performed for smaller loads,
+| | ... | their results are also displayed.
+| | ... | Finally, two measurements for runtime stats are done (not displayed).
+| | ... | Currently, the min_rate value is hardcoded to 90kpps,
+| | ... | allowing measurement at 10% of the discovered rate
+| | ... | without breaking latency streams.
 | |
 | | ... | *Test (or broader scope) variables read:*
 | | ... | - traffic_profile - Name of module defining traffc for measurements.
@@ -68,8 +79,9 @@
 | | ... | ${doublings}=${2} | ${traffic_directions}=${2}
 | | ... | ${latency_duration}=${PERF_TRIAL_LATENCY_DURATION}
 | |
+| | # Latency measurements will need more than 9000 pps.
 | | ${result} = | Perform optimized ndrpdr search | ${frame_size}
-| | ... | ${traffic_profile} | ${10000} | ${max_rate}
+| | ... | ${traffic_profile} | ${9001} | ${max_rate}
 | | ... | ${packet_loss_ratio} | ${final_relative_width}
 | | ... | ${final_trial_duration} | ${initial_trial_duration}
 | | ... | ${number_of_intermediate_phases} | timeout=${timeout}
 | | Check NDRPDR interval validity | ${result.pdr_interval}
 | | ... | ${packet_loss_ratio}
 | | Check NDRPDR interval validity | ${result.ndr_interval}
-| | # Rate needs to be high enough for latency streams.
-| | ${rate}= | Set Variable | ${9500}
-| | Measure and show latency at specified rate | Latency at 0%:
-| | ... | ${latency_duration} | ${rate}pps | ${framesize}
-| | ... | ${traffic_profile} | ${traffic_directions}
+| | ${pdr_sum}= | Set Variable | ${result.pdr_interval.measured_low.target_tr}
+| | ${pdr_per_stream}= | Evaluate | ${pdr_sum} / float(${traffic_directions})
 | | ${ndr_sum}= | Set Variable | ${result.ndr_interval.measured_low.target_tr}
 | | ${ndr_per_stream}= | Evaluate | ${ndr_sum} / float(${traffic_directions})
-| | ${rate}= | Evaluate | 0.1 * ${ndr_per_stream}
-| | Measure and show latency at specified rate | Latency at 10% NDR:
-| | ... | ${latency_duration} | ${rate}pps | ${framesize}
-| | ... | ${traffic_profile} | ${traffic_directions}
-| | ${rate}= | Evaluate | 0.5 * ${ndr_per_stream}
-| | Measure and show latency at specified rate | Latency at 50% NDR:
-| | ... | ${latency_duration} | ${rate}pps | ${framesize}
+| | ${rate}= | Evaluate | 0.9 * ${pdr_per_stream}
+| | Measure and show latency at specified rate | Latency at 90% PDR:
+| | ... | ${latency_duration} | ${rate} | ${framesize}
 | | ... | ${traffic_profile} | ${traffic_directions}
-| | ${rate}= | Evaluate | 0.9 * ${ndr_per_stream}
-| | Measure and show latency at specified rate | Latency at 90% NDR:
-| | ... | ${latency_duration} | ${rate}pps | ${framesize}
+| | ${rate}= | Evaluate | 0.5 * ${pdr_per_stream}
+| | Measure and show latency at specified rate | Latency at 50% PDR:
+| | ... | ${latency_duration} | ${rate} | ${framesize}
 | | ... | ${traffic_profile} | ${traffic_directions}
-| | ${pdr_sum}= | Set Variable | ${result.pdr_interval.measured_low.target_tr}
-| | ${pdr_per_stream}= | Evaluate | ${pdr_sum} / float(${traffic_directions})
 | | ${rate}= | Evaluate | 0.1 * ${pdr_per_stream}
 | | Measure and show latency at specified rate | Latency at 10% PDR:
-| | ... | ${latency_duration} | ${rate}pps | ${framesize}
+| | ... | ${latency_duration} | ${rate} | ${framesize}
 | | ... | ${traffic_profile} | ${traffic_directions}
-| | ${rate}= | Evaluate | 0.5 * ${pdr_per_stream}
-| | Measure and show latency at specified rate | Latency at 50% PDR:
-| | ... | ${latency_duration} | ${rate}pps | ${framesize}
-| | ... | ${traffic_profile} | ${traffic_directions}
-| | ${rate}= | Evaluate | 0.9 * ${pdr_per_stream}
-| | Measure and show latency at specified rate | Latency at 90% PDR:
-| | ... | ${latency_duration} | ${rate}pps | ${framesize}
+| | Measure and show latency at specified rate | Latency at 0% PDR:
+| | ... | ${latency_duration} | ${0} | ${framesize}
 | | ... | ${traffic_profile} | ${traffic_directions}
 | | # Finally, trials with runtime and other stats.
 | | # We expect NDR and PDR to have different-looking stats.
 | | Send traffic at specified rate
-| | ... | ${1.0} | ${ndr_per_stream}pps | ${framesize} | ${traffic_profile}
+| | ... | ${1.0} | ${pdr_per_stream} | ${framesize} | ${traffic_profile}
 | | ... | traffic_directions=${traffic_directions}
 | | Send traffic at specified rate
-| | ... | ${1.0} | ${pdr_per_stream}pps | ${framesize} | ${traffic_profile}
+| | ... | ${1.0} | ${ndr_per_stream} | ${framesize} | ${traffic_profile}
 | | ... | traffic_directions=${traffic_directions}
 
 | Find Throughput Using MLRsearch
 | | ... | ${final_trial_duration} | ${initial_trial_duration}
 | | ... | ${number_of_intermediate_phases} | timeout=${timeout}
 | | ... | doublings=${doublings} | traffic_directions=${traffic_directions}
-| | Return From Keyword | ${result.pdr_interval.measured_low.transmit_rate}
+| | Check NDRPDR interval validity | ${result.pdr_interval}
+| | ... | ${packet_loss_ratio}
+| | Return From Keyword | ${result.pdr_interval.measured_low.target_tr}
 
 | Find critical load using PLRsearch
 | | [Documentation]
 | | ... | Find boundaries for troughput (of given target loss ratio)
 | | ... | using PLRsearch algorithm.
 | | ... | Display results as formatted test message.
-| | ... | Fail if computed lower bound is below minimal rate.
+| | ... | Fail if computed lower bound 110% of the minimal rate or less.
 | | ... | Input rates are understood as uni-directional,
 | | ... | reported result contains aggregate rates.
 | | ... | Currently, the min_rate value is hardcoded to match test teardowns.
 | | ... | traffic_directions=${traffic_directions}
 | | ${lower} | ${upper} = | Display result of soak search
 | | ... | ${average} | ${stdev}
-| | Should Not Be True | ${lower} < ${min_rate}
-| | ... | Lower bound ${lower} is below unidirectional minimum ${min_rate}.
+| | Should Not Be True | 1.1 * ${traffic_directions} * ${min_rate} > ${lower}
+| | ... | Lower bound ${lower} too small for unidirectional minimum ${min_rate}.
 
 | Display single bound
 | | [Documentation]
 | |
 | | ... | *Arguments:*
 | | ... | - result - Result of bidirectional measurtement.
-| | ... |   Type: ReceiveRateMeasurement
+| | ... | Type: ReceiveRateMeasurement
 | |
 | | ... | *Example:*
 | |
 | |
 | | ${frame_size} = | Get Average Frame Size | ${frame_size}
 | | Display single bound | NDR_LOWER
-| | ... | ${result.ndr_interval.measured_low.transmit_rate} | ${frame_size}
+| | ... | ${result.ndr_interval.measured_low.target_tr} | ${frame_size}
 | | ... | ${result.ndr_interval.measured_low.latency}
 | | Display single bound | NDR_UPPER
-| | ... | ${result.ndr_interval.measured_high.transmit_rate} | ${frame_size}
+| | ... | ${result.ndr_interval.measured_high.target_tr} | ${frame_size}
 | | Display single bound | PDR_LOWER
-| | ... | ${result.pdr_interval.measured_low.transmit_rate} | ${frame_size}
+| | ... | ${result.pdr_interval.measured_low.target_tr} | ${frame_size}
 | | ... | ${result.pdr_interval.measured_low.latency}
 | | Display single bound | PDR_UPPER
-| | ... | ${result.pdr_interval.measured_high.transmit_rate} | ${frame_size}
+| | ... | ${result.pdr_interval.measured_high.target_tr} | ${frame_size}
 
 | Display result of soak search
 | | [Documentation]
 | | ... | Type: float
 | |
 | | ... | *Arguments:*
-| | ... | - 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
+| | ... | - trial_duration - Duration of single trial [s].
+| | ... | Type: float
+| | ... | - fail_no_traffic - Whether to fail on zero receive count.
+| | ... | Type: boolean
+| | ... | - trial_multiplicity - How many trials in this measurement.
+| | ... | Type: int
 | | ... | - traffic_directions - Bi- (2) or uni- (1) directional traffic.
 | | ... | Type: int
-| | ... | - tx_port - TX port of TG, default 0. Type: integer
-| | ... | - rx_port - RX port of TG, default 1. Type: integer
+| | ... | - tx_port - TX port of TG, default 0.
+| | ... | Type: integer
+| | ... | - rx_port - RX port of TG, default 1.
+| | ... | Type: integer
 | |
 | | ... | *Example:*
 | |
 | | ... | \| Traffic should pass with maximum rate \| \${1} \| \${10.0} \
 | | ... | \| \${False} \| \${2} \| \${0} \| \${1} \|
 | |
-| | [Arguments] | ${trial_duration}=${PERF_TRIAL_DURATION}
-| | ... | ${fail_no_traffic}=${True} | ${subsamples}=${PERF_TRIAL_MULTIPLICITY}
+| | [Arguments] | ${trial_duration}=${trial_duration}
+| | ... | ${fail_no_traffic}=${True}
+| | ... | ${trial_multiplicity}=${trial_multiplicity}
 | | ... | ${traffic_directions}=${2} | ${tx_port}=${0} | ${rx_port}=${1}
+| | ... | ${latency}=${True}
 | |
-| | ${results} = | Send traffic at specified rate | ${trial_duration}
-| | ... | ${max_rate}pps | ${frame_size} | ${traffic_profile} | ${subsamples}
-| | ... | ${traffic_directions} | ${tx_port} | ${rx_port}
+| | ${results}= | Send traffic at specified rate
+| | ... | ${trial_duration} | ${max_rate} | ${frame_size}
+| | ... | ${traffic_profile} | ${trial_multiplicity}
+| | ... | ${traffic_directions} | ${tx_port} | ${rx_port} | latency=${latency}
 | | Set Test Message | ${\n}Maximum Receive Rate trial results
 | | Set Test Message | in packets per second: ${results}
 | | ... | append=yes
 | | ... | Then send traffic at specified rate, possibly multiple trials.
 | | ... | Show various DUT stats, optionally also packet trace.
 | | ... | Return list of measured receive rates.
-| | ... | The rate argument should be TRex friendly, so it should include "pps".
 | |
 | | ... | *Arguments:*
 | | ... | - trial_duration - Duration of single trial [s]. Type: float
-| | ... | - rate - Rate for sending packets. Type: string
+| | ... | - rate - Target aggregate transmit rate [pps] / Connections per second
+| | ... | (CPS) for UDP/TCP flows. Type: float
 | | ... | - frame_size - L2 Frame Size [B]. Type: integer/string
 | | ... | - traffic_profile - Name of module defining traffc for measurements.
 | | ... | Type: string
-| | ... | - subsamples - How many trials in this measurement. Type: int
+| | ... | - trial_multiplicity - How many trials in this measurement.
+| | ... | Type: int
 | | ... | - traffic_directions - Bi- (2) or uni- (1) directional traffic.
 | | ... | Type: int
-| | ... | - tx_port - TX port of TG, default 0. Type: integer
-| | ... | - rx_port - RX port of TG, default 1. Type: integer
-| | ... | - pkt_trace - True to enable packet trace. Type: boolean
+| | ... | - tx_port - TX port of TG, default 0.
+| | ... | Type: integer
+| | ... | - rx_port - RX port of TG, default 1.
+| | ... | Type: integer
+| | ... | - extended_debug- True to enable extended debug.
+| | ... | Type: boolean
 | |
 | | ... | *Example:*
 | |
-| | ... | \| Send traffic at specified rate \| \${1.0} \| 4.0mpps \| \${64} \
-| | ... | \| 3-node-IPv4 \| \${10} \| \${2} \| \${0} \| \${1} \| \${False} \|
+| | ... | \| Send traffic at specified rate \| \${1.0} \| ${4000000.0} \
+| | ... | \| \${64} \| 3-node-IPv4 \| \${10} \| \${2} \| \${0} \| \${1} \
+| | ... | \${False} \|
 | |
 | | [Arguments] | ${trial_duration} | ${rate} | ${frame_size}
-| | ... | ${traffic_profile} | ${subsamples}=${1} | ${traffic_directions}=${2}
-| | ... | ${tx_port}=${0} | ${rx_port}=${1} | ${pkt_trace}=${False}
+| | ... | ${traffic_profile} | ${trial_multiplicity}=${trial_multiplicity}
+| | ... | ${traffic_directions}=${2} | ${tx_port}=${0} | ${rx_port}=${1}
+| | ... | ${extended_debug}=${extended_debug} | ${latency}=${True}
 | |
+| | Set Test Variable | ${extended_debug}
 | | Clear and show runtime counters with running traffic | ${trial_duration}
 | | ... | ${rate} | ${frame_size} | ${traffic_profile}
 | | ... | ${traffic_directions} | ${tx_port} | ${rx_port}
-| | Run Keyword If | ${dut_stats}==${True}
-| | ... | Clear statistics on all DUTs | ${nodes}
-| | Run Keyword If | ${dut_stats}==${True} and ${pkt_trace}==${True}
-| | ... | VPP Enable Traces On All DUTs | ${nodes} | fail_on_error=${False}
-| | Run Keyword If | ${dut_stats}==${True}
-| | ... | VPP enable elog traces on all DUTs | ${nodes}
+| | FOR | ${action} | IN | @{pre_stats}
+| | | Run Keyword | Additional Statistics Action For ${action}
+| | END
 | | ${results} = | Create List
-| | FOR | ${i} | IN RANGE | ${subsamples}
+| | FOR | ${i} | IN RANGE | ${trial_multiplicity}
 | | | # The following line is skipping some default arguments,
 | | | # that is why subsequent arguments have to be named.
 | | | Send traffic on tg | ${trial_duration} | ${rate} | ${frame_size}
 | | | ... | ${traffic_profile} | warmup_time=${0}
 | | | ... | traffic_directions=${traffic_directions} | tx_port=${tx_port}
-| | | ... | rx_port=${rx_port}
+| | | ... | rx_port=${rx_port} | latency=${latency}
 | | | ${rx} = | Get Received
 | | | ${rr} = | Evaluate | ${rx} / ${trial_duration}
 | | | Append To List | ${results} | ${rr}
 | | END
-| | Run Keyword If | ${dut_stats}==${True} | Show event logger on all DUTs
-| | ... | ${nodes}
-| | 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}
+| | FOR | ${action} | IN | @{post_stats}
+| | | Run Keyword | Additional Statistics Action For ${action}
+| | END
 | | Return From Keyword | ${results}
 
 | Measure and show latency at specified rate
 | | [Documentation]
 | | ... | Send traffic at specified rate, single trial.
 | | ... | Extract latency information and append it to text message.
-| | ... | The rate argument should be TRex friendly, so it should include "pps".
+| | ... | The rate argument is int, so should not include "pps".
+| | ... | If the given rate is too low, a safe value is used instead.
 | |
 | | ... | *Arguments:*
 | | ... | - message_prefix - Preface to test message addition. Type: string
 | | ... | - trial_duration - Duration of single trial [s]. Type: float
-| | ... | - rate - Rate for sending packets. Type: string
+| | ... | - rate - Rate [pps] for sending packets in case of T-Rex stateless
+| | ... | mode or multiplier of profile CPS in case of T-Rex astf mode.
+| | ... | Type: float
 | | ... | - frame_size - L2 Frame Size [B]. Type: integer/string
 | | ... | - traffic_profile - Name of module defining traffic for measurements.
 | | ... | Type: string
 | | ... | Type: int
 | | ... | - tx_port - TX port of TG, default 0. Type: integer
 | | ... | - rx_port - RX port of TG, default 1. Type: integer
+| | ... | - safe_rate - To apply if rate is below this, as latency pps is fixed.
+| | ... | In pps, type int.
 | |
 | | ... | *Example:*
 | |
 | | ... | \| Measure and show latency at specified rate \| Latency at 90% NDR \
-| | ... | \| \${1.0} \| 4.0mpps \| \${64} \| 3-node-IPv4 \| \${2} \|
+| | ... | \| \${1.0} \| ${10000000} \| \${64} \| 3-node-IPv4 \| \${2} \
+| | ... | \| \${0} \| \${1} \| ${9500} \|
 | |
 | | [Arguments] | ${message_prefix} | ${trial_duration} | ${rate}
 | | ... | ${frame_size} | ${traffic_profile} | ${traffic_directions}=${2}
-| | ... | ${tx_port}=${0} | ${rx_port}=${1}
+| | ... | ${tx_port}=${0} | ${rx_port}=${1} | ${safe_rate}=${9001}
 | |
+| | ${real_rate} = | Evaluate | max(${rate}, ${safe_rate})
 | | # The following line is skipping some default arguments,
 | | # that is why subsequent arguments have to be named.
-| | Send traffic on tg | ${trial_duration} | ${rate} | ${frame_size}
+| | Send traffic on tg | ${trial_duration} | ${real_rate} | ${frame_size}
 | | ... | ${traffic_profile} | warmup_time=${0}
 | | ... | traffic_directions=${traffic_directions} | tx_port=${tx_port}
 | | ... | rx_port=${rx_port}
 | |
 | | ... | *Arguments:*
 | | ... | - duration - Duration of traffic run [s]. Type: integer
-| | ... | - rate - Unidirectional rate for sending packets. Type: string
+| | ... | - rate - Rate [pps] for sending packets in case of T-Rex stateless
+| | ... | mode or multiplier of profile CPS in case of T-Rex astf mode.
+| | ... | Type: float
 | | ... | - frame_size - L2 Frame Size [B] or IMIX_v4_1. Type: integer/string
 | | ... | - traffic_profile - Name of module defining traffc for measurements.
 | | ... | Type: string
 | | ... | *Example:*
 | |
 | | ... | \| Clear and show runtime counters with running traffic \| \${10} \
-| | ... | \| 4.0mpps \| \${64} \| 3-node-IPv4 \| \${2} \| \${0} \| \${1} \|
+| | ... | \| ${4000000.0} \| \${64} \| 3-node-IPv4 \| \${2} \| \${0} \| \${1} \|
 | |
 | | [Arguments] | ${duration} | ${rate} | ${frame_size} | ${traffic_profile}
 | | ... | ${traffic_directions}=${2} | ${tx_port}=${0} | ${rx_port}=${1}
 | | ... | warmup_time=${0} | async_call=${True} | latency=${False}
 | | ... | traffic_directions=${traffic_directions} | tx_port=${tx_port}
 | | ... | rx_port=${rx_port}
-| | Run Keyword If | ${dut_stats}==${True}
-| | ... | VPP clear runtime on all DUTs | ${nodes}
+| | FOR | ${action} | IN | @{pre_run_stats}
+| | | Run Keyword | Additional Statistics Action For ${action}
+| | END
 | | Sleep | ${duration}
-| | Run Keyword If | ${dut_stats}==${True}
-| | ... | VPP show runtime on all DUTs | ${nodes}
+| | FOR | ${action} | IN | @{post_run_stats}
+| | | Run Keyword | Additional Statistics Action For ${action}
+| | END
 | | Stop traffic on tg
 
 | Start Traffic on Background
 | | ... | Type: string
 | | ... | - frame_size - L2 Frame Size [B] or IMIX string. Type: int or str
 | | ... | *Arguments:*
-| | ... | - rate - Unidirectional rate for sending packets. Type: string
+| | ... | - rate - Rate [pps] for sending packets in case of T-Rex stateless
+| | ... | mode or multiplier of profile CPS in case of T-Rex astf mode.
+| | ... | Type: float
 | | ... | - traffic_directions - Bi- (2) or uni- (1) directional traffic.
 | | ... | Type: int
 | | ... | - tx_port - TX port of TG, default 0. Type: integer
 | |
 | | ... | *Example:*
 | |
-| | ... | \| Start Traffic on Background \| 4.0mpps \| \${2} \| \${0} \
+| | ... | \| Start Traffic on Background \| ${4000000.0} \| \${2} \| \${0} \
 | | ... | \| \${1} \|
 | |
 | | [Arguments] | ${rate} | ${traffic_directions}=${2} | ${tx_port}=${0}
 | |
 | | ${result}= | Stop traffic on tg
 | | Return From Keyword | ${result}
+
+| Additional Statistics Action For vpp-clear-stats
+| | [Documentation]
+| | ... | Additional Statistics Action for clear VPP statistics.
+| |
+| | Clear Statistics On All DUTs | ${nodes}
+
+| Additional Statistics Action For vpp-show-stats
+| | [Documentation]
+| | ... | Additional Statistics Action for show VPP statistics.
+| |
+| | Show Statistics On All DUTs | ${nodes}
+
+| Additional Statistics Action For vpp-clear-runtime
+| | [Documentation]
+| | ... | Additional Statistics Action for clear VPP runtime.
+| |
+| | VPP Clear Runtime On All DUTs | ${nodes}
+
+| Additional Statistics Action For vpp-show-runtime
+| | [Documentation]
+| | ... | Additional Statistics Action for show VPP runtime.
+| |
+| | VPP Show Runtime On All DUTs | ${nodes}
+
+| Additional Statistics Action For vpp-enable-packettrace
+| | [Documentation]
+| | ... | Additional Statistics Action for enable VPP packet trace.
+| |
+| | Run Keyword If | ${extended_debug}==${True}
+| | ... | VPP Enable Traces On All DUTs | ${nodes} | fail_on_error=${False}
+
+| Additional Statistics Action For vpp-show-packettrace
+| | [Documentation]
+| | ... | Additional Statistics Action for show VPP packet trace.
+| |
+| | Run Keyword If | ${extended_debug}==${True}
+| | ... | Show Packet Trace On All Duts | ${nodes} | maximum=${100}
+
+| Additional Statistics Action For vpp-enable-elog
+| | [Documentation]
+| | ... | Additional Statistics Action for enable VPP elog trace.
+| |
+| | VPP Enable Elog Traces On All DUTs | ${nodes}
+
+| Additional Statistics Action For vpp-show-elog
+| | [Documentation]
+| | ... | Additional Statistics Action for show VPP elog trace.
+| |
+| | Show Event Logger On All DUTs | ${nodes}
+
+| Additional Statistics Action For bash-perf-stat
+| | [Documentation]
+| | ... | Additional Statistics Action for bash command "perf stat".
+| |
+| | Run Keyword If | ${extended_debug}==${True}
+| | ... | Perf Stat On All DUTs | ${nodes}
\ No newline at end of file