From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 527DC4548E;
	Tue, 18 Jun 2024 16:45:24 +0200 (CEST)
Received: from mails.dpdk.org (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 034FF40E7C;
	Tue, 18 Jun 2024 16:45:20 +0200 (CEST)
Received: from mail-pl1-f173.google.com (mail-pl1-f173.google.com
 [209.85.214.173])
 by mails.dpdk.org (Postfix) with ESMTP id 644D9402B4
 for <dev@dpdk.org>; Tue, 18 Jun 2024 16:45:18 +0200 (CEST)
Received: by mail-pl1-f173.google.com with SMTP id
 d9443c01a7336-1f6a837e9a3so34921005ad.1
 for <dev@dpdk.org>; Tue, 18 Jun 2024 07:45:18 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1718721917;
 x=1719326717; darn=dpdk.org; 
 h=content-transfer-encoding:mime-version:references:in-reply-to
 :message-id:date:subject:cc:to:from:from:to:cc:subject:date
 :message-id:reply-to;
 bh=eWFk1IdYCRHAmfoDnlvvgTg5z/7GDh44A5mO9HmKlwM=;
 b=SMi+tF1fryfiJnMgA9b1upXXIkHT4cGV30TpD1da5kHh2iNo9hoId6PGnrPiATe/ZH
 WgHg9oZLJ6LlGfiyLwFVn4Mt7uYhcZl96IDYgOfYjVvU/IK6hTDSgogqbpON2CcKfY9o
 7ue13uk7zm72Vi0BGZyf5Ry5B9UwQ1Y9SlBWdEnYi8+HX+Eu07wYsxUqXYVbsu4xloRL
 xxVPNGU88KrYkNzDDV5GEaX2trHAZ6eZFIYd+WxNdwjmo2Tie02VX/ttrn0CtS4V3QLp
 Aa4o6pMfWGEMWQvo6w1l7zqKBmaXzVZ9kGKF17HUq7D3AnJTJw2WKNaRFwPFzy2fbU/X
 pfDA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1718721917; x=1719326717;
 h=content-transfer-encoding:mime-version:references:in-reply-to
 :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
 :subject:date:message-id:reply-to;
 bh=eWFk1IdYCRHAmfoDnlvvgTg5z/7GDh44A5mO9HmKlwM=;
 b=MPSPNe68Xzt8SrNuLVKEQBoWE51JOumODvE6s+0WvvwFk2LHiH5os1up8siVc6VLcX
 2htGSrOf3QAt4+jKYa1c+sPxEOlyGX4Z2iCfO7Hyp73wa/nN1Iw7twYY6vWeI3HEQiw8
 oS0wYnpRDRtXZBjompUbWTzMbKKb69UNTCV/usRSSfWO/6ja60gbcfqDeumMXiOhzcKQ
 OlFo6dlgASkT79j8Knuhel6OiWELVKid4zz3/r+u53q05SOf4tbroBLC7IaiVzJfbwYL
 dPqjS1GefOOZ6JmvmK8TZFV2tsr6v9CvtclZmrwPSBwbg7lGskUEFYa5N7Gf6UiEtgJv
 cGEA==
X-Gm-Message-State: AOJu0Yy33GYOpW18mhXSRrSdj9+pqHH/J38TsWtthG4lr8pvuqPPbDVJ
 trIvlNun9rQBVzMBsuX/wqvSH5i/V3R7TjbvjH3iA0bNUFHAn6TZvdwh9Xhd8r8TaeG8ZH/YC0f
 a
X-Google-Smtp-Source: AGHT+IFUpWJuMmOytl/xz3YLkRqg+7lIrsaDo8CwlnHBeWcpD1PqRaBZiFqbXhXR6NisypAlW5O73Q==
X-Received: by 2002:a17:903:1ce:b0:1f7:3e75:20c3 with SMTP id
 d9443c01a7336-1f862900697mr141137795ad.42.1718721917421; 
 Tue, 18 Jun 2024 07:45:17 -0700 (PDT)
Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226])
 by smtp.gmail.com with ESMTPSA id
 d9443c01a7336-1f855e72483sm98589905ad.96.2024.06.18.07.45.16
 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
 Tue, 18 Jun 2024 07:45:17 -0700 (PDT)
