netdev: Fix typo in error message.
[sliver-openvswitch.git] / lib / nx-match.c
1 /*
2  * Copyright (c) 2010, 2011 Nicira Networks.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18
19 #include "nx-match.h"
20
21 #include <netinet/icmp6.h>
22
23 #include "classifier.h"
24 #include "dynamic-string.h"
25 #include "meta-flow.h"
26 #include "ofp-util.h"
27 #include "ofpbuf.h"
28 #include "openflow/nicira-ext.h"
29 #include "packets.h"
30 #include "unaligned.h"
31 #include "vlog.h"
32
33 VLOG_DEFINE_THIS_MODULE(nx_match);
34
35 /* Rate limit for nx_match parse errors.  These always indicate a bug in the
36  * peer and so there's not much point in showing a lot of them. */
37 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
38
39 enum {
40     NXM_INVALID = OFP_MKERR_NICIRA(OFPET_BAD_REQUEST, NXBRC_NXM_INVALID),
41     NXM_BAD_TYPE = OFP_MKERR_NICIRA(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_TYPE),
42     NXM_BAD_VALUE = OFP_MKERR_NICIRA(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_VALUE),
43     NXM_BAD_MASK = OFP_MKERR_NICIRA(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_MASK),
44     NXM_BAD_PREREQ = OFP_MKERR_NICIRA(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_PREREQ),
45     NXM_DUP_TYPE = OFP_MKERR_NICIRA(OFPET_BAD_REQUEST, NXBRC_NXM_DUP_TYPE),
46     BAD_ARGUMENT = OFP_MKERR(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT)
47 };
48
49 /* For each NXM_* field, define NFI_NXM_* as consecutive integers starting from
50  * zero. */
51 enum nxm_field_index {
52 #define DEFINE_FIELD(HEADER, MFF_ID, WRITABLE)  \
53         NFI_NXM_##HEADER,
54 #include "nx-match.def"
55     N_NXM_FIELDS
56 };
57
58 struct nxm_field {
59     struct hmap_node hmap_node;
60     enum nxm_field_index index;       /* NFI_* value. */
61     uint32_t header;                  /* NXM_* value. */
62     enum mf_field_id mf_id;           /* MFF_* value. */
63     const struct mf_field *mf;
64     const char *name;                 /* "NXM_*" string. */
65     bool writable;                    /* Writable with NXAST_REG_{MOVE,LOAD}? */
66 };
67
68 /* All the known fields. */
69 static struct nxm_field nxm_fields[N_NXM_FIELDS] = {
70 #define DEFINE_FIELD(HEADER, MFF_ID, WRITABLE)                            \
71     { HMAP_NODE_NULL_INITIALIZER, NFI_NXM_##HEADER, NXM_##HEADER, \
72       MFF_ID, NULL, "NXM_" #HEADER, WRITABLE },
73 #include "nx-match.def"
74 };
75
76 /* Hash table of 'nxm_fields'. */
77 static struct hmap all_nxm_fields = HMAP_INITIALIZER(&all_nxm_fields);
78
79 static void
80 nxm_init(void)
81 {
82     if (hmap_is_empty(&all_nxm_fields)) {
83         int i;
84
85         for (i = 0; i < N_NXM_FIELDS; i++) {
86             struct nxm_field *f = &nxm_fields[i];
87             hmap_insert(&all_nxm_fields, &f->hmap_node,
88                         hash_int(f->header, 0));
89             f->mf = mf_from_id(f->mf_id);
90         }
91
92         /* Verify that the header values are unique (duplicate "case" values
93          * cause a compile error). */
94         switch (0) {
95 #define DEFINE_FIELD(HEADER, MFF_ID, WRITABLE)  \
96         case NXM_##HEADER: break;
97 #include "nx-match.def"
98         }
99     }
100 }
101
102 static const struct nxm_field *
103 nxm_field_lookup(uint32_t header)
104 {
105     struct nxm_field *f;
106
107     nxm_init();
108
109     HMAP_FOR_EACH_WITH_HASH (f, hmap_node, hash_int(header, 0),
110                              &all_nxm_fields) {
111         if (f->header == header) {
112             return f;
113         }
114     }
115
116     return NULL;
117 }
118
119 /* Returns the width of the data for a field with the given 'header', in
120  * bytes. */
121 int
122 nxm_field_bytes(uint32_t header)
123 {
124     unsigned int length = NXM_LENGTH(header);
125     return NXM_HASMASK(header) ? length / 2 : length;
126 }
127
128 /* Returns the width of the data for a field with the given 'header', in
129  * bits. */
130 int
131 nxm_field_bits(uint32_t header)
132 {
133     return nxm_field_bytes(header) * 8;
134 }
135
136 const struct mf_field *
137 nxm_field_to_mf_field(uint32_t header)
138 {
139     const struct nxm_field *f = nxm_field_lookup(header);
140     return f ? f->mf : NULL;
141 }
142 \f
143 /* nx_pull_match() and helpers. */
144
145 static uint32_t
146 nx_entry_ok(const void *p, unsigned int match_len)
147 {
148     unsigned int payload_len;
149     ovs_be32 header_be;
150     uint32_t header;
151
152     if (match_len < 4) {
153         if (match_len) {
154             VLOG_DBG_RL(&rl, "nx_match ends with partial nxm_header");
155         }
156         return 0;
157     }
158     memcpy(&header_be, p, 4);
159     header = ntohl(header_be);
160
161     payload_len = NXM_LENGTH(header);
162     if (!payload_len) {
163         VLOG_DBG_RL(&rl, "nxm_entry %08"PRIx32" has invalid payload "
164                     "length 0", header);
165         return 0;
166     }
167     if (match_len < payload_len + 4) {
168         VLOG_DBG_RL(&rl, "%"PRIu32"-byte nxm_entry but only "
169                     "%u bytes left in nx_match", payload_len + 4, match_len);
170         return 0;
171     }
172
173     return header;
174 }
175
176 int
177 nx_pull_match(struct ofpbuf *b, unsigned int match_len, uint16_t priority,
178               struct cls_rule *rule)
179 {
180     uint32_t header;
181     uint8_t *p;
182
183     p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
184     if (!p) {
185         VLOG_DBG_RL(&rl, "nx_match length %u, rounded up to a "
186                     "multiple of 8, is longer than space in message (max "
187                     "length %zu)", match_len, b->size);
188         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
189     }
190
191     cls_rule_init_catchall(rule, priority);
192     while ((header = nx_entry_ok(p, match_len)) != 0) {
193         unsigned length = NXM_LENGTH(header);
194         const struct nxm_field *f;
195         int error;
196
197         f = nxm_field_lookup(header);
198         if (!f) {
199             error = NXM_BAD_TYPE;
200         } else if (!mf_are_prereqs_ok(f->mf, &rule->flow)) {
201             error = NXM_BAD_PREREQ;
202         } else if (!mf_is_all_wild(f->mf, &rule->wc)) {
203             error = NXM_DUP_TYPE;
204         } else {
205             unsigned int width = f->mf->n_bytes;
206             union mf_value value;
207
208             memcpy(&value, p + 4, width);
209             if (!mf_is_value_valid(f->mf, &value)) {
210                 error = NXM_BAD_VALUE;
211             } else if (!NXM_HASMASK(header)) {
212                 error = 0;
213                 mf_set_value(f->mf, &value, rule);
214             } else {
215                 union mf_value mask;
216
217                 memcpy(&mask, p + 4 + width, width);
218                 if (!mf_is_mask_valid(f->mf, &mask)) {
219                     error = NXM_BAD_MASK;
220                 } else {
221                     error = 0;
222                     mf_set(f->mf, &value, &mask, rule);
223                 }
224             }
225         }
226
227         if (error) {
228             char *msg = ofputil_error_to_string(error);
229             VLOG_DBG_RL(&rl, "bad nxm_entry with vendor=%"PRIu32", "
230                         "field=%"PRIu32", hasmask=%"PRIu32", type=%"PRIu32" "
231                         "(%s)",
232                         NXM_VENDOR(header), NXM_FIELD(header),
233                         NXM_HASMASK(header), NXM_TYPE(header),
234                         msg);
235             free(msg);
236
237             return error;
238         }
239
240         p += 4 + length;
241         match_len -= 4 + length;
242     }
243
244     return match_len ? NXM_INVALID : 0;
245 }
246 \f
247 /* nx_put_match() and helpers.
248  *
249  * 'put' functions whose names end in 'w' add a wildcarded field.
250  * 'put' functions whose names end in 'm' add a field that might be wildcarded.
251  * Other 'put' functions add exact-match fields.
252  */
253
254 static void
255 nxm_put_header(struct ofpbuf *b, uint32_t header)
256 {
257     ovs_be32 n_header = htonl(header);
258     ofpbuf_put(b, &n_header, sizeof n_header);
259 }
260
261 static void
262 nxm_put_8(struct ofpbuf *b, uint32_t header, uint8_t value)
263 {
264     nxm_put_header(b, header);
265     ofpbuf_put(b, &value, sizeof value);
266 }
267
268 static void
269 nxm_put_8m(struct ofpbuf *b, uint32_t header, uint8_t value, uint8_t mask)
270 {
271     switch (mask) {
272     case 0:
273         break;
274
275     case UINT8_MAX:
276         nxm_put_8(b, header, value);
277         break;
278
279     default:
280         nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
281         ofpbuf_put(b, &value, sizeof value);
282         ofpbuf_put(b, &mask, sizeof mask);
283     }
284 }
285
286 static void
287 nxm_put_16(struct ofpbuf *b, uint32_t header, ovs_be16 value)
288 {
289     nxm_put_header(b, header);
290     ofpbuf_put(b, &value, sizeof value);
291 }
292
293 static void
294 nxm_put_16w(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
295 {
296     nxm_put_header(b, header);
297     ofpbuf_put(b, &value, sizeof value);
298     ofpbuf_put(b, &mask, sizeof mask);
299 }
300
301 static void
302 nxm_put_16m(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
303 {
304     switch (mask) {
305     case 0:
306         break;
307
308     case CONSTANT_HTONS(UINT16_MAX):
309         nxm_put_16(b, header, value);
310         break;
311
312     default:
313         nxm_put_16w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
314         break;
315     }
316 }
317
318 static void
319 nxm_put_32(struct ofpbuf *b, uint32_t header, ovs_be32 value)
320 {
321     nxm_put_header(b, header);
322     ofpbuf_put(b, &value, sizeof value);
323 }
324
325 static void
326 nxm_put_32w(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
327 {
328     nxm_put_header(b, header);
329     ofpbuf_put(b, &value, sizeof value);
330     ofpbuf_put(b, &mask, sizeof mask);
331 }
332
333 static void
334 nxm_put_32m(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
335 {
336     switch (mask) {
337     case 0:
338         break;
339
340     case CONSTANT_HTONL(UINT32_MAX):
341         nxm_put_32(b, header, value);
342         break;
343
344     default:
345         nxm_put_32w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
346         break;
347     }
348 }
349
350 static void
351 nxm_put_64(struct ofpbuf *b, uint32_t header, ovs_be64 value)
352 {
353     nxm_put_header(b, header);
354     ofpbuf_put(b, &value, sizeof value);
355 }
356
357 static void
358 nxm_put_64w(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
359 {
360     nxm_put_header(b, header);
361     ofpbuf_put(b, &value, sizeof value);
362     ofpbuf_put(b, &mask, sizeof mask);
363 }
364
365 static void
366 nxm_put_64m(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
367 {
368     switch (mask) {
369     case 0:
370         break;
371
372     case CONSTANT_HTONLL(UINT64_MAX):
373         nxm_put_64(b, header, value);
374         break;
375
376     default:
377         nxm_put_64w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
378         break;
379     }
380 }
381
382 static void
383 nxm_put_eth(struct ofpbuf *b, uint32_t header,
384             const uint8_t value[ETH_ADDR_LEN])
385 {
386     nxm_put_header(b, header);
387     ofpbuf_put(b, value, ETH_ADDR_LEN);
388 }
389
390 static void
391 nxm_put_eth_dst(struct ofpbuf *b,
392                 flow_wildcards_t wc, const uint8_t value[ETH_ADDR_LEN])
393 {
394     switch (wc & (FWW_DL_DST | FWW_ETH_MCAST)) {
395     case FWW_DL_DST | FWW_ETH_MCAST:
396         break;
397     default:
398         nxm_put_header(b, NXM_OF_ETH_DST_W);
399         ofpbuf_put(b, value, ETH_ADDR_LEN);
400         ofpbuf_put(b, flow_wildcards_to_dl_dst_mask(wc), ETH_ADDR_LEN);
401         break;
402     case 0:
403         nxm_put_eth(b, NXM_OF_ETH_DST, value);
404         break;
405     }
406 }
407
408 static void
409 nxm_put_ipv6(struct ofpbuf *b, uint32_t header,
410              const struct in6_addr *value, const struct in6_addr *mask)
411 {
412     if (ipv6_mask_is_any(mask)) {
413         return;
414     } else if (ipv6_mask_is_exact(mask)) {
415         nxm_put_header(b, header);
416         ofpbuf_put(b, value, sizeof *value);
417     } else {
418         nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
419         ofpbuf_put(b, value, sizeof *value);
420         ofpbuf_put(b, mask, sizeof *mask);
421     }
422 }
423
424 static void
425 nxm_put_tos_frag(struct ofpbuf *b, const struct cls_rule *cr)
426 {
427     uint8_t tos_frag = cr->flow.tos_frag;
428     uint8_t tos_frag_mask = cr->wc.tos_frag_mask;
429
430     if (tos_frag_mask & IP_DSCP_MASK) {
431         nxm_put_8(b, NXM_OF_IP_TOS, tos_frag & IP_DSCP_MASK);
432     }
433
434     switch (tos_frag_mask & FLOW_FRAG_MASK) {
435     case 0:
436         break;
437
438     case FLOW_FRAG_MASK:
439         /* Output it as exact-match even though only the low 2 bits matter. */
440         nxm_put_8(b, NXM_NX_IP_FRAG, tos_frag & FLOW_FRAG_MASK);
441         break;
442
443     default:
444         nxm_put_8m(b, NXM_NX_IP_FRAG, tos_frag & FLOW_FRAG_MASK,
445                    tos_frag_mask & FLOW_FRAG_MASK);
446         break;
447     }
448 }
449
450 /* Appends to 'b' the nx_match format that expresses 'cr' (except for
451  * 'cr->priority', because priority is not part of nx_match), plus enough
452  * zero bytes to pad the nx_match out to a multiple of 8.
453  *
454  * This function can cause 'b''s data to be reallocated.
455  *
456  * Returns the number of bytes appended to 'b', excluding padding.
457  *
458  * If 'cr' is a catch-all rule that matches every packet, then this function
459  * appends nothing to 'b' and returns 0. */
460 int
461 nx_put_match(struct ofpbuf *b, const struct cls_rule *cr)
462 {
463     const flow_wildcards_t wc = cr->wc.wildcards;
464     const struct flow *flow = &cr->flow;
465     const size_t start_len = b->size;
466     int match_len;
467     int i;
468
469     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 3);
470
471     /* Metadata. */
472     if (!(wc & FWW_IN_PORT)) {
473         uint16_t in_port = flow->in_port;
474         nxm_put_16(b, NXM_OF_IN_PORT, htons(in_port));
475     }
476
477     /* Ethernet. */
478     nxm_put_eth_dst(b, wc, flow->dl_dst);
479     if (!(wc & FWW_DL_SRC)) {
480         nxm_put_eth(b, NXM_OF_ETH_SRC, flow->dl_src);
481     }
482     if (!(wc & FWW_DL_TYPE)) {
483         nxm_put_16(b, NXM_OF_ETH_TYPE,
484                    ofputil_dl_type_to_openflow(flow->dl_type));
485     }
486
487     /* 802.1Q. */
488     nxm_put_16m(b, NXM_OF_VLAN_TCI, flow->vlan_tci, cr->wc.vlan_tci_mask);
489
490     /* L3. */
491     if (!(wc & FWW_DL_TYPE) && flow->dl_type == htons(ETH_TYPE_IP)) {
492         /* IP. */
493         nxm_put_tos_frag(b, cr);
494         nxm_put_32m(b, NXM_OF_IP_SRC, flow->nw_src, cr->wc.nw_src_mask);
495         nxm_put_32m(b, NXM_OF_IP_DST, flow->nw_dst, cr->wc.nw_dst_mask);
496
497         if (!(wc & FWW_NW_PROTO)) {
498             nxm_put_8(b, NXM_OF_IP_PROTO, flow->nw_proto);
499             switch (flow->nw_proto) {
500                 /* TCP. */
501             case IPPROTO_TCP:
502                 if (!(wc & FWW_TP_SRC)) {
503                     nxm_put_16(b, NXM_OF_TCP_SRC, flow->tp_src);
504                 }
505                 if (!(wc & FWW_TP_DST)) {
506                     nxm_put_16(b, NXM_OF_TCP_DST, flow->tp_dst);
507                 }
508                 break;
509
510                 /* UDP. */
511             case IPPROTO_UDP:
512                 if (!(wc & FWW_TP_SRC)) {
513                     nxm_put_16(b, NXM_OF_UDP_SRC, flow->tp_src);
514                 }
515                 if (!(wc & FWW_TP_DST)) {
516                     nxm_put_16(b, NXM_OF_UDP_DST, flow->tp_dst);
517                 }
518                 break;
519
520                 /* ICMP. */
521             case IPPROTO_ICMP:
522                 if (!(wc & FWW_TP_SRC)) {
523                     nxm_put_8(b, NXM_OF_ICMP_TYPE, ntohs(flow->tp_src));
524                 }
525                 if (!(wc & FWW_TP_DST)) {
526                     nxm_put_8(b, NXM_OF_ICMP_CODE, ntohs(flow->tp_dst));
527                 }
528                 break;
529             }
530         }
531     } else if (!(wc & FWW_DL_TYPE) && flow->dl_type == htons(ETH_TYPE_IPV6)) {
532         /* IPv6. */
533         nxm_put_tos_frag(b, cr);
534         nxm_put_ipv6(b, NXM_NX_IPV6_SRC, &flow->ipv6_src,
535                 &cr->wc.ipv6_src_mask);
536         nxm_put_ipv6(b, NXM_NX_IPV6_DST, &flow->ipv6_dst,
537                 &cr->wc.ipv6_dst_mask);
538
539         if (!(wc & FWW_NW_PROTO)) {
540             nxm_put_8(b, NXM_OF_IP_PROTO, flow->nw_proto);
541             switch (flow->nw_proto) {
542                 /* TCP. */
543             case IPPROTO_TCP:
544                 if (!(wc & FWW_TP_SRC)) {
545                     nxm_put_16(b, NXM_OF_TCP_SRC, flow->tp_src);
546                 }
547                 if (!(wc & FWW_TP_DST)) {
548                     nxm_put_16(b, NXM_OF_TCP_DST, flow->tp_dst);
549                 }
550                 break;
551
552                 /* UDP. */
553             case IPPROTO_UDP:
554                 if (!(wc & FWW_TP_SRC)) {
555                     nxm_put_16(b, NXM_OF_UDP_SRC, flow->tp_src);
556                 }
557                 if (!(wc & FWW_TP_DST)) {
558                     nxm_put_16(b, NXM_OF_UDP_DST, flow->tp_dst);
559                 }
560                 break;
561
562                 /* ICMPv6. */
563             case IPPROTO_ICMPV6:
564                 if (!(wc & FWW_TP_SRC)) {
565                     nxm_put_8(b, NXM_NX_ICMPV6_TYPE, ntohs(flow->tp_src));
566
567                     if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
568                         flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
569                         if (!(wc & FWW_ND_TARGET)) {
570                             nxm_put_ipv6(b, NXM_NX_ND_TARGET, &flow->nd_target,
571                                          &in6addr_exact);
572                         }
573                         if (!(wc & FWW_ARP_SHA)
574                             && flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
575                             nxm_put_eth(b, NXM_NX_ND_SLL, flow->arp_sha);
576                         }
577                         if (!(wc & FWW_ARP_THA)
578                             && flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
579                             nxm_put_eth(b, NXM_NX_ND_TLL, flow->arp_tha);
580                         }
581                     }
582                 }
583                 if (!(wc & FWW_TP_DST)) {
584                     nxm_put_8(b, NXM_NX_ICMPV6_CODE, ntohs(flow->tp_dst));
585                 }
586                 break;
587             }
588         }
589     } else if (!(wc & FWW_DL_TYPE) && flow->dl_type == htons(ETH_TYPE_ARP)) {
590         /* ARP. */
591         if (!(wc & FWW_NW_PROTO)) {
592             nxm_put_16(b, NXM_OF_ARP_OP, htons(flow->nw_proto));
593         }
594         nxm_put_32m(b, NXM_OF_ARP_SPA, flow->nw_src, cr->wc.nw_src_mask);
595         nxm_put_32m(b, NXM_OF_ARP_TPA, flow->nw_dst, cr->wc.nw_dst_mask);
596         if (!(wc & FWW_ARP_SHA)) {
597             nxm_put_eth(b, NXM_NX_ARP_SHA, flow->arp_sha);
598         }
599         if (!(wc & FWW_ARP_THA)) {
600             nxm_put_eth(b, NXM_NX_ARP_THA, flow->arp_tha);
601         }
602     }
603
604     /* Tunnel ID. */
605     nxm_put_64m(b, NXM_NX_TUN_ID, flow->tun_id, cr->wc.tun_id_mask);
606
607     /* Registers. */
608     for (i = 0; i < FLOW_N_REGS; i++) {
609         nxm_put_32m(b, NXM_NX_REG(i),
610                     htonl(flow->regs[i]), htonl(cr->wc.reg_masks[i]));
611     }
612
613     match_len = b->size - start_len;
614     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
615     return match_len;
616 }
617 \f
618 /* nx_match_to_string() and helpers. */
619
620 static void format_nxm_field_name(struct ds *, uint32_t header);
621
622 char *
623 nx_match_to_string(const uint8_t *p, unsigned int match_len)
624 {
625     uint32_t header;
626     struct ds s;
627
628     if (!match_len) {
629         return xstrdup("<any>");
630     }
631
632     ds_init(&s);
633     while ((header = nx_entry_ok(p, match_len)) != 0) {
634         unsigned int length = NXM_LENGTH(header);
635         unsigned int value_len = nxm_field_bytes(header);
636         const uint8_t *value = p + 4;
637         const uint8_t *mask = value + value_len;
638         unsigned int i;
639
640         if (s.length) {
641             ds_put_cstr(&s, ", ");
642         }
643
644         format_nxm_field_name(&s, header);
645         ds_put_char(&s, '(');
646
647         for (i = 0; i < value_len; i++) {
648             ds_put_format(&s, "%02x", value[i]);
649         }
650         if (NXM_HASMASK(header)) {
651             ds_put_char(&s, '/');
652             for (i = 0; i < value_len; i++) {
653                 ds_put_format(&s, "%02x", mask[i]);
654             }
655         }
656         ds_put_char(&s, ')');
657
658         p += 4 + length;
659         match_len -= 4 + length;
660     }
661
662     if (match_len) {
663         if (s.length) {
664             ds_put_cstr(&s, ", ");
665         }
666
667         ds_put_format(&s, "<%u invalid bytes>", match_len);
668     }
669
670     return ds_steal_cstr(&s);
671 }
672
673 static void
674 format_nxm_field_name(struct ds *s, uint32_t header)
675 {
676     const struct nxm_field *f = nxm_field_lookup(header);
677     if (f) {
678         ds_put_cstr(s, f->name);
679     } else {
680         ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
681     }
682 }
683
684 static uint32_t
685 parse_nxm_field_name(const char *name, int name_len)
686 {
687     const struct nxm_field *f;
688
689     /* Check whether it's a field name. */
690     for (f = nxm_fields; f < &nxm_fields[ARRAY_SIZE(nxm_fields)]; f++) {
691         if (!strncmp(f->name, name, name_len) && f->name[name_len] == '\0') {
692             return f->header;
693         }
694     }
695
696     /* Check whether it's a 32-bit field header value as hex.
697      * (This isn't ordinarily useful except for testing error behavior.) */
698     if (name_len == 8) {
699         uint32_t header = hexits_value(name, name_len, NULL);
700         if (header != UINT_MAX) {
701             return header;
702         }
703     }
704
705     return 0;
706 }
707 \f
708 /* nx_match_from_string(). */
709
710 int
711 nx_match_from_string(const char *s, struct ofpbuf *b)
712 {
713     const char *full_s = s;
714     const size_t start_len = b->size;
715     int match_len;
716
717     if (!strcmp(s, "<any>")) {
718         /* Ensure that 'b->data' isn't actually null. */
719         ofpbuf_prealloc_tailroom(b, 1);
720         return 0;
721     }
722
723     for (s += strspn(s, ", "); *s; s += strspn(s, ", ")) {
724         const char *name;
725         uint32_t header;
726         int name_len;
727         size_t n;
728
729         name = s;
730         name_len = strcspn(s, "(");
731         if (s[name_len] != '(') {
732             ovs_fatal(0, "%s: missing ( at end of nx_match", full_s);
733         }
734
735         header = parse_nxm_field_name(name, name_len);
736         if (!header) {
737             ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
738         }
739
740         s += name_len + 1;
741
742         nxm_put_header(b, header);
743         s = ofpbuf_put_hex(b, s, &n);
744         if (n != nxm_field_bytes(header)) {
745             ovs_fatal(0, "%.2s: hex digits expected", s);
746         }
747         if (NXM_HASMASK(header)) {
748             s += strspn(s, " ");
749             if (*s != '/') {
750                 ovs_fatal(0, "%s: missing / in masked field %.*s",
751                           full_s, name_len, name);
752             }
753             s = ofpbuf_put_hex(b, s + 1, &n);
754             if (n != nxm_field_bytes(header)) {
755                 ovs_fatal(0, "%.2s: hex digits expected", s);
756             }
757         }
758
759         s += strspn(s, " ");
760         if (*s != ')') {
761             ovs_fatal(0, "%s: missing ) following field %.*s",
762                       full_s, name_len, name);
763         }
764         s++;
765     }
766
767     match_len = b->size - start_len;
768     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
769     return match_len;
770 }
771 \f
772 const char *
773 nxm_parse_field_bits(const char *s, uint32_t *headerp, int *ofsp, int *n_bitsp)
774 {
775     const char *full_s = s;
776     const char *name;
777     uint32_t header;
778     int start, end;
779     int name_len;
780     int width;
781
782     name = s;
783     name_len = strcspn(s, "[");
784     if (s[name_len] != '[') {
785         ovs_fatal(0, "%s: missing [ looking for field name", full_s);
786     }
787
788     header = parse_nxm_field_name(name, name_len);
789     if (!header) {
790         ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
791     }
792     width = nxm_field_bits(header);
793
794     s += name_len;
795     if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
796         /* Nothing to do. */
797     } else if (sscanf(s, "[%d]", &start) == 1) {
798         end = start;
799     } else if (!strncmp(s, "[]", 2)) {
800         start = 0;
801         end = width - 1;
802     } else {
803         ovs_fatal(0, "%s: syntax error expecting [] or [<bit>] or "
804                   "[<start>..<end>]", full_s);
805     }
806     s = strchr(s, ']') + 1;
807
808     if (start > end) {
809         ovs_fatal(0, "%s: starting bit %d is after ending bit %d",
810                   full_s, start, end);
811     } else if (start >= width) {
812         ovs_fatal(0, "%s: starting bit %d is not valid because field is only "
813                   "%d bits wide", full_s, start, width);
814     } else if (end >= width){
815         ovs_fatal(0, "%s: ending bit %d is not valid because field is only "
816                   "%d bits wide", full_s, end, width);
817     }
818
819     *headerp = header;
820     *ofsp = start;
821     *n_bitsp = end - start + 1;
822
823     return s;
824 }
825
826 void
827 nxm_parse_reg_move(struct nx_action_reg_move *move, const char *s)
828 {
829     const char *full_s = s;
830     uint32_t src, dst;
831     int src_ofs, dst_ofs;
832     int src_n_bits, dst_n_bits;
833
834     s = nxm_parse_field_bits(s, &src, &src_ofs, &src_n_bits);
835     if (strncmp(s, "->", 2)) {
836         ovs_fatal(0, "%s: missing `->' following source", full_s);
837     }
838     s += 2;
839     s = nxm_parse_field_bits(s, &dst, &dst_ofs, &dst_n_bits);
840     if (*s != '\0') {
841         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
842     }
843
844     if (src_n_bits != dst_n_bits) {
845         ovs_fatal(0, "%s: source field is %d bits wide but destination is "
846                   "%d bits wide", full_s, src_n_bits, dst_n_bits);
847     }
848
849     ofputil_init_NXAST_REG_MOVE(move);
850     move->n_bits = htons(src_n_bits);
851     move->src_ofs = htons(src_ofs);
852     move->dst_ofs = htons(dst_ofs);
853     move->src = htonl(src);
854     move->dst = htonl(dst);
855 }
856
857 void
858 nxm_parse_reg_load(struct nx_action_reg_load *load, const char *s)
859 {
860     const char *full_s = s;
861     uint32_t dst;
862     int ofs, n_bits;
863     uint64_t value;
864
865     value = strtoull(s, (char **) &s, 0);
866     if (strncmp(s, "->", 2)) {
867         ovs_fatal(0, "%s: missing `->' following value", full_s);
868     }
869     s += 2;
870     s = nxm_parse_field_bits(s, &dst, &ofs, &n_bits);
871     if (*s != '\0') {
872         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
873     }
874
875     if (n_bits < 64 && (value >> n_bits) != 0) {
876         ovs_fatal(0, "%s: value %"PRIu64" does not fit into %d bits",
877                   full_s, value, n_bits);
878     }
879
880     ofputil_init_NXAST_REG_LOAD(load);
881     load->ofs_nbits = nxm_encode_ofs_nbits(ofs, n_bits);
882     load->dst = htonl(dst);
883     load->value = htonll(value);
884 }
885 \f
886 /* nxm_format_reg_move(), nxm_format_reg_load(). */
887
888 void
889 nxm_format_field_bits(struct ds *s, uint32_t header, int ofs, int n_bits)
890 {
891     format_nxm_field_name(s, header);
892     if (ofs == 0 && n_bits == nxm_field_bits(header)) {
893         ds_put_cstr(s, "[]");
894     } else if (n_bits == 1) {
895         ds_put_format(s, "[%d]", ofs);
896     } else {
897         ds_put_format(s, "[%d..%d]", ofs, ofs + n_bits - 1);
898     }
899 }
900
901 void
902 nxm_format_reg_move(const struct nx_action_reg_move *move, struct ds *s)
903 {
904     int n_bits = ntohs(move->n_bits);
905     int src_ofs = ntohs(move->src_ofs);
906     int dst_ofs = ntohs(move->dst_ofs);
907     uint32_t src = ntohl(move->src);
908     uint32_t dst = ntohl(move->dst);
909
910     ds_put_format(s, "move:");
911     nxm_format_field_bits(s, src, src_ofs, n_bits);
912     ds_put_cstr(s, "->");
913     nxm_format_field_bits(s, dst, dst_ofs, n_bits);
914 }
915
916 void
917 nxm_format_reg_load(const struct nx_action_reg_load *load, struct ds *s)
918 {
919     int ofs = nxm_decode_ofs(load->ofs_nbits);
920     int n_bits = nxm_decode_n_bits(load->ofs_nbits);
921     uint32_t dst = ntohl(load->dst);
922     uint64_t value = ntohll(load->value);
923
924     ds_put_format(s, "load:%#"PRIx64"->", value);
925     nxm_format_field_bits(s, dst, ofs, n_bits);
926 }
927 \f
928 /* nxm_check_reg_move(), nxm_check_reg_load(). */
929
930 static bool
931 field_ok(const struct nxm_field *f, const struct flow *flow, int size)
932 {
933     return (f
934             && !NXM_HASMASK(f->header)
935             && mf_are_prereqs_ok(f->mf, flow)
936             && size <= nxm_field_bits(f->header));
937 }
938
939 int
940 nxm_check_reg_move(const struct nx_action_reg_move *action,
941                    const struct flow *flow)
942 {
943     int src_ofs, dst_ofs, n_bits;
944     int error;
945
946     n_bits = ntohs(action->n_bits);
947     src_ofs = ntohs(action->src_ofs);
948     dst_ofs = ntohs(action->dst_ofs);
949
950     error = nxm_src_check(action->src, src_ofs, n_bits, flow);
951     if (error) {
952         return error;
953     }
954
955     return nxm_dst_check(action->dst, dst_ofs, n_bits, flow);
956 }
957
958 /* Given a flow, checks that the source field represented by 'src_header'
959  * in the range ['ofs', 'ofs' + 'n_bits') is valid. */
960 int
961 nxm_src_check(ovs_be32 src_header, unsigned int ofs, unsigned int n_bits,
962               const struct flow *flow)
963 {
964     const struct nxm_field *src = nxm_field_lookup(ntohl(src_header));
965
966     if (!n_bits) {
967         VLOG_WARN_RL(&rl, "zero bit source field");
968     } else if (!field_ok(src, flow, ofs + n_bits)) {
969         VLOG_WARN_RL(&rl, "invalid source field");
970     } else {
971         return 0;
972     }
973
974     return BAD_ARGUMENT;
975 }
976
977 /* Given a flow, checks that the destination field represented by 'dst_header'
978  * in the range ['ofs', 'ofs' + 'n_bits') is valid. */
979 int
980 nxm_dst_check(ovs_be32 dst_header, unsigned int ofs, unsigned int n_bits,
981               const struct flow *flow)
982 {
983     const struct nxm_field *dst = nxm_field_lookup(ntohl(dst_header));
984
985     if (!n_bits) {
986         VLOG_WARN_RL(&rl, "zero bit destination field");
987     } else if (!field_ok(dst, flow, ofs + n_bits)) {
988         VLOG_WARN_RL(&rl, "invalid destination field");
989     } else if (!dst->writable) {
990         VLOG_WARN_RL(&rl, "destination field is not writable");
991     } else {
992         return 0;
993     }
994
995     return BAD_ARGUMENT;
996 }
997
998 int
999 nxm_check_reg_load(const struct nx_action_reg_load *action,
1000                    const struct flow *flow)
1001 {
1002     unsigned int ofs = nxm_decode_ofs(action->ofs_nbits);
1003     unsigned int n_bits = nxm_decode_n_bits(action->ofs_nbits);
1004     int error;
1005
1006     error = nxm_dst_check(action->dst, ofs, n_bits, flow);
1007     if (error) {
1008         return error;
1009     }
1010
1011     /* Reject 'action' if a bit numbered 'n_bits' or higher is set to 1 in
1012      * action->value. */
1013     if (n_bits < 64 && ntohll(action->value) >> n_bits) {
1014         return BAD_ARGUMENT;
1015     }
1016
1017     return 0;
1018 }
1019 \f
1020 /* nxm_execute_reg_move(), nxm_execute_reg_load(). */
1021
1022 static uint64_t
1023 nxm_read_field(const struct nxm_field *src, const struct flow *flow)
1024 {
1025     switch (src->index) {
1026     case NFI_NXM_OF_IN_PORT:
1027         return flow->in_port;
1028
1029     case NFI_NXM_OF_ETH_DST:
1030         return eth_addr_to_uint64(flow->dl_dst);
1031
1032     case NFI_NXM_OF_ETH_SRC:
1033         return eth_addr_to_uint64(flow->dl_src);
1034
1035     case NFI_NXM_OF_ETH_TYPE:
1036         return ntohs(ofputil_dl_type_to_openflow(flow->dl_type));
1037
1038     case NFI_NXM_OF_VLAN_TCI:
1039         return ntohs(flow->vlan_tci);
1040
1041     case NFI_NXM_OF_IP_TOS:
1042         return flow->tos_frag & IP_DSCP_MASK;
1043
1044     case NFI_NXM_NX_IP_FRAG:
1045         return flow->tos_frag & FLOW_FRAG_MASK;
1046
1047     case NFI_NXM_OF_IP_PROTO:
1048     case NFI_NXM_OF_ARP_OP:
1049         return flow->nw_proto;
1050
1051     case NFI_NXM_OF_IP_SRC:
1052     case NFI_NXM_OF_ARP_SPA:
1053         return ntohl(flow->nw_src);
1054
1055     case NFI_NXM_OF_IP_DST:
1056     case NFI_NXM_OF_ARP_TPA:
1057         return ntohl(flow->nw_dst);
1058
1059     case NFI_NXM_OF_TCP_SRC:
1060     case NFI_NXM_OF_UDP_SRC:
1061         return ntohs(flow->tp_src);
1062
1063     case NFI_NXM_OF_TCP_DST:
1064     case NFI_NXM_OF_UDP_DST:
1065         return ntohs(flow->tp_dst);
1066
1067     case NFI_NXM_OF_ICMP_TYPE:
1068     case NFI_NXM_NX_ICMPV6_TYPE:
1069         return ntohs(flow->tp_src) & 0xff;
1070
1071     case NFI_NXM_OF_ICMP_CODE:
1072     case NFI_NXM_NX_ICMPV6_CODE:
1073         return ntohs(flow->tp_dst) & 0xff;
1074
1075     case NFI_NXM_NX_TUN_ID:
1076         return ntohll(flow->tun_id);
1077
1078 #define NXM_READ_REGISTER(IDX)                  \
1079     case NFI_NXM_NX_REG##IDX:                   \
1080         return flow->regs[IDX];                 \
1081     case NFI_NXM_NX_REG##IDX##_W:               \
1082         NOT_REACHED();
1083
1084     NXM_READ_REGISTER(0);
1085 #if FLOW_N_REGS >= 2
1086     NXM_READ_REGISTER(1);
1087 #endif
1088 #if FLOW_N_REGS >= 3
1089     NXM_READ_REGISTER(2);
1090 #endif
1091 #if FLOW_N_REGS >= 4
1092     NXM_READ_REGISTER(3);
1093 #endif
1094 #if FLOW_N_REGS >= 5
1095     NXM_READ_REGISTER(4);
1096 #endif
1097 #if FLOW_N_REGS > 5
1098 #error
1099 #endif
1100
1101     case NFI_NXM_NX_ARP_SHA:
1102     case NFI_NXM_NX_ND_SLL:
1103         return eth_addr_to_uint64(flow->arp_sha);
1104
1105     case NFI_NXM_NX_ARP_THA:
1106     case NFI_NXM_NX_ND_TLL:
1107         return eth_addr_to_uint64(flow->arp_tha);
1108
1109     case NFI_NXM_NX_TUN_ID_W:
1110     case NFI_NXM_OF_ETH_DST_W:
1111     case NFI_NXM_OF_VLAN_TCI_W:
1112     case NFI_NXM_OF_IP_SRC_W:
1113     case NFI_NXM_OF_IP_DST_W:
1114     case NFI_NXM_OF_ARP_SPA_W:
1115     case NFI_NXM_OF_ARP_TPA_W:
1116     case NFI_NXM_NX_IPV6_SRC:
1117     case NFI_NXM_NX_IPV6_SRC_W:
1118     case NFI_NXM_NX_IPV6_DST:
1119     case NFI_NXM_NX_IPV6_DST_W:
1120     case NFI_NXM_NX_IP_FRAG_W:
1121     case NFI_NXM_NX_ND_TARGET:
1122     case N_NXM_FIELDS:
1123         NOT_REACHED();
1124     }
1125
1126     NOT_REACHED();
1127 }
1128
1129 /* Returns the value of the NXM field corresponding to 'header' at 'ofs_nbits'
1130  * in 'flow'. */
1131 uint64_t
1132 nxm_read_field_bits(ovs_be32 header, ovs_be16 ofs_nbits,
1133                     const struct flow *flow)
1134 {
1135     int n_bits = nxm_decode_n_bits(ofs_nbits);
1136     int ofs = nxm_decode_ofs(ofs_nbits);
1137     uint64_t mask, data;
1138
1139     mask = n_bits == 64 ? UINT64_MAX : (UINT64_C(1) << n_bits) - 1;
1140     data = nxm_read_field(nxm_field_lookup(ntohl(header)), flow);
1141     data = (data >> ofs) & mask;
1142
1143     return data;
1144 }
1145
1146 static void
1147 nxm_write_field(const struct nxm_field *dst, struct flow *flow,
1148                 uint64_t new_value)
1149 {
1150     switch (dst->index) {
1151     case NFI_NXM_OF_ETH_DST:
1152         eth_addr_from_uint64(new_value, flow->dl_dst);
1153         break;
1154
1155     case NFI_NXM_OF_ETH_SRC:
1156         eth_addr_from_uint64(new_value, flow->dl_src);
1157         break;
1158
1159     case NFI_NXM_OF_VLAN_TCI:
1160         flow->vlan_tci = htons(new_value);
1161         break;
1162
1163     case NFI_NXM_NX_TUN_ID:
1164         flow->tun_id = htonll(new_value);
1165         break;
1166
1167 #define NXM_WRITE_REGISTER(IDX)                 \
1168     case NFI_NXM_NX_REG##IDX:                   \
1169         flow->regs[IDX] = new_value;            \
1170         break;                                  \
1171     case NFI_NXM_NX_REG##IDX##_W:               \
1172         NOT_REACHED();
1173
1174     NXM_WRITE_REGISTER(0);
1175 #if FLOW_N_REGS >= 2
1176     NXM_WRITE_REGISTER(1);
1177 #endif
1178 #if FLOW_N_REGS >= 3
1179     NXM_WRITE_REGISTER(2);
1180 #endif
1181 #if FLOW_N_REGS >= 4
1182     NXM_WRITE_REGISTER(3);
1183 #endif
1184 #if FLOW_N_REGS >= 5
1185     NXM_WRITE_REGISTER(4);
1186 #endif
1187 #if FLOW_N_REGS > 5
1188 #error
1189 #endif
1190
1191     case NFI_NXM_OF_IP_TOS:
1192         flow->tos_frag &= ~IP_DSCP_MASK;
1193         flow->tos_frag |= new_value & IP_DSCP_MASK;
1194         break;
1195
1196     case NFI_NXM_NX_IP_FRAG:
1197         flow->tos_frag &= ~FLOW_FRAG_MASK;
1198         flow->tos_frag |= new_value & FLOW_FRAG_MASK;
1199         break;
1200
1201     case NFI_NXM_OF_IP_SRC:
1202         flow->nw_src = htonl(new_value);
1203         break;
1204
1205     case NFI_NXM_OF_IP_DST:
1206         flow->nw_dst = htonl(new_value);
1207         break;
1208
1209     case NFI_NXM_OF_TCP_SRC:
1210     case NFI_NXM_OF_UDP_SRC:
1211         flow->tp_src = htons(new_value);
1212         break;
1213
1214     case NFI_NXM_OF_TCP_DST:
1215     case NFI_NXM_OF_UDP_DST:
1216         flow->tp_dst = htons(new_value);
1217         break;
1218
1219     case NFI_NXM_OF_IN_PORT:
1220     case NFI_NXM_OF_ETH_TYPE:
1221     case NFI_NXM_OF_IP_PROTO:
1222     case NFI_NXM_OF_ARP_OP:
1223     case NFI_NXM_OF_ARP_SPA:
1224     case NFI_NXM_OF_ARP_TPA:
1225     case NFI_NXM_OF_ICMP_TYPE:
1226     case NFI_NXM_OF_ICMP_CODE:
1227     case NFI_NXM_NX_TUN_ID_W:
1228     case NFI_NXM_OF_ETH_DST_W:
1229     case NFI_NXM_OF_VLAN_TCI_W:
1230     case NFI_NXM_OF_IP_SRC_W:
1231     case NFI_NXM_OF_IP_DST_W:
1232     case NFI_NXM_OF_ARP_SPA_W:
1233     case NFI_NXM_OF_ARP_TPA_W:
1234     case NFI_NXM_NX_ARP_SHA:
1235     case NFI_NXM_NX_ARP_THA:
1236     case NFI_NXM_NX_IPV6_SRC:
1237     case NFI_NXM_NX_IPV6_SRC_W:
1238     case NFI_NXM_NX_IPV6_DST:
1239     case NFI_NXM_NX_IPV6_DST_W:
1240     case NFI_NXM_NX_IP_FRAG_W:
1241     case NFI_NXM_NX_ICMPV6_TYPE:
1242     case NFI_NXM_NX_ICMPV6_CODE:
1243     case NFI_NXM_NX_ND_TARGET:
1244     case NFI_NXM_NX_ND_SLL:
1245     case NFI_NXM_NX_ND_TLL:
1246     case N_NXM_FIELDS:
1247         NOT_REACHED();
1248     }
1249 }
1250
1251 void
1252 nxm_execute_reg_move(const struct nx_action_reg_move *action,
1253                      struct flow *flow)
1254 {
1255     ovs_be16 src_ofs_nbits, dst_ofs_nbits;
1256     uint64_t src_data;
1257     int n_bits;
1258
1259     n_bits = ntohs(action->n_bits);
1260     src_ofs_nbits = nxm_encode_ofs_nbits(ntohs(action->src_ofs), n_bits);
1261     dst_ofs_nbits = nxm_encode_ofs_nbits(ntohs(action->dst_ofs), n_bits);
1262
1263     src_data = nxm_read_field_bits(action->src, src_ofs_nbits, flow);
1264     nxm_reg_load(action->dst, dst_ofs_nbits, src_data, flow);
1265 }
1266
1267 void
1268 nxm_execute_reg_load(const struct nx_action_reg_load *action,
1269                      struct flow *flow)
1270 {
1271     nxm_reg_load(action->dst, action->ofs_nbits, ntohll(action->value), flow);
1272 }
1273
1274 /* Calculates ofs and n_bits from the given 'ofs_nbits' parameter, and copies
1275  * 'src_data'[0:n_bits] to 'dst_header'[ofs:ofs+n_bits] in the given 'flow'. */
1276 void
1277 nxm_reg_load(ovs_be32 dst_header, ovs_be16 ofs_nbits, uint64_t src_data,
1278              struct flow *flow)
1279 {
1280     int n_bits = nxm_decode_n_bits(ofs_nbits);
1281     int dst_ofs = nxm_decode_ofs(ofs_nbits);
1282     uint64_t mask = n_bits == 64 ? UINT64_MAX : (UINT64_C(1) << n_bits) - 1;
1283
1284     /* Get remaining bits of the destination field. */
1285     const struct nxm_field *dst = nxm_field_lookup(ntohl(dst_header));
1286     uint64_t dst_data = nxm_read_field(dst, flow) & ~(mask << dst_ofs);
1287
1288     /* Get the final value. */
1289     uint64_t new_data = dst_data | (src_data << dst_ofs);
1290
1291     nxm_write_field(dst, flow, new_data);
1292 }