ip6_hop_by_hop.c File Reference

In-band OAM (iOAM). More...

Include dependency graph for ip6_hop_by_hop.c:

Go to the source code of this file.

Data Structures
struct	ip6_add_hop_by_hop_trace_t
struct	ip6_pop_hop_by_hop_trace_t
struct	ip6_local_hop_by_hop_trace_t

Macros
#define	foreach_ip6_hbyh_ioam_input_next
#define	foreach_ip6_add_hop_by_hop_error   _(PROCESSED, "Pkts w/ added ip6 hop-by-hop options")
#define	foreach_ip6_pop_hop_by_hop_error
#define	foreach_ip6_local_hop_by_hop_error

Enumerations
enum	ip6_hbyh_ioam_input_next_t { IP6_HBYH_IOAM_INPUT_N_NEXT }
enum	ip6_add_hop_by_hop_error_t { IP6_ADD_HOP_BY_HOP_N_ERROR }
enum	ip6_pop_hop_by_hop_error_t { IP6_POP_HOP_BY_HOP_N_ERROR }
enum	ip6_local_hop_by_hop_error_t { IP6_LOCAL_HOP_BY_HOP_N_ERROR }
enum	ip6_local_hop_by_hop_next_t { IP6_LOCAL_HOP_BY_HOP_NEXT_DROP, IP6_LOCAL_HOP_BY_HOP_N_NEXT }

