openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/statistics/services/MeterFeaturesService.java

   1 /**
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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 package org.opendaylight.openflowplugin.impl.statistics.services;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.base.Preconditions;
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import java.util.concurrent.atomic.AtomicLong;
  15 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  16 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  17 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  18 import org.opendaylight.openflowplugin.impl.services.util.RequestInputUtils;
  19 import org.opendaylight.openflowplugin.impl.services.util.ServiceException;
  20 import org.opendaylight.openflowplugin.impl.statistics.services.compatibility.AbstractCompatibleStatService;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.GetMeterFeaturesInput;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.GetMeterFeaturesOutput;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.GetMeterFeaturesOutputBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.MeterFeaturesUpdated;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.MeterFeaturesUpdatedBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterBand;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterBandDrop;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterBandDscpRemark;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterBurst;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterCapability;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterKbps;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterPktps;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterStats;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterBandTypeBitmap;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterFlags;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInputBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterFeaturesCase;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.features._case.MultipartReplyMeterFeatures;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestMeterFeaturesCase;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestMeterFeaturesCaseBuilder;
  46
  47 final class MeterFeaturesService
  48         extends AbstractCompatibleStatService<GetMeterFeaturesInput, GetMeterFeaturesOutput, MeterFeaturesUpdated> {
  49     private static final MultipartRequestMeterFeaturesCase METER_FEATURES_CASE =
  50             new MultipartRequestMeterFeaturesCaseBuilder().build();
  51
  52     MeterFeaturesService(RequestContextStack requestContextStack,
  53                                 DeviceContext deviceContext,
  54                                 AtomicLong compatibilityXidSeed) {
  55         super(requestContextStack, deviceContext, compatibilityXidSeed);
  56     }
  57
  58     @Override
  59     protected OfHeader buildRequest(final Xid xid, final GetMeterFeaturesInput input) throws ServiceException {
  60         MultipartRequestInputBuilder mprInput =
  61                 RequestInputUtils.createMultipartHeader(MultipartType.OFPMPMETERFEATURES, xid.getValue(), getVersion());
  62         mprInput.setMultipartRequestBody(METER_FEATURES_CASE);
  63         return mprInput.build();
  64     }
  65
  66     @Override
  67     public GetMeterFeaturesOutput buildTxCapableResult(TransactionId emulatedTxId) {
  68         return new GetMeterFeaturesOutputBuilder().setTransactionId(emulatedTxId).build();
  69     }
  70
  71     @Override
  72     public MeterFeaturesUpdated transformToNotification(List<MultipartReply> result, TransactionId emulatedTxId) {
  73         final int mpSize = result.size();
  74         Preconditions.checkArgument(mpSize == 1, "unexpected (!=1) mp-reply size received: {}", mpSize);
  75
  76         MeterFeaturesUpdatedBuilder notification = new MeterFeaturesUpdatedBuilder();
  77         notification.setId(getDeviceInfo().getNodeId());
  78         notification.setMoreReplies(Boolean.FALSE);
  79         notification.setTransactionId(emulatedTxId);
  80
  81         MultipartReplyMeterFeaturesCase caseBody =
  82                 (MultipartReplyMeterFeaturesCase) result.get(0).getMultipartReplyBody();
  83         MultipartReplyMeterFeatures replyBody = caseBody.getMultipartReplyMeterFeatures();
  84         notification.setMaxBands(replyBody.getMaxBands());
  85         notification.setMaxColor(replyBody.getMaxColor());
  86         notification.setMaxMeter(new Counter32(replyBody.getMaxMeter()));
  87         notification.setMeterCapabilitiesSupported(extractMeterCapabilities(replyBody.getCapabilities()));
  88         notification.setMeterBandSupported(extractSupportedMeterBand(replyBody, replyBody.getBandTypes()));
  89
  90         return notification.build();
  91     }
  92
  93     @VisibleForTesting
  94     protected List<Class<? extends MeterBand>> extractSupportedMeterBand(MultipartReplyMeterFeatures replyBody,
  95                                                                          MeterBandTypeBitmap bandTypes) {
  96         List<Class<? extends MeterBand>> supportedMeterBand = new ArrayList<>();
  97         if (bandTypes.isOFPMBTDROP()) {
  98             supportedMeterBand.add(MeterBandDrop.class);
  99         }
 100         if (replyBody.getBandTypes().isOFPMBTDSCPREMARK()) {
 101             supportedMeterBand.add(MeterBandDscpRemark.class);
 102         }
 103         return supportedMeterBand;
 104     }
 105
 106     @VisibleForTesting
 107     protected static List<Class<? extends MeterCapability>> extractMeterCapabilities(MeterFlags capabilities) {
 108         List<Class<? extends MeterCapability>> supportedCapabilities = new ArrayList<>();
 109
 110         if (capabilities.isOFPMFBURST()) {
 111             supportedCapabilities.add(MeterBurst.class);
 112         }
 113         if (capabilities.isOFPMFKBPS()) {
 114             supportedCapabilities.add(MeterKbps.class);
 115         }
 116         if (capabilities.isOFPMFPKTPS()) {
 117             supportedCapabilities.add(MeterPktps.class);
 118         }
 119         if (capabilities.isOFPMFSTATS()) {
 120             supportedCapabilities.add(MeterStats.class);
 121         }
 122         return supportedCapabilities;
 123     }
 124 }