libnl 1.1
Modules
Caching

Modules

 Cache
 Manager
 

Helps keeping caches up to date.


Cache Operations Sets

struct nl_cache_opsnl_cache_ops_lookup (const char *name)
 Lookup the set cache operations of a certain cache type.
struct nl_cache_opsnl_cache_ops_associate (int protocol, int msgtype)
 Associate a message type to a set of cache operations.
struct nl_msgtypenl_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.

Function Documentation

struct nl_cache_ops* nl_cache_ops_lookup ( const char *  name) [read]
Parameters:
namename of the cache type
Returns:
The cache operations or NULL if no operations have been registered under the specified name.

Definition at line 36 of file cache_mngt.c.

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

{
        struct nl_cache_ops *ops;

        for (ops = cache_ops; ops; ops = ops->co_next)
                if (!strcmp(ops->co_name, name))
                        return ops;

        return NULL;
}
struct nl_cache_ops* nl_cache_ops_associate ( int  protocol,
int  msgtype 
) [read]
Parameters:
protocolnetlink protocol
msgtypenetlink message type

Associates the specified netlink message type with a registered set of cache operations.

Returns:
The cache operations or NULL if no association could be made.

Definition at line 58 of file cache_mngt.c.

References nl_msgtype::mt_id.

Referenced by nl_msg_dump().

{
        int i;
        struct nl_cache_ops *ops;

        for (ops = cache_ops; ops; ops = ops->co_next)
                for (i = 0; ops->co_msgtypes[i].mt_id >= 0; i++)
                        if (ops->co_msgtypes[i].mt_id == msgtype &&
                            ops->co_protocol == protocol)
                                return ops;

        return NULL;
}
struct nl_msgtype* nl_msgtype_lookup ( struct nl_cache_ops ops,
int  msgtype 
) [read]
Parameters:
opscache operations
msgtypenetlink message type

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

Returns:
A message type association or NULL.

Definition at line 82 of file cache_mngt.c.

References nl_msgtype::mt_id.

{
        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;
}
void nl_cache_ops_foreach ( void(*)(struct nl_cache_ops *, void *)  cb,
void *  arg 
)
Parameters:
cbCallback function to be called
argUser specific argument.

Definition at line 110 of file cache_mngt.c.

{
        struct nl_cache_ops *ops;

        for (ops = cache_ops; ops; ops = ops->co_next)
                cb(ops, arg);
}
int nl_cache_mngt_register ( struct nl_cache_ops ops)
Parameters:
opscache 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 127 of file cache_mngt.c.

References nl_cache_ops_lookup().

Referenced by genl_register().

{
        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");

        if (nl_cache_ops_lookup(ops->co_name))
                return nl_error(EEXIST, "Cache operations already exist");
            
        ops->co_next = cache_ops;
        cache_ops = ops;

        NL_DBG(1, "Registered cache operations %s\n", ops->co_name);

        return 0;
}
int nl_cache_mngt_unregister ( struct nl_cache_ops ops)
Parameters:
opscache 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 157 of file cache_mngt.c.

Referenced by genl_unregister().

{
        struct nl_cache_ops *t, **tp;

        for (tp = &cache_ops; (t=*tp) != NULL; tp = &t->co_next)
                if (t == ops)
                        break;

        if (!t)
                return nl_error(ENOENT, "No such cache operations");

        NL_DBG(1, "Unregistered cache operations %s\n", ops->co_name);

        *tp = t->co_next;
        return 0;
}
void nl_cache_mngt_provide ( struct nl_cache *  cache)
Parameters:
cachecache 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 189 of file cache_mngt.c.

Referenced by nl_cache_mngr_add().

{
        struct nl_cache_ops *ops;

        ops = cache_ops_lookup_for_obj(cache->c_ops->co_obj_ops);
        if (!ops)
                BUG();
        else
                ops->co_major_cache = cache;
}
void nl_cache_mngt_unprovide ( struct nl_cache *  cache)
Parameters:
cachecache 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 208 of file cache_mngt.c.

{
        struct nl_cache_ops *ops;

        ops = cache_ops_lookup_for_obj(cache->c_ops->co_obj_ops);
        if (!ops)
                BUG();
        else if (ops->co_major_cache == cache)
                ops->co_major_cache = NULL;
}
struct nl_cache* nl_cache_mngt_require ( const char *  name) [read]
Parameters:
namename 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 229 of file cache_mngt.c.

References nl_cache_ops_lookup().

{
        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;
}