[v3,5/6] eal: hide internal device event structure
diff mbox series

Message ID 20200917112823.10534-6-david.marchand@redhat.com
State Accepted
Delegated to: David Marchand
Headers show
Series
  • 20.11 announced cleanups
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

David Marchand Sept. 17, 2020, 11:28 a.m. UTC
This structure is not used in the public API.

Fixes: a753e53d517b ("eal: add device event monitor framework")

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 doc/guides/rel_notes/deprecation.rst   | 3 ---
 doc/guides/rel_notes/release_20_11.rst | 3 +++
 lib/librte_eal/include/rte_dev.h       | 6 ------
 lib/librte_eal/linux/eal_dev.c         | 6 ++++++
 4 files changed, 9 insertions(+), 9 deletions(-)

Comments

Guo, Jia Sept. 18, 2020, 3:40 a.m. UTC | #1
Hi, David

> -----Original Message-----
> From: David Marchand <david.marchand@redhat.com>
> Sent: Thursday, September 17, 2020 7:28 PM
> To: dev@dpdk.org
> Cc: arybchenko@solarflare.com; Ray Kinsella <mdr@ashroe.eu>; Neil
> Horman <nhorman@tuxdriver.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>; Jianfeng Tan <jianfeng.tan@intel.com>; Guo,
> Jia <jia.guo@intel.com>
> Subject: [PATCH v3 5/6] eal: hide internal device event structure
> 
> This structure is not used in the public API.
> 
> Fixes: a753e53d517b ("eal: add device event monitor framework")
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>

Agree with the patch that the struct involve os platform specific, it is better no public it.
Acked-by: Jeff Guo <jia.guo@intel.com>

