containers.h File Reference

This file contains the definitions, prototypes, constants, and other information necessary for the identification and processing of AMM Resource Identifiers (ARIs). More...

#include "base.h"
#include "algo.h"
#include <m-array.h>
#include <m-bptree.h>
#include <m-deque.h>
#include <m-dict.h>

Include dependency graph for containers.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	cace_ari_ac_t
struct	cace_ari_am_t
struct	cace_ari_tbl_t
struct	cace_ari_execset_t
struct	cace_ari_report_t
	A report is always a member of a Reporting Set (see ::cace_ari_rptset_s). More...
struct	cace_ari_rptset_t

Macros
#define	M_OPL_cace_ari_report_t()

Functions
void	cace_ari_ac_init (cace_ari_ac_t *obj)
void	cace_ari_ac_deinit (cace_ari_ac_t *obj)
int	cace_ari_ac_cmp (const cace_ari_ac_t *left, const cace_ari_ac_t *right)
bool	cace_ari_ac_equal (const cace_ari_ac_t *left, const cace_ari_ac_t *right)
void	cace_ari_am_init (cace_ari_am_t *obj)
void	cace_ari_am_deinit (cace_ari_am_t *obj)
int	cace_ari_am_cmp (const cace_ari_am_t *left, const cace_ari_am_t *right)
bool	cace_ari_am_equal (const cace_ari_am_t *left, const cace_ari_am_t *right)
void	cace_ari_tbl_init (cace_ari_tbl_t *obj)
void	cace_ari_tbl_deinit (cace_ari_tbl_t *obj)
bool	cace_ari_tbl_cmp (const cace_ari_tbl_t *left, const cace_ari_tbl_t *right)
bool	cace_ari_tbl_equal (const cace_ari_tbl_t *left, const cace_ari_tbl_t *right)
void	cace_ari_tbl_reset (cace_ari_tbl_t *obj, size_t ncols, size_t nrows)
	Reset a table to a specific size.
size_t	cace_ari_tbl_num_rows (const cace_ari_tbl_t *obj)
	Compute the number of rows in this table.
int	cace_ari_tbl_move_row_ac (cace_ari_tbl_t *obj, cace_ari_ac_t *row)
	Append a row to a table, moving data from the source.
int	cace_ari_tbl_move_row_array (cace_ari_tbl_t *obj, cace_ari_array_t row)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void	cace_ari_execset_init (cace_ari_execset_t *obj)
void	cace_ari_execset_deinit (cace_ari_execset_t *obj)
int	cace_ari_execset_cmp (const cace_ari_execset_t *left, const cace_ari_execset_t *right)
bool	cace_ari_execset_equal (const cace_ari_execset_t *left, const cace_ari_execset_t *right)
void	cace_ari_report_init (cace_ari_report_t *obj)
void	cace_ari_report_init_copy (cace_ari_report_t *obj, const cace_ari_report_t *src)
void	cace_ari_report_init_move (cace_ari_report_t *obj, cace_ari_report_t *src)
void	cace_ari_report_deinit (cace_ari_report_t *obj)
void	cace_ari_report_set_copy (cace_ari_report_t *obj, const cace_ari_report_t *src)
void	cace_ari_report_set_move (cace_ari_report_t *obj, cace_ari_report_t *src)
size_t	cace_ari_report_hash (const cace_ari_report_t *obj)
int	cace_ari_report_cmp (const cace_ari_report_t *left, const cace_ari_report_t *right)
bool	cace_ari_report_equal (const cace_ari_report_t *left, const cace_ari_report_t *right)
void	cace_ari_rptset_init (cace_ari_rptset_t *obj)
void	cace_ari_rptset_deinit (cace_ari_rptset_t *obj)
int	cace_ari_rptset_cmp (const cace_ari_rptset_t *left, const cace_ari_rptset_t *right)
bool	cace_ari_rptset_equal (const cace_ari_rptset_t *left, const cace_ari_rptset_t *right)
int	cace_ari_rptset_join_move (cace_ari_rptset_t *out, cace_ari_list_t *src)
	Combine multiple RPTSET into a single value.
