pkt_cls.h 12.9 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
L
Linus Torvalds 已提交
2 3 4 5
#ifndef __NET_PKT_CLS_H
#define __NET_PKT_CLS_H

#include <linux/pkt_cls.h>
6
#include <linux/workqueue.h>
L
Linus Torvalds 已提交
7 8 9 10 11
#include <net/sch_generic.h>
#include <net/act_api.h>

/* Basic packet classifier frontend definitions. */

E
Eric Dumazet 已提交
12
struct tcf_walker {
L
Linus Torvalds 已提交
13 14 15
	int	stop;
	int	skip;
	int	count;
16
	int	(*fn)(struct tcf_proto *, void *node, struct tcf_walker *);
L
Linus Torvalds 已提交
17 18
};

19 20
int register_tcf_proto_ops(struct tcf_proto_ops *ops);
int unregister_tcf_proto_ops(struct tcf_proto_ops *ops);
L
Linus Torvalds 已提交
21

22 23
bool tcf_queue_work(struct work_struct *work);

24
#ifdef CONFIG_NET_CLS
25 26
struct tcf_chain *tcf_chain_get(struct tcf_block *block, u32 chain_index,
				bool create);
27
void tcf_chain_put(struct tcf_chain *chain);
28 29 30
int tcf_block_get(struct tcf_block **p_block,
		  struct tcf_proto __rcu **p_filter_chain);
void tcf_block_put(struct tcf_block *block);
31 32 33
int tcf_classify(struct sk_buff *skb, const struct tcf_proto *tp,
		 struct tcf_result *res, bool compat_mode);

34
#else
35 36 37 38 39 40 41 42
static inline
int tcf_block_get(struct tcf_block **p_block,
		  struct tcf_proto __rcu **p_filter_chain)
{
	return 0;
}

static inline void tcf_block_put(struct tcf_block *block)
43 44
{
}
45 46 47 48 49 50

static inline int tcf_classify(struct sk_buff *skb, const struct tcf_proto *tp,
			       struct tcf_result *res, bool compat_mode)
{
	return TC_ACT_UNSPEC;
}
51
#endif
52

L
Linus Torvalds 已提交
53 54 55
static inline unsigned long
__cls_set_class(unsigned long *clp, unsigned long cl)
{
56
	return xchg(clp, cl);
L
Linus Torvalds 已提交
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
}

static inline unsigned long
cls_set_class(struct tcf_proto *tp, unsigned long *clp, 
	unsigned long cl)
{
	unsigned long old_cl;
	
	tcf_tree_lock(tp);
	old_cl = __cls_set_class(clp, cl);
	tcf_tree_unlock(tp);
 
	return old_cl;
}

static inline void
tcf_bind_filter(struct tcf_proto *tp, struct tcf_result *r, unsigned long base)
{
	unsigned long cl;

	cl = tp->q->ops->cl_ops->bind_tcf(tp->q, base, r->classid);
	cl = cls_set_class(tp, &r->class, cl);
	if (cl)
		tp->q->ops->cl_ops->unbind_tcf(tp->q, cl);
}

static inline void
tcf_unbind_filter(struct tcf_proto *tp, struct tcf_result *r)
{
	unsigned long cl;

	if ((cl = __cls_set_class(&r->class, 0)) != 0)
		tp->q->ops->cl_ops->unbind_tcf(tp->q, cl);
}

E
Eric Dumazet 已提交
92
struct tcf_exts {
L
Linus Torvalds 已提交
93
#ifdef CONFIG_NET_CLS_ACT
94
	__u32	type; /* for backward compat(TCA_OLD_COMPAT) */
95 96
	int nr_actions;
	struct tc_action **actions;
L
Linus Torvalds 已提交
97
#endif
98 99 100
	/* Map to export classifier specific extension TLV types to the
	 * generic extensions API. Unsupported extensions must be set to 0.
	 */
L
Linus Torvalds 已提交
101 102 103 104
	int action;
	int police;
};

