[PATCH v9 06/23] eal: replace use of sanity check in comments and messages
Stephen Hemminger
stephen at networkplumber.org
Mon Feb 5 18:43:34 CET 2024
Sanity check is on the Tier 2 non-inclusive list.
Replace or remove it.
Signed-off-by: Stephen Hemminger <stephen at networkplumber.org>
Acked-by: Anatoly Burakov <anatoly.burakov at intel.com>
---
lib/eal/common/eal_common_memory.c | 2 +-
lib/eal/common/eal_common_proc.c | 3 ++-
lib/eal/common/eal_common_trace.c | 2 +-
lib/eal/common/eal_memcfg.h | 2 +-
lib/eal/common/rte_malloc.c | 2 +-
lib/eal/freebsd/eal.c | 2 +-
lib/eal/linux/eal.c | 2 +-
lib/eal/windows/eal.c | 2 +-
8 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/lib/eal/common/eal_common_memory.c b/lib/eal/common/eal_common_memory.c
index 60ddc30580a7..9f4a8676f18f 100644
--- a/lib/eal/common/eal_common_memory.c
+++ b/lib/eal/common/eal_common_memory.c
@@ -562,7 +562,7 @@ check_dma_mask(uint8_t maskbits, bool thread_unsafe)
uint64_t mask;
int ret;
- /* Sanity check. We only check width can be managed with 64 bits
+ /* We only check width can be managed with 64 bits
* variables. Indeed any higher value is likely wrong. */
if (maskbits > MAX_DMA_MASK_BITS) {
EAL_LOG(ERR, "wrong dma mask size %u (Max: %u)",
diff --git a/lib/eal/common/eal_common_proc.c b/lib/eal/common/eal_common_proc.c
index d24093937c1d..838602edef08 100644
--- a/lib/eal/common/eal_common_proc.c
+++ b/lib/eal/common/eal_common_proc.c
@@ -309,7 +309,8 @@ read_msg(int fd, struct mp_msg_internal *m, struct sockaddr_un *s)
break;
}
}
- /* sanity-check the response */
+
+ /* Check that the response is valid */
if (m->msg.num_fds < 0 || m->msg.num_fds > RTE_MP_MAX_FD_NUM) {
EAL_LOG(ERR, "invalid number of fd's received");
return -1;
diff --git a/lib/eal/common/eal_common_trace.c b/lib/eal/common/eal_common_trace.c
index 6ad87fc0df5d..b2bab5c45f1e 100644
--- a/lib/eal/common/eal_common_trace.c
+++ b/lib/eal/common/eal_common_trace.c
@@ -468,7 +468,7 @@ __rte_trace_point_register(rte_trace_point_t *handle, const char *name,
struct trace_point *tp;
uint16_t sz;
- /* Sanity checks of arguments */
+ /* Check arguments */
if (name == NULL || register_fn == NULL || handle == NULL) {
trace_err("invalid arguments");
rte_errno = EINVAL;
diff --git a/lib/eal/common/eal_memcfg.h b/lib/eal/common/eal_memcfg.h
index 60e2089797a2..e8a85df35585 100644
--- a/lib/eal/common/eal_memcfg.h
+++ b/lib/eal/common/eal_memcfg.h
@@ -18,7 +18,7 @@
* Memory configuration shared across multiple processes.
*/
struct rte_mem_config {
- volatile uint32_t magic; /**< Magic number - sanity check. */
+ volatile uint32_t magic; /**< Magic number check. */
uint32_t version;
/**< Prevent secondary processes using different DPDK versions. */
diff --git a/lib/eal/common/rte_malloc.c b/lib/eal/common/rte_malloc.c
index 6d3c301a2368..dac077bc8e09 100644
--- a/lib/eal/common/rte_malloc.c
+++ b/lib/eal/common/rte_malloc.c
@@ -654,7 +654,7 @@ rte_malloc_heap_destroy(const char *heap_name)
ret = -1;
goto unlock;
}
- /* sanity checks done, now we can destroy the heap */
+ /* checks done, now we can destroy the heap */
rte_spinlock_lock(&heap->lock);
ret = malloc_heap_destroy(heap);
rte_spinlock_unlock(&heap->lock);
diff --git a/lib/eal/freebsd/eal.c b/lib/eal/freebsd/eal.c
index bab77118e967..1500778b4f06 100644
--- a/lib/eal/freebsd/eal.c
+++ b/lib/eal/freebsd/eal.c
@@ -501,7 +501,7 @@ eal_parse_args(int argc, char **argv)
goto out;
}
- /* sanity checks */
+ /* options checks */
if (eal_check_common_options(internal_conf) != 0) {
eal_usage(prgname);
ret = -1;
diff --git a/lib/eal/linux/eal.c b/lib/eal/linux/eal.c
index fd422f1f6236..50cebdbbd481 100644
--- a/lib/eal/linux/eal.c
+++ b/lib/eal/linux/eal.c
@@ -803,7 +803,7 @@ eal_parse_args(int argc, char **argv)
goto out;
}
- /* sanity checks */
+ /* options checks */
if (eal_check_common_options(internal_conf) != 0) {
eal_usage(prgname);
ret = -1;
diff --git a/lib/eal/windows/eal.c b/lib/eal/windows/eal.c
index 52f0e7462dd8..915c8e569a5d 100644
--- a/lib/eal/windows/eal.c
+++ b/lib/eal/windows/eal.c
@@ -194,7 +194,7 @@ eal_parse_args(int argc, char **argv)
if (eal_adjust_config(internal_conf) != 0)
return -1;
- /* sanity checks */
+ /* options checks */
if (eal_check_common_options(internal_conf) != 0) {
eal_usage(prgname);
return -1;
--
2.43.0
More information about the dev
mailing list