bfd_cli.c File Reference

BFD CLI implementation. More...

Include dependency graph for bfd_cli.c:

Go to the source code of this file.

Macros
#define	INTERFACE_STR   "interface"
#define	LOCAL_ADDR_STR   "local-addr"
#define	PEER_ADDR_STR   "peer-addr"
#define	CONF_KEY_ID_STR   "conf-key-id"
#define	BFD_KEY_ID_STR   "bfd-key-id"
#define	DESIRED_MIN_TX_STR   "desired-min-tx"
#define	REQUIRED_MIN_RX_STR   "required-min-rx"
#define	DETECT_MULT_STR   "detect-mult"
#define	ADMIN_STR   "admin"
#define	DELAYED_STR   "delayed"
#define	DECLARE(t, n, s, r, ...)
#define	UNFORMAT(t, n, s, r, ...)
#define	CHECK_MANDATORY(t, n, s, r, ...)
#define	foreach_bfd_cli_udp_session_add_cli_param(F)
#define	foreach_bfd_cli_udp_session_mod_cli_param(F)
#define	foreach_bfd_cli_udp_session_del_cli_param(F)
#define	foreach_bfd_cli_udp_session_set_flags_cli_param(F)
#define	foreach_bfd_cli_udp_session_auth_activate_cli_param(F)
#define	foreach_bfd_cli_udp_session_auth_deactivate_cli_param(F)
#define	foreach_bfd_cli_udp_set_echo_source_cli_param(F)

Functions
static u8 *	format_bfd_session_cli (u8 *s, va_list *args)
static clib_error_t *	show_bfd (vlib_main_t *vm, unformat_input_t *input, CLIB_UNUSED(vlib_cli_command_t *lmd))
static clib_error_t *	bfd_cli_key_add (vlib_main_t *vm, unformat_input_t *input, CLIB_UNUSED(vlib_cli_command_t *lmd))
static clib_error_t *	bfd_cli_key_del (vlib_main_t *vm, unformat_input_t *input, CLIB_UNUSED(vlib_cli_command_t *lmd))
static clib_error_t *	bfd_cli_udp_session_add (vlib_main_t *vm, unformat_input_t *input, CLIB_UNUSED(vlib_cli_command_t *lmd))
static clib_error_t *	bfd_cli_udp_session_mod (vlib_main_t *vm, unformat_input_t *input, CLIB_UNUSED(vlib_cli_command_t *lmd))
static clib_error_t *	bfd_cli_udp_session_del (vlib_main_t *vm, unformat_input_t *input, CLIB_UNUSED(vlib_cli_command_t *lmd))
static clib_error_t *	bfd_cli_udp_session_set_flags (vlib_main_t *vm, unformat_input_t *input, CLIB_UNUSED(vlib_cli_command_t *lmd))
static clib_error_t *	bfd_cli_udp_session_auth_activate (vlib_main_t *vm, unformat_input_t *input, CLIB_UNUSED(vlib_cli_command_t *lmd))
static clib_error_t *	bfd_cli_udp_session_auth_deactivate (vlib_main_t *vm, unformat_input_t *input, CLIB_UNUSED(vlib_cli_command_t *lmd))
static clib_error_t *	bfd_cli_udp_set_echo_source (vlib_main_t *vm, unformat_input_t *input, CLIB_UNUSED(vlib_cli_command_t *lmd))
static clib_error_t *	bfd_cli_udp_del_echo_source (vlib_main_t *vm, unformat_input_t *input, CLIB_UNUSED(vlib_cli_command_t *lmd))

Variables
static vlib_cli_command_t	show_bfd_command
	(constructor) VLIB_CLI_COMMAND (show_bfd_command) More...
static vlib_cli_command_t	bfd_cli_key_add_command
	(constructor) VLIB_CLI_COMMAND (bfd_cli_key_add_command) More...
static vlib_cli_command_t	bfd_cli_key_del_command
	(constructor) VLIB_CLI_COMMAND (bfd_cli_key_del_command) More...
static const unsigned	mandatory = 1
static const unsigned	optional = 0
static vlib_cli_command_t	bfd_cli_udp_session_add_command
	(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_session_add_command) More...
static vlib_cli_command_t	bfd_cli_udp_session_mod_command
	(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_session_mod_command) More...
static vlib_cli_command_t	bfd_cli_udp_session_del_command
	(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_session_del_command) More...