105
static inline int tcf_exts_init(struct tcf_exts *exts, int action, int police)
106 107
{
#ifdef CONFIG_NET_CLS_ACT
108
	exts->type = 0;
109 110 111
	exts->nr_actions = 0;
	exts->actions = kcalloc(TCA_ACT_MAX_PRIO, sizeof(struct tc_action *),
				GFP_KERNEL);
112 113
	if (!exts->actions)
		return -ENOMEM;
114
#endif
115 116
	exts->action = action;
	exts->police = police;
117
	return 0;
118 119
}

120 121 122 123 124 125 126 127 128
static inline void tcf_exts_to_list(const struct tcf_exts *exts,
				    struct list_head *actions)
{
#ifdef CONFIG_NET_CLS_ACT
	int i;

	for (i = 0; i < exts->nr_actions; i++) {
		struct tc_action *a = exts->actions[i];

129
		list_add_tail(&a->list, actions);
130 131 132 133
	}
#endif
}

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
static inline void
tcf_exts_stats_update(const struct tcf_exts *exts,
		      u64 bytes, u64 packets, u64 lastuse)
{
#ifdef CONFIG_NET_CLS_ACT
	int i;

	preempt_disable();

	for (i = 0; i < exts->nr_actions; i++) {
		struct tc_action *a = exts->actions[i];

		tcf_action_stats_update(a, bytes, packets, lastuse);
	}

	preempt_enable();
#endif
}

153 154 155 156 157 158 159 160
/**
 * tcf_exts_has_actions - check if at least one action is present
 * @exts: tc filter extensions handle
 *
 * Returns true if at least one action is present.
 */
static inline bool tcf_exts_has_actions(struct tcf_exts *exts)
{
161
#ifdef CONFIG_NET_CLS_ACT
162 163 164 165 166
	return exts->nr_actions;
#else
	return false;
#endif
}
167

168 169 170 171 172 173 174 175 176 177 178 179 180 181
/**
 * tcf_exts_has_one_action - check if exactly one action is present
 * @exts: tc filter extensions handle
 *
 * Returns true if exactly one action is present.
 */
static inline bool tcf_exts_has_one_action(struct tcf_exts *exts)
{
#ifdef CONFIG_NET_CLS_ACT
	return exts->nr_actions == 1;
#else
	return false;
#endif
}
182

183 184 185 186 187 188
/**
 * tcf_exts_exec - execute tc filter extensions
 * @skb: socket buffer
 * @exts: tc filter extensions handle
 * @res: desired result
 *
189
 * Executes all configured extensions. Returns TC_ACT_OK on a normal execution,
190 191 192 193 194 195 196 197 198
 * a negative number if the filter must be considered unmatched or
 * a positive action code (TC_ACT_*) which must be returned to the
 * underlying layer.
 */
static inline int
tcf_exts_exec(struct sk_buff *skb, struct tcf_exts *exts,
	      struct tcf_result *res)
{
#ifdef CONFIG_NET_CLS_ACT
199
	return tcf_action_exec(skb, exts->actions, exts->nr_actions, res);
200
#endif
201
	return TC_ACT_OK;
202 203
}

204 205
int tcf_exts_validate(struct net *net, struct tcf_proto *tp,
		      struct nlattr **tb, struct nlattr *rate_tlv,
206
		      struct tcf_exts *exts, bool ovr);
207
void tcf_exts_destroy(struct tcf_exts *exts);
208
void tcf_exts_change(struct tcf_exts *dst, struct tcf_exts *src);
209 210
int tcf_exts_dump(struct sk_buff *skb, struct tcf_exts *exts);
int tcf_exts_dump_stats(struct sk_buff *skb, struct tcf_exts *exts);
211 212
int tcf_exts_get_dev(struct net_device *dev, struct tcf_exts *exts,
		     struct net_device **hw_dev);
L
Linus Torvalds 已提交
213 214 215 216

/**
 * struct tcf_pkt_info - packet information
 */
E
Eric Dumazet 已提交
217
struct tcf_pkt_info {
L
Linus Torvalds 已提交
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
	unsigned char *		ptr;
	int			nexthdr;
};

