[mirror_ubuntu-artful-kernel.git] / include / uapi / linux / netlink.h

#ifndef _UAPI__LINUX_NETLINK_H
#define _UAPI__LINUX_NETLINK_H

#include <linux/kernel.h>
#include <linux/socket.h> /* for __kernel_sa_family_t */
#include <linux/types.h>

#define NETLINK_ROUTE		0	/* Routing/device hook				*/
#define NETLINK_UNUSED		1	/* Unused number				*/
#define NETLINK_USERSOCK	2	/* Reserved for user mode socket protocols 	*/
#define NETLINK_FIREWALL	3	/* Unused number, formerly ip_queue		*/
#define NETLINK_SOCK_DIAG	4	/* socket monitoring				*/
#define NETLINK_NFLOG		5	/* netfilter/iptables ULOG */
#define NETLINK_XFRM		6	/* ipsec */
#define NETLINK_SELINUX		7	/* SELinux event notifications */
#define NETLINK_ISCSI		8	/* Open-iSCSI */
#define NETLINK_AUDIT		9	/* auditing */
#define NETLINK_FIB_LOOKUP	10	
#define NETLINK_CONNECTOR	11
#define NETLINK_NETFILTER	12	/* netfilter subsystem */
#define NETLINK_IP6_FW		13
#define NETLINK_DNRTMSG		14	/* DECnet routing messages */
#define NETLINK_KOBJECT_UEVENT	15	/* Kernel messages to userspace */
#define NETLINK_GENERIC		16
/* leave room for NETLINK_DM (DM Events) */
#define NETLINK_SCSITRANSPORT	18	/* SCSI Transports */
#define NETLINK_ECRYPTFS	19
#define NETLINK_RDMA		20
#define NETLINK_CRYPTO		21	/* Crypto layer */
#define NETLINK_SMC		22	/* SMC monitoring */

#define NETLINK_INET_DIAG	NETLINK_SOCK_DIAG

#define MAX_LINKS 32		

struct sockaddr_nl {
	__kernel_sa_family_t	nl_family;	/* AF_NETLINK	*/
	unsigned short	nl_pad;		/* zero		*/
	__u32		nl_pid;		/* port ID	*/
       	__u32		nl_groups;	/* multicast groups mask */
};

struct nlmsghdr {
	__u32		nlmsg_len;	/* Length of message including header */
	__u16		nlmsg_type;	/* Message content */
	__u16		nlmsg_flags;	/* Additional flags */
	__u32		nlmsg_seq;	/* Sequence number */
	__u32		nlmsg_pid;	/* Sending process port ID */
};

/* Flags values */

#define NLM_F_REQUEST		0x01	/* It is request message. 	*/
#define NLM_F_MULTI		0x02	/* Multipart message, terminated by NLMSG_DONE */
#define NLM_F_ACK		0x04	/* Reply with ack, with zero or error code */
#define NLM_F_ECHO		0x08	/* Echo this request 		*/
#define NLM_F_DUMP_INTR		0x10	/* Dump was inconsistent due to sequence change */
#define NLM_F_DUMP_FILTERED	0x20	/* Dump was filtered as requested */

/* Modifiers to GET request */
#define NLM_F_ROOT	0x100	/* specify tree	root	*/
#define NLM_F_MATCH	0x200	/* return all matching	*/
#define NLM_F_ATOMIC	0x400	/* atomic GET		*/
#define NLM_F_DUMP	(NLM_F_ROOT|NLM_F_MATCH)

/* Modifiers to NEW request */
#define NLM_F_REPLACE	0x100	/* Override existing		*/
#define NLM_F_EXCL	0x200	/* Do not touch, if it exists	*/
#define NLM_F_CREATE	0x400	/* Create, if it does not exist	*/
#define NLM_F_APPEND	0x800	/* Add to end of list		*/

/* Flags for ACK message */
#define NLM_F_CAPPED	0x100	/* request was capped */
#define NLM_F_ACK_TLVS	0x200	/* extended ACK TVLs were included */

