1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
|
/*
* lib/route/qdisc/htb.c HTB Qdisc
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation version 2.1
* of the License.
*
* Copyright (c) 2003-2011 Thomas Graf <tgraf@suug.ch>
* Copyright (c) 2005-2006 Petr Gotthard <petr.gotthard@siemens.com>
* Copyright (c) 2005-2006 Siemens AG Oesterreich
*/
/**
* @ingroup qdisc
* @ingroup class
* @defgroup qdisc_htb Hierachical Token Bucket (HTB)
* @{
*/
#include <netlink-local.h>
#include <netlink-tc.h>
#include <netlink/netlink.h>
#include <netlink/cache.h>
#include <netlink/utils.h>
#include <netlink/route/tc-api.h>
#include <netlink/route/qdisc.h>
#include <netlink/route/class.h>
#include <netlink/route/link.h>
#include <netlink/route/qdisc/htb.h>
/** @cond SKIP */
#define SCH_HTB_HAS_RATE2QUANTUM 0x01
#define SCH_HTB_HAS_DEFCLS 0x02
#define SCH_HTB_HAS_PRIO 0x001
#define SCH_HTB_HAS_RATE 0x002
#define SCH_HTB_HAS_CEIL 0x004
#define SCH_HTB_HAS_RBUFFER 0x008
#define SCH_HTB_HAS_CBUFFER 0x010
#define SCH_HTB_HAS_QUANTUM 0x020
#define SCH_HTB_HAS_LEVEL 0x040
/** @endcond */
static struct nla_policy htb_policy[TCA_HTB_MAX+1] = {
[TCA_HTB_INIT] = { .minlen = sizeof(struct tc_htb_glob) },
[TCA_HTB_PARMS] = { .minlen = sizeof(struct tc_htb_opt) },
};
static int htb_qdisc_msg_parser(struct rtnl_tc *tc, void *data)
{
struct nlattr *tb[TCA_HTB_MAX + 1];
struct rtnl_htb_qdisc *htb = data;
int err;
if ((err = tca_parse(tb, TCA_HTB_MAX, tc, htb_policy)) < 0)
return err;
if (tb[TCA_HTB_INIT]) {
struct tc_htb_glob opts;
nla_memcpy(&opts, tb[TCA_HTB_INIT], sizeof(opts));
htb->qh_rate2quantum = opts.rate2quantum;
htb->qh_defcls = opts.defcls;
htb->qh_direct_pkts = opts.direct_pkts;
htb->qh_mask = (SCH_HTB_HAS_RATE2QUANTUM | SCH_HTB_HAS_DEFCLS);
}
return 0;
}
static int htb_class_msg_parser(struct rtnl_tc *tc, void *data)
{
struct nlattr *tb[TCA_HTB_MAX + 1];
struct rtnl_htb_class *htb = data;
int err;
if ((err = tca_parse(tb, TCA_HTB_MAX, tc, htb_policy)) < 0)
return err;
if (tb[TCA_HTB_PARMS]) {
struct tc_htb_opt opts;
nla_memcpy(&opts, tb[TCA_HTB_PARMS], sizeof(opts));
htb->ch_prio = opts.prio;
rtnl_copy_ratespec(&htb->ch_rate, &opts.rate);
rtnl_copy_ratespec(&htb->ch_ceil, &opts.ceil);
htb->ch_rbuffer = rtnl_tc_calc_bufsize(opts.buffer,
opts.rate.rate);
htb->ch_cbuffer = rtnl_tc_calc_bufsize(opts.cbuffer,
opts.ceil.rate);
htb->ch_quantum = opts.quantum;
htb->ch_level = opts.level;
rtnl_tc_set_mpu(tc, htb->ch_rate.rs_mpu);
rtnl_tc_set_overhead(tc, htb->ch_rate.rs_overhead);
htb->ch_mask = (SCH_HTB_HAS_PRIO | SCH_HTB_HAS_RATE |
SCH_HTB_HAS_CEIL | SCH_HTB_HAS_RBUFFER |
SCH_HTB_HAS_CBUFFER | SCH_HTB_HAS_QUANTUM |
SCH_HTB_HAS_LEVEL);
}
return 0;
}
static void htb_qdisc_dump_line(struct rtnl_tc *tc, void *data,
struct nl_dump_params *p)
{
struct rtnl_htb_qdisc *htb = data;
if (!htb)
return;
if (htb->qh_mask & SCH_HTB_HAS_RATE2QUANTUM)
nl_dump(p, " r2q %u", htb->qh_rate2quantum);
if (htb->qh_mask & SCH_HTB_HAS_DEFCLS) {
char buf[64];
nl_dump(p, " default-class %s",
rtnl_tc_handle2str(htb->qh_defcls, buf, sizeof(buf)));
}
}
static void htb_class_dump_line(struct rtnl_tc *tc, void *data,
struct nl_dump_params *p)
{
struct rtnl_htb_class *htb = data;
if (!htb)
return;
if (htb->ch_mask & SCH_HTB_HAS_RATE) {
double r, rbit;
char *ru, *rubit;
r = nl_cancel_down_bytes(htb->ch_rate.rs_rate, &ru);
rbit = nl_cancel_down_bits(htb->ch_rate.rs_rate*8, &rubit);
nl_dump(p, " rate %.2f%s/s (%.0f%s) log %u",
r, ru, rbit, rubit, 1<<htb->ch_rate.rs_cell_log);
}
}
static void htb_class_dump_details(struct rtnl_tc *tc, void *data,
struct nl_dump_params *p)
{
struct rtnl_htb_class *htb = data;
if (!htb)
return;
/* line 1 */
if (htb->ch_mask & SCH_HTB_HAS_CEIL) {
double r, rbit;
char *ru, *rubit;
r = nl_cancel_down_bytes(htb->ch_ceil.rs_rate, &ru);
rbit = nl_cancel_down_bits(htb->ch_ceil.rs_rate*8, &rubit);
nl_dump(p, " ceil %.2f%s/s (%.0f%s) log %u",
r, ru, rbit, rubit, 1<<htb->ch_ceil.rs_cell_log);
}
if (htb->ch_mask & SCH_HTB_HAS_PRIO)
nl_dump(p, " prio %u", htb->ch_prio);
if (htb->ch_mask & SCH_HTB_HAS_RBUFFER) {
double b;
char *bu;
b = nl_cancel_down_bytes(htb->ch_rbuffer, &bu);
nl_dump(p, " rbuffer %.2f%s", b, bu);
}
if (htb->ch_mask & SCH_HTB_HAS_CBUFFER) {
double b;
char *bu;
b = nl_cancel_down_bytes(htb->ch_cbuffer, &bu);
nl_dump(p, " cbuffer %.2f%s", b, bu);
}
if (htb->ch_mask & SCH_HTB_HAS_QUANTUM)
nl_dump(p, " quantum %u", htb->ch_quantum);
}
static int htb_qdisc_msg_fill(struct rtnl_tc *tc, void *data,
struct nl_msg *msg)
{
struct rtnl_htb_qdisc *htb = data;
struct tc_htb_glob opts = {0};
opts.version = TC_HTB_PROTOVER;
opts.rate2quantum = 10;
if (htb) {
if (htb->qh_mask & SCH_HTB_HAS_RATE2QUANTUM)
opts.rate2quantum = htb->qh_rate2quantum;
if (htb->qh_mask & SCH_HTB_HAS_DEFCLS)
opts.defcls = htb->qh_defcls;
}
return nla_put(msg, TCA_HTB_INIT, sizeof(opts), &opts);
}
static int htb_class_msg_fill(struct rtnl_tc *tc, void *data,
struct nl_msg *msg)
{
struct rtnl_htb_class *htb = data;
uint32_t mtu, rtable[RTNL_TC_RTABLE_SIZE], ctable[RTNL_TC_RTABLE_SIZE];
struct tc_htb_opt opts;
int buffer, cbuffer;
if (!htb || !(htb->ch_mask & SCH_HTB_HAS_RATE))
BUG();
memset(&opts, 0, sizeof(opts));
/* if not set, zero (0) is used as priority */
if (htb->ch_mask & SCH_HTB_HAS_PRIO)
opts.prio = htb->ch_prio;
mtu = rtnl_tc_get_mtu(tc);
rtnl_tc_build_rate_table(tc, &htb->ch_rate, rtable);
rtnl_rcopy_ratespec(&opts.rate, &htb->ch_rate);
if (htb->ch_mask & SCH_HTB_HAS_CEIL) {
rtnl_tc_build_rate_table(tc, &htb->ch_ceil, ctable);
rtnl_rcopy_ratespec(&opts.ceil, &htb->ch_ceil);
} else {
/*
* If not set, configured rate is used as ceil, which implies
* no borrowing.
*/
memcpy(&opts.ceil, &opts.rate, sizeof(struct tc_ratespec));
}
if (htb->ch_mask & SCH_HTB_HAS_RBUFFER)
buffer = htb->ch_rbuffer;
else
buffer = opts.rate.rate / nl_get_user_hz() + mtu; /* XXX */
opts.buffer = rtnl_tc_calc_txtime(buffer, opts.rate.rate);
if (htb->ch_mask & SCH_HTB_HAS_CBUFFER)
cbuffer = htb->ch_cbuffer;
else
cbuffer = opts.ceil.rate / nl_get_user_hz() + mtu; /* XXX */
opts.cbuffer = rtnl_tc_calc_txtime(cbuffer, opts.ceil.rate);
if (htb->ch_mask & SCH_HTB_HAS_QUANTUM)
opts.quantum = htb->ch_quantum;
NLA_PUT(msg, TCA_HTB_PARMS, sizeof(opts), &opts);
NLA_PUT(msg, TCA_HTB_RTAB, sizeof(rtable), &rtable);
NLA_PUT(msg, TCA_HTB_CTAB, sizeof(ctable), &ctable);
return 0;
nla_put_failure:
return -NLE_MSGSIZE;
}
static struct rtnl_tc_ops htb_qdisc_ops;
static struct rtnl_tc_ops htb_class_ops;
static struct rtnl_htb_qdisc *htb_qdisc_data(struct rtnl_qdisc *qdisc)
{
return rtnl_tc_data_check(TC_CAST(qdisc), &htb_qdisc_ops);
}
static struct rtnl_htb_class *htb_class_data(struct rtnl_class *class)
{
return rtnl_tc_data_check(TC_CAST(class), &htb_class_ops);
}
/**
* @name Attribute Modifications
* @{
*/
/**
* Return rate/quantum ratio of HTB qdisc
* @arg qdisc htb qdisc object
*
* @return rate/quantum ratio or 0 if unspecified
*/
uint32_t rtnl_htb_get_rate2quantum(struct rtnl_qdisc *qdisc)
{
struct rtnl_htb_qdisc *htb;
if ((htb = htb_qdisc_data(qdisc)) &&
htb->qh_mask & SCH_HTB_HAS_RATE2QUANTUM)
return htb->qh_rate2quantum;
return 0;
}
int rtnl_htb_set_rate2quantum(struct rtnl_qdisc *qdisc, uint32_t rate2quantum)
{
struct rtnl_htb_qdisc *htb;
if (!(htb = htb_qdisc_data(qdisc)))
return -NLE_OPNOTSUPP;
htb->qh_rate2quantum = rate2quantum;
htb->qh_mask |= SCH_HTB_HAS_RATE2QUANTUM;
return 0;
}
/**
* Return default class of HTB qdisc
* @arg qdisc htb qdisc object
*
* Returns the classid of the class where all unclassified traffic
* goes to.
*
* @return classid or TC_H_UNSPEC if unspecified.
*/
uint32_t rtnl_htb_get_defcls(struct rtnl_qdisc *qdisc)
{
struct rtnl_htb_qdisc *htb;
if ((htb = htb_qdisc_data(qdisc)) &&
htb->qh_mask & SCH_HTB_HAS_DEFCLS)
return htb->qh_defcls;
return TC_H_UNSPEC;
}
/**
* Set default class of the htb qdisc to the specified value
* @arg qdisc qdisc to change
* @arg defcls new default class
*/
int rtnl_htb_set_defcls(struct rtnl_qdisc *qdisc, uint32_t defcls)
{
struct rtnl_htb_qdisc *htb;
if (!(htb = htb_qdisc_data(qdisc)))
return -NLE_OPNOTSUPP;
htb->qh_defcls = defcls;
htb->qh_mask |= SCH_HTB_HAS_DEFCLS;
return 0;
}
uint32_t rtnl_htb_get_prio(struct rtnl_class *class)
{
struct rtnl_htb_class *htb;
if ((htb = htb_class_data(class)) && htb->ch_mask & SCH_HTB_HAS_PRIO)
return htb->ch_prio;
return 0;
}
int rtnl_htb_set_prio(struct rtnl_class *class, uint32_t prio)
{
struct rtnl_htb_class *htb;
if (!(htb = htb_class_data(class)))
return -NLE_OPNOTSUPP;
htb->ch_prio = prio;
htb->ch_mask |= SCH_HTB_HAS_PRIO;
return 0;
}
/**
* Return rate of HTB class
* @arg class htb class object
*
* @return Rate in bytes/s or 0 if unspecified.
*/
uint32_t rtnl_htb_get_rate(struct rtnl_class *class)
{
struct rtnl_htb_class *htb;
if ((htb = htb_class_data(class)) && htb->ch_mask & SCH_HTB_HAS_RATE)
return htb->ch_rate.rs_rate;
return 0;
}
/**
* Set rate of HTB class
* @arg class htb class object
* @arg rate new rate in bytes per second
*
* @return 0 on success or a negative error code.
*/
int rtnl_htb_set_rate(struct rtnl_class *class, uint32_t rate)
{
struct rtnl_htb_class *htb;
if (!(htb = htb_class_data(class)))
return -NLE_OPNOTSUPP;
htb->ch_rate.rs_cell_log = UINT8_MAX; /* use default value */
htb->ch_rate.rs_rate = rate;
htb->ch_mask |= SCH_HTB_HAS_RATE;
return 0;
}
/**
* Return ceil rate of HTB class
* @arg class htb class object
*
* @return Ceil rate in bytes/s or 0 if unspecified
*/
uint32_t rtnl_htb_get_ceil(struct rtnl_class *class)
{
struct rtnl_htb_class *htb;
if ((htb = htb_class_data(class)) && htb->ch_mask & SCH_HTB_HAS_CEIL)
return htb->ch_ceil.rs_rate;
return 0;
}
/**
* Set ceil rate of HTB class
* @arg class htb class object
* @arg ceil new ceil rate number of bytes per second
*
* @return 0 on success or a negative error code.
*/
int rtnl_htb_set_ceil(struct rtnl_class *class, uint32_t ceil)
{
struct rtnl_htb_class *htb;
if (!(htb = htb_class_data(class)))
return -NLE_OPNOTSUPP;
htb->ch_ceil.rs_cell_log = UINT8_MAX; /* use default value */
htb->ch_ceil.rs_rate = ceil;
htb->ch_mask |= SCH_HTB_HAS_CEIL;
return 0;
}
/**
* Return burst buffer size of HTB class
* @arg class htb class object
*
* @return Burst buffer size or 0 if unspecified
*/
uint32_t rtnl_htb_get_rbuffer(struct rtnl_class *class)
{
struct rtnl_htb_class *htb;
if ((htb = htb_class_data(class)) &&
htb->ch_mask & SCH_HTB_HAS_RBUFFER)
return htb->ch_rbuffer;
return 0;
}
/**
* Set size of the rate bucket of HTB class.
* @arg class HTB class to be modified.
* @arg rbuffer New size in bytes.
*/
int rtnl_htb_set_rbuffer(struct rtnl_class *class, uint32_t rbuffer)
{
struct rtnl_htb_class *htb;
if (!(htb = htb_class_data(class)))
return -NLE_OPNOTSUPP;
htb->ch_rbuffer = rbuffer;
htb->ch_mask |= SCH_HTB_HAS_RBUFFER;
return 0;
}
/**
* Return ceil burst buffer size of HTB class
* @arg class htb class object
*
* @return Ceil burst buffer size or 0 if unspecified
*/
uint32_t rtnl_htb_get_cbuffer(struct rtnl_class *class)
{
struct rtnl_htb_class *htb;
if ((htb = htb_class_data(class)) &&
htb->ch_mask & SCH_HTB_HAS_CBUFFER)
return htb->ch_cbuffer;
return 0;
}
/**
* Set size of the ceil bucket of HTB class.
* @arg class HTB class to be modified.
* @arg cbuffer New size in bytes.
*/
int rtnl_htb_set_cbuffer(struct rtnl_class *class, uint32_t cbuffer)
{
struct rtnl_htb_class *htb;
if (!(htb = htb_class_data(class)))
return -NLE_OPNOTSUPP;
htb->ch_cbuffer = cbuffer;
htb->ch_mask |= SCH_HTB_HAS_CBUFFER;
return 0;
}
/**
* Return quantum of HTB class
* @arg class htb class object
*
* See XXX[quantum def]
*
* @return Quantum or 0 if unspecified.
*/
uint32_t rtnl_htb_get_quantum(struct rtnl_class *class)
{
struct rtnl_htb_class *htb;
if ((htb = htb_class_data(class)) &&
htb->ch_mask & SCH_HTB_HAS_QUANTUM)
return htb->ch_quantum;
return 0;
}
/**
* Set quantum of HTB class (overwrites value calculated based on r2q)
* @arg class htb class object
* @arg quantum new quantum in number of bytes
*
* See XXX[quantum def]
*
* @return 0 on success or a negative error code.
*/
int rtnl_htb_set_quantum(struct rtnl_class *class, uint32_t quantum)
{
struct rtnl_htb_class *htb;
if (!(htb = htb_class_data(class)))
return -NLE_OPNOTSUPP;
htb->ch_quantum = quantum;
htb->ch_mask |= SCH_HTB_HAS_QUANTUM;
return 0;
}
/**
* Return level of HTB class
* @arg class htb class object
*
* Returns the level of the HTB class. Leaf classes are assigned level
* 0, root classes have level (TC_HTB_MAXDEPTH - 1). Interior classes
* have a level of one less than their parent.
*
* @return Level or -NLE_OPNOTSUPP
*/
int rtnl_htb_get_level(struct rtnl_class *class)
{
struct rtnl_htb_class *htb;
if ((htb = htb_class_data(class)) && htb->ch_mask & SCH_HTB_HAS_LEVEL)
return htb->ch_level;
return -NLE_OPNOTSUPP;
}
/**
* Set level of HTB class
* @arg class htb class object
* @arg level new level of HTB class
*
* Sets the level of a HTB class. Note that changing the level of a HTB
* class does not change the level of its in kernel counterpart. This
* function is provided only to create HTB objects which can be compared
* against or filtered upon.
*
* @return 0 on success or a negative error code.
*/
int rtnl_htb_set_level(struct rtnl_class *class, int level)
{
struct rtnl_htb_class *htb;
if (!(htb = htb_class_data(class)))
return -NLE_OPNOTSUPP;
htb->ch_level = level;
htb->ch_mask |= SCH_HTB_HAS_LEVEL;
return 0;
}
/** @} */
static struct rtnl_tc_ops htb_qdisc_ops = {
.to_kind = "htb",
.to_type = RTNL_TC_TYPE_QDISC,
.to_size = sizeof(struct rtnl_htb_qdisc),
.to_msg_parser = htb_qdisc_msg_parser,
.to_dump[NL_DUMP_LINE] = htb_qdisc_dump_line,
.to_msg_fill = htb_qdisc_msg_fill,
};
static struct rtnl_tc_ops htb_class_ops = {
.to_kind = "htb",
.to_type = RTNL_TC_TYPE_CLASS,
.to_size = sizeof(struct rtnl_htb_class),
.to_msg_parser = htb_class_msg_parser,
.to_dump = {
[NL_DUMP_LINE] = htb_class_dump_line,
[NL_DUMP_DETAILS] = htb_class_dump_details,
},
.to_msg_fill = htb_class_msg_fill,
};
static void __init htb_init(void)
{
rtnl_tc_register(&htb_qdisc_ops);
rtnl_tc_register(&htb_class_ops);
}
static void __exit htb_exit(void)
{
rtnl_tc_unregister(&htb_qdisc_ops);
rtnl_tc_unregister(&htb_class_ops);
}
/** @} */
|