From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH v3 1/2] rte_malloc: document that type is for tracing
Date: Tue, 18 Jun 2024 07:44:15 -0700
Message-ID: <20240618144507.73770-2-stephen@networkplumber.org>
X-Mailer: git-send-email 2.43.0
In-Reply-To: <20240618144507.73770-1-stephen@networkplumber.org>
References: <20240425182738.4771-1-stephen@networkplumber.org>
 <20240618144507.73770-1-stephen@networkplumber.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org

The string type is only used for tracing and not used as
documented by dump_stats.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 lib/eal/include/rte_malloc.h | 27 +++++++++++++--------------
 1 file changed, 13 insertions(+), 14 deletions(-)

diff --git a/lib/eal/include/rte_malloc.h b/lib/eal/include/rte_malloc.h
index 54a8ac211e..1f91e7bdde 100644
--- a/lib/eal/include/rte_malloc.h
+++ b/lib/eal/include/rte_malloc.h
@@ -37,8 +37,8 @@ struct rte_malloc_socket_stats {
  * NUMA socket as the core that calls this function.
  *
  * @param type
- *   A string identifying the type of allocated objects (useful for debug
- *   purposes, such as identifying the cause of a memory leak). Can be NULL.
+ *   A string identifying the type of allocated objects (useful for tracing).
+ *   Can be NULL.
  * @param size
  *   Size (in bytes) to be allocated.
  * @param align
@@ -64,8 +64,8 @@ rte_malloc(const char *type, size_t size, unsigned align)
  * same NUMA socket as the core that calls this function.
  *
  * @param type
- *   A string identifying the type of allocated objects (useful for debug
- *   purposes, such as identifying the cause of a memory leak). Can be NULL.
+ *   A string identifying the type of allocated objects (useful for tracing).
+ *   Can be NULL.
  * @param size
  *   Size (in bytes) to be allocated.
  * @param align
@@ -89,8 +89,8 @@ rte_zmalloc(const char *type, size_t size, unsigned align)
  * same NUMA socket as the core that calls this function.
  *
  * @param type
- *   A string identifying the type of allocated objects (useful for debug
- *   purposes, such as identifying the cause of a memory leak). Can be NULL.
+ *   A string identifying the type of allocated objects (useful for tracing).
+ *   Can be NULL.
  * @param num
  *   Number of elements to be allocated.
  * @param size
@@ -165,8 +165,8 @@ rte_realloc_socket(void *ptr, size_t size, unsigned int align, int socket)
  * is not cleared.
  *
  * @param type
- *   A string identifying the type of allocated objects (useful for debug
- *   purposes, such as identifying the cause of a memory leak). Can be NULL.
+ *   A string identifying the type of allocated objects (useful for tracing).
+ *   Can be NULL.
  * @param size
  *   Size (in bytes) to be allocated.
  * @param align
@@ -194,8 +194,8 @@ rte_malloc_socket(const char *type, size_t size, unsigned align, int socket)
  * initialised with zeros.
  *
  * @param type
- *   A string identifying the type of allocated objects (useful for debug
- *   purposes, such as identifying the cause of a memory leak). Can be NULL.
+ *   A string identifying the type of allocated objects (useful for tracing).
+ *   Can be NULL.
  * @param size
  *   Size (in bytes) to be allocated.
  * @param align
@@ -221,8 +221,8 @@ rte_zmalloc_socket(const char *type, size_t size, unsigned align, int socket)
  * initialised with zeros.
  *
  * @param type
- *   A string identifying the type of allocated objects (useful for debug
- *   purposes, such as identifying the cause of a memory leak). Can be NULL.
+ *   A string identifying the type of allocated objects (useful for tracing).
+ *   Can be NULL.
  * @param num
  *   Number of elements to be allocated.
  * @param size
@@ -502,8 +502,7 @@ rte_malloc_heap_socket_is_external(int socket_id);
  * @param f
  *   A pointer to a file for output
  * @param type
- *   A string identifying the type of objects to dump, or NULL
- *   to dump all objects.
+ *   Deprecated parameter unused.
  */
 void
 rte_malloc_dump_stats(FILE *f, const char *type);
-- 
2.43.0