openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/protocol/deserialization/multipart/MultipartReplyMeterConfigDeserializer.java

   1 /*
   2  * Copyright (c) 2017 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.deserialization.multipart;
  10
  11 import io.netty.buffer.ByteBuf;
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistryInjector;
  16 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
  17 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdDeserializerKey;
  18 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.multipart.reply.multipart.reply.body.MultipartReplyMeterConfigBuilder;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.BandId;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterBandType;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterFlags;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.DropBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.DscpRemarkBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.Experimenter;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.MeterBandHeadersBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.config.stats.reply.MeterConfigStats;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.config.stats.reply.MeterConfigStatsBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.config.stats.reply.MeterConfigStatsKey;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers.MeterBandHeader;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers.MeterBandHeaderBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers.MeterBandHeaderKey;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers.meter.band.header.MeterBandTypesBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.multipart.types.rev170112.multipart.reply.MultipartReplyBody;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 public class MultipartReplyMeterConfigDeserializer implements OFDeserializer<MultipartReplyBody>,
  40         DeserializerRegistryInjector {
  41
  42     private static final Logger LOG = LoggerFactory.getLogger(MultipartReplyMeterConfigDeserializer.class);
  43
  44     private static final byte METER_CONFIG_LENGTH = 8;
  45     private static final int OFPMBTDROP = 1;
  46     private static final int OFPMBTDSCP = 2;
  47     private static final int OFPMBTEXPERIMENTER = 0xFFFF;
  48     private static final byte PADDING_IN_METER_BAND_DROP_HEADER = 4;
  49     private static final byte PADDING_IN_METER_BAND_DSCP_HEADER = 3;
  50
  51     private DeserializerRegistry registry;
  52
  53     @Override
  54     public MultipartReplyBody deserialize(ByteBuf message) {
  55         final MultipartReplyMeterConfigBuilder builder = new MultipartReplyMeterConfigBuilder();
  56         final List<MeterConfigStats> items = new ArrayList<>();
  57
  58         while (message.readableBytes() > 0) {
  59             final int itemLength = message.readUnsignedShort();
  60
  61             final MeterConfigStatsBuilder itemBuilder = new MeterConfigStatsBuilder()
  62                     .setFlags(readMeterFlags(message))
  63                     .setMeterId(new MeterId(message.readUnsignedInt()));
  64
  65             final List<MeterBandHeader> subItems = new ArrayList<>();
  66             int actualLength = METER_CONFIG_LENGTH;
  67             long bandKey = 0;
  68
  69             while (actualLength < itemLength) {
  70                 final int itemStartIndex = message.readerIndex();
  71                 final int itemBandType = message.readUnsignedShort();
  72                 final MeterBandHeaderBuilder subItemBuilder = new MeterBandHeaderBuilder();
  73                 actualLength += message.readUnsignedShort();
  74
  75                 switch (itemBandType) {
  76                     case OFPMBTDROP:
  77                         subItemBuilder
  78                                 .setMeterBandTypes(new MeterBandTypesBuilder()
  79                                         .setFlags(new MeterBandType(true, false, false))
  80                                         .build())
  81                                 .setBandType(new DropBuilder()
  82                                         .setDropRate(message.readUnsignedInt())
  83                                         .setDropBurstSize(message.readUnsignedInt())
  84                                         .build());
  85                         message.skipBytes(PADDING_IN_METER_BAND_DROP_HEADER);
  86                         break;
  87
  88                     case OFPMBTDSCP:
  89                         subItemBuilder
  90                                 .setMeterBandTypes(new MeterBandTypesBuilder()
  91                                         .setFlags(new MeterBandType(false, true, false))
  92                                         .build())
  93                                 .setBandType(new DscpRemarkBuilder()
  94                                         .setDscpRemarkRate(message.readUnsignedInt())
  95                                         .setDscpRemarkBurstSize(message.readUnsignedInt())
  96                                         .setPrecLevel(message.readUnsignedByte())
  97                                         .build());
  98                         message.skipBytes(PADDING_IN_METER_BAND_DSCP_HEADER);
  99                         break;
 100
 101                     case OFPMBTEXPERIMENTER:
 102                         // TODO: Finish meter band experimenter deserialization
 103                         final long expId = message.getUnsignedInt(message.readerIndex() + 2 * Integer.BYTES);
 104                         message.readerIndex(itemStartIndex);
 105
 106                         final OFDeserializer<Experimenter> deserializer = registry.getDeserializer(
 107                                 new ExperimenterIdDeserializerKey(EncodeConstants.OF13_VERSION_ID, expId,
 108                                         Experimenter.class));
 109
 110                         subItemBuilder
 111                                 .setMeterBandTypes(new MeterBandTypesBuilder()
 112                                         .setFlags(new MeterBandType(false, false, true))
 113                                         .build())
 114                                 .setBandType(deserializer.deserialize(message));
 115                         break;
 116                     default:
 117                         // no operation
 118
 119                 }
 120                 subItems.add(subItemBuilder.withKey(new MeterBandHeaderKey(new BandId(bandKey++))).build());
 121             }
 122
 123             items.add(itemBuilder
 124                     .withKey(new MeterConfigStatsKey(itemBuilder.getMeterId()))
 125                     .setMeterBandHeaders(new MeterBandHeadersBuilder()
 126                             .setMeterBandHeader(subItems)
 127                             .build())
 128                     .build());
 129         }
 130
 131         return builder
 132                 .setMeterConfigStats(items)
 133                 .build();
 134     }
 135
 136     private static MeterFlags readMeterFlags(ByteBuf message) {
 137         int input = message.readUnsignedShort();
 138         final Boolean mfKbps = (input & (1)) != 0;
 139         final Boolean mfPktps = (input & (1 << 1)) != 0;
 140         final Boolean mfBurst = (input & (1 << 2)) != 0;
 141         final Boolean mfStats = (input & (1 << 3)) != 0;
 142         return new MeterFlags(mfBurst, mfKbps, mfPktps, mfStats);
 143     }
 144
 145     @Override
 146     public void injectDeserializerRegistry(DeserializerRegistry deserializerRegistry) {
 147         registry = deserializerRegistry;
 148     }
 149 }