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