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 8770D41FDB; Thu, 31 Aug 2023 12:04:48 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D6AA0402B3; Thu, 31 Aug 2023 12:04:18 +0200 (CEST) Received: from mail-ed1-f49.google.com (mail-ed1-f49.google.com [209.85.208.49]) by mails.dpdk.org (Postfix) with ESMTP id 97B9E402AD for ; Thu, 31 Aug 2023 12:04:15 +0200 (CEST) Received: by mail-ed1-f49.google.com with SMTP id 4fb4d7f45d1cf-52bcb8b199aso777114a12.3 for ; Thu, 31 Aug 2023 03:04:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1693476255; x=1694081055; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Om1CGkuj7K9t5bJb8S2YiTcUFEUz3htI2M5f30th+Xk=; b=jS/wkd/4BW2SfJr8Z+G4PO2Cz+CdX7d3dLy2DbZkErYD2+ppYZA6HIrtRZryfwC6ni hgsnswrOPm5Yo8OyPciVlgKIOLw11kib/mH5S/21pVt/hVtPr2zG5ZOXXpaxETfjvfK+ Lkh3Cav1JiEggIegvB3CsEEbia+8+FaE0ckBXZTNIEmVoGjiY3R5wD8ZYrwFgPZk5TfF cBwK9A5KEM6x5tUt9zjnZj7KC4lz1pHPMimpnQe5sPkl41EuZARYXAzC70Y40sgYTsve q/KW71Wk9tSznGk7PyaWOt1riWkUPdi19hziNVDTSm73CgtSrl6Xp9ThYc6JxOVIkTeU 1IVQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1693476255; x=1694081055; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Om1CGkuj7K9t5bJb8S2YiTcUFEUz3htI2M5f30th+Xk=; b=lwfpZdPRwOtNTuUdO9MYxSoPZhc78ubTQYUjr9Fov64muyPPz1aFMMu0CmVCb32W80 ZnEnQ2LuZYCAVQ9bmwYP3W3Q4wsApuEdRn0QY8fUbNogTwUAjNEL5pIT99x1/iqjYZVj 0+wHXHAg+BHJNab896VHgKgO19RdcU3od6/GTAepkmF1s9w7MnnGdcKHSYJs1J3iln97 KDZHcSi4FrZfQfd52RCNYyM2S1iTG8LSQQCmmR2UPcFacx8H/2bwNFNR0z3JQcnKZT9d 91YlzCfZ4+lC3l9rrQNEXpYDrc+jHjTA7VQ0miWBfaFg7BCE2qzk6OCHd6vkuDOSnTaW PiIQ== X-Gm-Message-State: AOJu0YxWk9iNDncusQcdOO4VTfChuA/mzrM4s/OOJ9/eXsTRAAST900K N4tAYdjON5sc3GDiXcOiawr9kw== X-Google-Smtp-Source: AGHT+IFEOWifFFut4TQrrPktZNUAjksvKxHDyZhGbURUZpvh163tjt4xqfeKl1FHiB0Y9ESo/uzQyQ== X-Received: by 2002:a17:907:7612:b0:99b:6e54:bd6e with SMTP id jx18-20020a170907761200b0099b6e54bd6emr3324417ejc.56.1693476255251; Thu, 31 Aug 2023 03:04:15 -0700 (PDT) Received: from jlinkes-PT-Latitude-5530.. (ip-46.34.238.3.o2inet.sk. [46.34.238.3]) by smtp.gmail.com with ESMTPSA id l18-20020a1709066b9200b0099bc08862b6sm587513ejr.171.2023.08.31.03.04.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 31 Aug 2023 03:04:15 -0700 (PDT) From: =?UTF-8?q?Juraj=20Linke=C5=A1?= To: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, lijuan.tu@intel.com, bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu Cc: dev@dpdk.org, =?UTF-8?q?Juraj=20Linke=C5=A1?= Subject: [RFC PATCH v4 4/4] dts: format docstrigs to google format Date: Thu, 31 Aug 2023 12:04:07 +0200 Message-Id: <20230831100407.59865-5-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230831100407.59865-1-juraj.linkes@pantheon.tech> References: <20230511091408.236638-1-juraj.linkes@pantheon.tech> <20230831100407.59865-1-juraj.linkes@pantheon.tech> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 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 WIP: only one module is reformatted to serve as a demonstration. The google format is documented here [0]. [0]: https://google.github.io/styleguide/pyguide.html Signed-off-by: Juraj Linkeš --- dts/framework/testbed_model/node.py | 171 +++++++++++++++++++--------- 1 file changed, 118 insertions(+), 53 deletions(-) diff --git a/dts/framework/testbed_model/node.py b/dts/framework/testbed_model/node.py index 23efa79c50..619743ebe7 100644 --- a/dts/framework/testbed_model/node.py +++ b/dts/framework/testbed_model/node.py @@ -3,8 +3,13 @@ # Copyright(c) 2022-2023 PANTHEON.tech s.r.o. # Copyright(c) 2022-2023 University of New Hampshire -""" -A node is a generic host that DTS connects to and manages. +"""Common functionality for node management. + +There's a base class, Node, that's supposed to be extended by other classes +with functionality specific to that node type. +The only part that can be used standalone is the Node.skip_setup static method, +which is a decorator used to skip method execution if skip_setup is passed +by the user on the cmdline or in an env variable. """ from abc import ABC @@ -35,10 +40,26 @@ class Node(ABC): - """ - Basic class for node management. This class implements methods that - manage a node, such as information gathering (of CPU/PCI/NIC) and - environment setup. + """The base class for node management. + + It shouldn't be instantiated, but rather extended. + It implements common methods to manage any node: + + * connection to the node + * information gathering of CPU + * hugepages setup + + Arguments: + node_config: The config from the input configuration file. + + Attributes: + main_session: The primary OS-agnostic remote session used + to communicate with the node. + config: The configuration used to create the node. + name: The name of the node. + lcores: The list of logical cores that DTS can use on the node. + It's derived from logical cores present on the node and user configuration. + ports: The ports of this node specified in user configuration. """ main_session: OSSession @@ -77,9 +98,14 @@ def _init_ports(self) -> None: self.configure_port_state(port) def set_up_execution(self, execution_config: ExecutionConfiguration) -> None: - """ - Perform the execution setup that will be done for each execution - this node is part of. + """Execution setup steps. + + Configure hugepages and call self._set_up_execution where + the rest of the configuration steps (if any) are implemented. + + Args: + execution_config: The execution configuration according to which + the setup steps will be taken. """ self._setup_hugepages() self._set_up_execution(execution_config) @@ -88,58 +114,78 @@ def set_up_execution(self, execution_config: ExecutionConfiguration) -> None: self.virtual_devices.append(VirtualDevice(vdev)) def _set_up_execution(self, execution_config: ExecutionConfiguration) -> None: - """ - This method exists to be optionally overwritten by derived classes and - is not decorated so that the derived class doesn't have to use the decorator. + """Optional additional execution setup steps for derived classes. + + Derived classes should overwrite this + if they want to add additional execution setup steps. """ def tear_down_execution(self) -> None: - """ - Perform the execution teardown that will be done after each execution - this node is part of concludes. + """Execution teardown steps. + + There are currently no common execution teardown steps + common to all DTS node types. """ self.virtual_devices = [] self._tear_down_execution() def _tear_down_execution(self) -> None: - """ - This method exists to be optionally overwritten by derived classes and - is not decorated so that the derived class doesn't have to use the decorator. + """Optional additional execution teardown steps for derived classes. + + Derived classes should overwrite this + if they want to add additional execution teardown steps. """ def set_up_build_target( self, build_target_config: BuildTargetConfiguration ) -> None: - """ - Perform the build target setup that will be done for each build target - tested on this node. + """Build target setup steps. + + There are currently no common build target setup steps + common to all DTS node types. + + Args: + build_target_config: The build target configuration according to which + the setup steps will be taken. """ self._set_up_build_target(build_target_config) def _set_up_build_target( self, build_target_config: BuildTargetConfiguration ) -> None: - """ - This method exists to be optionally overwritten by derived classes and - is not decorated so that the derived class doesn't have to use the decorator. + """Optional additional build target setup steps for derived classes. + + Derived classes should optionally overwrite this + if they want to add additional build target setup steps. """ def tear_down_build_target(self) -> None: - """ - Perform the build target teardown that will be done after each build target - tested on this node. + """Build target teardown steps. + + There are currently no common build target teardown steps + common to all DTS node types. """ self._tear_down_build_target() def _tear_down_build_target(self) -> None: - """ - This method exists to be optionally overwritten by derived classes and - is not decorated so that the derived class doesn't have to use the decorator. + """Optional additional build target teardown steps for derived classes. + + Derived classes should overwrite this + if they want to add additional build target teardown steps. """ def create_session(self, name: str) -> OSSession: - """ - Create and return a new OSSession tailored to the remote OS. + """Create and return a new OS-agnostic remote session. + + The returned session won't be used by the node creating it. + The session must be used by the caller. + Will be cleaned up automatically. + + Args: + name: The name of the session. + + Returns: + A new OS-agnostic remote session. """ session_name = f"{self.name} {name}" connection = create_session( @@ -186,14 +232,24 @@ def filter_lcores( filter_specifier: LogicalCoreCount | LogicalCoreList, ascending: bool = True, ) -> list[LogicalCore]: - """ - Filter the LogicalCores found on the Node according to - a LogicalCoreCount or a LogicalCoreList. + """Filter the node's logical cores that DTS can use. - If ascending is True, use cores with the lowest numerical id first - and continue in ascending order. If False, start with the highest - id and continue in descending order. This ordering affects which - sockets to consider first as well. + Logical cores that DTS can use are ones that are present on the node, + but filtered according to user config. + The filter_specifier will filter cores from those logical cores. + + Args: + filter_specifier: Two different filters can be used, one that specifies + the number of logical cores per core, cores per socket and + the number of sockets, + the other that specifies a logical core list. + ascending: If True, use cores with the lowest numerical id first + and continue in ascending order. If False, start with the highest + id and continue in descending order. This ordering affects which + sockets to consider first as well. + + Returns: + A list of logical cores. """ self._logger.debug(f"Filtering {filter_specifier} from {self.lcores}.") return lcore_filter( @@ -203,17 +259,14 @@ def filter_lcores( ).filter() def _get_remote_cpus(self) -> None: - """ - Scan CPUs in the remote OS and store a list of LogicalCores. - """ + """Scan CPUs in the remote OS and store a list of LogicalCores.""" self._logger.info("Getting CPU information.") self.lcores = self.main_session.get_remote_cpus(self.config.use_first_core) def _setup_hugepages(self): - """ - Setup hugepages on the Node. Different architectures can supply different - amounts of memory for hugepages and numa-based hugepage allocation may need - to be considered. + """Setup hugepages on the Node. + + Configure the hugepages only if they're specified in user configuration. """ if self.config.hugepages: self.main_session.setup_hugepages( @@ -221,8 +274,11 @@ def _setup_hugepages(self): ) def configure_port_state(self, port: Port, enable: bool = True) -> None: - """ - Enable/disable port. + """Enable/disable port. + + Args: + port: The port to enable/disable. + enable: True to enable, false to disable. """ self.main_session.configure_port_state(port, enable) @@ -232,15 +288,19 @@ def configure_port_ip_address( port: Port, delete: bool = False, ) -> None: - """ - Configure the IP address of a port on this node. + """Add an IP address to a port on this node. + + Args: + address: The IP address with mask in CIDR format. + Can be either IPv4 or IPv6. + port: The port to which to add the address. + delete: If True, will delete the address from the port + instead of adding it. """ self.main_session.configure_port_ip_address(address, port, delete) def close(self) -> None: - """ - Close all connections and free other resources. - """ + """Close all connections and free other resources.""" if self.main_session: self.main_session.close() for session in self._other_sessions: @@ -249,6 +309,11 @@ def close(self) -> None: @staticmethod def skip_setup(func: Callable[..., Any]) -> Callable[..., Any]: + """A decorator that skips the decorated function. + + When used, the decorator executes an empty lambda function + instead of the decorated function. + """ if SETTINGS.skip_setup: return lambda *args: None else: -- 2.34.1