libnl 3.7.0
cache.h
1/* SPDX-License-Identifier: LGPL-2.1-only */
2/*
3 * Copyright (c) 2003-2012 Thomas Graf <tgraf@suug.ch>
4 */
5
6#ifndef NETLINK_CACHE_H_
7#define NETLINK_CACHE_H_
8
9#include <netlink/netlink.h>
10#include <netlink/msg.h>
11#include <netlink/utils.h>
12#include <netlink/object.h>
13
14#ifdef __cplusplus
15extern "C" {
16#endif
17
18enum {
19 NL_ACT_UNSPEC,
20 NL_ACT_NEW,
21 NL_ACT_DEL,
22 NL_ACT_GET,
23 NL_ACT_SET,
24 NL_ACT_CHANGE,
25 __NL_ACT_MAX,
26};
27
28#define NL_ACT_MAX (__NL_ACT_MAX - 1)
29
30struct nl_cache;
31typedef void (*change_func_t)(struct nl_cache *, struct nl_object *, int, void *);
32typedef void (*change_func_v2_t)(struct nl_cache *, struct nl_object *old_obj,
33 struct nl_object *new_obj, uint64_t, int, void *);
34
35/**
36 * @ingroup cache
37 * Explicitely iterate over all address families when updating the cache
38 */
39#define NL_CACHE_AF_ITER 0x0001
40
41/* Access Functions */
42extern int nl_cache_nitems(struct nl_cache *);
43extern int nl_cache_nitems_filter(struct nl_cache *,
44 struct nl_object *);
45extern struct nl_cache_ops * nl_cache_get_ops(struct nl_cache *);
46extern struct nl_object * nl_cache_get_first(struct nl_cache *);
47extern struct nl_object * nl_cache_get_last(struct nl_cache *);
48extern struct nl_object * nl_cache_get_next(struct nl_object *);
49extern struct nl_object * nl_cache_get_prev(struct nl_object *);
50
51extern struct nl_cache * nl_cache_alloc(struct nl_cache_ops *);
52extern int nl_cache_alloc_and_fill(struct nl_cache_ops *,
53 struct nl_sock *,
54 struct nl_cache **);
55extern int nl_cache_alloc_name(const char *,
56 struct nl_cache **);
57extern struct nl_cache * nl_cache_subset(struct nl_cache *,
58 struct nl_object *);
59extern struct nl_cache * nl_cache_clone(struct nl_cache *);
60extern void nl_cache_clear(struct nl_cache *);
61extern void nl_cache_get(struct nl_cache *);
62extern void nl_cache_free(struct nl_cache *);
63extern void nl_cache_put(struct nl_cache *cache);
64
65/* Cache modification */
66extern int nl_cache_add(struct nl_cache *,
67 struct nl_object *);
68extern int nl_cache_parse_and_add(struct nl_cache *,
69 struct nl_msg *);
70extern int nl_cache_move(struct nl_cache *,
71 struct nl_object *);
72extern void nl_cache_remove(struct nl_object *);
73extern int nl_cache_refill(struct nl_sock *,
74 struct nl_cache *);
75extern int nl_cache_pickup(struct nl_sock *,
76 struct nl_cache *);
77extern int nl_cache_pickup_checkdup(struct nl_sock *,
78 struct nl_cache *);
79extern int nl_cache_resync(struct nl_sock *,
80 struct nl_cache *,
81 change_func_t,
82 void *);
83extern int nl_cache_include(struct nl_cache *,
84 struct nl_object *,
85 change_func_t,
86 void *);
87extern int nl_cache_include_v2(struct nl_cache *,
88 struct nl_object *,
89 change_func_v2_t,
90 void *);
91extern void nl_cache_set_arg1(struct nl_cache *, int);
92extern void nl_cache_set_arg2(struct nl_cache *, int);
93extern void nl_cache_set_flags(struct nl_cache *, unsigned int);
94
95/* General */
96extern int nl_cache_is_empty(struct nl_cache *);
97extern struct nl_object * nl_cache_search(struct nl_cache *,
98 struct nl_object *);
99extern struct nl_object *nl_cache_find(struct nl_cache *,
100 struct nl_object *);
101extern void nl_cache_mark_all(struct nl_cache *);
102
103/* Dumping */
104extern void nl_cache_dump(struct nl_cache *,
105 struct nl_dump_params *);
106extern void nl_cache_dump_filter(struct nl_cache *,
107 struct nl_dump_params *,
108 struct nl_object *);
109
110/* Iterators */
111extern void nl_cache_foreach(struct nl_cache *,
112 void (*cb)(struct nl_object *,
113 void *),
114 void *arg);
115extern void nl_cache_foreach_filter(struct nl_cache *,
116 struct nl_object *,
117 void (*cb)(struct
118 nl_object *,
119 void *),
120 void *arg);
121
122/* --- cache management --- */
123
124/* Cache type management */
125extern struct nl_cache_ops * nl_cache_ops_lookup(const char *);
126extern struct nl_cache_ops * nl_cache_ops_lookup_safe(const char *);
127extern struct nl_cache_ops * nl_cache_ops_associate(int, int);
128extern struct nl_cache_ops * nl_cache_ops_associate_safe(int, int);
129extern struct nl_msgtype * nl_msgtype_lookup(struct nl_cache_ops *, int);
130extern void nl_cache_ops_foreach(void (*cb)(struct nl_cache_ops *, void *), void *);
131extern int nl_cache_mngt_register(struct nl_cache_ops *);
132extern int nl_cache_mngt_unregister(struct nl_cache_ops *);
133
134/* Global cache provisioning/requiring */
135extern void nl_cache_mngt_provide(struct nl_cache *);
136extern void nl_cache_mngt_unprovide(struct nl_cache *);
137extern struct nl_cache * nl_cache_mngt_require(const char *);
138extern struct nl_cache * nl_cache_mngt_require_safe(const char *);
139extern struct nl_cache * __nl_cache_mngt_require(const char *);
140
141struct nl_cache_mngr;
142
143#define NL_AUTO_PROVIDE 1
144#define NL_ALLOCATED_SOCK 2 /* For internal use only, do not use */
145
146extern int nl_cache_mngr_alloc(struct nl_sock *,
147 int, int,
148 struct nl_cache_mngr **);
149extern int nl_cache_mngr_add(struct nl_cache_mngr *,
150 const char *,
151 change_func_t,
152 void *,
153 struct nl_cache **);
154extern int nl_cache_mngr_add_cache(struct nl_cache_mngr *mngr,
155 struct nl_cache *cache,
156 change_func_t cb, void *data);
157extern int nl_cache_mngr_add_cache_v2(struct nl_cache_mngr *mngr,
158 struct nl_cache *cache,
159 change_func_v2_t cb, void *data);
160extern int nl_cache_mngr_get_fd(struct nl_cache_mngr *);
161extern int nl_cache_mngr_poll(struct nl_cache_mngr *,
162 int);
163extern int nl_cache_mngr_data_ready(struct nl_cache_mngr *);
164extern void nl_cache_mngr_info(struct nl_cache_mngr *,
165 struct nl_dump_params *);
166extern void nl_cache_mngr_free(struct nl_cache_mngr *);
167
168extern void nl_cache_ops_get(struct nl_cache_ops *);
169extern void nl_cache_ops_put(struct nl_cache_ops *);
170extern void nl_cache_ops_set_flags(struct nl_cache_ops *,
171 unsigned int);
172
173#ifdef __cplusplus
174}
175#endif
176
177#endif
nl_cache_mngr_alloc
int nl_cache_mngr_alloc(struct nl_sock *, int, int, struct nl_cache_mngr **)
Allocate new cache manager.
Definition: cache_mngr.c:136
nl_cache_mngr_free
void nl_cache_mngr_free(struct nl_cache_mngr *)
Free cache manager and all caches.
Definition: cache_mngr.c:602
nl_cache_mngr_info
void nl_cache_mngr_info(struct nl_cache_mngr *, struct nl_dump_params *)
Print information about cache manager.
Definition: cache_mngr.c:563
nl_cache_mngr_poll
int nl_cache_mngr_poll(struct nl_cache_mngr *, int)
Check for event notifications.
Definition: cache_mngr.c:488
nl_cache_mngr_add_cache_v2
int nl_cache_mngr_add_cache_v2(struct nl_cache_mngr *mngr, struct nl_cache *cache, change_func_v2_t cb, void *data)
Add cache to cache manager.
Definition: cache_mngr.c:384
nl_cache_mngr_add
int nl_cache_mngr_add(struct nl_cache_mngr *, const char *, change_func_t, void *, struct nl_cache **)
Add cache to cache manager.
Definition: cache_mngr.c:425
nl_cache_mngr_get_fd
int nl_cache_mngr_get_fd(struct nl_cache_mngr *)
Get socket file descriptor.
Definition: cache_mngr.c:464
nl_cache_mngr_data_ready
int nl_cache_mngr_data_ready(struct nl_cache_mngr *)
Receive available event notifications.
Definition: cache_mngr.c:527
nl_cache_mngr_add_cache
int nl_cache_mngr_add_cache(struct nl_cache_mngr *mngr, struct nl_cache *cache, change_func_t cb, void *data)
Add cache to cache manager.
Definition: cache_mngr.c:286
nl_cache_mngt_unregister
int nl_cache_mngt_unregister(struct nl_cache_ops *)
Unregister a set of cache operations.
Definition: cache_mngt.c:281
nl_cache_ops_foreach
void nl_cache_ops_foreach(void(*cb)(struct nl_cache_ops *, void *), void *)
Call a function for each registered cache operation.
Definition: cache_mngt.c:212
nl_cache_mngt_register
int nl_cache_mngt_register(struct nl_cache_ops *)
Register a set of cache operations.
Definition: cache_mngt.c:246
nl_cache_mngt_unprovide
void nl_cache_mngt_unprovide(struct nl_cache *)
Unprovide a cache for global use.
Definition: cache_mngt.c:359
nl_cache_ops_set_flags
void nl_cache_ops_set_flags(struct nl_cache_ops *, unsigned int)
Set default flags for caches of this type.
Definition: cache_mngt.c:230
nl_cache_ops_associate
struct nl_cache_ops * nl_cache_ops_associate(int, int)
Associate protocol and message type to cache operations.
Definition: cache_mngt.c:134
nl_cache_mngt_require
struct nl_cache * nl_cache_mngt_require(const char *)
Return cache previously provided via nl_cache_mngt_provide()
Definition: cache_mngt.c:402
nl_cache_ops_lookup
struct nl_cache_ops * nl_cache_ops_lookup(const char *)
Lookup cache operations by name.
Definition: cache_mngt.c:73
nl_cache_mngt_provide
void nl_cache_mngt_provide(struct nl_cache *)
Provide a cache for global use.
Definition: cache_mngt.c:326
nl_cache_ops_get
void nl_cache_ops_get(struct nl_cache_ops *)
Increment reference counter.
Definition: cache_mngt.c:50
nl_msgtype_lookup
struct nl_msgtype * nl_msgtype_lookup(struct nl_cache_ops *, int)
Lookup message type cache association.
Definition: cache_mngt.c:183
nl_cache_mngt_require_safe
struct nl_cache * nl_cache_mngt_require_safe(const char *)
Return cache previously provided via nl_cache_mngt_provide()
Definition: cache_mngt.c:424
nl_cache_ops_lookup_safe
struct nl_cache_ops * nl_cache_ops_lookup_safe(const char *)
Lookup cache operations by name.
Definition: cache_mngt.c:93
nl_cache_ops_associate_safe
struct nl_cache_ops * nl_cache_ops_associate_safe(int, int)
Associate protocol and message type to cache operations.
Definition: cache_mngt.c:158
nl_cache_ops_put
void nl_cache_ops_put(struct nl_cache_ops *)
Decrement reference counter.
Definition: cache_mngt.c:59
nl_cache_refill
int nl_cache_refill(struct nl_sock *, struct nl_cache *)
(Re)fill a cache with the contents in the kernel.
Definition: cache.c:1035
nl_cache_set_flags
void nl_cache_set_flags(struct nl_cache *, unsigned int)
Set cache flags.
Definition: cache.c:608
nl_cache_set_arg1
void nl_cache_set_arg1(struct nl_cache *, int)
Set synchronization arg1 of cache.
Definition: cache.c:585
nl_cache_search
struct nl_object * nl_cache_search(struct nl_cache *, struct nl_object *)
Search object in cache.
Definition: cache.c:1108
nl_cache_foreach
void nl_cache_foreach(struct nl_cache *, void(*cb)(struct nl_object *, void *), void *arg)
Call a callback on each element of the cache.
Definition: cache.c:1277
nl_cache_nitems
int nl_cache_nitems(struct nl_cache *)
Return the number of items in the cache.
Definition: cache.c:63
nl_cache_find
struct nl_object * nl_cache_find(struct nl_cache *, struct nl_object *)
Find object in cache.
Definition: cache.c:1143
nl_cache_free
void nl_cache_free(struct nl_cache *)
Free a cache.
Definition: cache.c:403
nl_cache_get
void nl_cache_get(struct nl_cache *)
Increase reference counter of cache.
Definition: cache.c:386
nl_cache_nitems_filter
int nl_cache_nitems_filter(struct nl_cache *, struct nl_object *)
Return the number of items matching a filter in the cache.
Definition: cache.c:73
nl_cache_dump_filter
void nl_cache_dump_filter(struct nl_cache *, struct nl_dump_params *, struct nl_object *)
Dump all elements of a cache (filtered).
Definition: cache.c:1211
nl_cache_add
int nl_cache_add(struct nl_cache *, struct nl_object *)
Add object to cache.
Definition: cache.c:474
nl_cache_foreach_filter
void nl_cache_foreach_filter(struct nl_cache *, struct nl_object *, void(*cb)(struct nl_object *, void *), void *arg)
Call a callback on each element of the cache (filtered).
Definition: cache.c:1294
nl_cache_pickup
int nl_cache_pickup(struct nl_sock *, struct nl_cache *)
Pickup a netlink dump response and put it into a cache.
Definition: cache.c:776
nl_cache_parse_and_add
int nl_cache_parse_and_add(struct nl_cache *, struct nl_msg *)
Parse a netlink message and add it to the cache.
Definition: cache.c:1015
nl_cache_get_last
struct nl_object * nl_cache_get_last(struct nl_cache *)
Return the last element in the cache.
Definition: cache.c:127
nl_cache_alloc
struct nl_cache * nl_cache_alloc(struct nl_cache_ops *)
Allocate new cache.
Definition: cache.c:178
nl_cache_get_next
struct nl_object * nl_cache_get_next(struct nl_object *)
Return the next element in the cache.
Definition: cache.c:140
nl_cache_remove
void nl_cache_remove(struct nl_object *)
Remove object from cache.
Definition: cache.c:546
nl_cache_dump
void nl_cache_dump(struct nl_cache *, struct nl_dump_params *)
Dump all elements of a cache.
Definition: cache.c:1197
nl_cache_is_empty
int nl_cache_is_empty(struct nl_cache *)
Returns true if the cache is empty.
Definition: cache.c:96
nl_cache_alloc_and_fill
int nl_cache_alloc_and_fill(struct nl_cache_ops *, struct nl_sock *, struct nl_cache **)
Allocate new cache and fill it.
Definition: cache.c:228
nl_cache_get_first
struct nl_object * nl_cache_get_first(struct nl_cache *)
Return the first element in the cache.
Definition: cache.c:114
nl_cache_pickup_checkdup
int nl_cache_pickup_checkdup(struct nl_sock *, struct nl_cache *)
Pickup a netlink dump response and put it into a cache.
Definition: cache.c:761
nl_cache_get_prev
struct nl_object * nl_cache_get_prev(struct nl_object *)
Return the previous element in the cache.
Definition: cache.c:153
nl_cache_subset
struct nl_cache * nl_cache_subset(struct nl_cache *, struct nl_object *)
Allocate new cache containing a subset of an existing cache.
Definition: cache.c:292
nl_cache_alloc_name
int nl_cache_alloc_name(const char *, struct nl_cache **)
Allocate new cache based on type name.
Definition: cache.c:259
nl_cache_clear
void nl_cache_clear(struct nl_cache *)
Remove all objects of a cache.
Definition: cache.c:361
nl_cache_clone
struct nl_cache * nl_cache_clone(struct nl_cache *)
Allocate new cache and copy the contents of an existing cache.
Definition: cache.c:332
nl_cache_set_arg2
void nl_cache_set_arg2(struct nl_cache *, int)
Set synchronization arg2 of cache.
Definition: cache.c:598
nl_cache_get_ops
struct nl_cache_ops * nl_cache_get_ops(struct nl_cache *)
Return the operations set of the cache.
Definition: cache.c:105
nl_cache_move
int nl_cache_move(struct nl_cache *, struct nl_object *)
Move object from one cache to another.
Definition: cache.c:518
nl_cache_mark_all
void nl_cache_mark_all(struct nl_cache *)
Mark all objects of a cache.
Definition: cache.c:1172
nl_dump_params
Dumping parameters.
Definition: types.h:28