alshabib | e27055b | 2015-07-09 21:43:10 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 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.provider.of.meter.impl; |
| 18 | |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 19 | |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 20 | import com.google.common.cache.Cache; |
| 21 | import com.google.common.cache.CacheBuilder; |
| 22 | import com.google.common.cache.RemovalCause; |
| 23 | import com.google.common.cache.RemovalNotification; |
| 24 | import com.google.common.collect.Maps; |
| 25 | import org.apache.felix.scr.annotations.Activate; |
alshabib | e27055b | 2015-07-09 21:43:10 -0700 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Component; |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 27 | import org.apache.felix.scr.annotations.Deactivate; |
alshabib | e27055b | 2015-07-09 21:43:10 -0700 | [diff] [blame] | 28 | import org.apache.felix.scr.annotations.Reference; |
| 29 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 30 | import org.onosproject.core.CoreService; |
| 31 | import org.onosproject.incubator.net.meter.Band; |
| 32 | import org.onosproject.incubator.net.meter.DefaultBand; |
| 33 | import org.onosproject.incubator.net.meter.DefaultMeter; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 34 | import org.onosproject.incubator.net.meter.Meter; |
| 35 | import org.onosproject.incubator.net.meter.MeterFailReason; |
| 36 | import org.onosproject.incubator.net.meter.MeterOperation; |
| 37 | import org.onosproject.incubator.net.meter.MeterOperations; |
| 38 | import org.onosproject.incubator.net.meter.MeterProvider; |
| 39 | import org.onosproject.incubator.net.meter.MeterProviderRegistry; |
| 40 | import org.onosproject.incubator.net.meter.MeterProviderService; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 41 | import org.onosproject.incubator.net.meter.MeterState; |
| 42 | import org.onosproject.net.DeviceId; |
alshabib | e27055b | 2015-07-09 21:43:10 -0700 | [diff] [blame] | 43 | import org.onosproject.net.provider.AbstractProvider; |
| 44 | import org.onosproject.net.provider.ProviderId; |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 45 | import org.onosproject.openflow.controller.Dpid; |
alshabib | e27055b | 2015-07-09 21:43:10 -0700 | [diff] [blame] | 46 | import org.onosproject.openflow.controller.OpenFlowController; |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 47 | import org.onosproject.openflow.controller.OpenFlowEventListener; |
| 48 | import org.onosproject.openflow.controller.OpenFlowSwitch; |
| 49 | import org.onosproject.openflow.controller.OpenFlowSwitchListener; |
| 50 | import org.onosproject.openflow.controller.RoleState; |
| 51 | import org.projectfloodlight.openflow.protocol.OFErrorMsg; |
| 52 | import org.projectfloodlight.openflow.protocol.OFErrorType; |
| 53 | import org.projectfloodlight.openflow.protocol.OFMessage; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 54 | import org.projectfloodlight.openflow.protocol.OFMeterBandStats; |
| 55 | import org.projectfloodlight.openflow.protocol.OFMeterConfigStatsReply; |
| 56 | import org.projectfloodlight.openflow.protocol.OFMeterStats; |
| 57 | import org.projectfloodlight.openflow.protocol.OFMeterStatsReply; |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 58 | import org.projectfloodlight.openflow.protocol.OFPortStatus; |
| 59 | import org.projectfloodlight.openflow.protocol.OFStatsReply; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 60 | import org.projectfloodlight.openflow.protocol.OFStatsType; |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 61 | import org.projectfloodlight.openflow.protocol.OFVersion; |
| 62 | import org.projectfloodlight.openflow.protocol.errormsg.OFMeterModFailedErrorMsg; |
alshabib | e27055b | 2015-07-09 21:43:10 -0700 | [diff] [blame] | 63 | import org.slf4j.Logger; |
| 64 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 65 | import java.util.Collection; |
| 66 | import java.util.List; |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 67 | import java.util.Map; |
| 68 | import java.util.concurrent.TimeUnit; |
| 69 | import java.util.concurrent.atomic.AtomicLong; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 70 | import java.util.stream.Collectors; |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 71 | |
alshabib | e27055b | 2015-07-09 21:43:10 -0700 | [diff] [blame] | 72 | import static org.slf4j.LoggerFactory.getLogger; |
| 73 | |
| 74 | /** |
| 75 | * Provider which uses an OpenFlow controller to handle meters. |
| 76 | */ |
Thomas Vachuska | c87348d | 2015-07-31 12:33:50 -0700 | [diff] [blame] | 77 | @Component(immediate = true, enabled = false) |
alshabib | e27055b | 2015-07-09 21:43:10 -0700 | [diff] [blame] | 78 | public class OpenFlowMeterProvider extends AbstractProvider implements MeterProvider { |
| 79 | |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 80 | |
alshabib | e27055b | 2015-07-09 21:43:10 -0700 | [diff] [blame] | 81 | private final Logger log = getLogger(getClass()); |
| 82 | |
| 83 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 84 | protected OpenFlowController controller; |
| 85 | |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 86 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 87 | protected MeterProviderRegistry providerRegistry; |
| 88 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 89 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 90 | protected CoreService coreService; |
| 91 | |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 92 | private MeterProviderService providerService; |
| 93 | |
| 94 | private static final AtomicLong XID_COUNTER = new AtomicLong(1); |
| 95 | |
| 96 | static final int POLL_INTERVAL = 10; |
| 97 | static final long TIMEOUT = 30; |
| 98 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 99 | private Cache<Long, MeterOperation> pendingOperations; |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 100 | |
| 101 | |
| 102 | private InternalMeterListener listener = new InternalMeterListener(); |
| 103 | private Map<Dpid, MeterStatsCollector> collectors = Maps.newHashMap(); |
alshabib | e27055b | 2015-07-09 21:43:10 -0700 | [diff] [blame] | 104 | |
| 105 | /** |
| 106 | * Creates a OpenFlow meter provider. |
| 107 | */ |
| 108 | public OpenFlowMeterProvider() { |
| 109 | super(new ProviderId("of", "org.onosproject.provider.meter")); |
| 110 | } |
alshabib | bc37196 | 2015-07-09 22:26:21 -0700 | [diff] [blame] | 111 | |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 112 | @Activate |
| 113 | public void activate() { |
| 114 | providerService = providerRegistry.register(this); |
| 115 | |
| 116 | pendingOperations = CacheBuilder.newBuilder() |
| 117 | .expireAfterWrite(TIMEOUT, TimeUnit.SECONDS) |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 118 | .removalListener((RemovalNotification<Long, MeterOperation> notification) -> { |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 119 | if (notification.getCause() == RemovalCause.EXPIRED) { |
| 120 | providerService.meterOperationFailed(notification.getValue(), |
| 121 | MeterFailReason.TIMEOUT); |
| 122 | } |
| 123 | }).build(); |
| 124 | |
| 125 | controller.addEventListener(listener); |
| 126 | controller.addListener(listener); |
| 127 | |
| 128 | controller.getSwitches().forEach((sw -> createStatsCollection(sw))); |
| 129 | } |
| 130 | |
| 131 | @Deactivate |
| 132 | public void deactivate() { |
| 133 | providerRegistry.unregister(this); |
| 134 | controller.removeEventListener(listener); |
| 135 | controller.removeListener(listener); |
| 136 | providerService = null; |
| 137 | } |
| 138 | |
alshabib | bc37196 | 2015-07-09 22:26:21 -0700 | [diff] [blame] | 139 | @Override |
| 140 | public void performMeterOperation(DeviceId deviceId, MeterOperations meterOps) { |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 141 | Dpid dpid = Dpid.dpid(deviceId.uri()); |
| 142 | OpenFlowSwitch sw = controller.getSwitch(dpid); |
| 143 | if (sw == null) { |
| 144 | log.error("Unknown device {}", deviceId); |
| 145 | meterOps.operations().forEach(op -> |
| 146 | providerService.meterOperationFailed(op, |
| 147 | MeterFailReason.UNKNOWN_DEVICE) |
| 148 | ); |
| 149 | return; |
| 150 | } |
alshabib | bc37196 | 2015-07-09 22:26:21 -0700 | [diff] [blame] | 151 | |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 152 | meterOps.operations().forEach(op -> performOperation(sw, op)); |
alshabib | bc37196 | 2015-07-09 22:26:21 -0700 | [diff] [blame] | 153 | } |
| 154 | |
| 155 | @Override |
| 156 | public void performMeterOperation(DeviceId deviceId, MeterOperation meterOp) { |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 157 | Dpid dpid = Dpid.dpid(deviceId.uri()); |
| 158 | OpenFlowSwitch sw = controller.getSwitch(dpid); |
| 159 | if (sw == null) { |
| 160 | log.error("Unknown device {}", deviceId); |
| 161 | providerService.meterOperationFailed(meterOp, |
| 162 | MeterFailReason.UNKNOWN_DEVICE); |
| 163 | return; |
| 164 | } |
alshabib | bc37196 | 2015-07-09 22:26:21 -0700 | [diff] [blame] | 165 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 166 | performOperation(sw, meterOp); |
| 167 | |
alshabib | bc37196 | 2015-07-09 22:26:21 -0700 | [diff] [blame] | 168 | } |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 169 | |
| 170 | private void performOperation(OpenFlowSwitch sw, MeterOperation op) { |
| 171 | |
| 172 | pendingOperations.put(op.meter().id().id(), op); |
| 173 | |
| 174 | |
| 175 | Meter meter = op.meter(); |
| 176 | MeterModBuilder builder = MeterModBuilder.builder(meter.id().id(), sw.factory()); |
| 177 | if (meter.isBurst()) { |
| 178 | builder.burst(); |
| 179 | } |
| 180 | builder.withBands(meter.bands()) |
| 181 | .withId(meter.id()) |
| 182 | .withRateUnit(meter.unit()); |
| 183 | |
| 184 | switch (op.type()) { |
| 185 | case ADD: |
| 186 | sw.sendMsg(builder.add()); |
| 187 | break; |
| 188 | case REMOVE: |
| 189 | sw.sendMsg(builder.remove()); |
| 190 | break; |
| 191 | case MODIFY: |
| 192 | sw.sendMsg(builder.modify()); |
| 193 | break; |
| 194 | default: |
| 195 | log.warn("Unknown Meter command {}; not sending anything", |
| 196 | op.type()); |
| 197 | providerService.meterOperationFailed(op, |
| 198 | MeterFailReason.UNKNOWN_COMMAND); |
| 199 | } |
| 200 | |
| 201 | } |
| 202 | |
| 203 | private void createStatsCollection(OpenFlowSwitch sw) { |
| 204 | if (isMeterSupported(sw)) { |
| 205 | MeterStatsCollector msc = new MeterStatsCollector(sw, POLL_INTERVAL); |
| 206 | msc.start(); |
| 207 | collectors.put(new Dpid(sw.getId()), msc); |
| 208 | } |
| 209 | } |
| 210 | |
| 211 | private boolean isMeterSupported(OpenFlowSwitch sw) { |
| 212 | if (sw.factory().getVersion() == OFVersion.OF_10 || |
| 213 | sw.factory().getVersion() == OFVersion.OF_11 || |
| 214 | sw.factory().getVersion() == OFVersion.OF_12) { |
| 215 | return false; |
| 216 | } |
| 217 | |
| 218 | return true; |
| 219 | } |
| 220 | |
| 221 | private void pushMeterStats(Dpid dpid, OFStatsReply msg) { |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 222 | DeviceId deviceId = DeviceId.deviceId(Dpid.uri(dpid)); |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 223 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 224 | if (msg.getStatsType() == OFStatsType.METER) { |
| 225 | OFMeterStatsReply reply = (OFMeterStatsReply) msg; |
| 226 | Collection<Meter> meters = buildMeters(deviceId, reply.getEntries()); |
| 227 | //TODO do meter accounting here. |
| 228 | providerService.pushMeterMetrics(deviceId, meters); |
| 229 | } else if (msg.getStatsType() == OFStatsType.METER_CONFIG) { |
| 230 | OFMeterConfigStatsReply reply = (OFMeterConfigStatsReply) msg; |
| 231 | // FIXME: Map<Long, Meter> meters = collectMeters(deviceId, reply); |
| 232 | } |
| 233 | |
| 234 | } |
| 235 | |
| 236 | private Map<Long, Meter> collectMeters(DeviceId deviceId, |
| 237 | OFMeterConfigStatsReply reply) { |
| 238 | return Maps.newHashMap(); |
| 239 | //TODO: Needs a fix to be applied to loxi MeterConfig stat is incorrect |
| 240 | } |
| 241 | |
| 242 | private Collection<Meter> buildMeters(DeviceId deviceId, |
| 243 | List<OFMeterStats> entries) { |
| 244 | return entries.stream().map(stat -> { |
| 245 | DefaultMeter.Builder builder = DefaultMeter.builder(); |
| 246 | Collection<Band> bands = buildBands(stat.getBandStats()); |
| 247 | builder.forDevice(deviceId) |
| 248 | .withId(stat.getMeterId()) |
| 249 | //FIXME: need to encode appId in meter id, but that makes |
| 250 | // things a little annoying for debugging |
| 251 | .fromApp(coreService.getAppId("org.onosproject.core")) |
| 252 | .withBands(bands); |
| 253 | DefaultMeter meter = builder.build(); |
| 254 | meter.setState(MeterState.ADDED); |
| 255 | meter.setLife(stat.getDurationSec()); |
| 256 | meter.setProcessedBytes(stat.getByteInCount().getValue()); |
| 257 | meter.setProcessedPackets(stat.getPacketInCount().getValue()); |
| 258 | meter.setReferenceCount(stat.getFlowCount()); |
| 259 | |
| 260 | // marks the meter as seen on the dataplane |
| 261 | pendingOperations.invalidate(stat.getMeterId()); |
| 262 | return meter; |
| 263 | }).collect(Collectors.toSet()); |
| 264 | } |
| 265 | |
| 266 | private Collection<Band> buildBands(List<OFMeterBandStats> bandStats) { |
| 267 | return bandStats.stream().map(stat -> { |
| 268 | DefaultBand band = DefaultBand.builder().build(); |
| 269 | band.setBytes(stat.getByteBandCount().getValue()); |
| 270 | band.setPackets(stat.getPacketBandCount().getValue()); |
| 271 | return band; |
| 272 | }).collect(Collectors.toSet()); |
alshabib | c791179 | 2015-07-30 17:55:30 -0700 | [diff] [blame] | 273 | } |
| 274 | |
| 275 | private void signalMeterError(OFMeterModFailedErrorMsg meterError, |
| 276 | MeterOperation op) { |
| 277 | switch (meterError.getCode()) { |
| 278 | case UNKNOWN: |
| 279 | providerService.meterOperationFailed(op, |
| 280 | MeterFailReason.UNKNOWN_DEVICE); |
| 281 | break; |
| 282 | case METER_EXISTS: |
| 283 | providerService.meterOperationFailed(op, |
| 284 | MeterFailReason.EXISTING_METER); |
| 285 | break; |
| 286 | case INVALID_METER: |
| 287 | providerService.meterOperationFailed(op, |
| 288 | MeterFailReason.INVALID_METER); |
| 289 | break; |
| 290 | case UNKNOWN_METER: |
| 291 | providerService.meterOperationFailed(op, |
| 292 | MeterFailReason.UNKNOWN); |
| 293 | break; |
| 294 | case BAD_COMMAND: |
| 295 | providerService.meterOperationFailed(op, |
| 296 | MeterFailReason.UNKNOWN_COMMAND); |
| 297 | break; |
| 298 | case BAD_FLAGS: |
| 299 | providerService.meterOperationFailed(op, |
| 300 | MeterFailReason.UNKNOWN_FLAGS); |
| 301 | break; |
| 302 | case BAD_RATE: |
| 303 | providerService.meterOperationFailed(op, |
| 304 | MeterFailReason.BAD_RATE); |
| 305 | break; |
| 306 | case BAD_BURST: |
| 307 | providerService.meterOperationFailed(op, |
| 308 | MeterFailReason.BAD_BURST); |
| 309 | break; |
| 310 | case BAD_BAND: |
| 311 | providerService.meterOperationFailed(op, |
| 312 | MeterFailReason.BAD_BAND); |
| 313 | break; |
| 314 | case BAD_BAND_VALUE: |
| 315 | providerService.meterOperationFailed(op, |
| 316 | MeterFailReason.BAD_BAND_VALUE); |
| 317 | break; |
| 318 | case OUT_OF_METERS: |
| 319 | providerService.meterOperationFailed(op, |
| 320 | MeterFailReason.OUT_OF_METERS); |
| 321 | break; |
| 322 | case OUT_OF_BANDS: |
| 323 | providerService.meterOperationFailed(op, |
| 324 | MeterFailReason.OUT_OF_BANDS); |
| 325 | break; |
| 326 | default: |
| 327 | providerService.meterOperationFailed(op, |
| 328 | MeterFailReason.UNKNOWN); |
| 329 | } |
| 330 | } |
| 331 | |
| 332 | private class InternalMeterListener |
| 333 | implements OpenFlowSwitchListener, OpenFlowEventListener { |
| 334 | @Override |
| 335 | public void handleMessage(Dpid dpid, OFMessage msg) { |
| 336 | switch (msg.getType()) { |
| 337 | case STATS_REPLY: |
| 338 | pushMeterStats(dpid, (OFStatsReply) msg); |
| 339 | break; |
| 340 | case ERROR: |
| 341 | OFErrorMsg error = (OFErrorMsg) msg; |
| 342 | if (error.getErrType() == OFErrorType.METER_MOD_FAILED) { |
| 343 | MeterOperation op = |
| 344 | pendingOperations.getIfPresent(error.getXid()); |
| 345 | pendingOperations.invalidate(error.getXid()); |
| 346 | if (op == null) { |
| 347 | log.warn("Unknown Meter operation failed {}", error); |
| 348 | } else { |
| 349 | OFMeterModFailedErrorMsg meterError = |
| 350 | (OFMeterModFailedErrorMsg) error; |
| 351 | signalMeterError(meterError, op); |
| 352 | } |
| 353 | } |
| 354 | break; |
| 355 | default: |
| 356 | break; |
| 357 | } |
| 358 | |
| 359 | } |
| 360 | |
| 361 | @Override |
| 362 | public void switchAdded(Dpid dpid) { |
| 363 | createStatsCollection(controller.getSwitch(dpid)); |
| 364 | } |
| 365 | |
| 366 | @Override |
| 367 | public void switchRemoved(Dpid dpid) { |
| 368 | MeterStatsCollector msc = collectors.remove(dpid); |
| 369 | if (msc != null) { |
| 370 | msc.stop(); |
| 371 | } |
| 372 | } |
| 373 | |
| 374 | @Override |
| 375 | public void switchChanged(Dpid dpid) { |
| 376 | |
| 377 | } |
| 378 | |
| 379 | @Override |
| 380 | public void portChanged(Dpid dpid, OFPortStatus status) { |
| 381 | |
| 382 | } |
| 383 | |
| 384 | @Override |
| 385 | public void receivedRoleReply(Dpid dpid, RoleState requested, RoleState response) { |
| 386 | |
| 387 | } |
| 388 | } |
| 389 | |
| 390 | |
| 391 | |
alshabib | e27055b | 2015-07-09 21:43:10 -0700 | [diff] [blame] | 392 | } |