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 identifier (private)
  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  * @mcast_bind: a socket bound to the given multicast group (which
  37  *      is given as the offset into the groups array)
  38  * @mcast_unbind: a socket was unbound from the given multicast group.
  39  *      Note that unbind() will not be called symmetrically if the
  40  *      generic netlink family is removed while there are still open
  41  *      sockets.
  42  * @attrbuf: buffer to store parsed attributes (private)
  43  * @mcgrps: multicast groups used by this family
  44  * @n_mcgrps: number of multicast groups
  45  * @mcgrp_offset: starting number of multicast group IDs in this family
  46  *      (private)
  47  * @ops: the operations supported by this family
  48  * @n_ops: number of operations supported by this family
  49  */
  50 struct genl_family {
  51         int                     id;             /* private */
  52         unsigned int            hdrsize;
  53         char                    name[GENL_NAMSIZ];
  54         unsigned int            version;
  55         unsigned int            maxattr;
  56         bool                    netnsok;
  57         bool                    parallel_ops;
  58         int                     (*pre_doit)(const struct genl_ops *ops,
  59                                             struct sk_buff *skb,
  60                                             struct genl_info *info);
  61         void                    (*post_doit)(const struct genl_ops *ops,
  62                                              struct sk_buff *skb,
  63                                              struct genl_info *info);
  64         int                     (*mcast_bind)(struct net *net, int group);
  65         void                    (*mcast_unbind)(struct net *net, int group);
  66         struct nlattr **        attrbuf;        /* private */
  67         const struct genl_ops * ops;
  68         const struct genl_multicast_group *mcgrps;
  69         unsigned int            n_ops;
  70         unsigned int            n_mcgrps;
  71         unsigned int            mcgrp_offset;   /* private */
  72         struct module           *module;
  73 };
  74
  75 struct nlattr **genl_family_attrbuf(const struct genl_family *family);
  76
  77 /**
  78  * struct genl_info - receiving information
  79  * @snd_seq: sending sequence number
  80  * @snd_portid: netlink portid of sender
  81  * @nlhdr: netlink message header
  82  * @genlhdr: generic netlink message header
  83  * @userhdr: user specific header
  84  * @attrs: netlink attributes
  85  * @_net: network namespace
  86  * @user_ptr: user pointers
  87  * @extack: extended ACK report struct
  88  */
  89 struct genl_info {
  90         u32                     snd_seq;
  91         u32                     snd_portid;
  92         struct nlmsghdr *       nlhdr;
  93         struct genlmsghdr *     genlhdr;
  94         void *                  userhdr;
  95         struct nlattr **        attrs;
  96         possible_net_t          _net;
  97         void *                  user_ptr[2];
  98         struct netlink_ext_ack *extack;
  99 };
 100
 101 static inline struct net *genl_info_net(struct genl_info *info)
 102 {
 103         return read_pnet(&info->_net);
 104 }
 105
 106 static inline void genl_info_net_set(struct genl_info *info, struct net *net)
 107 {
 108         write_pnet(&info->_net, net);
 109 }
 110
 111 #define GENL_SET_ERR_MSG(info, msg) NL_SET_ERR_MSG((info)->extack, msg)
 112
 113 static inline int genl_err_attr(struct genl_info *info, int err,
 114                                 struct nlattr *attr)
 115 {
 116         info->extack->bad_attr = attr;
 117
 118         return err;
 119 }
 120
 121 /**
 122  * struct genl_ops - generic netlink operations
 123  * @cmd: command identifier
 124  * @internal_flags: flags used by the family
 125  * @flags: flags
 126  * @policy: attribute validation policy
 127  * @doit: standard command callback
 128  * @start: start callback for dumps
 129  * @dumpit: callback for dumpers
 130  * @done: completion callback for dumps
 131  * @ops_list: operations list
 132  */
 133 struct genl_ops {
 134         const struct nla_policy *policy;
 135         int                    (*doit)(struct sk_buff *skb,
 136                                        struct genl_info *info);
 137         int                    (*start)(struct netlink_callback *cb);
 138         int                    (*dumpit)(struct sk_buff *skb,
 139                                          struct netlink_callback *cb);
 140         int                    (*done)(struct netlink_callback *cb);
 141         u8                      cmd;
 142         u8                      internal_flags;
 143         u8                      flags;
 144 };
 145
 146 int genl_register_family(struct genl_family *family);
 147 int genl_unregister_family(const struct genl_family *family);
 148 void genl_notify(const struct genl_family *family, struct sk_buff *skb,
 149                  struct genl_info *info, u32 group, gfp_t flags);
 150
 151 void *genlmsg_put(struct sk_buff *skb, u32 portid, u32 seq,
 152                   const struct genl_family *family, int flags, u8 cmd);
 153
 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 *
 162 genlmsg_nlhdr(void *user_hdr, const 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  * genlmsg_parse - parse attributes of a genetlink message
 172  * @nlh: netlink message header
 173  * @family: genetlink message family
 174  * @tb: destination array with maxtype+1 elements
 175  * @maxtype: maximum attribute type to be expected
 176  * @policy: validation policy
 177  * */
 178 static inline int genlmsg_parse(const struct nlmsghdr *nlh,
 179                                 const struct genl_family *family,
 180                                 struct nlattr *tb[], int maxtype,
 181                                 const struct nla_policy *policy)
 182 {
 183         return nlmsg_parse(nlh, family->hdrsize + GENL_HDRLEN, tb, maxtype,
 184                            policy);
 185 }
 186
 187 /**
 188  * genl_dump_check_consistent - check if sequence is consistent and advertise if not
 189  * @cb: netlink callback structure that stores the sequence number
 190  * @user_hdr: user header as returned from genlmsg_put()
 191  * @family: generic netlink family
 192  *
 193  * Cf. nl_dump_check_consistent(), this just provides a wrapper to make it
 194  * simpler to use with generic netlink.
 195  */
 196 static inline void genl_dump_check_consistent(struct netlink_callback *cb,
 197                                               void *user_hdr,
 198                                               const struct genl_family *family)
 199 {
 200         nl_dump_check_consistent(cb, genlmsg_nlhdr(user_hdr, family));
 201 }
 202
 203 /**
 204  * genlmsg_put_reply - Add generic netlink header to a reply message
 205  * @skb: socket buffer holding the message
 206  * @info: receiver info
 207  * @family: generic netlink family
 208  * @flags: netlink message flags
 209  * @cmd: generic netlink command
 210  *
 211  * Returns pointer to user specific header
 212  */
 213 static inline void *genlmsg_put_reply(struct sk_buff *skb,
 214                                       struct genl_info *info,
 215                                       const struct genl_family *family,
 216                                       int flags, u8 cmd)
 217 {
 218         return genlmsg_put(skb, info->snd_portid, info->snd_seq, family,
 219                            flags, cmd);
 220 }
 221
 222 /**
 223  * genlmsg_end - Finalize a generic netlink message
 224  * @skb: socket buffer the message is stored in
 225  * @hdr: user specific header
 226  */
 227 static inline void genlmsg_end(struct sk_buff *skb, void *hdr)
 228 {
 229         nlmsg_end(skb, hdr - GENL_HDRLEN - NLMSG_HDRLEN);
 230 }
 231
 232 /**
 233  * genlmsg_cancel - Cancel construction of a generic netlink message
 234  * @skb: socket buffer the message is stored in
 235  * @hdr: generic netlink message header
 236  */
 237 static inline void genlmsg_cancel(struct sk_buff *skb, void *hdr)
 238 {
 239         if (hdr)
 240                 nlmsg_cancel(skb, hdr - GENL_HDRLEN - NLMSG_HDRLEN);
 241 }
 242
 243 /**
 244  * genlmsg_multicast_netns - multicast a netlink message to a specific netns
 245  * @family: the generic netlink family
 246  * @net: the net namespace
 247  * @skb: netlink message as socket buffer
 248  * @portid: own netlink portid to avoid sending to yourself
 249  * @group: offset of multicast group in groups array
 250  * @flags: allocation flags
 251  */
 252 static inline int genlmsg_multicast_netns(const struct genl_family *family,
 253                                           struct net *net, struct sk_buff *skb,
 254                                           u32 portid, unsigned int group, gfp_t flags)
 255 {
 256         if (WARN_ON_ONCE(group >= family->n_mcgrps))
 257                 return -EINVAL;
 258         group = family->mcgrp_offset + group;
 259         return nlmsg_multicast(net->genl_sock, skb, portid, group, flags);
 260 }
 261
 262 /**
 263  * genlmsg_multicast - multicast a netlink message to the default netns
 264  * @family: the generic netlink family
 265  * @skb: netlink message as socket buffer
 266  * @portid: own netlink portid to avoid sending to yourself
 267  * @group: offset of multicast group in groups array
 268  * @flags: allocation flags
 269  */
 270 static inline int genlmsg_multicast(const struct genl_family *family,
 271                                     struct sk_buff *skb, u32 portid,
 272                                     unsigned int group, gfp_t flags)
 273 {
 274         return genlmsg_multicast_netns(family, &init_net, skb,
 275                                        portid, group, flags);
 276 }
 277
 278 /**
 279  * genlmsg_multicast_allns - multicast a netlink message to all net namespaces
 280  * @family: the generic netlink family
 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  * This function must hold the RTNL or rcu_read_lock().
 287  */
 288 int genlmsg_multicast_allns(const struct genl_family *family,
 289                             struct sk_buff *skb, u32 portid,
 290                             unsigned int group, gfp_t flags);
 291
 292 /**
 293  * genlmsg_unicast - unicast a netlink message
 294  * @skb: netlink message as socket buffer
 295  * @portid: netlink portid of the destination socket
 296  */
 297 static inline int genlmsg_unicast(struct net *net, struct sk_buff *skb, u32 portid)
 298 {
 299         return nlmsg_unicast(net->genl_sock, skb, portid);
 300 }
 301
 302 /**
 303  * genlmsg_reply - reply to a request
 304  * @skb: netlink message to be sent back
 305  * @info: receiver information
 306  */
 307 static inline int genlmsg_reply(struct sk_buff *skb, struct genl_info *info)
 308 {
 309         return genlmsg_unicast(genl_info_net(info), skb, info->snd_portid);
 310 }
 311
 312 /**
 313  * gennlmsg_data - head of message payload
 314  * @gnlh: genetlink message header
 315  */
 316 static inline void *genlmsg_data(const struct genlmsghdr *gnlh)
 317 {
 318         return ((unsigned char *) gnlh + GENL_HDRLEN);
 319 }
 320
 321 /**
 322  * genlmsg_len - length of message payload
 323  * @gnlh: genetlink message header
 324  */
 325 static inline int genlmsg_len(const struct genlmsghdr *gnlh)
 326 {
 327         struct nlmsghdr *nlh = (struct nlmsghdr *)((unsigned char *)gnlh -
 328                                                         NLMSG_HDRLEN);
 329         return (nlh->nlmsg_len - GENL_HDRLEN - NLMSG_HDRLEN);
 330 }
 331
 332 /**
 333  * genlmsg_msg_size - length of genetlink message not including padding
 334  * @payload: length of message payload
 335  */
 336 static inline int genlmsg_msg_size(int payload)
 337 {
 338         return GENL_HDRLEN + payload;
 339 }
 340
 341 /**
 342  * genlmsg_total_size - length of genetlink message including padding
 343  * @payload: length of message payload
 344  */
 345 static inline int genlmsg_total_size(int payload)
 346 {
 347         return NLMSG_ALIGN(genlmsg_msg_size(payload));
 348 }
 349
 350 /**
 351  * genlmsg_new - Allocate a new generic netlink message
 352  * @payload: size of the message payload
 353  * @flags: the type of memory to allocate.
 354  */
 355 static inline struct sk_buff *genlmsg_new(size_t payload, gfp_t flags)
 356 {
 357         return nlmsg_new(genlmsg_total_size(payload), flags);
 358 }
 359
 360 /**
 361  * genl_set_err - report error to genetlink broadcast listeners
 362  * @family: the generic netlink family
 363  * @net: the network namespace to report the error to
 364  * @portid: the PORTID of a process that we want to skip (if any)
 365  * @group: the broadcast group that will notice the error
 366  *      (this is the offset of the multicast group in the groups array)
 367  * @code: error code, must be negative (as usual in kernelspace)
 368  *
 369  * This function returns the number of broadcast listeners that have set the
 370  * NETLINK_RECV_NO_ENOBUFS socket option.
 371  */
 372 static inline int genl_set_err(const struct genl_family *family,
 373                                struct net *net, u32 portid,
 374                                u32 group, int code)
 375 {
 376         if (WARN_ON_ONCE(group >= family->n_mcgrps))
 377                 return -EINVAL;
 378         group = family->mcgrp_offset + group;
 379         return netlink_set_err(net->genl_sock, portid, group, code);
 380 }
 381
 382 static inline int genl_has_listeners(const struct genl_family *family,
 383                                      struct net *net, unsigned int group)
 384 {
 385         if (WARN_ON_ONCE(group >= family->n_mcgrps))
 386                 return -EINVAL;
 387         group = family->mcgrp_offset + group;
 388         return netlink_has_listeners(net->genl_sock, group);
 389 }
 390 #endif  /* __NET_GENERIC_NETLINK_H */