opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/packet/Packet.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, 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
   9 package org.opendaylight.controller.sal.packet;
  10
  11 import java.net.InetAddress;
  12 import java.net.UnknownHostException;
  13 import java.util.Map;
  14 import java.util.Map.Entry;
  15
  16 import org.apache.commons.lang3.tuple.Pair;
  17 import org.opendaylight.controller.sal.utils.HexEncode;
  18 import org.opendaylight.controller.sal.utils.NetUtils;
  19 import org.slf4j.Logger;
  20 import org.slf4j.LoggerFactory;
  21
  22 /**
  23  * Abstract class which represents the generic network packet object It provides
  24  * the basic methods which are common for all the packets, like serialize and
  25  * deserialize
  26  *
  27  *
  28  */
  29
  30 public abstract class Packet {
  31     protected static final Logger logger = LoggerFactory
  32             .getLogger(Packet.class);
  33     // Access level granted to this packet
  34     protected boolean writeAccess;
  35     // When deserialized from wire, packet could result corrupted
  36     protected boolean corrupted;
  37     // The packet that encapsulate this packet
  38     protected Packet parent;
  39     // The packet encapsulated by this packet
  40     protected Packet payload;
  41     // Bit coordinates of packet header fields
  42     protected Map<String, Pair<Integer, Integer>> hdrFieldCoordMap;
  43     // Header fields values: Map<FieldName,Value>
  44     protected Map<String, byte[]> hdrFieldsMap;
  45     // The class of the encapsulated packet object
  46     protected Class<? extends Packet> payloadClass;
  47
  48     public Packet() {
  49         writeAccess = false;
  50         corrupted = false;
  51     }
  52
  53     public Packet(boolean writeAccess) {
  54         this.writeAccess = writeAccess;
  55         this.corrupted = false;
  56     }
  57
  58     public Packet getParent() {
  59         return parent;
  60     }
  61
  62     public Packet getPayload() {
  63         return payload;
  64     }
  65
  66     public void setParent(Packet parent) {
  67         this.parent = parent;
  68     }
  69
  70     public void setPayload(Packet payload) {
  71         this.payload = payload;
  72     }
  73
  74     public void setHeaderField(String headerField, byte[] readValue) {
  75         hdrFieldsMap.put(headerField, readValue);
  76     }
  77
  78     /**
  79      * This method deserializes the data bits obtained from the wire into the
  80      * respective header and payload which are of type Packet
  81      *
  82      * @param byte[] data - data from wire to deserialize
  83      * @param int bitOffset bit position where packet header starts in data
  84      *        array
  85      * @param int size of packet in bits
  86      * @return Packet
  87      * @throws PacketException
  88      */
  89
  90     public Packet deserialize(byte[] data, int bitOffset, int size)
  91             throws PacketException {
  92         String hdrField;
  93         Integer startOffset = 0, numBits = 0;
  94         byte[] hdrFieldBytes;
  95
  96         for (Entry<String, Pair<Integer, Integer>> pairs : hdrFieldCoordMap
  97                 .entrySet()) {
  98             hdrField = pairs.getKey();
  99             startOffset = bitOffset + this.getfieldOffset(hdrField);
 100             numBits = this.getfieldnumBits(hdrField);
 101
 102             try {
 103                 hdrFieldBytes = BitBufferHelper.getBits(data, startOffset,
 104                         numBits);
 105             } catch (BufferException e) {
 106                 throw new PacketException(e.getMessage());
 107             }
 108             /*
 109              * Store the raw read value, checks the payload type and set the
 110              * payloadClass accordingly
 111              */
 112             this.setHeaderField(hdrField, hdrFieldBytes);
 113         }
 114
 115         postDeserializeCustomOperation(data, startOffset);
 116
 117         int payloadStart = startOffset + numBits;
 118         // int payloadSize = size - payloadStart;
 119         int payloadSize = data.length * NetUtils.NumBitsInAByte - payloadStart;
 120
 121         if (payloadClass != null) {
 122             try {
 123                 payload = payloadClass.newInstance();
 124             } catch (Exception e) {
 125                 throw new RuntimeException(
 126                         "Error parsing payload for Ethernet packet", e);
 127             }
 128             payload.deserialize(data, payloadStart, payloadSize);
 129             payload.setParent(this);
 130         } else {
 131             // For now let's discard unparsable payload
 132         }
 133         return this;
 134     }
 135
 136     /**
 137      * This method serializes the header and payload bytes from the respective
 138      * packet class, into a single stream of bytes to be sent on the wire
 139      *
 140      * @return byte[] - serialized bytes
 141      * @throws PacketException
 142      */
 143
 144     public byte[] serialize() throws PacketException {
 145         byte[] payloadBytes = null;
 146         int payloadSize = 0;
 147         int headerSize = this.getHeaderSize();
 148         int payloadByteOffset = headerSize / NetUtils.NumBitsInAByte;
 149         int size = 0;
 150
 151         if (payload != null) {
 152             payloadBytes = payload.serialize();
 153             payloadSize = payloadBytes.length * NetUtils.NumBitsInAByte;
 154         }
 155
 156         size = headerSize + payloadSize;
 157         int length = size / NetUtils.NumBitsInAByte;
 158         byte headerBytes[] = new byte[length];
 159
 160         if (payload != null) {
 161             System.arraycopy(payloadBytes, 0, headerBytes, payloadByteOffset,
 162                     payloadBytes.length);
 163         }
 164
 165         String field;
 166         byte[] fieldBytes;
 167         Integer startOffset, numBits;
 168
 169         for (Map.Entry<String, Pair<Integer, Integer>> pairs : hdrFieldCoordMap
 170                 .entrySet()) {
 171             field = pairs.getKey();
 172             fieldBytes = hdrFieldsMap.get(field);
 173             // Let's skip optional fields when not set
 174             if (fieldBytes != null) {
 175                 startOffset = this.getfieldOffset(field);
 176                 numBits = this.getfieldnumBits(field);
 177                 try {
 178                     BitBufferHelper.setBytes(headerBytes, fieldBytes,
 179                             startOffset, numBits);
 180                 } catch (BufferException e) {
 181                     throw new PacketException(e.getMessage());
 182                 }
 183             }
 184         }
 185         postSerializeCustomOperation(headerBytes);
 186
 187         return headerBytes;
 188     }
 189
 190     /**
 191      * This method gets called at the end of the serialization process It is
 192      * intended for the child packets to insert some custom data into the output
 193      * byte stream which cannot be done or cannot be done efficiently during the
 194      * normal Packet.serialize() path. An example is the checksum computation
 195      * for IPv4
 196      *
 197      * @param byte[] - serialized bytes
 198      * @throws PacketException
 199      */
 200     protected void postSerializeCustomOperation(byte[] myBytes)
 201             throws PacketException {
 202         // no op
 203     }
 204
 205     /**
 206      * This method re-computes the checksum of the bits received on the wire and
 207      * validates it with the checksum in the bits received Since the computation
 208      * of checksum varies based on the protocol, this method is overridden
 209      * Currently only IPv4 does checksum computation and validation TCP and UDP
 210      * need to implement these if required
 211      *
 212      * @param byte[] data
 213      * @param int endBitOffset
 214      * @throws PacketException
 215      */
 216     protected void postDeserializeCustomOperation(byte[] data, int endBitOffset)
 217             throws PacketException {
 218         // no op
 219     }
 220
 221     /**
 222      * Gets the header length in bits
 223      *
 224      * @return int the header length in bits
 225      */
 226     public int getHeaderSize() {
 227         int size = 0;
 228         /*
 229          * We need to iterate over the fields that were read in the frame
 230          * (hdrFieldsMap) not all the possible ones described in
 231          * hdrFieldCoordMap. For ex, 802.1Q may or may not be there
 232          */
 233         for (Map.Entry<String, byte[]> fieldEntry : hdrFieldsMap.entrySet()) {
 234             if (fieldEntry.getValue() != null) {
 235                 String field = fieldEntry.getKey();
 236                 size += getfieldnumBits(field);
 237             }
 238         }
 239         return size;
 240     }
 241
 242     /**
 243      * This method fetches the start bit offset for header field specified by
 244      * 'fieldname'. The offset is present in the hdrFieldCoordMap of the
 245      * respective packet class
 246      *
 247      * @param String
 248      *            fieldName
 249      * @return Integer - startOffset of the requested field
 250      */
 251     public int getfieldOffset(String fieldName) {
 252         return (((Pair<Integer, Integer>) hdrFieldCoordMap.get(fieldName))
 253                 .getLeft());
 254     }
 255
 256     /**
 257      * This method fetches the number of bits for header field specified by
 258      * 'fieldname'. The numBits are present in the hdrFieldCoordMap of the
 259      * respective packet class
 260      *
 261      * @param String
 262      *            fieldName
 263      * @return Integer - number of bits of the requested field
 264      */
 265     public int getfieldnumBits(String fieldName) {
 266         return (((Pair<Integer, Integer>) hdrFieldCoordMap.get(fieldName))
 267                 .getRight());
 268     }
 269
 270     @Override
 271     public String toString() {
 272         StringBuffer ret = new StringBuffer();
 273         for (Map.Entry<String, byte[]> entry : hdrFieldsMap.entrySet()) {
 274             ret.append(entry.getKey() + ": ");
 275             if (entry.getValue().length == 6) {
 276                 ret.append(HexEncode.bytesToHexString(entry.getValue()) + " ");
 277             } else if (entry.getValue().length == 4) {
 278                 try {
 279                     ret.append(InetAddress.getByAddress(entry.getValue())
 280                             .getHostAddress() + " ");
 281                 } catch (UnknownHostException e) {
 282                     logger.error("", e);
 283                 }
 284             } else {
 285                 ret.append(((Long) BitBufferHelper.getLong(entry.getValue()))
 286                         .toString() + " ");
 287             }
 288         }
 289         return ret.toString();
 290     }
 291
 292     /**
 293      * Returns true if the packet is corrupted
 294      *
 295      * @return boolean
 296      */
 297     protected boolean isPacketCorrupted() {
 298         return corrupted;
 299     }
 300 }