static vlib_cli_command_t	bfd_cli_udp_session_set_flags_command
	(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_session_set_flags_command) More...
static vlib_cli_command_t	bfd_cli_udp_session_auth_activate_command
	(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_session_auth_activate_command) More...
static vlib_cli_command_t	bfd_cli_udp_session_auth_deactivate_command
	(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_session_auth_deactivate_command) More...
static vlib_cli_command_t	bfd_cli_udp_set_echo_source_cmd
	(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_set_echo_source_cmd) More...
static vlib_cli_command_t	bfd_cli_udp_del_echo_source_cmd
	(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_del_echo_source_cmd) More...

Detailed Description

BFD CLI implementation.

Definition in file bfd_cli.c.

Macro Definition Documentation

ADMIN_STR

#define ADMIN_STR   "admin"

Definition at line 374 of file bfd_cli.c.

BFD_KEY_ID_STR

#define BFD_KEY_ID_STR   "bfd-key-id"

Definition at line 370 of file bfd_cli.c.

CHECK_MANDATORY

#define CHECK_MANDATORY	(		t,
			n,
			s,
			r,
			...
	)

Value:

WARN_OFF(tautological-compare)                                            \
  if (mandatory == r && !have_##n)                                        \
    {                                                                     \
      WARN_ON(tautological-compare)                                       \
      ret = clib_error_return (0, "Required parameter `%s' missing.", s); \
      goto out;                                                           \
    }

Definition at line 391 of file bfd_cli.c.

CONF_KEY_ID_STR

#define CONF_KEY_ID_STR   "conf-key-id"

Definition at line 369 of file bfd_cli.c.

DECLARE

#define DECLARE	(		t,
			n,
			s,
			r,
			...
	)

Value:

int have_##n = 0;              \
  t n;

Definition at line 380 of file bfd_cli.c.

DELAYED_STR

#define DELAYED_STR   "delayed"

Definition at line 375 of file bfd_cli.c.

DESIRED_MIN_TX_STR

#define DESIRED_MIN_TX_STR   "desired-min-tx"

Definition at line 371 of file bfd_cli.c.

DETECT_MULT_STR

#define DETECT_MULT_STR   "detect-mult"

Definition at line 373 of file bfd_cli.c.

foreach_bfd_cli_udp_session_add_cli_param

#define foreach_bfd_cli_udp_session_add_cli_param

(

F

)

Value:

F (u32, sw_if_index, INTERFACE_STR, mandatory, "%U",            \
     unformat_vnet_sw_interface(), &vnet_main)                      \
  F (ip46_address_t, local_addr, LOCAL_ADDR_STR, mandatory, "%U", \
     unformat_ip46_address)                                       \
  F (ip46_address_t, peer_addr, PEER_ADDR_STR, mandatory, "%U",   \
     unformat_ip46_address)                                       \
  F (u32, desired_min_tx, DESIRED_MIN_TX_STR, mandatory, "%u")    \
  F (u32, required_min_rx, REQUIRED_MIN_RX_STR, mandatory, "%u")  \
  F (u32, detect_mult, DETECT_MULT_STR, mandatory, "%u")          \
  F (u32, conf_key_id, CONF_KEY_ID_STR, optional, "%u")           \
  F (u32, bfd_key_id, BFD_KEY_ID_STR, optional, "%u")

foreach_bfd_cli_udp_session_auth_activate_cli_param

#define foreach_bfd_cli_udp_session_auth_activate_cli_param

(

F

)

Value:

F (u32, sw_if_index, INTERFACE_STR, mandatory, "%U",            \
     unformat_vnet_sw_interface(), &vnet_main)                      \
  F (ip46_address_t, local_addr, LOCAL_ADDR_STR, mandatory, "%U", \
     unformat_ip46_address)                                       \
  F (ip46_address_t, peer_addr, PEER_ADDR_STR, mandatory, "%U",   \
     unformat_ip46_address)                                       \
  F (u8 *, delayed_token, DELAYED_STR, optional, "%v")            \
  F (u32, conf_key_id, CONF_KEY_ID_STR, mandatory, "%u")          \
  F (u32, bfd_key_id, BFD_KEY_ID_STR, mandatory, "%u")

foreach_bfd_cli_udp_session_auth_deactivate_cli_param

#define foreach_bfd_cli_udp_session_auth_deactivate_cli_param

(

F

)

Value:

