sys/contrib/altq/altq/altq_cbq.h

   1 /*      $KAME: altq_cbq.h,v 1.12 2003/10/03 05:05:15 kjc Exp $  */
   2
   3 /*
   4  * Copyright (c) Sun Microsystems, Inc. 1993-1998 All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. All advertising materials mentioning features or use of this software
  18  *    must display the following acknowledgement:
  19  *      This product includes software developed by the SMCC Technology
  20  *      Development Group at Sun Microsystems, Inc.
  21  *
  22  * 4. The name of the Sun Microsystems, Inc nor may not be used to endorse or
  23  *      promote products derived from this software without specific prior
  24  *      written permission.
  25  *
  26  * SUN MICROSYSTEMS DOES NOT CLAIM MERCHANTABILITY OF THIS SOFTWARE OR THE
  27  * SUITABILITY OF THIS SOFTWARE FOR ANY PARTICULAR PURPOSE.  The software is
  28  * provided "as is" without express or implied warranty of any kind.
  29  *
  30  * These notices must be retained in any copies of any part of this software.
  31  */
  32
  33 #ifndef _ALTQ_ALTQ_CBQ_H_
  34 #define _ALTQ_ALTQ_CBQ_H_
  35
  36 #include <altq/altq.h>
  37 #include <altq/altq_codel.h>
  38 #include <altq/altq_rmclass.h>
  39 #include <altq/altq_red.h>
  40 #include <altq/altq_rio.h>
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 #define NULL_CLASS_HANDLE       0
  47
  48 /* class flags should be same as class flags in rm_class.h */
  49 #define CBQCLF_RED              0x0001  /* use RED */
  50 #define CBQCLF_ECN              0x0002  /* use RED/ECN */
  51 #define CBQCLF_RIO              0x0004  /* use RIO */
  52 #define CBQCLF_FLOWVALVE        0x0008  /* use flowvalve (aka penalty-box) */
  53 #define CBQCLF_CLEARDSCP        0x0010  /* clear diffserv codepoint */
  54 #define CBQCLF_BORROW           0x0020  /* borrow from parent */
  55 #define CBQCLF_CODEL            0x0040  /* use CoDel */
  56
  57 /* class flags only for root class */
  58 #define CBQCLF_WRR              0x0100  /* weighted-round robin */
  59 #define CBQCLF_EFFICIENT        0x0200  /* work-conserving */
  60
  61 /* class flags for special classes */
  62 #define CBQCLF_ROOTCLASS        0x1000  /* root class */
  63 #define CBQCLF_DEFCLASS         0x2000  /* default class */
  64 #ifdef ALTQ3_COMPAT
  65 #define CBQCLF_CTLCLASS         0x4000  /* control class */
  66 #endif
  67 #define CBQCLF_CLASSMASK        0xf000  /* class mask */
  68
  69 #define CBQ_MAXQSIZE            200
  70 #define CBQ_MAXPRI              RM_MAXPRIO
  71
  72 typedef struct _cbq_class_stats_ {
  73         u_int32_t       handle;
  74         u_int           depth;
  75
  76         struct pktcntr  xmit_cnt;       /* packets sent in this class */
  77         struct pktcntr  drop_cnt;       /* dropped packets */
  78         u_int           over;           /* # times went over limit */
  79         u_int           borrows;        /* # times tried to borrow */
  80         u_int           overactions;    /* # times invoked overlimit action */
  81         u_int           delays;         /* # times invoked delay actions */
  82
  83         /* other static class parameters useful for debugging */
  84         int             priority;
  85         int             maxidle;
  86         int             minidle;
  87         int             offtime;
  88         int             qmax;
  89         int             ns_per_byte;
  90         int             wrr_allot;
  91
  92         int             qcnt;           /* # packets in queue */
  93         int             avgidle;
  94
  95         /* codel, red and rio related info */
  96         int             qtype;
  97         struct redstats red[3];
  98         struct codel_stats codel;
  99 } class_stats_t;
 100
 101 #ifdef ALTQ3_COMPAT
 102 /*
 103  * Define structures associated with IOCTLS for cbq.
 104  */
 105
 106 /*
 107  * Define the CBQ interface structure.  This must be included in all
 108  * IOCTL's such that the CBQ driver may find the appropriate CBQ module
 109  * associated with the network interface to be affected.
 110  */
 111 struct cbq_interface {
 112         char    cbq_ifacename[IFNAMSIZ];
 113 };
 114
 115 typedef struct cbq_class_spec {
 116         u_int           priority;
 117         u_int           nano_sec_per_byte;
 118         u_int           maxq;
 119         u_int           maxidle;
 120         int             minidle;
 121         u_int           offtime;
 122         u_int32_t       parent_class_handle;
 123         u_int32_t       borrow_class_handle;
 124
 125         u_int           pktsize;
 126         int             flags;
 127 } cbq_class_spec_t;
 128
 129 struct cbq_add_class {
 130         struct cbq_interface    cbq_iface;
 131
 132         cbq_class_spec_t        cbq_class;
 133         u_int32_t               cbq_class_handle;
 134 };
 135
 136 struct cbq_delete_class {
 137         struct cbq_interface    cbq_iface;
 138         u_int32_t               cbq_class_handle;
 139 };
 140
 141 struct cbq_modify_class {
 142         struct cbq_interface    cbq_iface;
 143
 144         cbq_class_spec_t        cbq_class;
 145         u_int32_t               cbq_class_handle;
 146 };
 147
 148 struct cbq_add_filter {
 149         struct cbq_interface            cbq_iface;
 150         u_int32_t               cbq_class_handle;
 151         struct flow_filter      cbq_filter;
 152
 153         u_long                  cbq_filter_handle;
 154 };
 155
 156 struct cbq_delete_filter {
 157         struct cbq_interface    cbq_iface;
 158         u_long                  cbq_filter_handle;
 159 };
 160
 161 /* number of classes are returned in nclasses field */
 162 struct cbq_getstats {
 163         struct cbq_interface    iface;
 164         int                     nclasses;
 165         class_stats_t           *stats;
 166 };
 167
 168 /*
 169  * Define IOCTLs for CBQ.
 170  */
 171 #define CBQ_IF_ATTACH           _IOW('Q', 1, struct cbq_interface)
 172 #define CBQ_IF_DETACH           _IOW('Q', 2, struct cbq_interface)
 173 #define CBQ_ENABLE              _IOW('Q', 3, struct cbq_interface)
 174 #define CBQ_DISABLE             _IOW('Q', 4, struct cbq_interface)
 175 #define CBQ_CLEAR_HIERARCHY     _IOW('Q', 5, struct cbq_interface)
 176 #define CBQ_ADD_CLASS           _IOWR('Q', 7, struct cbq_add_class)
 177 #define CBQ_DEL_CLASS           _IOW('Q', 8, struct cbq_delete_class)
 178 #define CBQ_MODIFY_CLASS        _IOWR('Q', 9, struct cbq_modify_class)
 179 #define CBQ_ADD_FILTER          _IOWR('Q', 10, struct cbq_add_filter)
 180 #define CBQ_DEL_FILTER          _IOW('Q', 11, struct cbq_delete_filter)
 181 #define CBQ_GETSTATS            _IOWR('Q', 12, struct cbq_getstats)
 182 #endif /* ALTQ3_COMPAT */
 183
 184 #ifdef _KERNEL
 185 /*
 186  * Define macros only good for kernel drivers and modules.
 187  */
 188 #define CBQ_WATCHDOG            (hz / 20)
 189 #define CBQ_TIMEOUT             10
 190 #define CBQ_LS_TIMEOUT          (20 * hz / 1000)
 191
 192 #define CBQ_MAX_CLASSES 256
 193
 194 #ifdef ALTQ3_COMPAT
 195 #define CBQ_MAX_FILTERS 256
 196
 197 #define DISABLE         0x00
 198 #define ENABLE          0x01
 199 #endif /* ALTQ3_COMPAT */
 200
 201 /*
 202  * Define State structures.
 203  */
 204 typedef struct cbqstate {
 205 #ifdef ALTQ3_COMPAT
 206         struct cbqstate         *cbq_next;
 207 #endif
 208         int                      cbq_qlen;      /* # of packets in cbq */
 209         struct rm_class         *cbq_class_tbl[CBQ_MAX_CLASSES];
 210
 211         struct rm_ifdat          ifnp;
 212         struct callout           cbq_callout;   /* for timeouts */
 213 #ifdef ALTQ3_CLFIER_COMPAT
 214         struct acc_classifier   cbq_classifier;
 215 #endif
 216 } cbq_state_t;
 217
 218 #endif /* _KERNEL */
 219
 220 #ifdef __cplusplus
 221 }
 222 #endif
 223
 224 #endif /* !_ALTQ_ALTQ_CBQ_H_ */