sys/net/altq/altq_priq.h

   1 /*-
   2  * Copyright (C) 2000-2003
   3  *      Sony Computer Science Laboratories Inc.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $KAME: altq_priq.h,v 1.7 2003/10/03 05:05:15 kjc Exp $
  27  */
  28
  29 #ifndef _ALTQ_ALTQ_PRIQ_H_
  30 #define _ALTQ_ALTQ_PRIQ_H_
  31
  32 #include <net/altq/altq.h>
  33 #include <net/altq/altq_classq.h>
  34 #include <net/altq/altq_codel.h>
  35 #include <net/altq/altq_red.h>
  36 #include <net/altq/altq_rio.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 #define PRIQ_MAXPRI     16      /* upper limit of the number of priorities */
  43
  44 /* priq class flags */
  45 #define PRCF_RED                0x0001  /* use RED */
  46 #define PRCF_ECN                0x0002  /* use RED/ECN */
  47 #define PRCF_RIO                0x0004  /* use RIO */
  48 #define PRCF_CODEL              0x0008  /* use CoDel */
  49 #define PRCF_CLEARDSCP          0x0010  /* clear diffserv codepoint */
  50 #define PRCF_DEFAULTCLASS       0x1000  /* default class */
  51
  52 /* special class handles */
  53 #define PRIQ_NULLCLASS_HANDLE   0
  54
  55 struct priq_classstats {
  56         u_int32_t               class_handle;
  57
  58         u_int                   qlength;
  59         u_int                   qlimit;
  60         u_int                   period;
  61         struct pktcntr          xmitcnt;  /* transmitted packet counter */
  62         struct pktcntr          dropcnt;  /* dropped packet counter */
  63
  64         /* codel, red and rio related info */
  65         int                     qtype;
  66         struct redstats         red[3]; /* rio has 3 red stats */
  67         struct codel_stats      codel;
  68 };
  69
  70 /*
  71  * PRIQ_STATS_VERSION is defined in altq.h to work around issues stemming
  72  * from mixing of public-API and internal bits in each scheduler-specific
  73  * header.
  74  */
  75
  76 #ifdef _KERNEL
  77
  78 struct priq_class {
  79         u_int32_t       cl_handle;      /* class handle */
  80         class_queue_t   *cl_q;          /* class queue structure */
  81         union {
  82                 struct red      *cl_red;        /* RED state */
  83                 struct codel    *cl_codel;      /* CoDel state */
  84         } cl_aqm;
  85 #define cl_red          cl_aqm.cl_red
  86 #define cl_codel        cl_aqm.cl_codel
  87         int             cl_pri;         /* priority */
  88         int             cl_flags;       /* class flags */
  89         struct priq_if  *cl_pif;        /* back pointer to pif */
  90         struct altq_pktattr *cl_pktattr; /* saved header used by ECN */
  91
  92         /* statistics */
  93         u_int           cl_period;      /* backlog period */
  94         struct pktcntr  cl_xmitcnt;     /* transmitted packet counter */
  95         struct pktcntr  cl_dropcnt;     /* dropped packet counter */
  96 };
  97
  98 /*
  99  * priq interface state
 100  */
 101 struct priq_if {
 102         struct priq_if          *pif_next;      /* interface state list */
 103         struct ifaltq           *pif_ifq;       /* backpointer to ifaltq */
 104         u_int                   pif_bandwidth;  /* link bandwidth in bps */
 105         int                     pif_maxpri;     /* max priority in use */
 106         struct priq_class       *pif_default;   /* default class */
 107         struct priq_class       *pif_classes[PRIQ_MAXPRI]; /* classes */
 108 #ifdef ALTQ3_CLFIER_COMPAT
 109         struct acc_classifier   pif_classifier; /* classifier */
 110 #endif
 111 };
 112
 113 #endif /* _KERNEL */
 114
 115 #ifdef __cplusplus
 116 }
 117 #endif
 118
 119 #endif /* _ALTQ_ALTQ_PRIQ_H_ */