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
39 vlog = ovs.vlog.Vlog("ovs-xapi-sync")
46 def unixctl_exit(conn, unused_argv, unused_aux):
52 def unixctl_flush_cache(conn, unused_argv, unused_aux):
58 # Set up a session to interact with XAPI.
60 # On system start-up, OVS comes up before XAPI, so we can't log into the
61 # session until later. Try to do this on-demand, since we won't
62 # actually do anything interesting until XAPI is up.
65 if session is not None:
69 session = XenAPI.xapi_local()
70 session.xenapi.login_with_password("", "")
71 except XenAPI.Failure as e:
73 vlog.warn("Couldn't login to XAPI (%s)" % e)
79 def get_network_by_bridge(br_name):
80 if not init_session():
81 vlog.warn("Failed to get bridge id %s because"
82 " XAPI session could not be initialized" % br_name)
85 recs = session.xenapi.network.get_all_records_where(
86 'field "bridge"="%s"' % br_name)
88 return next(six.itervalues(recs))
93 # There are possibilities when multiple xs-network-uuids are set for a bridge.
94 # In cases like that, we should choose the bridge-id associated with the bridge
96 def get_single_bridge_id(bridge_ids, br_name, default=None):
99 rec = get_network_by_bridge(br_name)
100 if rec and rec['uuid'] in bridge_ids:
103 vlog.warn("Failed to get a single bridge id from Xapi.")
108 # By default, the "bridge-id" external id in the Bridge table is the
109 # same as "xs-network-uuids". This may be overridden by defining a
110 # "nicira-bridge-id" key in the "other_config" field of the network
111 # record of XAPI. If nicira-bridge-id is undefined returns default.
112 # On error returns None.
113 def get_bridge_id(br_name, default=None):
114 rec = get_network_by_bridge(br_name)
116 return rec['other_config'].get('nicira-bridge-id', default)
120 # By default, the "iface-id" external id in the Interface table is the
121 # same as "xs-vif-uuid". This may be overridden by defining a
122 # "nicira-iface-id" key in the "other_config" field of the VIF
124 def get_iface_id(if_name, xs_vif_uuid):
125 if not if_name.startswith("vif") and not if_name.startswith("tap"):
126 # Treat whatever was passed into 'xs_vif_uuid' as a default
127 # value for non-VIFs.
130 if not init_session():
131 vlog.warn("Failed to get interface id %s because"
132 " XAPI session could not be initialized" % if_name)
136 vif = session.xenapi.VIF.get_by_uuid(xs_vif_uuid)
137 rec = session.xenapi.VIF.get_record(vif)
138 return rec['other_config'].get('nicira-iface-id', xs_vif_uuid)
139 except XenAPI.Failure:
140 vlog.warn("Could not find XAPI entry for VIF %s" % if_name)
144 # By default, the "vm-id" external id in the Interface table is the
145 # same as "xs-vm-uuid". This may be overridden by defining a
146 # "nicira-vm-id" key in the "other_config" field of the VM
148 def get_vm_id(if_name, xs_vm_uuid):
149 if not if_name.startswith("vif") and not if_name.startswith("tap"):
150 # Treat whatever was passed into 'xs_vm_uuid' as a default
151 # value for non-VIFs.
154 if not init_session():
155 vlog.warn("Failed to get vm id for interface id %s because"
156 " XAPI session could not be initialized" % if_name)
160 vm = session.xenapi.VM.get_by_uuid(xs_vm_uuid)
161 rec = session.xenapi.VM.get_record(vm)
162 return rec['other_config'].get('nicira-vm-id', xs_vm_uuid)
163 except XenAPI.Failure:
164 vlog.warn("Could not find XAPI entry for VIF %s" % if_name)
168 def set_or_delete(d, key, value):
174 if d.get(key) != value:
180 def set_external_id(row, key, value):
181 row.verify("external_ids")
182 external_ids = row.external_ids
183 if set_or_delete(external_ids, key, value):
184 row.external_ids = external_ids
187 # XenServer does not call interface-reconfigure on internal networks,
188 # which is where the fail-mode would normally be set.
189 def update_fail_mode(row):
190 rec = get_network_by_bridge(row.name)
194 fail_mode = rec['other_config'].get('vswitch-controller-fail-mode')
197 pools = session.xenapi.pool.get_all()
199 prec = session.xenapi.pool.get_record(pools[0])
200 fail_mode = prec['other_config'].get(
201 'vswitch-controller-fail-mode')
203 if fail_mode not in ['standalone', 'secure']:
204 fail_mode = 'standalone'
206 row.verify("fail_mode")
207 if row.fail_mode != fail_mode:
208 row.fail_mode = fail_mode
211 def update_in_band_mgmt(row):
212 rec = get_network_by_bridge(row.name)
216 dib = rec['other_config'].get('vswitch-disable-in-band')
218 row.verify("other_config")
219 other_config = row.other_config
220 if dib and dib not in ['true', 'false']:
221 vlog.warn('"%s" isn\'t a valid setting for '
222 "other_config:disable-in-band on %s" % (dib, row.name))
223 elif set_or_delete(other_config, 'disable-in-band', dib):
224 row.other_config = other_config
228 global flush_cache, xapi_down
230 parser = argparse.ArgumentParser()
231 parser.add_argument("database", metavar="DATABASE",
232 help="A socket on which ovsdb-server is listening.")
233 parser.add_argument("--root-prefix", metavar="DIR", default='',
234 help="Use DIR as alternate root directory"
237 ovs.vlog.add_args(parser)
238 ovs.daemon.add_args(parser)
239 args = parser.parse_args()
240 ovs.vlog.handle_args(args)
241 ovs.daemon.handle_args(args)
243 remote = args.database
244 schema_helper = ovs.db.idl.SchemaHelper()
245 schema_helper.register_columns("Bridge", ["name", "external_ids",
246 "other_config", "fail_mode"])
247 schema_helper.register_columns("Interface", ["name", "external_ids"])
248 idl = ovs.db.idl.Idl(remote, schema_helper)
250 ovs.daemon.daemonize()
252 ovs.unixctl.command_register("exit", "", 0, 0, unixctl_exit, None)
253 ovs.unixctl.command_register("flush-cache", "", 0, 0, unixctl_flush_cache,
255 error, unixctl_server = ovs.unixctl.server.UnixctlServer.create(None)
257 ovs.util.ovs_fatal(error, "could not create unixctl server", vlog)
259 # This daemon is usually started before XAPI, but to complete our
260 # tasks, we need it. Wait here until it's up.
261 cookie_file = args.root_prefix + "/var/run/xapi_init_complete.cookie"
262 while not os.path.exists(cookie_file):
265 bridges = {} # Map from bridge name to nicira-bridge-id
266 iface_ids = {} # Map from xs-vif-uuid to iface-id
267 vm_ids = {} # Map from xs-vm-uuid to vm-id
268 seqno = idl.change_seqno # Sequence number when we last processed the db
275 if not xapi_down and not flush_cache and seqno == idl.change_seqno:
276 poller = ovs.poller.Poller()
277 unixctl_server.wait(poller)
283 vlog.warn("Xapi is probably down. Retry again after a second.")
288 vlog.info("Flushing cache as the result of unixctl.")
293 seqno = idl.change_seqno
295 txn = ovs.db.idl.Transaction(idl)
298 for row in six.itervalues(idl.tables["Bridge"].rows):
299 bridge_id = bridges.get(row.name)
300 if bridge_id is None:
301 # Configure the new bridge.
302 update_fail_mode(row)
303 update_in_band_mgmt(row)
305 # Get the correct bridge_id, if we can.
306 bridge_id = get_bridge_id(row.name)
307 if bridge_id is None:
308 xs_network_uuids = row.external_ids.get("xs-network-uuids")
310 bridge_ids = xs_network_uuids.split(";")
311 if len(bridge_ids) == 1:
312 bridge_id = bridge_ids[0]
314 bridge_id = get_single_bridge_id(bridge_ids,
316 set_external_id(row, "bridge-id", bridge_id)
318 if bridge_id is not None:
319 new_bridges[row.name] = bridge_id
320 bridges = new_bridges
323 for row in six.itervalues(idl.tables["Interface"].rows):
324 iface_by_name[row.name] = row
328 for row in six.itervalues(idl.tables["Interface"].rows):
329 # Match up paired vif and tap devices.
330 if row.name.startswith("vif"):
332 tap = iface_by_name.get("tap%s" % row.name[3:])
333 elif row.name.startswith("tap"):
335 vif = iface_by_name.get("vif%s" % row.name[3:])
339 # Several tap external-ids need to be copied from the vif.
340 if row == tap and vif:
341 keys = ["attached-mac",
346 set_external_id(row, k, vif.external_ids.get(k))
348 # Map from xs-vif-uuid to iface-id.
350 # (A tap's xs-vif-uuid comes from its vif. That falls out
351 # naturally from the copy loop above.)
352 xvu = row.external_ids.get("xs-vif-uuid")
354 iface_id = (new_iface_ids.get(xvu)
355 or iface_ids.get(xvu)
356 or get_iface_id(row.name, xvu))
357 new_iface_ids[xvu] = iface_id
359 # No xs-vif-uuid therefore no iface-id.
361 set_external_id(row, "iface-id", iface_id)
363 # Map from xs-vm-uuid to vm-id.
364 xvmu = row.external_ids.get("xs-vm-uuid")
366 vm_id = (new_vm_ids.get(xvmu)
368 or get_vm_id(row.name, xvmu))
369 new_vm_ids[xvmu] = vm_id
372 set_external_id(row, "vm-id", vm_id)
374 # When there's a vif and a tap, the tap is active (used for
375 # traffic). When there's just a vif, the vif is active.
377 # A tap on its own shouldn't happen, and we don't know
378 # anything about other kinds of devices, so we don't use
379 # an iface-status for those devices at all.
381 set_external_id(tap, "iface-status", "active")
382 set_external_id(vif, "iface-status", "inactive")
384 set_external_id(vif, "iface-status", "active")
386 set_external_id(row, "iface-status", None)
387 iface_ids = new_iface_ids
390 txn.add_comment("ovs-xapi-sync: Updating records from XAPI")
393 unixctl_server.close()
397 if __name__ == '__main__':
401 # Let system.exit() calls complete normally
404 vlog.exception("traceback")
405 sys.exit(ovs.daemon.RESTART_EXIT_CODE)