2 # Copyright (c) 2009, 2010, 2011, 2012 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.
33 from ovs.db import error
34 from ovs.db import types
38 import ovs.unixctl.server
40 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, 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 for n in session.xenapi.network.get_all():
86 rec = session.xenapi.network.get_record(n)
87 if rec['bridge'] == br_name:
93 # By default, the "bridge-id" external id in the Bridge table is the
94 # same as "xs-network-uuids". This may be overridden by defining a
95 # "nicira-bridge-id" key in the "other_config" field of the network
96 # record of XAPI. If nicira-bridge-id is undefined returns default.
97 # On error returns None.
98 def get_bridge_id(br_name, default=None):
99 rec = get_network_by_bridge(br_name)
101 return rec['other_config'].get('nicira-bridge-id', default)
105 # By default, the "iface-id" external id in the Interface table is the
106 # same as "xs-vif-uuid". This may be overridden by defining a
107 # "nicira-iface-id" key in the "other_config" field of the VIF
109 def get_iface_id(if_name, xs_vif_uuid):
110 if not if_name.startswith("vif") and not if_name.startswith("tap"):
111 # Treat whatever was passed into 'xs_vif_uuid' as a default
112 # value for non-VIFs.
115 if not init_session():
116 vlog.warn("Failed to get interface id %s because"
117 " XAPI session could not be initialized" % if_name)
121 vif = session.xenapi.VIF.get_by_uuid(xs_vif_uuid)
122 rec = session.xenapi.VIF.get_record(vif)
123 return rec['other_config'].get('nicira-iface-id', xs_vif_uuid)
124 except XenAPI.Failure:
125 vlog.warn("Could not find XAPI entry for VIF %s" % if_name)
129 # By default, the "vm-id" external id in the Interface table is the
130 # same as "xs-vm-uuid". This may be overridden by defining a
131 # "nicira-vm-id" key in the "other_config" field of the VM
133 def get_vm_id(if_name, xs_vm_uuid):
134 if not if_name.startswith("vif") and not if_name.startswith("tap"):
135 # Treat whatever was passed into 'xs_vm_uuid' as a default
136 # value for non-VIFs.
139 if not init_session():
140 vlog.warn("Failed to get vm id for interface id %s because"
141 " XAPI session could not be initialized" % if_name)
145 vm = session.xenapi.VM.get_by_uuid(xs_vm_uuid)
146 rec = session.xenapi.VM.get_record(vm)
147 return rec['other_config'].get('nicira-vm-id', xs_vm_uuid)
148 except XenAPI.Failure:
149 vlog.warn("Could not find XAPI entry for VIF %s" % if_name)
153 def set_or_delete(d, key, value):
159 if d.get(key) != value:
165 def set_external_id(row, key, value):
166 row.verify("external_ids")
167 external_ids = row.external_ids
168 if set_or_delete(external_ids, key, value):
169 row.external_ids = external_ids
172 # XenServer does not call interface-reconfigure on internal networks,
173 # which is where the fail-mode would normally be set.
174 def update_fail_mode(row):
175 rec = get_network_by_bridge(row.name)
179 fail_mode = rec['other_config'].get('vswitch-controller-fail-mode')
182 pools = session.xenapi.pool.get_all()
184 prec = session.xenapi.pool.get_record(pools[0])
185 fail_mode = prec['other_config'].get(
186 'vswitch-controller-fail-mode')
188 if fail_mode not in ['standalone', 'secure']:
189 fail_mode = 'standalone'
191 row.verify("fail_mode")
192 if row.fail_mode != fail_mode:
193 row.fail_mode = fail_mode
196 def update_in_band_mgmt(row):
197 rec = get_network_by_bridge(row.name)
201 dib = rec['other_config'].get('vswitch-disable-in-band')
203 row.verify("other_config")
204 other_config = row.other_config
205 if dib and dib not in ['true', 'false']:
206 vlog.warn('"%s" isn\'t a valid setting for '
207 "other_config:disable-in-band on %s" % (dib, row.name))
208 elif set_or_delete(other_config, 'disable-in-band', dib):
209 row.other_config = other_config
215 parser = argparse.ArgumentParser()
216 parser.add_argument("database", metavar="DATABASE",
217 help="A socket on which ovsdb-server is listening.")
218 parser.add_argument("--root-prefix", metavar="DIR", default='',
219 help="Use DIR as alternate root directory"
222 ovs.vlog.add_args(parser)
223 ovs.daemon.add_args(parser)
224 args = parser.parse_args()
225 ovs.vlog.handle_args(args)
226 ovs.daemon.handle_args(args)
228 remote = args.database
229 schema_helper = ovs.db.idl.SchemaHelper()
230 schema_helper.register_columns("Bridge", ["name", "external_ids",
231 "other_config", "fail_mode"])
232 schema_helper.register_columns("Interface", ["name", "external_ids"])
233 idl = ovs.db.idl.Idl(remote, schema_helper)
235 ovs.daemon.daemonize()
237 ovs.unixctl.command_register("exit", "", 0, 0, unixctl_exit, None)
238 ovs.unixctl.command_register("flush-cache", "", 0, 0, unixctl_flush_cache,
240 error, unixctl_server = ovs.unixctl.server.UnixctlServer.create(None)
242 ovs.util.ovs_fatal(error, "could not create unixctl server", vlog)
244 # This daemon is usually started before XAPI, but to complete our
245 # tasks, we need it. Wait here until it's up.
246 cookie_file = args.root_prefix + "/var/run/xapi_init_complete.cookie"
247 while not os.path.exists(cookie_file):
250 bridges = {} # Map from bridge name to nicira-bridge-id
251 iface_ids = {} # Map from xs-vif-uuid to iface-id
252 vm_ids = {} # Map from xs-vm-uuid to vm-id
253 seqno = idl.change_seqno # Sequence number when we last processed the db
260 if not flush_cache and seqno == idl.change_seqno:
261 poller = ovs.poller.Poller()
262 unixctl_server.wait(poller)
268 vlog.info("Flushing cache as the result of unixctl.")
273 seqno = idl.change_seqno
275 txn = ovs.db.idl.Transaction(idl)
278 for row in idl.tables["Bridge"].rows.itervalues():
279 if row.name in bridges:
280 nbd = bridges[row.name]
283 update_fail_mode(row)
284 update_in_band_mgmt(row)
285 nbd = get_bridge_id(row.name)
288 if bridge_id is None:
289 bridge_id = row.external_ids.get("xs-network-uuids")
291 if bridge_id is not None:
292 set_external_id(row, "bridge-id", bridge_id.split(";")[0])
294 new_bridges[row.name] = nbd
295 bridges = new_bridges
298 for row in idl.tables["Interface"].rows.itervalues():
299 iface_by_name[row.name] = row
303 for row in idl.tables["Interface"].rows.itervalues():
304 # Match up paired vif and tap devices.
305 if row.name.startswith("vif"):
307 tap = iface_by_name.get("tap%s" % row.name[3:])
308 elif row.name.startswith("tap"):
310 vif = iface_by_name.get("vif%s" % row.name[3:])
314 # Several tap external-ids need to be copied from the vif.
315 if row == tap and vif:
316 keys = ["attached-mac",
321 set_external_id(row, k, vif.external_ids.get(k))
323 # Map from xs-vif-uuid to iface-id.
325 # (A tap's xs-vif-uuid comes from its vif. That falls out
326 # naturally from the copy loop above.)
327 xvu = row.external_ids.get("xs-vif-uuid")
329 iface_id = (new_iface_ids.get(xvu)
330 or iface_ids.get(xvu)
331 or get_iface_id(row.name, xvu))
332 new_iface_ids[xvu] = iface_id
334 # No xs-vif-uuid therefore no iface-id.
336 set_external_id(row, "iface-id", iface_id)
338 # Map from xs-vm-uuid to vm-id.
339 xvmu = row.external_ids.get("xs-vm-uuid")
341 vm_id = (new_vm_ids.get(xvmu)
343 or get_vm_id(row.name, xvmu))
344 new_vm_ids[xvmu] = vm_id
347 set_external_id(row, "vm-id", vm_id)
349 # When there's a vif and a tap, the tap is active (used for
350 # traffic). When there's just a vif, the vif is active.
352 # A tap on its own shouldn't happen, and we don't know
353 # anything about other kinds of devices, so we don't use
354 # an iface-status for those devices at all.
356 set_external_id(tap, "iface-status", "active")
357 set_external_id(vif, "iface-status", "inactive")
359 set_external_id(vif, "iface-status", "active")
361 set_external_id(row, "iface-status", None)
362 iface_ids = new_iface_ids
365 txn.add_comment("ovs-xapi-sync: Updating records from XAPI")
368 unixctl_server.close()
372 if __name__ == '__main__':
376 # Let system.exit() calls complete normally
379 vlog.exception("traceback")
380 sys.exit(ovs.daemon.RESTART_EXIT_CODE)