reorder: add checks for invalid function inputs

Message ID 20190410112447.68386-1-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series reorder: add checks for invalid function inputs |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Performance-Testing success Performance Testing PASS
ci/mellanox-Performance-Testing success Performance Testing PASS

Commit Message

Bruce Richardson April 10, 2019, 11:24 a.m. UTC
  For APIs which can return an error value, do sanity checking of the input
parameters for NULL and return a suitable error value for those cases.

NOTE: The drain function is currently omitting NULL checks too, but this
function has no way to flag an error value, so checking in that case would
simply mask problems.

Reported-by: Bernard Iremonger <bernard.iremonger@intel.com>
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 lib/librte_reorder/rte_reorder.c | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)
  

Comments

Iremonger, Bernard April 11, 2019, 8:43 a.m. UTC | #1
> -----Original Message-----
> From: Richardson, Bruce
> Sent: Wednesday, April 10, 2019 12:25 PM
> To: dev@dpdk.org
> Cc: Iremonger, Bernard <bernard.iremonger@intel.com>; Richardson, Bruce
> <bruce.richardson@intel.com>
> Subject: [PATCH] reorder: add checks for invalid function inputs
> 
> For APIs which can return an error value, do sanity checking of the input
> parameters for NULL and return a suitable error value for those cases.
> 
> NOTE: The drain function is currently omitting NULL checks too, but this
> function has no way to flag an error value, so checking in that case would
> simply mask problems.
> 
> Reported-by: Bernard Iremonger <bernard.iremonger@intel.com>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
  
Thomas Monjalon April 22, 2019, 5:37 p.m. UTC | #2
> > For APIs which can return an error value, do sanity checking of the input
> > parameters for NULL and return a suitable error value for those cases.
> > 
> > NOTE: The drain function is currently omitting NULL checks too, but this
> > function has no way to flag an error value, so checking in that case would
> > simply mask problems.
> > 
> > Reported-by: Bernard Iremonger <bernard.iremonger@intel.com>
> > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> 
> Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>

Applied, thanks
  

Patch

diff --git a/lib/librte_reorder/rte_reorder.c b/lib/librte_reorder/rte_reorder.c
index b15328b2e..3a4a1b0a0 100644
--- a/lib/librte_reorder/rte_reorder.c
+++ b/lib/librte_reorder/rte_reorder.c
@@ -222,6 +222,11 @@  rte_reorder_find_existing(const char *name)
 	struct rte_tailq_entry *te;
 	struct rte_reorder_list *reorder_list;
 
+	if (name == NULL) {
+		rte_errno = EINVAL;
+		return NULL;
+	}
+
 	reorder_list = RTE_TAILQ_CAST(rte_reorder_tailq.head, rte_reorder_list);
 
 	rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
@@ -295,8 +300,14 @@  int
 rte_reorder_insert(struct rte_reorder_buffer *b, struct rte_mbuf *mbuf)
 {
 	uint32_t offset, position;
-	struct cir_buffer *order_buf = &b->order_buf;
+	struct cir_buffer *order_buf;
+
+	if (b == NULL || mbuf == NULL) {
+		rte_errno = EINVAL;
+		return -1;
+	}
 
+	order_buf = &b->order_buf;
 	if (!b->is_initialized) {
 		b->min_seqn = mbuf->seqn;
 		b->is_initialized = 1;