include/linux/netlink.h

   1 #ifndef __LINUX_NETLINK_H
   2 #define __LINUX_NETLINK_H
   3
   4
   5 #include <linux/capability.h>
   6 #include <linux/skbuff.h>
   7 #include <linux/export.h>
   8 #include <net/scm.h>
   9 #include <uapi/linux/netlink.h>
  10
  11 struct net;
  12
  13 static inline struct nlmsghdr *nlmsg_hdr(const struct sk_buff *skb)
  14 {
  15         return (struct nlmsghdr *)skb->data;
  16 }
  17
  18 enum netlink_skb_flags {
  19         NETLINK_SKB_MMAPED      = 0x1,  /* Packet data is mmaped */
  20         NETLINK_SKB_TX          = 0x2,  /* Packet was sent by userspace */
  21         NETLINK_SKB_DELIVERED   = 0x4,  /* Packet was delivered */
  22         NETLINK_SKB_DST         = 0x8,  /* Dst set in sendto or sendmsg */
  23 };
  24
  25 struct netlink_skb_parms {
  26         struct scm_creds        creds;          /* Skb credentials      */
  27         __u32                   portid;
  28         __u32                   dst_group;
  29         __u32                   flags;
  30         struct sock             *sk;
  31         bool                    nsid_is_set;
  32         int                     nsid;
  33 };
  34
  35 #define NETLINK_CB(skb)         (*(struct netlink_skb_parms*)&((skb)->cb))
  36 #define NETLINK_CREDS(skb)      (&NETLINK_CB((skb)).creds)
  37
  38
  39 extern void netlink_table_grab(void);
  40 extern void netlink_table_ungrab(void);
  41
  42 #define NL_CFG_F_NONROOT_RECV   (1 << 0)
  43 #define NL_CFG_F_NONROOT_SEND   (1 << 1)
  44
  45 /* optional Netlink kernel configuration parameters */
  46 struct netlink_kernel_cfg {
  47         unsigned int    groups;
  48         unsigned int    flags;
  49         void            (*input)(struct sk_buff *skb);
  50         struct mutex    *cb_mutex;
  51         int             (*bind)(struct net *net, int group);
  52         void            (*unbind)(struct net *net, int group);
  53         bool            (*compare)(struct net *net, struct sock *sk);
  54 };
  55
  56 extern struct sock *__netlink_kernel_create(struct net *net, int unit,
  57                                             struct module *module,
  58                                             struct netlink_kernel_cfg *cfg);
  59 static inline struct sock *
  60 netlink_kernel_create(struct net *net, int unit, struct netlink_kernel_cfg *cfg)
  61 {
  62         return __netlink_kernel_create(net, unit, THIS_MODULE, cfg);
  63 }
  64
  65 /* this can be increased when necessary - don't expose to userland */
  66 #define NETLINK_MAX_COOKIE_LEN  20
  67
  68 /**
  69  * struct netlink_ext_ack - netlink extended ACK report struct
  70  * @_msg: message string to report - don't access directly, use
  71  *      %NL_SET_ERR_MSG
  72  * @bad_attr: attribute with error
  73  * @cookie: cookie data to return to userspace (for success)
  74  * @cookie_len: actual cookie data length
  75  */
  76 struct netlink_ext_ack {
  77         const char *_msg;
  78         const struct nlattr *bad_attr;
  79         u8 cookie[NETLINK_MAX_COOKIE_LEN];
  80         u8 cookie_len;
  81 };
  82
  83 /* Always use this macro, this allows later putting the
  84  * message into a separate section or such for things
  85  * like translation or listing all possible messages.
  86  * Currently string formatting is not supported (due
  87  * to the lack of an output buffer.)
  88  */
  89 #define NL_SET_ERR_MSG(extack, msg) do {                \
  90         static const char __msg[] = (msg);              \
  91         struct netlink_ext_ack *__extack = (extack);    \
  92                                                         \
  93         if (__extack)                                   \
  94                 __extack->_msg = __msg;                 \
  95 } while (0)
  96
  97 #define NL_SET_ERR_MSG_MOD(extack, msg)                 \
  98         NL_SET_ERR_MSG((extack), KBUILD_MODNAME ": " msg)
  99
 100 extern void netlink_kernel_release(struct sock *sk);
 101 extern int __netlink_change_ngroups(struct sock *sk, unsigned int groups);
 102 extern int netlink_change_ngroups(struct sock *sk, unsigned int groups);
 103 extern void __netlink_clear_multicast_users(struct sock *sk, unsigned int group);
 104 extern void netlink_ack(struct sk_buff *in_skb, struct nlmsghdr *nlh, int err,
 105                         const struct netlink_ext_ack *extack);
 106 extern int netlink_has_listeners(struct sock *sk, unsigned int group);
 107
 108 extern int netlink_unicast(struct sock *ssk, struct sk_buff *skb, __u32 portid, int nonblock);
 109 extern int netlink_broadcast(struct sock *ssk, struct sk_buff *skb, __u32 portid,
 110                              __u32 group, gfp_t allocation);
 111 extern int netlink_broadcast_filtered(struct sock *ssk, struct sk_buff *skb,
 112         __u32 portid, __u32 group, gfp_t allocation,
 113         int (*filter)(struct sock *dsk, struct sk_buff *skb, void *data),
 114         void *filter_data);
 115 extern int netlink_set_err(struct sock *ssk, __u32 portid, __u32 group, int code);
 116 extern int netlink_register_notifier(struct notifier_block *nb);
 117 extern int netlink_unregister_notifier(struct notifier_block *nb);
 118
 119 /* finegrained unicast helpers: */
 120 struct sock *netlink_getsockbyfilp(struct file *filp);
 121 int netlink_attachskb(struct sock *sk, struct sk_buff *skb,
 122                       long *timeo, struct sock *ssk);
 123 void netlink_detachskb(struct sock *sk, struct sk_buff *skb);
 124 int netlink_sendskb(struct sock *sk, struct sk_buff *skb);
 125
 126 static inline struct sk_buff *
 127 netlink_skb_clone(struct sk_buff *skb, gfp_t gfp_mask)
 128 {
 129         struct sk_buff *nskb;
 130
 131         nskb = skb_clone(skb, gfp_mask);
 132         if (!nskb)
 133                 return NULL;
 134
 135         /* This is a large skb, set destructor callback to release head */
 136         if (is_vmalloc_addr(skb->head))
 137                 nskb->destructor = skb->destructor;
 138
 139         return nskb;
 140 }
 141
 142 /*
 143  *      skb should fit one page. This choice is good for headerless malloc.
 144  *      But we should limit to 8K so that userspace does not have to
 145  *      use enormous buffer sizes on recvmsg() calls just to avoid
 146  *      MSG_TRUNC when PAGE_SIZE is very large.
 147  */
 148 #if PAGE_SIZE < 8192UL
 149 #define NLMSG_GOODSIZE  SKB_WITH_OVERHEAD(PAGE_SIZE)
 150 #else
 151 #define NLMSG_GOODSIZE  SKB_WITH_OVERHEAD(8192UL)
 152 #endif
 153
 154 #define NLMSG_DEFAULT_SIZE (NLMSG_GOODSIZE - NLMSG_HDRLEN)
 155
 156
 157 struct netlink_callback {
 158         struct sk_buff          *skb;
 159         const struct nlmsghdr   *nlh;
 160         int                     (*start)(struct netlink_callback *);
 161         int                     (*dump)(struct sk_buff * skb,
 162                                         struct netlink_callback *cb);
 163         int                     (*done)(struct netlink_callback *cb);
 164         void                    *data;
 165         /* the module that dump function belong to */
 166         struct module           *module;
 167         u16                     family;
 168         u16                     min_dump_alloc;
 169         unsigned int            prev_seq, seq;
 170         long                    args[6];
 171 };
 172
 173 struct netlink_notify {
 174         struct net *net;
 175         u32 portid;
 176         int protocol;
 177 };
 178
 179 struct nlmsghdr *
 180 __nlmsg_put(struct sk_buff *skb, u32 portid, u32 seq, int type, int len, int flags);
 181
 182 struct netlink_dump_control {
 183         int (*start)(struct netlink_callback *);
 184         int (*dump)(struct sk_buff *skb, struct netlink_callback *);
 185         int (*done)(struct netlink_callback *);
 186         void *data;
 187         struct module *module;
 188         u16 min_dump_alloc;
 189 };
 190
 191 extern int __netlink_dump_start(struct sock *ssk, struct sk_buff *skb,
 192                                 const struct nlmsghdr *nlh,
 193                                 struct netlink_dump_control *control);
 194 static inline int netlink_dump_start(struct sock *ssk, struct sk_buff *skb,
 195                                      const struct nlmsghdr *nlh,
 196                                      struct netlink_dump_control *control)
 197 {
 198         if (!control->module)
 199                 control->module = THIS_MODULE;
 200
 201         return __netlink_dump_start(ssk, skb, nlh, control);
 202 }
 203
 204 struct netlink_tap {
 205         struct net_device *dev;
 206         struct module *module;
 207         struct list_head list;
 208 };
 209
 210 extern int netlink_add_tap(struct netlink_tap *nt);
 211 extern int netlink_remove_tap(struct netlink_tap *nt);
 212
 213 bool __netlink_ns_capable(const struct netlink_skb_parms *nsp,
 214                           struct user_namespace *ns, int cap);
 215 bool netlink_ns_capable(const struct sk_buff *skb,
 216                         struct user_namespace *ns, int cap);
 217 bool netlink_capable(const struct sk_buff *skb, int cap);
 218 bool netlink_net_capable(const struct sk_buff *skb, int cap);
 219
 220 #endif  /* __LINUX_NETLINK_H */