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