malloc: deprecate unused set limit

Message ID 20190626223212.25815-1-stephen@networkplumber.org (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series malloc: deprecate unused set limit |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/intel-Performance-Testing success Performance Testing PASS
ci/Intel-compilation fail apply issues

Commit Message

Stephen Hemminger June 26, 2019, 10:32 p.m. UTC
  The function rte_malloc_set_limit was defined but never implemented.
Mark it as deprecated for now, and remove in next release.

There is no point in keeping dead code.
"You Aren't Going to Need It"

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 app/test/test_malloc.c                     | 21 ---------------------
 doc/guides/rel_notes/release_19_08.rst     |  3 +++
 lib/librte_eal/common/include/rte_malloc.h |  2 +-
 3 files changed, 4 insertions(+), 22 deletions(-)
  

Comments

Anatoly Burakov June 27, 2019, 8:09 a.m. UTC | #1
On 26-Jun-19 11:32 PM, Stephen Hemminger wrote:
> The function rte_malloc_set_limit was defined but never implemented.
> Mark it as deprecated for now, and remove in next release.
> 
> There is no point in keeping dead code.
> "You Aren't Going to Need It"
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---

Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
  
Thomas Monjalon July 1, 2019, 4:37 p.m. UTC | #2
27/06/2019 00:32, Stephen Hemminger:
> The function rte_malloc_set_limit was defined but never implemented.
> Mark it as deprecated for now, and remove in next release.
> 
> There is no point in keeping dead code.
> "You Aren't Going to Need It"
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
> -int
> +int __rte_deprecated
>  rte_malloc_set_limit(const char *type, size_t max);

Tag moved in a separate line before the return type.

Applied, thanks
  

Patch

diff --git a/app/test/test_malloc.c b/app/test/test_malloc.c
index f0e608cdaf22..7243e8389472 100644
--- a/app/test/test_malloc.c
+++ b/app/test/test_malloc.c
@@ -372,18 +372,6 @@  test_multi_alloc_statistics(void)
 	return 0;
 }
 
-static int
-test_rte_malloc_type_limits(void)
-{
-	/* The type-limits functionality is not yet implemented,
-	 * so always return 0 no matter what the retval.
-	 */
-	const char *typename = "limit_test";
-	rte_malloc_set_limit(typename, 64 * 1024);
-	rte_malloc_dump_stats(stdout, typename);
-	return 0;
-}
-
 static int
 test_realloc(void)
 {
@@ -952,15 +940,6 @@  test_malloc(void)
 	}
 	else printf("test_random_alloc_free() passed\n");
 
-	/*----------------------------*/
-	ret = test_rte_malloc_type_limits();
-	if (ret < 0){
-		printf("test_rte_malloc_type_limits() failed\n");
-		return ret;
-	}
-	/* TODO: uncomment following line once type limits are valid */
-	/*else printf("test_rte_malloc_type_limits() passed\n");*/
-
 	/*----------------------------*/
 	ret = test_rte_malloc_validate();
 	if (ret < 0){
diff --git a/doc/guides/rel_notes/release_19_08.rst b/doc/guides/rel_notes/release_19_08.rst
index 3da26670550d..0e79390e16a1 100644
--- a/doc/guides/rel_notes/release_19_08.rst
+++ b/doc/guides/rel_notes/release_19_08.rst
@@ -135,6 +135,9 @@  API Changes
 * The network structures, definitions and functions have
   been prefixed by ``rte_`` to resolve conflicts with libc headers.
 
+* malloc: The function ``rte_malloc_set_limit`` was never implemented
+  is deprecated and will be removed in a future release.
+
 
 ABI Changes
 -----------
diff --git a/lib/librte_eal/common/include/rte_malloc.h b/lib/librte_eal/common/include/rte_malloc.h
index 5ff1a39a2e78..924a08605998 100644
--- a/lib/librte_eal/common/include/rte_malloc.h
+++ b/lib/librte_eal/common/include/rte_malloc.h
@@ -526,7 +526,7 @@  rte_malloc_dump_heaps(FILE *f);
  *   - 0: Success.
  *   - (-1): Error.
  */
-int
+int __rte_deprecated
 rte_malloc_set_limit(const char *type, size_t max);
 
 /**