F (u32, sw_if_index, INTERFACE_STR, mandatory, "%U",            \
     unformat_vnet_sw_interface(), &vnet_main)                      \
  F (ip46_address_t, local_addr, LOCAL_ADDR_STR, mandatory, "%U", \
     unformat_ip46_address)                                       \
  F (ip46_address_t, peer_addr, PEER_ADDR_STR, mandatory, "%U",   \
     unformat_ip46_address)                                       \
  F (u8 *, delayed_token, DELAYED_STR, optional, "%v")

foreach_bfd_cli_udp_session_del_cli_param

#define foreach_bfd_cli_udp_session_del_cli_param

(

F

)

Value:

F (u32, sw_if_index, INTERFACE_STR, mandatory, "%U",            \
     unformat_vnet_sw_interface(), &vnet_main)                      \
  F (ip46_address_t, local_addr, LOCAL_ADDR_STR, mandatory, "%U", \
     unformat_ip46_address)                                       \
  F (ip46_address_t, peer_addr, PEER_ADDR_STR, mandatory, "%U",   \
     unformat_ip46_address)

foreach_bfd_cli_udp_session_mod_cli_param

#define foreach_bfd_cli_udp_session_mod_cli_param

(

F

)

Value:

F (u32, sw_if_index, INTERFACE_STR, mandatory, "%U",            \
     unformat_vnet_sw_interface(), &vnet_main)                      \
  F (ip46_address_t, local_addr, LOCAL_ADDR_STR, mandatory, "%U", \
     unformat_ip46_address)                                       \
  F (ip46_address_t, peer_addr, PEER_ADDR_STR, mandatory, "%U",   \
     unformat_ip46_address)                                       \
  F (u32, desired_min_tx, DESIRED_MIN_TX_STR, mandatory, "%u")    \
  F (u32, required_min_rx, REQUIRED_MIN_RX_STR, mandatory, "%u")  \
  F (u32, detect_mult, DETECT_MULT_STR, mandatory, "%u")

foreach_bfd_cli_udp_session_set_flags_cli_param

#define foreach_bfd_cli_udp_session_set_flags_cli_param

(

F

)

Value:

F (u32, sw_if_index, INTERFACE_STR, mandatory, "%U",            \
     unformat_vnet_sw_interface(), &vnet_main)                      \
  F (ip46_address_t, local_addr, LOCAL_ADDR_STR, mandatory, "%U", \
     unformat_ip46_address)                                       \
  F (ip46_address_t, peer_addr, PEER_ADDR_STR, mandatory, "%U",   \
     unformat_ip46_address)                                       \
  F (u8 *, admin_up_down_token, ADMIN_STR, mandatory, "%v",       \
     &admin_up_down_token)

foreach_bfd_cli_udp_set_echo_source_cli_param

#define foreach_bfd_cli_udp_set_echo_source_cli_param

(

F

)

Value:

F (u32, sw_if_index, INTERFACE_STR, mandatory, "%U",   \
     unformat_vnet_sw_interface(), &vnet_main)

INTERFACE_STR

#define INTERFACE_STR   "interface"

Definition at line 366 of file bfd_cli.c.

LOCAL_ADDR_STR

#define LOCAL_ADDR_STR   "local-addr"

Definition at line 367 of file bfd_cli.c.

PEER_ADDR_STR

#define PEER_ADDR_STR   "peer-addr"

Definition at line 368 of file bfd_cli.c.

REQUIRED_MIN_RX_STR

#define REQUIRED_MIN_RX_STR   "required-min-rx"

Definition at line 372 of file bfd_cli.c.

UNFORMAT

#define UNFORMAT	(		t,
			n,
			s,
			r,
			...
	)

Value:

if (unformat (line_input, s " " __VA_ARGS__, &n)) \
    {                                          \
      something_parsed = 1;                    \
      have_##n = 1;                            \
    }

Definition at line 384 of file bfd_cli.c.

Function Documentation

bfd_cli_key_add()

static clib_error_t* bfd_cli_key_add ( vlib_main_t *  vm, unformat_input_t *  input, CLIB_UNUSED(vlib_cli_command_t *lmd)    )

static

Definition at line 224 of file bfd_cli.c.

Here is the call graph for this function:

bfd_cli_key_del()

static clib_error_t* bfd_cli_key_del ( vlib_main_t *  vm, unformat_input_t *  input, CLIB_UNUSED(vlib_cli_command_t *lmd)    )

static

Definition at line 325 of file bfd_cli.c.

