2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.ovsdb.southbound;
10 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
11 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
12 import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
13 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
14 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
15 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange;
16 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
17 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListenerRegistration;
18 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
19 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
21 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
22 import org.opendaylight.controller.sal.core.api.model.SchemaService;
23 import org.opendaylight.ovsdb.lib.OvsdbConnection;
24 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvoker;
25 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvokerImpl;
26 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopologyBuilder;
28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
30 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
31 import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeSerializer;
32 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
33 import org.slf4j.Logger;
34 import org.slf4j.LoggerFactory;
36 import com.google.common.base.Optional;
37 import com.google.common.util.concurrent.CheckedFuture;
39 public class SouthboundProvider implements AutoCloseable {
41 private static final Logger LOG = LoggerFactory.getLogger(SouthboundProvider.class);
42 private static final String ENTITY_TYPE = "ovsdb-southbound-provider";
44 public static DataBroker getDb() {
48 private static DataBroker db;
49 private OvsdbConnectionManager cm;
50 private TransactionInvoker txInvoker;
51 private OvsdbDataTreeChangeListener ovsdbDataTreeChangeListener;
52 private EntityOwnershipService entityOwnershipService;
53 private EntityOwnershipCandidateRegistration registration;
54 private SouthboundPluginInstanceEntityOwnershipListener providerOwnershipChangeListener;
55 private OvsdbConnection ovsdbConnection;
57 public SouthboundProvider(final DataBroker dataBroker,
58 final EntityOwnershipService entityOwnershipServiceDependency,
59 final OvsdbConnection ovsdbConnection,
60 final SchemaService schemaService,
61 final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer) {
63 this.entityOwnershipService = entityOwnershipServiceDependency;
65 this.ovsdbConnection = ovsdbConnection;
67 SouthboundUtil.setInstanceIdentifierCodec(new InstanceIdentifierCodec(schemaService,
68 bindingNormalizedNodeSerializer));
69 LOG.info("SouthboundProvider ovsdbConnectionService: {}", ovsdbConnection);
73 * Used by blueprint when starting the container.
76 LOG.info("SouthboundProvider Session Initiated");
77 this.txInvoker = new TransactionInvokerImpl(db);
78 cm = new OvsdbConnectionManager(db,txInvoker,entityOwnershipService, ovsdbConnection);
79 ovsdbDataTreeChangeListener = new OvsdbDataTreeChangeListener(db, cm);
81 //Register listener for entityOnwership changes
82 providerOwnershipChangeListener =
83 new SouthboundPluginInstanceEntityOwnershipListener(this,this.entityOwnershipService);
84 entityOwnershipService.registerListener(ENTITY_TYPE,providerOwnershipChangeListener);
86 //register instance entity to get the ownership of the provider
87 Entity instanceEntity = new Entity(ENTITY_TYPE, ENTITY_TYPE);
89 Optional<EntityOwnershipState> ownershipStateOpt = entityOwnershipService.getOwnershipState(instanceEntity);
90 registration = entityOwnershipService.registerCandidate(instanceEntity);
91 if (ownershipStateOpt.isPresent()) {
92 EntityOwnershipState ownershipState = ownershipStateOpt.get();
93 if (ownershipState.hasOwner() && !ownershipState.isOwner()) {
94 ovsdbConnection.registerConnectionListener(cm);
95 ovsdbConnection.startOvsdbManager(SouthboundConstants.DEFAULT_OVSDB_PORT);
96 LOG.info("*This* instance of OVSDB southbound provider is set as a SLAVE instance");
99 } catch (CandidateAlreadyRegisteredException e) {
100 LOG.warn("OVSDB Southbound Provider instance entity {} was already "
101 + "registered for ownership", instanceEntity, e);
106 public void close() {
107 LOG.info("SouthboundProvider Closed");
109 ovsdbDataTreeChangeListener.close();
110 registration.close();
111 providerOwnershipChangeListener.close();
114 private void initializeOvsdbTopology(LogicalDatastoreType type) {
115 InstanceIdentifier<Topology> path = InstanceIdentifier
116 .create(NetworkTopology.class)
117 .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID));
118 initializeTopology(type);
119 ReadWriteTransaction transaction = db.newReadWriteTransaction();
120 CheckedFuture<Optional<Topology>, ReadFailedException> ovsdbTp = transaction.read(type, path);
122 if (!ovsdbTp.get().isPresent()) {
123 TopologyBuilder tpb = new TopologyBuilder();
124 tpb.setTopologyId(SouthboundConstants.OVSDB_TOPOLOGY_ID);
125 transaction.put(type, path, tpb.build());
126 transaction.submit();
128 transaction.cancel();
130 } catch (Exception e) {
131 LOG.error("Error initializing ovsdb topology", e);
135 private void initializeTopology(LogicalDatastoreType type) {
136 ReadWriteTransaction transaction = db.newReadWriteTransaction();
137 InstanceIdentifier<NetworkTopology> path = InstanceIdentifier.create(NetworkTopology.class);
138 CheckedFuture<Optional<NetworkTopology>, ReadFailedException> topology = transaction.read(type,path);
140 if (!topology.get().isPresent()) {
141 NetworkTopologyBuilder ntb = new NetworkTopologyBuilder();
142 transaction.put(type,path,ntb.build());
143 transaction.submit();
145 transaction.cancel();
147 } catch (Exception e) {
148 LOG.error("Error initializing ovsdb topology", e);
152 public void handleOwnershipChange(EntityOwnershipChange ownershipChange) {
153 if (ownershipChange.isOwner()) {
154 LOG.info("*This* instance of OVSDB southbound provider is set as a MASTER instance");
155 LOG.info("Initialize OVSDB topology {} in operational and config data store if not already present"
156 ,SouthboundConstants.OVSDB_TOPOLOGY_ID);
157 initializeOvsdbTopology(LogicalDatastoreType.OPERATIONAL);
158 initializeOvsdbTopology(LogicalDatastoreType.CONFIGURATION);
160 LOG.info("*This* instance of OVSDB southbound provider is set as a SLAVE instance");
162 ovsdbConnection.registerConnectionListener(cm);
163 ovsdbConnection.startOvsdbManager(SouthboundConstants.DEFAULT_OVSDB_PORT);
166 private class SouthboundPluginInstanceEntityOwnershipListener implements EntityOwnershipListener {
167 private SouthboundProvider sp;
168 private EntityOwnershipListenerRegistration listenerRegistration;
170 SouthboundPluginInstanceEntityOwnershipListener(SouthboundProvider sp,
171 EntityOwnershipService entityOwnershipService) {
173 listenerRegistration = entityOwnershipService.registerListener(ENTITY_TYPE, this);
176 public void close() {
177 this.listenerRegistration.close();
180 public void ownershipChanged(EntityOwnershipChange ownershipChange) {
181 sp.handleOwnershipChange(ownershipChange);