[v3,1/4] devargs: remove deprecated functions

Message ID 20180928162144.1972-2-thomas@monjalon.net (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series eal: simplify devargs and hotplug functions |

Checks

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

Commit Message

Thomas Monjalon Sept. 28, 2018, 4:21 p.m. UTC
  rte_eal_parse_devargs_str() does not support parsing the bus name
at the start of devargs. So it has been renamed and deprecated.

rte_eal_devargs_add(), rte_eal_devargs_type_count() and
rte_eal_devargs_dump() were declared deprecated and had their
implementation body renamed.

All these functions were deprecated in release 18.05.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
The library version is not updated because it should be done
in earlier patch https://patches.dpdk.org/patch/43903/
---
 lib/librte_eal/common/eal_common_devargs.c  | 30 ---------
 lib/librte_eal/common/include/rte_devargs.h | 71 ---------------------
 lib/librte_eal/rte_eal_version.map          |  4 --
 3 files changed, 105 deletions(-)
  

Comments

Andrew Rybchenko Oct. 1, 2018, 11:24 a.m. UTC | #1
On 9/28/18 7:21 PM, Thomas Monjalon wrote:
> rte_eal_parse_devargs_str() does not support parsing the bus name
> at the start of devargs. So it has been renamed and deprecated.
>
> rte_eal_devargs_add(), rte_eal_devargs_type_count() and
> rte_eal_devargs_dump() were declared deprecated and had their
> implementation body renamed.
>
> All these functions were deprecated in release 18.05.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Reviewed-by: Andrew Rybchenko <arybchenko@solarflare.com>

I would say that it is more fair to say that changes related to
rte_eal_devargs_add(), rte_eal_devargs_type_count() and
rte_eal_devargs_dump() fixes b65ecf19 since the changeset
simply removes these functions. May be the ideal solution
is to add changeset which adds these deprecated functions
and simply calls replacement and remove in the next changeset.
But it is too many efforts for nothing, so good to go as is.

Should it be mentioned in release notes (API removal)?
  
Thomas Monjalon Oct. 1, 2018, 5:10 p.m. UTC | #2
01/10/2018 13:24, Andrew Rybchenko:
> On 9/28/18 7:21 PM, Thomas Monjalon wrote:
> > rte_eal_parse_devargs_str() does not support parsing the bus name
> > at the start of devargs. So it has been renamed and deprecated.
> >
> > rte_eal_devargs_add(), rte_eal_devargs_type_count() and
> > rte_eal_devargs_dump() were declared deprecated and had their
> > implementation body renamed.
> >
> > All these functions were deprecated in release 18.05.
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Reviewed-by: Andrew Rybchenko <arybchenko@solarflare.com>
> 
> I would say that it is more fair to say that changes related to
> rte_eal_devargs_add(), rte_eal_devargs_type_count() and
> rte_eal_devargs_dump() fixes b65ecf19 since the changeset
> simply removes these functions. May be the ideal solution
> is to add changeset which adds these deprecated functions
> and simply calls replacement and remove in the next changeset.
> But it is too many efforts for nothing, so good to go as is.

Yes, not worth the effort.

> Should it be mentioned in release notes (API removal)?

Yes, you're right, will add a note in v4.
Thanks
  

Patch

diff --git a/lib/librte_eal/common/eal_common_devargs.c b/lib/librte_eal/common/eal_common_devargs.c
index dac2402a4..f63d2c663 100644
--- a/lib/librte_eal/common/eal_common_devargs.c
+++ b/lib/librte_eal/common/eal_common_devargs.c
@@ -31,36 +31,6 @@  TAILQ_HEAD(rte_devargs_list, rte_devargs);
 struct rte_devargs_list devargs_list =
 	TAILQ_HEAD_INITIALIZER(devargs_list);
 
-int
-rte_eal_parse_devargs_str(const char *devargs_str,
-			char **drvname, char **drvargs)
-{
-	char *sep;
-
-	if ((devargs_str) == NULL || (drvname) == NULL || (drvargs == NULL))
-		return -1;
-
-	*drvname = strdup(devargs_str);
-	if (*drvname == NULL)
-		return -1;
-
-	/* set the first ',' to '\0' to split name and arguments */
-	sep = strchr(*drvname, ',');
-	if (sep != NULL) {
-		sep[0] = '\0';
-		*drvargs = strdup(sep + 1);
-	} else {
-		*drvargs = strdup("");
-	}
-
-	if (*drvargs == NULL) {
-		free(*drvname);
-		*drvname = NULL;
-		return -1;
-	}
-	return 0;
-}
-
 static size_t
 devargs_layer_count(const char *s)
 {
diff --git a/lib/librte_eal/common/include/rte_devargs.h b/lib/librte_eal/common/include/rte_devargs.h
index 097a4ce7b..0eef6e9c4 100644
--- a/lib/librte_eal/common/include/rte_devargs.h
+++ b/lib/librte_eal/common/include/rte_devargs.h
@@ -66,36 +66,6 @@  struct rte_devargs {
 	const char *data; /**< Device string storage. */
 };
 
-/**
- * @deprecated
- * Parse a devargs string.
- *
- * For PCI devices, the format of arguments string is "PCI_ADDR" or
- * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
- * "04:00.0,arg=val".
- *
- * For virtual devices, the format of arguments string is "DRIVER_NAME*"
- * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
- * "net_ring0", "net_pmdAnything,arg=0:arg2=1".
- *
- * The function parses the arguments string to get driver name and driver
- * arguments.
- *
- * @param devargs_str
- *   The arguments as given by the user.
- * @param drvname
- *   The pointer to the string to store parsed driver name.
- * @param drvargs
- *   The pointer to the string to store parsed driver arguments.
- *
- * @return
- *   - 0 on success
- *   - A negative value on error
- */
-__rte_deprecated
-int rte_eal_parse_devargs_str(const char *devargs_str,
-				char **drvname, char **drvargs);
-
 /**
  * Parse a device string.
  *
@@ -201,23 +171,6 @@  rte_devargs_insert(struct rte_devargs *da);
 __rte_experimental
 int rte_devargs_add(enum rte_devtype devtype, const char *devargs_str);
 
-/**
- * @deprecated
- * Add a device to the user device list
- * See rte_devargs_parse() for details.
- *
- * @param devtype
- *   The type of the device.
- * @param devargs_str
- *   The arguments as given by the user.
- *
- * @return
- *   - 0 on success
- *   - A negative value on error
- */
-__rte_deprecated
-int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
-
 /**
  * Remove a device from the user device list.
  * Its resources are freed.
@@ -251,20 +204,6 @@  __rte_experimental
 unsigned int
 rte_devargs_type_count(enum rte_devtype devtype);
 
-/**
- * @deprecated
- * Count the number of user devices of a specified type
- *
- * @param devtype
- *   The type of the devices to counted.
- *
- * @return
- *   The number of devices.
- */
-__rte_deprecated
-unsigned int
-rte_eal_devargs_type_count(enum rte_devtype devtype);
-
 /**
  * This function dumps the list of user device and their arguments.
  *
@@ -274,16 +213,6 @@  rte_eal_devargs_type_count(enum rte_devtype devtype);
 __rte_experimental
 void rte_devargs_dump(FILE *f);
 
-/**
- * @deprecated
- * This function dumps the list of user device and their arguments.
- *
- * @param f
- *   A pointer to a file for output
- */
-__rte_deprecated
-void rte_eal_devargs_dump(FILE *f);
-
 /**
  * Find next rte_devargs matching the provided bus name.
  *
diff --git a/lib/librte_eal/rte_eal_version.map b/lib/librte_eal/rte_eal_version.map
index 73282bbb0..3df7f9831 100644
--- a/lib/librte_eal/rte_eal_version.map
+++ b/lib/librte_eal/rte_eal_version.map
@@ -19,9 +19,6 @@  DPDK_2.0 {
 	rte_dump_tailq;
 	rte_eal_alarm_cancel;
 	rte_eal_alarm_set;
-	rte_eal_devargs_add;
-	rte_eal_devargs_dump;
-	rte_eal_devargs_type_count;
 	rte_eal_get_configuration;
 	rte_eal_get_lcore_state;
 	rte_eal_get_physmem_size;
@@ -32,7 +29,6 @@  DPDK_2.0 {
 	rte_eal_lcore_role;
 	rte_eal_mp_remote_launch;
 	rte_eal_mp_wait_lcore;
-	rte_eal_parse_devargs_str;
 	rte_eal_process_type;
 	rte_eal_remote_launch;
 	rte_eal_tailq_lookup;