Here is the call graph for this function:

bfd_cli_udp_del_echo_source()

static clib_error_t* bfd_cli_udp_del_echo_source ( vlib_main_t *  vm, unformat_input_t *  input, CLIB_UNUSED(vlib_cli_command_t *lmd)    )

static

Definition at line 953 of file bfd_cli.c.

Here is the call graph for this function:

bfd_cli_udp_session_add()

static clib_error_t* bfd_cli_udp_session_add ( vlib_main_t *  vm, unformat_input_t *  input, CLIB_UNUSED(vlib_cli_command_t *lmd)    )

static

Definition at line 401 of file bfd_cli.c.

Here is the call graph for this function:

bfd_cli_udp_session_auth_activate()

static clib_error_t* bfd_cli_udp_session_auth_activate ( vlib_main_t *  vm, unformat_input_t *  input, CLIB_UNUSED(vlib_cli_command_t *lmd)    )

static

Definition at line 718 of file bfd_cli.c.

Here is the call graph for this function:

bfd_cli_udp_session_auth_deactivate()

static clib_error_t* bfd_cli_udp_session_auth_deactivate ( vlib_main_t *  vm, unformat_input_t *  input, CLIB_UNUSED(vlib_cli_command_t *lmd)    )

static

Definition at line 816 of file bfd_cli.c.

Here is the call graph for this function:

bfd_cli_udp_session_del()

static clib_error_t* bfd_cli_udp_session_del ( vlib_main_t *  vm, unformat_input_t *  input, CLIB_UNUSED(vlib_cli_command_t *lmd)    )

static

Definition at line 574 of file bfd_cli.c.

Here is the call graph for this function:

bfd_cli_udp_session_mod()

static clib_error_t* bfd_cli_udp_session_mod ( vlib_main_t *  vm, unformat_input_t *  input, CLIB_UNUSED(vlib_cli_command_t *lmd)    )

static

Definition at line 499 of file bfd_cli.c.

Here is the call graph for this function:

bfd_cli_udp_session_set_flags()

static clib_error_t* bfd_cli_udp_session_set_flags ( vlib_main_t *  vm, unformat_input_t *  input, CLIB_UNUSED(vlib_cli_command_t *lmd)    )

static

Definition at line 635 of file bfd_cli.c.

Here is the call graph for this function:

bfd_cli_udp_set_echo_source()

static clib_error_t* bfd_cli_udp_set_echo_source ( vlib_main_t *  vm, unformat_input_t *  input, CLIB_UNUSED(vlib_cli_command_t *lmd)    )

static

Definition at line 900 of file bfd_cli.c.

Here is the call graph for this function:

format_bfd_session_cli()

static u8* format_bfd_session_cli ( u8 *  s, va_list *  args  )

static

Definition at line 30 of file bfd_cli.c.

Here is the call graph for this function:

show_bfd()

static clib_error_t* show_bfd ( vlib_main_t *  vm, unformat_input_t *  input, CLIB_UNUSED(vlib_cli_command_t *lmd)    )

static

Definition at line 121 of file bfd_cli.c.

Here is the call graph for this function:

Variable Documentation

bfd_cli_key_add_command

vlib_cli_command_t bfd_cli_key_add_command

static

Initial value:

= {
  .path = "bfd key set",
  .short_help = "bfd key set"
                " conf-key-id <id>"
                " type <keyed-sha1|meticulous-keyed-sha1> "
                " secret <secret>",
  .function = bfd_cli_key_add,
}

(constructor) VLIB_CLI_COMMAND (bfd_cli_key_add_command)

Definition at line 314 of file bfd_cli.c.

bfd_cli_key_del_command

vlib_cli_command_t bfd_cli_key_del_command

static

Initial value:

= {
  .path = "bfd key del",
  .short_help = "bfd key del conf-key-id <id>",
  .function = bfd_cli_key_del,
}

(constructor) VLIB_CLI_COMMAND (bfd_cli_key_del_command)

Definition at line 359 of file bfd_cli.c.

bfd_cli_udp_del_echo_source_cmd

vlib_cli_command_t bfd_cli_udp_del_echo_source_cmd

static

Initial value:

= {
  .path = "bfd udp echo-source del",
  .short_help = "bfd udp echo-source del",
  .function = bfd_cli_udp_del_echo_source,
}

(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_del_echo_source_cmd)

Definition at line 968 of file bfd_cli.c.

