altq_fairq.h revision 298133 
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 * $FreeBSD: stable/10/sys/contrib/altq/altq/altq_fairq.h 298133 2016-04-16 22:02:32Z loos $
36 */
37
38#ifndef _ALTQ_ALTQ_FAIRQ_H_
39#define	_ALTQ_ALTQ_FAIRQ_H_
40
41#include <altq/altq.h>
42#include <altq/altq_classq.h>
43#include <altq/altq_codel.h>
44#include <altq/altq_red.h>
45#include <altq/altq_rio.h>
46#include <altq/altq_rmclass.h>
47
48#define	FAIRQ_MAX_BUCKETS	2048	/* maximum number of sorting buckets */
49#define	FAIRQ_MAXPRI		RM_MAXPRIO
50#define FAIRQ_BITMAP_WIDTH	(sizeof(fairq_bitmap_t)*8)
51#define FAIRQ_BITMAP_MASK	(FAIRQ_BITMAP_WIDTH - 1)
52
53/* fairq class flags */
54#define	FARF_RED		0x0001	/* use RED */
55#define	FARF_ECN		0x0002  /* use RED/ECN */
56#define	FARF_RIO		0x0004  /* use RIO */
57#define	FARF_CODEL		0x0008	/* use CoDel */
58#define	FARF_CLEARDSCP		0x0010  /* clear diffserv codepoint */
59#define	FARF_DEFAULTCLASS	0x1000	/* default class */
60
61#define FARF_HAS_PACKETS	0x2000	/* might have queued packets */
62
63#define FARF_USERFLAGS		(FARF_RED|FARF_ECN|FARF_RIO|FARF_CLEARDSCP| \
64				 FARF_DEFAULTCLASS)
65
66/* special class handles */
67#define	FAIRQ_NULLCLASS_HANDLE	0
68
69typedef u_int	fairq_bitmap_t;
70
71struct fairq_classstats {
72	uint32_t		class_handle;
73
74	u_int			qlength;
75	u_int			qlimit;
76	struct pktcntr		xmit_cnt;  /* transmitted packet counter */
77	struct pktcntr		drop_cnt;  /* dropped packet counter */
78
79	/* codel, red and rio related info */
80	int			qtype;
81	struct redstats		red[3];	/* rio has 3 red stats */
82	struct codel_stats	codel;
83};
84
85#ifdef _KERNEL
86
87typedef struct fairq_bucket {
88	struct fairq_bucket *next;	/* circular list */
89	struct fairq_bucket *prev;	/* circular list */
90	class_queue_t	queue;		/* the actual queue */
91	uint64_t	bw_bytes;	/* statistics used to calculate bw */
92	uint64_t	bw_delta;	/* statistics used to calculate bw */
93	uint64_t	last_time;
94	int		in_use;
95} fairq_bucket_t;
96
97struct fairq_class {
98	uint32_t	cl_handle;	/* class handle */
99	u_int		cl_nbuckets;	/* (power of 2) */
100	u_int		cl_nbucket_mask; /* bucket mask */
101	fairq_bucket_t	*cl_buckets;
102	fairq_bucket_t	*cl_head;	/* head of circular bucket list */
103	fairq_bucket_t	*cl_polled;
104	union {
105		struct red	*cl_red;	/* RED state */
106		struct codel	*cl_codel;	/* CoDel state */
107	} cl_aqm;
108#define	cl_red		cl_aqm.cl_red
109#define	cl_codel	cl_aqm.cl_codel
110	u_int		cl_hogs_m1;
111	u_int		cl_lssc_m1;
112	u_int		cl_bandwidth;
113	uint64_t	cl_bw_bytes;
114	uint64_t	cl_bw_delta;
115	uint64_t	cl_last_time;
116	int		cl_qtype;	/* rollup */
117	int		cl_qlimit;
118	int		cl_pri;		/* priority */
119	int		cl_flags;	/* class flags */
120	struct fairq_if	*cl_pif;	/* back pointer to pif */
121	struct altq_pktattr *cl_pktattr; /* saved header used by ECN */
122
123	/* round robin index */
124
125	/* statistics */
126	struct pktcntr  cl_xmitcnt;	/* transmitted packet counter */
127	struct pktcntr  cl_dropcnt;	/* dropped packet counter */
128};
129
130/*
131 * fairq interface state
132 */
133struct fairq_if {
134	struct fairq_if		*pif_next;	/* interface state list */
135	struct ifaltq		*pif_ifq;	/* backpointer to ifaltq */
136	u_int			pif_bandwidth;	/* link bandwidth in bps */
137	int			pif_maxpri;	/* max priority in use */
138	struct fairq_class	*pif_poll_cache;/* cached poll */
139	struct fairq_class	*pif_default;	/* default class */
140	struct fairq_class	*pif_classes[FAIRQ_MAXPRI]; /* classes */
141};
142
143#endif /* _KERNEL */
144
145#endif /* _ALTQ_ALTQ_FAIRQ_H_ */
146