tests: Add test suite for packets.h.
[openvswitch] / lib / ofp-parse.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 "ofp-parse.h"
20
21 #include <ctype.h>
22 #include <errno.h>
23 #include <stdlib.h>
24
25 #include "byte-order.h"
26 #include "dynamic-string.h"
27 #include "netdev.h"
28 #include "multipath.h"
29 #include "nx-match.h"
30 #include "ofp-util.h"
31 #include "ofpbuf.h"
32 #include "openflow/openflow.h"
33 #include "packets.h"
34 #include "socket-util.h"
35 #include "vconn.h"
36 #include "vlog.h"
37
38 VLOG_DEFINE_THIS_MODULE(ofp_parse);
39
40 static uint32_t
41 str_to_u32(const char *str)
42 {
43     char *tail;
44     uint32_t value;
45
46     if (!str) {
47         ovs_fatal(0, "missing required numeric argument");
48     }
49
50     errno = 0;
51     value = strtoul(str, &tail, 0);
52     if (errno == EINVAL || errno == ERANGE || *tail) {
53         ovs_fatal(0, "invalid numeric format %s", str);
54     }
55     return value;
56 }
57
58 static uint64_t
59 str_to_u64(const char *str)
60 {
61     char *tail;
62     uint64_t value;
63
64     errno = 0;
65     value = strtoull(str, &tail, 0);
66     if (errno == EINVAL || errno == ERANGE || *tail) {
67         ovs_fatal(0, "invalid numeric format %s", str);
68     }
69     return value;
70 }
71
72 static void
73 str_to_mac(const char *str, uint8_t mac[6])
74 {
75     if (sscanf(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
76         != ETH_ADDR_SCAN_COUNT) {
77         ovs_fatal(0, "invalid mac address %s", str);
78     }
79 }
80
81 static void
82 str_to_ip(const char *str_, ovs_be32 *ip, ovs_be32 *maskp)
83 {
84     char *str = xstrdup(str_);
85     char *save_ptr = NULL;
86     const char *name, *netmask;
87     struct in_addr in_addr;
88     ovs_be32 mask;
89     int retval;
90
91     name = strtok_r(str, "/", &save_ptr);
92     retval = name ? lookup_ip(name, &in_addr) : EINVAL;
93     if (retval) {
94         ovs_fatal(0, "%s: could not convert to IP address", str);
95     }
96     *ip = in_addr.s_addr;
97
98     netmask = strtok_r(NULL, "/", &save_ptr);
99     if (netmask) {
100         uint8_t o[4];
101         if (sscanf(netmask, "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8,
102                    &o[0], &o[1], &o[2], &o[3]) == 4) {
103             mask = htonl((o[0] << 24) | (o[1] << 16) | (o[2] << 8) | o[3]);
104         } else {
105             int prefix = atoi(netmask);
106             if (prefix <= 0 || prefix > 32) {
107                 ovs_fatal(0, "%s: network prefix bits not between 1 and 32",
108                           str);
109             } else if (prefix == 32) {
110                 mask = htonl(UINT32_MAX);
111             } else {
112                 mask = htonl(((1u << prefix) - 1) << (32 - prefix));
113             }
114         }
115     } else {
116         mask = htonl(UINT32_MAX);
117     }
118     *ip &= mask;
119
120     if (maskp) {
121         *maskp = mask;
122     } else {
123         if (mask != htonl(UINT32_MAX)) {
124             ovs_fatal(0, "%s: netmask not allowed here", str_);
125         }
126     }
127
128     free(str);
129 }
130
131 static void
132 str_to_tun_id(const char *str, ovs_be64 *tun_idp, ovs_be64 *maskp)
133 {
134     uint64_t tun_id, mask;
135     char *tail;
136
137     errno = 0;
138     tun_id = strtoull(str, &tail, 0);
139     if (errno || (*tail != '\0' && *tail != '/')) {
140         goto error;
141     }
142
143     if (*tail == '/') {
144         mask = strtoull(tail + 1, &tail, 0);
145         if (errno || *tail != '\0') {
146             goto error;
147         }
148     } else {
149         mask = UINT64_MAX;
150     }
151
152     *tun_idp = htonll(tun_id);
153     *maskp = htonll(mask);
154     return;
155
156 error:
157     ovs_fatal(0, "%s: bad syntax for tunnel id", str);
158 }
159
160 static void *
161 put_action(struct ofpbuf *b, size_t size, uint16_t type)
162 {
163     struct ofp_action_header *ah = ofpbuf_put_zeros(b, size);
164     ah->type = htons(type);
165     ah->len = htons(size);
166     return ah;
167 }
168
169 static struct ofp_action_output *
170 put_output_action(struct ofpbuf *b, uint16_t port)
171 {
172     struct ofp_action_output *oao = put_action(b, sizeof *oao, OFPAT_OUTPUT);
173     oao->port = htons(port);
174     return oao;
175 }
176
177 static void
178 put_enqueue_action(struct ofpbuf *b, uint16_t port, uint32_t queue)
179 {
180     struct ofp_action_enqueue *oae = put_action(b, sizeof *oae, OFPAT_ENQUEUE);
181     oae->port = htons(port);
182     oae->queue_id = htonl(queue);
183 }
184
185 static void
186 put_dl_addr_action(struct ofpbuf *b, uint16_t type, const char *addr)
187 {
188     struct ofp_action_dl_addr *oada = put_action(b, sizeof *oada, type);
189     str_to_mac(addr, oada->dl_addr);
190 }
191
192
193 static bool
194 parse_port_name(const char *name, uint16_t *port)
195 {
196     struct pair {
197         const char *name;
198         uint16_t value;
199     };
200     static const struct pair pairs[] = {
201 #define DEF_PAIR(NAME) {#NAME, OFPP_##NAME}
202         DEF_PAIR(IN_PORT),
203         DEF_PAIR(TABLE),
204         DEF_PAIR(NORMAL),
205         DEF_PAIR(FLOOD),
206         DEF_PAIR(ALL),
207         DEF_PAIR(CONTROLLER),
208         DEF_PAIR(LOCAL),
209         DEF_PAIR(NONE),
210 #undef DEF_PAIR
211     };
212     static const int n_pairs = ARRAY_SIZE(pairs);
213     size_t i;
214
215     for (i = 0; i < n_pairs; i++) {
216         if (!strcasecmp(name, pairs[i].name)) {
217             *port = pairs[i].value;
218             return true;
219         }
220     }
221     return false;
222 }
223
224 static void
225 str_to_action(char *str, struct ofpbuf *b)
226 {
227     bool drop = false;
228     int n_actions;
229     char *pos;
230
231     pos = str;
232     n_actions = 0;
233     for (;;) {
234         char *act, *arg;
235         size_t actlen;
236         uint16_t port;
237
238         pos += strspn(pos, ", \t\r\n");
239         if (*pos == '\0') {
240             break;
241         }
242
243         if (drop) {
244             ovs_fatal(0, "Drop actions must not be followed by other actions");
245         }
246
247         act = pos;
248         actlen = strcspn(pos, ":(, \t\r\n");
249         if (act[actlen] == ':') {
250             /* The argument can be separated by a colon. */
251             size_t arglen;
252
253             arg = act + actlen + 1;
254             arglen = strcspn(arg, ", \t\r\n");
255             pos = arg + arglen + (arg[arglen] != '\0');
256             arg[arglen] = '\0';
257         } else if (act[actlen] == '(') {
258             /* The argument can be surrounded by balanced parentheses.  The
259              * outermost set of parentheses is removed. */
260             int level = 1;
261             size_t arglen;
262
263             arg = act + actlen + 1;
264             for (arglen = 0; level > 0; arglen++) {
265                 switch (arg[arglen]) {
266                 case '\0':
267                     ovs_fatal(0, "unbalanced parentheses in argument to %s "
268                               "action", act);
269
270                 case '(':
271                     level++;
272                     break;
273
274                 case ')':
275                     level--;
276                     break;
277                 }
278             }
279             arg[arglen - 1] = '\0';
280             pos = arg + arglen;
281         } else {
282             /* There might be no argument at all. */
283             arg = NULL;
284             pos = act + actlen + (act[actlen] != '\0');
285         }
286         act[actlen] = '\0';
287
288         if (!strcasecmp(act, "mod_vlan_vid")) {
289             struct ofp_action_vlan_vid *va;
290             va = put_action(b, sizeof *va, OFPAT_SET_VLAN_VID);
291             va->vlan_vid = htons(str_to_u32(arg));
292         } else if (!strcasecmp(act, "mod_vlan_pcp")) {
293             struct ofp_action_vlan_pcp *va;
294             va = put_action(b, sizeof *va, OFPAT_SET_VLAN_PCP);
295             va->vlan_pcp = str_to_u32(arg);
296         } else if (!strcasecmp(act, "strip_vlan")) {
297             struct ofp_action_header *ah;
298             ah = put_action(b, sizeof *ah, OFPAT_STRIP_VLAN);
299             ah->type = htons(OFPAT_STRIP_VLAN);
300         } else if (!strcasecmp(act, "mod_dl_src")) {
301             put_dl_addr_action(b, OFPAT_SET_DL_SRC, arg);
302         } else if (!strcasecmp(act, "mod_dl_dst")) {
303             put_dl_addr_action(b, OFPAT_SET_DL_DST, arg);
304         } else if (!strcasecmp(act, "mod_nw_src")) {
305             struct ofp_action_nw_addr *na;
306             na = put_action(b, sizeof *na, OFPAT_SET_NW_SRC);
307             str_to_ip(arg, &na->nw_addr, NULL);
308         } else if (!strcasecmp(act, "mod_nw_dst")) {
309             struct ofp_action_nw_addr *na;
310             na = put_action(b, sizeof *na, OFPAT_SET_NW_DST);
311             str_to_ip(arg, &na->nw_addr, NULL);
312         } else if (!strcasecmp(act, "mod_tp_src")) {
313             struct ofp_action_tp_port *ta;
314             ta = put_action(b, sizeof *ta, OFPAT_SET_TP_SRC);
315             ta->tp_port = htons(str_to_u32(arg));
316         } else if (!strcasecmp(act, "mod_tp_dst")) {
317             struct ofp_action_tp_port *ta;
318             ta = put_action(b, sizeof *ta, OFPAT_SET_TP_DST);
319             ta->tp_port = htons(str_to_u32(arg));
320         } else if (!strcasecmp(act, "mod_nw_tos")) {
321             struct ofp_action_nw_tos *nt;
322             nt = put_action(b, sizeof *nt, OFPAT_SET_NW_TOS);
323             nt->nw_tos = str_to_u32(arg);
324         } else if (!strcasecmp(act, "resubmit")) {
325             struct nx_action_resubmit *nar;
326             nar = put_action(b, sizeof *nar, OFPAT_VENDOR);
327             nar->vendor = htonl(NX_VENDOR_ID);
328             nar->subtype = htons(NXAST_RESUBMIT);
329             nar->in_port = htons(str_to_u32(arg));
330         } else if (!strcasecmp(act, "set_tunnel")
331                    || !strcasecmp(act, "set_tunnel64")) {
332             uint64_t tun_id = str_to_u64(arg);
333             if (!strcasecmp(act, "set_tunnel64") || tun_id > UINT32_MAX) {
334                 struct nx_action_set_tunnel64 *nast64;
335                 nast64 = put_action(b, sizeof *nast64, OFPAT_VENDOR);
336                 nast64->vendor = htonl(NX_VENDOR_ID);
337                 nast64->subtype = htons(NXAST_SET_TUNNEL64);
338                 nast64->tun_id = htonll(tun_id);
339             } else {
340                 struct nx_action_set_tunnel *nast;
341                 nast = put_action(b, sizeof *nast, OFPAT_VENDOR);
342                 nast->vendor = htonl(NX_VENDOR_ID);
343                 nast->subtype = htons(NXAST_SET_TUNNEL);
344                 nast->tun_id = htonl(tun_id);
345             }
346         } else if (!strcasecmp(act, "drop_spoofed_arp")) {
347             struct nx_action_header *nah;
348             nah = put_action(b, sizeof *nah, OFPAT_VENDOR);
349             nah->vendor = htonl(NX_VENDOR_ID);
350             nah->subtype = htons(NXAST_DROP_SPOOFED_ARP);
351         } else if (!strcasecmp(act, "set_queue")) {
352             struct nx_action_set_queue *nasq;
353             nasq = put_action(b, sizeof *nasq, OFPAT_VENDOR);
354             nasq->vendor = htonl(NX_VENDOR_ID);
355             nasq->subtype = htons(NXAST_SET_QUEUE);
356             nasq->queue_id = htonl(str_to_u32(arg));
357         } else if (!strcasecmp(act, "pop_queue")) {
358             struct nx_action_header *nah;
359             nah = put_action(b, sizeof *nah, OFPAT_VENDOR);
360             nah->vendor = htonl(NX_VENDOR_ID);
361             nah->subtype = htons(NXAST_POP_QUEUE);
362         } else if (!strcasecmp(act, "note")) {
363             size_t start_ofs = b->size;
364             struct nx_action_note *nan;
365             int remainder;
366             size_t len;
367
368             nan = put_action(b, sizeof *nan, OFPAT_VENDOR);
369             nan->vendor = htonl(NX_VENDOR_ID);
370             nan->subtype = htons(NXAST_NOTE);
371
372             b->size -= sizeof nan->note;
373             while (arg && *arg != '\0') {
374                 uint8_t byte;
375                 bool ok;
376
377                 if (*arg == '.') {
378                     arg++;
379                 }
380                 if (*arg == '\0') {
381                     break;
382                 }
383
384                 byte = hexits_value(arg, 2, &ok);
385                 if (!ok) {
386                     ovs_fatal(0, "bad hex digit in `note' argument");
387                 }
388                 ofpbuf_put(b, &byte, 1);
389
390                 arg += 2;
391             }
392
393             len = b->size - start_ofs;
394             remainder = len % OFP_ACTION_ALIGN;
395             if (remainder) {
396                 ofpbuf_put_zeros(b, OFP_ACTION_ALIGN - remainder);
397             }
398             nan->len = htons(b->size - start_ofs);
399         } else if (!strcasecmp(act, "move")) {
400             struct nx_action_reg_move *move;
401             move = ofpbuf_put_uninit(b, sizeof *move);
402             nxm_parse_reg_move(move, arg);
403         } else if (!strcasecmp(act, "load")) {
404             struct nx_action_reg_load *load;
405             load = ofpbuf_put_uninit(b, sizeof *load);
406             nxm_parse_reg_load(load, arg);
407         } else if (!strcasecmp(act, "multipath")) {
408             struct nx_action_multipath *nam;
409             nam = ofpbuf_put_uninit(b, sizeof *nam);
410             multipath_parse(nam, arg);
411         } else if (!strcasecmp(act, "output")) {
412             put_output_action(b, str_to_u32(arg));
413         } else if (!strcasecmp(act, "enqueue")) {
414             char *sp = NULL;
415             char *port_s = strtok_r(arg, ":q", &sp);
416             char *queue = strtok_r(NULL, "", &sp);
417             if (port_s == NULL || queue == NULL) {
418                 ovs_fatal(0, "\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
419             }
420             put_enqueue_action(b, str_to_u32(port_s), str_to_u32(queue));
421         } else if (!strcasecmp(act, "drop")) {
422             /* A drop action in OpenFlow occurs by just not setting
423              * an action. */
424             drop = true;
425             if (n_actions) {
426                 ovs_fatal(0, "Drop actions must not be preceded by other "
427                           "actions");
428             }
429         } else if (!strcasecmp(act, "CONTROLLER")) {
430             struct ofp_action_output *oao;
431             oao = put_output_action(b, OFPP_CONTROLLER);
432
433             /* Unless a numeric argument is specified, we send the whole
434              * packet to the controller. */
435             if (arg && (strspn(arg, "0123456789") == strlen(arg))) {
436                oao->max_len = htons(str_to_u32(arg));
437             } else {
438                 oao->max_len = htons(UINT16_MAX);
439             }
440         } else if (parse_port_name(act, &port)) {
441             put_output_action(b, port);
442         } else if (strspn(act, "0123456789") == strlen(act)) {
443             put_output_action(b, str_to_u32(act));
444         } else {
445             ovs_fatal(0, "Unknown action: %s", act);
446         }
447         n_actions++;
448     }
449 }
450
451 struct protocol {
452     const char *name;
453     uint16_t dl_type;
454     uint8_t nw_proto;
455 };
456
457 static bool
458 parse_protocol(const char *name, const struct protocol **p_out)
459 {
460     static const struct protocol protocols[] = {
461         { "ip", ETH_TYPE_IP, 0 },
462         { "arp", ETH_TYPE_ARP, 0 },
463         { "icmp", ETH_TYPE_IP, IP_TYPE_ICMP },
464         { "tcp", ETH_TYPE_IP, IP_TYPE_TCP },
465         { "udp", ETH_TYPE_IP, IP_TYPE_UDP },
466     };
467     const struct protocol *p;
468
469     for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
470         if (!strcmp(p->name, name)) {
471             *p_out = p;
472             return true;
473         }
474     }
475     *p_out = NULL;
476     return false;
477 }
478
479 #define FIELDS                                              \
480     FIELD(F_TUN_ID,      "tun_id",      0)                  \
481     FIELD(F_IN_PORT,     "in_port",     FWW_IN_PORT)        \
482     FIELD(F_DL_VLAN,     "dl_vlan",     0)                  \
483     FIELD(F_DL_VLAN_PCP, "dl_vlan_pcp", 0)                  \
484     FIELD(F_DL_SRC,      "dl_src",      FWW_DL_SRC)         \
485     FIELD(F_DL_DST,      "dl_dst",      FWW_DL_DST)         \
486     FIELD(F_DL_TYPE,     "dl_type",     FWW_DL_TYPE)        \
487     FIELD(F_NW_SRC,      "nw_src",      0)                  \
488     FIELD(F_NW_DST,      "nw_dst",      0)                  \
489     FIELD(F_NW_PROTO,    "nw_proto",    FWW_NW_PROTO)       \
490     FIELD(F_NW_TOS,      "nw_tos",      FWW_NW_TOS)         \
491     FIELD(F_TP_SRC,      "tp_src",      FWW_TP_SRC)         \
492     FIELD(F_TP_DST,      "tp_dst",      FWW_TP_DST)         \
493     FIELD(F_ICMP_TYPE,   "icmp_type",   FWW_TP_SRC)         \
494     FIELD(F_ICMP_CODE,   "icmp_code",   FWW_TP_DST)
495
496 enum field_index {
497 #define FIELD(ENUM, NAME, WILDCARD) ENUM,
498     FIELDS
499 #undef FIELD
500     N_FIELDS
501 };
502
503 struct field {
504     enum field_index index;
505     const char *name;
506     flow_wildcards_t wildcard;  /* FWW_* bit. */
507 };
508
509 static bool
510 parse_field_name(const char *name, const struct field **f_out)
511 {
512     static const struct field fields[N_FIELDS] = {
513 #define FIELD(ENUM, NAME, WILDCARD) { ENUM, NAME, WILDCARD },
514         FIELDS
515 #undef FIELD
516     };
517     const struct field *f;
518
519     for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
520         if (!strcmp(f->name, name)) {
521             *f_out = f;
522             return true;
523         }
524     }
525     *f_out = NULL;
526     return false;
527 }
528
529 static void
530 parse_field_value(struct cls_rule *rule, enum field_index index,
531                   const char *value)
532 {
533     uint8_t mac[ETH_ADDR_LEN];
534     ovs_be64 tun_id, tun_mask;
535     ovs_be32 ip, mask;
536     uint16_t port_no;
537
538     switch (index) {
539     case F_TUN_ID:
540         str_to_tun_id(value, &tun_id, &tun_mask);
541         cls_rule_set_tun_id_masked(rule, tun_id, tun_mask);
542         break;
543
544     case F_IN_PORT:
545         if (!parse_port_name(value, &port_no)) {
546             port_no = atoi(value);
547         }
548         if (port_no == OFPP_LOCAL) {
549             port_no = ODPP_LOCAL;
550         }
551         cls_rule_set_in_port(rule, port_no);
552         break;
553
554     case F_DL_VLAN:
555         cls_rule_set_dl_vlan(rule, htons(str_to_u32(value)));
556         break;
557
558     case F_DL_VLAN_PCP:
559         cls_rule_set_dl_vlan_pcp(rule, str_to_u32(value));
560         break;
561
562     case F_DL_SRC:
563         str_to_mac(value, mac);
564         cls_rule_set_dl_src(rule, mac);
565         break;
566
567     case F_DL_DST:
568         str_to_mac(value, mac);
569         cls_rule_set_dl_dst(rule, mac);
570         break;
571
572     case F_DL_TYPE:
573         cls_rule_set_dl_type(rule, htons(str_to_u32(value)));
574         break;
575
576     case F_NW_SRC:
577         str_to_ip(value, &ip, &mask);
578         cls_rule_set_nw_src_masked(rule, ip, mask);
579         break;
580
581     case F_NW_DST:
582         str_to_ip(value, &ip, &mask);
583         cls_rule_set_nw_dst_masked(rule, ip, mask);
584         break;
585
586     case F_NW_PROTO:
587         cls_rule_set_nw_proto(rule, str_to_u32(value));
588         break;
589
590     case F_NW_TOS:
591         cls_rule_set_nw_tos(rule, str_to_u32(value));
592         break;
593
594     case F_TP_SRC:
595         cls_rule_set_tp_src(rule, htons(str_to_u32(value)));
596         break;
597
598     case F_TP_DST:
599         cls_rule_set_tp_dst(rule, htons(str_to_u32(value)));
600         break;
601
602     case F_ICMP_TYPE:
603         cls_rule_set_icmp_type(rule, str_to_u32(value));
604         break;
605
606     case F_ICMP_CODE:
607         cls_rule_set_icmp_code(rule, str_to_u32(value));
608         break;
609
610     case N_FIELDS:
611         NOT_REACHED();
612     }
613 }
614
615 static void
616 parse_reg_value(struct cls_rule *rule, int reg_idx, const char *value)
617 {
618     uint32_t reg_value, reg_mask;
619
620     if (!strcmp(value, "ANY") || !strcmp(value, "*")) {
621         cls_rule_set_reg_masked(rule, reg_idx, 0, 0);
622     } else if (sscanf(value, "%"SCNi32"/%"SCNi32,
623                       &reg_value, &reg_mask) == 2) {
624         cls_rule_set_reg_masked(rule, reg_idx, reg_value, reg_mask);
625     } else if (sscanf(value, "%"SCNi32, &reg_value)) {
626         cls_rule_set_reg(rule, reg_idx, reg_value);
627     } else {
628         ovs_fatal(0, "register fields must take the form <value> "
629                   "or <value>/<mask>");
630     }
631 }
632
633 /* Convert 'string' (as described in the Flow Syntax section of the ovs-ofctl
634  * man page) into 'pf'.  If 'actions' is specified, an action must be in
635  * 'string' and may be expanded or reallocated. */
636 static void
637 parse_ofp_str(struct flow_mod *fm, uint8_t *table_idx,
638               struct ofpbuf *actions, char *string)
639 {
640     char *save_ptr = NULL;
641     char *name;
642
643     if (table_idx) {
644         *table_idx = 0xff;
645     }
646     cls_rule_init_catchall(&fm->cr, OFP_DEFAULT_PRIORITY);
647     fm->cookie = htonll(0);
648     fm->command = UINT16_MAX;
649     fm->idle_timeout = OFP_FLOW_PERMANENT;
650     fm->hard_timeout = OFP_FLOW_PERMANENT;
651     fm->buffer_id = UINT32_MAX;
652     fm->out_port = OFPP_NONE;
653     fm->flags = 0;
654     if (actions) {
655         char *act_str = strstr(string, "action");
656         if (!act_str) {
657             ovs_fatal(0, "must specify an action");
658         }
659         *act_str = '\0';
660
661         act_str = strchr(act_str + 1, '=');
662         if (!act_str) {
663             ovs_fatal(0, "must specify an action");
664         }
665
666         act_str++;
667
668         str_to_action(act_str, actions);
669         fm->actions = actions->data;
670         fm->n_actions = actions->size / sizeof(union ofp_action);
671     } else {
672         fm->actions = NULL;
673         fm->n_actions = 0;
674     }
675     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
676          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
677         const struct protocol *p;
678
679         if (parse_protocol(name, &p)) {
680             cls_rule_set_dl_type(&fm->cr, htons(p->dl_type));
681             if (p->nw_proto) {
682                 cls_rule_set_nw_proto(&fm->cr, p->nw_proto);
683             }
684         } else {
685             const struct field *f;
686             char *value;
687
688             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
689             if (!value) {
690                 ovs_fatal(0, "field %s missing value", name);
691             }
692
693             if (table_idx && !strcmp(name, "table")) {
694                 *table_idx = atoi(value);
695             } else if (!strcmp(name, "out_port")) {
696                 fm->out_port = atoi(value);
697             } else if (!strcmp(name, "priority")) {
698                 fm->cr.priority = atoi(value);
699             } else if (!strcmp(name, "idle_timeout")) {
700                 fm->idle_timeout = atoi(value);
701             } else if (!strcmp(name, "hard_timeout")) {
702                 fm->hard_timeout = atoi(value);
703             } else if (!strcmp(name, "cookie")) {
704                 fm->cookie = htonll(str_to_u64(value));
705             } else if (parse_field_name(name, &f)) {
706                 if (!strcmp(value, "*") || !strcmp(value, "ANY")) {
707                     if (f->wildcard) {
708                         fm->cr.wc.wildcards |= f->wildcard;
709                         cls_rule_zero_wildcarded_fields(&fm->cr);
710                     } else if (f->index == F_NW_SRC) {
711                         cls_rule_set_nw_src_masked(&fm->cr, 0, 0);
712                     } else if (f->index == F_NW_DST) {
713                         cls_rule_set_nw_dst_masked(&fm->cr, 0, 0);
714                     } else if (f->index == F_DL_VLAN) {
715                         cls_rule_set_any_vid(&fm->cr);
716                     } else if (f->index == F_DL_VLAN_PCP) {
717                         cls_rule_set_any_pcp(&fm->cr);
718                     } else {
719                         NOT_REACHED();
720                     }
721                 } else {
722                     parse_field_value(&fm->cr, f->index, value);
723                 }
724             } else if (!strncmp(name, "reg", 3) && isdigit(name[3])) {
725                 unsigned int reg_idx = atoi(name + 3);
726                 if (reg_idx >= FLOW_N_REGS) {
727                     ovs_fatal(0, "only %d registers supported", FLOW_N_REGS);
728                 }
729                 parse_reg_value(&fm->cr, reg_idx, value);
730             } else {
731                 ovs_fatal(0, "unknown keyword %s", name);
732             }
733         }
734     }
735 }
736
737 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
738  * (one of OFPFC_*) and appends the parsed OpenFlow message to 'packets'.
739  * '*cur_format' should initially contain the flow format currently configured
740  * on the connection; this function will add a message to change the flow
741  * format and update '*cur_format', if this is necessary to add the parsed
742  * flow. */
743 void
744 parse_ofp_flow_mod_str(struct list *packets, enum nx_flow_format *cur_format,
745                        char *string, uint16_t command)
746 {
747     bool is_del = command == OFPFC_DELETE || command == OFPFC_DELETE_STRICT;
748     enum nx_flow_format min_format, next_format;
749     struct ofpbuf actions;
750     struct ofpbuf *ofm;
751     struct flow_mod fm;
752
753     ofpbuf_init(&actions, 64);
754     parse_ofp_str(&fm, NULL, is_del ? NULL : &actions, string);
755     fm.command = command;
756
757     min_format = ofputil_min_flow_format(&fm.cr, true, fm.cookie);
758     next_format = MAX(*cur_format, min_format);
759     if (next_format != *cur_format) {
760         struct ofpbuf *sff = ofputil_make_set_flow_format(next_format);
761         list_push_back(packets, &sff->list_node);
762         *cur_format = next_format;
763     }
764
765     ofm = ofputil_encode_flow_mod(&fm, *cur_format);
766     list_push_back(packets, &ofm->list_node);
767
768     ofpbuf_uninit(&actions);
769 }
770
771 /* Similar to parse_ofp_flow_mod_str(), except that the string is read from
772  * 'stream' and the command is always OFPFC_ADD.  Returns false if end-of-file
773  * is reached before reading a flow, otherwise true. */
774 bool
775 parse_ofp_add_flow_file(struct list *packets, enum nx_flow_format *cur,
776                         FILE *stream)
777 {
778     struct ds s = DS_EMPTY_INITIALIZER;
779     bool ok = false;
780
781     while (!ds_get_line(&s, stream)) {
782         char *line = ds_cstr(&s);
783         char *comment;
784
785         /* Delete comments. */
786         comment = strchr(line, '#');
787         if (comment) {
788             *comment = '\0';
789         }
790
791         /* Drop empty lines. */
792         if (line[strspn(line, " \t\n")] == '\0') {
793             continue;
794         }
795
796         parse_ofp_flow_mod_str(packets, cur, line, OFPFC_ADD);
797         ok = true;
798         break;
799     }
800     ds_destroy(&s);
801
802     return ok;
803 }
804
805 void
806 parse_ofp_flow_stats_request_str(struct flow_stats_request *fsr,
807                                  bool aggregate, char *string)
808 {
809     struct flow_mod fm;
810     uint8_t table_id;
811
812     parse_ofp_str(&fm, &table_id, NULL, string);
813     fsr->aggregate = aggregate;
814     fsr->match = fm.cr;
815     fsr->out_port = fm.out_port;
816     fsr->table_id = table_id;
817 }
818