pcep/impl/src/main/java/org/opendaylight/protocol/pcep/impl/object/PCEPLspObjectParser.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 package org.opendaylight.protocol.pcep.impl.object;
   9
  10 import java.util.BitSet;
  11
  12 import org.opendaylight.protocol.pcep.PCEPDeserializerException;
  13 import org.opendaylight.protocol.pcep.PCEPDocumentedException;
  14 import org.opendaylight.protocol.pcep.spi.TlvHandlerRegistry;
  15 import org.opendaylight.protocol.util.ByteArray;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.LspObject;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.ObjectHeader;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.OperationalStatus;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.PlspId;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Tlv;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.error.code.tlv.LspErrorCode;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.identifiers.tlv.LspIdentifiers;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.object.Lsp;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.object.LspBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.object.lsp.Tlvs;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.object.lsp.TlvsBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rsvp.error.spec.tlv.RsvpErrorSpec;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.symbolic.path.name.tlv.SymbolicPathName;
  30
  31 /**
  32  * Parser for {@link LspObject}
  33  */
  34 public class PCEPLspObjectParser extends AbstractObjectWithTlvsParser<TlvsBuilder> {
  35
  36         public static final int CLASS = 32;
  37
  38         public static final int TYPE = 1;
  39
  40         /*
  41          * offset of TLVs offset of other fields are not defined as constants
  42          * because of non-standard mapping of bits
  43          */
  44         private static final int TLVS_OFFSET = 4;
  45
  46         /*
  47          * 12b extended to 16b so first 4b are restricted (belongs to LSP ID)
  48          */
  49         private static final int DELEGATE_FLAG_OFFSET = 15;
  50         private static final int SYNC_FLAG_OFFSET = 14;
  51         private static final int REMOVE_FLAG_OFFSET = 13;
  52         private static final int ADMINISTRATIVE_FLAG_OFFSET = 12;
  53         private static final int OPERATIONAL_OFFSET = 9;
  54
  55         public PCEPLspObjectParser(final TlvHandlerRegistry tlvReg) {
  56                 super(tlvReg);
  57         }
  58
  59         @Override
  60         public Lsp parseObject(final ObjectHeader header, final byte[] bytes) throws PCEPDeserializerException, PCEPDocumentedException {
  61                 if (bytes == null || bytes.length == 0) {
  62                         throw new IllegalArgumentException("Array of bytes is mandatory. Can't be null or empty.");
  63                 }
  64                 final BitSet flags = ByteArray.bytesToBitSet(ByteArray.subByte(bytes, 2, 2));
  65
  66                 final LspBuilder builder = new LspBuilder();
  67                 builder.setIgnore(header.isIgnore());
  68                 builder.setProcessingRule(header.isProcessingRule());
  69
  70                 builder.setPlspId(new PlspId((ByteArray.bytesToLong(ByteArray.subByte(bytes, 0, 2)) & 0xFFFF) << 4 | (bytes[2] & 0xFF) >> 4));
  71                 builder.setDelegate(flags.get(DELEGATE_FLAG_OFFSET));
  72                 builder.setSync(flags.get(SYNC_FLAG_OFFSET));
  73                 builder.setRemove(flags.get(REMOVE_FLAG_OFFSET));
  74                 builder.setAdministrative(flags.get(ADMINISTRATIVE_FLAG_OFFSET));
  75                 short s = 0;
  76                 s |= flags.get(OPERATIONAL_OFFSET + 2) ? 1 : 0;
  77                 s |= (flags.get(OPERATIONAL_OFFSET + 1) ? 1 : 0) << 1;
  78                 s |= (flags.get(OPERATIONAL_OFFSET) ? 1 : 0) << 2;
  79                 builder.setOperational(OperationalStatus.forValue(s));
  80                 final TlvsBuilder b = new TlvsBuilder();
  81                 parseTlvs(b, ByteArray.cutBytes(bytes, TLVS_OFFSET));
  82                 builder.setTlvs(b.build());
  83                 return builder.build();
  84         }
  85
  86         @Override
  87         public void addTlv(final TlvsBuilder builder, final Tlv tlv) {
  88                 if (tlv instanceof LspErrorCode) {
  89                         builder.setLspErrorCode((LspErrorCode) tlv);
  90                 } else if (tlv instanceof LspIdentifiers) {
  91                         builder.setLspIdentifiers((LspIdentifiers) tlv);
  92                 } else if (tlv instanceof RsvpErrorSpec) {
  93                         builder.setRsvpErrorSpec((RsvpErrorSpec) tlv);
  94                 } else if (tlv instanceof SymbolicPathName) {
  95                         builder.setSymbolicPathName((SymbolicPathName) tlv);
  96                 }
  97         }
  98
  99         @Override
 100         public byte[] serializeObject(final Object object) {
 101                 if (!(object instanceof Lsp)) {
 102                         throw new IllegalArgumentException("Wrong instance of PCEPObject. Passed " + object.getClass() + ". Needed LspObject.");
 103                 }
 104                 final Lsp specObj = (Lsp) object;
 105
 106                 final byte[] tlvs = serializeTlvs(specObj.getTlvs());
 107                 final byte[] retBytes = new byte[TLVS_OFFSET + tlvs.length + getPadding(TLVS_OFFSET + tlvs.length, PADDED_TO)];
 108
 109                 final int lspID = specObj.getPlspId().getValue().intValue();
 110                 retBytes[0] = (byte) (lspID >> 12);
 111                 retBytes[1] = (byte) (lspID >> 4);
 112                 retBytes[2] = (byte) (lspID << 4);
 113                 if (specObj.isDelegate()) {
 114                         retBytes[3] |= 1 << (Byte.SIZE - (DELEGATE_FLAG_OFFSET - Byte.SIZE) - 1);
 115                 }
 116                 if (specObj.isRemove()) {
 117                         retBytes[3] |= 1 << (Byte.SIZE - (REMOVE_FLAG_OFFSET - Byte.SIZE) - 1);
 118                 }
 119                 if (specObj.isSync()) {
 120                         retBytes[3] |= 1 << (Byte.SIZE - (SYNC_FLAG_OFFSET - Byte.SIZE) - 1);
 121                 }
 122                 if (specObj.isAdministrative()) {
 123                         retBytes[3] |= 1 << (Byte.SIZE - (ADMINISTRATIVE_FLAG_OFFSET - Byte.SIZE) - 1);
 124                 }
 125                 final int op = specObj.getOperational().getIntValue();
 126                 retBytes[3] |= (op & 7) << 4;
 127                 ByteArray.copyWhole(tlvs, retBytes, TLVS_OFFSET);
 128                 return retBytes;
 129         }
 130
 131         public byte[] serializeTlvs(final Tlvs tlvs) {
 132                 if (tlvs == null) {
 133                         return new byte[0];
 134                 }
 135                 int finalLength = 0;
 136                 byte[] lspErrBytes = null;
 137                 byte[] lspIdBytes = null;
 138                 byte[] rsvpErrBytes = null;
 139                 byte[] symbBytes = null;
 140                 if (tlvs.getLspErrorCode() != null) {
 141                         lspErrBytes = serializeTlv(tlvs.getLspErrorCode());
 142                         finalLength += lspErrBytes.length;
 143                 }
 144                 if (tlvs.getLspIdentifiers() != null) {
 145                         lspIdBytes = serializeTlv(tlvs.getLspIdentifiers());
 146                         finalLength += lspIdBytes.length;
 147                 }
 148                 if (tlvs.getRsvpErrorSpec() != null) {
 149                         rsvpErrBytes = serializeTlv(tlvs.getRsvpErrorSpec());
 150                         finalLength += rsvpErrBytes.length;
 151                 }
 152                 if (tlvs.getSymbolicPathName() != null) {
 153                         symbBytes = serializeTlv(tlvs.getSymbolicPathName());
 154                         finalLength += symbBytes.length;
 155                 }
 156                 int offset = 0;
 157                 final byte[] result = new byte[finalLength];
 158                 if (lspErrBytes != null) {
 159                         ByteArray.copyWhole(lspErrBytes, result, offset);
 160                         offset += lspErrBytes.length;
 161                 }
 162                 if (lspIdBytes != null) {
 163                         ByteArray.copyWhole(lspIdBytes, result, offset);
 164                         offset += lspIdBytes.length;
 165                 }
 166                 if (rsvpErrBytes != null) {
 167                         ByteArray.copyWhole(rsvpErrBytes, result, offset);
 168                         offset += rsvpErrBytes.length;
 169                 }
 170                 if (symbBytes != null) {
 171                         ByteArray.copyWhole(symbBytes, result, offset);
 172                         offset += symbBytes.length;
 173                 }
 174                 return result;
 175         }
 176
 177         @Override
 178         public int getObjectType() {
 179                 return TYPE;
 180         }
 181
 182         @Override
 183         public int getObjectClass() {
 184                 return CLASS;
 185         }
 186 }