Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017 Open Networking Foundation |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.drivers.polatis.netconf; |
| 18 | |
| 19 | import com.google.common.collect.Range; |
| 20 | import org.apache.commons.configuration.HierarchicalConfiguration; |
| 21 | import org.onosproject.net.Direction; |
| 22 | import org.onosproject.net.OchSignal; |
| 23 | import org.onosproject.net.PortNumber; |
| 24 | import org.onosproject.net.behaviour.PowerConfig; |
| 25 | import org.onosproject.net.driver.AbstractHandlerBehaviour; |
| 26 | import org.slf4j.Logger; |
| 27 | |
Laszlo Papp | 8cd61fb | 2017-10-13 16:45:00 +0100 | [diff] [blame] | 28 | import java.util.ArrayList; |
| 29 | import java.util.List; |
Laszlo Papp | 8b87a19 | 2017-10-19 18:47:12 +0100 | [diff] [blame] | 30 | import java.util.NoSuchElementException; |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 31 | import java.util.Optional; |
| 32 | |
| 33 | import static org.onosproject.drivers.polatis.netconf.PolatisOpticalUtility.POWER_MULTIPLIER; |
Laszlo Papp | 8b87a19 | 2017-10-19 18:47:12 +0100 | [diff] [blame] | 34 | import static org.onosproject.drivers.polatis.netconf.PolatisOpticalUtility.VOA_MULTIPLIER; |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 35 | import static org.onosproject.drivers.polatis.netconf.PolatisOpticalUtility.POWER_RANGE; |
Laszlo Papp | 81cc642 | 2017-10-18 02:24:09 +0100 | [diff] [blame] | 36 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.netconfGet; |
Laszlo Papp | 8b87a19 | 2017-10-19 18:47:12 +0100 | [diff] [blame] | 37 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.netconfEditConfig; |
Laszlo Papp | 81cc642 | 2017-10-18 02:24:09 +0100 | [diff] [blame] | 38 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.configAt; |
| 39 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.configsAt; |
Laszlo Papp | 8b87a19 | 2017-10-19 18:47:12 +0100 | [diff] [blame] | 40 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.xml; |
Laszlo Papp | 81cc642 | 2017-10-18 02:24:09 +0100 | [diff] [blame] | 41 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.xmlOpen; |
| 42 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.xmlClose; |
| 43 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.KEY_PORT; |
| 44 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.KEY_PORTID; |
| 45 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.KEY_OPM; |
| 46 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.KEY_OPM_XMLNS; |
| 47 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.KEY_DATA_OPM; |
| 48 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.KEY_DATA_OPM_PORT; |
Laszlo Papp | 8b87a19 | 2017-10-19 18:47:12 +0100 | [diff] [blame] | 49 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.KEY_VOA; |
| 50 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.KEY_VOA_XMLNS; |
| 51 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.KEY_DATA_VOA_PORT; |
| 52 | import static org.onosproject.drivers.polatis.netconf.PolatisNetconfUtility.CFG_MODE_MERGE; |
Laszlo Papp | 81cc642 | 2017-10-18 02:24:09 +0100 | [diff] [blame] | 53 | |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 54 | import static org.slf4j.LoggerFactory.getLogger; |
| 55 | |
| 56 | /** |
| 57 | * Get current or target port/channel power from a Polatis optical netconf device. |
| 58 | * Set target port power or channel attenuation to an optical netconf device. |
| 59 | */ |
| 60 | public class PolatisPowerConfig<T> extends AbstractHandlerBehaviour |
Andrea Campanella | dadf640 | 2019-08-07 15:24:11 +0200 | [diff] [blame^] | 61 | implements PowerConfig<T> { |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 62 | |
Laszlo Papp | 81cc642 | 2017-10-18 02:24:09 +0100 | [diff] [blame] | 63 | private static final String KEY_POWER = "power"; |
Laszlo Papp | 8b87a19 | 2017-10-19 18:47:12 +0100 | [diff] [blame] | 64 | private static final String KEY_ATTEN_LEVEL = "atten-level"; |
| 65 | private static final String KEY_ATTEN_MODE = "atten-mode"; |
| 66 | private static final String VALUE_ATTEN_MODE = "VOA_MODE_ABSOLUTE"; |
Laszlo Papp | 81cc642 | 2017-10-18 02:24:09 +0100 | [diff] [blame] | 67 | |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 68 | private static final Logger log = getLogger(PolatisPowerConfig.class); |
| 69 | |
| 70 | @Override |
Andrea Campanella | dadf640 | 2019-08-07 15:24:11 +0200 | [diff] [blame^] | 71 | public Optional<Double> getTargetPower(PortNumber port, T component) { |
| 72 | Long power = acquireCurrentPower(port, component); |
| 73 | if (power == null) { |
| 74 | return Optional.empty(); |
| 75 | } |
| 76 | return Optional.of(power.doubleValue()); |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 77 | } |
| 78 | |
| 79 | @Override |
Andrea Campanella | dadf640 | 2019-08-07 15:24:11 +0200 | [diff] [blame^] | 80 | public void setTargetPower(PortNumber port, T component, double power) { |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 81 | if (component instanceof OchSignal) { |
| 82 | log.warn("Channel power is not applicable."); |
| 83 | return; |
| 84 | } |
Andrea Campanella | dadf640 | 2019-08-07 15:24:11 +0200 | [diff] [blame^] | 85 | setPortTargetPower(port, (long) power); |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 86 | } |
| 87 | |
| 88 | @Override |
Andrea Campanella | dadf640 | 2019-08-07 15:24:11 +0200 | [diff] [blame^] | 89 | public Optional<Double> currentPower(PortNumber port, T component) { |
| 90 | Long power = acquireCurrentPower(port, component); |
| 91 | if (power == null) { |
| 92 | return Optional.empty(); |
| 93 | } |
| 94 | return Optional.of(power.doubleValue()); |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 95 | } |
| 96 | |
| 97 | @Override |
Andrea Campanella | dadf640 | 2019-08-07 15:24:11 +0200 | [diff] [blame^] | 98 | public Optional<Range<Double>> getTargetPowerRange(PortNumber port, T component) { |
| 99 | Range<Long> power = getTxPowerRange(port, component); |
| 100 | if (power == null) { |
| 101 | return Optional.empty(); |
| 102 | } |
| 103 | return Optional.of(Range.closed((double) power.lowerEndpoint(), (double) power.upperEndpoint())); |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | @Override |
Andrea Campanella | dadf640 | 2019-08-07 15:24:11 +0200 | [diff] [blame^] | 107 | public Optional<Range<Double>> getInputPowerRange(PortNumber port, T component) { |
| 108 | Range<Long> power = getRxPowerRange(port, component); |
| 109 | if (power == null) { |
| 110 | return Optional.empty(); |
| 111 | } |
| 112 | return Optional.of(Range.closed((double) power.lowerEndpoint(), (double) power.upperEndpoint())); |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 113 | } |
| 114 | |
Laszlo Papp | 8cd61fb | 2017-10-13 16:45:00 +0100 | [diff] [blame] | 115 | @Override |
| 116 | public List<PortNumber> getPorts(T component) { |
| 117 | if (component instanceof OchSignal) { |
| 118 | log.warn("Channel component is not applicable."); |
| 119 | return new ArrayList<PortNumber>(); |
| 120 | } |
| 121 | log.debug("Get port config ports..."); |
| 122 | return acquirePorts(); |
| 123 | } |
| 124 | |
| 125 | private List<PortNumber> acquirePorts() { |
| 126 | String filter = getPortPowerFilter(null); |
| 127 | String reply = netconfGet(handler(), filter); |
| 128 | List<HierarchicalConfiguration> subtrees = configsAt(reply, KEY_DATA_OPM); |
| 129 | List<PortNumber> ports = new ArrayList<PortNumber>(); |
| 130 | for (HierarchicalConfiguration portConfig : subtrees) { |
| 131 | ports.add(PortNumber.portNumber(portConfig.getLong(KEY_PORTID))); |
| 132 | } |
| 133 | return ports; |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Get the filter string for the OPM power NETCONF request. |
| 138 | * |
| 139 | * @param port the port, null to return all the opm ports |
| 140 | * @return filter string |
| 141 | */ |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 142 | private String getPortPowerFilter(PortNumber port) { |
Laszlo Papp | 8cd61fb | 2017-10-13 16:45:00 +0100 | [diff] [blame] | 143 | StringBuilder filter = new StringBuilder(xmlOpen(KEY_OPM_XMLNS)) |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 144 | .append(xmlOpen(KEY_PORT)) |
Laszlo Papp | 8cd61fb | 2017-10-13 16:45:00 +0100 | [diff] [blame] | 145 | .append(xmlOpen(KEY_PORTID)); |
| 146 | if (port != null) { |
| 147 | filter.append(port.toLong()); |
| 148 | } |
| 149 | return filter.append(xmlClose(KEY_PORTID)) |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 150 | .append(xmlClose(KEY_PORT)) |
| 151 | .append(xmlClose(KEY_OPM)) |
| 152 | .toString(); |
| 153 | } |
| 154 | |
| 155 | private Long acquireTargetPower(PortNumber port, T component) { |
| 156 | if (component instanceof OchSignal) { |
| 157 | log.warn("Channel power is not applicable."); |
| 158 | return null; |
| 159 | } |
| 160 | log.debug("Get port{} target power...", port); |
Laszlo Papp | 8b87a19 | 2017-10-19 18:47:12 +0100 | [diff] [blame] | 161 | return acquirePortAttenuation(port); |
| 162 | } |
| 163 | |
| 164 | /** |
| 165 | * Get the filter string for the attenuation NETCONF request. |
| 166 | * |
| 167 | * @param port the port, null to return all the attenuation ports |
| 168 | * @return filter string |
| 169 | */ |
| 170 | private String getPortAttenuationFilter(PortNumber port) { |
| 171 | StringBuilder filter = new StringBuilder(xmlOpen(KEY_VOA_XMLNS)) |
| 172 | .append(xmlOpen(KEY_PORT)) |
| 173 | .append(xmlOpen(KEY_PORTID)); |
| 174 | if (port != null) { |
| 175 | filter.append(port.toLong()); |
| 176 | } |
| 177 | return filter.append(xmlClose(KEY_PORTID)) |
| 178 | .append(xmlOpen(KEY_ATTEN_LEVEL)) |
| 179 | .append(xmlClose(KEY_ATTEN_LEVEL)) |
| 180 | .append(xmlClose(KEY_PORT)) |
| 181 | .append(xmlClose(KEY_VOA)) |
| 182 | .toString(); |
| 183 | } |
| 184 | |
| 185 | private Long acquirePortAttenuation(PortNumber port) { |
| 186 | String filter = getPortAttenuationFilter(port); |
| 187 | String reply = netconfGet(handler(), filter); |
| 188 | HierarchicalConfiguration info = configAt(reply, KEY_DATA_VOA_PORT); |
| 189 | if (info == null) { |
| 190 | return null; |
| 191 | } |
| 192 | long attenuation = 0; |
| 193 | try { |
| 194 | attenuation = (long) (info.getDouble(KEY_ATTEN_LEVEL) * VOA_MULTIPLIER); |
| 195 | } catch (NoSuchElementException e) { |
| 196 | log.debug("Could not find atten-level for port {}", port); |
| 197 | } |
| 198 | |
| 199 | return attenuation; |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 200 | } |
| 201 | |
| 202 | private Long acquireCurrentPower(PortNumber port, T component) { |
| 203 | if (component instanceof OchSignal) { |
| 204 | log.warn("Channel power is not applicable."); |
| 205 | return null; |
| 206 | } |
| 207 | log.debug("Get port{} current power...", port); |
| 208 | return acquirePortPower(port); |
| 209 | } |
| 210 | |
| 211 | private Long acquirePortPower(PortNumber port) { |
| 212 | String filter = getPortPowerFilter(port); |
| 213 | String reply = netconfGet(handler(), filter); |
| 214 | HierarchicalConfiguration info = configAt(reply, KEY_DATA_OPM_PORT); |
| 215 | if (info == null) { |
| 216 | return null; |
| 217 | } |
| 218 | return (long) (info.getDouble(KEY_POWER) * POWER_MULTIPLIER); |
| 219 | } |
| 220 | |
| 221 | private boolean setPortTargetPower(PortNumber port, long power) { |
| 222 | log.debug("Set port{} target power...", port); |
Laszlo Papp | 8b87a19 | 2017-10-19 18:47:12 +0100 | [diff] [blame] | 223 | String cfg = new StringBuilder(xmlOpen(KEY_VOA_XMLNS)) |
| 224 | .append(xmlOpen(KEY_PORT)) |
| 225 | .append(xml(KEY_PORTID, Long.toString(port.toLong()))) |
| 226 | .append(xml(KEY_ATTEN_MODE, VALUE_ATTEN_MODE)) |
Laszlo Papp | da059e7 | 2017-10-23 11:39:31 +0100 | [diff] [blame] | 227 | .append(xml(KEY_ATTEN_LEVEL, Double.toString((double) power / VOA_MULTIPLIER))) |
Laszlo Papp | 8b87a19 | 2017-10-19 18:47:12 +0100 | [diff] [blame] | 228 | .append(xmlClose(KEY_PORT)) |
Laszlo Papp | da059e7 | 2017-10-23 11:39:31 +0100 | [diff] [blame] | 229 | .append(xmlClose(KEY_VOA)) |
Laszlo Papp | 8b87a19 | 2017-10-19 18:47:12 +0100 | [diff] [blame] | 230 | .toString(); |
| 231 | return netconfEditConfig(handler(), CFG_MODE_MERGE, cfg); |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 232 | } |
| 233 | |
| 234 | private Range<Long> getPowerRange() { |
| 235 | return POWER_RANGE; |
| 236 | } |
| 237 | |
| 238 | private Range<Long> getTxPowerRange(PortNumber port, T component) { |
| 239 | if (component instanceof Direction) { |
| 240 | log.debug("Get target port{} power range...", port); |
| 241 | return getPowerRange(); |
| 242 | } else { |
Laszlo Papp | 8b3a5f6 | 2017-10-05 13:32:00 +0100 | [diff] [blame] | 243 | log.warn("Channel power is not applicable."); |
| 244 | return null; |
| 245 | } |
| 246 | } |
| 247 | |
| 248 | private Range<Long> getRxPowerRange(PortNumber port, T component) { |
| 249 | log.debug("Get input port{} power range...", port); |
| 250 | return getPowerRange(); |
| 251 | } |
| 252 | } |