diff mbox series

[v8,1/2] vhost: introduce API to get vDPA device number

Message ID 20180928214747.48938-2-xiaolong.ye@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Maxime Coquelin
Headers
Series introduce vdpa sample |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Xiaolong Ye Sept. 28, 2018, 9:47 p.m. UTC 
  It's used to get number of available registered vDPA devices.

Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
Acked-by: Xiao Wang <xiao.w.wang@intel.com>
Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
---
 lib/librte_vhost/rte_vdpa.h            | 3 +++
 lib/librte_vhost/rte_vhost_version.map | 1 +
 lib/librte_vhost/vdpa.c                | 6 ++++++
 3 files changed, 10 insertions(+)

Comments

Ferruh Yigit Oct. 2, 2018, 1:19 p.m. UTC | #1 
On 9/28/2018 10:47 PM, Xiaolong Ye wrote:
> It's used to get number of available registered vDPA devices.
> 
> Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
> Acked-by: Xiao Wang <xiao.w.wang@intel.com>
> Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
> ---
>  lib/librte_vhost/rte_vdpa.h            | 3 +++
>  lib/librte_vhost/rte_vhost_version.map | 1 +
>  lib/librte_vhost/vdpa.c                | 6 ++++++
>  3 files changed, 10 insertions(+)
> 
> diff --git a/lib/librte_vhost/rte_vdpa.h b/lib/librte_vhost/rte_vdpa.h
> index 90465ca26..b8223e337 100644
> --- a/lib/librte_vhost/rte_vdpa.h
> +++ b/lib/librte_vhost/rte_vdpa.h
> @@ -84,4 +84,7 @@ rte_vdpa_find_device_id(struct rte_vdpa_dev_addr *addr);
>  struct rte_vdpa_device * __rte_experimental
>  rte_vdpa_get_device(int did);
>  
> +/* Get current available vdpa device number */
> +int __rte_experimental
> +rte_vdpa_get_device_num(void);

Hi Xiaolong,

Is rte_vdpa_get_device_num() an public API? (It should be since it will be used
in an application in next patch.)

If so, header needs to be part of API documentation:
1- Update doc/api/doxy-api-index.md to include this header.
2- Update all APIs comments to be an doxygen comment.
3- Add doxygen comment to all data structures.

I can see rte_vdpa.h not documented at all, it is not just this API, so it can
be better to send a new patch to address above items.

Thanks,
ferruh
Xiaolong Ye Oct. 3, 2018, 5:53 a.m. UTC | #2 
Hi, Ferruh,

On 10/02, Ferruh Yigit wrote:
>On 9/28/2018 10:47 PM, Xiaolong Ye wrote:
>> It's used to get number of available registered vDPA devices.
>> 
>> Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
>> Acked-by: Xiao Wang <xiao.w.wang@intel.com>
>> Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
>> ---
>>  lib/librte_vhost/rte_vdpa.h            | 3 +++
>>  lib/librte_vhost/rte_vhost_version.map | 1 +
>>  lib/librte_vhost/vdpa.c                | 6 ++++++
>>  3 files changed, 10 insertions(+)
>> 
>> diff --git a/lib/librte_vhost/rte_vdpa.h b/lib/librte_vhost/rte_vdpa.h
>> index 90465ca26..b8223e337 100644
>> --- a/lib/librte_vhost/rte_vdpa.h
>> +++ b/lib/librte_vhost/rte_vdpa.h
>> @@ -84,4 +84,7 @@ rte_vdpa_find_device_id(struct rte_vdpa_dev_addr *addr);
>>  struct rte_vdpa_device * __rte_experimental
>>  rte_vdpa_get_device(int did);
>>  
>> +/* Get current available vdpa device number */
>> +int __rte_experimental
>> +rte_vdpa_get_device_num(void);
>
>Hi Xiaolong,
>
>Is rte_vdpa_get_device_num() an public API? (It should be since it will be used
>in an application in next patch.)
>
>If so, header needs to be part of API documentation:
>1- Update doc/api/doxy-api-index.md to include this header.
>2- Update all APIs comments to be an doxygen comment.
>3- Add doxygen comment to all data structures.
>
>I can see rte_vdpa.h not documented at all, it is not just this API, so it can
>be better to send a new patch to address above items.

Thanks for the reminder, I'll send a new patch for it.

Thanks,
Xiaolong
>
>Thanks,
>ferruh
diff mbox series

Patch

diff --git a/lib/librte_vhost/rte_vdpa.h b/lib/librte_vhost/rte_vdpa.h
index 90465ca26..b8223e337 100644
--- a/lib/librte_vhost/rte_vdpa.h
+++ b/lib/librte_vhost/rte_vdpa.h
@@ -84,4 +84,7 @@  rte_vdpa_find_device_id(struct rte_vdpa_dev_addr *addr);
 struct rte_vdpa_device * __rte_experimental
 rte_vdpa_get_device(int did);
 
+/* Get current available vdpa device number */
+int __rte_experimental
+rte_vdpa_get_device_num(void);
 #endif /* _RTE_VDPA_H_ */
diff --git a/lib/librte_vhost/rte_vhost_version.map b/lib/librte_vhost/rte_vhost_version.map
index da220dd02..ae39b6e21 100644
--- a/lib/librte_vhost/rte_vhost_version.map
+++ b/lib/librte_vhost/rte_vhost_version.map
@@ -67,6 +67,7 @@  EXPERIMENTAL {
 	rte_vdpa_unregister_device;
 	rte_vdpa_find_device_id;
 	rte_vdpa_get_device;
+	rte_vdpa_get_device_num;
 	rte_vhost_driver_attach_vdpa_device;
 	rte_vhost_driver_detach_vdpa_device;
 	rte_vhost_driver_get_vdpa_device_id;
diff --git a/lib/librte_vhost/vdpa.c b/lib/librte_vhost/vdpa.c
index c82fd4370..c2c5dff1d 100644
--- a/lib/librte_vhost/vdpa.c
+++ b/lib/librte_vhost/vdpa.c
@@ -113,3 +113,9 @@  rte_vdpa_get_device(int did)
 
 	return vdpa_devices[did];
 }
+
+int
+rte_vdpa_get_device_num(void)
+{
+	return vdpa_device_num;
+}