xref: /linux/include/net/dropreason-core.h (revision 4cde72fead4cebb5b6b2fe9425904c2064739184)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 
3 #ifndef _LINUX_DROPREASON_CORE_H
4 #define _LINUX_DROPREASON_CORE_H
5 
6 #define DEFINE_DROP_REASON(FN, FNe)	\
7 	FN(NOT_SPECIFIED)		\
8 	FN(NO_SOCKET)			\
9 	FN(PKT_TOO_SMALL)		\
10 	FN(TCP_CSUM)			\
11 	FN(SOCKET_FILTER)		\
12 	FN(UDP_CSUM)			\
13 	FN(NETFILTER_DROP)		\
14 	FN(OTHERHOST)			\
15 	FN(IP_CSUM)			\
16 	FN(IP_INHDR)			\
17 	FN(IP_RPFILTER)			\
18 	FN(UNICAST_IN_L2_MULTICAST)	\
19 	FN(XFRM_POLICY)			\
20 	FN(IP_NOPROTO)			\
21 	FN(SOCKET_RCVBUFF)		\
22 	FN(PROTO_MEM)			\
23 	FN(TCP_AUTH_HDR)		\
24 	FN(TCP_MD5NOTFOUND)		\
25 	FN(TCP_MD5UNEXPECTED)		\
26 	FN(TCP_MD5FAILURE)		\
27 	FN(TCP_AONOTFOUND)		\
28 	FN(TCP_AOUNEXPECTED)		\
29 	FN(TCP_AOKEYNOTFOUND)		\
30 	FN(TCP_AOFAILURE)		\
31 	FN(SOCKET_BACKLOG)		\
32 	FN(TCP_FLAGS)			\
33 	FN(TCP_ZEROWINDOW)		\
34 	FN(TCP_OLD_DATA)		\
35 	FN(TCP_OVERWINDOW)		\
36 	FN(TCP_OFOMERGE)		\
37 	FN(TCP_RFC7323_PAWS)		\
38 	FN(TCP_OLD_SEQUENCE)		\
39 	FN(TCP_INVALID_SEQUENCE)	\
40 	FN(TCP_RESET)			\
41 	FN(TCP_INVALID_SYN)		\
42 	FN(TCP_CLOSE)			\
43 	FN(TCP_FASTOPEN)		\
44 	FN(TCP_OLD_ACK)			\
45 	FN(TCP_TOO_OLD_ACK)		\
46 	FN(TCP_ACK_UNSENT_DATA)		\
47 	FN(TCP_OFO_QUEUE_PRUNE)		\
48 	FN(TCP_OFO_DROP)		\
49 	FN(IP_OUTNOROUTES)		\
50 	FN(BPF_CGROUP_EGRESS)		\
51 	FN(IPV6DISABLED)		\
52 	FN(NEIGH_CREATEFAIL)		\
53 	FN(NEIGH_FAILED)		\
54 	FN(NEIGH_QUEUEFULL)		\
55 	FN(NEIGH_DEAD)			\
56 	FN(TC_EGRESS)			\
57 	FN(QDISC_DROP)			\
58 	FN(CPU_BACKLOG)			\
59 	FN(XDP)				\
60 	FN(TC_INGRESS)			\
61 	FN(UNHANDLED_PROTO)		\
62 	FN(SKB_CSUM)			\
63 	FN(SKB_GSO_SEG)			\
64 	FN(SKB_UCOPY_FAULT)		\
65 	FN(DEV_HDR)			\
66 	FN(DEV_READY)			\
67 	FN(FULL_RING)			\
68 	FN(NOMEM)			\
69 	FN(HDR_TRUNC)			\
70 	FN(TAP_FILTER)			\
71 	FN(TAP_TXFILTER)		\
72 	FN(ICMP_CSUM)			\
73 	FN(INVALID_PROTO)		\
74 	FN(IP_INADDRERRORS)		\
75 	FN(IP_INNOROUTES)		\
76 	FN(PKT_TOO_BIG)			\
77 	FN(DUP_FRAG)			\
78 	FN(FRAG_REASM_TIMEOUT)		\
79 	FN(FRAG_TOO_FAR)		\
80 	FN(TCP_MINTTL)			\
81 	FN(IPV6_BAD_EXTHDR)		\
82 	FN(IPV6_NDISC_FRAG)		\
83 	FN(IPV6_NDISC_HOP_LIMIT)	\
84 	FN(IPV6_NDISC_BAD_CODE)		\
85 	FN(IPV6_NDISC_BAD_OPTIONS)	\
86 	FN(IPV6_NDISC_NS_OTHERHOST)	\
87 	FN(QUEUE_PURGE)			\
88 	FN(TC_ERROR)			\
89 	FN(PACKET_SOCK_ERROR)		\
90 	FNe(MAX)
91 
92 /**
93  * enum skb_drop_reason - the reasons of skb drops
94  *
95  * The reason of skb drop, which is used in kfree_skb_reason().
96  */
97 enum skb_drop_reason {
98 	/**
99 	 * @SKB_NOT_DROPPED_YET: skb is not dropped yet (used for no-drop case)
100 	 */
101 	SKB_NOT_DROPPED_YET = 0,
102 	/** @SKB_CONSUMED: packet has been consumed */
103 	SKB_CONSUMED,
104 	/** @SKB_DROP_REASON_NOT_SPECIFIED: drop reason is not specified */
105 	SKB_DROP_REASON_NOT_SPECIFIED,
106 	/** @SKB_DROP_REASON_NO_SOCKET: socket not found */
107 	SKB_DROP_REASON_NO_SOCKET,
108 	/** @SKB_DROP_REASON_PKT_TOO_SMALL: packet size is too small */
109 	SKB_DROP_REASON_PKT_TOO_SMALL,
110 	/** @SKB_DROP_REASON_TCP_CSUM: TCP checksum error */
111 	SKB_DROP_REASON_TCP_CSUM,
112 	/** @SKB_DROP_REASON_SOCKET_FILTER: dropped by socket filter */
113 	SKB_DROP_REASON_SOCKET_FILTER,
114 	/** @SKB_DROP_REASON_UDP_CSUM: UDP checksum error */
115 	SKB_DROP_REASON_UDP_CSUM,
116 	/** @SKB_DROP_REASON_NETFILTER_DROP: dropped by netfilter */
117 	SKB_DROP_REASON_NETFILTER_DROP,
118 	/**
119 	 * @SKB_DROP_REASON_OTHERHOST: packet don't belong to current host
120 	 * (interface is in promisc mode)
121 	 */
122 	SKB_DROP_REASON_OTHERHOST,
123 	/** @SKB_DROP_REASON_IP_CSUM: IP checksum error */
124 	SKB_DROP_REASON_IP_CSUM,
125 	/**
126 	 * @SKB_DROP_REASON_IP_INHDR: there is something wrong with IP header (see
127 	 * IPSTATS_MIB_INHDRERRORS)
128 	 */
129 	SKB_DROP_REASON_IP_INHDR,
130 	/**
131 	 * @SKB_DROP_REASON_IP_RPFILTER: IP rpfilter validate failed. see the
132 	 * document for rp_filter in ip-sysctl.rst for more information
133 	 */
134 	SKB_DROP_REASON_IP_RPFILTER,
135 	/**
136 	 * @SKB_DROP_REASON_UNICAST_IN_L2_MULTICAST: destination address of L2 is
137 	 * multicast, but L3 is unicast.
138 	 */
139 	SKB_DROP_REASON_UNICAST_IN_L2_MULTICAST,
140 	/** @SKB_DROP_REASON_XFRM_POLICY: xfrm policy check failed */
141 	SKB_DROP_REASON_XFRM_POLICY,
142 	/** @SKB_DROP_REASON_IP_NOPROTO: no support for IP protocol */
143 	SKB_DROP_REASON_IP_NOPROTO,
144 	/** @SKB_DROP_REASON_SOCKET_RCVBUFF: socket receive buff is full */
145 	SKB_DROP_REASON_SOCKET_RCVBUFF,
146 	/**
147 	 * @SKB_DROP_REASON_PROTO_MEM: proto memory limition, such as udp packet
148 	 * drop out of udp_memory_allocated.
149 	 */
150 	SKB_DROP_REASON_PROTO_MEM,
151 	/**
152 	 * @SKB_DROP_REASON_TCP_AUTH_HDR: TCP-MD5 or TCP-AO hashes are met
153 	 * twice or set incorrectly.
154 	 */
155 	SKB_DROP_REASON_TCP_AUTH_HDR,
156 	/**
157 	 * @SKB_DROP_REASON_TCP_MD5NOTFOUND: no MD5 hash and one expected,
158 	 * corresponding to LINUX_MIB_TCPMD5NOTFOUND
159 	 */
160 	SKB_DROP_REASON_TCP_MD5NOTFOUND,
161 	/**
162 	 * @SKB_DROP_REASON_TCP_MD5UNEXPECTED: MD5 hash and we're not expecting
163 	 * one, corresponding to LINUX_MIB_TCPMD5UNEXPECTED
164 	 */
165 	SKB_DROP_REASON_TCP_MD5UNEXPECTED,
166 	/**
167 	 * @SKB_DROP_REASON_TCP_MD5FAILURE: MD5 hash and its wrong, corresponding
168 	 * to LINUX_MIB_TCPMD5FAILURE
169 	 */
170 	SKB_DROP_REASON_TCP_MD5FAILURE,
171 	/**
172 	 * @SKB_DROP_REASON_TCP_AONOTFOUND: no TCP-AO hash and one was expected,
173 	 * corresponding to LINUX_MIB_TCPAOREQUIRED
174 	 */
175 	SKB_DROP_REASON_TCP_AONOTFOUND,
176 	/**
177 	 * @SKB_DROP_REASON_TCP_AOUNEXPECTED: TCP-AO hash is present and it
178 	 * was not expected, corresponding to LINUX_MIB_TCPAOKEYNOTFOUND
179 	 */
180 	SKB_DROP_REASON_TCP_AOUNEXPECTED,
181 	/**
182 	 * @SKB_DROP_REASON_TCP_AOKEYNOTFOUND: TCP-AO key is unknown,
183 	 * corresponding to LINUX_MIB_TCPAOKEYNOTFOUND
184 	 */
185 	SKB_DROP_REASON_TCP_AOKEYNOTFOUND,
186 	/**
187 	 * @SKB_DROP_REASON_TCP_AOFAILURE: TCP-AO hash is wrong,
188 	 * corresponding to LINUX_MIB_TCPAOBAD
189 	 */
190 	SKB_DROP_REASON_TCP_AOFAILURE,
191 	/**
192 	 * @SKB_DROP_REASON_SOCKET_BACKLOG: failed to add skb to socket backlog (
193 	 * see LINUX_MIB_TCPBACKLOGDROP)
194 	 */
195 	SKB_DROP_REASON_SOCKET_BACKLOG,
196 	/** @SKB_DROP_REASON_TCP_FLAGS: TCP flags invalid */
197 	SKB_DROP_REASON_TCP_FLAGS,
198 	/**
199 	 * @SKB_DROP_REASON_TCP_ZEROWINDOW: TCP receive window size is zero,
200 	 * see LINUX_MIB_TCPZEROWINDOWDROP
201 	 */
202 	SKB_DROP_REASON_TCP_ZEROWINDOW,
203 	/**
204 	 * @SKB_DROP_REASON_TCP_OLD_DATA: the TCP data reveived is already
205 	 * received before (spurious retrans may happened), see
206 	 * LINUX_MIB_DELAYEDACKLOST
207 	 */
208 	SKB_DROP_REASON_TCP_OLD_DATA,
209 	/**
210 	 * @SKB_DROP_REASON_TCP_OVERWINDOW: the TCP data is out of window,
211 	 * the seq of the first byte exceed the right edges of receive
212 	 * window
213 	 */
214 	SKB_DROP_REASON_TCP_OVERWINDOW,
215 	/**
216 	 * @SKB_DROP_REASON_TCP_OFOMERGE: the data of skb is already in the ofo
217 	 * queue, corresponding to LINUX_MIB_TCPOFOMERGE
218 	 */
219 	SKB_DROP_REASON_TCP_OFOMERGE,
220 	/**
221 	 * @SKB_DROP_REASON_TCP_RFC7323_PAWS: PAWS check, corresponding to
222 	 * LINUX_MIB_PAWSESTABREJECTED
223 	 */
224 	SKB_DROP_REASON_TCP_RFC7323_PAWS,
225 	/** @SKB_DROP_REASON_TCP_OLD_SEQUENCE: Old SEQ field (duplicate packet) */
226 	SKB_DROP_REASON_TCP_OLD_SEQUENCE,
227 	/** @SKB_DROP_REASON_TCP_INVALID_SEQUENCE: Not acceptable SEQ field */
228 	SKB_DROP_REASON_TCP_INVALID_SEQUENCE,
229 	/** @SKB_DROP_REASON_TCP_RESET: Invalid RST packet */
230 	SKB_DROP_REASON_TCP_RESET,
231 	/**
232 	 * @SKB_DROP_REASON_TCP_INVALID_SYN: Incoming packet has unexpected
233 	 * SYN flag
234 	 */
235 	SKB_DROP_REASON_TCP_INVALID_SYN,
236 	/** @SKB_DROP_REASON_TCP_CLOSE: TCP socket in CLOSE state */
237 	SKB_DROP_REASON_TCP_CLOSE,
238 	/** @SKB_DROP_REASON_TCP_FASTOPEN: dropped by FASTOPEN request socket */
239 	SKB_DROP_REASON_TCP_FASTOPEN,
240 	/** @SKB_DROP_REASON_TCP_OLD_ACK: TCP ACK is old, but in window */
241 	SKB_DROP_REASON_TCP_OLD_ACK,
242 	/** @SKB_DROP_REASON_TCP_TOO_OLD_ACK: TCP ACK is too old */
243 	SKB_DROP_REASON_TCP_TOO_OLD_ACK,
244 	/**
245 	 * @SKB_DROP_REASON_TCP_ACK_UNSENT_DATA: TCP ACK for data we haven't
246 	 * sent yet
247 	 */
248 	SKB_DROP_REASON_TCP_ACK_UNSENT_DATA,
249 	/** @SKB_DROP_REASON_TCP_OFO_QUEUE_PRUNE: pruned from TCP OFO queue */
250 	SKB_DROP_REASON_TCP_OFO_QUEUE_PRUNE,
251 	/** @SKB_DROP_REASON_TCP_OFO_DROP: data already in receive queue */
252 	SKB_DROP_REASON_TCP_OFO_DROP,
253 	/** @SKB_DROP_REASON_IP_OUTNOROUTES: route lookup failed */
254 	SKB_DROP_REASON_IP_OUTNOROUTES,
255 	/**
256 	 * @SKB_DROP_REASON_BPF_CGROUP_EGRESS: dropped by BPF_PROG_TYPE_CGROUP_SKB
257 	 * eBPF program
258 	 */
259 	SKB_DROP_REASON_BPF_CGROUP_EGRESS,
260 	/** @SKB_DROP_REASON_IPV6DISABLED: IPv6 is disabled on the device */
261 	SKB_DROP_REASON_IPV6DISABLED,
262 	/** @SKB_DROP_REASON_NEIGH_CREATEFAIL: failed to create neigh entry */
263 	SKB_DROP_REASON_NEIGH_CREATEFAIL,
264 	/** @SKB_DROP_REASON_NEIGH_FAILED: neigh entry in failed state */
265 	SKB_DROP_REASON_NEIGH_FAILED,
266 	/** @SKB_DROP_REASON_NEIGH_QUEUEFULL: arp_queue for neigh entry is full */
267 	SKB_DROP_REASON_NEIGH_QUEUEFULL,
268 	/** @SKB_DROP_REASON_NEIGH_DEAD: neigh entry is dead */
269 	SKB_DROP_REASON_NEIGH_DEAD,
270 	/** @SKB_DROP_REASON_TC_EGRESS: dropped in TC egress HOOK */
271 	SKB_DROP_REASON_TC_EGRESS,
272 	/**
273 	 * @SKB_DROP_REASON_QDISC_DROP: dropped by qdisc when packet outputting (
274 	 * failed to enqueue to current qdisc)
275 	 */
276 	SKB_DROP_REASON_QDISC_DROP,
277 	/**
278 	 * @SKB_DROP_REASON_CPU_BACKLOG: failed to enqueue the skb to the per CPU
279 	 * backlog queue. This can be caused by backlog queue full (see
280 	 * netdev_max_backlog in net.rst) or RPS flow limit
281 	 */
282 	SKB_DROP_REASON_CPU_BACKLOG,
283 	/** @SKB_DROP_REASON_XDP: dropped by XDP in input path */
284 	SKB_DROP_REASON_XDP,
285 	/** @SKB_DROP_REASON_TC_INGRESS: dropped in TC ingress HOOK */
286 	SKB_DROP_REASON_TC_INGRESS,
287 	/** @SKB_DROP_REASON_UNHANDLED_PROTO: protocol not implemented or not supported */
288 	SKB_DROP_REASON_UNHANDLED_PROTO,
289 	/** @SKB_DROP_REASON_SKB_CSUM: sk_buff checksum computation error */
290 	SKB_DROP_REASON_SKB_CSUM,
291 	/** @SKB_DROP_REASON_SKB_GSO_SEG: gso segmentation error */
292 	SKB_DROP_REASON_SKB_GSO_SEG,
293 	/**
294 	 * @SKB_DROP_REASON_SKB_UCOPY_FAULT: failed to copy data from user space,
295 	 * e.g., via zerocopy_sg_from_iter() or skb_orphan_frags_rx()
296 	 */
297 	SKB_DROP_REASON_SKB_UCOPY_FAULT,
298 	/** @SKB_DROP_REASON_DEV_HDR: device driver specific header/metadata is invalid */
299 	SKB_DROP_REASON_DEV_HDR,
300 	/**
301 	 * @SKB_DROP_REASON_DEV_READY: the device is not ready to xmit/recv due to
302 	 * any of its data structure that is not up/ready/initialized,
303 	 * e.g., the IFF_UP is not set, or driver specific tun->tfiles[txq]
304 	 * is not initialized
305 	 */
306 	SKB_DROP_REASON_DEV_READY,
307 	/** @SKB_DROP_REASON_FULL_RING: ring buffer is full */
308 	SKB_DROP_REASON_FULL_RING,
309 	/** @SKB_DROP_REASON_NOMEM: error due to OOM */
310 	SKB_DROP_REASON_NOMEM,
311 	/**
312 	 * @SKB_DROP_REASON_HDR_TRUNC: failed to trunc/extract the header from
313 	 * networking data, e.g., failed to pull the protocol header from
314 	 * frags via pskb_may_pull()
315 	 */
316 	SKB_DROP_REASON_HDR_TRUNC,
317 	/**
318 	 * @SKB_DROP_REASON_TAP_FILTER: dropped by (ebpf) filter directly attached
319 	 * to tun/tap, e.g., via TUNSETFILTEREBPF
320 	 */
321 	SKB_DROP_REASON_TAP_FILTER,
322 	/**
323 	 * @SKB_DROP_REASON_TAP_TXFILTER: dropped by tx filter implemented at
324 	 * tun/tap, e.g., check_filter()
325 	 */
326 	SKB_DROP_REASON_TAP_TXFILTER,
327 	/** @SKB_DROP_REASON_ICMP_CSUM: ICMP checksum error */
328 	SKB_DROP_REASON_ICMP_CSUM,
329 	/**
330 	 * @SKB_DROP_REASON_INVALID_PROTO: the packet doesn't follow RFC 2211,
331 	 * such as a broadcasts ICMP_TIMESTAMP
332 	 */
333 	SKB_DROP_REASON_INVALID_PROTO,
334 	/**
335 	 * @SKB_DROP_REASON_IP_INADDRERRORS: host unreachable, corresponding to
336 	 * IPSTATS_MIB_INADDRERRORS
337 	 */
338 	SKB_DROP_REASON_IP_INADDRERRORS,
339 	/**
340 	 * @SKB_DROP_REASON_IP_INNOROUTES: network unreachable, corresponding to
341 	 * IPSTATS_MIB_INADDRERRORS
342 	 */
343 	SKB_DROP_REASON_IP_INNOROUTES,
344 	/**
345 	 * @SKB_DROP_REASON_PKT_TOO_BIG: packet size is too big (maybe exceed the
346 	 * MTU)
347 	 */
348 	SKB_DROP_REASON_PKT_TOO_BIG,
349 	/** @SKB_DROP_REASON_DUP_FRAG: duplicate fragment */
350 	SKB_DROP_REASON_DUP_FRAG,
351 	/** @SKB_DROP_REASON_FRAG_REASM_TIMEOUT: fragment reassembly timeout */
352 	SKB_DROP_REASON_FRAG_REASM_TIMEOUT,
353 	/**
354 	 * @SKB_DROP_REASON_FRAG_TOO_FAR: ipv4 fragment too far.
355 	 * (/proc/sys/net/ipv4/ipfrag_max_dist)
356 	 */
357 	SKB_DROP_REASON_FRAG_TOO_FAR,
358 	/**
359 	 * @SKB_DROP_REASON_TCP_MINTTL: ipv4 ttl or ipv6 hoplimit below
360 	 * the threshold (IP_MINTTL or IPV6_MINHOPCOUNT).
361 	 */
362 	SKB_DROP_REASON_TCP_MINTTL,
363 	/** @SKB_DROP_REASON_IPV6_BAD_EXTHDR: Bad IPv6 extension header. */
364 	SKB_DROP_REASON_IPV6_BAD_EXTHDR,
365 	/** @SKB_DROP_REASON_IPV6_NDISC_FRAG: invalid frag (suppress_frag_ndisc). */
366 	SKB_DROP_REASON_IPV6_NDISC_FRAG,
367 	/** @SKB_DROP_REASON_IPV6_NDISC_HOP_LIMIT: invalid hop limit. */
368 	SKB_DROP_REASON_IPV6_NDISC_HOP_LIMIT,
369 	/** @SKB_DROP_REASON_IPV6_NDISC_BAD_CODE: invalid NDISC icmp6 code. */
370 	SKB_DROP_REASON_IPV6_NDISC_BAD_CODE,
371 	/** @SKB_DROP_REASON_IPV6_NDISC_BAD_OPTIONS: invalid NDISC options. */
372 	SKB_DROP_REASON_IPV6_NDISC_BAD_OPTIONS,
373 	/**
374 	 * @SKB_DROP_REASON_IPV6_NDISC_NS_OTHERHOST: NEIGHBOUR SOLICITATION
375 	 * for another host.
376 	 */
377 	SKB_DROP_REASON_IPV6_NDISC_NS_OTHERHOST,
378 	/** @SKB_DROP_REASON_QUEUE_PURGE: bulk free. */
379 	SKB_DROP_REASON_QUEUE_PURGE,
380 	/** @SKB_DROP_REASON_TC_ERROR: generic internal tc error. */
381 	SKB_DROP_REASON_TC_ERROR,
382 	/**
383 	 * @SKB_DROP_REASON_PACKET_SOCK_ERROR: generic packet socket errors
384 	 * after its filter matches an incoming packet.
385 	 */
386 	SKB_DROP_REASON_PACKET_SOCK_ERROR,
387 	/**
388 	 * @SKB_DROP_REASON_MAX: the maximum of core drop reasons, which
389 	 * shouldn't be used as a real 'reason' - only for tracing code gen
390 	 */
391 	SKB_DROP_REASON_MAX,
392 
393 	/**
394 	 * @SKB_DROP_REASON_SUBSYS_MASK: subsystem mask in drop reasons,
395 	 * see &enum skb_drop_reason_subsys
396 	 */
397 	SKB_DROP_REASON_SUBSYS_MASK = 0xffff0000,
398 };
399 
400 #define SKB_DROP_REASON_SUBSYS_SHIFT	16
401 
402 #define SKB_DR_INIT(name, reason)				\
403 	enum skb_drop_reason name = SKB_DROP_REASON_##reason
404 #define SKB_DR(name)						\
405 	SKB_DR_INIT(name, NOT_SPECIFIED)
406 #define SKB_DR_SET(name, reason)				\
407 	(name = SKB_DROP_REASON_##reason)
408 #define SKB_DR_OR(name, reason)					\
409 	do {							\
410 		if (name == SKB_DROP_REASON_NOT_SPECIFIED ||	\
411 		    name == SKB_NOT_DROPPED_YET)		\
412 			SKB_DR_SET(name, reason);		\
413 	} while (0)
414 
415 #endif
416