1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2 #ifndef _UAPI__LINUX_NETLINK_H 3 #define _UAPI__LINUX_NETLINK_H 4 5 #include <linux/const.h> 6 #include <linux/socket.h> /* for __kernel_sa_family_t */ 7 #include <linux/types.h> 8 9 #define NETLINK_ROUTE 0 /* Routing/device hook */ 10 #define NETLINK_UNUSED 1 /* Unused number */ 11 #define NETLINK_USERSOCK 2 /* Reserved for user mode socket protocols */ 12 #define NETLINK_FIREWALL 3 /* Unused number, formerly ip_queue */ 13 #define NETLINK_SOCK_DIAG 4 /* socket monitoring */ 14 #define NETLINK_NFLOG 5 /* netfilter/iptables ULOG */ 15 #define NETLINK_XFRM 6 /* ipsec */ 16 #define NETLINK_SELINUX 7 /* SELinux event notifications */ 17 #define NETLINK_ISCSI 8 /* Open-iSCSI */ 18 #define NETLINK_AUDIT 9 /* auditing */ 19 #define NETLINK_FIB_LOOKUP 10 20 #define NETLINK_CONNECTOR 11 21 #define NETLINK_NETFILTER 12 /* netfilter subsystem */ 22 #define NETLINK_IP6_FW 13 23 #define NETLINK_DNRTMSG 14 /* DECnet routing messages */ 24 #define NETLINK_KOBJECT_UEVENT 15 /* Kernel messages to userspace */ 25 #define NETLINK_GENERIC 16 26 /* leave room for NETLINK_DM (DM Events) */ 27 #define NETLINK_SCSITRANSPORT 18 /* SCSI Transports */ 28 #define NETLINK_ECRYPTFS 19 29 #define NETLINK_RDMA 20 30 #define NETLINK_CRYPTO 21 /* Crypto layer */ 31 #define NETLINK_SMC 22 /* SMC monitoring */ 32 33 #define NETLINK_INET_DIAG NETLINK_SOCK_DIAG 34 35 #define MAX_LINKS 32 36 37 struct sockaddr_nl { 38 __kernel_sa_family_t nl_family; /* AF_NETLINK */ 39 unsigned short nl_pad; /* zero */ 40 uint32_t nl_pid; /* port ID */ 41 uint32_t nl_groups; /* multicast groups mask */ 42 }; 43 44 struct nlmsghdr { 45 uint32_t nlmsg_len; /* Length of message including header */ 46 uint16_t nlmsg_type; /* Message content */ 47 uint16_t nlmsg_flags; /* Additional flags */ 48 uint32_t nlmsg_seq; /* Sequence number */ 49 uint32_t nlmsg_pid; /* Sending process port ID */ 50 }; 51 52 /* Flags values */ 53 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 */ 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 73 /* Modifiers to DELETE request */ 74 #define NLM_F_NONREC 0x100 /* Do not delete recursively */ 75 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 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 89 #define NLMSG_ALIGNTO 4U 90 #define NLMSG_ALIGN(len) ( ((len)+NLMSG_ALIGNTO-1) & ~(NLMSG_ALIGNTO-1) ) 91 #define NLMSG_HDRLEN ((int) NLMSG_ALIGN(sizeof(struct nlmsghdr))) 92 #define NLMSG_LENGTH(len) ((len) + NLMSG_HDRLEN) 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 107 #define NLMSG_MIN_TYPE 0x10 /* < 0x10: reserved control messages */ 108 109 struct nlmsgerr { 110 int error; 111 struct nlmsghdr msg; 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_POLICY: policy for a rejected attribute 133 * @__NLMSGERR_ATTR_MAX: number of attributes 134 * @NLMSGERR_ATTR_MAX: highest attribute number 135 */ 136 enum nlmsgerr_attrs { 137 NLMSGERR_ATTR_UNUSED, 138 NLMSGERR_ATTR_MSG, 139 NLMSGERR_ATTR_OFFS, 140 NLMSGERR_ATTR_COOKIE, 141 NLMSGERR_ATTR_POLICY, 142 143 __NLMSGERR_ATTR_MAX, 144 NLMSGERR_ATTR_MAX = __NLMSGERR_ATTR_MAX - 1 145 }; 146 147 #define NETLINK_ADD_MEMBERSHIP 1 148 #define NETLINK_DROP_MEMBERSHIP 2 149 #define NETLINK_PKTINFO 3 150 #define NETLINK_BROADCAST_ERROR 4 151 #define NETLINK_NO_ENOBUFS 5 152 #ifndef __KERNEL__ 153 #define NETLINK_RX_RING 6 154 #define NETLINK_TX_RING 7 155 #endif 156 #define NETLINK_LISTEN_ALL_NSID 8 157 #define NETLINK_LIST_MEMBERSHIPS 9 158 #define NETLINK_CAP_ACK 10 159 #define NETLINK_EXT_ACK 11 160 #define NETLINK_GET_STRICT_CHK 12 161 162 struct nl_pktinfo { 163 uint32_t group; 164 }; 165 166 struct nl_mmap_req { 167 unsigned int nm_block_size; 168 unsigned int nm_block_nr; 169 unsigned int nm_frame_size; 170 unsigned int nm_frame_nr; 171 }; 172 173 struct nl_mmap_hdr { 174 unsigned int nm_status; 175 unsigned int nm_len; 176 uint32_t nm_group; 177 /* credentials */ 178 uint32_t nm_pid; 179 uint32_t nm_uid; 180 uint32_t nm_gid; 181 }; 182 183 #ifndef __KERNEL__ 184 enum nl_mmap_status { 185 NL_MMAP_STATUS_UNUSED, 186 NL_MMAP_STATUS_RESERVED, 187 NL_MMAP_STATUS_VALID, 188 NL_MMAP_STATUS_COPY, 189 NL_MMAP_STATUS_SKIP, 190 }; 191 192 #define NL_MMAP_MSG_ALIGNMENT NLMSG_ALIGNTO 193 #define NL_MMAP_MSG_ALIGN(sz) __ALIGN_KERNEL(sz, NL_MMAP_MSG_ALIGNMENT) 194 #define NL_MMAP_HDRLEN NL_MMAP_MSG_ALIGN(sizeof(struct nl_mmap_hdr)) 195 #endif 196 197 #define NET_MAJOR 36 /* Major 36 is reserved for networking */ 198 199 enum { 200 NETLINK_UNCONNECTED = 0, 201 NETLINK_CONNECTED, 202 }; 203 204 /* 205 * <------- NLA_HDRLEN ------> <-- NLA_ALIGN(payload)--> 206 * +---------------------+- - -+- - - - - - - - - -+- - -+ 207 * | Header | Pad | Payload | Pad | 208 * | (struct nlattr) | ing | | ing | 209 * +---------------------+- - -+- - - - - - - - - -+- - -+ 210 * <-------------- nlattr->nla_len --------------> 211 */ 212 213 struct nlattr { 214 uint16_t nla_len; 215 uint16_t nla_type; 216 }; 217 218 /* 219 * nla_type (16 bits) 220 * +---+---+-------------------------------+ 221 * | N | O | Attribute Type | 222 * +---+---+-------------------------------+ 223 * N := Carries nested attributes 224 * O := Payload stored in network byte order 225 * 226 * Note: The N and O flag are mutually exclusive. 227 */ 228 #define NLA_F_NESTED (1 << 15) 229 #define NLA_F_NET_BYTEORDER (1 << 14) 230 #define NLA_TYPE_MASK ~(NLA_F_NESTED | NLA_F_NET_BYTEORDER) 231 232 #define NLA_ALIGNTO 4 233 #define NLA_ALIGN(len) (((len) + NLA_ALIGNTO - 1) & ~(NLA_ALIGNTO - 1)) 234 #define NLA_HDRLEN ((int) NLA_ALIGN(sizeof(struct nlattr))) 235 236 /* Generic 32 bitflags attribute content sent to the kernel. 237 * 238 * The value is a bitmap that defines the values being set 239 * The selector is a bitmask that defines which value is legit 240 * 241 * Examples: 242 * value = 0x0, and selector = 0x1 243 * implies we are selecting bit 1 and we want to set its value to 0. 244 * 245 * value = 0x2, and selector = 0x2 246 * implies we are selecting bit 2 and we want to set its value to 1. 247 * 248 */ 249 struct nla_bitfield32 { 250 uint32_t value; 251 uint32_t selector; 252 }; 253 254 /* 255 * policy descriptions - it's specific to each family how this is used 256 * Normally, it should be retrieved via a dump inside another attribute 257 * specifying where it applies. 258 */ 259 260 /** 261 * enum netlink_attribute_type - type of an attribute 262 * @NL_ATTR_TYPE_INVALID: unused 263 * @NL_ATTR_TYPE_FLAG: flag attribute (present/not present) 264 * @NL_ATTR_TYPE_U8: 8-bit unsigned attribute 265 * @NL_ATTR_TYPE_U16: 16-bit unsigned attribute 266 * @NL_ATTR_TYPE_U32: 32-bit unsigned attribute 267 * @NL_ATTR_TYPE_U64: 64-bit unsigned attribute 268 * @NL_ATTR_TYPE_S8: 8-bit signed attribute 269 * @NL_ATTR_TYPE_S16: 16-bit signed attribute 270 * @NL_ATTR_TYPE_S32: 32-bit signed attribute 271 * @NL_ATTR_TYPE_S64: 64-bit signed attribute 272 * @NL_ATTR_TYPE_BINARY: binary data, min/max length may be specified 273 * @NL_ATTR_TYPE_STRING: string, min/max length may be specified 274 * @NL_ATTR_TYPE_NUL_STRING: NUL-terminated string, 275 * min/max length may be specified 276 * @NL_ATTR_TYPE_NESTED: nested, i.e. the content of this attribute 277 * consists of sub-attributes. The nested policy and maxtype 278 * inside may be specified. 279 * @NL_ATTR_TYPE_NESTED_ARRAY: nested array, i.e. the content of this 280 * attribute contains sub-attributes whose type is irrelevant 281 * (just used to separate the array entries) and each such array 282 * entry has attributes again, the policy for those inner ones 283 * and the corresponding maxtype may be specified. 284 * @NL_ATTR_TYPE_BITFIELD32: &struct nla_bitfield32 attribute 285 */ 286 enum netlink_attribute_type { 287 NL_ATTR_TYPE_INVALID, 288 289 NL_ATTR_TYPE_FLAG, 290 291 NL_ATTR_TYPE_U8, 292 NL_ATTR_TYPE_U16, 293 NL_ATTR_TYPE_U32, 294 NL_ATTR_TYPE_U64, 295 296 NL_ATTR_TYPE_S8, 297 NL_ATTR_TYPE_S16, 298 NL_ATTR_TYPE_S32, 299 NL_ATTR_TYPE_S64, 300 301 NL_ATTR_TYPE_BINARY, 302 NL_ATTR_TYPE_STRING, 303 NL_ATTR_TYPE_NUL_STRING, 304 305 NL_ATTR_TYPE_NESTED, 306 NL_ATTR_TYPE_NESTED_ARRAY, 307 308 NL_ATTR_TYPE_BITFIELD32, 309 }; 310 311 /** 312 * enum netlink_policy_type_attr - policy type attributes 313 * @NL_POLICY_TYPE_ATTR_UNSPEC: unused 314 * @NL_POLICY_TYPE_ATTR_TYPE: type of the attribute, 315 * &enum netlink_attribute_type (U32) 316 * @NL_POLICY_TYPE_ATTR_MIN_VALUE_S: minimum value for signed 317 * integers (S64) 318 * @NL_POLICY_TYPE_ATTR_MAX_VALUE_S: maximum value for signed 319 * integers (S64) 320 * @NL_POLICY_TYPE_ATTR_MIN_VALUE_U: minimum value for unsigned 321 * integers (U64) 322 * @NL_POLICY_TYPE_ATTR_MAX_VALUE_U: maximum value for unsigned 323 * integers (U64) 324 * @NL_POLICY_TYPE_ATTR_MIN_LENGTH: minimum length for binary 325 * attributes, no minimum if not given (U32) 326 * @NL_POLICY_TYPE_ATTR_MAX_LENGTH: maximum length for binary 327 * attributes, no maximum if not given (U32) 328 * @NL_POLICY_TYPE_ATTR_POLICY_IDX: sub policy for nested and 329 * nested array types (U32) 330 * @NL_POLICY_TYPE_ATTR_POLICY_MAXTYPE: maximum sub policy 331 * attribute for nested and nested array types, this can 332 * in theory be < the size of the policy pointed to by 333 * the index, if limited inside the nesting (U32) 334 * @NL_POLICY_TYPE_ATTR_BITFIELD32_MASK: valid mask for the 335 * bitfield32 type (U32) 336 * @NL_POLICY_TYPE_ATTR_MASK: mask of valid bits for unsigned integers (U64) 337 * @NL_POLICY_TYPE_ATTR_PAD: pad attribute for 64-bit alignment 338 */ 339 enum netlink_policy_type_attr { 340 NL_POLICY_TYPE_ATTR_UNSPEC, 341 NL_POLICY_TYPE_ATTR_TYPE, 342 NL_POLICY_TYPE_ATTR_MIN_VALUE_S, 343 NL_POLICY_TYPE_ATTR_MAX_VALUE_S, 344 NL_POLICY_TYPE_ATTR_MIN_VALUE_U, 345 NL_POLICY_TYPE_ATTR_MAX_VALUE_U, 346 NL_POLICY_TYPE_ATTR_MIN_LENGTH, 347 NL_POLICY_TYPE_ATTR_MAX_LENGTH, 348 NL_POLICY_TYPE_ATTR_POLICY_IDX, 349 NL_POLICY_TYPE_ATTR_POLICY_MAXTYPE, 350 NL_POLICY_TYPE_ATTR_BITFIELD32_MASK, 351 NL_POLICY_TYPE_ATTR_PAD, 352 NL_POLICY_TYPE_ATTR_MASK, 353 354 /* keep last */ 355 __NL_POLICY_TYPE_ATTR_MAX, 356 NL_POLICY_TYPE_ATTR_MAX = __NL_POLICY_TYPE_ATTR_MAX - 1 357 }; 358 359 #endif /* _UAPI__LINUX_NETLINK_H */ 360