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