Data Structures | Modules

Object
[Cache]

Data Structures

struct  nl_derived_object

Modules

 Object API

Object Creation/Deletion



struct nl_objectnl_object_alloc (struct nl_object_ops *ops)
 Allocate a new object of kind specified by the operations handle.
int nl_object_alloc_name (const char *kind, struct nl_object **result)
 Allocate a new object of kind specified by the name.
struct nl_objectnl_object_clone (struct nl_object *obj)
 Allocate a new object and copy all data from an existing object.
void nl_object_free (struct nl_object *obj)
 Free a cacheable object.

Reference Management



void nl_object_get (struct nl_object *obj)
 Acquire a reference on a object.
void nl_object_put (struct nl_object *obj)
 Release a reference from an object.
int nl_object_shared (struct nl_object *obj)
 Check whether this object is used by multiple users.

Marks



void nl_object_mark (struct nl_object *obj)
 Add mark to object.
void nl_object_unmark (struct nl_object *obj)
 Remove mark from object.
int nl_object_is_marked (struct nl_object *obj)
 Return true if object is marked.

Utillities



void nl_object_dump (struct nl_object *obj, struct nl_dump_params *params)
 Dump this object according to the specified parameters.
int nl_object_identical (struct nl_object *a, struct nl_object *b)
 Check if the identifiers of two objects are identical.
uint32_t nl_object_diff (struct nl_object *a, struct nl_object *b)
 Compute bitmask representing difference in attribute values.
int nl_object_match_filter (struct nl_object *obj, struct nl_object *filter)
 Match a filter against an object.
char * nl_object_attrs2str (struct nl_object *obj, uint32_t attrs, char *buf, size_t len)
 Convert bitmask of attributes to a character string.
char * nl_object_attr_list (struct nl_object *obj, char *buf, size_t len)
 Return list of attributes present in an object.

Attributes



int nl_object_get_refcnt (struct nl_object *obj)
struct nl_cache * nl_object_get_cache (struct nl_object *obj)

Function Documentation

struct nl_object* nl_object_alloc ( struct nl_object_ops ops  )  [read]

Allocate a new object of kind specified by the operations handle.

Parameters:
ops cache operations handle
Returns:
The new object or NULL

Definition at line 42 of file object.c.

References nl_object_ops::oo_constructor, and nl_object_ops::oo_size.

Referenced by nl_object_alloc_name(), and nl_object_clone().

Here is the caller graph for this function:

int nl_object_alloc_name ( const char *  kind,
struct nl_object **  result 
)

Allocate a new object of kind specified by the name.

Parameters:
kind name of object type
Returns:
The new object or nULL

Definition at line 70 of file object.c.

References nl_cache_ops_lookup(), and nl_object_alloc().

Here is the call graph for this function:

struct nl_object* nl_object_clone ( struct nl_object obj  )  [read]

Allocate a new object and copy all data from an existing object.

Parameters:
obj object to inherite data from
Returns:
The new object or NULL.

Definition at line 94 of file object.c.

References nl_object_alloc(), nl_object_free(), nl_object_ops::oo_clone, nl_object_ops::oo_free_data, and nl_object_ops::oo_size.

Referenced by nl_cache_add().

Here is the call graph for this function:

Here is the caller graph for this function:

void nl_object_free ( struct nl_object obj  ) 

Free a cacheable object.

Parameters:
obj object to free
Returns:
0 or a negative error code.

Definition at line 133 of file object.c.

References nl_cache_remove(), and nl_object_ops::oo_free_data.

Referenced by nl_object_clone(), and nl_object_put().

Here is the call graph for this function:

Here is the caller graph for this function:

void nl_object_get ( struct nl_object obj  ) 

Acquire a reference on a object.

Parameters:
obj object to acquire reference from

Definition at line 162 of file object.c.

