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