/*
   4.4BSD ADD		NLM_F_CREATE|NLM_F_EXCL
   4.4BSD CHANGE	NLM_F_REPLACE

   True CHANGE		NLM_F_CREATE|NLM_F_REPLACE
   Append		NLM_F_CREATE
   Check		NLM_F_EXCL
 */

#define NLMSG_ALIGNTO	4U
#define NLMSG_ALIGN(len) ( ((len)+NLMSG_ALIGNTO-1) & ~(NLMSG_ALIGNTO-1) )
#define NLMSG_HDRLEN	 ((int) NLMSG_ALIGN(sizeof(struct nlmsghdr)))
#define NLMSG_LENGTH(len) ((len) + NLMSG_HDRLEN)
#define NLMSG_SPACE(len) NLMSG_ALIGN(NLMSG_LENGTH(len))
#define NLMSG_DATA(nlh)  ((void*)(((char*)nlh) + NLMSG_LENGTH(0)))
#define NLMSG_NEXT(nlh,len)	 ((len) -= NLMSG_ALIGN((nlh)->nlmsg_len), \
				  (struct nlmsghdr*)(((char*)(nlh)) + NLMSG_ALIGN((nlh)->nlmsg_len)))
#define NLMSG_OK(nlh,len) ((len) >= (int)sizeof(struct nlmsghdr) && \
			   (nlh)->nlmsg_len >= sizeof(struct nlmsghdr) && \
			   (nlh)->nlmsg_len <= (len))
#define NLMSG_PAYLOAD(nlh,len) ((nlh)->nlmsg_len - NLMSG_SPACE((len)))

#define NLMSG_NOOP		0x1	/* Nothing.		*/
#define NLMSG_ERROR		0x2	/* Error		*/
#define NLMSG_DONE		0x3	/* End of a dump	*/
#define NLMSG_OVERRUN		0x4	/* Data lost		*/

#define NLMSG_MIN_TYPE		0x10	/* < 0x10: reserved control messages */

struct nlmsgerr {
	int		error;
	struct nlmsghdr msg;
	/*
	 * followed by the message contents unless NETLINK_CAP_ACK was set
	 * or the ACK indicates success (error == 0)
	 * message length is aligned with NLMSG_ALIGN()
	 */
	/*
	 * followed by TLVs defined in enum nlmsgerr_attrs
	 * if NETLINK_EXT_ACK was set
	 */
};

/**
 * enum nlmsgerr_attrs - nlmsgerr attributes
 * @NLMSGERR_ATTR_UNUSED: unused
 * @NLMSGERR_ATTR_MSG: error message string (string)
 * @NLMSGERR_ATTR_OFFS: offset of the invalid attribute in the original
 *	 message, counting from the beginning of the header (u32)
 * @NLMSGERR_ATTR_COOKIE: arbitrary subsystem specific cookie to
 *	be used - in the success case - to identify a created
 *	object or operation or similar (binary)
 * @__NLMSGERR_ATTR_MAX: number of attributes
 * @NLMSGERR_ATTR_MAX: highest attribute number
 */
enum nlmsgerr_attrs {
	NLMSGERR_ATTR_UNUSED,
	NLMSGERR_ATTR_MSG,
	NLMSGERR_ATTR_OFFS,
	NLMSGERR_ATTR_COOKIE,

	__NLMSGERR_ATTR_MAX,
	NLMSGERR_ATTR_MAX = __NLMSGERR_ATTR_MAX - 1
};

#define NETLINK_ADD_MEMBERSHIP		1
#define NETLINK_DROP_MEMBERSHIP		2
#define NETLINK_PKTINFO			3
#define NETLINK_BROADCAST_ERROR		4
#define NETLINK_NO_ENOBUFS		5
#ifndef __KERNEL__
#define NETLINK_RX_RING			6
#define NETLINK_TX_RING			7
#endif
#define NETLINK_LISTEN_ALL_NSID		8
#define NETLINK_LIST_MEMBERSHIPS	9
#define NETLINK_CAP_ACK			10
#define NETLINK_EXT_ACK			11

