1 #ifndef __NET_GENERIC_NETLINK_H
2 #define __NET_GENERIC_NETLINK_H
4 #include <linux/genetlink.h>
5 #include <net/netlink.h>
6 #include <net/net_namespace.h>
8 #define GENLMSG_DEFAULT_SIZE (NLMSG_DEFAULT_SIZE - GENL_HDRLEN)
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
18 struct genl_multicast_group
{
19 struct genl_family
*family
; /* private */
20 struct list_head list
; /* private */
21 char name
[GENL_NAMSIZ
];
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
35 * @netnsok: set to true if the family can handle network
36 * namespaces and should be presented in all of them
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
41 * @attrbuf: buffer to store parsed attributes
42 * @ops_list: list of all assigned operations
43 * @family_list: family list
44 * @mcast_groups: multicast groups list
49 char name
[GENL_NAMSIZ
];
54 int (*pre_doit
)(struct genl_ops
*ops
,
56 struct genl_info
*info
);
57 void (*post_doit
)(struct genl_ops
*ops
,
59 struct genl_info
*info
);
60 struct nlattr
** attrbuf
; /* private */
61 struct list_head ops_list
; /* private */
62 struct list_head family_list
; /* private */
63 struct list_head mcast_groups
; /* private */
67 * struct genl_info - receiving information
68 * @snd_seq: sending sequence number
69 * @snd_portid: netlink portid of sender
70 * @nlhdr: netlink message header
71 * @genlhdr: generic netlink message header
72 * @userhdr: user specific header
73 * @attrs: netlink attributes
74 * @_net: network namespace
75 * @user_ptr: user pointers
80 struct nlmsghdr
* nlhdr
;
81 struct genlmsghdr
* genlhdr
;
83 struct nlattr
** attrs
;
90 static inline struct net
*genl_info_net(struct genl_info
*info
)
92 return read_pnet(&info
->_net
);
95 static inline void genl_info_net_set(struct genl_info
*info
, struct net
*net
)
97 write_pnet(&info
->_net
, net
);
101 * struct genl_ops - generic netlink operations
102 * @cmd: command identifier
103 * @internal_flags: flags used by the family
105 * @policy: attribute validation policy
106 * @doit: standard command callback
107 * @dumpit: callback for dumpers
108 * @done: completion callback for dumps
109 * @ops_list: operations list
115 const struct nla_policy
*policy
;
116 int (*doit
)(struct sk_buff
*skb
,
117 struct genl_info
*info
);
118 int (*dumpit
)(struct sk_buff
*skb
,
119 struct netlink_callback
*cb
);
120 int (*done
)(struct netlink_callback
*cb
);
121 struct list_head ops_list
;
124 extern int genl_register_family(struct genl_family
*family
);
125 extern int genl_register_family_with_ops(struct genl_family
*family
,
126 struct genl_ops
*ops
, size_t n_ops
);
127 extern int genl_unregister_family(struct genl_family
*family
);
128 extern int genl_register_ops(struct genl_family
*, struct genl_ops
*ops
);
129 extern int genl_unregister_ops(struct genl_family
*, struct genl_ops
*ops
);
130 extern int genl_register_mc_group(struct genl_family
*family
,
131 struct genl_multicast_group
*grp
);
132 extern void genl_unregister_mc_group(struct genl_family
*family
,
133 struct genl_multicast_group
*grp
);
134 extern void genl_notify(struct sk_buff
*skb
, struct net
*net
, u32 portid
,
135 u32 group
, struct nlmsghdr
*nlh
, gfp_t flags
);
137 void *genlmsg_put(struct sk_buff
*skb
, u32 portid
, u32 seq
,
138 struct genl_family
*family
, int flags
, u8 cmd
);
141 * genlmsg_nlhdr - Obtain netlink header from user specified header
142 * @user_hdr: user header as returned from genlmsg_put()
143 * @family: generic netlink family
145 * Returns pointer to netlink header.
147 static inline struct nlmsghdr
*genlmsg_nlhdr(void *user_hdr
,
148 struct genl_family
*family
)
150 return (struct nlmsghdr
*)((char *)user_hdr
-
157 * genl_dump_check_consistent - check if sequence is consistent and advertise if not
158 * @cb: netlink callback structure that stores the sequence number
159 * @user_hdr: user header as returned from genlmsg_put()
160 * @family: generic netlink family
162 * Cf. nl_dump_check_consistent(), this just provides a wrapper to make it
163 * simpler to use with generic netlink.
165 static inline void genl_dump_check_consistent(struct netlink_callback
*cb
,
167 struct genl_family
*family
)
169 nl_dump_check_consistent(cb
, genlmsg_nlhdr(user_hdr
, family
));
173 * genlmsg_put_reply - Add generic netlink header to a reply message
174 * @skb: socket buffer holding the message
175 * @info: receiver info
176 * @family: generic netlink family
177 * @flags: netlink message flags
178 * @cmd: generic netlink command
180 * Returns pointer to user specific header
182 static inline void *genlmsg_put_reply(struct sk_buff
*skb
,
183 struct genl_info
*info
,
184 struct genl_family
*family
,
187 return genlmsg_put(skb
, info
->snd_portid
, info
->snd_seq
, family
,
192 * genlmsg_end - Finalize a generic netlink message
193 * @skb: socket buffer the message is stored in
194 * @hdr: user specific header
196 static inline int genlmsg_end(struct sk_buff
*skb
, void *hdr
)
198 return nlmsg_end(skb
, hdr
- GENL_HDRLEN
- NLMSG_HDRLEN
);
202 * genlmsg_cancel - Cancel construction of a generic netlink message
203 * @skb: socket buffer the message is stored in
204 * @hdr: generic netlink message header
206 static inline void genlmsg_cancel(struct sk_buff
*skb
, void *hdr
)
209 nlmsg_cancel(skb
, hdr
- GENL_HDRLEN
- NLMSG_HDRLEN
);
213 * genlmsg_multicast_netns - multicast a netlink message to a specific netns
214 * @net: the net namespace
215 * @skb: netlink message as socket buffer
216 * @portid: own netlink portid to avoid sending to yourself
217 * @group: multicast group id
218 * @flags: allocation flags
220 static inline int genlmsg_multicast_netns(struct net
*net
, struct sk_buff
*skb
,
221 u32 portid
, unsigned int group
, gfp_t flags
)
223 return nlmsg_multicast(net
->genl_sock
, skb
, portid
, group
, flags
);
227 * genlmsg_multicast - multicast a netlink message to the default netns
228 * @skb: netlink message as socket buffer
229 * @portid: own netlink portid to avoid sending to yourself
230 * @group: multicast group id
231 * @flags: allocation flags
233 static inline int genlmsg_multicast(struct sk_buff
*skb
, u32 portid
,
234 unsigned int group
, gfp_t flags
)
236 return genlmsg_multicast_netns(&init_net
, skb
, portid
, group
, flags
);
240 * genlmsg_multicast_allns - multicast a netlink message to all net namespaces
241 * @skb: netlink message as socket buffer
242 * @portid: own netlink portid to avoid sending to yourself
243 * @group: multicast group id
244 * @flags: allocation flags
246 * This function must hold the RTNL or rcu_read_lock().
248 int genlmsg_multicast_allns(struct sk_buff
*skb
, u32 portid
,
249 unsigned int group
, gfp_t flags
);
252 * genlmsg_unicast - unicast a netlink message
253 * @skb: netlink message as socket buffer
254 * @portid: netlink portid of the destination socket
256 static inline int genlmsg_unicast(struct net
*net
, struct sk_buff
*skb
, u32 portid
)
258 return nlmsg_unicast(net
->genl_sock
, skb
, portid
);
262 * genlmsg_reply - reply to a request
263 * @skb: netlink message to be sent back
264 * @info: receiver information
266 static inline int genlmsg_reply(struct sk_buff
*skb
, struct genl_info
*info
)
268 return genlmsg_unicast(genl_info_net(info
), skb
, info
->snd_portid
);
272 * gennlmsg_data - head of message payload
273 * @gnlh: genetlink message header
275 static inline void *genlmsg_data(const struct genlmsghdr
*gnlh
)
277 return ((unsigned char *) gnlh
+ GENL_HDRLEN
);
281 * genlmsg_len - length of message payload
282 * @gnlh: genetlink message header
284 static inline int genlmsg_len(const struct genlmsghdr
*gnlh
)
286 struct nlmsghdr
*nlh
= (struct nlmsghdr
*)((unsigned char *)gnlh
-
288 return (nlh
->nlmsg_len
- GENL_HDRLEN
- NLMSG_HDRLEN
);
292 * genlmsg_msg_size - length of genetlink message not including padding
293 * @payload: length of message payload
295 static inline int genlmsg_msg_size(int payload
)
297 return GENL_HDRLEN
+ payload
;
301 * genlmsg_total_size - length of genetlink message including padding
302 * @payload: length of message payload
304 static inline int genlmsg_total_size(int payload
)
306 return NLMSG_ALIGN(genlmsg_msg_size(payload
));
310 * genlmsg_new - Allocate a new generic netlink message
311 * @payload: size of the message payload
312 * @flags: the type of memory to allocate.
314 static inline struct sk_buff
*genlmsg_new(size_t payload
, gfp_t flags
)
316 return nlmsg_new(genlmsg_total_size(payload
), flags
);
320 #endif /* __NET_GENERIC_NETLINK_H */