2 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
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
8 package org.opendaylight.protocol.bgp.parser.impl.message.open;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
13 import io.netty.buffer.ByteBuf;
14 import io.netty.buffer.Unpooled;
15 import java.util.ArrayList;
16 import java.util.List;
18 import org.opendaylight.protocol.bgp.parser.spi.AddressFamilyRegistry;
19 import org.opendaylight.protocol.bgp.parser.spi.CapabilityParser;
20 import org.opendaylight.protocol.bgp.parser.spi.CapabilitySerializer;
21 import org.opendaylight.protocol.bgp.parser.spi.CapabilityUtil;
22 import org.opendaylight.protocol.bgp.parser.spi.SubsequentAddressFamilyRegistry;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.CParameters;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1Builder;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.LlGracefulRestartCapability;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.LlGracefulRestartCapabilityBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.ll.graceful.restart.capability.Tables;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.ll.graceful.restart.capability.TablesBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.ll.graceful.restart.capability.TablesKey;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.AddressFamily;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.SubsequentAddressFamily;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.uint24.rev200104.Uint24;
35 import org.opendaylight.yangtools.yang.common.Uint32;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
39 public final class LlGracefulCapabilityHandler implements CapabilityParser, CapabilitySerializer {
40 public static final int CODE = 71;
42 private static final Logger LOG = LoggerFactory.getLogger(LlGracefulCapabilityHandler.class);
44 // size of AFI (16 bits) and SAFI (8bits) fields in bytes
45 private static final int AFI_SAFI_SIZE = 3;
47 private static final int AFI_FLAGS_SIZE = 1;
48 private static final int STALE_TIME_SIZE = 3;
50 private static final int PER_TABLE_SIZE = AFI_SAFI_SIZE + AFI_FLAGS_SIZE + STALE_TIME_SIZE;
52 private static final int MAX_STALE_TIME = 16777215;
53 private static final byte AFI_FLAG_FORWARDING_STATE = (byte) 0x80;
55 private final AddressFamilyRegistry afiReg;
56 private final SubsequentAddressFamilyRegistry safiReg;
58 public LlGracefulCapabilityHandler(final AddressFamilyRegistry afiReg,
59 final SubsequentAddressFamilyRegistry safiReg) {
60 this.afiReg = requireNonNull(afiReg);
61 this.safiReg = requireNonNull(safiReg);
65 public CParameters parseCapability(final ByteBuf buffer) {
66 final List<Tables> tables = new ArrayList<>();
68 while (buffer.isReadable()) {
69 final short afival = buffer.readShort();
70 final Class<? extends AddressFamily> afi = this.afiReg.classForFamily(afival);
72 LOG.debug("Ignoring GR capability for unknown address family {}", afival);
73 buffer.skipBytes(PER_TABLE_SIZE - 2);
77 final byte safival = buffer.readByte();
78 final Class<? extends SubsequentAddressFamily> safi = this.safiReg.classForFamily(safival);
80 LOG.debug("Ignoring GR capability for unknown subsequent address family {}", safival);
81 buffer.skipBytes(PER_TABLE_SIZE - 3);
85 final byte afiFlags = buffer.readByte();
86 final int staleTime = buffer.readUnsignedMedium();
87 final Tables table = new TablesBuilder()
90 .setAfiFlags(new Tables.AfiFlags(Boolean.valueOf(afiFlags == AFI_FLAG_FORWARDING_STATE)))
91 .setLongLivedStaleTime(new Uint24(Uint32.valueOf(staleTime)))
95 return new CParametersBuilder()
96 .addAugmentation(CParameters1.class, new CParameters1Builder()
97 .setLlGracefulRestartCapability(new LlGracefulRestartCapabilityBuilder()
105 public void serializeCapability(final CParameters capability, final ByteBuf byteAggregator) {
106 final CParameters1 aug = capability.augmentation(CParameters1.class);
108 final LlGracefulRestartCapability cap = aug.getLlGracefulRestartCapability();
110 CapabilityUtil.formatCapability(CODE, serializeCapability(cap), byteAggregator);
115 private ByteBuf serializeCapability(final LlGracefulRestartCapability cap) {
116 final Map<TablesKey, Tables> tables = cap.getTables();
117 if (tables == null || tables.isEmpty()) {
118 return Unpooled.EMPTY_BUFFER;
121 final ByteBuf buffer = Unpooled.buffer(PER_TABLE_SIZE * tables.size());
122 for (Tables table : tables.values()) {
123 final Class<? extends AddressFamily> afi = table.getAfi();
124 final Class<? extends SubsequentAddressFamily> safi = table.getSafi();
125 final Integer afival = this.afiReg.numberForClass(afi);
126 checkArgument(afival != null, "Unhandled address family %s", afi);
127 buffer.writeShort(afival);
128 final Integer safival = this.safiReg.numberForClass(safi);
129 checkArgument(safival != null, "Unhandled subsequent address family %s", safi);
130 buffer.writeByte(safival);
131 if (table.getAfiFlags() != null && table.getAfiFlags().isForwardingState()) {
132 buffer.writeByte(AFI_FLAG_FORWARDING_STATE);
136 final Uint24 staleTime = table.getLongLivedStaleTime();
137 final int timeval = staleTime != null ? staleTime.getValue().intValue() : 0;
138 checkArgument(timeval >= 0 && timeval <= MAX_STALE_TIME, "Restart time is %s", staleTime);
139 buffer.writeMedium(timeval);