struct nl_pktinfo {
	__u32	group;
};

struct nl_mmap_req {
	unsigned int	nm_block_size;
	unsigned int	nm_block_nr;
	unsigned int	nm_frame_size;
	unsigned int	nm_frame_nr;
};

struct nl_mmap_hdr {
	unsigned int	nm_status;
	unsigned int	nm_len;
	__u32		nm_group;
	/* credentials */
	__u32		nm_pid;
	__u32		nm_uid;
	__u32		nm_gid;
};

#ifndef __KERNEL__
enum nl_mmap_status {
	NL_MMAP_STATUS_UNUSED,
	NL_MMAP_STATUS_RESERVED,
	NL_MMAP_STATUS_VALID,
	NL_MMAP_STATUS_COPY,
	NL_MMAP_STATUS_SKIP,
};

#define NL_MMAP_MSG_ALIGNMENT		NLMSG_ALIGNTO
#define NL_MMAP_MSG_ALIGN(sz)		__ALIGN_KERNEL(sz, NL_MMAP_MSG_ALIGNMENT)
#define NL_MMAP_HDRLEN			NL_MMAP_MSG_ALIGN(sizeof(struct nl_mmap_hdr))
#endif

#define NET_MAJOR 36		/* Major 36 is reserved for networking 						*/

enum {
	NETLINK_UNCONNECTED = 0,
	NETLINK_CONNECTED,
};

/*
 *  <------- NLA_HDRLEN ------> <-- NLA_ALIGN(payload)-->
 * +---------------------+- - -+- - - - - - - - - -+- - -+
 * |        Header       | Pad |     Payload       | Pad |
 * |   (struct nlattr)   | ing |                   | ing |
 * +---------------------+- - -+- - - - - - - - - -+- - -+
 *  <-------------- nlattr->nla_len -------------->
 */

struct nlattr {
	__u16           nla_len;
	__u16           nla_type;
};

/*
 * nla_type (16 bits)
 * +---+---+-------------------------------+
 * | N | O | Attribute Type                |
 * +---+---+-------------------------------+
 * N := Carries nested attributes
 * O := Payload stored in network byte order
 *
 * Note: The N and O flag are mutually exclusive.
 */
#define NLA_F_NESTED		(1 << 15)
#define NLA_F_NET_BYTEORDER	(1 << 14)
#define NLA_TYPE_MASK		~(NLA_F_NESTED | NLA_F_NET_BYTEORDER)

#define NLA_ALIGNTO		4
#define NLA_ALIGN(len)		(((len) + NLA_ALIGNTO - 1) & ~(NLA_ALIGNTO - 1))
#define NLA_HDRLEN		((int) NLA_ALIGN(sizeof(struct nlattr)))


#endif /* _UAPI__LINUX_NETLINK_H */
Commit	Line	Data
607ca46e DH	1	#ifndef _UAPI__LINUX_NETLINK_H
	2	#define _UAPI__LINUX_NETLINK_H
	3