Functions
static uword	unformat_opaque_ioam (unformat_input_t *input, va_list *args)
u8 *	get_flow_name_from_flow_ctx (u32 flow_ctx)
int	ip6_hbh_add_register_option (u8 option, u8 size, int rewrite_options(u8 *rewrite_string, u8 *rewrite_size))
int	ip6_hbh_add_unregister_option (u8 option)
int	ip6_hbh_config_handler_register (u8 option, int config_handler(void *data, u8 disable))
int	ip6_hbh_config_handler_unregister (u8 option)
int	ip6_hbh_flow_handler_register (u8 option, u32 ioam_flow_handler(u32 flow_ctx, u8 add))
int	ip6_hbh_flow_handler_unregister (u8 option)
static u8 *	format_ip6_add_hop_by_hop_trace (u8 *s, va_list *args)
VLIB_NODE_FN()	ip6_add_hop_by_hop_node (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
static u8 *	format_ip6_pop_hop_by_hop_trace (u8 *s, va_list *args)
int	ip6_hbh_pop_register_option (u8 option, int options(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt))
int	ip6_hbh_pop_unregister_option (u8 option)
static void	ioam_pop_hop_by_hop_processing (vlib_main_t *vm, ip6_header_t *ip0, ip6_hop_by_hop_header_t *hbh0, vlib_buffer_t *b)
VLIB_NODE_FN()	ip6_pop_hop_by_hop_node (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
static u8 *	format_ip6_local_hop_by_hop_trace (u8 *s, va_list *args)
static uword	ip6_local_hop_by_hop_inline (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame, int is_trace)
VLIB_NODE_FN()	ip6_local_hop_by_hop_node (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
clib_error_t *	show_ip6_hbh_command_fn (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
static clib_error_t *	ip6_hop_by_hop_ioam_init (vlib_main_t *vm)
void	ip6_local_hop_by_hop_register_protocol (u32 protocol, u32 node_index)
int	ip6_ioam_set_rewrite (u8 **rwp, int has_trace_option, int has_pot_option, int has_seqno_option)
clib_error_t *	clear_ioam_rewrite_fn (void)
clib_error_t *	clear_ioam_rewrite_command_fn (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
clib_error_t *	ip6_ioam_enable (int has_trace_option, int has_pot_option, int has_seqno_option, int has_analyse_option)
static clib_error_t *	ip6_set_ioam_rewrite_command_fn (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
static clib_error_t *	ip6_show_ioam_summary_cmd_fn (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
void	vnet_register_ioam_end_of_path_callback (void *cb)

Variables
ip6_hop_by_hop_ioam_main_t	ip6_hop_by_hop_ioam_main
vlib_node_registration_t	ip6_add_hop_by_hop_node
	(constructor) VLIB_REGISTER_NODE (ip6_add_hop_by_hop_node) More...
static char *	ip6_add_hop_by_hop_error_strings []
vlib_node_registration_t	ip6_pop_hop_by_hop_node
	(constructor) VLIB_REGISTER_NODE (ip6_pop_hop_by_hop_node) More...
static char *	ip6_pop_hop_by_hop_error_strings []
vlib_node_registration_t	ip6_local_hop_by_hop_node
	(constructor) VLIB_REGISTER_NODE (ip6_local_hop_by_hop_node) More...
static char *	ip6_local_hop_by_hop_error_strings []
static vlib_cli_command_t	show_ip6_hbh
	(constructor) VLIB_CLI_COMMAND (show_ip6_hbh) More...
static vlib_cli_command_t	ip6_clear_ioam_rewrite_cmd
	(constructor) VLIB_CLI_COMMAND (ip6_clear_ioam_rewrite_cmd) More...
static vlib_cli_command_t	ip6_set_ioam_rewrite_cmd
	(constructor) VLIB_CLI_COMMAND (ip6_set_ioam_rewrite_cmd) More...
static vlib_cli_command_t	ip6_show_ioam_run_cmd
	(constructor) VLIB_CLI_COMMAND (ip6_show_ioam_run_cmd) More...

Detailed Description

In-band OAM (iOAM).

In-band OAM (iOAM) is an implementation study to record operational information in the packet while the packet traverses a path between two points in the network.

VPP can function as in-band OAM encapsulating, transit and decapsulating node. In this version of VPP in-band OAM data is transported as options in an IPv6 hop-by-hop extension header. Hence in-band OAM can be enabled for IPv6 traffic.

Definition in file ip6_hop_by_hop.c.

Macro Definition Documentation

foreach_ip6_add_hop_by_hop_error

#define foreach_ip6_add_hop_by_hop_error   _(PROCESSED, "Pkts w/ added ip6 hop-by-hop options")

Definition at line 224 of file ip6_hop_by_hop.c.

foreach_ip6_hbyh_ioam_input_next

#define foreach_ip6_hbyh_ioam_input_next

Value:

_(IP6_REWRITE, "ip6-rewrite")                   \
  _(IP6_LOOKUP, "ip6-lookup")                   \
  _(DROP, "ip6-drop")

Definition at line 48 of file ip6_hop_by_hop.c.

foreach_ip6_local_hop_by_hop_error

#define foreach_ip6_local_hop_by_hop_error

Value:

_(UNKNOWN, "Unknown protocol ip6 local h-b-h packets dropped")  \
_(OK, "Good ip6 local h-b-h packets")

Definition at line 822 of file ip6_hop_by_hop.c.

foreach_ip6_pop_hop_by_hop_error

#define foreach_ip6_pop_hop_by_hop_error

Value:

_(PROCESSED, "Pkts w/ removed ip6 hop-by-hop options")  \
_(NO_HOHO, "Pkts w/ no ip6 hop-by-hop options")         \
_(OPTION_FAILED, "ip6 pop hop-by-hop failed to process")

Definition at line 517 of file ip6_hop_by_hop.c.

Enumeration Type Documentation

ip6_add_hop_by_hop_error_t

enum ip6_add_hop_by_hop_error_t

Enumerator
IP6_ADD_HOP_BY_HOP_N_ERROR

Definition at line 227 of file ip6_hop_by_hop.c.

ip6_hbyh_ioam_input_next_t

enum ip6_hbyh_ioam_input_next_t

Enumerator
IP6_HBYH_IOAM_INPUT_N_NEXT

Definition at line 53 of file ip6_hop_by_hop.c.

ip6_local_hop_by_hop_error_t

enum ip6_local_hop_by_hop_error_t

Enumerator
IP6_LOCAL_HOP_BY_HOP_N_ERROR

Definition at line 826 of file ip6_hop_by_hop.c.

ip6_local_hop_by_hop_next_t

enum ip6_local_hop_by_hop_next_t

Enumerator
IP6_LOCAL_HOP_BY_HOP_NEXT_DROP
IP6_LOCAL_HOP_BY_HOP_N_NEXT

Definition at line 842 of file ip6_hop_by_hop.c.

ip6_pop_hop_by_hop_error_t

enum ip6_pop_hop_by_hop_error_t

Enumerator
IP6_POP_HOP_BY_HOP_N_ERROR

Definition at line 522 of file ip6_hop_by_hop.c.

Function Documentation

clear_ioam_rewrite_command_fn()

clib_error_t* clear_ioam_rewrite_command_fn	(	vlib_main_t *	vm,
		unformat_input_t *	input,
		vlib_cli_command_t *	cmd
	)

Definition at line 1251 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

clear_ioam_rewrite_fn()

clib_error_t* clear_ioam_rewrite_fn

(

void

)

Definition at line 1224 of file ip6_hop_by_hop.c.

Here is the caller graph for this function:

format_ip6_add_hop_by_hop_trace()

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

static

Definition at line 211 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

format_ip6_local_hop_by_hop_trace()

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

static

Definition at line 806 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

Here is the caller graph for this function:

format_ip6_pop_hop_by_hop_trace()

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

static

Definition at line 468 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

get_flow_name_from_flow_ctx()

u8* get_flow_name_from_flow_ctx

(

u32

flow_ctx

)

Definition at line 85 of file ip6_hop_by_hop.c.

Here is the caller graph for this function:

ioam_pop_hop_by_hop_processing()

static void ioam_pop_hop_by_hop_processing ( vlib_main_t *  vm, ip6_header_t *  ip0, ip6_hop_by_hop_header_t *  hbh0, vlib_buffer_t *  b  )

inlinestatic

Definition at line 537 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

Here is the caller graph for this function:

ip6_add_hop_by_hop_node()

VLIB_NODE_FN() ip6_add_hop_by_hop_node	(	vlib_main_t *	vm,
		vlib_node_runtime_t *	node,
		vlib_frame_t *	frame
	)

Definition at line 241 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

ip6_hbh_add_register_option()

int ip6_hbh_add_register_option	(	u8	option,
		u8	size,
		int	rewrite_optionsu8 *rewrite_string, u8 *rewrite_size
	)

Definition at line 102 of file ip6_hop_by_hop.c.

Here is the caller graph for this function:

ip6_hbh_add_unregister_option()

int ip6_hbh_add_unregister_option

(

u8

option

)

Definition at line 122 of file ip6_hop_by_hop.c.

Here is the caller graph for this function:

ip6_hbh_config_handler_register()

int ip6_hbh_config_handler_register	(	u8	option,
		int	config_handlervoid *data, u8 disable
	)

Definition at line 139 of file ip6_hop_by_hop.c.

Here is the caller graph for this function:

ip6_hbh_config_handler_unregister()

int ip6_hbh_config_handler_unregister

(

u8

option

)

Definition at line 156 of file ip6_hop_by_hop.c.

Here is the caller graph for this function:

ip6_hbh_flow_handler_register()

int ip6_hbh_flow_handler_register	(	u8	option,
		u32	ioam_flow_handleru32 flow_ctx, u8 add
	)

Definition at line 172 of file ip6_hop_by_hop.c.

Here is the caller graph for this function:

ip6_hbh_flow_handler_unregister()

int ip6_hbh_flow_handler_unregister

(

u8

option

)

Definition at line 189 of file ip6_hop_by_hop.c.

Here is the caller graph for this function:

ip6_hbh_pop_register_option()

int ip6_hbh_pop_register_option	(	u8	option,
		int	optionsvlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt
	)

Definition at line 481 of file ip6_hop_by_hop.c.

Here is the caller graph for this function:

ip6_hbh_pop_unregister_option()

int ip6_hbh_pop_unregister_option

(

u8

option

)

Definition at line 500 of file ip6_hop_by_hop.c.

Here is the caller graph for this function:

ip6_hop_by_hop_ioam_init()

static clib_error_t* ip6_hop_by_hop_ioam_init ( vlib_main_t *  vm )

static

Definition at line 1076 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

ip6_ioam_enable()

clib_error_t* ip6_ioam_enable	(	int	has_trace_option,
		int	has_pot_option,
		int	has_seqno_option,
		int	has_analyse_option
	)

Definition at line 1276 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

Here is the caller graph for this function:

ip6_ioam_set_rewrite()

int ip6_ioam_set_rewrite	(	u8 **	rwp,
		int	has_trace_option,
		int	has_pot_option,
		int	has_seqno_option
	)

Definition at line 1138 of file ip6_hop_by_hop.c.

Here is the caller graph for this function:

ip6_local_hop_by_hop_inline()

static uword ip6_local_hop_by_hop_inline ( vlib_main_t *  vm, vlib_node_runtime_t *  node, vlib_frame_t *  frame, int  is_trace  )

inlinestatic

Definition at line 849 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

Here is the caller graph for this function:

ip6_local_hop_by_hop_node()

VLIB_NODE_FN() ip6_local_hop_by_hop_node	(	vlib_main_t *	vm,
		vlib_node_runtime_t *	node,
		vlib_frame_t *	frame
	)

Definition at line 998 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

ip6_local_hop_by_hop_register_protocol()

void ip6_local_hop_by_hop_register_protocol	(	u32	protocol,
		u32	node_index
	)

Definition at line 1116 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

Here is the caller graph for this function:

ip6_pop_hop_by_hop_node()

VLIB_NODE_FN() ip6_pop_hop_by_hop_node	(	vlib_main_t *	vm,
		vlib_node_runtime_t *	node,
		vlib_frame_t *	frame
	)

Definition at line 582 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

ip6_set_ioam_rewrite_command_fn()

static clib_error_t* ip6_set_ioam_rewrite_command_fn ( vlib_main_t *  vm, unformat_input_t *  input, vlib_cli_command_t *  cmd  )

static

Definition at line 1325 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

ip6_show_ioam_summary_cmd_fn()

static clib_error_t* ip6_show_ioam_summary_cmd_fn ( vlib_main_t *  vm, unformat_input_t *  input, vlib_cli_command_t *  cmd  )

static

Definition at line 1383 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

show_ip6_hbh_command_fn()

clib_error_t* show_ip6_hbh_command_fn	(	vlib_main_t *	vm,
		unformat_input_t *	input,
		vlib_cli_command_t *	cmd
	)

Definition at line 1031 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

unformat_opaque_ioam()

static uword unformat_opaque_ioam ( unformat_input_t *  input, va_list *  args  )

static

Definition at line 63 of file ip6_hop_by_hop.c.

Here is the call graph for this function:

Here is the caller graph for this function:

vnet_register_ioam_end_of_path_callback()

void vnet_register_ioam_end_of_path_callback

(

void *

cb

)

Definition at line 1467 of file ip6_hop_by_hop.c.

Variable Documentation

ip6_add_hop_by_hop_error_strings

char* ip6_add_hop_by_hop_error_strings[]

static

Initial value:

= {
#define _(sym,string) 
  foreach_ip6_add_hop_by_hop_error

}

Definition at line 235 of file ip6_hop_by_hop.c.

ip6_add_hop_by_hop_node

vlib_node_registration_t ip6_add_hop_by_hop_node

Initial value:

=       
{
  .name = "ip6-add-hop-by-hop",
  .vector_size = sizeof (u32),
  .format_trace = format_ip6_add_hop_by_hop_trace,
  .type = VLIB_NODE_TYPE_INTERNAL,
  .n_errors = ARRAY_LEN (ip6_add_hop_by_hop_error_strings),
  .error_strings = ip6_add_hop_by_hop_error_strings,
  
  .n_next_nodes = IP6_HBYH_IOAM_INPUT_N_NEXT,
  .next_nodes = {
#define _(s,n) 
    foreach_ip6_hbyh_ioam_input_next

  },
}

(constructor) VLIB_REGISTER_NODE (ip6_add_hop_by_hop_node)

Definition at line 442 of file ip6_hop_by_hop.c.

ip6_clear_ioam_rewrite_cmd

vlib_cli_command_t ip6_clear_ioam_rewrite_cmd

static

Initial value:

= {
  .path = "clear ioam rewrite",
  .short_help = "clear ioam rewrite",
  .function = clear_ioam_rewrite_command_fn,
}

(constructor) VLIB_CLI_COMMAND (ip6_clear_ioam_rewrite_cmd)

Definition at line 1268 of file ip6_hop_by_hop.c.

ip6_hop_by_hop_ioam_main

ip6_hop_by_hop_ioam_main_t ip6_hop_by_hop_ioam_main

Definition at line 45 of file ip6_hop_by_hop.c.

ip6_local_hop_by_hop_error_strings

char* ip6_local_hop_by_hop_error_strings[]

static

Initial value:

= {
#define _(sym,string) 
  foreach_ip6_local_hop_by_hop_error

}

Definition at line 835 of file ip6_hop_by_hop.c.

ip6_local_hop_by_hop_node

vlib_node_registration_t ip6_local_hop_by_hop_node

Initial value:

=
{
  .name = "ip6-local-hop-by-hop",
  .vector_size = sizeof (u32),
  .format_trace = format_ip6_local_hop_by_hop_trace,
  .type = VLIB_NODE_TYPE_INTERNAL,

  .n_errors = ARRAY_LEN(ip6_local_hop_by_hop_error_strings),
  .error_strings = ip6_local_hop_by_hop_error_strings,

  .n_next_nodes = IP6_LOCAL_HOP_BY_HOP_N_NEXT,

  
  .next_nodes =
  {
    [IP6_LOCAL_HOP_BY_HOP_NEXT_DROP] = "error-drop",
  },
}

(constructor) VLIB_REGISTER_NODE (ip6_local_hop_by_hop_node)

Definition at line 818 of file ip6_hop_by_hop.c.

ip6_pop_hop_by_hop_error_strings

char* ip6_pop_hop_by_hop_error_strings[]

static

Initial value:

= {
#define _(sym,string) 
  foreach_ip6_pop_hop_by_hop_error

}

Definition at line 530 of file ip6_hop_by_hop.c.

ip6_pop_hop_by_hop_node

vlib_node_registration_t ip6_pop_hop_by_hop_node

Initial value:

=
{
  .name = "ip6-pop-hop-by-hop",
  .vector_size = sizeof (u32),
  .format_trace = format_ip6_pop_hop_by_hop_trace,
  .type = VLIB_NODE_TYPE_INTERNAL,
  .sibling_of = "ip6-lookup",
  .n_errors = ARRAY_LEN (ip6_pop_hop_by_hop_error_strings),
  .error_strings = ip6_pop_hop_by_hop_error_strings,
  
  .n_next_nodes = 0,
}

(constructor) VLIB_REGISTER_NODE (ip6_pop_hop_by_hop_node)

Definition at line 782 of file ip6_hop_by_hop.c.

ip6_set_ioam_rewrite_cmd

vlib_cli_command_t ip6_set_ioam_rewrite_cmd

static

Initial value:

= {
  .path = "set ioam rewrite",
  .short_help = "set ioam [trace] [pot] [seqno] [analyse]",
  .function = ip6_set_ioam_rewrite_command_fn,
}

(constructor) VLIB_CLI_COMMAND (ip6_set_ioam_rewrite_cmd)

Definition at line 1375 of file ip6_hop_by_hop.c.

ip6_show_ioam_run_cmd

vlib_cli_command_t ip6_show_ioam_run_cmd

static

Initial value:

= {
  .path = "show ioam summary",
  .short_help = "show ioam summary",
  .function = ip6_show_ioam_summary_cmd_fn,
}

(constructor) VLIB_CLI_COMMAND (ip6_show_ioam_run_cmd)

Definition at line 1459 of file ip6_hop_by_hop.c.

show_ip6_hbh

vlib_cli_command_t show_ip6_hbh

static

Initial value:

= {
  .path = "show ip6 hbh",
  .short_help = "show ip6 hbh",
  .function = show_ip6_hbh_command_fn,
}

(constructor) VLIB_CLI_COMMAND (show_ip6_hbh)

Definition at line 1063 of file ip6_hop_by_hop.c.