unixctl: Avoid double error reporting.
[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 }
484
485 static int 
486 del_bridge(const struct ovsrec_open_vswitch *ovs, const char *br_name)
487 {
488     struct ovsrec_bridge *br = find_bridge(ovs, br_name);
489     struct ovsrec_bridge **bridges;
490     size_t i, n;
491
492     if (!br) {
493         VLOG_WARN("delbr %s: no bridge named %s", br_name, br_name);
494         return ENXIO;
495     }
496
497     del_port(br, br_name);
498
499     ovsrec_bridge_delete(br);
500
501     bridges = xmalloc(sizeof *ovs->bridges * ovs->n_bridges);
502     for (i = n = 0; i < ovs->n_bridges; i++) {
503         if (ovs->bridges[i] != br) {
504             bridges[n++] = ovs->bridges[i];
505         }
506     }
507     ovsrec_open_vswitch_set_bridges(ovs, bridges, n);
508     free(bridges);
509
510     VLOG_INFO("delbr %s: success", br_name);
511
512     return 0;
513 }
514
515 static int
516 parse_command(struct ofpbuf *buffer, uint32_t *seq, const char **br_name,
517               const char **port_name, uint64_t *count, uint64_t *skip)
518 {
519     static const struct nl_policy policy[] = {
520         [BRC_GENL_A_DP_NAME] = { .type = NL_A_STRING, .optional = true },
521         [BRC_GENL_A_PORT_NAME] = { .type = NL_A_STRING, .optional = true },
522         [BRC_GENL_A_FDB_COUNT] = { .type = NL_A_U64, .optional = true },
523         [BRC_GENL_A_FDB_SKIP] = { .type = NL_A_U64, .optional = true },
524     };
525     struct nlattr *attrs[ARRAY_SIZE(policy)];
526
527     if (!nl_policy_parse(buffer, NLMSG_HDRLEN + GENL_HDRLEN, policy,
528                          attrs, ARRAY_SIZE(policy))
529         || (br_name && !attrs[BRC_GENL_A_DP_NAME])
530         || (port_name && !attrs[BRC_GENL_A_PORT_NAME])
531         || (count && !attrs[BRC_GENL_A_FDB_COUNT])
532         || (skip && !attrs[BRC_GENL_A_FDB_SKIP])) {
533         return EINVAL;
534     }
535
536     *seq = ((struct nlmsghdr *) buffer->data)->nlmsg_seq;
537     if (br_name) {
538         *br_name = nl_attr_get_string(attrs[BRC_GENL_A_DP_NAME]);
539     }
540     if (port_name) {
541         *port_name = nl_attr_get_string(attrs[BRC_GENL_A_PORT_NAME]);
542     }
543     if (count) {
544         *count = nl_attr_get_u64(attrs[BRC_GENL_A_FDB_COUNT]);
545     }
546     if (skip) {
547         *skip = nl_attr_get_u64(attrs[BRC_GENL_A_FDB_SKIP]);
548     }
549     return 0;
550 }
551
552 /* Composes and returns a reply to a request made by the datapath with Netlink
553  * sequence number 'seq' and error code 'error'.  The caller may add additional
554  * attributes to the message, then it may send it with send_reply(). */
555 static struct ofpbuf *
556 compose_reply(uint32_t seq, int error)
557 {
558     struct ofpbuf *reply = ofpbuf_new(4096);
559     nl_msg_put_genlmsghdr(reply, brc_sock, 32, brc_family, NLM_F_REQUEST,
560                           BRC_GENL_C_DP_RESULT, 1);
561     ((struct nlmsghdr *) reply->data)->nlmsg_seq = seq;
562     nl_msg_put_u32(reply, BRC_GENL_A_ERR_CODE, error);
563     return reply;
564 }
565
566 /* Sends 'reply' to the datapath and frees it. */
567 static void
568 send_reply(struct ofpbuf *reply)
569 {
570     int retval = nl_sock_send(brc_sock, reply, false);
571     if (retval) {
572         VLOG_WARN_RL(&rl, "replying to brcompat request: %s",
573                      strerror(retval));
574     }
575     ofpbuf_delete(reply);
576 }
577
578 /* Composes and sends a reply to a request made by the datapath with Netlink
579  * sequence number 'seq' and error code 'error'. */
580 static void
581 send_simple_reply(uint32_t seq, int error)
582 {
583     send_reply(compose_reply(seq, error));
584 }
585
586 static int
587 handle_bridge_cmd(const struct ovsrec_open_vswitch *ovs, 
588                   struct ofpbuf *buffer, bool add)
589 {
590     const char *br_name;
591     uint32_t seq;
592     int error;
593
594     error = parse_command(buffer, &seq, &br_name, NULL, NULL, NULL);
595     if (!error) {
596         error = add ? add_bridge(ovs, br_name) : del_bridge(ovs, br_name);
597         send_simple_reply(seq, error);
598     }
599     return error;
600 }
601
602 static const struct nl_policy brc_port_policy[] = {
603     [BRC_GENL_A_DP_NAME] = { .type = NL_A_STRING },
604     [BRC_GENL_A_PORT_NAME] = { .type = NL_A_STRING },
605 };
606
607 static int
608 handle_port_cmd(const struct ovsrec_open_vswitch *ovs,
609                 struct ofpbuf *buffer, bool add)
610 {
611     const char *cmd_name = add ? "add-if" : "del-if";
612     const char *br_name, *port_name;
613     uint32_t seq;
614     int error;
615
616     error = parse_command(buffer, &seq, &br_name, &port_name, NULL, NULL);
617     if (!error) {
618         struct ovsrec_bridge *br = find_bridge(ovs, br_name);
619
620         if (!br) {
621             VLOG_WARN("%s %s %s: no bridge named %s",
622                       cmd_name, br_name, port_name, br_name);
623             error = EINVAL;
624         } else if (!netdev_exists(port_name)) {
625             VLOG_WARN("%s %s %s: no network device named %s",
626                       cmd_name, br_name, port_name, port_name);
627             error = EINVAL;
628         } else {
629             if (add) {
630                 add_port(ovs, br, port_name);
631             } else {
632                 del_port(br, port_name);
633             }
634             VLOG_INFO("%s %s %s: success", cmd_name, br_name, port_name);
635         }
636         send_simple_reply(seq, error);
637     }
638
639     return error;
640 }
641
642 /* The caller is responsible for freeing '*ovs_name' if the call is
643  * successful. */
644 static int
645 linux_bridge_to_ovs_bridge(const struct ovsrec_open_vswitch *ovs,
646                            const char *linux_name,
647                            const struct ovsrec_bridge **ovs_bridge,
648                            int *br_vlan)
649 {
650     *ovs_bridge = find_bridge(ovs, linux_name);
651     if (*ovs_bridge) {
652         /* Bridge name is the same.  We are interested in VLAN 0. */
653         *br_vlan = 0;
654         return 0;
655     } else {
656         /* No such Open vSwitch bridge 'linux_name', but there might be an
657          * internal port named 'linux_name' on some other bridge
658          * 'ovs_bridge'.  If so then we are interested in the VLAN assigned to
659          * port 'linux_name' on the bridge named 'ovs_bridge'. */
660         size_t i, j;
661
662         for (i = 0; i < ovs->n_bridges; i++) {
663             const struct ovsrec_bridge *br = ovs->bridges[i];
664
665             for (j = 0; j < br->n_ports; j++) {
666                 const struct ovsrec_port *port = br->ports[j];
667
668                 if (!strcmp(port->name, linux_name)) {
669                     *ovs_bridge = br;
670                     *br_vlan = port->n_tag ? *port->tag : -1;
671                     return 0;
672                 }
673             }
674
675         }
676         return ENODEV;
677     }
678 }
679
680 static int
681 handle_fdb_query_cmd(const struct ovsrec_open_vswitch *ovs,
682                      struct ofpbuf *buffer)
683 {
684     /* This structure is copied directly from the Linux 2.6.30 header files.
685      * It would be more straightforward to #include <linux/if_bridge.h>, but
686      * the 'port_hi' member was only introduced in Linux 2.6.26 and so systems
687      * with old header files won't have it. */
688     struct __fdb_entry {
689         __u8 mac_addr[6];
690         __u8 port_no;
691         __u8 is_local;
692         __u32 ageing_timer_value;
693         __u8 port_hi;
694         __u8 pad0;
695         __u16 unused;
696     };
697
698     struct mac {
699         uint8_t addr[6];
700     };
701     struct mac *local_macs;
702     int n_local_macs;
703     int i;
704
705     /* Impedance matching between the vswitchd and Linux kernel notions of what
706      * a bridge is.  The kernel only handles a single VLAN per bridge, but
707      * vswitchd can deal with all the VLANs on a single bridge.  We have to
708      * pretend that the former is the case even though the latter is the
709      * implementation. */
710     const char *linux_name;   /* Name used by brctl. */
711     const struct ovsrec_bridge *ovs_bridge;  /* Bridge used by ovs-vswitchd. */
712     int br_vlan;                /* VLAN tag. */
713     struct svec ifaces;
714
715     struct ofpbuf query_data;
716     struct ofpbuf *reply;
717     char *unixctl_command;
718     uint64_t count, skip;
719     char *output;
720     char *save_ptr;
721     uint32_t seq;
722     int error;
723
724     /* Parse the command received from brcompat_mod. */
725     error = parse_command(buffer, &seq, &linux_name, NULL, &count, &skip);
726     if (error) {
727         return error;
728     }
729
730     /* Figure out vswitchd bridge and VLAN. */
731     error = linux_bridge_to_ovs_bridge(ovs, linux_name, 
732                                        &ovs_bridge, &br_vlan);
733     if (error) {
734         send_simple_reply(seq, error);
735         return error;
736     }
737
738     /* Fetch the forwarding database using ovs-appctl. */
739     unixctl_command = xasprintf("fdb/show %s", ovs_bridge->name);
740     error = execute_appctl_command(unixctl_command, &output);
741     free(unixctl_command);
742     if (error) {
743         send_simple_reply(seq, error);
744         return error;
745     }
746
747     /* Fetch the MAC address for each interface on the bridge, so that we can
748      * fill in the is_local field in the response. */
749     svec_init(&ifaces);
750     get_bridge_ifaces(ovs_bridge, &ifaces, br_vlan);
751     local_macs = xmalloc(ifaces.n * sizeof *local_macs);
752     n_local_macs = 0;
753     for (i = 0; i < ifaces.n; i++) {
754         const char *iface_name = ifaces.names[i];
755         struct mac *mac = &local_macs[n_local_macs];
756         struct netdev *netdev;
757
758         error = netdev_open_default(iface_name, &netdev);
759         if (netdev) {
760             if (!netdev_get_etheraddr(netdev, mac->addr)) {
761                 n_local_macs++;
762             }
763             netdev_close(netdev);
764         }
765     }
766     svec_destroy(&ifaces);
767
768     /* Parse the response from ovs-appctl and convert it to binary format to
769      * pass back to the kernel. */
770     ofpbuf_init(&query_data, sizeof(struct __fdb_entry) * 8);
771     save_ptr = NULL;
772     strtok_r(output, "\n", &save_ptr); /* Skip header line. */
773     while (count > 0) {
774         struct __fdb_entry *entry;
775         int port, vlan, age;
776         uint8_t mac[ETH_ADDR_LEN];
777         char *line;
778         bool is_local;
779
780         line = strtok_r(NULL, "\n", &save_ptr);
781         if (!line) {
782             break;
783         }
784
785         if (sscanf(line, "%d %d "ETH_ADDR_SCAN_FMT" %d",
786                    &port, &vlan, ETH_ADDR_SCAN_ARGS(mac), &age)
787             != 2 + ETH_ADDR_SCAN_COUNT + 1) {
788             struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
789             VLOG_INFO_RL(&rl, "fdb/show output has invalid format: %s", line);
790             continue;
791         }
792
793         if (vlan != br_vlan) {
794             continue;
795         }
796
797         if (skip > 0) {
798             skip--;
799             continue;
800         }
801
802         /* Is this the MAC address of an interface on the bridge? */
803         is_local = false;
804         for (i = 0; i < n_local_macs; i++) {
805             if (eth_addr_equals(local_macs[i].addr, mac)) {
806                 is_local = true;
807                 break;
808             }
809         }
810
811         entry = ofpbuf_put_uninit(&query_data, sizeof *entry);
812         memcpy(entry->mac_addr, mac, ETH_ADDR_LEN);
813         entry->port_no = port & 0xff;
814         entry->is_local = is_local;
815         entry->ageing_timer_value = age * HZ;
816         entry->port_hi = (port & 0xff00) >> 8;
817         entry->pad0 = 0;
818         entry->unused = 0;
819         count--;
820     }
821     free(output);
822
823     /* Compose and send reply to datapath. */
824     reply = compose_reply(seq, 0);
825     nl_msg_put_unspec(reply, BRC_GENL_A_FDB_DATA,
826                       query_data.data, query_data.size);
827     send_reply(reply);
828
829     /* Free memory. */
830     ofpbuf_uninit(&query_data);
831
832     return 0;
833 }
834
835 static void
836 send_ifindex_reply(uint32_t seq, struct svec *ifaces)
837 {
838     struct ofpbuf *reply;
839     const char *iface;
840     size_t n_indices;
841     int *indices;
842     size_t i;
843
844     /* Make sure that any given interface only occurs once.  This shouldn't
845      * happen, but who knows what people put into their configuration files. */
846     svec_sort_unique(ifaces);
847
848     /* Convert 'ifaces' into ifindexes. */
849     n_indices = 0;
850     indices = xmalloc(ifaces->n * sizeof *indices);
851     SVEC_FOR_EACH (i, iface, ifaces) {
852         int ifindex = if_nametoindex(iface);
853         if (ifindex) {
854             indices[n_indices++] = ifindex;
855         }
856     }
857
858     /* Compose and send reply. */
859     reply = compose_reply(seq, 0);
860     nl_msg_put_unspec(reply, BRC_GENL_A_IFINDEXES,
861                       indices, n_indices * sizeof *indices);
862     send_reply(reply);
863
864     /* Free memory. */
865     free(indices);
866 }
867
868 static int
869 handle_get_bridges_cmd(const struct ovsrec_open_vswitch *ovs,
870                        struct ofpbuf *buffer)
871 {
872     struct svec bridges;
873     size_t i, j;
874
875     uint32_t seq;
876
877     int error;
878
879     /* Parse Netlink command.
880      *
881      * The command doesn't actually have any arguments, but we need the
882      * sequence number to send the reply. */
883     error = parse_command(buffer, &seq, NULL, NULL, NULL, NULL);
884     if (error) {
885         return error;
886     }
887
888     /* Get all the real bridges and all the fake ones. */
889     svec_init(&bridges);
890     for (i = 0; i < ovs->n_bridges; i++) {
891         const struct ovsrec_bridge *br = ovs->bridges[i];
892
893         svec_add(&bridges, br->name);
894         for (j = 0; j < br->n_ports; j++) {
895             const struct ovsrec_port *port = br->ports[j];
896
897             if (port->fake_bridge) {
898                 svec_add(&bridges, port->name);
899             }
900         }
901     }
902
903     send_ifindex_reply(seq, &bridges);
904     svec_destroy(&bridges);
905
906     return 0;
907 }
908
909 static int
910 handle_get_ports_cmd(const struct ovsrec_open_vswitch *ovs,
911                      struct ofpbuf *buffer)
912 {
913     uint32_t seq;
914
915     const char *linux_name;
916     const struct ovsrec_bridge *ovs_bridge;
917     int br_vlan;
918
919     struct svec ports;
920
921     int error;
922
923     /* Parse Netlink command. */
924     error = parse_command(buffer, &seq, &linux_name, NULL, NULL, NULL);
925     if (error) {
926         return error;
927     }
928
929     error = linux_bridge_to_ovs_bridge(ovs, linux_name, 
930                                        &ovs_bridge, &br_vlan);
931     if (error) {
932         send_simple_reply(seq, error);
933         return error;
934     }
935
936     svec_init(&ports);
937     get_bridge_ports(ovs_bridge, &ports, br_vlan);
938     svec_sort(&ports);
939     svec_del(&ports, linux_name);
940     send_ifindex_reply(seq, &ports); /* XXX bonds won't show up */
941     svec_destroy(&ports);
942
943     return 0;
944 }
945
946 static void
947 brc_recv_update(const struct ovsrec_open_vswitch *ovs)
948 {
949     int retval;
950     struct ofpbuf *buffer;
951     struct genlmsghdr *genlmsghdr;
952
953
954     buffer = NULL;
955     do {
956         ofpbuf_delete(buffer);
957         retval = nl_sock_recv(brc_sock, &buffer, false);
958     } while (retval == ENOBUFS
959             || (!retval
960                 && (nl_msg_nlmsgerr(buffer, NULL)
961                     || nl_msg_nlmsghdr(buffer)->nlmsg_type == NLMSG_DONE)));
962     if (retval) {
963         if (retval != EAGAIN) {
964             VLOG_WARN_RL(&rl, "brc_recv_update: %s", strerror(retval));
965         }
966         return;
967     }
968
969     genlmsghdr = nl_msg_genlmsghdr(buffer);
970     if (!genlmsghdr) {
971         VLOG_WARN_RL(&rl, "received packet too short for generic NetLink");
972         goto error;
973     }
974
975     if (nl_msg_nlmsghdr(buffer)->nlmsg_type != brc_family) {
976         VLOG_DBG_RL(&rl, "received type (%"PRIu16") != brcompat family (%d)",
977                 nl_msg_nlmsghdr(buffer)->nlmsg_type, brc_family);
978         goto error;
979     }
980
981     /* Just drop the request on the floor if a valid configuration
982      * doesn't exist.  We don't immediately do this check, because we
983      * want to drain pending netlink messages. */
984     if (!ovs) {
985         VLOG_WARN_RL(&rl, "could not find valid configuration to update");
986         goto error;
987     }
988
989     switch (genlmsghdr->cmd) {
990     case BRC_GENL_C_DP_ADD:
991         handle_bridge_cmd(ovs, buffer, true);
992         break;
993
994     case BRC_GENL_C_DP_DEL:
995         handle_bridge_cmd(ovs, buffer, false);
996         break;
997
998     case BRC_GENL_C_PORT_ADD:
999         handle_port_cmd(ovs, buffer, true);
1000         break;
1001
1002     case BRC_GENL_C_PORT_DEL:
1003         handle_port_cmd(ovs, buffer, false);
1004         break;
1005
1006     case BRC_GENL_C_FDB_QUERY:
1007         handle_fdb_query_cmd(ovs, buffer);
1008         break;
1009
1010     case BRC_GENL_C_GET_BRIDGES:
1011         handle_get_bridges_cmd(ovs, buffer);
1012         break;
1013
1014     case BRC_GENL_C_GET_PORTS:
1015         handle_get_ports_cmd(ovs, buffer);
1016         break;
1017
1018     default:
1019         VLOG_WARN_RL(&rl, "received unknown brc netlink command: %d\n",
1020                 genlmsghdr->cmd);
1021         break;
1022     }
1023
1024 error:
1025     ofpbuf_delete(buffer);
1026     return;
1027 }
1028
1029 /* Check for interface configuration changes announced through RTNL. */
1030 static void
1031 rtnl_recv_update(const struct ovsrec_open_vswitch *ovs)
1032 {
1033     struct ofpbuf *buf;
1034
1035     int error = nl_sock_recv(rtnl_sock, &buf, false);
1036     if (error == EAGAIN) {
1037         /* Nothing to do. */
1038     } else if (error == ENOBUFS) {
1039         VLOG_WARN_RL(&rl, "network monitor socket overflowed");
1040     } else if (error) {
1041         VLOG_WARN_RL(&rl, "error on network monitor socket: %s", 
1042                 strerror(error));
1043     } else {
1044         struct nlattr *attrs[ARRAY_SIZE(rtnlgrp_link_policy)];
1045         struct nlmsghdr *nlh;
1046         struct ifinfomsg *iim;
1047
1048         nlh = ofpbuf_at(buf, 0, NLMSG_HDRLEN);
1049         iim = ofpbuf_at(buf, NLMSG_HDRLEN, sizeof *iim);
1050         if (!iim) {
1051             VLOG_WARN_RL(&rl, "received bad rtnl message (no ifinfomsg)");
1052             ofpbuf_delete(buf);
1053             return;
1054         } 
1055     
1056         if (!nl_policy_parse(buf, NLMSG_HDRLEN + sizeof(struct ifinfomsg),
1057                              rtnlgrp_link_policy,
1058                              attrs, ARRAY_SIZE(rtnlgrp_link_policy))) {
1059             VLOG_WARN_RL(&rl,"received bad rtnl message (policy)");
1060             ofpbuf_delete(buf);
1061             return;
1062         }
1063         if (nlh->nlmsg_type == RTM_DELLINK && attrs[IFLA_MASTER]) {
1064             const char *port_name = nl_attr_get_string(attrs[IFLA_IFNAME]);
1065             char br_name[IFNAMSIZ];
1066             uint32_t br_idx = nl_attr_get_u32(attrs[IFLA_MASTER]);
1067
1068             if (!if_indextoname(br_idx, br_name)) {
1069                 ofpbuf_delete(buf);
1070                 return;
1071             }
1072
1073             if (!netdev_exists(port_name)) {
1074                 /* Network device is really gone. */
1075                 struct ovsrec_bridge *br = find_bridge(ovs, br_name);
1076
1077                 VLOG_INFO("network device %s destroyed, "
1078                           "removing from bridge %s", port_name, br_name);
1079
1080                 if (!br) {
1081                     VLOG_WARN("no bridge named %s from which to remove %s", 
1082                             br_name, port_name);
1083                     ofpbuf_delete(buf);
1084                     return;
1085                 }
1086
1087                 del_port(br, port_name);
1088             } else {
1089                 /* A network device by that name exists even though the kernel
1090                  * told us it had disappeared.  Probably, what happened was
1091                  * this:
1092                  *
1093                  *      1. Device destroyed.
1094                  *      2. Notification sent to us.
1095                  *      3. New device created with same name as old one.
1096                  *      4. ovs-brcompatd notified, removes device from bridge.
1097                  *
1098                  * There's no a priori reason that in this situation that the
1099                  * new device with the same name should remain in the bridge;
1100                  * on the contrary, that would be unexpected.  *But* there is
1101                  * one important situation where, if we do this, bad things
1102                  * happen.  This is the case of XenServer Tools version 5.0.0,
1103                  * which on boot of a Windows VM cause something like this to
1104                  * happen on the Xen host:
1105                  *
1106                  *      i. Create tap1.0 and vif1.0.
1107                  *      ii. Delete tap1.0.
1108                  *      iii. Delete vif1.0.
1109                  *      iv. Re-create vif1.0.
1110                  *
1111                  * (XenServer Tools 5.5.0 does not exhibit this behavior, and
1112                  * neither does a VM without Tools installed at all.@.)
1113                  *
1114                  * Steps iii and iv happen within a few seconds of each other.
1115                  * Step iv causes /etc/xensource/scripts/vif to run, which in
1116                  * turn calls ovs-cfg-mod to add the new device to the bridge.
1117                  * If step iv happens after step 4 (in our first list of
1118                  * steps), then all is well, but if it happens between 3 and 4
1119                  * (which can easily happen if ovs-brcompatd has to wait to
1120                  * lock the configuration file), then we will remove the new
1121                  * incarnation from the bridge instead of the old one!
1122                  *
1123                  * So, to avoid this problem, we do nothing here.  This is
1124                  * strictly incorrect except for this one particular case, and
1125                  * perhaps that will bite us someday.  If that happens, then we
1126                  * will have to somehow track network devices by ifindex, since
1127                  * a new device will have a new ifindex even if it has the same
1128                  * name as an old device.
1129                  */
1130                 VLOG_INFO("kernel reported network device %s removed but "
1131                           "a device by that name exists (XS Tools 5.0.0?)",
1132                           port_name);
1133             }
1134         }
1135         ofpbuf_delete(buf);
1136     }
1137 }
1138
1139 int
1140 main(int argc, char *argv[])
1141 {
1142     struct unixctl_server *unixctl;
1143     const char *remote;
1144     struct ovsdb_idl *idl;
1145     int retval;
1146
1147     set_program_name(argv[0]);
1148     time_init();
1149     vlog_init();
1150     vlog_set_levels(VLM_ANY_MODULE, VLF_CONSOLE, VLL_WARN);
1151     vlog_set_levels(VLM_reconnect, VLF_ANY_FACILITY, VLL_WARN);
1152
1153     remote = parse_options(argc, argv);
1154     signal(SIGPIPE, SIG_IGN);
1155     process_init();
1156
1157     die_if_already_running();
1158     daemonize_start();
1159
1160     retval = unixctl_server_create(NULL, &unixctl);
1161     if (retval) {
1162         exit(EXIT_FAILURE);
1163     }
1164
1165     if (brc_open(&brc_sock)) {
1166         ovs_fatal(0, "could not open brcompat socket.  Check "
1167                 "\"brcompat\" kernel module.");
1168     }
1169
1170     if (prune_timeout) {
1171         if (nl_sock_create(NETLINK_ROUTE, RTNLGRP_LINK, 0, 0, &rtnl_sock)) {
1172             ovs_fatal(0, "could not create rtnetlink socket");
1173         }
1174     }
1175
1176     daemonize_complete();
1177
1178     idl = ovsdb_idl_create(remote, &ovsrec_idl_class);
1179
1180     for (;;) {
1181         const struct ovsrec_open_vswitch *ovs;
1182         struct ovsdb_idl_txn *txn;
1183         enum ovsdb_idl_txn_status status;
1184
1185         ovsdb_idl_run(idl);
1186
1187         txn = ovsdb_idl_txn_create(idl);
1188
1189         unixctl_server_run(unixctl);
1190         ovs = ovsrec_open_vswitch_first(idl);
1191         brc_recv_update(ovs);
1192
1193         if (!ovs && ovsdb_idl_has_ever_connected(idl)) {
1194             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
1195             VLOG_WARN_RL(&rl, "%s: database does not contain any Open vSwitch "
1196                          "configuration", remote);
1197         }
1198         netdev_run();
1199
1200         /* If 'prune_timeout' is non-zero, we actively prune from the
1201          * configuration of port entries that are no longer valid.  We 
1202          * use two methods: 
1203          *
1204          *   1) The kernel explicitly notifies us of removed ports
1205          *      through the RTNL messages.
1206          *
1207          *   2) We periodically check all ports associated with bridges
1208          *      to see if they no longer exist.
1209          */
1210         if (ovs && prune_timeout) {
1211             rtnl_recv_update(ovs);
1212 #if 0
1213             prune_ports();
1214 #endif
1215
1216             nl_sock_wait(rtnl_sock, POLLIN);
1217             poll_timer_wait(prune_timeout);
1218         }
1219
1220         while ((status = ovsdb_idl_txn_commit(txn)) == TXN_INCOMPLETE) {
1221             ovsdb_idl_run(idl);
1222             ovsdb_idl_wait(idl);
1223             ovsdb_idl_txn_wait(txn);
1224             poll_block();
1225         }
1226         ovsdb_idl_txn_destroy(txn);
1227             
1228         switch (status) {
1229         case TXN_INCOMPLETE:
1230             NOT_REACHED();
1231         
1232         case TXN_ABORTED:
1233             /* Should not happen--we never call ovsdb_idl_txn_abort(). */
1234             ovs_fatal(0, "transaction aborted");
1235         
1236         case TXN_SUCCESS:
1237         case TXN_UNCHANGED:
1238             break;
1239         
1240         case TXN_TRY_AGAIN:
1241             /* xxx Handle this better! */
1242             printf("xxx We need to try again!\n");
1243             break;
1244
1245         case TXN_ERROR:
1246             /* xxx Is this what we want to do? */
1247             ovs_fatal(0, "transaction error");
1248                 
1249         default:
1250             NOT_REACHED();
1251         }
1252
1253         nl_sock_wait(brc_sock, POLLIN);
1254         ovsdb_idl_wait(idl);
1255         unixctl_server_wait(unixctl);
1256         netdev_wait();
1257         poll_block();
1258     }
1259
1260     ovsdb_idl_destroy(idl);
1261
1262     return 0;
1263 }
1264
1265 static void
1266 validate_appctl_command(void)
1267 {
1268     const char *p;
1269     int n;
1270
1271     n = 0;
1272     for (p = strchr(appctl_command, '%'); p; p = strchr(p + 2, '%')) {
1273         if (p[1] == '%') {
1274             /* Nothing to do. */
1275         } else if (p[1] == 's') {
1276             n++;
1277         } else {
1278             ovs_fatal(0, "only '%%s' and '%%%%' allowed in --appctl-command");
1279         }
1280     }
1281     if (n != 1) {
1282         ovs_fatal(0, "'%%s' must appear exactly once in --appctl-command");
1283     }
1284 }
1285
1286 static const char *
1287 parse_options(int argc, char *argv[])
1288 {
1289     enum {
1290         OPT_PRUNE_TIMEOUT,
1291         OPT_APPCTL_COMMAND,
1292         VLOG_OPTION_ENUMS,
1293         LEAK_CHECKER_OPTION_ENUMS
1294     };
1295     static struct option long_options[] = {
1296         {"help",             no_argument, 0, 'h'},
1297         {"version",          no_argument, 0, 'V'},
1298         {"prune-timeout",    required_argument, 0, OPT_PRUNE_TIMEOUT},
1299         {"appctl-command",   required_argument, 0, OPT_APPCTL_COMMAND},
1300         DAEMON_LONG_OPTIONS,
1301         VLOG_LONG_OPTIONS,
1302         LEAK_CHECKER_LONG_OPTIONS,
1303         {0, 0, 0, 0},
1304     };
1305     char *short_options = long_options_to_short_options(long_options);
1306
1307     appctl_command = xasprintf("%s/ovs-appctl %%s", ovs_bindir);
1308     for (;;) {
1309         int c;
1310
1311         c = getopt_long(argc, argv, short_options, long_options, NULL);
1312         if (c == -1) {
1313             break;
1314         }
1315
1316         switch (c) {
1317         case 'H':
1318         case 'h':
1319             usage();
1320
1321         case 'V':
1322             OVS_PRINT_VERSION(0, 0);
1323             exit(EXIT_SUCCESS);
1324
1325         case OPT_PRUNE_TIMEOUT:
1326             prune_timeout = atoi(optarg) * 1000;
1327             break;
1328
1329         case OPT_APPCTL_COMMAND:
1330             appctl_command = optarg;
1331             break;
1332
1333         VLOG_OPTION_HANDLERS
1334         DAEMON_OPTION_HANDLERS
1335         LEAK_CHECKER_OPTION_HANDLERS
1336
1337         case '?':
1338             exit(EXIT_FAILURE);
1339
1340         default:
1341             abort();
1342         }
1343     }
1344     free(short_options);
1345
1346     validate_appctl_command();
1347
1348     argc -= optind;
1349     argv += optind;
1350
1351     if (argc != 1) {
1352         ovs_fatal(0, "database socket is non-option argument; "
1353                 "use --help for usage");
1354     }
1355
1356     return argv[0];
1357 }
1358
1359 static void
1360 usage(void)
1361 {
1362     printf("%s: bridge compatibility front-end for ovs-vswitchd\n"
1363            "usage: %s [OPTIONS] CONFIG\n"
1364            "CONFIG is the configuration file used by ovs-vswitchd.\n",
1365            program_name, program_name);
1366     printf("\nConfiguration options:\n"
1367            "  --appctl-command=COMMAND  shell command to run ovs-appctl\n"
1368            "  --prune-timeout=SECS    wait at most SECS before pruning ports\n"
1369           );
1370     daemon_usage();
1371     vlog_usage();
1372     printf("\nOther options:\n"
1373            "  -h, --help              display this help message\n"
1374            "  -V, --version           display version information\n");
1375     leak_checker_usage();
1376     printf("\nThe default appctl command is:\n%s\n", appctl_command);
1377     exit(EXIT_SUCCESS);
1378 }