ccdfcc39	4	#include <linux/kernel.h>
607ca46e DH	5	#include <linux/socket.h> /* for __kernel_sa_family_t */
	6	#include <linux/types.h>
	7
	8	#define NETLINK_ROUTE 0 /* Routing/device hook */
	9	#define NETLINK_UNUSED 1 /* Unused number */
	10	#define NETLINK_USERSOCK 2 /* Reserved for user mode socket protocols */
	11	#define NETLINK_FIREWALL 3 /* Unused number, formerly ip_queue */
	12	#define NETLINK_SOCK_DIAG 4 /* socket monitoring */
	13	#define NETLINK_NFLOG 5 /* netfilter/iptables ULOG */
	14	#define NETLINK_XFRM 6 /* ipsec */
	15	#define NETLINK_SELINUX 7 /* SELinux event notifications */
	16	#define NETLINK_ISCSI 8 /* Open-iSCSI */
	17	#define NETLINK_AUDIT 9 /* auditing */
	18	#define NETLINK_FIB_LOOKUP 10
	19	#define NETLINK_CONNECTOR 11
	20	#define NETLINK_NETFILTER 12 /* netfilter subsystem */
	21	#define NETLINK_IP6_FW 13
	22	#define NETLINK_DNRTMSG 14 /* DECnet routing messages */
	23	#define NETLINK_KOBJECT_UEVENT 15 /* Kernel messages to userspace */
	24	#define NETLINK_GENERIC 16
	25	/* leave room for NETLINK_DM (DM Events) */
	26	#define NETLINK_SCSITRANSPORT 18 /* SCSI Transports */
	27	#define NETLINK_ECRYPTFS 19
	28	#define NETLINK_RDMA 20
	29	#define NETLINK_CRYPTO 21 /* Crypto layer */
f16a7dd5	30	#define NETLINK_SMC 22 /* SMC monitoring */
607ca46e DH	31
	32	#define NETLINK_INET_DIAG NETLINK_SOCK_DIAG
	33
	34	#define MAX_LINKS 32
	35
	36	struct sockaddr_nl {
	37	__kernel_sa_family_t nl_family; /* AF_NETLINK */
	38	unsigned short nl_pad; /* zero */
	39	__u32 nl_pid; /* port ID */
	40	__u32 nl_groups; /* multicast groups mask */
	41	};
	42
	43	struct nlmsghdr {
	44	__u32 nlmsg_len; /* Length of message including header */
	45	__u16 nlmsg_type; /* Message content */
	46	__u16 nlmsg_flags; /* Additional flags */
	47	__u32 nlmsg_seq; /* Sequence number */
	48	__u32 nlmsg_pid; /* Sending process port ID */
	49	};
	50
	51	/* Flags values */
	52
261a0a54 JB	53	#define NLM_F_REQUEST 0x01 /* It is request message. */
	54	#define NLM_F_MULTI 0x02 /* Multipart message, terminated by NLMSG_DONE */
	55	#define NLM_F_ACK 0x04 /* Reply with ack, with zero or error code */
	56	#define NLM_F_ECHO 0x08 /* Echo this request */
	57	#define NLM_F_DUMP_INTR 0x10 /* Dump was inconsistent due to sequence change */
	58	#define NLM_F_DUMP_FILTERED 0x20 /* Dump was filtered as requested */
607ca46e DH	59
	60	/* Modifiers to GET request */
	61	#define NLM_F_ROOT 0x100 /* specify tree root */
	62	#define NLM_F_MATCH 0x200 /* return all matching */
	63	#define NLM_F_ATOMIC 0x400 /* atomic GET */
	64	#define NLM_F_DUMP (NLM_F_ROOT\|NLM_F_MATCH)
	65
	66	/* Modifiers to NEW request */
	67	#define NLM_F_REPLACE 0x100 /* Override existing */
	68	#define NLM_F_EXCL 0x200 /* Do not touch, if it exists */
	69	#define NLM_F_CREATE 0x400 /* Create, if it does not exist */
	70	#define NLM_F_APPEND 0x800 /* Add to end of list */
	71
2d4bc933 JB	72	/* Flags for ACK message */
	73	#define NLM_F_CAPPED 0x100 /* request was capped */
	74	#define NLM_F_ACK_TLVS 0x200 /* extended ACK TVLs were included */
	75
