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 static java.util.Objects.requireNonNull;
  11
  12 import io.netty.buffer.ByteBuf;
  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.BandType;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.Drop;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.DscpRemark;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.Experimenter;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.MeterBandHeaders;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers.MeterBandHeader;
  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     private static final int DEFAULT_METER_FLAGS = createMeterFlagsBitMask(new MeterFlags(false, false, true, false));
  42
  43     private SerializerRegistry registry;
  44
  45     @Override
  46     public void serialize(final MeterMessage message, final ByteBuf outBuffer) {
  47         final int index = outBuffer.writerIndex();
  48         super.serialize(message, outBuffer);
  49         outBuffer.writeShort(message.getCommand().getIntValue());
  50
  51         final MeterFlags flags = message.getFlags();
  52         outBuffer.writeShort(flags != null ? createMeterFlagsBitMask(flags) : DEFAULT_METER_FLAGS);
  53
  54         outBuffer.writeInt(message.getMeterId().getValue().intValue());
  55         serializeBands(message.getMeterBandHeaders(), outBuffer);
  56         outBuffer.setShort(index + 2, outBuffer.writerIndex() - index);
  57     }
  58
  59     @Override
  60     protected byte getMessageType() {
  61         return 29;
  62     }
  63
  64     private void serializeBands(final MeterBandHeaders meterBandHeaders, final ByteBuf outBuffer) {
  65         if (meterBandHeaders == null) {
  66             return;
  67         }
  68
  69         for (MeterBandHeader meterBandHeader : meterBandHeaders.nonnullMeterBandHeader().values()) {
  70             final BandType type = meterBandHeader.getBandType();
  71             if (type == null) {
  72                 continue;
  73             }
  74             final var types = meterBandHeader.getMeterBandTypes();
  75             if (types == null) {
  76                 continue;
  77             }
  78             final var flags = types.getFlags();
  79             if (flags != null) {
  80                 if (flags.getOfpmbtDrop()) {
  81                     final Drop band = (Drop) type;
  82                     outBuffer.writeShort(MeterBandType.OFPMBTDROP.getIntValue());
  83
  84                     outBuffer.writeShort(LENGTH_OF_METER_BANDS);
  85                     outBuffer.writeInt(band.getDropRate().intValue());
  86                     outBuffer.writeInt(band.getDropBurstSize().intValue());
  87                     outBuffer.writeZero(PADDING_IN_METER_BAND_DROP);
  88                 } else if (flags.getOfpmbtDscpRemark()) {
  89                     final DscpRemark band = (DscpRemark) type;
  90                     outBuffer.writeShort(MeterBandType.OFPMBTDSCPREMARK.getIntValue());
  91
  92                     outBuffer.writeShort(LENGTH_OF_METER_BANDS);
  93                     outBuffer.writeInt(band.getDscpRemarkRate().intValue());
  94                     outBuffer.writeInt(band.getDscpRemarkBurstSize().intValue());
  95                     outBuffer.writeByte(band.getPrecLevel().toJava());
  96                     outBuffer.writeZero(PADDING_IN_METER_BAND_DSCP_REMARK);
  97                 } else if (flags.getOfpmbtExperimenter()) {
  98                     final Experimenter band = (Experimenter) type;
  99
 100                     // TODO: finish experimenter serialization
 101                     final ExperimenterIdSerializerKey<Experimenter> key =
 102                         new ExperimenterIdSerializerKey<>(EncodeConstants.OF_VERSION_1_3,
 103                             band.getExperimenter(), (Class<Experimenter>) type.implementedInterface());
 104
 105                     final OFSerializer<Experimenter> serializer = registry.getSerializer(key);
 106                     try {
 107                         serializer.serialize(band, outBuffer);
 108                     } catch (final IllegalStateException e) {
 109                         LOG.warn("Serializer for key: {} wasn't found", key, e);
 110                     }
 111                 }
 112             }
 113         }
 114     }
 115
 116     @Override
 117     public void injectSerializerRegistry(final SerializerRegistry serializerRegistry) {
 118         registry = requireNonNull(serializerRegistry);
 119     }
 120
 121     private static int createMeterFlagsBitMask(final MeterFlags flags) {
 122         return ByteBufUtils.fillBitMask(0,
 123                 flags.getMeterKbps(),
 124                 flags.getMeterPktps(),
 125                 flags.getMeterBurst(),
 126                 flags.getMeterStats());
 127     }
 128 }