From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm0-f66.google.com (mail-wm0-f66.google.com [74.125.82.66]) by dpdk.org (Postfix) with ESMTP id 5183C1B7EF for ; Thu, 26 Oct 2017 00:39:26 +0200 (CEST) Received: by mail-wm0-f66.google.com with SMTP id r196so4735614wmf.2 for ; Wed, 25 Oct 2017 15:39:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :in-reply-to:references; bh=aGSHEgs+HGN6UucGgCtT6WA71B5jnYI9c4ryKpzfwVA=; b=uuV9mi/x5uWU4A5QQ+TXPixyLz0eSIJ5WgWojVSF3AFYFvgUTw+lFWh5k3pJp95ym/ HYN2ufCmvynL0yUHeKZ5L9TkyqfuAauIfXmJXD5b0dxGWWp6HeYPinELpHhfL5Iw1EWV ZmqOV8KusAeGxP3Ec4JeT2eFd8dkQXC0bqT0fhCnMRwBcuzcUtgD6o8GQR5OSb1AZZwj Qb5L9kiu81phEs779BpOnB4ycvgZY/1SCed2S0m1V9io2U0louMxWYezxfl5tU6knmBQ /1jC89pqJxtC9i5PqTL11461LPEwMWPHiwKA7Q/otW4fAIdu6IFscvIMLs6jp2dmIaBJ 2dCA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:in-reply-to:references; bh=aGSHEgs+HGN6UucGgCtT6WA71B5jnYI9c4ryKpzfwVA=; b=byTLXpZ1mASJZWleBMOl6hRXXWjOgqTCIJqm8dlnsx/cmqcQa9d8LT2X68s06GG2r6 +Igz7bWyTxcxki65rm6ml2XUXEf1Nfomk3Ru0MNM5EQJ6wXthUZYuqg3BqdNa6YgFFq/ 12U3b+8L5xhleVIPQivTyP83gUi33VxwBEByjlZhPt+br6G+VK5Zr9wplBG+bUSapdC2 oKh3WgvzBIIgm79hz7kAunKZ0NFsSCHX8u9ZUiCJKYGi5S2JlVxOtAtvY4FSwxst870e Uk/AGUNYl2VzTuRu/P0YmUS38WtWQrBbadrHzIs4ha3nYqwHF+FViNYja91x4pnpjWvl qvng== X-Gm-Message-State: AMCzsaX3MAOtvXzoLXBDo2GaO5azpycM5bPWUyklb+hC0AVg07y0ZWOZ o788CdSGknnAeEdFuXAeBZepVkpt X-Google-Smtp-Source: ABhQp+TvQ0PTM1K1KV72zE2uNsFXWAlID/TkUOsRIwgtbbDf4D5zAdlOIBCTkrTBqrQa2xocfa8GEw== X-Received: by 10.28.145.13 with SMTP id t13mr2885531wmd.40.1508971165444; Wed, 25 Oct 2017 15:39:25 -0700 (PDT) Received: from bidouze.dev.6wind.com (host.78.145.23.62.rev.coltfrance.com. [62.23.145.78]) by smtp.gmail.com with ESMTPSA id r63sm4466124wmg.13.2017.10.25.15.39.24 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 25 Oct 2017 15:39:24 -0700 (PDT) From: Gaetan Rivet To: dev@dpdk.org Cc: Gaetan Rivet Date: Thu, 26 Oct 2017 00:38:35 +0200 Message-Id: X-Mailer: git-send-email 2.1.4 In-Reply-To: References: In-Reply-To: References: Subject: [dpdk-dev] [PATCH v7 13/25] pci: deprecate misnamed functions X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 25 Oct 2017 22:39:26 -0000 Rename misnamed functions and describe the change in a deprecation notice. Signed-off-by: Gaetan Rivet --- doc/guides/rel_notes/deprecation.rst | 9 +++++++ lib/librte_eal/common/eal_common_pci.c | 27 ++++++++++++++++--- lib/librte_eal/common/include/rte_pci.h | 47 +++++++++++++++++++++++++++++++++ lib/librte_eal/rte_eal_version.map | 3 +++ 4 files changed, 82 insertions(+), 4 deletions(-) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 023cb60..f3d7203 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -84,3 +84,12 @@ Deprecation Notices * librte_meter: The API will change to accommodate configuration profiles. Most of the API functions will have an additional opaque parameter. + +* pci: Several exposed functions are misnamed. + The following functions are deprecated starting from v17.11 and are replaced: + + - ``eal_parse_pci_BDF`` replaced by ``rte_pci_bdf_parse`` + - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_dbdf_parse`` + - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp`` + + The functions are only renamed. Their behavior is not affected. diff --git a/lib/librte_eal/common/eal_common_pci.c b/lib/librte_eal/common/eal_common_pci.c index 20ae349..a3c32fb 100644 --- a/lib/librte_eal/common/eal_common_pci.c +++ b/lib/librte_eal/common/eal_common_pci.c @@ -106,7 +106,7 @@ get_u8_pciaddr_field(const char *in, void *_u8, char dlm) int -eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr) +rte_pci_bdf_parse(const char *input, struct rte_pci_addr *dev_addr) { const char *in = input; @@ -124,7 +124,13 @@ eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr) } int -eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr) +eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr) +{ + return rte_pci_bdf_parse(input, dev_addr); +} + +int +rte_pci_dbdf_parse(const char *input, struct rte_pci_addr *dev_addr) { const char *in = input; unsigned long val; @@ -148,6 +154,12 @@ eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr) return 0; } +int +eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr) +{ + return rte_pci_dbdf_parse(input, dev_addr); +} + void rte_pci_device_name(const struct rte_pci_addr *addr, char *output, size_t size) @@ -159,8 +171,8 @@ rte_pci_device_name(const struct rte_pci_addr *addr, } int -rte_eal_compare_pci_addr(const struct rte_pci_addr *addr, - const struct rte_pci_addr *addr2) +rte_pci_addr_cmp(const struct rte_pci_addr *addr, + const struct rte_pci_addr *addr2) { uint64_t dev_addr, dev_addr2; @@ -180,6 +192,13 @@ rte_eal_compare_pci_addr(const struct rte_pci_addr *addr, return 0; } +int +rte_eal_compare_pci_addr(const struct rte_pci_addr *addr, + const struct rte_pci_addr *addr2) +{ + return rte_pci_addr_cmp(addr, addr2); +} + void pci_name_set(struct rte_pci_device *dev) { diff --git a/lib/librte_eal/common/include/rte_pci.h b/lib/librte_eal/common/include/rte_pci.h index a366f3f..9ac19d5 100644 --- a/lib/librte_eal/common/include/rte_pci.h +++ b/lib/librte_eal/common/include/rte_pci.h @@ -253,6 +253,22 @@ TAILQ_HEAD(mapped_pci_res_list, mapped_pci_resource); * @return * 0 on success, negative on error. */ +int rte_pci_bdf_parse(const char *input, struct rte_pci_addr *dev_addr); + +/** + * @deprecated + * Utility function to produce a PCI Bus-Device-Function value + * given a string representation. Assumes that the BDF is provided without + * a domain prefix (i.e. domain returned is always 0) + * + * @param input + * The input string to be parsed. Should have the format XX:XX.X + * @param dev_addr + * The PCI Bus-Device-Function address to be returned. Domain will always be + * returned as 0 + * @return + * 0 on success, negative on error. + */ int eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr); /** @@ -267,6 +283,21 @@ int eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr); * @return * 0 on success, negative on error. */ +int rte_pci_dbdf_parse(const char *input, struct rte_pci_addr *dev_addr); + +/** + * @deprecated + * Utility function to produce a PCI Bus-Device-Function value + * given a string representation. Assumes that the BDF is provided including + * a domain prefix. + * + * @param input + * The input string to be parsed. Should have the format XXXX:XX:XX.X + * @param dev_addr + * The PCI Bus-Device-Function address to be returned + * @return + * 0 on success, negative on error. + */ int eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr); /** @@ -296,6 +327,22 @@ void rte_pci_device_name(const struct rte_pci_addr *addr, char *output, * Positive on addr is greater than addr2. * Negative on addr is less than addr2, or error. */ +int rte_pci_addr_cmp(const struct rte_pci_addr *addr, + const struct rte_pci_addr *addr2); + +/** + * @deprecated + * Utility function to compare two PCI device addresses. + * + * @param addr + * The PCI Bus-Device-Function address to compare + * @param addr2 + * The PCI Bus-Device-Function address to compare + * @return + * 0 on equal PCI address. + * Positive on addr is greater than addr2. + * Negative on addr is less than addr2, or error. + */ int rte_eal_compare_pci_addr(const struct rte_pci_addr *addr, const struct rte_pci_addr *addr2); diff --git a/lib/librte_eal/rte_eal_version.map b/lib/librte_eal/rte_eal_version.map index f22869a..5cad972 100644 --- a/lib/librte_eal/rte_eal_version.map +++ b/lib/librte_eal/rte_eal_version.map @@ -253,6 +253,9 @@ DPDK_17.11 { rte_eal_vfio_intr_mode; rte_lcore_has_role; rte_memcpy_ptr; + rte_pci_addr_cmp; + rte_pci_bdf_parse; + rte_pci_dbdf_parse; rte_pci_device_name; rte_pci_get_iommu_class; rte_pci_match; -- 2.1.4