Object

Modules
	Object API

Data Structures
struct	nl_derived_object

Object Creation/Deletion
struct nl_object *	nl_object_alloc (struct nl_object_ops *ops)
	Allocate a new object of kind specified by the operations handle.
struct nl_object *	nl_object_alloc_name (const char *kind)
	Allocate a new object of kind specified by the name.
struct nl_object *	nl_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)

Detailed Description

Function Documentation

nl_object_alloc()

struct nl_object * nl_object_alloc

(

struct nl_object_ops *

ops

)

Parameters

ops	cache operations handle

Returns

The new object or NULL

Definition at line 42 of file object.c.

{
        struct nl_object *new;
 
        if (ops->oo_size < sizeof(*new))
                BUG();
 
        new = calloc(1, ops->oo_size);
        if (!new) {
                nl_errno(ENOMEM);
                return NULL;
        }
 
        new->ce_refcnt = 1;
        nl_init_list_head(&new->ce_list);
 
        new->ce_ops = ops;
        if (ops->oo_constructor)
                ops->oo_constructor(new);
 
        NL_DBG(4, "Allocated new object %p\n", new);
 
        return new;
}

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

Referenced by nl_object_alloc_name(), and nl_object_clone().

nl_object_alloc_name()

struct nl_object * nl_object_alloc_name

(

const char *

kind

)

Parameters

kind	name of object type

Returns

The new object or nULL

Definition at line 72 of file object.c.

{
        struct nl_cache_ops *ops;
 
        ops = nl_cache_ops_lookup(kind);
        if (!ops) {
                nl_error(ENOENT, "Unable to lookup cache kind \"%s\"", kind);
                return NULL;
        }
 
        return nl_object_alloc(ops->co_obj_ops);
}

References nl_cache_ops_lookup(), and nl_object_alloc().

nl_object_clone()

struct nl_object * nl_object_clone

(

struct nl_object *

obj

)

Parameters

obj	object to inherite data from

Returns

The new object or NULL.

Definition at line 95 of file object.c.

{
        struct nl_object *new;
        struct nl_object_ops *ops = obj_ops(obj);
        int doff = offsetof(struct nl_derived_object, data);
        int size;
 
        new = nl_object_alloc(ops);
        if (!new)
                return NULL;
 
        size = ops->oo_size - doff;
        if (size < 0)
                BUG();
 
        new->ce_ops = obj->ce_ops;
        new->ce_msgtype = obj->ce_msgtype;
 
        if (size)
                memcpy((void *)new + doff, (void *)obj + doff, size);
 
        if (ops->oo_clone) {
                if (ops->oo_clone(new, obj) < 0) {
                        nl_object_free(new);
                        return NULL;
                }
        } else if (size && ops->oo_free_data)
                BUG();
 
        return new;
}

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().

nl_object_free()

void nl_object_free

(

struct nl_object *

obj

)

Parameters

obj	object to free

Returns

0 or a negative error code.

Definition at line 133 of file object.c.

{
        struct nl_object_ops *ops;
 
        if (!obj)
                return;
 
        ops = obj_ops(obj);
 
        if (obj->ce_refcnt > 0)
                NL_DBG(1, "Warning: Freeing object in use...\n");
 
        if (obj->ce_cache)
                nl_cache_remove(obj);
 
        if (ops->oo_free_data)
                ops->oo_free_data(obj);
 
        free(obj);
 
        NL_DBG(4, "Freed object %p\n", obj);
}

References nl_cache_remove(), and nl_object_ops::oo_free_data.

Referenced by nl_object_clone(), and nl_object_put().

nl_object_get()

void nl_object_get

(

struct nl_object *

obj

)

Parameters

obj	object to acquire reference from

Definition at line 167 of file object.c.

{
        obj->ce_refcnt++;
        NL_DBG(4, "New reference to object %p, total %d\n",
               obj, obj->ce_refcnt);
}

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

nl_object_put()

void nl_object_put

(

struct nl_object *

obj

)

Parameters

obj	object to release reference from

Definition at line 178 of file object.c.

{
        if (!obj)
                return;
 
        obj->ce_refcnt--;
        NL_DBG(4, "Returned object reference %p, %d remaining\n",
               obj, obj->ce_refcnt);
 
        if (obj->ce_refcnt < 0)
                BUG();
 
        if (obj->ce_refcnt <= 0)
                nl_object_free(obj);
}

