2 * Copyright (c) 2017 Pantheon Technologies s.r.o. 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.device.initialization;
10 import com.google.common.base.Preconditions;
11 import com.google.common.util.concurrent.FutureCallback;
12 import com.google.common.util.concurrent.Futures;
13 import com.google.common.util.concurrent.ListenableFuture;
14 import com.google.common.util.concurrent.MoreExecutors;
15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
16 import org.eclipse.jdt.annotation.NonNull;
17 import org.eclipse.jdt.annotation.Nullable;
18 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
19 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
20 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
21 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
22 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
23 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
24 import org.opendaylight.openflowplugin.api.openflow.device.TxFacade;
25 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
26 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
27 import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProvider;
28 import org.opendaylight.openflowplugin.impl.services.multilayer.MultiLayerMultipartCollectorService;
29 import org.opendaylight.openflowplugin.impl.services.singlelayer.SingleLayerMultipartCollectorService;
30 import org.opendaylight.openflowplugin.impl.util.DeviceInitializationUtil;
31 import org.opendaylight.openflowplugin.impl.util.DeviceStateUtil;
32 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
33 import org.opendaylight.openflowplugin.openflow.md.util.InventoryDataServiceUtil;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.CapabilitiesV10;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
46 import org.opendaylight.yangtools.yang.common.RpcResult;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
50 public class OF10DeviceInitializer extends AbstractDeviceInitializer {
52 private static final Logger LOG = LoggerFactory.getLogger(OF10DeviceInitializer.class);
55 protected ListenableFuture<Void> initializeNodeInformation(@NonNull final DeviceContext deviceContext,
56 final boolean switchFeaturesMandatory,
57 final boolean skipTableFeatures,
58 @Nullable final MultipartWriterProvider multipartWriterProvider,
59 @Nullable final ConvertorExecutor convertorExecutor) {
60 final ConnectionContext connectionContext =
61 Preconditions.checkNotNull(deviceContext.getPrimaryConnectionContext());
62 final DeviceState deviceState = Preconditions.checkNotNull(deviceContext.getDeviceState());
63 final DeviceInfo deviceInfo = Preconditions.checkNotNull(deviceContext.getDeviceInfo());
64 final CapabilitiesV10 capabilitiesV10 = connectionContext.getFeatures().getCapabilitiesV10();
66 // Set capabilities for this device based on capabilities of connection context
67 LOG.debug("Setting capabilities for device {}", deviceInfo);
68 DeviceStateUtil.setDeviceStateBasedOnV10Capabilities(deviceState, capabilitiesV10);
69 final ListenableFuture<Boolean> future = requestMultipart(MultipartType.OFPMPDESC, deviceContext);
71 Futures.addCallback(future, new FutureCallback<Boolean>() {
73 public void onSuccess(final Boolean result) {
74 if (Boolean.TRUE.equals(result)) {
75 LOG.debug("Creating empty flow capable node: {}", deviceInfo);
76 makeEmptyFlowCapableNode(deviceContext, deviceInfo);
78 LOG.debug("Creating empty tables for {}", deviceInfo);
79 DeviceInitializationUtil.makeEmptyTables(
82 deviceContext.getPrimaryConnectionContext().getFeatures().getTables().toJava());
87 public void onFailure(final Throwable throwable) {
88 LOG.warn("Error occurred in preparation node {} for protocol 1.0", deviceInfo);
89 LOG.trace("Error for node {} : ", deviceInfo, throwable);
91 }, MoreExecutors.directExecutor());
93 return Futures.transform(future, input -> {
94 LOG.debug("Writing physical port information for {}", deviceInfo);
95 writePhyPortInformation(deviceContext);
97 }, MoreExecutors.directExecutor());
100 @SuppressWarnings("checkstyle:IllegalCatch")
101 private static void writePhyPortInformation(final DeviceContext deviceContext) {
102 final DeviceInfo deviceInfo = deviceContext.getDeviceInfo();
103 final ConnectionContext connectionContext = deviceContext.getPrimaryConnectionContext();
104 final MessageTranslator<PortGrouping, FlowCapableNodeConnector> translator = deviceContext
106 .lookupTranslator(new TranslatorKey(deviceInfo.getVersion(), PortGrouping.class.getName()));
108 connectionContext.getFeatures().getPhyPort().forEach(port -> {
109 final NodeConnectorId nodeConnectorId = InventoryDataServiceUtil.nodeConnectorIdfromDatapathPortNo(
110 deviceInfo.getDatapathId(),
112 OpenflowVersion.get(deviceInfo.getVersion()));
115 deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL,
117 .getNodeInstanceIdentifier()
118 .child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId)),
119 new NodeConnectorBuilder()
120 .setId(nodeConnectorId)
122 FlowCapableNodeConnector.class,
123 translator.translate(port, deviceInfo, null))
125 FlowCapableNodeConnectorStatisticsData.class,
126 new FlowCapableNodeConnectorStatisticsDataBuilder().build())
128 } catch (final Exception e) {
129 LOG.debug("Failed to write node {} to DS ", deviceInfo, e);
134 @SuppressWarnings("checkstyle:IllegalCatch")
135 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
136 justification = "https://github.com/spotbugs/spotbugs/issues/811")
137 private static void makeEmptyFlowCapableNode(final TxFacade txFacade, final DeviceInfo deviceInfo) {
139 txFacade.writeToTransaction(LogicalDatastoreType.OPERATIONAL,
141 .getNodeInstanceIdentifier()
142 .augmentation(FlowCapableNode.class),
143 new FlowCapableNodeBuilder().build());
144 } catch (final Exception e) {
145 LOG.debug("Failed to write empty node {} to DS ", deviceInfo, e);
149 private static ListenableFuture<Boolean> requestMultipart(final MultipartType multipartType,
150 final DeviceContext deviceContext) {
151 if (deviceContext.canUseSingleLayerSerialization()) {
152 final SingleLayerMultipartCollectorService service =
153 new SingleLayerMultipartCollectorService(deviceContext, deviceContext);
155 return Futures.transform(service.handleServiceCall(multipartType),
156 RpcResult::isSuccessful, MoreExecutors.directExecutor());
159 final MultiLayerMultipartCollectorService service =
160 new MultiLayerMultipartCollectorService(deviceContext, deviceContext);
162 return Futures.transform(service.handleServiceCall(multipartType),
163 RpcResult::isSuccessful, MoreExecutors.directExecutor());