2 * lib/route/cls/u32.c u32 classifier
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation version 2.1
9 * Copyright (c) 2003-2006 Thomas Graf <tgraf@suug.ch>
10 * Copyright (c) 2005-2006 Petr Gotthard <petr.gotthard@siemens.com>
11 * Copyright (c) 2005-2006 Siemens AG Oesterreich
16 * @defgroup u32 Universal 32-bit Classifier
21 #include <netlink-local.h>
22 #include <netlink-tc.h>
23 #include <netlink/netlink.h>
24 #include <netlink/attr.h>
25 #include <netlink/utils.h>
26 #include <netlink/route/tc.h>
27 #include <netlink/route/classifier.h>
28 #include <netlink/route/classifier-modules.h>
29 #include <netlink/route/cls/u32.h>
32 #define U32_ATTR_DIVISOR 0x001
33 #define U32_ATTR_HASH 0x002
34 #define U32_ATTR_CLASSID 0x004
35 #define U32_ATTR_LINK 0x008
36 #define U32_ATTR_PCNT 0x010
37 #define U32_ATTR_SELECTOR 0x020
38 #define U32_ATTR_ACTION 0x040
39 #define U32_ATTR_POLICE 0x080
40 #define U32_ATTR_INDEV 0x100
43 static inline struct rtnl_u32 *u32_cls(struct rtnl_cls *cls)
45 return (struct rtnl_u32 *) cls->c_subdata;
48 static inline struct rtnl_u32 *u32_alloc(struct rtnl_cls *cls)
51 cls->c_subdata = calloc(1, sizeof(struct rtnl_u32));
56 static inline struct tc_u32_sel *u32_selector(struct rtnl_u32 *u)
58 return (struct tc_u32_sel *) u->cu_selector->d_data;
61 static inline struct tc_u32_sel *u32_selector_alloc(struct rtnl_u32 *u)
64 u->cu_selector = nl_data_alloc(NULL, sizeof(struct tc_u32_sel));
66 return u32_selector(u);
69 static struct nla_policy u32_policy[TCA_U32_MAX+1] = {
70 [TCA_U32_DIVISOR] = { .type = NLA_U32 },
71 [TCA_U32_HASH] = { .type = NLA_U32 },
72 [TCA_U32_CLASSID] = { .type = NLA_U32 },
73 [TCA_U32_LINK] = { .type = NLA_U32 },
74 [TCA_U32_INDEV] = { .type = NLA_STRING,
76 [TCA_U32_SEL] = { .minlen = sizeof(struct tc_u32_sel) },
77 [TCA_U32_PCNT] = { .minlen = sizeof(struct tc_u32_pcnt) },
80 static int u32_msg_parser(struct rtnl_cls *cls)
83 struct nlattr *tb[TCA_U32_MAX + 1];
86 err = tca_parse(tb, TCA_U32_MAX, (struct rtnl_tca *) cls, u32_policy);
94 if (tb[TCA_U32_DIVISOR]) {
95 u->cu_divisor = nla_get_u32(tb[TCA_U32_DIVISOR]);
96 u->cu_mask |= U32_ATTR_DIVISOR;
99 if (tb[TCA_U32_SEL]) {
100 u->cu_selector = nla_get_data(tb[TCA_U32_SEL]);
103 u->cu_mask |= U32_ATTR_SELECTOR;
106 if (tb[TCA_U32_HASH]) {
107 u->cu_hash = nla_get_u32(tb[TCA_U32_HASH]);
108 u->cu_mask |= U32_ATTR_HASH;
111 if (tb[TCA_U32_CLASSID]) {
112 u->cu_classid = nla_get_u32(tb[TCA_U32_CLASSID]);
113 u->cu_mask |= U32_ATTR_CLASSID;
116 if (tb[TCA_U32_LINK]) {
117 u->cu_link = nla_get_u32(tb[TCA_U32_LINK]);
118 u->cu_mask |= U32_ATTR_LINK;
121 if (tb[TCA_U32_ACT]) {
122 u->cu_act = nla_get_data(tb[TCA_U32_ACT]);
125 u->cu_mask |= U32_ATTR_ACTION;
128 if (tb[TCA_U32_POLICE]) {
129 u->cu_police = nla_get_data(tb[TCA_U32_POLICE]);
132 u->cu_mask |= U32_ATTR_POLICE;
135 if (tb[TCA_U32_PCNT]) {
136 struct tc_u32_sel *sel;
139 if (!tb[TCA_U32_SEL]) {
140 err = nl_error(EINVAL, "Missing TCA_U32_SEL required "
145 sel = u->cu_selector->d_data;
146 pcnt_size = sizeof(struct tc_u32_pcnt) +
147 (sel->nkeys * sizeof(uint64_t));
148 if (nla_len(tb[TCA_U32_PCNT]) < pcnt_size) {
149 err = nl_error(EINVAL, "Invalid size for TCA_U32_PCNT");
153 u->cu_pcnt = nla_get_data(tb[TCA_U32_PCNT]);
156 u->cu_mask |= U32_ATTR_PCNT;
159 if (tb[TCA_U32_INDEV]) {
160 nla_strlcpy(u->cu_indev, tb[TCA_U32_INDEV], IFNAMSIZ);
161 u->cu_mask |= U32_ATTR_INDEV;
167 err = nl_errno(ENOMEM);
172 static void u32_free_data(struct rtnl_cls *cls)
174 struct rtnl_u32 *u = u32_cls(cls);
179 nl_data_free(u->cu_selector);
180 nl_data_free(u->cu_act);
181 nl_data_free(u->cu_police);
182 nl_data_free(u->cu_pcnt);
184 free(cls->c_subdata);
187 static int u32_dump_brief(struct rtnl_cls *cls, struct nl_dump_params *p,
190 struct rtnl_u32 *u = u32_cls(cls);
196 if (u->cu_mask & U32_ATTR_DIVISOR)
197 dp_dump(p, " divisor %u", u->cu_divisor);
198 else if (u->cu_mask & U32_ATTR_CLASSID)
199 dp_dump(p, " target %s",
200 rtnl_tc_handle2str(u->cu_classid, buf, sizeof(buf)));
206 static int print_selector(struct nl_dump_params *p, struct tc_u32_sel *sel,
207 struct rtnl_cls *cls, struct rtnl_u32 *u, int line)
210 struct tc_u32_key *key;
212 if (sel->hmask || sel->hoff) {
213 /* I guess this will never be used since the kernel only
214 * exports the selector if no divisor is set but hash offset
215 * and hash mask make only sense in hash filters with divisor
217 dp_dump(p, " hash at %u & 0x%x", sel->hoff, sel->hmask);
220 if (sel->flags & (TC_U32_OFFSET | TC_U32_VAROFFSET)) {
221 dp_dump(p, " offset at %u", sel->off);
223 if (sel->flags & TC_U32_VAROFFSET)
224 dp_dump(p, " variable (at %u & 0x%x) >> %u",
225 sel->offoff, ntohs(sel->offmask), sel->offshift);
229 int flags = sel->flags;
232 #define PRINT_FLAG(f) if (flags & TC_U32_##f) { \
233 flags &= ~TC_U32_##f; dp_dump(p, #f "%s", flags ? "," : ""); }
235 PRINT_FLAG(TERMINAL);
237 PRINT_FLAG(VAROFFSET);
245 for (i = 0; i < sel->nkeys; i++) {
246 key = (struct tc_u32_key *) ((char *) sel + sizeof(*sel));
249 dp_dump_line(p, line++, " match key at %s%u ",
250 key->offmask ? "nexthdr+" : "", key->off);
253 dp_dump(p, "[0x%u] ", key->offmask);
255 dp_dump(p, "& 0x%08x == 0x%08x", ntohl(key->mask), ntohl(key->val));
257 if (p->dp_type == NL_DUMP_STATS &&
258 (u->cu_mask & U32_ATTR_PCNT)) {
259 struct tc_u32_pcnt *pcnt = u->cu_pcnt->d_data;
260 dp_dump(p, " successful %" PRIu64, pcnt->kcnts[i]);
268 static int u32_dump_full(struct rtnl_cls *cls, struct nl_dump_params *p,
271 struct rtnl_u32 *u = u32_cls(cls);
272 struct tc_u32_sel *s;
277 if (!(u->cu_mask & U32_ATTR_SELECTOR)) {
278 dp_dump(p, "no-selector\n");
282 s = u->cu_selector->d_data;
284 dp_dump(p, "nkeys %u ", s->nkeys);
286 if (u->cu_mask & U32_ATTR_HASH)
287 dp_dump(p, "ht key 0x%x hash 0x%u",
288 TC_U32_USERHTID(u->cu_hash), TC_U32_HASH(u->cu_hash));
290 if (u->cu_mask & U32_ATTR_LINK)
291 dp_dump(p, "link %u ", u->cu_link);
293 if (u->cu_mask & U32_ATTR_INDEV)
294 dp_dump(p, "indev %s ", u->cu_indev);
296 line = print_selector(p, s, cls, u, line);
303 #define U32_ATTR_ACTION 0x040
304 #define U32_ATTR_POLICE 0x080
307 struct nl_data police;
311 static int u32_dump_stats(struct rtnl_cls *cls, struct nl_dump_params *p,
314 struct rtnl_u32 *u = u32_cls(cls);
319 if (u->cu_mask & U32_ATTR_PCNT) {
320 struct tc_u32_pcnt *pc = u->cu_pcnt->d_data;
322 dp_dump_line(p, line++, "%s successful hits\n");
323 dp_dump_line(p, line++, "%s %8llu %8llu\n",
331 static struct nl_msg *u32_get_opts(struct rtnl_cls *cls)
340 msg = nlmsg_build_no_hdr();
344 if (u->cu_mask & U32_ATTR_DIVISOR)
345 nla_put_u32(msg, TCA_U32_DIVISOR, u->cu_divisor);
347 if (u->cu_mask & U32_ATTR_HASH)
348 nla_put_u32(msg, TCA_U32_HASH, u->cu_hash);
350 if (u->cu_mask & U32_ATTR_CLASSID)
351 nla_put_u32(msg, TCA_U32_CLASSID, u->cu_classid);
353 if (u->cu_mask & U32_ATTR_LINK)
354 nla_put_u32(msg, TCA_U32_LINK, u->cu_link);
356 if (u->cu_mask & U32_ATTR_SELECTOR)
357 nla_put_data(msg, TCA_U32_SEL, u->cu_selector);
359 if (u->cu_mask & U32_ATTR_ACTION)
360 nla_put_data(msg, TCA_U32_ACT, u->cu_act);
362 if (u->cu_mask & U32_ATTR_POLICE)
363 nla_put_data(msg, TCA_U32_POLICE, u->cu_police);
365 if (u->cu_mask & U32_ATTR_INDEV)
366 nla_put_string(msg, TCA_U32_INDEV, u->cu_indev);
372 * @name Attribute Modifications
376 void rtnl_u32_set_handle(struct rtnl_cls *cls, int htid, int hash,
379 uint32_t handle = (htid << 20) | (hash << 12) | nodeid;
381 tca_set_handle((struct rtnl_tca *) cls, handle );
384 int rtnl_u32_set_classid(struct rtnl_cls *cls, uint32_t classid)
390 return nl_errno(ENOMEM);
392 u->cu_classid = classid;
393 u->cu_mask |= U32_ATTR_CLASSID;
401 * @name Selector Modifications
405 int rtnl_u32_set_flags(struct rtnl_cls *cls, int flags)
407 struct tc_u32_sel *sel;
412 return nl_errno(ENOMEM);
414 sel = u32_selector_alloc(u);
416 return nl_errno(ENOMEM);
419 u->cu_mask |= U32_ATTR_SELECTOR;
425 * Append new 32-bit key to the selector
427 * @arg cls classifier to be modifier
428 * @arg val value to be matched (network byte-order)
429 * @arg mask mask to be applied before matching (network byte-order)
430 * @arg off offset, in bytes, to start matching
431 * @arg offmask offset mask
433 * General selectors define the pattern, mask and offset the pattern will be
434 * matched to the packet contents. Using the general selectors you can match
435 * virtually any single bit in the IP (or upper layer) header.
438 int rtnl_u32_add_key(struct rtnl_cls *cls, uint32_t val, uint32_t mask,
439 int off, int offmask)
441 struct tc_u32_sel *sel;
447 return nl_errno(ENOMEM);
449 sel = u32_selector_alloc(u);
451 return nl_errno(ENOMEM);
453 err = nl_data_append(u->cu_selector, NULL, sizeof(struct tc_u32_key));
457 /* the selector might have been moved by realloc */
458 sel = u32_selector(u);
460 sel->keys[sel->nkeys].mask = mask;
461 sel->keys[sel->nkeys].val = val & mask;
462 sel->keys[sel->nkeys].off = off;
463 sel->keys[sel->nkeys].offmask = offmask;
465 u->cu_mask |= U32_ATTR_SELECTOR;
470 int rtnl_u32_add_key_uint8(struct rtnl_cls *cls, uint8_t val, uint8_t mask,
471 int off, int offmask)
473 int shift = 24 - 8 * (off & 3);
475 return rtnl_u32_add_key(cls, htonl((uint32_t)val << shift),
476 htonl((uint32_t)mask << shift),
481 * Append new selector key to match a 16-bit number
483 * @arg cls classifier to be modified
484 * @arg val value to be matched (host byte-order)
485 * @arg mask mask to be applied before matching (host byte-order)
486 * @arg off offset, in bytes, to start matching
487 * @arg offmask offset mask
489 int rtnl_u32_add_key_uint16(struct rtnl_cls *cls, uint16_t val, uint16_t mask,
490 int off, int offmask)
492 int shift = ((off & 3) == 0 ? 16 : 0);
494 return nl_error(EINVAL, "Invalid offset alignment");
496 return rtnl_u32_add_key(cls, htonl((uint32_t)val << shift),
497 htonl((uint32_t)mask << shift),
502 * Append new selector key to match a 32-bit number
504 * @arg cls classifier to be modified
505 * @arg val value to be matched (host byte-order)
506 * @arg mask mask to be applied before matching (host byte-order)
507 * @arg off offset, in bytes, to start matching
508 * @arg offmask offset mask
510 int rtnl_u32_add_key_uint32(struct rtnl_cls *cls, uint32_t val, uint32_t mask,
511 int off, int offmask)
513 return rtnl_u32_add_key(cls, htonl(val), htonl(mask),
517 int rtnl_u32_add_key_in_addr(struct rtnl_cls *cls, struct in_addr *addr,
518 uint8_t bitmask, int off, int offmask)
520 uint32_t mask = 0xFFFFFFFF << (32 - bitmask);
521 return rtnl_u32_add_key(cls, addr->s_addr, htonl(mask), off, offmask);
524 int rtnl_u32_add_key_in6_addr(struct rtnl_cls *cls, struct in6_addr *addr,
525 uint8_t bitmask, int off, int offmask)
529 for (i = 1; i <= 4; i++) {
530 if (32 * i - bitmask <= 0)
531 return rtnl_u32_add_key(cls, addr->s6_addr32[i-1],
532 0xFFFFFFFF, off, offmask );
533 else if (32 * i - bitmask < 32) {
534 uint32_t mask = 0xFFFFFFFF << (32 * i - bitmask);
535 return rtnl_u32_add_key(cls, addr->s6_addr32[i-1],
536 htonl(mask), off, offmask );
538 /* otherwise, if (32*i - bitmask >= 32) no key is generated */
546 static struct rtnl_cls_ops u32_ops = {
548 .co_msg_parser = u32_msg_parser,
549 .co_free_data = u32_free_data,
550 .co_get_opts = u32_get_opts,
551 .co_dump[NL_DUMP_BRIEF] = u32_dump_brief,
552 .co_dump[NL_DUMP_FULL] = u32_dump_full,
553 .co_dump[NL_DUMP_STATS] = u32_dump_stats,
556 static void __init u32_init(void)
558 rtnl_cls_register(&u32_ops);
561 static void __exit u32_exit(void)
563 rtnl_cls_unregister(&u32_ops);