southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/SouthboundProvider.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.ovsdb.southbound;
   9
  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.binding.api.BindingAwareBroker.ProviderContext;
  23 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
  24 import org.opendaylight.ovsdb.lib.OvsdbConnection;
  25 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvoker;
  26 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvokerImpl;
  27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopologyBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  30 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  32 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35
  36 import com.google.common.base.Optional;
  37 import com.google.common.util.concurrent.CheckedFuture;
  38
  39 public class SouthboundProvider implements BindingAwareProvider, AutoCloseable {
  40
  41     private static final Logger LOG = LoggerFactory.getLogger(SouthboundProvider.class);
  42     private static final String ENTITY_TYPE = "ovsdb-southbound-provider";
  43
  44     public static DataBroker getDb() {
  45         return db;
  46     }
  47
  48     private static DataBroker db;
  49     private OvsdbConnectionManager cm;
  50     private TransactionInvoker txInvoker;
  51     private OvsdbDataChangeListener ovsdbDataChangeListener;
  52     private EntityOwnershipService entityOwnershipService;
  53     private EntityOwnershipCandidateRegistration registration;
  54     private SouthboundPluginInstanceEntityOwnershipListener providerOwnershipChangeListener;
  55     private OvsdbConnection ovsdbConnection;
  56
  57
  58     public SouthboundProvider(
  59             EntityOwnershipService entityOwnershipServiceDependency,
  60             OvsdbConnection ovsdbConnection) {
  61         this.entityOwnershipService = entityOwnershipServiceDependency;
  62         registration = null;
  63         this.ovsdbConnection = ovsdbConnection;
  64         LOG.info("SouthboundProvider ovsdbConnectionService: {}", ovsdbConnection);
  65     }
  66
  67     @Override
  68     public void onSessionInitiated(ProviderContext session) {
  69         LOG.info("SouthboundProvider Session Initiated");
  70         db = session.getSALService(DataBroker.class);
  71         this.txInvoker = new TransactionInvokerImpl(db);
  72         cm = new OvsdbConnectionManager(db,txInvoker,entityOwnershipService, ovsdbConnection);
  73         ovsdbDataChangeListener = new OvsdbDataChangeListener(db,cm);
  74
  75         //Register listener for entityOnwership changes
  76         providerOwnershipChangeListener =
  77                 new SouthboundPluginInstanceEntityOwnershipListener(this,this.entityOwnershipService);
  78         entityOwnershipService.registerListener(ENTITY_TYPE,providerOwnershipChangeListener);
  79
  80         //register instance entity to get the ownership of the provider
  81         Entity instanceEntity = new Entity(ENTITY_TYPE, ENTITY_TYPE);
  82         try {
  83             Optional<EntityOwnershipState> ownershipStateOpt = entityOwnershipService.getOwnershipState(instanceEntity);
  84             registration = entityOwnershipService.registerCandidate(instanceEntity);
  85             if (ownershipStateOpt.isPresent()) {
  86                 EntityOwnershipState ownershipState = ownershipStateOpt.get();
  87                 if (ownershipState.hasOwner() && !ownershipState.isOwner()) {
  88                     ovsdbConnection.registerConnectionListener(cm);
  89                     ovsdbConnection.startOvsdbManager(SouthboundConstants.DEFAULT_OVSDB_PORT);
  90                 }
  91             }
  92         } catch (CandidateAlreadyRegisteredException e) {
  93             LOG.warn("OVSDB Southbound Provider instance entity {} was already "
  94                     + "registered for {} ownership", instanceEntity, e);
  95         }
  96     }
  97
  98     @Override
  99     public void close() throws Exception {
 100         LOG.info("SouthboundProvider Closed");
 101         cm.close();
 102         ovsdbDataChangeListener.close();
 103         registration.close();
 104         providerOwnershipChangeListener.close();
 105     }
 106
 107     private void initializeOvsdbTopology(LogicalDatastoreType type) {
 108         InstanceIdentifier<Topology> path = InstanceIdentifier
 109                 .create(NetworkTopology.class)
 110                 .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID));
 111         initializeTopology(type);
 112         ReadWriteTransaction transaction = db.newReadWriteTransaction();
 113         CheckedFuture<Optional<Topology>, ReadFailedException> ovsdbTp = transaction.read(type, path);
 114         try {
 115             if (!ovsdbTp.get().isPresent()) {
 116                 TopologyBuilder tpb = new TopologyBuilder();
 117                 tpb.setTopologyId(SouthboundConstants.OVSDB_TOPOLOGY_ID);
 118                 transaction.put(type, path, tpb.build());
 119                 transaction.submit();
 120             } else {
 121                 transaction.cancel();
 122             }
 123         } catch (Exception e) {
 124             LOG.error("Error initializing ovsdb topology", e);
 125         }
 126     }
 127
 128     private void initializeTopology(LogicalDatastoreType type) {
 129         ReadWriteTransaction transaction = db.newReadWriteTransaction();
 130         InstanceIdentifier<NetworkTopology> path = InstanceIdentifier.create(NetworkTopology.class);
 131         CheckedFuture<Optional<NetworkTopology>, ReadFailedException> topology = transaction.read(type,path);
 132         try {
 133             if (!topology.get().isPresent()) {
 134                 NetworkTopologyBuilder ntb = new NetworkTopologyBuilder();
 135                 transaction.put(type,path,ntb.build());
 136                 transaction.submit();
 137             } else {
 138                 transaction.cancel();
 139             }
 140         } catch (Exception e) {
 141             LOG.error("Error initializing ovsdb topology {}",e);
 142         }
 143     }
 144
 145     public void handleOwnershipChange(EntityOwnershipChange ownershipChange) {
 146         if (ownershipChange.isOwner()) {
 147             LOG.info("*This* instance of OVSDB southbound provider is set as a MASTER instance");
 148             LOG.info("Initialize OVSDB topology {} in operational and config data store if not already present"
 149                     ,SouthboundConstants.OVSDB_TOPOLOGY_ID);
 150             initializeOvsdbTopology(LogicalDatastoreType.OPERATIONAL);
 151             initializeOvsdbTopology(LogicalDatastoreType.CONFIGURATION);
 152         } else {
 153             LOG.info("*This* instance of OVSDB southbound provider is set as a SLAVE instance");
 154         }
 155         ovsdbConnection.registerConnectionListener(cm);
 156         ovsdbConnection.startOvsdbManager(SouthboundConstants.DEFAULT_OVSDB_PORT);
 157     }
 158
 159     private class SouthboundPluginInstanceEntityOwnershipListener implements EntityOwnershipListener {
 160         private SouthboundProvider sp;
 161         private EntityOwnershipListenerRegistration listenerRegistration;
 162
 163         SouthboundPluginInstanceEntityOwnershipListener(SouthboundProvider sp,
 164                 EntityOwnershipService entityOwnershipService) {
 165             this.sp = sp;
 166             listenerRegistration = entityOwnershipService.registerListener(ENTITY_TYPE, this);
 167         }
 168
 169         public void close() {
 170             this.listenerRegistration.close();
 171         }
 172         @Override
 173         public void ownershipChanged(EntityOwnershipChange ownershipChange) {
 174             sp.handleOwnershipChange(ownershipChange);
 175         }
 176     }
 177
 178 }