2 * Copyright (c) 2016 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.openflowplugin.impl.util;
10 import java.net.InetSocketAddress;
11 import java.util.Optional;
12 import java.util.concurrent.ExecutionException;
13 import org.opendaylight.mdsal.binding.api.DataBroker;
14 import org.opendaylight.mdsal.binding.api.WriteTransaction;
15 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
16 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
17 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
18 import org.opendaylight.openflowplugin.api.openflow.device.TxFacade;
19 import org.opendaylight.openflowplugin.impl.device.SwitchFeaturesUtil;
20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.SwitchFeatures;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableBuilder;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsData;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsDataBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodesBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutputBuilder;
34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
38 public final class DeviceInitializationUtil {
39 private static final Logger LOG = LoggerFactory.getLogger(DeviceInitializationUtil.class);
41 private DeviceInitializationUtil() {
42 // Hiding implicit constructor
46 * Merge empty nodes to operational DS to predict any problems with missing parent for node.
48 * @param dataBroker the data broker
50 public static void makeEmptyNodes(final DataBroker dataBroker) {
51 final WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
54 tx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(Nodes.class), new NodesBuilder()
57 } catch (ExecutionException | InterruptedException e) {
58 LOG.error("Creation of node failed.", e);
59 throw new IllegalStateException(e);
64 * Create specified number of empty tables on device.
65 * FIXME: remove after ovs table features fix
67 * @param txFacade transaction facade
68 * @param deviceInfo device info
69 * @param nrOfTables number of tables
71 public static void makeEmptyTables(final TxFacade txFacade, final DeviceInfo deviceInfo, final short nrOfTables) {
72 if (LOG.isDebugEnabled()) {
73 LOG.debug("About to create {} empty tables for node {}.", nrOfTables, deviceInfo);
76 for (int i = 0; i < nrOfTables; i++) {
77 txFacade.writeToTransaction(LogicalDatastoreType.OPERATIONAL,
79 .getNodeInstanceIdentifier()
80 .augmentation(FlowCapableNode.class)
81 .child(Table.class, new TableKey((short) i)),
85 FlowTableStatisticsData.class,
86 new FlowTableStatisticsDataBuilder().build())
92 * Retrieve ip address from connection.
94 * @param connectionContext connection context
95 * @param instanceIdentifier instance identifier
98 public static IpAddress getIpAddress(final ConnectionContext connectionContext,
99 final InstanceIdentifier<Node> instanceIdentifier) {
100 final String node = PathUtil.extractNodeId(instanceIdentifier).getValue();
102 return getRemoteAddress(connectionContext, instanceIdentifier)
103 .map(inetSocketAddress -> {
104 final IpAddress ipAddress = IetfInetUtil.INSTANCE.ipAddressFor(inetSocketAddress.getAddress());
105 LOG.info("IP address of the node {} is: {}", node, ipAddress);
112 * Retrieve port number from connection.
114 * @param connectionContext connection context
115 * @param instanceIdentifier instance identifier
116 * @return port number
118 public static PortNumber getPortNumber(final ConnectionContext connectionContext,
119 final InstanceIdentifier<Node> instanceIdentifier) {
120 final String node = PathUtil.extractNodeId(instanceIdentifier).getValue();
122 return getRemoteAddress(connectionContext, instanceIdentifier)
123 .map(inetSocketAddress -> {
124 final int port = inetSocketAddress.getPort();
125 LOG.info("Port number of the node {} is: {}", node, port);
126 return new PortNumber(port);
133 * Retrieve switch features from connection.
135 * @param connectionContext connection context
136 * @return switch features
138 public static SwitchFeatures getSwitchFeatures(final ConnectionContext connectionContext) {
139 return SwitchFeaturesUtil
141 .buildSwitchFeatures(new GetFeaturesOutputBuilder(connectionContext
146 private static Optional<InetSocketAddress> getRemoteAddress(final ConnectionContext connectionContext,
147 final InstanceIdentifier<Node> instanceIdentifier) {
148 final Optional<InetSocketAddress> inetSocketAddress = Optional
149 .ofNullable(connectionContext.getConnectionAdapter())
150 .flatMap(connectionAdapter -> Optional.ofNullable(connectionAdapter.getRemoteAddress()));
152 if (!inetSocketAddress.isPresent()) {
153 LOG.warn("Remote address of the node {} cannot be obtained. No connection with switch.", PathUtil
154 .extractNodeId(instanceIdentifier));
157 return inetSocketAddress;