xref: /xnu-12377.81.4/bsd/net/flowadv.h (revision 043036a2b3718f7f0be807e2870f8f47d3fa0796)
1 /*
2  * Copyright (c) 2012-2021 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 #ifndef _NET_FLOWADV_H_
30 #define _NET_FLOWADV_H_
31 
32 #ifdef KERNEL_PRIVATE
33 #include <sys/types.h>
34 #include <sys/queue.h>
35 
36 #if SKYWALK
37 #include <skywalk/os_skywalk.h>
38 #endif /* SKYWALK */
39 
40 #define FADV_SUCCESS            0       /* success */
41 #define FADV_FLOW_CONTROLLED    1       /* regular flow control */
42 #define FADV_SUSPENDED          2       /* flow control due to suspension */
43 #define FADV_CONGESTED          3       /* AQM gives congestion notification signal */
44 
45 struct flowadv {
46 	int32_t         code;           /* FADV advisory code */
47 };
48 
49 typedef enum fce_event_type {
50 	FCE_EVENT_TYPE_FLOW_CONTROL_FEEDBACK   = 0,
51 	FCE_EVENT_TYPE_CONGESTION_EXPERIENCED  = 1,
52 } fce_event_type_t;
53 
54 #ifdef BSD_KERNEL_PRIVATE
55 struct flowadv_fcentry {
56 	STAILQ_ENTRY(flowadv_fcentry) fce_link;
57 	u_int32_t        fce_flowsrc_type;       /* FLOWSRC values */
58 	u_int32_t        fce_flowid;
59 	u_int32_t        fce_congestion_cnt;
60 	u_int32_t        l4s_ce_cnt;
61 	u_int32_t        fce_pkts_since_last_report;
62 	fce_event_type_t fce_event_type;
63 #if SKYWALK
64 	flowadv_token_t fce_flowsrc_token;
65 	flowadv_idx_t   fce_flowsrc_fidx;
66 	struct ifnet    *fce_ifp;
67 #endif /* SKYWALK */
68 };
69 
70 STAILQ_HEAD(flowadv_fclist, flowadv_fcentry);
71 
72 __BEGIN_DECLS
73 
74 extern void flowadv_init(void);
75 extern struct flowadv_fcentry *flowadv_alloc_entry(int);
76 extern void flowadv_free_entry(struct flowadv_fcentry *);
77 extern void flowadv_add(struct flowadv_fclist *);
78 extern void flowadv_add_entry(struct flowadv_fcentry *);
79 
80 __END_DECLS
81 
82 #endif /* BSD_KERNEL_PRIVATE */
83 #endif /* KERNEL_PRIVATE */
84 #endif /* _NET_FLOWADV_H_ */
85