From patchwork Wed Apr 6 15:19:03 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Juraj_Linke=C5=A1?= X-Patchwork-Id: 109322 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id E8C85A0509; Wed, 6 Apr 2022 17:22:01 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 8C8844298E; Wed, 6 Apr 2022 17:19:34 +0200 (CEST) Received: from lb.pantheon.sk (lb.pantheon.sk [46.229.239.20]) by mails.dpdk.org (Postfix) with ESMTP id 0AC294296F for ; Wed, 6 Apr 2022 17:19:31 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by lb.pantheon.sk (Postfix) with ESMTP id 55204184FF0; Wed, 6 Apr 2022 17:19:30 +0200 (CEST) X-Virus-Scanned: amavisd-new at siecit.sk Received: from lb.pantheon.sk ([127.0.0.1]) by localhost (lb.pantheon.sk [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id FiRwZTNlGSHQ; Wed, 6 Apr 2022 17:19:29 +0200 (CEST) Received: from entguard.lab.pantheon.local (unknown [46.229.239.141]) by lb.pantheon.sk (Postfix) with ESMTP id 26BC8184FF9; Wed, 6 Apr 2022 17:19:18 +0200 (CEST) From: =?utf-8?q?Juraj_Linke=C5=A1?= To: thomas@monjalon.net, david.marchand@redhat.com, Honnappa.Nagarahalli@arm.com, ohilyard@iol.unh.edu, lijuan.tu@intel.com Cc: dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= Subject: [RFC PATCH v1 23/23] dts: merge DTS framework/flow/generator.py to DPDK Date: Wed, 6 Apr 2022 15:19:03 +0000 Message-Id: <20220406151903.2916254-24-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220406151903.2916254-1-juraj.linkes@pantheon.tech> References: <20220406151903.2916254-1-juraj.linkes@pantheon.tech> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org --- dts/framework/flow/generator.py | 204 ++++++++++++++++++++++++++++++++ 1 file changed, 204 insertions(+) create mode 100644 dts/framework/flow/generator.py diff --git a/dts/framework/flow/generator.py b/dts/framework/flow/generator.py new file mode 100644 index 0000000000..c2bde76e53 --- /dev/null +++ b/dts/framework/flow/generator.py @@ -0,0 +1,204 @@ +# BSD LICENSE +# +# Copyright(c) 2020 Intel Corporation. All rights reserved. +# Copyright © 2018[, 2019] The University of New Hampshire. All rights reserved. +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in +# the documentation and/or other materials provided with the +# distribution. +# * Neither the name of Intel Corporation nor the names of its +# contributors may be used to endorse or promote products derived +# from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +from __future__ import annotations + +import os +import sys +from typing import FrozenSet, Generator, Iterable, List, Set, Tuple + +path = os.path.dirname(os.path.dirname(__file__)) +if path not in sys.path: + sys.path.append(path) + +from .flow import Flow +from .flow_pattern_items import ( + ALWAYS_ALLOWED_ITEMS, + L3_FLOW_TYPES, + PATTERN_ITEMS_TYPE_CLASS_MAPPING, + PATTERN_OPERATION_TYPES, + FlowItemEth, + FlowItemGre, + FlowItemIpv4, + FlowItemUdp, + FlowItemVxlan, + PatternFlowItem, +) +from .flow_rule import FlowItemType + + +def get_valid_next_protocols(current_protocol, protocol_stack, type_denylist): + return list( + filter( + lambda patent_item: patent_item not in type_denylist + and patent_item not in {p.type for p in protocol_stack}, + current_protocol.valid_parent_items, + ) + ) + + +def _generate(type_denylist=None) -> List[List[PatternFlowItem]]: + if type_denylist is None: + type_denylist = set() + UNUSED_PATTERN_ITEMS = {PATTERN_ITEMS_TYPE_CLASS_MAPPING[i] for i in type_denylist} + + patterns: List[List[PatternFlowItem]] = [] + for pattern_item in [ + clazz + for clazz in PATTERN_ITEMS_TYPE_CLASS_MAPPING.values() + if clazz not in UNUSED_PATTERN_ITEMS + ]: + protocol_stack = [] + if protocol_stack.count(pattern_item) >= 2: + continue + + current_protocol = pattern_item() + valid_next_protocols = get_valid_next_protocols( + current_protocol, protocol_stack, type_denylist + ) + while len(valid_next_protocols) > 0: + protocol_stack.append(current_protocol) + current_protocol = PATTERN_ITEMS_TYPE_CLASS_MAPPING[ + list(valid_next_protocols)[0] + ]() + valid_next_protocols = get_valid_next_protocols( + current_protocol, protocol_stack, type_denylist + ) + + protocol_stack.append(current_protocol) + + patterns.append( + list(reversed(protocol_stack)) + ) # This will place the lowest level protocols first + return patterns + + +def convert_protocol_stack_to_flow_pattern(protocol_stack): + return Flow(pattern_items=protocol_stack) + + +def _get_patterns_with_type_denylist(type_denylist: Set): + return [ + convert_protocol_stack_to_flow_pattern(protocol_stack) + for protocol_stack in (_generate(type_denylist=type_denylist)) + ] + + +def _get_normal_protocol_patterns() -> List[Flow]: + return _get_patterns_with_type_denylist( + PATTERN_OPERATION_TYPES + | ALWAYS_ALLOWED_ITEMS + | {FlowItemType.ANY, FlowItemType.END} + ) + + +def _get_tunnelled_protocol_patterns(patterns: List[Flow]) -> Generator[Flow]: + VXLAN_FLOW = Flow( + pattern_items=[FlowItemEth(), FlowItemIpv4(), FlowItemUdp(), FlowItemVxlan()] + ) + for pattern in patterns: + yield VXLAN_FLOW / pattern + + GRE_FLOW = Flow(pattern_items=[FlowItemEth(), FlowItemIpv4(), FlowItemGre()]) + for pattern in patterns: + if len(pattern.pattern_items) >= 2: + if pattern.pattern_items[1].type in L3_FLOW_TYPES: + yield GRE_FLOW / pattern + + +def get_patterns() -> Iterable[Iterable[Flow]]: + patterns: List[Flow] = _get_normal_protocol_patterns() + + # The flow with only an ethernet header was a consequence of the + # generation algorithm, but isn't that useful to test since we can't + # create a failing case without getting each NIC to write arbitrary + # bytes over the link. + eth_only_flow = Flow(pattern_items=[FlowItemEth()]) + patterns.remove(eth_only_flow) + + # tunnelled_patterns = _get_tunnelled_protocol_patterns(patterns) + + return patterns + + +def add_properties_to_patterns( + patterns: Iterable[Flow], +) -> Iterable[Tuple[Flow, FrozenSet[str], FrozenSet[str], str]]: + test_property_flow_iters = map(lambda f: f.get_test_property_flows(), patterns) + for iterator in test_property_flow_iters: + yield from iterator + + +def get_patterns_with_properties() -> Iterable[ + Tuple[Flow, FrozenSet[str], FrozenSet[str], str] +]: + base_patterns = get_patterns() + return add_properties_to_patterns(base_patterns) + + +def create_test_function_strings( + test_configurations: Iterable[Tuple[Flow, FrozenSet[str], FrozenSet[str], str]] +) -> Iterable[str]: + """ + This will break if the __str__ methods of frozenset ever changes or if % formatting syntax is removed. + + @param test_configurations: An iterable with test configurations to convert into test case strings. + @return: An iterable containing strings that are function parameters. + """ + function_template = """ +def test_%s(self): + self.do_test_with_queue_action("%s", %s, %s) + """ + return map( + lambda test_configuration: function_template + % ( + test_configuration[-1], + test_configuration[0], + test_configuration[1], + test_configuration[2], + ), + test_configurations, + ) + + +def main(): + """ + Run this file (python3 generator.py) from the flow directory to print + out the pattern functions which are normally automatically generated + and added to the RTE Flow test suite at runtime. + """ + pattern_tests = list(get_patterns_with_properties()) + pattern_functions = create_test_function_strings(pattern_tests) + print("\n".join(pattern_functions)) + + +if __name__ == "__main__": + main()