Modules
	Cache

	Manager
	Helps keeping caches up to date.

Cache Operations Sets
struct nl_cache_ops *	__nl_cache_ops_lookup (const char *name)

void	nl_cache_ops_get (struct nl_cache_ops *ops)
	Increment reference counter.

void	nl_cache_ops_put (struct nl_cache_ops *ops)
	Decrement reference counter.

struct nl_cache_ops *	nl_cache_ops_lookup (const char *name)
	Lookup cache operations by name.

struct nl_cache_ops *	nl_cache_ops_lookup_safe (const char *name)
	Lookup cache operations by name.

struct nl_cache_ops *	nl_cache_ops_associate (int protocol, int msgtype)
	Associate protocol and message type to cache operations.

struct nl_cache_ops *	nl_cache_ops_associate_safe (int protocol, int msgtype)
	Associate protocol and message type to cache operations.

struct nl_msgtype *	nl_msgtype_lookup (struct nl_cache_ops *ops, int msgtype)
	Lookup message type cache association.

void	nl_cache_ops_foreach (void(cb)(struct nl_cache_ops , void ), void arg)
	Call a function for each registered cache operation.

int	nl_cache_mngt_register (struct nl_cache_ops *ops)
	Register a set of cache operations.

int	nl_cache_mngt_unregister (struct nl_cache_ops *ops)
	Unregister a set of cache operations.

Global Cache Provisioning/Requiring
void	nl_cache_mngt_provide (struct nl_cache *cache)
	Provide a cache for global use.

void	nl_cache_mngt_unprovide (struct nl_cache *cache)
	Unprovide a cache for global use.

struct nl_cache *	nl_cache_mngt_require (const char *name)
	Demand the use of a global cache.

Detailed Description

Function Documentation

◆ __nl_cache_ops_lookup()

struct nl_cache_ops * __nl_cache_ops_lookup ( const char * name )

Definition at line 30 of file cache_mngt.c.

{
        struct nl_cache_ops *ops;
 
        for (ops = cache_ops; ops; ops = ops->co_next)
                if (!strcmp(ops->co_name, name))
                        return ops;
 
        return NULL;
}

◆ nl_cache_ops_get()

void nl_cache_ops_get ( struct nl_cache_ops * ops )

Parameters

ops	Cache operations

Definition at line 45 of file cache_mngt.c.

{
        ops->co_refcnt++;
}

References nl_cache_ops::co_refcnt.

Referenced by nl_cache_ops_associate_safe(), and nl_cache_ops_lookup_safe().

◆ nl_cache_ops_put()

void nl_cache_ops_put ( struct nl_cache_ops * ops )

Parameters

ops	Cache operations

Definition at line 54 of file cache_mngt.c.

{
        ops->co_refcnt--;
}

References nl_cache_ops::co_refcnt.

◆ nl_cache_ops_lookup()

struct nl_cache_ops * nl_cache_ops_lookup ( const char * name )

Parameters

name	name of the cache type

Attention: This function is not safe, it does not increment the reference counter. Please use nl_cache_ops_lookup_safe().

Returns: The cache operations or NULL if not found.

Definition at line 68 of file cache_mngt.c.

{
        struct nl_cache_ops *ops;
 
        nl_read_lock(&cache_ops_lock);
        ops = __nl_cache_ops_lookup(name);
        nl_read_unlock(&cache_ops_lock);
 
        return ops;
}

Referenced by nl_cache_alloc_name(), nl_cache_mngr_add(), nl_cache_mngt_require(), and nl_object_alloc_name().

◆ nl_cache_ops_lookup_safe()

struct nl_cache_ops * nl_cache_ops_lookup_safe ( const char * name )

Parameters

name	name of the cache type

Note: The reference counter of the returned cache operation is incremented and must be decremented after use with nl_cache_ops_put().

Returns: The cache operations or NULL if not found.

Definition at line 88 of file cache_mngt.c.

{
        struct nl_cache_ops *ops;
 
        nl_write_lock(&cache_ops_lock);
        if ((ops = __nl_cache_ops_lookup(name)))
                nl_cache_ops_get(ops);
        nl_write_unlock(&cache_ops_lock);
 
        return ops;
}

