From d239e0f2d58ed17422f6135892ae592294a1f837 Mon Sep 17 00:00:00 2001
From: Eric Leblond <eric@regit.org>
Date: Sun, 17 Mar 2019 20:22:55 +0100
Subject: [PATCH] flow-hash: doc and code cleaning

---
 src/flow-hash.c | 29 ++++++++++++++++++++---------
 1 file changed, 20 insertions(+), 9 deletions(-)

diff --git a/src/flow-hash.c b/src/flow-hash.c
index ea90a9455d..1c795a51a5 100644
--- a/src/flow-hash.c
+++ b/src/flow-hash.c
@@ -609,11 +609,24 @@ static inline int FlowCompareKey(Flow *f, FlowKey *key)
     return CMP_FLOW(f, key);
 }
 
+/** \brief Get or create a Flow using a FlowKey
+ *
+ * Hash retrieval function for flows. Looks up the hash bucket containing the
+ * flow pointer. Then compares the packet with the found flow to see if it is
+ * the flow we need. If it isn't, walk the list until the right flow is found.
+ * Return a new Flow if ever no Flow was found.
+ *
+ *
+ *  \param key Pointer to FlowKey build using flow to look for
+ *  \param ttime time to use for flow creation
+ *  \param hash Value of the flow hash
+ *  \retval f *LOCKED* flow or NULL
+ */
+
 Flow *FlowGetFromFlowKey(FlowKey *key, struct timespec *ttime, const uint32_t hash)
 {
-    Flow *f = NULL;
+    Flow *f = FlowGetExistingFlowFromHash(key, hash);
 
-    f = FlowGetExistingFlowFromHash(key, hash);
     if (f != NULL) {
         return f;
     }
@@ -621,11 +634,10 @@ Flow *FlowGetFromFlowKey(FlowKey *key, struct timespec *ttime, const uint32_t ha
     /* No existing flow so let's get one new */
     f = FlowDequeue(&flow_spare_q);
     if (f == NULL) {
-        return NULL;
         /* now see if we can alloc a new flow */
         f = FlowAlloc();
         if (f == NULL) {
-            SCLogError(SC_ERR_FLOW_INIT, "Can't get a spare flow at start");
+            SCLogDebug("Can't get a spare flow at start");
             return NULL;
         }
     }
@@ -646,8 +658,7 @@ Flow *FlowGetFromFlowKey(FlowKey *key, struct timespec *ttime, const uint32_t ha
     f->flow_hash = hash;
     if (key->src.family == AF_INET) {
         f->flags |= FLOW_IPV4;
-    }
-    if (key->src.family == AF_INET6) {
+    } else if (key->src.family == AF_INET6) {
         f->flags |= FLOW_IPV6;
     }
     FlowUpdateState(f, FLOW_STATE_CAPTURE_BYPASSED);
@@ -682,12 +693,12 @@ Flow *FlowGetFromFlowKey(FlowKey *key, struct timespec *ttime, const uint32_t ha
  * the flow we need. If it isn't, walk the list until the right flow is found.
  *
  *
+ *  \param key Pointer to FlowKey build using flow to look for
+ *  \param hash Value of the flow hash
  *  \retval f *LOCKED* flow or NULL
  */
 Flow *FlowGetExistingFlowFromHash(FlowKey *key, const uint32_t hash)
 {
-    Flow *f = NULL;
-
     /* get our hash bucket and lock it */
     FlowBucket *fb = &flow_hash[hash % flow_config.hash_size];
     FBLOCK_LOCK(fb);
@@ -701,7 +712,7 @@ Flow *FlowGetExistingFlowFromHash(FlowKey *key, const uint32_t hash)
     }
 
     /* ok, we have a flow in the bucket. Let's find out if it is our flow */
-    f = fb->head;
+    Flow *f = fb->head;
 
     /* see if this is the flow we are looking for */
     if (FlowCompareKey(f, key) == 0) {