#ifdef CONFIG_NET_EMATCH

struct tcf_ematch_ops;

/**
 * struct tcf_ematch - extended match (ematch)
 * 
 * @matchid: identifier to allow userspace to reidentify a match
 * @flags: flags specifying attributes and the relation to other matches
 * @ops: the operations lookup table of the corresponding ematch module
 * @datalen: length of the ematch specific configuration data
 * @data: ematch specific data
 */
E
Eric Dumazet 已提交
235
struct tcf_ematch {
L
Linus Torvalds 已提交
236 237 238 239 240
	struct tcf_ematch_ops * ops;
	unsigned long		data;
	unsigned int		datalen;
	u16			matchid;
	u16			flags;
241
	struct net		*net;
L
Linus Torvalds 已提交
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
};

static inline int tcf_em_is_container(struct tcf_ematch *em)
{
	return !em->ops;
}

static inline int tcf_em_is_simple(struct tcf_ematch *em)
{
	return em->flags & TCF_EM_SIMPLE;
}

static inline int tcf_em_is_inverted(struct tcf_ematch *em)
{
	return em->flags & TCF_EM_INVERT;
}

static inline int tcf_em_last_match(struct tcf_ematch *em)
{
	return (em->flags & TCF_EM_REL_MASK) == TCF_EM_REL_END;
}

static inline int tcf_em_early_end(struct tcf_ematch *em, int result)
{
	if (tcf_em_last_match(em))
		return 1;

	if (result == 0 && em->flags & TCF_EM_REL_AND)
		return 1;

	if (result != 0 && em->flags & TCF_EM_REL_OR)
		return 1;

	return 0;
}
	
/**
 * struct tcf_ematch_tree - ematch tree handle
 *
 * @hdr: ematch tree header supplied by userspace
 * @matches: array of ematches
 */
E
Eric Dumazet 已提交
284
struct tcf_ematch_tree {
L
Linus Torvalds 已提交
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
	struct tcf_ematch_tree_hdr hdr;
	struct tcf_ematch *	matches;
	
};

/**
 * struct tcf_ematch_ops - ematch module operations
 * 
 * @kind: identifier (kind) of this ematch module
 * @datalen: length of expected configuration data (optional)
 * @change: called during validation (optional)
 * @match: called during ematch tree evaluation, must return 1/0
 * @destroy: called during destroyage (optional)
 * @dump: called during dumping process (optional)
 * @owner: owner, must be set to THIS_MODULE
 * @link: link to previous/next ematch module (internal use)
 */
E
Eric Dumazet 已提交
302
struct tcf_ematch_ops {
L
Linus Torvalds 已提交
303 304
	int			kind;
	int			datalen;
305
	int			(*change)(struct net *net, void *,
L
Linus Torvalds 已提交
306 307 308
					  int, struct tcf_ematch *);
	int			(*match)(struct sk_buff *, struct tcf_ematch *,
					 struct tcf_pkt_info *);
309
	void			(*destroy)(struct tcf_ematch *);
L
Linus Torvalds 已提交
310 311 312 313 314
	int			(*dump)(struct sk_buff *, struct tcf_ematch *);
	struct module		*owner;
	struct list_head	link;
};

315 316 317 318
int tcf_em_register(struct tcf_ematch_ops *);
void tcf_em_unregister(struct tcf_ematch_ops *);
int tcf_em_tree_validate(struct tcf_proto *, struct nlattr *,
			 struct tcf_ematch_tree *);
319
void tcf_em_tree_destroy(struct tcf_ematch_tree *);
320 321 322
int tcf_em_tree_dump(struct sk_buff *, struct tcf_ematch_tree *, int);
int __tcf_em_tree_match(struct sk_buff *, struct tcf_ematch_tree *,
			struct tcf_pkt_info *);
L
Linus Torvalds 已提交
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

