openflowjava/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/factories/HelloMessageFactory.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.deserialization.factories;
  10
  11 import static org.opendaylight.yangtools.yang.common.netty.ByteBufUtils.readUint32;
  12
  13 import io.netty.buffer.ByteBuf;
  14 import java.util.ArrayList;
  15 import java.util.List;
  16 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
  17 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  18 import org.opendaylight.openflowjava.protocol.impl.util.VersionAssignableFactory;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.HelloElementType;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessageBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.hello.Elements;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.hello.ElementsBuilder;
  24
  25 /**
  26  * Translates Hello messages. OF protocol versions: 1.3, 1.4, 1.5.
  27  *
  28  * @author michal.polkorab
  29  * @author timotej.kubas
  30  */
  31 public class HelloMessageFactory extends VersionAssignableFactory implements OFDeserializer<HelloMessage> {
  32
  33     private static final byte HELLO_ELEMENT_HEADER_SIZE = 4;
  34
  35     @Override
  36     public HelloMessage deserialize(ByteBuf rawMessage) {
  37         HelloMessageBuilder builder = new HelloMessageBuilder();
  38         builder.setVersion(getVersion());
  39         builder.setXid(readUint32(rawMessage));
  40         if (rawMessage.readableBytes() > 0) {
  41             builder.setElements(readElement(rawMessage));
  42         }
  43         return builder.build();
  44     }
  45
  46     private static List<Elements> readElement(ByteBuf input) {
  47         List<Elements> elementsList = new ArrayList<>();
  48         while (input.readableBytes() > 0) {
  49             ElementsBuilder elementsBuilder = new ElementsBuilder();
  50             int type = input.readUnsignedShort();
  51             int elementLength = input.readUnsignedShort();
  52             if (type == HelloElementType.VERSIONBITMAP.getIntValue()) {
  53                 elementsBuilder.setType(HelloElementType.forValue(type));
  54                 int[] versionBitmap = new int[(elementLength - HELLO_ELEMENT_HEADER_SIZE) / 4];
  55                 for (int i = 0; i < versionBitmap.length; i++) {
  56                     versionBitmap[i] = (int) input.readUnsignedInt();
  57                 }
  58                 elementsBuilder.setVersionBitmap(readVersionBitmap(versionBitmap));
  59                 int paddingRemainder = elementLength % EncodeConstants.PADDING;
  60                 if (paddingRemainder != 0) {
  61                     input.readBytes(EncodeConstants.PADDING - paddingRemainder);
  62                 }
  63             } else {
  64                 return elementsList;
  65             }
  66             elementsList.add(elementsBuilder.build());
  67         }
  68         return elementsList;
  69     }
  70
  71     private static List<Boolean> readVersionBitmap(int[] input) {
  72         List<Boolean> versionBitmapList = new ArrayList<>();
  73         for (int mask : input) {
  74             for (int j = 0; j < Integer.SIZE; j++) {
  75                 versionBitmapList.add((mask & 1 << j) != 0);
  76             }
  77         }
  78         return versionBitmapList;
  79     }
  80 }