ofproto-dpif: Factor out VLAN splinter flow adjustment into new function.
[openvswitch] / lib / nx-match.c
1 /*
2  * Copyright (c) 2010, 2011, 2012 Nicira, Inc.
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-errors.h"
27 #include "ofp-util.h"
28 #include "ofpbuf.h"
29 #include "openflow/nicira-ext.h"
30 #include "packets.h"
31 #include "unaligned.h"
32 #include "util.h"
33 #include "vlog.h"
34
35 VLOG_DEFINE_THIS_MODULE(nx_match);
36
37 /* Rate limit for nx_match parse errors.  These always indicate a bug in the
38  * peer and so there's not much point in showing a lot of them. */
39 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
40
41 /* Returns the width of the data for a field with the given 'header', in
42  * bytes. */
43 int
44 nxm_field_bytes(uint32_t header)
45 {
46     unsigned int length = NXM_LENGTH(header);
47     return NXM_HASMASK(header) ? length / 2 : length;
48 }
49
50 /* Returns the width of the data for a field with the given 'header', in
51  * bits. */
52 int
53 nxm_field_bits(uint32_t header)
54 {
55     return nxm_field_bytes(header) * 8;
56 }
57 \f
58 /* nx_pull_match() and helpers. */
59
60 static uint32_t
61 nx_entry_ok(const void *p, unsigned int match_len)
62 {
63     unsigned int payload_len;
64     ovs_be32 header_be;
65     uint32_t header;
66
67     if (match_len < 4) {
68         if (match_len) {
69             VLOG_DBG_RL(&rl, "nx_match ends with partial nxm_header");
70         }
71         return 0;
72     }
73     memcpy(&header_be, p, 4);
74     header = ntohl(header_be);
75
76     payload_len = NXM_LENGTH(header);
77     if (!payload_len) {
78         VLOG_DBG_RL(&rl, "nxm_entry %08"PRIx32" has invalid payload "
79                     "length 0", header);
80         return 0;
81     }
82     if (match_len < payload_len + 4) {
83         VLOG_DBG_RL(&rl, "%"PRIu32"-byte nxm_entry but only "
84                     "%u bytes left in nx_match", payload_len + 4, match_len);
85         return 0;
86     }
87
88     return header;
89 }
90
91 static enum ofperr
92 nx_pull_match__(struct ofpbuf *b, unsigned int match_len, bool strict,
93                 uint16_t priority, struct cls_rule *rule,
94                 ovs_be64 *cookie, ovs_be64 *cookie_mask)
95 {
96     uint32_t header;
97     uint8_t *p;
98
99     assert((cookie != NULL) == (cookie_mask != NULL));
100
101     p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
102     if (!p) {
103         VLOG_DBG_RL(&rl, "nx_match length %u, rounded up to a "
104                     "multiple of 8, is longer than space in message (max "
105                     "length %zu)", match_len, b->size);
106         return OFPERR_OFPBMC_BAD_LEN;
107     }
108
109     cls_rule_init_catchall(rule, priority);
110     if (cookie) {
111         *cookie = *cookie_mask = htonll(0);
112     }
113     for (;
114          (header = nx_entry_ok(p, match_len)) != 0;
115          p += 4 + NXM_LENGTH(header), match_len -= 4 + NXM_LENGTH(header)) {
116         const struct mf_field *mf;
117         enum ofperr error;
118
119         mf = mf_from_nxm_header(header);
120         if (!mf) {
121             if (strict) {
122                 error = OFPERR_OFPBMC_BAD_FIELD;
123             } else {
124                 continue;
125             }
126         } else if (!mf_are_prereqs_ok(mf, &rule->flow)) {
127             error = OFPERR_OFPBMC_BAD_PREREQ;
128         } else if (!mf_is_all_wild(mf, &rule->wc)) {
129             error = OFPERR_OFPBMC_DUP_FIELD;
130         } else {
131             unsigned int width = mf->n_bytes;
132             union mf_value value;
133
134             memcpy(&value, p + 4, width);
135             if (!mf_is_value_valid(mf, &value)) {
136                 error = OFPERR_OFPBMC_BAD_VALUE;
137             } else if (!NXM_HASMASK(header)) {
138                 error = 0;
139                 mf_set_value(mf, &value, rule);
140             } else {
141                 union mf_value mask;
142
143                 memcpy(&mask, p + 4 + width, width);
144                 if (!mf_is_mask_valid(mf, &mask)) {
145                     error = OFPERR_OFPBMC_BAD_MASK;
146                 } else {
147                     error = 0;
148                     mf_set(mf, &value, &mask, rule);
149                 }
150             }
151         }
152
153         /* Check if the match is for a cookie rather than a classifier rule. */
154         if ((header == NXM_NX_COOKIE || header == NXM_NX_COOKIE_W) && cookie) {
155             if (*cookie_mask) {
156                 error = OFPERR_OFPBMC_DUP_FIELD;
157             } else {
158                 unsigned int width = sizeof *cookie;
159
160                 memcpy(cookie, p + 4, width);
161                 if (NXM_HASMASK(header)) {
162                     memcpy(cookie_mask, p + 4 + width, width);
163                 } else {
164                     *cookie_mask = htonll(UINT64_MAX);
165                 }
166                 error = 0;
167             }
168         }
169
170         if (error) {
171             VLOG_DBG_RL(&rl, "bad nxm_entry %#08"PRIx32" (vendor=%"PRIu32", "
172                         "field=%"PRIu32", hasmask=%"PRIu32", len=%"PRIu32"), "
173                         "(%s)", header,
174                         NXM_VENDOR(header), NXM_FIELD(header),
175                         NXM_HASMASK(header), NXM_LENGTH(header),
176                         ofperr_to_string(error));
177             return error;
178         }
179     }
180
181     return match_len ? OFPERR_OFPBMC_BAD_LEN : 0;
182 }
183
184 /* Parses the nx_match formatted match description in 'b' with length
185  * 'match_len'.  The results are stored in 'rule', which is initialized with
186  * 'priority'.  If 'cookie' and 'cookie_mask' contain valid pointers, then the
187  * cookie and mask will be stored in them if a "NXM_NX_COOKIE*" match is
188  * defined.  Otherwise, 0 is stored in both.
189  *
190  * Fails with an error when encountering unknown NXM headers.
191  *
192  * Returns 0 if successful, otherwise an OpenFlow error code. */
193 enum ofperr
194 nx_pull_match(struct ofpbuf *b, unsigned int match_len,
195               uint16_t priority, struct cls_rule *rule,
196               ovs_be64 *cookie, ovs_be64 *cookie_mask)
197 {
198     return nx_pull_match__(b, match_len, true, priority, rule, cookie,
199                            cookie_mask);
200 }
201
202 /* Behaves the same as nx_pull_match() with one exception.  Skips over unknown
203  * NXM headers instead of failing with an error when they are encountered. */
204 enum ofperr
205 nx_pull_match_loose(struct ofpbuf *b, unsigned int match_len,
206                     uint16_t priority, struct cls_rule *rule,
207                     ovs_be64 *cookie, ovs_be64 *cookie_mask)
208 {
209     return nx_pull_match__(b, match_len, false, priority, rule, cookie,
210                            cookie_mask);
211 }
212 \f
213 /* nx_put_match() and helpers.
214  *
215  * 'put' functions whose names end in 'w' add a wildcarded field.
216  * 'put' functions whose names end in 'm' add a field that might be wildcarded.
217  * Other 'put' functions add exact-match fields.
218  */
219
220 static void
221 nxm_put_header(struct ofpbuf *b, uint32_t header)
222 {
223     ovs_be32 n_header = htonl(header);
224     ofpbuf_put(b, &n_header, sizeof n_header);
225 }
226
227 static void
228 nxm_put_8(struct ofpbuf *b, uint32_t header, uint8_t value)
229 {
230     nxm_put_header(b, header);
231     ofpbuf_put(b, &value, sizeof value);
232 }
233
234 static void
235 nxm_put_8m(struct ofpbuf *b, uint32_t header, uint8_t value, uint8_t mask)
236 {
237     switch (mask) {
238     case 0:
239         break;
240
241     case UINT8_MAX:
242         nxm_put_8(b, header, value);
243         break;
244
245     default:
246         nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
247         ofpbuf_put(b, &value, sizeof value);
248         ofpbuf_put(b, &mask, sizeof mask);
249     }
250 }
251
252 static void
253 nxm_put_16(struct ofpbuf *b, uint32_t header, ovs_be16 value)
254 {
255     nxm_put_header(b, header);
256     ofpbuf_put(b, &value, sizeof value);
257 }
258
259 static void
260 nxm_put_16w(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
261 {
262     nxm_put_header(b, header);
263     ofpbuf_put(b, &value, sizeof value);
264     ofpbuf_put(b, &mask, sizeof mask);
265 }
266
267 static void
268 nxm_put_16m(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
269 {
270     switch (mask) {
271     case 0:
272         break;
273
274     case CONSTANT_HTONS(UINT16_MAX):
275         nxm_put_16(b, header, value);
276         break;
277
278     default:
279         nxm_put_16w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
280         break;
281     }
282 }
283
284 static void
285 nxm_put_32(struct ofpbuf *b, uint32_t header, ovs_be32 value)
286 {
287     nxm_put_header(b, header);
288     ofpbuf_put(b, &value, sizeof value);
289 }
290
291 static void
292 nxm_put_32w(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
293 {
294     nxm_put_header(b, header);
295     ofpbuf_put(b, &value, sizeof value);
296     ofpbuf_put(b, &mask, sizeof mask);
297 }
298
299 static void
300 nxm_put_32m(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
301 {
302     switch (mask) {
303     case 0:
304         break;
305
306     case CONSTANT_HTONL(UINT32_MAX):
307         nxm_put_32(b, header, value);
308         break;
309
310     default:
311         nxm_put_32w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
312         break;
313     }
314 }
315
316 static void
317 nxm_put_64(struct ofpbuf *b, uint32_t header, ovs_be64 value)
318 {
319     nxm_put_header(b, header);
320     ofpbuf_put(b, &value, sizeof value);
321 }
322
323 static void
324 nxm_put_64w(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
325 {
326     nxm_put_header(b, header);
327     ofpbuf_put(b, &value, sizeof value);
328     ofpbuf_put(b, &mask, sizeof mask);
329 }
330
331 static void
332 nxm_put_64m(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
333 {
334     switch (mask) {
335     case 0:
336         break;
337
338     case CONSTANT_HTONLL(UINT64_MAX):
339         nxm_put_64(b, header, value);
340         break;
341
342     default:
343         nxm_put_64w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
344         break;
345     }
346 }
347
348 static void
349 nxm_put_eth(struct ofpbuf *b, uint32_t header,
350             const uint8_t value[ETH_ADDR_LEN])
351 {
352     nxm_put_header(b, header);
353     ofpbuf_put(b, value, ETH_ADDR_LEN);
354 }
355
356 static void
357 nxm_put_eth_dst(struct ofpbuf *b,
358                 flow_wildcards_t wc, const uint8_t value[ETH_ADDR_LEN])
359 {
360     switch (wc & (FWW_DL_DST | FWW_ETH_MCAST)) {
361     case FWW_DL_DST | FWW_ETH_MCAST:
362         break;
363     default:
364         nxm_put_header(b, NXM_OF_ETH_DST_W);
365         ofpbuf_put(b, value, ETH_ADDR_LEN);
366         ofpbuf_put(b, flow_wildcards_to_dl_dst_mask(wc), ETH_ADDR_LEN);
367         break;
368     case 0:
369         nxm_put_eth(b, NXM_OF_ETH_DST, value);
370         break;
371     }
372 }
373
374 static void
375 nxm_put_ipv6(struct ofpbuf *b, uint32_t header,
376              const struct in6_addr *value, const struct in6_addr *mask)
377 {
378     if (ipv6_mask_is_any(mask)) {
379         return;
380     } else if (ipv6_mask_is_exact(mask)) {
381         nxm_put_header(b, header);
382         ofpbuf_put(b, value, sizeof *value);
383     } else {
384         nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
385         ofpbuf_put(b, value, sizeof *value);
386         ofpbuf_put(b, mask, sizeof *mask);
387     }
388 }
389
390 static void
391 nxm_put_frag(struct ofpbuf *b, const struct cls_rule *cr)
392 {
393     uint8_t nw_frag = cr->flow.nw_frag;
394     uint8_t nw_frag_mask = cr->wc.nw_frag_mask;
395
396     switch (nw_frag_mask) {
397     case 0:
398         break;
399
400     case FLOW_NW_FRAG_MASK:
401         nxm_put_8(b, NXM_NX_IP_FRAG, nw_frag);
402         break;
403
404     default:
405         nxm_put_8m(b, NXM_NX_IP_FRAG, nw_frag,
406                    nw_frag_mask & FLOW_NW_FRAG_MASK);
407         break;
408     }
409 }
410
411 static void
412 nxm_put_ip(struct ofpbuf *b, const struct cls_rule *cr,
413            uint8_t icmp_proto, uint32_t icmp_type, uint32_t icmp_code)
414 {
415     const flow_wildcards_t wc = cr->wc.wildcards;
416     const struct flow *flow = &cr->flow;
417
418     nxm_put_frag(b, cr);
419
420     if (!(wc & FWW_NW_DSCP)) {
421         nxm_put_8(b, NXM_OF_IP_TOS, flow->nw_tos & IP_DSCP_MASK);
422     }
423
424     if (!(wc & FWW_NW_ECN)) {
425         nxm_put_8(b, NXM_NX_IP_ECN, flow->nw_tos & IP_ECN_MASK);
426     }
427
428     if (!(wc & FWW_NW_TTL)) {
429         nxm_put_8(b, NXM_NX_IP_TTL, flow->nw_ttl);
430     }
431
432     if (!(wc & FWW_NW_PROTO)) {
433         nxm_put_8(b, NXM_OF_IP_PROTO, flow->nw_proto);
434
435         if (flow->nw_proto == IPPROTO_TCP) {
436             nxm_put_16m(b, NXM_OF_TCP_SRC, flow->tp_src, cr->wc.tp_src_mask);
437             nxm_put_16m(b, NXM_OF_TCP_DST, flow->tp_dst, cr->wc.tp_dst_mask);
438         } else if (flow->nw_proto == IPPROTO_UDP) {
439             nxm_put_16m(b, NXM_OF_UDP_SRC, flow->tp_src, cr->wc.tp_src_mask);
440             nxm_put_16m(b, NXM_OF_UDP_DST, flow->tp_dst, cr->wc.tp_dst_mask);
441         } else if (flow->nw_proto == icmp_proto) {
442             if (cr->wc.tp_src_mask) {
443                 nxm_put_8(b, icmp_type, ntohs(flow->tp_src));
444             }
445             if (cr->wc.tp_dst_mask) {
446                 nxm_put_8(b, icmp_code, ntohs(flow->tp_dst));
447             }
448         }
449     }
450 }
451
452 /* Appends to 'b' the nx_match format that expresses 'cr' (except for
453  * 'cr->priority', because priority is not part of nx_match), plus enough
454  * zero bytes to pad the nx_match out to a multiple of 8.  For Flow Mod
455  * and Flow Stats Requests messages, a 'cookie' and 'cookie_mask' may be
456  * supplied.  Otherwise, 'cookie_mask' should be zero.
457  *
458  * This function can cause 'b''s data to be reallocated.
459  *
460  * Returns the number of bytes appended to 'b', excluding padding.
461  *
462  * If 'cr' is a catch-all rule that matches every packet, then this function
463  * appends nothing to 'b' and returns 0. */
464 int
465 nx_put_match(struct ofpbuf *b, const struct cls_rule *cr,
466              ovs_be64 cookie, ovs_be64 cookie_mask)
467 {
468     const flow_wildcards_t wc = cr->wc.wildcards;
469     const struct flow *flow = &cr->flow;
470     const size_t start_len = b->size;
471     int match_len;
472     int i;
473
474     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 10);
475
476     /* Metadata. */
477     if (!(wc & FWW_IN_PORT)) {
478         uint16_t in_port = flow->in_port;
479         nxm_put_16(b, NXM_OF_IN_PORT, htons(in_port));
480     }
481
482     /* Ethernet. */
483     nxm_put_eth_dst(b, wc, flow->dl_dst);
484     if (!(wc & FWW_DL_SRC)) {
485         nxm_put_eth(b, NXM_OF_ETH_SRC, flow->dl_src);
486     }
487     if (!(wc & FWW_DL_TYPE)) {
488         nxm_put_16(b, NXM_OF_ETH_TYPE,
489                    ofputil_dl_type_to_openflow(flow->dl_type));
490     }
491
492     /* 802.1Q. */
493     nxm_put_16m(b, NXM_OF_VLAN_TCI, flow->vlan_tci, cr->wc.vlan_tci_mask);
494
495     /* L3. */
496     if (!(wc & FWW_DL_TYPE) && flow->dl_type == htons(ETH_TYPE_IP)) {
497         /* IP. */
498         nxm_put_32m(b, NXM_OF_IP_SRC, flow->nw_src, cr->wc.nw_src_mask);
499         nxm_put_32m(b, NXM_OF_IP_DST, flow->nw_dst, cr->wc.nw_dst_mask);
500         nxm_put_ip(b, cr, IPPROTO_ICMP, NXM_OF_ICMP_TYPE, NXM_OF_ICMP_CODE);
501     } else if (!(wc & FWW_DL_TYPE) && flow->dl_type == htons(ETH_TYPE_IPV6)) {
502         /* IPv6. */
503         nxm_put_ipv6(b, NXM_NX_IPV6_SRC, &flow->ipv6_src,
504                 &cr->wc.ipv6_src_mask);
505         nxm_put_ipv6(b, NXM_NX_IPV6_DST, &flow->ipv6_dst,
506                 &cr->wc.ipv6_dst_mask);
507         nxm_put_ip(b, cr,
508                    IPPROTO_ICMPV6, NXM_NX_ICMPV6_TYPE, NXM_NX_ICMPV6_CODE);
509
510         if (!(wc & FWW_IPV6_LABEL)) {
511             nxm_put_32(b, NXM_NX_IPV6_LABEL, flow->ipv6_label);
512         }
513
514         if (flow->nw_proto == IPPROTO_ICMPV6
515             && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
516                 flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
517             nxm_put_ipv6(b, NXM_NX_ND_TARGET, &flow->nd_target,
518                          &cr->wc.nd_target_mask);
519             if (!(wc & FWW_ARP_SHA)
520                 && flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
521                 nxm_put_eth(b, NXM_NX_ND_SLL, flow->arp_sha);
522             }
523             if (!(wc & FWW_ARP_THA)
524                 && flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
525                 nxm_put_eth(b, NXM_NX_ND_TLL, flow->arp_tha);
526             }
527         }
528     } else if (!(wc & FWW_DL_TYPE) && flow->dl_type == htons(ETH_TYPE_ARP)) {
529         /* ARP. */
530         if (!(wc & FWW_NW_PROTO)) {
531             nxm_put_16(b, NXM_OF_ARP_OP, htons(flow->nw_proto));
532         }
533         nxm_put_32m(b, NXM_OF_ARP_SPA, flow->nw_src, cr->wc.nw_src_mask);
534         nxm_put_32m(b, NXM_OF_ARP_TPA, flow->nw_dst, cr->wc.nw_dst_mask);
535         if (!(wc & FWW_ARP_SHA)) {
536             nxm_put_eth(b, NXM_NX_ARP_SHA, flow->arp_sha);
537         }
538         if (!(wc & FWW_ARP_THA)) {
539             nxm_put_eth(b, NXM_NX_ARP_THA, flow->arp_tha);
540         }
541     }
542
543     /* Tunnel ID. */
544     nxm_put_64m(b, NXM_NX_TUN_ID, flow->tun_id, cr->wc.tun_id_mask);
545
546     /* Registers. */
547     for (i = 0; i < FLOW_N_REGS; i++) {
548         nxm_put_32m(b, NXM_NX_REG(i),
549                     htonl(flow->regs[i]), htonl(cr->wc.reg_masks[i]));
550     }
551
552     /* Cookie. */
553     nxm_put_64m(b, NXM_NX_COOKIE, cookie, cookie_mask);
554
555     match_len = b->size - start_len;
556     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
557     return match_len;
558 }
559 \f
560 /* nx_match_to_string() and helpers. */
561
562 static void format_nxm_field_name(struct ds *, uint32_t header);
563
564 char *
565 nx_match_to_string(const uint8_t *p, unsigned int match_len)
566 {
567     uint32_t header;
568     struct ds s;
569
570     if (!match_len) {
571         return xstrdup("<any>");
572     }
573
574     ds_init(&s);
575     while ((header = nx_entry_ok(p, match_len)) != 0) {
576         unsigned int length = NXM_LENGTH(header);
577         unsigned int value_len = nxm_field_bytes(header);
578         const uint8_t *value = p + 4;
579         const uint8_t *mask = value + value_len;
580         unsigned int i;
581
582         if (s.length) {
583             ds_put_cstr(&s, ", ");
584         }
585
586         format_nxm_field_name(&s, header);
587         ds_put_char(&s, '(');
588
589         for (i = 0; i < value_len; i++) {
590             ds_put_format(&s, "%02x", value[i]);
591         }
592         if (NXM_HASMASK(header)) {
593             ds_put_char(&s, '/');
594             for (i = 0; i < value_len; i++) {
595                 ds_put_format(&s, "%02x", mask[i]);
596             }
597         }
598         ds_put_char(&s, ')');
599
600         p += 4 + length;
601         match_len -= 4 + length;
602     }
603
604     if (match_len) {
605         if (s.length) {
606             ds_put_cstr(&s, ", ");
607         }
608
609         ds_put_format(&s, "<%u invalid bytes>", match_len);
610     }
611
612     return ds_steal_cstr(&s);
613 }
614
615 static void
616 format_nxm_field_name(struct ds *s, uint32_t header)
617 {
618     const struct mf_field *mf = mf_from_nxm_header(header);
619     if (mf) {
620         ds_put_cstr(s, mf->nxm_name);
621         if (NXM_HASMASK(header)) {
622             ds_put_cstr(s, "_W");
623         }
624     } else if (header == NXM_NX_COOKIE) {
625         ds_put_cstr(s, "NXM_NX_COOKIE");
626     } else if (header == NXM_NX_COOKIE_W) {
627         ds_put_cstr(s, "NXM_NX_COOKIE_W");
628     } else {
629         ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
630     }
631 }
632
633 static uint32_t
634 parse_nxm_field_name(const char *name, int name_len)
635 {
636     bool wild;
637     int i;
638
639     /* Check whether it's a field name. */
640     wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
641     if (wild) {
642         name_len -= 2;
643     }
644
645     for (i = 0; i < MFF_N_IDS; i++) {
646         const struct mf_field *mf = mf_from_id(i);
647
648         if (mf->nxm_name
649             && !strncmp(mf->nxm_name, name, name_len)
650             && mf->nxm_name[name_len] == '\0') {
651             if (!wild) {
652                 return mf->nxm_header;
653             } else if (mf->maskable != MFM_NONE) {
654                 return NXM_MAKE_WILD_HEADER(mf->nxm_header);
655             }
656         }
657     }
658
659     if (!strncmp("NXM_NX_COOKIE", name, name_len)
660                 && (name_len == strlen("NXM_NX_COOKIE"))) {
661         if (!wild) {
662             return NXM_NX_COOKIE;
663         } else {
664             return NXM_NX_COOKIE_W;
665         }
666     }
667
668     /* Check whether it's a 32-bit field header value as hex.
669      * (This isn't ordinarily useful except for testing error behavior.) */
670     if (name_len == 8) {
671         uint32_t header = hexits_value(name, name_len, NULL);
672         if (header != UINT_MAX) {
673             return header;
674         }
675     }
676
677     return 0;
678 }
679 \f
680 /* nx_match_from_string(). */
681
682 int
683 nx_match_from_string(const char *s, struct ofpbuf *b)
684 {
685     const char *full_s = s;
686     const size_t start_len = b->size;
687     int match_len;
688
689     if (!strcmp(s, "<any>")) {
690         /* Ensure that 'b->data' isn't actually null. */
691         ofpbuf_prealloc_tailroom(b, 1);
692         return 0;
693     }
694
695     for (s += strspn(s, ", "); *s; s += strspn(s, ", ")) {
696         const char *name;
697         uint32_t header;
698         int name_len;
699         size_t n;
700
701         name = s;
702         name_len = strcspn(s, "(");
703         if (s[name_len] != '(') {
704             ovs_fatal(0, "%s: missing ( at end of nx_match", full_s);
705         }
706
707         header = parse_nxm_field_name(name, name_len);
708         if (!header) {
709             ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
710         }
711
712         s += name_len + 1;
713
714         nxm_put_header(b, header);
715         s = ofpbuf_put_hex(b, s, &n);
716         if (n != nxm_field_bytes(header)) {
717             ovs_fatal(0, "%.2s: hex digits expected", s);
718         }
719         if (NXM_HASMASK(header)) {
720             s += strspn(s, " ");
721             if (*s != '/') {
722                 ovs_fatal(0, "%s: missing / in masked field %.*s",
723                           full_s, name_len, name);
724             }
725             s = ofpbuf_put_hex(b, s + 1, &n);
726             if (n != nxm_field_bytes(header)) {
727                 ovs_fatal(0, "%.2s: hex digits expected", s);
728             }
729         }
730
731         s += strspn(s, " ");
732         if (*s != ')') {
733             ovs_fatal(0, "%s: missing ) following field %.*s",
734                       full_s, name_len, name);
735         }
736         s++;
737     }
738
739     match_len = b->size - start_len;
740     ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
741     return match_len;
742 }
743 \f
744 void
745 nxm_parse_reg_move(struct nx_action_reg_move *move, const char *s)
746 {
747     const char *full_s = s;
748     struct mf_subfield src, dst;
749
750     s = mf_parse_subfield(&src, s);
751     if (strncmp(s, "->", 2)) {
752         ovs_fatal(0, "%s: missing `->' following source", full_s);
753     }
754     s += 2;
755     s = mf_parse_subfield(&dst, s);
756     if (*s != '\0') {
757         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
758     }
759
760     if (src.n_bits != dst.n_bits) {
761         ovs_fatal(0, "%s: source field is %d bits wide but destination is "
762                   "%d bits wide", full_s, src.n_bits, dst.n_bits);
763     }
764
765     ofputil_init_NXAST_REG_MOVE(move);
766     move->n_bits = htons(src.n_bits);
767     move->src_ofs = htons(src.ofs);
768     move->dst_ofs = htons(dst.ofs);
769     move->src = htonl(src.field->nxm_header);
770     move->dst = htonl(dst.field->nxm_header);
771 }
772
773 void
774 nxm_parse_reg_load(struct nx_action_reg_load *load, const char *s)
775 {
776     const char *full_s = s;
777     struct mf_subfield dst;
778     uint64_t value;
779
780     value = strtoull(s, (char **) &s, 0);
781     if (strncmp(s, "->", 2)) {
782         ovs_fatal(0, "%s: missing `->' following value", full_s);
783     }
784     s += 2;
785     s = mf_parse_subfield(&dst, s);
786     if (*s != '\0') {
787         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
788     }
789
790     if (dst.n_bits < 64 && (value >> dst.n_bits) != 0) {
791         ovs_fatal(0, "%s: value %"PRIu64" does not fit into %u bits",
792                   full_s, value, dst.n_bits);
793     }
794
795     ofputil_init_NXAST_REG_LOAD(load);
796     load->ofs_nbits = nxm_encode_ofs_nbits(dst.ofs, dst.n_bits);
797     load->dst = htonl(dst.field->nxm_header);
798     load->value = htonll(value);
799 }
800 \f
801 /* nxm_format_reg_move(), nxm_format_reg_load(). */
802
803 void
804 nxm_format_reg_move(const struct nx_action_reg_move *move, struct ds *s)
805 {
806     struct mf_subfield src, dst;
807
808     nxm_decode_discrete(&src, move->src, move->src_ofs, move->n_bits);
809     nxm_decode_discrete(&dst, move->dst, move->dst_ofs, move->n_bits);
810
811     ds_put_format(s, "move:");
812     mf_format_subfield(&src, s);
813     ds_put_cstr(s, "->");
814     mf_format_subfield(&dst, s);
815 }
816
817 void
818 nxm_format_reg_load(const struct nx_action_reg_load *load, struct ds *s)
819 {
820     struct mf_subfield dst;
821
822     ds_put_format(s, "load:%#"PRIx64"->", ntohll(load->value));
823
824     nxm_decode(&dst, load->dst, load->ofs_nbits);
825     mf_format_subfield(&dst, s);
826 }
827 \f
828 /* nxm_check_reg_move(), nxm_check_reg_load(). */
829
830 enum ofperr
831 nxm_check_reg_move(const struct nx_action_reg_move *action,
832                    const struct flow *flow)
833 {
834     struct mf_subfield src;
835     struct mf_subfield dst;
836     int error;
837
838     nxm_decode_discrete(&src, action->src, action->src_ofs, action->n_bits);
839     error = mf_check_src(&src, flow);
840     if (error) {
841         return error;
842     }
843
844     nxm_decode_discrete(&dst, action->dst, action->dst_ofs, action->n_bits);
845     return mf_check_dst(&dst, flow);
846 }
847
848 enum ofperr
849 nxm_check_reg_load(const struct nx_action_reg_load *action,
850                    const struct flow *flow)
851 {
852     struct mf_subfield dst;
853     enum ofperr error;
854
855     nxm_decode(&dst, action->dst, action->ofs_nbits);
856     error = mf_check_dst(&dst, flow);
857     if (error) {
858         return error;
859     }
860
861     /* Reject 'action' if a bit numbered 'n_bits' or higher is set to 1 in
862      * action->value. */
863     if (dst.n_bits < 64 && ntohll(action->value) >> dst.n_bits) {
864         return OFPERR_OFPBAC_BAD_ARGUMENT;
865     }
866
867     return 0;
868 }
869 \f
870 /* nxm_execute_reg_move(), nxm_execute_reg_load(). */
871
872 void
873 nxm_execute_reg_move(const struct nx_action_reg_move *action,
874                      struct flow *flow)
875 {
876     struct mf_subfield src, dst;
877     union mf_value src_value;
878     union mf_value dst_value;
879
880     nxm_decode_discrete(&src, action->src, action->src_ofs, action->n_bits);
881     nxm_decode_discrete(&dst, action->dst, action->dst_ofs, action->n_bits);
882
883     mf_get_value(dst.field, flow, &dst_value);
884     mf_get_value(src.field, flow, &src_value);
885     bitwise_copy(&src_value, src.field->n_bytes, src.ofs,
886                  &dst_value, dst.field->n_bytes, dst.ofs,
887                  src.n_bits);
888     mf_set_flow_value(dst.field, &dst_value, flow);
889 }
890
891 void
892 nxm_execute_reg_load(const struct nx_action_reg_load *action,
893                      struct flow *flow)
894 {
895     struct mf_subfield dst;
896
897     nxm_decode(&dst, action->dst, action->ofs_nbits);
898     mf_set_subfield_value(&dst, ntohll(action->value), flow);
899 }
900
901 /* Initializes 'sf->field' with the field corresponding to the given NXM
902  * 'header' and 'sf->ofs' and 'sf->n_bits' decoded from 'ofs_nbits' with
903  * nxm_decode_ofs() and nxm_decode_n_bits(), respectively.
904  *
905  * Afterward, 'sf' might be invalid in a few different ways:
906  *
907  *   - 'sf->field' will be NULL if 'header' is unknown.
908  *
909  *   - 'sf->ofs' and 'sf->n_bits' might exceed the width of sf->field.
910  *
911  * The caller should call mf_check_src() or mf_check_dst() to check for these
912  * problems. */
913 void
914 nxm_decode(struct mf_subfield *sf, ovs_be32 header, ovs_be16 ofs_nbits)
915 {
916     sf->field = mf_from_nxm_header(ntohl(header));
917     sf->ofs = nxm_decode_ofs(ofs_nbits);
918     sf->n_bits = nxm_decode_n_bits(ofs_nbits);
919 }
920
921 /* Initializes 'sf->field' with the field corresponding to the given NXM
922  * 'header' and 'sf->ofs' and 'sf->n_bits' from 'ofs' and 'n_bits',
923  * respectively.
924  *
925  * Afterward, 'sf' might be invalid in a few different ways:
926  *
927  *   - 'sf->field' will be NULL if 'header' is unknown.
928  *
929  *   - 'sf->ofs' and 'sf->n_bits' might exceed the width of sf->field.
930  *
931  * The caller should call mf_check_src() or mf_check_dst() to check for these
932  * problems. */
933 void
934 nxm_decode_discrete(struct mf_subfield *sf, ovs_be32 header,
935                     ovs_be16 ofs, ovs_be16 n_bits)
936 {
937     sf->field = mf_from_nxm_header(ntohl(header));
938     sf->ofs = ntohs(ofs);
939     sf->n_bits = ntohs(n_bits);
940 }