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>
diff --git a/src/vnet/ip/ip4_source_check.c b/src/vnet/ip/ip4_source_check.c
index d461cc8..3af32f2 100644
--- a/src/vnet/ip/ip4_source_check.c
+++ b/src/vnet/ip/ip4_source_check.c
@@ -399,6 +399,8 @@
vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index,
is_del == 0, &config, sizeof (config));
done:
+ unformat_free (line_input);
+
return error;
}
@@ -531,7 +533,9 @@
}
done:
- return (error);
+ unformat_free (line_input);
+
+ return error;
}
/*?
diff --git a/src/vnet/ip/ip4_test.c b/src/vnet/ip/ip4_test.c
index 45d1711..73dabfd 100644
--- a/src/vnet/ip/ip4_test.c
+++ b/src/vnet/ip/ip4_test.c
@@ -143,8 +143,11 @@
else if (unformat (line_input, "verbose"))
verbose = 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;
+ }
}
}
@@ -178,7 +181,7 @@
if (p == 0)
{
vlib_cli_output (vm, "Couldn't map fib id %d to fib index\n", table_id);
- return 0;
+ goto done;
}
table_index = p[0];
@@ -294,7 +297,11 @@
pool_free (tm->route_pool);
}
- return 0;
+
+done:
+ unformat_free (line_input);
+
+ return error;
}
/*?
diff --git a/src/vnet/ip/ip6_neighbor.c b/src/vnet/ip/ip6_neighbor.c
index 7229591..6b53137 100644
--- a/src/vnet/ip/ip6_neighbor.c
+++ b/src/vnet/ip/ip6_neighbor.c
@@ -2923,7 +2923,10 @@
else if (unformat (line_input, "ra-lifetime"))
{
if (!unformat (line_input, "%d", &ra_lifetime))
- return (error = unformat_parse_error (line_input));
+ {
+ error = unformat_parse_error (line_input);
+ goto done;
+ }
use_lifetime = 1;
break;
}
@@ -2931,13 +2934,19 @@
{
if (!unformat
(line_input, "%d %d", &ra_initial_count, &ra_initial_interval))
- return (error = unformat_parse_error (line_input));
+ {
+ error = unformat_parse_error (line_input);
+ goto done;
+ }
break;
}
else if (unformat (line_input, "ra-interval"))
{
if (!unformat (line_input, "%d", &ra_max_interval))
- return (error = unformat_parse_error (line_input));
+ {
+ error = unformat_parse_error (line_input);
+ goto done;
+ }
if (!unformat (line_input, "%d", &ra_min_interval))
ra_min_interval = 0;
@@ -2949,7 +2958,10 @@
break;
}
else
- return (unformat_parse_error (line_input));
+ {
+ error = unformat_parse_error (line_input);
+ goto done;
+ }
}
if (add_radv_info)
@@ -3006,7 +3018,10 @@
else if (unformat (line_input, "no-onlink"))
no_onlink = 1;
else
- return (unformat_parse_error (line_input));
+ {
+ error = unformat_parse_error (line_input);
+ goto done;
+ }
}
ip6_neighbor_ra_prefix (vm, sw_if_index,
@@ -3018,9 +3033,9 @@
off_link, no_autoconfig, no_onlink, is_no);
}
+done:
unformat_free (line_input);
-done:
return error;
}
diff --git a/src/vnet/ip/lookup.c b/src/vnet/ip/lookup.c
index 0ef0e7a..807b87b 100644
--- a/src/vnet/ip/lookup.c
+++ b/src/vnet/ip/lookup.c
@@ -568,8 +568,6 @@
}
}
- unformat_free (line_input);
-
if (vec_len (prefixs) == 0)
{
error =
@@ -704,6 +702,7 @@
vec_free (dpos);
vec_free (prefixs);
vec_free (rpaths);
+ unformat_free (line_input);
return error;
}
@@ -872,8 +871,6 @@
}
}
- unformat_free (line_input);
-
if (~0 == table_id)
{
/*
@@ -970,6 +967,8 @@
(scount * gcount) / (timet[1] - timet[0]));
done:
+ unformat_free (line_input);
+
return error;
}
@@ -1149,24 +1148,37 @@
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;
}