Referenced by genl_ctrl_search(), genl_ctrl_search_by_name(), nl_cache_add(), nl_cache_foreach_filter(), nl_cache_move(), nl_cache_search(), rtnl_class_get(), rtnl_link_get(), rtnl_link_get_by_name(), rtnl_neigh_get(), rtnl_neightbl_get(), rtnl_qdisc_get(), rtnl_qdisc_get_by_parent(), and rtnl_tc_set_link().

Here is the caller graph for this function:

void nl_object_put ( struct nl_object obj  ) 

Release a reference from an object.

Parameters:
obj object to release reference from

Definition at line 173 of file object.c.

References nl_object_free().

Referenced by nl_cache_foreach_filter(), and nl_cache_remove().

Here is the call graph for this function:

Here is the caller graph for this function:

int nl_object_shared ( struct nl_object obj  ) 

Check whether this object is used by multiple users.

Parameters:
obj object to check
Returns:
true or false

Definition at line 194 of file object.c.

void nl_object_mark ( struct nl_object obj  ) 

Add mark to object.

Parameters:
obj Object to mark

Definition at line 210 of file object.c.

Referenced by nl_cache_mark_all().

Here is the caller graph for this function:

void nl_object_unmark ( struct nl_object obj  ) 

Remove mark from object.

Parameters:
obj Object to unmark

Definition at line 219 of file object.c.

int nl_object_is_marked ( struct nl_object obj  ) 

Return true if object is marked.

Parameters:
obj Object to check
Returns:
true if object is marked, otherwise false

Definition at line 229 of file object.c.

void nl_object_dump ( struct nl_object obj,
struct nl_dump_params params 
)

Dump this object according to the specified parameters.

Parameters:
obj object to dump
params dumping parameters

Definition at line 246 of file object.c.

int nl_object_identical ( struct nl_object a,
struct nl_object b 
)

Check if the identifiers of two objects are identical.

Parameters:
a an object
b another object of same type
Returns:
true if both objects have equal identifiers, otherwise false.

Definition at line 258 of file object.c.

References nl_object_ops::oo_compare.

Referenced by nl_cache_search().

Here is the caller graph for this function:

uint32_t nl_object_diff ( struct nl_object a,
struct nl_object b 
)

Compute bitmask representing difference in attribute values.

Parameters:
a an object
b another object of same type

The bitmask returned is specific to an object type, each bit set represents an attribute which mismatches in either of the two objects. Unavailability of an attribute in one object and presence in the other is regarded a mismatch as well.

Returns:
Bitmask describing differences or 0 if they are completely identical.

Definition at line 296 of file object.c.

References nl_object_ops::oo_compare.

int nl_object_match_filter ( struct nl_object obj,
struct nl_object filter 
)

Match a filter against an object.

Parameters:
obj object to check
filter object of same type acting as filter
Returns:
1 if the object matches the filter or 0 if no filter procedure is available or if the filter does not match.

Definition at line 315 of file object.c.

References nl_object_ops::oo_compare.

Referenced by nl_cache_dump_filter(), nl_cache_foreach_filter(), nl_cache_nitems_filter(), and nl_cache_subset().

Here is the caller graph for this function:

char* nl_object_attrs2str ( struct nl_object obj,
uint32_t  attrs,
char *  buf,
size_t  len 
)

Convert bitmask of attributes to a character string.

Parameters:
obj object of same type as attribute bitmask
attrs bitmask of attribute types
buf destination buffer
len length of destination buffer

Converts the bitmask of attribute types into a list of attribute names separated by comas.

Returns:
destination buffer.

Definition at line 338 of file object.c.

Referenced by nl_object_attr_list().

Here is the caller graph for this function:

char* nl_object_attr_list ( struct nl_object obj,
char *  buf,
size_t  len 
)

Return list of attributes present in an object.

Parameters:
obj an object
buf destination buffer
len length of destination buffer
Returns:
destination buffer.

Definition at line 359 of file object.c.

References nl_object_attrs2str().

Here is the call graph for this function: