mappingservice/implementation/src/main/java/org/opendaylight/lispflowmapping/implementation/serializer/MapRequestSerializer.java

   1 /*
   2  * Copyright (c) 2014 Contextream, Inc. 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.lispflowmapping.implementation.serializer;
   9
  10 import java.nio.ByteBuffer;
  11 import java.util.ArrayList;
  12
  13 import org.apache.commons.lang3.BooleanUtils;
  14 import org.opendaylight.lispflowmapping.implementation.lisp.exception.LispSerializationException;
  15 import org.opendaylight.lispflowmapping.implementation.serializer.address.LispAddressSerializer;
  16 import org.opendaylight.lispflowmapping.implementation.util.ByteUtil;
  17 import org.opendaylight.lispflowmapping.implementation.util.LispAFIConvertor;
  18 import org.opendaylight.lispflowmapping.implementation.util.NumberUtil;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.MapRequest;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.eidrecords.EidRecord;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.eidtolocatorrecords.EidToLocatorRecordBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.maprequest.ItrRloc;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.maprequest.ItrRlocBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.maprequest.SourceEidBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.maprequestnotification.MapRequestBuilder;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 /**
  30  * This class deals with deserializing map request from udp to the java object.
  31  */
  32 public class MapRequestSerializer {
  33
  34     private static final MapRequestSerializer INSTANCE = new MapRequestSerializer();
  35     protected static final Logger LOG = LoggerFactory.getLogger(MapRequestSerializer.class);
  36
  37     // Private constructor prevents instantiation from other classes
  38     private MapRequestSerializer() {
  39     }
  40
  41     public static MapRequestSerializer getInstance() {
  42         return INSTANCE;
  43     }
  44
  45     public ByteBuffer serialize(MapRequest mapRequest) {
  46         int size = Length.HEADER_SIZE;
  47         if (mapRequest.getSourceEid() != null && mapRequest.getSourceEid().getLispAddressContainer() != null) {
  48             size += LispAddressSerializer.getInstance().getAddressSize(
  49                     LispAFIConvertor.toAFI(mapRequest.getSourceEid().getLispAddressContainer()));
  50         } else {
  51             size += 2;
  52         }
  53         if (mapRequest.getItrRloc() != null) {
  54             for (ItrRloc address : mapRequest.getItrRloc()) {
  55                 size += LispAddressSerializer.getInstance().getAddressSize(LispAFIConvertor.toAFI(address.getLispAddressContainer()));
  56             }
  57         }
  58         if (mapRequest.getEidRecord() != null) {
  59             for (EidRecord record : mapRequest.getEidRecord()) {
  60                 size += 2 + LispAddressSerializer.getInstance().getAddressSize(LispAFIConvertor.toAFI(record.getLispAddressContainer()));
  61             }
  62         }
  63         ByteBuffer requestBuffer = ByteBuffer.allocate(size);
  64         requestBuffer.put((byte) ((byte) (LispMessageEnum.MapRequest.getValue() << 4)
  65                 | ByteUtil.boolToBit(BooleanUtils.isTrue(mapRequest.isAuthoritative()), Flags.AUTHORITATIVE)
  66                 | ByteUtil.boolToBit(BooleanUtils.isTrue(mapRequest.isMapDataPresent()), Flags.MAP_DATA_PRESENT)
  67                 | ByteUtil.boolToBit(BooleanUtils.isTrue(mapRequest.isProbe()), Flags.PROBE) | ByteUtil.boolToBit(
  68                 BooleanUtils.isTrue(mapRequest.isSmr()), Flags.SMR)));
  69         requestBuffer.put((byte) (ByteUtil.boolToBit(BooleanUtils.isTrue(mapRequest.isPitr()), Flags.PITR) | ByteUtil.boolToBit(
  70                 BooleanUtils.isTrue(mapRequest.isSmrInvoked()), Flags.SMR_INVOKED)));
  71         if (mapRequest.getItrRloc() != null) {
  72             int IRC = mapRequest.getItrRloc().size();
  73             if (IRC > 0) {
  74                 IRC--;
  75             }
  76             requestBuffer.put((byte) (IRC));
  77         } else {
  78             requestBuffer.put((byte) 0);
  79
  80         }
  81         if (mapRequest.getEidRecord() != null) {
  82             requestBuffer.put((byte) mapRequest.getEidRecord().size());
  83         } else {
  84             requestBuffer.put((byte) 0);
  85
  86         }
  87         requestBuffer.putLong(NumberUtil.asLong(mapRequest.getNonce()));
  88         if (mapRequest.getSourceEid() != null && mapRequest.getSourceEid().getLispAddressContainer() != null) {
  89             LispAddressSerializer.getInstance().serialize(requestBuffer,
  90                     LispAFIConvertor.toAFI(mapRequest.getSourceEid().getLispAddressContainer()));
  91         } else {
  92             requestBuffer.putShort((short) 0);
  93         }
  94         if (mapRequest.getItrRloc() != null) {
  95             for (ItrRloc address : mapRequest.getItrRloc()) {
  96                 LispAddressSerializer.getInstance().serialize(requestBuffer, LispAFIConvertor.toAFI(address.getLispAddressContainer()));
  97             }
  98         }
  99         if (mapRequest.getEidRecord() != null) {
 100             for (EidRecord record : mapRequest.getEidRecord()) {
 101                 requestBuffer.put((byte) 0);
 102                 requestBuffer.put((byte) record.getMask().byteValue());
 103                 LispAddressSerializer.getInstance().serialize(requestBuffer, LispAFIConvertor.toAFI(record.getLispAddressContainer()));
 104             }
 105         }
 106         if (mapRequest.getMapReply() != null) {
 107             ByteBuffer replyBuffer = ByteBuffer.allocate(EidToLocatorRecordSerializer.getInstance().getSerializationSize(mapRequest.getMapReply()));
 108             EidToLocatorRecordSerializer.getInstance().serialize(replyBuffer, mapRequest.getMapReply());
 109             ByteBuffer combinedBuffer = ByteBuffer.allocate(requestBuffer.capacity() + replyBuffer.capacity());
 110             combinedBuffer.put(requestBuffer.array());
 111             combinedBuffer.put(replyBuffer.array());
 112             return combinedBuffer;
 113         }
 114         return requestBuffer;
 115     }
 116
 117     public MapRequest deserialize(ByteBuffer requestBuffer) {
 118         try {
 119             MapRequestBuilder builder = new MapRequestBuilder();
 120
 121             byte typeAndFlags = requestBuffer.get();
 122             builder.setAuthoritative(ByteUtil.extractBit(typeAndFlags, Flags.AUTHORITATIVE));
 123             builder.setMapDataPresent(ByteUtil.extractBit(typeAndFlags, Flags.MAP_DATA_PRESENT));
 124             builder.setProbe(ByteUtil.extractBit(typeAndFlags, Flags.PROBE));
 125             builder.setSmr(ByteUtil.extractBit(typeAndFlags, Flags.SMR));
 126
 127             byte moreFlags = requestBuffer.get();
 128             builder.setPitr(ByteUtil.extractBit(moreFlags, Flags.PITR));
 129             builder.setSmrInvoked(ByteUtil.extractBit(moreFlags, Flags.SMR_INVOKED));
 130
 131             int itrCount = ByteUtil.getUnsignedByte(requestBuffer) + 1;
 132             int recordCount = ByteUtil.getUnsignedByte(requestBuffer);
 133             builder.setNonce(requestBuffer.getLong());
 134             builder.setSourceEid(new SourceEidBuilder().setLispAddressContainer(
 135                     LispAFIConvertor.toContainer(LispAddressSerializer.getInstance().deserialize(requestBuffer)))
 136                     .build());
 137
 138             if (builder.getItrRloc() == null) {
 139                 builder.setItrRloc(new ArrayList<ItrRloc>());
 140             }
 141             for (int i = 0; i < itrCount; i++) {
 142                 builder.getItrRloc().add(
 143                         new ItrRlocBuilder().setLispAddressContainer(
 144                                 LispAFIConvertor.toContainer(LispAddressSerializer.getInstance().deserialize(requestBuffer)))
 145                                 .build());
 146             }
 147
 148             if (builder.getEidRecord() == null) {
 149                 builder.setEidRecord(new ArrayList<EidRecord>());
 150             }
 151             for (int i = 0; i < recordCount; i++) {
 152                 builder.getEidRecord().add(EidRecordSerializer.getInstance().deserialize(requestBuffer));
 153             }
 154             if (builder.isMapDataPresent() && requestBuffer.hasRemaining()) {
 155                 try {
 156                     builder.setMapReply(new org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.maprequest.MapReplyBuilder(
 157                             new EidToLocatorRecordBuilder(EidToLocatorRecordSerializer.getInstance().deserialize(requestBuffer)).build()).build());
 158                 } catch (RuntimeException re) {
 159                     LOG.warn("couldn't deserialize map reply encapsulated in map request. {}", re.getMessage());
 160                 }
 161             }
 162             return builder.build();
 163         } catch (RuntimeException re) {
 164             throw new LispSerializationException("Couldn't deserialize Map-Request (len=" + requestBuffer.capacity() + ")", re);
 165         }
 166     }
 167
 168     public interface Flags {
 169         byte AUTHORITATIVE = 0x08;
 170         byte MAP_DATA_PRESENT = 0x04;
 171         byte PROBE = 0x02;
 172         byte SMR = 0x01;
 173
 174         byte PITR = (byte) 0x80;
 175         byte SMR_INVOKED = 0x40;
 176     }
 177
 178     private interface Length {
 179         int HEADER_SIZE = 12;
 180     }
 181
 182 }