/* * Copyright (c) 2016-2021 Apple Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. The rights granted to you under the License * may not be used to create, or enable the creation or redistribution of, * unlawful or unlicensed copies of an Apple operating system, or to * circumvent, violate, or enable the circumvention or violation of, any * terms of an Apple operating system software license agreement. * * Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ #ifndef _NET_CLASSQ_CLASSQ_FQ_CODEL_H #define _NET_CLASSQ_CLASSQ_FQ_CODEL_H #ifdef PRIVATE #ifdef BSD_KERNEL_PRIVATE #include #include #include #include #if SKYWALK #include #endif /* SKYWALK */ #ifdef __cplusplus extern "C" { #endif #define FQ_MIN_FC_THRESHOLD_BYTES 7500 #define FQ_IS_DELAYHIGH(_fq_) ((_fq_)->fq_flags & FQF_DELAY_HIGH) #define FQ_SET_DELAY_HIGH(_fq_) do { \ (_fq_)->fq_flags |= FQF_DELAY_HIGH; \ } while (0) #define FQ_CLEAR_DELAY_HIGH(_fq_) do { \ (_fq_)->fq_flags &= ~FQF_DELAY_HIGH; \ } while (0) typedef struct flowq { union { MBUFQ_HEAD(mbufq_head) __mbufq; /* mbuf packet queue */ #if SKYWALK KPKTQ_HEAD(kpktq_head) __kpktq; /* skywalk packet queue */ #endif /* SKYWALK */ } __fq_pktq_u; #define FQF_FLOWCTL_CAPABLE 0x01 /* Use flow control instead of drop */ #define FQF_DELAY_HIGH 0x02 /* Min delay is greater than target */ #define FQF_NEW_FLOW 0x04 /* Currently on new flows queue */ #define FQF_OLD_FLOW 0x08 /* Currently on old flows queue */ #define FQF_FLOWCTL_ON 0x10 /* Currently flow controlled */ #define FQF_DESTROYED 0x80 /* flowq destroyed */ uint8_t fq_flags; /* flags */ uint8_t fq_sc_index; /* service_class index */ int32_t fq_deficit; /* Deficit for scheduling */ uint32_t fq_bytes; /* Number of bytes in the queue */ uint64_t fq_min_qdelay; /* min queue delay for Codel */ uint64_t fq_updatetime; /* next update interval */ uint64_t fq_getqtime; /* last dequeue time */ SLIST_ENTRY(flowq) fq_hashlink; /* for flow queue hash table */ STAILQ_ENTRY(flowq) fq_actlink; /* for new/old flow queues */ uint32_t fq_flowhash; /* Flow hash */ classq_pkt_type_t fq_ptype; /* Packet type */ /* temporary packet queue for dequeued packets */ classq_pkt_t fq_dq_head; classq_pkt_t fq_dq_tail; STAILQ_ENTRY(flowq) fq_dqlink; /* entry on dequeue flow list */ bool fq_in_dqlist; } fq_t; #define fq_mbufq __fq_pktq_u.__mbufq #if SKYWALK #define fq_kpktq __fq_pktq_u.__kpktq #endif /* SKYWALK */ #if SKYWALK #define fq_empty(_q) (((_q)->fq_ptype == QP_MBUF) ? \ MBUFQ_EMPTY(&(_q)->fq_mbufq) : \ KPKTQ_EMPTY(&(_q)->fq_kpktq)) #else /* !SKYWALK */ #define fq_empty(_q) MBUFQ_EMPTY(&(_q)->fq_mbufq) #endif /* !SKYWALK */ #if SKYWALK #define fq_enqueue(_q, _h, _t, _c) do { \ switch ((_q)->fq_ptype) { \ case QP_MBUF: \ ASSERT((_h).cp_ptype == QP_MBUF); \ ASSERT((_t).cp_ptype == QP_MBUF); \ MBUFQ_ENQUEUE_MULTI(&(_q)->fq_mbufq, (_h).cp_mbuf, \ (_t).cp_mbuf); \ MBUFQ_ADD_CRUMB_MULTI(&(_q)->fq_mbufq, (_h).cp_mbuf, \ (_t).cp_mbuf, PKT_CRUMB_FQ_ENQUEUE); \ break; \ case QP_PACKET: \ ASSERT((_h).cp_ptype == QP_PACKET); \ ASSERT((_t).cp_ptype == QP_PACKET); \ KPKTQ_ENQUEUE_MULTI(&(_q)->fq_kpktq, (_h).cp_kpkt, \ (_t).cp_kpkt, (_c)); \ break; \ default: \ VERIFY(0); \ __builtin_unreachable(); \ break; \ } \ } while (0) #else /* !SKYWALK */ #define fq_enqueue(_q, _h, _t, _c) do { \ MBUFQ_ENQUEUE_MULTI(&(_q)->fq_mbufq, (_h).cp_mbuf, \ (_t).cp_mbuf); \ MBUFQ_ADD_CRUMB_MULTI(&(_q)->fq_mbufq, (_h).cp_mbuf, \ (_t).cp_mbuf, PKT_CRUMB_FQ_ENQUEUE); \ } while (0) #endif /* !SKYWALK */ #if SKYWALK #define fq_dequeue(_q, _p) do { \ switch ((_q)->fq_ptype) { \ case QP_MBUF: { \ MBUFQ_DEQUEUE(&(_q)->fq_mbufq, (_p)->cp_mbuf); \ if (__probable((_p)->cp_mbuf != NULL)) { \ CLASSQ_PKT_INIT_MBUF((_p), (_p)->cp_mbuf); \ m_add_crumb((_p)->cp_mbuf, \ PKT_CRUMB_FQ_DEQUEUE); \ } \ break; \ } \ case QP_PACKET: { \ KPKTQ_DEQUEUE(&(_q)->fq_kpktq, (_p)->cp_kpkt); \ if (__probable((_p)->cp_kpkt != NULL)) { \ CLASSQ_PKT_INIT_PACKET((_p), (_p)->cp_kpkt); \ } \ break; \ } \ default: \ VERIFY(0); \ __builtin_unreachable(); \ break; \ } \ } while (0) #else /* !SKYWALK */ #define fq_dequeue(_q, _p) do { \ MBUFQ_DEQUEUE(&(_q)->fq_mbufq, (_p)->cp_mbuf); \ if (__probable((_p)->cp_mbuf != NULL)) { \ CLASSQ_PKT_INIT_MBUF((_p), (_p)->cp_mbuf); \ m_add_crumb((_p)->cp_mbuf, PKT_CRUMB_FQ_DEQUEUE); \ } \ } while (0) #endif /* !SKYWALK */ struct fq_codel_sched_data; struct fq_if_classq; /* Function definitions */ extern void fq_codel_init(void); extern void fq_codel_reap_caches(boolean_t); extern fq_t *fq_alloc(classq_pkt_type_t); extern void fq_destroy(fq_t *); extern int fq_addq(struct fq_codel_sched_data *, pktsched_pkt_t *, struct fq_if_classq *); extern void fq_getq_flow(struct fq_codel_sched_data *, fq_t *, pktsched_pkt_t *); extern void fq_getq_flow_internal(struct fq_codel_sched_data *, fq_t *, pktsched_pkt_t *); extern void fq_head_drop(struct fq_codel_sched_data *, fq_t *); #ifdef __cplusplus } #endif #endif /* BSD_KERNEL_PRIVATE */ #endif /* PRIVATE */ #endif /* _NET_CLASSQ_CLASSQ_FQ_CODEL_H */