openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/protocol/serialization/messages/MeterMessageSerializer.java

   1 /*
   2  * Copyright (c) 2016 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 package org.opendaylight.openflowplugin.impl.protocol.serialization.messages;
   9
  10 import com.google.common.base.MoreObjects;
  11 import io.netty.buffer.ByteBuf;
  12 import java.util.Optional;
  13 import org.opendaylight.openflowjava.protocol.api.extensibility.OFSerializer;
  14 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistryInjector;
  16 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdSerializerKey;
  17 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  18 import org.opendaylight.openflowjava.util.ByteBufUtils;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterFlags;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterMessage;
  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.openflow.common.types.rev130731.MeterBandType;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 /**
  30  * Translates MeterMod messages
  31  * OF protocol versions: 1.3.
  32  */
  33 public class MeterMessageSerializer extends AbstractMessageSerializer<MeterMessage> implements
  34         SerializerRegistryInjector {
  35     private static final Logger LOG = LoggerFactory.getLogger(MeterMessageSerializer.class);
  36     private static final short LENGTH_OF_METER_BANDS = 16;
  37     private static final short PADDING_IN_METER_BAND_DROP = 4;
  38     private static final short PADDING_IN_METER_BAND_DSCP_REMARK = 3;
  39
  40     private SerializerRegistry registry;
  41
  42     @Override
  43     public void serialize(final MeterMessage message, final ByteBuf outBuffer) {
  44         final int index = outBuffer.writerIndex();
  45         super.serialize(message, outBuffer);
  46         outBuffer.writeShort(message.getCommand().getIntValue());
  47         outBuffer.writeShort(createMeterFlagsBitMask(
  48                 MoreObjects.firstNonNull(message.getFlags(), new MeterFlags(false, false, true, false))));
  49         outBuffer.writeInt(message.getMeterId().getValue().intValue());
  50         serializeBands(message.getMeterBandHeaders(), outBuffer);
  51         outBuffer.setShort(index + 2, outBuffer.writerIndex() - index);
  52     }
  53
  54     @Override
  55     protected byte getMessageType() {
  56         return 29;
  57     }
  58
  59     private void serializeBands(final MeterBandHeaders meterBandHeaders, final ByteBuf outBuffer) {
  60         if (meterBandHeaders != null && meterBandHeaders.getMeterBandHeader() != null) {
  61             meterBandHeaders.getMeterBandHeader().forEach(meterBandHeader ->
  62                     Optional.ofNullable(meterBandHeader.getMeterBandTypes())
  63                             .flatMap(m -> Optional.ofNullable(m.getFlags()))
  64                             .ifPresent(flags -> Optional.ofNullable(meterBandHeader.getBandType()).ifPresent(type -> {
  65                                 if (flags.isOfpmbtDrop()) {
  66                                     final Drop band = (Drop) type;
  67                                     outBuffer.writeShort(MeterBandType.OFPMBTDROP.getIntValue());
  68
  69                                     outBuffer.writeShort(LENGTH_OF_METER_BANDS);
  70                                     outBuffer.writeInt(band.getDropRate().intValue());
  71                                     outBuffer.writeInt(band.getDropBurstSize().intValue());
  72                                     outBuffer.writeZero(PADDING_IN_METER_BAND_DROP);
  73                                 } else if (flags.isOfpmbtDscpRemark()) {
  74                                     final DscpRemark band = (DscpRemark) type;
  75                                     outBuffer.writeShort(MeterBandType.OFPMBTDSCPREMARK.getIntValue());
  76
  77                                     outBuffer.writeShort(LENGTH_OF_METER_BANDS);
  78                                     outBuffer.writeInt(band.getDscpRemarkRate().intValue());
  79                                     outBuffer.writeInt(band.getDscpRemarkBurstSize().intValue());
  80                                     outBuffer.writeByte(band.getPrecLevel().toJava());
  81                                     outBuffer.writeZero(PADDING_IN_METER_BAND_DSCP_REMARK);
  82                                 } else if (flags.isOfpmbtExperimenter()) {
  83                                     final Experimenter band = (Experimenter) type;
  84
  85                                     // TODO: finish experimenter serialization
  86                                     final ExperimenterIdSerializerKey<Experimenter> key =
  87                                             new ExperimenterIdSerializerKey<>(
  88                                                     EncodeConstants.OF13_VERSION_ID,
  89                                                     band.getExperimenter().toJava(),
  90                                                     (Class<Experimenter>) type.implementedInterface());
  91
  92                                     try {
  93                                         final OFSerializer<Experimenter> serializer = registry.getSerializer(key);
  94                                         serializer.serialize(band, outBuffer);
  95                                     } catch (final IllegalStateException e) {
  96                                         LOG.warn("Serializer for key: {} wasn't found", key, e);
  97                                     }
  98                                 }
  99                             })));
 100         }
 101     }
 102
 103     @Override
 104     public void injectSerializerRegistry(final SerializerRegistry serializerRegistry) {
 105         registry = serializerRegistry;
 106     }
 107
 108     private static int createMeterFlagsBitMask(final MeterFlags flags) {
 109         return ByteBufUtils.fillBitMask(0,
 110                 flags.isMeterKbps(),
 111                 flags.isMeterPktps(),
 112                 flags.isMeterBurst(),
 113                 flags.isMeterStats());
 114     }
 115 }