int	cace_ari_rptset_split_move (cace_ari_list_t *out, cace_ari_rptset_t *src)
	Split a single RPTSET into a list where each result contains exactly one report.
void	cace_ari_lit_init_container (cace_ari_lit_t *lit, cace_ari_type_t ctype)
	Helper to assign a new container to a literal ARI.

Detailed Description

This file contains the definitions, prototypes, constants, and other information necessary for the identification and processing of AMM Resource Identifiers (ARIs).

Every object in the AMM can be uniquely identified using an ARI.

Macro Definition Documentation

M_OPL_cace_ari_report_t

#define M_OPL_cace_ari_report_t

(

)

Value:

    (INIT(API_2(cace_ari_report_init)), INIT_SET(API_6(cace_ari_report_init_copy)),                                  \
     INIT_MOVE(API_6(cace_ari_report_init_move)), CLEAR(API_2(cace_ari_report_deinit)),                              \
     SET(API_6(cace_ari_report_set_copy)), MOVE(API_6(cace_ari_report_set_move)), HASH(API_2(cace_ari_report_hash)), \
     CMP(API_6(cace_ari_report_cmp)), EQUAL(API_6(cace_ari_report_equal)))

Function Documentation

cace_ari_ac_cmp()

int cace_ari_ac_cmp	(	const cace_ari_ac_t *	left,
		const cace_ari_ac_t *	right
	)

References cace_ari_list_cmp(), CHKRET, and cace_ari_ac_t::items.

Referenced by cace_ari_cmp(), and cace_ari_params_cmp().

cace_ari_ac_deinit()

void cace_ari_ac_deinit

(

cace_ari_ac_t *

obj

)

References CHKVOID, and cace_ari_ac_t::items.

Referenced by cace_ari_lit_deinit(), and cace_ari_params_deinit().

cace_ari_ac_equal()

bool cace_ari_ac_equal	(	const cace_ari_ac_t *	left,
		const cace_ari_ac_t *	right
	)

References CHKFALSE, and cace_ari_ac_t::items.

Referenced by cace_ari_equal(), and cace_ari_params_equal().

cace_ari_ac_init()

void cace_ari_ac_init

(

cace_ari_ac_t *

obj

)

References CHKVOID, and cace_ari_ac_t::items.

Referenced by cace_amm_semtype_dlist_name(), cace_ari_lit_copy(), cace_ari_lit_init_container(), cace_ari_params_copy(), cace_ari_set_ac(), refda_adm_ietf_amm_semtype_init(), test_cace_ari_cbor_encode_lit_typed_ac_1item(), and test_refda_adm_ietf_dtnma_agent_ctrl_ensure_var().

cace_ari_am_cmp()

int cace_ari_am_cmp	(	const cace_ari_am_t *	left,
		const cace_ari_am_t *	right
	)

References cace_ari_cmp(), CHKRET, and cace_ari_am_t::items.

Referenced by cace_ari_cmp(), and cace_ari_params_cmp().

cace_ari_am_deinit()

void cace_ari_am_deinit

(

cace_ari_am_t *

obj

)

References CHKVOID, and cace_ari_am_t::items.

Referenced by cace_ari_lit_deinit(), and cace_ari_params_deinit().

cace_ari_am_equal()

bool cace_ari_am_equal	(	const cace_ari_am_t *	left,
		const cace_ari_am_t *	right
	)

References CHKFALSE, and cace_ari_am_t::items.

Referenced by cace_ari_equal(), and cace_ari_params_equal().

cace_ari_am_init()

void cace_ari_am_init

(

cace_ari_am_t *

obj

)

References CHKVOID, and cace_ari_am_t::items.

Referenced by cace_amm_semtype_umap_convert(), cace_ari_lit_copy(), cace_ari_lit_init_container(), cace_ari_params_copy(), and cace_ari_set_am().

cace_ari_execset_cmp()

