xref: /linux-6.15/include/linux/netlink.h (revision 20dd026d)
1 #ifndef __LINUX_NETLINK_H
2 #define __LINUX_NETLINK_H
3 
4 #include <linux/socket.h> /* for sa_family_t */
5 #include <linux/types.h>
6 
7 #define NETLINK_ROUTE		0	/* Routing/device hook				*/
8 #define NETLINK_W1		1	/* 1-wire subsystem				*/
9 #define NETLINK_USERSOCK	2	/* Reserved for user mode socket protocols 	*/
10 #define NETLINK_FIREWALL	3	/* Firewalling hook				*/
11 #define NETLINK_INET_DIAG	4	/* INET socket monitoring			*/
12 #define NETLINK_NFLOG		5	/* netfilter/iptables ULOG */
13 #define NETLINK_XFRM		6	/* ipsec */
14 #define NETLINK_SELINUX		7	/* SELinux event notifications */
15 #define NETLINK_ISCSI		8	/* Open-iSCSI */
16 #define NETLINK_AUDIT		9	/* auditing */
17 #define NETLINK_FIB_LOOKUP	10
18 #define NETLINK_NETFILTER	12	/* netfilter subsystem */
19 #define NETLINK_IP6_FW		13
20 #define NETLINK_DNRTMSG		14	/* DECnet routing messages */
21 #define NETLINK_KOBJECT_UEVENT	15	/* Kernel messages to userspace */
22 
23 #define MAX_LINKS 32
24 
25 struct sockaddr_nl
26 {
27 	sa_family_t	nl_family;	/* AF_NETLINK	*/
28 	unsigned short	nl_pad;		/* zero		*/
29 	__u32		nl_pid;		/* process pid	*/
30        	__u32		nl_groups;	/* multicast groups mask */
31 };
32 
33 struct nlmsghdr
34 {
35 	__u32		nlmsg_len;	/* Length of message including header */
36 	__u16		nlmsg_type;	/* Message content */
37 	__u16		nlmsg_flags;	/* Additional flags */
38 	__u32		nlmsg_seq;	/* Sequence number */
39 	__u32		nlmsg_pid;	/* Sending process PID */
40 };
41 
42 /* Flags values */
43 
44 #define NLM_F_REQUEST		1	/* It is request message. 	*/
45 #define NLM_F_MULTI		2	/* Multipart message, terminated by NLMSG_DONE */
46 #define NLM_F_ACK		4	/* Reply with ack, with zero or error code */
47 #define NLM_F_ECHO		8	/* Echo this request 		*/
48 
49 /* Modifiers to GET request */
50 #define NLM_F_ROOT	0x100	/* specify tree	root	*/
51 #define NLM_F_MATCH	0x200	/* return all matching	*/
52 #define NLM_F_ATOMIC	0x400	/* atomic GET		*/
53 #define NLM_F_DUMP	(NLM_F_ROOT|NLM_F_MATCH)
54 
55 /* Modifiers to NEW request */
56 #define NLM_F_REPLACE	0x100	/* Override existing		*/
57 #define NLM_F_EXCL	0x200	/* Do not touch, if it exists	*/
58 #define NLM_F_CREATE	0x400	/* Create, if it does not exist	*/
59 #define NLM_F_APPEND	0x800	/* Add to end of list		*/
60 
61 /*
62    4.4BSD ADD		NLM_F_CREATE|NLM_F_EXCL
63    4.4BSD CHANGE	NLM_F_REPLACE
64 
65    True CHANGE		NLM_F_CREATE|NLM_F_REPLACE
66    Append		NLM_F_CREATE
67    Check		NLM_F_EXCL
68  */
69 
70 #define NLMSG_ALIGNTO	4
71 #define NLMSG_ALIGN(len) ( ((len)+NLMSG_ALIGNTO-1) & ~(NLMSG_ALIGNTO-1) )
72 #define NLMSG_LENGTH(len) ((len)+NLMSG_ALIGN(sizeof(struct nlmsghdr)))
73 #define NLMSG_SPACE(len) NLMSG_ALIGN(NLMSG_LENGTH(len))
74 #define NLMSG_DATA(nlh)  ((void*)(((char*)nlh) + NLMSG_LENGTH(0)))
75 #define NLMSG_NEXT(nlh,len)	 ((len) -= NLMSG_ALIGN((nlh)->nlmsg_len), \
76 				  (struct nlmsghdr*)(((char*)(nlh)) + NLMSG_ALIGN((nlh)->nlmsg_len)))
77 #define NLMSG_OK(nlh,len) ((len) >= (int)sizeof(struct nlmsghdr) && \
78 			   (nlh)->nlmsg_len >= sizeof(struct nlmsghdr) && \
79 			   (nlh)->nlmsg_len <= (len))
80 #define NLMSG_PAYLOAD(nlh,len) ((nlh)->nlmsg_len - NLMSG_SPACE((len)))
81 
82 #define NLMSG_NOOP		0x1	/* Nothing.		*/
83 #define NLMSG_ERROR		0x2	/* Error		*/
84 #define NLMSG_DONE		0x3	/* End of a dump	*/
85 #define NLMSG_OVERRUN		0x4	/* Data lost		*/
86 
87 struct nlmsgerr
88 {
89 	int		error;
90 	struct nlmsghdr msg;
91 };
92 
93 #define NETLINK_ADD_MEMBERSHIP	1
94 #define NETLINK_DROP_MEMBERSHIP	2
95 #define NETLINK_PKTINFO		3
96 
97 struct nl_pktinfo
98 {
99 	__u32	group;
100 };
101 
102 #define NET_MAJOR 36		/* Major 36 is reserved for networking 						*/
103 
104 enum {
105 	NETLINK_UNCONNECTED = 0,
106 	NETLINK_CONNECTED,
107 };
108 
109 #ifdef __KERNEL__
110 
111 #include <linux/capability.h>
112 #include <linux/skbuff.h>
113 
114 struct netlink_skb_parms
115 {
116 	struct ucred		creds;		/* Skb credentials	*/
117 	__u32			pid;
118 	__u32			dst_pid;
119 	__u32			dst_group;
120 	kernel_cap_t		eff_cap;
121 	__u32			loginuid;	/* Login (audit) uid */
122 };
123 
124 #define NETLINK_CB(skb)		(*(struct netlink_skb_parms*)&((skb)->cb))
125 #define NETLINK_CREDS(skb)	(&NETLINK_CB((skb)).creds)
126 
127 
128 extern struct sock *netlink_kernel_create(int unit, unsigned int groups, void (*input)(struct sock *sk, int len), struct module *module);
129 extern void netlink_ack(struct sk_buff *in_skb, struct nlmsghdr *nlh, int err);
130 extern int netlink_unicast(struct sock *ssk, struct sk_buff *skb, __u32 pid, int nonblock);
131 extern int netlink_broadcast(struct sock *ssk, struct sk_buff *skb, __u32 pid,
132 			     __u32 group, unsigned int __nocast allocation);
133 extern void netlink_set_err(struct sock *ssk, __u32 pid, __u32 group, int code);
134 extern int netlink_register_notifier(struct notifier_block *nb);
135 extern int netlink_unregister_notifier(struct notifier_block *nb);
136 
137 /* finegrained unicast helpers: */
138 struct sock *netlink_getsockbyfilp(struct file *filp);
139 int netlink_attachskb(struct sock *sk, struct sk_buff *skb, int nonblock, long timeo);
140 void netlink_detachskb(struct sock *sk, struct sk_buff *skb);
141 int netlink_sendskb(struct sock *sk, struct sk_buff *skb, int protocol);
142 
143 /*
144  *	skb should fit one page. This choice is good for headerless malloc.
145  */
146 #define NLMSG_GOODORDER 0
147 #define NLMSG_GOODSIZE (SKB_MAX_ORDER(0, NLMSG_GOODORDER))
148 
149 
150 struct netlink_callback
151 {
152 	struct sk_buff	*skb;
153 	struct nlmsghdr	*nlh;
154 	int		(*dump)(struct sk_buff * skb, struct netlink_callback *cb);
155 	int		(*done)(struct netlink_callback *cb);
156 	int		family;
157 	long		args[5];
158 };
159 
160 struct netlink_notify
161 {
162 	int pid;
163 	int protocol;
164 };
165 
166 static __inline__ struct nlmsghdr *
167 __nlmsg_put(struct sk_buff *skb, u32 pid, u32 seq, int type, int len, int flags)
168 {
169 	struct nlmsghdr *nlh;
170 	int size = NLMSG_LENGTH(len);
171 
172 	nlh = (struct nlmsghdr*)skb_put(skb, NLMSG_ALIGN(size));
173 	nlh->nlmsg_type = type;
174 	nlh->nlmsg_len = size;
175 	nlh->nlmsg_flags = flags;
176 	nlh->nlmsg_pid = pid;
177 	nlh->nlmsg_seq = seq;
178 	memset(NLMSG_DATA(nlh) + len, 0, NLMSG_ALIGN(size) - size);
179 	return nlh;
180 }
181 
182 #define NLMSG_NEW(skb, pid, seq, type, len, flags) \
183 ({	if (skb_tailroom(skb) < (int)NLMSG_SPACE(len)) \
184 		goto nlmsg_failure; \
185 	__nlmsg_put(skb, pid, seq, type, len, flags); })
186 
187 #define NLMSG_PUT(skb, pid, seq, type, len) \
188 	NLMSG_NEW(skb, pid, seq, type, len, 0)
189 
190 #define NLMSG_NEW_ANSWER(skb, cb, type, len, flags) \
191 	NLMSG_NEW(skb, NETLINK_CB((cb)->skb).pid, \
192 		  (cb)->nlh->nlmsg_seq, type, len, flags)
193 
194 #define NLMSG_END(skb, nlh) \
195 ({	(nlh)->nlmsg_len = (skb)->tail - (unsigned char *) (nlh); \
196 	(skb)->len; })
197 
198 #define NLMSG_CANCEL(skb, nlh) \
199 ({	skb_trim(skb, (unsigned char *) (nlh) - (skb)->data); \
200 	-1; })
201 
202 extern int netlink_dump_start(struct sock *ssk, struct sk_buff *skb,
203 			      struct nlmsghdr *nlh,
204 			      int (*dump)(struct sk_buff *skb, struct netlink_callback*),
205 			      int (*done)(struct netlink_callback*));
206 
207 
208 #define NL_NONROOT_RECV 0x1
209 #define NL_NONROOT_SEND 0x2
210 extern void netlink_set_nonroot(int protocol, unsigned flag);
211 
212 #endif /* __KERNEL__ */
213 
214 #endif	/* __LINUX_NETLINK_H */
215