Caching


Modules

 Cache
 
   Cache Management             |    | Type Specific Cache Operations
                                      
                                |    | +----------------+ +------------+
                                       | request update | | msg_parser |
                                |    | +----------------+ +------------+
                                     +- - - - -^- - - - - - - -^- -|- - - -
    nl_cache_update:            |              |               |   |
          1) --------- co_request_update ------+               |   |
                                |                              |   |
          2) destroy old cache     +----------- pp_cb ---------|---+
                                |  |                           |
          3) ---------- nl_recvmsgs ----------+   +- cb_valid -+
             +--------------+   |  |          |   |
             | nl_cache_add |<-----+   + - - -v- -|- - - - - - - - - - -
             +--------------+   |      | +-------------+
                                         | nl_recvmsgs |
                                |      | +-----|-^-----+
                                           +---v-|---+
                                |      |   | nl_recv |
                                           +---------+
                                |      |                 Core Netlink

 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:
name name 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.

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

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* nl_cache_ops_associate ( int  protocol,
int  msgtype 
) [read]

Parameters:
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.

Definition at line 58 of file cache_mngt.c.

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

Referenced by nl_msg_dump().

struct nl_msgtype* nl_msgtype_lookup ( struct nl_cache_ops ops,
int  msgtype 
) [read]

Parameters:
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.

Definition at line 82 of file cache_mngt.c.

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

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 110 of file cache_mngt.c.

References nl_cache_ops::co_next.

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 127 of file cache_mngt.c.

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

Referenced by genl_register().

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 157 of file cache_mngt.c.

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

Referenced by genl_unregister().

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 189 of file cache_mngt.c.

References nl_cache_ops::co_major_cache.

Referenced by nl_cache_mngr_add().

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 208 of file cache_mngt.c.

References nl_cache_ops::co_major_cache.

struct nl_cache* nl_cache_mngt_require ( const char *  name  )  [read]

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 229 of file cache_mngt.c.

References nl_cache_ops::co_major_cache, and nl_cache_ops_lookup().


Generated on Tue Feb 12 03:16:00 2008 for libnl by  doxygen 1.5.4