[mirror_ubuntu-bionic-kernel.git] / net / netlink / af_netlink.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _AF_NETLINK_H
#define _AF_NETLINK_H

#include <linux/rhashtable.h>
#include <linux/atomic.h>
#include <linux/workqueue.h>
#include <net/sock.h>

/* flags */
#define NETLINK_F_KERNEL_SOCKET		0x1
#define NETLINK_F_RECV_PKTINFO		0x2
#define NETLINK_F_BROADCAST_SEND_ERROR	0x4
#define NETLINK_F_RECV_NO_ENOBUFS	0x8
#define NETLINK_F_LISTEN_ALL_NSID	0x10
#define NETLINK_F_CAP_ACK		0x20
#define NETLINK_F_EXT_ACK		0x40

#define NLGRPSZ(x)	(ALIGN(x, sizeof(unsigned long) * 8) / 8)
#define NLGRPLONGS(x)	(NLGRPSZ(x)/sizeof(unsigned long))

struct netlink_sock {
	/* struct sock has to be the first member of netlink_sock */
	struct sock		sk;
	u32			portid;
	u32			dst_portid;
	u32			dst_group;
	u32			flags;
	u32			subscriptions;
	u32			ngroups;
	unsigned long		*groups;
	unsigned long		state;
	size_t			max_recvmsg_len;
	wait_queue_head_t	wait;
	bool			bound;
	bool			cb_running;
	int			dump_done_errno;
	struct netlink_callback	cb;
	struct mutex		*cb_mutex;
	struct mutex		cb_def_mutex;
	void			(*netlink_rcv)(struct sk_buff *skb);
	int			(*netlink_bind)(struct net *net, int group);
	void			(*netlink_unbind)(struct net *net, int group);
	struct module		*module;

	struct rhash_head	node;
	struct rcu_head		rcu;
	struct work_struct	work;
};

static inline struct netlink_sock *nlk_sk(struct sock *sk)
{
	return container_of(sk, struct netlink_sock, sk);
}

struct netlink_table {
	struct rhashtable	hash;
	struct hlist_head	mc_list;
	struct listeners __rcu	*listeners;
	unsigned int		flags;
	unsigned int		groups;
	struct mutex		*cb_mutex;
	struct module		*module;
	int			(*bind)(struct net *net, int group);
	void			(*unbind)(struct net *net, int group);
	bool			(*compare)(struct net *net, struct sock *sock);
	int			registered;
};

extern struct netlink_table *nl_table;
extern rwlock_t nl_table_lock;

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
0f29c768 AV	2	#ifndef _AF_NETLINK_H
	3	#define _AF_NETLINK_H
	4
e341694e	5	#include <linux/rhashtable.h>
ee1c2442	6	#include <linux/atomic.h>
707693c8	7	#include <linux/workqueue.h>
0f29c768 AV	8	#include <net/sock.h>
0f29c768 AV	9
457c79e5 AV	10	/* flags */
	11	#define NETLINK_F_KERNEL_SOCKET 0x1
	12	#define NETLINK_F_RECV_PKTINFO 0x2
	13	#define NETLINK_F_BROADCAST_SEND_ERROR 0x4
	14	#define NETLINK_F_RECV_NO_ENOBUFS 0x8
	15	#define NETLINK_F_LISTEN_ALL_NSID 0x10
	16	#define NETLINK_F_CAP_ACK 0x20
2d4bc933	17	#define NETLINK_F_EXT_ACK 0x40
457c79e5	18
0f29c768 AV	19	#define NLGRPSZ(x) (ALIGN(x, sizeof(unsigned long) * 8) / 8)
	20	#define NLGRPLONGS(x) (NLGRPSZ(x)/sizeof(unsigned long))
	21
	22	struct netlink_sock {
	23	/* struct sock has to be the first member of netlink_sock */
	24	struct sock sk;
	25	u32 portid;
	26	u32 dst_portid;
	27	u32 dst_group;
	28	u32 flags;
	29	u32 subscriptions;
	30	u32 ngroups;
	31	unsigned long *groups;
	32	unsigned long state;
9063e21f	33	size_t max_recvmsg_len;
0f29c768	34	wait_queue_head_t wait;
da314c99	35	bool bound;
16b304f3	36	bool cb_running;
0642840b	37	int dump_done_errno;
16b304f3	38	struct netlink_callback cb;
0f29c768 AV	39	struct mutex *cb_mutex;
	40	struct mutex cb_def_mutex;
	41	void (netlink_rcv)(struct sk_buff skb);
023e2cfa JB	42	int (netlink_bind)(struct net net, int group);
023e2cfa JB	43	void (netlink_unbind)(struct net net, int group);
0f29c768	44	struct module *module;
e341694e TG	45
e341694e TG	46	struct rhash_head node;
21e4902a	47	struct rcu_head rcu;
707693c8	48	struct work_struct work;
0f29c768 AV	49	};
	50
	51	static inline struct netlink_sock nlk_sk(struct sock sk)
	52	{
	53	return container_of(sk, struct netlink_sock, sk);
	54	}
	55
0f29c768	56	struct netlink_table {
e341694e	57	struct rhashtable hash;
0f29c768 AV	58	struct hlist_head mc_list;
	59	struct listeners __rcu *listeners;
	60	unsigned int flags;
	61	unsigned int groups;
	62	struct mutex *cb_mutex;
	63	struct module *module;
023e2cfa JB	64	int (bind)(struct net net, int group);
023e2cfa JB	65	void (unbind)(struct net net, int group);
da12c90e	66	bool (compare)(struct net net, struct sock *sock);
0f29c768 AV	67	int registered;
	68	};
	69
	70	extern struct netlink_table *nl_table;
	71	extern rwlock_t nl_table_lock;
	72
	73	#endif