2 * Copyright (c) 2015 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.rib.impl;
10 import com.google.common.base.Preconditions;
11 import com.google.common.base.Verify;
12 import com.google.common.collect.ImmutableSet;
13 import com.google.common.collect.ImmutableSet.Builder;
14 import java.util.Map.Entry;
16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
17 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
18 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContext;
19 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.ClusterId;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OriginatorId;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Aggregator;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPath;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Communities;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.ExtendedCommunities;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.LocalPref;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.MultiExitDisc;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Origin;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes1;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpAggregator;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Community;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ExtendedCommunity;
45 import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTree;
46 import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTreeNode;
47 import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeCachingCodec;
48 import org.opendaylight.yangtools.yang.binding.DataObject;
49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
50 import org.opendaylight.yangtools.yang.common.QName;
51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
53 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
54 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
55 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
56 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
57 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
58 import org.slf4j.Logger;
59 import org.slf4j.LoggerFactory;
61 class RIBSupportContextImpl extends RIBSupportContext {
63 private static final Logger LOG = LoggerFactory.getLogger(RIBSupportContextImpl.class);
64 private static final ContainerNode EMPTY_TABLE_ATTRIBUTES = ImmutableNodes.containerNode(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Attributes.QNAME);
65 private static final Set<Class<? extends DataObject>> ATTRIBUTE_CACHEABLES;
67 private static final InstanceIdentifier<Tables> TABLE_BASE_II = InstanceIdentifier.builder(BgpRib.class)
72 private static final InstanceIdentifier<MpReachNlri> MP_REACH_NLRI_II = InstanceIdentifier.create(Update.class)
73 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes.class)
74 .augmentation(Attributes1.class)
75 .child(MpReachNlri.class);
76 private static final InstanceIdentifier<MpUnreachNlri> MP_UNREACH_NLRI_II = InstanceIdentifier.create(Update.class)
77 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes.class)
78 .augmentation(Attributes2.class)
79 .child(MpUnreachNlri.class);
83 final Builder<Class<? extends DataObject>> acb = ImmutableSet.builder();
84 acb.add(Aggregator.class);
85 acb.add(BgpAggregator.class);
86 acb.add(AsPath.class);
87 acb.add(ClusterId.class);
88 acb.add(Community.class);
89 acb.add(Communities.class);
90 acb.add(ExtendedCommunity.class);
91 acb.add(ExtendedCommunities.class);
92 acb.add(LocalPref.class);
93 acb.add(MultiExitDisc.class);
94 acb.add(Origin.class);
95 acb.add(OriginatorId.class);
96 ATTRIBUTE_CACHEABLES = acb.build();
99 private final RIBSupport tableSupport;
100 private final ImmutableSet<Class<? extends DataObject>> cacheableAttributes;
101 private BindingNormalizedNodeCachingCodec<Attributes> attributesCodec;
102 private BindingNormalizedNodeCachingCodec<MpReachNlri> reachNlriCodec;
103 private BindingNormalizedNodeCachingCodec<MpUnreachNlri> unreachNlriCodec;
106 public RIBSupportContextImpl(final RIBSupport ribSupport) {
107 this.tableSupport = Preconditions.checkNotNull(ribSupport);
108 final Builder<Class<? extends DataObject>> acb = ImmutableSet.builder();
109 acb.addAll(ATTRIBUTE_CACHEABLES);
110 acb.addAll(this.tableSupport.cacheableAttributeObjects());
111 this.cacheableAttributes = acb.build();
115 @SuppressWarnings("unchecked")
116 void onCodecTreeUpdated(final BindingCodecTree tree) {
118 @SuppressWarnings("rawtypes")
120 BindingCodecTreeNode tableCodecContext = tree.getSubtreeCodec(TABLE_BASE_II);
121 final BindingCodecTreeNode<? extends Route> routeListCodec = tableCodecContext
122 .streamChild(Routes.class)
123 .streamChild(this.tableSupport.routesCaseClass())
124 .streamChild(this.tableSupport.routesContainerClass())
125 .streamChild(this.tableSupport.routesListClass());
127 this.attributesCodec = routeListCodec.streamChild(Attributes.class).createCachingCodec(this.cacheableAttributes);
128 this.reachNlriCodec = tree.getSubtreeCodec(MP_REACH_NLRI_II).createCachingCodec(this.tableSupport.cacheableNlriObjects());
129 this.unreachNlriCodec = tree.getSubtreeCodec(MP_UNREACH_NLRI_II).createCachingCodec(this.tableSupport.cacheableNlriObjects());
133 public void writeRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tableId, final MpReachNlri nlri,
134 final Attributes attributes) {
135 final ContainerNode domNlri = serialiazeReachNlri(nlri);
136 final ContainerNode routeAttributes = serializeAttributes(attributes);
137 this.tableSupport.putRoutes(tx, tableId, domNlri, routeAttributes);
141 public void clearTable(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tableId) {
142 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> tb = ImmutableNodes.mapEntryBuilder();
143 tb.withNodeIdentifier((NodeIdentifierWithPredicates)tableId.getLastPathArgument());
144 tb.withChild(EMPTY_TABLE_ATTRIBUTES);
146 // tableId is keyed, but that fact is not directly visible from YangInstanceIdentifier, see BUG-2796
147 final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) tableId.getLastPathArgument();
148 for (final Entry<QName, Object> e : tableKey.getKeyValues().entrySet()) {
149 tb.withChild(ImmutableNodes.leafNode(e.getKey(), e.getValue()));
152 final ChoiceNode routes = this.tableSupport.emptyRoutes();
153 Verify.verifyNotNull(routes, "Null empty routes in %s", this.tableSupport);
154 Verify.verify(Routes.QNAME.equals(routes.getNodeType()), "Empty routes have unexpected identifier %s, expected %s", routes.getNodeType(), Routes.QNAME);
156 tx.put(LogicalDatastoreType.OPERATIONAL, tableId, tb.withChild(routes).build());
160 public void deleteRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tableId, final MpUnreachNlri nlri) {
161 this.tableSupport.deleteRoutes(tx, tableId, serialiazeUnreachNlri(nlri));
164 private ContainerNode serialiazeUnreachNlri(final MpUnreachNlri nlri) {
165 Preconditions.checkState(this.unreachNlriCodec != null, "MpReachNlri codec not available");
166 return (ContainerNode) this.unreachNlriCodec.serialize(nlri);
169 private ContainerNode serialiazeReachNlri(final MpReachNlri nlri) {
170 Preconditions.checkState(this.reachNlriCodec != null, "MpReachNlri codec not available");
171 return (ContainerNode) this.reachNlriCodec.serialize(nlri);
174 private ContainerNode serializeAttributes(final Attributes pathAttr) {
175 Preconditions.checkState(this.attributesCodec != null, "MpReachNlri codec not available");
176 final AttributesBuilder a = new AttributesBuilder(pathAttr);
177 a.addAugmentation(Attributes1.class, null);
178 a.addAugmentation(Attributes2.class, null);
179 return (ContainerNode) this.attributesCodec.serialize(a.build());
183 public RIBSupport getRibSupport() {
184 return this.tableSupport;