46#include "nl-default.h"
48#include <netlink/netlink.h>
49#include <netlink/cache.h>
50#include <netlink/object.h>
51#include <netlink/hashtable.h>
52#include <netlink/utils.h>
55#include "nl-priv-dynamic-core/nl-core.h"
56#include "nl-priv-dynamic-core/object-api.h"
57#include "nl-priv-dynamic-core/cache-api.h"
58#include "nl-aux-core/nl-core.h"
71 return cache->c_nitems;
81 struct nl_object *obj;
84 if (cache->c_ops == NULL)
87 nl_list_for_each_entry(obj, &cache->c_items, ce_list) {
104 return nl_list_empty(&cache->c_items);
122 if (nl_list_empty(&cache->c_items))
125 return nl_list_entry(cache->c_items.next,
126 struct nl_object, ce_list);
135 if (nl_list_empty(&cache->c_items))
138 return nl_list_entry(cache->c_items.prev,
139 struct nl_object, ce_list);
148 if (nl_list_at_tail(obj, &obj->ce_cache->c_items, ce_list))
151 return nl_list_entry(obj->ce_list.next,
152 struct nl_object, ce_list);
161 if (nl_list_at_head(obj, &obj->ce_cache->c_items, ce_list))
164 return nl_list_entry(obj->ce_list.prev,
165 struct nl_object, ce_list);
186 struct nl_cache *cache;
188 cache = calloc(1,
sizeof(*cache));
192 nl_init_list_head(&cache->c_items);
194 cache->c_flags |= ops->co_flags;
202 if (ops->co_obj_ops->oo_keygen) {
205 if (ops->co_hash_size)
206 hashtable_size = ops->co_hash_size;
208 hashtable_size = NL_MAX_HASH_ENTRIES;
213 NL_DBG(2,
"Allocated cache %p <%s>.\n", cache, nl_cache_name(cache));
235 struct nl_cache **result)
237 struct nl_cache *cache;
267 struct nl_cache_ops *ops;
268 struct nl_cache *cache;
299 struct nl_object *filter)
301 struct nl_cache *cache;
302 struct nl_object *obj;
311 NL_DBG(2,
"Filling subset of cache %p <%s> with filter %p into %p\n",
312 orig, nl_cache_name(orig), filter, cache);
314 nl_list_for_each_entry(obj, &orig->c_items, ce_list) {
341 struct nl_cache *clone;
342 struct nl_object *obj;
348 NL_DBG(2,
"Cloning %p into %p\n", cache, clone);
350 nl_list_for_each_entry(obj, &cache->c_items, ce_list)
369 struct nl_object *obj, *tmp;
371 NL_DBG(2,
"Clearing cache %p <%s>...\n", cache, nl_cache_name(cache));
373 nl_list_for_each_entry_safe(obj, tmp, &cache->c_items, ce_list)
377static void __nl_cache_free(
struct nl_cache *cache)
381 if (cache->hashtable)
384 NL_DBG(2,
"Freeing cache %p <%s>...\n", cache, nl_cache_name(cache));
396 NL_DBG(3,
"Incremented cache %p <%s> reference count to %d\n",
397 cache, nl_cache_name(cache), cache->c_refcnt);
416 NL_DBG(3,
"Decremented cache %p <%s> reference count, %d remaining\n",
417 cache, nl_cache_name(cache), cache->c_refcnt);
419 if (cache->c_refcnt <= 0)
420 __nl_cache_free(cache);
423void nl_cache_put(
struct nl_cache *cache)
435static int __cache_add(
struct nl_cache *cache,
struct nl_object *obj)
439 obj->ce_cache = cache;
441 if (cache->hashtable) {
444 obj->ce_cache = NULL;
449 nl_list_add_tail(&obj->ce_list, &cache->c_items);
452 NL_DBG(3,
"Added object %p to cache %p <%s>, nitems %d\n",
453 obj, cache, nl_cache_name(cache), cache->c_nitems);
482 struct nl_object *
new;
485 if (cache->c_ops->co_obj_ops != obj->ce_ops)
486 return -NLE_OBJ_MISMATCH;
488 if (!nl_list_empty(&obj->ce_list)) {
489 NL_DBG(3,
"Object %p already in cache, cloning new object\n", obj);
499 ret = __cache_add(cache,
new);
526 if (cache->c_ops->co_obj_ops != obj->ce_ops)
527 return -NLE_OBJ_MISMATCH;
529 NL_DBG(3,
"Moving object %p from cache %p to cache %p\n",
530 obj, obj->ce_cache, cache);
536 if (!nl_list_empty(&obj->ce_list))
539 return __cache_add(cache, obj);
555 struct nl_cache *cache = obj->ce_cache;
560 if (cache->hashtable) {
563 NL_DBG(2,
"Failed to delete %p from cache %p <%s>.\n",
564 obj, cache, nl_cache_name(cache));
567 nl_list_del(&obj->ce_list);
568 obj->ce_cache = NULL;
572 NL_DBG(2,
"Deleted object %p from cache %p <%s>.\n",
573 obj, cache, nl_cache_name(cache));
593 cache->c_iarg1 = arg;
606 cache->c_iarg2 = arg;
616 cache->c_flags |= flags;
645static int nl_cache_request_full_dump(
struct nl_sock *sk,
646 struct nl_cache *cache)
648 if (sk->s_proto != cache->c_ops->co_protocol)
649 return -NLE_PROTO_MISMATCH;
651 if (cache->c_ops->co_request_update == NULL)
652 return -NLE_OPNOTSUPP;
654 NL_DBG(2,
"Requesting update from kernel for cache %p <%s>\n",
655 cache, nl_cache_name(cache));
657 return cache->c_ops->co_request_update(cache, sk);
662 struct nl_cache_ops *ops;
663 struct nl_parser_param *params;
666static int update_msg_parser(
struct nl_msg *msg,
void *arg)
668 struct update_xdata *x = arg;
671 ret = nl_cache_parse(x->ops, &msg->nm_src, msg->nm_nlh, x->params);
672 if (ret == -NLE_EXIST)
685static int __cache_pickup(
struct nl_sock *sk,
struct nl_cache *cache,
686 struct nl_parser_param *param)
690 struct update_xdata x = {
695 NL_DBG(2,
"Picking up answer for cache %p <%s>\n",
696 cache, nl_cache_name(cache));
706 NL_DBG(2,
"While picking up for %p <%s>, recvmsgs() returned %d: %s\n",
707 cache, nl_cache_name(cache), err, nl_geterror(err));
714static int pickup_checkdup_cb(
struct nl_object *c,
struct nl_parser_param *p)
716 struct nl_cache *cache = (
struct nl_cache *)p->pp_arg;
717 _nl_auto_nl_object
struct nl_object *old = NULL;
730static int pickup_cb(
struct nl_object *c,
struct nl_parser_param *p)
732 struct nl_cache *cache = p->pp_arg;
737static int __nl_cache_pickup(
struct nl_sock *sk,
struct nl_cache *cache,
740 struct nl_parser_param p;
742 p.pp_cb = checkdup ? pickup_checkdup_cb : pickup_cb;
745 if (sk->s_proto != cache->c_ops->co_protocol)
746 return -NLE_PROTO_MISMATCH;
748 return __cache_pickup(sk, cache, &p);
766 return __nl_cache_pickup(sk, cache, 1);
781 return __nl_cache_pickup(sk, cache, 0);
784static int cache_include(
struct nl_cache *cache,
struct nl_object *obj,
785 struct nl_msgtype *type, change_func_t cb,
786 change_func_v2_t cb_v2,
void *data)
788 _nl_auto_nl_object
struct nl_object *old = NULL;
789 _nl_auto_nl_object
struct nl_object *clone = NULL;
792 switch (type->mt_act) {
797 if (cb_v2 && old->ce_ops->oo_update) {
808 cb_v2(cache, clone, old, diff,
809 NL_ACT_CHANGE, data);
812 cb(cache, old, NL_ACT_CHANGE, data);
816 if (type->mt_act == NL_ACT_DEL) {
818 cb_v2(cache, old, NULL, 0, NL_ACT_DEL,
821 cb(cache, old, NL_ACT_DEL, data);
825 if (type->mt_act == NL_ACT_NEW) {
829 cb_v2(cache, NULL, obj, 0, NL_ACT_NEW,
832 cb(cache, obj, NL_ACT_NEW, data);
838 cb_v2(cache, old, obj, diff, NL_ACT_CHANGE,
840 }
else if (diff && cb)
841 cb(cache, obj, NL_ACT_CHANGE, data);
847 NL_DBG(2,
"Unknown action associated to object %p\n", obj);
854int nl_cache_include(
struct nl_cache *cache,
struct nl_object *obj,
855 change_func_t change_cb,
void *data)
857 struct nl_cache_ops *ops = cache->c_ops;
860 if (ops->co_obj_ops != obj->ce_ops)
861 return -NLE_OBJ_MISMATCH;
863 for (i = 0; ops->co_msgtypes[i].mt_id >= 0; i++)
864 if (ops->co_msgtypes[i].mt_id == obj->ce_msgtype)
865 return cache_include(cache, obj, &ops->co_msgtypes[i],
866 change_cb, NULL, data);
868 NL_DBG(3,
"Object %p does not seem to belong to cache %p <%s>\n",
869 obj, cache, nl_cache_name(cache));
871 return -NLE_MSGTYPE_NOSUPPORT;
874int nl_cache_include_v2(
struct nl_cache *cache,
struct nl_object *obj,
875 change_func_v2_t change_cb,
void *data)
877 struct nl_cache_ops *ops = cache->c_ops;
880 if (ops->co_obj_ops != obj->ce_ops)
881 return -NLE_OBJ_MISMATCH;
883 for (i = 0; ops->co_msgtypes[i].mt_id >= 0; i++)
884 if (ops->co_msgtypes[i].mt_id == obj->ce_msgtype)
885 return cache_include(cache, obj, &ops->co_msgtypes[i],
886 NULL, change_cb, data);
888 NL_DBG(3,
"Object %p does not seem to belong to cache %p <%s>\n",
889 obj, cache, nl_cache_name(cache));
891 return -NLE_MSGTYPE_NOSUPPORT;
894static int resync_cb(
struct nl_object *c,
struct nl_parser_param *p)
896 struct nl_cache_assoc *ca = p->pp_arg;
898 if (ca->ca_change_v2)
899 return nl_cache_include_v2(ca->ca_cache, c, ca->ca_change_v2,
902 return nl_cache_include(ca->ca_cache, c, ca->ca_change,
906int nl_cache_resync(
struct nl_sock *sk,
struct nl_cache *cache,
907 change_func_t change_cb,
void *data)
909 struct nl_object *obj, *next;
910 struct nl_af_group *grp;
911 struct nl_cache_assoc ca = {
913 .ca_change = change_cb,
914 .ca_change_data = data,
916 struct nl_parser_param p = {
922 if (sk->s_proto != cache->c_ops->co_protocol)
923 return -NLE_PROTO_MISMATCH;
925 NL_DBG(1,
"Resyncing cache %p <%s>...\n", cache, nl_cache_name(cache));
930 grp = cache->c_ops->co_groups;
932 if (grp && grp->ag_group &&
937 err = nl_cache_request_full_dump(sk, cache);
941 err = __cache_pickup(sk, cache, &p);
942 if (err == -NLE_DUMP_INTR)
949 }
while (grp && grp->ag_group &&
952 nl_list_for_each_entry_safe(obj, next, &cache->c_items, ce_list) {
957 change_cb(cache, obj, NL_ACT_DEL, data);
962 NL_DBG(1,
"Finished resyncing %p <%s>\n", cache, nl_cache_name(cache));
977int nl_cache_parse(
struct nl_cache_ops *ops,
struct sockaddr_nl *who,
978 struct nlmsghdr *nlh,
struct nl_parser_param *params)
982 if (!nlmsg_valid_hdr(nlh, ops->co_hdrsize))
983 return -NLE_MSG_TOOSHORT;
985 for (i = 0; ops->co_msgtypes[i].mt_id >= 0; i++) {
986 if (ops->co_msgtypes[i].mt_id == nlh->nlmsg_type) {
987 err = ops->co_msg_parser(ops, who, nlh, params);
988 if (err != -NLE_OPNOTSUPP)
994 err = -NLE_MSGTYPE_NOSUPPORT;
1015 struct nl_parser_param p = {
1020 return nl_cache_parse(cache->c_ops, NULL,
nlmsg_hdr(msg), &p);
1035 struct nl_af_group *grp;
1038 if (sk->s_proto != cache->c_ops->co_protocol)
1039 return -NLE_PROTO_MISMATCH;
1042 grp = cache->c_ops->co_groups;
1044 if (grp && grp->ag_group &&
1049 err = nl_cache_request_full_dump(sk, cache);
1053 NL_DBG(2,
"Updating cache %p <%s> for family %u, request sent, waiting for reply\n",
1054 cache, nl_cache_name(cache), grp ? grp->ag_family : AF_UNSPEC);
1057 if (err == -NLE_DUMP_INTR) {
1058 NL_DBG(2,
"Dump interrupted, restarting!\n");
1065 }
while (grp && grp->ag_group &&
1077static struct nl_object *__cache_fast_lookup(
struct nl_cache *cache,
1078 struct nl_object *needle)
1080 struct nl_object *obj;
1107 struct nl_object *needle)
1109 struct nl_object *obj;
1111 if (cache->hashtable)
1112 return __cache_fast_lookup(cache, needle);
1114 nl_list_for_each_entry(obj, &cache->c_items, ce_list) {
1142 struct nl_object *filter)
1144 struct nl_object *obj;
1146 if (cache->c_ops == NULL)
1150 && cache->hashtable)
1151 return __cache_fast_lookup(cache, filter);
1153 nl_list_for_each_entry(obj, &cache->c_items, ce_list) {
1172 struct nl_object *obj;
1174 NL_DBG(2,
"Marking all objects in cache %p <%s>\n",
1175 cache, nl_cache_name(cache));
1177 nl_list_for_each_entry(obj, &cache->c_items, ce_list)
1211 struct nl_object *filter)
1214 struct nl_object_ops *ops;
1215 struct nl_object *obj;
1218 NL_DBG(2,
"Dumping cache %p <%s> with filter %p\n",
1219 cache, nl_cache_name(cache), filter);
1228 _nl_assert_not_reached ();
1232 params = ¶ms_copy;
1237 if (type > NL_DUMP_MAX || type < 0)
1240 if (cache->c_ops == NULL)
1243 ops = cache->c_ops->co_obj_ops;
1244 if (!ops->oo_dump[type])
1250 nl_list_for_each_entry(obj, &cache->c_items, ce_list) {
1254 NL_DBG(4,
"Dumping object %p...\n", obj);
1255 dump_from_ops(obj, params);
1276 void (*cb)(
struct nl_object *,
void *),
void *arg)
1293 void (*cb)(
struct nl_object *,
void *),
void *arg)
1295 struct nl_object *obj, *tmp;
1297 if (cache->c_ops == NULL)
1300 nl_list_for_each_entry_safe(obj, tmp, &cache->c_items, ce_list) {
1304 NL_DBG(3,
"%p<->%p object difference: %x\n",
struct nl_cache_ops * nl_cache_ops_lookup_safe(const char *name)
Lookup cache operations by name.
void nl_cache_ops_put(struct nl_cache_ops *ops)
Decrement reference counter.
int nl_cache_refill(struct nl_sock *sk, struct nl_cache *cache)
(Re)fill a cache with the contents in the kernel.
void nl_cache_set_flags(struct nl_cache *cache, unsigned int flags)
Set cache flags.
void nl_cache_set_arg1(struct nl_cache *cache, int arg)
Set synchronization arg1 of cache.
struct nl_object * nl_cache_search(struct nl_cache *cache, struct nl_object *needle)
Search object in cache.
void nl_cache_foreach(struct nl_cache *cache, void(*cb)(struct nl_object *, void *), void *arg)
Call a callback on each element of the cache.
int nl_cache_nitems(struct nl_cache *cache)
Return the number of items in the cache.
struct nl_object * nl_cache_find(struct nl_cache *cache, struct nl_object *filter)
Find object in cache.
void nl_cache_free(struct nl_cache *cache)
Free a cache.
void nl_cache_get(struct nl_cache *cache)
Increase reference counter of cache.
int nl_cache_nitems_filter(struct nl_cache *cache, struct nl_object *filter)
Return the number of items matching a filter in the cache.
void nl_cache_dump_filter(struct nl_cache *cache, struct nl_dump_params *params, struct nl_object *filter)
Dump all elements of a cache (filtered).
int nl_cache_add(struct nl_cache *cache, struct nl_object *obj)
Add object to cache.
void nl_cache_foreach_filter(struct nl_cache *cache, struct nl_object *filter, void(*cb)(struct nl_object *, void *), void *arg)
Call a callback on each element of the cache (filtered).
int nl_cache_pickup(struct nl_sock *sk, struct nl_cache *cache)
Pickup a netlink dump response and put it into a cache.
#define NL_CACHE_AF_ITER
Explicitely iterate over all address families when updating the cache.
int nl_cache_parse_and_add(struct nl_cache *cache, struct nl_msg *msg)
Parse a netlink message and add it to the cache.
struct nl_object * nl_cache_get_last(struct nl_cache *cache)
Return the last element in the cache.
struct nl_cache * nl_cache_alloc(struct nl_cache_ops *ops)
Allocate new cache.
struct nl_object * nl_cache_get_next(struct nl_object *obj)
Return the next element in the cache.
void nl_cache_remove(struct nl_object *obj)
Remove object from cache.
void nl_cache_dump(struct nl_cache *cache, struct nl_dump_params *params)
Dump all elements of a cache.
int nl_cache_is_empty(struct nl_cache *cache)
Returns true if the cache is empty.
int nl_cache_alloc_and_fill(struct nl_cache_ops *ops, struct nl_sock *sock, struct nl_cache **result)
Allocate new cache and fill it.
struct nl_object * nl_cache_get_first(struct nl_cache *cache)
Return the first element in the cache.
int nl_cache_pickup_checkdup(struct nl_sock *sk, struct nl_cache *cache)
Pickup a netlink dump response and put it into a cache.
struct nl_object * nl_cache_get_prev(struct nl_object *obj)
Return the previous element in the cache.
struct nl_cache * nl_cache_subset(struct nl_cache *orig, struct nl_object *filter)
Allocate new cache containing a subset of an existing cache.
int nl_cache_alloc_name(const char *kind, struct nl_cache **result)
Allocate new cache based on type name.
void nl_cache_clear(struct nl_cache *cache)
Remove all objects of a cache.
struct nl_cache * nl_cache_clone(struct nl_cache *cache)
Allocate new cache and copy the contents of an existing cache.
void nl_cache_set_arg2(struct nl_cache *cache, int arg)
Set synchronization arg2 of cache.
struct nl_cache_ops * nl_cache_get_ops(struct nl_cache *cache)
Return the operations set of the cache.
int nl_cache_move(struct nl_cache *cache, struct nl_object *obj)
Move object from one cache to another.
void nl_cache_mark_all(struct nl_cache *cache)
Mark all objects of a cache.
int nl_cb_set(struct nl_cb *cb, enum nl_cb_type type, enum nl_cb_kind kind, nl_recvmsg_msg_cb_t func, void *arg)
Set up a callback.
struct nl_cb * nl_cb_clone(struct nl_cb *orig)
Clone an existing callback handle.
@ NL_SKIP
Skip this message.
@ NL_CB_VALID
Message is valid.
@ NL_CB_CUSTOM
Customized handler specified by the user.
int nl_hash_table_del(nl_hash_table_t *ht, struct nl_object *obj)
Remove object from hashtable.
nl_hash_table_t * nl_hash_table_alloc(int size)
Allocate hashtable.
void nl_hash_table_free(nl_hash_table_t *ht)
Free hashtable including all nodes.
int nl_hash_table_add(nl_hash_table_t *ht, struct nl_object *obj)
Add object to hashtable.
struct nl_object * nl_hash_table_lookup(nl_hash_table_t *ht, struct nl_object *obj)
Lookup identical object in hashtable.
struct nlmsghdr * nlmsg_hdr(struct nl_msg *n)
Return actual netlink message.
int nl_object_update(struct nl_object *dst, struct nl_object *src)
Merge a cacheable object.
struct nl_object * nl_object_clone(struct nl_object *obj)
Allocate a new object and copy all data from an existing object.
uint64_t nl_object_diff64(struct nl_object *a, struct nl_object *b)
Compute bitmask representing difference in attribute values.
uint32_t nl_object_get_id_attrs(struct nl_object *obj)
Return object id attribute mask.
void nl_object_put(struct nl_object *obj)
Release a reference from an object.
int nl_object_identical(struct nl_object *a, struct nl_object *b)
Check if the identifiers of two objects are identical.
void nl_object_get(struct nl_object *obj)
Acquire a reference on a object.
int nl_object_match_filter(struct nl_object *obj, struct nl_object *filter)
Match a filter against an object.
int nl_object_is_marked(struct nl_object *obj)
Return true if object is marked.
void nl_object_mark(struct nl_object *obj)
Add mark to object.
int nl_recvmsgs(struct nl_sock *sk, struct nl_cb *cb)
Receive a set of messages from a netlink socket.
@ NL_DUMP_DETAILS
Dump all attributes but no statistics.
size_t dp_buflen
Length of the buffer dp_buf.
char * dp_buf
Alternatively the output may be redirected into a buffer.
enum nl_dump_type dp_type
Specifies the type of dump that is requested.