netfilter
firewalling, NAT, and packet mangling for linux
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Caching
Collaboration diagram for 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. More...
 
struct nl_cache_opsnl_cache_ops_associate (int protocol, int msgtype)
 Associate a message type to a set of cache operations. More...
 
struct nl_msgtypenl_msgtype_lookup (struct nl_cache_ops *ops, int msgtype)
 Lookup message type cache association. More...
 
void nl_cache_ops_foreach (void(*cb)(struct nl_cache_ops *, void *), void *arg)
 Call a function for each registered cache operation. More...
 
int nl_cache_mngt_register (struct nl_cache_ops *ops)
 Register a set of cache operations. More...
 
int nl_cache_mngt_unregister (struct nl_cache_ops *ops)
 Unregister a set of cache operations. More...
 

Global Cache Provisioning/Requiring

void nl_cache_mngt_provide (struct nl_cache *cache)
 Provide a cache for global use. More...
 
void nl_cache_mngt_unprovide (struct nl_cache *cache)
 Unprovide a cache for global use. More...
 
struct nl_cachenl_cache_mngt_require (const char *name)
 Demand the use of a global cache. More...
 

Detailed Description

Function Documentation

void nl_cache_mngt_provide ( struct nl_cache cache)

Provide a cache for global use.

  • 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.

References BUG, nl_cache::c_ops, nl_cache_ops::co_major_cache, and nl_cache_ops::co_obj_ops.

Referenced by main(), nl_cache_mngr_add(), nl_cli_alloc_cache(), nl_cli_route_alloc_cache(), and nl_cli_rule_alloc_cache().

Here is the caller graph for this function:

int nl_cache_mngt_register ( struct nl_cache_ops ops)

Register a set of cache operations.

  • 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.

References nl_cache_ops::co_name, nl_cache_ops::co_next, nl_cache_ops::co_obj_ops, nl_cache_ops_lookup(), NL_DBG, NLE_EXIST, and NLE_INVAL.

Referenced by genl_register().

Here is the call graph for this function:

Here is the caller graph for this function:

struct nl_cache* nl_cache_mngt_require ( const char *  name)

Demand the use of a global cache.

  • 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.

References nl_cache_ops::co_major_cache, nl_cache_ops_lookup(), and NULL.

Here is the call graph for this function:

void nl_cache_mngt_unprovide ( struct nl_cache cache)

Unprovide a cache for global use.

  • 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.

References BUG, nl_cache::c_ops, nl_cache_ops::co_major_cache, nl_cache_ops::co_obj_ops, and NULL.

int nl_cache_mngt_unregister ( struct nl_cache_ops ops)

Unregister a set of cache operations.

  • 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

References nl_cache_ops::co_name, nl_cache_ops::co_next, NL_DBG, NLE_NOCACHE, and NULL.

Referenced by genl_unregister().

Here is the caller graph for this function:

struct nl_cache_ops* nl_cache_ops_associate ( int  protocol,
int  msgtype 
)

Associate a message type to a set of cache operations.

  • protocol netlink protocol
  • msgtype netlink 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.

References nl_cache_ops::co_msgtypes, nl_cache_ops::co_next, nl_cache_ops::co_protocol, nl_msgtype::mt_id, and NULL.

Referenced by nl_msg_dump(), and nl_msg_parse().

Here is the caller graph for this function:

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

Call a function for each registered cache operation.

  • cb Callback function to be called
  • arg User specific argument.

References nl_cache_ops::co_next.

Referenced by main().

Here is the caller graph for this function:

struct nl_cache_ops* nl_cache_ops_lookup ( const char *  name)

Lookup the set cache operations of a certain cache type.

  • name name of the cache type
Returns
The cache operations or NULL if no operations have been registered under the specified name.

References nl_cache_ops::co_name, nl_cache_ops::co_next, and NULL.

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

Here is the caller graph for this function:

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

Lookup message type cache association.

  • ops cache operations
  • msgtype netlink message type

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

Returns
A message type association or NULL.

References nl_cache_ops::co_msgtypes, nl_msgtype::mt_id, and NULL.