1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2010 Luigi Rizzo, Riccardo Panicucci, Universita` di Pisa 5 * 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 THE AUTHOR 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 THE AUTHOR 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 29 /* 30 * internal dummynet APIs. 31 * 32 * $FreeBSD$ 33 */ 34 35 #ifndef _IP_DN_PRIVATE_H 36 #define _IP_DN_PRIVATE_H 37 38 /* debugging support 39 * use ND() to remove debugging, D() to print a line, 40 * DX(level, ...) to print above a certain level 41 * If you redefine D() you are expected to redefine all. 42 */ 43 #ifndef D 44 #define ND(fmt, ...) do {} while (0) 45 #define D1(fmt, ...) do {} while (0) 46 #define D(fmt, ...) printf("%-10s " fmt "\n", \ 47 __FUNCTION__, ## __VA_ARGS__) 48 #define DX(lev, fmt, ...) do { \ 49 if (dn_cfg.debug > lev) D(fmt, ## __VA_ARGS__); } while (0) 50 #endif 51 52 MALLOC_DECLARE(M_DUMMYNET); 53 54 #ifndef __linux__ 55 #define div64(a, b) ((int64_t)(a) / (int64_t)(b)) 56 #endif 57 58 #define DN_LOCK_INIT() do { \ 59 mtx_init(&dn_cfg.uh_mtx, "dn_uh", NULL, MTX_DEF); \ 60 mtx_init(&dn_cfg.bh_mtx, "dn_bh", NULL, MTX_DEF); \ 61 } while (0) 62 #define DN_LOCK_DESTROY() do { \ 63 mtx_destroy(&dn_cfg.uh_mtx); \ 64 mtx_destroy(&dn_cfg.bh_mtx); \ 65 } while (0) 66 #if 0 /* not used yet */ 67 #define DN_UH_RLOCK() mtx_lock(&dn_cfg.uh_mtx) 68 #define DN_UH_RUNLOCK() mtx_unlock(&dn_cfg.uh_mtx) 69 #define DN_UH_WLOCK() mtx_lock(&dn_cfg.uh_mtx) 70 #define DN_UH_WUNLOCK() mtx_unlock(&dn_cfg.uh_mtx) 71 #define DN_UH_LOCK_ASSERT() mtx_assert(&dn_cfg.uh_mtx, MA_OWNED) 72 #endif 73 74 #define DN_BH_RLOCK() mtx_lock(&dn_cfg.uh_mtx) 75 #define DN_BH_RUNLOCK() mtx_unlock(&dn_cfg.uh_mtx) 76 #define DN_BH_WLOCK() mtx_lock(&dn_cfg.uh_mtx) 77 #define DN_BH_WUNLOCK() mtx_unlock(&dn_cfg.uh_mtx) 78 #define DN_BH_LOCK_ASSERT() mtx_assert(&dn_cfg.uh_mtx, MA_OWNED) 79 80 SLIST_HEAD(dn_schk_head, dn_schk); 81 SLIST_HEAD(dn_sch_inst_head, dn_sch_inst); 82 SLIST_HEAD(dn_fsk_head, dn_fsk); 83 SLIST_HEAD(dn_queue_head, dn_queue); 84 SLIST_HEAD(dn_alg_head, dn_alg); 85 86 #ifdef NEW_AQM 87 SLIST_HEAD(dn_aqm_head, dn_aqm); /* for new AQMs */ 88 #endif 89 90 struct mq { /* a basic queue of packets*/ 91 struct mbuf *head, *tail; 92 int count; 93 }; 94 95 static inline void 96 set_oid(struct dn_id *o, int type, int len) 97 { 98 o->type = type; 99 o->len = len; 100 o->subtype = 0; 101 } 102 103 /* 104 * configuration and global data for a dummynet instance 105 * 106 * When a configuration is modified from userland, 'id' is incremented 107 * so we can use the value to check for stale pointers. 108 */ 109 struct dn_parms { 110 uint32_t id; /* configuration version */ 111 112 /* defaults (sysctl-accessible) */ 113 int red_lookup_depth; 114 int red_avg_pkt_size; 115 int red_max_pkt_size; 116 int hash_size; 117 int max_hash_size; 118 long byte_limit; /* max queue sizes */ 119 long slot_limit; 120 121 int io_fast; 122 int debug; 123 124 /* timekeeping */ 125 struct timeval prev_t; /* last time dummynet_tick ran */ 126 struct dn_heap evheap; /* scheduled events */ 127 128 long tick_last; /* Last tick duration (usec). */ 129 long tick_delta; /* Last vs standard tick diff (usec). */ 130 long tick_delta_sum; /* Accumulated tick difference (usec).*/ 131 long tick_adjustment; /* Tick adjustments done. */ 132 long tick_lost; /* Lost(coalesced) ticks number. */ 133 /* Adjusted vs non-adjusted curr_time difference (ticks). */ 134 long tick_diff; 135 136 /* counters of objects -- used for reporting space */ 137 int schk_count; 138 int si_count; 139 int fsk_count; 140 int queue_count; 141 142 /* packet counters */ 143 unsigned long io_pkt; 144 unsigned long io_pkt_fast; 145 unsigned long io_pkt_drop; 146 147 /* ticks and other stuff */ 148 uint64_t curr_time; 149 /* flowsets and schedulers are in hash tables, with 'hash_size' 150 * buckets. fshash is looked up at every packet arrival 151 * so better be generous if we expect many entries. 152 */ 153 struct dn_ht *fshash; 154 struct dn_ht *schedhash; 155 /* list of flowsets without a scheduler -- use sch_chain */ 156 struct dn_fsk_head fsu; /* list of unlinked flowsets */ 157 struct dn_alg_head schedlist; /* list of algorithms */ 158 #ifdef NEW_AQM 159 struct dn_aqm_head aqmlist; /* list of AQMs */ 160 #endif 161 162 /* Store the fs/sch to scan when draining. The value is the 163 * bucket number of the hash table. Expire can be disabled 164 * with net.inet.ip.dummynet.expire=0, or it happens every 165 * expire ticks. 166 **/ 167 int drain_fs; 168 int drain_sch; 169 uint32_t expire; 170 uint32_t expire_cycle; /* tick count */ 171 172 int init_done; 173 174 #ifdef _KERNEL 175 /* 176 * This file is normally used in the kernel, unless we do 177 * some userland tests, in which case we do not need a mtx. 178 * uh_mtx arbitrates between system calls and also 179 * protects fshash, schedhash and fsunlinked. 180 * These structures are readonly for the lower half. 181 * bh_mtx protects all other structures which may be 182 * modified upon packet arrivals 183 */ 184 #if defined( __linux__ ) || defined( _WIN32 ) 185 spinlock_t uh_mtx; 186 spinlock_t bh_mtx; 187 #else 188 struct mtx uh_mtx; 189 struct mtx bh_mtx; 190 #endif 191 192 #endif /* _KERNEL */ 193 }; 194 195 /* 196 * Delay line, contains all packets on output from a link. 197 * Every scheduler instance has one. 198 */ 199 struct delay_line { 200 struct dn_id oid; 201 struct dn_sch_inst *si; 202 struct mq mq; 203 }; 204 205 /* 206 * The kernel side of a flowset. It is linked in a hash table 207 * of flowsets, and in a list of children of their parent scheduler. 208 * qht is either the queue or (if HAVE_MASK) a hash table queues. 209 * Note that the mask to use is the (flow_mask|sched_mask), which 210 * changes as we attach/detach schedulers. So we store it here. 211 * 212 * XXX If we want to add scheduler-specific parameters, we need to 213 * put them in external storage because the scheduler may not be 214 * available when the fsk is created. 215 */ 216 struct dn_fsk { /* kernel side of a flowset */ 217 struct dn_fs fs; 218 SLIST_ENTRY(dn_fsk) fsk_next; /* hash chain for fshash */ 219 220 struct ipfw_flow_id fsk_mask; 221 222 /* qht is a hash table of queues, or just a single queue 223 * a bit in fs.flags tells us which one 224 */ 225 struct dn_ht *qht; 226 struct dn_schk *sched; /* Sched we are linked to */ 227 SLIST_ENTRY(dn_fsk) sch_chain; /* list of fsk attached to sched */ 228 229 /* bucket index used by drain routine to drain queues for this 230 * flowset 231 */ 232 int drain_bucket; 233 /* Parameter realted to RED / GRED */ 234 /* original values are in dn_fs*/ 235 int w_q ; /* queue weight (scaled) */ 236 int max_th ; /* maximum threshold for queue (scaled) */ 237 int min_th ; /* minimum threshold for queue (scaled) */ 238 int max_p ; /* maximum value for p_b (scaled) */ 239 240 u_int c_1 ; /* max_p/(max_th-min_th) (scaled) */ 241 u_int c_2 ; /* max_p*min_th/(max_th-min_th) (scaled) */ 242 u_int c_3 ; /* for GRED, (1-max_p)/max_th (scaled) */ 243 u_int c_4 ; /* for GRED, 1 - 2*max_p (scaled) */ 244 u_int * w_q_lookup ; /* lookup table for computing (1-w_q)^t */ 245 u_int lookup_depth ; /* depth of lookup table */ 246 int lookup_step ; /* granularity inside the lookup table */ 247 int lookup_weight ; /* equal to (1-w_q)^t / (1-w_q)^(t+1) */ 248 int avg_pkt_size ; /* medium packet size */ 249 int max_pkt_size ; /* max packet size */ 250 #ifdef NEW_AQM 251 struct dn_aqm *aqmfp; /* Pointer to AQM functions */ 252 void *aqmcfg; /* configuration parameters for AQM */ 253 #endif 254 }; 255 256 /* 257 * A queue is created as a child of a flowset unless it belongs to 258 * a !MULTIQUEUE scheduler. It is normally in a hash table in the 259 * flowset. fs always points to the parent flowset. 260 * si normally points to the sch_inst, unless the flowset has been 261 * detached from the scheduler -- in this case si == NULL and we 262 * should not enqueue. 263 */ 264 struct dn_queue { 265 struct dn_flow ni; /* oid, flow_id, stats */ 266 struct mq mq; /* packets queue */ 267 struct dn_sch_inst *_si; /* owner scheduler instance */ 268 SLIST_ENTRY(dn_queue) q_next; /* hash chain list for qht */ 269 struct dn_fsk *fs; /* parent flowset. */ 270 271 /* RED parameters */ 272 int avg; /* average queue length est. (scaled) */ 273 int count; /* arrivals since last RED drop */ 274 int random; /* random value (scaled) */ 275 uint64_t q_time; /* start of queue idle time */ 276 #ifdef NEW_AQM 277 void *aqm_status; /* per-queue status variables*/ 278 #endif 279 280 }; 281 282 /* 283 * The kernel side of a scheduler. Contains the userland config, 284 * a link, pointer to extra config arguments from command line, 285 * kernel flags, and a pointer to the scheduler methods. 286 * It is stored in a hash table, and holds a list of all 287 * flowsets and scheduler instances. 288 * XXX sch must be at the beginning, see schk_hash(). 289 */ 290 struct dn_schk { 291 struct dn_sch sch; 292 struct dn_alg *fp; /* Pointer to scheduler functions */ 293 struct dn_link link; /* The link, embedded */ 294 struct dn_profile *profile; /* delay profile, if any */ 295 struct dn_id *cfg; /* extra config arguments */ 296 297 SLIST_ENTRY(dn_schk) schk_next; /* hash chain for schedhash */ 298 299 struct dn_fsk_head fsk_list; /* all fsk linked to me */ 300 struct dn_fsk *fs; /* Flowset for !MULTIQUEUE */ 301 302 /* bucket index used by the drain routine to drain the scheduler 303 * instance for this flowset. 304 */ 305 int drain_bucket; 306 307 /* Hash table of all instances (through sch.sched_mask) 308 * or single instance if no mask. Always valid. 309 */ 310 struct dn_ht *siht; 311 }; 312 313 /* 314 * Scheduler instance. 315 * Contains variables and all queues relative to a this instance. 316 * This struct is created a runtime. 317 */ 318 struct dn_sch_inst { 319 struct dn_flow ni; /* oid, flowid and stats */ 320 SLIST_ENTRY(dn_sch_inst) si_next; /* hash chain for siht */ 321 struct delay_line dline; 322 struct dn_schk *sched; /* the template */ 323 int kflags; /* DN_ACTIVE */ 324 325 int64_t credit; /* bits I can transmit (more or less). */ 326 uint64_t sched_time; /* time link was scheduled in ready_heap */ 327 uint64_t idle_time; /* start of scheduler instance idle time */ 328 329 /* q_count is the number of queues that this instance is using. 330 * The counter is incremented or decremented when 331 * a reference from the queue is created or deleted. 332 * It is used to make sure that a scheduler instance can be safely 333 * deleted by the drain routine. See notes below. 334 */ 335 int q_count; 336 337 }; 338 339 /* 340 * NOTE about object drain. 341 * The system will automatically (XXX check when) drain queues and 342 * scheduler instances when they are idle. 343 * A queue is idle when it has no packets; an instance is idle when 344 * it is not in the evheap heap, and the corresponding delay line is empty. 345 * A queue can be safely deleted when it is idle because of the scheduler 346 * function xxx_free_queue() will remove any references to it. 347 * An instance can be only deleted when no queues reference it. To be sure 348 * of that, a counter (q_count) stores the number of queues that are pointing 349 * to the instance. 350 * 351 * XXX 352 * Order of scan: 353 * - take all flowset in a bucket for the flowset hash table 354 * - take all queues in a bucket for the flowset 355 * - increment the queue bucket 356 * - scan next flowset bucket 357 * Nothing is done if a bucket contains no entries. 358 * 359 * The same schema is used for sceduler instances 360 */ 361 362 /* kernel-side flags. Linux has DN_DELETE in fcntl.h 363 */ 364 enum { 365 /* 1 and 2 are reserved for the SCAN flags */ 366 DN_DESTROY = 0x0004, /* destroy */ 367 DN_DELETE_FS = 0x0008, /* destroy flowset */ 368 DN_DETACH = 0x0010, 369 DN_ACTIVE = 0x0020, /* object is in evheap */ 370 DN_F_DLINE = 0x0040, /* object is a delay line */ 371 DN_DEL_SAFE = 0x0080, /* delete a queue only if no longer needed 372 * by scheduler */ 373 DN_QHT_IS_Q = 0x0100, /* in flowset, qht is a single queue */ 374 }; 375 376 /* 377 * Packets processed by dummynet have an mbuf tag associated with 378 * them that carries their dummynet state. 379 * Outside dummynet, only the 'rule' field is relevant, and it must 380 * be at the beginning of the structure. 381 */ 382 struct dn_pkt_tag { 383 struct ipfw_rule_ref rule; /* matching rule */ 384 385 /* second part, dummynet specific */ 386 int dn_dir; /* action when packet comes out.*/ 387 /* see ip_fw_private.h */ 388 uint64_t output_time; /* when the pkt is due for delivery*/ 389 struct ifnet *ifp; /* interface, for ip_output */ 390 struct _ip6dn_args ip6opt; /* XXX ipv6 options */ 391 uint16_t iphdr_off; /* IP header offset for mtodo() */ 392 }; 393 394 /* 395 * Possible values for dn_dir. XXXGL: this needs to be reviewed 396 * and converted to same values ip_fw_args.flags use. 397 */ 398 enum { 399 DIR_OUT = 0, 400 DIR_IN = 1, 401 DIR_FWD = 2, 402 DIR_DROP = 3, 403 PROTO_LAYER2 = 0x4, /* set for layer 2 */ 404 PROTO_IPV4 = 0x08, 405 PROTO_IPV6 = 0x10, 406 PROTO_IFB = 0x0c, /* layer2 + ifbridge */ 407 }; 408 409 extern struct dn_parms dn_cfg; 410 //VNET_DECLARE(struct dn_parms, _base_dn_cfg); 411 //#define dn_cfg VNET(_base_dn_cfg) 412 413 int dummynet_io(struct mbuf **, struct ip_fw_args *); 414 void dummynet_task(void *context, int pending); 415 void dn_reschedule(void); 416 struct dn_pkt_tag * dn_tag_get(struct mbuf *m); 417 418 struct dn_queue *ipdn_q_find(struct dn_fsk *, struct dn_sch_inst *, 419 struct ipfw_flow_id *); 420 struct dn_sch_inst *ipdn_si_find(struct dn_schk *, struct ipfw_flow_id *); 421 422 /* 423 * copy_range is a template for requests for ranges of pipes/queues/scheds. 424 * The number of ranges is variable and can be derived by o.len. 425 * As a default, we use a small number of entries so that the struct 426 * fits easily on the stack and is sufficient for most common requests. 427 */ 428 #define DEFAULT_RANGES 5 429 struct copy_range { 430 struct dn_id o; 431 uint32_t r[ 2 * DEFAULT_RANGES ]; 432 }; 433 434 struct copy_args { 435 char **start; 436 char *end; 437 int flags; 438 int type; 439 struct copy_range *extra; /* extra filtering */ 440 }; 441 442 struct sockopt; 443 int ip_dummynet_compat(struct sockopt *sopt); 444 int dummynet_get(struct sockopt *sopt, void **compat); 445 int dn_c_copy_q (void *_ni, void *arg); 446 int dn_c_copy_pipe(struct dn_schk *s, struct copy_args *a, int nq); 447 int dn_c_copy_fs(struct dn_fsk *f, struct copy_args *a, int nq); 448 int dn_compat_copy_queue(struct copy_args *a, void *_o); 449 int dn_compat_copy_pipe(struct copy_args *a, void *_o); 450 int copy_data_helper_compat(void *_o, void *_arg); 451 int dn_compat_calc_size(void); 452 int do_config(void *p, int l); 453 454 /* function to drain idle object */ 455 void dn_drain_scheduler(void); 456 void dn_drain_queue(void); 457 458 #ifdef NEW_AQM 459 int ecn_mark(struct mbuf* m); 460 461 /* moved from ip_dn_io.c to here to be available for AQMs modules*/ 462 static inline void 463 mq_append(struct mq *q, struct mbuf *m) 464 { 465 #ifdef USERSPACE 466 // buffers from netmap need to be copied 467 // XXX note that the routine is not expected to fail 468 ND("append %p to %p", m, q); 469 if (m->m_flags & M_STACK) { 470 struct mbuf *m_new; 471 void *p; 472 int l, ofs; 473 474 ofs = m->m_data - m->__m_extbuf; 475 // XXX allocate 476 MGETHDR(m_new, M_NOWAIT, MT_DATA); 477 ND("*** WARNING, volatile buf %p ext %p %d dofs %d m_new %p", 478 m, m->__m_extbuf, m->__m_extlen, ofs, m_new); 479 p = m_new->__m_extbuf; /* new pointer */ 480 l = m_new->__m_extlen; /* new len */ 481 if (l <= m->__m_extlen) { 482 panic("extlen too large"); 483 } 484 485 *m_new = *m; // copy 486 m_new->m_flags &= ~M_STACK; 487 m_new->__m_extbuf = p; // point to new buffer 488 _pkt_copy(m->__m_extbuf, p, m->__m_extlen); 489 m_new->m_data = p + ofs; 490 m = m_new; 491 } 492 #endif /* USERSPACE */ 493 if (q->head == NULL) 494 q->head = m; 495 else 496 q->tail->m_nextpkt = m; 497 q->count++; 498 q->tail = m; 499 m->m_nextpkt = NULL; 500 } 501 #endif /* NEW_AQM */ 502 503 #endif /* _IP_DN_PRIVATE_H */ 504