References nl_cache_ops_get().

◆ nl_cache_ops_associate()

struct nl_cache_ops * nl_cache_ops_associate	(	int	protocol,
		int	msgtype
	)

Parameters

protocol	netlink protocol
msgtype	netlink message type

Attention: This function is not safe, it does not increment the reference counter. Please use nl_cache_ops_associate_safe().

See also: nl_cache_ops_associate_safe()

Returns: The cache operations or NULL if no match found.

Definition at line 129 of file cache_mngt.c.

{
        struct nl_cache_ops *ops;
 
        nl_read_lock(&cache_ops_lock);
        ops = __cache_ops_associate(protocol, msgtype);
        nl_read_unlock(&cache_ops_lock);
 
        return ops;
}

Referenced by nl_msg_dump().

◆ nl_cache_ops_associate_safe()

struct nl_cache_ops * nl_cache_ops_associate_safe	(	int	protocol,
		int	msgtype
	)

Parameters

protocol	netlink protocol
msgtype	netlink message type

Searches the registered cache operations for a matching protocol and message type.

Note: The reference counter of the returned cache operation is incremented and must be decremented after use with nl_cache_ops_put().

Returns: The cache operations or NULL if no no match was found.

Definition at line 153 of file cache_mngt.c.

{
        struct nl_cache_ops *ops;
 
        nl_write_lock(&cache_ops_lock);
        if ((ops = __cache_ops_associate(protocol, msgtype)))
                nl_cache_ops_get(ops);
        nl_write_unlock(&cache_ops_lock);
 
        return ops;
}

References nl_cache_ops_get().

◆ nl_msgtype_lookup()

struct nl_msgtype * nl_msgtype_lookup	(	struct nl_cache_ops *	ops,
		int	msgtype
	)

Parameters

ops	cache operations
msgtype	netlink message type

Searches for a matching message type association ing the specified cache operations.

Attention: The guranteed lifetime of the returned message type is bound to the lifetime of the underlying cache operations.

Returns: A message type association or NULL.

Definition at line 178 of file cache_mngt.c.

{
        int i;
 
        for (i = 0; ops->co_msgtypes[i].mt_id >= 0; i++)
                if (ops->co_msgtypes[i].mt_id == msgtype)
                        return &ops->co_msgtypes[i];
 
        return NULL;
}

References nl_msgtype::mt_id.

◆ nl_cache_ops_foreach()

void nl_cache_ops_foreach	(	void()(struct nl_cache_ops , void *)	cb,
		void *	arg
	)

Parameters

cb	Callback function to be called
arg	User specific argument.

Definition at line 207 of file cache_mngt.c.

{
        struct nl_cache_ops *ops;
 
        nl_read_lock(&cache_ops_lock);
        for (ops = cache_ops; ops; ops = ops->co_next)
                cb(ops, arg);
        nl_read_unlock(&cache_ops_lock);
}

◆ nl_cache_mngt_register()

int nl_cache_mngt_register ( struct nl_cache_ops * ops )

Parameters

ops	cache operations

Called by users of caches to announce the avaibility of a certain cache type.

Returns: 0 on success or a negative error code.

Definition at line 226 of file cache_mngt.c.

{
        if (!ops->co_name)
                return nl_error(EINVAL, "No cache name specified");
 
        if (!ops->co_obj_ops)
                return nl_error(EINVAL, "No obj cache ops specified");
 
        nl_write_lock(&cache_ops_lock);
        if (__nl_cache_ops_lookup(ops->co_name)) {
                nl_write_unlock(&cache_ops_lock);
                return nl_error(EEXIST, "Cache operations already exist");
        }
 
        ops->co_refcnt = 0;
        ops->co_next = cache_ops;
        cache_ops = ops;
        nl_write_unlock(&cache_ops_lock);
 
        NL_DBG(1, "Registered cache operations %s\n", ops->co_name);
 
        return 0;
}

References nl_cache_ops::co_refcnt.

Referenced by genl_register().

◆ nl_cache_mngt_unregister()

int nl_cache_mngt_unregister ( struct nl_cache_ops * ops )