/**
 * tcf_em_tree_match - evaulate an ematch tree
 *
 * @skb: socket buffer of the packet in question
 * @tree: ematch tree to be used for evaluation
 * @info: packet information examined by classifier
 *
 * This function matches @skb against the ematch tree in @tree by going
 * through all ematches respecting their logic relations returning
 * as soon as the result is obvious.
 *
 * Returns 1 if the ematch tree as-one matches, no ematches are configured
 * or ematch is not enabled in the kernel, otherwise 0 is returned.
 */
static inline int tcf_em_tree_match(struct sk_buff *skb,
				    struct tcf_ematch_tree *tree,
				    struct tcf_pkt_info *info)
{
	if (tree->hdr.nmatches)
		return __tcf_em_tree_match(skb, tree, info);
	else
		return 1;
}

348 349
#define MODULE_ALIAS_TCF_EMATCH(kind)	MODULE_ALIAS("ematch-kind-" __stringify(kind))

L
Linus Torvalds 已提交
350 351
#else /* CONFIG_NET_EMATCH */

E
Eric Dumazet 已提交
352
struct tcf_ematch_tree {
L
Linus Torvalds 已提交
353 354 355
};

#define tcf_em_tree_validate(tp, tb, t) ((void)(t), 0)
356
#define tcf_em_tree_destroy(t) do { (void)(t); } while(0)
L
Linus Torvalds 已提交
357 358 359 360 361 362 363 364 365 366 367
#define tcf_em_tree_dump(skb, t, tlv) (0)
#define tcf_em_tree_match(skb, t, info) ((void)(info), 1)

#endif /* CONFIG_NET_EMATCH */

static inline unsigned char * tcf_get_base_ptr(struct sk_buff *skb, int layer)
{
	switch (layer) {
		case TCF_LAYER_LINK:
			return skb->data;
		case TCF_LAYER_NETWORK:
368
			return skb_network_header(skb);
L
Linus Torvalds 已提交
369
		case TCF_LAYER_TRANSPORT:
370
			return skb_transport_header(skb);
L
Linus Torvalds 已提交
371 372 373 374 375
	}

	return NULL;
}

376 377
static inline int tcf_valid_offset(const struct sk_buff *skb,
				   const unsigned char *ptr, const int len)
L
Linus Torvalds 已提交
378
{
379 380 381
	return likely((ptr + len) <= skb_tail_pointer(skb) &&
		      ptr >= skb->head &&
		      (ptr <= (ptr + len)));
L
Linus Torvalds 已提交
382 383 384
}

#ifdef CONFIG_NET_CLS_IND
385 386
#include <net/net_namespace.h>

L
Linus Torvalds 已提交
387
static inline int
388
tcf_change_indev(struct net *net, struct nlattr *indev_tlv)
L
Linus Torvalds 已提交
389
{
390 391 392
	char indev[IFNAMSIZ];
	struct net_device *dev;

393
	if (nla_strlcpy(indev, indev_tlv, IFNAMSIZ) >= IFNAMSIZ)
L
Linus Torvalds 已提交
394
		return -EINVAL;
395 396 397 398
	dev = __dev_get_by_name(net, indev);
	if (!dev)
		return -ENODEV;
	return dev->ifindex;
L
Linus Torvalds 已提交
399 400
}

401 402
static inline bool
tcf_match_indev(struct sk_buff *skb, int ifindex)
L
Linus Torvalds 已提交
403
{
404 405 406 407 408
	if (!ifindex)
		return true;
	if  (!skb->skb_iif)
		return false;
	return ifindex == skb->skb_iif;
L
Linus Torvalds 已提交
409 410 411
}
#endif /* CONFIG_NET_CLS_IND */

412 413 414
struct tc_cls_common_offload {
	u32 chain_index;
	__be16 protocol;
415
	u32 prio;
416
	u32 classid;
417 418 419 420 421 422 423 424
};

static inline void
tc_cls_common_offload_init(struct tc_cls_common_offload *cls_common,
			   const struct tcf_proto *tp)
{
	cls_common->chain_index = tp->chain->index;
	cls_common->protocol = tp->protocol;
425
	cls_common->prio = tp->prio;
426
	cls_common->classid = tp->classid;
427 428
}

