include/net/genetlink.h

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