53 #include <netlink-private/netlink.h> 54 #include <netlink/netlink.h> 55 #include <netlink/cache.h> 56 #include <netlink/object.h> 57 #include <netlink/hashtable.h> 58 #include <netlink/utils.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)
377 static 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);
423 void nl_cache_put(
struct nl_cache *cache)
435 static 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;
645 static 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);
661 struct update_xdata {
662 struct nl_cache_ops *ops;
663 struct nl_parser_param *params;
666 static 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)
685 static 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));
714 static 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 struct nl_object *old;
733 static int pickup_cb(
struct nl_object *c,
struct nl_parser_param *p)
735 struct nl_cache *cache = p->pp_arg;
740 static int __nl_cache_pickup(
struct nl_sock *sk,
struct nl_cache *cache,
743 struct nl_parser_param p;
745 p.pp_cb = checkdup ? pickup_checkdup_cb : pickup_cb;
748 if (sk->s_proto != cache->c_ops->co_protocol)
749 return -NLE_PROTO_MISMATCH;
751 return __cache_pickup(sk, cache, &p);
766 return __nl_cache_pickup(sk, cache, 1);
784 return __nl_cache_pickup(sk, cache, 0);
787 static int cache_include(
struct nl_cache *cache,
struct nl_object *obj,
788 struct nl_msgtype *type, change_func_t cb,
789 change_func_v2_t cb_v2,
void *data)
791 struct nl_object *old;
792 struct nl_object *clone = NULL;
795 switch (type->mt_act) {
800 if (cb_v2 && old->ce_ops->oo_update) {
811 cb_v2(cache, clone, obj, diff,
812 NL_ACT_CHANGE, data);
815 cb(cache, old, NL_ACT_CHANGE, data);
822 if (type->mt_act == NL_ACT_DEL) {
824 cb_v2(cache, old, NULL, 0, NL_ACT_DEL,
827 cb(cache, old, NL_ACT_DEL, data);
832 if (type->mt_act == NL_ACT_NEW) {
836 cb_v2(cache, NULL, obj, 0, NL_ACT_NEW,
839 cb(cache, obj, NL_ACT_NEW, data);
845 cb_v2(cache, old, obj, diff, NL_ACT_CHANGE,
847 }
else if (diff && cb)
848 cb(cache, obj, NL_ACT_CHANGE, data);
855 NL_DBG(2,
"Unknown action associated to object %p\n", obj);
862 int nl_cache_include(
struct nl_cache *cache,
struct nl_object *obj,
863 change_func_t change_cb,
void *data)
865 struct nl_cache_ops *ops = cache->c_ops;
868 if (ops->co_obj_ops != obj->ce_ops)
869 return -NLE_OBJ_MISMATCH;
871 for (i = 0; ops->co_msgtypes[i].mt_id >= 0; i++)
872 if (ops->co_msgtypes[i].mt_id == obj->ce_msgtype)
873 return cache_include(cache, obj, &ops->co_msgtypes[i],
874 change_cb, NULL, data);
876 NL_DBG(3,
"Object %p does not seem to belong to cache %p <%s>\n",
877 obj, cache, nl_cache_name(cache));
879 return -NLE_MSGTYPE_NOSUPPORT;
882 int nl_cache_include_v2(
struct nl_cache *cache,
struct nl_object *obj,
883 change_func_v2_t change_cb,
void *data)
885 struct nl_cache_ops *ops = cache->c_ops;
888 if (ops->co_obj_ops != obj->ce_ops)
889 return -NLE_OBJ_MISMATCH;
891 for (i = 0; ops->co_msgtypes[i].mt_id >= 0; i++)
892 if (ops->co_msgtypes[i].mt_id == obj->ce_msgtype)
893 return cache_include(cache, obj, &ops->co_msgtypes[i],
894 NULL, change_cb, data);
896 NL_DBG(3,
"Object %p does not seem to belong to cache %p <%s>\n",
897 obj, cache, nl_cache_name(cache));
899 return -NLE_MSGTYPE_NOSUPPORT;
902 static int resync_cb(
struct nl_object *c,
struct nl_parser_param *p)
904 struct nl_cache_assoc *ca = p->pp_arg;
906 if (ca->ca_change_v2)
907 return nl_cache_include_v2(ca->ca_cache, c, ca->ca_change_v2,
910 return nl_cache_include(ca->ca_cache, c, ca->ca_change,
914 int nl_cache_resync(
struct nl_sock *sk,
struct nl_cache *cache,
915 change_func_t change_cb,
void *data)
917 struct nl_object *obj, *next;
918 struct nl_af_group *grp;
919 struct nl_cache_assoc ca = {
921 .ca_change = change_cb,
922 .ca_change_data = data,
924 struct nl_parser_param p = {
930 if (sk->s_proto != cache->c_ops->co_protocol)
931 return -NLE_PROTO_MISMATCH;
933 NL_DBG(1,
"Resyncing cache %p <%s>...\n", cache, nl_cache_name(cache));
938 grp = cache->c_ops->co_groups;
940 if (grp && grp->ag_group &&
945 err = nl_cache_request_full_dump(sk, cache);
949 err = __cache_pickup(sk, cache, &p);
950 if (err == -NLE_DUMP_INTR)
957 }
while (grp && grp->ag_group &&
960 nl_list_for_each_entry_safe(obj, next, &cache->c_items, ce_list) {
965 change_cb(cache, obj, NL_ACT_DEL, data);
970 NL_DBG(1,
"Finished resyncing %p <%s>\n", cache, nl_cache_name(cache));
985 int nl_cache_parse(
struct nl_cache_ops *ops,
struct sockaddr_nl *who,
986 struct nlmsghdr *nlh,
struct nl_parser_param *params)
990 if (!nlmsg_valid_hdr(nlh, ops->co_hdrsize))
991 return -NLE_MSG_TOOSHORT;
993 for (i = 0; ops->co_msgtypes[i].mt_id >= 0; i++) {
994 if (ops->co_msgtypes[i].mt_id == nlh->nlmsg_type) {
995 err = ops->co_msg_parser(ops, who, nlh, params);
996 if (err != -NLE_OPNOTSUPP)
1002 err = -NLE_MSGTYPE_NOSUPPORT;
1023 struct nl_parser_param p = {
1028 return nl_cache_parse(cache->c_ops, NULL,
nlmsg_hdr(msg), &p);
1043 struct nl_af_group *grp;
1046 if (sk->s_proto != cache->c_ops->co_protocol)
1047 return -NLE_PROTO_MISMATCH;
1050 grp = cache->c_ops->co_groups;
1052 if (grp && grp->ag_group &&
1057 err = nl_cache_request_full_dump(sk, cache);
1061 NL_DBG(2,
"Updating cache %p <%s> for family %u, request sent, waiting for reply\n",
1062 cache, nl_cache_name(cache), grp ? grp->ag_family : AF_UNSPEC);
1065 if (err == -NLE_DUMP_INTR) {
1066 NL_DBG(2,
"Dump interrupted, restarting!\n");
1073 }
while (grp && grp->ag_group &&
1085 static struct nl_object *__cache_fast_lookup(
struct nl_cache *cache,
1086 struct nl_object *needle)
1088 struct nl_object *obj;
1115 struct nl_object *needle)
1117 struct nl_object *obj;
1119 if (cache->hashtable)
1120 return __cache_fast_lookup(cache, needle);
1122 nl_list_for_each_entry(obj, &cache->c_items, ce_list) {
1150 struct nl_object *filter)
1152 struct nl_object *obj;
1154 if (cache->c_ops == NULL)
1158 && cache->hashtable)
1159 return __cache_fast_lookup(cache, filter);
1161 nl_list_for_each_entry(obj, &cache->c_items, ce_list) {
1180 struct nl_object *obj;
1182 NL_DBG(2,
"Marking all objects in cache %p <%s>\n",
1183 cache, nl_cache_name(cache));
1185 nl_list_for_each_entry(obj, &cache->c_items, ce_list)
1219 struct nl_object *filter)
1222 struct nl_object_ops *ops;
1223 struct nl_object *obj;
1225 NL_DBG(2,
"Dumping cache %p <%s> with filter %p\n",
1226 cache, nl_cache_name(cache), filter);
1228 if (type > NL_DUMP_MAX || type < 0)
1231 if (cache->c_ops == NULL)
1234 ops = cache->c_ops->co_obj_ops;
1235 if (!ops->oo_dump[type])
1238 if (params && params->
dp_buf)
1241 nl_list_for_each_entry(obj, &cache->c_items, ce_list) {
1245 NL_DBG(4,
"Dumping object %p...\n", obj);
1246 dump_from_ops(obj, params);
1267 void (*cb)(
struct nl_object *,
void *),
void *arg)
1284 void (*cb)(
struct nl_object *,
void *),
void *arg)
1286 struct nl_object *obj, *tmp;
1288 if (cache->c_ops == NULL)
1291 nl_list_for_each_entry_safe(obj, tmp, &cache->c_items, ce_list) {
1295 NL_DBG(3,
"%p<->%p object difference: %x\n",
char * dp_buf
Alternatively the output may be redirected into a buffer.
void nl_cache_ops_put(struct nl_cache_ops *ops)
Decrement reference counter.
struct nl_object * nl_cache_get_prev(struct nl_object *obj)
Return the previous element in the cache.
int nl_cache_alloc_name(const char *kind, struct nl_cache **result)
Allocate new cache based on type name.
struct nl_cache * nl_cache_subset(struct nl_cache *orig, struct nl_object *filter)
Allocate new cache containing a subset of an existing cache.
Customized handler specified by the user.
enum nl_dump_type dp_type
Specifies the type of dump that is requested.
void nl_object_get(struct nl_object *obj)
Acquire a reference on a object.
void nl_cache_get(struct nl_cache *cache)
Increase reference counter of cache.
void nl_hash_table_free(nl_hash_table_t *ht)
Free hashtable including all nodes.
struct nl_object * nl_cache_find(struct nl_cache *cache, struct nl_object *filter)
Find object in 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).
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).
struct nl_object * nl_cache_get_last(struct nl_cache *cache)
Return the last element in the cache.
nl_hash_table_t * nl_hash_table_alloc(int size)
Allocate hashtable.
Dump all attributes but no statistics.
struct nl_cb * nl_cb_clone(struct nl_cb *orig)
Clone an existing callback handle.
uint32_t nl_object_get_id_attrs(struct nl_object *obj)
Return object id attribute mask.
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.
int nl_cache_pickup_checkdup(struct nl_sock *sk, struct nl_cache *cache)
Pickup a netlink dump response and put it into a cache.
int nl_recvmsgs(struct nl_sock *sk, struct nl_cb *cb)
Receive a set of messages from a netlink socket.
struct nl_object * nl_hash_table_lookup(nl_hash_table_t *ht, struct nl_object *obj)
Lookup identical object in hashtable.
uint64_t nl_object_diff64(struct nl_object *a, struct nl_object *b)
Compute bitmask representing difference in attribute values.
void nl_cache_free(struct nl_cache *cache)
Free a cache.
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.
struct nlmsghdr * nlmsg_hdr(struct nl_msg *n)
Return actual netlink message.
void nl_cache_remove(struct nl_object *obj)
Remove object from cache.
int nl_hash_table_add(nl_hash_table_t *ht, struct nl_object *obj)
Add object to hashtable.
int nl_cache_is_empty(struct nl_cache *cache)
Returns true if the cache is empty.
void nl_cache_clear(struct nl_cache *cache)
Remove all objects of a cache.
struct nl_cache_ops * nl_cache_ops_lookup_safe(const char *name)
Lookup cache operations by name.
void nl_cache_set_arg2(struct nl_cache *cache, int arg)
Set synchronization arg2 of cache.
void nl_cache_dump(struct nl_cache *cache, struct nl_dump_params *params)
Dump all elements of a 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.
int nl_cache_nitems(struct nl_cache *cache)
Return the number of items in the cache.
struct nl_object * nl_cache_get_next(struct nl_object *obj)
Return the next element in the cache.
int nl_cache_refill(struct nl_sock *sk, struct nl_cache *cache)
(Re)fill a cache with the contents in the kernel.
void nl_object_put(struct nl_object *obj)
Release a reference from an object.
void nl_cache_mark_all(struct nl_cache *cache)
Mark all objects of a cache.
int nl_cache_move(struct nl_cache *cache, struct nl_object *obj)
Move object from one cache to another.
int nl_object_identical(struct nl_object *a, struct nl_object *b)
Check if the identifiers of two objects are identical.
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_set_flags(struct nl_cache *cache, unsigned int flags)
Set cache flags.
int nl_hash_table_del(nl_hash_table_t *ht, struct nl_object *obj)
Remove object from hashtable.
struct nl_cache_ops * nl_cache_get_ops(struct nl_cache *cache)
Return the operations set of the cache.
size_t dp_buflen
Length of the buffer dp_buf.
#define NL_CACHE_AF_ITER
Explicitely iterate over all address families when updating the cache.
int nl_object_match_filter(struct nl_object *obj, struct nl_object *filter)
Match a filter against an object.
void nl_object_mark(struct nl_object *obj)
Add mark to object.
struct nl_cache * nl_cache_clone(struct nl_cache *cache)
Allocate new cache and copy the contents of an existing cache.
int nl_object_update(struct nl_object *dst, struct nl_object *src)
Merge a cacheable object.
int nl_cache_add(struct nl_cache *cache, struct nl_object *obj)
Add object to cache.
struct nl_object * nl_object_clone(struct nl_object *obj)
Allocate a new object and copy all data from an existing object.
int nl_object_is_marked(struct nl_object *obj)
Return true if object is marked.
struct nl_object * nl_cache_get_first(struct nl_cache *cache)
Return the first element in the cache.
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_cache * nl_cache_alloc(struct nl_cache_ops *ops)
Allocate new cache.
int nl_cache_pickup(struct nl_sock *sk, struct nl_cache *cache)
Pickup a netlink dump response and put it into a cache.