diff options
Diffstat (limited to 'framework/src/onos/core/net/src/main/java/org/onosproject/net/device/impl/OpticalPortOperator.java')
| -rw-r--r-- | framework/src/onos/core/net/src/main/java/org/onosproject/net/device/impl/OpticalPortOperator.java | 173 |
1 files changed, 173 insertions, 0 deletions
diff --git a/framework/src/onos/core/net/src/main/java/org/onosproject/net/device/impl/OpticalPortOperator.java b/framework/src/onos/core/net/src/main/java/org/onosproject/net/device/impl/OpticalPortOperator.java new file mode 100644 index 00000000..b2fd02c7 --- /dev/null +++ b/framework/src/onos/core/net/src/main/java/org/onosproject/net/device/impl/OpticalPortOperator.java @@ -0,0 +1,173 @@ +/* + * Copyright 2014-2015 Open Networking Laboratory + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.onosproject.net.device.impl; + +import static org.slf4j.LoggerFactory.getLogger; +import static com.google.common.base.Preconditions.checkNotNull; + +import org.onosproject.net.config.ConfigOperator; +import org.onosproject.net.config.basics.OpticalPortConfig; +import org.onosproject.net.AnnotationKeys; +import org.onosproject.net.DefaultAnnotations; +import org.onosproject.net.OchPort; +import org.onosproject.net.OduCltPort; +import org.onosproject.net.OmsPort; +import org.onosproject.net.Port; +import org.onosproject.net.PortNumber; +import org.onosproject.net.SparseAnnotations; +import org.onosproject.net.device.DefaultPortDescription; +import org.onosproject.net.device.OchPortDescription; +import org.onosproject.net.device.OduCltPortDescription; +import org.onosproject.net.device.OmsPortDescription; +import org.onosproject.net.device.PortDescription; +import org.slf4j.Logger; + +/** + * Implementations of merge policies for various sources of optical port + * configuration information. This includes applications, provides, and network + * configurations. + */ +public final class OpticalPortOperator implements ConfigOperator { + + private static final Logger log = getLogger(OpticalPortOperator.class); + + private OpticalPortOperator() { + } + + /** + * Generates a PortDescription containing fields from a PortDescription and + * an OpticalPortConfig. + * + * @param opc the port config entity from network config + * @param descr a PortDescription + * @return PortDescription based on both sources + */ + public static PortDescription combine(OpticalPortConfig opc, PortDescription descr) { + if (opc == null) { + return descr; + } + + PortNumber port = descr.portNumber(); + final String name = opc.name(); + final String numName = opc.numberName(); + // if the description is null, or the current description port name != config name, + // create a new PortNumber. + PortNumber newPort = null; + if (port == null) { + // try to get the portNumber from the numName. + if (!numName.isEmpty()) { + final long pn = Long.parseLong(numName); + newPort = (!name.isEmpty()) ? PortNumber.portNumber(pn, name) : PortNumber.portNumber(pn); + } else { + // we don't have defining info (a port number value) + throw new RuntimeException("Possible misconfig, bailing on handling for: \n\t" + descr); + } + } else if ((!name.isEmpty()) && !name.equals(port.name())) { + final long pn = (numName.isEmpty()) ? port.toLong() : Long.parseLong(numName); + newPort = PortNumber.portNumber(pn, name); + } + + // Port type won't change unless we're overwriting a port completely. + // Watch out for overwrites to avoid class cast craziness. + boolean noOwrite = opc.type() == descr.type(); + + SparseAnnotations sa = combine(opc, descr.annotations()); + if (noOwrite) { + return updateDescription((newPort == null) ? port : newPort, sa, descr); + } else { + // TODO: must reconstruct a different type of PortDescription. + log.info("Type rewrite from {} to {} required", descr.type(), opc.type()); + } + return descr; + } + + // updates a port description whose port type has not changed. + private static PortDescription updateDescription( + PortNumber port, SparseAnnotations sa, PortDescription descr) { + switch (descr.type()) { + case OMS: + OmsPortDescription oms = (OmsPortDescription) descr; + return new OmsPortDescription(port, oms.isEnabled(), oms.minFrequency(), + oms.maxFrequency(), oms.grid(), sa); + case OCH: + // We might need to update lambda below with STATIC_LAMBDA. + OchPortDescription och = (OchPortDescription) descr; + return new OchPortDescription(port, och.isEnabled(), och.signalType(), + och.isTunable(), och.lambda(), sa); + case ODUCLT: + OduCltPortDescription odu = (OduCltPortDescription) descr; + return new OduCltPortDescription(port, odu.isEnabled(), odu.signalType(), sa); + case PACKET: + case FIBER: + return new DefaultPortDescription(port, descr.isEnabled(), descr.type(), + descr.portSpeed(), sa); + default: + // this includes copper ports. + log.warn("Unsupported optical port type {} - can't update", descr.type()); + return descr; + } + } + + /** + * Generates an annotation from an existing annotation and OptcalPortConfig. + * + * @param opc the port config entity from network config + * @param an the annotation + * @return annotation combining both sources + */ + public static SparseAnnotations combine(OpticalPortConfig opc, SparseAnnotations an) { + DefaultAnnotations.Builder b = DefaultAnnotations.builder(); + if (!opc.staticPort().isEmpty()) { + b.set(AnnotationKeys.STATIC_PORT, opc.staticPort()); + } + if (opc.staticLambda().isPresent()) { + b.set(AnnotationKeys.STATIC_LAMBDA, String.valueOf(opc.staticLambda().get())); + } + // The following may not need to be carried. + if (!opc.name().isEmpty()) { + b.set(AnnotationKeys.PORT_NAME, opc.name()); + } + return DefaultAnnotations.union(an, b.build()); + } + + /** + * Returns a description built from an existing port. + * + * @param port the device port + * @return a PortDescription based on the port + */ + public static PortDescription descriptionOf(Port port) { + checkNotNull(port, "Must supply non-null Port"); + final PortNumber ptn = port.number(); + final boolean isup = port.isEnabled(); + final SparseAnnotations an = (SparseAnnotations) port.annotations(); + switch (port.type()) { + case OMS: + OmsPort oms = (OmsPort) port; + return new OmsPortDescription(ptn, isup, oms.minFrequency(), + oms.maxFrequency(), oms.grid(), an); + case OCH: + OchPort och = (OchPort) port; + return new OchPortDescription(ptn, isup, och.signalType(), + och.isTunable(), och.lambda(), an); + case ODUCLT: + OduCltPort odu = (OduCltPort) port; + return new OduCltPortDescription(ptn, isup, odu.signalType(), an); + default: + return new DefaultPortDescription(ptn, isup, port.type(), port.portSpeed(), an); + } + } +} |