Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.pcepio.protocol.ver1; |
| 18 | |
| 19 | import java.util.LinkedList; |
| 20 | import java.util.ListIterator; |
| 21 | |
| 22 | import org.jboss.netty.buffer.ChannelBuffer; |
| 23 | import org.onosproject.pcepio.exceptions.PcepParseException; |
| 24 | import org.onosproject.pcepio.protocol.PcepSrpObject; |
Priyanka B | 21f4b73 | 2016-03-21 20:54:12 +0530 | [diff] [blame] | 25 | import org.onosproject.pcepio.types.PathSetupTypeTlv; |
Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 26 | import org.onosproject.pcepio.types.PcepObjectHeader; |
| 27 | import org.onosproject.pcepio.types.PcepValueType; |
| 28 | import org.onosproject.pcepio.types.SymbolicPathNameTlv; |
| 29 | import org.slf4j.Logger; |
| 30 | import org.slf4j.LoggerFactory; |
| 31 | |
| 32 | import com.google.common.base.MoreObjects; |
| 33 | |
| 34 | /** |
| 35 | * Provides PCEP SRP obejct. |
| 36 | */ |
| 37 | public class PcepSrpObjectVer1 implements PcepSrpObject { |
| 38 | |
| 39 | /* |
| 40 | * ref : draft-ietf-pce-stateful-pce-10, section : 7.2 |
| 41 | 0 1 2 3 |
| 42 | 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 |
| 43 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 44 | | Object-Class | OT |Res|P|I| Object Length (bytes) | |
| 45 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 46 | | Flags |R| |
| 47 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 48 | | SRP-ID-number | |
| 49 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 50 | | | |
| 51 | // Optional TLVs // |
| 52 | | | |
| 53 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 54 | |
| 55 | */ |
| 56 | protected static final Logger log = LoggerFactory.getLogger(PcepSrpObjectVer1.class); |
| 57 | |
| 58 | public static final byte SRP_OBJ_TYPE = 1; |
| 59 | public static final byte SRP_OBJ_CLASS = 33; |
| 60 | public static final byte SRP_OBJECT_VERSION = 1; |
| 61 | public static final short SRP_OBJ_MINIMUM_LENGTH = 12; |
| 62 | public static final int MINIMUM_COMMON_HEADER_LENGTH = 4; |
| 63 | public static final boolean DEFAULT_RFLAG = false; |
| 64 | |
| 65 | static final PcepObjectHeader DEFAULT_SRP_OBJECT_HEADER = new PcepObjectHeader(SRP_OBJ_CLASS, SRP_OBJ_TYPE, |
| 66 | PcepObjectHeader.REQ_OBJ_OPTIONAL_PROCESS, PcepObjectHeader.RSP_OBJ_PROCESSED, SRP_OBJ_MINIMUM_LENGTH); |
| 67 | |
| 68 | private PcepObjectHeader srpObjHeader; |
| 69 | private static int flags; |
| 70 | private boolean bRFlag; |
| 71 | private int srpId; |
| 72 | |
| 73 | //Optional TLV |
| 74 | private LinkedList<PcepValueType> llOptionalTlv; |
| 75 | public static final byte BBIT_SET = 1; |
| 76 | public static final byte BBIT_RESET = 0; |
| 77 | |
| 78 | /** |
| 79 | * Constructor to initialize member variables. |
| 80 | * |
| 81 | * @param srpObjHeader srp object header |
| 82 | * @param bRFlag R flag |
| 83 | * @param srpID srp Id |
| 84 | * @param llOptionalTlv list of optional tlv |
| 85 | */ |
| 86 | public PcepSrpObjectVer1(PcepObjectHeader srpObjHeader, boolean bRFlag, int srpID, |
| 87 | LinkedList<PcepValueType> llOptionalTlv) { |
| 88 | |
| 89 | this.srpObjHeader = srpObjHeader; |
| 90 | this.bRFlag = bRFlag; |
| 91 | this.srpId = srpID; |
| 92 | this.llOptionalTlv = llOptionalTlv; |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * sets the SRP object header. |
| 97 | * |
| 98 | * @param obj srp object header |
| 99 | */ |
| 100 | public void setSrpObjHeader(PcepObjectHeader obj) { |
| 101 | this.srpObjHeader = obj; |
| 102 | } |
| 103 | |
| 104 | @Override |
| 105 | public void setSrpID(int srpID) { |
| 106 | this.srpId = srpID; |
| 107 | } |
| 108 | |
| 109 | @Override |
| 110 | public void setRFlag(boolean bRFlag) { |
| 111 | this.bRFlag = bRFlag; |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * Returns SRP object header. |
| 116 | * |
| 117 | * @return srpObjHeader |
| 118 | */ |
| 119 | public PcepObjectHeader getSrpObjHeader() { |
| 120 | return this.srpObjHeader; |
| 121 | } |
| 122 | |
| 123 | @Override |
| 124 | public int getSrpID() { |
| 125 | return this.srpId; |
| 126 | } |
| 127 | |
| 128 | @Override |
| 129 | public boolean getRFlag() { |
| 130 | return this.bRFlag; |
| 131 | } |
| 132 | |
| 133 | @Override |
| 134 | public void setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv) { |
| 135 | this.llOptionalTlv = llOptionalTlv; |
| 136 | |
| 137 | } |
| 138 | |
| 139 | @Override |
| 140 | public LinkedList<PcepValueType> getOptionalTlv() { |
| 141 | return this.llOptionalTlv; |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * Reads from channel buffer and returns instance of PCEP SRP object. |
| 146 | * |
| 147 | * @param cb of channel buffer. |
| 148 | * @return PCEP SRP object |
| 149 | * @throws PcepParseException when srp object is not received in channel buffer |
| 150 | */ |
| 151 | public static PcepSrpObject read(ChannelBuffer cb) throws PcepParseException { |
| 152 | |
| 153 | log.debug("SrpObject::read"); |
| 154 | PcepObjectHeader srpObjHeader; |
| 155 | boolean bRFlag; |
| 156 | |
| 157 | int srpID; |
| 158 | int flags; |
Sho SHIMIZU | 9b8274c | 2015-09-04 15:54:24 -0700 | [diff] [blame] | 159 | LinkedList<PcepValueType> llOptionalTlv = new LinkedList<>(); |
Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 160 | |
| 161 | srpObjHeader = PcepObjectHeader.read(cb); |
| 162 | |
Sho SHIMIZU | de09fa0 | 2015-09-03 09:39:52 -0700 | [diff] [blame] | 163 | if (srpObjHeader.getObjClass() != SRP_OBJ_CLASS) { |
Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 164 | throw new PcepParseException("SRP object expected. But received " + srpObjHeader.getObjClass()); |
| 165 | } |
| 166 | |
| 167 | //take only SrpObject buffer. |
| 168 | ChannelBuffer tempCb = cb.readBytes(srpObjHeader.getObjLen() - MINIMUM_COMMON_HEADER_LENGTH); |
| 169 | flags = tempCb.readInt(); |
Phanendra Manda | f346ea8 | 2015-09-04 15:21:39 -0700 | [diff] [blame] | 170 | bRFlag = 0 < flags; |
Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 171 | srpID = tempCb.readInt(); |
| 172 | |
| 173 | llOptionalTlv = parseOptionalTlv(tempCb); |
| 174 | |
| 175 | return new PcepSrpObjectVer1(srpObjHeader, bRFlag, srpID, llOptionalTlv); |
| 176 | } |
| 177 | |
| 178 | @Override |
| 179 | public int write(ChannelBuffer cb) throws PcepParseException { |
| 180 | |
| 181 | int objStartIndex = cb.writerIndex(); |
| 182 | |
| 183 | //write common header |
| 184 | int objLenIndex = srpObjHeader.write(cb); |
| 185 | |
| 186 | //write Flags |
| 187 | byte bFlag; |
| 188 | |
| 189 | bFlag = (bRFlag) ? BBIT_SET : BBIT_RESET; |
| 190 | |
| 191 | cb.writeInt(bFlag); |
| 192 | |
| 193 | //write SrpId |
| 194 | cb.writeInt(srpId); |
| 195 | |
| 196 | // Add optional TLV |
| 197 | if (!packOptionalTlv(cb)) { |
| 198 | throw new PcepParseException("Failed to write srp tlv to channel buffer."); |
| 199 | } |
| 200 | |
| 201 | //now write SRP Object Length |
| 202 | cb.setShort(objLenIndex, (short) (cb.writerIndex() - objStartIndex)); |
| 203 | |
| 204 | return cb.writerIndex(); |
| 205 | } |
| 206 | |
| 207 | /** |
| 208 | * Parse Optional TLvs from the channel buffer. |
| 209 | * |
| 210 | * @param cb of type channel buffer |
| 211 | * @return list of optional tlvs |
| 212 | * @throws PcepParseException when unsupported tlv is received in srp object |
| 213 | */ |
| 214 | public static LinkedList<PcepValueType> parseOptionalTlv(ChannelBuffer cb) throws PcepParseException { |
| 215 | |
Sho SHIMIZU | 9b8274c | 2015-09-04 15:54:24 -0700 | [diff] [blame] | 216 | LinkedList<PcepValueType> llOutOptionalTlv = new LinkedList<>(); |
Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 217 | |
| 218 | while (MINIMUM_COMMON_HEADER_LENGTH <= cb.readableBytes()) { |
| 219 | |
| 220 | PcepValueType tlv; |
| 221 | short hType = cb.readShort(); |
| 222 | short hLength = cb.readShort(); |
| 223 | |
| 224 | switch (hType) { |
Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 225 | case SymbolicPathNameTlv.TYPE: |
Priyanka B | 21f4b73 | 2016-03-21 20:54:12 +0530 | [diff] [blame] | 226 | if (cb.readableBytes() < hLength) { |
| 227 | throw new PcepParseException("Length is not valid in SymbolicPathNameTlv"); |
| 228 | } |
Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 229 | tlv = SymbolicPathNameTlv.read(cb, hLength); |
Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 230 | break; |
Priyanka B | 21f4b73 | 2016-03-21 20:54:12 +0530 | [diff] [blame] | 231 | case PathSetupTypeTlv.TYPE: |
| 232 | if (cb.readableBytes() != PathSetupTypeTlv.LENGTH) { |
| 233 | throw new PcepParseException("Length is not valid in PathSetupTypeTlv"); |
| 234 | } |
| 235 | tlv = PathSetupTypeTlv.of(cb.readInt()); |
| 236 | break; |
Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 237 | default: |
| 238 | throw new PcepParseException("Unsupported TLV received in SRP Object."); |
| 239 | } |
| 240 | |
| 241 | // Check for the padding |
| 242 | int pad = hLength % 4; |
| 243 | if (0 < pad) { |
| 244 | pad = 4 - pad; |
| 245 | if (pad <= cb.readableBytes()) { |
| 246 | cb.skipBytes(pad); |
| 247 | } |
| 248 | } |
| 249 | llOutOptionalTlv.add(tlv); |
| 250 | } |
| 251 | |
| 252 | return llOutOptionalTlv; |
| 253 | } |
| 254 | |
| 255 | /** |
| 256 | * Writes optional tlvs to channel buffer. |
| 257 | * |
| 258 | * @param cb of type channel buffer |
| 259 | * @return true if writing optional tlv to channel buffer is success. |
| 260 | */ |
| 261 | protected boolean packOptionalTlv(ChannelBuffer cb) { |
| 262 | |
| 263 | ListIterator<PcepValueType> listIterator = llOptionalTlv.listIterator(); |
| 264 | |
| 265 | while (listIterator.hasNext()) { |
| 266 | PcepValueType tlv = listIterator.next(); |
| 267 | |
Sho SHIMIZU | de09fa0 | 2015-09-03 09:39:52 -0700 | [diff] [blame] | 268 | if (tlv == null) { |
Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 269 | log.debug("tlv is null from OptionalTlv list"); |
| 270 | continue; |
| 271 | } |
| 272 | tlv.write(cb); |
| 273 | |
| 274 | // need to take care of padding |
| 275 | int pad = tlv.getLength() % 4; |
| 276 | |
| 277 | if (0 != pad) { |
| 278 | pad = 4 - pad; |
| 279 | for (int i = 0; i < pad; ++i) { |
| 280 | cb.writeByte((byte) 0); |
| 281 | } |
| 282 | } |
| 283 | } |
| 284 | |
| 285 | return true; |
| 286 | } |
| 287 | |
| 288 | /** |
| 289 | * Builder class for PCEP srp Object. |
| 290 | */ |
| 291 | public static class Builder implements PcepSrpObject.Builder { |
| 292 | private boolean bIsHeaderSet = false; |
| 293 | private boolean bIsSrpIdset = false; |
| 294 | private boolean bIsRFlagSet = false; |
| 295 | |
| 296 | private PcepObjectHeader srpObjHeader; |
| 297 | private int srpId; |
| 298 | private boolean bRFlag; |
Sho SHIMIZU | 9b8274c | 2015-09-04 15:54:24 -0700 | [diff] [blame] | 299 | LinkedList<PcepValueType> llOptionalTlv = new LinkedList<>(); |
Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 300 | |
| 301 | private boolean bIsPFlagSet = false; |
| 302 | private boolean bPFlag; |
| 303 | |
| 304 | private boolean bIsIFlagSet = false; |
| 305 | private boolean bIFlag; |
| 306 | |
| 307 | @Override |
| 308 | public PcepSrpObject build() throws PcepParseException { |
| 309 | PcepObjectHeader srpObjHeader = this.bIsHeaderSet ? this.srpObjHeader : DEFAULT_SRP_OBJECT_HEADER; |
| 310 | |
| 311 | boolean bRFlag = this.bIsRFlagSet ? this.bRFlag : DEFAULT_RFLAG; |
| 312 | |
| 313 | if (!this.bIsSrpIdset) { |
| 314 | throw new PcepParseException("SrpID not set while building SRP Object."); |
| 315 | } |
| 316 | |
| 317 | if (bIsPFlagSet) { |
| 318 | srpObjHeader.setPFlag(bPFlag); |
| 319 | } |
| 320 | |
| 321 | if (bIsIFlagSet) { |
| 322 | srpObjHeader.setIFlag(bIFlag); |
| 323 | } |
| 324 | |
| 325 | return new PcepSrpObjectVer1(srpObjHeader, bRFlag, this.srpId, this.llOptionalTlv); |
| 326 | } |
| 327 | |
| 328 | @Override |
| 329 | public PcepObjectHeader getSrpObjHeader() { |
| 330 | return this.srpObjHeader; |
| 331 | } |
| 332 | |
| 333 | @Override |
| 334 | public Builder setSrpObjHeader(PcepObjectHeader obj) { |
| 335 | this.srpObjHeader = obj; |
| 336 | this.bIsHeaderSet = true; |
| 337 | return this; |
| 338 | } |
| 339 | |
| 340 | @Override |
| 341 | public int getSrpID() { |
| 342 | return this.srpId; |
| 343 | } |
| 344 | |
| 345 | @Override |
| 346 | public Builder setSrpID(int srpID) { |
| 347 | this.srpId = srpID; |
| 348 | this.bIsSrpIdset = true; |
| 349 | return this; |
| 350 | } |
| 351 | |
| 352 | @Override |
| 353 | public boolean getRFlag() { |
| 354 | return this.bRFlag; |
| 355 | } |
| 356 | |
| 357 | @Override |
| 358 | public Builder setRFlag(boolean bRFlag) { |
| 359 | this.bRFlag = bRFlag; |
| 360 | this.bIsRFlagSet = true; |
| 361 | return this; |
| 362 | } |
| 363 | |
| 364 | @Override |
| 365 | public Builder setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv) { |
| 366 | this.llOptionalTlv = llOptionalTlv; |
| 367 | return this; |
| 368 | } |
| 369 | |
| 370 | @Override |
| 371 | public LinkedList<PcepValueType> getOptionalTlv() { |
| 372 | return this.llOptionalTlv; |
| 373 | } |
| 374 | |
| 375 | @Override |
| 376 | public Builder setPFlag(boolean value) { |
| 377 | this.bPFlag = value; |
| 378 | this.bIsPFlagSet = true; |
| 379 | return this; |
| 380 | } |
| 381 | |
| 382 | @Override |
| 383 | public Builder setIFlag(boolean value) { |
| 384 | this.bIFlag = value; |
| 385 | this.bIsIFlagSet = true; |
| 386 | return this; |
| 387 | } |
| 388 | |
| 389 | } |
| 390 | |
| 391 | @Override |
| 392 | public String toString() { |
Sho SHIMIZU | 7cdbcf7 | 2015-09-03 14:43:05 -0700 | [diff] [blame] | 393 | return MoreObjects.toStringHelper(getClass()) |
| 394 | .add("RFlag", bRFlag) |
| 395 | .add("SRPID", srpId) |
| 396 | .add("OptionalTlvList", llOptionalTlv) |
| 397 | .toString(); |
Sho SHIMIZU | e81e4db | 2015-09-03 09:44:38 -0700 | [diff] [blame] | 398 | } |
| 399 | } |