VPP-635: CLI Memory leak with invalid parameter

In the CLI parsing, below is a common pattern:
  /* Get a line of input. */
  if (!unformat_user (input, unformat_line_input, line_input))
    return 0;

  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
    {
      if (unformat (line_input, "x"))
	x = 1;
      :
      else
	return clib_error_return (0, "unknown input `%U'",
				  format_unformat_error, line_input);
    }
  unformat_free (line_input);

The 'else' returns if an unknown string is encountered. There a memory
leak because the 'unformat_free(line_input)' is not called. There is a
large number of instances of this pattern.

Replaced the previous pattern with:
  /* Get a line of input. */
  if (!unformat_user (input, unformat_line_input, line_input))
    return 0;

  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
    {
      if (unformat (line_input, "x"))
	x = 1;
      :
      else
        {
	  error = clib_error_return (0, "unknown input `%U'",
				     format_unformat_error, line_input);
	  goto done:
        }
    }

  /* ...Remaining code... */

done:
  unformat_free (line_input);
  return error;
}

In multiple files, 'unformat_free (line_input);' was never called, so
there was a memory leak whether an invalid string was entered or not.

Also, there were multiple instance where:
	  error = clib_error_return (0, "unknown input `%U'",
				     format_unformat_error, line_input);
used 'input' as the last parameter instead of 'line_input'. The result
is that output did not contain the substring in error, instead just an
empty string. Fixed all of those as well.

There are a lot of file, and very mind numbing work, so tried to keep
it to a pattern to avoid mistakes.

Change-Id: I8902f0c32a47dd7fb3bb3471a89818571702f1d2
Signed-off-by: Billy McFall <bmcfall@redhat.com>
Signed-off-by: Dave Barach <dave@barachs.net>

1 files changed, 23 insertions, 11 deletions

diff --git a/src/vnet/ip/lookup.c b/src/vnet/ip/lookup.c
index 0ef0e7a6deb..807b87b6037 100644
--- a/src/vnet/ip/lookup.c
+++ b/src/vnet/ip/lookup.c
@@ -568,8 +568,6 @@ vnet_ip_route_cmd (vlib_main_t * vm,
 	}
     }
 
-  unformat_free (line_input);
-
   if (vec_len (prefixs) == 0)
     {
       error =
@@ -704,6 +702,7 @@ done:
   vec_free (dpos);
   vec_free (prefixs);
   vec_free (rpaths);
+  unformat_free (line_input);
   return error;
 }
 
@@ -872,8 +871,6 @@ vnet_ip_mroute_cmd (vlib_main_t * vm,
 	}
     }
 
-  unformat_free (line_input);
-
   if (~0 == table_id)
     {
       /*
@@ -970,6 +967,8 @@ vnet_ip_mroute_cmd (vlib_main_t * vm,
 		     (scount * gcount) / (timet[1] - timet[0]));
 
 done:
+  unformat_free (line_input);
+
   return error;
 }
 
@@ -1149,24 +1148,37 @@ probe_neighbor_address (vlib_main_t * vm,
 	  is_ip4 = 0;
 	}
       else
-	return clib_error_return (0, "unknown input '%U'",
-				  format_unformat_error, line_input);
+	{
+	  error = clib_error_return (0, "unknown input '%U'",
+				     format_unformat_error, line_input);
+	  goto done;
+	}
     }
 
-  unformat_free (line_input);
-
   if (sw_if_index == ~0)
-    return clib_error_return (0, "Interface required, not set.");
+    {
+      error = clib_error_return (0, "Interface required, not set.");
+      goto done;
+    }
   if (address_set == 0)
-    return clib_error_return (0, "ip address required, not set.");
+    {
+      error = clib_error_return (0, "ip address required, not set.");
+      goto done;
+    }
   if (address_set > 1)
-    return clib_error_return (0, "Multiple ip addresses not supported.");
+    {
+      error = clib_error_return (0, "Multiple ip addresses not supported.");
+      goto done;
+    }
 
   if (is_ip4)
     error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
   else
     error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
 
+done:
+  unformat_free (line_input);
+
   return error;
 }