interfacemgr/interfacemgr-impl/src/main/java/org/opendaylight/vpnservice/interfacemgr/InterfaceManager.java

   1 /*
   2  * Copyright (c) 2015 Ericsson India Global Services Pvt Ltd. 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.vpnservice.interfacemgr;
   9
  10 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
  11
  12 import java.math.BigInteger;
  13 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32;
  14 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64;
  15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state._interface.StatisticsBuilder;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state._interface.Statistics;
  18 import com.google.common.util.concurrent.Futures;
  19 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  21 import com.google.common.util.concurrent.FutureCallback;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.BaseIds;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  30 import org.opendaylight.vpnservice.AbstractDataChangeListener;
  31 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  32 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
  33 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  34 import org.opendaylight.yangtools.yang.binding.DataObject;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  37 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  38 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  39 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45 import com.google.common.base.Optional;
  46
  47 public class InterfaceManager extends AbstractDataChangeListener<Interface> implements AutoCloseable{
  48     private static final Logger LOG = LoggerFactory.getLogger(InterfaceManager.class);
  49     private ListenerRegistration<DataChangeListener> listenerRegistration;
  50     private final DataBroker broker;
  51
  52     private static final FutureCallback<Void> DEFAULT_CALLBACK =
  53                     new FutureCallback<Void>() {
  54                         public void onSuccess(Void result) {
  55                             LOG.debug("Success in Datastore write operation");
  56                         }
  57
  58                         public void onFailure(Throwable error) {
  59                             LOG.error("Error in Datastore write operation", error);
  60                         };
  61                     };
  62
  63     public InterfaceManager(final DataBroker db) {
  64         super(Interface.class);
  65         broker = db;
  66         registerListener(db);
  67     }
  68
  69     @Override
  70     public void close() throws Exception {
  71         if (listenerRegistration != null) {
  72             try {
  73                 listenerRegistration.close();
  74             } catch (final Exception e) {
  75                 LOG.error("Error when cleaning up DataChangeListener.", e);
  76             }
  77             listenerRegistration = null;
  78         }
  79         LOG.info("Interface Manager Closed");
  80     }
  81
  82     private void registerListener(final DataBroker db) {
  83         try {
  84             listenerRegistration = db.registerDataChangeListener(LogicalDatastoreType.CONFIGURATION,
  85                     getWildCardPath(), InterfaceManager.this, DataChangeScope.SUBTREE);
  86         } catch (final Exception e) {
  87             LOG.error("InterfaceManager DataChange listener registration fail!", e);
  88             throw new IllegalStateException("InterfaceManager registration Listener failed.", e);
  89         }
  90     }
  91
  92     @Override
  93     protected void add(final InstanceIdentifier<Interface> identifier,
  94             final Interface imgrInterface) {
  95         LOG.trace("key: " + identifier + ", value=" + imgrInterface );
  96         addInterface(identifier, imgrInterface);
  97     }
  98
  99     private InstanceIdentifier<Interface> buildId(final InstanceIdentifier<Interface> identifier) {
 100         //TODO Make this generic and move to AbstractDataChangeListener or Utils.
 101         final InterfaceKey key = identifier.firstKeyOf(Interface.class, InterfaceKey.class);
 102         String interfaceName = key.getName();
 103         InstanceIdentifierBuilder<Interface> idBuilder =
 104                 InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName));
 105         InstanceIdentifier<Interface> id = idBuilder.build();
 106         return id;
 107     }
 108
 109     private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> buildStateInterfaceId(String interfaceName) {
 110         //TODO Make this generic and move to AbstractDataChangeListener or Utils.
 111         InstanceIdentifierBuilder<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> idBuilder =
 112                 InstanceIdentifier.builder(InterfacesState.class)
 113                 .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.class,
 114                                 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(interfaceName));
 115         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> id = idBuilder.build();
 116         return id;
 117     }
 118
 119     private void addInterface(final InstanceIdentifier<Interface> identifier,
 120                               final Interface imgrInterface) {
 121         InstanceIdentifier<Interface> id = buildId(identifier);
 122         Optional<Interface> port = read(LogicalDatastoreType.CONFIGURATION, id);
 123         if(port.isPresent()) {
 124             Interface interf = port.get();
 125             NodeConnector nodeConn = getNodeConnectorFromInterface(interf);
 126             updateInterfaceState(interf, nodeConn);
 127             /* TODO:
 128              *  1. Get interface-id from id manager
 129              *  2. Update interface-state with following:
 130              *    admin-status = set to enable value
 131              *    oper-status = Down [?]
 132              *    if-index = interface-id
 133              * FIXME:
 134              *  1. Get operational data from node-connector-id?
 135              *
 136              */
 137         }
 138     }
 139
 140     private void updateInterfaceState(Interface interf, NodeConnector nodeConn) {
 141         /* Update InterfaceState
 142          * 1. Get interfaces-state Identifier
 143          * 2. Add interface to interfaces-state/interface
 144          * 3. Get interface-id from id manager
 145          * 4. Update interface-state with following:
 146          *    admin-status = set to enable value
 147          *    oper-status = Down [?]
 148          *    if-index = interface-id
 149         */
 150         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> id =
 151                         buildStateInterfaceId(interf.getName());
 152         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> stateIf =
 153                         read(LogicalDatastoreType.OPERATIONAL, id);
 154         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface stateIface;
 155         if(!stateIf.isPresent()) {
 156             org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceBuilder ifaceBuilder = new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceBuilder();
 157             // TODO: Get interface-id from IdManager
 158             ifaceBuilder.setAdminStatus((interf.isEnabled()) ?  org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.AdminStatus.Up :
 159                 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.AdminStatus.Down);
 160             ifaceBuilder.setOperStatus(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.OperStatus.Down);
 161             ifaceBuilder.setIfIndex(200).setName(interf.getName()).setType(interf.getType());
 162             ifaceBuilder.setKey(getStateInterfaceKeyFromName(interf.getName()));
 163             //ifaceBuilder.setStatistics(createStatistics(interf.getName(), nodeConn));
 164             stateIface = ifaceBuilder.build();
 165             LOG.trace("updating OPERATIONAL data store with stateIface {} and id {}", stateIface, id);
 166             asyncWrite(LogicalDatastoreType.OPERATIONAL, id, stateIface, DEFAULT_CALLBACK);
 167         }
 168     }
 169
 170     private Statistics createStatistics(String name, NodeConnector nodeConn) {
 171         Counter64 init64 = new Counter64(new BigInteger("0000000000000000"));
 172         Counter32 init32 = new Counter32((long) 0);
 173         StatisticsBuilder statBuilder = new StatisticsBuilder();
 174         statBuilder.setDiscontinuityTime(new DateAndTime("2015-04-04T00:00:00Z"))
 175         .setInBroadcastPkts(init64).setInDiscards(init32).setInErrors(init32).setInMulticastPkts(init64)
 176         .setInOctets(init64).setInUnicastPkts(init64).setInUnknownProtos(init32).setOutBroadcastPkts(init64)
 177         .setOutDiscards(init32).setOutErrors(init32).setOutMulticastPkts(init64).setOutOctets(init64)
 178         .setOutUnicastPkts(init64);
 179         return statBuilder.build();
 180     }
 181
 182     private org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey getStateInterfaceKeyFromName(
 183                     String name) {
 184         return new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(name);
 185     }
 186
 187     private NodeConnector getNodeConnectorFromInterface(Interface interf) {
 188         NodeConnectorId ncId = interf.getAugmentation(BaseIds.class).getOfPortId();
 189         NodeId nodeId = new NodeId(ncId.getValue().substring(0,ncId.getValue().lastIndexOf(":")));
 190         InstanceIdentifier<NodeConnector> ncIdentifier = InstanceIdentifier.builder(Nodes.class)
 191                         .child(Node.class, new NodeKey(nodeId))
 192                         .child(NodeConnector.class, new NodeConnectorKey(ncId)).build();
 193
 194         Optional<NodeConnector> nc = read(LogicalDatastoreType.OPERATIONAL, ncIdentifier);
 195         if(nc.isPresent()) {
 196             NodeConnector nodeConn = nc.get();
 197             LOG.trace("nodeConnector: {}",nodeConn);
 198             return nodeConn;
 199         }
 200         return null;
 201     }
 202
 203     private void delInterface(final InstanceIdentifier<Interface> identifier,
 204                               final Interface del) {
 205         InstanceIdentifier<Interface> id = buildId(identifier);
 206         Optional<Interface> port = read(LogicalDatastoreType.CONFIGURATION, id);
 207         if(port.isPresent()) {
 208             Interface interf = port.get();
 209             // TODO: Update operational data
 210         }
 211     }
 212
 213     private void updateInterface(final InstanceIdentifier<Interface> identifier,
 214                               final Interface original, final Interface udpate) {
 215         InstanceIdentifier<Interface> id = buildId(identifier);
 216         Optional<Interface> port = read(LogicalDatastoreType.CONFIGURATION, id);
 217         if(port.isPresent()) {
 218             Interface interf = port.get();
 219             //TODO: Update operational data
 220         }
 221     }
 222
 223     private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
 224             InstanceIdentifier<T> path) {
 225
 226         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 227
 228         Optional<T> result = Optional.absent();
 229         try {
 230             result = tx.read(datastoreType, path).get();
 231         } catch (Exception e) {
 232             throw new RuntimeException(e);
 233         }
 234
 235         return result;
 236     }
 237
 238     private InstanceIdentifier<Interface> getWildCardPath() {
 239         return InstanceIdentifier.create(Interfaces.class).child(Interface.class);
 240     }
 241
 242     @Override
 243     protected void remove(InstanceIdentifier<Interface> identifier, Interface del) {
 244         LOG.trace("key: " + identifier + ", value=" + del );
 245         delInterface(identifier, del);
 246     }
 247
 248     @Override
 249     protected void update(InstanceIdentifier<Interface> identifier, Interface original, Interface update) {
 250         LOG.trace("key: " + identifier + ", original=" + original + ", update=" + update );
 251         updateInterface(identifier, original, update);
 252     }
 253
 254     private <T extends DataObject> void asyncWrite(LogicalDatastoreType datastoreType,
 255                     InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 256     WriteTransaction tx = broker.newWriteOnlyTransaction();
 257     tx.put(datastoreType, path, data, true);
 258     Futures.addCallback(tx.submit(), callback);
 259     }
 260 }