232b75518d6c74ad0f862d3f7c879cef03e6282d
[transportpce.git] / renderer / src / main / java / org / opendaylight / transportpce / renderer / openroadminterface / OpenRoadmInterface221.java
1 /*
2  * Copyright © 2017 AT&T 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.transportpce.renderer.openroadminterface;
10
11 import java.math.BigDecimal;
12 import java.util.ArrayList;
13 import java.util.List;
14 import java.util.Optional;
15
16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
17 import org.opendaylight.transportpce.common.Timeouts;
18 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
19 import org.opendaylight.transportpce.common.fixedflex.FixedFlexInterface;
20 import org.opendaylight.transportpce.common.mapping.PortMapping;
21 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
22 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
23 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev170228.network.nodes.Mapping;
24 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.FrequencyGHz;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.FrequencyTHz;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.PowerDBm;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.R100G;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceBuilder;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceKey;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.OrgOpenroadmDevice;
31 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.RoadmConnections;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.RoadmConnectionsKey;
33 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev171215.AdminStates;
34 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev181019.EthAttributes;
35 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev181019.Interface1;
36 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev181019.Interface1Builder;
37 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev181019.ethernet.container.EthernetBuilder;
38 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.EthernetCsmacd;
39 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.InterfaceType;
40 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.MediaChannelTrailTerminationPoint;
41 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.NetworkMediaChannelConnectionTerminationPoint;
42 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OpenROADMOpticalMultiplex;
43 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OpticalChannel;
44 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OpticalTransport;
45 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OtnOdu;
46 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OtnOtu;
47 import org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.mc.ttp.container.McTtpBuilder;
48 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.nmc.ctp.container.NmcCtpBuilder;
49 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.och.container.OchBuilder;
50 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.OtsAttributes;
51 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.ots.container.OtsBuilder;
52 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev171215.ODU4;
53 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev171215.OTU4;
54 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev171215.PayloadTypeDef;
55 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.OduAttributes;
56 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.odu.container.OduBuilder;
57 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.opu.OpuBuilder;
58 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.OtuAttributes;
59 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.otu.container.OtuBuilder;
60 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
61 import org.slf4j.Logger;
62 import org.slf4j.LoggerFactory;
63
64 public class OpenRoadmInterface221 {
65     private final PortMapping portMapping;
66     private final OpenRoadmInterfaces openRoadmInterfaces;
67     private FixedFlexInterface fixedFlex;
68     private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmInterfaceFactory.class);
69
70     public OpenRoadmInterface221(PortMapping portMapping, OpenRoadmInterfaces openRoadmInterfaces,
71         FixedFlexInterface fixedFlex) {
72         this.portMapping = portMapping;
73         this.openRoadmInterfaces = openRoadmInterfaces;
74         this.fixedFlex = fixedFlex;
75     }
76
77     public String createOpenRoadmEthInterface(String nodeId, String logicalConnPoint)
78         throws OpenRoadmInterfaceException {
79         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
80         if (portMap == null) {
81             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
82                 + " logical connection port %s", nodeId, logicalConnPoint));
83         }
84
85         // Ethernet interface specific data
86         EthernetBuilder ethIfBuilder = new EthernetBuilder();
87         ethIfBuilder.setAutoNegotiation(EthAttributes.AutoNegotiation.Enabled);
88         ethIfBuilder.setDuplex(EthAttributes.Duplex.Full);
89         ethIfBuilder.setFec(EthAttributes.Fec.Off);
90         ethIfBuilder.setSpeed(100000L);
91         ethIfBuilder.setMtu(9000L);
92
93         InterfaceBuilder ethInterfaceBldr = createGenericInterfaceBuilder(portMap, EthernetCsmacd.class,
94             logicalConnPoint + "-ETHERNET");
95         // Create Interface1 type object required for adding as augmentation
96         Interface1Builder ethIf1Builder = new Interface1Builder();
97         ethInterfaceBldr.addAugmentation(Interface1.class, ethIf1Builder.setEthernet(ethIfBuilder.build()).build());
98
99         // Post interface on the device
100         openRoadmInterfaces.postInterface(nodeId, ethInterfaceBldr);
101         return ethInterfaceBldr.getName();
102     }
103
104     /**
105      * This methods creates an OCH interface on the given termination point on
106      * Roadm.
107      *
108      * @param waveNumber wavelength number of the OCH interface.
109      * @return Name of the interface if successful, otherwise return null.
110      */
111
112     public List<String> createFlexOCH(String nodeId, String logicalConnPoint, Long waveNumber)
113         throws OpenRoadmInterfaceException {
114
115         List<String> interfacesCreated = new ArrayList<>();
116
117         String nmcInterfaceCreated = createNMCInterface(nodeId, logicalConnPoint, waveNumber);
118         interfacesCreated.add(nmcInterfaceCreated);
119
120         String mcInterfaceCreated = createMCInterface(nodeId, logicalConnPoint, waveNumber);
121         interfacesCreated.add(mcInterfaceCreated);
122
123         return interfacesCreated;
124     }
125
126     public String createMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
127         throws OpenRoadmInterfaceException {
128
129         // TODO : Check this method
130
131         fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
132
133         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
134         if (portMap == null) {
135             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
136                 + " logical connection port %s", nodeId, logicalConnPoint));
137         }
138
139         // TODO : Check this method
140
141         InterfaceBuilder mcInterfaceBldr = createGenericInterfaceBuilder(portMap,
142             MediaChannelTrailTerminationPoint.class, logicalConnPoint + "-mc");
143         mcInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
144
145         McTtpBuilder mcTtpBuilder = new McTtpBuilder();
146         mcTtpBuilder.setMinFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStart())));
147         mcTtpBuilder.setMaxFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStop())));
148
149         // Create Interface1 type object required for adding as augmentation
150         org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1Builder
151             interface1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019
152             .Interface1Builder();
153         interface1Builder.setMcTtp(mcTtpBuilder.build());
154         mcInterfaceBldr.addAugmentation(
155             org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1.class,
156             interface1Builder.build());
157
158         // Post interface on the device
159         openRoadmInterfaces.postInterface(nodeId, mcInterfaceBldr);
160         return mcInterfaceBldr.getName();
161     }
162
163     public String createNMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
164         throws OpenRoadmInterfaceException {
165
166         // TODO : Check this method
167
168         fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
169
170         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
171         if (portMap == null) {
172             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
173                 + " logical connection port %s", nodeId, logicalConnPoint));
174         }
175
176         // TODO : Check this method
177         InterfaceBuilder nmcInterfaceBldr = createGenericInterfaceBuilder(portMap,
178             NetworkMediaChannelConnectionTerminationPoint.class, logicalConnPoint + "-nmc");
179         nmcInterfaceBldr.setSupportingInterface(logicalConnPoint + "-mc");
180         NmcCtpBuilder nmcCtpIfBuilder = new NmcCtpBuilder();
181
182         nmcCtpIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
183         nmcCtpIfBuilder.setWidth(FrequencyGHz.getDefaultInstance(String.valueOf(fixedFlex.getWavelength())));
184         // Create Interface1 type object required for adding as augmentation
185         org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.Interface1Builder
186             nmcCtpI1fBuilder = new org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces
187             .rev181019.Interface1Builder();
188         nmcCtpI1fBuilder.setNmcCtp(nmcCtpIfBuilder.build());
189         nmcInterfaceBldr.addAugmentation(
190             org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.Interface1.class,
191             nmcCtpI1fBuilder.build());
192         // Post interface on the device
193         openRoadmInterfaces.postInterface(nodeId, nmcInterfaceBldr);
194         return nmcInterfaceBldr.getName();
195     }
196
197     public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber)
198         throws OpenRoadmInterfaceException {
199         // TODO : Check this method
200
201         fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
202
203         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
204         if (portMap == null) {
205             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node %s and"
206                 + " logical connection port %s", nodeId, logicalConnPoint));
207         }
208
209         // OCH interface specific data
210         OchBuilder ocIfBuilder = new OchBuilder();
211
212         ocIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
213         // ocIfBuilder.setWidth(FrequencyGHz.getDefaultInstance(String.valueOf(fixedFlex.getWavelength())));
214         // ocIfBuilder.setModulationFormat(ModulationFormat.DpQpsk);
215         ocIfBuilder.setRate(R100G.class);
216         ocIfBuilder.setTransmitPower(new PowerDBm(new BigDecimal("-5")));
217
218         // Create generic interface
219         InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
220             createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
221         // Create Interface1 type object required for adding as augmentation
222         // TODO look at imports of different versions of class
223         org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1Builder
224             ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019
225             .Interface1Builder();
226         ochInterfaceBldr.addAugmentation(
227             org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1.class,
228             ochIf1Builder.setOch(ocIfBuilder.build()).build());
229
230         // Post interface on the device
231         openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
232         return ochInterfaceBldr.getName();
233     }
234
235     public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
236         throws OpenRoadmInterfaceException {
237         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
238         if (portMap == null) {
239             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
240                 + " logical connection port %s", nodeId, logicalConnPoint));
241         }
242         InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class,
243             logicalConnPoint + "-ODU");
244         oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
245
246         // ODU interface specific data
247         OduBuilder oduIfBuilder = new OduBuilder();
248         oduIfBuilder.setRate(ODU4.class);
249         oduIfBuilder.setMonitoringMode(OduAttributes.MonitoringMode.Terminated);
250
251         // Set Opu attributes
252         OpuBuilder opuBldr = new OpuBuilder();
253         opuBldr.setPayloadType(PayloadTypeDef.getDefaultInstance("07"));
254         opuBldr.setExpPayloadType(PayloadTypeDef.getDefaultInstance("07"));
255         oduIfBuilder.setOpu(opuBldr.build());
256
257         // Create Interface1 type object required for adding as augmentation
258         // TODO look at imports of different versions of class
259         org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1Builder
260             oduIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019
261             .Interface1Builder();
262         oduInterfaceBldr.addAugmentation(
263             org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1.class,
264             oduIf1Builder.setOdu(oduIfBuilder.build()).build());
265
266         // Post interface on the device
267         openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
268         return oduInterfaceBldr.getName();
269     }
270
271     public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
272         throws OpenRoadmInterfaceException {
273         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
274         if (portMap == null) {
275             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
276                 + " logical connection port %s", nodeId, logicalConnPoint));
277         }
278         // Create generic interface
279         InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class,
280             logicalConnPoint + "-OTU");
281         otuInterfaceBldr.setSupportingInterface(supportOchInterface);
282
283         // OTU interface specific data
284         OtuBuilder otuIfBuilder = new OtuBuilder();
285         otuIfBuilder.setFec(OtuAttributes.Fec.Scfec);
286         otuIfBuilder.setRate(OTU4.class);
287
288         // Create Interface1 type object required for adding as augmentation
289         // TODO look at imports of different versions of class
290         org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder
291             otuIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019
292             .Interface1Builder();
293         otuInterfaceBldr.addAugmentation(
294             org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1.class,
295             otuIf1Builder.setOtu(otuIfBuilder.build()).build());
296
297         // Post interface on the device
298         openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
299         return otuInterfaceBldr.getName();
300     }
301
302     public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, Long waveNumber) {
303         return logicalConnectionPoint + "-" + waveNumber;
304     }
305
306     private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
307         String key) {
308         InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
309         interfaceBuilder.setDescription("  TBD   ");
310         interfaceBuilder.setCircuitId("   TBD    ");
311         interfaceBuilder.setSupportingCircuitPackName(portMap.getSupportingCircuitPackName());
312         interfaceBuilder.setSupportingPort(portMap.getSupportingPort());
313         interfaceBuilder.setAdministrativeState(AdminStates.InService);
314         interfaceBuilder.setType(type);
315         interfaceBuilder.setName(key);
316         interfaceBuilder.withKey(new InterfaceKey(key));
317         return interfaceBuilder;
318     }
319
320     public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
321         if (mapping.getSupportingOms() == null) {
322             // Create generic interface
323             InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
324                 "OMS-" + mapping.getLogicalConnectionPoint());
325             if (mapping.getSupportingOts() != null) {
326                 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
327             } else {
328                 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId,
329                     mapping.getLogicalConnectionPoint());
330                 return null;
331             }
332             this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
333             this.portMapping.updateMapping(nodeId, mapping);
334             return omsInterfaceBldr.build().getName();
335         } else {
336             return mapping.getSupportingOms();
337         }
338     }
339
340     public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
341         if (mapping.getSupportingOts() == null) {
342             // Create generic interface
343             InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
344                 + mapping.getLogicalConnectionPoint());
345             // OTS interface augmentation specific data
346             OtsBuilder otsIfBuilder = new OtsBuilder();
347             otsIfBuilder.setFiberType(OtsAttributes.FiberType.Smf);
348
349             // Create Interface1 type object required for adding as
350             // augmentation
351             org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.Interface1Builder
352                 otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces
353                 .rev181019.Interface1Builder();
354             otsInterfaceBldr.addAugmentation(
355                 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.Interface1.class,
356                 otsIf1Builder.setOts(otsIfBuilder.build()).build());
357             this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
358             this.portMapping.updateMapping(nodeId, mapping);
359             return otsInterfaceBldr.build().getName();
360         } else {
361             return mapping.getSupportingOts();
362         }
363     }
364
365     public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
366         DeviceTransactionManager deviceTransactionManager) {
367         InstanceIdentifier<RoadmConnections> xciid = InstanceIdentifier.create(OrgOpenroadmDevice.class)
368             .child(RoadmConnections.class, new RoadmConnectionsKey(xc));
369         LOG.info("reading xc {} in node {}", xc, nodeId);
370         Optional<RoadmConnections> crossconnection = deviceTransactionManager.getDataFromDevice(nodeId,
371             LogicalDatastoreType.CONFIGURATION, xciid, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
372         if (crossconnection.isPresent()) {
373             RoadmConnections rc = crossconnection.get();
374             LOG.info("xd {} found", xc);
375             String supportedinter = null;
376             if (!interfaceName.contains("nmc")) {
377                 supportedinter = interfaceName.replace("mc", "nmc");
378             }
379             if (rc.getSource().getSrcIf().equals(interfaceName)
380                 || rc.getDestination().getDstIf().equals(interfaceName)
381                 || rc.getSource().getSrcIf().equals(supportedinter)
382                 || rc.getDestination().getDstIf().equals(supportedinter)) {
383                 return true;
384             }
385         } else {
386             LOG.info("xd {} not found !", xc);
387         }
388         return false;
389     }
390
391 }