int cace_ari_execset_cmp	(	const cace_ari_execset_t *	left,
		const cace_ari_execset_t *	right
	)

References cace_ari_cmp(), cace_ari_list_cmp(), cace_ari_execset_t::nonce, and cace_ari_execset_t::targets.

Referenced by cace_ari_cmp().

cace_ari_execset_deinit()

void cace_ari_execset_deinit

(

cace_ari_execset_t *

obj

)

References cace_ari_deinit(), cace_ari_execset_t::nonce, and cace_ari_execset_t::targets.

Referenced by cace_ari_lit_deinit().

cace_ari_execset_equal()

bool cace_ari_execset_equal	(	const cace_ari_execset_t *	left,
		const cace_ari_execset_t *	right
	)

References cace_ari_equal(), cace_ari_execset_t::nonce, and cace_ari_execset_t::targets.

Referenced by cace_ari_equal().

cace_ari_execset_init()

void cace_ari_execset_init

(

cace_ari_execset_t *

obj

)

References cace_ari_init(), cace_ari_execset_t::nonce, and cace_ari_execset_t::targets.

Referenced by cace_ari_lit_copy(), cace_ari_lit_init_container(), and cace_ari_set_execset().

cace_ari_lit_init_container()

void cace_ari_lit_init_container	(	cace_ari_lit_t *	lit,
		cace_ari_type_t	ctype
	)

Helper to assign a new container to a literal ARI.

Parameters

[in,out]	The	literal value to modify.
	ctype	The container type to create.

References cace_ari_lit_t::ari_type, cace_ari_prim_val_u::as_ac, cace_ari_prim_val_u::as_am, cace_ari_prim_val_u::as_execset, cace_ari_prim_val_u::as_rptset, cace_ari_prim_val_u::as_tbl, cace_ari_ac_init(), cace_ari_am_init(), cace_ari_execset_init(), CACE_ARI_PRIM_OTHER, cace_ari_rptset_init(), cace_ari_tbl_init(), CACE_ARI_TYPE_AC, CACE_ARI_TYPE_AM, CACE_ARI_TYPE_EXECSET, CACE_ARI_TYPE_RPTSET, CACE_ARI_TYPE_TBL, CACE_MALLOC, CHKVOID, cace_ari_lit_t::has_ari_type, cace_ari_lit_t::prim_type, and cace_ari_lit_t::value.

Referenced by cace_ari_cbor_decode_stream(), and cace_ari_translate_ari().

cace_ari_report_cmp()

int cace_ari_report_cmp	(	const cace_ari_report_t *	left,
		const cace_ari_report_t *	right
	)

References cace_ari_cmp(), cace_ari_list_cmp(), cace_ari_report_t::items, cace_ari_report_t::reltime, and cace_ari_report_t::source.

Referenced by cace_ari_report_list_cmp().

cace_ari_report_deinit()

void cace_ari_report_deinit

(

cace_ari_report_t *

obj

)

References cace_ari_deinit(), cace_ari_report_t::items, cace_ari_report_t::reltime, and cace_ari_report_t::source.

Referenced by cace_ari_cbor_decode_rptset().

cace_ari_report_equal()

bool cace_ari_report_equal	(	const cace_ari_report_t *	left,
		const cace_ari_report_t *	right
	)

References cace_ari_equal(), cace_ari_report_t::items, cace_ari_report_t::reltime, and cace_ari_report_t::source.

cace_ari_report_hash()

size_t cace_ari_report_hash

(

const cace_ari_report_t *

obj

)

cace_ari_report_init()

void cace_ari_report_init

(

cace_ari_report_t *

obj

)

References cace_ari_init(), cace_ari_report_t::items, cace_ari_report_t::reltime, and cace_ari_report_t::source.

Referenced by cace_ari_cbor_decode_rptset().

cace_ari_report_init_copy()

void cace_ari_report_init_copy	(	cace_ari_report_t *	obj,
		const cace_ari_report_t *	src
	)

References cace_ari_init_copy(), cace_ari_report_t::items, cace_ari_report_t::reltime, and cace_ari_report_t::source.

