master
1/*-
2 * Copyright (C) 1997-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: if_altq.h,v 1.12 2005/04/13 03:44:25 suz Exp $
27 */
28#ifndef _ALTQ_IF_ALTQ_H_
29#define _ALTQ_IF_ALTQ_H_
30
31#include <sys/lock.h> /* XXX */
32#include <sys/mutex.h> /* XXX */
33#include <sys/event.h> /* XXX */
34
35struct altq_pktattr; struct tb_regulator; struct top_cdnr;
36
37/*
38 * Structure defining a queue for a network interface.
39 */
40struct ifaltq {
41 /* fields compatible with struct ifqueue */
42 struct mbuf *ifq_head;
43 struct mbuf *ifq_tail;
44 int ifq_len;
45 int ifq_maxlen;
46 struct mtx ifq_mtx;
47
48 /* driver owned queue (used for bulk dequeue and prepend) UNLOCKED */
49 struct mbuf *ifq_drv_head;
50 struct mbuf *ifq_drv_tail;
51 int ifq_drv_len;
52 int ifq_drv_maxlen;
53
54 /* alternate queueing related fields */
55 int altq_type; /* discipline type */
56 int altq_flags; /* flags (e.g. ready, in-use) */
57 void *altq_disc; /* for discipline-specific use */
58 struct ifnet *altq_ifp; /* back pointer to interface */
59
60 int (*altq_enqueue)(struct ifaltq *, struct mbuf *,
61 struct altq_pktattr *);
62 struct mbuf *(*altq_dequeue)(struct ifaltq *, int);
63 int (*altq_request)(struct ifaltq *, int, void *);
64
65 /* token bucket regulator */
66 struct tb_regulator *altq_tbr;
67
68 /* input traffic conditioner (doesn't belong to the output queue...) */
69 struct top_cdnr *altq_cdnr;
70};
71
72#ifdef _KERNEL
73
74/*
75 * packet attributes used by queueing disciplines.
76 * pattr_class is a discipline-dependent scheduling class that is
77 * set by a classifier.
78 * pattr_hdr and pattr_af may be used by a discipline to access
79 * the header within a mbuf. (e.g. ECN needs to update the CE bit)
80 * note that pattr_hdr could be stale after m_pullup, though link
81 * layer output routines usually don't use m_pullup. link-level
82 * compression also invalidates these fields. thus, pattr_hdr needs
83 * to be verified when a discipline touches the header.
84 */
85struct altq_pktattr {
86 void *pattr_class; /* sched class set by classifier */
87 int pattr_af; /* address family */
88 caddr_t pattr_hdr; /* saved header position in mbuf */
89};
90
91/*
92 * mbuf tag to carry a queue id (and hints for ECN).
93 */
94struct altq_tag {
95 u_int32_t qid; /* queue id */
96 /* hints for ecn */
97 int af; /* address family */
98 void *hdr; /* saved header position in mbuf */
99};
100
101/*
102 * a token-bucket regulator limits the rate that a network driver can
103 * dequeue packets from the output queue.
104 * modern cards are able to buffer a large amount of packets and dequeue
105 * too many packets at a time. this bursty dequeue behavior makes it
106 * impossible to schedule packets by queueing disciplines.
107 * a token-bucket is used to control the burst size in a device
108 * independent manner.
109 */
110struct tb_regulator {
111 int64_t tbr_rate; /* (scaled) token bucket rate */
112 int64_t tbr_depth; /* (scaled) token bucket depth */
113
114 int64_t tbr_token; /* (scaled) current token */
115 int64_t tbr_filluptime; /* (scaled) time to fill up bucket */
116 u_int64_t tbr_last; /* last time token was updated */
117
118 int tbr_lastop; /* last dequeue operation type
119 needed for poll-and-dequeue */
120};
121
122/* if_altqflags */
123#define ALTQF_READY 0x01 /* driver supports alternate queueing */
124#define ALTQF_ENABLED 0x02 /* altq is in use */
125/* ALTQF_CLASSIFY 0x04 obsolete classify packets */
126#define ALTQF_CNDTNING 0x08 /* altq traffic conditioning is enabled */
127#define ALTQF_DRIVER1 0x40 /* driver specific */
128
129/* if_altqflags set internally only: */
130#define ALTQF_CANTCHANGE (ALTQF_READY)
131
132/* altq_dequeue 2nd arg */
133#define ALTDQ_REMOVE 1 /* dequeue mbuf from the queue */
134#define ALTDQ_POLL 2 /* don't dequeue mbuf from the queue */
135
136/* altq request types (currently only purge is defined) */
137#define ALTRQ_PURGE 1 /* purge all packets */
138
139#define ALTQ_IS_READY(ifq) ((ifq)->altq_flags & ALTQF_READY)
140#ifdef ALTQ
141#define ALTQ_IS_ENABLED(ifq) ((ifq)->altq_flags & ALTQF_ENABLED)
142#else
143#define ALTQ_IS_ENABLED(ifq) 0
144#endif
145#define ALTQ_IS_CNDTNING(ifq) ((ifq)->altq_flags & ALTQF_CNDTNING)
146
147#define ALTQ_SET_CNDTNING(ifq) ((ifq)->altq_flags |= ALTQF_CNDTNING)
148#define ALTQ_CLEAR_CNDTNING(ifq) ((ifq)->altq_flags &= ~ALTQF_CNDTNING)
149#define ALTQ_IS_ATTACHED(ifq) ((ifq)->altq_disc != NULL)
150
151#define ALTQ_ENQUEUE(ifq, m, pa, err) \
152 (err) = (*(ifq)->altq_enqueue)((ifq),(m),(pa))
153#define ALTQ_DEQUEUE(ifq, m) \
154 (m) = (*(ifq)->altq_dequeue)((ifq), ALTDQ_REMOVE)
155#define ALTQ_POLL(ifq, m) \
156 (m) = (*(ifq)->altq_dequeue)((ifq), ALTDQ_POLL)
157#define ALTQ_PURGE(ifq) \
158 (void)(*(ifq)->altq_request)((ifq), ALTRQ_PURGE, (void *)0)
159#define ALTQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0)
160#define TBR_IS_ENABLED(ifq) ((ifq)->altq_tbr != NULL)
161
162extern int altq_attach(struct ifaltq *, int, void *,
163 int (*)(struct ifaltq *, struct mbuf *,
164 struct altq_pktattr *),
165 struct mbuf *(*)(struct ifaltq *, int),
166 int (*)(struct ifaltq *, int, void *));
167extern int altq_detach(struct ifaltq *);
168extern int altq_enable(struct ifaltq *);
169extern int altq_disable(struct ifaltq *);
170extern struct mbuf *(*tbr_dequeue_ptr)(struct ifaltq *, int);
171#if 0 /* ALTQ3_CLFIER_COMPAT */
172void altq_etherclassify(struct ifaltq *, struct mbuf *, struct altq_pktattr *);
173#endif
174#endif /* _KERNEL */
175
176#endif /* _ALTQ_IF_ALTQ_H_ */