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 E24EA45463;
Sat, 15 Jun 2024 18:02:34 +0200 (CEST)
Received: from mails.dpdk.org (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id 0F308402EB;
Sat, 15 Jun 2024 18:02:29 +0200 (CEST)
Received: from mail-pl1-f179.google.com (mail-pl1-f179.google.com
[209.85.214.179])
by mails.dpdk.org (Postfix) with ESMTP id B81C7402BC
for <dev@dpdk.org>; Sat, 15 Jun 2024 18:02:27 +0200 (CEST)
Received: by mail-pl1-f179.google.com with SMTP id
d9443c01a7336-1f44b45d6abso24136805ad.0
for <dev@dpdk.org>; Sat, 15 Jun 2024 09:02:27 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1718467347;
x=1719072147; 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=D7RkaKPqyk0oJyeRK5KTkoBc0nbyntHNhlmx+xZcrss=;
b=aN/nfqj8gq5VJ6B+oIDER2TxjCsn0oBztLG8ndrKqn96ayUydHGBWpgp3fPSaiPKOU
ZxKLF5Vvvd5F0zDcVJuwwtrDW/WCyIXFm0l8m0gJWi2VfKQrgleT3n+agFJXjsggBsIy
LlOopDLOi+Wp2BYw2ISYLWv3+6OFelTHhT+OF6N3HUwFhhMJDq/fZlzeWL8OOadj+Rra
KdIiQnlWhvpRZVl3qCc+YFGXnsAOIz47Ub+UZILmBtpLxU+EnN/SMRZL3h1JGITJxDzy
RyI//ntOL184i8Is3e0OnZT4KNN0zJcvvJOcVgZLfUEgRI+Ag0hDuPPYbix/js3ClJ2h
FGIA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1718467347; x=1719072147;
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=D7RkaKPqyk0oJyeRK5KTkoBc0nbyntHNhlmx+xZcrss=;
b=TLocAGFTIPEf5gaQsh3aEjB53GRfMXDR+ZNFu/ttqY8znugiMyl1iwPk/vJJB0HOYL
Z+4MSSkzjZuXN/ZySiN+HBAUsZq4aFFBeyDcCGM7W1oRzIMTbKTcRaLRHEfsTHVwWx0R
s2uSZ4Pr6ouNoMcaujd4tt72yFwWg1Mr68NxMirt6it+F32DiAiOHvzuIm+SO6TIUFAp
NGPmzNyWsWBBEbzfRLto9fG/sou1CK6IPsoZaIEKzFPneaX6T4PlwBwhnPqvKzCGdNb6
MgsvAB8T9ZWyy2qaB8OZxcwJAr5sPWOdyT8LTF+pQ8DoWby1ROO1qpqfOf7PcpJNEX1d
M83A==
X-Gm-Message-State: AOJu0YzK5m8xW9wKG89sfLx+WYjtBOTeNG8awPDvpm/pBHX3RO8AFvYT
IGzNW1jKZKnIoGEQy2Dy6k114TB9/4I1iW9YAdwhNjw0N44eflFPK4CL6o6gIV8pyVPUmheXup0
6
X-Google-Smtp-Source: AGHT+IEGVrtOKFm7EnIt9Gg4kNEDTkyAi0kWY9WnqSmXDO9U9MAbsyvfS4Um8UmnnDwg/KFh3kQMGg==
X-Received: by 2002:a17:902:ea07:b0:1f7:1aff:67ad with SMTP id
d9443c01a7336-1f8625c0a78mr68527535ad.2.1718467346669;
Sat, 15 Jun 2024 09:02:26 -0700 (PDT)
Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226])
by smtp.gmail.com with ESMTPSA id
d9443c01a7336-1f855f043f1sm50264675ad.204.2024.06.15.09.02.25
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Sat, 15 Jun 2024 09:02:26 -0700 (PDT)
From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>,
Anatoly Burakov <anatoly.burakov@intel.com>,
Tyler Retzlaff <roretzla@linux.microsoft.com>
Subject: [PATCH v2 1/3] rte_malloc: document that type is for tracing
Date: Sat, 15 Jun 2024 09:00:12 -0700
Message-ID: <20240615160215.117401-2-stephen@networkplumber.org>
X-Mailer: git-send-email 2.43.0
In-Reply-To: <20240615160215.117401-1-stephen@networkplumber.org>
References: <20240425182738.4771-1-stephen@networkplumber.org>
<20240615160215.117401-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 | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/lib/eal/include/rte_malloc.h b/lib/eal/include/rte_malloc.h
index 54a8ac211e..67a459c6a3 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
--
2.43.0