cace_ari_report_init_move()

void cace_ari_report_init_move	(	cace_ari_report_t *	obj,
		cace_ari_report_t *	src
	)

References cace_ari_init_move(), cace_ari_report_t::items, cace_ari_report_t::reltime, and cace_ari_report_t::source.

cace_ari_report_set_copy()

void cace_ari_report_set_copy	(	cace_ari_report_t *	obj,
		const cace_ari_report_t *	src
	)

References cace_ari_set_copy(), cace_ari_report_t::items, and cace_ari_report_t::source.

cace_ari_report_set_move()

void cace_ari_report_set_move	(	cace_ari_report_t *	obj,
		cace_ari_report_t *	src
	)

References cace_ari_set_move(), cace_ari_report_t::items, cace_ari_report_t::reltime, and cace_ari_report_t::source.

cace_ari_rptset_cmp()

int cace_ari_rptset_cmp	(	const cace_ari_rptset_t *	left,
		const cace_ari_rptset_t *	right
	)

References cace_ari_cmp(), cace_ari_report_list_cmp(), cace_ari_rptset_t::nonce, cace_ari_rptset_t::reftime, and cace_ari_rptset_t::reports.

Referenced by cace_ari_cmp().

cace_ari_rptset_deinit()

void cace_ari_rptset_deinit

(

cace_ari_rptset_t *

obj

)

References cace_ari_deinit(), cace_ari_rptset_t::nonce, cace_ari_rptset_t::reftime, and cace_ari_rptset_t::reports.

Referenced by cace_ari_lit_deinit().

cace_ari_rptset_equal()

bool cace_ari_rptset_equal	(	const cace_ari_rptset_t *	left,
		const cace_ari_rptset_t *	right
	)

References cace_ari_equal(), cace_ari_rptset_t::nonce, cace_ari_rptset_t::reftime, and cace_ari_rptset_t::reports.

Referenced by cace_ari_equal().

cace_ari_rptset_init()

void cace_ari_rptset_init

(

cace_ari_rptset_t *

obj

)

References cace_ari_init(), cace_ari_rptset_t::nonce, cace_ari_rptset_t::reftime, and cace_ari_rptset_t::reports.

Referenced by cace_ari_lit_copy(), cace_ari_lit_init_container(), and cace_ari_set_rptset().

cace_ari_rptset_join_move()

int cace_ari_rptset_join_move	(	cace_ari_rptset_t *	out,
		cace_ari_list_t *	src
	)

Combine multiple RPTSET into a single value.

Each of the source values must have identical nonce parameters.

Parameters

[in,out]	out	The result to combine into.
[in,out]	src	The source list to move values from.

Returns

Zero if successful.

cace_ari_rptset_split_move()

int cace_ari_rptset_split_move	(	cace_ari_list_t *	out,
		cace_ari_rptset_t *	src
	)

Split a single RPTSET into a list where each result contains exactly one report.

Returns

Zero if successful.

cace_ari_tbl_cmp()

bool cace_ari_tbl_cmp	(	const cace_ari_tbl_t *	left,
		const cace_ari_tbl_t *	right
	)

References cace_ari_cmp(), cace_ari_tbl_t::items, and cace_ari_tbl_t::ncols.

Referenced by cace_ari_cmp().

cace_ari_tbl_deinit()

void cace_ari_tbl_deinit

(

cace_ari_tbl_t *

obj

)

References CHKVOID, and cace_ari_tbl_t::items.

Referenced by cace_ari_lit_deinit(), and refda_adm_ietf_dtnma_agent_oper_tbl_filter().

cace_ari_tbl_equal()

bool cace_ari_tbl_equal	(	const cace_ari_tbl_t *	left,
		const cace_ari_tbl_t *	right
	)

References CHKFALSE, cace_ari_tbl_t::items, and cace_ari_tbl_t::ncols.

Referenced by cace_ari_equal().

cace_ari_tbl_init()

void cace_ari_tbl_init

(

cace_ari_tbl_t *

obj

)

