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 D1F5643F09;
Thu, 25 Apr 2024 20:27:56 +0200 (CEST)
Received: from mails.dpdk.org (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id B36414394F;
Thu, 25 Apr 2024 20:27:52 +0200 (CEST)
Received: from mail-pf1-f178.google.com (mail-pf1-f178.google.com
[209.85.210.178])
by mails.dpdk.org (Postfix) with ESMTP id 304E040A67
for <dev@dpdk.org>; Thu, 25 Apr 2024 20:27:50 +0200 (CEST)
Received: by mail-pf1-f178.google.com with SMTP id
d2e1a72fcca58-6edb76d83d0so1215798b3a.0
for <dev@dpdk.org>; Thu, 25 Apr 2024 11:27:50 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1714069669;
x=1714674469; 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=hFC5DzGzPNzUJ3Kfg57UBXCUkgZk/ncI+/kVAITVyJM=;
b=rQuW3UF0+xA1Ywdugyy3h47HXsG4SHQTiKhVu4oqRSC/oskHqPIHf6kWhNEvll75LM
tqNp5Pa47N1eIbKvVe0HHaAjSOFnGcOEsKD/9ajokj8G4qpog92cKCwfOtVbmewvsOCs
Ups98eFWDNZxPBzdTounBWC3vjyOWJwVdp6sx5Y4y+7PiCJ+ka5xxlExhGC0G9pbovnM
MbHtCrvB+sfFgIvdhZTQ2eqnDcwrecmsGvDls9AQDkGVEcgpg347dEVsMLq5ziCJo6bT
5HzpKKjSmneXxgWGJyWRAk1HKIGQCct79V/Fg7158cA5kc7MDD+w9yctfXws7sNiA+eD
wIuw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1714069669; x=1714674469;
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=hFC5DzGzPNzUJ3Kfg57UBXCUkgZk/ncI+/kVAITVyJM=;
b=reeBK/28q6AcYbfQECHNxm0GsHh6v/KR/Ir5ojiFMX2vi+OGqlLOsF98IydgIOMdCh
aSdYNmCLtZjp9fWElb4g1qpODMCZqa8QpL1iMX2+5fALnlfeAzuLtLXd379pVKBv+DGL
zvUXiOiv55JolcoUSXFSf8KjvjnXeMDF1fAJYoldi2AOcOEzd+ez5H1ILoJ66NxbuWMI
QPxSOwr4jBoQTBraD4j7yZscFVLJepPEnfTsX19rHbcG0EihQkGGXpoQA+5/0nPnZ/Ao
TtQyzbDLCBdN4pNwSzVw7i4D7V7ExG2MKDfb6sSMhsa+gYJQURmDE8mcvRvGhezw8GfX
Cwpg==
X-Gm-Message-State: AOJu0YzXqKF409pCHld5am1RHEFKJTTiZvPsOjGxF3DEc9p4NBwdVdnT
kjQKIA9kxT42uASM2QZnY2GM+d9L+yv4WUh+znYuwzbg8dIYN2Nf9WlA4ghVBoP/CRoTSX5gklJ
j
X-Google-Smtp-Source: AGHT+IE+gTl0bktDiKpqeVY2HsE+8slKd3q3S3gw1r+yq03xxQOHRn4RrKDZJv6+ocQbqHoatomBbw==
X-Received: by 2002:a05:6a20:6a1d:b0:1ad:84ca:88f0 with SMTP id
p29-20020a056a206a1d00b001ad84ca88f0mr709533pzk.4.1714069669158;
Thu, 25 Apr 2024 11:27:49 -0700 (PDT)
Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226])
by smtp.gmail.com with ESMTPSA id
d7-20020a056a00244700b006f0ba1c8ddesm4067006pfj.184.2024.04.25.11.27.48
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Thu, 25 Apr 2024 11:27:48 -0700 (PDT)
From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [RFC 1/4] rte_malloc: document that type is unused
Date: Thu, 25 Apr 2024 11:23:58 -0700
Message-ID: <20240425182738.4771-2-stephen@networkplumber.org>
X-Mailer: git-send-email 2.43.0
In-Reply-To: <20240425182738.4771-1-stephen@networkplumber.org>
References: <20240425182738.4771-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 left over from first version of DPDK and
was never implemented.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
lib/eal/include/rte_malloc.h | 21 +++++++--------------
1 file changed, 7 insertions(+), 14 deletions(-)
diff --git a/lib/eal/include/rte_malloc.h b/lib/eal/include/rte_malloc.h
index 54a8ac211e..91c9214c57 100644
--- a/lib/eal/include/rte_malloc.h
+++ b/lib/eal/include/rte_malloc.h
@@ -37,8 +37,7 @@ 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.
+ * Legacy argument, never unused should be NULL.
* @param size
* Size (in bytes) to be allocated.
* @param align
@@ -64,8 +63,7 @@ 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.
+ * Legacy argument, never unused should be NULL.
* @param size
* Size (in bytes) to be allocated.
* @param align
@@ -89,8 +87,7 @@ 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.
+ * Legacy argument, never unused should be NULL.
* @param num
* Number of elements to be allocated.
* @param size
@@ -165,8 +162,7 @@ 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.
+ * Legacy argument, never unused should be NULL.
* @param size
* Size (in bytes) to be allocated.
* @param align
@@ -194,8 +190,7 @@ 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.
+ * Legacy argument, never unused should be NULL.
* @param size
* Size (in bytes) to be allocated.
* @param align
@@ -221,8 +216,7 @@ 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.
+ * Legacy argument, never unused should be NULL.
* @param num
* Number of elements to be allocated.
* @param size
@@ -502,8 +496,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.
+ * Legacy argument, never unused should be NULL.
*/
void
rte_malloc_dump_stats(FILE *f, const char *type);
--
2.43.0