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