ovs-ofctl: Document that all actions are supported now.
[sliver-openvswitch.git] / utilities / ovs-ofctl.c
1 /*
2  * Copyright (c) 2008, 2009, 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 #include <errno.h>
19 #include <getopt.h>
20 #include <inttypes.h>
21 #include <sys/socket.h>
22 #include <net/if.h>
23 #include <signal.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <unistd.h>
27 #include <sys/stat.h>
28 #include <sys/time.h>
29
30 #include "byte-order.h"
31 #include "classifier.h"
32 #include "command-line.h"
33 #include "compiler.h"
34 #include "dirs.h"
35 #include "dynamic-string.h"
36 #include "netlink.h"
37 #include "nx-match.h"
38 #include "odp-util.h"
39 #include "ofp-parse.h"
40 #include "ofp-print.h"
41 #include "ofp-util.h"
42 #include "ofpbuf.h"
43 #include "ofproto/ofproto.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
46 #include "random.h"
47 #include "stream-ssl.h"
48 #include "timeval.h"
49 #include "util.h"
50 #include "vconn.h"
51 #include "vlog.h"
52
53 VLOG_DEFINE_THIS_MODULE(ofctl);
54
55 /* --strict: Use strict matching for flow mod commands? */
56 static bool strict;
57
58 /* --readd: If ture, on replace-flows, re-add even flows that have not changed
59  * (to reset flow counters). */
60 static bool readd;
61
62 /* -F, --flow-format: Flow format to use.  Either one of NXFF_* to force a
63  * particular flow format or -1 to let ovs-ofctl choose intelligently. */
64 static int preferred_flow_format = -1;
65
66 /* -m, --more: Additional verbosity for ofp-print functions. */
67 static int verbosity;
68
69 static const struct command all_commands[];
70
71 static void usage(void) NO_RETURN;
72 static void parse_options(int argc, char *argv[]);
73
74 int
75 main(int argc, char *argv[])
76 {
77     set_program_name(argv[0]);
78     parse_options(argc, argv);
79     signal(SIGPIPE, SIG_IGN);
80     run_command(argc - optind, argv + optind, all_commands);
81     return 0;
82 }
83
84 static void
85 parse_options(int argc, char *argv[])
86 {
87     enum {
88         OPT_STRICT = UCHAR_MAX + 1,
89         OPT_READD,
90         VLOG_OPTION_ENUMS
91     };
92     static struct option long_options[] = {
93         {"timeout", required_argument, NULL, 't'},
94         {"strict", no_argument, NULL, OPT_STRICT},
95         {"readd", no_argument, NULL, OPT_READD},
96         {"flow-format", required_argument, NULL, 'F'},
97         {"more", no_argument, NULL, 'm'},
98         {"help", no_argument, NULL, 'h'},
99         {"version", no_argument, NULL, 'V'},
100         VLOG_LONG_OPTIONS,
101         STREAM_SSL_LONG_OPTIONS,
102         {NULL, 0, NULL, 0},
103     };
104     char *short_options = long_options_to_short_options(long_options);
105
106     for (;;) {
107         unsigned long int timeout;
108         int c;
109
110         c = getopt_long(argc, argv, short_options, long_options, NULL);
111         if (c == -1) {
112             break;
113         }
114
115         switch (c) {
116         case 't':
117             timeout = strtoul(optarg, NULL, 10);
118             if (timeout <= 0) {
119                 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
120                           optarg);
121             } else {
122                 time_alarm(timeout);
123             }
124             break;
125
126         case 'F':
127             preferred_flow_format = ofputil_flow_format_from_string(optarg);
128             if (preferred_flow_format < 0) {
129                 ovs_fatal(0, "unknown flow format `%s'", optarg);
130             }
131             break;
132
133         case 'm':
134             verbosity++;
135             break;
136
137         case 'h':
138             usage();
139
140         case 'V':
141             ovs_print_version(OFP_VERSION, OFP_VERSION);
142             exit(EXIT_SUCCESS);
143
144         case OPT_STRICT:
145             strict = true;
146             break;
147
148         case OPT_READD:
149             readd = true;
150             break;
151
152         VLOG_OPTION_HANDLERS
153         STREAM_SSL_OPTION_HANDLERS
154
155         case '?':
156             exit(EXIT_FAILURE);
157
158         default:
159             abort();
160         }
161     }
162     free(short_options);
163 }
164
165 static void
166 usage(void)
167 {
168     printf("%s: OpenFlow switch management utility\n"
169            "usage: %s [OPTIONS] COMMAND [ARG...]\n"
170            "\nFor OpenFlow switches:\n"
171            "  show SWITCH                 show OpenFlow information\n"
172            "  dump-desc SWITCH            print switch description\n"
173            "  dump-tables SWITCH          print table stats\n"
174            "  mod-port SWITCH IFACE ACT   modify port behavior\n"
175            "  dump-ports SWITCH [PORT]    print port statistics\n"
176            "  dump-flows SWITCH           print all flow entries\n"
177            "  dump-flows SWITCH FLOW      print matching FLOWs\n"
178            "  dump-aggregate SWITCH       print aggregate flow statistics\n"
179            "  dump-aggregate SWITCH FLOW  print aggregate stats for FLOWs\n"
180            "  queue-stats SWITCH [PORT [QUEUE]]  dump queue stats\n"
181            "  add-flow SWITCH FLOW        add flow described by FLOW\n"
182            "  add-flows SWITCH FILE       add flows from FILE\n"
183            "  mod-flows SWITCH FLOW       modify actions of matching FLOWs\n"
184            "  del-flows SWITCH [FLOW]     delete matching FLOWs\n"
185            "  replace-flows SWITCH FILE   replace flows with those in FILE\n"
186            "  monitor SWITCH [MISSLEN]    print packets received from SWITCH\n"
187            "\nFor OpenFlow switches and controllers:\n"
188            "  probe VCONN                 probe whether VCONN is up\n"
189            "  ping VCONN [N]              latency of N-byte echos\n"
190            "  benchmark VCONN N COUNT     bandwidth of COUNT N-byte echos\n"
191            "where each SWITCH is an active OpenFlow connection method.\n",
192            program_name, program_name);
193     vconn_usage(true, false, false);
194     vlog_usage();
195     printf("\nOther options:\n"
196            "  --strict                    use strict match for flow commands\n"
197            "  --readd                     replace flows that haven't changed\n"
198            "  -F, --flow-format=FORMAT    force particular flow format\n"
199            "  -m, --more                  be more verbose printing OpenFlow\n"
200            "  -t, --timeout=SECS          give up after SECS seconds\n"
201            "  -h, --help                  display this help message\n"
202            "  -V, --version               display version information\n");
203     exit(EXIT_SUCCESS);
204 }
205
206 static void run(int retval, const char *message, ...)
207     PRINTF_FORMAT(2, 3);
208
209 static void run(int retval, const char *message, ...)
210 {
211     if (retval) {
212         va_list args;
213
214         va_start(args, message);
215         ovs_fatal_valist(retval, message, args);
216     }
217 }
218 \f
219 /* Generic commands. */
220
221 static void
222 open_vconn_socket(const char *name, struct vconn **vconnp)
223 {
224     char *vconn_name = xasprintf("unix:%s", name);
225     VLOG_DBG("connecting to %s", vconn_name);
226     run(vconn_open_block(vconn_name, OFP_VERSION, vconnp),
227         "connecting to %s", vconn_name);
228     free(vconn_name);
229 }
230
231 static void
232 open_vconn__(const char *name, const char *default_suffix,
233              struct vconn **vconnp)
234 {
235     char *datapath_name, *datapath_type, *socket_name;
236     char *bridge_path;
237     struct stat s;
238
239     bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, default_suffix);
240
241     ofproto_parse_name(name, &datapath_name, &datapath_type);
242     socket_name = xasprintf("%s/%s.%s",
243                             ovs_rundir(), datapath_name, default_suffix);
244     free(datapath_name);
245     free(datapath_type);
246
247     if (strchr(name, ':')) {
248         run(vconn_open_block(name, OFP_VERSION, vconnp),
249             "connecting to %s", name);
250     } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
251         open_vconn_socket(name, vconnp);
252     } else if (!stat(bridge_path, &s) && S_ISSOCK(s.st_mode)) {
253         open_vconn_socket(bridge_path, vconnp);
254     } else if (!stat(socket_name, &s)) {
255         if (!S_ISSOCK(s.st_mode)) {
256             ovs_fatal(0, "cannot connect to %s: %s is not a socket",
257                       name, socket_name);
258         }
259         open_vconn_socket(socket_name, vconnp);
260     } else {
261         ovs_fatal(0, "%s is not a bridge or a socket", name);
262     }
263
264     free(bridge_path);
265     free(socket_name);
266 }
267
268 static void
269 open_vconn(const char *name, struct vconn **vconnp)
270 {
271     return open_vconn__(name, "mgmt", vconnp);
272 }
273
274 static void *
275 alloc_stats_request(size_t rq_len, uint16_t type, struct ofpbuf **bufferp)
276 {
277     struct ofp_stats_msg *rq;
278
279     rq = make_openflow(rq_len, OFPT_STATS_REQUEST, bufferp);
280     rq->type = htons(type);
281     rq->flags = htons(0);
282     return rq;
283 }
284
285 static void
286 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
287 {
288     update_openflow_length(buffer);
289     run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
290 }
291
292 static void
293 dump_transaction(const char *vconn_name, struct ofpbuf *request)
294 {
295     struct vconn *vconn;
296     struct ofpbuf *reply;
297
298     update_openflow_length(request);
299     open_vconn(vconn_name, &vconn);
300     run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
301     ofp_print(stdout, reply->data, reply->size, verbosity + 1);
302     vconn_close(vconn);
303 }
304
305 static void
306 dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
307 {
308     struct ofpbuf *request;
309     make_openflow(sizeof(struct ofp_header), request_type, &request);
310     dump_transaction(vconn_name, request);
311 }
312
313 static void
314 dump_stats_transaction(const char *vconn_name, struct ofpbuf *request)
315 {
316     ovs_be32 send_xid = ((struct ofp_header *) request->data)->xid;
317     struct vconn *vconn;
318     bool done = false;
319
320     open_vconn(vconn_name, &vconn);
321     send_openflow_buffer(vconn, request);
322     while (!done) {
323         ovs_be32 recv_xid;
324         struct ofpbuf *reply;
325
326         run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
327         recv_xid = ((struct ofp_header *) reply->data)->xid;
328         if (send_xid == recv_xid) {
329             struct ofp_stats_msg *osm;
330
331             ofp_print(stdout, reply->data, reply->size, verbosity + 1);
332
333             osm = ofpbuf_at(reply, 0, sizeof *osm);
334             done = !osm || !(ntohs(osm->flags) & OFPSF_REPLY_MORE);
335         } else {
336             VLOG_DBG("received reply with xid %08"PRIx32" "
337                      "!= expected %08"PRIx32, recv_xid, send_xid);
338         }
339         ofpbuf_delete(reply);
340     }
341     vconn_close(vconn);
342 }
343
344 static void
345 dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
346 {
347     struct ofpbuf *request;
348     alloc_stats_request(sizeof(struct ofp_stats_msg), stats_type, &request);
349     dump_stats_transaction(vconn_name, request);
350 }
351
352 /* Sends 'request', which should be a request that only has a reply if an error
353  * occurs, and waits for it to succeed or fail.  If an error does occur, prints
354  * it and exits with an error. */
355 static void
356 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
357 {
358     struct ofpbuf *request, *reply;
359
360     LIST_FOR_EACH (request, list_node, requests) {
361         update_openflow_length(request);
362     }
363
364     run(vconn_transact_multiple_noreply(vconn, requests, &reply),
365         "talking to %s", vconn_get_name(vconn));
366     if (reply) {
367         ofp_print(stderr, reply->data, reply->size, verbosity + 2);
368         exit(1);
369     }
370     ofpbuf_delete(reply);
371 }
372
373 /* Sends 'request', which should be a request that only has a reply if an error
374  * occurs, and waits for it to succeed or fail.  If an error does occur, prints
375  * it and exits with an error. */
376 static void
377 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
378 {
379     struct list requests;
380
381     list_init(&requests);
382     list_push_back(&requests, &request->list_node);
383     transact_multiple_noreply(vconn, &requests);
384 }
385
386 static void
387 do_show(int argc OVS_UNUSED, char *argv[])
388 {
389     dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
390     dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
391 }
392
393 static void
394 do_dump_desc(int argc OVS_UNUSED, char *argv[])
395 {
396     dump_trivial_stats_transaction(argv[1], OFPST_DESC);
397 }
398
399 static void
400 do_dump_tables(int argc OVS_UNUSED, char *argv[])
401 {
402     dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
403 }
404
405 /* Opens a connection to 'vconn_name', fetches the ofp_phy_port structure for
406  * 'port_name' (which may be a port name or number), and copies it into
407  * '*oppp'. */
408 static void
409 fetch_ofp_phy_port(const char *vconn_name, const char *port_name,
410                    struct ofp_phy_port *oppp)
411 {
412     struct ofpbuf *request, *reply;
413     struct ofp_switch_features *osf;
414     unsigned int port_no;
415     struct vconn *vconn;
416     int n_ports;
417     int port_idx;
418
419     /* Try to interpret the argument as a port number. */
420     if (!str_to_uint(port_name, 10, &port_no)) {
421         port_no = UINT_MAX;
422     }
423
424     /* Fetch the switch's ofp_switch_features. */
425     make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
426     open_vconn(vconn_name, &vconn);
427     run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
428
429     osf = reply->data;
430     if (reply->size < sizeof *osf) {
431         ovs_fatal(0, "%s: received too-short features reply (only %zu bytes)",
432                   vconn_name, reply->size);
433     }
434     n_ports = (reply->size - sizeof *osf) / sizeof *osf->ports;
435
436     for (port_idx = 0; port_idx < n_ports; port_idx++) {
437         const struct ofp_phy_port *opp = &osf->ports[port_idx];
438
439         if (port_no != UINT_MAX
440             ? htons(port_no) == opp->port_no
441             : !strncmp(opp->name, port_name, sizeof opp->name)) {
442             *oppp = *opp;
443             ofpbuf_delete(reply);
444             vconn_close(vconn);
445             return;
446         }
447     }
448     ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
449 }
450
451 /* Returns the port number corresponding to 'port_name' (which may be a port
452  * name or number) within the switch 'vconn_name'. */
453 static uint16_t
454 str_to_port_no(const char *vconn_name, const char *port_name)
455 {
456     unsigned int port_no;
457
458     if (str_to_uint(port_name, 10, &port_no)) {
459         return port_no;
460     } else {
461         struct ofp_phy_port opp;
462
463         fetch_ofp_phy_port(vconn_name, port_name, &opp);
464         return ntohs(opp.port_no);
465     }
466 }
467
468 static bool
469 try_set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
470 {
471     struct ofpbuf *sff, *reply;
472
473     sff = ofputil_make_set_flow_format(flow_format);
474     run(vconn_transact_noreply(vconn, sff, &reply),
475         "talking to %s", vconn_get_name(vconn));
476     if (reply) {
477         char *s = ofp_to_string(reply->data, reply->size, 2);
478         VLOG_DBG("%s: failed to set flow format %s, controller replied: %s",
479                  vconn_get_name(vconn),
480                  ofputil_flow_format_to_string(flow_format),
481                  s);
482         free(s);
483         ofpbuf_delete(reply);
484         return false;
485     }
486     return true;
487 }
488
489 static void
490 set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
491 {
492     struct ofpbuf *sff = ofputil_make_set_flow_format(flow_format);
493     transact_noreply(vconn, sff);
494     VLOG_DBG("%s: using user-specified flow format %s",
495              vconn_get_name(vconn),
496              ofputil_flow_format_to_string(flow_format));
497 }
498
499 static enum nx_flow_format
500 negotiate_highest_flow_format(struct vconn *vconn,
501                               enum nx_flow_format min_format)
502 {
503     if (preferred_flow_format != -1) {
504         if (preferred_flow_format < min_format) {
505             ovs_fatal(0, "%s: cannot use requested flow format %s for "
506                       "specified flow", vconn_get_name(vconn),
507                       ofputil_flow_format_to_string(min_format));
508         }
509
510         set_flow_format(vconn, preferred_flow_format);
511         return preferred_flow_format;
512     } else {
513         enum nx_flow_format flow_format;
514
515         if (try_set_flow_format(vconn, NXFF_NXM)) {
516             flow_format = NXFF_NXM;
517         } else {
518             flow_format = NXFF_OPENFLOW10;
519         }
520
521         if (flow_format < min_format) {
522             ovs_fatal(0, "%s: cannot use switch's most advanced flow format "
523                       "%s for specified flow", vconn_get_name(vconn),
524                       ofputil_flow_format_to_string(min_format));
525         }
526
527         VLOG_DBG("%s: negotiated flow format %s", vconn_get_name(vconn),
528                  ofputil_flow_format_to_string(flow_format));
529         return flow_format;
530     }
531 }
532
533 static void
534 do_dump_flows__(int argc, char *argv[], bool aggregate)
535 {
536     enum nx_flow_format min_flow_format, flow_format;
537     struct ofputil_flow_stats_request fsr;
538     struct ofpbuf *request;
539     struct vconn *vconn;
540
541     parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
542
543     open_vconn(argv[1], &vconn);
544     min_flow_format = ofputil_min_flow_format(&fsr.match);
545     flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
546     request = ofputil_encode_flow_stats_request(&fsr, flow_format);
547     dump_stats_transaction(argv[1], request);
548     vconn_close(vconn);
549 }
550
551 static void
552 do_dump_flows(int argc, char *argv[])
553 {
554     return do_dump_flows__(argc, argv, false);
555 }
556
557 static void
558 do_dump_aggregate(int argc, char *argv[])
559 {
560     return do_dump_flows__(argc, argv, true);
561 }
562
563 static void
564 do_queue_stats(int argc, char *argv[])
565 {
566     struct ofp_queue_stats_request *req;
567     struct ofpbuf *request;
568
569     req = alloc_stats_request(sizeof *req, OFPST_QUEUE, &request);
570
571     if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
572         req->port_no = htons(str_to_port_no(argv[1], argv[2]));
573     } else {
574         req->port_no = htons(OFPP_ALL);
575     }
576     if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
577         req->queue_id = htonl(atoi(argv[3]));
578     } else {
579         req->queue_id = htonl(OFPQ_ALL);
580     }
581
582     memset(req->pad, 0, sizeof req->pad);
583
584     dump_stats_transaction(argv[1], request);
585 }
586
587 /* Sets up the flow format for a vconn that will be used to modify the flow
588  * table.  Returns the flow format used, after possibly adding an OpenFlow
589  * request to 'requests'.
590  *
591  * If 'preferred_flow_format' is -1, returns NXFF_OPENFLOW10 without modifying
592  * 'requests', since NXFF_OPENFLOW10 is the default flow format for any
593  * OpenFlow connection.
594  *
595  * If 'preferred_flow_format' is a specific format, adds a request to set that
596  * format to 'requests' and returns the format. */
597 static enum nx_flow_format
598 set_initial_format_for_flow_mod(struct list *requests)
599 {
600     if (preferred_flow_format < 0) {
601         return NXFF_OPENFLOW10;
602     } else {
603         struct ofpbuf *sff;
604
605         sff = ofputil_make_set_flow_format(preferred_flow_format);
606         list_push_back(requests, &sff->list_node);
607         return preferred_flow_format;
608     }
609 }
610
611 /* Checks that 'flow_format' is acceptable as a flow format after a flow_mod
612  * operation, given the global 'preferred_flow_format'. */
613 static void
614 check_final_format_for_flow_mod(enum nx_flow_format flow_format)
615 {
616     if (preferred_flow_format >= 0 && flow_format > preferred_flow_format) {
617         ovs_fatal(0, "flow cannot be expressed in flow format %s "
618                   "(flow format %s or better is required)",
619                   ofputil_flow_format_to_string(preferred_flow_format),
620                   ofputil_flow_format_to_string(flow_format));
621     }
622 }
623
624 static void
625 do_flow_mod_file__(int argc OVS_UNUSED, char *argv[], uint16_t command)
626 {
627     enum nx_flow_format flow_format;
628     bool flow_mod_table_id;
629     struct list requests;
630     struct vconn *vconn;
631     FILE *file;
632
633     file = !strcmp(argv[2], "-") ? stdin : fopen(argv[2], "r");
634     if (file == NULL) {
635         ovs_fatal(errno, "%s: open", argv[2]);
636     }
637
638     list_init(&requests);
639     flow_format = set_initial_format_for_flow_mod(&requests);
640     flow_mod_table_id = false;
641
642     open_vconn(argv[1], &vconn);
643     while (parse_ofp_flow_mod_file(&requests, &flow_format, &flow_mod_table_id,
644                                    file, command)) {
645         check_final_format_for_flow_mod(flow_format);
646         transact_multiple_noreply(vconn, &requests);
647     }
648     vconn_close(vconn);
649
650     if (file != stdin) {
651         fclose(file);
652     }
653 }
654
655 static void
656 do_flow_mod__(int argc, char *argv[], uint16_t command)
657 {
658     enum nx_flow_format flow_format;
659     bool flow_mod_table_id;
660     struct list requests;
661     struct vconn *vconn;
662
663     if (argc > 2 && !strcmp(argv[2], "-")) {
664         do_flow_mod_file__(argc, argv, command);
665         return;
666     }
667
668     list_init(&requests);
669     flow_format = set_initial_format_for_flow_mod(&requests);
670     flow_mod_table_id = false;
671
672     parse_ofp_flow_mod_str(&requests, &flow_format, &flow_mod_table_id,
673                            argc > 2 ? argv[2] : "", command, false);
674     check_final_format_for_flow_mod(flow_format);
675
676     open_vconn(argv[1], &vconn);
677     transact_multiple_noreply(vconn, &requests);
678     vconn_close(vconn);
679 }
680
681 static void
682 do_add_flow(int argc, char *argv[])
683 {
684     do_flow_mod__(argc, argv, OFPFC_ADD);
685 }
686
687 static void
688 do_add_flows(int argc, char *argv[])
689 {
690     do_flow_mod_file__(argc, argv, OFPFC_ADD);
691 }
692
693 static void
694 do_mod_flows(int argc, char *argv[])
695 {
696     do_flow_mod__(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
697 }
698
699 static void
700 do_del_flows(int argc, char *argv[])
701 {
702     do_flow_mod__(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
703 }
704
705 static void
706 monitor_vconn(struct vconn *vconn)
707 {
708     for (;;) {
709         struct ofpbuf *b;
710         run(vconn_recv_block(vconn, &b), "vconn_recv");
711         ofp_print(stderr, b->data, b->size, verbosity + 2);
712         ofpbuf_delete(b);
713     }
714 }
715
716 static void
717 do_monitor(int argc, char *argv[])
718 {
719     struct vconn *vconn;
720
721     open_vconn(argv[1], &vconn);
722     if (argc > 2) {
723         int miss_send_len = atoi(argv[2]);
724         struct ofp_switch_config *osc;
725         struct ofpbuf *buf;
726
727         osc = make_openflow(sizeof *osc, OFPT_SET_CONFIG, &buf);
728         osc->miss_send_len = htons(miss_send_len);
729         transact_noreply(vconn, buf);
730     }
731     monitor_vconn(vconn);
732 }
733
734 static void
735 do_snoop(int argc OVS_UNUSED, char *argv[])
736 {
737     struct vconn *vconn;
738
739     open_vconn__(argv[1], "snoop", &vconn);
740     monitor_vconn(vconn);
741 }
742
743 static void
744 do_dump_ports(int argc, char *argv[])
745 {
746     struct ofp_port_stats_request *req;
747     struct ofpbuf *request;
748     uint16_t port;
749
750     req = alloc_stats_request(sizeof *req, OFPST_PORT, &request);
751     port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
752     req->port_no = htons(port);
753     dump_stats_transaction(argv[1], request);
754 }
755
756 static void
757 do_probe(int argc OVS_UNUSED, char *argv[])
758 {
759     struct ofpbuf *request;
760     struct vconn *vconn;
761     struct ofpbuf *reply;
762
763     make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
764     open_vconn(argv[1], &vconn);
765     run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
766     if (reply->size != sizeof(struct ofp_header)) {
767         ovs_fatal(0, "reply does not match request");
768     }
769     ofpbuf_delete(reply);
770     vconn_close(vconn);
771 }
772
773 static void
774 do_mod_port(int argc OVS_UNUSED, char *argv[])
775 {
776     struct ofp_port_mod *opm;
777     struct ofp_phy_port opp;
778     struct ofpbuf *request;
779     struct vconn *vconn;
780
781     fetch_ofp_phy_port(argv[1], argv[2], &opp);
782
783     opm = make_openflow(sizeof(struct ofp_port_mod), OFPT_PORT_MOD, &request);
784     opm->port_no = opp.port_no;
785     memcpy(opm->hw_addr, opp.hw_addr, sizeof opm->hw_addr);
786     opm->config = htonl(0);
787     opm->mask = htonl(0);
788     opm->advertise = htonl(0);
789
790     if (!strcasecmp(argv[3], "up")) {
791         opm->mask |= htonl(OFPPC_PORT_DOWN);
792     } else if (!strcasecmp(argv[3], "down")) {
793         opm->mask |= htonl(OFPPC_PORT_DOWN);
794         opm->config |= htonl(OFPPC_PORT_DOWN);
795     } else if (!strcasecmp(argv[3], "flood")) {
796         opm->mask |= htonl(OFPPC_NO_FLOOD);
797     } else if (!strcasecmp(argv[3], "noflood")) {
798         opm->mask |= htonl(OFPPC_NO_FLOOD);
799         opm->config |= htonl(OFPPC_NO_FLOOD);
800     } else {
801         ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
802     }
803
804     open_vconn(argv[1], &vconn);
805     transact_noreply(vconn, request);
806     vconn_close(vconn);
807 }
808
809 static void
810 do_ping(int argc, char *argv[])
811 {
812     size_t max_payload = 65535 - sizeof(struct ofp_header);
813     unsigned int payload;
814     struct vconn *vconn;
815     int i;
816
817     payload = argc > 2 ? atoi(argv[2]) : 64;
818     if (payload > max_payload) {
819         ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
820     }
821
822     open_vconn(argv[1], &vconn);
823     for (i = 0; i < 10; i++) {
824         struct timeval start, end;
825         struct ofpbuf *request, *reply;
826         struct ofp_header *rq_hdr, *rpy_hdr;
827
828         rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
829                                OFPT_ECHO_REQUEST, &request);
830         random_bytes(rq_hdr + 1, payload);
831
832         xgettimeofday(&start);
833         run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
834         xgettimeofday(&end);
835
836         rpy_hdr = reply->data;
837         if (reply->size != request->size
838             || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
839             || rpy_hdr->xid != rq_hdr->xid
840             || rpy_hdr->type != OFPT_ECHO_REPLY) {
841             printf("Reply does not match request.  Request:\n");
842             ofp_print(stdout, request, request->size, verbosity + 2);
843             printf("Reply:\n");
844             ofp_print(stdout, reply, reply->size, verbosity + 2);
845         }
846         printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
847                reply->size - sizeof *rpy_hdr, argv[1], ntohl(rpy_hdr->xid),
848                    (1000*(double)(end.tv_sec - start.tv_sec))
849                    + (.001*(end.tv_usec - start.tv_usec)));
850         ofpbuf_delete(request);
851         ofpbuf_delete(reply);
852     }
853     vconn_close(vconn);
854 }
855
856 static void
857 do_benchmark(int argc OVS_UNUSED, char *argv[])
858 {
859     size_t max_payload = 65535 - sizeof(struct ofp_header);
860     struct timeval start, end;
861     unsigned int payload_size, message_size;
862     struct vconn *vconn;
863     double duration;
864     int count;
865     int i;
866
867     payload_size = atoi(argv[2]);
868     if (payload_size > max_payload) {
869         ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
870     }
871     message_size = sizeof(struct ofp_header) + payload_size;
872
873     count = atoi(argv[3]);
874
875     printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
876            count, message_size, count * message_size);
877
878     open_vconn(argv[1], &vconn);
879     xgettimeofday(&start);
880     for (i = 0; i < count; i++) {
881         struct ofpbuf *request, *reply;
882         struct ofp_header *rq_hdr;
883
884         rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
885         memset(rq_hdr + 1, 0, payload_size);
886         run(vconn_transact(vconn, request, &reply), "transact");
887         ofpbuf_delete(reply);
888     }
889     xgettimeofday(&end);
890     vconn_close(vconn);
891
892     duration = ((1000*(double)(end.tv_sec - start.tv_sec))
893                 + (.001*(end.tv_usec - start.tv_usec)));
894     printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
895            duration, count / (duration / 1000.0),
896            count * message_size / (duration / 1000.0));
897 }
898
899 static void
900 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
901 {
902     usage();
903 }
904 \f
905 /* replace-flows and diff-flows commands. */
906
907 /* A flow table entry, possibly with two different versions. */
908 struct fte {
909     struct cls_rule rule;       /* Within a "struct classifier". */
910     struct fte_version *versions[2];
911 };
912
913 /* One version of a Flow Table Entry. */
914 struct fte_version {
915     ovs_be64 cookie;
916     uint16_t idle_timeout;
917     uint16_t hard_timeout;
918     uint16_t flags;
919     union ofp_action *actions;
920     size_t n_actions;
921 };
922
923 /* Frees 'version' and the data that it owns. */
924 static void
925 fte_version_free(struct fte_version *version)
926 {
927     if (version) {
928         free(version->actions);
929         free(version);
930     }
931 }
932
933 /* Returns true if 'a' and 'b' are the same, false if they differ.
934  *
935  * Ignores differences in 'flags' because there's no way to retrieve flags from
936  * an OpenFlow switch.  We have to assume that they are the same. */
937 static bool
938 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
939 {
940     return (a->cookie == b->cookie
941             && a->idle_timeout == b->idle_timeout
942             && a->hard_timeout == b->hard_timeout
943             && a->n_actions == b->n_actions
944             && !memcmp(a->actions, b->actions,
945                        a->n_actions * sizeof *a->actions));
946 }
947
948 /* Prints 'version' on stdout.  Expects the caller to have printed the rule
949  * associated with the version. */
950 static void
951 fte_version_print(const struct fte_version *version)
952 {
953     struct ds s;
954
955     if (version->cookie != htonll(0)) {
956         printf(" cookie=0x%"PRIx64, ntohll(version->cookie));
957     }
958     if (version->idle_timeout != OFP_FLOW_PERMANENT) {
959         printf(" idle_timeout=%"PRIu16, version->idle_timeout);
960     }
961     if (version->hard_timeout != OFP_FLOW_PERMANENT) {
962         printf(" hard_timeout=%"PRIu16, version->hard_timeout);
963     }
964
965     ds_init(&s);
966     ofp_print_actions(&s, version->actions, version->n_actions);
967     printf(" %s\n", ds_cstr(&s));
968     ds_destroy(&s);
969 }
970
971 static struct fte *
972 fte_from_cls_rule(const struct cls_rule *cls_rule)
973 {
974     return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
975 }
976
977 /* Frees 'fte' and its versions. */
978 static void
979 fte_free(struct fte *fte)
980 {
981     if (fte) {
982         fte_version_free(fte->versions[0]);
983         fte_version_free(fte->versions[1]);
984         free(fte);
985     }
986 }
987
988 /* Frees all of the FTEs within 'cls'. */
989 static void
990 fte_free_all(struct classifier *cls)
991 {
992     struct cls_cursor cursor;
993     struct fte *fte, *next;
994
995     cls_cursor_init(&cursor, cls, NULL);
996     CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
997         classifier_remove(cls, &fte->rule);
998         fte_free(fte);
999     }
1000 }
1001
1002 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
1003  * necessary.  Sets 'version' as the version of that rule with the given
1004  * 'index', replacing any existing version, if any.
1005  *
1006  * Takes ownership of 'version'. */
1007 static void
1008 fte_insert(struct classifier *cls, const struct cls_rule *rule,
1009            struct fte_version *version, int index)
1010 {
1011     struct fte *old, *fte;
1012
1013     fte = xzalloc(sizeof *fte);
1014     fte->rule = *rule;
1015     fte->versions[index] = version;
1016
1017     old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
1018     if (old) {
1019         fte_version_free(old->versions[index]);
1020         fte->versions[!index] = old->versions[!index];
1021         free(old);
1022     }
1023 }
1024
1025 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1026  * with the specified 'index'.  Returns the minimum flow format required to
1027  * represent the flows that were read. */
1028 static enum nx_flow_format
1029 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1030 {
1031     enum nx_flow_format min_flow_format;
1032     struct ds s;
1033     FILE *file;
1034
1035     file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1036     if (file == NULL) {
1037         ovs_fatal(errno, "%s: open", filename);
1038     }
1039
1040     ds_init(&s);
1041     min_flow_format = NXFF_OPENFLOW10;
1042     while (!ds_get_preprocessed_line(&s, file)) {
1043         struct fte_version *version;
1044         struct ofputil_flow_mod fm;
1045         enum nx_flow_format min_ff;
1046
1047         parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), true);
1048
1049         version = xmalloc(sizeof *version);
1050         version->cookie = fm.cookie;
1051         version->idle_timeout = fm.idle_timeout;
1052         version->hard_timeout = fm.hard_timeout;
1053         version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF_EMERG);
1054         version->actions = fm.actions;
1055         version->n_actions = fm.n_actions;
1056
1057         min_ff = ofputil_min_flow_format(&fm.cr);
1058         min_flow_format = MAX(min_flow_format, min_ff);
1059         check_final_format_for_flow_mod(min_flow_format);
1060
1061         fte_insert(cls, &fm.cr, version, index);
1062     }
1063     ds_destroy(&s);
1064
1065     if (file != stdin) {
1066         fclose(file);
1067     }
1068
1069     return min_flow_format;
1070 }
1071
1072 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1073  * format 'flow_format', and adds them as flow table entries in 'cls' for the
1074  * version with the specified 'index'. */
1075 static void
1076 read_flows_from_switch(struct vconn *vconn, enum nx_flow_format flow_format,
1077                        struct classifier *cls, int index)
1078 {
1079     struct ofputil_flow_stats_request fsr;
1080     struct ofpbuf *request;
1081     ovs_be32 send_xid;
1082     bool done;
1083
1084     fsr.aggregate = false;
1085     cls_rule_init_catchall(&fsr.match, 0);
1086     fsr.out_port = OFPP_NONE;
1087     fsr.table_id = 0xff;
1088     request = ofputil_encode_flow_stats_request(&fsr, flow_format);
1089     send_xid = ((struct ofp_header *) request->data)->xid;
1090     send_openflow_buffer(vconn, request);
1091
1092     done = false;
1093     while (!done) {
1094         ovs_be32 recv_xid;
1095         struct ofpbuf *reply;
1096
1097         run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
1098         recv_xid = ((struct ofp_header *) reply->data)->xid;
1099         if (send_xid == recv_xid) {
1100             const struct ofputil_msg_type *type;
1101             const struct ofp_stats_msg *osm;
1102             enum ofputil_msg_code code;
1103
1104             ofputil_decode_msg_type(reply->data, &type);
1105             code = ofputil_msg_type_code(type);
1106             if (code != OFPUTIL_OFPST_FLOW_REPLY &&
1107                 code != OFPUTIL_NXST_FLOW_REPLY) {
1108                 ovs_fatal(0, "received bad reply: %s",
1109                           ofp_to_string(reply->data, reply->size,
1110                                         verbosity + 1));
1111             }
1112
1113             osm = reply->data;
1114             if (!(osm->flags & htons(OFPSF_REPLY_MORE))) {
1115                 done = true;
1116             }
1117
1118             for (;;) {
1119                 struct fte_version *version;
1120                 struct ofputil_flow_stats fs;
1121                 int retval;
1122
1123                 retval = ofputil_decode_flow_stats_reply(&fs, reply);
1124                 if (retval) {
1125                     if (retval != EOF) {
1126                         ovs_fatal(0, "parse error in reply");
1127                     }
1128                     break;
1129                 }
1130
1131                 version = xmalloc(sizeof *version);
1132                 version->cookie = fs.cookie;
1133                 version->idle_timeout = fs.idle_timeout;
1134                 version->hard_timeout = fs.hard_timeout;
1135                 version->flags = 0;
1136                 version->n_actions = fs.n_actions;
1137                 version->actions = xmemdup(fs.actions,
1138                                            fs.n_actions * sizeof *fs.actions);
1139
1140                 fte_insert(cls, &fs.rule, version, index);
1141             }
1142         } else {
1143             VLOG_DBG("received reply with xid %08"PRIx32" "
1144                      "!= expected %08"PRIx32, recv_xid, send_xid);
1145         }
1146         ofpbuf_delete(reply);
1147     }
1148 }
1149
1150 static void
1151 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
1152                   enum nx_flow_format flow_format, struct list *packets)
1153 {
1154     const struct fte_version *version = fte->versions[index];
1155     struct ofputil_flow_mod fm;
1156     struct ofpbuf *ofm;
1157
1158     fm.cr = fte->rule;
1159     fm.cookie = version->cookie;
1160     fm.table_id = 0xff;
1161     fm.command = command;
1162     fm.idle_timeout = version->idle_timeout;
1163     fm.hard_timeout = version->hard_timeout;
1164     fm.buffer_id = UINT32_MAX;
1165     fm.out_port = OFPP_NONE;
1166     fm.flags = version->flags;
1167     if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
1168         command == OFPFC_MODIFY_STRICT) {
1169         fm.actions = version->actions;
1170         fm.n_actions = version->n_actions;
1171     } else {
1172         fm.actions = NULL;
1173         fm.n_actions = 0;
1174     }
1175
1176     ofm = ofputil_encode_flow_mod(&fm, flow_format, false);
1177     list_push_back(packets, &ofm->list_node);
1178 }
1179
1180 static void
1181 do_replace_flows(int argc OVS_UNUSED, char *argv[])
1182 {
1183     enum { FILE_IDX = 0, SWITCH_IDX = 1 };
1184     enum nx_flow_format min_flow_format, flow_format;
1185     struct cls_cursor cursor;
1186     struct classifier cls;
1187     struct list requests;
1188     struct vconn *vconn;
1189     struct fte *fte;
1190
1191     classifier_init(&cls);
1192     min_flow_format = read_flows_from_file(argv[2], &cls, FILE_IDX);
1193
1194     open_vconn(argv[1], &vconn);
1195     flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
1196     read_flows_from_switch(vconn, flow_format, &cls, SWITCH_IDX);
1197
1198     list_init(&requests);
1199
1200     /* Delete flows that exist on the switch but not in the file. */
1201     cls_cursor_init(&cursor, &cls, NULL);
1202     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1203         struct fte_version *file_ver = fte->versions[FILE_IDX];
1204         struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1205
1206         if (sw_ver && !file_ver) {
1207             fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
1208                               flow_format, &requests);
1209         }
1210     }
1211
1212     /* Add flows that exist in the file but not on the switch.
1213      * Update flows that exist in both places but differ. */
1214     cls_cursor_init(&cursor, &cls, NULL);
1215     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1216         struct fte_version *file_ver = fte->versions[FILE_IDX];
1217         struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1218
1219         if (file_ver
1220             && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
1221             fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, flow_format,
1222                               &requests);
1223         }
1224     }
1225     transact_multiple_noreply(vconn, &requests);
1226     vconn_close(vconn);
1227
1228     fte_free_all(&cls);
1229 }
1230
1231 static void
1232 read_flows_from_source(const char *source, struct classifier *cls, int index)
1233 {
1234     struct stat s;
1235
1236     if (source[0] == '/' || source[0] == '.'
1237         || (!strchr(source, ':') && !stat(source, &s))) {
1238         read_flows_from_file(source, cls, index);
1239     } else {
1240         enum nx_flow_format flow_format;
1241         struct vconn *vconn;
1242
1243         open_vconn(source, &vconn);
1244         flow_format = negotiate_highest_flow_format(vconn, NXFF_OPENFLOW10);
1245         read_flows_from_switch(vconn, flow_format, cls, index);
1246         vconn_close(vconn);
1247     }
1248 }
1249
1250 static void
1251 do_diff_flows(int argc OVS_UNUSED, char *argv[])
1252 {
1253     bool differences = false;
1254     struct cls_cursor cursor;
1255     struct classifier cls;
1256     struct fte *fte;
1257
1258     classifier_init(&cls);
1259     read_flows_from_source(argv[1], &cls, 0);
1260     read_flows_from_source(argv[2], &cls, 1);
1261
1262     cls_cursor_init(&cursor, &cls, NULL);
1263     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1264         struct fte_version *a = fte->versions[0];
1265         struct fte_version *b = fte->versions[1];
1266
1267         if (!a || !b || !fte_version_equals(a, b)) {
1268             char *rule_s = cls_rule_to_string(&fte->rule);
1269             if (a) {
1270                 printf("-%s", rule_s);
1271                 fte_version_print(a);
1272             }
1273             if (b) {
1274                 printf("+%s", rule_s);
1275                 fte_version_print(b);
1276             }
1277             free(rule_s);
1278
1279             differences = true;
1280         }
1281     }
1282
1283     fte_free_all(&cls);
1284
1285     if (differences) {
1286         exit(2);
1287     }
1288 }
1289 \f
1290 /* Undocumented commands for unit testing. */
1291
1292 static void
1293 print_packet_list(struct list *packets)
1294 {
1295     struct ofpbuf *packet, *next;
1296
1297     LIST_FOR_EACH_SAFE (packet, next, list_node, packets) {
1298         ofp_print(stdout, packet->data, packet->size, verbosity);
1299         list_remove(&packet->list_node);
1300         ofpbuf_delete(packet);
1301     }
1302 }
1303
1304 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
1305  * it back to stdout.  */
1306 static void
1307 do_parse_flow(int argc OVS_UNUSED, char *argv[])
1308 {
1309     enum nx_flow_format flow_format;
1310     bool flow_mod_table_id;
1311     struct list packets;
1312
1313     flow_format = NXFF_OPENFLOW10;
1314     if (preferred_flow_format > 0) {
1315         flow_format = preferred_flow_format;
1316     }
1317     flow_mod_table_id = false;
1318
1319     list_init(&packets);
1320     parse_ofp_flow_mod_str(&packets, &flow_format, &flow_mod_table_id,
1321                            argv[1], OFPFC_ADD, false);
1322     print_packet_list(&packets);
1323 }
1324
1325 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
1326  * add-flows) and prints each of the flows back to stdout.  */
1327 static void
1328 do_parse_flows(int argc OVS_UNUSED, char *argv[])
1329 {
1330     enum nx_flow_format flow_format;
1331     bool flow_mod_table_id;
1332     struct list packets;
1333     FILE *file;
1334
1335     file = fopen(argv[1], "r");
1336     if (file == NULL) {
1337         ovs_fatal(errno, "%s: open", argv[2]);
1338     }
1339
1340     flow_format = NXFF_OPENFLOW10;
1341     if (preferred_flow_format > 0) {
1342         flow_format = preferred_flow_format;
1343     }
1344     flow_mod_table_id = false;
1345
1346     list_init(&packets);
1347     while (parse_ofp_flow_mod_file(&packets, &flow_format, &flow_mod_table_id,
1348                                    file, OFPFC_ADD)) {
1349         print_packet_list(&packets);
1350     }
1351     fclose(file);
1352 }
1353
1354 /* "parse-nx-match": reads a series of nx_match specifications as strings from
1355  * stdin, does some internal fussing with them, and then prints them back as
1356  * strings on stdout. */
1357 static void
1358 do_parse_nx_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1359 {
1360     struct ds in;
1361
1362     ds_init(&in);
1363     while (!ds_get_line(&in, stdin)) {
1364         struct ofpbuf nx_match;
1365         struct cls_rule rule;
1366         int match_len;
1367         int error;
1368         char *s;
1369
1370         /* Delete comments, skip blank lines. */
1371         s = ds_cstr(&in);
1372         if (*s == '#') {
1373             puts(s);
1374             continue;
1375         }
1376         if (strchr(s, '#')) {
1377             *strchr(s, '#') = '\0';
1378         }
1379         if (s[strspn(s, " ")] == '\0') {
1380             putchar('\n');
1381             continue;
1382         }
1383
1384         /* Convert string to nx_match. */
1385         ofpbuf_init(&nx_match, 0);
1386         match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
1387
1388         /* Convert nx_match to cls_rule. */
1389         error = nx_pull_match(&nx_match, match_len, 0, &rule);
1390         if (!error) {
1391             char *out;
1392
1393             /* Convert cls_rule back to nx_match. */
1394             ofpbuf_uninit(&nx_match);
1395             ofpbuf_init(&nx_match, 0);
1396             match_len = nx_put_match(&nx_match, &rule);
1397
1398             /* Convert nx_match to string. */
1399             out = nx_match_to_string(nx_match.data, match_len);
1400             puts(out);
1401             free(out);
1402         } else {
1403             printf("nx_pull_match() returned error %x (%s)\n", error,
1404                    ofputil_error_to_string(error));
1405         }
1406
1407         ofpbuf_uninit(&nx_match);
1408     }
1409     ds_destroy(&in);
1410 }
1411
1412 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
1413  * binary data, interpreting them as an OpenFlow message, and prints the
1414  * OpenFlow message on stdout, at VERBOSITY (level 2 by default).  */
1415 static void
1416 do_ofp_print(int argc, char *argv[])
1417 {
1418     struct ofpbuf packet;
1419
1420     ofpbuf_init(&packet, strlen(argv[1]) / 2);
1421     if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
1422         ovs_fatal(0, "trailing garbage following hex bytes");
1423     }
1424     ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
1425     ofpbuf_uninit(&packet);
1426 }
1427
1428 static const struct command all_commands[] = {
1429     { "show", 1, 1, do_show },
1430     { "monitor", 1, 2, do_monitor },
1431     { "snoop", 1, 1, do_snoop },
1432     { "dump-desc", 1, 1, do_dump_desc },
1433     { "dump-tables", 1, 1, do_dump_tables },
1434     { "dump-flows", 1, 2, do_dump_flows },
1435     { "dump-aggregate", 1, 2, do_dump_aggregate },
1436     { "queue-stats", 1, 3, do_queue_stats },
1437     { "add-flow", 2, 2, do_add_flow },
1438     { "add-flows", 2, 2, do_add_flows },
1439     { "mod-flows", 2, 2, do_mod_flows },
1440     { "del-flows", 1, 2, do_del_flows },
1441     { "replace-flows", 2, 2, do_replace_flows },
1442     { "diff-flows", 2, 2, do_diff_flows },
1443     { "dump-ports", 1, 2, do_dump_ports },
1444     { "mod-port", 3, 3, do_mod_port },
1445     { "probe", 1, 1, do_probe },
1446     { "ping", 1, 2, do_ping },
1447     { "benchmark", 3, 3, do_benchmark },
1448     { "help", 0, INT_MAX, do_help },
1449
1450     /* Undocumented commands for testing. */
1451     { "parse-flow", 1, 1, do_parse_flow },
1452     { "parse-flows", 1, 1, do_parse_flows },
1453     { "parse-nx-match", 0, 0, do_parse_nx_match },
1454     { "ofp-print", 1, 2, do_ofp_print },
1455
1456     { NULL, 0, 0, NULL },
1457 };