References CHKVOID, and cace_ari_tbl_t::items.

Referenced by cace_amm_semtype_tblt_name(), cace_ari_lit_copy(), cace_ari_lit_init_container(), cace_ari_set_tbl(), and refda_adm_ietf_dtnma_agent_oper_tbl_filter().

cace_ari_tbl_move_row_ac()

int cace_ari_tbl_move_row_ac	(	cace_ari_tbl_t *	obj,
		cace_ari_ac_t *	row
	)

Append a row to a table, moving data from the source.

Parameters

[in,out]	obj	The table to append to.
[in,out]	row	The row to move items from.

Returns

Zero if successful. 2 if the row size is mismatched.

References cace_ari_deinit(), cace_ari_init(), CHKERR1, cace_ari_ac_t::items, cace_ari_tbl_t::items, and cace_ari_tbl_t::ncols.

cace_ari_tbl_move_row_array()

int cace_ari_tbl_move_row_array	(	cace_ari_tbl_t *	obj,
		cace_ari_array_t	row
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References CHKERR1, cace_ari_tbl_t::items, and cace_ari_tbl_t::ncols.

Referenced by alarms_append_derived_ident(), cace_amm_semtype_tblt_name(), refda_adm_ietf_dtnma_agent_acl_edd_access_list(), refda_adm_ietf_dtnma_agent_acl_edd_group_list(), refda_adm_ietf_dtnma_agent_edd_capability(), refda_adm_ietf_dtnma_agent_edd_const_list(), refda_adm_ietf_dtnma_agent_edd_exec_running(), refda_adm_ietf_dtnma_agent_edd_odm_list(), refda_adm_ietf_dtnma_agent_edd_sbr_list(), refda_adm_ietf_dtnma_agent_edd_tbr_list(), refda_adm_ietf_dtnma_agent_edd_typedef_list(), refda_adm_ietf_dtnma_agent_edd_var_list(), refda_adm_ietf_dtnma_agent_oper_tbl_filter(), and refda_alarms_get_table().

cace_ari_tbl_num_rows()

size_t cace_ari_tbl_num_rows

(

const cace_ari_tbl_t *

obj

)

Compute the number of rows in this table.

Parameters

[in]

obj

The table to inspect.

Returns

The row count.

References cace_ari_tbl_t::items, and cace_ari_tbl_t::ncols.

Referenced by refda_adm_ietf_dtnma_agent_oper_tbl_filter().

cace_ari_tbl_reset()

void cace_ari_tbl_reset	(	cace_ari_tbl_t *	obj,
		size_t	ncols,
		size_t	nrows
	)

Reset a table to a specific size.

Parameters

[in,out]	obj	The table to append to.
	ncols	The number of columns.
	nrows	The number of rows, which can start zero and be appended to.

See also

cace_ari_tbl_move_row_ac(), cace_ari_tbl_move_row_array()

References cace_ari_tbl_t::items, and cace_ari_tbl_t::ncols.

Referenced by cace_amm_semtype_tblt_convert(), cace_amm_semtype_tblt_name(), cace_ari_lit_copy(), refda_adm_ietf_alarms_edd_category_inventory(), refda_adm_ietf_alarms_edd_resource_inventory(), refda_adm_ietf_dtnma_agent_acl_edd_access_list(), refda_adm_ietf_dtnma_agent_acl_edd_group_list(), refda_adm_ietf_dtnma_agent_edd_capability(), refda_adm_ietf_dtnma_agent_edd_const_list(), refda_adm_ietf_dtnma_agent_edd_exec_running(), refda_adm_ietf_dtnma_agent_edd_odm_list(), refda_adm_ietf_dtnma_agent_edd_sbr_list(), refda_adm_ietf_dtnma_agent_edd_tbr_list(), refda_adm_ietf_dtnma_agent_edd_typedef_list(), refda_adm_ietf_dtnma_agent_edd_var_list(), refda_adm_ietf_dtnma_agent_oper_tbl_filter(), and refda_alarms_get_table().