> ---
>  doc/guides/rel_notes/deprecation.rst   | 3 ---
>  doc/guides/rel_notes/release_20_11.rst | 3 +++
>  lib/librte_eal/include/rte_dev.h       | 6 ------
>  lib/librte_eal/linux/eal_dev.c         | 6 ++++++
>  4 files changed, 9 insertions(+), 9 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 8fca461045..3669d6533b 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -70,9 +70,6 @@ Deprecation Notices
>  * eal: The function ``rte_eal_remote_launch`` will return new error codes
>    after read or write error on the pipe, instead of calling ``rte_panic``.
> 
> -* eal: The ``rte_dev_event`` structure will be made private to the EAL as no
> -  public API makes use of it.
> -
>  * rte_atomicNN_xxx: These APIs do not take memory order parameter. This
> does
>    not allow for writing optimized code for all the CPU architectures supported
>    in DPDK. DPDK will adopt C11 atomic operations semantics and provide
> wrappers diff --git a/doc/guides/rel_notes/release_20_11.rst
> b/doc/guides/rel_notes/release_20_11.rst
> index 185eeae731..e87509dfa7 100644
> --- a/doc/guides/rel_notes/release_20_11.rst
> +++ b/doc/guides/rel_notes/release_20_11.rst
> @@ -87,6 +87,9 @@ API Changes
>  * eal: The ``rte_logs`` struct and global symbol was made private
>    and is no longer part of the API.
> 
> +* eal: Made the ``rte_dev_event`` structure private to the EAL as no
> +public API
> +  used it.
> +
>  * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
>    replaced with a private enum in the PCI subsystem.
> 
> diff --git a/lib/librte_eal/include/rte_dev.h
> b/lib/librte_eal/include/rte_dev.h
> index 53c8bc6fab..81905b3ae3 100644
> --- a/lib/librte_eal/include/rte_dev.h
> +++ b/lib/librte_eal/include/rte_dev.h
> @@ -33,12 +33,6 @@ enum rte_dev_event_type {
>  	RTE_DEV_EVENT_MAX	/**< max value of this enum */
>  };
> 
> -struct rte_dev_event {
> -	enum rte_dev_event_type type;	/**< device event type */
> -	int subsystem;			/**< subsystem id */
> -	char *devname;			/**< device name */
> -};
> -
>  typedef void (*rte_dev_event_cb_fn)(const char *device_name,
>  					enum rte_dev_event_type event,
>  					void *cb_arg);
> diff --git a/lib/librte_eal/linux/eal_dev.c b/lib/librte_eal/linux/eal_dev.c
> index 83b6068264..2e15762b56 100644
> --- a/lib/librte_eal/linux/eal_dev.c
> +++ b/lib/librte_eal/linux/eal_dev.c
> @@ -133,6 +133,12 @@ dev_uev_socket_fd_create(void)
>  	return ret;
>  }
> 
> +struct rte_dev_event {
> +	enum rte_dev_event_type type;	/**< device event type */
> +	int subsystem;			/**< subsystem id */
> +	char *devname;			/**< device name */
> +};
> +
>  static int
>  dev_uev_parse(const char *buf, struct rte_dev_event *event, int length)  {
> --
> 2.23.0
Ray Kinsella Sept. 18, 2020, 1:36 p.m. UTC | #2
On 18/09/2020 04:40, Guo, Jia wrote:
> Hi, David
> 
>> -----Original Message-----
>> From: David Marchand <david.marchand@redhat.com>
>> Sent: Thursday, September 17, 2020 7:28 PM
>> To: dev@dpdk.org
>> Cc: arybchenko@solarflare.com; Ray Kinsella <mdr@ashroe.eu>; Neil
>> Horman <nhorman@tuxdriver.com>; Mcnamara, John
>> <john.mcnamara@intel.com>; Kovacevic, Marko
>> <marko.kovacevic@intel.com>; Jianfeng Tan <jianfeng.tan@intel.com>; Guo,
>> Jia <jia.guo@intel.com>
>> Subject: [PATCH v3 5/6] eal: hide internal device event structure
>>
>> This structure is not used in the public API.
>>
>> Fixes: a753e53d517b ("eal: add device event monitor framework")
>>
>> Signed-off-by: David Marchand <david.marchand@redhat.com>
> 
> Agree with the patch that the struct involve os platform specific, it is better no public it.
> Acked-by: Jeff Guo <jia.guo@intel.com>

Acked-by: Ray Kinsella <mdr@ashroe.eu>

> 
>> ---
>>  doc/guides/rel_notes/deprecation.rst   | 3 ---
>>  doc/guides/rel_notes/release_20_11.rst | 3 +++
>>  lib/librte_eal/include/rte_dev.h       | 6 ------
>>  lib/librte_eal/linux/eal_dev.c         | 6 ++++++
>>  4 files changed, 9 insertions(+), 9 deletions(-)
>>
>> diff --git a/doc/guides/rel_notes/deprecation.rst
>> b/doc/guides/rel_notes/deprecation.rst
>> index 8fca461045..3669d6533b 100644
>> --- a/doc/guides/rel_notes/deprecation.rst
>> +++ b/doc/guides/rel_notes/deprecation.rst
>> @@ -70,9 +70,6 @@ Deprecation Notices
>>  * eal: The function ``rte_eal_remote_launch`` will return new error codes
>>    after read or write error on the pipe, instead of calling ``rte_panic``.
>>
>> -* eal: The ``rte_dev_event`` structure will be made private to the EAL as no
>> -  public API makes use of it.
>> -
>>  * rte_atomicNN_xxx: These APIs do not take memory order parameter. This
>> does
>>    not allow for writing optimized code for all the CPU architectures supported
>>    in DPDK. DPDK will adopt C11 atomic operations semantics and provide
>> wrappers diff --git a/doc/guides/rel_notes/release_20_11.rst
>> b/doc/guides/rel_notes/release_20_11.rst
>> index 185eeae731..e87509dfa7 100644
>> --- a/doc/guides/rel_notes/release_20_11.rst
>> +++ b/doc/guides/rel_notes/release_20_11.rst
>> @@ -87,6 +87,9 @@ API Changes
>>  * eal: The ``rte_logs`` struct and global symbol was made private
>>    and is no longer part of the API.
>>
>> +* eal: Made the ``rte_dev_event`` structure private to the EAL as no
>> +public API
>> +  used it.
>> +
>>  * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
>>    replaced with a private enum in the PCI subsystem.
>>
>> diff --git a/lib/librte_eal/include/rte_dev.h
>> b/lib/librte_eal/include/rte_dev.h
>> index 53c8bc6fab..81905b3ae3 100644
>> --- a/lib/librte_eal/include/rte_dev.h
>> +++ b/lib/librte_eal/include/rte_dev.h
>> @@ -33,12 +33,6 @@ enum rte_dev_event_type {
>>  	RTE_DEV_EVENT_MAX	/**< max value of this enum */
>>  };
>>
>> -struct rte_dev_event {
>> -	enum rte_dev_event_type type;	/**< device event type */
>> -	int subsystem;			/**< subsystem id */
>> -	char *devname;			/**< device name */
>> -};
>> -
>>  typedef void (*rte_dev_event_cb_fn)(const char *device_name,
>>  					enum rte_dev_event_type event,
>>  					void *cb_arg);
>> diff --git a/lib/librte_eal/linux/eal_dev.c b/lib/librte_eal/linux/eal_dev.c
>> index 83b6068264..2e15762b56 100644
>> --- a/lib/librte_eal/linux/eal_dev.c
>> +++ b/lib/librte_eal/linux/eal_dev.c
>> @@ -133,6 +133,12 @@ dev_uev_socket_fd_create(void)
>>  	return ret;
>>  }
>>
>> +struct rte_dev_event {
>> +	enum rte_dev_event_type type;	/**< device event type */
>> +	int subsystem;			/**< subsystem id */
>> +	char *devname;			/**< device name */
>> +};
>> +
>>  static int
>>  dev_uev_parse(const char *buf, struct rte_dev_event *event, int length)  {
>> --
>> 2.23.0
>

Patch
diff mbox series

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 8fca461045..3669d6533b 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -70,9 +70,6 @@  Deprecation Notices
 * eal: The function ``rte_eal_remote_launch`` will return new error codes
   after read or write error on the pipe, instead of calling ``rte_panic``.
 
-* eal: The ``rte_dev_event`` structure will be made private to the EAL as no
-  public API makes use of it.
-
 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
   not allow for writing optimized code for all the CPU architectures supported
   in DPDK. DPDK will adopt C11 atomic operations semantics and provide wrappers
diff --git a/doc/guides/rel_notes/release_20_11.rst b/doc/guides/rel_notes/release_20_11.rst
index 185eeae731..e87509dfa7 100644
--- a/doc/guides/rel_notes/release_20_11.rst
+++ b/doc/guides/rel_notes/release_20_11.rst
@@ -87,6 +87,9 @@  API Changes
 * eal: The ``rte_logs`` struct and global symbol was made private
   and is no longer part of the API.
 
+* eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
+  used it.
+
 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
   replaced with a private enum in the PCI subsystem.
 
diff --git a/lib/librte_eal/include/rte_dev.h b/lib/librte_eal/include/rte_dev.h
index 53c8bc6fab..81905b3ae3 100644
--- a/lib/librte_eal/include/rte_dev.h
+++ b/lib/librte_eal/include/rte_dev.h
@@ -33,12 +33,6 @@  enum rte_dev_event_type {
 	RTE_DEV_EVENT_MAX	/**< max value of this enum */
 };
 
-struct rte_dev_event {
-	enum rte_dev_event_type type;	/**< device event type */
-	int subsystem;			/**< subsystem id */
-	char *devname;			/**< device name */
-};
-
 typedef void (*rte_dev_event_cb_fn)(const char *device_name,
 					enum rte_dev_event_type event,
 					void *cb_arg);
diff --git a/lib/librte_eal/linux/eal_dev.c b/lib/librte_eal/linux/eal_dev.c
index 83b6068264..2e15762b56 100644
--- a/lib/librte_eal/linux/eal_dev.c
+++ b/lib/librte_eal/linux/eal_dev.c
@@ -133,6 +133,12 @@  dev_uev_socket_fd_create(void)
 	return ret;
 }
 
+struct rte_dev_event {
+	enum rte_dev_event_type type;	/**< device event type */
+	int subsystem;			/**< subsystem id */
+	char *devname;			/**< device name */
+};
+
 static int
 dev_uev_parse(const char *buf, struct rte_dev_event *event, int length)
 {