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 BA5BD45972; Thu, 12 Sep 2024 22:27:47 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 494224029B; Thu, 12 Sep 2024 22:27:47 +0200 (CEST) Received: from mail-pf1-f174.google.com (mail-pf1-f174.google.com [209.85.210.174]) by mails.dpdk.org (Postfix) with ESMTP id 36B5F4028F for ; Thu, 12 Sep 2024 22:27:46 +0200 (CEST) Received: by mail-pf1-f174.google.com with SMTP id d2e1a72fcca58-71911585911so1211670b3a.3 for ; Thu, 12 Sep 2024 13:27:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1726172865; x=1726777665; 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=xYmoihfj0+mEJfAjJTUDPci8sFveJPVmNEkYfJaq128=; b=rA+eHriKsK8GthhKZnVQve9NqY/7jN3ZkmepudPvQ0r8lDhFoIB63LYvgOjNs8iDP+ LLoXT/B7jxQeOIbuf5mdCvTaAqOjpKH9Lz/zP8uxpCslp7y3jitwtN68lgHiaX3cJI34 QU7eAIGb/ZYMLWZsJX2mbj310XnaexplUuAavPJxnT/bJqsJvH3SGpgjTfmszrfr+3Bv VbTjJ/XU3MRZR/NEvPXffAhsJDCP2Kpn0wAmS8moMB24HrVc4Nza+zFpaM/5CSD9RCtj 8Y2QPO4a9bNJaE+IQGhtOCFGJFpd2T/+9VH7xCZhDa+b5qIZTjCFBXpT4QNk42aZvHv1 nHHg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1726172865; x=1726777665; 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=xYmoihfj0+mEJfAjJTUDPci8sFveJPVmNEkYfJaq128=; b=g5Rxc4Y6K8g3GxhwuS7F4qZTsfXIWSBiYTryF3i56D05VeHDAmILHDcc9hUXWpFSqD Zhcqop+mzkMTqqLo3zrpXjJwkcHkzsvJ4iUw6Q1nWzwgMCaixKIRqSx6ehgvduSSCZsJ Vl+Ty/QZn5JWSH92ATjlexObsdp/w3orImVuL9KylAErT3zF4PrFNxSzwQ4S457LKkFz GHyjO6ph5pFeNVK15POo0E0Y0rYieBtnSf9N2KkVAZHbRpokv/fcFABvRx1qhHipvyUN SzwSkrZSktlthE3iSHIozkMxIKzdzTqKVXDVUQBjnsOyefHxZLcXwNXopWOTcMN1KGw8 2mLw== X-Gm-Message-State: AOJu0YzLs5la5AImUkVVGODUmhp6zrysyqifZZ70umeX2aVXbg2rJff/ LkI/fv0dLpWjYmLa9vAbUirPtq3ANg/bK2gu0QYR/L5qKiBbviGalAAZCTy5yaMKizOw9h4HMCQ c X-Google-Smtp-Source: AGHT+IFwwu+0LsqnJWcF6L3tyGF48RWAzhyQOfTCCUDLmBDhXFYoW+N3KJoXUXcLLyPZWoN6hhUaAQ== X-Received: by 2002:a05:6a21:181a:b0:1cc:bb1f:1d4 with SMTP id adf61e73a8af0-1cf756c1867mr6383511637.0.1726172864761; Thu, 12 Sep 2024 13:27:44 -0700 (PDT) Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-71909092662sm4963641b3a.120.2024.09.12.13.27.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 12 Sep 2024 13:27:44 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Nandini Persad , Ferruh Yigit , Thomas Monjalon , Stephen Hemminger Subject: [PATCH v3] doc: add new driver guidelines Date: Thu, 12 Sep 2024 13:26:59 -0700 Message-ID: <20240912202734.24440-1-stephen@networkplumber.org> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20240814190901.14912-1-stephen@networkplumber.org> References: <20240814190901.14912-1-stephen@networkplumber.org> 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 From: Nandini Persad This document was created to assist contributors in creating DPDK drivers and provides suggestions and guidelines on how to upstream effectively. Co-authored-by: Ferruh Yigit Co-authored-by: Thomas Monjalon Signed-off-by: Nandini Persad Reviewed-by: Stephen Hemminger --- v3 - incorporate review feedback doc/guides/contributing/index.rst | 1 + doc/guides/contributing/new_driver.rst | 217 +++++++++++++++++++++++++ 2 files changed, 218 insertions(+) create mode 100644 doc/guides/contributing/new_driver.rst diff --git a/doc/guides/contributing/index.rst b/doc/guides/contributing/index.rst index dcb9b1fbf0..7fc6511361 100644 --- a/doc/guides/contributing/index.rst +++ b/doc/guides/contributing/index.rst @@ -15,6 +15,7 @@ Contributor's Guidelines documentation unit_test new_library + new_driver patches vulnerability stable diff --git a/doc/guides/contributing/new_driver.rst b/doc/guides/contributing/new_driver.rst new file mode 100644 index 0000000000..5cb2a9c9bf --- /dev/null +++ b/doc/guides/contributing/new_driver.rst @@ -0,0 +1,217 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2024 The DPDK contributors + + +Upstreaming New DPDK Drivers Guide +================================== + +The DPDK project continuously grows its ecosystem by adding support for new devices. +This document is designed to assist contributors in creating DPDK +drivers, also known as Poll Mode Drivers (PMD's). + +By having public support for a device, we can ensure accessibility across various +operating systems and guarantee community maintenance in future releases. +If a new device is similar to a device already supported by an existing driver, +it is more efficient to update the existing driver. + +Here are our best practice recommendations for creating a new driver. + + +Early Engagement with the Community +----------------------------------- + +When creating a new driver, we highly recommend engaging with the DPDK +community early instead of waiting the work to mature. + +These public discussions help align development of your driver with DPDK expectations. +You may submit a roadmap before the release to inform the community of +your plans. Additionally, sending a Request for Comments (RFC) early in +the release cycle, or even during the prior release, is advisable. + +DPDK is mainly consumed via Long Term Support (LTS) releases. +It is common to target a new PMD to a LTS release. For this, it is +suggested to start upstreaming at least one release before a LTS release. + + +Progressive Work +---------------- + +To continually progress your work, we recommend planning for incremental +upstreaming across multiple patch series or releases. + +It's important to prioritize quality of the driver over upstreaming +in a single release or single patch series. + + +Finalizing +---------- + +Once the driver has been upstreamed, the author has +a responsibility to the community to maintain it. + +This includes the public test report. Authors must send a public +test report after the first upstreaming of the PMD. The same +public test procedure may be reproduced regularly per release. + +After the PMD is upstreamed, the author should send a patch +to update the website with the name of the new PMD and supported devices +via the DPDK mailing list. + +For more information about the role of maintainers, see :doc:`patches`. + + + +Splitting into Patches +---------------------- + +We recommend that drivers are split into patches, so that each patch represents +a single feature. If the driver code is already developed, it may be challenging +to split. However, there are many benefits to doing so. + +Splitting patches makes it easier to understand a feature and clarifies the +list of components/files that compose that specific feature. + +It also enables the ability to track from the source code to the feature +it is enabled for and helps users to understand the reasoning and intention +of implementation. This kind of tracing is regularly required +for defect resolution and refactoring. + +Another benefit of splitting the codebase per feature is that it highlights +unnecessary or irrelevant code, as any code not belonging to any specific +feature becomes obvious. + +Git bisect is also more useful if patches are split per patch. + +The split should focus on logical features +rather than file-based divisions. + +Each patch in the series must compile without errors +and should maintain functionality. + +Enable the build as early as possible within the series +to facilitate continuous integration and testing. +This approach ensures a clear and manageable development process. + +We suggest splitting patches following this approach: + +* Each patch should be organized logically as a new feature. +* Run test tools per patch (See :ref:`tool_list`:). +* Update relevant documentation and .ini file with each patch. + + +The following order in the patch series is as suggested below. + +The first patch should have the driver's skeleton which should include: + +* Maintainer's file update +* Driver documentation +* Document must have links to official product documentation web page +* The new document should be added into the index (`doc/guides/index.rst`) +* Initial .ini file +* Release notes announcement for the new driver + + +The next patches should include basic device features. +The following is suggested sample list to include in these patches: + +======================= ======================== +Net Crypto +======================= ======================== +Initialization Initialization +Configure queues Configure queues +Start queues Configure sessions +Simple Rx / Tx Add capabilities +Statistics Statistics and device info +Device info Simple data processing +Link interrupt +Burst mode info +Promisc all-multicast +RSS +======================= ======================== + + +Advanced features should be in the next group of patches. +The suggestions for these, listed below, are in no specific order: + +============================= +Net +============================= +Advanced Rx / Tx +Scatter Support +Vector Support +TSO / LRO +Rx / Tx Descriptor Status +RX / Tx Queue Info +Flow Offload +Traffic Management/Metering +Extended statistics +Secondary Process Support +FreeBSD / Windows Support +Flow control +FEC +EEPROM access +Register Dump +Time Synchronization, PTP +Perf documentation +============================= + + +============================= +Crypto +============================= +Chained operations +Scatter Gather +Security protocols - IPsec, MACsec etc. +Asymmetric crypto +============================= + + +After all features are enabled, if there is remaining base code that +is not upstreamed, they can be upstreamed at the end of the patch series. +However, we recommend these patches are still split into logical groups. + + +Additional Suggestions +---------------------- + +* We recommend using DPDK macros instead of inventing new ones in the PMD. +* Do not include unused headers. Use the ./devtools/process-iwyu.py tool. +* Do not disable compiler warnings in the build file. +* Do not use #ifdef with driver-defined macros, instead prefer runtime configuration. +* Document device parameters in the driver guide. +* Make device operations struct 'const'. +* Use dynamic logging. +* The driver must be target for the current release. + Do not use DPDK version checks (via RTE_VERSION_NUM) in the upstream code. +* Be sure to have SPDX license tags and copyright notice on each side. + Use ./devtools/check-spdx-tag.sh +* Run the Coccinelle scripts ./devtools/cocci.sh which check for common cleanups such as + useless null checks before calling free routines. +* Avoid adding driver private API's. If a new feature is needed it is + better to extend the corresponding framework API; + +Dependencies +------------ + +At times, drivers may have dependencies to external software. +For driver dependencies, same DPDK rules for dependencies applies. +Dependencies should be publicly and freely available, +drivers which depend on non-available components will not be accepted. +If the required dependency is not yet publicly available, then wait to submit +the driver until the dependent library is available. + + +.. _tool_list: + +Test Tools +---------- + +Build and check the driver's documentation. Make sure there are no +warnings and driver shows up in the relevant index page. + +Be sure to run the following test tools per patch in a patch series: + +* checkpatches.sh +* check-git-log.sh +* check-meson.py +* check-doc-vs-code.sh -- 2.45.2