sys/net/altq/altq_fairq.h

   1 /*
   2  * Copyright (c) 2008 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sys/net/altq/altq_fairq.h,v 1.1 2008/04/06 18:58:15 dillon Exp $
  35  */
  36
  37 #ifndef _ALTQ_ALTQ_FAIRQ_H_
  38 #define _ALTQ_ALTQ_FAIRQ_H_
  39
  40 #include <net/altq/altq.h>
  41 #include <net/altq/altq_classq.h>
  42 #include <net/altq/altq_codel.h>
  43 #include <net/altq/altq_red.h>
  44 #include <net/altq/altq_rio.h>
  45 #include <net/altq/altq_rmclass.h>
  46
  47 #define FAIRQ_MAX_BUCKETS       2048    /* maximum number of sorting buckets */
  48 #define FAIRQ_MAXPRI            RM_MAXPRIO
  49 #define FAIRQ_BITMAP_WIDTH      (sizeof(fairq_bitmap_t)*8)
  50 #define FAIRQ_BITMAP_MASK       (FAIRQ_BITMAP_WIDTH - 1)
  51
  52 /* fairq class flags */
  53 #define FARF_RED                0x0001  /* use RED */
  54 #define FARF_ECN                0x0002  /* use RED/ECN */
  55 #define FARF_RIO                0x0004  /* use RIO */
  56 #define FARF_CODEL              0x0008  /* use CoDel */
  57 #define FARF_CLEARDSCP          0x0010  /* clear diffserv codepoint */
  58 #define FARF_DEFAULTCLASS       0x1000  /* default class */
  59
  60 #define FARF_HAS_PACKETS        0x2000  /* might have queued packets */
  61
  62 #define FARF_USERFLAGS          (FARF_RED|FARF_ECN|FARF_RIO|FARF_CLEARDSCP| \
  63                                  FARF_DEFAULTCLASS)
  64
  65 /* special class handles */
  66 #define FAIRQ_NULLCLASS_HANDLE  0
  67
  68 typedef u_int   fairq_bitmap_t;
  69
  70 struct fairq_classstats {
  71         uint32_t                class_handle;
  72
  73         u_int                   qlength;
  74         u_int                   qlimit;
  75         struct pktcntr          xmit_cnt;  /* transmitted packet counter */
  76         struct pktcntr          drop_cnt;  /* dropped packet counter */
  77
  78         /* codel, red and rio related info */
  79         int                     qtype;
  80         struct redstats         red[3]; /* rio has 3 red stats */
  81         struct codel_stats      codel;
  82 };
  83
  84 /*
  85  * FAIRQ_STATS_VERSION is defined in altq.h to work around issues stemming
  86  * from mixing of public-API and internal bits in each scheduler-specific
  87  * header.
  88  */
  89
  90 #ifdef _KERNEL
  91
  92 typedef struct fairq_bucket {
  93         struct fairq_bucket *next;      /* circular list */
  94         struct fairq_bucket *prev;      /* circular list */
  95         class_queue_t   queue;          /* the actual queue */
  96         uint64_t        bw_bytes;       /* statistics used to calculate bw */
  97         uint64_t        bw_delta;       /* statistics used to calculate bw */
  98         uint64_t        last_time;
  99         int             in_use;
 100 } fairq_bucket_t;
 101
 102 struct fairq_class {
 103         uint32_t        cl_handle;      /* class handle */
 104         u_int           cl_nbuckets;    /* (power of 2) */
 105         u_int           cl_nbucket_mask; /* bucket mask */
 106         fairq_bucket_t  *cl_buckets;
 107         fairq_bucket_t  *cl_head;       /* head of circular bucket list */
 108         fairq_bucket_t  *cl_polled;
 109         union {
 110                 struct red      *cl_red;        /* RED state */
 111                 struct codel    *cl_codel;      /* CoDel state */
 112         } cl_aqm;
 113 #define cl_red          cl_aqm.cl_red
 114 #define cl_codel        cl_aqm.cl_codel
 115         u_int           cl_hogs_m1;
 116         u_int           cl_lssc_m1;
 117         u_int           cl_bandwidth;
 118         uint64_t        cl_bw_bytes;
 119         uint64_t        cl_bw_delta;
 120         uint64_t        cl_last_time;
 121         int             cl_qtype;       /* rollup */
 122         int             cl_qlimit;
 123         int             cl_pri;         /* priority */
 124         int             cl_flags;       /* class flags */
 125         struct fairq_if *cl_pif;        /* back pointer to pif */
 126         struct altq_pktattr *cl_pktattr; /* saved header used by ECN */
 127
 128         /* round robin index */
 129
 130         /* statistics */
 131         struct pktcntr  cl_xmitcnt;     /* transmitted packet counter */
 132         struct pktcntr  cl_dropcnt;     /* dropped packet counter */
 133 };
 134
 135 /*
 136  * fairq interface state
 137  */
 138 struct fairq_if {
 139         struct fairq_if         *pif_next;      /* interface state list */
 140         struct ifaltq           *pif_ifq;       /* backpointer to ifaltq */
 141         u_int                   pif_bandwidth;  /* link bandwidth in bps */
 142         int                     pif_maxpri;     /* max priority in use */
 143         struct fairq_class      *pif_poll_cache;/* cached poll */
 144         struct fairq_class      *pif_default;   /* default class */
 145         struct fairq_class      *pif_classes[FAIRQ_MAXPRI]; /* classes */
 146 };
 147
 148 #endif /* _KERNEL */
 149
 150 #endif /* _ALTQ_ALTQ_FAIRQ_H_ */