2 * Copyright (c) 2013 Cisco Systems, Inc. and others. 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 java.util.Objects.requireNonNull;
11 import static org.opendaylight.protocol.util.ByteBufWriteUtil.writeUnsignedShort;
13 import com.google.common.base.Preconditions;
14 import io.netty.buffer.ByteBuf;
15 import io.netty.buffer.Unpooled;
16 import java.util.ArrayList;
17 import java.util.List;
18 import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
19 import org.opendaylight.protocol.bgp.parser.BGPParsingException;
20 import org.opendaylight.protocol.bgp.parser.spi.AddressFamilyRegistry;
21 import org.opendaylight.protocol.bgp.parser.spi.CapabilityParser;
22 import org.opendaylight.protocol.bgp.parser.spi.CapabilitySerializer;
23 import org.opendaylight.protocol.bgp.parser.spi.CapabilityUtil;
24 import org.opendaylight.protocol.bgp.parser.spi.SubsequentAddressFamilyRegistry;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.CParameters;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1Builder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.GracefulRestartCapability;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.GracefulRestartCapability.RestartFlags;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.GracefulRestartCapabilityBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.graceful.restart.capability.Tables;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.graceful.restart.capability.Tables.AfiFlags;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.graceful.restart.capability.TablesBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
40 public final class GracefulCapabilityHandler implements CapabilityParser, CapabilitySerializer {
41 public static final int CODE = 64;
43 private static final Logger LOG = LoggerFactory.getLogger(GracefulCapabilityHandler.class);
45 // Restart flag size, in bits
46 private static final int RESTART_FLAGS_SIZE = 4;
47 private static final int RESTART_FLAG_STATE = 0x8000;
49 // Restart timer size, in bits
50 private static final int TIMER_SIZE = 12;
51 private static final int TIMER_TOPBITS_MASK = 0x0F;
53 // Size of the capability header
54 private static final int HEADER_SIZE = (RESTART_FLAGS_SIZE + TIMER_SIZE) / Byte.SIZE;
56 // Length of each AFI/SAFI array member, in bytes
57 private static final int PER_AFI_SAFI_SIZE = 4;
59 private static final short AFI_FLAG_FORWARDING_STATE = 0x80;
61 private static final int MAX_RESTART_TIME = 4095;
63 private final AddressFamilyRegistry afiReg;
64 private final SubsequentAddressFamilyRegistry safiReg;
66 public GracefulCapabilityHandler(final AddressFamilyRegistry afiReg, final SubsequentAddressFamilyRegistry safiReg) {
67 this.afiReg = requireNonNull(afiReg);
68 this.safiReg = requireNonNull(safiReg);
71 private void serializeTables(final List<Tables> tables, final ByteBuf bytes) {
75 for (final Tables t : tables) {
76 final Class<? extends AddressFamily> afi = t.getAfi();
77 final Integer afival = this.afiReg.numberForClass(afi);
78 Preconditions.checkArgument(afival != null, "Unhandled address family " + afi);
79 bytes.writeShort(afival);
80 final Class<? extends SubsequentAddressFamily> safi = t.getSafi();
81 final Integer safival = this.safiReg.numberForClass(safi);
82 Preconditions.checkArgument(safival != null, "Unhandled subsequent address family " + safi);
83 bytes.writeByte(safival);
84 if (t.getAfiFlags() != null && t.getAfiFlags().isForwardingState()) {
85 bytes.writeByte(AFI_FLAG_FORWARDING_STATE);
92 private ByteBuf serializeCapability(final GracefulRestartCapability grace) {
93 final List<Tables> tables = grace.getTables();
94 final int tablesSize = (tables != null) ? tables.size() : 0;
95 final ByteBuf bytes = Unpooled.buffer(HEADER_SIZE + (PER_AFI_SAFI_SIZE * tablesSize));
97 Integer time = grace.getRestartTime();
101 Preconditions.checkArgument(time >= 0 && time <= MAX_RESTART_TIME, "Restart time is " + time);
103 final GracefulRestartCapability.RestartFlags flags = grace.getRestartFlags();
104 if (flags != null && flags.isRestartState()) {
105 writeUnsignedShort(RESTART_FLAG_STATE | timeval, bytes);
107 writeUnsignedShort(timeval, bytes);
109 serializeTables(tables, bytes);
114 public void serializeCapability(final CParameters capability, final ByteBuf byteAggregator) {
115 if (capability.getAugmentation(CParameters1.class) == null
116 || capability.getAugmentation(CParameters1.class).getGracefulRestartCapability() == null) {
119 final GracefulRestartCapability grace = capability.getAugmentation(CParameters1.class).getGracefulRestartCapability();
121 final ByteBuf bytes = serializeCapability(grace);
123 CapabilityUtil.formatCapability(CODE, bytes, byteAggregator);
127 public CParameters parseCapability(final ByteBuf buffer) throws BGPDocumentedException, BGPParsingException {
128 final GracefulRestartCapabilityBuilder cb = new GracefulRestartCapabilityBuilder();
130 final int flagBits = (buffer.getByte(0) >> RESTART_FLAGS_SIZE);
131 cb.setRestartFlags(new RestartFlags((flagBits & Byte.SIZE) != 0));
133 final int timer = ((buffer.readUnsignedByte() & TIMER_TOPBITS_MASK) << Byte.SIZE) + buffer.readUnsignedByte();
134 cb.setRestartTime(timer);
136 final List<Tables> tables = new ArrayList<>();
137 while (buffer.readableBytes() != 0) {
138 final int afiVal = buffer.readShort();
139 final Class<? extends AddressFamily> afi = this.afiReg.classForFamily(afiVal);
141 LOG.debug("Ignoring GR capability for unknown address family {}", afiVal);
142 buffer.skipBytes(PER_AFI_SAFI_SIZE - 2);
145 final int safiVal = buffer.readUnsignedByte();
146 final Class<? extends SubsequentAddressFamily> safi = this.safiReg.classForFamily(safiVal);
148 LOG.debug("Ignoring GR capability for unknown subsequent address family {}", safiVal);
152 final int flags = buffer.readUnsignedByte();
153 tables.add(new TablesBuilder().setAfi(afi).setSafi(safi).setAfiFlags(new AfiFlags((flags & AFI_FLAG_FORWARDING_STATE) != 0)).build());
155 cb.setTables(tables);
156 return new CParametersBuilder().addAugmentation(CParameters1.class, new CParameters1Builder()
157 .setGracefulRestartCapability(cb.build()).build()).build();