[v9,08/10] ethdev: new API to get representor info
Checks
Commit Message
The NIC can have multiple PCIe links and can be attached to multiple
hosts, for example the same single NIC can be shared for multiple server
units in the rack. On each PCIe link NIC can provide multiple PFs and
VFs/SFs based on these ones. The full representor identifier consists of
three indices - controller index, PF index, and VF or SF index (if any).
This patch introduces a new API rte_eth_representor_info_get() to
retrieve representor corresponding info mapping:
- caller controller index and pf index.
- supported representor ID ranges.
- type, controller, pf and start vf/sf ID of each range.
The API is useful to calculate representor from devargs to representor
ID.
New ethdev callback representor_info_get() is added to retrieve info
from PMD driver, optional for PMD that doesn't support new devargs
representor syntax.
Signed-off-by: Xueming Li <xuemingl@nvidia.com>
Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
lib/librte_ethdev/ethdev_driver.h | 27 ++++++++++++++++
lib/librte_ethdev/rte_ethdev.c | 14 ++++++++
lib/librte_ethdev/rte_ethdev.h | 54 +++++++++++++++++++++++++++++++
lib/librte_ethdev/version.map | 3 ++
4 files changed, 98 insertions(+)
Comments
On 3/11/2021 1:13 PM, Xueming Li wrote:
> The NIC can have multiple PCIe links and can be attached to multiple
> hosts, for example the same single NIC can be shared for multiple server
> units in the rack. On each PCIe link NIC can provide multiple PFs and
> VFs/SFs based on these ones. The full representor identifier consists of
> three indices - controller index, PF index, and VF or SF index (if any).
>
> This patch introduces a new API rte_eth_representor_info_get() to
> retrieve representor corresponding info mapping:
> - caller controller index and pf index.
> - supported representor ID ranges.
> - type, controller, pf and start vf/sf ID of each range.
> The API is useful to calculate representor from devargs to representor
> ID.
>
> New ethdev callback representor_info_get() is added to retrieve info
> from PMD driver, optional for PMD that doesn't support new devargs
> representor syntax.
>
> Signed-off-by: Xueming Li <xuemingl@nvidia.com>
> Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
<...>
> @@ -243,6 +243,9 @@ EXPERIMENTAL {
>
> # added in 21.02
> rte_eth_get_monitor_addr;
> +
> + # added in 21.05
> + rte_eth_representor_info_get;
> };
New API documented in release notes, "API Changes" section, while merging.
16/03/2021 20:18, Ferruh Yigit:
> On 3/11/2021 1:13 PM, Xueming Li wrote:
> > + # added in 21.05
> > + rte_eth_representor_info_get;
>
> New API documented in release notes, "API Changes" section, while merging.
In general we don't mention new API in release notes.
What is the intent Ferruh?
On 3/16/2021 9:19 PM, Thomas Monjalon wrote:
> 16/03/2021 20:18, Ferruh Yigit:
>> On 3/11/2021 1:13 PM, Xueming Li wrote:
>>> + # added in 21.05
>>> + rte_eth_representor_info_get;
>>
>> New API documented in release notes, "API Changes" section, while merging.
>
> In general we don't mention new API in release notes.
> What is the intent Ferruh?
>
Intent is just document new APIs.
I recognized that new APIs are not mentioned previously, is there a specific
reason to it? Shouldn't be good to document them?
17/03/2021 00:34, Ferruh Yigit:
> On 3/16/2021 9:19 PM, Thomas Monjalon wrote:
> > 16/03/2021 20:18, Ferruh Yigit:
> >> On 3/11/2021 1:13 PM, Xueming Li wrote:
> >>> + # added in 21.05
> >>> + rte_eth_representor_info_get;
> >>
> >> New API documented in release notes, "API Changes" section, while merging.
> >
> > In general we don't mention new API in release notes.
> > What is the intent Ferruh?
> >
>
> Intent is just document new APIs.
> I recognized that new APIs are not mentioned previously, is there a specific
> reason to it? Shouldn't be good to document them?
In general, a new API comes with a new feature description.
The API changes section is for documenting what must be adapted
in the applications.
If we add more info in this section, I'm afraid it will be less
straightforward for those who just need to maintain apps.
On 3/17/2021 6:57 AM, Thomas Monjalon wrote:
> 17/03/2021 00:34, Ferruh Yigit:
>> On 3/16/2021 9:19 PM, Thomas Monjalon wrote:
>>> 16/03/2021 20:18, Ferruh Yigit:
>>>> On 3/11/2021 1:13 PM, Xueming Li wrote:
>>>>> + # added in 21.05
>>>>> + rte_eth_representor_info_get;
>>>>
>>>> New API documented in release notes, "API Changes" section, while merging.
>>>
>>> In general we don't mention new API in release notes.
>>> What is the intent Ferruh?
>>>
>>
>> Intent is just document new APIs.
>> I recognized that new APIs are not mentioned previously, is there a specific
>> reason to it? Shouldn't be good to document them?
>
> In general, a new API comes with a new feature description.
>
> The API changes section is for documenting what must be adapted
> in the applications.
> If we add more info in this section, I'm afraid it will be less
> straightforward for those who just need to maintain apps.
>
>
OK, I will remove it back.
@@ -783,6 +783,30 @@ typedef int (*eth_hairpin_queue_peer_unbind_t)
typedef int (*eth_get_monitor_addr_t)(void *rxq,
struct rte_power_monitor_cond *pmc);
+/**
+ * @internal
+ * Get representor info to be able to calculate the unique representor ID.
+ *
+ * Caller should pass NULL as pointer of info to get number of entries,
+ * allocate info buffer according to returned entry number, then call
+ * again with buffer to get real info.
+ *
+ * To calculate the representor ID, caller should iterate each entry,
+ * match controller index, pf index, vf or sf start index and range,
+ * then calculate representor ID from offset to vf/sf start index.
+ * @see rte_eth_representor_id_get.
+ *
+ * @param dev
+ * Ethdev handle of port.
+ * @param [out] info
+ * Pointer to memory to save device representor info.
+ * @return
+ * Negative errno value on error, number of info entries otherwise.
+ */
+
+typedef int (*eth_representor_info_get_t)(struct rte_eth_dev *dev,
+ struct rte_eth_representor_info *info);
+
/**
* @internal A structure containing the functions exported by an Ethernet driver.
*/
@@ -940,6 +964,9 @@ struct eth_dev_ops {
eth_get_monitor_addr_t get_monitor_addr;
/**< Get power monitoring condition for Rx queue. */
+
+ eth_representor_info_get_t representor_info_get;
+ /**< Get representor info. */
};
/**
@@ -5816,6 +5816,20 @@ rte_eth_hairpin_queue_peer_unbind(uint16_t cur_port, uint16_t cur_queue,
direction);
}
+int
+rte_eth_representor_info_get(uint16_t port_id,
+ struct rte_eth_representor_info *info)
+{
+ struct rte_eth_dev *dev;
+
+ RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+ dev = &rte_eth_devices[port_id];
+
+ RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->representor_info_get, -ENOTSUP);
+ return eth_err(port_id, (*dev->dev_ops->representor_info_get)(dev,
+ info));
+}
+
RTE_LOG_REGISTER(rte_eth_dev_logtype, lib.ethdev, INFO);
RTE_INIT(ethdev_init_telemetry)
@@ -4791,6 +4791,60 @@ __rte_experimental
int rte_eth_dev_hairpin_capability_get(uint16_t port_id,
struct rte_eth_hairpin_cap *cap);
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change without prior notice.
+ *
+ * ethernet device representor ID range entry
+ */
+struct rte_eth_representor_range {
+ enum rte_eth_representor_type type; /**< Representor type */
+ int controller; /**< Controller index */
+ int pf; /**< Physical function index */
+ __extension__
+ union {
+ int vf; /**< VF start index */
+ int sf; /**< SF start index */
+ };
+ uint32_t id_base; /**< Representor ID start index */
+ uint32_t id_end; /**< Representor ID end index */
+ char name[RTE_DEV_NAME_MAX_LEN]; /**< Representor name */
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change without prior notice.
+ *
+ * Ethernet device representor information
+ */
+struct rte_eth_representor_info {
+ uint16_t controller; /**< Controller ID of caller device. */
+ uint16_t pf; /**< Physical function ID of caller device. */
+ struct rte_eth_representor_range ranges[];/**< Representor ID range. */
+};
+
+/**
+ * Retrieve the representor info of the device.
+ *
+ * Get device representor info to be able to calculate a unique
+ * representor ID. @see rte_eth_representor_id_get helper.
+ *
+ * @param port_id
+ * The port identifier of the device.
+ * @param info
+ * A pointer to a representor info structure.
+ * NULL to return number of range entries and allocate memory
+ * for next call to store detail.
+ * @return
+ * - (-ENOTSUP) if operation is not supported.
+ * - (-ENODEV) if *port_id* invalid.
+ * - (-EIO) if device is removed.
+ * - (>=0) number of representor range entries supported by device.
+ */
+__rte_experimental
+int rte_eth_representor_info_get(uint16_t port_id,
+ struct rte_eth_representor_info *info);
+
#include <rte_ethdev_core.h>
/**
@@ -243,6 +243,9 @@ EXPERIMENTAL {
# added in 21.02
rte_eth_get_monitor_addr;
+
+ # added in 21.05
+ rte_eth_representor_info_get;
};
INTERNAL {