stv0g/libnl
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
libnl/include/netlink/cache.h

175 lines
5.7 KiB
C
Raw Permalink Normal View History

Initial import
2007-09-15 01:28:01 +02:00
/*
* netlink/cache.h Caching Module
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation version 2.1
* of the License.
*
cache_mngr: Automatically allocate socket if needed The requirement to have the caller provide the socket does not make much sense. Automatically allocate the socket if none was provided. This may also avoid some future abuse of reusing request sockets for handling notifications. Also rename cm_handle to cm_sock for clarity (no API change)
2012-04-21 12:11:45 +02:00
* Copyright (c) 2003-2012 Thomas Graf <tgraf@suug.ch>
Initial import
2007-09-15 01:28:01 +02:00
*/
#ifndef NETLINK_CACHE_H_
#define NETLINK_CACHE_H_
#include <netlink/netlink.h>
#include <netlink/msg.h>
#include <netlink/utils.h>
#include <netlink/object.h>
#ifdef __cplusplus
extern "C" {
#endif
cache: Make NL_ACT_* and nl_cache_ops_(get|put)() available Move NL_ACT_* definition and the functions nl_cache_ops_get() and nl_cache_ops_put() into the public facing API. They can be considered stable. Signed-off-by: Thomas Graf <tgraf@suug.ch>
2013-02-01 10:21:58 +01:00
enum {
NL_ACT_UNSPEC,
NL_ACT_NEW,
NL_ACT_DEL,
NL_ACT_GET,
NL_ACT_SET,
NL_ACT_CHANGE,
__NL_ACT_MAX,
};
#define NL_ACT_MAX (__NL_ACT_MAX - 1)
Initial import
2007-09-15 01:28:01 +02:00
struct nl_cache;
fix includes after removing some headers commit f20bbe1f07fcff1509425884f5ed72ca8d5fb6ab Author: Thomas Graf <tgraf@suug.ch> Date: Tue Jan 22 19:10:38 2013 +0100 No longer install module API headers This commit causes a regression so no app using libnl can be compiled against it. This patch fixes it by removing includes of no-longe existing headers. Signed-off-by: Jiri Pirko <jiri@resnulli.us> Signed-off-by: Thomas Graf <tgraf@suug.ch>
2013-01-23 13:17:43 +01:00
typedef void (*change_func_t)(struct nl_cache *, struct nl_object *, int, void *);
Initial import
2007-09-15 01:28:01 +02:00
cache: Move NL_CACHE_AF_ITER to <netlink/cache.h> <netlink/cache-api.h> alreay requires <netlink/cache.h> anyway. Signed-off-by: Thomas Graf <tgraf@suug.ch>
2012-11-12 21:59:54 +01:00
/**
* @ingroup cache
* Explicitely iterate over all address families when updating the cache
*/
#define NL_CACHE_AF_ITER 0x0001
Initial import
2007-09-15 01:28:01 +02:00
/* Access Functions */
extern int nl_cache_nitems(struct nl_cache *);
extern int nl_cache_nitems_filter(struct nl_cache *,
struct nl_object *);
extern struct nl_cache_ops * nl_cache_get_ops(struct nl_cache *);
extern struct nl_object * nl_cache_get_first(struct nl_cache *);
extern struct nl_object * nl_cache_get_last(struct nl_cache *);
extern struct nl_object * nl_cache_get_next(struct nl_object *);
extern struct nl_object * nl_cache_get_prev(struct nl_object *);
extern struct nl_cache * nl_cache_alloc(struct nl_cache_ops *);
Thread-safe error handling In order for the interface to become more thread safe, the error handling was revised to no longer depend on a static errno and error string buffer. This patch converts all error paths to return a libnl specific error code which can be translated to a error message using nl_geterror(int error). The functions nl_error() and nl_get_errno() are therefore obsolete. This change required various sets of function prototypes to be changed in order to return an error code, the most prominent are: struct nl_cache *foo_alloc_cache(...); changed to: int foo_alloc_cache(..., struct nl_cache **); struct nl_msg *foo_build_request(...); changed to: int foo_build_request(..., struct nl_msg **); struct foo *foo_parse(...); changed to: int foo_parse(..., struct foo **); This pretty much only leaves trivial allocation functions to still return a pointer object which can still return NULL to signal out of memory. This change is a serious API and ABI breaker, sorry!
2008-05-14 17:49:44 +02:00
extern int nl_cache_alloc_and_fill(struct nl_cache_ops *,
Rename struct nl_handle to struct nl_sock The idea of a common handle is long revised and only misleading, nl_handle really represents a socket with some additional action handlers assigned to it. Alias for nl_handle is kept for backwards compatibility.
2008-05-15 13:26:32 +02:00
struct nl_sock *,
Thread-safe error handling In order for the interface to become more thread safe, the error handling was revised to no longer depend on a static errno and error string buffer. This patch converts all error paths to return a libnl specific error code which can be translated to a error message using nl_geterror(int error). The functions nl_error() and nl_get_errno() are therefore obsolete. This change required various sets of function prototypes to be changed in order to return an error code, the most prominent are: struct nl_cache *foo_alloc_cache(...); changed to: int foo_alloc_cache(..., struct nl_cache **); struct nl_msg *foo_build_request(...); changed to: int foo_build_request(..., struct nl_msg **); struct foo *foo_parse(...); changed to: int foo_parse(..., struct foo **); This pretty much only leaves trivial allocation functions to still return a pointer object which can still return NULL to signal out of memory. This change is a serious API and ABI breaker, sorry!
2008-05-14 17:49:44 +02:00
struct nl_cache **);
extern int nl_cache_alloc_name(const char *,
struct nl_cache **);
Initial import
2007-09-15 01:28:01 +02:00
extern struct nl_cache * nl_cache_subset(struct nl_cache *,
struct nl_object *);
Add new nl_cache_clone() function. The function can be used to make a copy of an existing cache. It is very similar to nl_cache_subset() except that it allows no filtering but copies every object. Signed-off-by: Thierry Reding <thierry.reding@avionic-design.de> Signed-off-by: Thomas Graf <tgraf@redhat.com>
2012-02-16 12:57:42 +01:00
extern struct nl_cache * nl_cache_clone(struct nl_cache *);
Initial import
2007-09-15 01:28:01 +02:00
extern void nl_cache_clear(struct nl_cache *);
cache: Add reference counter to caches Signed-off-by: Thomas Graf <tgraf@suug.ch>
2012-11-15 20:45:44 +01:00
extern void nl_cache_get(struct nl_cache *);
Initial import
2007-09-15 01:28:01 +02:00
extern void nl_cache_free(struct nl_cache *);
cache: provide safe variant of nl_cache_mngt_require() and use it This makes runtime removal of cache operations possible if non-safe API is not in use by application. The non-safe API will be removed in the next major version. Signed-off-by: Thomas Graf <tgraf@suug.ch>
2012-11-16 01:11:55 +01:00
extern void nl_cache_put(struct nl_cache *cache);
Initial import
2007-09-15 01:28:01 +02:00
/* Cache modification */
extern int nl_cache_add(struct nl_cache *,
struct nl_object *);
extern int nl_cache_parse_and_add(struct nl_cache *,
struct nl_msg *);
cache: add missing declaration of nl_cache_move() in include/netlink/cache.h Signed-off-by: Sruthi Yellamraju <ysruthi@gmail.com> [thaller@redhat.com: modified tab vs. whitespace] Signed-off-by: Thomas Haller <thaller@redhat.com>
2014-06-24 15:03:15 -04:00
extern int nl_cache_move(struct nl_cache *,
struct nl_object *);
Initial import
2007-09-15 01:28:01 +02:00
extern void nl_cache_remove(struct nl_object *);
Rename struct nl_handle to struct nl_sock The idea of a common handle is long revised and only misleading, nl_handle really represents a socket with some additional action handlers assigned to it. Alias for nl_handle is kept for backwards compatibility.
2008-05-15 13:26:32 +02:00
extern int nl_cache_refill(struct nl_sock *,
Initial import
2007-09-15 01:28:01 +02:00
struct nl_cache *);
Rename struct nl_handle to struct nl_sock The idea of a common handle is long revised and only misleading, nl_handle really represents a socket with some additional action handlers assigned to it. Alias for nl_handle is kept for backwards compatibility.
2008-05-15 13:26:32 +02:00
extern int nl_cache_pickup(struct nl_sock *,
Initial import
2007-09-15 01:28:01 +02:00
struct nl_cache *);
cache: avoid duplicate check on initial dump The cache pickup does a check for duplicates for some time now. However, the pickup in nl_cache_refill() explicitely clears the cache, so the pickup doesn't need to actually do the dupe check, as uniqueness is already guaranteed be Netlink subsystem. And avoiding the dup check is beneficitial for performance reasons, as the current algorithm is O(n^2). http://lists.infradead.org/pipermail/libnl/2014-October/001680.html Fixes: 96bb7c9a4cdd10a2665c0f56120943e79e33c560 Signed-off-by: Holger Eitzenberger <holger@eitzenberger.org> Acked-by: Thomas Graf <tgraf@suug.ch> Signed-off-by: Thomas Haller <thaller@redhat.com>
2014-11-23 15:40:36 +01:00
extern int nl_cache_pickup_checkdup(struct nl_sock *,
struct nl_cache *);
Rename struct nl_handle to struct nl_sock The idea of a common handle is long revised and only misleading, nl_handle really represents a socket with some additional action handlers assigned to it. Alias for nl_handle is kept for backwards compatibility.
2008-05-15 13:26:32 +02:00
extern int nl_cache_resync(struct nl_sock *,
Initial import
2007-09-15 01:28:01 +02:00
struct nl_cache *,
add user data to change_func_t for caches the patch below adds the possibility to pass user data to callbacks of type change_func_t when using the nl_cache_mngr_* family of functions. If there is any better way to do this, without duplicating the code in cache_mngr.c please let me know.
2010-09-22 20:10:26 +02:00
change_func_t,
void *);
Initial import
2007-09-15 01:28:01 +02:00
extern int nl_cache_include(struct nl_cache *,
struct nl_object *,
add user data to change_func_t for caches the patch below adds the possibility to pass user data to callbacks of type change_func_t when using the nl_cache_mngr_* family of functions. If there is any better way to do this, without duplicating the code in cache_mngr.c please let me know.
2010-09-22 20:10:26 +02:00
change_func_t,
void *);
Provide nl_cache_set_arg{1,2}() to specify cache args Added based on a RFE. This is required if allocation and (re)filling is to be splitted.
2011-04-10 10:22:27 +02:00
extern void nl_cache_set_arg1(struct nl_cache *, int);
extern void nl_cache_set_arg2(struct nl_cache *, int);
Add support for per cache flags This patch adds support for per cache flags and adds a flag NL_CACHE_AF_ITER to iter over all supported families when filling the cache. Signed-off-by: Thomas Graf <tgraf@suug.ch>
2012-11-12 12:38:31 -08:00
extern void nl_cache_set_flags(struct nl_cache *, unsigned int);
Initial import
2007-09-15 01:28:01 +02:00
/* General */
extern int nl_cache_is_empty(struct nl_cache *);
add missing nl_cache_search in cache.h fix missing declaration of nl_cache_search
2011-03-22 10:53:51 +01:00
extern struct nl_object * nl_cache_search(struct nl_cache *,
struct nl_object *);
cache: Add missing declaration for nl_cache_find() Reported-by: Andrej.Gantvorg@wago.com Signed-off-by: Thomas Graf <tgraf@suug.ch>
2013-12-13 15:57:43 +01:00
extern struct nl_object *nl_cache_find(struct nl_cache *,
struct nl_object *);
Initial import
2007-09-15 01:28:01 +02:00
extern void nl_cache_mark_all(struct nl_cache *);
/* Dumping */
extern void nl_cache_dump(struct nl_cache *,
struct nl_dump_params *);
extern void nl_cache_dump_filter(struct nl_cache *,
struct nl_dump_params *,
struct nl_object *);
/* Iterators */
extern void nl_cache_foreach(struct nl_cache *,
void (*cb)(struct nl_object *,
void *),
void *arg);
extern void nl_cache_foreach_filter(struct nl_cache *,
struct nl_object *,
void (*cb)(struct
nl_object *,
void *),
void *arg);
/* --- cache management --- */
/* Cache type management */
extern struct nl_cache_ops * nl_cache_ops_lookup(const char *);
cache: Provide safe versions of nl_cache_ops_associate() and nl_cache_ops_lookup() Signed-off-by: Thomas Graf <tgraf@suug.ch>
2012-11-16 00:19:38 +01:00
extern struct nl_cache_ops * nl_cache_ops_lookup_safe(const char *);
Cache message type association interface cleanups
2007-10-11 23:09:49 +02:00
extern struct nl_cache_ops * nl_cache_ops_associate(int, int);
cache: Provide safe versions of nl_cache_ops_associate() and nl_cache_ops_lookup() Signed-off-by: Thomas Graf <tgraf@suug.ch>
2012-11-16 00:19:38 +01:00
extern struct nl_cache_ops * nl_cache_ops_associate_safe(int, int);
Cache message type association interface cleanups
2007-10-11 23:09:49 +02:00
extern struct nl_msgtype * nl_msgtype_lookup(struct nl_cache_ops *, int);
extern void nl_cache_ops_foreach(void (*cb)(struct nl_cache_ops *, void *), void *);
Initial import
2007-09-15 01:28:01 +02:00
extern int nl_cache_mngt_register(struct nl_cache_ops *);
extern int nl_cache_mngt_unregister(struct nl_cache_ops *);
/* Global cache provisioning/requiring */
extern void nl_cache_mngt_provide(struct nl_cache *);
extern void nl_cache_mngt_unprovide(struct nl_cache *);
extern struct nl_cache * nl_cache_mngt_require(const char *);
cache: provide safe variant of nl_cache_mngt_require() and use it This makes runtime removal of cache operations possible if non-safe API is not in use by application. The non-safe API will be removed in the next major version. Signed-off-by: Thomas Graf <tgraf@suug.ch>
2012-11-16 01:11:55 +01:00
extern struct nl_cache * nl_cache_mngt_require_safe(const char *);
Provide silent variation of nl_cache_require() Use in addr and tc layer to avoid warnings being printed if no cache is available.
2011-05-11 09:33:29 +02:00
extern struct nl_cache * __nl_cache_mngt_require(const char *);
Initial import
2007-09-15 01:28:01 +02:00
struct nl_cache_mngr;
#define NL_AUTO_PROVIDE 1
cache_mngr: Automatically allocate socket if needed The requirement to have the caller provide the socket does not make much sense. Automatically allocate the socket if none was provided. This may also avoid some future abuse of reusing request sockets for handling notifications. Also rename cm_handle to cm_sock for clarity (no API change)
2012-04-21 12:11:45 +02:00
#define NL_ALLOCATED_SOCK 2 /* For internal use only, do not use */
Initial import
2007-09-15 01:28:01 +02:00
Rename struct nl_handle to struct nl_sock The idea of a common handle is long revised and only misleading, nl_handle really represents a socket with some additional action handlers assigned to it. Alias for nl_handle is kept for backwards compatibility.
2008-05-15 13:26:32 +02:00
extern int nl_cache_mngr_alloc(struct nl_sock *,
Thread-safe error handling In order for the interface to become more thread safe, the error handling was revised to no longer depend on a static errno and error string buffer. This patch converts all error paths to return a libnl specific error code which can be translated to a error message using nl_geterror(int error). The functions nl_error() and nl_get_errno() are therefore obsolete. This change required various sets of function prototypes to be changed in order to return an error code, the most prominent are: struct nl_cache *foo_alloc_cache(...); changed to: int foo_alloc_cache(..., struct nl_cache **); struct nl_msg *foo_build_request(...); changed to: int foo_build_request(..., struct nl_msg **); struct foo *foo_parse(...); changed to: int foo_parse(..., struct foo **); This pretty much only leaves trivial allocation functions to still return a pointer object which can still return NULL to signal out of memory. This change is a serious API and ABI breaker, sorry!
2008-05-14 17:49:44 +02:00
int, int,
struct nl_cache_mngr **);
extern int nl_cache_mngr_add(struct nl_cache_mngr *,
Initial import
2007-09-15 01:28:01 +02:00
const char *,
Thread-safe error handling In order for the interface to become more thread safe, the error handling was revised to no longer depend on a static errno and error string buffer. This patch converts all error paths to return a libnl specific error code which can be translated to a error message using nl_geterror(int error). The functions nl_error() and nl_get_errno() are therefore obsolete. This change required various sets of function prototypes to be changed in order to return an error code, the most prominent are: struct nl_cache *foo_alloc_cache(...); changed to: int foo_alloc_cache(..., struct nl_cache **); struct nl_msg *foo_build_request(...); changed to: int foo_build_request(..., struct nl_msg **); struct foo *foo_parse(...); changed to: int foo_parse(..., struct foo **); This pretty much only leaves trivial allocation functions to still return a pointer object which can still return NULL to signal out of memory. This change is a serious API and ABI breaker, sorry!
2008-05-14 17:49:44 +02:00
change_func_t,
add user data to change_func_t for caches the patch below adds the possibility to pass user data to callbacks of type change_func_t when using the nl_cache_mngr_* family of functions. If there is any better way to do this, without duplicating the code in cache_mngr.c please let me know.
2010-09-22 20:10:26 +02:00
void *,
Thread-safe error handling In order for the interface to become more thread safe, the error handling was revised to no longer depend on a static errno and error string buffer. This patch converts all error paths to return a libnl specific error code which can be translated to a error message using nl_geterror(int error). The functions nl_error() and nl_get_errno() are therefore obsolete. This change required various sets of function prototypes to be changed in order to return an error code, the most prominent are: struct nl_cache *foo_alloc_cache(...); changed to: int foo_alloc_cache(..., struct nl_cache **); struct nl_msg *foo_build_request(...); changed to: int foo_build_request(..., struct nl_msg **); struct foo *foo_parse(...); changed to: int foo_parse(..., struct foo **); This pretty much only leaves trivial allocation functions to still return a pointer object which can still return NULL to signal out of memory. This change is a serious API and ABI breaker, sorry!
2008-05-14 17:49:44 +02:00
struct nl_cache **);
New cache manager add cache api This patch is an attempt to add a new nl_cache_mngr_add_cache api to allow adding an existing cache to cache manager. Since the new api is similar to nl_cache_mngr_add except for allocating the cache, the patch moves most of the nl_cache_mngr_add code to nl_cache_mngr_add_cache and changes nl_cache_mngr_add to call nl_cache_mngr_add_cache. One use case for this api as pointed out by thomas would be to set cache flags before associating the cache with a cache manager. nl_cache_alloc_name("route/link", &cache); nl_cache_set_flags(cache, NL_CACHE_AF_ITER); nl_cache_mngr_add_cache(mngr, cache, ...); Signed-off-by: Thomas Graf <tgraf@suug.ch>
2012-11-12 12:38:32 -08:00
extern int nl_cache_mngr_add_cache(struct nl_cache_mngr *mngr,
struct nl_cache *cache,
change_func_t cb, void *data);
Initial import
2007-09-15 01:28:01 +02:00
extern int nl_cache_mngr_get_fd(struct nl_cache_mngr *);
extern int nl_cache_mngr_poll(struct nl_cache_mngr *,
int);
extern int nl_cache_mngr_data_ready(struct nl_cache_mngr *);
cache_mngr: Provide nl_cache_mngr_info() to pring cache manager details Useful for debugging and testing
2012-04-21 15:48:37 +02:00
extern void nl_cache_mngr_info(struct nl_cache_mngr *,
struct nl_dump_params *);
Initial import
2007-09-15 01:28:01 +02:00
extern void nl_cache_mngr_free(struct nl_cache_mngr *);
cache: Make NL_ACT_* and nl_cache_ops_(get|put)() available Move NL_ACT_* definition and the functions nl_cache_ops_get() and nl_cache_ops_put() into the public facing API. They can be considered stable. Signed-off-by: Thomas Graf <tgraf@suug.ch>
2013-02-01 10:21:58 +01:00
extern void nl_cache_ops_get(struct nl_cache_ops *);
extern void nl_cache_ops_put(struct nl_cache_ops *);
cache: Declare nl_cache_ops_set_flags() Signed-off-by: Thomas Graf <tgraf@suug.ch> Signed-off-by: Thomas Haller <thaller@redhat.com>
2014-07-26 21:33:21 +02:00
extern void nl_cache_ops_set_flags(struct nl_cache_ops *,
unsigned int);
cache: Make NL_ACT_* and nl_cache_ops_(get|put)() available Move NL_ACT_* definition and the functions nl_cache_ops_get() and nl_cache_ops_put() into the public facing API. They can be considered stable. Signed-off-by: Thomas Graf <tgraf@suug.ch>
2013-02-01 10:21:58 +01:00
Initial import
2007-09-15 01:28:01 +02:00
#ifdef __cplusplus
}
#endif
#endif
Reference in a new issue Copy permalink