aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/robot/performance/performance_limits.robot
diff options
context:
space:
mode:
Diffstat (limited to 'resources/libraries/robot/performance/performance_limits.robot')
-rw-r--r--resources/libraries/robot/performance/performance_limits.robot117
1 files changed, 117 insertions, 0 deletions
diff --git a/resources/libraries/robot/performance/performance_limits.robot b/resources/libraries/robot/performance/performance_limits.robot
new file mode 100644
index 0000000000..759ee5c28f
--- /dev/null
+++ b/resources/libraries/robot/performance/performance_limits.robot
@@ -0,0 +1,117 @@
+# Copyright (c) 2019 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+*** Settings ***
+| Documentation | Performance suite keywords - Handling NIC and TG limits.
+| Library | Collections
+| Variables | ${CURDIR}/../../python/Constants.py
+
+*** Keywords ***
+| Get Average Frame Size
+| | [Documentation]
+| | ... | Framesize can be either integer in case of a single packet
+| | ... | in stream, or set of packets in case of IMIX type or simmilar.
+| | ...
+| | ... | *Arguments:*
+| | ... | - frame_size - Framesize. Type: integer or string
+| | ...
+| | ... | *Returns:*
+| | ... | Average frame size. Type: float
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Get Average Frame Size \| IMIX_v4_1 \|
+| | ...
+| | [Arguments] | ${frame_size}
+| | ...
+| | Return From Keyword If | '${frame_size}' == 'IMIX_v4_1' | ${353.83333}
+| | ${frame_size} = | Convert To Number | ${frame_size}
+| | Return From Keyword | ${frame_size}
+
+| Set Max Rate And Jumbo
+| | [Documentation]
+| | ... | Input 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 NIC name.
+| | ... | The implementation works by mapping from exact
+| | ... | whitelisted NIC names.
+| | ... | The mapping is hardcoded in nic_limits.yaml
+| | ... | TODO: Make the mapping from NIC names case insensistive.
+| | ...
+| | ... | TODO: Make pps limit also definable per NIC.
+| | ...
+| | ... | This keyword computes maximal unidirectional transmit rate
+| | ... | and jumbo boolean (some suites need that for configuration decisions).
+| | ... | To streamline suite autogeneration, both input and output values
+| | ... | are communicated as test (or broader scope) variables,
+| | ... | instead of explicit arguments and return values.
+| | ...
+| | ... | *Test (or broader scope) variables read:*
+| | ... | - nic_name - Name of bottleneck NIC. Type: string
+| | ... | - overhead - Overhead in bytes. Default: 0. Type: integer
+| | ... | - frame_size - L2 Frame Size [B] or IMIX string. Type: int or str
+| | ...
+| | ... | *Test variables set:*
+| | ... | - max_rate - Calculated unidirectional maximal transmit rate [pps].
+| | ... | Type: float
+| | ... | - jumbo - Jumbo boolean, true if jumbo packet support
+| | ... | has to be enabled. Type: boolean
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Set test Variable \| \${frame_size} \| IMIX_v4_1 \|
+| | ... | \| Set Max Rate And Jumbo \|
+| | ...
+| | ${pps_limit} = | Set Variable | ${18750000.0}
+| | ${bps_limit} = | Get From Dictionary | ${NIC_NAME_TO_LIMIT} | ${nic_name}
+| | ${avg_size} = | Get Average Frame Size | ${frame_size}
+| | ${max_size} = | Set Variable If | '${frame_size}' == 'IMIX_v4_1'
+| | ... | ${1518} | ${frame_size}
+| | # 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}
+| | ${rate} = | Evaluate | ${bps_limit} / ((${avg_swo} + 20.0) * 8)
+| | ${max_rate} = | Set Variable If | ${rate} > ${pps_limit}
+| | ... | ${pps_limit} | ${rate}
+| | Set Test Variable | \${jumbo}
+| | Set Test Variable | \${max_rate}
+
+| Set Max Rate And Jumbo And Handle Multi Seg
+| | [Documentation]
+| | ... | This keyword starts with Get Max Rate And Jumbo keyword,
+| | ... | then adds correct multi seg VPP configuration.
+| | ...
+| | ... | See Documentation of Set Max Rate And Jumbo for more details.
+| | ...
+| | ... | *Test (or broader scope) variables read:*
+| | ... | - nic_name - Name of bottleneck NIC. Type: string
+| | ... | - overhead - Overhead in bytes. Default: 0. Type: integer
+| | ... | - frame_size - L2 Frame Size [B] or IMIX string. Type: int or str
+| | ...
+| | ... | *Test variables set:*
+| | ... | - max_rate - Calculated unidirectional maximal transmit rate [pps].
+| | ... | Type: float
+| | ... | - jumbo - Jumbo boolean, true if jumbo packet support
+| | ... | has to be enabled. Type: boolean
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Set Max Rate And Jumbo And Handle Multi Seg \|
+| | ...
+| | Set Max Rate And Jumbo
+| | Run Keyword If | not ${jumbo} | Add no multi seg to all DUTs