2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include <arpa/inet.h>
22 #include <sys/socket.h>
24 #include <netinet/in.h>
33 #include "command-line.h"
37 #include "dynamic-string.h"
41 #include "ofp-print.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
48 #include "socket-util.h"
49 #include "stream-ssl.h"
56 VLOG_DEFINE_THIS_MODULE(ofctl)
58 #define DEFAULT_IDLE_TIMEOUT 60
60 #define MOD_PORT_CMD_UP "up"
61 #define MOD_PORT_CMD_DOWN "down"
62 #define MOD_PORT_CMD_FLOOD "flood"
63 #define MOD_PORT_CMD_NOFLOOD "noflood"
65 /* Use strict matching for flow mod commands? */
68 static const struct command all_commands[];
70 static void usage(void) NO_RETURN;
71 static void parse_options(int argc, char *argv[]);
74 main(int argc, char *argv[])
76 set_program_name(argv[0]);
77 parse_options(argc, argv);
78 signal(SIGPIPE, SIG_IGN);
79 run_command(argc - optind, argv + optind, all_commands);
84 parse_options(int argc, char *argv[])
87 OPT_STRICT = UCHAR_MAX + 1,
90 static struct option long_options[] = {
91 {"timeout", required_argument, 0, 't'},
92 {"strict", no_argument, 0, OPT_STRICT},
93 {"help", no_argument, 0, 'h'},
94 {"version", no_argument, 0, 'V'},
96 STREAM_SSL_LONG_OPTIONS
99 char *short_options = long_options_to_short_options(long_options);
102 unsigned long int timeout;
105 c = getopt_long(argc, argv, short_options, long_options, NULL);
112 timeout = strtoul(optarg, NULL, 10);
114 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
125 OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
133 STREAM_SSL_OPTION_HANDLERS
148 printf("%s: OpenFlow switch management utility\n"
149 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
150 "\nFor OpenFlow switches:\n"
151 " show SWITCH show OpenFlow information\n"
152 " status SWITCH [KEY] report statistics (about KEY)\n"
153 " dump-desc SWITCH print switch description\n"
154 " dump-tables SWITCH print table stats\n"
155 " mod-port SWITCH IFACE ACT modify port behavior\n"
156 " dump-ports SWITCH [PORT] print port statistics\n"
157 " dump-flows SWITCH print all flow entries\n"
158 " dump-flows SWITCH FLOW print matching FLOWs\n"
159 " dump-aggregate SWITCH print aggregate flow statistics\n"
160 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
161 " add-flow SWITCH FLOW add flow described by FLOW\n"
162 " add-flows SWITCH FILE add flows from FILE\n"
163 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
164 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
165 " monitor SWITCH [MISSLEN] print packets received from SWITCH\n"
166 "\nFor OpenFlow switches and controllers:\n"
167 " probe VCONN probe whether VCONN is up\n"
168 " ping VCONN [N] latency of N-byte echos\n"
169 " benchmark VCONN N COUNT bandwidth of COUNT N-byte echos\n"
170 "where each SWITCH is an active OpenFlow connection method.\n",
171 program_name, program_name);
172 vconn_usage(true, false, false);
174 printf("\nOther options:\n"
175 " --strict use strict match for flow commands\n"
176 " -t, --timeout=SECS give up after SECS seconds\n"
177 " -h, --help display this help message\n"
178 " -V, --version display version information\n");
182 static void run(int retval, const char *message, ...)
185 static void run(int retval, const char *message, ...)
190 fprintf(stderr, "%s: ", program_name);
191 va_start(args, message);
192 vfprintf(stderr, message, args);
195 fputs(": unexpected end of file\n", stderr);
197 fprintf(stderr, ": %s\n", strerror(retval));
204 /* Generic commands. */
207 open_vconn_socket(const char *name, struct vconn **vconnp)
209 char *vconn_name = xasprintf("unix:%s", name);
210 VLOG_INFO("connecting to %s", vconn_name);
211 run(vconn_open_block(vconn_name, OFP_VERSION, vconnp),
212 "connecting to %s", vconn_name);
217 open_vconn__(const char *name, const char *default_suffix,
218 struct vconn **vconnp)
222 char *bridge_path, *datapath_name, *datapath_type;
224 bridge_path = xasprintf("%s/%s.%s", ovs_rundir, name, default_suffix);
225 dp_parse_name(name, &datapath_name, &datapath_type);
227 if (strstr(name, ":")) {
228 run(vconn_open_block(name, OFP_VERSION, vconnp),
229 "connecting to %s", name);
230 } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
231 open_vconn_socket(name, vconnp);
232 } else if (!stat(bridge_path, &s) && S_ISSOCK(s.st_mode)) {
233 open_vconn_socket(bridge_path, vconnp);
234 } else if (!dpif_open(datapath_name, datapath_type, &dpif)) {
235 char dpif_name[IF_NAMESIZE + 1];
238 run(dpif_port_get_name(dpif, ODPP_LOCAL, dpif_name, sizeof dpif_name),
239 "obtaining name of %s", dpif_name);
241 if (strcmp(dpif_name, name)) {
242 VLOG_INFO("datapath %s is named %s", name, dpif_name);
245 socket_name = xasprintf("%s/%s.%s",
246 ovs_rundir, dpif_name, default_suffix);
247 if (stat(socket_name, &s)) {
248 ovs_fatal(errno, "cannot connect to %s: stat failed on %s",
250 } else if (!S_ISSOCK(s.st_mode)) {
251 ovs_fatal(0, "cannot connect to %s: %s is not a socket",
255 open_vconn_socket(socket_name, vconnp);
258 ovs_fatal(0, "%s is not a valid connection method", name);
267 open_vconn(const char *name, struct vconn **vconnp)
269 return open_vconn__(name, "mgmt", vconnp);
273 alloc_stats_request(size_t body_len, uint16_t type, struct ofpbuf **bufferp)
275 struct ofp_stats_request *rq;
276 rq = make_openflow((offsetof(struct ofp_stats_request, body)
277 + body_len), OFPT_STATS_REQUEST, bufferp);
278 rq->type = htons(type);
279 rq->flags = htons(0);
284 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
286 update_openflow_length(buffer);
287 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
291 dump_transaction(const char *vconn_name, struct ofpbuf *request)
294 struct ofpbuf *reply;
296 update_openflow_length(request);
297 open_vconn(vconn_name, &vconn);
298 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
299 ofp_print(stdout, reply->data, reply->size, 1);
304 dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
306 struct ofpbuf *request;
307 make_openflow(sizeof(struct ofp_header), request_type, &request);
308 dump_transaction(vconn_name, request);
312 dump_stats_transaction(const char *vconn_name, struct ofpbuf *request)
314 uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
318 open_vconn(vconn_name, &vconn);
319 send_openflow_buffer(vconn, request);
322 struct ofpbuf *reply;
324 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
325 recv_xid = ((struct ofp_header *) reply->data)->xid;
326 if (send_xid == recv_xid) {
327 struct ofp_stats_reply *osr;
329 ofp_print(stdout, reply->data, reply->size, 1);
331 osr = ofpbuf_at(reply, 0, sizeof *osr);
332 done = !osr || !(ntohs(osr->flags) & OFPSF_REPLY_MORE);
334 VLOG_DBG("received reply with xid %08"PRIx32" "
335 "!= expected %08"PRIx32, recv_xid, send_xid);
337 ofpbuf_delete(reply);
343 dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
345 struct ofpbuf *request;
346 alloc_stats_request(0, stats_type, &request);
347 dump_stats_transaction(vconn_name, request);
351 do_show(int argc OVS_UNUSED, char *argv[])
353 dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
354 dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
358 do_status(int argc, char *argv[])
360 struct nicira_header *request, *reply;
364 request = make_openflow(sizeof *request, OFPT_VENDOR, &b);
365 request->vendor = htonl(NX_VENDOR_ID);
366 request->subtype = htonl(NXT_STATUS_REQUEST);
368 ofpbuf_put(b, argv[2], strlen(argv[2]));
369 update_openflow_length(b);
371 open_vconn(argv[1], &vconn);
372 run(vconn_transact(vconn, b, &b), "talking to %s", argv[1]);
375 if (b->size < sizeof *reply) {
376 ovs_fatal(0, "short reply (%zu bytes)", b->size);
379 if (reply->header.type != OFPT_VENDOR
380 || reply->vendor != ntohl(NX_VENDOR_ID)
381 || reply->subtype != ntohl(NXT_STATUS_REPLY)) {
382 ofp_print(stderr, b->data, b->size, 2);
383 ovs_fatal(0, "bad reply");
386 fwrite(reply + 1, b->size - sizeof *reply, 1, stdout);
390 do_dump_desc(int argc OVS_UNUSED, char *argv[])
392 dump_trivial_stats_transaction(argv[1], OFPST_DESC);
396 do_dump_tables(int argc OVS_UNUSED, char *argv[])
398 dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
403 str_to_u32(const char *str)
409 value = strtoul(str, &tail, 0);
410 if (errno == EINVAL || errno == ERANGE || *tail) {
411 ovs_fatal(0, "invalid numeric format %s", str);
417 str_to_u64(const char *str)
423 value = strtoull(str, &tail, 0);
424 if (errno == EINVAL || errno == ERANGE || *tail) {
425 ovs_fatal(0, "invalid numeric format %s", str);
431 str_to_mac(const char *str, uint8_t mac[6])
433 if (sscanf(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
434 != ETH_ADDR_SCAN_COUNT) {
435 ovs_fatal(0, "invalid mac address %s", str);
440 str_to_ip(const char *str_, uint32_t *ip)
442 char *str = xstrdup(str_);
443 char *save_ptr = NULL;
444 const char *name, *netmask;
445 struct in_addr in_addr;
448 name = strtok_r(str, "/", &save_ptr);
449 retval = name ? lookup_ip(name, &in_addr) : EINVAL;
451 ovs_fatal(0, "%s: could not convert to IP address", str);
453 *ip = in_addr.s_addr;
455 netmask = strtok_r(NULL, "/", &save_ptr);
458 if (sscanf(netmask, "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8,
459 &o[0], &o[1], &o[2], &o[3]) == 4) {
460 uint32_t nm = (o[0] << 24) | (o[1] << 16) | (o[2] << 8) | o[3];
463 /* Find first 1-bit. */
464 for (i = 0; i < 32; i++) {
465 if (nm & (1u << i)) {
471 /* Verify that the rest of the bits are 1-bits. */
472 for (; i < 32; i++) {
473 if (!(nm & (1u << i))) {
474 ovs_fatal(0, "%s: %s is not a valid netmask",
479 int prefix = atoi(netmask);
480 if (prefix <= 0 || prefix > 32) {
481 ovs_fatal(0, "%s: network prefix bits not between 1 and 32",
484 n_wild = 32 - prefix;
495 str_to_port_no(const char *vconn_name, const char *str)
497 struct ofpbuf *request, *reply;
498 struct ofp_switch_features *osf;
502 unsigned int port_no;
505 /* Check if the argument is a port index. Otherwise, treat it as
507 if (str_to_uint(str, 10, &port_no)) {
511 /* Send a "Features Request" to resolve the name into a number. */
512 make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
513 open_vconn(vconn_name, &vconn);
514 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
517 n_ports = (reply->size - sizeof *osf) / sizeof *osf->ports;
519 for (port_idx = 0; port_idx < n_ports; port_idx++) {
520 /* Check argument as an interface name */
521 if (!strncmp((char *)osf->ports[port_idx].name, str,
522 sizeof osf->ports[0].name)) {
526 if (port_idx == n_ports) {
527 ovs_fatal(0, "couldn't find monitored port: %s", str);
530 ofpbuf_delete(reply);
537 put_action(struct ofpbuf *b, size_t size, uint16_t type)
539 struct ofp_action_header *ah = ofpbuf_put_zeros(b, size);
540 ah->type = htons(type);
541 ah->len = htons(size);
545 static struct ofp_action_output *
546 put_output_action(struct ofpbuf *b, uint16_t port)
548 struct ofp_action_output *oao = put_action(b, sizeof *oao, OFPAT_OUTPUT);
549 oao->port = htons(port);
554 put_dl_addr_action(struct ofpbuf *b, uint16_t type, const char *addr)
556 struct ofp_action_dl_addr *oada = put_action(b, sizeof *oada, type);
557 str_to_mac(addr, oada->dl_addr);
562 parse_port_name(const char *name, uint16_t *port)
568 static const struct pair pairs[] = {
569 #define DEF_PAIR(NAME) {#NAME, OFPP_##NAME}
575 DEF_PAIR(CONTROLLER),
580 static const int n_pairs = ARRAY_SIZE(pairs);
583 for (i = 0; i < n_pairs; i++) {
584 if (!strcasecmp(name, pairs[i].name)) {
585 *port = pairs[i].value;
593 str_to_action(char *str, struct ofpbuf *b)
596 char *saveptr = NULL;
600 for (act = strtok_r(str, ", \t\r\n", &saveptr), n_actions = 0; act;
601 act = strtok_r(NULL, ", \t\r\n", &saveptr), n_actions++)
606 ovs_fatal(0, "Drop actions must not be followed by other actions");
609 /* Arguments are separated by colons */
610 arg = strchr(act, ':');
616 if (!strcasecmp(act, "mod_vlan_vid")) {
617 struct ofp_action_vlan_vid *va;
618 va = put_action(b, sizeof *va, OFPAT_SET_VLAN_VID);
619 va->vlan_vid = htons(str_to_u32(arg));
620 } else if (!strcasecmp(act, "mod_vlan_pcp")) {
621 struct ofp_action_vlan_pcp *va;
622 va = put_action(b, sizeof *va, OFPAT_SET_VLAN_PCP);
623 va->vlan_pcp = str_to_u32(arg);
624 } else if (!strcasecmp(act, "strip_vlan")) {
625 struct ofp_action_header *ah;
626 ah = put_action(b, sizeof *ah, OFPAT_STRIP_VLAN);
627 ah->type = htons(OFPAT_STRIP_VLAN);
628 } else if (!strcasecmp(act, "mod_dl_src")) {
629 put_dl_addr_action(b, OFPAT_SET_DL_SRC, arg);
630 } else if (!strcasecmp(act, "mod_dl_dst")) {
631 put_dl_addr_action(b, OFPAT_SET_DL_DST, arg);
632 } else if (!strcasecmp(act, "mod_nw_src")) {
633 struct ofp_action_nw_addr *na;
634 na = put_action(b, sizeof *na, OFPAT_SET_NW_SRC);
635 str_to_ip(arg, &na->nw_addr);
636 } else if (!strcasecmp(act, "mod_nw_dst")) {
637 struct ofp_action_nw_addr *na;
638 na = put_action(b, sizeof *na, OFPAT_SET_NW_DST);
639 str_to_ip(arg, &na->nw_addr);
640 } else if (!strcasecmp(act, "mod_tp_src")) {
641 struct ofp_action_tp_port *ta;
642 ta = put_action(b, sizeof *ta, OFPAT_SET_TP_SRC);
643 ta->tp_port = htons(str_to_u32(arg));
644 } else if (!strcasecmp(act, "mod_tp_dst")) {
645 struct ofp_action_tp_port *ta;
646 ta = put_action(b, sizeof *ta, OFPAT_SET_TP_DST);
647 ta->tp_port = htons(str_to_u32(arg));
648 } else if (!strcasecmp(act, "mod_nw_tos")) {
649 struct ofp_action_nw_tos *nt;
650 nt = put_action(b, sizeof *nt, OFPAT_SET_NW_TOS);
651 nt->nw_tos = str_to_u32(arg);
652 } else if (!strcasecmp(act, "resubmit")) {
653 struct nx_action_resubmit *nar;
654 nar = put_action(b, sizeof *nar, OFPAT_VENDOR);
655 nar->vendor = htonl(NX_VENDOR_ID);
656 nar->subtype = htons(NXAST_RESUBMIT);
657 nar->in_port = htons(str_to_u32(arg));
658 } else if (!strcasecmp(act, "set_tunnel")) {
659 struct nx_action_set_tunnel *nast;
660 nast = put_action(b, sizeof *nast, OFPAT_VENDOR);
661 nast->vendor = htonl(NX_VENDOR_ID);
662 nast->subtype = htons(NXAST_SET_TUNNEL);
663 nast->tun_id = htonl(str_to_u32(arg));
664 } else if (!strcasecmp(act, "output")) {
665 put_output_action(b, str_to_u32(arg));
666 } else if (!strcasecmp(act, "drop")) {
667 /* A drop action in OpenFlow occurs by just not setting
671 ovs_fatal(0, "Drop actions must not be preceded by other "
674 } else if (!strcasecmp(act, "CONTROLLER")) {
675 struct ofp_action_output *oao;
676 oao = put_output_action(b, OFPP_CONTROLLER);
678 /* Unless a numeric argument is specified, we send the whole
679 * packet to the controller. */
680 if (arg && (strspn(arg, "0123456789") == strlen(arg))) {
681 oao->max_len = htons(str_to_u32(arg));
683 oao->max_len = htons(UINT16_MAX);
685 } else if (parse_port_name(act, &port)) {
686 put_output_action(b, port);
687 } else if (strspn(act, "0123456789") == strlen(act)) {
688 put_output_action(b, str_to_u32(act));
690 ovs_fatal(0, "Unknown action: %s", act);
702 parse_protocol(const char *name, const struct protocol **p_out)
704 static const struct protocol protocols[] = {
705 { "ip", ETH_TYPE_IP, 0 },
706 { "arp", ETH_TYPE_ARP, 0 },
707 { "icmp", ETH_TYPE_IP, IP_TYPE_ICMP },
708 { "tcp", ETH_TYPE_IP, IP_TYPE_TCP },
709 { "udp", ETH_TYPE_IP, IP_TYPE_UDP },
711 const struct protocol *p;
713 for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
714 if (!strcmp(p->name, name)) {
726 enum { F_U8, F_U16, F_MAC, F_IP } type;
727 size_t offset, shift;
731 parse_field(const char *name, const struct field **f_out)
733 #define F_OFS(MEMBER) offsetof(struct ofp_match, MEMBER)
734 static const struct field fields[] = {
735 { "in_port", OFPFW_IN_PORT, F_U16, F_OFS(in_port), 0 },
736 { "dl_vlan", OFPFW_DL_VLAN, F_U16, F_OFS(dl_vlan), 0 },
737 { "dl_vlan_pcp", OFPFW_DL_VLAN_PCP, F_U8, F_OFS(dl_vlan_pcp), 0 },
738 { "dl_src", OFPFW_DL_SRC, F_MAC, F_OFS(dl_src), 0 },
739 { "dl_dst", OFPFW_DL_DST, F_MAC, F_OFS(dl_dst), 0 },
740 { "dl_type", OFPFW_DL_TYPE, F_U16, F_OFS(dl_type), 0 },
741 { "nw_src", OFPFW_NW_SRC_MASK, F_IP,
742 F_OFS(nw_src), OFPFW_NW_SRC_SHIFT },
743 { "nw_dst", OFPFW_NW_DST_MASK, F_IP,
744 F_OFS(nw_dst), OFPFW_NW_DST_SHIFT },
745 { "nw_proto", OFPFW_NW_PROTO, F_U8, F_OFS(nw_proto), 0 },
746 { "nw_tos", OFPFW_NW_TOS, F_U8, F_OFS(nw_tos), 0 },
747 { "tp_src", OFPFW_TP_SRC, F_U16, F_OFS(tp_src), 0 },
748 { "tp_dst", OFPFW_TP_DST, F_U16, F_OFS(tp_dst), 0 },
749 { "icmp_type", OFPFW_ICMP_TYPE, F_U16, F_OFS(icmp_type), 0 },
750 { "icmp_code", OFPFW_ICMP_CODE, F_U16, F_OFS(icmp_code), 0 }
752 const struct field *f;
754 for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
755 if (!strcmp(f->name, name)) {
765 str_to_flow(char *string, struct ofp_match *match, struct ofpbuf *actions,
766 uint8_t *table_idx, uint16_t *out_port, uint16_t *priority,
767 uint16_t *idle_timeout, uint16_t *hard_timeout,
770 struct ofp_match normalized;
771 char *save_ptr = NULL;
779 *out_port = OFPP_NONE;
782 *priority = OFP_DEFAULT_PRIORITY;
785 *idle_timeout = DEFAULT_IDLE_TIMEOUT;
788 *hard_timeout = OFP_FLOW_PERMANENT;
794 char *act_str = strstr(string, "action");
796 ovs_fatal(0, "must specify an action");
800 act_str = strchr(act_str + 1, '=');
802 ovs_fatal(0, "must specify an action");
807 str_to_action(act_str, actions);
809 memset(match, 0, sizeof *match);
810 wildcards = OFPFW_ALL;
811 for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
812 name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
813 const struct protocol *p;
815 if (parse_protocol(name, &p)) {
816 wildcards &= ~OFPFW_DL_TYPE;
817 match->dl_type = htons(p->dl_type);
819 wildcards &= ~OFPFW_NW_PROTO;
820 match->nw_proto = p->nw_proto;
823 const struct field *f;
826 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
828 ovs_fatal(0, "field %s missing value", name);
831 if (table_idx && !strcmp(name, "table")) {
832 *table_idx = atoi(value);
833 } else if (out_port && !strcmp(name, "out_port")) {
834 *out_port = atoi(value);
835 } else if (priority && !strcmp(name, "priority")) {
836 *priority = atoi(value);
837 } else if (idle_timeout && !strcmp(name, "idle_timeout")) {
838 *idle_timeout = atoi(value);
839 } else if (hard_timeout && !strcmp(name, "hard_timeout")) {
840 *hard_timeout = atoi(value);
841 } else if (cookie && !strcmp(name, "cookie")) {
842 *cookie = str_to_u64(value);
843 } else if (!strcmp(name, "tun_id_wild")) {
844 wildcards |= NXFW_TUN_ID;
845 } else if (parse_field(name, &f)) {
846 void *data = (char *) match + f->offset;
847 if (!strcmp(value, "*") || !strcmp(value, "ANY")) {
848 wildcards |= f->wildcard;
850 wildcards &= ~f->wildcard;
851 if (f->wildcard == OFPFW_IN_PORT
852 && parse_port_name(value, (uint16_t *) data)) {
854 } else if (f->type == F_U8) {
855 *(uint8_t *) data = str_to_u32(value);
856 } else if (f->type == F_U16) {
857 *(uint16_t *) data = htons(str_to_u32(value));
858 } else if (f->type == F_MAC) {
859 str_to_mac(value, data);
860 } else if (f->type == F_IP) {
861 wildcards |= str_to_ip(value, data) << f->shift;
867 ovs_fatal(0, "unknown keyword %s", name);
871 match->wildcards = htonl(wildcards);
874 normalize_match(&normalized);
875 if (memcmp(match, &normalized, sizeof normalized)) {
876 char *old = ofp_match_to_literal_string(match);
877 char *new = ofp_match_to_literal_string(&normalized);
878 VLOG_WARN("The specified flow is not in normal form:");
879 VLOG_WARN(" as specified: %s", old);
880 VLOG_WARN("as normalized: %s", new);
887 do_dump_flows(int argc, char *argv[])
889 struct ofp_flow_stats_request *req;
891 struct ofpbuf *request;
893 req = alloc_stats_request(sizeof *req, OFPST_FLOW, &request);
894 str_to_flow(argc > 2 ? argv[2] : "", &req->match, NULL,
895 &req->table_id, &out_port, NULL, NULL, NULL, NULL);
896 memset(&req->pad, 0, sizeof req->pad);
897 req->out_port = htons(out_port);
899 dump_stats_transaction(argv[1], request);
903 do_dump_aggregate(int argc, char *argv[])
905 struct ofp_aggregate_stats_request *req;
906 struct ofpbuf *request;
909 req = alloc_stats_request(sizeof *req, OFPST_AGGREGATE, &request);
910 str_to_flow(argc > 2 ? argv[2] : "", &req->match, NULL,
911 &req->table_id, &out_port, NULL, NULL, NULL, NULL);
912 memset(&req->pad, 0, sizeof req->pad);
913 req->out_port = htons(out_port);
915 dump_stats_transaction(argv[1], request);
919 do_add_flow(int argc OVS_UNUSED, char *argv[])
922 struct ofpbuf *buffer;
923 struct ofp_flow_mod *ofm;
924 uint16_t priority, idle_timeout, hard_timeout;
926 struct ofp_match match;
928 /* Parse and send. str_to_flow() will expand and reallocate the data in
929 * 'buffer', so we can't keep pointers to across the str_to_flow() call. */
930 make_openflow(sizeof *ofm, OFPT_FLOW_MOD, &buffer);
931 str_to_flow(argv[2], &match, buffer,
932 NULL, NULL, &priority, &idle_timeout, &hard_timeout,
936 ofm->command = htons(OFPFC_ADD);
937 ofm->cookie = htonll(cookie);
938 ofm->idle_timeout = htons(idle_timeout);
939 ofm->hard_timeout = htons(hard_timeout);
940 ofm->buffer_id = htonl(UINT32_MAX);
941 ofm->priority = htons(priority);
943 open_vconn(argv[1], &vconn);
944 send_openflow_buffer(vconn, buffer);
949 do_add_flows(int argc OVS_UNUSED, char *argv[])
955 file = fopen(argv[2], "r");
957 ovs_fatal(errno, "%s: open", argv[2]);
960 open_vconn(argv[1], &vconn);
961 while (fgets(line, sizeof line, file)) {
962 struct ofpbuf *buffer;
963 struct ofp_flow_mod *ofm;
964 uint16_t priority, idle_timeout, hard_timeout;
966 struct ofp_match match;
970 /* Delete comments. */
971 comment = strchr(line, '#');
976 /* Drop empty lines. */
977 if (line[strspn(line, " \t\n")] == '\0') {
981 /* Parse and send. str_to_flow() will expand and reallocate the data
982 * in 'buffer', so we can't keep pointers to across the str_to_flow()
984 make_openflow(sizeof *ofm, OFPT_FLOW_MOD, &buffer);
985 str_to_flow(line, &match, buffer,
986 NULL, NULL, &priority, &idle_timeout, &hard_timeout,
990 ofm->command = htons(OFPFC_ADD);
991 ofm->cookie = htonll(cookie);
992 ofm->idle_timeout = htons(idle_timeout);
993 ofm->hard_timeout = htons(hard_timeout);
994 ofm->buffer_id = htonl(UINT32_MAX);
995 ofm->priority = htons(priority);
997 send_openflow_buffer(vconn, buffer);
1004 do_mod_flows(int argc OVS_UNUSED, char *argv[])
1006 uint16_t priority, idle_timeout, hard_timeout;
1008 struct vconn *vconn;
1009 struct ofpbuf *buffer;
1010 struct ofp_flow_mod *ofm;
1011 struct ofp_match match;
1013 /* Parse and send. str_to_flow() will expand and reallocate the data in
1014 * 'buffer', so we can't keep pointers to across the str_to_flow() call. */
1015 make_openflow(sizeof *ofm, OFPT_FLOW_MOD, &buffer);
1016 str_to_flow(argv[2], &match, buffer,
1017 NULL, NULL, &priority, &idle_timeout, &hard_timeout,
1022 ofm->command = htons(OFPFC_MODIFY_STRICT);
1024 ofm->command = htons(OFPFC_MODIFY);
1026 ofm->idle_timeout = htons(idle_timeout);
1027 ofm->hard_timeout = htons(hard_timeout);
1028 ofm->cookie = htonll(cookie);
1029 ofm->buffer_id = htonl(UINT32_MAX);
1030 ofm->priority = htons(priority);
1032 open_vconn(argv[1], &vconn);
1033 send_openflow_buffer(vconn, buffer);
1037 static void do_del_flows(int argc, char *argv[])
1039 struct vconn *vconn;
1042 struct ofpbuf *buffer;
1043 struct ofp_flow_mod *ofm;
1045 /* Parse and send. */
1046 ofm = make_openflow(sizeof *ofm, OFPT_FLOW_MOD, &buffer);
1047 str_to_flow(argc > 2 ? argv[2] : "", &ofm->match, NULL, NULL,
1048 &out_port, &priority, NULL, NULL, NULL);
1050 ofm->command = htons(OFPFC_DELETE_STRICT);
1052 ofm->command = htons(OFPFC_DELETE);
1054 ofm->idle_timeout = htons(0);
1055 ofm->hard_timeout = htons(0);
1056 ofm->buffer_id = htonl(UINT32_MAX);
1057 ofm->out_port = htons(out_port);
1058 ofm->priority = htons(priority);
1060 open_vconn(argv[1], &vconn);
1061 send_openflow_buffer(vconn, buffer);
1066 do_tun_cookie(int argc OVS_UNUSED, char *argv[])
1068 struct nxt_tun_id_cookie *tun_id_cookie;
1069 struct ofpbuf *buffer;
1070 struct vconn *vconn;
1072 tun_id_cookie = make_openflow(sizeof *tun_id_cookie, OFPT_VENDOR, &buffer);
1074 tun_id_cookie->vendor = htonl(NX_VENDOR_ID);
1075 tun_id_cookie->subtype = htonl(NXT_TUN_ID_FROM_COOKIE);
1076 tun_id_cookie->set = !strcmp(argv[2], "true");
1078 open_vconn(argv[1], &vconn);
1079 send_openflow_buffer(vconn, buffer);
1084 monitor_vconn(struct vconn *vconn)
1088 run(vconn_recv_block(vconn, &b), "vconn_recv");
1089 ofp_print(stderr, b->data, b->size, 2);
1095 do_monitor(int argc, char *argv[])
1097 struct vconn *vconn;
1099 open_vconn(argv[1], &vconn);
1101 int miss_send_len = atoi(argv[2]);
1102 struct ofp_switch_config *osc;
1105 osc = make_openflow(sizeof *osc, OFPT_SET_CONFIG, &buf);
1106 osc->miss_send_len = htons(miss_send_len);
1107 send_openflow_buffer(vconn, buf);
1109 monitor_vconn(vconn);
1113 do_snoop(int argc OVS_UNUSED, char *argv[])
1115 struct vconn *vconn;
1117 open_vconn__(argv[1], "snoop", &vconn);
1118 monitor_vconn(vconn);
1122 do_dump_ports(int argc, char *argv[])
1124 struct ofp_port_stats_request *req;
1125 struct ofpbuf *request;
1128 req = alloc_stats_request(sizeof *req, OFPST_PORT, &request);
1129 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
1130 req->port_no = htons(port);
1131 dump_stats_transaction(argv[1], request);
1135 do_probe(int argc OVS_UNUSED, char *argv[])
1137 struct ofpbuf *request;
1138 struct vconn *vconn;
1139 struct ofpbuf *reply;
1141 make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
1142 open_vconn(argv[1], &vconn);
1143 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1144 if (reply->size != sizeof(struct ofp_header)) {
1145 ovs_fatal(0, "reply does not match request");
1147 ofpbuf_delete(reply);
1152 do_mod_port(int argc OVS_UNUSED, char *argv[])
1154 struct ofpbuf *request, *reply;
1155 struct ofp_switch_features *osf;
1156 struct ofp_port_mod *opm;
1157 struct vconn *vconn;
1164 /* Check if the argument is a port index. Otherwise, treat it as
1166 port_no = strtol(argv[2], &endptr, 10);
1167 if (port_no == 0 && endptr == argv[2]) {
1171 /* Send a "Features Request" to get the information we need in order
1172 * to modify the port. */
1173 make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
1174 open_vconn(argv[1], &vconn);
1175 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1178 n_ports = (reply->size - sizeof *osf) / sizeof *osf->ports;
1180 for (port_idx = 0; port_idx < n_ports; port_idx++) {
1181 if (port_no != -1) {
1182 /* Check argument as a port index */
1183 if (osf->ports[port_idx].port_no == htons(port_no)) {
1187 /* Check argument as an interface name */
1188 if (!strncmp((char *)osf->ports[port_idx].name, argv[2],
1189 sizeof osf->ports[0].name)) {
1195 if (port_idx == n_ports) {
1196 ovs_fatal(0, "couldn't find monitored port: %s", argv[2]);
1199 opm = make_openflow(sizeof(struct ofp_port_mod), OFPT_PORT_MOD, &request);
1200 opm->port_no = osf->ports[port_idx].port_no;
1201 memcpy(opm->hw_addr, osf->ports[port_idx].hw_addr, sizeof opm->hw_addr);
1202 opm->config = htonl(0);
1203 opm->mask = htonl(0);
1204 opm->advertise = htonl(0);
1206 printf("modifying port: %s\n", osf->ports[port_idx].name);
1208 if (!strncasecmp(argv[3], MOD_PORT_CMD_UP, sizeof MOD_PORT_CMD_UP)) {
1209 opm->mask |= htonl(OFPPC_PORT_DOWN);
1210 } else if (!strncasecmp(argv[3], MOD_PORT_CMD_DOWN,
1211 sizeof MOD_PORT_CMD_DOWN)) {
1212 opm->mask |= htonl(OFPPC_PORT_DOWN);
1213 opm->config |= htonl(OFPPC_PORT_DOWN);
1214 } else if (!strncasecmp(argv[3], MOD_PORT_CMD_FLOOD,
1215 sizeof MOD_PORT_CMD_FLOOD)) {
1216 opm->mask |= htonl(OFPPC_NO_FLOOD);
1217 } else if (!strncasecmp(argv[3], MOD_PORT_CMD_NOFLOOD,
1218 sizeof MOD_PORT_CMD_NOFLOOD)) {
1219 opm->mask |= htonl(OFPPC_NO_FLOOD);
1220 opm->config |= htonl(OFPPC_NO_FLOOD);
1222 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1225 send_openflow_buffer(vconn, request);
1227 ofpbuf_delete(reply);
1232 do_ping(int argc, char *argv[])
1234 size_t max_payload = 65535 - sizeof(struct ofp_header);
1235 unsigned int payload;
1236 struct vconn *vconn;
1239 payload = argc > 2 ? atoi(argv[2]) : 64;
1240 if (payload > max_payload) {
1241 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1244 open_vconn(argv[1], &vconn);
1245 for (i = 0; i < 10; i++) {
1246 struct timeval start, end;
1247 struct ofpbuf *request, *reply;
1248 struct ofp_header *rq_hdr, *rpy_hdr;
1250 rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
1251 OFPT_ECHO_REQUEST, &request);
1252 random_bytes(rq_hdr + 1, payload);
1254 gettimeofday(&start, NULL);
1255 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1256 gettimeofday(&end, NULL);
1258 rpy_hdr = reply->data;
1259 if (reply->size != request->size
1260 || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
1261 || rpy_hdr->xid != rq_hdr->xid
1262 || rpy_hdr->type != OFPT_ECHO_REPLY) {
1263 printf("Reply does not match request. Request:\n");
1264 ofp_print(stdout, request, request->size, 2);
1266 ofp_print(stdout, reply, reply->size, 2);
1268 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1269 reply->size - sizeof *rpy_hdr, argv[1], rpy_hdr->xid,
1270 (1000*(double)(end.tv_sec - start.tv_sec))
1271 + (.001*(end.tv_usec - start.tv_usec)));
1272 ofpbuf_delete(request);
1273 ofpbuf_delete(reply);
1279 do_benchmark(int argc OVS_UNUSED, char *argv[])
1281 size_t max_payload = 65535 - sizeof(struct ofp_header);
1282 struct timeval start, end;
1283 unsigned int payload_size, message_size;
1284 struct vconn *vconn;
1289 payload_size = atoi(argv[2]);
1290 if (payload_size > max_payload) {
1291 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1293 message_size = sizeof(struct ofp_header) + payload_size;
1295 count = atoi(argv[3]);
1297 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1298 count, message_size, count * message_size);
1300 open_vconn(argv[1], &vconn);
1301 gettimeofday(&start, NULL);
1302 for (i = 0; i < count; i++) {
1303 struct ofpbuf *request, *reply;
1304 struct ofp_header *rq_hdr;
1306 rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
1307 memset(rq_hdr + 1, 0, payload_size);
1308 run(vconn_transact(vconn, request, &reply), "transact");
1309 ofpbuf_delete(reply);
1311 gettimeofday(&end, NULL);
1314 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1315 + (.001*(end.tv_usec - start.tv_usec)));
1316 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1317 duration, count / (duration / 1000.0),
1318 count * message_size / (duration / 1000.0));
1322 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1327 static const struct command all_commands[] = {
1328 { "show", 1, 1, do_show },
1329 { "status", 1, 2, do_status },
1330 { "monitor", 1, 2, do_monitor },
1331 { "snoop", 1, 1, do_snoop },
1332 { "dump-desc", 1, 1, do_dump_desc },
1333 { "dump-tables", 1, 1, do_dump_tables },
1334 { "dump-flows", 1, 2, do_dump_flows },
1335 { "dump-aggregate", 1, 2, do_dump_aggregate },
1336 { "add-flow", 2, 2, do_add_flow },
1337 { "add-flows", 2, 2, do_add_flows },
1338 { "mod-flows", 2, 2, do_mod_flows },
1339 { "del-flows", 1, 2, do_del_flows },
1340 { "tun-cookie", 2, 2, do_tun_cookie },
1341 { "dump-ports", 1, 2, do_dump_ports },
1342 { "mod-port", 3, 3, do_mod_port },
1343 { "probe", 1, 1, do_probe },
1344 { "ping", 1, 2, do_ping },
1345 { "benchmark", 3, 3, do_benchmark },
1346 { "help", 0, INT_MAX, do_help },
1347 { NULL, 0, 0, NULL },