openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/serialization/factories/MeterModInputMessageFactory.java

   1 /*
   2  * Copyright (c) 2013 Pantheon Technologies s.r.o. 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.openflowjava.protocol.impl.serialization.factories;
  10
  11 import io.netty.buffer.ByteBuf;
  12
  13 import java.util.List;
  14
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.OFSerializer;
  16 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;
  17 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistryInjector;
  18 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  19 import org.opendaylight.openflowjava.util.ByteBufUtils;
  20 import org.opendaylight.openflowjava.util.ExperimenterSerializerKeyFactory;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.ExperimenterIdMeterBand;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterFlags;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MeterBandCommons;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MeterModInput;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.MeterBand;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandDropCase;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandDscpRemarkCase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCase;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.drop._case.MeterBandDrop;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.dscp.remark._case.MeterBandDscpRemark;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.experimenter._case.MeterBandExperimenter;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.mod.Bands;
  33
  34 /**
  35  * Translates MeterMod messages
  36  * @author timotej.kubas
  37  * @author michal.polkorab
  38  */
  39 public class MeterModInputMessageFactory implements OFSerializer<MeterModInput>,
  40         SerializerRegistryInjector {
  41
  42     private static final byte MESSAGE_TYPE = 29;
  43     private static final short LENGTH_OF_METER_BANDS = 16;
  44     private static final short PADDING_IN_METER_BAND_DROP = 4;
  45     private static final short PADDING_IN_METER_BAND_DSCP_REMARK = 3;
  46     private SerializerRegistry registry;
  47
  48     @Override
  49     public void serialize(final MeterModInput message, final ByteBuf outBuffer) {
  50         ByteBufUtils.writeOFHeader(MESSAGE_TYPE, message, outBuffer, EncodeConstants.EMPTY_LENGTH);
  51         outBuffer.writeShort(message.getCommand().getIntValue());
  52         outBuffer.writeShort(createMeterFlagsBitmask(message.getFlags()));
  53         outBuffer.writeInt(message.getMeterId().getValue().intValue());
  54         serializeBands(message.getBands(), outBuffer);
  55         ByteBufUtils.updateOFHeaderLength(outBuffer);
  56     }
  57
  58     private static int createMeterFlagsBitmask(final MeterFlags flags) {
  59         return ByteBufUtils.fillBitMask(0,
  60                 flags.isOFPMFKBPS(),
  61                 flags.isOFPMFPKTPS(),
  62                 flags.isOFPMFBURST(),
  63                 flags.isOFPMFSTATS());
  64     }
  65
  66     private void serializeBands(final List<Bands> bands, final ByteBuf outBuffer) {
  67         if (bands != null) {
  68             for (Bands currentBand : bands) {
  69                 MeterBand meterBand = currentBand.getMeterBand();
  70                 if (meterBand instanceof MeterBandDropCase) {
  71                     MeterBandDropCase dropBandCase = (MeterBandDropCase) meterBand;
  72                     MeterBandDrop dropBand = dropBandCase.getMeterBandDrop();
  73                     writeBandCommonFields(dropBand, outBuffer);
  74                     outBuffer.writeZero(PADDING_IN_METER_BAND_DROP);
  75                 } else if (meterBand instanceof MeterBandDscpRemarkCase) {
  76                     MeterBandDscpRemarkCase dscpRemarkBandCase = (MeterBandDscpRemarkCase) meterBand;
  77                     MeterBandDscpRemark dscpRemarkBand = dscpRemarkBandCase.getMeterBandDscpRemark();
  78                     writeBandCommonFields(dscpRemarkBand, outBuffer);
  79                     outBuffer.writeByte(dscpRemarkBand.getPrecLevel());
  80                     outBuffer.writeZero(PADDING_IN_METER_BAND_DSCP_REMARK);
  81                 } else if (meterBand instanceof MeterBandExperimenterCase) {
  82                     MeterBandExperimenterCase experimenterBandCase = (MeterBandExperimenterCase) meterBand;
  83                     MeterBandExperimenter experimenterBand = experimenterBandCase.getMeterBandExperimenter();
  84                     long expId = experimenterBand.getAugmentation(ExperimenterIdMeterBand.class)
  85                             .getExperimenter().getValue();
  86                     OFSerializer<MeterBandExperimenterCase> serializer = registry.getSerializer(
  87                             ExperimenterSerializerKeyFactory.createMeterBandSerializerKey(
  88                                     EncodeConstants.OF13_VERSION_ID, expId));
  89                     serializer.serialize(experimenterBandCase, outBuffer);
  90                 }
  91             }
  92         }
  93     }
  94
  95     private static void writeBandCommonFields(final MeterBandCommons meterBand, final ByteBuf outBuffer) {
  96         outBuffer.writeShort(meterBand.getType().getIntValue());
  97         outBuffer.writeShort(LENGTH_OF_METER_BANDS);
  98         outBuffer.writeInt(meterBand.getRate().intValue());
  99         outBuffer.writeInt(meterBand.getBurstSize().intValue());
 100     }
 101
 102     @Override
 103     public void injectSerializerRegistry(final SerializerRegistry serializerRegistry) {
 104         registry = serializerRegistry;
 105     }
 106 }