VPP-635: CLI Memory leak with invalid parameter 48/5148/5
authorBilly McFall <bmcfall@redhat.com>
Wed, 15 Feb 2017 16:39:12 +0000 (11:39 -0500)
committerDave Barach <openvpp@barachs.net>
Wed, 22 Feb 2017 16:23:12 +0000 (16:23 +0000)
commita9a20e7f69f4a91a4d5267ab5ce14125bdc7d6c6
tree58647f28d51d1cac3e7aa4e9ca94280192e6ec25
parent2291a36008e197423a0f0414f6dcca4afa3ac4c1
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>
37 files changed:
build-root/emacs-lisp/tunnel-c-skel.el
src/plugins/ila/ila.c
src/plugins/lb/cli.c
src/plugins/sixrd/sixrd.c
src/plugins/snat/snat.c
src/vlib/threads_cli.c
src/vlib/trace.c
src/vlib/unix/cli.c
src/vnet/devices/af_packet/cli.c
src/vnet/devices/dpdk/cli.c
src/vnet/devices/dpdk/ipsec/cli.c
src/vnet/devices/netmap/cli.c
src/vnet/devices/virtio/vhost-user.c
src/vnet/gre/interface.c
src/vnet/ip/ip4_source_check.c
src/vnet/ip/ip4_test.c
src/vnet/ip/ip6_neighbor.c
src/vnet/ip/lookup.c
src/vnet/ipsec-gre/interface.c
src/vnet/ipsec/ipsec_cli.c
src/vnet/l2/l2_patch.c
src/vnet/l2/l2_xcrw.c
src/vnet/l2tp/l2tp.c
src/vnet/lisp-cp/lisp_cli.c
src/vnet/lisp-gpe/interface.c
src/vnet/lisp-gpe/lisp_gpe.c
src/vnet/map/map.c
src/vnet/mpls/mpls.c
src/vnet/mpls/mpls_tunnel.c
src/vnet/pg/cli.c
src/vnet/policer/node_funcs.c
src/vnet/policer/policer.c
src/vnet/unix/tapcli.c
src/vnet/vxlan-gpe/vxlan_gpe.c
src/vnet/vxlan/vxlan.c
src/vpp/app/l2t.c
src/vpp/app/vpe_cli.c