Commit | Line | Data |
---|---|---|
482a8524 TG |
1 | #ifndef __NET_GENERIC_NETLINK_H |
2 | #define __NET_GENERIC_NETLINK_H | |
3 | ||
4 | #include <linux/genetlink.h> | |
5 | #include <net/netlink.h> | |
134e6375 | 6 | #include <net/net_namespace.h> |
482a8524 | 7 | |
58050fce TG |
8 | #define GENLMSG_DEFAULT_SIZE (NLMSG_DEFAULT_SIZE - GENL_HDRLEN) |
9 | ||
2dbba6f7 JB |
10 | /** |
11 | * struct genl_multicast_group - generic netlink multicast group | |
12 | * @name: name of the multicast group, names are per-family | |
13 | * @id: multicast group ID, assigned by the core, to use with | |
14 | * genlmsg_multicast(). | |
15 | * @list: list entry for linking | |
16 | * @family: pointer to family, need not be set before registering | |
17 | */ | |
fd2c3ef7 | 18 | struct genl_multicast_group { |
2dbba6f7 JB |
19 | struct genl_family *family; /* private */ |
20 | struct list_head list; /* private */ | |
21 | char name[GENL_NAMSIZ]; | |
22 | u32 id; | |
23 | }; | |
24 | ||
ff4c92d8 JB |
25 | struct genl_ops; |
26 | struct genl_info; | |
27 | ||
482a8524 TG |
28 | /** |
29 | * struct genl_family - generic netlink family | |
30 | * @id: protocol family idenfitier | |
31 | * @hdrsize: length of user specific header in bytes | |
32 | * @name: name of family | |
33 | * @version: protocol version | |
34 | * @maxattr: maximum number of attributes supported | |
134e6375 JB |
35 | * @netnsok: set to true if the family can handle network |
36 | * namespaces and should be presented in all of them | |
ff4c92d8 JB |
37 | * @pre_doit: called before an operation's doit callback, it may |
38 | * do additional, common, filtering and return an error | |
39 | * @post_doit: called after an operation's doit callback, it may | |
40 | * undo operations done by pre_doit, for example release locks | |
482a8524 | 41 | * @attrbuf: buffer to store parsed attributes |
482a8524 | 42 | * @family_list: family list |
2dbba6f7 | 43 | * @mcast_groups: multicast groups list |
d91824c0 JB |
44 | * @ops: the operations supported by this family (private) |
45 | * @n_ops: number of operations supported by this family (private) | |
482a8524 | 46 | */ |
fd2c3ef7 | 47 | struct genl_family { |
482a8524 TG |
48 | unsigned int id; |
49 | unsigned int hdrsize; | |
50 | char name[GENL_NAMSIZ]; | |
51 | unsigned int version; | |
52 | unsigned int maxattr; | |
134e6375 | 53 | bool netnsok; |
def31174 | 54 | bool parallel_ops; |
f84f771d | 55 | int (*pre_doit)(const struct genl_ops *ops, |
ff4c92d8 JB |
56 | struct sk_buff *skb, |
57 | struct genl_info *info); | |
f84f771d | 58 | void (*post_doit)(const struct genl_ops *ops, |
ff4c92d8 JB |
59 | struct sk_buff *skb, |
60 | struct genl_info *info); | |
482a8524 | 61 | struct nlattr ** attrbuf; /* private */ |
f84f771d | 62 | const struct genl_ops * ops; /* private */ |
d91824c0 | 63 | unsigned int n_ops; /* private */ |
482a8524 | 64 | struct list_head family_list; /* private */ |
2dbba6f7 | 65 | struct list_head mcast_groups; /* private */ |
33c6b1f6 | 66 | struct module *module; |
482a8524 TG |
67 | }; |
68 | ||
482a8524 TG |
69 | /** |
70 | * struct genl_info - receiving information | |
71 | * @snd_seq: sending sequence number | |
15e47304 | 72 | * @snd_portid: netlink portid of sender |
482a8524 TG |
73 | * @nlhdr: netlink message header |
74 | * @genlhdr: generic netlink message header | |
75 | * @userhdr: user specific header | |
76 | * @attrs: netlink attributes | |
ff4c92d8 JB |
77 | * @_net: network namespace |
78 | * @user_ptr: user pointers | |
482a8524 | 79 | */ |
fd2c3ef7 | 80 | struct genl_info { |
482a8524 | 81 | u32 snd_seq; |
15e47304 | 82 | u32 snd_portid; |
482a8524 TG |
83 | struct nlmsghdr * nlhdr; |
84 | struct genlmsghdr * genlhdr; | |
85 | void * userhdr; | |
86 | struct nlattr ** attrs; | |
134e6375 JB |
87 | #ifdef CONFIG_NET_NS |
88 | struct net * _net; | |
89 | #endif | |
ff4c92d8 | 90 | void * user_ptr[2]; |
482a8524 TG |
91 | }; |
92 | ||
134e6375 JB |
93 | static inline struct net *genl_info_net(struct genl_info *info) |
94 | { | |
c2d9ba9b | 95 | return read_pnet(&info->_net); |
134e6375 JB |
96 | } |
97 | ||
98 | static inline void genl_info_net_set(struct genl_info *info, struct net *net) | |
99 | { | |
c2d9ba9b | 100 | write_pnet(&info->_net, net); |
134e6375 | 101 | } |
134e6375 | 102 | |
482a8524 TG |
103 | /** |
104 | * struct genl_ops - generic netlink operations | |
105 | * @cmd: command identifier | |
ff4c92d8 | 106 | * @internal_flags: flags used by the family |
482a8524 TG |
107 | * @flags: flags |
108 | * @policy: attribute validation policy | |
109 | * @doit: standard command callback | |
110 | * @dumpit: callback for dumpers | |
a4d1366d | 111 | * @done: completion callback for dumps |
482a8524 TG |
112 | * @ops_list: operations list |
113 | */ | |
fd2c3ef7 | 114 | struct genl_ops { |
ef7c79ed | 115 | const struct nla_policy *policy; |
482a8524 TG |
116 | int (*doit)(struct sk_buff *skb, |
117 | struct genl_info *info); | |
118 | int (*dumpit)(struct sk_buff *skb, | |
119 | struct netlink_callback *cb); | |
a4d1366d | 120 | int (*done)(struct netlink_callback *cb); |
3f5ccd06 JB |
121 | u8 cmd; |
122 | u8 internal_flags; | |
123 | u8 flags; | |
482a8524 TG |
124 | }; |
125 | ||
ff2b94d2 | 126 | int __genl_register_family(struct genl_family *family); |
33c6b1f6 PS |
127 | |
128 | static inline int genl_register_family(struct genl_family *family) | |
129 | { | |
130 | family->module = THIS_MODULE; | |
131 | return __genl_register_family(family); | |
132 | } | |
133 | ||
568508aa JB |
134 | /** |
135 | * genl_register_family_with_ops - register a generic netlink family with ops | |
136 | * @family: generic netlink family | |
137 | * @ops: operations to be registered | |
138 | * @n_ops: number of elements to register | |
139 | * | |
140 | * Registers the specified family and operations from the specified table. | |
141 | * Only one family may be registered with the same family name or identifier. | |
142 | * | |
143 | * The family id may equal GENL_ID_GENERATE causing an unique id to | |
144 | * be automatically generated and assigned. | |
145 | * | |
146 | * Either a doit or dumpit callback must be specified for every registered | |
147 | * operation or the function will fail. Only one operation structure per | |
148 | * command identifier may be registered. | |
149 | * | |
150 | * See include/net/genetlink.h for more documenation on the operations | |
151 | * structure. | |
152 | * | |
153 | * Return 0 on success or a negative error code. | |
154 | */ | |
33c6b1f6 | 155 | static inline int genl_register_family_with_ops(struct genl_family *family, |
f84f771d | 156 | const struct genl_ops *ops, size_t n_ops) |
33c6b1f6 PS |
157 | { |
158 | family->module = THIS_MODULE; | |
568508aa JB |
159 | family->ops = ops; |
160 | family->n_ops = n_ops; | |
161 | return __genl_register_family(family); | |
33c6b1f6 PS |
162 | } |
163 | ||
ff2b94d2 | 164 | int genl_unregister_family(struct genl_family *family); |
ff2b94d2 JP |
165 | int genl_register_mc_group(struct genl_family *family, |
166 | struct genl_multicast_group *grp); | |
167 | void genl_unregister_mc_group(struct genl_family *family, | |
168 | struct genl_multicast_group *grp); | |
169 | void genl_notify(struct sk_buff *skb, struct net *net, u32 portid, | |
170 | u32 group, struct nlmsghdr *nlh, gfp_t flags); | |
482a8524 | 171 | |
15e47304 | 172 | void *genlmsg_put(struct sk_buff *skb, u32 portid, u32 seq, |
ff2b94d2 | 173 | struct genl_family *family, int flags, u8 cmd); |
482a8524 | 174 | |
670dc283 JB |
175 | /** |
176 | * genlmsg_nlhdr - Obtain netlink header from user specified header | |
177 | * @user_hdr: user header as returned from genlmsg_put() | |
178 | * @family: generic netlink family | |
179 | * | |
180 | * Returns pointer to netlink header. | |
181 | */ | |
182 | static inline struct nlmsghdr *genlmsg_nlhdr(void *user_hdr, | |
183 | struct genl_family *family) | |
184 | { | |
185 | return (struct nlmsghdr *)((char *)user_hdr - | |
186 | family->hdrsize - | |
187 | GENL_HDRLEN - | |
188 | NLMSG_HDRLEN); | |
189 | } | |
190 | ||
191 | /** | |
192 | * genl_dump_check_consistent - check if sequence is consistent and advertise if not | |
193 | * @cb: netlink callback structure that stores the sequence number | |
194 | * @user_hdr: user header as returned from genlmsg_put() | |
195 | * @family: generic netlink family | |
196 | * | |
197 | * Cf. nl_dump_check_consistent(), this just provides a wrapper to make it | |
198 | * simpler to use with generic netlink. | |
199 | */ | |
200 | static inline void genl_dump_check_consistent(struct netlink_callback *cb, | |
201 | void *user_hdr, | |
202 | struct genl_family *family) | |
203 | { | |
204 | nl_dump_check_consistent(cb, genlmsg_nlhdr(user_hdr, family)); | |
205 | } | |
206 | ||
17c157c8 TG |
207 | /** |
208 | * genlmsg_put_reply - Add generic netlink header to a reply message | |
209 | * @skb: socket buffer holding the message | |
210 | * @info: receiver info | |
211 | * @family: generic netlink family | |
212 | * @flags: netlink message flags | |
213 | * @cmd: generic netlink command | |
214 | * | |
215 | * Returns pointer to user specific header | |
216 | */ | |
217 | static inline void *genlmsg_put_reply(struct sk_buff *skb, | |
218 | struct genl_info *info, | |
219 | struct genl_family *family, | |
220 | int flags, u8 cmd) | |
221 | { | |
15e47304 | 222 | return genlmsg_put(skb, info->snd_portid, info->snd_seq, family, |
17c157c8 TG |
223 | flags, cmd); |
224 | } | |
225 | ||
482a8524 TG |
226 | /** |
227 | * genlmsg_end - Finalize a generic netlink message | |
228 | * @skb: socket buffer the message is stored in | |
229 | * @hdr: user specific header | |
230 | */ | |
231 | static inline int genlmsg_end(struct sk_buff *skb, void *hdr) | |
232 | { | |
233 | return nlmsg_end(skb, hdr - GENL_HDRLEN - NLMSG_HDRLEN); | |
234 | } | |
235 | ||
236 | /** | |
237 | * genlmsg_cancel - Cancel construction of a generic netlink message | |
238 | * @skb: socket buffer the message is stored in | |
239 | * @hdr: generic netlink message header | |
240 | */ | |
bc3ed28c | 241 | static inline void genlmsg_cancel(struct sk_buff *skb, void *hdr) |
482a8524 | 242 | { |
38db9e1d JL |
243 | if (hdr) |
244 | nlmsg_cancel(skb, hdr - GENL_HDRLEN - NLMSG_HDRLEN); | |
482a8524 TG |
245 | } |
246 | ||
247 | /** | |
134e6375 JB |
248 | * genlmsg_multicast_netns - multicast a netlink message to a specific netns |
249 | * @net: the net namespace | |
250 | * @skb: netlink message as socket buffer | |
15e47304 | 251 | * @portid: own netlink portid to avoid sending to yourself |
134e6375 JB |
252 | * @group: multicast group id |
253 | * @flags: allocation flags | |
254 | */ | |
255 | static inline int genlmsg_multicast_netns(struct net *net, struct sk_buff *skb, | |
15e47304 | 256 | u32 portid, unsigned int group, gfp_t flags) |
134e6375 | 257 | { |
15e47304 | 258 | return nlmsg_multicast(net->genl_sock, skb, portid, group, flags); |
134e6375 JB |
259 | } |
260 | ||
261 | /** | |
262 | * genlmsg_multicast - multicast a netlink message to the default netns | |
482a8524 | 263 | * @skb: netlink message as socket buffer |
15e47304 | 264 | * @portid: own netlink portid to avoid sending to yourself |
482a8524 | 265 | * @group: multicast group id |
d387f6ad | 266 | * @flags: allocation flags |
482a8524 | 267 | */ |
15e47304 | 268 | static inline int genlmsg_multicast(struct sk_buff *skb, u32 portid, |
d387f6ad | 269 | unsigned int group, gfp_t flags) |
482a8524 | 270 | { |
15e47304 | 271 | return genlmsg_multicast_netns(&init_net, skb, portid, group, flags); |
482a8524 TG |
272 | } |
273 | ||
134e6375 JB |
274 | /** |
275 | * genlmsg_multicast_allns - multicast a netlink message to all net namespaces | |
276 | * @skb: netlink message as socket buffer | |
15e47304 | 277 | * @portid: own netlink portid to avoid sending to yourself |
134e6375 JB |
278 | * @group: multicast group id |
279 | * @flags: allocation flags | |
280 | * | |
281 | * This function must hold the RTNL or rcu_read_lock(). | |
282 | */ | |
15e47304 | 283 | int genlmsg_multicast_allns(struct sk_buff *skb, u32 portid, |
134e6375 JB |
284 | unsigned int group, gfp_t flags); |
285 | ||
482a8524 TG |
286 | /** |
287 | * genlmsg_unicast - unicast a netlink message | |
288 | * @skb: netlink message as socket buffer | |
15e47304 | 289 | * @portid: netlink portid of the destination socket |
482a8524 | 290 | */ |
15e47304 | 291 | static inline int genlmsg_unicast(struct net *net, struct sk_buff *skb, u32 portid) |
482a8524 | 292 | { |
15e47304 | 293 | return nlmsg_unicast(net->genl_sock, skb, portid); |
482a8524 TG |
294 | } |
295 | ||
81878d27 TG |
296 | /** |
297 | * genlmsg_reply - reply to a request | |
298 | * @skb: netlink message to be sent back | |
299 | * @info: receiver information | |
300 | */ | |
301 | static inline int genlmsg_reply(struct sk_buff *skb, struct genl_info *info) | |
302 | { | |
15e47304 | 303 | return genlmsg_unicast(genl_info_net(info), skb, info->snd_portid); |
81878d27 TG |
304 | } |
305 | ||
fb0ba6bd BS |
306 | /** |
307 | * gennlmsg_data - head of message payload | |
70f23fd6 | 308 | * @gnlh: genetlink message header |
fb0ba6bd BS |
309 | */ |
310 | static inline void *genlmsg_data(const struct genlmsghdr *gnlh) | |
311 | { | |
312 | return ((unsigned char *) gnlh + GENL_HDRLEN); | |
313 | } | |
314 | ||
315 | /** | |
316 | * genlmsg_len - length of message payload | |
317 | * @gnlh: genetlink message header | |
318 | */ | |
319 | static inline int genlmsg_len(const struct genlmsghdr *gnlh) | |
320 | { | |
321 | struct nlmsghdr *nlh = (struct nlmsghdr *)((unsigned char *)gnlh - | |
322 | NLMSG_HDRLEN); | |
323 | return (nlh->nlmsg_len - GENL_HDRLEN - NLMSG_HDRLEN); | |
324 | } | |
325 | ||
17db952c BS |
326 | /** |
327 | * genlmsg_msg_size - length of genetlink message not including padding | |
328 | * @payload: length of message payload | |
329 | */ | |
330 | static inline int genlmsg_msg_size(int payload) | |
331 | { | |
332 | return GENL_HDRLEN + payload; | |
333 | } | |
334 | ||
335 | /** | |
336 | * genlmsg_total_size - length of genetlink message including padding | |
337 | * @payload: length of message payload | |
338 | */ | |
339 | static inline int genlmsg_total_size(int payload) | |
340 | { | |
341 | return NLMSG_ALIGN(genlmsg_msg_size(payload)); | |
342 | } | |
343 | ||
3dabc715 TG |
344 | /** |
345 | * genlmsg_new - Allocate a new generic netlink message | |
346 | * @payload: size of the message payload | |
347 | * @flags: the type of memory to allocate. | |
348 | */ | |
349 | static inline struct sk_buff *genlmsg_new(size_t payload, gfp_t flags) | |
350 | { | |
351 | return nlmsg_new(genlmsg_total_size(payload), flags); | |
352 | } | |
353 | ||
354 | ||
482a8524 | 355 | #endif /* __NET_GENERIC_NETLINK_H */ |