bsd/net/pktsched/pktsched_fq_codel.h

   1 /*
   2  * Copyright (c) 2016 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_PKTSCHED_FQ_CODEL_H_
  30 #define _NET_PKTSCHED_FQ_CODEL_H_
  31
  32 #ifdef PRIVATE
  33 #include <sys/types.h>
  34 #include <sys/param.h>
  35
  36 #ifdef BSD_KERNEL_PRIVATE
  37 #include <net/flowadv.h>
  38 #endif /* BSD_KERNEL_PRIVATE */
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 #ifdef BSD_KERNEL_PRIVATE
  45 struct fcl_stat {
  46         u_int32_t fcl_flow_control;
  47         u_int32_t fcl_flow_feedback;
  48         u_int32_t fcl_dequeue_stall;
  49         u_int32_t fcl_flow_control_fail;
  50         u_int64_t fcl_drop_overflow;
  51         u_int64_t fcl_drop_early;
  52         u_int32_t fcl_drop_memfailure;
  53         u_int32_t fcl_flows_cnt;
  54         u_int32_t fcl_newflows_cnt;
  55         u_int32_t fcl_oldflows_cnt;
  56         u_int64_t fcl_pkt_cnt;
  57         u_int64_t fcl_dequeue;
  58         u_int64_t fcl_dequeue_bytes;
  59         u_int64_t fcl_byte_cnt;
  60         u_int32_t fcl_throttle_on;
  61         u_int32_t fcl_throttle_off;
  62         u_int32_t fcl_throttle_drops;
  63         u_int32_t fcl_dup_rexmts;
  64 };
  65
  66 /*
  67  * Use the top most 8 bits of flow id as the tag for set associative
  68  * hashing
  69  */
  70
  71 #define FQ_IF_HASH_TAG_SIZE     8
  72 #define FQ_IF_HASH_TAG_SHIFT    24
  73 #define FQ_IF_HASH_TAG_MASK     0xFF
  74 #define FQ_IF_HASH_TABLE_SIZE   (1 << FQ_IF_HASH_TAG_SIZE)
  75
  76 /* maximum number f packets stored across all queues */
  77 #define FQ_IF_MAX_PKT_LIMIT     2048
  78
  79 /* Set the quantum to be one MTU */
  80 #define FQ_IF_DEFAULT_QUANTUM   1500
  81
  82 /* Max number of service classes currently supported */
  83 #define FQ_IF_MAX_CLASSES       10
  84
  85 struct flowq;
  86 typedef u_int32_t pktsched_bitmap_t;
  87 struct if_ifclassq_stats;
  88
  89 enum fq_if_state {
  90         FQ_IF_ER = 0,           /* eligible, ready */
  91         FQ_IF_IR = 1,           /* ineligible, ready */
  92         FQ_IF_EB = 2,           /* eligible blocked */
  93         FQ_IF_IB = 3,           /* ineligible, blocked */
  94         FQ_IF_MAX_STATE
  95 };
  96
  97 /*
  98  * This priority index is used for QFQ state bitmaps, lower index gets
  99  * higher priority
 100  */
 101 #define FQ_IF_BK_SYS_INDEX      9
 102 #define FQ_IF_BK_INDEX  8
 103 #define FQ_IF_BE_INDEX  7
 104 #define FQ_IF_RD_INDEX  6
 105 #define FQ_IF_OAM_INDEX 5
 106 #define FQ_IF_AV_INDEX  4
 107 #define FQ_IF_RV_INDEX  3
 108 #define FQ_IF_VI_INDEX  2
 109 #define FQ_IF_VO_INDEX  1
 110 #define FQ_IF_CTL_INDEX 0
 111
 112 typedef SLIST_HEAD(, flowq) flowq_list_t;
 113 typedef STAILQ_HEAD(, flowq) flowq_stailq_t;
 114 typedef struct fq_if_classq {
 115         u_int32_t fcl_pri;      /* class priority, lower the better */
 116         u_int32_t fcl_service_class;    /* service class */
 117         u_int32_t fcl_quantum;          /* quantum in bytes */
 118         u_int32_t fcl_drr_max;          /* max flows per class for DRR */
 119         int64_t fcl_budget;             /* budget for this classq */
 120         flowq_stailq_t fcl_new_flows;   /* List of new flows */
 121         flowq_stailq_t fcl_old_flows;   /* List of old flows */
 122         struct fcl_stat fcl_stat;
 123 } fq_if_classq_t;
 124
 125 typedef struct fq_codel_sched_data {
 126         struct ifclassq *fqs_ifq;       /* back pointer to ifclassq */
 127         u_int64_t       fqs_target_qdelay;      /* Target queue delay (ns) */
 128         u_int64_t       fqs_update_interval;    /* update interval (ns) */
 129         flowq_list_t    fqs_flows[FQ_IF_HASH_TABLE_SIZE]; /* flows table */
 130         pktsched_bitmap_t       fqs_bitmaps[FQ_IF_MAX_STATE];
 131         u_int32_t       fqs_pkt_droplimit;      /* drop limit */
 132         u_int8_t        fqs_throttle;   /* throttle on or off */
 133         fq_if_classq_t  fqs_classq[FQ_IF_MAX_CLASSES]; /* class queues */
 134         struct flowadv_fclist   fqs_fclist; /* flow control state */
 135         struct flowq    *fqs_large_flow; /* flow has highest number of bytes */
 136 } fq_if_t;
 137
 138 #endif /* BSD_KERNEL_PRIVATE */
 139
 140 struct fq_codel_classstats {
 141         u_int32_t       fcls_pri;
 142         u_int32_t       fcls_service_class;
 143         u_int32_t       fcls_quantum;
 144         u_int32_t       fcls_drr_max;
 145         int64_t         fcls_budget;
 146         u_int64_t       fcls_target_qdelay;
 147         u_int64_t       fcls_update_interval;
 148         u_int32_t       fcls_flow_control;
 149         u_int32_t       fcls_flow_feedback;
 150         u_int32_t       fcls_dequeue_stall;
 151         u_int32_t       fcls_flow_control_fail;
 152         u_int64_t       fcls_drop_overflow;
 153         u_int64_t       fcls_drop_early;
 154         u_int32_t       fcls_drop_memfailure;
 155         u_int32_t       fcls_flows_cnt;
 156         u_int32_t       fcls_newflows_cnt;
 157         u_int32_t       fcls_oldflows_cnt;
 158         u_int64_t       fcls_pkt_cnt;
 159         u_int64_t       fcls_dequeue;
 160         u_int64_t       fcls_dequeue_bytes;
 161         u_int64_t       fcls_byte_cnt;
 162         u_int32_t       fcls_throttle_on;
 163         u_int32_t       fcls_throttle_off;
 164         u_int32_t       fcls_throttle_drops;
 165         u_int32_t       fcls_dup_rexmts;
 166 };
 167
 168 #ifdef BSD_KERNEL_PRIVATE
 169
 170 extern void fq_codel_scheduler_init(void);
 171 extern struct flowq *fq_if_hash_pkt(fq_if_t *, u_int32_t, mbuf_svc_class_t,
 172     u_int64_t, boolean_t);
 173 extern boolean_t fq_if_at_drop_limit(fq_if_t *);
 174 extern void fq_if_drop_packet(fq_if_t *);
 175 extern void fq_if_is_flow_heavy(fq_if_t *, struct flowq *);
 176 extern boolean_t fq_if_add_fcentry(fq_if_t *, struct pkthdr *,
 177     fq_if_classq_t *);
 178 extern void fq_if_flow_feedback(fq_if_t *, struct flowq *, fq_if_classq_t *);
 179 extern int fq_if_setup_ifclassq(struct ifclassq *ifq, u_int32_t flags);
 180 extern int fq_if_teardown_ifclassq(struct ifclassq *ifq);
 181 extern int fq_if_getqstats_ifclassq(struct ifclassq *ifq, u_int32_t qid,
 182     struct if_ifclassq_stats *ifqs);
 183
 184
 185 #endif /* BSD_KERNEL_PRIVATE */
 186
 187 #ifdef __cplusplus
 188 }
 189 #endif
 190
 191 #endif /* PRIVATE */
 192 #endif /* _NET_PKTSCHED_PKTSCHED_FQ_CODEL_H_ */