Update copyright on all non-GPL files
[openvswitch] / switch / switch.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 <stdint.h>
37 #include <stdlib.h>
38 #include <string.h>
39
40 #include "command-line.h"
41 #include "controller.h"
42 #include "datapath.h"
43 #include "fault.h"
44 #include "openflow.h"
45 #include "poll-loop.h"
46 #include "queue.h"
47 #include "util.h"
48 #include "vconn.h"
49 #include "vconn-ssl.h"
50 #include "vlog-socket.h"
51
52 #define THIS_MODULE VLM_switch
53 #include "vlog.h"
54
55 static void parse_options(int argc, char *argv[]);
56 static void usage(void) NO_RETURN;
57
58 static bool reliable = true;
59 static struct datapath *dp;
60 static uint64_t dpid = UINT64_MAX;
61 static char *port_list;
62
63 static void add_ports(struct datapath *dp, char *port_list);
64
65 int
66 main(int argc, char *argv[])
67 {
68     struct controller_connection cc;
69     int error;
70
71     set_program_name(argv[0]);
72     register_fault_handlers();
73     vlog_init();
74     parse_options(argc, argv);
75
76     if (argc - optind != 1) {
77         fatal(0, "missing controller argument; use --help for usage");
78     }
79
80     controller_init(&cc, argv[optind], reliable);
81     error = dp_new(&dp, dpid, &cc);
82     if (error) {
83         fatal(error, "could not create datapath");
84     }
85     if (port_list) {
86         add_ports(dp, port_list); 
87     }
88
89     error = vlog_server_listen(NULL, NULL);
90     if (error) {
91         fatal(error, "could not listen for vlog connections");
92     }
93
94     for (;;) {
95         controller_run(&cc, dp);
96         dp_run(dp);
97         dp_wait(dp);
98         controller_wait(&cc);
99         poll_block();
100     }
101
102     return 0;
103 }
104
105 static void
106 add_ports(struct datapath *dp, char *port_list)
107 {
108     char *port, *save_ptr;
109
110     /* Glibc 2.7 has a bug in strtok_r when compiling with optimization that
111      * can cause segfaults here:
112      * http://sources.redhat.com/bugzilla/show_bug.cgi?id=5614.
113      * Using ",," instead of the obvious "," works around it. */
114     for (port = strtok_r(port_list, ",,", &save_ptr); port;
115          port = strtok_r(NULL, ",,", &save_ptr)) {
116         int error = dp_add_port(dp, port);
117         if (error) {
118             fatal(error, "failed to add port %s", port);
119         }
120     }
121 }
122
123 static void
124 parse_options(int argc, char *argv[])
125 {
126     static struct option long_options[] = {
127         {"interfaces",  required_argument, 0, 'i'},
128         {"unreliable",  no_argument, 0, 'u'},
129         {"datapath-id", required_argument, 0, 'd'},
130         {"verbose",     optional_argument, 0, 'v'},
131         {"help",        no_argument, 0, 'h'},
132         {"version",     no_argument, 0, 'V'},
133 #ifdef HAVE_OPENSSL
134         {"private-key", required_argument, 0, 'p'},
135         {"certificate", required_argument, 0, 'c'},
136         {"ca-cert",     required_argument, 0, 'C'},
137 #endif
138         {0, 0, 0, 0},
139     };
140     char *short_options = long_options_to_short_options(long_options);
141
142     for (;;) {
143         int indexptr;
144         int c;
145
146         c = getopt_long(argc, argv, short_options, long_options, &indexptr);
147         if (c == -1) {
148             break;
149         }
150
151         switch (c) {
152         case 'u':
153             reliable = false;
154             break;
155
156         case 'd':
157             if (strlen(optarg) != 12
158                 || strspn(optarg, "0123456789abcdefABCDEF") != 12) {
159                 fatal(0, "argument to -d or --datapath-id must be "
160                       "exactly 12 hex digits");
161             }
162             dpid = strtoll(optarg, NULL, 16);
163             if (!dpid) {
164                 fatal(0, "argument to -d or --datapath-id must be nonzero");
165             }
166             break;
167
168         case 'h':
169             usage();
170
171         case 'V':
172             printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
173             exit(EXIT_SUCCESS);
174
175         case 'v':
176             vlog_set_verbosity(optarg);
177             break;
178
179         case 'i':
180             if (!port_list) {
181                 port_list = optarg;
182             } else {
183                 port_list = xasprintf("%s,%s", port_list, optarg);
184             }
185             break;
186
187 #ifdef HAVE_OPENSSL
188         case 'p':
189             vconn_ssl_set_private_key_file(optarg);
190             break;
191
192         case 'c':
193             vconn_ssl_set_certificate_file(optarg);
194             break;
195
196         case 'C':
197             vconn_ssl_set_ca_cert_file(optarg);
198             break;
199 #endif
200
201         case '?':
202             exit(EXIT_FAILURE);
203
204         default:
205             abort();
206         }
207     }
208     free(short_options);
209 }
210
211 static void
212 usage(void)
213 {
214     printf("%s: userspace OpenFlow switch\n"
215            "usage: %s [OPTIONS] CONTROLLER\n"
216            "CONTROLLER must be one of the following:\n"
217            "  tcp:HOST[:PORT]         PORT (default: %d) on remote TCP HOST\n",
218            program_name, program_name, OFP_TCP_PORT);
219 #ifdef HAVE_OPENSSL
220     printf("  ssl:HOST[:PORT]         SSL PORT (default: %d) on remote HOST\n"
221            "\nPKI configuration (required to use SSL):\n"
222            "  -p, --private-key=FILE  file with private key\n"
223            "  -c, --certificate=FILE  file with certificate for private key\n"
224            "  -C, --ca-cert=FILE      file with peer CA certificate\n",
225            OFP_SSL_PORT);
226 #endif
227     printf("Options:\n"
228            "  -i, --interfaces=NETDEV[,NETDEV]...\n"
229            "                          add specified initial switch ports\n"
230            "  -d, --datapath-id=ID    Use ID as the OpenFlow switch ID\n"
231            "                          (ID must consist of 12 hex digits)\n"
232            "  -u, --unreliable        do not reconnect to controller\n"
233            "  -v, --verbose           set maximum verbosity level\n"
234            "  -h, --help              display this help message\n"
235            "  -V, --version           display version information\n");
236     exit(EXIT_SUCCESS);
237 }