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