ifq/staging: Initial implementation of IFQ packet staging mechanism
[dragonfly.git] / sys / net / altq / if_altq.h
1 /*      $KAME: if_altq.h,v 1.11 2003/07/10 12:07:50 kjc Exp $   */
2
3 /*
4  * Copyright (C) 1997-2003
5  *      Sony Computer Science Laboratories Inc.  All rights reserved.
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  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 #ifndef _NET_ALTQ_IF_ALTQ_H_
29 #define _NET_ALTQ_IF_ALTQ_H_
30
31 #ifndef _SYS_SERIALIZE_H_
32 #include <sys/serialize.h>
33 #endif
34
35 struct altq_pktattr;
36
37 struct ifaltq;
38
39 struct ifaltq_stage {
40         struct ifaltq   *ifqs_altq;
41         int             ifqs_cnt;
42         int             ifqs_len;
43         uint32_t        ifqs_flags;
44         TAILQ_ENTRY(ifaltq_stage) ifqs_link;
45 } __cachealign;
46
47 #define IFQ_STAGE_FLAG_QUED     0x1
48
49 /*
50  * Structure defining a queue for a network interface.
51  */
52 struct  ifaltq {
53         /* fields compatible with struct ifqueue */
54         struct  mbuf *ifq_head;
55         struct  mbuf *ifq_tail;
56         int     ifq_len;
57         int     ifq_maxlen;
58         int     ifq_drops;
59
60         /* alternate queueing related fields */
61         int     altq_type;              /* discipline type */
62         int     altq_flags;             /* flags (e.g. ready, in-use) */
63         void    *altq_disc;             /* for discipline-specific use */
64         struct  ifnet *altq_ifp;        /* back pointer to interface */
65
66         int     (*altq_enqueue)(struct ifaltq *, struct mbuf *,
67                                 struct altq_pktattr *);
68         struct  mbuf *(*altq_dequeue)(struct ifaltq *, struct mbuf *, int);
69         int     (*altq_request)(struct ifaltq *, int, void *);
70
71         /* classifier fields */
72         void    *altq_clfier;           /* classifier-specific use */
73         void    *(*altq_classify)(struct ifaltq *, struct mbuf *,
74                                   struct altq_pktattr *);
75
76         /* token bucket regulator */
77         struct  tb_regulator *altq_tbr;
78
79         struct  lwkt_serialize altq_lock;
80         struct  mbuf *altq_prepended;   /* mbuf dequeued, but not yet xmit */
81         int     altq_started;           /* ifnet.if_start interlock */
82         struct ifaltq_stage *altq_stage;
83 };
84
85 #define ALTQ_ASSERT_LOCKED(ifq) ASSERT_SERIALIZED(&(ifq)->altq_lock)
86 #define ALTQ_LOCK_INIT(ifq)     lwkt_serialize_init(&(ifq)->altq_lock)
87 #define ALTQ_LOCK(ifq)          lwkt_serialize_adaptive_enter(&(ifq)->altq_lock)
88 #define ALTQ_UNLOCK(ifq)        lwkt_serialize_exit(&(ifq)->altq_lock)
89
90 #ifdef _KERNEL
91
92 /*
93  * packet attributes used by queueing disciplines.
94  * pattr_class is a discipline-dependent scheduling class that is
95  * set by a classifier.
96  * pattr_hdr and pattr_af may be used by a discipline to access
97  * the header within a mbuf.  (e.g. ECN needs to update the CE bit)
98  * note that pattr_hdr could be stale after m_pullup, though link
99  * layer output routines usually don't use m_pullup.  link-level
100  * compression also invalidates these fields.  thus, pattr_hdr needs
101  * to be verified when a discipline touches the header.
102  */
103 struct altq_pktattr {
104         void    *pattr_class;           /* sched class set by classifier */
105         int     pattr_af;               /* address family */
106         caddr_t pattr_hdr;              /* saved header position in mbuf */
107 };
108
109 /*
110  * a token-bucket regulator limits the rate that a network driver can
111  * dequeue packets from the output queue.
112  * modern cards are able to buffer a large amount of packets and dequeue
113  * too many packets at a time.  this bursty dequeue behavior makes it
114  * impossible to schedule packets by queueing disciplines.
115  * a token-bucket is used to control the burst size in a device
116  * independent manner.
117  */
118 struct tb_regulator {
119         int64_t         tbr_rate;       /* (scaled) token bucket rate */
120         int64_t         tbr_depth;      /* (scaled) token bucket depth */
121
122         int64_t         tbr_token;      /* (scaled) current token */
123         int64_t         tbr_filluptime; /* (scaled) time to fill up bucket */
124         uint64_t        tbr_last;       /* last time token was updated */
125
126         int             tbr_lastop;     /* last dequeue operation type
127                                            needed for poll-and-dequeue */
128 };
129
130 /* if_altqflags */
131 #define ALTQF_READY      0x01   /* driver supports alternate queueing */
132 #define ALTQF_ENABLED    0x02   /* altq is in use */
133 #define ALTQF_CLASSIFY   0x04   /* classify packets */
134 #define ALTQF_DRIVER1    0x40   /* driver specific */
135
136 /* if_altqflags set internally only: */
137 #define ALTQF_CANTCHANGE        (ALTQF_READY)
138
139 /* altq_dequeue 2nd arg */
140 #define ALTDQ_REMOVE            1       /* dequeue mbuf from the queue */
141 #define ALTDQ_POLL              2       /* don't dequeue mbuf from the queue */
142
143 /* altq request types (currently only purge is defined) */
144 #define ALTRQ_PURGE             1       /* purge all packets */
145
146 int     altq_attach(struct ifaltq *, int, void *,
147                     int (*)(struct ifaltq *, struct mbuf *, struct altq_pktattr *),
148                     struct mbuf *(*)(struct ifaltq *, struct mbuf *, int),
149                     int (*)(struct ifaltq *, int, void *),
150                     void *, void *(*)(struct ifaltq *, struct mbuf *,
151                                       struct altq_pktattr *));
152 int     altq_detach(struct ifaltq *);
153 int     altq_enable(struct ifaltq *);
154 int     altq_disable(struct ifaltq *);
155 struct mbuf *tbr_dequeue(struct ifaltq *, struct mbuf *, int);
156 extern int      (*altq_input)(struct mbuf *, int);
157 #endif /* _KERNEL */
158
159 #endif /* _NET_ALTQ_IF_ALTQ_H_ */