2 # Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 # A daemon to monitor the external_ids columns of the Bridge and
18 # Interface OVSDB tables for changes that require interrogating XAPI.
19 # Its responsibilities include:
21 # - Set the "bridge-id" key in the Bridge table.
22 # - Set the "iface-id" key in the Interface table.
23 # - Set the fail-mode on internal bridges.
36 import ovs.unixctl.server
38 vlog = ovs.vlog.Vlog("ovs-xapi-sync")
45 def unixctl_exit(conn, unused_argv, unused_aux):
51 def unixctl_flush_cache(conn, unused_argv, unused_aux):
57 # Set up a session to interact with XAPI.
59 # On system start-up, OVS comes up before XAPI, so we can't log into the
60 # session until later. Try to do this on-demand, since we won't
61 # actually do anything interesting until XAPI is up.
64 if session is not None:
68 session = XenAPI.xapi_local()
69 session.xenapi.login_with_password("", "")
70 except XenAPI.Failure as e:
72 vlog.warn("Couldn't login to XAPI (%s)" % e)
78 def get_network_by_bridge(br_name):
79 if not init_session():
80 vlog.warn("Failed to get bridge id %s because"
81 " XAPI session could not be initialized" % br_name)
84 recs = session.xenapi.network.get_all_records_where(
85 'field "bridge"="%s"' % br_name)
87 return recs.values()[0]
92 # There are possibilities when multiple xs-network-uuids are set for a bridge.
93 # In cases like that, we should choose the bridge-id associated with the bridge
95 def get_single_bridge_id(bridge_ids, br_name, default=None):
98 rec = get_network_by_bridge(br_name)
99 if rec and rec['uuid'] in bridge_ids:
102 vlog.warn("Failed to get a single bridge id from Xapi.")
107 # By default, the "bridge-id" external id in the Bridge table is the
108 # same as "xs-network-uuids". This may be overridden by defining a
109 # "nicira-bridge-id" key in the "other_config" field of the network
110 # record of XAPI. If nicira-bridge-id is undefined returns default.
111 # On error returns None.
112 def get_bridge_id(br_name, default=None):
113 rec = get_network_by_bridge(br_name)
115 return rec['other_config'].get('nicira-bridge-id', default)
119 # By default, the "iface-id" external id in the Interface table is the
120 # same as "xs-vif-uuid". This may be overridden by defining a
121 # "nicira-iface-id" key in the "other_config" field of the VIF
123 def get_iface_id(if_name, xs_vif_uuid):
124 if not if_name.startswith("vif") and not if_name.startswith("tap"):
125 # Treat whatever was passed into 'xs_vif_uuid' as a default
126 # value for non-VIFs.
129 if not init_session():
130 vlog.warn("Failed to get interface id %s because"
131 " XAPI session could not be initialized" % if_name)
135 vif = session.xenapi.VIF.get_by_uuid(xs_vif_uuid)
136 rec = session.xenapi.VIF.get_record(vif)
137 return rec['other_config'].get('nicira-iface-id', xs_vif_uuid)
138 except XenAPI.Failure:
139 vlog.warn("Could not find XAPI entry for VIF %s" % if_name)
143 # By default, the "vm-id" external id in the Interface table is the
144 # same as "xs-vm-uuid". This may be overridden by defining a
145 # "nicira-vm-id" key in the "other_config" field of the VM
147 def get_vm_id(if_name, xs_vm_uuid):
148 if not if_name.startswith("vif") and not if_name.startswith("tap"):
149 # Treat whatever was passed into 'xs_vm_uuid' as a default
150 # value for non-VIFs.
153 if not init_session():
154 vlog.warn("Failed to get vm id for interface id %s because"
155 " XAPI session could not be initialized" % if_name)
159 vm = session.xenapi.VM.get_by_uuid(xs_vm_uuid)
160 rec = session.xenapi.VM.get_record(vm)
161 return rec['other_config'].get('nicira-vm-id', xs_vm_uuid)
162 except XenAPI.Failure:
163 vlog.warn("Could not find XAPI entry for VIF %s" % if_name)
167 def set_or_delete(d, key, value):
173 if d.get(key) != value:
179 def set_external_id(row, key, value):
180 row.verify("external_ids")
181 external_ids = row.external_ids
182 if set_or_delete(external_ids, key, value):
183 row.external_ids = external_ids
186 # XenServer does not call interface-reconfigure on internal networks,
187 # which is where the fail-mode would normally be set.
188 def update_fail_mode(row):
189 rec = get_network_by_bridge(row.name)
193 fail_mode = rec['other_config'].get('vswitch-controller-fail-mode')
196 pools = session.xenapi.pool.get_all()
198 prec = session.xenapi.pool.get_record(pools[0])
199 fail_mode = prec['other_config'].get(
200 'vswitch-controller-fail-mode')
202 if fail_mode not in ['standalone', 'secure']:
203 fail_mode = 'standalone'
205 row.verify("fail_mode")
206 if row.fail_mode != fail_mode:
207 row.fail_mode = fail_mode
210 def update_in_band_mgmt(row):
211 rec = get_network_by_bridge(row.name)
215 dib = rec['other_config'].get('vswitch-disable-in-band')
217 row.verify("other_config")
218 other_config = row.other_config
219 if dib and dib not in ['true', 'false']:
220 vlog.warn('"%s" isn\'t a valid setting for '
221 "other_config:disable-in-band on %s" % (dib, row.name))
222 elif set_or_delete(other_config, 'disable-in-band', dib):
223 row.other_config = other_config
227 global flush_cache, xapi_down
229 parser = argparse.ArgumentParser()
230 parser.add_argument("database", metavar="DATABASE",
231 help="A socket on which ovsdb-server is listening.")
232 parser.add_argument("--root-prefix", metavar="DIR", default='',
233 help="Use DIR as alternate root directory"
236 ovs.vlog.add_args(parser)
237 ovs.daemon.add_args(parser)
238 args = parser.parse_args()
239 ovs.vlog.handle_args(args)
240 ovs.daemon.handle_args(args)
242 remote = args.database
243 schema_helper = ovs.db.idl.SchemaHelper()
244 schema_helper.register_columns("Bridge", ["name", "external_ids",
245 "other_config", "fail_mode"])
246 schema_helper.register_columns("Interface", ["name", "external_ids"])
247 idl = ovs.db.idl.Idl(remote, schema_helper)
249 ovs.daemon.daemonize()
251 ovs.unixctl.command_register("exit", "", 0, 0, unixctl_exit, None)
252 ovs.unixctl.command_register("flush-cache", "", 0, 0, unixctl_flush_cache,
254 error, unixctl_server = ovs.unixctl.server.UnixctlServer.create(None)
256 ovs.util.ovs_fatal(error, "could not create unixctl server", vlog)
258 # This daemon is usually started before XAPI, but to complete our
259 # tasks, we need it. Wait here until it's up.
260 cookie_file = args.root_prefix + "/var/run/xapi_init_complete.cookie"
261 while not os.path.exists(cookie_file):
264 bridges = {} # Map from bridge name to nicira-bridge-id
265 iface_ids = {} # Map from xs-vif-uuid to iface-id
266 vm_ids = {} # Map from xs-vm-uuid to vm-id
267 seqno = idl.change_seqno # Sequence number when we last processed the db
274 if not xapi_down and not flush_cache and seqno == idl.change_seqno:
275 poller = ovs.poller.Poller()
276 unixctl_server.wait(poller)
282 vlog.warn("Xapi is probably down. Retry again after a second.")
287 vlog.info("Flushing cache as the result of unixctl.")
292 seqno = idl.change_seqno
294 txn = ovs.db.idl.Transaction(idl)
297 for row in idl.tables["Bridge"].rows.itervalues():
298 bridge_id = bridges.get(row.name)
299 if bridge_id is None:
300 # Configure the new bridge.
301 update_fail_mode(row)
302 update_in_band_mgmt(row)
304 # Get the correct bridge_id, if we can.
305 bridge_id = get_bridge_id(row.name)
306 if bridge_id is None:
307 xs_network_uuids = row.external_ids.get("xs-network-uuids")
309 bridge_ids = xs_network_uuids.split(";")
310 if len(bridge_ids) == 1:
311 bridge_id = bridge_ids[0]
313 bridge_id = get_single_bridge_id(bridge_ids,
315 set_external_id(row, "bridge-id", bridge_id)
317 if bridge_id is not None:
318 new_bridges[row.name] = bridge_id
319 bridges = new_bridges
322 for row in idl.tables["Interface"].rows.itervalues():
323 iface_by_name[row.name] = row
327 for row in idl.tables["Interface"].rows.itervalues():
328 # Match up paired vif and tap devices.
329 if row.name.startswith("vif"):
331 tap = iface_by_name.get("tap%s" % row.name[3:])
332 elif row.name.startswith("tap"):
334 vif = iface_by_name.get("vif%s" % row.name[3:])
338 # Several tap external-ids need to be copied from the vif.
339 if row == tap and vif:
340 keys = ["attached-mac",
345 set_external_id(row, k, vif.external_ids.get(k))
347 # Map from xs-vif-uuid to iface-id.
349 # (A tap's xs-vif-uuid comes from its vif. That falls out
350 # naturally from the copy loop above.)
351 xvu = row.external_ids.get("xs-vif-uuid")
353 iface_id = (new_iface_ids.get(xvu)
354 or iface_ids.get(xvu)
355 or get_iface_id(row.name, xvu))
356 new_iface_ids[xvu] = iface_id
358 # No xs-vif-uuid therefore no iface-id.
360 set_external_id(row, "iface-id", iface_id)
362 # Map from xs-vm-uuid to vm-id.
363 xvmu = row.external_ids.get("xs-vm-uuid")
365 vm_id = (new_vm_ids.get(xvmu)
367 or get_vm_id(row.name, xvmu))
368 new_vm_ids[xvmu] = vm_id
371 set_external_id(row, "vm-id", vm_id)
373 # When there's a vif and a tap, the tap is active (used for
374 # traffic). When there's just a vif, the vif is active.
376 # A tap on its own shouldn't happen, and we don't know
377 # anything about other kinds of devices, so we don't use
378 # an iface-status for those devices at all.
380 set_external_id(tap, "iface-status", "active")
381 set_external_id(vif, "iface-status", "inactive")
383 set_external_id(vif, "iface-status", "active")
385 set_external_id(row, "iface-status", None)
386 iface_ids = new_iface_ids
389 txn.add_comment("ovs-xapi-sync: Updating records from XAPI")
392 unixctl_server.close()
396 if __name__ == '__main__':
400 # Let system.exit() calls complete normally
403 vlog.exception("traceback")
404 sys.exit(ovs.daemon.RESTART_EXIT_CODE)