2 * em_meta.c Metadata Ematch
4 * This program is free software; you can distribute 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>
16 #include <sys/socket.h>
17 #include <netinet/in.h>
18 #include <arpa/inet.h>
23 #include <linux/tc_ematch/tc_em_meta.h>
25 extern struct ematch_util meta_ematch_util
;
27 static void meta_print_usage(FILE *fd
)
30 "Usage: meta(OBJECT { eq | lt | gt } OBJECT)\n" \
31 "where: OBJECT := { META_ID | VALUE }\n" \
32 " META_ID := id [ shift SHIFT ] [ mask MASK ]\n" \
34 "Example: meta(nf_mark gt 24)\n" \
35 " meta(indev shift 1 eq \"ppp\")\n" \
36 " meta(tcindex mask 0xf0 eq 0xf0)\n" \
38 "For a list of meta identifiers, use meta(list).\n");
41 static const struct meta_entry
{
47 #define TCF_META_ID_SECTION 0
48 #define __A(id, name, mask, desc) { TCF_META_ID_##id, name, mask, desc }
49 __A(SECTION
, "Generic", "", ""),
50 __A(RANDOM
, "random", "i",
51 "Random value (32 bit)"),
52 __A(LOADAVG_0
, "loadavg_1", "i",
53 "Load average in last minute"),
54 __A(LOADAVG_1
, "loadavg_5", "i",
55 "Load average in last 5 minutes"),
56 __A(LOADAVG_2
, "loadavg_15", "i",
57 "Load average in last 15 minutes"),
59 __A(SECTION
, "Interfaces", "", ""),
61 "Device the packet is on"),
62 __A(SECTION
, "Packet attributes", "", ""),
63 __A(PRIORITY
, "priority", "i",
64 "Priority of packet"),
65 __A(PROTOCOL
, "protocol", "i",
66 "Link layer protocol"),
67 __A(PKTTYPE
, "pkt_type", "i",
68 "Packet type (uni|multi|broad|...)cast"),
69 __A(PKTLEN
, "pkt_len", "i",
71 __A(DATALEN
, "data_len", "i",
72 "Length of data in packet"),
73 __A(MACLEN
, "mac_len", "i",
74 "Length of link layer header"),
76 __A(SECTION
, "Netfilter", "", ""),
77 __A(NFMARK
, "nf_mark", "i",
79 __A(NFMARK
, "fwmark", "i",
82 __A(SECTION
, "Traffic Control", "", ""),
83 __A(TCINDEX
, "tc_index", "i", "TC Index"),
84 __A(SECTION
, "Routing", "", ""),
85 __A(RTCLASSID
, "rt_classid", "i",
86 "Routing ClassID (cls_route)"),
87 __A(RTIIF
, "rt_iif", "i",
88 "Incoming interface index"),
89 __A(VLAN_TAG
, "vlan", "i", "Vlan tag"),
91 __A(SECTION
, "Sockets", "", ""),
92 __A(SK_FAMILY
, "sk_family", "i", "Address family"),
93 __A(SK_STATE
, "sk_state", "i", "State"),
94 __A(SK_REUSE
, "sk_reuse", "i", "Reuse Flag"),
95 __A(SK_BOUND_IF
, "sk_bind_if", "iv", "Bound interface"),
96 __A(SK_REFCNT
, "sk_refcnt", "i", "Reference counter"),
97 __A(SK_SHUTDOWN
, "sk_shutdown", "i", "Shutdown mask"),
98 __A(SK_PROTO
, "sk_proto", "i", "Protocol"),
99 __A(SK_TYPE
, "sk_type", "i", "Type"),
100 __A(SK_RCVBUF
, "sk_rcvbuf", "i", "Receive buffer size"),
101 __A(SK_RMEM_ALLOC
, "sk_rmem", "i", "RMEM"),
102 __A(SK_WMEM_ALLOC
, "sk_wmem", "i", "WMEM"),
103 __A(SK_OMEM_ALLOC
, "sk_omem", "i", "OMEM"),
104 __A(SK_WMEM_QUEUED
, "sk_wmem_queue", "i", "WMEM queue"),
105 __A(SK_SND_QLEN
, "sk_snd_queue", "i", "Send queue length"),
106 __A(SK_RCV_QLEN
, "sk_rcv_queue", "i", "Receive queue length"),
107 __A(SK_ERR_QLEN
, "sk_err_queue", "i", "Error queue length"),
108 __A(SK_FORWARD_ALLOCS
, "sk_fwd_alloc", "i", "Forward allocations"),
109 __A(SK_SNDBUF
, "sk_sndbuf", "i", "Send buffer size"),
113 static inline int map_type(char k
)
116 case 'i': return TCF_META_TYPE_INT
;
117 case 'v': return TCF_META_TYPE_VAR
;
120 fprintf(stderr
, "BUG: Unknown map character '%c'\n", k
);
124 static const struct meta_entry
*lookup_meta_entry(struct bstr
*kind
)
128 for (i
= 0; i
< ARRAY_SIZE(meta_table
); i
++)
129 if (!bstrcmp(kind
, meta_table
[i
].kind
) &&
130 meta_table
[i
].id
!= 0)
131 return &meta_table
[i
];
136 static const struct meta_entry
*lookup_meta_entry_byid(int id
)
140 for (i
= 0; i
< ARRAY_SIZE(meta_table
); i
++)
141 if (meta_table
[i
].id
== id
)
142 return &meta_table
[i
];
147 static inline void dump_value(struct nlmsghdr
*n
, int tlv
, unsigned long val
,
148 struct tcf_meta_val
*hdr
)
152 switch (TCF_META_TYPE(hdr
->kind
)) {
153 case TCF_META_TYPE_INT
:
155 addattr_l(n
, MAX_MSG
, tlv
, &t
, sizeof(t
));
158 case TCF_META_TYPE_VAR
:
159 if (TCF_META_ID(hdr
->kind
) == TCF_META_ID_VALUE
) {
160 struct bstr
*a
= (struct bstr
*) val
;
162 addattr_l(n
, MAX_MSG
, tlv
, a
->data
, a
->len
);
168 static inline int is_compatible(struct tcf_meta_val
*what
,
169 struct tcf_meta_val
*needed
)
171 const struct meta_entry
*entry
;
174 entry
= lookup_meta_entry_byid(TCF_META_ID(what
->kind
));
179 for (p
= entry
->mask
; p
; p
++)
180 if (map_type(*p
) == TCF_META_TYPE(needed
->kind
))
186 static void list_meta_ids(FILE *fd
)
191 "--------------------------------------------------------\n" \
192 " ID Type Description\n" \
193 "--------------------------------------------------------");
195 for (i
= 0; i
< ARRAY_SIZE(meta_table
); i
++) {
196 if (meta_table
[i
].id
== TCF_META_ID_SECTION
) {
197 fprintf(fd
, "\n%s:\n", meta_table
[i
].kind
);
199 char *p
= meta_table
[i
].mask
;
202 fprintf(fd
, " %-16s ", meta_table
[i
].kind
);
205 int type
= map_type(*p
);
208 case TCF_META_TYPE_INT
:
212 case TCF_META_TYPE_VAR
:
221 fprintf(fd
, "%-10s %s\n", buf
, meta_table
[i
].desc
);
226 "--------------------------------------------------------\n");
229 #undef TCF_META_ID_SECTION
231 #define PARSE_FAILURE ((void *) (-1))
233 #define PARSE_ERR(CARG, FMT, ARGS...) \
234 em_parse_error(EINVAL, args, CARG, &meta_ematch_util, FMT, ##ARGS)
236 static inline int can_adopt(struct tcf_meta_val
*val
)
238 return !!TCF_META_ID(val
->kind
);
241 static inline int overwrite_type(struct tcf_meta_val
*src
,
242 struct tcf_meta_val
*dst
)
244 return (TCF_META_TYPE(dst
->kind
) << 12) | TCF_META_ID(src
->kind
);
248 static inline struct bstr
*
249 parse_object(struct bstr
*args
, struct bstr
*arg
, struct tcf_meta_val
*obj
,
250 unsigned long *dst
, struct tcf_meta_val
*left
)
252 const struct meta_entry
*entry
;
257 obj
->kind
= TCF_META_TYPE_VAR
<< 12;
258 obj
->kind
|= TCF_META_ID_VALUE
;
259 *dst
= (unsigned long) arg
;
260 return bstr_next(arg
);
264 if (num
!= ULONG_MAX
) {
265 obj
->kind
= TCF_META_TYPE_INT
<< 12;
266 obj
->kind
|= TCF_META_ID_VALUE
;
267 *dst
= (unsigned long) num
;
268 return bstr_next(arg
);
271 entry
= lookup_meta_entry(arg
);
274 PARSE_ERR(arg
, "meta: unknown meta id\n");
275 return PARSE_FAILURE
;
278 obj
->kind
= entry
->id
| (map_type(entry
->mask
[0]) << 12);
281 struct tcf_meta_val
*right
= obj
;
283 if (TCF_META_TYPE(right
->kind
) == TCF_META_TYPE(left
->kind
))
286 if (can_adopt(left
) && !can_adopt(right
)) {
287 if (is_compatible(left
, right
))
288 left
->kind
= overwrite_type(left
, right
);
291 } else if (can_adopt(right
) && !can_adopt(left
)) {
292 if (is_compatible(right
, left
))
293 right
->kind
= overwrite_type(right
, left
);
296 } else if (can_adopt(left
) && can_adopt(right
)) {
297 if (is_compatible(left
, right
))
298 left
->kind
= overwrite_type(left
, right
);
299 else if (is_compatible(right
, left
))
300 right
->kind
= overwrite_type(right
, left
);
312 if (!bstrcmp(a
, "shift")) {
315 if (a
->next
== NULL
) {
316 PARSE_ERR(a
, "meta: missing argument");
317 return PARSE_FAILURE
;
322 if (shift
== ULONG_MAX
) {
323 PARSE_ERR(a
, "meta: invalid shift, must " \
325 return PARSE_FAILURE
;
328 obj
->shift
= (__u8
) shift
;
330 } else if (!bstrcmp(a
, "mask")) {
333 if (a
->next
== NULL
) {
334 PARSE_ERR(a
, "meta: missing argument");
335 return PARSE_FAILURE
;
340 if (mask
== ULONG_MAX
) {
341 PARSE_ERR(a
, "meta: invalid mask, must be " \
343 return PARSE_FAILURE
;
345 *dst
= (unsigned long) mask
;
354 PARSE_ERR(arg
, "lvalue and rvalue are not compatible.");
355 return PARSE_FAILURE
;
358 static int meta_parse_eopt(struct nlmsghdr
*n
, struct tcf_ematch_hdr
*hdr
,
363 struct tcf_meta_hdr meta_hdr
= {};
364 unsigned long lvalue
= 0, rvalue
= 0;
367 return PARSE_ERR(args
, "meta: missing arguments");
369 if (!bstrcmp(args
, "list")) {
370 list_meta_ids(stderr
);
374 a
= parse_object(args
, args
, &meta_hdr
.left
, &lvalue
, NULL
);
375 if (a
== PARSE_FAILURE
)
378 return PARSE_ERR(args
, "meta: missing operand");
380 if (!bstrcmp(a
, "eq"))
381 opnd
= TCF_EM_OPND_EQ
;
382 else if (!bstrcmp(a
, "gt"))
383 opnd
= TCF_EM_OPND_GT
;
384 else if (!bstrcmp(a
, "lt"))
385 opnd
= TCF_EM_OPND_LT
;
387 return PARSE_ERR(a
, "meta: invalid operand");
389 meta_hdr
.left
.op
= (__u8
) opnd
;
392 return PARSE_ERR(args
, "meta: missing rvalue");
395 a
= parse_object(args
, a
, &meta_hdr
.right
, &rvalue
, &meta_hdr
.left
);
396 if (a
== PARSE_FAILURE
)
399 return PARSE_ERR(a
, "meta: unexpected trailer");
402 addraw_l(n
, MAX_MSG
, hdr
, sizeof(*hdr
));
404 addattr_l(n
, MAX_MSG
, TCA_EM_META_HDR
, &meta_hdr
, sizeof(meta_hdr
));
406 dump_value(n
, TCA_EM_META_LVALUE
, lvalue
, &meta_hdr
.left
);
407 dump_value(n
, TCA_EM_META_RVALUE
, rvalue
, &meta_hdr
.right
);
413 static inline void print_binary(FILE *fd
, unsigned char *str
, int len
)
417 for (i
= 0; i
< len
; i
++)
418 if (!isprint(str
[i
]))
421 for (i
= 0; i
< len
; i
++)
422 fprintf(fd
, "%c", str
[i
]);
426 for (i
= 0; i
< len
; i
++)
427 fprintf(fd
, "%02x ", str
[i
]);
430 for (i
= 0; i
< len
; i
++)
431 fprintf(fd
, "%c", isprint(str
[i
]) ? str
[i
] : '.');
435 static inline int print_value(FILE *fd
, int type
, struct rtattr
*rta
)
438 fprintf(stderr
, "Missing value TLV\n");
443 case TCF_META_TYPE_INT
:
444 if (RTA_PAYLOAD(rta
) < sizeof(__u32
)) {
445 fprintf(stderr
, "meta int type value TLV " \
449 fprintf(fd
, "%d", rta_getattr_u32(rta
));
452 case TCF_META_TYPE_VAR
:
453 print_binary(fd
, RTA_DATA(rta
), RTA_PAYLOAD(rta
));
460 static int print_object(FILE *fd
, struct tcf_meta_val
*obj
, struct rtattr
*rta
)
462 int id
= TCF_META_ID(obj
->kind
);
463 int type
= TCF_META_TYPE(obj
->kind
);
464 const struct meta_entry
*entry
;
466 if (id
== TCF_META_ID_VALUE
)
467 return print_value(fd
, type
, rta
);
469 entry
= lookup_meta_entry_byid(id
);
472 fprintf(fd
, "[unknown meta id %d]", id
);
474 fprintf(fd
, "%s", entry
->kind
);
477 fprintf(fd
, " shift %d", obj
->shift
);
480 case TCF_META_TYPE_INT
:
482 if (RTA_PAYLOAD(rta
) < sizeof(__u32
))
485 if (rta_getattr_u32(rta
))
486 fprintf(fd
, " mask 0x%08x",
487 rta_getattr_u32(rta
));
495 fprintf(stderr
, "meta int type mask TLV size mismatch\n");
500 static int meta_print_eopt(FILE *fd
, struct tcf_ematch_hdr
*hdr
, void *data
,
503 struct rtattr
*tb
[TCA_EM_META_MAX
+1];
504 struct tcf_meta_hdr
*meta_hdr
;
506 if (parse_rtattr(tb
, TCA_EM_META_MAX
, data
, data_len
) < 0)
509 if (tb
[TCA_EM_META_HDR
] == NULL
) {
510 fprintf(stderr
, "Missing meta header\n");
514 if (RTA_PAYLOAD(tb
[TCA_EM_META_HDR
]) < sizeof(*meta_hdr
)) {
515 fprintf(stderr
, "Meta header size mismatch\n");
519 meta_hdr
= RTA_DATA(tb
[TCA_EM_META_HDR
]);
521 if (print_object(fd
, &meta_hdr
->left
, tb
[TCA_EM_META_LVALUE
]) < 0)
524 switch (meta_hdr
->left
.op
) {
536 return print_object(fd
, &meta_hdr
->right
, tb
[TCA_EM_META_RVALUE
]);
539 struct ematch_util meta_ematch_util
= {
541 .kind_num
= TCF_EM_META
,
542 .parse_eopt
= meta_parse_eopt
,
543 .print_eopt
= meta_print_eopt
,
544 .print_usage
= meta_print_usage