Merge "Bug 6372 table-miss-enforcer - DTCL instead of DTL"
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / util / DeviceInitializationUtils.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
9 package org.opendaylight.openflowplugin.impl.util;
10
11 import com.google.common.base.Preconditions;
12 import com.google.common.util.concurrent.AsyncFunction;
13 import com.google.common.util.concurrent.FutureCallback;
14 import com.google.common.util.concurrent.Futures;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import com.google.common.util.concurrent.SettableFuture;
17 import java.math.BigInteger;
18 import java.net.InetSocketAddress;
19 import java.util.Arrays;
20 import java.util.Collection;
21 import java.util.Collections;
22 import java.util.Iterator;
23 import java.util.List;
24 import java.util.concurrent.ExecutionException;
25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
26 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
27 import org.opendaylight.openflowplugin.api.ConnectionException;
28 import org.opendaylight.openflowplugin.api.OFConstants;
29 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
30 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
31 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
32 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
33 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
34 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
35 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
36 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
37 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
38 import org.opendaylight.openflowplugin.impl.common.MultipartRequestInputFactory;
39 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
40 import org.opendaylight.openflowplugin.impl.rpc.AbstractRequestContext;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
43 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsData;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsDataBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupFeatures;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterFeatures;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Capabilities;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.CapabilitiesV10;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.MultipartReplyBody;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyDescCase;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupFeaturesCase;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterFeaturesCase;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortDescCase;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableFeaturesCase;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.desc._case.MultipartReplyDesc;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.features._case.MultipartReplyGroupFeatures;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.features._case.MultipartReplyMeterFeatures;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.desc._case.MultipartReplyPortDesc;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table.features._case.MultipartReplyTableFeatures;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeaturesKey;
80 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
81 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
82 import org.opendaylight.yangtools.yang.common.RpcError;
83 import org.opendaylight.yangtools.yang.common.RpcResult;
84 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
85 import org.slf4j.Logger;
86 import org.slf4j.LoggerFactory;
87
88 public class DeviceInitializationUtils {
89
90     private static final Logger LOG = LoggerFactory.getLogger(DeviceInitializationUtils.class);
91
92     /**
93      * InitializationNodeInformation is good to call only for MASTER otherwise we will have not empty transaction
94      * for every Cluster Node (SLAVE too) and we will get race-condition by closing Connection.
95      *
96      * @param deviceContext
97      * @param switchFeaturesMandatory
98      * @param convertorExecutor
99      * @return future - recommended to have blocking call for this future
100      */
101     public static ListenableFuture<Void> initializeNodeInformation(final DeviceContext deviceContext, final boolean switchFeaturesMandatory, final ConvertorExecutor convertorExecutor) {
102         Preconditions.checkArgument(deviceContext != null);
103         final DeviceState deviceState = Preconditions.checkNotNull(deviceContext.getDeviceState());
104         final DeviceInfo deviceInfo = deviceContext.getDeviceInfo();
105         final ConnectionContext connectionContext = Preconditions.checkNotNull(deviceContext.getPrimaryConnectionContext());
106         final short version = deviceInfo.getVersion();
107         LOG.trace("initalizeNodeInformation for node {}", deviceInfo.getNodeId());
108         final SettableFuture<Void> returnFuture = SettableFuture.<Void>create();
109         addNodeToOperDS(deviceContext, returnFuture);
110         final ListenableFuture<List<RpcResult<List<MultipartReply>>>> deviceFeaturesFuture;
111         if (OFConstants.OFP_VERSION_1_0 == version) {
112             final CapabilitiesV10 capabilitiesV10 = connectionContext.getFeatures().getCapabilitiesV10();
113
114             DeviceStateUtil.setDeviceStateBasedOnV10Capabilities(deviceState, capabilitiesV10);
115
116             deviceFeaturesFuture = createDeviceFeaturesForOF10(deviceContext);
117             // create empty tables after device description is processed
118             chainTableTrunkWriteOF10(deviceContext, deviceFeaturesFuture);
119
120             final short ofVersion = deviceInfo.getVersion();
121             final TranslatorKey translatorKey = new TranslatorKey(ofVersion, PortGrouping.class.getName());
122             final MessageTranslator<PortGrouping, FlowCapableNodeConnector> translator = deviceContext.oook()
123                     .lookupTranslator(translatorKey);
124             final BigInteger dataPathId = deviceContext.getDeviceInfo().getDatapathId();
125
126             for (final PortGrouping port : connectionContext.getFeatures().getPhyPort()) {
127                 final FlowCapableNodeConnector fcNodeConnector = translator.translate(port, deviceContext.getDeviceInfo(), null);
128
129                 final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(
130                         dataPathId.toString(), port.getPortNo(), ofVersion);
131                 final NodeConnectorBuilder ncBuilder = new NodeConnectorBuilder().setId(nodeConnectorId);
132                 ncBuilder.addAugmentation(FlowCapableNodeConnector.class, fcNodeConnector);
133                 ncBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class,
134                         new FlowCapableNodeConnectorStatisticsDataBuilder().build());
135                 final NodeConnector connector = ncBuilder.build();
136                 final InstanceIdentifier<NodeConnector> connectorII = deviceInfo.getNodeInstanceIdentifier().child(
137                         NodeConnector.class, connector.getKey());
138                 try {
139                     deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, connectorII, connector);
140                 } catch (final Exception e) {
141                     LOG.debug("initializeNodeInformation: Failed to write node {} to DS ", deviceInfo.getNodeId().toString(),
142                             e);
143                 }
144
145             }
146         } else if (OFConstants.OFP_VERSION_1_3 == version) {
147             final Capabilities capabilities = connectionContext.getFeatures().getCapabilities();
148             LOG.debug("Setting capabilities for device {}", deviceInfo.getNodeId());
149             DeviceStateUtil.setDeviceStateBasedOnV13Capabilities(deviceState, capabilities);
150             deviceFeaturesFuture = createDeviceFeaturesForOF13(deviceContext, switchFeaturesMandatory, convertorExecutor);
151         } else {
152             deviceFeaturesFuture = Futures.immediateFailedFuture(new ConnectionException("Unsupported version "
153                     + version));
154         }
155
156         Futures.addCallback(deviceFeaturesFuture, new FutureCallback<List<RpcResult<List<MultipartReply>>>>() {
157             @Override
158             public void onSuccess(final List<RpcResult<List<MultipartReply>>> result) {
159                 LOG.debug("All init data for node {} is in submitted.", deviceInfo.getNodeId());
160                 returnFuture.set(null);
161             }
162
163             @Override
164             public void onFailure(final Throwable t) {
165                 // FIXME : remove session
166                 LOG.trace("Device capabilities gathering future failed.");
167                 LOG.trace("more info in exploration failure..", t);
168                 LOG.debug("All init data for node {} was not submited correctly - connection has to go down.", deviceInfo.getNodeId());
169                 returnFuture.setException(t);
170             }
171         });
172         return returnFuture;
173     }
174
175     private static void addNodeToOperDS(final DeviceContext deviceContext, final SettableFuture<Void> future) {
176         Preconditions.checkArgument(deviceContext != null);
177         final NodeBuilder nodeBuilder = new NodeBuilder().setId(deviceContext.getDeviceInfo().getNodeId()).setNodeConnector(
178                 Collections.<NodeConnector>emptyList());
179         try {
180             deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, deviceContext.getDeviceInfo().getNodeInstanceIdentifier(),
181                     nodeBuilder.build());
182         } catch (final Exception e) {
183             LOG.warn("addNodeToOperDS: Failed to write node {} to DS ", deviceContext.getDeviceInfo().getNodeId(), e);
184             future.cancel(true);
185         }
186     }
187
188     private static ListenableFuture<List<RpcResult<List<MultipartReply>>>> createDeviceFeaturesForOF10(
189             final DeviceContext deviceContext) {
190         final ListenableFuture<RpcResult<List<MultipartReply>>> replyDesc = getNodeStaticInfo(MultipartType.OFPMPDESC,
191                 deviceContext, deviceContext.getDeviceInfo().getNodeInstanceIdentifier(), deviceContext.getDeviceInfo().getVersion());
192
193         return Futures.allAsList(Arrays.asList(replyDesc));
194     }
195
196     private static ListenableFuture<List<RpcResult<List<MultipartReply>>>> createDeviceFeaturesForOF13(
197             final DeviceContext deviceContext, final boolean switchFeaturesMandatory, final ConvertorExecutor convertorExecutor) {
198
199         final ListenableFuture<RpcResult<List<MultipartReply>>> replyDesc = getNodeStaticInfo(MultipartType.OFPMPDESC,
200                 deviceContext, deviceContext.getDeviceInfo().getNodeInstanceIdentifier(), deviceContext.getDeviceInfo().getVersion());
201
202         //first process description reply, write data to DS and write consequent data if successful
203         return Futures.transform(replyDesc,
204                 new AsyncFunction<RpcResult<List<MultipartReply>>, List<RpcResult<List<MultipartReply>>>>() {
205                     @Override
206                     public ListenableFuture<List<RpcResult<List<MultipartReply>>>> apply(
207                             final RpcResult<List<MultipartReply>> rpcResult) throws Exception {
208
209                         translateAndWriteReply(MultipartType.OFPMPDESC, deviceContext,
210                                 deviceContext.getDeviceInfo().getNodeInstanceIdentifier(), rpcResult.getResult(), convertorExecutor);
211
212                         final ListenableFuture<RpcResult<List<MultipartReply>>> replyMeterFeature = getNodeStaticInfo(
213                                 MultipartType.OFPMPMETERFEATURES, deviceContext,
214                                 deviceContext.getDeviceInfo().getNodeInstanceIdentifier(), deviceContext.getDeviceInfo().getVersion());
215
216                         createSuccessProcessingCallback(MultipartType.OFPMPMETERFEATURES, deviceContext,
217                                 deviceContext.getDeviceInfo().getNodeInstanceIdentifier(), replyMeterFeature, convertorExecutor);
218
219                         final ListenableFuture<RpcResult<List<MultipartReply>>> replyGroupFeatures = getNodeStaticInfo(
220                                 MultipartType.OFPMPGROUPFEATURES, deviceContext,
221                                 deviceContext.getDeviceInfo().getNodeInstanceIdentifier(), deviceContext.getDeviceInfo().getVersion());
222                         createSuccessProcessingCallback(MultipartType.OFPMPGROUPFEATURES, deviceContext,
223                                 deviceContext.getDeviceInfo().getNodeInstanceIdentifier(), replyGroupFeatures, convertorExecutor);
224
225                         final ListenableFuture<RpcResult<List<MultipartReply>>> replyTableFeatures = getNodeStaticInfo(
226                                 MultipartType.OFPMPTABLEFEATURES, deviceContext,
227                                 deviceContext.getDeviceInfo().getNodeInstanceIdentifier(), deviceContext.getDeviceInfo().getVersion());
228                         createSuccessProcessingCallback(MultipartType.OFPMPTABLEFEATURES, deviceContext,
229                                 deviceContext.getDeviceInfo().getNodeInstanceIdentifier(), replyTableFeatures, convertorExecutor);
230
231                         final ListenableFuture<RpcResult<List<MultipartReply>>> replyPortDescription = getNodeStaticInfo(
232                                 MultipartType.OFPMPPORTDESC, deviceContext, deviceContext.getDeviceInfo().getNodeInstanceIdentifier(),
233                                 deviceContext.getDeviceInfo().getVersion());
234                         createSuccessProcessingCallback(MultipartType.OFPMPPORTDESC, deviceContext,
235                                 deviceContext.getDeviceInfo().getNodeInstanceIdentifier(), replyPortDescription, convertorExecutor);
236                         if (switchFeaturesMandatory) {
237                             return Futures.allAsList(Arrays.asList(replyMeterFeature, replyGroupFeatures,
238                                     replyTableFeatures, replyPortDescription));
239                         } else {
240                             return Futures.successfulAsList(Arrays.asList(replyMeterFeature, replyGroupFeatures,
241                                     replyTableFeatures, replyPortDescription));
242                         }
243                     }
244                 });
245
246     }
247
248     static void translateAndWriteReply(final MultipartType type, final DeviceContext dContext,
249                                        final InstanceIdentifier<Node> nodeII, final Collection<MultipartReply> result,
250                                        final ConvertorExecutor convertorExecutor) {
251         try {
252             for (final MultipartReply reply : result) {
253                 final MultipartReplyBody body = reply.getMultipartReplyBody();
254                 switch (type) {
255                     case OFPMPDESC:
256                         Preconditions.checkArgument(body instanceof MultipartReplyDescCase);
257                         final MultipartReplyDesc replyDesc = ((MultipartReplyDescCase) body).getMultipartReplyDesc();
258                         final FlowCapableNode fcNode = NodeStaticReplyTranslatorUtil.nodeDescTranslator(replyDesc,
259                                 getIpAddressOf(dContext));
260                         final InstanceIdentifier<FlowCapableNode> fNodeII = nodeII.augmentation(FlowCapableNode.class);
261                         dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, fNodeII, fcNode);
262                         break;
263
264                     case OFPMPTABLEFEATURES:
265                         Preconditions.checkArgument(body instanceof MultipartReplyTableFeaturesCase);
266                         final MultipartReplyTableFeatures tableFeaturesMP = ((MultipartReplyTableFeaturesCase) body)
267                                 .getMultipartReplyTableFeatures();
268                         final List<TableFeatures> tableFeatures = NodeStaticReplyTranslatorUtil
269                                 .nodeTableFeatureTranslator(tableFeaturesMP, dContext.getDeviceInfo().getVersion(), convertorExecutor);
270                         for (final TableFeatures tableFeature : tableFeatures) {
271                             final Short tableId = tableFeature.getTableId();
272                             final KeyedInstanceIdentifier<TableFeatures, TableFeaturesKey> tableFeaturesII =
273                                     nodeII.augmentation(FlowCapableNode.class)
274                                             .child(TableFeatures.class, new TableFeaturesKey(tableId));
275                             dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, tableFeaturesII, tableFeature);
276
277                             // write parent for table statistics
278                             final KeyedInstanceIdentifier<Table, TableKey> tableII =
279                                     nodeII.augmentation(FlowCapableNode.class)
280                                             .child(Table.class, new TableKey(tableId));
281                             final TableBuilder tableBld = new TableBuilder().setId(tableId)
282                                     .addAugmentation(FlowTableStatisticsData.class,
283                                             new FlowTableStatisticsDataBuilder().build());
284
285                             dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, tableII, tableBld.build());
286                         }
287                         break;
288
289                     case OFPMPMETERFEATURES:
290                         Preconditions.checkArgument(body instanceof MultipartReplyMeterFeaturesCase);
291                         final MultipartReplyMeterFeatures meterFeatures = ((MultipartReplyMeterFeaturesCase) body)
292                                 .getMultipartReplyMeterFeatures();
293                         final NodeMeterFeatures mFeature = NodeStaticReplyTranslatorUtil
294                                 .nodeMeterFeatureTranslator(meterFeatures);
295                         final InstanceIdentifier<NodeMeterFeatures> mFeatureII = nodeII
296                                 .augmentation(NodeMeterFeatures.class);
297                         dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, mFeatureII, mFeature);
298                         if (0L < mFeature.getMeterFeatures().getMaxMeter().getValue()) {
299                             dContext.getDeviceState().setMeterAvailable(true);
300                         }
301                         break;
302
303                     case OFPMPGROUPFEATURES:
304                         Preconditions.checkArgument(body instanceof MultipartReplyGroupFeaturesCase);
305                         final MultipartReplyGroupFeatures groupFeatures = ((MultipartReplyGroupFeaturesCase) body)
306                                 .getMultipartReplyGroupFeatures();
307                         final NodeGroupFeatures gFeature = NodeStaticReplyTranslatorUtil
308                                 .nodeGroupFeatureTranslator(groupFeatures);
309                         final InstanceIdentifier<NodeGroupFeatures> gFeatureII = nodeII
310                                 .augmentation(NodeGroupFeatures.class);
311                         dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, gFeatureII, gFeature);
312                         break;
313
314                     case OFPMPPORTDESC:
315                         Preconditions.checkArgument(body instanceof MultipartReplyPortDescCase);
316                         final MultipartReplyPortDesc portDesc = ((MultipartReplyPortDescCase) body)
317                                 .getMultipartReplyPortDesc();
318                         for (final PortGrouping port : portDesc.getPorts()) {
319                             final short ofVersion = dContext.getDeviceInfo().getVersion();
320                             final TranslatorKey translatorKey = new TranslatorKey(ofVersion, PortGrouping.class.getName());
321                             final MessageTranslator<PortGrouping, FlowCapableNodeConnector> translator = dContext.oook()
322                                     .lookupTranslator(translatorKey);
323                             final FlowCapableNodeConnector fcNodeConnector = translator.translate(port, dContext.getDeviceInfo(), null);
324
325                             final BigInteger dataPathId = dContext.getPrimaryConnectionContext().getFeatures()
326                                     .getDatapathId();
327                             final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(
328                                     dataPathId.toString(), port.getPortNo(), ofVersion);
329                             final NodeConnectorBuilder ncBuilder = new NodeConnectorBuilder().setId(nodeConnectorId);
330                             ncBuilder.addAugmentation(FlowCapableNodeConnector.class, fcNodeConnector);
331
332                             ncBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class,
333                                     new FlowCapableNodeConnectorStatisticsDataBuilder().build());
334                             final NodeConnector connector = ncBuilder.build();
335
336                             final InstanceIdentifier<NodeConnector> connectorII = nodeII.child(NodeConnector.class,
337                                     connector.getKey());
338                             dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, connectorII, connector);
339                         }
340
341                         break;
342
343                     default:
344                         throw new IllegalArgumentException("Unnexpected MultipartType " + type);
345                 }
346             }
347         } catch (final Exception e) {
348             LOG.debug("translateAndWriteReply: Failed to write node {} to DS ", dContext.getDeviceInfo().getNodeId().toString(), e);
349         }
350     }
351
352     private static void createEmptyFlowCapableNodeInDs(final DeviceContext deviceContext) {
353         final FlowCapableNodeBuilder flowCapableNodeBuilder = new FlowCapableNodeBuilder();
354         final InstanceIdentifier<FlowCapableNode> fNodeII = deviceContext.getDeviceInfo().getNodeInstanceIdentifier()
355                 .augmentation(FlowCapableNode.class);
356         try {
357             deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, fNodeII, flowCapableNodeBuilder.build());
358         } catch (final Exception e) {
359             LOG.debug("createEmptyFlowCapableNodeInDs: Failed to write node {} to DS ", deviceContext.getDeviceInfo().getNodeId().toString(), e);
360         }
361     }
362
363     private static IpAddress getIpAddressOf(final DeviceContext deviceContext) {
364
365         final InetSocketAddress remoteAddress = deviceContext.getPrimaryConnectionContext().getConnectionAdapter()
366                 .getRemoteAddress();
367
368         if (remoteAddress == null) {
369             LOG.warn("IP address of the node {} cannot be obtained. No connection with switch.", deviceContext
370                     .getDeviceInfo().getNodeId());
371             return null;
372         }
373         LOG.info("IP address of switch is: {}", remoteAddress);
374
375         return IetfInetUtil.INSTANCE.ipAddressFor(remoteAddress.getAddress());
376     }
377
378     // FIXME : remove after ovs tableFeatures fix
379     private static void makeEmptyTables(final DeviceContext dContext, final InstanceIdentifier<Node> nodeII,
380                                         final Short nrOfTables) {
381         LOG.debug("About to create {} empty tables.", nrOfTables);
382         for (int i = 0; i < nrOfTables; i++) {
383             final short tId = (short) i;
384             final InstanceIdentifier<Table> tableII = nodeII.augmentation(FlowCapableNode.class).child(Table.class,
385                     new TableKey(tId));
386             final TableBuilder tableBuilder = new TableBuilder().setId(tId).addAugmentation(
387                     FlowTableStatisticsData.class, new FlowTableStatisticsDataBuilder().build());
388
389             try {
390                 dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, tableII, tableBuilder.build());
391             } catch (final Exception e) {
392                 LOG.debug("makeEmptyTables: Failed to write node {} to DS ", dContext.getDeviceInfo().getNodeId().toString(), e);
393             }
394
395         }
396     }
397
398     static void createSuccessProcessingCallback(final MultipartType type, final DeviceContext deviceContext,
399                                                 final InstanceIdentifier<Node> nodeII,
400                                                 final ListenableFuture<RpcResult<List<MultipartReply>>> requestContextFuture,
401                                                 final ConvertorExecutor convertorExecutor) {
402         Futures.addCallback(requestContextFuture, new FutureCallback<RpcResult<List<MultipartReply>>>() {
403             @Override
404             public void onSuccess(final RpcResult<List<MultipartReply>> rpcResult) {
405                 final List<MultipartReply> result = rpcResult.getResult();
406                 if (result != null) {
407                     LOG.info("Static node {} info: {} collected", deviceContext.getDeviceInfo().getNodeId(), type);
408                     translateAndWriteReply(type, deviceContext, nodeII, result, convertorExecutor);
409                 } else {
410                     final Iterator<RpcError> rpcErrorIterator = rpcResult.getErrors().iterator();
411                     while (rpcErrorIterator.hasNext()) {
412                         final RpcError rpcError = rpcErrorIterator.next();
413                         LOG.info("Failed to retrieve static node {} info: {}", type, rpcError.getMessage());
414                         if (null != rpcError.getCause()) {
415                             LOG.trace("Detailed error:", rpcError.getCause());
416                         }
417                     }
418                     if (MultipartType.OFPMPTABLEFEATURES.equals(type)) {
419                         makeEmptyTables(deviceContext, nodeII, deviceContext.getPrimaryConnectionContext()
420                                 .getFeatures().getTables());
421                     }
422                 }
423             }
424
425             @Override
426             public void onFailure(final Throwable throwable) {
427                 LOG.info("Request of type {} for static info of node {} failed.", type, nodeII);
428             }
429         });
430     }
431
432     private static ListenableFuture<RpcResult<List<MultipartReply>>> getNodeStaticInfo(final MultipartType type,
433                                                                                        final DeviceContext deviceContext, final InstanceIdentifier<Node> nodeII, final short version) {
434
435         final OutboundQueue queue = deviceContext.getPrimaryConnectionContext().getOutboundQueueProvider();
436
437         final Long reserved = deviceContext.reserveXidForDeviceMessage();
438         final RequestContext<List<MultipartReply>> requestContext = new AbstractRequestContext<List<MultipartReply>>(
439                 reserved) {
440             @Override
441             public void close() {
442                 //NOOP
443             }
444         };
445
446         final Xid xid = requestContext.getXid();
447
448         LOG.trace("Hooking xid {} to device context - precaution.", reserved);
449
450         final MultiMsgCollector multiMsgCollector = deviceContext.getMultiMsgCollector(requestContext);
451         queue.commitEntry(xid.getValue(),
452                 MultipartRequestInputFactory.makeMultipartRequestInput(xid.getValue(), version, type),
453                 new FutureCallback<OfHeader>() {
454                     @Override
455                     public void onSuccess(final OfHeader ofHeader) {
456                         if (ofHeader instanceof MultipartReply) {
457                             final MultipartReply multipartReply = (MultipartReply) ofHeader;
458                             multiMsgCollector.addMultipartMsg(multipartReply);
459                         } else if (null != ofHeader) {
460                             LOG.info("Unexpected response type received {}.", ofHeader.getClass());
461                         } else {
462                             multiMsgCollector.endCollecting();
463                             LOG.info("Response received is null.");
464                         }
465                     }
466
467                     @Override
468                     public void onFailure(final Throwable t) {
469                         LOG.info("Fail response from OutboundQueue for multipart type {}.", type);
470                         final RpcResult<List<MultipartReply>> rpcResult = RpcResultBuilder
471                                 .<List<MultipartReply>>failed().build();
472                         requestContext.setResult(rpcResult);
473                         if (MultipartType.OFPMPTABLEFEATURES.equals(type)) {
474                             makeEmptyTables(deviceContext, nodeII, deviceContext.getPrimaryConnectionContext()
475                                     .getFeatures().getTables());
476                         }
477                         requestContext.close();
478                     }
479                 });
480
481         return requestContext.getFuture();
482     }
483
484     static void chainTableTrunkWriteOF10(final DeviceContext deviceContext,
485                                          final ListenableFuture<List<RpcResult<List<MultipartReply>>>> deviceFeaturesFuture) {
486
487         try {
488             LOG.trace("Waiting for protocol version 1.0");
489             List<RpcResult<List<MultipartReply>>> results = deviceFeaturesFuture.get();
490             boolean allSucceeded = true;
491             for (final RpcResult<List<MultipartReply>> rpcResult : results) {
492                 allSucceeded &= rpcResult.isSuccessful();
493             }
494             if (allSucceeded) {
495                 LOG.debug("Creating emtpy flow capable node: {}", deviceContext.getDeviceInfo().getNodeId().getValue());
496                 createEmptyFlowCapableNodeInDs(deviceContext);
497                 LOG.debug("Creating emtpy tables for {}", deviceContext.getDeviceInfo().getNodeId().getValue());
498                 makeEmptyTables(deviceContext, deviceContext.getDeviceInfo().getNodeInstanceIdentifier(),
499                         deviceContext.getPrimaryConnectionContext().getFeatures().getTables());
500             }
501         } catch (InterruptedException | ExecutionException e) {
502             LOG.warn("Error occurred in preparation node {} for protocol 1.0", deviceContext.getDeviceInfo().getNodeId().getValue());
503         }
504     }
505 }