References nl_object_free().

Referenced by nl_cache_remove().

nl_object_shared()

int nl_object_shared

(

struct nl_object *

obj

)

Parameters

obj	object to check

Returns

true or false

Definition at line 199 of file object.c.

{
        return obj->ce_refcnt > 1;
}

nl_object_mark()

void nl_object_mark

(

struct nl_object *

obj

)

Parameters

obj	Object to mark

Definition at line 215 of file object.c.

{
        obj->ce_flags |= NL_OBJ_MARK;
}

Referenced by nl_cache_mark_all().

nl_object_unmark()

void nl_object_unmark

(

struct nl_object *

obj

)

Parameters

obj	Object to unmark

Definition at line 224 of file object.c.

{
        obj->ce_flags &= ~NL_OBJ_MARK;
}

nl_object_is_marked()

int nl_object_is_marked

(

struct nl_object *

obj

)

Parameters

obj	Object to check

Returns

true if object is marked, otherwise false

Definition at line 234 of file object.c.

{
        return (obj->ce_flags & NL_OBJ_MARK);
}

nl_object_dump()

void nl_object_dump	(	struct nl_object *	obj,
		struct nl_dump_params *	params
	)

Parameters

obj	object to dump
params	dumping parameters

Definition at line 251 of file object.c.

{
        dump_from_ops(obj, params);
}

nl_object_identical()

int nl_object_identical	(	struct nl_object *	a,
		struct nl_object *	b
	)

Parameters

a	an object
b	another object of same type

Returns

true if both objects have equal identifiers, otherwise false.

Definition at line 263 of file object.c.

{
        struct nl_object_ops *ops = obj_ops(a);
        int req_attrs;
 
        /* Both objects must be of same type */
        if (ops != obj_ops(b))
                return 0;
 
        req_attrs = ops->oo_id_attrs;
 
        /* Both objects must provide all required attributes to uniquely
         * identify an object */
        if ((a->ce_mask & req_attrs) != req_attrs ||
            (b->ce_mask & req_attrs) != req_attrs)
                return 0;
 
        /* Can't judge unless we can compare */
        if (ops->oo_compare == NULL)
                return 0;
 
        return !(ops->oo_compare(a, b, req_attrs, 0));
}

References nl_object_ops::oo_compare.

Referenced by nl_cache_search().

nl_object_diff()

uint32_t nl_object_diff	(	struct nl_object *	a,
		struct nl_object *	b
	)

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 299 of file object.c.

{
        struct nl_object_ops *ops = obj_ops(a);
 
        if (ops != obj_ops(b) || ops->oo_compare == NULL)
                return UINT_MAX;
 
        return ops->oo_compare(a, b, ~0, 0);
}

References nl_object_ops::oo_compare.

nl_object_match_filter()

int nl_object_match_filter	(	struct nl_object *	obj,
		struct nl_object *	filter
	)

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 318 of file object.c.

{
        struct nl_object_ops *ops = obj_ops(obj);
 
        if (ops != obj_ops(filter) || ops->oo_compare == NULL)
                return 0;
        
        return !(ops->oo_compare(obj, filter, filter->ce_mask,
                                 LOOSE_FLAG_COMPARISON));
}

References nl_object_ops::oo_compare.

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

nl_object_attrs2str()

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

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 341 of file object.c.

{
        struct nl_object_ops *ops = obj_ops(obj);
 
        if (ops->oo_attrs2str != NULL)
                return ops->oo_attrs2str(attrs, buf, len);
        else {
                memset(buf, 0, len);
                return buf;
        }
}

Referenced by nl_object_attr_list().

nl_object_attr_list()

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

Parameters

obj	an object
buf	destination buffer
len	length of destination buffer

Returns

destination buffer.

Definition at line 362 of file object.c.

{
        return nl_object_attrs2str(obj, obj->ce_mask, buf, len);
}

References nl_object_attrs2str().

nl_object_get_refcnt()

int nl_object_get_refcnt

(

struct nl_object *

obj

)

Definition at line 374 of file object.c.

{
        return obj->ce_refcnt;
}

nl_object_get_cache()

struct nl_cache * nl_object_get_cache

(

struct nl_object *

obj

)

Definition at line 379 of file object.c.

{
        return obj->ce_cache;
}