bsd/net/classq/classq_blue.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 /*      $NetBSD: altq_blue.h,v 1.5 2006/10/12 19:59:08 peter Exp $      */
  30 /*      $KAME: altq_blue.h,v 1.7 2002/11/29 04:36:22 kjc Exp $  */
  31
  32 /*
  33  * Copyright (C) 1997-2002
  34  *      Sony Computer Science Laboratories Inc.  All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  * 1. Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  * 2. Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in the
  43  *    documentation and/or other materials provided with the distribution.
  44  *
  45  * THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND
  46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  48  * ARE DISCLAIMED.  IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE
  49  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  55  * SUCH DAMAGE.
  56  */
  57
  58 #ifndef _NET_CLASSQ_CLASSQ_BLUE_H_
  59 #define _NET_CLASSQ_CLASSQ_BLUE_H_
  60
  61 #ifdef PRIVATE
  62 #ifdef BSD_KERNEL_PRIVATE
  63 #include <net/classq/if_classq.h>
  64 #endif /* BSD_KERNEL_PRIVATE */
  65
  66 #ifdef __cplusplus
  67 extern "C" {
  68 #endif
  69
  70 struct blue_stats {
  71         int32_t                 q_pmark;
  72         u_int32_t               _pad;
  73         u_int64_t               drop_forced;
  74         u_int64_t               drop_unforced;
  75         u_int64_t               marked_packets;
  76 };
  77
  78 #ifdef BSD_KERNEL_PRIVATE
  79 /* blue flags */
  80 #define BLUEF_ECN4      0x01    /* use packet marking for IPv4 packets */
  81 #define BLUEF_ECN6      0x02    /* use packet marking for IPv6 packets */
  82 #define BLUEF_ECN       (BLUEF_ECN4 | BLUEF_ECN6)
  83
  84 #define BLUEF_USERFLAGS                                                 \
  85         (BLUEF_ECN4 | BLUEF_ECN6)
  86
  87 typedef struct blue {
  88         u_int32_t blue_flags;   /* blue flags */
  89
  90         /* blue parameters */
  91         int32_t   blue_pmark;     /* 0-1000 (mark probability*10000) */
  92         int32_t   blue_max_pmark; /* sets precision of marking probability */
  93         u_int32_t blue_hold_time; /* hold time in usec */
  94         struct ifnet *blue_ifp;   /* back pointer to ifnet */
  95
  96         /* variables for internal use */
  97         u_int32_t blue_idle;      /* queue was empty */
  98         struct timeval blue_last; /* timestamp when the queue becomes idle */
  99
 100         /* statistics */
 101         struct {
 102                 struct pktcntr  xmit_cnt;
 103                 struct pktcntr  drop_cnt;
 104                 u_int64_t       drop_forced;
 105                 u_int64_t       drop_unforced;
 106                 u_int64_t       marked_packets;
 107         } blue_stats;
 108 } blue_t;
 109
 110 extern void blue_init(void);
 111 extern struct blue *blue_alloc(struct ifnet *, u_int32_t, u_int32_t, u_int32_t);
 112 extern void blue_destroy(struct blue *);
 113 extern int blue_addq(struct blue *, class_queue_t *, struct mbuf *,
 114     struct pf_mtag *);
 115 extern struct mbuf *blue_getq(struct blue *, class_queue_t *);
 116 extern void blue_purgeq(struct blue *, class_queue_t *, u_int32_t,
 117     u_int32_t *, u_int32_t *);
 118 extern void blue_getstats(struct blue *, struct blue_stats *);
 119 extern void blue_updateq(struct blue *, cqev_t);
 120 extern int blue_suspendq(struct blue *, class_queue_t *, boolean_t);
 121 #endif /* BSD_KERNEL_PRIVATE */
 122
 123 #ifdef __cplusplus
 124 }
 125 #endif
 126 #endif /* PRIVATE */
 127 #endif /* _NET_CLASSQ_CLASSQ_BLUE_H_ */