From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id D35ABA0507; Wed, 6 Apr 2022 16:58:18 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id AE622428BC; Wed, 6 Apr 2022 16:56:36 +0200 (CEST) Received: from lb.pantheon.sk (lb.pantheon.sk [46.229.239.20]) by mails.dpdk.org (Postfix) with ESMTP id 3E10D4289C for ; Wed, 6 Apr 2022 16:56:32 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by lb.pantheon.sk (Postfix) with ESMTP id 97DDF1B1F7F; Wed, 6 Apr 2022 16:56:31 +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 bQTCHK04VASP; Wed, 6 Apr 2022 16:56:30 +0200 (CEST) Received: from entguard.lab.pantheon.local (unknown [46.229.239.141]) by lb.pantheon.sk (Postfix) with ESMTP id 2A16C1B27A0; Wed, 6 Apr 2022 16:56:13 +0200 (CEST) From: =?UTF-8?q?Juraj=20Linke=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=20Linke=C5=A1?= Subject: [RFC PATCH v1 13/15] dts: merge DTS framework/utils.py to DPDK Date: Wed, 6 Apr 2022 14:56:04 +0000 Message-Id: <20220406145606.2913834-14-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220406145606.2913834-1-juraj.linkes@pantheon.tech> References: <20220406145606.2913834-1-juraj.linkes@pantheon.tech> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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/utils.py | 353 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 353 insertions(+) create mode 100644 dts/framework/utils.py diff --git a/dts/framework/utils.py b/dts/framework/utils.py new file mode 100644 index 0000000000..8b22d24b0c --- /dev/null +++ b/dts/framework/utils.py @@ -0,0 +1,353 @@ +# BSD LICENSE +# +# Copyright(c) 2010-2014 Intel Corporation. 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. + +import inspect +import json # json format +import os +import re +import socket +import struct +import sys +import threading +import types +from functools import wraps + +DTS_ENV_PAT = r"DTS_*" + + +def create_parallel_locks(num_duts): + """ + Create thread lock dictionary based on DUTs number + """ + global locks_info + locks_info = [] + for _ in range(num_duts): + lock_info = dict() + lock_info["update_lock"] = threading.RLock() + locks_info.append(lock_info) + + +def parallel_lock(num=1): + """ + Wrapper function for protect parallel threads, allow multiple threads + share one lock. Locks are created based on function name. Thread locks are + separated between duts according to argument 'dut_id'. + Parameter: + num: Number of parallel threads for the lock + """ + global locks_info + + def decorate(func): + @wraps(func) + def wrapper(*args, **kwargs): + if "dut_id" in kwargs: + dut_id = kwargs["dut_id"] + else: + dut_id = 0 + + # in case function arguments is not correct + if dut_id >= len(locks_info): + dut_id = 0 + + lock_info = locks_info[dut_id] + uplock = lock_info["update_lock"] + + name = func.__name__ + uplock.acquire() + + if name not in lock_info: + lock_info[name] = dict() + lock_info[name]["lock"] = threading.RLock() + lock_info[name]["current_thread"] = 1 + else: + lock_info[name]["current_thread"] += 1 + + lock = lock_info[name]["lock"] + + # make sure when owned global lock, should also own update lock + if lock_info[name]["current_thread"] >= num: + if lock._is_owned(): + print( + RED( + "DUT%d %s waiting for func lock %s" + % (dut_id, threading.current_thread().name, func.__name__) + ) + ) + lock.acquire() + else: + uplock.release() + + try: + ret = func(*args, **kwargs) + except Exception as e: + if not uplock._is_owned(): + uplock.acquire() + + if lock._is_owned(): + lock.release() + lock_info[name]["current_thread"] = 0 + uplock.release() + raise e + + if not uplock._is_owned(): + uplock.acquire() + + if lock._is_owned(): + lock.release() + lock_info[name]["current_thread"] = 0 + + uplock.release() + + return ret + + return wrapper + + return decorate + + +def RED(text): + return "\x1B[" + "31;1m" + str(text) + "\x1B[" + "0m" + + +def BLUE(text): + return "\x1B[" + "36;1m" + str(text) + "\x1B[" + "0m" + + +def GREEN(text): + return "\x1B[" + "32;1m" + str(text) + "\x1B[" + "0m" + + +def pprint(some_dict, serialzer=None): + """ + Print JSON format dictionary object. + """ + return json.dumps(some_dict, sort_keys=True, indent=4, default=serialzer) + + +def regexp(s, to_match, allString=False): + """ + Ensure that the re `to_match' only has one group in it. + """ + + scanner = re.compile(to_match, re.DOTALL) + if allString: + return scanner.findall(s) + m = scanner.search(s) + if m is None: + print(RED("Failed to match " + to_match + " in the string " + s)) + return None + return m.group(1) + + +def get_obj_funcs(obj, func_name_regex): + """ + Return function list which name matched regex. + """ + for func_name in dir(obj): + func = getattr(obj, func_name) + if callable(func) and re.match(func_name_regex, func.__name__): + yield func + + +@parallel_lock() +def remove_old_rsa_key(crb, ip): + """ + Remove the old RSA key of specified IP on crb. + """ + rsa_key_path = "~/.ssh/known_hosts" + remove_rsa_key_cmd = "sed -i '/%s/d' %s" % (ip, rsa_key_path) + crb.send_expect(remove_rsa_key_cmd, "# ") + + +def human_read_number(num): + if num > 1000000: + num /= 1000000 + return str(num) + "M" + elif num > 1000: + num /= 1000 + return str(num) + "K" + else: + return str(num) + + +def get_subclasses(module, clazz): + """ + Get module attribute name and attribute. + """ + for subclazz_name, subclazz in inspect.getmembers(module): + if ( + hasattr(subclazz, "__bases__") + and subclazz.__bases__ + and clazz in subclazz.__bases__ + ): + yield (subclazz_name, subclazz) + + +def copy_instance_attr(from_inst, to_inst): + for key in list(from_inst.__dict__.keys()): + to_inst.__dict__[key] = from_inst.__dict__[key] + + +def create_mask(indexes): + """ + Convert index to hex mask. + """ + val = 0 + for index in indexes: + val |= 1 << int(index) + + return hex(val).rstrip("L") + + +def convert_int2ip(value, ip_type=4): + """ + @change: + 2019.0403 set default value + """ + if ip_type == 4: + ip_str = socket.inet_ntop(socket.AF_INET, struct.pack("!I", value)) + else: + h = value >> 64 + l = value & ((1 << 64) - 1) + ip_str = socket.inet_ntop(socket.AF_INET6, struct.pack("!QQ", h, l)) + + return ip_str + + +def convert_ip2int(ip_str, ip_type=4): + """ + @change: + 2019.0403 set default value + """ + if ip_type == 4: + ip_val = struct.unpack("!I", socket.inet_aton(ip_str))[0] + else: + _hex = socket.inet_pton(socket.AF_INET6, ip_str) + h, l = struct.unpack("!QQ", _hex) + ip_val = (h << 64) | l + + return ip_val + + +def convert_mac2long(mac_str): + """ + convert the MAC type from the string into the int. + """ + mac_hex = "0x" + for mac_part in mac_str.lower().split(":"): + mac_hex += mac_part + ret = int(mac_hex, 16) + return ret + + +def convert_mac2str(mac_long): + """ + convert the MAC type from the int into the string. + """ + mac = hex(mac_long)[2:].zfill(12) + b = [] + [b.append(mac[n : n + 2]) for n in range(len(mac)) if n % 2 == 0] + new_mac = ":".join(b) + return new_mac + + +def get_backtrace_object(file_name, obj_name): + import inspect + + frame = inspect.currentframe() + obj = None + found = False + while frame: + file_path = inspect.getsourcefile(frame) + call_file = file_path.split(os.sep)[-1] + if file_name == call_file: + found = True + break + + frame = frame.f_back + + if found: + obj = getattr(frame.f_locals["self"], obj_name, None) + + return obj + + +def check_crb_python_version(crb): + cmd = "python3 -V" + out = crb.send_expect(cmd, "#", 5) + pat = "Python (\d+).(\d+).(\d+)" + result = re.findall(pat, out) + if ( + not result + or int(result[0][0]) < 3 + or (int(result[0][0]) == 3 and int(result[0][1]) < 6) + or (int(result[0][0]) == 3 and int(result[0][1]) == 6 and int(result[0][2]) < 9) + ): + crb.logger.warning( + ( + "WARNING: Tester node python version is lower than python 3.6, " + "it is deprecated for use in DTS, " + "and will not work in future releases." + ) + ) + crb.logger.warning("Please use Python >= 3.6.9 instead") + + +def check_dts_python_version(): + if ( + sys.version_info.major < 3 + or (sys.version_info.major == 3 and sys.version_info.minor < 6) + or ( + sys.version_info.major == 3 + and sys.version_info.minor == 6 + and sys.version_info.micro < 9 + ) + ): + print( + RED( + ( + "WARNING: Dts running node python version is lower than python 3.6, " + "it is deprecated for use in DTS, " + "and will not work in future releases." + ) + ), + file=sys.stderr, + ) + print(RED("Please use Python >= 3.6.9 instead"), file=sys.stderr) + + +def get_module_path(module_name): + from importlib import import_module + + _module = import_module(module_name) + _module_file_path = _module.__file__ + del _module + return os.path.dirname(_module_file_path) -- 2.20.1