bsd/net/pktsched/pktsched.h

   1 /*
   2  * Copyright (c) 2011-2012 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 _PKTSCHED_PKTSCHED_H_
  30 #define _PKTSCHED_PKTSCHED_H_
  31
  32 #ifdef PRIVATE
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /* packet scheduler type */
  38 #define PKTSCHEDT_NONE          0       /* reserved */
  39 #define PKTSCHEDT_CBQ           1       /* cbq */
  40 #define PKTSCHEDT_HFSC          2       /* hfsc */
  41 #define PKTSCHEDT_PRIQ          3       /* priority queue */
  42 #define PKTSCHEDT_FAIRQ         4       /* fairq */
  43 #define PKTSCHEDT_TCQ           5       /* traffic class queue */
  44 #define PKTSCHEDT_QFQ           6       /* quick fair queueing */
  45 #define PKTSCHEDT_FQ_CODEL      7       /* Flow queues with CoDel */
  46 #define PKTSCHEDT_MAX           8       /* should be max sched type + 1 */
  47
  48 #ifdef BSD_KERNEL_PRIVATE
  49 #include <mach/mach_time.h>
  50 #include <sys/sysctl.h>
  51 #include <libkern/libkern.h>
  52
  53 /* flags for pktsched_setup */
  54 #define PKTSCHEDF_QALG_RED      0x1     /* use RED */
  55 #define PKTSCHEDF_QALG_RIO      0x2     /* use RIO */
  56 #define PKTSCHEDF_QALG_BLUE     0x4     /* use BLUE */
  57 #define PKTSCHEDF_QALG_SFB      0x8     /* use SFB */
  58 #define PKTSCHEDF_QALG_ECN      0x10    /* enable ECN */
  59 #define PKTSCHEDF_QALG_FLOWCTL  0x20    /* enable flow control advisories */
  60 #define PKTSCHEDF_QALG_DELAYBASED       0x40    /* Delay based queueing */
  61 #define PKTSCHEDF_QALG_FQ_CODEL 0x80    /* Flow queueing with Codel */
  62
  63 /* macro for timeout/untimeout */
  64 /* use old-style timeout/untimeout */
  65 /* dummy callout structure */
  66 struct callout {
  67         void            *c_arg;                 /* function argument */
  68         void            (*c_func)(void *);      /* function to call */
  69 };
  70
  71 #define CALLOUT_INIT(c) do {                                    \
  72         (void) memset((c), 0, sizeof (*(c)));                   \
  73 } while (/*CONSTCOND*/ 0)
  74
  75 #define CALLOUT_RESET(c, t, f, a) do {                          \
  76         (c)->c_arg = (a);                                       \
  77         (c)->c_func = (f);                                      \
  78         timeout((f), (a), (t));                                 \
  79 } while (/*CONSTCOND*/ 0)
  80
  81 #define CALLOUT_STOP(c)         untimeout((c)->c_func, (c)->c_arg)
  82 #define CALLOUT_INITIALIZER     { NULL, NULL }
  83
  84 typedef void (timeout_t)(void *);
  85
  86 /*
  87  * Bitmap operations
  88  */
  89 typedef u_int32_t pktsched_bitmap_t;
  90
  91 static inline boolean_t
  92 pktsched_bit_tst(u_int32_t ix, pktsched_bitmap_t *pData)
  93 {
  94         return (*pData & (1 << ix));
  95 }
  96
  97 static inline void
  98 pktsched_bit_set(u_int32_t ix, pktsched_bitmap_t *pData)
  99 {
 100         *pData |= (1 << ix);
 101 }
 102
 103 static inline void
 104 pktsched_bit_clr(u_int32_t ix, pktsched_bitmap_t *pData)
 105 {
 106         *pData &= ~(1 << ix);
 107 }
 108
 109 static inline pktsched_bitmap_t
 110 pktsched_ffs(pktsched_bitmap_t pData)
 111 {
 112         return (ffs(pData));
 113 }
 114
 115 static inline pktsched_bitmap_t
 116 pktsched_fls(pktsched_bitmap_t pData)
 117 {
 118         return ((sizeof (pktsched_bitmap_t) << 3) - clz(pData));
 119 }
 120
 121 static inline pktsched_bitmap_t
 122 __fls(pktsched_bitmap_t word)
 123 {
 124         VERIFY(word != 0);
 125         return (pktsched_fls(word) - 1);
 126 }
 127
 128 /*
 129  * We can use mach_absolute_time which returns a 64-bit value with
 130  * granularity less than a microsecond even on the slowest processor.
 131  */
 132 #define read_machclk()          mach_absolute_time()
 133
 134 /*
 135  * machine dependent clock
 136  * a 64bit high resolution time counter.
 137  */
 138 extern u_int32_t machclk_freq;
 139 extern u_int64_t machclk_per_sec;
 140 extern u_int32_t pktsched_verbose;
 141
 142 SYSCTL_DECL(_net_pktsched);
 143
 144 struct if_ifclassq_stats;
 145
 146 extern void pktsched_init(void);
 147 extern int pktsched_setup(struct ifclassq *, u_int32_t, u_int32_t);
 148 extern int pktsched_teardown(struct ifclassq *);
 149 extern int pktsched_getqstats(struct ifclassq *, u_int32_t,
 150     struct if_ifclassq_stats *);
 151 extern u_int64_t pktsched_abs_to_nsecs(u_int64_t);
 152 extern u_int64_t pktsched_nsecs_to_abstime(u_int64_t);
 153 #endif /* BSD_KERNEL_PRIVATE */
 154
 155 #ifdef __cplusplus
 156 }
 157 #endif
 158 #endif /* PRIVATE */
 159 #endif /* _PKTSCHED_PKTSCHED_H_ */