From patchwork Wed Nov 29 17:25:59 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Hemminger X-Patchwork-Id: 134707 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 8CA3B43403; Wed, 29 Nov 2023 18:32:17 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BF24042E76; Wed, 29 Nov 2023 18:31:44 +0100 (CET) Received: from mail-pf1-f180.google.com (mail-pf1-f180.google.com [209.85.210.180]) by mails.dpdk.org (Postfix) with ESMTP id 1FC4E42E68 for ; Wed, 29 Nov 2023 18:31:41 +0100 (CET) Received: by mail-pf1-f180.google.com with SMTP id d2e1a72fcca58-6cde11fb647so236719b3a.1 for ; Wed, 29 Nov 2023 09:31:41 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1701279100; x=1701883900; 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=/Lfvt3k3DtrG+364NbbTqMP3mwZnb3mqaculuXN6OnA=; b=qesf+9pKC6UFqCoi3psonF2qUwqv2J3JtnL9SrpzZtuft117qKHAqdScPr2tm0gXMB A4BvZqPNuO4TcVuWeU265eu5iQ+lNlLdVzlExsc/eTyvlGx8aUs9kyG6BDf5kRDkjn8o D6gZIWnU9g1qLL12c6q3wNANV25INbw91phCc/RAIKbQjtOUHqxpE4vFA08WOelOGFUI DFAi546gWiHhRx+otfscCHEYZkccDqDOzZ1ZIXMvMXhh6th/V+qUpbhQqxjO8k97R5Z0 M+9GcJuLgWKKM4Uzljb8l8exYQebUnq8VE+UgEKdgtjwXPnt9X1KLzmgV0mlSn0ZoxFf X+TQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1701279100; x=1701883900; 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=/Lfvt3k3DtrG+364NbbTqMP3mwZnb3mqaculuXN6OnA=; b=pvTANlYG7N9q57FJYaOZDCwF7ZOMFbdViPVYpgrZy9935ItR3iZCBcwOA2G7Vw0PHP Q4MYyaw+tsZi409fRM8ME2k+oDtF7wkTFd178ACXZbaQ6r8jTL4Mjk/hcGXDRrgxBGfa QDBNTPW3e1JKzfm8LBFTqxieSYV5BnNzUnkPaYsxZ64IrH6B2QSMmBjsjcTsWilb5CO6 tS8VvFvnrW0tuEewqn1DR+6/TSsZ+Xk0RePVTLRPflCiwLLOEXeNqzYaFcFkwemjlwOw 5SYnuBkRE/75bAVy44459DxU5XFsATsFBoacVhVCRGr3bQ2xXfRclPhA2rs7JQ6cUGyQ dCOw== X-Gm-Message-State: AOJu0Yz6zoEf+U9ZhwLLrsd5gs9JWSOjaqtdlHUpdLUM3OAv5XTD3kgB JSPcbChWotT8D8JQ7UnXVaNqDscQC/JCgFGgsTs= X-Google-Smtp-Source: AGHT+IG7jGUbCz5lnNdlgvFKPFPWp8GrkjisvLe/l248z8B4uStgHayJBeDUhua3j2IJfuQ8r2OOCw== X-Received: by 2002:a05:6a20:3941:b0:18d:d16:e86 with SMTP id r1-20020a056a20394100b0018d0d160e86mr2453928pzg.59.1701279100014; Wed, 29 Nov 2023 09:31:40 -0800 (PST) Received: from hermes.local (204-195-123-141.wavecable.com. [204.195.123.141]) by smtp.gmail.com with ESMTPSA id y42-20020a056a0003aa00b006baa1cf561dsm10950435pfs.0.2023.11.29.09.31.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 29 Nov 2023 09:31:39 -0800 (PST) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Jerin Jacob , Kiran Kumar K , Nithin Dabilpuram , Zhirun Yan , Reshma Pattan Subject: [PATCH v5 05/19] lib: replace use of sanity check in comments and messages Date: Wed, 29 Nov 2023 09:25:59 -0800 Message-ID: <20231129173122.126895-6-stephen@networkplumber.org> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231129173122.126895-1-stephen@networkplumber.org> References: <20230802232550.125487-1-stephen@networkplumber.org> <20231129173122.126895-1-stephen@networkplumber.org> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sanity check is on the Tier 2 non-inclusive list. Replace or remove it. Signed-off-by: Stephen Hemminger --- lib/graph/graph.c | 2 +- lib/graph/graph_stats.c | 2 +- lib/graph/node.c | 2 +- lib/jobstats/rte_jobstats.c | 6 +++--- lib/metrics/rte_metrics.c | 2 +- lib/pcapng/rte_pcapng.c | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/graph/graph.c b/lib/graph/graph.c index 26f0968a978d..e51dcc30568e 100644 --- a/lib/graph/graph.c +++ b/lib/graph/graph.c @@ -344,7 +344,7 @@ rte_graph_create(const char *name, struct rte_graph_param *prm) graph_spinlock_lock(); - /* Check arguments sanity */ + /* Check argument validity */ if (prm == NULL) SET_ERR_JMP(EINVAL, fail, "Param should not be NULL"); diff --git a/lib/graph/graph_stats.c b/lib/graph/graph_stats.c index cc32245c0593..cfb30ae07497 100644 --- a/lib/graph/graph_stats.c +++ b/lib/graph/graph_stats.c @@ -317,7 +317,7 @@ rte_graph_cluster_stats_create(const struct rte_graph_cluster_stats_param *prm) const char *pattern; rte_graph_t i; - /* Sanity checks */ + /* Validate arguments */ if (!rte_graph_has_stats_feature()) SET_ERR_JMP(EINVAL, fail, "Stats feature is not enabled"); diff --git a/lib/graph/node.c b/lib/graph/node.c index 99a962277964..c238d140ed31 100644 --- a/lib/graph/node.c +++ b/lib/graph/node.c @@ -68,7 +68,7 @@ __rte_node_register(const struct rte_node_register *reg) graph_spinlock_lock(); - /* Check sanity */ + /* Check argument validity */ if (reg == NULL || reg->process == NULL) { rte_errno = EINVAL; goto fail; diff --git a/lib/jobstats/rte_jobstats.c b/lib/jobstats/rte_jobstats.c index af565a14eaf3..1c4b280c952a 100644 --- a/lib/jobstats/rte_jobstats.c +++ b/lib/jobstats/rte_jobstats.c @@ -124,7 +124,7 @@ rte_jobstats_start(struct rte_jobstats_context *ctx, struct rte_jobstats *job) { uint64_t now; - /* Some sanity check. */ + /* Check validity of arguments. */ if (unlikely(ctx == NULL || job == NULL || job->context != NULL)) return -EINVAL; @@ -144,7 +144,7 @@ rte_jobstats_abort(struct rte_jobstats *job) struct rte_jobstats_context *ctx; uint64_t now, exec_time; - /* Some sanity check. */ + /* Check that arguments are valid */ if (unlikely(job == NULL || job->context == NULL)) return -EINVAL; @@ -165,7 +165,7 @@ rte_jobstats_finish(struct rte_jobstats *job, int64_t job_value) uint64_t now, exec_time; int need_update; - /* Some sanity check. */ + /* Check arguments */ if (unlikely(job == NULL || job->context == NULL)) return -EINVAL; diff --git a/lib/metrics/rte_metrics.c b/lib/metrics/rte_metrics.c index 0ccdbabc04eb..f60d4f3f6e25 100644 --- a/lib/metrics/rte_metrics.c +++ b/lib/metrics/rte_metrics.c @@ -120,7 +120,7 @@ rte_metrics_reg_names(const char * const *names, uint16_t cnt_names) uint16_t idx_name; uint16_t idx_base; - /* Some sanity checks */ + /* Some consistency checks */ if (cnt_names < 1 || names == NULL) return -EINVAL; for (idx_name = 0; idx_name < cnt_names; idx_name++) diff --git a/lib/pcapng/rte_pcapng.c b/lib/pcapng/rte_pcapng.c index f74ec939a9f8..0de0a231693e 100644 --- a/lib/pcapng/rte_pcapng.c +++ b/lib/pcapng/rte_pcapng.c @@ -619,7 +619,7 @@ rte_pcapng_write_packets(rte_pcapng_t *self, struct pcapng_enhance_packet_block *epb; uint64_t cycles, timestamp; - /* sanity check that is really a pcapng mbuf */ + /* Check that is really a pcapng mbuf */ epb = rte_pktmbuf_mtod(m, struct pcapng_enhance_packet_block *); if (unlikely(epb->block_type != PCAPNG_ENHANCED_PACKET_BLOCK || epb->block_length != rte_pktmbuf_data_len(m))) {