ovsdb: Add support for "enum" constraints.
[openvswitch] / vswitchd / ovs-brcompatd.c
1 /* Copyright (c) 2008, 2009, 2010 Nicira Networks
2  *
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #include <config.h>
17
18 #include <asm/param.h>
19 #include <assert.h>
20 #include <errno.h>
21 #include <getopt.h>
22 #include <inttypes.h>
23 #include <limits.h>
24 #include <net/if.h>
25 #include <linux/genetlink.h>
26 #include <linux/rtnetlink.h>
27 #include <signal.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <sys/types.h>
31 #include <sys/stat.h>
32 #include <time.h>
33 #include <fcntl.h>
34 #include <unistd.h>
35
36 #include "command-line.h"
37 #include "coverage.h"
38 #include "daemon.h"
39 #include "dirs.h"
40 #include "dynamic-string.h"
41 #include "fatal-signal.h"
42 #include "leak-checker.h"
43 #include "netdev.h"
44 #include "netlink.h"
45 #include "ofpbuf.h"
46 #include "openvswitch/brcompat-netlink.h"
47 #include "ovsdb-idl.h"
48 #include "packets.h"
49 #include "poll-loop.h"
50 #include "process.h"
51 #include "signals.h"
52 #include "svec.h"
53 #include "timeval.h"
54 #include "unixctl.h"
55 #include "util.h"
56 #include "vswitchd/vswitch-idl.h"
57
58 #include "vlog.h"
59 #define THIS_MODULE VLM_brcompatd
60
61
62 /* xxx Just hangs if datapath is rmmod/insmod.  Learn to reconnect? */
63
64 /* Actions to modify bridge compatibility configuration. */
65 enum bmc_action {
66     BMC_ADD_DP,
67     BMC_DEL_DP,
68     BMC_ADD_PORT,
69     BMC_DEL_PORT
70 };
71
72 static const char *parse_options(int argc, char *argv[]);
73 static void usage(void) NO_RETURN;
74
75 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 60);
76
77 /* Maximum number of milliseconds to wait before pruning port entries that 
78  * no longer exist.  If set to zero, ports are never pruned. */
79 static int prune_timeout = 5000;
80
81 /* Shell command to execute (via popen()) to send a control command to the
82  * running ovs-vswitchd process.  The string must contain one instance of %s,
83  * which is replaced by the control command. */
84 static char *appctl_command;
85
86 /* Netlink socket to listen for interface changes. */
87 static struct nl_sock *rtnl_sock;
88
89 /* Netlink socket to bridge compatibility kernel module. */
90 static struct nl_sock *brc_sock;
91
92 /* The Generic Netlink family number used for bridge compatibility. */
93 static int brc_family;
94
95 static const struct nl_policy brc_multicast_policy[] = {
96     [BRC_GENL_A_MC_GROUP] = {.type = NL_A_U32 }
97 };
98
99 static const struct nl_policy rtnlgrp_link_policy[] = {
100     [IFLA_IFNAME] = { .type = NL_A_STRING, .optional = false },
101     [IFLA_MASTER] = { .type = NL_A_U32, .optional = true },
102 };
103
104 static int
105 lookup_brc_multicast_group(int *multicast_group)
106 {
107     struct nl_sock *sock;
108     struct ofpbuf request, *reply;
109     struct nlattr *attrs[ARRAY_SIZE(brc_multicast_policy)];
110     int retval;
111
112     retval = nl_sock_create(NETLINK_GENERIC, 0, 0, 0, &sock);
113     if (retval) {
114         return retval;
115     }
116     ofpbuf_init(&request, 0);
117     nl_msg_put_genlmsghdr(&request, sock, 0, brc_family,
118             NLM_F_REQUEST, BRC_GENL_C_QUERY_MC, 1);
119     retval = nl_sock_transact(sock, &request, &reply);
120     ofpbuf_uninit(&request);
121     if (retval) {
122         nl_sock_destroy(sock);
123         return retval;
124     }
125     if (!nl_policy_parse(reply, NLMSG_HDRLEN + GENL_HDRLEN,
126                          brc_multicast_policy, attrs,
127                          ARRAY_SIZE(brc_multicast_policy))) {
128         nl_sock_destroy(sock);
129         ofpbuf_delete(reply);
130         return EPROTO;
131     }
132     *multicast_group = nl_attr_get_u32(attrs[BRC_GENL_A_MC_GROUP]);
133     nl_sock_destroy(sock);
134     ofpbuf_delete(reply);
135
136     return 0;
137 }
138
139 /* Opens a socket for brcompat notifications.  Returns 0 if successful,
140  * otherwise a positive errno value. */
141 static int
142 brc_open(struct nl_sock **sock)
143 {
144     int multicast_group = 0;
145     int retval;
146
147     retval = nl_lookup_genl_family(BRC_GENL_FAMILY_NAME, &brc_family);
148     if (retval) {
149         return retval;
150     }
151
152     retval = lookup_brc_multicast_group(&multicast_group);
153     if (retval) {
154         return retval;
155     }
156
157     retval = nl_sock_create(NETLINK_GENERIC, multicast_group, 0, 0, sock);
158     if (retval) {
159         return retval;
160     }
161
162     return 0;
163 }
164
165 static const struct nl_policy brc_dp_policy[] = {
166     [BRC_GENL_A_DP_NAME] = { .type = NL_A_STRING },
167 };
168
169 static struct ovsrec_bridge *
170 find_bridge(const struct ovsrec_open_vswitch *ovs, const char *br_name)
171 {
172     size_t i;
173
174     for (i = 0; i < ovs->n_bridges; i++) {
175         if (!strcmp(br_name, ovs->bridges[i]->name)) {
176             return ovs->bridges[i];
177         }
178     }
179
180     return NULL;
181 }
182
183 static int
184 execute_appctl_command(const char *unixctl_command, char **output)
185 {
186     char *stdout_log, *stderr_log;
187     int error, status;
188     char *argv[5];
189
190     argv[0] = "/bin/sh";
191     argv[1] = "-c";
192     argv[2] = xasprintf(appctl_command, unixctl_command);
193     argv[3] = NULL;
194
195     /* Run process and log status. */
196     error = process_run_capture(argv, &stdout_log, &stderr_log, &status);
197     if (error) {
198         VLOG_ERR("failed to execute %s command via ovs-appctl: %s",
199                  unixctl_command, strerror(error));
200     } else if (status) {
201         char *msg = process_status_msg(status);
202         VLOG_ERR("ovs-appctl exited with error (%s)", msg);
203         free(msg);
204         error = ECHILD;
205     }
206
207     /* Deal with stdout_log. */
208     if (output) {
209         *output = stdout_log;
210     } else {
211         free(stdout_log);
212     }
213
214     /* Deal with stderr_log */
215     if (stderr_log && *stderr_log) {
216         VLOG_INFO("ovs-appctl wrote to stderr:\n%s", stderr_log);
217     }
218     free(stderr_log);
219
220     free(argv[2]);
221
222     return error;
223 }
224
225 static void
226 do_get_bridge_parts(const struct ovsrec_bridge *br, struct svec *parts, 
227                     int vlan, bool break_down_bonds)
228 {
229     struct svec ports;
230     size_t i, j;
231
232     svec_init(&ports);
233     for (i = 0; i < br->n_ports; i++) {
234         const struct ovsrec_port *port = br->ports[i];
235
236         svec_add(&ports, port->name);
237         if (vlan >= 0) {
238             int port_vlan = port->n_tag ? *port->tag : 0;
239             if (vlan != port_vlan) {
240                 continue;
241             }
242         }
243         if (break_down_bonds) {
244             for (j = 0; j < port->n_interfaces; j++) {
245                 const struct ovsrec_interface *iface = port->interfaces[j];
246                 svec_add(parts, iface->name);
247             }
248         } else {
249             svec_add(parts, port->name);
250         }
251     }
252     svec_destroy(&ports);
253 }
254
255 /* Add all the interfaces for 'bridge' to 'ifaces', breaking bonded interfaces
256  * down into their constituent parts.
257  *
258  * If 'vlan' < 0, all interfaces on 'bridge' are reported.  If 'vlan' == 0,
259  * then only interfaces for trunk ports or ports with implicit VLAN 0 are
260  * reported.  If 'vlan' > 0, only interfaces with implicit VLAN 'vlan' are
261  * reported.  */
262 static void
263 get_bridge_ifaces(const struct ovsrec_bridge *br, struct svec *ifaces, 
264                   int vlan)
265 {
266     do_get_bridge_parts(br, ifaces, vlan, true);
267 }
268
269 /* Add all the ports for 'bridge' to 'ports'.  Bonded ports are reported under
270  * the bond name, not broken down into their constituent interfaces.
271  *
272  * If 'vlan' < 0, all ports on 'bridge' are reported.  If 'vlan' == 0, then
273  * only trunk ports or ports with implicit VLAN 0 are reported.  If 'vlan' > 0,
274  * only port with implicit VLAN 'vlan' are reported.  */
275 static void
276 get_bridge_ports(const struct ovsrec_bridge *br, struct svec *ports, 
277                  int vlan)
278 {
279     do_get_bridge_parts(br, ports, vlan, false);
280 }
281
282 #if 0
283 /* Go through the configuration file and remove any ports that no longer
284  * exist associated with a bridge. */
285 static void
286 prune_ports(void)
287 {
288     int i, j;
289     struct svec bridges, delete;
290
291     if (cfg_lock(NULL, 0)) {
292         /* Couldn't lock config file. */
293         return;
294     }
295
296     svec_init(&bridges);
297     svec_init(&delete);
298     cfg_get_subsections(&bridges, "bridge");
299     for (i=0; i<bridges.n; i++) {
300         const char *br_name = bridges.names[i];
301         struct svec ifaces;
302
303         /* Check that each bridge interface exists. */
304         svec_init(&ifaces);
305         get_bridge_ifaces(br_name, &ifaces, -1);
306         for (j = 0; j < ifaces.n; j++) {
307             const char *iface_name = ifaces.names[j];
308
309             /* The local port and internal ports are created and destroyed by
310              * ovs-vswitchd itself, so don't bother checking for them at all.
311              * In practice, they might not exist if ovs-vswitchd hasn't
312              * finished reloading since the configuration file was updated. */
313             if (!strcmp(iface_name, br_name)
314                 || cfg_get_bool(0, "iface.%s.internal", iface_name)) {
315                 continue;
316             }
317
318             if (!netdev_exists(iface_name)) {
319                 VLOG_INFO_RL(&rl, "removing dead interface %s from %s",
320                              iface_name, br_name);
321                 svec_add(&delete, iface_name);
322             }
323         }
324         svec_destroy(&ifaces);
325     }
326     svec_destroy(&bridges);
327
328     if (delete.n) {
329         size_t i;
330
331         for (i = 0; i < delete.n; i++) {
332             cfg_del_match("bridge.*.port=%s", delete.names[i]);
333             cfg_del_match("bonding.*.slave=%s", delete.names[i]);
334         }
335         reload_config();
336         cfg_unlock();
337     } else {
338         cfg_unlock();
339     }
340     svec_destroy(&delete);
341 }
342 #endif
343
344 static struct ovsdb_idl_txn *
345 txn_from_openvswitch(const struct ovsrec_open_vswitch *ovs)
346 {
347     return ovsdb_idl_txn_get(&ovs->header_);
348 }
349
350 static bool
351 port_is_fake_bridge(const struct ovsrec_port *port)
352 {
353     return (port->fake_bridge
354             && port->tag
355             && *port->tag >= 1 && *port->tag <= 4095);
356 }
357
358 static void
359 ovs_insert_bridge(const struct ovsrec_open_vswitch *ovs,
360                   struct ovsrec_bridge *bridge)
361 {
362     struct ovsrec_bridge **bridges;
363     size_t i;     
364
365     bridges = xmalloc(sizeof *ovs->bridges * (ovs->n_bridges + 1));
366     for (i = 0; i < ovs->n_bridges; i++) {
367         bridges[i] = ovs->bridges[i];
368     }
369     bridges[ovs->n_bridges] = bridge;
370     ovsrec_open_vswitch_set_bridges(ovs, bridges, ovs->n_bridges + 1);
371     free(bridges);
372 }   
373
374 static int
375 add_bridge(const struct ovsrec_open_vswitch *ovs, const char *br_name)
376 {
377     struct ovsrec_bridge *br;
378     struct ovsrec_port *port;
379     struct ovsrec_interface *iface;
380
381     if (find_bridge(ovs, br_name)) {
382         VLOG_WARN("addbr %s: bridge %s exists", br_name, br_name);
383         return EEXIST;
384     } else if (netdev_exists(br_name)) {
385         size_t i;
386
387         for (i = 0; i < ovs->n_bridges; i++) {
388             size_t j;
389             struct ovsrec_bridge *br_cfg = ovs->bridges[i];
390
391             for (j = 0; j < br_cfg->n_ports; j++) {
392                 if (port_is_fake_bridge(br_cfg->ports[j])) {
393                     VLOG_WARN("addbr %s: %s exists as a fake bridge",
394                               br_name, br_name);
395                     return 0;
396                 }
397             }
398         }
399
400         VLOG_WARN("addbr %s: cannot create bridge %s because a network "
401                   "device named %s already exists",
402                   br_name, br_name, br_name);
403         return EEXIST;
404     }
405
406     iface = ovsrec_interface_insert(txn_from_openvswitch(ovs));
407     ovsrec_interface_set_name(iface, br_name);
408
409     port = ovsrec_port_insert(txn_from_openvswitch(ovs));
410     ovsrec_port_set_name(port, br_name);
411     ovsrec_port_set_interfaces(port, &iface, 1);
412     
413     br = ovsrec_bridge_insert(txn_from_openvswitch(ovs));
414     ovsrec_bridge_set_name(br, br_name);
415     ovsrec_bridge_set_ports(br, &port, 1);
416     
417     ovs_insert_bridge(ovs, br);
418
419     VLOG_INFO("addbr %s: success", br_name);
420
421     return 0;
422 }
423
424 static void
425 add_port(const struct ovsrec_open_vswitch *ovs, 
426          const struct ovsrec_bridge *br, const char *port_name)
427 {
428     struct ovsrec_interface *iface;
429     struct ovsrec_port *port;
430     struct ovsrec_port **ports;
431     size_t i;
432
433     /* xxx Check conflicts? */
434     iface = ovsrec_interface_insert(txn_from_openvswitch(ovs));
435     ovsrec_interface_set_name(iface, port_name);
436
437     port = ovsrec_port_insert(txn_from_openvswitch(ovs));
438     ovsrec_port_set_name(port, port_name);
439     ovsrec_port_set_interfaces(port, &iface, 1);
440
441     ports = xmalloc(sizeof *br->ports * (br->n_ports + 1));
442     for (i = 0; i < br->n_ports; i++) {
443         ports[i] = br->ports[i];
444     }
445     ports[br->n_ports] = port;
446     ovsrec_bridge_set_ports(br, ports, br->n_ports + 1);
447     free(ports);
448 }
449
450 static void
451 del_port(const struct ovsrec_bridge *br, const char *port_name)
452 {
453     size_t i, j;
454     struct ovsrec_port *port_rec = NULL;
455
456     for (i = 0; i < br->n_ports; i++) {
457         struct ovsrec_port *port = br->ports[i];
458         if (!strcmp(port_name, port->name)) {
459             port_rec = port;
460         }
461         for (j = 0; j < port->n_interfaces; j++) {
462             struct ovsrec_interface *iface = port->interfaces[j];
463             if (!strcmp(port_name, iface->name)) {
464                 ovsrec_interface_delete(iface);
465             }
466         }
467     }
468
469     /* xxx Probably can move this into the "for" loop. */
470     if (port_rec) {
471         struct ovsrec_port **ports;
472         size_t n;
473
474         ports = xmalloc(sizeof *br->ports * br->n_ports);
475         for (i = n = 0; i < br->n_ports; i++) {
476             if (br->ports[i] != port_rec) {
477                 ports[n++] = br->ports[i];
478             }
479         }
480         ovsrec_bridge_set_ports(br, ports, n);
481         free(ports);
482
483         ovsrec_port_delete(port_rec);
484     }
485 }
486
487 static int 
488 del_bridge(const struct ovsrec_open_vswitch *ovs, const char *br_name)
489 {
490     struct ovsrec_bridge *br = find_bridge(ovs, br_name);
491     struct ovsrec_bridge **bridges;
492     size_t i, n;
493
494     if (!br) {
495         VLOG_WARN("delbr %s: no bridge named %s", br_name, br_name);
496         return ENXIO;
497     }
498
499     del_port(br, br_name);
500
501     ovsrec_bridge_delete(br);
502
503     bridges = xmalloc(sizeof *ovs->bridges * ovs->n_bridges);
504     for (i = n = 0; i < ovs->n_bridges; i++) {
505         if (ovs->bridges[i] != br) {
506             bridges[n++] = ovs->bridges[i];
507         }
508     }
509     ovsrec_open_vswitch_set_bridges(ovs, bridges, n);
510     free(bridges);
511
512     /* Delete the bridge itself. */
513     ovsrec_bridge_delete(br);
514
515     VLOG_INFO("delbr %s: success", br_name);
516
517     return 0;
518 }
519
520 static int
521 parse_command(struct ofpbuf *buffer, uint32_t *seq, const char **br_name,
522               const char **port_name, uint64_t *count, uint64_t *skip)
523 {
524     static const struct nl_policy policy[] = {
525         [BRC_GENL_A_DP_NAME] = { .type = NL_A_STRING, .optional = true },
526         [BRC_GENL_A_PORT_NAME] = { .type = NL_A_STRING, .optional = true },
527         [BRC_GENL_A_FDB_COUNT] = { .type = NL_A_U64, .optional = true },
528         [BRC_GENL_A_FDB_SKIP] = { .type = NL_A_U64, .optional = true },
529     };
530     struct nlattr *attrs[ARRAY_SIZE(policy)];
531
532     if (!nl_policy_parse(buffer, NLMSG_HDRLEN + GENL_HDRLEN, policy,
533                          attrs, ARRAY_SIZE(policy))
534         || (br_name && !attrs[BRC_GENL_A_DP_NAME])
535         || (port_name && !attrs[BRC_GENL_A_PORT_NAME])
536         || (count && !attrs[BRC_GENL_A_FDB_COUNT])
537         || (skip && !attrs[BRC_GENL_A_FDB_SKIP])) {
538         return EINVAL;
539     }
540
541     *seq = ((struct nlmsghdr *) buffer->data)->nlmsg_seq;
542     if (br_name) {
543         *br_name = nl_attr_get_string(attrs[BRC_GENL_A_DP_NAME]);
544     }
545     if (port_name) {
546         *port_name = nl_attr_get_string(attrs[BRC_GENL_A_PORT_NAME]);
547     }
548     if (count) {
549         *count = nl_attr_get_u64(attrs[BRC_GENL_A_FDB_COUNT]);
550     }
551     if (skip) {
552         *skip = nl_attr_get_u64(attrs[BRC_GENL_A_FDB_SKIP]);
553     }
554     return 0;
555 }
556
557 /* Composes and returns a reply to a request made by the datapath with Netlink
558  * sequence number 'seq' and error code 'error'.  The caller may add additional
559  * attributes to the message, then it may send it with send_reply(). */
560 static struct ofpbuf *
561 compose_reply(uint32_t seq, int error)
562 {
563     struct ofpbuf *reply = ofpbuf_new(4096);
564     nl_msg_put_genlmsghdr(reply, brc_sock, 32, brc_family, NLM_F_REQUEST,
565                           BRC_GENL_C_DP_RESULT, 1);
566     ((struct nlmsghdr *) reply->data)->nlmsg_seq = seq;
567     nl_msg_put_u32(reply, BRC_GENL_A_ERR_CODE, error);
568     return reply;
569 }
570
571 /* Sends 'reply' to the datapath and frees it. */
572 static void
573 send_reply(struct ofpbuf *reply)
574 {
575     int retval = nl_sock_send(brc_sock, reply, false);
576     if (retval) {
577         VLOG_WARN_RL(&rl, "replying to brcompat request: %s",
578                      strerror(retval));
579     }
580     ofpbuf_delete(reply);
581 }
582
583 /* Composes and sends a reply to a request made by the datapath with Netlink
584  * sequence number 'seq' and error code 'error'. */
585 static void
586 send_simple_reply(uint32_t seq, int error)
587 {
588     send_reply(compose_reply(seq, error));
589 }
590
591 static int
592 handle_bridge_cmd(const struct ovsrec_open_vswitch *ovs, 
593                   struct ofpbuf *buffer, bool add)
594 {
595     const char *br_name;
596     uint32_t seq;
597     int error;
598
599     error = parse_command(buffer, &seq, &br_name, NULL, NULL, NULL);
600     if (!error) {
601         error = add ? add_bridge(ovs, br_name) : del_bridge(ovs, br_name);
602         send_simple_reply(seq, error);
603     }
604     return error;
605 }
606
607 static const struct nl_policy brc_port_policy[] = {
608     [BRC_GENL_A_DP_NAME] = { .type = NL_A_STRING },
609     [BRC_GENL_A_PORT_NAME] = { .type = NL_A_STRING },
610 };
611
612 static int
613 handle_port_cmd(const struct ovsrec_open_vswitch *ovs,
614                 struct ofpbuf *buffer, bool add)
615 {
616     const char *cmd_name = add ? "add-if" : "del-if";
617     const char *br_name, *port_name;
618     uint32_t seq;
619     int error;
620
621     error = parse_command(buffer, &seq, &br_name, &port_name, NULL, NULL);
622     if (!error) {
623         struct ovsrec_bridge *br = find_bridge(ovs, br_name);
624
625         if (!br) {
626             VLOG_WARN("%s %s %s: no bridge named %s",
627                       cmd_name, br_name, port_name, br_name);
628             error = EINVAL;
629         } else if (!netdev_exists(port_name)) {
630             VLOG_WARN("%s %s %s: no network device named %s",
631                       cmd_name, br_name, port_name, port_name);
632             error = EINVAL;
633         } else {
634             if (add) {
635                 add_port(ovs, br, port_name);
636             } else {
637                 del_port(br, port_name);
638             }
639             VLOG_INFO("%s %s %s: success", cmd_name, br_name, port_name);
640         }
641         send_simple_reply(seq, error);
642     }
643
644     return error;
645 }
646
647 /* The caller is responsible for freeing '*ovs_name' if the call is
648  * successful. */
649 static int
650 linux_bridge_to_ovs_bridge(const struct ovsrec_open_vswitch *ovs,
651                            const char *linux_name,
652                            const struct ovsrec_bridge **ovs_bridge,
653                            int *br_vlan)
654 {
655     *ovs_bridge = find_bridge(ovs, linux_name);
656     if (*ovs_bridge) {
657         /* Bridge name is the same.  We are interested in VLAN 0. */
658         *br_vlan = 0;
659         return 0;
660     } else {
661         /* No such Open vSwitch bridge 'linux_name', but there might be an
662          * internal port named 'linux_name' on some other bridge
663          * 'ovs_bridge'.  If so then we are interested in the VLAN assigned to
664          * port 'linux_name' on the bridge named 'ovs_bridge'. */
665         size_t i, j;
666
667         for (i = 0; i < ovs->n_bridges; i++) {
668             const struct ovsrec_bridge *br = ovs->bridges[i];
669
670             for (j = 0; j < br->n_ports; j++) {
671                 const struct ovsrec_port *port = br->ports[j];
672
673                 if (!strcmp(port->name, linux_name)) {
674                     *ovs_bridge = br;
675                     *br_vlan = port->n_tag ? *port->tag : -1;
676                     return 0;
677                 }
678             }
679
680         }
681         return ENODEV;
682     }
683 }
684
685 static int
686 handle_fdb_query_cmd(const struct ovsrec_open_vswitch *ovs,
687                      struct ofpbuf *buffer)
688 {
689     /* This structure is copied directly from the Linux 2.6.30 header files.
690      * It would be more straightforward to #include <linux/if_bridge.h>, but
691      * the 'port_hi' member was only introduced in Linux 2.6.26 and so systems
692      * with old header files won't have it. */
693     struct __fdb_entry {
694         __u8 mac_addr[6];
695         __u8 port_no;
696         __u8 is_local;
697         __u32 ageing_timer_value;
698         __u8 port_hi;
699         __u8 pad0;
700         __u16 unused;
701     };
702
703     struct mac {
704         uint8_t addr[6];
705     };
706     struct mac *local_macs;
707     int n_local_macs;
708     int i;
709
710     /* Impedance matching between the vswitchd and Linux kernel notions of what
711      * a bridge is.  The kernel only handles a single VLAN per bridge, but
712      * vswitchd can deal with all the VLANs on a single bridge.  We have to
713      * pretend that the former is the case even though the latter is the
714      * implementation. */
715     const char *linux_name;   /* Name used by brctl. */
716     const struct ovsrec_bridge *ovs_bridge;  /* Bridge used by ovs-vswitchd. */
717     int br_vlan;                /* VLAN tag. */
718     struct svec ifaces;
719
720     struct ofpbuf query_data;
721     struct ofpbuf *reply;
722     char *unixctl_command;
723     uint64_t count, skip;
724     char *output;
725     char *save_ptr;
726     uint32_t seq;
727     int error;
728
729     /* Parse the command received from brcompat_mod. */
730     error = parse_command(buffer, &seq, &linux_name, NULL, &count, &skip);
731     if (error) {
732         return error;
733     }
734
735     /* Figure out vswitchd bridge and VLAN. */
736     error = linux_bridge_to_ovs_bridge(ovs, linux_name, 
737                                        &ovs_bridge, &br_vlan);
738     if (error) {
739         send_simple_reply(seq, error);
740         return error;
741     }
742
743     /* Fetch the forwarding database using ovs-appctl. */
744     unixctl_command = xasprintf("fdb/show %s", ovs_bridge->name);
745     error = execute_appctl_command(unixctl_command, &output);
746     free(unixctl_command);
747     if (error) {
748         send_simple_reply(seq, error);
749         return error;
750     }
751
752     /* Fetch the MAC address for each interface on the bridge, so that we can
753      * fill in the is_local field in the response. */
754     svec_init(&ifaces);
755     get_bridge_ifaces(ovs_bridge, &ifaces, br_vlan);
756     local_macs = xmalloc(ifaces.n * sizeof *local_macs);
757     n_local_macs = 0;
758     for (i = 0; i < ifaces.n; i++) {
759         const char *iface_name = ifaces.names[i];
760         struct mac *mac = &local_macs[n_local_macs];
761         struct netdev *netdev;
762
763         error = netdev_open_default(iface_name, &netdev);
764         if (!error) {
765             if (!netdev_get_etheraddr(netdev, mac->addr)) {
766                 n_local_macs++;
767             }
768             netdev_close(netdev);
769         }
770     }
771     svec_destroy(&ifaces);
772
773     /* Parse the response from ovs-appctl and convert it to binary format to
774      * pass back to the kernel. */
775     ofpbuf_init(&query_data, sizeof(struct __fdb_entry) * 8);
776     save_ptr = NULL;
777     strtok_r(output, "\n", &save_ptr); /* Skip header line. */
778     while (count > 0) {
779         struct __fdb_entry *entry;
780         int port, vlan, age;
781         uint8_t mac[ETH_ADDR_LEN];
782         char *line;
783         bool is_local;
784
785         line = strtok_r(NULL, "\n", &save_ptr);
786         if (!line) {
787             break;
788         }
789
790         if (sscanf(line, "%d %d "ETH_ADDR_SCAN_FMT" %d",
791                    &port, &vlan, ETH_ADDR_SCAN_ARGS(mac), &age)
792             != 2 + ETH_ADDR_SCAN_COUNT + 1) {
793             struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
794             VLOG_INFO_RL(&rl, "fdb/show output has invalid format: %s", line);
795             continue;
796         }
797
798         if (vlan != br_vlan) {
799             continue;
800         }
801
802         if (skip > 0) {
803             skip--;
804             continue;
805         }
806
807         /* Is this the MAC address of an interface on the bridge? */
808         is_local = false;
809         for (i = 0; i < n_local_macs; i++) {
810             if (eth_addr_equals(local_macs[i].addr, mac)) {
811                 is_local = true;
812                 break;
813             }
814         }
815
816         entry = ofpbuf_put_uninit(&query_data, sizeof *entry);
817         memcpy(entry->mac_addr, mac, ETH_ADDR_LEN);
818         entry->port_no = port & 0xff;
819         entry->is_local = is_local;
820         entry->ageing_timer_value = age * HZ;
821         entry->port_hi = (port & 0xff00) >> 8;
822         entry->pad0 = 0;
823         entry->unused = 0;
824         count--;
825     }
826     free(output);
827
828     /* Compose and send reply to datapath. */
829     reply = compose_reply(seq, 0);
830     nl_msg_put_unspec(reply, BRC_GENL_A_FDB_DATA,
831                       query_data.data, query_data.size);
832     send_reply(reply);
833
834     /* Free memory. */
835     ofpbuf_uninit(&query_data);
836
837     return 0;
838 }
839
840 static void
841 send_ifindex_reply(uint32_t seq, struct svec *ifaces)
842 {
843     struct ofpbuf *reply;
844     const char *iface;
845     size_t n_indices;
846     int *indices;
847     size_t i;
848
849     /* Make sure that any given interface only occurs once.  This shouldn't
850      * happen, but who knows what people put into their configuration files. */
851     svec_sort_unique(ifaces);
852
853     /* Convert 'ifaces' into ifindexes. */
854     n_indices = 0;
855     indices = xmalloc(ifaces->n * sizeof *indices);
856     SVEC_FOR_EACH (i, iface, ifaces) {
857         int ifindex = if_nametoindex(iface);
858         if (ifindex) {
859             indices[n_indices++] = ifindex;
860         }
861     }
862
863     /* Compose and send reply. */
864     reply = compose_reply(seq, 0);
865     nl_msg_put_unspec(reply, BRC_GENL_A_IFINDEXES,
866                       indices, n_indices * sizeof *indices);
867     send_reply(reply);
868
869     /* Free memory. */
870     free(indices);
871 }
872
873 static int
874 handle_get_bridges_cmd(const struct ovsrec_open_vswitch *ovs,
875                        struct ofpbuf *buffer)
876 {
877     struct svec bridges;
878     size_t i, j;
879
880     uint32_t seq;
881
882     int error;
883
884     /* Parse Netlink command.
885      *
886      * The command doesn't actually have any arguments, but we need the
887      * sequence number to send the reply. */
888     error = parse_command(buffer, &seq, NULL, NULL, NULL, NULL);
889     if (error) {
890         return error;
891     }
892
893     /* Get all the real bridges and all the fake ones. */
894     svec_init(&bridges);
895     for (i = 0; i < ovs->n_bridges; i++) {
896         const struct ovsrec_bridge *br = ovs->bridges[i];
897
898         svec_add(&bridges, br->name);
899         for (j = 0; j < br->n_ports; j++) {
900             const struct ovsrec_port *port = br->ports[j];
901
902             if (port->fake_bridge) {
903                 svec_add(&bridges, port->name);
904             }
905         }
906     }
907
908     send_ifindex_reply(seq, &bridges);
909     svec_destroy(&bridges);
910
911     return 0;
912 }
913
914 static int
915 handle_get_ports_cmd(const struct ovsrec_open_vswitch *ovs,
916                      struct ofpbuf *buffer)
917 {
918     uint32_t seq;
919
920     const char *linux_name;
921     const struct ovsrec_bridge *ovs_bridge;
922     int br_vlan;
923
924     struct svec ports;
925
926     int error;
927
928     /* Parse Netlink command. */
929     error = parse_command(buffer, &seq, &linux_name, NULL, NULL, NULL);
930     if (error) {
931         return error;
932     }
933
934     error = linux_bridge_to_ovs_bridge(ovs, linux_name, 
935                                        &ovs_bridge, &br_vlan);
936     if (error) {
937         send_simple_reply(seq, error);
938         return error;
939     }
940
941     svec_init(&ports);
942     get_bridge_ports(ovs_bridge, &ports, br_vlan);
943     svec_sort(&ports);
944     svec_del(&ports, linux_name);
945     send_ifindex_reply(seq, &ports); /* XXX bonds won't show up */
946     svec_destroy(&ports);
947
948     return 0;
949 }
950
951 static void
952 brc_recv_update(const struct ovsrec_open_vswitch *ovs)
953 {
954     int retval;
955     struct ofpbuf *buffer;
956     struct genlmsghdr *genlmsghdr;
957
958
959     buffer = NULL;
960     do {
961         ofpbuf_delete(buffer);
962         retval = nl_sock_recv(brc_sock, &buffer, false);
963     } while (retval == ENOBUFS
964             || (!retval
965                 && (nl_msg_nlmsgerr(buffer, NULL)
966                     || nl_msg_nlmsghdr(buffer)->nlmsg_type == NLMSG_DONE)));
967     if (retval) {
968         if (retval != EAGAIN) {
969             VLOG_WARN_RL(&rl, "brc_recv_update: %s", strerror(retval));
970         }
971         return;
972     }
973
974     genlmsghdr = nl_msg_genlmsghdr(buffer);
975     if (!genlmsghdr) {
976         VLOG_WARN_RL(&rl, "received packet too short for generic NetLink");
977         goto error;
978     }
979
980     if (nl_msg_nlmsghdr(buffer)->nlmsg_type != brc_family) {
981         VLOG_DBG_RL(&rl, "received type (%"PRIu16") != brcompat family (%d)",
982                 nl_msg_nlmsghdr(buffer)->nlmsg_type, brc_family);
983         goto error;
984     }
985
986     /* Just drop the request on the floor if a valid configuration
987      * doesn't exist.  We don't immediately do this check, because we
988      * want to drain pending netlink messages. */
989     if (!ovs) {
990         VLOG_WARN_RL(&rl, "could not find valid configuration to update");
991         goto error;
992     }
993
994     switch (genlmsghdr->cmd) {
995     case BRC_GENL_C_DP_ADD:
996         handle_bridge_cmd(ovs, buffer, true);
997         break;
998
999     case BRC_GENL_C_DP_DEL:
1000         handle_bridge_cmd(ovs, buffer, false);
1001         break;
1002
1003     case BRC_GENL_C_PORT_ADD:
1004         handle_port_cmd(ovs, buffer, true);
1005         break;
1006
1007     case BRC_GENL_C_PORT_DEL:
1008         handle_port_cmd(ovs, buffer, false);
1009         break;
1010
1011     case BRC_GENL_C_FDB_QUERY:
1012         handle_fdb_query_cmd(ovs, buffer);
1013         break;
1014
1015     case BRC_GENL_C_GET_BRIDGES:
1016         handle_get_bridges_cmd(ovs, buffer);
1017         break;
1018
1019     case BRC_GENL_C_GET_PORTS:
1020         handle_get_ports_cmd(ovs, buffer);
1021         break;
1022
1023     default:
1024         VLOG_WARN_RL(&rl, "received unknown brc netlink command: %d\n",
1025                 genlmsghdr->cmd);
1026         break;
1027     }
1028
1029 error:
1030     ofpbuf_delete(buffer);
1031     return;
1032 }
1033
1034 /* Check for interface configuration changes announced through RTNL. */
1035 static void
1036 rtnl_recv_update(const struct ovsrec_open_vswitch *ovs)
1037 {
1038     struct ofpbuf *buf;
1039
1040     int error = nl_sock_recv(rtnl_sock, &buf, false);
1041     if (error == EAGAIN) {
1042         /* Nothing to do. */
1043     } else if (error == ENOBUFS) {
1044         VLOG_WARN_RL(&rl, "network monitor socket overflowed");
1045     } else if (error) {
1046         VLOG_WARN_RL(&rl, "error on network monitor socket: %s", 
1047                 strerror(error));
1048     } else {
1049         struct nlattr *attrs[ARRAY_SIZE(rtnlgrp_link_policy)];
1050         struct nlmsghdr *nlh;
1051         struct ifinfomsg *iim;
1052
1053         nlh = ofpbuf_at(buf, 0, NLMSG_HDRLEN);
1054         iim = ofpbuf_at(buf, NLMSG_HDRLEN, sizeof *iim);
1055         if (!iim) {
1056             VLOG_WARN_RL(&rl, "received bad rtnl message (no ifinfomsg)");
1057             ofpbuf_delete(buf);
1058             return;
1059         } 
1060     
1061         if (!nl_policy_parse(buf, NLMSG_HDRLEN + sizeof(struct ifinfomsg),
1062                              rtnlgrp_link_policy,
1063                              attrs, ARRAY_SIZE(rtnlgrp_link_policy))) {
1064             VLOG_WARN_RL(&rl,"received bad rtnl message (policy)");
1065             ofpbuf_delete(buf);
1066             return;
1067         }
1068         if (nlh->nlmsg_type == RTM_DELLINK && attrs[IFLA_MASTER]) {
1069             const char *port_name = nl_attr_get_string(attrs[IFLA_IFNAME]);
1070             char br_name[IFNAMSIZ];
1071             uint32_t br_idx = nl_attr_get_u32(attrs[IFLA_MASTER]);
1072
1073             if (!if_indextoname(br_idx, br_name)) {
1074                 ofpbuf_delete(buf);
1075                 return;
1076             }
1077
1078             if (!netdev_exists(port_name)) {
1079                 /* Network device is really gone. */
1080                 struct ovsrec_bridge *br = find_bridge(ovs, br_name);
1081
1082                 VLOG_INFO("network device %s destroyed, "
1083                           "removing from bridge %s", port_name, br_name);
1084
1085                 if (!br) {
1086                     VLOG_WARN("no bridge named %s from which to remove %s", 
1087                             br_name, port_name);
1088                     ofpbuf_delete(buf);
1089                     return;
1090                 }
1091
1092                 del_port(br, port_name);
1093             } else {
1094                 /* A network device by that name exists even though the kernel
1095                  * told us it had disappeared.  Probably, what happened was
1096                  * this:
1097                  *
1098                  *      1. Device destroyed.
1099                  *      2. Notification sent to us.
1100                  *      3. New device created with same name as old one.
1101                  *      4. ovs-brcompatd notified, removes device from bridge.
1102                  *
1103                  * There's no a priori reason that in this situation that the
1104                  * new device with the same name should remain in the bridge;
1105                  * on the contrary, that would be unexpected.  *But* there is
1106                  * one important situation where, if we do this, bad things
1107                  * happen.  This is the case of XenServer Tools version 5.0.0,
1108                  * which on boot of a Windows VM cause something like this to
1109                  * happen on the Xen host:
1110                  *
1111                  *      i. Create tap1.0 and vif1.0.
1112                  *      ii. Delete tap1.0.
1113                  *      iii. Delete vif1.0.
1114                  *      iv. Re-create vif1.0.
1115                  *
1116                  * (XenServer Tools 5.5.0 does not exhibit this behavior, and
1117                  * neither does a VM without Tools installed at all.@.)
1118                  *
1119                  * Steps iii and iv happen within a few seconds of each other.
1120                  * Step iv causes /etc/xensource/scripts/vif to run, which in
1121                  * turn calls ovs-cfg-mod to add the new device to the bridge.
1122                  * If step iv happens after step 4 (in our first list of
1123                  * steps), then all is well, but if it happens between 3 and 4
1124                  * (which can easily happen if ovs-brcompatd has to wait to
1125                  * lock the configuration file), then we will remove the new
1126                  * incarnation from the bridge instead of the old one!
1127                  *
1128                  * So, to avoid this problem, we do nothing here.  This is
1129                  * strictly incorrect except for this one particular case, and
1130                  * perhaps that will bite us someday.  If that happens, then we
1131                  * will have to somehow track network devices by ifindex, since
1132                  * a new device will have a new ifindex even if it has the same
1133                  * name as an old device.
1134                  */
1135                 VLOG_INFO("kernel reported network device %s removed but "
1136                           "a device by that name exists (XS Tools 5.0.0?)",
1137                           port_name);
1138             }
1139         }
1140         ofpbuf_delete(buf);
1141     }
1142 }
1143
1144 int
1145 main(int argc, char *argv[])
1146 {
1147     struct unixctl_server *unixctl;
1148     const char *remote;
1149     struct ovsdb_idl *idl;
1150     int retval;
1151
1152     proctitle_init(argc, argv);
1153     set_program_name(argv[0]);
1154     time_init();
1155     vlog_init();
1156     vlog_set_levels(VLM_ANY_MODULE, VLF_CONSOLE, VLL_WARN);
1157     vlog_set_levels(VLM_reconnect, VLF_ANY_FACILITY, VLL_WARN);
1158
1159     remote = parse_options(argc, argv);
1160     signal(SIGPIPE, SIG_IGN);
1161     process_init();
1162     ovsrec_init();
1163
1164     die_if_already_running();
1165     daemonize_start();
1166
1167     retval = unixctl_server_create(NULL, &unixctl);
1168     if (retval) {
1169         exit(EXIT_FAILURE);
1170     }
1171
1172     if (brc_open(&brc_sock)) {
1173         ovs_fatal(0, "could not open brcompat socket.  Check "
1174                 "\"brcompat\" kernel module.");
1175     }
1176
1177     if (prune_timeout) {
1178         if (nl_sock_create(NETLINK_ROUTE, RTNLGRP_LINK, 0, 0, &rtnl_sock)) {
1179             ovs_fatal(0, "could not create rtnetlink socket");
1180         }
1181     }
1182
1183     daemonize_complete();
1184
1185     idl = ovsdb_idl_create(remote, &ovsrec_idl_class);
1186
1187     for (;;) {
1188         const struct ovsrec_open_vswitch *ovs;
1189         struct ovsdb_idl_txn *txn;
1190         enum ovsdb_idl_txn_status status;
1191
1192         ovsdb_idl_run(idl);
1193
1194         txn = ovsdb_idl_txn_create(idl);
1195
1196         unixctl_server_run(unixctl);
1197         ovs = ovsrec_open_vswitch_first(idl);
1198         brc_recv_update(ovs);
1199
1200         if (!ovs && ovsdb_idl_has_ever_connected(idl)) {
1201             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
1202             VLOG_WARN_RL(&rl, "%s: database does not contain any Open vSwitch "
1203                          "configuration", remote);
1204         }
1205         netdev_run();
1206
1207         /* If 'prune_timeout' is non-zero, we actively prune from the
1208          * configuration of port entries that are no longer valid.  We 
1209          * use two methods: 
1210          *
1211          *   1) The kernel explicitly notifies us of removed ports
1212          *      through the RTNL messages.
1213          *
1214          *   2) We periodically check all ports associated with bridges
1215          *      to see if they no longer exist.
1216          */
1217         if (ovs && prune_timeout) {
1218             rtnl_recv_update(ovs);
1219 #if 0
1220             prune_ports();
1221 #endif
1222
1223             nl_sock_wait(rtnl_sock, POLLIN);
1224             poll_timer_wait(prune_timeout);
1225         }
1226
1227         while ((status = ovsdb_idl_txn_commit(txn)) == TXN_INCOMPLETE) {
1228             ovsdb_idl_run(idl);
1229             ovsdb_idl_wait(idl);
1230             ovsdb_idl_txn_wait(txn);
1231             poll_block();
1232         }
1233             
1234         switch (status) {
1235         case TXN_INCOMPLETE:
1236             NOT_REACHED();
1237         
1238         case TXN_ABORTED:
1239             /* Should not happen--we never call ovsdb_idl_txn_abort(). */
1240             ovs_fatal(0, "transaction aborted");
1241         
1242         case TXN_SUCCESS:
1243         case TXN_UNCHANGED:
1244             break;
1245         
1246         case TXN_TRY_AGAIN:
1247             /* xxx Handle this better! */
1248             VLOG_ERR("OVSDB transaction needs retry");
1249             break;
1250
1251         case TXN_ERROR:
1252             /* xxx Handle this better! */
1253             VLOG_ERR("OVSDB transaction failed: %s",
1254                      ovsdb_idl_txn_get_error(txn));
1255             break;
1256
1257         default:
1258             NOT_REACHED();
1259         }
1260         ovsdb_idl_txn_destroy(txn);
1261
1262         nl_sock_wait(brc_sock, POLLIN);
1263         ovsdb_idl_wait(idl);
1264         unixctl_server_wait(unixctl);
1265         netdev_wait();
1266         poll_block();
1267     }
1268
1269     ovsdb_idl_destroy(idl);
1270
1271     return 0;
1272 }
1273
1274 static void
1275 validate_appctl_command(void)
1276 {
1277     const char *p;
1278     int n;
1279
1280     n = 0;
1281     for (p = strchr(appctl_command, '%'); p; p = strchr(p + 2, '%')) {
1282         if (p[1] == '%') {
1283             /* Nothing to do. */
1284         } else if (p[1] == 's') {
1285             n++;
1286         } else {
1287             ovs_fatal(0, "only '%%s' and '%%%%' allowed in --appctl-command");
1288         }
1289     }
1290     if (n != 1) {
1291         ovs_fatal(0, "'%%s' must appear exactly once in --appctl-command");
1292     }
1293 }
1294
1295 static const char *
1296 parse_options(int argc, char *argv[])
1297 {
1298     enum {
1299         OPT_PRUNE_TIMEOUT,
1300         OPT_APPCTL_COMMAND,
1301         VLOG_OPTION_ENUMS,
1302         LEAK_CHECKER_OPTION_ENUMS
1303     };
1304     static struct option long_options[] = {
1305         {"help",             no_argument, 0, 'h'},
1306         {"version",          no_argument, 0, 'V'},
1307         {"prune-timeout",    required_argument, 0, OPT_PRUNE_TIMEOUT},
1308         {"appctl-command",   required_argument, 0, OPT_APPCTL_COMMAND},
1309         DAEMON_LONG_OPTIONS,
1310         VLOG_LONG_OPTIONS,
1311         LEAK_CHECKER_LONG_OPTIONS,
1312         {0, 0, 0, 0},
1313     };
1314     char *short_options = long_options_to_short_options(long_options);
1315
1316     appctl_command = xasprintf("%s/ovs-appctl %%s", ovs_bindir);
1317     for (;;) {
1318         int c;
1319
1320         c = getopt_long(argc, argv, short_options, long_options, NULL);
1321         if (c == -1) {
1322             break;
1323         }
1324
1325         switch (c) {
1326         case 'H':
1327         case 'h':
1328             usage();
1329
1330         case 'V':
1331             OVS_PRINT_VERSION(0, 0);
1332             exit(EXIT_SUCCESS);
1333
1334         case OPT_PRUNE_TIMEOUT:
1335             prune_timeout = atoi(optarg) * 1000;
1336             break;
1337
1338         case OPT_APPCTL_COMMAND:
1339             appctl_command = optarg;
1340             break;
1341
1342         VLOG_OPTION_HANDLERS
1343         DAEMON_OPTION_HANDLERS
1344         LEAK_CHECKER_OPTION_HANDLERS
1345
1346         case '?':
1347             exit(EXIT_FAILURE);
1348
1349         default:
1350             abort();
1351         }
1352     }
1353     free(short_options);
1354
1355     validate_appctl_command();
1356
1357     argc -= optind;
1358     argv += optind;
1359
1360     if (argc != 1) {
1361         ovs_fatal(0, "database socket is non-option argument; "
1362                 "use --help for usage");
1363     }
1364
1365     return argv[0];
1366 }
1367
1368 static void
1369 usage(void)
1370 {
1371     printf("%s: bridge compatibility front-end for ovs-vswitchd\n"
1372            "usage: %s [OPTIONS] CONFIG\n"
1373            "CONFIG is the configuration file used by ovs-vswitchd.\n",
1374            program_name, program_name);
1375     printf("\nConfiguration options:\n"
1376            "  --appctl-command=COMMAND  shell command to run ovs-appctl\n"
1377            "  --prune-timeout=SECS    wait at most SECS before pruning ports\n"
1378           );
1379     daemon_usage();
1380     vlog_usage();
1381     printf("\nOther options:\n"
1382            "  -h, --help              display this help message\n"
1383            "  -V, --version           display version information\n");
1384     leak_checker_usage();
1385     printf("\nThe default appctl command is:\n%s\n", appctl_command);
1386     exit(EXIT_SUCCESS);
1387 }