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