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
44struct flowadv {
45 int32_t code; /* FADV advisory code */
46};
47
48typedef enum fce_event_type {
49 FCE_EVENT_TYPE_FLOW_CONTROL_FEEDBACK = 0,
50 FCE_EVENT_TYPE_CONGESTION_EXPERIENCED = 1,
51} fce_event_type_t;
52
53#ifdef BSD_KERNEL_PRIVATE
54struct flowadv_fcentry {
55 STAILQ_ENTRY(flowadv_fcentry) fce_link;
56 u_int32_t fce_flowsrc_type; /* FLOWSRC values */
57 u_int32_t fce_flowid;
58 u_int32_t fce_ce_cnt;
59 u_int32_t fce_pkts_since_last_report;
60 fce_event_type_t fce_event_type;
61#if SKYWALK
62 flowadv_token_t fce_flowsrc_token;
63 flowadv_idx_t fce_flowsrc_fidx;
64 struct ifnet *fce_ifp;
65#endif /* SKYWALK */
66};
67
68STAILQ_HEAD(flowadv_fclist, flowadv_fcentry);
69
70__BEGIN_DECLS
71
72extern void flowadv_init(void);
73extern struct flowadv_fcentry *flowadv_alloc_entry(int);
74extern void flowadv_free_entry(struct flowadv_fcentry *);
75extern void flowadv_add(struct flowadv_fclist *);
76extern void flowadv_add_entry(struct flowadv_fcentry *);
77
78__END_DECLS
79
80#endif /* BSD_KERNEL_PRIVATE */
81#endif /* KERNEL_PRIVATE */
82#endif /* _NET_FLOWADV_H_ */
83