openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/MeterConvertor.java

   1 /*
   2  * Copyright (c) 2014 Ericsson India Global Services Pvt Ltd. 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
   9 package org.opendaylight.openflowplugin.openflow.md.core.sal.convertor;
  10
  11 import java.util.ArrayList;
  12 import java.util.Arrays;
  13 import java.util.Collection;
  14 import java.util.List;
  15 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common.Convertor;
  16 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.data.VersionConvertorData;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.AddMeterInput;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.RemoveMeterInput;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.UpdatedMeter;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.Meter;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.Drop;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.DscpRemark;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.Experimenter;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.MeterBandHeaders;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers.MeterBandHeader;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.ExperimenterIdMeterBand;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.ExperimenterIdMeterBandBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.ExperimenterId;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterBandType;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterFlags;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterId;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterModCommand;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MeterModInputBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.MeterBand;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandDropCaseBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandDscpRemarkCaseBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCaseBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.drop._case.MeterBandDropBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.dscp.remark._case.MeterBandDscpRemarkBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.experimenter._case.MeterBandExperimenterBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.mod.Bands;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.mod.BandsBuilder;
  43 import org.opendaylight.yangtools.yang.binding.DataContainer;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 /**
  48  * Converts a MD-SAL meter mod command into the OF library meter mod command.
  49  * <p>
  50  * Example usage:
  51  * <pre>
  52  * {@code
  53  * VersionConvertorData data = new VersionConvertorData(version);
  54  * Optional<MeterModInputBuilder> ofMeter = convertorManager.convert(salMeter, data);
  55  * }
  56  * </pre>
  57  */
  58 public class MeterConvertor extends Convertor<Meter, MeterModInputBuilder, VersionConvertorData> {
  59     private static final Logger LOG = LoggerFactory.getLogger(MeterConvertor.class);
  60     private static final List<Class<?>> TYPES = Arrays.asList(Meter.class, AddMeterInput.class, RemoveMeterInput.class, UpdatedMeter.class);
  61
  62     /**
  63      * Create default empty meter mot input builder.
  64      * Use this method, if result from convertor is empty.
  65      *
  66      * @param version Openflow version
  67      * @return default empty meter mod input builder
  68      */
  69     public static MeterModInputBuilder defaultResult(short version) {
  70         return new MeterModInputBuilder()
  71                 .setVersion(version)
  72                 .setFlags(new MeterFlags(false, false, true, false));
  73     }
  74
  75     private static void getBandsFromSAL(MeterBandHeaders meterBandHeaders, List<Bands> bands) {
  76         for (MeterBandHeader meterBandHeader : meterBandHeaders.getMeterBandHeader()) {
  77             // The band types :drop,DSCP_Remark or experimenter.
  78             if (null != meterBandHeader.getMeterBandTypes() &&
  79                     null != meterBandHeader.getMeterBandTypes().getFlags()) {
  80
  81                 if (meterBandHeader.getMeterBandTypes().getFlags().isOfpmbtDrop()) {
  82                     if (meterBandHeader.getBandType() != null) {
  83                         MeterBandDropCaseBuilder dropCaseBuilder = new MeterBandDropCaseBuilder();
  84                         MeterBandDropBuilder meterBandDropBuilder = new MeterBandDropBuilder();
  85                         meterBandDropBuilder.setType(MeterBandType.OFPMBTDROP);
  86                         Drop drop = (Drop) meterBandHeader.getBandType();
  87                         meterBandDropBuilder.setBurstSize(drop.getDropBurstSize());
  88                         meterBandDropBuilder.setRate(drop.getDropRate());
  89                         dropCaseBuilder.setMeterBandDrop(meterBandDropBuilder.build());
  90                         MeterBand meterBandItem = dropCaseBuilder.build();
  91                         BandsBuilder bandsB = new BandsBuilder();
  92                         bandsB.setMeterBand(meterBandItem);
  93                         // Bands list
  94                         bands.add(bandsB.build());
  95                     } else {
  96                         logBandTypeMissing(MeterBandType.OFPMBTDROP);
  97                     }
  98                 } else if (meterBandHeader.getMeterBandTypes().getFlags().isOfpmbtDscpRemark()) {
  99                     if (meterBandHeader.getBandType() != null) {
 100                         MeterBandDscpRemarkCaseBuilder dscpCaseBuilder = new MeterBandDscpRemarkCaseBuilder();
 101                         MeterBandDscpRemarkBuilder meterBandDscpRemarkBuilder = new MeterBandDscpRemarkBuilder();
 102                         meterBandDscpRemarkBuilder.setType(MeterBandType.OFPMBTDSCPREMARK);
 103                         DscpRemark dscpRemark = (DscpRemark) meterBandHeader.getBandType();
 104                         meterBandDscpRemarkBuilder.setBurstSize(dscpRemark.getDscpRemarkBurstSize());
 105                         meterBandDscpRemarkBuilder.setRate(dscpRemark.getDscpRemarkRate());
 106                         meterBandDscpRemarkBuilder.setPrecLevel(dscpRemark.getPrecLevel());
 107                         dscpCaseBuilder.setMeterBandDscpRemark(meterBandDscpRemarkBuilder.build());
 108                         MeterBand meterBandItem = dscpCaseBuilder.build();
 109                         BandsBuilder bandsB = new BandsBuilder();
 110                         bandsB.setMeterBand(meterBandItem);
 111                         // Bands list
 112                         bands.add(bandsB.build());
 113                     } else {
 114                         logBandTypeMissing(MeterBandType.OFPMBTDSCPREMARK);
 115                     }
 116                 } else if (meterBandHeader.getMeterBandTypes().getFlags().isOfpmbtExperimenter()) {
 117                     if (meterBandHeader.getBandType() != null) {
 118                         MeterBandExperimenterCaseBuilder experimenterCaseBuilder = new MeterBandExperimenterCaseBuilder();
 119                         MeterBandExperimenterBuilder meterBandExperimenterBuilder = new MeterBandExperimenterBuilder();
 120                         meterBandExperimenterBuilder.setType(MeterBandType.OFPMBTEXPERIMENTER);
 121                         Experimenter experimenter = (Experimenter) meterBandHeader.getBandType();
 122                         meterBandExperimenterBuilder.setBurstSize(experimenter.getExperimenterBurstSize());
 123                         meterBandExperimenterBuilder.setRate(experimenter.getExperimenterRate());
 124                         ExperimenterIdMeterBandBuilder expBuilder = new ExperimenterIdMeterBandBuilder();
 125                         expBuilder.setExperimenter(new ExperimenterId(experimenter.getExperimenter()));
 126                         meterBandExperimenterBuilder.addAugmentation(ExperimenterIdMeterBand.class, expBuilder.build());
 127                         // TODO - implement / finish experimenter meter band translation
 128                         experimenterCaseBuilder.setMeterBandExperimenter(meterBandExperimenterBuilder.build());
 129                         MeterBand meterBandItem = experimenterCaseBuilder.build();
 130                         BandsBuilder bandsB = new BandsBuilder();
 131                         bandsB.setMeterBand(meterBandItem);
 132                         // Bands list
 133                         bands.add(bandsB.build());
 134                     } else {
 135                         logBandTypeMissing(MeterBandType.OFPMBTEXPERIMENTER);
 136                     }
 137                 }
 138             } else {
 139                 LOG.error("Invalid meter band data found.");
 140             }
 141         }
 142
 143     }
 144
 145     private static void logBandTypeMissing(final MeterBandType meterBandType) {
 146         LOG.error("BandType: {} No Band Data found", meterBandType);
 147     }
 148
 149     @Override
 150     public Collection<Class<?>> getTypes() {
 151         return  TYPES;
 152     }
 153
 154     @Override
 155     public MeterModInputBuilder convert(Meter source, VersionConvertorData data) {
 156         MeterModInputBuilder meterModInputBuilder = new MeterModInputBuilder();
 157         List<Bands> bands = new ArrayList<>();
 158
 159         if (source instanceof AddMeterInput) {
 160             meterModInputBuilder.setCommand(MeterModCommand.OFPMCADD);
 161         } else if (source instanceof RemoveMeterInput) {
 162             meterModInputBuilder.setCommand(MeterModCommand.OFPMCDELETE);
 163         } else if (source instanceof UpdatedMeter) {
 164             meterModInputBuilder.setCommand(MeterModCommand.OFPMCMODIFY);
 165         }
 166
 167         meterModInputBuilder.setMeterId(new MeterId(source.getMeterId().getValue()));
 168
 169         if (null != source.getFlags()) {
 170             meterModInputBuilder.setFlags(new MeterFlags(source.getFlags().isMeterBurst(), source.getFlags()
 171                     .isMeterKbps(), source.getFlags().isMeterPktps(), source.getFlags().isMeterStats()));
 172         } else {
 173
 174             /*
 175              * As per 0F1.3.1,The rate field indicates the rate value above
 176              * which the corresponding band may apply to packets (see 5.7.1).
 177              * The rate value is in kilobit per seconds, unless the flags eld
 178              * includes OFPMF_PKTPS, in which case the rate is in packets per
 179              * seconds.
 180              */
 181
 182             meterModInputBuilder.setFlags(new MeterFlags(false, false, true, false));
 183         }
 184
 185         if (source.getMeterBandHeaders() != null) {
 186             getBandsFromSAL(source.getMeterBandHeaders(), bands);
 187             meterModInputBuilder.setBands(bands);
 188         } else {
 189             LOG.error("For this meter Id" + source.getMeterId().getValue() + ",no associated band data found!");
 190         }
 191
 192         meterModInputBuilder.setVersion(data.getVersion());
 193         return meterModInputBuilder;
 194     }
 195 }