2 * net/sched/em_meta.c Metadata ematch
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version
7 * 2 of the License, or (at your option) any later version.
9 * Authors: Thomas Graf <tgraf@suug.ch>
11 * ==========================================================================
13 * The metadata ematch compares two meta objects where each object
14 * represents either a meta value stored in the kernel or a static
15 * value provided by userspace. The objects are not provided by
16 * userspace itself but rather a definition providing the information
17 * to build them. Every object is of a certain type which must be
18 * equal to the object it is being compared to.
20 * The definition of a objects conists of the type (meta type), a
21 * identifier (meta id) and additional type specific information.
22 * The meta id is either TCF_META_TYPE_VALUE for values provided by
23 * userspace or a index to the meta operations table consisting of
24 * function pointers to type specific meta data collectors returning
25 * the value of the requested meta value.
28 * +-----------+ +-----------+
29 * | type: INT | | type: INT |
30 * def | id: DEV | | id: VALUE |
31 * | data: | | data: 3 |
32 * +-----------+ +-----------+
34 * ---> meta_ops[INT][DEV](...) |
38 * +-----------+ +-----------+
39 * | type: INT | | type: INT |
40 * obj | id: DEV | | id: VALUE |
41 * | data: 2 |<--data got filled out | data: 3 |
42 * +-----------+ +-----------+
44 * --------------> 2 equals 3 <--------------
46 * This is a simplified schema, the complexity varies depending
47 * on the meta type. Obviously, the length of the data must also
48 * be provided for non-numeric types.
50 * Additionaly, type dependant modifiers such as shift operators
51 * or mask may be applied to extend the functionaliy. As of now,
52 * the variable length type supports shifting the byte string to
53 * the right, eating up any number of octets and thus supporting
54 * wildcard interface name comparisons such as "ppp%" matching
57 * NOTE: Certain meta values depend on other subsystems and are
58 * only available if that subsytem is enabled in the kernel.
61 #include <linux/module.h>
62 #include <linux/types.h>
63 #include <linux/kernel.h>
64 #include <linux/sched.h>
65 #include <linux/string.h>
66 #include <linux/skbuff.h>
67 #include <linux/random.h>
68 #include <linux/tc_ematch/tc_em_meta.h>
70 #include <net/route.h>
71 #include <net/pkt_cls.h>
82 struct tcf_meta_val hdr;
89 struct meta_value lvalue;
90 struct meta_value rvalue;
93 static inline int meta_id(struct meta_value *v)
95 return TCF_META_ID(v->hdr.kind);
98 static inline int meta_type(struct meta_value *v)
100 return TCF_META_TYPE(v->hdr.kind);
103 #define META_COLLECTOR(FUNC) static void meta_##FUNC(struct sk_buff *skb, \
104 struct tcf_pkt_info *info, struct meta_value *v, \
105 struct meta_obj *dst, int *err)
107 /**************************************************************************
108 * System status & misc
109 **************************************************************************/
111 META_COLLECTOR(int_random)
113 get_random_bytes(&dst->value, sizeof(dst->value));
116 static inline unsigned long fixed_loadavg(int load)
118 int rnd_load = load + (FIXED_1/200);
119 int rnd_frac = ((rnd_load & (FIXED_1-1)) * 100) >> FSHIFT;
121 return ((rnd_load >> FSHIFT) * 100) + rnd_frac;
124 META_COLLECTOR(int_loadavg_0)
126 dst->value = fixed_loadavg(avenrun[0]);
129 META_COLLECTOR(int_loadavg_1)
131 dst->value = fixed_loadavg(avenrun[1]);
134 META_COLLECTOR(int_loadavg_2)
136 dst->value = fixed_loadavg(avenrun[2]);
139 /**************************************************************************
140 * Device names & indices
141 **************************************************************************/
143 static inline int int_dev(struct net_device *dev, struct meta_obj *dst)
145 if (unlikely(dev == NULL))
148 dst->value = dev->ifindex;
152 static inline int var_dev(struct net_device *dev, struct meta_obj *dst)
154 if (unlikely(dev == NULL))
157 dst->value = (unsigned long) dev->name;
158 dst->len = strlen(dev->name);
162 META_COLLECTOR(int_dev)
164 *err = int_dev(skb->dev, dst);
167 META_COLLECTOR(var_dev)
169 *err = var_dev(skb->dev, dst);
172 /**************************************************************************
174 **************************************************************************/
176 META_COLLECTOR(int_priority)
178 dst->value = skb->priority;
181 META_COLLECTOR(int_protocol)
183 /* Let userspace take care of the byte ordering */
184 dst->value = skb->protocol;
187 META_COLLECTOR(int_pkttype)
189 dst->value = skb->pkt_type;
192 META_COLLECTOR(int_pktlen)
194 dst->value = skb->len;
197 META_COLLECTOR(int_datalen)
199 dst->value = skb->data_len;
202 META_COLLECTOR(int_maclen)
204 dst->value = skb->mac_len;
207 /**************************************************************************
209 **************************************************************************/
211 META_COLLECTOR(int_nfmark)
213 #ifdef CONFIG_NETFILTER
214 dst->value = skb->nfmark;
220 /**************************************************************************
222 **************************************************************************/
224 META_COLLECTOR(int_tcindex)
226 dst->value = skb->tc_index;
229 /**************************************************************************
231 **************************************************************************/
233 META_COLLECTOR(int_rtclassid)
235 if (unlikely(skb->dst == NULL))
238 #ifdef CONFIG_NET_CLS_ROUTE
239 dst->value = skb->dst->tclassid;
245 META_COLLECTOR(int_rtiif)
247 if (unlikely(skb->dst == NULL))
250 dst->value = ((struct rtable*) skb->dst)->fl.iif;
253 /**************************************************************************
255 **************************************************************************/
257 #define SKIP_NONLOCAL(skb) \
258 if (unlikely(skb->sk == NULL)) { \
263 META_COLLECTOR(int_sk_family)
266 dst->value = skb->sk->sk_family;
269 META_COLLECTOR(int_sk_state)
272 dst->value = skb->sk->sk_state;
275 META_COLLECTOR(int_sk_reuse)
278 dst->value = skb->sk->sk_reuse;
281 META_COLLECTOR(int_sk_bound_if)
284 /* No error if bound_dev_if is 0, legal userspace check */
285 dst->value = skb->sk->sk_bound_dev_if;
288 META_COLLECTOR(var_sk_bound_if)
292 if (skb->sk->sk_bound_dev_if == 0) {
293 dst->value = (unsigned long) "any";
296 struct net_device *dev;
298 dev = dev_get_by_index(skb->sk->sk_bound_dev_if);
299 *err = var_dev(dev, dst);
305 META_COLLECTOR(int_sk_refcnt)
308 dst->value = atomic_read(&skb->sk->sk_refcnt);
311 META_COLLECTOR(int_sk_rcvbuf)
314 dst->value = skb->sk->sk_rcvbuf;
317 META_COLLECTOR(int_sk_shutdown)
320 dst->value = skb->sk->sk_shutdown;
323 META_COLLECTOR(int_sk_proto)
326 dst->value = skb->sk->sk_protocol;
329 META_COLLECTOR(int_sk_type)
332 dst->value = skb->sk->sk_type;
335 META_COLLECTOR(int_sk_rmem_alloc)
338 dst->value = atomic_read(&skb->sk->sk_rmem_alloc);
341 META_COLLECTOR(int_sk_wmem_alloc)
344 dst->value = atomic_read(&skb->sk->sk_wmem_alloc);
347 META_COLLECTOR(int_sk_omem_alloc)
350 dst->value = atomic_read(&skb->sk->sk_omem_alloc);
353 META_COLLECTOR(int_sk_rcv_qlen)
356 dst->value = skb->sk->sk_receive_queue.qlen;
359 META_COLLECTOR(int_sk_snd_qlen)
362 dst->value = skb->sk->sk_write_queue.qlen;
365 META_COLLECTOR(int_sk_wmem_queued)
368 dst->value = skb->sk->sk_wmem_queued;
371 META_COLLECTOR(int_sk_fwd_alloc)
374 dst->value = skb->sk->sk_forward_alloc;
377 META_COLLECTOR(int_sk_sndbuf)
380 dst->value = skb->sk->sk_sndbuf;
383 META_COLLECTOR(int_sk_alloc)
386 dst->value = skb->sk->sk_allocation;
389 META_COLLECTOR(int_sk_route_caps)
392 dst->value = skb->sk->sk_route_caps;
395 META_COLLECTOR(int_sk_hash)
398 dst->value = skb->sk->sk_hash;
401 META_COLLECTOR(int_sk_lingertime)
404 dst->value = skb->sk->sk_lingertime / HZ;
407 META_COLLECTOR(int_sk_err_qlen)
410 dst->value = skb->sk->sk_error_queue.qlen;
413 META_COLLECTOR(int_sk_ack_bl)
416 dst->value = skb->sk->sk_ack_backlog;
419 META_COLLECTOR(int_sk_max_ack_bl)
422 dst->value = skb->sk->sk_max_ack_backlog;
425 META_COLLECTOR(int_sk_prio)
428 dst->value = skb->sk->sk_priority;
431 META_COLLECTOR(int_sk_rcvlowat)
434 dst->value = skb->sk->sk_rcvlowat;
437 META_COLLECTOR(int_sk_rcvtimeo)
440 dst->value = skb->sk->sk_rcvtimeo / HZ;
443 META_COLLECTOR(int_sk_sndtimeo)
446 dst->value = skb->sk->sk_sndtimeo / HZ;
449 META_COLLECTOR(int_sk_sendmsg_off)
452 dst->value = skb->sk->sk_sndmsg_off;
455 META_COLLECTOR(int_sk_write_pend)
458 dst->value = skb->sk->sk_write_pending;
461 /**************************************************************************
462 * Meta value collectors assignment table
463 **************************************************************************/
467 void (*get)(struct sk_buff *, struct tcf_pkt_info *,
468 struct meta_value *, struct meta_obj *, int *);
471 #define META_ID(name) TCF_META_ID_##name
472 #define META_FUNC(name) { .get = meta_##name }
474 /* Meta value operations table listing all meta value collectors and
475 * assigns them to a type and meta id. */
476 static struct meta_ops __meta_ops[TCF_META_TYPE_MAX+1][TCF_META_ID_MAX+1] = {
477 [TCF_META_TYPE_VAR] = {
478 [META_ID(DEV)] = META_FUNC(var_dev),
479 [META_ID(SK_BOUND_IF)] = META_FUNC(var_sk_bound_if),
481 [TCF_META_TYPE_INT] = {
482 [META_ID(RANDOM)] = META_FUNC(int_random),
483 [META_ID(LOADAVG_0)] = META_FUNC(int_loadavg_0),
484 [META_ID(LOADAVG_1)] = META_FUNC(int_loadavg_1),
485 [META_ID(LOADAVG_2)] = META_FUNC(int_loadavg_2),
486 [META_ID(DEV)] = META_FUNC(int_dev),
487 [META_ID(PRIORITY)] = META_FUNC(int_priority),
488 [META_ID(PROTOCOL)] = META_FUNC(int_protocol),
489 [META_ID(PKTTYPE)] = META_FUNC(int_pkttype),
490 [META_ID(PKTLEN)] = META_FUNC(int_pktlen),
491 [META_ID(DATALEN)] = META_FUNC(int_datalen),
492 [META_ID(MACLEN)] = META_FUNC(int_maclen),
493 [META_ID(NFMARK)] = META_FUNC(int_nfmark),
494 [META_ID(TCINDEX)] = META_FUNC(int_tcindex),
495 [META_ID(RTCLASSID)] = META_FUNC(int_rtclassid),
496 [META_ID(RTIIF)] = META_FUNC(int_rtiif),
497 [META_ID(SK_FAMILY)] = META_FUNC(int_sk_family),
498 [META_ID(SK_STATE)] = META_FUNC(int_sk_state),
499 [META_ID(SK_REUSE)] = META_FUNC(int_sk_reuse),
500 [META_ID(SK_BOUND_IF)] = META_FUNC(int_sk_bound_if),
501 [META_ID(SK_REFCNT)] = META_FUNC(int_sk_refcnt),
502 [META_ID(SK_RCVBUF)] = META_FUNC(int_sk_rcvbuf),
503 [META_ID(SK_SNDBUF)] = META_FUNC(int_sk_sndbuf),
504 [META_ID(SK_SHUTDOWN)] = META_FUNC(int_sk_shutdown),
505 [META_ID(SK_PROTO)] = META_FUNC(int_sk_proto),
506 [META_ID(SK_TYPE)] = META_FUNC(int_sk_type),
507 [META_ID(SK_RMEM_ALLOC)] = META_FUNC(int_sk_rmem_alloc),
508 [META_ID(SK_WMEM_ALLOC)] = META_FUNC(int_sk_wmem_alloc),
509 [META_ID(SK_OMEM_ALLOC)] = META_FUNC(int_sk_omem_alloc),
510 [META_ID(SK_WMEM_QUEUED)] = META_FUNC(int_sk_wmem_queued),
511 [META_ID(SK_RCV_QLEN)] = META_FUNC(int_sk_rcv_qlen),
512 [META_ID(SK_SND_QLEN)] = META_FUNC(int_sk_snd_qlen),
513 [META_ID(SK_ERR_QLEN)] = META_FUNC(int_sk_err_qlen),
514 [META_ID(SK_FORWARD_ALLOCS)] = META_FUNC(int_sk_fwd_alloc),
515 [META_ID(SK_ALLOCS)] = META_FUNC(int_sk_alloc),
516 [META_ID(SK_ROUTE_CAPS)] = META_FUNC(int_sk_route_caps),
517 [META_ID(SK_HASH)] = META_FUNC(int_sk_hash),
518 [META_ID(SK_LINGERTIME)] = META_FUNC(int_sk_lingertime),
519 [META_ID(SK_ACK_BACKLOG)] = META_FUNC(int_sk_ack_bl),
520 [META_ID(SK_MAX_ACK_BACKLOG)] = META_FUNC(int_sk_max_ack_bl),
521 [META_ID(SK_PRIO)] = META_FUNC(int_sk_prio),
522 [META_ID(SK_RCVLOWAT)] = META_FUNC(int_sk_rcvlowat),
523 [META_ID(SK_RCVTIMEO)] = META_FUNC(int_sk_rcvtimeo),
524 [META_ID(SK_SNDTIMEO)] = META_FUNC(int_sk_sndtimeo),
525 [META_ID(SK_SENDMSG_OFF)] = META_FUNC(int_sk_sendmsg_off),
526 [META_ID(SK_WRITE_PENDING)] = META_FUNC(int_sk_write_pend),
530 static inline struct meta_ops * meta_ops(struct meta_value *val)
532 return &__meta_ops[meta_type(val)][meta_id(val)];
535 /**************************************************************************
536 * Type specific operations for TCF_META_TYPE_VAR
537 **************************************************************************/
539 static int meta_var_compare(struct meta_obj *a, struct meta_obj *b)
541 int r = a->len - b->len;
544 r = memcmp((void *) a->value, (void *) b->value, a->len);
549 static int meta_var_change(struct meta_value *dst, struct rtattr *rta)
551 int len = RTA_PAYLOAD(rta);
553 dst->val = (unsigned long) kmalloc(len, GFP_KERNEL);
556 memcpy((void *) dst->val, RTA_DATA(rta), len);
561 static void meta_var_destroy(struct meta_value *v)
563 kfree((void *) v->val);
566 static void meta_var_apply_extras(struct meta_value *v,
567 struct meta_obj *dst)
569 int shift = v->hdr.shift;
571 if (shift && shift < dst->len)
575 static int meta_var_dump(struct sk_buff *skb, struct meta_value *v, int tlv)
577 if (v->val && v->len)
578 RTA_PUT(skb, tlv, v->len, (void *) v->val);
585 /**************************************************************************
586 * Type specific operations for TCF_META_TYPE_INT
587 **************************************************************************/
589 static int meta_int_compare(struct meta_obj *a, struct meta_obj *b)
591 /* Let gcc optimize it, the unlikely is not really based on
592 * some numbers but jump free code for mismatches seems
594 if (unlikely(a->value == b->value))
596 else if (a->value < b->value)
602 static int meta_int_change(struct meta_value *dst, struct rtattr *rta)
604 if (RTA_PAYLOAD(rta) >= sizeof(unsigned long)) {
605 dst->val = *(unsigned long *) RTA_DATA(rta);
606 dst->len = sizeof(unsigned long);
607 } else if (RTA_PAYLOAD(rta) == sizeof(u32)) {
608 dst->val = *(u32 *) RTA_DATA(rta);
609 dst->len = sizeof(u32);
616 static void meta_int_apply_extras(struct meta_value *v,
617 struct meta_obj *dst)
620 dst->value >>= v->hdr.shift;
623 dst->value &= v->val;
626 static int meta_int_dump(struct sk_buff *skb, struct meta_value *v, int tlv)
628 if (v->len == sizeof(unsigned long))
629 RTA_PUT(skb, tlv, sizeof(unsigned long), &v->val);
630 else if (v->len == sizeof(u32)) {
632 RTA_PUT(skb, tlv, sizeof(d), &d);
641 /**************************************************************************
642 * Type specific operations table
643 **************************************************************************/
647 void (*destroy)(struct meta_value *);
648 int (*compare)(struct meta_obj *, struct meta_obj *);
649 int (*change)(struct meta_value *, struct rtattr *);
650 void (*apply_extras)(struct meta_value *, struct meta_obj *);
651 int (*dump)(struct sk_buff *, struct meta_value *, int);
654 static struct meta_type_ops __meta_type_ops[TCF_META_TYPE_MAX+1] = {
655 [TCF_META_TYPE_VAR] = {
656 .destroy = meta_var_destroy,
657 .compare = meta_var_compare,
658 .change = meta_var_change,
659 .apply_extras = meta_var_apply_extras,
660 .dump = meta_var_dump
662 [TCF_META_TYPE_INT] = {
663 .compare = meta_int_compare,
664 .change = meta_int_change,
665 .apply_extras = meta_int_apply_extras,
666 .dump = meta_int_dump
670 static inline struct meta_type_ops * meta_type_ops(struct meta_value *v)
672 return &__meta_type_ops[meta_type(v)];
675 /**************************************************************************
677 **************************************************************************/
679 static inline int meta_get(struct sk_buff *skb, struct tcf_pkt_info *info,
680 struct meta_value *v, struct meta_obj *dst)
684 if (meta_id(v) == TCF_META_ID_VALUE) {
690 meta_ops(v)->get(skb, info, v, dst, &err);
694 if (meta_type_ops(v)->apply_extras)
695 meta_type_ops(v)->apply_extras(v, dst);
700 static int em_meta_match(struct sk_buff *skb, struct tcf_ematch *m,
701 struct tcf_pkt_info *info)
704 struct meta_match *meta = (struct meta_match *) m->data;
705 struct meta_obj l_value, r_value;
707 if (meta_get(skb, info, &meta->lvalue, &l_value) < 0 ||
708 meta_get(skb, info, &meta->rvalue, &r_value) < 0)
711 r = meta_type_ops(&meta->lvalue)->compare(&l_value, &r_value);
713 switch (meta->lvalue.hdr.op) {
725 static inline void meta_delete(struct meta_match *meta)
727 struct meta_type_ops *ops = meta_type_ops(&meta->lvalue);
729 if (ops && ops->destroy) {
730 ops->destroy(&meta->lvalue);
731 ops->destroy(&meta->rvalue);
737 static inline int meta_change_data(struct meta_value *dst, struct rtattr *rta)
740 if (RTA_PAYLOAD(rta) == 0)
743 return meta_type_ops(dst)->change(dst, rta);
749 static inline int meta_is_supported(struct meta_value *val)
751 return (!meta_id(val) || meta_ops(val)->get);
754 static int em_meta_change(struct tcf_proto *tp, void *data, int len,
755 struct tcf_ematch *m)
758 struct rtattr *tb[TCA_EM_META_MAX];
759 struct tcf_meta_hdr *hdr;
760 struct meta_match *meta = NULL;
762 if (rtattr_parse(tb, TCA_EM_META_MAX, data, len) < 0)
765 if (tb[TCA_EM_META_HDR-1] == NULL ||
766 RTA_PAYLOAD(tb[TCA_EM_META_HDR-1]) < sizeof(*hdr))
768 hdr = RTA_DATA(tb[TCA_EM_META_HDR-1]);
770 if (TCF_META_TYPE(hdr->left.kind) != TCF_META_TYPE(hdr->right.kind) ||
771 TCF_META_TYPE(hdr->left.kind) > TCF_META_TYPE_MAX ||
772 TCF_META_ID(hdr->left.kind) > TCF_META_ID_MAX ||
773 TCF_META_ID(hdr->right.kind) > TCF_META_ID_MAX)
776 meta = kzalloc(sizeof(*meta), GFP_KERNEL);
780 memcpy(&meta->lvalue.hdr, &hdr->left, sizeof(hdr->left));
781 memcpy(&meta->rvalue.hdr, &hdr->right, sizeof(hdr->right));
783 if (!meta_is_supported(&meta->lvalue) ||
784 !meta_is_supported(&meta->rvalue)) {
789 if (meta_change_data(&meta->lvalue, tb[TCA_EM_META_LVALUE-1]) < 0 ||
790 meta_change_data(&meta->rvalue, tb[TCA_EM_META_RVALUE-1]) < 0)
793 m->datalen = sizeof(*meta);
794 m->data = (unsigned long) meta;
803 static void em_meta_destroy(struct tcf_proto *tp, struct tcf_ematch *m)
806 meta_delete((struct meta_match *) m->data);
809 static int em_meta_dump(struct sk_buff *skb, struct tcf_ematch *em)
811 struct meta_match *meta = (struct meta_match *) em->data;
812 struct tcf_meta_hdr hdr;
813 struct meta_type_ops *ops;
815 memset(&hdr, 0, sizeof(hdr));
816 memcpy(&hdr.left, &meta->lvalue.hdr, sizeof(hdr.left));
817 memcpy(&hdr.right, &meta->rvalue.hdr, sizeof(hdr.right));
819 RTA_PUT(skb, TCA_EM_META_HDR, sizeof(hdr), &hdr);
821 ops = meta_type_ops(&meta->lvalue);
822 if (ops->dump(skb, &meta->lvalue, TCA_EM_META_LVALUE) < 0 ||
823 ops->dump(skb, &meta->rvalue, TCA_EM_META_RVALUE) < 0)
832 static struct tcf_ematch_ops em_meta_ops = {
834 .change = em_meta_change,
835 .match = em_meta_match,
836 .destroy = em_meta_destroy,
837 .dump = em_meta_dump,
838 .owner = THIS_MODULE,
839 .link = LIST_HEAD_INIT(em_meta_ops.link)
842 static int __init init_em_meta(void)
844 return tcf_em_register(&em_meta_ops);
847 static void __exit exit_em_meta(void)
849 tcf_em_unregister(&em_meta_ops);
852 MODULE_LICENSE("GPL");
854 module_init(init_em_meta);
855 module_exit(exit_em_meta);