607ca46e DH	76	/*
	77	4.4BSD ADD NLM_F_CREATE\|NLM_F_EXCL
	78	4.4BSD CHANGE NLM_F_REPLACE
	79
	80	True CHANGE NLM_F_CREATE\|NLM_F_REPLACE
	81	Append NLM_F_CREATE
	82	Check NLM_F_EXCL
	83	*/
	84
	85	#define NLMSG_ALIGNTO 4U
	86	#define NLMSG_ALIGN(len) ( ((len)+NLMSG_ALIGNTO-1) & ~(NLMSG_ALIGNTO-1) )
	87	#define NLMSG_HDRLEN ((int) NLMSG_ALIGN(sizeof(struct nlmsghdr)))
a88b9ce5	88	#define NLMSG_LENGTH(len) ((len) + NLMSG_HDRLEN)
607ca46e DH	89	#define NLMSG_SPACE(len) NLMSG_ALIGN(NLMSG_LENGTH(len))
	90	#define NLMSG_DATA(nlh) ((void)(((char)nlh) + NLMSG_LENGTH(0)))
	91	#define NLMSG_NEXT(nlh,len) ((len) -= NLMSG_ALIGN((nlh)->nlmsg_len), \
	92	(struct nlmsghdr)(((char)(nlh)) + NLMSG_ALIGN((nlh)->nlmsg_len)))
	93	#define NLMSG_OK(nlh,len) ((len) >= (int)sizeof(struct nlmsghdr) && \
	94	(nlh)->nlmsg_len >= sizeof(struct nlmsghdr) && \
	95	(nlh)->nlmsg_len <= (len))
	96	#define NLMSG_PAYLOAD(nlh,len) ((nlh)->nlmsg_len - NLMSG_SPACE((len)))
	97
	98	#define NLMSG_NOOP 0x1 /* Nothing. */
	99	#define NLMSG_ERROR 0x2 /* Error */
	100	#define NLMSG_DONE 0x3 /* End of a dump */
	101	#define NLMSG_OVERRUN 0x4 /* Data lost */
	102
	103	#define NLMSG_MIN_TYPE 0x10 /* < 0x10: reserved control messages */
	104
	105	struct nlmsgerr {
	106	int error;
	107	struct nlmsghdr msg;
2d4bc933 JB	108	/*
	109	* followed by the message contents unless NETLINK_CAP_ACK was set
	110	* or the ACK indicates success (error == 0)
	111	* message length is aligned with NLMSG_ALIGN()
	112	*/
	113	/*
	114	* followed by TLVs defined in enum nlmsgerr_attrs
	115	* if NETLINK_EXT_ACK was set
	116	*/
	117	};
	118
	119	/**
	120	* enum nlmsgerr_attrs - nlmsgerr attributes
	121	* @NLMSGERR_ATTR_UNUSED: unused
	122	* @NLMSGERR_ATTR_MSG: error message string (string)
	123	* @NLMSGERR_ATTR_OFFS: offset of the invalid attribute in the original
	124	* message, counting from the beginning of the header (u32)
ba0dc5f6 JB	125	* @NLMSGERR_ATTR_COOKIE: arbitrary subsystem specific cookie to
	126	* be used - in the success case - to identify a created
	127	* object or operation or similar (binary)
2d4bc933 JB	128	* @__NLMSGERR_ATTR_MAX: number of attributes
	129	* @NLMSGERR_ATTR_MAX: highest attribute number
	130	*/
	131	enum nlmsgerr_attrs {
	132	NLMSGERR_ATTR_UNUSED,
	133	NLMSGERR_ATTR_MSG,
	134	NLMSGERR_ATTR_OFFS,
ba0dc5f6	135	NLMSGERR_ATTR_COOKIE,
2d4bc933 JB	136
	137	__NLMSGERR_ATTR_MAX,
	138	NLMSGERR_ATTR_MAX = __NLMSGERR_ATTR_MAX - 1
607ca46e DH	139	};
607ca46e DH	140
b42be38b DH	141	#define NETLINK_ADD_MEMBERSHIP 1
	142	#define NETLINK_DROP_MEMBERSHIP 2
	143	#define NETLINK_PKTINFO 3
	144	#define NETLINK_BROADCAST_ERROR 4
	145	#define NETLINK_NO_ENOBUFS 5
