openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/util/DeviceInitializationUtil.java

   1 /*
   2  * Copyright (c) 2016 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.openflowplugin.impl.util;
   9
  10 import java.net.InetSocketAddress;
  11 import java.util.Collections;
  12 import java.util.Optional;
  13 import java.util.concurrent.ExecutionException;
  14 import org.opendaylight.mdsal.binding.api.DataBroker;
  15 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  16 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  17 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  18 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  19 import org.opendaylight.openflowplugin.api.openflow.device.TxFacade;
  20 import org.opendaylight.openflowplugin.impl.device.SwitchFeaturesUtil;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.SwitchFeatures;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsData;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsDataBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodesBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutputBuilder;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 public final class DeviceInitializationUtil {
  40     private static final Logger LOG = LoggerFactory.getLogger(DeviceInitializationUtil.class);
  41
  42     private DeviceInitializationUtil() {
  43         // Hiding implicit constructor
  44     }
  45
  46     /**
  47      * Merge empty nodes to operational DS to predict any problems with missing parent for node.
  48      *
  49      * @param dataBroker the data broker
  50      */
  51     public static void makeEmptyNodes(final DataBroker dataBroker) {
  52         final WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
  53
  54         try {
  55             tx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(Nodes.class), new NodesBuilder()
  56                     .setNode(Collections.emptyList())
  57                     .build());
  58             tx.commit().get();
  59         } catch (ExecutionException | InterruptedException e) {
  60             LOG.error("Creation of node failed.", e);
  61             throw new IllegalStateException(e);
  62         }
  63     }
  64
  65     /**
  66      * Create specified number of empty tables on device.
  67      * FIXME: remove after ovs table features fix
  68      *
  69      * @param txFacade   transaction facade
  70      * @param deviceInfo device info
  71      * @param nrOfTables number of tables
  72      */
  73     public static void makeEmptyTables(final TxFacade txFacade, final DeviceInfo deviceInfo, final short nrOfTables) {
  74         if (LOG.isDebugEnabled()) {
  75             LOG.debug("About to create {} empty tables for node {}.", nrOfTables, deviceInfo);
  76         }
  77
  78         for (int i = 0; i < nrOfTables; i++) {
  79             txFacade.writeToTransaction(LogicalDatastoreType.OPERATIONAL,
  80                     deviceInfo
  81                             .getNodeInstanceIdentifier()
  82                             .augmentation(FlowCapableNode.class)
  83                             .child(Table.class, new TableKey((short) i)),
  84                     new TableBuilder()
  85                             .setId((short) i)
  86                             .addAugmentation(
  87                                     FlowTableStatisticsData.class,
  88                                     new FlowTableStatisticsDataBuilder().build())
  89                             .build());
  90         }
  91     }
  92
  93     /**
  94      * Retrieve ip address from connection.
  95      *
  96      * @param connectionContext  connection context
  97      * @param instanceIdentifier instance identifier
  98      * @return ip address
  99      */
 100     public static IpAddress getIpAddress(final ConnectionContext connectionContext,
 101                                          final InstanceIdentifier<Node> instanceIdentifier) {
 102         final String node = PathUtil.extractNodeId(instanceIdentifier).getValue();
 103
 104         return getRemoteAddress(connectionContext, instanceIdentifier)
 105                 .map(inetSocketAddress -> {
 106                     final IpAddress ipAddress = IetfInetUtil.INSTANCE.ipAddressFor(inetSocketAddress.getAddress());
 107                     LOG.info("IP address of the node {} is: {}", node, ipAddress);
 108                     return ipAddress;
 109                 })
 110                 .orElse(null);
 111     }
 112
 113     /**
 114      * Retrieve port number from connection.
 115      *
 116      * @param connectionContext  connection context
 117      * @param instanceIdentifier instance identifier
 118      * @return port number
 119      */
 120     public static PortNumber getPortNumber(final ConnectionContext connectionContext,
 121                                            final InstanceIdentifier<Node> instanceIdentifier) {
 122         final String node = PathUtil.extractNodeId(instanceIdentifier).getValue();
 123
 124         return getRemoteAddress(connectionContext, instanceIdentifier)
 125                 .map(inetSocketAddress -> {
 126                     final int port = inetSocketAddress.getPort();
 127                     LOG.info("Port number of the node {} is: {}", node, port);
 128                     return new PortNumber(port);
 129                 })
 130                 .orElse(null);
 131
 132     }
 133
 134     /**
 135      * Retrieve switch features from connection.
 136      *
 137      * @param connectionContext connection context
 138      * @return switch features
 139      */
 140     public static SwitchFeatures getSwitchFeatures(final ConnectionContext connectionContext) {
 141         return SwitchFeaturesUtil
 142                 .getInstance()
 143                 .buildSwitchFeatures(new GetFeaturesOutputBuilder(connectionContext
 144                         .getFeatures())
 145                         .build());
 146     }
 147
 148     private static Optional<InetSocketAddress> getRemoteAddress(final ConnectionContext connectionContext,
 149                                                                 final InstanceIdentifier<Node> instanceIdentifier) {
 150         final Optional<InetSocketAddress> inetSocketAddress = Optional
 151                 .ofNullable(connectionContext.getConnectionAdapter())
 152                 .flatMap(connectionAdapter -> Optional.ofNullable(connectionAdapter.getRemoteAddress()));
 153
 154         if (!inetSocketAddress.isPresent()) {
 155             LOG.warn("Remote address of the node {} cannot be obtained. No connection with switch.", PathUtil
 156                     .extractNodeId(instanceIdentifier));
 157         }
 158
 159         return inetSocketAddress;
 160     }
 161
 162 }