Make facility and level optional in -v, --verbose options.
[sliver-openvswitch.git] / secchan / secchan.c
1  /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
2  * Junior University
3  * 
4  * We are making the OpenFlow specification and associated documentation
5  * (Software) available for public use and benefit with the expectation
6  * that others will use, modify and enhance the Software and contribute
7  * those enhancements back to the community. However, since we would
8  * like to make the Software available for broadest use, with as few
9  * restrictions as possible permission is hereby granted, free of
10  * charge, to any person obtaining a copy of this Software to deal in
11  * the Software under the copyrights without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  * 
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  * 
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27  * SOFTWARE.
28  * 
29  * The name and trademarks of copyright holder(s) may NOT be used in
30  * advertising or publicity pertaining to the Software or any
31  * derivatives without specific, written prior permission.
32  */
33
34 #include <errno.h>
35 #include <getopt.h>
36 #include <inttypes.h>
37 #include <netinet/in.h>
38 #include <poll.h>
39 #include <stdlib.h>
40 #include <string.h>
41 #include <time.h>
42 #include <unistd.h>
43
44 #include "buffer.h"
45 #include "command-line.h"
46 #include "compiler.h"
47 #include "daemon.h"
48 #include "fault.h"
49 #include "flow.h"
50 #include "learning-switch.h"
51 #include "list.h"
52 #include "mac-learning.h"
53 #include "netdev.h"
54 #include "openflow.h"
55 #include "packets.h"
56 #include "poll-loop.h"
57 #include "rconn.h"
58 #include "util.h"
59 #include "vconn-ssl.h"
60 #include "vconn.h"
61 #include "vlog-socket.h"
62
63 #include "vlog.h"
64 #define THIS_MODULE VLM_secchan
65
66 #include "ofp-print.h"
67
68 static const char *listen_vconn_name;
69
70 struct half {
71     struct rconn *rconn;
72     struct buffer *rxbuf;
73 };
74
75 /* Behavior when the connection to the controller fails. */
76 enum fail_mode {
77     FAIL_OPEN,                  /* Act as learning switch. */
78     FAIL_CLOSED                 /* Drop all packets. */
79 };
80
81 struct relay {
82     struct list node;
83
84 #define HALF_LOCAL 0
85 #define HALF_REMOTE 1
86     struct half halves[2];
87
88     bool is_mgmt_conn;
89     struct lswitch *lswitch;
90 };
91
92 static struct list relays = LIST_INITIALIZER(&relays);
93
94 /* Enable the local port? */
95 static int local_port;
96
97 /* MAC address of local port. */
98 static uint8_t local_mac[ETH_ADDR_LEN];
99
100 /* MAC learning table for local port. */
101 static struct mac_learning *local_ml;
102
103 /* -f, --fail: Behavior when the connection to the controller fails. */
104 static enum fail_mode fail_mode = FAIL_OPEN;
105
106 /* The OpenFlow virtual network device ofX. */
107 static struct netdev *of_device;
108
109 /* --inactivity-probe: Number of seconds without receiving a message from the
110    controller before sending an inactivity probe. */
111 static int probe_interval = 15;
112
113 /* --max-idle: Idle time to assign to flows created by learning switch when in
114  * fail-open mode. */
115 static int max_idle = 15;
116
117 /* --max-backoff: Maximum interval between controller connection attempts, in
118  * seconds. */
119 static int max_backoff = 15;
120
121 static void parse_options(int argc, char *argv[]);
122 static void usage(void) NO_RETURN;
123
124 static void new_management_connection(const char *nl_name, struct vconn *new_remote);
125 static struct relay *relay_create(struct rconn *local, struct rconn *remote,
126                                   bool is_mgmt_conn);
127 static void relay_run(struct relay *);
128 static void relay_wait(struct relay *);
129 static void relay_destroy(struct relay *);
130
131 static bool local_hook(struct relay *r);
132 static bool failing_open(struct relay *r);
133 static bool fail_open_hook(struct relay *r);
134
135 int
136 main(int argc, char *argv[])
137 {
138     struct rconn *local_rconn, *remote_rconn;
139     struct vconn *listen_vconn;
140     struct relay *controller_relay;
141     const char *nl_name;
142     char of_name[16];
143     int retval;
144
145     set_program_name(argv[0]);
146     register_fault_handlers();
147     vlog_init();
148     parse_options(argc, argv);
149
150     if (argc - optind != 2) {
151         fatal(0,
152               "need exactly two non-option arguments; use --help for usage");
153     }
154     nl_name = argv[optind];
155     if (strncmp(nl_name, "nl:", 3)
156         || strlen(nl_name) < 4
157         || nl_name[strspn(nl_name + 3, "0123456789") + 3]) {
158         fatal(0, "%s: argument is not of the form \"nl:DP_IDX\"", nl_name);
159     }
160
161     if (listen_vconn_name) {
162         retval = vconn_open(listen_vconn_name, &listen_vconn);
163         if (retval && retval != EAGAIN) {
164             fatal(retval, "opening %s", listen_vconn_name);
165         }
166         if (!vconn_is_passive(listen_vconn)) {
167             fatal(0, "%s is not a passive vconn", listen_vconn_name);
168         }
169     } else {
170         listen_vconn = NULL;
171     }
172
173     snprintf(of_name, sizeof of_name, "of%s", nl_name + 3);
174     retval = netdev_open(of_name, NETDEV_ETH_TYPE_NONE, &of_device);
175     if (!retval) {
176         enum netdev_flags flags;
177         retval = netdev_get_flags(of_device, &flags);
178         if (!retval) {
179             if (flags & NETDEV_UP) {
180                 struct in6_addr in6;
181
182                 local_port = true;
183                 memcpy(local_mac, netdev_get_etheraddr(of_device),
184                        ETH_ADDR_LEN);
185                 if (netdev_get_in6(of_device, &in6)) {
186                     VLOG_WARN("Ignoring IPv6 address on %s device: "
187                               "IPv6 not supported", of_name);
188                 }
189                 local_ml = mac_learning_create();
190             }
191         } else {
192             error(retval, "Could not get flags for %s device", of_name);
193         }
194     } else {
195         error(retval, "Could not open %s device", of_name);
196     }
197
198     retval = vlog_server_listen(NULL, NULL);
199     if (retval) {
200         fatal(retval, "Could not listen for vlog connections");
201     }
202
203     daemonize();
204
205     local_rconn = rconn_create(1, 0, max_backoff);
206     retval = rconn_connect(local_rconn, nl_name);
207     if (retval == EAFNOSUPPORT) {
208         fatal(0, "No support for %s vconn", nl_name);
209     }
210
211     remote_rconn = rconn_create(1, probe_interval, max_backoff);
212     retval = rconn_connect(remote_rconn, argv[optind + 1]);
213     if (retval == EAFNOSUPPORT) {
214         fatal(0, "No support for %s vconn", argv[optind + 1]);
215     }
216     controller_relay = relay_create(local_rconn, remote_rconn, false);
217     for (;;) {
218         struct relay *r, *n;
219
220         /* Do work. */
221         LIST_FOR_EACH_SAFE (r, n, struct relay, node, &relays) {
222             relay_run(r);
223         }
224         if (listen_vconn) {
225             for (;;) {
226                 struct vconn *new_remote;
227                 retval = vconn_accept(listen_vconn, &new_remote);
228                 if (retval) {
229                     if (retval != EAGAIN) {
230                         VLOG_WARN("accept failed (%s)", strerror(retval));
231                     }
232                     break;
233                 }
234                 new_management_connection(nl_name, new_remote);
235             }
236         }
237         failing_open(controller_relay);
238
239         /* Wait for something to happen. */
240         LIST_FOR_EACH (r, struct relay, node, &relays) {
241             relay_wait(r);
242         }
243         if (listen_vconn) {
244             vconn_accept_wait(listen_vconn);
245         }
246         poll_block();
247     }
248
249     return 0;
250 }
251
252 static void
253 new_management_connection(const char *nl_name, struct vconn *new_remote)
254 {
255     char *nl_name_without_subscription;
256     struct vconn *new_local;
257     struct rconn *r1, *r2;
258     int retval;
259
260     /* nl:123 or nl:123:1 opens a netlink connection to local datapath 123.  We
261      * only accept the former syntax in main().
262      *
263      * nl:123:0 opens a netlink connection to local datapath 123 without
264      * obtaining a subscription for ofp_packet_in or ofp_flow_expired
265      * messages.*/
266     nl_name_without_subscription = xasprintf("%s:0", nl_name);
267     retval = vconn_open(nl_name_without_subscription, &new_local);
268     if (retval) {
269         VLOG_ERR("could not connect to %s (%s)",
270                  nl_name_without_subscription, strerror(retval));
271         vconn_close(new_remote);
272         free(nl_name_without_subscription);
273         return;
274     }
275
276     /* Add it to the relay list. */
277     r1 = rconn_new_from_vconn(nl_name_without_subscription, 1, new_local);
278     r2 = rconn_new_from_vconn("passive", 1, new_remote);
279     relay_create(r1, r2, true);
280
281     free(nl_name_without_subscription);
282 }
283
284 static struct relay *
285 relay_create(struct rconn *local, struct rconn *remote, bool is_mgmt_conn)
286 {
287     struct relay *r;
288     int i;
289
290     r = xmalloc(sizeof *r);
291     r->halves[HALF_LOCAL].rconn = local;
292     r->halves[HALF_REMOTE].rconn = remote;
293     for (i = 0; i < 2; i++) {
294         r->halves[i].rxbuf = NULL;
295     }
296     r->is_mgmt_conn = is_mgmt_conn;
297     r->lswitch = NULL;
298     list_push_back(&relays, &r->node);
299     return r;
300 }
301
302 static void
303 relay_run(struct relay *r)
304 {
305     int iteration;
306     int i;
307
308     for (i = 0; i < 2; i++) {
309         rconn_run(r->halves[i].rconn);
310     }
311
312     /* Limit the number of iterations to prevent other tasks from starving. */
313     for (iteration = 0; iteration < 50; iteration++) {
314         bool progress = false;
315         for (i = 0; i < 2; i++) {
316             struct half *this = &r->halves[i];
317             struct half *peer = &r->halves[!i];
318
319             if (!this->rxbuf) {
320                 this->rxbuf = rconn_recv(this->rconn);
321                 if (this->rxbuf && !r->is_mgmt_conn && i == HALF_LOCAL
322                     && (local_hook(r) || fail_open_hook(r))) {
323                     buffer_delete(this->rxbuf);
324                     this->rxbuf = NULL;
325                 }
326             }
327
328             if (this->rxbuf) {
329                 int retval = rconn_send(peer->rconn, this->rxbuf);
330                 if (retval != EAGAIN) {
331                     if (!retval) {
332                         progress = true;
333                     } else {
334                         buffer_delete(this->rxbuf);
335                     }
336                     this->rxbuf = NULL;
337                 }
338             }
339         }
340         if (!progress) {
341             break;
342         }
343     }
344
345     for (i = 0; i < 2; i++) {
346         struct half *this = &r->halves[i];
347         if (!rconn_is_alive(this->rconn)) {
348             relay_destroy(r);
349             return;
350         }
351     }
352 }
353
354 static void
355 relay_wait(struct relay *r)
356 {
357     int i;
358
359     for (i = 0; i < 2; i++) {
360         struct half *this = &r->halves[i];
361
362         rconn_run_wait(this->rconn);
363         if (!this->rxbuf) {
364             rconn_recv_wait(this->rconn);
365         }
366     }
367 }
368
369 static void
370 relay_destroy(struct relay *r)
371 {
372     int i;
373
374     list_remove(&r->node);
375     for (i = 0; i < 2; i++) {
376         struct half *this = &r->halves[i];
377         rconn_destroy(this->rconn);
378         buffer_delete(this->rxbuf);
379     }
380     free(r);
381 }
382
383 static bool
384 is_controller_mac(const uint8_t dl_addr[ETH_ADDR_LEN],
385                   struct rconn *controller) 
386 {
387     static uint32_t ip, last_nonzero_ip;
388     static uint8_t mac[ETH_ADDR_LEN], last_nonzero_mac[ETH_ADDR_LEN];
389     static time_t next_refresh = 0;
390
391     uint32_t last_ip = ip;
392
393     time_t now = time(0);
394
395     ip = rconn_get_ip(controller);
396     if (last_ip != ip || !next_refresh || now >= next_refresh) {
397         bool have_mac;
398
399         /* Look up MAC address. */
400         memset(mac, 0, sizeof mac);
401         if (ip) {
402             int retval = netdev_arp_lookup(of_device, ip, mac);
403             if (retval) {
404                 VLOG_DBG("cannot look up controller hw address ("IP_FMT"): %s",
405                          IP_ARGS(&ip), strerror(retval));
406             }
407         }
408         have_mac = !eth_addr_is_zero(mac);
409
410         /* Log changes in IP, MAC addresses. */
411         if (ip && ip != last_nonzero_ip) {
412             VLOG_DBG("controller IP address changed from "IP_FMT
413                      " to "IP_FMT, IP_ARGS(&last_nonzero_ip), IP_ARGS(&ip));
414             last_nonzero_ip = ip;
415         }
416         if (have_mac && memcmp(last_nonzero_mac, mac, ETH_ADDR_LEN)) {
417             VLOG_DBG("controller MAC address changed from "ETH_ADDR_FMT" to "
418                      ETH_ADDR_FMT,
419                      ETH_ADDR_ARGS(last_nonzero_mac), ETH_ADDR_ARGS(mac));
420             memcpy(last_nonzero_mac, mac, ETH_ADDR_LEN);
421         }
422
423         /* Schedule next refresh.
424          *
425          * If we have an IP address but not a MAC address, then refresh
426          * quickly, since we probably will get a MAC address soon (via ARP).
427          * Otherwise, we can afford to wait a little while. */
428         next_refresh = now + (!ip || have_mac ? 10 : 1);
429     }
430     return !eth_addr_is_zero(mac) && eth_addr_equals(mac, dl_addr);
431 }
432
433 static bool
434 local_hook(struct relay *r)
435 {
436     struct rconn *rc = r->halves[HALF_LOCAL].rconn;
437     struct buffer *msg = r->halves[HALF_LOCAL].rxbuf;
438     struct ofp_packet_in *opi;
439     struct ofp_header *oh;
440     size_t pkt_ofs, pkt_len;
441     struct buffer pkt, *b;
442     struct flow flow;
443     uint16_t in_port, out_port;
444
445     if (!local_port) {
446         return false;
447     }
448
449     oh = msg->data;
450     if (oh->type != OFPT_PACKET_IN) {
451         return false;
452     }
453     if (msg->size < offsetof (struct ofp_packet_in, data)) {
454         VLOG_WARN("packet too short (%zu bytes) for packet_in", msg->size);
455         return false;
456     }
457
458     /* Extract flow data from 'opi' into 'flow'. */
459     opi = msg->data;
460     in_port = ntohs(opi->in_port);
461     pkt_ofs = offsetof(struct ofp_packet_in, data);
462     pkt_len = ntohs(opi->header.length) - pkt_ofs;
463     pkt.data = opi->data;
464     pkt.size = pkt_len;
465     flow_extract(&pkt, in_port, &flow);
466
467     /* Deal with local stuff. */
468     if (in_port == OFPP_LOCAL) {
469         out_port = mac_learning_lookup(local_ml, flow.dl_dst);
470     } else if (eth_addr_equals(flow.dl_dst, local_mac)) {
471         out_port = OFPP_LOCAL;
472         if (mac_learning_learn(local_ml, flow.dl_src, in_port)) {
473             VLOG_DBG("learned that "ETH_ADDR_FMT" is on port %"PRIu16,
474                      ETH_ADDR_ARGS(flow.dl_src), in_port);
475         }
476     } else if (flow.dl_type == htons(ETH_TYPE_ARP)
477                && eth_addr_is_broadcast(flow.dl_dst)
478                && is_controller_mac(flow.dl_src,
479                                     r->halves[HALF_REMOTE].rconn)) {
480         out_port = OFPP_FLOOD;
481     } else {
482         return false;
483     }
484
485     /* Add new flow. */
486     if (out_port != OFPP_FLOOD) {
487         b = make_add_simple_flow(&flow, ntohl(opi->buffer_id), out_port,
488                                  max_idle);
489         if (rconn_force_send(rc, b)) {
490             buffer_delete(b);
491         }
492     }
493
494     /* If the switch didn't buffer the packet, we need to send a copy. */
495     if (out_port == OFPP_FLOOD || ntohl(opi->buffer_id) == UINT32_MAX) {
496         b = make_unbuffered_packet_out(&pkt, in_port, out_port);
497         if (rconn_force_send(rc, b)) {
498             buffer_delete(b);
499         }
500     }
501     return true;
502 }
503
504 /* Causess 'r' to enter or leave fail-open mode, if appropriate.  Returns true
505  * if 'r' is in fail-open fail, false otherwise. */
506 static bool
507 failing_open(struct relay *r)
508 {
509     struct rconn *local = r->halves[HALF_LOCAL].rconn;
510     struct rconn *remote = r->halves[HALF_REMOTE].rconn;
511     int disconnected_duration;
512
513     if (fail_mode == FAIL_CLOSED) {
514         /* We fail closed, so there's never anything to do. */
515         return false;
516     }
517
518     disconnected_duration = rconn_disconnected_duration(remote);
519     if (disconnected_duration < probe_interval * 3) {
520         /* It's not time to fail open yet. */
521         if (r->lswitch && rconn_is_connected(remote)) {
522             /* We're connected, so drop the learning switch. */
523             VLOG_WARN("No longer in fail-open mode");
524             lswitch_destroy(r->lswitch);
525             r->lswitch = NULL;
526         }
527         return false;
528     }
529
530     if (!r->lswitch) {
531         VLOG_WARN("Could not connect to controller for %d seconds, "
532                   "failing open", disconnected_duration);
533         r->lswitch = lswitch_create(local, true, max_idle);
534     }
535     return true;
536 }
537
538 static bool
539 fail_open_hook(struct relay *r)
540 {
541     if (!failing_open(r)) {
542         return false;
543     } else {
544         struct buffer *msg = r->halves[HALF_LOCAL].rxbuf;
545         struct rconn *local = r->halves[HALF_LOCAL].rconn;
546         lswitch_process_packet(r->lswitch, local, msg);
547         rconn_run(local);
548         return true;
549     }
550 }
551
552 static void
553 parse_options(int argc, char *argv[]) 
554 {
555     enum {
556         OPT_INACTIVITY_PROBE = UCHAR_MAX + 1,
557         OPT_MAX_IDLE,
558         OPT_MAX_BACKOFF
559     };
560     static struct option long_options[] = {
561         {"fail",        required_argument, 0, 'f'},
562         {"inactivity-probe", required_argument, 0, OPT_INACTIVITY_PROBE},
563         {"max-idle",    required_argument, 0, OPT_MAX_IDLE},
564         {"max-backoff", required_argument, 0, OPT_MAX_BACKOFF},
565         {"listen",      required_argument, 0, 'l'},
566         {"detach",      no_argument, 0, 'D'},
567         {"pidfile",     optional_argument, 0, 'P'},
568         {"verbose",     optional_argument, 0, 'v'},
569         {"help",        no_argument, 0, 'h'},
570         {"version",     no_argument, 0, 'V'},
571         VCONN_SSL_LONG_OPTIONS
572         {0, 0, 0, 0},
573     };
574     char *short_options = long_options_to_short_options(long_options);
575     
576     for (;;) {
577         int c;
578
579         c = getopt_long(argc, argv, short_options, long_options, NULL);
580         if (c == -1) {
581             break;
582         }
583
584         switch (c) {
585         case 'f':
586             if (!strcmp(optarg, "open")) {
587                 fail_mode = FAIL_OPEN;
588             } else if (!strcmp(optarg, "closed")) {
589                 fail_mode = FAIL_CLOSED;
590             } else {
591                 fatal(0,
592                       "-f or --fail argument must be \"open\" or \"closed\"");
593             }
594             break;
595
596         case OPT_INACTIVITY_PROBE:
597             probe_interval = atoi(optarg);
598             if (probe_interval < 5) {
599                 fatal(0, "--inactivity-probe argument must be at least 5");
600             }
601             break;
602
603         case OPT_MAX_IDLE:
604             if (!strcmp(optarg, "permanent")) {
605                 max_idle = OFP_FLOW_PERMANENT;
606             } else {
607                 max_idle = atoi(optarg);
608                 if (max_idle < 1 || max_idle > 65535) {
609                     fatal(0, "--max-idle argument must be between 1 and "
610                           "65535 or the word 'permanent'");
611                 }
612             }
613             break;
614
615         case OPT_MAX_BACKOFF:
616             max_backoff = atoi(optarg);
617             if (max_backoff < 1) {
618                 fatal(0, "--max-backoff argument must be at least 1");
619             } else if (max_backoff > 3600) {
620                 max_backoff = 3600;
621             }
622             break;
623
624         case 'D':
625             set_detach();
626             break;
627
628         case 'P':
629             set_pidfile(optarg ? optarg : "secchan.pid");
630             break;
631
632         case 'l':
633             if (listen_vconn_name) {
634                 fatal(0, "-l or --listen may be only specified once");
635             }
636             listen_vconn_name = optarg;
637             break;
638
639         case 'h':
640             usage();
641
642         case 'V':
643             printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
644             exit(EXIT_SUCCESS);
645
646         case 'v':
647             vlog_set_verbosity(optarg);
648             break;
649
650         VCONN_SSL_OPTION_HANDLERS
651
652         case '?':
653             exit(EXIT_FAILURE);
654
655         default:
656             abort();
657         }
658     }
659     free(short_options);
660 }
661
662 static void
663 usage(void)
664 {
665     printf("%s: secure channel, a relay for OpenFlow messages.\n"
666            "usage: %s [OPTIONS] nl:DP_IDX CONTROLLER\n"
667            "where nl:DP_IDX is a datapath that has been added with dpctl\n"
668            "and CONTROLLER is an active OpenFlow connection method.\n",
669            program_name, program_name);
670     vconn_usage(true, true);
671     printf("\nNetworking options:\n"
672            "  -f, --fail=open|closed  when controller connection fails:\n"
673            "                            closed: drop all packets\n"
674            "                            open (default): act as learning switch\n"
675            "  --inactivity-probe=SECS time between inactivity probes\n"
676            "  --max-idle=SECS         max idle for flows set up by secchan\n"
677            "  --max-backoff=SECS      max time between controller connection\n"
678            "                          attempts (default: 15 seconds)\n"
679            "  -l, --listen=METHOD     allow management connections on METHOD\n"
680            "                          (a passive OpenFlow connection method)\n"
681            "\nOther options:\n"
682            "  -D, --detach            run in background as daemon\n"
683            "  -P, --pidfile[=FILE]    create pidfile (default: %s/secchan.pid)\n"
684            "  -v, --verbose=MODULE[:FACILITY[:LEVEL]]  set logging levels\n"
685            "  -v, --verbose           set maximum verbosity level\n"
686            "  -h, --help              display this help message\n"
687            "  -V, --version           display version information\n",
688            RUNDIR);
689     exit(EXIT_SUCCESS);
690 }