Annotation of sys/altq/if_altq.h, Revision 1.1.1.1
1.1 nbrk 1: /* $OpenBSD: if_altq.h,v 1.10 2005/10/17 08:43:35 henning Exp $ */
2: /* $KAME: if_altq.h,v 1.6 2001/01/29 19:59:09 itojun Exp $ */
3:
4: /*
5: * Copyright (C) 1997-2000
6: * Sony Computer Science Laboratories Inc. All rights reserved.
7: *
8: * Redistribution and use in source and binary forms, with or without
9: * modification, are permitted provided that the following conditions
10: * are met:
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 the
15: * documentation and/or other materials provided with the distribution.
16: *
17: * THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND
18: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20: * ARE DISCLAIMED. IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE
21: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27: * SUCH DAMAGE.
28: */
29: #ifndef _ALTQ_IF_ALTQ_H_
30: #define _ALTQ_IF_ALTQ_H_
31:
32: #ifdef KERNEL
33: #ifndef _KERNEL
34: #define _KERNEL
35: #endif
36: #endif
37:
38: struct altq_pktattr; struct tb_regulator; struct top_cdnr;
39:
40: /*
41: * Structure defining a queue for a network interface.
42: */
43: struct ifaltq {
44: /* fields compatible with struct ifqueue */
45: struct mbuf *ifq_head;
46: struct mbuf *ifq_tail;
47: int ifq_len;
48: int ifq_maxlen;
49: int ifq_drops;
50: int ifq_congestion;
51:
52: /* alternate queueing related fields */
53: int altq_type; /* discipline type */
54: int altq_flags; /* flags (e.g. ready, in-use) */
55: void *altq_disc; /* for discipline-specific use */
56: struct ifnet *altq_ifp; /* back pointer to interface */
57:
58: int (*altq_enqueue)(struct ifaltq *, struct mbuf *,
59: struct altq_pktattr *);
60: struct mbuf *(*altq_dequeue)(struct ifaltq *, int);
61: int (*altq_request)(struct ifaltq *, int, void *);
62:
63: /* classifier fields */
64: void *altq_clfier; /* classifier-specific use */
65: void *(*altq_classify)(void *, struct mbuf *, int);
66:
67: /* token bucket regulator */
68: struct tb_regulator *altq_tbr;
69:
70: /* input traffic conditioner (doesn't belong to the output queue...) */
71: struct top_cdnr *altq_cdnr;
72: };
73:
74:
75: #ifdef _KERNEL
76:
77: /*
78: * packet attributes used by queueing disciplines.
79: * pattr_class is a discipline-dependent scheduling class that is
80: * set by a classifier.
81: * pattr_hdr and pattr_af may be used by a discipline to access
82: * the header within a mbuf. (e.g. ECN needs to update the CE bit)
83: * note that pattr_hdr could be stale after m_pullup, though link
84: * layer output routines usually don't use m_pullup. link-level
85: * compression also invalidates these fields. thus, pattr_hdr needs
86: * to be verified when a discipline touches the header.
87: */
88: struct altq_pktattr {
89: void *pattr_class; /* sched class set by classifier */
90: int pattr_af; /* address family */
91: caddr_t pattr_hdr; /* saved header position in mbuf */
92: };
93:
94: /*
95: * a token-bucket regulator limits the rate that a network driver can
96: * dequeue packets from the output queue.
97: * modern cards are able to buffer a large amount of packets and dequeue
98: * too many packets at a time. this bursty dequeue behavior makes it
99: * impossible to schedule packets by queueing disciplines.
100: * a token-bucket is used to control the burst size in a device
101: * independent manner.
102: */
103: struct tb_regulator {
104: int64_t tbr_rate; /* (scaled) token bucket rate */
105: int64_t tbr_depth; /* (scaled) token bucket depth */
106:
107: int64_t tbr_token; /* (scaled) current token */
108: int64_t tbr_filluptime; /* (scaled) time to fill up bucket */
109: u_int64_t tbr_last; /* last time token was updated */
110:
111: int tbr_lastop; /* last dequeue operation type
112: needed for poll-and-dequeue */
113: };
114:
115: /* if_altqflags */
116: #define ALTQF_READY 0x01 /* driver supports alternate queueing */
117: #define ALTQF_ENABLED 0x02 /* altq is in use */
118: #define ALTQF_CLASSIFY 0x04 /* classify packets */
119: #define ALTQF_CNDTNING 0x08 /* altq traffic conditioning is enabled */
120: #define ALTQF_DRIVER1 0x40 /* driver specific */
121:
122: /* if_altqflags set internally only: */
123: #define ALTQF_CANTCHANGE (ALTQF_READY)
124:
125: /* altq_dequeue 2nd arg */
126: #define ALTDQ_REMOVE 1 /* dequeue mbuf from the queue */
127: #define ALTDQ_POLL 2 /* don't dequeue mbuf from the queue */
128:
129: /* altq request types (currently only purge is defined) */
130: #define ALTRQ_PURGE 1 /* purge all packets */
131:
132: #define ALTQ_IS_READY(ifq) ((ifq)->altq_flags & ALTQF_READY)
133: #define ALTQ_IS_ENABLED(ifq) ((ifq)->altq_flags & ALTQF_ENABLED)
134: #define ALTQ_NEEDS_CLASSIFY(ifq) ((ifq)->altq_flags & ALTQF_CLASSIFY)
135: #define ALTQ_IS_CNDTNING(ifq) ((ifq)->altq_flags & ALTQF_CNDTNING)
136:
137: #define ALTQ_SET_CNDTNING(ifq) ((ifq)->altq_flags |= ALTQF_CNDTNING)
138: #define ALTQ_CLEAR_CNDTNING(ifq) ((ifq)->altq_flags &= ~ALTQF_CNDTNING)
139: #define ALTQ_IS_ATTACHED(ifq) ((ifq)->altq_disc != NULL)
140:
141: #define ALTQ_ENQUEUE(ifq, m, pa, err) \
142: (err) = (*(ifq)->altq_enqueue)((ifq),(m),(pa))
143: #define ALTQ_DEQUEUE(ifq, m) \
144: (m) = (*(ifq)->altq_dequeue)((ifq), ALTDQ_REMOVE)
145: #define ALTQ_POLL(ifq, m) \
146: (m) = (*(ifq)->altq_dequeue)((ifq), ALTDQ_POLL)
147: #define ALTQ_PURGE(ifq) \
148: (void)(*(ifq)->altq_request)((ifq), ALTRQ_PURGE, (void *)0)
149: #define ALTQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0)
150: #define TBR_IS_ENABLED(ifq) ((ifq)->altq_tbr != NULL)
151:
152: extern int altq_attach(struct ifaltq *, int, void *,
153: int (*)(struct ifaltq *, struct mbuf *,
154: struct altq_pktattr *),
155: struct mbuf *(*)(struct ifaltq *, int),
156: int (*)(struct ifaltq *, int, void *),
157: void *,
158: void *(*)(void *, struct mbuf *, int));
159: extern int altq_detach(struct ifaltq *);
160: extern int altq_enable(struct ifaltq *);
161: extern int altq_disable(struct ifaltq *);
162: extern struct mbuf *tbr_dequeue(struct ifaltq *, int);
163: extern int (*altq_input)(struct mbuf *, int);
164:
165: #endif /* _KERNEL */
166:
167: #endif /* _ALTQ_IF_ALTQ_H_ */
CVSweb
![[BACK]](/icons/back.gif){kind=icon}
Return to if_altq.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / sys / altq