2 * Copyright (c) 2008, 2009 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>
23 #include <netinet/in.h>
32 #include "command-line.h"
36 #include "dynamic-string.h"
40 #include "ofp-print.h"
42 #include "openflow/nicira-ext.h"
43 #include "openflow/openflow.h"
46 #include "socket-util.h"
49 #include "vconn-ssl.h"
53 #define THIS_MODULE VLM_ofctl
55 #define DEFAULT_IDLE_TIMEOUT 60
57 #define MOD_PORT_CMD_UP "up"
58 #define MOD_PORT_CMD_DOWN "down"
59 #define MOD_PORT_CMD_FLOOD "flood"
60 #define MOD_PORT_CMD_NOFLOOD "noflood"
63 /* Settings that may be configured by the user. */
65 bool strict; /* Use strict matching for flow mod commands */
72 void (*handler)(const struct settings *, int argc, char *argv[]);
75 static struct command all_commands[];
77 static void usage(void) NO_RETURN;
78 static void parse_options(int argc, char *argv[], struct settings *);
80 int main(int argc, char *argv[])
85 set_program_name(argv[0]);
88 parse_options(argc, argv, &s);
89 signal(SIGPIPE, SIG_IGN);
94 ovs_fatal(0, "missing command name; use --help for help");
96 for (p = all_commands; p->name != NULL; p++) {
97 if (!strcmp(p->name, argv[0])) {
99 if (n_arg < p->min_args)
100 ovs_fatal(0, "'%s' command requires at least %d arguments",
101 p->name, p->min_args);
102 else if (n_arg > p->max_args)
103 ovs_fatal(0, "'%s' command takes at most %d arguments",
104 p->name, p->max_args);
106 p->handler(&s, argc, argv);
107 if (ferror(stdout)) {
108 ovs_fatal(0, "write to stdout failed");
110 if (ferror(stderr)) {
111 ovs_fatal(0, "write to stderr failed");
117 ovs_fatal(0, "unknown command '%s'; use --help for help", argv[0]);
123 parse_options(int argc, char *argv[], struct settings *s)
126 OPT_STRICT = UCHAR_MAX + 1
128 static struct option long_options[] = {
129 {"timeout", required_argument, 0, 't'},
130 {"verbose", optional_argument, 0, 'v'},
131 {"strict", no_argument, 0, OPT_STRICT},
132 {"help", no_argument, 0, 'h'},
133 {"version", no_argument, 0, 'V'},
134 VCONN_SSL_LONG_OPTIONS
137 char *short_options = long_options_to_short_options(long_options);
139 /* Set defaults that we can figure out before parsing options. */
143 unsigned long int timeout;
146 c = getopt_long(argc, argv, short_options, long_options, NULL);
153 timeout = strtoul(optarg, NULL, 10);
155 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
166 OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
170 vlog_set_verbosity(optarg);
177 VCONN_SSL_OPTION_HANDLERS
192 printf("%s: OpenFlow switch management utility\n"
193 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
194 "\nFor OpenFlow switches:\n"
195 " show SWITCH show OpenFlow information\n"
196 " status SWITCH [KEY] report statistics (about KEY)\n"
197 " dump-desc SWITCH print switch description\n"
198 " dump-tables SWITCH print table stats\n"
199 " mod-port SWITCH IFACE ACT modify port behavior\n"
200 " dump-ports SWITCH print port statistics\n"
201 " dump-flows SWITCH print all flow entries\n"
202 " dump-flows SWITCH FLOW print matching FLOWs\n"
203 " dump-aggregate SWITCH print aggregate flow statistics\n"
204 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
205 " add-flow SWITCH FLOW add flow described by FLOW\n"
206 " add-flows SWITCH FILE add flows from FILE\n"
207 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
208 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
209 " monitor SWITCH MISSLEN EXP print packets received from SWITCH\n"
210 " execute SWITCH CMD [ARG...] execute CMD with ARGS on SWITCH\n"
211 "\nFor OpenFlow switches and controllers:\n"
212 " probe VCONN probe whether VCONN is up\n"
213 " ping VCONN [N] latency of N-byte echos\n"
214 " benchmark VCONN N COUNT bandwidth of COUNT N-byte echos\n"
215 "where each SWITCH is an active OpenFlow connection method.\n",
216 program_name, program_name);
217 vconn_usage(true, false, false);
219 printf("\nOther options:\n"
220 " --strict use strict match for flow commands\n"
221 " -t, --timeout=SECS give up after SECS seconds\n"
222 " -h, --help display this help message\n"
223 " -V, --version display version information\n");
227 static void run(int retval, const char *message, ...)
230 static void run(int retval, const char *message, ...)
235 fprintf(stderr, "%s: ", program_name);
236 va_start(args, message);
237 vfprintf(stderr, message, args);
240 fputs(": unexpected end of file\n", stderr);
242 fprintf(stderr, ": %s\n", strerror(retval));
249 /* Generic commands. */
252 open_vconn(const char *name, struct vconn **vconnp)
257 if (strstr(name, ":")) {
258 run(vconn_open_block(name, OFP_VERSION, vconnp),
259 "connecting to %s", name);
260 } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
261 char *vconn_name = xasprintf("unix:%s", name);
262 VLOG_INFO("connecting to %s", vconn_name);
263 run(vconn_open_block(vconn_name, OFP_VERSION, vconnp),
264 "connecting to %s", vconn_name);
266 } else if (!dpif_open(name, &dpif)) {
267 char dpif_name[IF_NAMESIZE + 1];
271 run(dpif_port_get_name(dpif, ODPP_LOCAL, dpif_name, sizeof dpif_name),
272 "obtaining name of %s", dpif_name);
274 if (strcmp(dpif_name, name)) {
275 VLOG_INFO("datapath %s is named %s", name, dpif_name);
278 socket_name = xasprintf("%s/%s.mgmt", ovs_rundir, dpif_name);
279 if (stat(socket_name, &s)) {
280 ovs_fatal(errno, "cannot connect to %s: stat failed on %s",
282 } else if (!S_ISSOCK(s.st_mode)) {
283 ovs_fatal(0, "cannot connect to %s: %s is not a socket",
287 vconn_name = xasprintf("unix:%s", socket_name);
288 VLOG_INFO("connecting to %s", vconn_name);
289 run(vconn_open_block(vconn_name, OFP_VERSION, vconnp),
290 "connecting to %s", vconn_name);
294 ovs_fatal(0, "%s is not a valid connection method", name);
299 alloc_stats_request(size_t body_len, uint16_t type, struct ofpbuf **bufferp)
301 struct ofp_stats_request *rq;
302 rq = make_openflow((offsetof(struct ofp_stats_request, body)
303 + body_len), OFPT_STATS_REQUEST, bufferp);
304 rq->type = htons(type);
305 rq->flags = htons(0);
310 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
312 update_openflow_length(buffer);
313 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
317 dump_transaction(const char *vconn_name, struct ofpbuf *request)
320 struct ofpbuf *reply;
322 update_openflow_length(request);
323 open_vconn(vconn_name, &vconn);
324 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
325 ofp_print(stdout, reply->data, reply->size, 1);
330 dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
332 struct ofpbuf *request;
333 make_openflow(sizeof(struct ofp_header), request_type, &request);
334 dump_transaction(vconn_name, request);
338 dump_stats_transaction(const char *vconn_name, struct ofpbuf *request)
340 uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
344 open_vconn(vconn_name, &vconn);
345 send_openflow_buffer(vconn, request);
348 struct ofpbuf *reply;
350 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
351 recv_xid = ((struct ofp_header *) reply->data)->xid;
352 if (send_xid == recv_xid) {
353 struct ofp_stats_reply *osr;
355 ofp_print(stdout, reply->data, reply->size, 1);
357 osr = ofpbuf_at(reply, 0, sizeof *osr);
358 done = !osr || !(ntohs(osr->flags) & OFPSF_REPLY_MORE);
360 VLOG_DBG("received reply with xid %08"PRIx32" "
361 "!= expected %08"PRIx32, recv_xid, send_xid);
363 ofpbuf_delete(reply);
369 dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
371 struct ofpbuf *request;
372 alloc_stats_request(0, stats_type, &request);
373 dump_stats_transaction(vconn_name, request);
377 do_show(const struct settings *s UNUSED, int argc UNUSED, char *argv[])
379 dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
380 dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
384 do_status(const struct settings *s UNUSED, int argc, char *argv[])
386 struct nicira_header *request, *reply;
390 request = make_openflow(sizeof *request, OFPT_VENDOR, &b);
391 request->vendor = htonl(NX_VENDOR_ID);
392 request->subtype = htonl(NXT_STATUS_REQUEST);
394 ofpbuf_put(b, argv[2], strlen(argv[2]));
395 update_openflow_length(b);
397 open_vconn(argv[1], &vconn);
398 run(vconn_transact(vconn, b, &b), "talking to %s", argv[1]);
401 if (b->size < sizeof *reply) {
402 ovs_fatal(0, "short reply (%zu bytes)", b->size);
405 if (reply->header.type != OFPT_VENDOR
406 || reply->vendor != ntohl(NX_VENDOR_ID)
407 || reply->subtype != ntohl(NXT_STATUS_REPLY)) {
408 ofp_print(stderr, b->data, b->size, 2);
409 ovs_fatal(0, "bad reply");
412 fwrite(reply + 1, b->size - sizeof *reply, 1, stdout);
416 do_dump_desc(const struct settings *s UNUSED, int argc UNUSED, char *argv[])
418 dump_trivial_stats_transaction(argv[1], OFPST_DESC);
422 do_dump_tables(const struct settings *s UNUSED, int argc UNUSED, char *argv[])
424 dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
429 str_to_u32(const char *str)
435 value = strtoul(str, &tail, 0);
436 if (errno == EINVAL || errno == ERANGE || *tail) {
437 ovs_fatal(0, "invalid numeric format %s", str);
443 str_to_mac(const char *str, uint8_t mac[6])
445 if (sscanf(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
446 != ETH_ADDR_SCAN_COUNT) {
447 ovs_fatal(0, "invalid mac address %s", str);
452 str_to_ip(const char *str_, uint32_t *ip)
454 char *str = xstrdup(str_);
455 char *save_ptr = NULL;
456 const char *name, *netmask;
457 struct in_addr in_addr;
460 name = strtok_r(str, "/", &save_ptr);
461 retval = name ? lookup_ip(name, &in_addr) : EINVAL;
463 ovs_fatal(0, "%s: could not convert to IP address", str);
465 *ip = in_addr.s_addr;
467 netmask = strtok_r(NULL, "/", &save_ptr);
470 if (sscanf(netmask, "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8,
471 &o[0], &o[1], &o[2], &o[3]) == 4) {
472 uint32_t nm = (o[0] << 24) | (o[1] << 16) | (o[2] << 8) | o[3];
475 /* Find first 1-bit. */
476 for (i = 0; i < 32; i++) {
477 if (nm & (1u << i)) {
483 /* Verify that the rest of the bits are 1-bits. */
484 for (; i < 32; i++) {
485 if (!(nm & (1u << i))) {
486 ovs_fatal(0, "%s: %s is not a valid netmask",
491 int prefix = atoi(netmask);
492 if (prefix <= 0 || prefix > 32) {
493 ovs_fatal(0, "%s: network prefix bits not between 1 and 32",
496 n_wild = 32 - prefix;
507 put_action(struct ofpbuf *b, size_t size, uint16_t type)
509 struct ofp_action_header *ah = ofpbuf_put_zeros(b, size);
510 ah->type = htons(type);
511 ah->len = htons(size);
515 static struct ofp_action_output *
516 put_output_action(struct ofpbuf *b, uint16_t port)
518 struct ofp_action_output *oao = put_action(b, sizeof *oao, OFPAT_OUTPUT);
519 oao->port = htons(port);
524 put_dl_addr_action(struct ofpbuf *b, uint16_t type, const char *addr)
526 struct ofp_action_dl_addr *oada = put_action(b, sizeof *oada, type);
527 str_to_mac(addr, oada->dl_addr);
532 parse_port_name(const char *name, uint16_t *port)
538 static const struct pair pairs[] = {
539 #define DEF_PAIR(NAME) {#NAME, OFPP_##NAME}
545 DEF_PAIR(CONTROLLER),
550 static const int n_pairs = ARRAY_SIZE(pairs);
553 for (i = 0; i < n_pairs; i++) {
554 if (!strcasecmp(name, pairs[i].name)) {
555 *port = pairs[i].value;
563 str_to_action(char *str, struct ofpbuf *b)
566 char *saveptr = NULL;
570 for (act = strtok_r(str, ", \t\r\n", &saveptr), n_actions = 0; act;
571 act = strtok_r(NULL, ", \t\r\n", &saveptr), n_actions++)
576 ovs_fatal(0, "Drop actions must not be followed by other actions");
579 /* Arguments are separated by colons */
580 arg = strchr(act, ':');
586 if (!strcasecmp(act, "mod_vlan_vid")) {
587 struct ofp_action_vlan_vid *va;
588 va = put_action(b, sizeof *va, OFPAT_SET_VLAN_VID);
589 va->vlan_vid = htons(str_to_u32(arg));
590 } else if (!strcasecmp(act, "mod_vlan_pcp")) {
591 struct ofp_action_vlan_pcp *va;
592 va = put_action(b, sizeof *va, OFPAT_SET_VLAN_PCP);
593 va->vlan_pcp = str_to_u32(arg);
594 } else if (!strcasecmp(act, "strip_vlan")) {
595 struct ofp_action_header *ah;
596 ah = put_action(b, sizeof *ah, OFPAT_STRIP_VLAN);
597 ah->type = htons(OFPAT_STRIP_VLAN);
598 } else if (!strcasecmp(act, "mod_dl_src")) {
599 put_dl_addr_action(b, OFPAT_SET_DL_SRC, arg);
600 } else if (!strcasecmp(act, "mod_dl_dst")) {
601 put_dl_addr_action(b, OFPAT_SET_DL_DST, arg);
602 } else if (!strcasecmp(act, "output")) {
603 put_output_action(b, str_to_u32(arg));
604 } else if (!strcasecmp(act, "drop")) {
605 /* A drop action in OpenFlow occurs by just not setting
609 ovs_fatal(0, "Drop actions must not be preceded by other "
612 } else if (!strcasecmp(act, "CONTROLLER")) {
613 struct ofp_action_output *oao;
614 oao = put_output_action(b, OFPP_CONTROLLER);
616 /* Unless a numeric argument is specified, we send the whole
617 * packet to the controller. */
618 if (arg && (strspn(act, "0123456789") == strlen(act))) {
619 oao->max_len = htons(str_to_u32(arg));
621 oao->max_len = htons(UINT16_MAX);
623 } else if (parse_port_name(act, &port)) {
624 put_output_action(b, port);
625 } else if (strspn(act, "0123456789") == strlen(act)) {
626 put_output_action(b, str_to_u32(act));
628 ovs_fatal(0, "Unknown action: %s", act);
640 parse_protocol(const char *name, const struct protocol **p_out)
642 static const struct protocol protocols[] = {
643 { "ip", ETH_TYPE_IP, 0 },
644 { "arp", ETH_TYPE_ARP, 0 },
645 { "icmp", ETH_TYPE_IP, IP_TYPE_ICMP },
646 { "tcp", ETH_TYPE_IP, IP_TYPE_TCP },
647 { "udp", ETH_TYPE_IP, IP_TYPE_UDP },
649 const struct protocol *p;
651 for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
652 if (!strcmp(p->name, name)) {
664 enum { F_U8, F_U16, F_MAC, F_IP } type;
665 size_t offset, shift;
669 parse_field(const char *name, const struct field **f_out)
671 #define F_OFS(MEMBER) offsetof(struct ofp_match, MEMBER)
672 static const struct field fields[] = {
673 { "in_port", OFPFW_IN_PORT, F_U16, F_OFS(in_port), 0 },
674 { "dl_vlan", OFPFW_DL_VLAN, F_U16, F_OFS(dl_vlan), 0 },
675 { "dl_src", OFPFW_DL_SRC, F_MAC, F_OFS(dl_src), 0 },
676 { "dl_dst", OFPFW_DL_DST, F_MAC, F_OFS(dl_dst), 0 },
677 { "dl_type", OFPFW_DL_TYPE, F_U16, F_OFS(dl_type), 0 },
678 { "nw_src", OFPFW_NW_SRC_MASK, F_IP,
679 F_OFS(nw_src), OFPFW_NW_SRC_SHIFT },
680 { "nw_dst", OFPFW_NW_DST_MASK, F_IP,
681 F_OFS(nw_dst), OFPFW_NW_DST_SHIFT },
682 { "nw_proto", OFPFW_NW_PROTO, F_U8, F_OFS(nw_proto), 0 },
683 { "tp_src", OFPFW_TP_SRC, F_U16, F_OFS(tp_src), 0 },
684 { "tp_dst", OFPFW_TP_DST, F_U16, F_OFS(tp_dst), 0 },
685 { "icmp_type", OFPFW_ICMP_TYPE, F_U16, F_OFS(icmp_type), 0 },
686 { "icmp_code", OFPFW_ICMP_CODE, F_U16, F_OFS(icmp_code), 0 }
688 const struct field *f;
690 for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
691 if (!strcmp(f->name, name)) {
701 str_to_flow(char *string, struct ofp_match *match, struct ofpbuf *actions,
702 uint8_t *table_idx, uint16_t *out_port, uint16_t *priority,
703 uint16_t *idle_timeout, uint16_t *hard_timeout)
705 char *save_ptr = NULL;
713 *out_port = OFPP_NONE;
716 *priority = OFP_DEFAULT_PRIORITY;
719 *idle_timeout = DEFAULT_IDLE_TIMEOUT;
722 *hard_timeout = OFP_FLOW_PERMANENT;
725 char *act_str = strstr(string, "action");
727 ovs_fatal(0, "must specify an action");
731 act_str = strchr(act_str, '=');
733 ovs_fatal(0, "must specify an action");
738 str_to_action(act_str, actions);
740 memset(match, 0, sizeof *match);
741 wildcards = OFPFW_ALL;
742 for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
743 name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
744 const struct protocol *p;
746 if (parse_protocol(name, &p)) {
747 wildcards &= ~OFPFW_DL_TYPE;
748 match->dl_type = htons(p->dl_type);
750 wildcards &= ~OFPFW_NW_PROTO;
751 match->nw_proto = p->nw_proto;
754 const struct field *f;
757 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
759 ovs_fatal(0, "field %s missing value", name);
762 if (table_idx && !strcmp(name, "table")) {
763 *table_idx = atoi(value);
764 } else if (out_port && !strcmp(name, "out_port")) {
765 *out_port = atoi(value);
766 } else if (priority && !strcmp(name, "priority")) {
767 *priority = atoi(value);
768 } else if (idle_timeout && !strcmp(name, "idle_timeout")) {
769 *idle_timeout = atoi(value);
770 } else if (hard_timeout && !strcmp(name, "hard_timeout")) {
771 *hard_timeout = atoi(value);
772 } else if (parse_field(name, &f)) {
773 void *data = (char *) match + f->offset;
774 if (!strcmp(value, "*") || !strcmp(value, "ANY")) {
775 wildcards |= f->wildcard;
777 wildcards &= ~f->wildcard;
778 if (f->wildcard == OFPFW_IN_PORT
779 && parse_port_name(value, (uint16_t *) data)) {
781 } else if (f->type == F_U8) {
782 *(uint8_t *) data = str_to_u32(value);
783 } else if (f->type == F_U16) {
784 *(uint16_t *) data = htons(str_to_u32(value));
785 } else if (f->type == F_MAC) {
786 str_to_mac(value, data);
787 } else if (f->type == F_IP) {
788 wildcards |= str_to_ip(value, data) << f->shift;
794 ovs_fatal(0, "unknown keyword %s", name);
798 match->wildcards = htonl(wildcards);
802 do_dump_flows(const struct settings *s UNUSED, int argc, char *argv[])
804 struct ofp_flow_stats_request *req;
806 struct ofpbuf *request;
808 req = alloc_stats_request(sizeof *req, OFPST_FLOW, &request);
809 str_to_flow(argc > 2 ? argv[2] : "", &req->match, NULL,
810 &req->table_id, &out_port, NULL, NULL, NULL);
811 memset(&req->pad, 0, sizeof req->pad);
812 req->out_port = htons(out_port);
814 dump_stats_transaction(argv[1], request);
818 do_dump_aggregate(const struct settings *s UNUSED, int argc, char *argv[])
820 struct ofp_aggregate_stats_request *req;
821 struct ofpbuf *request;
824 req = alloc_stats_request(sizeof *req, OFPST_AGGREGATE, &request);
825 str_to_flow(argc > 2 ? argv[2] : "", &req->match, NULL,
826 &req->table_id, &out_port, NULL, NULL, NULL);
827 memset(&req->pad, 0, sizeof req->pad);
828 req->out_port = htons(out_port);
830 dump_stats_transaction(argv[1], request);
834 do_add_flow(const struct settings *s UNUSED, int argc UNUSED, char *argv[])
837 struct ofpbuf *buffer;
838 struct ofp_flow_mod *ofm;
839 uint16_t priority, idle_timeout, hard_timeout;
840 struct ofp_match match;
842 /* Parse and send. str_to_flow() will expand and reallocate the data in
843 * 'buffer', so we can't keep pointers to across the str_to_flow() call. */
844 make_openflow(sizeof *ofm, OFPT_FLOW_MOD, &buffer);
845 str_to_flow(argv[2], &match, buffer,
846 NULL, NULL, &priority, &idle_timeout, &hard_timeout);
849 ofm->command = htons(OFPFC_ADD);
850 ofm->idle_timeout = htons(idle_timeout);
851 ofm->hard_timeout = htons(hard_timeout);
852 ofm->buffer_id = htonl(UINT32_MAX);
853 ofm->priority = htons(priority);
854 ofm->reserved = htonl(0);
856 open_vconn(argv[1], &vconn);
857 send_openflow_buffer(vconn, buffer);
862 do_add_flows(const struct settings *s UNUSED, int argc UNUSED, char *argv[])
868 file = fopen(argv[2], "r");
870 ovs_fatal(errno, "%s: open", argv[2]);
873 open_vconn(argv[1], &vconn);
874 while (fgets(line, sizeof line, file)) {
875 struct ofpbuf *buffer;
876 struct ofp_flow_mod *ofm;
877 uint16_t priority, idle_timeout, hard_timeout;
878 struct ofp_match match;
882 /* Delete comments. */
883 comment = strchr(line, '#');
888 /* Drop empty lines. */
889 if (line[strspn(line, " \t\n")] == '\0') {
893 /* Parse and send. str_to_flow() will expand and reallocate the data
894 * in 'buffer', so we can't keep pointers to across the str_to_flow()
896 ofm = make_openflow(sizeof *ofm, OFPT_FLOW_MOD, &buffer);
897 str_to_flow(line, &match, buffer,
898 NULL, NULL, &priority, &idle_timeout, &hard_timeout);
901 ofm->command = htons(OFPFC_ADD);
902 ofm->idle_timeout = htons(idle_timeout);
903 ofm->hard_timeout = htons(hard_timeout);
904 ofm->buffer_id = htonl(UINT32_MAX);
905 ofm->priority = htons(priority);
906 ofm->reserved = htonl(0);
908 send_openflow_buffer(vconn, buffer);
915 do_mod_flows(const struct settings *s, int argc UNUSED, char *argv[])
917 uint16_t priority, idle_timeout, hard_timeout;
919 struct ofpbuf *buffer;
920 struct ofp_flow_mod *ofm;
921 struct ofp_match match;
923 /* Parse and send. str_to_flow() will expand and reallocate the data in
924 * 'buffer', so we can't keep pointers to across the str_to_flow() call. */
925 make_openflow(sizeof *ofm, OFPT_FLOW_MOD, &buffer);
926 str_to_flow(argv[2], &match, buffer,
927 NULL, NULL, &priority, &idle_timeout, &hard_timeout);
931 ofm->command = htons(OFPFC_MODIFY_STRICT);
933 ofm->command = htons(OFPFC_MODIFY);
935 ofm->idle_timeout = htons(idle_timeout);
936 ofm->hard_timeout = htons(hard_timeout);
937 ofm->buffer_id = htonl(UINT32_MAX);
938 ofm->priority = htons(priority);
939 ofm->reserved = htonl(0);
941 open_vconn(argv[1], &vconn);
942 send_openflow_buffer(vconn, buffer);
946 static void do_del_flows(const struct settings *s, int argc, char *argv[])
951 struct ofpbuf *buffer;
952 struct ofp_flow_mod *ofm;
954 /* Parse and send. */
955 ofm = make_openflow(sizeof *ofm, OFPT_FLOW_MOD, &buffer);
956 str_to_flow(argc > 2 ? argv[2] : "", &ofm->match, NULL, NULL,
957 &out_port, &priority, NULL, NULL);
959 ofm->command = htons(OFPFC_DELETE_STRICT);
961 ofm->command = htons(OFPFC_DELETE);
963 ofm->idle_timeout = htons(0);
964 ofm->hard_timeout = htons(0);
965 ofm->buffer_id = htonl(UINT32_MAX);
966 ofm->out_port = htons(out_port);
967 ofm->priority = htons(priority);
968 ofm->reserved = htonl(0);
970 open_vconn(argv[1], &vconn);
971 send_openflow_buffer(vconn, buffer);
976 do_monitor(const struct settings *s UNUSED, int argc UNUSED, char *argv[])
980 open_vconn(argv[1], &vconn);
982 int miss_send_len = atoi(argv[2]);
983 int send_flow_exp = argc > 3 ? atoi(argv[3]) : 0;
984 struct ofp_switch_config *osc;
987 osc = make_openflow(sizeof *osc, OFPT_SET_CONFIG, &buf);
988 osc->flags = htons(send_flow_exp ? OFPC_SEND_FLOW_EXP : 0);
989 osc->miss_send_len = htons(miss_send_len);
990 send_openflow_buffer(vconn, buf);
994 run(vconn_recv_block(vconn, &b), "vconn_recv");
995 ofp_print(stderr, b->data, b->size, 2);
1001 do_dump_ports(const struct settings *s UNUSED, int argc UNUSED, char *argv[])
1003 dump_trivial_stats_transaction(argv[1], OFPST_PORT);
1007 do_probe(const struct settings *s UNUSED, int argc UNUSED, char *argv[])
1009 struct ofpbuf *request;
1010 struct vconn *vconn;
1011 struct ofpbuf *reply;
1013 make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
1014 open_vconn(argv[1], &vconn);
1015 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1016 if (reply->size != sizeof(struct ofp_header)) {
1017 ovs_fatal(0, "reply does not match request");
1019 ofpbuf_delete(reply);
1024 do_mod_port(const struct settings *s UNUSED, int argc UNUSED, char *argv[])
1026 struct ofpbuf *request, *reply;
1027 struct ofp_switch_features *osf;
1028 struct ofp_port_mod *opm;
1029 struct vconn *vconn;
1036 /* Check if the argument is a port index. Otherwise, treat it as
1038 port_no = strtol(argv[2], &endptr, 10);
1039 if (port_no == 0 && endptr == argv[2]) {
1043 /* Send a "Features Request" to get the information we need in order
1044 * to modify the port. */
1045 make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
1046 open_vconn(argv[1], &vconn);
1047 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1050 n_ports = (reply->size - sizeof *osf) / sizeof *osf->ports;
1052 for (port_idx = 0; port_idx < n_ports; port_idx++) {
1053 if (port_no != -1) {
1054 /* Check argument as a port index */
1055 if (osf->ports[port_idx].port_no == htons(port_no)) {
1059 /* Check argument as an interface name */
1060 if (!strncmp((char *)osf->ports[port_idx].name, argv[2],
1061 sizeof osf->ports[0].name)) {
1067 if (port_idx == n_ports) {
1068 ovs_fatal(0, "couldn't find monitored port: %s", argv[2]);
1071 opm = make_openflow(sizeof(struct ofp_port_mod), OFPT_PORT_MOD, &request);
1072 opm->port_no = osf->ports[port_idx].port_no;
1073 memcpy(opm->hw_addr, osf->ports[port_idx].hw_addr, sizeof opm->hw_addr);
1074 opm->config = htonl(0);
1075 opm->mask = htonl(0);
1076 opm->advertise = htonl(0);
1078 printf("modifying port: %s\n", osf->ports[port_idx].name);
1080 if (!strncasecmp(argv[3], MOD_PORT_CMD_UP, sizeof MOD_PORT_CMD_UP)) {
1081 opm->mask |= htonl(OFPPC_PORT_DOWN);
1082 } else if (!strncasecmp(argv[3], MOD_PORT_CMD_DOWN,
1083 sizeof MOD_PORT_CMD_DOWN)) {
1084 opm->mask |= htonl(OFPPC_PORT_DOWN);
1085 opm->config |= htonl(OFPPC_PORT_DOWN);
1086 } else if (!strncasecmp(argv[3], MOD_PORT_CMD_FLOOD,
1087 sizeof MOD_PORT_CMD_FLOOD)) {
1088 opm->mask |= htonl(OFPPC_NO_FLOOD);
1089 } else if (!strncasecmp(argv[3], MOD_PORT_CMD_NOFLOOD,
1090 sizeof MOD_PORT_CMD_NOFLOOD)) {
1091 opm->mask |= htonl(OFPPC_NO_FLOOD);
1092 opm->config |= htonl(OFPPC_NO_FLOOD);
1094 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1097 send_openflow_buffer(vconn, request);
1099 ofpbuf_delete(reply);
1104 do_ping(const struct settings *s UNUSED, int argc, char *argv[])
1106 size_t max_payload = 65535 - sizeof(struct ofp_header);
1107 unsigned int payload;
1108 struct vconn *vconn;
1111 payload = argc > 2 ? atoi(argv[2]) : 64;
1112 if (payload > max_payload) {
1113 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1116 open_vconn(argv[1], &vconn);
1117 for (i = 0; i < 10; i++) {
1118 struct timeval start, end;
1119 struct ofpbuf *request, *reply;
1120 struct ofp_header *rq_hdr, *rpy_hdr;
1122 rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
1123 OFPT_ECHO_REQUEST, &request);
1124 random_bytes(rq_hdr + 1, payload);
1126 gettimeofday(&start, NULL);
1127 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1128 gettimeofday(&end, NULL);
1130 rpy_hdr = reply->data;
1131 if (reply->size != request->size
1132 || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
1133 || rpy_hdr->xid != rq_hdr->xid
1134 || rpy_hdr->type != OFPT_ECHO_REPLY) {
1135 printf("Reply does not match request. Request:\n");
1136 ofp_print(stdout, request, request->size, 2);
1138 ofp_print(stdout, reply, reply->size, 2);
1140 printf("%d bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1141 reply->size - sizeof *rpy_hdr, argv[1], rpy_hdr->xid,
1142 (1000*(double)(end.tv_sec - start.tv_sec))
1143 + (.001*(end.tv_usec - start.tv_usec)));
1144 ofpbuf_delete(request);
1145 ofpbuf_delete(reply);
1151 do_benchmark(const struct settings *s UNUSED, int argc UNUSED, char *argv[])
1153 size_t max_payload = 65535 - sizeof(struct ofp_header);
1154 struct timeval start, end;
1155 unsigned int payload_size, message_size;
1156 struct vconn *vconn;
1161 payload_size = atoi(argv[2]);
1162 if (payload_size > max_payload) {
1163 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1165 message_size = sizeof(struct ofp_header) + payload_size;
1167 count = atoi(argv[3]);
1169 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1170 count, message_size, count * message_size);
1172 open_vconn(argv[1], &vconn);
1173 gettimeofday(&start, NULL);
1174 for (i = 0; i < count; i++) {
1175 struct ofpbuf *request, *reply;
1176 struct ofp_header *rq_hdr;
1178 rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
1179 memset(rq_hdr + 1, 0, payload_size);
1180 run(vconn_transact(vconn, request, &reply), "transact");
1181 ofpbuf_delete(reply);
1183 gettimeofday(&end, NULL);
1186 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1187 + (.001*(end.tv_usec - start.tv_usec)));
1188 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1189 duration, count / (duration / 1000.0),
1190 count * message_size / (duration / 1000.0));
1194 do_execute(const struct settings *s UNUSED, int argc, char *argv[])
1196 struct vconn *vconn;
1197 struct ofpbuf *request;
1198 struct nicira_header *nicira;
1199 struct nx_command_reply *ncr;
1203 nicira = make_openflow(sizeof *nicira, OFPT_VENDOR, &request);
1204 xid = nicira->header.xid;
1205 nicira->vendor = htonl(NX_VENDOR_ID);
1206 nicira->subtype = htonl(NXT_COMMAND_REQUEST);
1207 ofpbuf_put(request, argv[2], strlen(argv[2]));
1208 for (i = 3; i < argc; i++) {
1209 ofpbuf_put_zeros(request, 1);
1210 ofpbuf_put(request, argv[i], strlen(argv[i]));
1212 update_openflow_length(request);
1214 open_vconn(argv[1], &vconn);
1215 run(vconn_send_block(vconn, request), "send");
1218 struct ofpbuf *reply;
1221 run(vconn_recv_xid(vconn, xid, &reply), "recv_xid");
1222 if (reply->size < sizeof *ncr) {
1223 ovs_fatal(0, "reply is too short (%zu bytes < %zu bytes)",
1224 reply->size, sizeof *ncr);
1227 if (ncr->nxh.header.type != OFPT_VENDOR
1228 || ncr->nxh.vendor != htonl(NX_VENDOR_ID)
1229 || ncr->nxh.subtype != htonl(NXT_COMMAND_REPLY)) {
1230 ovs_fatal(0, "reply is invalid");
1233 status = ntohl(ncr->status);
1234 if (status & NXT_STATUS_STARTED) {
1235 /* Wait for a second reply. */
1237 } else if (status & NXT_STATUS_EXITED) {
1238 fprintf(stderr, "process terminated normally with exit code %d",
1239 status & NXT_STATUS_EXITSTATUS);
1240 } else if (status & NXT_STATUS_SIGNALED) {
1241 fprintf(stderr, "process terminated by signal %d",
1242 status & NXT_STATUS_TERMSIG);
1243 } else if (status & NXT_STATUS_ERROR) {
1244 fprintf(stderr, "error executing command");
1246 fprintf(stderr, "process terminated for unknown reason");
1248 if (status & NXT_STATUS_COREDUMP) {
1249 fprintf(stderr, " (core dumped)");
1253 fwrite(ncr + 1, reply->size - sizeof *ncr, 1, stdout);
1259 do_help(const struct settings *s UNUSED, int argc UNUSED, char *argv[] UNUSED)
1264 static struct command all_commands[] = {
1265 { "show", 1, 1, do_show },
1266 { "status", 1, 2, do_status },
1267 { "monitor", 1, 3, do_monitor },
1268 { "dump-desc", 1, 1, do_dump_desc },
1269 { "dump-tables", 1, 1, do_dump_tables },
1270 { "dump-flows", 1, 2, do_dump_flows },
1271 { "dump-aggregate", 1, 2, do_dump_aggregate },
1272 { "add-flow", 2, 2, do_add_flow },
1273 { "add-flows", 2, 2, do_add_flows },
1274 { "mod-flows", 2, 2, do_mod_flows },
1275 { "del-flows", 1, 2, do_del_flows },
1276 { "dump-ports", 1, 1, do_dump_ports },
1277 { "mod-port", 3, 3, do_mod_port },
1278 { "probe", 1, 1, do_probe },
1279 { "ping", 1, 2, do_ping },
1280 { "benchmark", 3, 3, do_benchmark },
1281 { "execute", 2, INT_MAX, do_execute },
1282 { "help", 0, INT_MAX, do_help },
1283 { NULL, 0, 0, NULL },