include/net/pkt_cls.h

   1 #ifndef __NET_PKT_CLS_H
   2 #define __NET_PKT_CLS_H
   3
   4 #include <linux/pkt_cls.h>
   5 #include <net/sch_generic.h>
   6 #include <net/act_api.h>
   7
   8 /* Basic packet classifier frontend definitions. */
   9
  10 struct tcf_walker {
  11         int     stop;
  12         int     skip;
  13         int     count;
  14         int     (*fn)(struct tcf_proto *, unsigned long node, struct tcf_walker *);
  15 };
  16
  17 int register_tcf_proto_ops(struct tcf_proto_ops *ops);
  18 int unregister_tcf_proto_ops(struct tcf_proto_ops *ops);
  19
  20 #ifdef CONFIG_NET_CLS
  21 void tcf_destroy_chain(struct tcf_proto __rcu **fl);
  22 #else
  23 static inline void tcf_destroy_chain(struct tcf_proto __rcu **fl)
  24 {
  25 }
  26 #endif
  27
  28 static inline unsigned long
  29 __cls_set_class(unsigned long *clp, unsigned long cl)
  30 {
  31         return xchg(clp, cl);
  32 }
  33
  34 static inline unsigned long
  35 cls_set_class(struct tcf_proto *tp, unsigned long *clp,
  36         unsigned long cl)
  37 {
  38         unsigned long old_cl;
  39
  40         tcf_tree_lock(tp);
  41         old_cl = __cls_set_class(clp, cl);
  42         tcf_tree_unlock(tp);
  43
  44         return old_cl;
  45 }
  46
  47 static inline void
  48 tcf_bind_filter(struct tcf_proto *tp, struct tcf_result *r, unsigned long base)
  49 {
  50         unsigned long cl;
  51
  52         cl = tp->q->ops->cl_ops->bind_tcf(tp->q, base, r->classid);
  53         cl = cls_set_class(tp, &r->class, cl);
  54         if (cl)
  55                 tp->q->ops->cl_ops->unbind_tcf(tp->q, cl);
  56 }
  57
  58 static inline void
  59 tcf_unbind_filter(struct tcf_proto *tp, struct tcf_result *r)
  60 {
  61         unsigned long cl;
  62
  63         if ((cl = __cls_set_class(&r->class, 0)) != 0)
  64                 tp->q->ops->cl_ops->unbind_tcf(tp->q, cl);
  65 }
  66
  67 struct tcf_exts {
  68 #ifdef CONFIG_NET_CLS_ACT
  69         __u32   type; /* for backward compat(TCA_OLD_COMPAT) */
  70         int nr_actions;
  71         struct tc_action **actions;
  72 #endif
  73         /* Map to export classifier specific extension TLV types to the
  74          * generic extensions API. Unsupported extensions must be set to 0.
  75          */
  76         int action;
  77         int police;
  78 };
  79
  80 static inline int tcf_exts_init(struct tcf_exts *exts, int action, int police)
  81 {
  82 #ifdef CONFIG_NET_CLS_ACT
  83         exts->type = 0;
  84         exts->nr_actions = 0;
  85         exts->actions = kcalloc(TCA_ACT_MAX_PRIO, sizeof(struct tc_action *),
  86                                 GFP_KERNEL);
  87         if (!exts->actions)
  88                 return -ENOMEM;
  89 #endif
  90         exts->action = action;
  91         exts->police = police;
  92         return 0;
  93 }
  94
  95 /**
  96  * tcf_exts_is_predicative - check if a predicative extension is present
  97  * @exts: tc filter extensions handle
  98  *
  99  * Returns 1 if a predicative extension is present, i.e. an extension which
 100  * might cause further actions and thus overrule the regular tcf_result.
 101  */
 102 static inline int
 103 tcf_exts_is_predicative(struct tcf_exts *exts)
 104 {
 105 #ifdef CONFIG_NET_CLS_ACT
 106         return exts->nr_actions;
 107 #else
 108         return 0;
 109 #endif
 110 }
 111
 112 /**
 113  * tcf_exts_is_available - check if at least one extension is present
 114  * @exts: tc filter extensions handle
 115  *
 116  * Returns 1 if at least one extension is present.
 117  */
 118 static inline int
 119 tcf_exts_is_available(struct tcf_exts *exts)
 120 {
 121         /* All non-predicative extensions must be added here. */
 122         return tcf_exts_is_predicative(exts);
 123 }
 124
 125 static inline void tcf_exts_to_list(const struct tcf_exts *exts,
 126                                     struct list_head *actions)
 127 {
 128 #ifdef CONFIG_NET_CLS_ACT
 129         int i;
 130
 131         for (i = 0; i < exts->nr_actions; i++) {
 132                 struct tc_action *a = exts->actions[i];
 133
 134                 list_add_tail(&a->list, actions);
 135         }
 136 #endif
 137 }
 138
 139 /**
 140  * tcf_exts_exec - execute tc filter extensions
 141  * @skb: socket buffer
 142  * @exts: tc filter extensions handle
 143  * @res: desired result
 144  *
 145  * Executes all configured extensions. Returns 0 on a normal execution,
 146  * a negative number if the filter must be considered unmatched or
 147  * a positive action code (TC_ACT_*) which must be returned to the
 148  * underlying layer.
 149  */
 150 static inline int
 151 tcf_exts_exec(struct sk_buff *skb, struct tcf_exts *exts,
 152                struct tcf_result *res)
 153 {
 154 #ifdef CONFIG_NET_CLS_ACT
 155         if (exts->nr_actions)
 156                 return tcf_action_exec(skb, exts->actions, exts->nr_actions,
 157                                        res);
 158 #endif
 159         return 0;
 160 }
 161
 162 #ifdef CONFIG_NET_CLS_ACT
 163
 164 #define tc_no_actions(_exts)  ((_exts)->nr_actions == 0)
 165 #define tc_single_action(_exts) ((_exts)->nr_actions == 1)
 166
 167 #else /* CONFIG_NET_CLS_ACT */
 168
 169 #define tc_no_actions(_exts) true
 170 #define tc_single_action(_exts) false
 171
 172 #endif /* CONFIG_NET_CLS_ACT */
 173
 174 int tcf_exts_validate(struct net *net, struct tcf_proto *tp,
 175                       struct nlattr **tb, struct nlattr *rate_tlv,
 176                       struct tcf_exts *exts, bool ovr);
 177 void tcf_exts_destroy(struct tcf_exts *exts);
 178 void tcf_exts_change(struct tcf_proto *tp, struct tcf_exts *dst,
 179                      struct tcf_exts *src);
 180 int tcf_exts_dump(struct sk_buff *skb, struct tcf_exts *exts);
 181 int tcf_exts_dump_stats(struct sk_buff *skb, struct tcf_exts *exts);
 182 int tcf_exts_get_dev(struct net_device *dev, struct tcf_exts *exts,
 183                      struct net_device **hw_dev);
 184
 185 /**
 186  * struct tcf_pkt_info - packet information
 187  */
 188 struct tcf_pkt_info {
 189         unsigned char *         ptr;
 190         int                     nexthdr;
 191 };
 192
 193 #ifdef CONFIG_NET_EMATCH
 194
 195 struct tcf_ematch_ops;
 196
 197 /**
 198  * struct tcf_ematch - extended match (ematch)
 199  *
 200  * @matchid: identifier to allow userspace to reidentify a match
 201  * @flags: flags specifying attributes and the relation to other matches
 202  * @ops: the operations lookup table of the corresponding ematch module
 203  * @datalen: length of the ematch specific configuration data
 204  * @data: ematch specific data
 205  */
 206 struct tcf_ematch {
 207         struct tcf_ematch_ops * ops;
 208         unsigned long           data;
 209         unsigned int            datalen;
 210         u16                     matchid;
 211         u16                     flags;
 212         struct net              *net;
 213 };
 214
 215 static inline int tcf_em_is_container(struct tcf_ematch *em)
 216 {
 217         return !em->ops;
 218 }
 219
 220 static inline int tcf_em_is_simple(struct tcf_ematch *em)
 221 {
 222         return em->flags & TCF_EM_SIMPLE;
 223 }
 224
 225 static inline int tcf_em_is_inverted(struct tcf_ematch *em)
 226 {
 227         return em->flags & TCF_EM_INVERT;
 228 }
 229
 230 static inline int tcf_em_last_match(struct tcf_ematch *em)
 231 {
 232         return (em->flags & TCF_EM_REL_MASK) == TCF_EM_REL_END;
 233 }
 234
 235 static inline int tcf_em_early_end(struct tcf_ematch *em, int result)
 236 {
 237         if (tcf_em_last_match(em))
 238                 return 1;
 239
 240         if (result == 0 && em->flags & TCF_EM_REL_AND)
 241                 return 1;
 242
 243         if (result != 0 && em->flags & TCF_EM_REL_OR)
 244                 return 1;
 245
 246         return 0;
 247 }
 248
 249 /**
 250  * struct tcf_ematch_tree - ematch tree handle
 251  *
 252  * @hdr: ematch tree header supplied by userspace
 253  * @matches: array of ematches
 254  */
 255 struct tcf_ematch_tree {
 256         struct tcf_ematch_tree_hdr hdr;
 257         struct tcf_ematch *     matches;
 258
 259 };
 260
 261 /**
 262  * struct tcf_ematch_ops - ematch module operations
 263  *
 264  * @kind: identifier (kind) of this ematch module
 265  * @datalen: length of expected configuration data (optional)
 266  * @change: called during validation (optional)
 267  * @match: called during ematch tree evaluation, must return 1/0
 268  * @destroy: called during destroyage (optional)
 269  * @dump: called during dumping process (optional)
 270  * @owner: owner, must be set to THIS_MODULE
 271  * @link: link to previous/next ematch module (internal use)
 272  */
 273 struct tcf_ematch_ops {
 274         int                     kind;
 275         int                     datalen;
 276         int                     (*change)(struct net *net, void *,
 277                                           int, struct tcf_ematch *);
 278         int                     (*match)(struct sk_buff *, struct tcf_ematch *,
 279                                          struct tcf_pkt_info *);
 280         void                    (*destroy)(struct tcf_ematch *);
 281         int                     (*dump)(struct sk_buff *, struct tcf_ematch *);
 282         struct module           *owner;
 283         struct list_head        link;
 284 };
 285
 286 int tcf_em_register(struct tcf_ematch_ops *);
 287 void tcf_em_unregister(struct tcf_ematch_ops *);
 288 int tcf_em_tree_validate(struct tcf_proto *, struct nlattr *,
 289                          struct tcf_ematch_tree *);
 290 void tcf_em_tree_destroy(struct tcf_ematch_tree *);
 291 int tcf_em_tree_dump(struct sk_buff *, struct tcf_ematch_tree *, int);
 292 int __tcf_em_tree_match(struct sk_buff *, struct tcf_ematch_tree *,
 293                         struct tcf_pkt_info *);
 294
 295 /**
 296  * tcf_em_tree_change - replace ematch tree of a running classifier
 297  *
 298  * @tp: classifier kind handle
 299  * @dst: destination ematch tree variable
 300  * @src: source ematch tree (temporary tree from tcf_em_tree_validate)
 301  *
 302  * This functions replaces the ematch tree in @dst with the ematch
 303  * tree in @src. The classifier in charge of the ematch tree may be
 304  * running.
 305  */
 306 static inline void tcf_em_tree_change(struct tcf_proto *tp,
 307                                       struct tcf_ematch_tree *dst,
 308                                       struct tcf_ematch_tree *src)
 309 {
 310         tcf_tree_lock(tp);
 311         memcpy(dst, src, sizeof(*dst));
 312         tcf_tree_unlock(tp);
 313 }
 314
 315 /**
 316  * tcf_em_tree_match - evaulate an ematch tree
 317  *
 318  * @skb: socket buffer of the packet in question
 319  * @tree: ematch tree to be used for evaluation
 320  * @info: packet information examined by classifier
 321  *
 322  * This function matches @skb against the ematch tree in @tree by going
 323  * through all ematches respecting their logic relations returning
 324  * as soon as the result is obvious.
 325  *
 326  * Returns 1 if the ematch tree as-one matches, no ematches are configured
 327  * or ematch is not enabled in the kernel, otherwise 0 is returned.
 328  */
 329 static inline int tcf_em_tree_match(struct sk_buff *skb,
 330                                     struct tcf_ematch_tree *tree,
 331                                     struct tcf_pkt_info *info)
 332 {
 333         if (tree->hdr.nmatches)
 334                 return __tcf_em_tree_match(skb, tree, info);
 335         else
 336                 return 1;
 337 }
 338
 339 #define MODULE_ALIAS_TCF_EMATCH(kind)   MODULE_ALIAS("ematch-kind-" __stringify(kind))
 340
 341 #else /* CONFIG_NET_EMATCH */
 342
 343 struct tcf_ematch_tree {
 344 };
 345
 346 #define tcf_em_tree_validate(tp, tb, t) ((void)(t), 0)
 347 #define tcf_em_tree_destroy(t) do { (void)(t); } while(0)
 348 #define tcf_em_tree_dump(skb, t, tlv) (0)
 349 #define tcf_em_tree_change(tp, dst, src) do { } while(0)
 350 #define tcf_em_tree_match(skb, t, info) ((void)(info), 1)
 351
 352 #endif /* CONFIG_NET_EMATCH */
 353
 354 static inline unsigned char * tcf_get_base_ptr(struct sk_buff *skb, int layer)
 355 {
 356         switch (layer) {
 357                 case TCF_LAYER_LINK:
 358                         return skb->data;
 359                 case TCF_LAYER_NETWORK:
 360                         return skb_network_header(skb);
 361                 case TCF_LAYER_TRANSPORT:
 362                         return skb_transport_header(skb);
 363         }
 364
 365         return NULL;
 366 }
 367
 368 static inline int tcf_valid_offset(const struct sk_buff *skb,
 369                                    const unsigned char *ptr, const int len)
 370 {
 371         return likely((ptr + len) <= skb_tail_pointer(skb) &&
 372                       ptr >= skb->head &&
 373                       (ptr <= (ptr + len)));
 374 }
 375
 376 #ifdef CONFIG_NET_CLS_IND
 377 #include <net/net_namespace.h>
 378
 379 static inline int
 380 tcf_change_indev(struct net *net, struct nlattr *indev_tlv)
 381 {
 382         char indev[IFNAMSIZ];
 383         struct net_device *dev;
 384
 385         if (nla_strlcpy(indev, indev_tlv, IFNAMSIZ) >= IFNAMSIZ)
 386                 return -EINVAL;
 387         dev = __dev_get_by_name(net, indev);
 388         if (!dev)
 389                 return -ENODEV;
 390         return dev->ifindex;
 391 }
 392
 393 static inline bool
 394 tcf_match_indev(struct sk_buff *skb, int ifindex)
 395 {
 396         if (!ifindex)
 397                 return true;
 398         if  (!skb->skb_iif)
 399                 return false;
 400         return ifindex == skb->skb_iif;
 401 }
 402 #endif /* CONFIG_NET_CLS_IND */
 403
 404 struct tc_cls_u32_knode {
 405         struct tcf_exts *exts;
 406         struct tc_u32_sel *sel;
 407         u32 handle;
 408         u32 val;
 409         u32 mask;
 410         u32 link_handle;
 411         u8 fshift;
 412 };
 413
 414 struct tc_cls_u32_hnode {
 415         u32 handle;
 416         u32 prio;
 417         unsigned int divisor;
 418 };
 419
 420 enum tc_clsu32_command {
 421         TC_CLSU32_NEW_KNODE,
 422         TC_CLSU32_REPLACE_KNODE,
 423         TC_CLSU32_DELETE_KNODE,
 424         TC_CLSU32_NEW_HNODE,
 425         TC_CLSU32_REPLACE_HNODE,
 426         TC_CLSU32_DELETE_HNODE,
 427 };
 428
 429 struct tc_cls_u32_offload {
 430         /* knode values */
 431         enum tc_clsu32_command command;
 432         union {
 433                 struct tc_cls_u32_knode knode;
 434                 struct tc_cls_u32_hnode hnode;
 435         };
 436 };
 437
 438 static inline bool tc_can_offload(const struct net_device *dev,
 439                                   const struct tcf_proto *tp)
 440 {
 441         const struct Qdisc *sch = tp->q;
 442         const struct Qdisc_class_ops *cops = sch->ops->cl_ops;
 443
 444         if (!(dev->features & NETIF_F_HW_TC))
 445                 return false;
 446         if (!dev->netdev_ops->ndo_setup_tc)
 447                 return false;
 448         if (cops && cops->tcf_cl_offload)
 449                 return cops->tcf_cl_offload(tp->classid);
 450
 451         return true;
 452 }
 453
 454 static inline bool tc_skip_hw(u32 flags)
 455 {
 456         return (flags & TCA_CLS_FLAGS_SKIP_HW) ? true : false;
 457 }
 458
 459 static inline bool tc_should_offload(const struct net_device *dev,
 460                                      const struct tcf_proto *tp, u32 flags)
 461 {
 462         if (tc_skip_hw(flags))
 463                 return false;
 464         return tc_can_offload(dev, tp);
 465 }
 466
 467 static inline bool tc_skip_sw(u32 flags)
 468 {
 469         return (flags & TCA_CLS_FLAGS_SKIP_SW) ? true : false;
 470 }
 471
 472 /* SKIP_HW and SKIP_SW are mutually exclusive flags. */
 473 static inline bool tc_flags_valid(u32 flags)
 474 {
 475         if (flags & ~(TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW))
 476                 return false;
 477
 478         if (!(flags ^ (TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW)))
 479                 return false;
 480
 481         return true;
 482 }
 483
 484 static inline bool tc_in_hw(u32 flags)
 485 {
 486         return (flags & TCA_CLS_FLAGS_IN_HW) ? true : false;
 487 }
 488
 489 enum tc_fl_command {
 490         TC_CLSFLOWER_REPLACE,
 491         TC_CLSFLOWER_DESTROY,
 492         TC_CLSFLOWER_STATS,
 493 };
 494
 495 struct tc_cls_flower_offload {
 496         enum tc_fl_command command;
 497         u32 prio;
 498         unsigned long cookie;
 499         struct flow_dissector *dissector;
 500         struct fl_flow_key *mask;
 501         struct fl_flow_key *key;
 502         struct tcf_exts *exts;
 503 };
 504
 505 enum tc_matchall_command {
 506         TC_CLSMATCHALL_REPLACE,
 507         TC_CLSMATCHALL_DESTROY,
 508 };
 509
 510 struct tc_cls_matchall_offload {
 511         enum tc_matchall_command command;
 512         struct tcf_exts *exts;
 513         unsigned long cookie;
 514 };
 515
 516 enum tc_clsbpf_command {
 517         TC_CLSBPF_ADD,
 518         TC_CLSBPF_REPLACE,
 519         TC_CLSBPF_DESTROY,
 520         TC_CLSBPF_STATS,
 521 };
 522
 523 struct tc_cls_bpf_offload {
 524         enum tc_clsbpf_command command;
 525         struct tcf_exts *exts;
 526         struct bpf_prog *prog;
 527         const char *name;
 528         bool exts_integrated;
 529         u32 gen_flags;
 530 };
 531
 532
 533 /* This structure holds cookie structure that is passed from user
 534  * to the kernel for actions and classifiers
 535  */
 536 struct tc_cookie {
 537         u8  *data;
 538         u32 len;
 539 };
 540 #endif