2 * Copyright (c) 2010 Luigi Rizzo, Riccardo Panicucci, Universita` di Pisa
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 THE AUTHOR 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
28 * internal dummynet APIs.
33 #ifndef _IP_DN_PRIVATE_H
34 #define _IP_DN_PRIVATE_H
37 * use ND() to remove debugging, D() to print a line,
38 * DX(level, ...) to print above a certain level
39 * If you redefine D() you are expected to redefine all.
42 #define ND(fmt, ...) do {} while (0)
43 #define D1(fmt, ...) do {} while (0)
44 #define D(fmt, ...) printf("%-10s " fmt "\n", \
45 __FUNCTION__, ## __VA_ARGS__)
46 #define DX(lev, fmt, ...) do { \
47 if (dn_cfg.debug > lev) D(fmt, ## __VA_ARGS__); } while (0)
50 MALLOC_DECLARE(M_DUMMYNET);
53 #define div64(a, b) ((int64_t)(a) / (int64_t)(b))
56 #define DN_LOCK_INIT() do { \
57 mtx_init(&dn_cfg.uh_mtx, "dn_uh", NULL, MTX_DEF); \
58 mtx_init(&dn_cfg.bh_mtx, "dn_bh", NULL, MTX_DEF); \
60 #define DN_LOCK_DESTROY() do { \
61 mtx_destroy(&dn_cfg.uh_mtx); \
62 mtx_destroy(&dn_cfg.bh_mtx); \
64 #if 0 /* not used yet */
65 #define DN_UH_RLOCK() mtx_lock(&dn_cfg.uh_mtx)
66 #define DN_UH_RUNLOCK() mtx_unlock(&dn_cfg.uh_mtx)
67 #define DN_UH_WLOCK() mtx_lock(&dn_cfg.uh_mtx)
68 #define DN_UH_WUNLOCK() mtx_unlock(&dn_cfg.uh_mtx)
69 #define DN_UH_LOCK_ASSERT() mtx_assert(&dn_cfg.uh_mtx, MA_OWNED)
72 #define DN_BH_RLOCK() mtx_lock(&dn_cfg.uh_mtx)
73 #define DN_BH_RUNLOCK() mtx_unlock(&dn_cfg.uh_mtx)
74 #define DN_BH_WLOCK() mtx_lock(&dn_cfg.uh_mtx)
75 #define DN_BH_WUNLOCK() mtx_unlock(&dn_cfg.uh_mtx)
76 #define DN_BH_LOCK_ASSERT() mtx_assert(&dn_cfg.uh_mtx, MA_OWNED)
78 SLIST_HEAD(dn_schk_head, dn_schk);
79 SLIST_HEAD(dn_sch_inst_head, dn_sch_inst);
80 SLIST_HEAD(dn_fsk_head, dn_fsk);
81 SLIST_HEAD(dn_queue_head, dn_queue);
82 SLIST_HEAD(dn_alg_head, dn_alg);
85 SLIST_HEAD(dn_aqm_head, dn_aqm); /* for new AQMs */
88 struct mq { /* a basic queue of packets*/
89 struct mbuf *head, *tail;
93 set_oid(struct dn_id *o, int type, int len)
101 * configuration and global data for a dummynet instance
103 * When a configuration is modified from userland, 'id' is incremented
104 * so we can use the value to check for stale pointers.
107 uint32_t id; /* configuration version */
109 /* defaults (sysctl-accessible) */
110 int red_lookup_depth;
111 int red_avg_pkt_size;
112 int red_max_pkt_size;
115 long byte_limit; /* max queue sizes */
122 struct timeval prev_t; /* last time dummynet_tick ran */
123 struct dn_heap evheap; /* scheduled events */
125 /* counters of objects -- used for reporting space */
131 /* ticks and other stuff */
133 /* flowsets and schedulers are in hash tables, with 'hash_size'
134 * buckets. fshash is looked up at every packet arrival
135 * so better be generous if we expect many entries.
137 struct dn_ht *fshash;
138 struct dn_ht *schedhash;
139 /* list of flowsets without a scheduler -- use sch_chain */
140 struct dn_fsk_head fsu; /* list of unlinked flowsets */
141 struct dn_alg_head schedlist; /* list of algorithms */
143 struct dn_aqm_head aqmlist; /* list of AQMs */
146 /* Store the fs/sch to scan when draining. The value is the
147 * bucket number of the hash table. Expire can be disabled
148 * with net.inet.ip.dummynet.expire=0, or it happens every
154 uint32_t expire_cycle; /* tick count */
158 /* if the upper half is busy doing something long,
159 * can set the busy flag and we will enqueue packets in
160 * a queue for later processing.
167 * This file is normally used in the kernel, unless we do
168 * some userland tests, in which case we do not need a mtx.
169 * uh_mtx arbitrates between system calls and also
170 * protects fshash, schedhash and fsunlinked.
171 * These structures are readonly for the lower half.
172 * bh_mtx protects all other structures which may be
173 * modified upon packet arrivals
175 #if defined( __linux__ ) || defined( _WIN32 )
187 * Delay line, contains all packets on output from a link.
188 * Every scheduler instance has one.
192 struct dn_sch_inst *si;
197 * The kernel side of a flowset. It is linked in a hash table
198 * of flowsets, and in a list of children of their parent scheduler.
199 * qht is either the queue or (if HAVE_MASK) a hash table queues.
200 * Note that the mask to use is the (flow_mask|sched_mask), which
201 * changes as we attach/detach schedulers. So we store it here.
203 * XXX If we want to add scheduler-specific parameters, we need to
204 * put them in external storage because the scheduler may not be
205 * available when the fsk is created.
207 struct dn_fsk { /* kernel side of a flowset */
209 SLIST_ENTRY(dn_fsk) fsk_next; /* hash chain for fshash */
211 struct ipfw_flow_id fsk_mask;
213 /* qht is a hash table of queues, or just a single queue
214 * a bit in fs.flags tells us which one
217 struct dn_schk *sched; /* Sched we are linked to */
218 SLIST_ENTRY(dn_fsk) sch_chain; /* list of fsk attached to sched */
220 /* bucket index used by drain routine to drain queues for this
224 /* Parameter realted to RED / GRED */
225 /* original values are in dn_fs*/
226 int w_q ; /* queue weight (scaled) */
227 int max_th ; /* maximum threshold for queue (scaled) */
228 int min_th ; /* minimum threshold for queue (scaled) */
229 int max_p ; /* maximum value for p_b (scaled) */
231 u_int c_1 ; /* max_p/(max_th-min_th) (scaled) */
232 u_int c_2 ; /* max_p*min_th/(max_th-min_th) (scaled) */
233 u_int c_3 ; /* for GRED, (1-max_p)/max_th (scaled) */
234 u_int c_4 ; /* for GRED, 1 - 2*max_p (scaled) */
235 u_int * w_q_lookup ; /* lookup table for computing (1-w_q)^t */
236 u_int lookup_depth ; /* depth of lookup table */
237 int lookup_step ; /* granularity inside the lookup table */
238 int lookup_weight ; /* equal to (1-w_q)^t / (1-w_q)^(t+1) */
239 int avg_pkt_size ; /* medium packet size */
240 int max_pkt_size ; /* max packet size */
242 struct dn_aqm *aqmfp; /* Pointer to AQM functions */
243 void *aqmcfg; /* configuration parameters for AQM */
248 * A queue is created as a child of a flowset unless it belongs to
249 * a !MULTIQUEUE scheduler. It is normally in a hash table in the
250 * flowset. fs always points to the parent flowset.
251 * si normally points to the sch_inst, unless the flowset has been
252 * detached from the scheduler -- in this case si == NULL and we
253 * should not enqueue.
256 struct dn_flow ni; /* oid, flow_id, stats */
257 struct mq mq; /* packets queue */
258 struct dn_sch_inst *_si; /* owner scheduler instance */
259 SLIST_ENTRY(dn_queue) q_next; /* hash chain list for qht */
260 struct dn_fsk *fs; /* parent flowset. */
263 int avg; /* average queue length est. (scaled) */
264 int count; /* arrivals since last RED drop */
265 int random; /* random value (scaled) */
266 uint64_t q_time; /* start of queue idle time */
268 void *aqm_status; /* per-queue status variables*/
274 * The kernel side of a scheduler. Contains the userland config,
275 * a link, pointer to extra config arguments from command line,
276 * kernel flags, and a pointer to the scheduler methods.
277 * It is stored in a hash table, and holds a list of all
278 * flowsets and scheduler instances.
279 * XXX sch must be at the beginning, see schk_hash().
283 struct dn_alg *fp; /* Pointer to scheduler functions */
284 struct dn_link link; /* The link, embedded */
285 struct dn_profile *profile; /* delay profile, if any */
286 struct dn_id *cfg; /* extra config arguments */
288 SLIST_ENTRY(dn_schk) schk_next; /* hash chain for schedhash */
290 struct dn_fsk_head fsk_list; /* all fsk linked to me */
291 struct dn_fsk *fs; /* Flowset for !MULTIQUEUE */
293 /* bucket index used by the drain routine to drain the scheduler
294 * instance for this flowset.
298 /* Hash table of all instances (through sch.sched_mask)
299 * or single instance if no mask. Always valid.
306 * Scheduler instance.
307 * Contains variables and all queues relative to a this instance.
308 * This struct is created a runtime.
311 struct dn_flow ni; /* oid, flowid and stats */
312 SLIST_ENTRY(dn_sch_inst) si_next; /* hash chain for siht */
313 struct delay_line dline;
314 struct dn_schk *sched; /* the template */
315 int kflags; /* DN_ACTIVE */
317 int64_t credit; /* bits I can transmit (more or less). */
318 uint64_t sched_time; /* time link was scheduled in ready_heap */
319 uint64_t idle_time; /* start of scheduler instance idle time */
321 /* q_count is the number of queues that this instance is using.
322 * The counter is incremented or decremented when
323 * a reference from the queue is created or deleted.
324 * It is used to make sure that a scheduler instance can be safely
325 * deleted by the drain routine. See notes below.
332 * NOTE about object drain.
333 * The system will automatically (XXX check when) drain queues and
334 * scheduler instances when they are idle.
335 * A queue is idle when it has no packets; an instance is idle when
336 * it is not in the evheap heap, and the corresponding delay line is empty.
337 * A queue can be safely deleted when it is idle because of the scheduler
338 * function xxx_free_queue() will remove any references to it.
339 * An instance can be only deleted when no queues reference it. To be sure
340 * of that, a counter (q_count) stores the number of queues that are pointing
345 * - take all flowset in a bucket for the flowset hash table
346 * - take all queues in a bucket for the flowset
347 * - increment the queue bucket
348 * - scan next flowset bucket
349 * Nothing is done if a bucket contains no entries.
351 * The same schema is used for sceduler instances
355 /* kernel-side flags. Linux has DN_DELETE in fcntl.h
358 /* 1 and 2 are reserved for the SCAN flags */
359 DN_DESTROY = 0x0004, /* destroy */
360 DN_DELETE_FS = 0x0008, /* destroy flowset */
362 DN_ACTIVE = 0x0020, /* object is in evheap */
363 DN_F_DLINE = 0x0040, /* object is a delay line */
364 DN_DEL_SAFE = 0x0080, /* delete a queue only if no longer needed
366 DN_QHT_IS_Q = 0x0100, /* in flowset, qht is a single queue */
369 extern struct dn_parms dn_cfg;
370 //VNET_DECLARE(struct dn_parms, _base_dn_cfg);
371 //#define dn_cfg VNET(_base_dn_cfg)
373 int dummynet_io(struct mbuf **, int , struct ip_fw_args *);
374 void dummynet_task(void *context, int pending);
375 void dn_reschedule(void);
377 struct dn_queue *ipdn_q_find(struct dn_fsk *, struct dn_sch_inst *,
378 struct ipfw_flow_id *);
379 struct dn_sch_inst *ipdn_si_find(struct dn_schk *, struct ipfw_flow_id *);
382 * copy_range is a template for requests for ranges of pipes/queues/scheds.
383 * The number of ranges is variable and can be derived by o.len.
384 * As a default, we use a small number of entries so that the struct
385 * fits easily on the stack and is sufficient for most common requests.
387 #define DEFAULT_RANGES 5
390 uint32_t r[ 2 * DEFAULT_RANGES ];
398 struct copy_range *extra; /* extra filtering */
402 int ip_dummynet_compat(struct sockopt *sopt);
403 int dummynet_get(struct sockopt *sopt, void **compat);
404 int dn_c_copy_q (void *_ni, void *arg);
405 int dn_c_copy_pipe(struct dn_schk *s, struct copy_args *a, int nq);
406 int dn_c_copy_fs(struct dn_fsk *f, struct copy_args *a, int nq);
407 int dn_compat_copy_queue(struct copy_args *a, void *_o);
408 int dn_compat_copy_pipe(struct copy_args *a, void *_o);
409 int copy_data_helper_compat(void *_o, void *_arg);
410 int dn_compat_calc_size(void);
411 int do_config(void *p, int l);
413 /* function to drain idle object */
414 void dn_drain_scheduler(void);
415 void dn_drain_queue(void);
418 int ecn_mark(struct mbuf* m);
420 /* moved from ip_dn_io.c to here to be available for AQMs modules*/
422 mq_append(struct mq *q, struct mbuf *m)
427 q->tail->m_nextpkt = m;
433 #endif /* _IP_DN_PRIVATE_H */