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  */
  14 struct genl_multicast_group {
  15         char                    name[GENL_NAMSIZ];
  16 };
  17
  18 struct genl_ops;
  19 struct genl_info;
  20
  21 /**
  22  * struct genl_family - generic netlink family
  23  * @id: protocol family idenfitier
  24  * @hdrsize: length of user specific header in bytes
  25  * @name: name of family
  26  * @version: protocol version
  27  * @maxattr: maximum number of attributes supported
  28  * @netnsok: set to true if the family can handle network
  29  *      namespaces and should be presented in all of them
  30  * @parallel_ops: operations can be called in parallel and aren't
  31  *      synchronized by the core genetlink code
  32  * @pre_doit: called before an operation's doit callback, it may
  33  *      do additional, common, filtering and return an error
  34  * @post_doit: called after an operation's doit callback, it may
  35  *      undo operations done by pre_doit, for example release locks
  36  * @attrbuf: buffer to store parsed attributes
  37  * @family_list: family list
  38  * @mcgrps: multicast groups used by this family (private)
  39  * @n_mcgrps: number of multicast groups (private)
  40  * @mcgrp_offset: starting number of multicast group IDs in this family
  41  * @ops: the operations supported by this family (private)
  42  * @n_ops: number of operations supported by this family (private)
  43  */
  44 struct genl_family {
  45         unsigned int            id;
  46         unsigned int            hdrsize;
  47         char                    name[GENL_NAMSIZ];
  48         unsigned int            version;
  49         unsigned int            maxattr;
  50         bool                    netnsok;
  51         bool                    parallel_ops;
  52         int                     (*pre_doit)(const struct genl_ops *ops,
  53                                             struct sk_buff *skb,
  54                                             struct genl_info *info);
  55         void                    (*post_doit)(const struct genl_ops *ops,
  56                                              struct sk_buff *skb,
  57                                              struct genl_info *info);
  58         struct nlattr **        attrbuf;        /* private */
  59         const struct genl_ops * ops;            /* private */
  60         const struct genl_multicast_group *mcgrps; /* private */
  61         unsigned int            n_ops;          /* private */
  62         unsigned int            n_mcgrps;       /* private */
  63         unsigned int            mcgrp_offset;   /* private */
  64         struct list_head        family_list;    /* private */
  65         struct module           *module;
  66 };
  67
  68 /**
  69  * struct genl_info - receiving information
  70  * @snd_seq: sending sequence number
  71  * @snd_portid: netlink portid of sender
  72  * @nlhdr: netlink message header
  73  * @genlhdr: generic netlink message header
  74  * @userhdr: user specific header
  75  * @attrs: netlink attributes
  76  * @_net: network namespace
  77  * @user_ptr: user pointers
  78  * @dst_sk: destination socket
  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         possible_net_t          _net;
  88         void *                  user_ptr[2];
  89         struct sock *           dst_sk;
  90 };
  91
  92 static inline struct net *genl_info_net(struct genl_info *info)
  93 {
  94         return read_pnet(&info->_net);
  95 }
  96
  97 static inline void genl_info_net_set(struct genl_info *info, struct net *net)
  98 {
  99         write_pnet(&info->_net, net);
 100 }
 101
 102 /**
 103  * struct genl_ops - generic netlink operations
 104  * @cmd: command identifier
 105  * @internal_flags: flags used by the family
 106  * @flags: flags
 107  * @policy: attribute validation policy
 108  * @doit: standard command callback
 109  * @start: start callback for dumps
 110  * @dumpit: callback for dumpers
 111  * @done: completion callback for dumps
 112  * @ops_list: operations list
 113  */
 114 struct genl_ops {
 115         const struct nla_policy *policy;
 116         int                    (*doit)(struct sk_buff *skb,
 117                                        struct genl_info *info);
 118         int                    (*start)(struct netlink_callback *cb);
 119         int                    (*dumpit)(struct sk_buff *skb,
 120                                          struct netlink_callback *cb);
 121         int                    (*done)(struct netlink_callback *cb);
 122         u8                      cmd;
 123         u8                      internal_flags;
 124         u8                      flags;
 125 };
 126
 127 int __genl_register_family(struct genl_family *family);
 128
 129 static inline int genl_register_family(struct genl_family *family)
 130 {
 131         family->module = THIS_MODULE;
 132         return __genl_register_family(family);
 133 }
 134
 135 /**
 136  * genl_register_family_with_ops - register a generic netlink family with ops
 137  * @family: generic netlink family
 138  * @ops: operations to be registered
 139  * @n_ops: number of elements to register
 140  *
 141  * Registers the specified family and operations from the specified table.
 142  * Only one family may be registered with the same family name or identifier.
 143  *
 144  * The family id may equal GENL_ID_GENERATE causing an unique id to
 145  * be automatically generated and assigned.
 146  *
 147  * Either a doit or dumpit callback must be specified for every registered
 148  * operation or the function will fail. Only one operation structure per
 149  * command identifier may be registered.
 150  *
 151  * See include/net/genetlink.h for more documenation on the operations
 152  * structure.
 153  *
 154  * Return 0 on success or a negative error code.
 155  */
 156 static inline int
 157 _genl_register_family_with_ops_grps(struct genl_family *family,
 158                                     const struct genl_ops *ops, size_t n_ops,
 159                                     const struct genl_multicast_group *mcgrps,
 160                                     size_t n_mcgrps)
 161 {
 162         family->module = THIS_MODULE;
 163         family->ops = ops;
 164         family->n_ops = n_ops;
 165         family->mcgrps = mcgrps;
 166         family->n_mcgrps = n_mcgrps;
 167         return __genl_register_family(family);
 168 }
 169
 170 #define genl_register_family_with_ops(family, ops)                      \
 171         _genl_register_family_with_ops_grps((family),                   \
 172                                             (ops), ARRAY_SIZE(ops),     \
 173                                             NULL, 0)
 174 #define genl_register_family_with_ops_groups(family, ops, grps) \
 175         _genl_register_family_with_ops_grps((family),                   \
 176                                             (ops), ARRAY_SIZE(ops),     \
 177                                             (grps), ARRAY_SIZE(grps))
 178
 179 int genl_unregister_family(struct genl_family *family);
 180 void genl_notify(struct genl_family *family, struct sk_buff *skb,
 181                  struct genl_info *info, u32 group, gfp_t flags);
 182
 183 struct sk_buff *genlmsg_new_unicast(size_t payload, struct genl_info *info,
 184                                     gfp_t flags);
 185 void *genlmsg_put(struct sk_buff *skb, u32 portid, u32 seq,
 186                   struct genl_family *family, int flags, u8 cmd);
 187
 188 /**
 189  * genlmsg_nlhdr - Obtain netlink header from user specified header
 190  * @user_hdr: user header as returned from genlmsg_put()
 191  * @family: generic netlink family
 192  *
 193  * Returns pointer to netlink header.
 194  */
 195 static inline struct nlmsghdr *genlmsg_nlhdr(void *user_hdr,
 196                                              struct genl_family *family)
 197 {
 198         return (struct nlmsghdr *)((char *)user_hdr -
 199                                    family->hdrsize -
 200                                    GENL_HDRLEN -
 201                                    NLMSG_HDRLEN);
 202 }
 203
 204 /**
 205  * genlmsg_parse - parse attributes of a genetlink message
 206  * @nlh: netlink message header
 207  * @family: genetlink message family
 208  * @tb: destination array with maxtype+1 elements
 209  * @maxtype: maximum attribute type to be expected
 210  * @policy: validation policy
 211  * */
 212 static inline int genlmsg_parse(const struct nlmsghdr *nlh,
 213                                 const struct genl_family *family,
 214                                 struct nlattr *tb[], int maxtype,
 215                                 const struct nla_policy *policy)
 216 {
 217         return nlmsg_parse(nlh, family->hdrsize + GENL_HDRLEN, tb, maxtype,
 218                            policy);
 219 }
 220
 221 /**
 222  * genl_dump_check_consistent - check if sequence is consistent and advertise if not
 223  * @cb: netlink callback structure that stores the sequence number
 224  * @user_hdr: user header as returned from genlmsg_put()
 225  * @family: generic netlink family
 226  *
 227  * Cf. nl_dump_check_consistent(), this just provides a wrapper to make it
 228  * simpler to use with generic netlink.
 229  */
 230 static inline void genl_dump_check_consistent(struct netlink_callback *cb,
 231                                               void *user_hdr,
 232                                               struct genl_family *family)
 233 {
 234         nl_dump_check_consistent(cb, genlmsg_nlhdr(user_hdr, family));
 235 }
 236
 237 /**
 238  * genlmsg_put_reply - Add generic netlink header to a reply message
 239  * @skb: socket buffer holding the message
 240  * @info: receiver info
 241  * @family: generic netlink family
 242  * @flags: netlink message flags
 243  * @cmd: generic netlink command
 244  *
 245  * Returns pointer to user specific header
 246  */
 247 static inline void *genlmsg_put_reply(struct sk_buff *skb,
 248                                       struct genl_info *info,
 249                                       struct genl_family *family,
 250                                       int flags, u8 cmd)
 251 {
 252         return genlmsg_put(skb, info->snd_portid, info->snd_seq, family,
 253                            flags, cmd);
 254 }
 255
 256 /**
 257  * genlmsg_end - Finalize a generic netlink message
 258  * @skb: socket buffer the message is stored in
 259  * @hdr: user specific header
 260  */
 261 static inline void genlmsg_end(struct sk_buff *skb, void *hdr)
 262 {
 263         nlmsg_end(skb, hdr - GENL_HDRLEN - NLMSG_HDRLEN);
 264 }
 265
 266 /**
 267  * genlmsg_cancel - Cancel construction of a generic netlink message
 268  * @skb: socket buffer the message is stored in
 269  * @hdr: generic netlink message header
 270  */
 271 static inline void genlmsg_cancel(struct sk_buff *skb, void *hdr)
 272 {
 273         if (hdr)
 274                 nlmsg_cancel(skb, hdr - GENL_HDRLEN - NLMSG_HDRLEN);
 275 }
 276
 277 /**
 278  * genlmsg_multicast_netns - multicast a netlink message to a specific netns
 279  * @family: the generic netlink family
 280  * @net: the net namespace
 281  * @skb: netlink message as socket buffer
 282  * @portid: own netlink portid to avoid sending to yourself
 283  * @group: offset of multicast group in groups array
 284  * @flags: allocation flags
 285  */
 286 static inline int genlmsg_multicast_netns(struct genl_family *family,
 287                                           struct net *net, struct sk_buff *skb,
 288                                           u32 portid, unsigned int group, gfp_t flags)
 289 {
 290         if (WARN_ON_ONCE(group >= family->n_mcgrps))
 291                 return -EINVAL;
 292         group = family->mcgrp_offset + group;
 293         return nlmsg_multicast(net->genl_sock, skb, portid, group, flags);
 294 }
 295
 296 /**
 297  * genlmsg_multicast - multicast a netlink message to the default netns
 298  * @family: the generic netlink family
 299  * @skb: netlink message as socket buffer
 300  * @portid: own netlink portid to avoid sending to yourself
 301  * @group: offset of multicast group in groups array
 302  * @flags: allocation flags
 303  */
 304 static inline int genlmsg_multicast(struct genl_family *family,
 305                                     struct sk_buff *skb, u32 portid,
 306                                     unsigned int group, gfp_t flags)
 307 {
 308         return genlmsg_multicast_netns(family, &init_net, skb,
 309                                        portid, group, flags);
 310 }
 311
 312 /**
 313  * genlmsg_multicast_allns - multicast a netlink message to all net namespaces
 314  * @family: the generic netlink family
 315  * @skb: netlink message as socket buffer
 316  * @portid: own netlink portid to avoid sending to yourself
 317  * @group: offset of multicast group in groups array
 318  * @flags: allocation flags
 319  *
 320  * This function must hold the RTNL or rcu_read_lock().
 321  */
 322 int genlmsg_multicast_allns(struct genl_family *family,
 323                             struct sk_buff *skb, u32 portid,
 324                             unsigned int group, gfp_t flags);
 325
 326 /**
 327  * genlmsg_unicast - unicast a netlink message
 328  * @skb: netlink message as socket buffer
 329  * @portid: netlink portid of the destination socket
 330  */
 331 static inline int genlmsg_unicast(struct net *net, struct sk_buff *skb, u32 portid)
 332 {
 333         return nlmsg_unicast(net->genl_sock, skb, portid);
 334 }
 335
 336 /**
 337  * genlmsg_reply - reply to a request
 338  * @skb: netlink message to be sent back
 339  * @info: receiver information
 340  */
 341 static inline int genlmsg_reply(struct sk_buff *skb, struct genl_info *info)
 342 {
 343         return genlmsg_unicast(genl_info_net(info), skb, info->snd_portid);
 344 }
 345
 346 /**
 347  * gennlmsg_data - head of message payload
 348  * @gnlh: genetlink message header
 349  */
 350 static inline void *genlmsg_data(const struct genlmsghdr *gnlh)
 351 {
 352         return ((unsigned char *) gnlh + GENL_HDRLEN);
 353 }
 354
 355 /**
 356  * genlmsg_len - length of message payload
 357  * @gnlh: genetlink message header
 358  */
 359 static inline int genlmsg_len(const struct genlmsghdr *gnlh)
 360 {
 361         struct nlmsghdr *nlh = (struct nlmsghdr *)((unsigned char *)gnlh -
 362                                                         NLMSG_HDRLEN);
 363         return (nlh->nlmsg_len - GENL_HDRLEN - NLMSG_HDRLEN);
 364 }
 365
 366 /**
 367  * genlmsg_msg_size - length of genetlink message not including padding
 368  * @payload: length of message payload
 369  */
 370 static inline int genlmsg_msg_size(int payload)
 371 {
 372         return GENL_HDRLEN + payload;
 373 }
 374
 375 /**
 376  * genlmsg_total_size - length of genetlink message including padding
 377  * @payload: length of message payload
 378  */
 379 static inline int genlmsg_total_size(int payload)
 380 {
 381         return NLMSG_ALIGN(genlmsg_msg_size(payload));
 382 }
 383
 384 /**
 385  * genlmsg_new - Allocate a new generic netlink message
 386  * @payload: size of the message payload
 387  * @flags: the type of memory to allocate.
 388  */
 389 static inline struct sk_buff *genlmsg_new(size_t payload, gfp_t flags)
 390 {
 391         return nlmsg_new(genlmsg_total_size(payload), flags);
 392 }
 393
 394 /**
 395  * genl_set_err - report error to genetlink broadcast listeners
 396  * @family: the generic netlink family
 397  * @net: the network namespace to report the error to
 398  * @portid: the PORTID of a process that we want to skip (if any)
 399  * @group: the broadcast group that will notice the error
 400  *      (this is the offset of the multicast group in the groups array)
 401  * @code: error code, must be negative (as usual in kernelspace)
 402  *
 403  * This function returns the number of broadcast listeners that have set the
 404  * NETLINK_RECV_NO_ENOBUFS socket option.
 405  */
 406 static inline int genl_set_err(struct genl_family *family, struct net *net,
 407                                u32 portid, u32 group, int code)
 408 {
 409         if (WARN_ON_ONCE(group >= family->n_mcgrps))
 410                 return -EINVAL;
 411         group = family->mcgrp_offset + group;
 412         return netlink_set_err(net->genl_sock, portid, group, code);
 413 }
 414
 415 static inline int genl_has_listeners(struct genl_family *family,
 416                                      struct net *net, unsigned int group)
 417 {
 418         if (WARN_ON_ONCE(group >= family->n_mcgrps))
 419                 return -EINVAL;
 420         group = family->mcgrp_offset + group;
 421         return netlink_has_listeners(net->genl_sock, group);
 422 }
 423 #endif  /* __NET_GENERIC_NETLINK_H */