• source navigation  • diff markup  • identifier search  • freetext search  • 

Sources/ucode/include/linux/netlink.h

  1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
  2 #ifndef __LINUX_NETLINK_H
  3 #define __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         __u32           nl_pid;         /* port ID      */
 41         __u32           nl_groups;      /* multicast groups mask */
 42 };
 43 
 44 struct nlmsghdr {
 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 */
 49         __u32           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 #define NETLINK_RX_RING                 6
153 #define NETLINK_TX_RING                 7
154 #define NETLINK_LISTEN_ALL_NSID         8
155 #define NETLINK_LIST_MEMBERSHIPS        9
156 #define NETLINK_CAP_ACK                 10
157 #define NETLINK_EXT_ACK                 11
158 #define NETLINK_GET_STRICT_CHK          12
159 
160 struct nl_pktinfo {
161         __u32   group;
162 };
163 
164 struct nl_mmap_req {
165         unsigned int    nm_block_size;
166         unsigned int    nm_block_nr;
167         unsigned int    nm_frame_size;
168         unsigned int    nm_frame_nr;
169 };
170 
171 struct nl_mmap_hdr {
172         unsigned int    nm_status;
173         unsigned int    nm_len;
174         __u32           nm_group;
175         /* credentials */
176         __u32           nm_pid;
177         __u32           nm_uid;
178         __u32           nm_gid;
179 };
180 
181 enum nl_mmap_status {
182         NL_MMAP_STATUS_UNUSED,
183         NL_MMAP_STATUS_RESERVED,
184         NL_MMAP_STATUS_VALID,
185         NL_MMAP_STATUS_COPY,
186         NL_MMAP_STATUS_SKIP,
187 };
188 
189 #define NL_MMAP_MSG_ALIGNMENT           NLMSG_ALIGNTO
190 #define NL_MMAP_MSG_ALIGN(sz)           __ALIGN_KERNEL(sz, NL_MMAP_MSG_ALIGNMENT)
191 #define NL_MMAP_HDRLEN                  NL_MMAP_MSG_ALIGN(sizeof(struct nl_mmap_hdr))
192 
193 #define NET_MAJOR 36            /* Major 36 is reserved for networking                                          */
194 
195 enum {
196         NETLINK_UNCONNECTED = 0,
197         NETLINK_CONNECTED,
198 };
199 
200 /*
201  *  <------- NLA_HDRLEN ------> <-- NLA_ALIGN(payload)-->
202  * +---------------------+- - -+- - - - - - - - - -+- - -+
203  * |        Header       | Pad |     Payload       | Pad |
204  * |   (struct nlattr)   | ing |                   | ing |
205  * +---------------------+- - -+- - - - - - - - - -+- - -+
206  *  <-------------- nlattr->nla_len -------------->
207  */
208 
209 struct nlattr {
210         __u16           nla_len;
211         __u16           nla_type;
212 };
213 
214 /*
215  * nla_type (16 bits)
216  * +---+---+-------------------------------+
217  * | N | O | Attribute Type                |
218  * +---+---+-------------------------------+
219  * N := Carries nested attributes
220  * O := Payload stored in network byte order
221  *
222  * Note: The N and O flag are mutually exclusive.
223  */
224 #define NLA_F_NESTED            (1 << 15)
225 #define NLA_F_NET_BYTEORDER     (1 << 14)
226 #define NLA_TYPE_MASK           ~(NLA_F_NESTED | NLA_F_NET_BYTEORDER)
227 
228 #define NLA_ALIGNTO             4
229 #define NLA_ALIGN(len)          (((len) + NLA_ALIGNTO - 1) & ~(NLA_ALIGNTO - 1))
230 #define NLA_HDRLEN              ((int) NLA_ALIGN(sizeof(struct nlattr)))
231 
232 /* Generic 32 bitflags attribute content sent to the kernel.
233  *
234  * The value is a bitmap that defines the values being set
235  * The selector is a bitmask that defines which value is legit
236  *
237  * Examples:
238  *  value = 0x0, and selector = 0x1
239  *  implies we are selecting bit 1 and we want to set its value to 0.
240  *
241  *  value = 0x2, and selector = 0x2
242  *  implies we are selecting bit 2 and we want to set its value to 1.
243  *
244  */
245 struct nla_bitfield32 {
246         __u32 value;
247         __u32 selector;
248 };
249 
250 /*
251  * policy descriptions - it's specific to each family how this is used
252  * Normally, it should be retrieved via a dump inside another attribute
253  * specifying where it applies.
254  */
255 
256 /**
257  * enum netlink_attribute_type - type of an attribute
258  * @NL_ATTR_TYPE_INVALID: unused
259  * @NL_ATTR_TYPE_FLAG: flag attribute (present/not present)
260  * @NL_ATTR_TYPE_U8: 8-bit unsigned attribute
261  * @NL_ATTR_TYPE_U16: 16-bit unsigned attribute
262  * @NL_ATTR_TYPE_U32: 32-bit unsigned attribute
263  * @NL_ATTR_TYPE_U64: 64-bit unsigned attribute
264  * @NL_ATTR_TYPE_S8: 8-bit signed attribute
265  * @NL_ATTR_TYPE_S16: 16-bit signed attribute
266  * @NL_ATTR_TYPE_S32: 32-bit signed attribute
267  * @NL_ATTR_TYPE_S64: 64-bit signed attribute
268  * @NL_ATTR_TYPE_BINARY: binary data, min/max length may be specified
269  * @NL_ATTR_TYPE_STRING: string, min/max length may be specified
270  * @NL_ATTR_TYPE_NUL_STRING: NUL-terminated string,
271  *      min/max length may be specified
272  * @NL_ATTR_TYPE_NESTED: nested, i.e. the content of this attribute
273  *      consists of sub-attributes. The nested policy and maxtype
274  *      inside may be specified.
275  * @NL_ATTR_TYPE_NESTED_ARRAY: nested array, i.e. the content of this
276  *      attribute contains sub-attributes whose type is irrelevant
277  *      (just used to separate the array entries) and each such array
278  *      entry has attributes again, the policy for those inner ones
279  *      and the corresponding maxtype may be specified.
280  * @NL_ATTR_TYPE_BITFIELD32: &struct nla_bitfield32 attribute
281  */
282 enum netlink_attribute_type {
283         NL_ATTR_TYPE_INVALID,
284 
285         NL_ATTR_TYPE_FLAG,
286 
287         NL_ATTR_TYPE_U8,
288         NL_ATTR_TYPE_U16,
289         NL_ATTR_TYPE_U32,
290         NL_ATTR_TYPE_U64,
291 
292         NL_ATTR_TYPE_S8,
293         NL_ATTR_TYPE_S16,
294         NL_ATTR_TYPE_S32,
295         NL_ATTR_TYPE_S64,
296 
297         NL_ATTR_TYPE_BINARY,
298         NL_ATTR_TYPE_STRING,
299         NL_ATTR_TYPE_NUL_STRING,
300 
301         NL_ATTR_TYPE_NESTED,
302         NL_ATTR_TYPE_NESTED_ARRAY,
303 
304         NL_ATTR_TYPE_BITFIELD32,
305 };
306 
307 /**
308  * enum netlink_policy_type_attr - policy type attributes
309  * @NL_POLICY_TYPE_ATTR_UNSPEC: unused
310  * @NL_POLICY_TYPE_ATTR_TYPE: type of the attribute,
311  *      &enum netlink_attribute_type (U32)
312  * @NL_POLICY_TYPE_ATTR_MIN_VALUE_S: minimum value for signed
313  *      integers (S64)
314  * @NL_POLICY_TYPE_ATTR_MAX_VALUE_S: maximum value for signed
315  *      integers (S64)
316  * @NL_POLICY_TYPE_ATTR_MIN_VALUE_U: minimum value for unsigned
317  *      integers (U64)
318  * @NL_POLICY_TYPE_ATTR_MAX_VALUE_U: maximum value for unsigned
319  *      integers (U64)
320  * @NL_POLICY_TYPE_ATTR_MIN_LENGTH: minimum length for binary
321  *      attributes, no minimum if not given (U32)
322  * @NL_POLICY_TYPE_ATTR_MAX_LENGTH: maximum length for binary
323  *      attributes, no maximum if not given (U32)
324  * @NL_POLICY_TYPE_ATTR_POLICY_IDX: sub policy for nested and
325  *      nested array types (U32)
326  * @NL_POLICY_TYPE_ATTR_POLICY_MAXTYPE: maximum sub policy
327  *      attribute for nested and nested array types, this can
328  *      in theory be < the size of the policy pointed to by
329  *      the index, if limited inside the nesting (U32)
330  * @NL_POLICY_TYPE_ATTR_BITFIELD32_MASK: valid mask for the
331  *      bitfield32 type (U32)
332  * @NL_POLICY_TYPE_ATTR_MASK: mask of valid bits for unsigned integers (U64)
333  * @NL_POLICY_TYPE_ATTR_PAD: pad attribute for 64-bit alignment
334  */
335 enum netlink_policy_type_attr {
336         NL_POLICY_TYPE_ATTR_UNSPEC,
337         NL_POLICY_TYPE_ATTR_TYPE,
338         NL_POLICY_TYPE_ATTR_MIN_VALUE_S,
339         NL_POLICY_TYPE_ATTR_MAX_VALUE_S,
340         NL_POLICY_TYPE_ATTR_MIN_VALUE_U,
341         NL_POLICY_TYPE_ATTR_MAX_VALUE_U,
342         NL_POLICY_TYPE_ATTR_MIN_LENGTH,
343         NL_POLICY_TYPE_ATTR_MAX_LENGTH,
344         NL_POLICY_TYPE_ATTR_POLICY_IDX,
345         NL_POLICY_TYPE_ATTR_POLICY_MAXTYPE,
346         NL_POLICY_TYPE_ATTR_BITFIELD32_MASK,
347         NL_POLICY_TYPE_ATTR_PAD,
348         NL_POLICY_TYPE_ATTR_MASK,
349 
350         /* keep last */
351         __NL_POLICY_TYPE_ATTR_MAX,
352         NL_POLICY_TYPE_ATTR_MAX = __NL_POLICY_TYPE_ATTR_MAX - 1
353 };
354 
355 #endif /* __LINUX_NETLINK_H */
356 

This page was automatically generated by LXR 0.3.1.  •  OpenWrt