d1b4c689	146	#ifndef __KERNEL__
b42be38b DH	147	#define NETLINK_RX_RING 6
b42be38b DH	148	#define NETLINK_TX_RING 7
d1b4c689	149	#endif
b42be38b DH	150	#define NETLINK_LISTEN_ALL_NSID 8
b42be38b DH	151	#define NETLINK_LIST_MEMBERSHIPS 9
0a6a3a23	152	#define NETLINK_CAP_ACK 10
2d4bc933	153	#define NETLINK_EXT_ACK 11
607ca46e DH	154
	155	struct nl_pktinfo {
	156	__u32 group;
	157	};
	158
ccdfcc39 PM	159	struct nl_mmap_req {
	160	unsigned int nm_block_size;
	161	unsigned int nm_block_nr;
	162	unsigned int nm_frame_size;
	163	unsigned int nm_frame_nr;
	164	};
	165
	166	struct nl_mmap_hdr {
	167	unsigned int nm_status;
	168	unsigned int nm_len;
	169	__u32 nm_group;
	170	/* credentials */
	171	__u32 nm_pid;
	172	__u32 nm_uid;
	173	__u32 nm_gid;
	174	};
	175
d1b4c689	176	#ifndef __KERNEL__
ccdfcc39 PM	177	enum nl_mmap_status {
	178	NL_MMAP_STATUS_UNUSED,
	179	NL_MMAP_STATUS_RESERVED,
	180	NL_MMAP_STATUS_VALID,
	181	NL_MMAP_STATUS_COPY,
	182	NL_MMAP_STATUS_SKIP,
	183	};
	184
	185	#define NL_MMAP_MSG_ALIGNMENT NLMSG_ALIGNTO
	186	#define NL_MMAP_MSG_ALIGN(sz) __ALIGN_KERNEL(sz, NL_MMAP_MSG_ALIGNMENT)
	187	#define NL_MMAP_HDRLEN NL_MMAP_MSG_ALIGN(sizeof(struct nl_mmap_hdr))
d1b4c689	188	#endif
ccdfcc39	189
607ca46e DH	190	#define NET_MAJOR 36 /* Major 36 is reserved for networking */
	191
	192	enum {
	193	NETLINK_UNCONNECTED = 0,
	194	NETLINK_CONNECTED,
	195	};
	196
	197	/*
	198	* <------- NLA_HDRLEN ------> <-- NLA_ALIGN(payload)-->
	199	* +---------------------+- - -+- - - - - - - - - -+- - -+
	200	* \| Header \| Pad \| Payload \| Pad \|
	201	* \| (struct nlattr) \| ing \| \| ing \|
	202	* +---------------------+- - -+- - - - - - - - - -+- - -+
	203	* <-------------- nlattr->nla_len -------------->
	204	*/
	205
	206	struct nlattr {
	207	__u16 nla_len;
	208	__u16 nla_type;
	209	};
	210
	211	/*
	212	* nla_type (16 bits)
	213	* +---+---+-------------------------------+
	214	* \| N \| O \| Attribute Type \|
	215	* +---+---+-------------------------------+
	216	* N := Carries nested attributes
	217	* O := Payload stored in network byte order
	218	*
	219	* Note: The N and O flag are mutually exclusive.
	220	*/
	221	#define NLA_F_NESTED (1 << 15)
	222	#define NLA_F_NET_BYTEORDER (1 << 14)
	223	#define NLA_TYPE_MASK ~(NLA_F_NESTED \| NLA_F_NET_BYTEORDER)
	224
	225	#define NLA_ALIGNTO 4
	226	#define NLA_ALIGN(len) (((len) + NLA_ALIGNTO - 1) & ~(NLA_ALIGNTO - 1))
	227	#define NLA_HDRLEN ((int) NLA_ALIGN(sizeof(struct nlattr)))
	228
	229
	230	#endif /* _UAPI__LINUX_NETLINK_H */