429 430
struct tc_cls_u32_knode {
	struct tcf_exts *exts;
431
	struct tc_u32_sel *sel;
432 433 434 435
	u32 handle;
	u32 val;
	u32 mask;
	u32 link_handle;
436
	u8 fshift;
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
};

struct tc_cls_u32_hnode {
	u32 handle;
	u32 prio;
	unsigned int divisor;
};

enum tc_clsu32_command {
	TC_CLSU32_NEW_KNODE,
	TC_CLSU32_REPLACE_KNODE,
	TC_CLSU32_DELETE_KNODE,
	TC_CLSU32_NEW_HNODE,
	TC_CLSU32_REPLACE_HNODE,
	TC_CLSU32_DELETE_HNODE,
};

struct tc_cls_u32_offload {
455
	struct tc_cls_common_offload common;
456 457 458 459 460 461 462 463
	/* knode values */
	enum tc_clsu32_command command;
	union {
		struct tc_cls_u32_knode knode;
		struct tc_cls_u32_hnode hnode;
	};
};

464
static inline bool tc_can_offload(const struct net_device *dev)
465
{
466 467
	if (!(dev->features & NETIF_F_HW_TC))
		return false;
468 469 470
	if (!dev->netdev_ops->ndo_setup_tc)
		return false;
	return true;
471 472
}

473 474 475 476 477
static inline bool tc_skip_hw(u32 flags)
{
	return (flags & TCA_CLS_FLAGS_SKIP_HW) ? true : false;
}

478
static inline bool tc_should_offload(const struct net_device *dev, u32 flags)
479 480 481
{
	if (tc_skip_hw(flags))
		return false;
482
	return tc_can_offload(dev);
483 484
}

485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
static inline bool tc_skip_sw(u32 flags)
{
	return (flags & TCA_CLS_FLAGS_SKIP_SW) ? true : false;
}

/* SKIP_HW and SKIP_SW are mutually exclusive flags. */
static inline bool tc_flags_valid(u32 flags)
{
	if (flags & ~(TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW))
		return false;

	if (!(flags ^ (TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW)))
		return false;

	return true;
}

502 503 504 505 506
static inline bool tc_in_hw(u32 flags)
{
	return (flags & TCA_CLS_FLAGS_IN_HW) ? true : false;
}

507 508 509
enum tc_fl_command {
	TC_CLSFLOWER_REPLACE,
	TC_CLSFLOWER_DESTROY,
510
	TC_CLSFLOWER_STATS,
511 512 513
};

struct tc_cls_flower_offload {
514
	struct tc_cls_common_offload common;
515
	enum tc_fl_command command;
A
Amir Vadai 已提交
516
	unsigned long cookie;
517 518 519 520
	struct flow_dissector *dissector;
	struct fl_flow_key *mask;
	struct fl_flow_key *key;
	struct tcf_exts *exts;
521
	bool egress_dev;
522 523
};

524 525 526 527 528 529
enum tc_matchall_command {
	TC_CLSMATCHALL_REPLACE,
	TC_CLSMATCHALL_DESTROY,
};

struct tc_cls_matchall_offload {
530
	struct tc_cls_common_offload common;
531 532 533 534 535
	enum tc_matchall_command command;
	struct tcf_exts *exts;
	unsigned long cookie;
};

536 537 538 539
enum tc_clsbpf_command {
	TC_CLSBPF_ADD,
	TC_CLSBPF_REPLACE,
	TC_CLSBPF_DESTROY,
540
	TC_CLSBPF_STATS,
541 542 543
};

struct tc_cls_bpf_offload {
544
	struct tc_cls_common_offload common;
545 546 547 548 549
	enum tc_clsbpf_command command;
	struct tcf_exts *exts;
	struct bpf_prog *prog;
	const char *name;
	bool exts_integrated;
550
	u32 gen_flags;
551 552
};

553 554 555 556 557 558 559 560

/* This structure holds cookie structure that is passed from user
 * to the kernel for actions and classifiers
 */
struct tc_cookie {
	u8  *data;
	u32 len;
};
L
Linus Torvalds 已提交
561
#endif