uapi/linux/netlink.h

0001 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
0002 #ifndef _UAPI__LINUX_NETLINK_H
0003 #define _UAPI__LINUX_NETLINK_H
0004
0005 #include <linux/kernel.h>
0006 #include <linux/socket.h> /* for __kernel_sa_family_t */
0007 #include <linux/types.h>
0008
0009 #define NETLINK_ROUTE       0   /* Routing/device hook              */
0010 #define NETLINK_UNUSED      1   /* Unused number                */
0011 #define NETLINK_USERSOCK    2   /* Reserved for user mode socket protocols  */
0012 #define NETLINK_FIREWALL    3   /* Unused number, formerly ip_queue     */
0013 #define NETLINK_SOCK_DIAG   4   /* socket monitoring                */
0014 #define NETLINK_NFLOG       5   /* netfilter/iptables ULOG */
0015 #define NETLINK_XFRM        6   /* ipsec */
0016 #define NETLINK_SELINUX     7   /* SELinux event notifications */
0017 #define NETLINK_ISCSI       8   /* Open-iSCSI */
0018 #define NETLINK_AUDIT       9   /* auditing */
0019 #define NETLINK_FIB_LOOKUP  10
0020 #define NETLINK_CONNECTOR   11
0021 #define NETLINK_NETFILTER   12  /* netfilter subsystem */
0022 #define NETLINK_IP6_FW      13
0023 #define NETLINK_DNRTMSG     14  /* DECnet routing messages */
0024 #define NETLINK_KOBJECT_UEVENT  15  /* Kernel messages to userspace */
0025 #define NETLINK_GENERIC     16
0026 /* leave room for NETLINK_DM (DM Events) */
0027 #define NETLINK_SCSITRANSPORT   18  /* SCSI Transports */
0028 #define NETLINK_ECRYPTFS    19
0029 #define NETLINK_RDMA        20
0030 #define NETLINK_CRYPTO      21  /* Crypto layer */
0031 #define NETLINK_SMC     22  /* SMC monitoring */
0032
0033 #define NETLINK_INET_DIAG   NETLINK_SOCK_DIAG
0034
0035 #define MAX_LINKS 32
0036
0037 struct sockaddr_nl {
0038     __kernel_sa_family_t    nl_family;  /* AF_NETLINK   */
0039     unsigned short  nl_pad;     /* zero     */
0040     __u32       nl_pid;     /* port ID  */
0041         __u32       nl_groups;  /* multicast groups mask */
0042 };
0043
0044 struct nlmsghdr {
0045     __u32       nlmsg_len;  /* Length of message including header */
0046     __u16       nlmsg_type; /* Message content */
0047     __u16       nlmsg_flags;    /* Additional flags */
0048     __u32       nlmsg_seq;  /* Sequence number */
0049     __u32       nlmsg_pid;  /* Sending process port ID */
0050 };
0051
0052 /* Flags values */
0053
0054 #define NLM_F_REQUEST       0x01    /* It is request message.   */
0055 #define NLM_F_MULTI     0x02    /* Multipart message, terminated by NLMSG_DONE */
0056 #define NLM_F_ACK       0x04    /* Reply with ack, with zero or error code */
0057 #define NLM_F_ECHO      0x08    /* Echo this request        */
0058 #define NLM_F_DUMP_INTR     0x10    /* Dump was inconsistent due to sequence change */
0059 #define NLM_F_DUMP_FILTERED 0x20    /* Dump was filtered as requested */
0060
0061 /* Modifiers to GET request */
0062 #define NLM_F_ROOT  0x100   /* specify tree root    */
0063 #define NLM_F_MATCH 0x200   /* return all matching  */
0064 #define NLM_F_ATOMIC    0x400   /* atomic GET       */
0065 #define NLM_F_DUMP  (NLM_F_ROOT|NLM_F_MATCH)
0066
0067 /* Modifiers to NEW request */
0068 #define NLM_F_REPLACE   0x100   /* Override existing        */
0069 #define NLM_F_EXCL  0x200   /* Do not touch, if it exists   */
0070 #define NLM_F_CREATE    0x400   /* Create, if it does not exist */
0071 #define NLM_F_APPEND    0x800   /* Add to end of list       */
0072
0073 /* Modifiers to DELETE request */
0074 #define NLM_F_NONREC    0x100   /* Do not delete recursively    */
0075
0076 /* Flags for ACK message */
0077 #define NLM_F_CAPPED    0x100   /* request was capped */
0078 #define NLM_F_ACK_TLVS  0x200   /* extended ACK TVLs were included */
0079
0080 /*
0081    4.4BSD ADD       NLM_F_CREATE|NLM_F_EXCL
0082    4.4BSD CHANGE    NLM_F_REPLACE
0083
0084    True CHANGE      NLM_F_CREATE|NLM_F_REPLACE
0085    Append       NLM_F_CREATE
0086    Check        NLM_F_EXCL
0087  */
0088
0089 #define NLMSG_ALIGNTO   4U
0090 #define NLMSG_ALIGN(len) ( ((len)+NLMSG_ALIGNTO-1) & ~(NLMSG_ALIGNTO-1) )
0091 #define NLMSG_HDRLEN     ((int) NLMSG_ALIGN(sizeof(struct nlmsghdr)))
0092 #define NLMSG_LENGTH(len) ((len) + NLMSG_HDRLEN)
0093 #define NLMSG_SPACE(len) NLMSG_ALIGN(NLMSG_LENGTH(len))
0094 #define NLMSG_DATA(nlh)  ((void*)(((char*)nlh) + NLMSG_LENGTH(0)))
0095 #define NLMSG_NEXT(nlh,len)  ((len) -= NLMSG_ALIGN((nlh)->nlmsg_len), \
0096                   (struct nlmsghdr*)(((char*)(nlh)) + NLMSG_ALIGN((nlh)->nlmsg_len)))
0097 #define NLMSG_OK(nlh,len) ((len) >= (int)sizeof(struct nlmsghdr) && \
0098                (nlh)->nlmsg_len >= sizeof(struct nlmsghdr) && \
0099                (nlh)->nlmsg_len <= (len))
0100 #define NLMSG_PAYLOAD(nlh,len) ((nlh)->nlmsg_len - NLMSG_SPACE((len)))
0101
0102 #define NLMSG_NOOP      0x1 /* Nothing.     */
0103 #define NLMSG_ERROR     0x2 /* Error        */
0104 #define NLMSG_DONE      0x3 /* End of a dump    */
0105 #define NLMSG_OVERRUN       0x4 /* Data lost        */
0106
0107 #define NLMSG_MIN_TYPE      0x10    /* < 0x10: reserved control messages */
0108
0109 struct nlmsgerr {
0110     int     error;
0111     struct nlmsghdr msg;
0112     /*
0113      * followed by the message contents unless NETLINK_CAP_ACK was set
0114      * or the ACK indicates success (error == 0)
0115      * message length is aligned with NLMSG_ALIGN()
0116      */
0117     /*
0118      * followed by TLVs defined in enum nlmsgerr_attrs
0119      * if NETLINK_EXT_ACK was set
0120      */
0121 };
0122
0123 /**
0124  * enum nlmsgerr_attrs - nlmsgerr attributes
0125  * @NLMSGERR_ATTR_UNUSED: unused
0126  * @NLMSGERR_ATTR_MSG: error message string (string)
0127  * @NLMSGERR_ATTR_OFFS: offset of the invalid attribute in the original
0128  *   message, counting from the beginning of the header (u32)
0129  * @NLMSGERR_ATTR_COOKIE: arbitrary subsystem specific cookie to
0130  *  be used - in the success case - to identify a created
0131  *  object or operation or similar (binary)
0132  * @__NLMSGERR_ATTR_MAX: number of attributes
0133  * @NLMSGERR_ATTR_MAX: highest attribute number
0134  */
0135 enum nlmsgerr_attrs {
0136     NLMSGERR_ATTR_UNUSED,
0137     NLMSGERR_ATTR_MSG,
0138     NLMSGERR_ATTR_OFFS,
0139     NLMSGERR_ATTR_COOKIE,
0140
0141     __NLMSGERR_ATTR_MAX,
0142     NLMSGERR_ATTR_MAX = __NLMSGERR_ATTR_MAX - 1
0143 };
0144
0145 #define NETLINK_ADD_MEMBERSHIP      1
0146 #define NETLINK_DROP_MEMBERSHIP     2
0147 #define NETLINK_PKTINFO         3
0148 #define NETLINK_BROADCAST_ERROR     4
0149 #define NETLINK_NO_ENOBUFS      5
0150 #ifndef __KERNEL__
0151 #define NETLINK_RX_RING         6
0152 #define NETLINK_TX_RING         7
0153 #endif
0154 #define NETLINK_LISTEN_ALL_NSID     8
0155 #define NETLINK_LIST_MEMBERSHIPS    9
0156 #define NETLINK_CAP_ACK         10
0157 #define NETLINK_EXT_ACK         11
0158 #define NETLINK_GET_STRICT_CHK      12
0159
0160 struct nl_pktinfo {
0161     __u32   group;
0162 };
0163
0164 struct nl_mmap_req {
0165     unsigned int    nm_block_size;
0166     unsigned int    nm_block_nr;
0167     unsigned int    nm_frame_size;
0168     unsigned int    nm_frame_nr;
0169 };
0170
0171 struct nl_mmap_hdr {
0172     unsigned int    nm_status;
0173     unsigned int    nm_len;
0174     __u32       nm_group;
0175     /* credentials */
0176     __u32       nm_pid;
0177     __u32       nm_uid;
0178     __u32       nm_gid;
0179 };
0180
0181 #ifndef __KERNEL__
0182 enum nl_mmap_status {
0183     NL_MMAP_STATUS_UNUSED,
0184     NL_MMAP_STATUS_RESERVED,
0185     NL_MMAP_STATUS_VALID,
0186     NL_MMAP_STATUS_COPY,
0187     NL_MMAP_STATUS_SKIP,
0188 };
0189
0190 #define NL_MMAP_MSG_ALIGNMENT       NLMSG_ALIGNTO
0191 #define NL_MMAP_MSG_ALIGN(sz)       __ALIGN_KERNEL(sz, NL_MMAP_MSG_ALIGNMENT)
0192 #define NL_MMAP_HDRLEN          NL_MMAP_MSG_ALIGN(sizeof(struct nl_mmap_hdr))
0193 #endif
0194
0195 #define NET_MAJOR 36        /* Major 36 is reserved for networking                      */
0196
0197 enum {
0198     NETLINK_UNCONNECTED = 0,
0199     NETLINK_CONNECTED,
0200 };
0201
0202 /*
0203  *  <------- NLA_HDRLEN ------> <-- NLA_ALIGN(payload)-->
0204  * +---------------------+- - -+- - - - - - - - - -+- - -+
0205  * |        Header       | Pad |     Payload       | Pad |
0206  * |   (struct nlattr)   | ing |                   | ing |
0207  * +---------------------+- - -+- - - - - - - - - -+- - -+
0208  *  <-------------- nlattr->nla_len -------------->
0209  */
0210
0211 struct nlattr {
0212     __u16           nla_len;
0213     __u16           nla_type;
0214 };
0215
0216 /*
0217  * nla_type (16 bits)
0218  * +---+---+-------------------------------+
0219  * | N | O | Attribute Type                |
0220  * +---+---+-------------------------------+
0221  * N := Carries nested attributes
0222  * O := Payload stored in network byte order
0223  *
0224  * Note: The N and O flag are mutually exclusive.
0225  */
0226 #define NLA_F_NESTED        (1 << 15)
0227 #define NLA_F_NET_BYTEORDER (1 << 14)
0228 #define NLA_TYPE_MASK       ~(NLA_F_NESTED | NLA_F_NET_BYTEORDER)
0229
0230 #define NLA_ALIGNTO     4
0231 #define NLA_ALIGN(len)      (((len) + NLA_ALIGNTO - 1) & ~(NLA_ALIGNTO - 1))
0232 #define NLA_HDRLEN      ((int) NLA_ALIGN(sizeof(struct nlattr)))
0233
0234 /* Generic 32 bitflags attribute content sent to the kernel.
0235  *
0236  * The value is a bitmap that defines the values being set
0237  * The selector is a bitmask that defines which value is legit
0238  *
0239  * Examples:
0240  *  value = 0x0, and selector = 0x1
0241  *  implies we are selecting bit 1 and we want to set its value to 0.
0242  *
0243  *  value = 0x2, and selector = 0x2
0244  *  implies we are selecting bit 2 and we want to set its value to 1.
0245  *
0246  */
0247 struct nla_bitfield32 {
0248     __u32 value;
0249     __u32 selector;
0250 };
0251
0252 #endif /* _UAPI__LINUX_NETLINK_H */