1
2#ifndef __NET_GENERIC_NETLINK_H
3#define __NET_GENERIC_NETLINK_H
4
5#include <linux/genetlink.h>
6#include <net/netlink.h>
7#include <net/net_namespace.h>
8
9#define GENLMSG_DEFAULT_SIZE (NLMSG_DEFAULT_SIZE - GENL_HDRLEN)
10
11
12
13
14
15struct genl_multicast_group {
16 char name[GENL_NAMSIZ];
17};
18
19struct genl_ops;
20struct genl_info;
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52struct genl_family {
53 int id;
54 unsigned int hdrsize;
55 char name[GENL_NAMSIZ];
56 unsigned int version;
57 unsigned int maxattr;
58 bool netnsok;
59 bool parallel_ops;
60 const struct nla_policy *policy;
61 int (*pre_doit)(const struct genl_ops *ops,
62 struct sk_buff *skb,
63 struct genl_info *info);
64 void (*post_doit)(const struct genl_ops *ops,
65 struct sk_buff *skb,
66 struct genl_info *info);
67 int (*mcast_bind)(struct net *net, int group);
68 void (*mcast_unbind)(struct net *net, int group);
69 struct nlattr ** attrbuf;
70 const struct genl_ops * ops;
71 const struct genl_multicast_group *mcgrps;
72 unsigned int n_ops;
73 unsigned int n_mcgrps;
74 unsigned int mcgrp_offset;
75 struct module *module;
76};
77
78
79
80
81
82
83
84
85
86
87
88
89
90struct genl_info {
91 u32 snd_seq;
92 u32 snd_portid;
93 struct nlmsghdr * nlhdr;
94 struct genlmsghdr * genlhdr;
95 void * userhdr;
96 struct nlattr ** attrs;
97 possible_net_t _net;
98 void * user_ptr[2];
99 struct netlink_ext_ack *extack;
100};
101
102static inline struct net *genl_info_net(struct genl_info *info)
103{
104 return read_pnet(&info->_net);
105}
106
107static inline void genl_info_net_set(struct genl_info *info, struct net *net)
108{
109 write_pnet(&info->_net, net);
110}
111
112#define GENL_SET_ERR_MSG(info, msg) NL_SET_ERR_MSG((info)->extack, msg)
113
114static inline int genl_err_attr(struct genl_info *info, int err,
115 const struct nlattr *attr)
116{
117 info->extack->bad_attr = attr;
118
119 return err;
120}
121
122enum genl_validate_flags {
123 GENL_DONT_VALIDATE_STRICT = BIT(0),
124 GENL_DONT_VALIDATE_DUMP = BIT(1),
125 GENL_DONT_VALIDATE_DUMP_STRICT = BIT(2),
126};
127
128
129
130
131
132
133
134struct genl_dumpit_info {
135 const struct genl_family *family;
136 const struct genl_ops *ops;
137 struct nlattr **attrs;
138};
139
140static inline const struct genl_dumpit_info *
141genl_dumpit_info(struct netlink_callback *cb)
142{
143 return cb->data;
144}
145
146
147
148
149
150
151
152
153
154
155
156struct genl_ops {
157 int (*doit)(struct sk_buff *skb,
158 struct genl_info *info);
159 int (*start)(struct netlink_callback *cb);
160 int (*dumpit)(struct sk_buff *skb,
161 struct netlink_callback *cb);
162 int (*done)(struct netlink_callback *cb);
163 u8 cmd;
164 u8 internal_flags;
165 u8 flags;
166 u8 validate;
167};
168
169int genl_register_family(struct genl_family *family);
170int genl_unregister_family(const struct genl_family *family);
171void genl_notify(const struct genl_family *family, struct sk_buff *skb,
172 struct genl_info *info, u32 group, gfp_t flags);
173
174void *genlmsg_put(struct sk_buff *skb, u32 portid, u32 seq,
175 const struct genl_family *family, int flags, u8 cmd);
176
177
178
179
180
181
182
183static inline struct nlmsghdr *genlmsg_nlhdr(void *user_hdr)
184{
185 return (struct nlmsghdr *)((char *)user_hdr -
186 GENL_HDRLEN -
187 NLMSG_HDRLEN);
188}
189
190
191
192
193
194
195
196
197
198
199static inline int genlmsg_parse_deprecated(const struct nlmsghdr *nlh,
200 const struct genl_family *family,
201 struct nlattr *tb[], int maxtype,
202 const struct nla_policy *policy,
203 struct netlink_ext_ack *extack)
204{
205 return __nlmsg_parse(nlh, family->hdrsize + GENL_HDRLEN, tb, maxtype,
206 policy, NL_VALIDATE_LIBERAL, extack);
207}
208
209
210
211
212
213
214
215
216
217
218static inline int genlmsg_parse(const struct nlmsghdr *nlh,
219 const struct genl_family *family,
220 struct nlattr *tb[], int maxtype,
221 const struct nla_policy *policy,
222 struct netlink_ext_ack *extack)
223{
224 return __nlmsg_parse(nlh, family->hdrsize + GENL_HDRLEN, tb, maxtype,
225 policy, NL_VALIDATE_STRICT, extack);
226}
227
228
229
230
231
232
233
234
235
236static inline void genl_dump_check_consistent(struct netlink_callback *cb,
237 void *user_hdr)
238{
239 nl_dump_check_consistent(cb, genlmsg_nlhdr(user_hdr));
240}
241
242
243
244
245
246
247
248
249
250
251
252static inline void *genlmsg_put_reply(struct sk_buff *skb,
253 struct genl_info *info,
254 const struct genl_family *family,
255 int flags, u8 cmd)
256{
257 return genlmsg_put(skb, info->snd_portid, info->snd_seq, family,
258 flags, cmd);
259}
260
261
262
263
264
265
266static inline void genlmsg_end(struct sk_buff *skb, void *hdr)
267{
268 nlmsg_end(skb, hdr - GENL_HDRLEN - NLMSG_HDRLEN);
269}
270
271
272
273
274
275
276static inline void genlmsg_cancel(struct sk_buff *skb, void *hdr)
277{
278 if (hdr)
279 nlmsg_cancel(skb, hdr - GENL_HDRLEN - NLMSG_HDRLEN);
280}
281
282
283
284
285
286
287
288
289
290
291static inline int genlmsg_multicast_netns(const struct genl_family *family,
292 struct net *net, struct sk_buff *skb,
293 u32 portid, unsigned int group, gfp_t flags)
294{
295 if (WARN_ON_ONCE(group >= family->n_mcgrps))
296 return -EINVAL;
297 group = family->mcgrp_offset + group;
298 return nlmsg_multicast(net->genl_sock, skb, portid, group, flags);
299}
300
301
302
303
304
305
306
307
308
309static inline int genlmsg_multicast(const struct genl_family *family,
310 struct sk_buff *skb, u32 portid,
311 unsigned int group, gfp_t flags)
312{
313 return genlmsg_multicast_netns(family, &init_net, skb,
314 portid, group, flags);
315}
316
317
318
319
320
321
322
323
324
325
326
327int genlmsg_multicast_allns(const struct genl_family *family,
328 struct sk_buff *skb, u32 portid,
329 unsigned int group, gfp_t flags);
330
331
332
333
334
335
336static inline int genlmsg_unicast(struct net *net, struct sk_buff *skb, u32 portid)
337{
338 return nlmsg_unicast(net->genl_sock, skb, portid);
339}
340
341
342
343
344
345
346static inline int genlmsg_reply(struct sk_buff *skb, struct genl_info *info)
347{
348 return genlmsg_unicast(genl_info_net(info), skb, info->snd_portid);
349}
350
351
352
353
354
355static inline void *genlmsg_data(const struct genlmsghdr *gnlh)
356{
357 return ((unsigned char *) gnlh + GENL_HDRLEN);
358}
359
360
361
362
363
364static inline int genlmsg_len(const struct genlmsghdr *gnlh)
365{
366 struct nlmsghdr *nlh = (struct nlmsghdr *)((unsigned char *)gnlh -
367 NLMSG_HDRLEN);
368 return (nlh->nlmsg_len - GENL_HDRLEN - NLMSG_HDRLEN);
369}
370
371
372
373
374
375static inline int genlmsg_msg_size(int payload)
376{
377 return GENL_HDRLEN + payload;
378}
379
380
381
382
383
384static inline int genlmsg_total_size(int payload)
385{
386 return NLMSG_ALIGN(genlmsg_msg_size(payload));
387}
388
389
390
391
392
393
394static inline struct sk_buff *genlmsg_new(size_t payload, gfp_t flags)
395{
396 return nlmsg_new(genlmsg_total_size(payload), flags);
397}
398
399
400
401
402
403
404
405
406
407
408
409
410
411static inline int genl_set_err(const struct genl_family *family,
412 struct net *net, u32 portid,
413 u32 group, int code)
414{
415 if (WARN_ON_ONCE(group >= family->n_mcgrps))
416 return -EINVAL;
417 group = family->mcgrp_offset + group;
418 return netlink_set_err(net->genl_sock, portid, group, code);
419}
420
421static inline int genl_has_listeners(const struct genl_family *family,
422 struct net *net, unsigned int group)
423{
424 if (WARN_ON_ONCE(group >= family->n_mcgrps))
425 return -EINVAL;
426 group = family->mcgrp_offset + group;
427 return netlink_has_listeners(net->genl_sock, group);
428}
429#endif
430