]> git.proxmox.com Git - mirror_iproute2.git/blame - include/uapi/linux/netlink.h
Update kernel headers
[mirror_iproute2.git] / include / uapi / linux / netlink.h
CommitLineData
ba914908 1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
910773dc
SH
2#ifndef __LINUX_NETLINK_H
3#define __LINUX_NETLINK_H
0633baa1 4
79e9a1db 5#include <linux/kernel.h>
9044a454 6#include <linux/socket.h> /* for __kernel_sa_family_t */
0633baa1
SH
7#include <linux/types.h>
8
9#define NETLINK_ROUTE 0 /* Routing/device hook */
1d35a127 10#define NETLINK_UNUSED 1 /* Unused number */
0633baa1 11#define NETLINK_USERSOCK 2 /* Reserved for user mode socket protocols */
5e4dc84f 12#define NETLINK_FIREWALL 3 /* Unused number, formerly ip_queue */
a08d2590 13#define NETLINK_SOCK_DIAG 4 /* socket monitoring */
0633baa1
SH
14#define NETLINK_NFLOG 5 /* netfilter/iptables ULOG */
15#define NETLINK_XFRM 6 /* ipsec */
16#define NETLINK_SELINUX 7 /* SELinux event notifications */
351efcde 17#define NETLINK_ISCSI 8 /* Open-iSCSI */
0633baa1 18#define NETLINK_AUDIT 9 /* auditing */
6864c1e7 19#define NETLINK_FIB_LOOKUP 10
2034ee97 20#define NETLINK_CONNECTOR 11
6864c1e7 21#define NETLINK_NETFILTER 12 /* netfilter subsystem */
0633baa1
SH
22#define NETLINK_IP6_FW 13
23#define NETLINK_DNRTMSG 14 /* DECnet routing messages */
d639d9d1 24#define NETLINK_KOBJECT_UEVENT 15 /* Kernel messages to userspace */
2034ee97 25#define NETLINK_GENERIC 16
ead2ba70
SH
26/* leave room for NETLINK_DM (DM Events) */
27#define NETLINK_SCSITRANSPORT 18 /* SCSI Transports */
de3d12f4 28#define NETLINK_ECRYPTFS 19
e760a19a 29#define NETLINK_RDMA 20
9044a454 30#define NETLINK_CRYPTO 21 /* Crypto layer */
e2ade8ce 31#define NETLINK_SMC 22 /* SMC monitoring */
0633baa1 32
a08d2590
SH
33#define NETLINK_INET_DIAG NETLINK_SOCK_DIAG
34
0633baa1
SH
35#define MAX_LINKS 32
36
ab322673 37struct sockaddr_nl {
707f612c 38 __kernel_sa_family_t nl_family; /* AF_NETLINK */
0633baa1 39 unsigned short nl_pad; /* zero */
de3d12f4 40 __u32 nl_pid; /* port ID */
0633baa1
SH
41 __u32 nl_groups; /* multicast groups mask */
42};
43
ab322673 44struct nlmsghdr {
0633baa1
SH
45 __u32 nlmsg_len; /* Length of message including header */
46 __u16 nlmsg_type; /* Message content */
47 __u16 nlmsg_flags; /* Additional flags */
48 __u32 nlmsg_seq; /* Sequence number */
de3d12f4 49 __u32 nlmsg_pid; /* Sending process port ID */
0633baa1
SH
50};
51
52/* Flags values */
53
2c6a0636
SH
54#define NLM_F_REQUEST 0x01 /* It is request message. */
55#define NLM_F_MULTI 0x02 /* Multipart message, terminated by NLMSG_DONE */
56#define NLM_F_ACK 0x04 /* Reply with ack, with zero or error code */
57#define NLM_F_ECHO 0x08 /* Echo this request */
58#define NLM_F_DUMP_INTR 0x10 /* Dump was inconsistent due to sequence change */
59#define NLM_F_DUMP_FILTERED 0x20 /* Dump was filtered as requested */
0633baa1
SH
60
61/* Modifiers to GET request */
62#define NLM_F_ROOT 0x100 /* specify tree root */
63#define NLM_F_MATCH 0x200 /* return all matching */
64#define NLM_F_ATOMIC 0x400 /* atomic GET */
65#define NLM_F_DUMP (NLM_F_ROOT|NLM_F_MATCH)
66
67/* Modifiers to NEW request */
68#define NLM_F_REPLACE 0x100 /* Override existing */
69#define NLM_F_EXCL 0x200 /* Do not touch, if it exists */
70#define NLM_F_CREATE 0x400 /* Create, if it does not exist */
71#define NLM_F_APPEND 0x800 /* Add to end of list */
72
4a5b3035
SH
73/* Modifiers to DELETE request */
74#define NLM_F_NONREC 0x100 /* Do not delete recursively */
75
2c6a0636
SH
76/* Flags for ACK message */
77#define NLM_F_CAPPED 0x100 /* request was capped */
78#define NLM_F_ACK_TLVS 0x200 /* extended ACK TVLs were included */
79
0633baa1
SH
80/*
81 4.4BSD ADD NLM_F_CREATE|NLM_F_EXCL
82 4.4BSD CHANGE NLM_F_REPLACE
83
84 True CHANGE NLM_F_CREATE|NLM_F_REPLACE
85 Append NLM_F_CREATE
86 Check NLM_F_EXCL
87 */
88
8552b387 89#define NLMSG_ALIGNTO 4U
0633baa1 90#define NLMSG_ALIGN(len) ( ((len)+NLMSG_ALIGNTO-1) & ~(NLMSG_ALIGNTO-1) )
09954dc6 91#define NLMSG_HDRLEN ((int) NLMSG_ALIGN(sizeof(struct nlmsghdr)))
79e9a1db 92#define NLMSG_LENGTH(len) ((len) + NLMSG_HDRLEN)
0633baa1
SH
93#define NLMSG_SPACE(len) NLMSG_ALIGN(NLMSG_LENGTH(len))
94#define NLMSG_DATA(nlh) ((void*)(((char*)nlh) + NLMSG_LENGTH(0)))
95#define NLMSG_NEXT(nlh,len) ((len) -= NLMSG_ALIGN((nlh)->nlmsg_len), \
96 (struct nlmsghdr*)(((char*)(nlh)) + NLMSG_ALIGN((nlh)->nlmsg_len)))
97#define NLMSG_OK(nlh,len) ((len) >= (int)sizeof(struct nlmsghdr) && \
98 (nlh)->nlmsg_len >= sizeof(struct nlmsghdr) && \
99 (nlh)->nlmsg_len <= (len))
100#define NLMSG_PAYLOAD(nlh,len) ((nlh)->nlmsg_len - NLMSG_SPACE((len)))
101
102#define NLMSG_NOOP 0x1 /* Nothing. */
103#define NLMSG_ERROR 0x2 /* Error */
104#define NLMSG_DONE 0x3 /* End of a dump */
105#define NLMSG_OVERRUN 0x4 /* Data lost */
106
09954dc6
SH
107#define NLMSG_MIN_TYPE 0x10 /* < 0x10: reserved control messages */
108
ab322673 109struct nlmsgerr {
0633baa1
SH
110 int error;
111 struct nlmsghdr msg;
2c6a0636
SH
112 /*
113 * followed by the message contents unless NETLINK_CAP_ACK was set
114 * or the ACK indicates success (error == 0)
115 * message length is aligned with NLMSG_ALIGN()
116 */
117 /*
118 * followed by TLVs defined in enum nlmsgerr_attrs
119 * if NETLINK_EXT_ACK was set
120 */
121};
122
123/**
124 * enum nlmsgerr_attrs - nlmsgerr attributes
125 * @NLMSGERR_ATTR_UNUSED: unused
126 * @NLMSGERR_ATTR_MSG: error message string (string)
127 * @NLMSGERR_ATTR_OFFS: offset of the invalid attribute in the original
128 * message, counting from the beginning of the header (u32)
129 * @NLMSGERR_ATTR_COOKIE: arbitrary subsystem specific cookie to
130 * be used - in the success case - to identify a created
131 * object or operation or similar (binary)
132 * @__NLMSGERR_ATTR_MAX: number of attributes
133 * @NLMSGERR_ATTR_MAX: highest attribute number
134 */
135enum nlmsgerr_attrs {
136 NLMSGERR_ATTR_UNUSED,
137 NLMSGERR_ATTR_MSG,
138 NLMSGERR_ATTR_OFFS,
139 NLMSGERR_ATTR_COOKIE,
140
141 __NLMSGERR_ATTR_MAX,
142 NLMSGERR_ATTR_MAX = __NLMSGERR_ATTR_MAX - 1
0633baa1
SH
143};
144
ff631c3a
SH
145#define NETLINK_ADD_MEMBERSHIP 1
146#define NETLINK_DROP_MEMBERSHIP 2
147#define NETLINK_PKTINFO 3
148#define NETLINK_BROADCAST_ERROR 4
149#define NETLINK_NO_ENOBUFS 5
150#define NETLINK_RX_RING 6
151#define NETLINK_TX_RING 7
152#define NETLINK_LISTEN_ALL_NSID 8
153#define NETLINK_LIST_MEMBERSHIPS 9
8d62f3e2 154#define NETLINK_CAP_ACK 10
2c6a0636 155#define NETLINK_EXT_ACK 11
fdce94d0 156#define NETLINK_GET_STRICT_CHK 12
351efcde 157
ab322673 158struct nl_pktinfo {
351efcde
SH
159 __u32 group;
160};
161
79e9a1db
SH
162struct nl_mmap_req {
163 unsigned int nm_block_size;
164 unsigned int nm_block_nr;
165 unsigned int nm_frame_size;
166 unsigned int nm_frame_nr;
167};
168
169struct nl_mmap_hdr {
170 unsigned int nm_status;
171 unsigned int nm_len;
172 __u32 nm_group;
173 /* credentials */
174 __u32 nm_pid;
175 __u32 nm_uid;
176 __u32 nm_gid;
177};
178
179enum nl_mmap_status {
180 NL_MMAP_STATUS_UNUSED,
181 NL_MMAP_STATUS_RESERVED,
182 NL_MMAP_STATUS_VALID,
183 NL_MMAP_STATUS_COPY,
184 NL_MMAP_STATUS_SKIP,
185};
186
187#define NL_MMAP_MSG_ALIGNMENT NLMSG_ALIGNTO
188#define NL_MMAP_MSG_ALIGN(sz) __ALIGN_KERNEL(sz, NL_MMAP_MSG_ALIGNMENT)
189#define NL_MMAP_HDRLEN NL_MMAP_MSG_ALIGN(sizeof(struct nl_mmap_hdr))
190
0633baa1
SH
191#define NET_MAJOR 36 /* Major 36 is reserved for networking */
192
193enum {
194 NETLINK_UNCONNECTED = 0,
195 NETLINK_CONNECTED,
196};
197
09954dc6
SH
198/*
199 * <------- NLA_HDRLEN ------> <-- NLA_ALIGN(payload)-->
200 * +---------------------+- - -+- - - - - - - - - -+- - -+
201 * | Header | Pad | Payload | Pad |
202 * | (struct nlattr) | ing | | ing |
203 * +---------------------+- - -+- - - - - - - - - -+- - -+
204 * <-------------- nlattr->nla_len -------------->
205 */
206
ab322673 207struct nlattr {
09954dc6
SH
208 __u16 nla_len;
209 __u16 nla_type;
210};
211
5472ac6f
SH
212/*
213 * nla_type (16 bits)
214 * +---+---+-------------------------------+
215 * | N | O | Attribute Type |
216 * +---+---+-------------------------------+
217 * N := Carries nested attributes
218 * O := Payload stored in network byte order
219 *
220 * Note: The N and O flag are mutually exclusive.
221 */
222#define NLA_F_NESTED (1 << 15)
223#define NLA_F_NET_BYTEORDER (1 << 14)
224#define NLA_TYPE_MASK ~(NLA_F_NESTED | NLA_F_NET_BYTEORDER)
225
09954dc6
SH
226#define NLA_ALIGNTO 4
227#define NLA_ALIGN(len) (((len) + NLA_ALIGNTO - 1) & ~(NLA_ALIGNTO - 1))
228#define NLA_HDRLEN ((int) NLA_ALIGN(sizeof(struct nlattr)))
229
72e4ea5e
SH
230/* Generic 32 bitflags attribute content sent to the kernel.
231 *
232 * The value is a bitmap that defines the values being set
233 * The selector is a bitmask that defines which value is legit
234 *
235 * Examples:
236 * value = 0x0, and selector = 0x1
237 * implies we are selecting bit 1 and we want to set its value to 0.
238 *
239 * value = 0x2, and selector = 0x2
240 * implies we are selecting bit 2 and we want to set its value to 1.
241 *
242 */
243struct nla_bitfield32 {
244 __u32 value;
245 __u32 selector;
246};
0633baa1 247
ae57e82d
DA
248/*
249 * policy descriptions - it's specific to each family how this is used
250 * Normally, it should be retrieved via a dump inside another attribute
251 * specifying where it applies.
252 */
253
254/**
255 * enum netlink_attribute_type - type of an attribute
256 * @NL_ATTR_TYPE_INVALID: unused
257 * @NL_ATTR_TYPE_FLAG: flag attribute (present/not present)
258 * @NL_ATTR_TYPE_U8: 8-bit unsigned attribute
259 * @NL_ATTR_TYPE_U16: 16-bit unsigned attribute
260 * @NL_ATTR_TYPE_U32: 32-bit unsigned attribute
261 * @NL_ATTR_TYPE_U64: 64-bit unsigned attribute
262 * @NL_ATTR_TYPE_S8: 8-bit signed attribute
263 * @NL_ATTR_TYPE_S16: 16-bit signed attribute
264 * @NL_ATTR_TYPE_S32: 32-bit signed attribute
265 * @NL_ATTR_TYPE_S64: 64-bit signed attribute
266 * @NL_ATTR_TYPE_BINARY: binary data, min/max length may be specified
267 * @NL_ATTR_TYPE_STRING: string, min/max length may be specified
268 * @NL_ATTR_TYPE_NUL_STRING: NUL-terminated string,
269 * min/max length may be specified
270 * @NL_ATTR_TYPE_NESTED: nested, i.e. the content of this attribute
271 * consists of sub-attributes. The nested policy and maxtype
272 * inside may be specified.
273 * @NL_ATTR_TYPE_NESTED_ARRAY: nested array, i.e. the content of this
274 * attribute contains sub-attributes whose type is irrelevant
275 * (just used to separate the array entries) and each such array
276 * entry has attributes again, the policy for those inner ones
277 * and the corresponding maxtype may be specified.
278 * @NL_ATTR_TYPE_BITFIELD32: &struct nla_bitfield32 attribute
279 */
280enum netlink_attribute_type {
281 NL_ATTR_TYPE_INVALID,
282
283 NL_ATTR_TYPE_FLAG,
284
285 NL_ATTR_TYPE_U8,
286 NL_ATTR_TYPE_U16,
287 NL_ATTR_TYPE_U32,
288 NL_ATTR_TYPE_U64,
289
290 NL_ATTR_TYPE_S8,
291 NL_ATTR_TYPE_S16,
292 NL_ATTR_TYPE_S32,
293 NL_ATTR_TYPE_S64,
294
295 NL_ATTR_TYPE_BINARY,
296 NL_ATTR_TYPE_STRING,
297 NL_ATTR_TYPE_NUL_STRING,
298
299 NL_ATTR_TYPE_NESTED,
300 NL_ATTR_TYPE_NESTED_ARRAY,
301
302 NL_ATTR_TYPE_BITFIELD32,
303};
304
305/**
306 * enum netlink_policy_type_attr - policy type attributes
307 * @NL_POLICY_TYPE_ATTR_UNSPEC: unused
308 * @NL_POLICY_TYPE_ATTR_TYPE: type of the attribute,
309 * &enum netlink_attribute_type (U32)
310 * @NL_POLICY_TYPE_ATTR_MIN_VALUE_S: minimum value for signed
311 * integers (S64)
312 * @NL_POLICY_TYPE_ATTR_MAX_VALUE_S: maximum value for signed
313 * integers (S64)
314 * @NL_POLICY_TYPE_ATTR_MIN_VALUE_U: minimum value for unsigned
315 * integers (U64)
316 * @NL_POLICY_TYPE_ATTR_MAX_VALUE_U: maximum value for unsigned
317 * integers (U64)
318 * @NL_POLICY_TYPE_ATTR_MIN_LENGTH: minimum length for binary
319 * attributes, no minimum if not given (U32)
320 * @NL_POLICY_TYPE_ATTR_MAX_LENGTH: maximum length for binary
321 * attributes, no maximum if not given (U32)
322 * @NL_POLICY_TYPE_ATTR_POLICY_IDX: sub policy for nested and
323 * nested array types (U32)
324 * @NL_POLICY_TYPE_ATTR_POLICY_MAXTYPE: maximum sub policy
325 * attribute for nested and nested array types, this can
326 * in theory be < the size of the policy pointed to by
327 * the index, if limited inside the nesting (U32)
328 * @NL_POLICY_TYPE_ATTR_BITFIELD32_MASK: valid mask for the
329 * bitfield32 type (U32)
330 * @NL_POLICY_TYPE_ATTR_PAD: pad attribute for 64-bit alignment
331 */
332enum netlink_policy_type_attr {
333 NL_POLICY_TYPE_ATTR_UNSPEC,
334 NL_POLICY_TYPE_ATTR_TYPE,
335 NL_POLICY_TYPE_ATTR_MIN_VALUE_S,
336 NL_POLICY_TYPE_ATTR_MAX_VALUE_S,
337 NL_POLICY_TYPE_ATTR_MIN_VALUE_U,
338 NL_POLICY_TYPE_ATTR_MAX_VALUE_U,
339 NL_POLICY_TYPE_ATTR_MIN_LENGTH,
340 NL_POLICY_TYPE_ATTR_MAX_LENGTH,
341 NL_POLICY_TYPE_ATTR_POLICY_IDX,
342 NL_POLICY_TYPE_ATTR_POLICY_MAXTYPE,
343 NL_POLICY_TYPE_ATTR_BITFIELD32_MASK,
344 NL_POLICY_TYPE_ATTR_PAD,
345
346 /* keep last */
347 __NL_POLICY_TYPE_ATTR_MAX,
348 NL_POLICY_TYPE_ATTR_MAX = __NL_POLICY_TYPE_ATTR_MAX - 1
349};
350
910773dc 351#endif /* __LINUX_NETLINK_H */