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