Separate the OF Polatis driver
Change-Id: I3678be3e06da9064824e3694e5119f80541fa056
diff --git a/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/OpenFlowLambdaQuery.java b/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/OpenFlowLambdaQuery.java
new file mode 100644
index 0000000..3bfb93e
--- /dev/null
+++ b/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/OpenFlowLambdaQuery.java
@@ -0,0 +1,129 @@
+/*
+ * Copyright 2018 Open Networking Foundation
+ *
+ * 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.drivers.polatis.openflow;
+
+import org.onlab.util.GuavaCollectors;
+import org.onlab.util.Spectrum;
+import org.onosproject.net.ChannelSpacing;
+import org.onosproject.net.GridType;
+import org.onosproject.net.OchSignal;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.behaviour.LambdaQuery;
+import org.onosproject.net.driver.AbstractHandlerBehaviour;
+
+import org.onosproject.openflow.controller.Dpid;
+import org.onosproject.openflow.controller.OpenFlowController;
+import org.onosproject.openflow.controller.OpenFlowSwitch;
+
+import org.projectfloodlight.openflow.protocol.OFPortDesc;
+import org.projectfloodlight.openflow.protocol.OFPortDescProp;
+import org.projectfloodlight.openflow.protocol.OFPortDescPropOptical;
+
+import org.slf4j.Logger;
+
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.IntStream;
+
+import static org.onosproject.openflow.controller.Dpid.dpid;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Lambda query implementation for OpenFlow Optical Circuit Switch.
+ */
+public class OpenFlowLambdaQuery extends AbstractHandlerBehaviour implements LambdaQuery {
+
+ private static final Logger log = getLogger(OpenFlowLambdaQuery.class);
+
+ @Override
+ public Set<OchSignal> queryLambdas(PortNumber port) {
+ Set<OchSignal> signals = new LinkedHashSet<>();
+ for (OFPortDesc pd : getPortDescs()) {
+ if (pd.getPortNo().getPortNumber() == port.toLong()) {
+ for (OFPortDescProp prop : pd.getProperties()) {
+ if (prop instanceof OFPortDescPropOptical) {
+ OFPortDescPropOptical oprop = (OFPortDescPropOptical) prop;
+ long txMin = oprop.getTxMinFreqLmda();
+ long txMax = oprop.getTxMaxFreqLmda();
+ long txGrid = oprop.getTxGridFreqLmda();
+ signals.addAll(signals(txMin, txMax, txGrid));
+ long rxMin = oprop.getRxMinFreqLmda();
+ long rxMax = oprop.getRxMaxFreqLmda();
+ long rxGrid = oprop.getRxGridFreqLmda();
+ signals.addAll(signals(rxMin, rxMax, rxGrid));
+ }
+ }
+ }
+ }
+ return signals;
+
+ }
+
+ private Set<OchSignal> signals(long min, long max, long grid) {
+ if (Spectrum.O_BAND_MIN.asMHz() > min) {
+ log.warn("Out of range frequency (below the O-band minimum)");
+ }
+ if (Spectrum.U_BAND_MAX.asMHz() < max) {
+ log.warn("Out of range frequency (above the U-band maximum)");
+ }
+
+ double centerFrequencyMHz = Spectrum.CENTER_FREQUENCY.asMHz();
+ long startSpacingMultiplier = (long) (min - centerFrequencyMHz) / grid;
+ long stopSpacingMultiplier = (long) (max - centerFrequencyMHz) / grid;
+
+ Set<OchSignal> signals = new LinkedHashSet<>();
+
+ if (grid == ChannelSpacing.CHL_100GHZ.frequency().asMHz()) {
+ signals = IntStream.rangeClosed((int) startSpacingMultiplier,
+ (int) stopSpacingMultiplier)
+ .mapToObj(i -> new OchSignal(GridType.DWDM, ChannelSpacing.CHL_100GHZ, i, 8))
+ .collect(GuavaCollectors.toImmutableSet());
+ } else if (grid == ChannelSpacing.CHL_50GHZ.frequency().asMHz()) {
+ signals = IntStream.rangeClosed((int) startSpacingMultiplier,
+ (int) stopSpacingMultiplier)
+ .mapToObj(i -> new OchSignal(GridType.DWDM, ChannelSpacing.CHL_50GHZ, i, 4))
+ .collect(GuavaCollectors.toImmutableSet());
+ } else if (grid == ChannelSpacing.CHL_25GHZ.frequency().asMHz()) {
+ signals = IntStream.rangeClosed((int) startSpacingMultiplier,
+ (int) stopSpacingMultiplier)
+ .mapToObj(i -> new OchSignal(GridType.DWDM, ChannelSpacing.CHL_25GHZ, i, 2))
+ .collect(GuavaCollectors.toImmutableSet());
+ } else if (grid == ChannelSpacing.CHL_12P5GHZ.frequency().asMHz()) {
+ signals = IntStream.rangeClosed((int) startSpacingMultiplier,
+ (int) stopSpacingMultiplier)
+ .mapToObj(i -> new OchSignal(GridType.DWDM, ChannelSpacing.CHL_6P25GHZ, i, 1))
+ .collect(GuavaCollectors.toImmutableSet());
+ } else if (grid == ChannelSpacing.CHL_6P25GHZ.frequency().asMHz()) {
+ // Only consider odd values for the multiplier (for easy mapping to fixed grid)
+ signals = IntStream.rangeClosed((int) startSpacingMultiplier,
+ (int) stopSpacingMultiplier)
+ .filter(i -> i % 2 == 1)
+ .mapToObj(i -> new OchSignal(GridType.FLEX, ChannelSpacing.CHL_6P25GHZ, i, 1))
+ .collect(GuavaCollectors.toImmutableSet());
+ } else {
+ log.warn("Unsupported channel spacing");
+ }
+
+ return signals;
+ }
+
+ private List<OFPortDesc> getPortDescs() {
+ final Dpid dpid = dpid(handler().data().deviceId().uri());
+ OpenFlowSwitch sw = handler().get(OpenFlowController.class).getSwitch(dpid);
+ return sw.getPorts();
+ }
+}
diff --git a/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/OpenFlowPowerConfig.java b/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/OpenFlowPowerConfig.java
new file mode 100644
index 0000000..2255ba0
--- /dev/null
+++ b/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/OpenFlowPowerConfig.java
@@ -0,0 +1,182 @@
+/*
+ * Copyright 2018 Open Networking Foundation
+ *
+ * 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.drivers.polatis.openflow;
+
+import com.google.common.collect.Range;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.behaviour.PowerConfig;
+import org.onosproject.net.driver.AbstractHandlerBehaviour;
+
+import org.onosproject.openflow.controller.Dpid;
+import org.onosproject.openflow.controller.OpenFlowController;
+import org.onosproject.openflow.controller.OpenFlowSwitch;
+
+import org.projectfloodlight.openflow.protocol.OFPortConfig;
+import org.projectfloodlight.openflow.protocol.OFPortDesc;
+import org.projectfloodlight.openflow.protocol.OFPortDescProp;
+import org.projectfloodlight.openflow.protocol.OFPortDescPropOptical;
+import org.projectfloodlight.openflow.protocol.OFPortMod;
+import org.projectfloodlight.openflow.protocol.OFPortModProp;
+import org.projectfloodlight.openflow.protocol.OFPortModPropOptical;
+import org.projectfloodlight.openflow.protocol.ver14.OFOpticalPortFeaturesSerializerVer14;
+import org.projectfloodlight.openflow.types.OFPort;
+
+import org.slf4j.Logger;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.EnumSet;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+
+import static org.onosproject.openflow.controller.Dpid.dpid;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Get current or target port/channel power from an openflow device.
+ * Set target port power or channel attenuation to an openflow device.
+ */
+public class OpenFlowPowerConfig<T> extends AbstractHandlerBehaviour
+ implements PowerConfig<T> {
+
+ private static final Logger log = getLogger(OpenFlowPowerConfig.class);
+
+ @Override
+ public Optional<Long> getTargetPower(PortNumber port, T component) {
+ // TODO: OpenFlow does not seem to have the concept of retrieving this
+ // information as only the current power is returned in the port stats
+ // reply. This can be different from the configured value. Perhaps, the
+ // settings in annotations or building a lookup table with the latest
+ // settings could be options.
+ return Optional.empty();
+ }
+
+ @Override
+ public void setTargetPower(PortNumber port, T component, long power) {
+ setPortTargetPower(port, power);
+ }
+
+ @Override
+ public Optional<Long> currentPower(PortNumber port, T component) {
+ // TODO: Ideally, this needs to read the port stats output for real-time
+ // data or as a short-term workaround, it could get the last read value
+ // from the port stats polling.
+ return null;
+ }
+
+ @Override
+ public Optional<Range<Long>> getTargetPowerRange(PortNumber port, T component) {
+ for (OFPortDesc pd : getPortDescs()) {
+ if (pd.getPortNo().getPortNumber() == port.toLong()) {
+ for (OFPortDescProp prop : pd.getProperties()) {
+ if (prop instanceof OFPortDescPropOptical) {
+ OFPortDescPropOptical oprop = (OFPortDescPropOptical) prop;
+ long txMin = oprop.getTxPwrMin();
+ long txMax = oprop.getTxPwrMax();
+ return Optional.of(Range.closed(txMin, txMax));
+ }
+ }
+ }
+ }
+ return Optional.empty();
+ }
+
+ private List<OFPortDesc> getPortDescs() {
+ final Dpid dpid = dpid(handler().data().deviceId().uri());
+ OpenFlowSwitch sw = handler().get(OpenFlowController.class).getSwitch(dpid);
+ return sw.getPorts();
+ }
+
+ @Override
+ public Optional<Range<Long>> getInputPowerRange(PortNumber port, T component) {
+ log.warn("Unsupported as OpenFlow does not seem to have the concept of input (presumably rx) power range.");
+ return Optional.empty();
+ }
+
+ @Override
+ public List<PortNumber> getPorts(T component) {
+ List<PortNumber> ports = new ArrayList<>();
+ for (OFPortDesc pd : getPortDescs()) {
+ for (OFPortDescProp prop : pd.getProperties()) {
+ // Note: Power monitor detection can actually be more complex
+ // than this. It is possible that the power is not
+ // configurable, but it is readable. In this case, the best
+ // bet is probably to check rx/tx power info valid in the
+ // port stats reply, unfortunately.
+ if (prop instanceof OFPortDescPropOptical) {
+ ports.add(PortNumber.portNumber(pd.getPortNo().getPortNumber()));
+ break;
+ }
+ }
+ }
+ return ports;
+ }
+
+ private OFPortMod.Builder makePortMod(OpenFlowSwitch sw, PortNumber portNumber,
+ boolean enable) {
+ OFPortMod.Builder pmb = sw.factory().buildPortMod();
+ OFPort port = OFPort.of((int) portNumber.toLong());
+ pmb.setPortNo(port);
+ Set<OFPortConfig> portConfig = EnumSet.noneOf(OFPortConfig.class);
+ if (!enable) {
+ portConfig.add(OFPortConfig.PORT_DOWN);
+ }
+ pmb.setConfig(portConfig);
+ Set<OFPortConfig> portMask = EnumSet.noneOf(OFPortConfig.class);
+ portMask.add(OFPortConfig.PORT_DOWN);
+ pmb.setMask(portMask);
+ pmb.setAdvertise(0x0);
+ for (OFPortDesc pd : sw.getPorts()) {
+ if (pd.getPortNo().equals(port)) {
+ pmb.setHwAddr(pd.getHwAddr());
+ break;
+ }
+ }
+ return pmb;
+ }
+
+ private boolean setPortTargetPower(PortNumber port, long power) {
+ DeviceId deviceId = handler().data().deviceId();
+ final Dpid dpid = dpid(deviceId.uri());
+ OpenFlowSwitch sw = handler().get(OpenFlowController.class).getSwitch(dpid);
+ if (sw == null || !sw.isConnected()) {
+ log.error("Failed to change port on device {}", deviceId);
+ return false;
+ }
+ boolean enable = false;
+ for (OFPortDesc pd : getPortDescs()) {
+ if (pd.getPortNo().getPortNumber() == port.toLong()) {
+ enable = pd.getConfig().contains(OFPortConfig.PORT_DOWN);
+ break;
+ }
+ }
+ OFPortMod.Builder pmb = makePortMod(sw, port, enable);
+ long configure = OFOpticalPortFeaturesSerializerVer14.TX_PWR_VAL;
+ OFPortModPropOptical.Builder property = sw.factory().buildPortModPropOptical();
+ property.setTxPwr(power);
+
+ List<OFPortModProp> properties = new ArrayList<>();
+ properties.add(property.build());
+ pmb.setProperties(properties);
+
+ sw.sendMsg(Collections.singletonList(pmb.build()));
+ // TODO: We would need to report false in case of port mod failure.
+ return true;
+ }
+}
diff --git a/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/PolatisDriversLoader.java b/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/PolatisDriversLoader.java
new file mode 100644
index 0000000..f484e5d
--- /dev/null
+++ b/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/PolatisDriversLoader.java
@@ -0,0 +1,89 @@
+/*
+ * Copyright 2018 Open Networking Foundation
+ *
+ * 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.drivers.polatis.openflow;
+
+import org.apache.felix.scr.annotations.Activate;
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Deactivate;
+import org.apache.felix.scr.annotations.Reference;
+import org.apache.felix.scr.annotations.ReferenceCardinality;
+import org.onosproject.net.driver.AbstractDriverLoader;
+import org.onosproject.net.optical.OpticalDevice;
+import org.onosproject.ui.UiGlyph;
+import org.onosproject.ui.UiGlyphFactory;
+import org.onosproject.ui.UiExtensionService;
+
+import com.google.common.collect.ImmutableList;
+
+/**
+ * Loader for Polatis OpenFlow device drivers.
+ */
+@Component(immediate = true)
+public class PolatisDriversLoader extends AbstractDriverLoader {
+
+ // OSGI: help bundle plugin discover runtime package dependency.
+ @SuppressWarnings("unused")
+ private OpticalDevice optical;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected UiExtensionService uiExtensionService;
+
+ private UiGlyphFactory glyphFactory =
+ () -> ImmutableList.of(
+ new UiGlyph("policon", "0 0 64 64",
+ "M 32.024746,2 30.163615,19.069136 24.258784,3.015638 "
+ + "26.879599,19.985033 17.021343,6.007051 23.943688,21.71947 "
+ + "10.8045,10.769161 21.557349,24.15439 6.031794,16.978659 "
+ + "19.883076,27.1245 3.027943,24.21114 19.033986,30.42674 "
+ + "2,31.97526 19.069136,33.83639 3.015638,39.74122 "
+ + "19.985033,37.12041 6.007051,46.97866 21.719466,40.05632 "
+ + "10.769161,53.19551 24.154391,42.44265 16.978659,57.96822 "
+ + "27.124504,44.11693 24.21114,60.97206 30.426738,44.96602 "
+ + "31.975259,62 33.83639,44.93086 39.74122,60.98437 "
+ + "37.120405,44.01497 46.978663,57.99296 40.056317,42.28054 "
+ + "53.195507,53.23084 42.442656,39.84561 57.968215,47.02135 "
+ + "44.116927,36.8755 60.972063,39.78886 44.966018,33.57327 "
+ + "62,32.02475 44.930865,30.16362 60.984369,24.25878 "
+ + "44.014972,26.8796 57.992959,17.021342 42.280539,23.94369 "
+ + "53.23084,10.8045 39.845614,21.55735 47.021349,6.031794 "
+ + "36.875501,19.883076 39.788865,3.027943 33.573267,19.033986 Z "
+ + "m -0.05497,19.23081 A 10.768943,10.768943 0 0 1 "
+ + "42.769201,31.96977 10.768943,10.768943 0 0 1 "
+ + "32.030235,42.7692 10.768943,10.768943 0 0 1 "
+ + "21.230812,32.03023 10.768943,10.768943 0 0 1 "
+ + "31.969778,21.23081 Z")
+ );
+
+ public PolatisDriversLoader() {
+ super("/polatis-openflow-drivers.xml");
+ }
+
+ @Activate
+ @Override
+ protected void activate() {
+ uiExtensionService.register(glyphFactory);
+ super.activate();
+ }
+
+ @Deactivate
+ @Override
+ protected void deactivate() {
+ uiExtensionService.unregister(glyphFactory);
+ super.deactivate();
+ }
+
+}
diff --git a/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/PolatisHandshaker.java b/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/PolatisHandshaker.java
new file mode 100644
index 0000000..d1e8ade
--- /dev/null
+++ b/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/PolatisHandshaker.java
@@ -0,0 +1,97 @@
+/*
+ * Copyright 2017-present Open Networking Foundation
+ *
+ * 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.drivers.polatis.openflow;
+
+import static org.slf4j.LoggerFactory.getLogger;
+
+import java.util.List;
+import java.util.Set;
+import org.onosproject.net.Device.Type;
+import org.onosproject.openflow.controller.OpenFlowOpticalSwitch;
+import org.onosproject.openflow.controller.PortDescPropertyType;
+import org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch;
+import org.projectfloodlight.openflow.protocol.OFMessage;
+import org.projectfloodlight.openflow.protocol.OFPortDesc;
+import org.slf4j.Logger;
+
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSet;
+
+/**
+ * Handshaker for Polatis fiber switch.
+ *
+ */
+public class PolatisHandshaker extends AbstractOpenFlowSwitch
+ implements OpenFlowOpticalSwitch {
+
+ private static final Logger log = getLogger(PolatisHandshaker.class);
+
+ @Override
+ public Boolean supportNxRole() {
+ // Device is OF1.4 so response doesn't matter.
+ return Boolean.FALSE;
+ }
+
+ @Override
+ public void startDriverHandshake() {
+ // nothing Device specific required
+ }
+
+ @Override
+ public boolean isDriverHandshakeComplete() {
+ // nothing Device specific to do
+ return true;
+ }
+
+ @Override
+ public void processDriverHandshakeMessage(OFMessage m) {
+ // nothing Device specific to do
+ }
+
+ @Override
+ public Type deviceType() {
+ return Type.FIBER_SWITCH;
+ }
+
+ @Override
+ public List<OFPortDesc> getPortsOf(PortDescPropertyType type) {
+ return this.getPorts().stream()
+ .filter(pd -> isPortType(type, pd))
+ .collect(ImmutableList.toImmutableList());
+ }
+
+ /**
+ * Tests if OFPortDesc {@code pd} is a {@code type}.
+ *
+ * @param type to test if {@code pd} is of port type
+ * @param pd OpenFlow port description to test.
+ * @return true if {@code pd} is of port description of {@code type}
+ */
+ private static boolean isPortType(PortDescPropertyType type, OFPortDesc pd) {
+ try {
+ return pd.getProperties().stream()
+ .anyMatch(prop -> prop.getType() == type.valueOf());
+ } catch (UnsupportedOperationException e) {
+ log.warn("Unexpected OFPortDesc {} reveived", pd, e);
+ return false;
+ }
+ }
+
+ @Override
+ public Set<PortDescPropertyType> getPortTypes() {
+ return ImmutableSet.of(PortDescPropertyType.OPTICAL);
+ }
+}
diff --git a/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/package-info.java b/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/package-info.java
new file mode 100644
index 0000000..b39e90e
--- /dev/null
+++ b/drivers/polatis/openflow/src/main/java/org/onosproject/drivers/polatis/openflow/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018 Open Networking Foundation
+ *
+ * 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 for Polatis OpenFlow device drivers.
+ */
+package org.onosproject.drivers.polatis.openflow;