Parameters

ops	cache operations

Called by users of caches to announce a set of cache operations is no longer available. The specified cache operations must have been registered previously using nl_cache_mngt_register()

Returns: 0 on success or a negative error code

Definition at line 261 of file cache_mngt.c.

{
        struct nl_cache_ops *t, **tp;
 
        nl_write_lock(&cache_ops_lock);
 
        if (ops->co_refcnt > 0) {
                nl_write_unlock(&cache_ops_lock);
                return nl_error(EBUSY, "Cache operations busy");
        }
 
        for (tp = &cache_ops; (t=*tp) != NULL; tp = &t->co_next)
                if (t == ops)
                        break;
 
        if (!t) {
                nl_write_unlock(&cache_ops_lock);
                return nl_error(ENOENT, "No such cache operations");
        }
 
        NL_DBG(1, "Unregistered cache operations %s\n", ops->co_name);
 
        *tp = t->co_next;
        nl_write_unlock(&cache_ops_lock);
 
        return 0;
}

References nl_cache_ops::co_refcnt.

Referenced by genl_unregister().

◆ nl_cache_mngt_provide()

void nl_cache_mngt_provide ( struct nl_cache * cache )

Parameters

cache cache to provide

Offers the specified cache to be used by other modules. Only one cache per type may be shared at a time, a previsouly provided caches will be overwritten.

Definition at line 304 of file cache_mngt.c.

{
        struct nl_cache_ops *ops;
 
        nl_write_lock(&cache_ops_lock);
 
        ops = cache_ops_lookup_for_obj(cache->c_ops->co_obj_ops);
        if (!ops)
                BUG();
        else {
                nl_cache_get(cache);
                ops->co_major_cache = cache;
        }
 
        nl_write_unlock(&cache_ops_lock);
}

References nl_cache_get().

Referenced by nl_cache_mngr_add().

◆ nl_cache_mngt_unprovide()

void nl_cache_mngt_unprovide ( struct nl_cache * cache )

Parameters

cache cache to unprovide

Cancels the offer to use a cache globally. The cache will no longer be returned via lookups but may still be in use.

Definition at line 329 of file cache_mngt.c.

{
        struct nl_cache_ops *ops;
 
        nl_write_lock(&cache_ops_lock);
 
        ops = cache_ops_lookup_for_obj(cache->c_ops->co_obj_ops);
        if (!ops)
                BUG();
        else if (ops->co_major_cache == cache) {
                nl_cache_free(ops->co_major_cache);
                ops->co_major_cache = NULL;
        }
 
        nl_write_unlock(&cache_ops_lock);
}

References nl_cache_free().

◆ nl_cache_mngt_require()

struct nl_cache * nl_cache_mngt_require ( const char * name )

Parameters

name	name of the required object type

Trys to find a cache of the specified type for global use.

Returns: A cache provided by another subsystem of the specified type marked to be available.

Definition at line 356 of file cache_mngt.c.

{
        struct nl_cache_ops *ops;
 
        ops = nl_cache_ops_lookup(name);
        if (!ops || !ops->co_major_cache) {
                fprintf(stderr, "Application BUG: Your application must "
                        "call nl_cache_mngt_provide() and\nprovide a valid "
                        "%s cache to be used for internal lookups.\nSee the "
                        " API documentation for more details.\n", name);
 
                return NULL;
        }
        
        return ops->co_major_cache;
}

References nl_cache_ops_lookup().

Modules

Cache Operations Sets

Global Cache Provisioning/Requiring

Detailed Description

Function Documentation

◆ __nl_cache_ops_lookup()

◆ nl_cache_ops_get()

◆ nl_cache_ops_put()

◆ nl_cache_ops_lookup()

◆ nl_cache_ops_lookup_safe()

◆ nl_cache_ops_associate()

◆ nl_cache_ops_associate_safe()

◆ nl_msgtype_lookup()

◆ nl_cache_ops_foreach()

◆ nl_cache_mngt_register()

◆ nl_cache_mngt_unregister()

◆ nl_cache_mngt_provide()

◆ nl_cache_mngt_unprovide()

◆ nl_cache_mngt_require()