bfd_cli_udp_session_add_command

vlib_cli_command_t bfd_cli_udp_session_add_command

static

Initial value:

= {
  .path = "bfd udp session add",
  .short_help = "bfd udp session add"
                " interface <interface>"
                " local-addr <local-address>"
                " peer-addr <peer-address>"
                " desired-min-tx <desired min tx interval>"
                " required-min-rx <required min rx interval>"
                " detect-mult <detect multiplier> "
                "["
                " conf-key-id <config key ID>"
                " bfd-key-id <BFD key ID>"
                "]",
  .function = bfd_cli_udp_session_add,
}

(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_session_add_command)

Definition at line 481 of file bfd_cli.c.

bfd_cli_udp_session_auth_activate_command

vlib_cli_command_t bfd_cli_udp_session_auth_activate_command

static

Initial value:

= {
  .path = "bfd udp session auth activate",
  .short_help = "bfd udp session auth activate"
                " interface <interface>"
                " local-addr <local-address>"
                " peer-addr <peer-address>"
                " conf-key-id <config key ID>"
                " bfd-key-id <BFD key ID>"
                " [ delayed <yes|no> ]",
  .function = bfd_cli_udp_session_auth_activate,
}

(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_session_auth_activate_command)

Definition at line 803 of file bfd_cli.c.

bfd_cli_udp_session_auth_deactivate_command

vlib_cli_command_t bfd_cli_udp_session_auth_deactivate_command

static

Initial value:

= {
  .path = "bfd udp session auth deactivate",
  .short_help = "bfd udp session auth deactivate"
                " interface <interface>"
                " local-addr <local-address>"
                " peer-addr <peer-address>"
                "[ delayed <yes|no> ]",
  .function = bfd_cli_udp_session_auth_deactivate,
}

(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_session_auth_deactivate_command)

Definition at line 888 of file bfd_cli.c.

bfd_cli_udp_session_del_command

vlib_cli_command_t bfd_cli_udp_session_del_command

static

Initial value:

= {
  .path = "bfd udp session del",
  .short_help = "bfd udp session del interface"
                " <interface> local-addr"
                " <local-address> peer-addr"
                "<peer-address> ",
  .function = bfd_cli_udp_session_del,
}

(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_session_del_command)

Definition at line 624 of file bfd_cli.c.

bfd_cli_udp_session_mod_command

vlib_cli_command_t bfd_cli_udp_session_mod_command

static

Initial value:

= {
  .path = "bfd udp session mod",
  .short_help = "bfd udp session mod interface"
                " <interface> local-addr"
                " <local-address> peer-addr"
                " <peer-address> desired-min-tx"
                " <desired min tx interval> required-min-rx"
                " <required min rx interval> detect-mult"
                " <detect multiplier> ",
  .function = bfd_cli_udp_session_mod,
}

(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_session_mod_command)

Definition at line 560 of file bfd_cli.c.

bfd_cli_udp_session_set_flags_command

vlib_cli_command_t bfd_cli_udp_session_set_flags_command

static

Initial value:

= {
  .path = "bfd udp session set-flags",
  .short_help = "bfd udp session set-flags"
                " interface <interface>"
                " local-addr <local-address>"
                " peer-addr <peer-address>"
                " admin <up|down>",
  .function = bfd_cli_udp_session_set_flags,
}

(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_session_set_flags_command)

Definition at line 706 of file bfd_cli.c.

bfd_cli_udp_set_echo_source_cmd

vlib_cli_command_t bfd_cli_udp_set_echo_source_cmd

static

Initial value:

= {
  .path = "bfd udp echo-source set",
  .short_help = "bfd udp echo-source set interface <interface>",
  .function = bfd_cli_udp_set_echo_source,
}

(constructor) VLIB_CLI_COMMAND (bfd_cli_udp_set_echo_source_cmd)

Definition at line 945 of file bfd_cli.c.

mandatory

const unsigned mandatory = 1

static

Definition at line 377 of file bfd_cli.c.

optional

const unsigned optional = 0

static

Definition at line 378 of file bfd_cli.c.

show_bfd_command

vlib_cli_command_t show_bfd_command

static

Initial value:

= {
  .path = "show bfd",
  .short_help = "show bfd [keys|sessions|echo-source]",
  .function = show_bfd,
}

(constructor) VLIB_CLI_COMMAND (show_bfd_command)

Definition at line 216 of file bfd_cli.c.