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, 14 insertions, 5 deletions

diff --git a/src/vnet/mpls/mpls_tunnel.c b/src/vnet/mpls/mpls_tunnel.c
index 8d1e30a36fb..e488271dd41 100644
--- a/src/vnet/mpls/mpls_tunnel.c
+++ b/src/vnet/mpls/mpls_tunnel.c
@@ -535,6 +535,7 @@ vnet_create_mpls_tunnel_command_fn (vlib_main_t * vm,
     fib_route_path_t rpath, *rpaths = NULL;
     mpls_label_t out_label = MPLS_LABEL_INVALID, *labels = NULL;
     u32 sw_if_index;
+    clib_error_t *error = NULL;
 
     memset(&rpath, 0, sizeof(rpath));
 
@@ -595,8 +596,11 @@ vnet_create_mpls_tunnel_command_fn (vlib_main_t * vm,
 	else if (unformat (line_input, "l2-only"))
 	    l2_only = 1;
 	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;
+	}
     }
 
     if (is_del)
@@ -606,17 +610,22 @@ vnet_create_mpls_tunnel_command_fn (vlib_main_t * vm,
     else
     {
 	if (0 == vec_len(labels))
-	    return clib_error_return (0, "No Output Labels '%U'",
-				      format_unformat_error, line_input);
+	{
+	    error = clib_error_return (0, "No Output Labels '%U'",
+				       format_unformat_error, line_input);
+	    goto done;
+	}
 
 	vec_add1(rpaths, rpath);
 	vnet_mpls_tunnel_add(rpaths, labels, l2_only, &sw_if_index);
     }
 
+done:
     vec_free(labels);
     vec_free(rpaths);
+    unformat_free (line_input);
 
-    return (NULL);
+    return error;
 }
 
 /*?