net/sched/ematch.c

   1 /*
   2  * net/sched/ematch.c           Extended Match API
   3  *
   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.
   8  *
   9  * Authors:     Thomas Graf <tgraf@suug.ch>
  10  *
  11  * ==========================================================================
  12  *
  13  * An extended match (ematch) is a small classification tool not worth
  14  * writing a full classifier for. Ematches can be interconnected to form
  15  * a logic expression and get attached to classifiers to extend their
  16  * functionatlity.
  17  *
  18  * The userspace part transforms the logic expressions into an array
  19  * consisting of multiple sequences of interconnected ematches separated
  20  * by markers. Precedence is implemented by a special ematch kind
  21  * referencing a sequence beyond the marker of the current sequence
  22  * causing the current position in the sequence to be pushed onto a stack
  23  * to allow the current position to be overwritten by the position referenced
  24  * in the special ematch. Matching continues in the new sequence until a
  25  * marker is reached causing the position to be restored from the stack.
  26  *
  27  * Example:
  28  *          A AND (B1 OR B2) AND C AND D
  29  *
  30  *              ------->-PUSH-------
  31  *    -->--    /         -->--      \   -->--
  32  *   /     \  /         /     \      \ /     \
  33  * +-------+-------+-------+-------+-------+--------+
  34  * | A AND | B AND | C AND | D END | B1 OR | B2 END |
  35  * +-------+-------+-------+-------+-------+--------+
  36  *                    \                      /
  37  *                     --------<-POP---------
  38  *
  39  * where B is a virtual ematch referencing to sequence starting with B1.
  40  *
  41  * ==========================================================================
  42  *
  43  * How to write an ematch in 60 seconds
  44  * ------------------------------------
  45  *
  46  *   1) Provide a matcher function:
  47  *      static int my_match(struct sk_buff *skb, struct tcf_ematch *m,
  48  *                          struct tcf_pkt_info *info)
  49  *      {
  50  *              struct mydata *d = (struct mydata *) m->data;
  51  *
  52  *              if (...matching goes here...)
  53  *                      return 1;
  54  *              else
  55  *                      return 0;
  56  *      }
  57  *
  58  *   2) Fill out a struct tcf_ematch_ops:
  59  *      static struct tcf_ematch_ops my_ops = {
  60  *              .kind = unique id,
  61  *              .datalen = sizeof(struct mydata),
  62  *              .match = my_match,
  63  *              .owner = THIS_MODULE,
  64  *      };
  65  *
  66  *   3) Register/Unregister your ematch:
  67  *      static int __init init_my_ematch(void)
  68  *      {
  69  *              return tcf_em_register(&my_ops);
  70  *      }
  71  *
  72  *      static void __exit exit_my_ematch(void)
  73  *      {
  74  *              tcf_em_unregister(&my_ops);
  75  *      }
  76  *
  77  *      module_init(init_my_ematch);
  78  *      module_exit(exit_my_ematch);
  79  *
  80  *   4) By now you should have two more seconds left, barely enough to
  81  *      open up a beer to watch the compilation going.
  82  */
  83
  84 #include <linux/module.h>
  85 #include <linux/slab.h>
  86 #include <linux/types.h>
  87 #include <linux/kernel.h>
  88 #include <linux/errno.h>
  89 #include <linux/rtnetlink.h>
  90 #include <linux/skbuff.h>
  91 #include <net/pkt_cls.h>
  92
  93 static LIST_HEAD(ematch_ops);
  94 static DEFINE_RWLOCK(ematch_mod_lock);
  95
  96 static struct tcf_ematch_ops *tcf_em_lookup(u16 kind)
  97 {
  98         struct tcf_ematch_ops *e = NULL;
  99
 100         read_lock(&ematch_mod_lock);
 101         list_for_each_entry(e, &ematch_ops, link) {
 102                 if (kind == e->kind) {
 103                         if (!try_module_get(e->owner))
 104                                 e = NULL;
 105                         read_unlock(&ematch_mod_lock);
 106                         return e;
 107                 }
 108         }
 109         read_unlock(&ematch_mod_lock);
 110
 111         return NULL;
 112 }
 113
 114 /**
 115  * tcf_em_register - register an extended match
 116  *
 117  * @ops: ematch operations lookup table
 118  *
 119  * This function must be called by ematches to announce their presence.
 120  * The given @ops must have kind set to a unique identifier and the
 121  * callback match() must be implemented. All other callbacks are optional
 122  * and a fallback implementation is used instead.
 123  *
 124  * Returns -EEXISTS if an ematch of the same kind has already registered.
 125  */
 126 int tcf_em_register(struct tcf_ematch_ops *ops)
 127 {
 128         int err = -EEXIST;
 129         struct tcf_ematch_ops *e;
 130
 131         if (ops->match == NULL)
 132                 return -EINVAL;
 133
 134         write_lock(&ematch_mod_lock);
 135         list_for_each_entry(e, &ematch_ops, link)
 136                 if (ops->kind == e->kind)
 137                         goto errout;
 138
 139         list_add_tail(&ops->link, &ematch_ops);
 140         err = 0;
 141 errout:
 142         write_unlock(&ematch_mod_lock);
 143         return err;
 144 }
 145 EXPORT_SYMBOL(tcf_em_register);
 146
 147 /**
 148  * tcf_em_unregister - unregster and extended match
 149  *
 150  * @ops: ematch operations lookup table
 151  *
 152  * This function must be called by ematches to announce their disappearance
 153  * for examples when the module gets unloaded. The @ops parameter must be
 154  * the same as the one used for registration.
 155  *
 156  * Returns -ENOENT if no matching ematch was found.
 157  */
 158 void tcf_em_unregister(struct tcf_ematch_ops *ops)
 159 {
 160         write_lock(&ematch_mod_lock);
 161         list_del(&ops->link);
 162         write_unlock(&ematch_mod_lock);
 163 }
 164 EXPORT_SYMBOL(tcf_em_unregister);
 165
 166 static inline struct tcf_ematch *tcf_em_get_match(struct tcf_ematch_tree *tree,
 167                                                   int index)
 168 {
 169         return &tree->matches[index];
 170 }
 171
 172
 173 static int tcf_em_validate(struct tcf_proto *tp,
 174                            struct tcf_ematch_tree_hdr *tree_hdr,
 175                            struct tcf_ematch *em, struct nlattr *nla, int idx)
 176 {
 177         int err = -EINVAL;
 178         struct tcf_ematch_hdr *em_hdr = nla_data(nla);
 179         int data_len = nla_len(nla) - sizeof(*em_hdr);
 180         void *data = (void *) em_hdr + sizeof(*em_hdr);
 181         struct net *net = dev_net(qdisc_dev(tp->q));
 182
 183         if (!TCF_EM_REL_VALID(em_hdr->flags))
 184                 goto errout;
 185
 186         if (em_hdr->kind == TCF_EM_CONTAINER) {
 187                 /* Special ematch called "container", carries an index
 188                  * referencing an external ematch sequence.
 189                  */
 190                 u32 ref;
 191
 192                 if (data_len < sizeof(ref))
 193                         goto errout;
 194                 ref = *(u32 *) data;
 195
 196                 if (ref >= tree_hdr->nmatches)
 197                         goto errout;
 198
 199                 /* We do not allow backward jumps to avoid loops and jumps
 200                  * to our own position are of course illegal.
 201                  */
 202                 if (ref <= idx)
 203                         goto errout;
 204
 205
 206                 em->data = ref;
 207         } else {
 208                 /* Note: This lookup will increase the module refcnt
 209                  * of the ematch module referenced. In case of a failure,
 210                  * a destroy function is called by the underlying layer
 211                  * which automatically releases the reference again, therefore
 212                  * the module MUST not be given back under any circumstances
 213                  * here. Be aware, the destroy function assumes that the
 214                  * module is held if the ops field is non zero.
 215                  */
 216                 em->ops = tcf_em_lookup(em_hdr->kind);
 217
 218                 if (em->ops == NULL) {
 219                         err = -ENOENT;
 220 #ifdef CONFIG_MODULES
 221                         __rtnl_unlock();
 222                         request_module("ematch-kind-%u", em_hdr->kind);
 223                         rtnl_lock();
 224                         em->ops = tcf_em_lookup(em_hdr->kind);
 225                         if (em->ops) {
 226                                 /* We dropped the RTNL mutex in order to
 227                                  * perform the module load. Tell the caller
 228                                  * to replay the request.
 229                                  */
 230                                 module_put(em->ops->owner);
 231                                 em->ops = NULL;
 232                                 err = -EAGAIN;
 233                         }
 234 #endif
 235                         goto errout;
 236                 }
 237
 238                 /* ematch module provides expected length of data, so we
 239                  * can do a basic sanity check.
 240                  */
 241                 if (em->ops->datalen && data_len < em->ops->datalen)
 242                         goto errout;
 243
 244                 if (em->ops->change) {
 245                         err = -EINVAL;
 246                         if (em_hdr->flags & TCF_EM_SIMPLE)
 247                                 goto errout;
 248                         err = em->ops->change(net, data, data_len, em);
 249                         if (err < 0)
 250                                 goto errout;
 251                 } else if (data_len > 0) {
 252                         /* ematch module doesn't provide an own change
 253                          * procedure and expects us to allocate and copy
 254                          * the ematch data.
 255                          *
 256                          * TCF_EM_SIMPLE may be specified stating that the
 257                          * data only consists of a u32 integer and the module
 258                          * does not expected a memory reference but rather
 259                          * the value carried.
 260                          */
 261                         if (em_hdr->flags & TCF_EM_SIMPLE) {
 262                                 if (data_len < sizeof(u32))
 263                                         goto errout;
 264                                 em->data = *(u32 *) data;
 265                         } else {
 266                                 void *v = kmemdup(data, data_len, GFP_KERNEL);
 267                                 if (v == NULL) {
 268                                         err = -ENOBUFS;
 269                                         goto errout;
 270                                 }
 271                                 em->data = (unsigned long) v;
 272                         }
 273                         em->datalen = data_len;
 274                 }
 275         }
 276
 277         em->matchid = em_hdr->matchid;
 278         em->flags = em_hdr->flags;
 279         em->net = net;
 280
 281         err = 0;
 282 errout:
 283         return err;
 284 }
 285
 286 static const struct nla_policy em_policy[TCA_EMATCH_TREE_MAX + 1] = {
 287         [TCA_EMATCH_TREE_HDR]   = { .len = sizeof(struct tcf_ematch_tree_hdr) },
 288         [TCA_EMATCH_TREE_LIST]  = { .type = NLA_NESTED },
 289 };
 290
 291 /**
 292  * tcf_em_tree_validate - validate ematch config TLV and build ematch tree
 293  *
 294  * @tp: classifier kind handle
 295  * @nla: ematch tree configuration TLV
 296  * @tree: destination ematch tree variable to store the resulting
 297  *        ematch tree.
 298  *
 299  * This function validates the given configuration TLV @nla and builds an
 300  * ematch tree in @tree. The resulting tree must later be copied into
 301  * the private classifier data using tcf_em_tree_change(). You MUST NOT
 302  * provide the ematch tree variable of the private classifier data directly,
 303  * the changes would not be locked properly.
 304  *
 305  * Returns a negative error code if the configuration TLV contains errors.
 306  */
 307 int tcf_em_tree_validate(struct tcf_proto *tp, struct nlattr *nla,
 308                          struct tcf_ematch_tree *tree)
 309 {
 310         int idx, list_len, matches_len, err;
 311         struct nlattr *tb[TCA_EMATCH_TREE_MAX + 1];
 312         struct nlattr *rt_match, *rt_hdr, *rt_list;
 313         struct tcf_ematch_tree_hdr *tree_hdr;
 314         struct tcf_ematch *em;
 315
 316         memset(tree, 0, sizeof(*tree));
 317         if (!nla)
 318                 return 0;
 319
 320         err = nla_parse_nested(tb, TCA_EMATCH_TREE_MAX, nla, em_policy);
 321         if (err < 0)
 322                 goto errout;
 323
 324         err = -EINVAL;
 325         rt_hdr = tb[TCA_EMATCH_TREE_HDR];
 326         rt_list = tb[TCA_EMATCH_TREE_LIST];
 327
 328         if (rt_hdr == NULL || rt_list == NULL)
 329                 goto errout;
 330
 331         tree_hdr = nla_data(rt_hdr);
 332         memcpy(&tree->hdr, tree_hdr, sizeof(*tree_hdr));
 333
 334         rt_match = nla_data(rt_list);
 335         list_len = nla_len(rt_list);
 336         matches_len = tree_hdr->nmatches * sizeof(*em);
 337
 338         tree->matches = kzalloc(matches_len, GFP_KERNEL);
 339         if (tree->matches == NULL)
 340                 goto errout;
 341
 342         /* We do not use nla_parse_nested here because the maximum
 343          * number of attributes is unknown. This saves us the allocation
 344          * for a tb buffer which would serve no purpose at all.
 345          *
 346          * The array of rt attributes is parsed in the order as they are
 347          * provided, their type must be incremental from 1 to n. Even
 348          * if it does not serve any real purpose, a failure of sticking
 349          * to this policy will result in parsing failure.
 350          */
 351         for (idx = 0; nla_ok(rt_match, list_len); idx++) {
 352                 err = -EINVAL;
 353
 354                 if (rt_match->nla_type != (idx + 1))
 355                         goto errout_abort;
 356
 357                 if (idx >= tree_hdr->nmatches)
 358                         goto errout_abort;
 359
 360                 if (nla_len(rt_match) < sizeof(struct tcf_ematch_hdr))
 361                         goto errout_abort;
 362
 363                 em = tcf_em_get_match(tree, idx);
 364
 365                 err = tcf_em_validate(tp, tree_hdr, em, rt_match, idx);
 366                 if (err < 0)
 367                         goto errout_abort;
 368
 369                 rt_match = nla_next(rt_match, &list_len);
 370         }
 371
 372         /* Check if the number of matches provided by userspace actually
 373          * complies with the array of matches. The number was used for
 374          * the validation of references and a mismatch could lead to
 375          * undefined references during the matching process.
 376          */
 377         if (idx != tree_hdr->nmatches) {
 378                 err = -EINVAL;
 379                 goto errout_abort;
 380         }
 381
 382         err = 0;
 383 errout:
 384         return err;
 385
 386 errout_abort:
 387         tcf_em_tree_destroy(tree);
 388         return err;
 389 }
 390 EXPORT_SYMBOL(tcf_em_tree_validate);
 391
 392 /**
 393  * tcf_em_tree_destroy - destroy an ematch tree
 394  *
 395  * @tp: classifier kind handle
 396  * @tree: ematch tree to be deleted
 397  *
 398  * This functions destroys an ematch tree previously created by
 399  * tcf_em_tree_validate()/tcf_em_tree_change(). You must ensure that
 400  * the ematch tree is not in use before calling this function.
 401  */
 402 void tcf_em_tree_destroy(struct tcf_ematch_tree *tree)
 403 {
 404         int i;
 405
 406         if (tree->matches == NULL)
 407                 return;
 408
 409         for (i = 0; i < tree->hdr.nmatches; i++) {
 410                 struct tcf_ematch *em = tcf_em_get_match(tree, i);
 411
 412                 if (em->ops) {
 413                         if (em->ops->destroy)
 414                                 em->ops->destroy(em);
 415                         else if (!tcf_em_is_simple(em))
 416                                 kfree((void *) em->data);
 417                         module_put(em->ops->owner);
 418                 }
 419         }
 420
 421         tree->hdr.nmatches = 0;
 422         kfree(tree->matches);
 423         tree->matches = NULL;
 424 }
 425 EXPORT_SYMBOL(tcf_em_tree_destroy);
 426
 427 /**
 428  * tcf_em_tree_dump - dump ematch tree into a rtnl message
 429  *
 430  * @skb: skb holding the rtnl message
 431  * @t: ematch tree to be dumped
 432  * @tlv: TLV type to be used to encapsulate the tree
 433  *
 434  * This function dumps a ematch tree into a rtnl message. It is valid to
 435  * call this function while the ematch tree is in use.
 436  *
 437  * Returns -1 if the skb tailroom is insufficient.
 438  */
 439 int tcf_em_tree_dump(struct sk_buff *skb, struct tcf_ematch_tree *tree, int tlv)
 440 {
 441         int i;
 442         u8 *tail;
 443         struct nlattr *top_start;
 444         struct nlattr *list_start;
 445
 446         top_start = nla_nest_start(skb, tlv);
 447         if (top_start == NULL)
 448                 goto nla_put_failure;
 449
 450         if (nla_put(skb, TCA_EMATCH_TREE_HDR, sizeof(tree->hdr), &tree->hdr))
 451                 goto nla_put_failure;
 452
 453         list_start = nla_nest_start(skb, TCA_EMATCH_TREE_LIST);
 454         if (list_start == NULL)
 455                 goto nla_put_failure;
 456
 457         tail = skb_tail_pointer(skb);
 458         for (i = 0; i < tree->hdr.nmatches; i++) {
 459                 struct nlattr *match_start = (struct nlattr *)tail;
 460                 struct tcf_ematch *em = tcf_em_get_match(tree, i);
 461                 struct tcf_ematch_hdr em_hdr = {
 462                         .kind = em->ops ? em->ops->kind : TCF_EM_CONTAINER,
 463                         .matchid = em->matchid,
 464                         .flags = em->flags
 465                 };
 466
 467                 if (nla_put(skb, i + 1, sizeof(em_hdr), &em_hdr))
 468                         goto nla_put_failure;
 469
 470                 if (em->ops && em->ops->dump) {
 471                         if (em->ops->dump(skb, em) < 0)
 472                                 goto nla_put_failure;
 473                 } else if (tcf_em_is_container(em) || tcf_em_is_simple(em)) {
 474                         u32 u = em->data;
 475                         nla_put_nohdr(skb, sizeof(u), &u);
 476                 } else if (em->datalen > 0)
 477                         nla_put_nohdr(skb, em->datalen, (void *) em->data);
 478
 479                 tail = skb_tail_pointer(skb);
 480                 match_start->nla_len = tail - (u8 *)match_start;
 481         }
 482
 483         nla_nest_end(skb, list_start);
 484         nla_nest_end(skb, top_start);
 485
 486         return 0;
 487
 488 nla_put_failure:
 489         return -1;
 490 }
 491 EXPORT_SYMBOL(tcf_em_tree_dump);
 492
 493 static inline int tcf_em_match(struct sk_buff *skb, struct tcf_ematch *em,
 494                                struct tcf_pkt_info *info)
 495 {
 496         int r = em->ops->match(skb, em, info);
 497
 498         return tcf_em_is_inverted(em) ? !r : r;
 499 }
 500
 501 /* Do not use this function directly, use tcf_em_tree_match instead */
 502 int __tcf_em_tree_match(struct sk_buff *skb, struct tcf_ematch_tree *tree,
 503                         struct tcf_pkt_info *info)
 504 {
 505         int stackp = 0, match_idx = 0, res = 0;
 506         struct tcf_ematch *cur_match;
 507         int stack[CONFIG_NET_EMATCH_STACK];
 508
 509 proceed:
 510         while (match_idx < tree->hdr.nmatches) {
 511                 cur_match = tcf_em_get_match(tree, match_idx);
 512
 513                 if (tcf_em_is_container(cur_match)) {
 514                         if (unlikely(stackp >= CONFIG_NET_EMATCH_STACK))
 515                                 goto stack_overflow;
 516
 517                         stack[stackp++] = match_idx;
 518                         match_idx = cur_match->data;
 519                         goto proceed;
 520                 }
 521
 522                 res = tcf_em_match(skb, cur_match, info);
 523
 524                 if (tcf_em_early_end(cur_match, res))
 525                         break;
 526
 527                 match_idx++;
 528         }
 529
 530 pop_stack:
 531         if (stackp > 0) {
 532                 match_idx = stack[--stackp];
 533                 cur_match = tcf_em_get_match(tree, match_idx);
 534
 535                 if (tcf_em_is_inverted(cur_match))
 536                         res = !res;
 537
 538                 if (tcf_em_early_end(cur_match, res)) {
 539                         goto pop_stack;
 540                 } else {
 541                         match_idx++;
 542                         goto proceed;
 543                 }
 544         }
 545
 546         return res;
 547
 548 stack_overflow:
 549         net_warn_ratelimited("tc ematch: local stack overflow, increase NET_EMATCH_STACK\n");
 550         return -1;
 551 }
 552 EXPORT_SYMBOL(__tcf_em_tree_match);