include/net/genetlink.h

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