Line data Source code
1 : /*
2 : * Copyright (c) 2013 Juniper Networks, Inc. All rights reserved.
3 : */
4 :
5 : #include "bgp/bgp_multicast.h"
6 :
7 : #include <boost/bind/bind.hpp>
8 : #include <boost/foreach.hpp>
9 :
10 : #include "base/string_util.h"
11 : #include "base/task_annotations.h"
12 : #include "bgp/bgp_log.h"
13 : #include "bgp/bgp_mvpn.h"
14 : #include "bgp/bgp_server.h"
15 : #include "bgp/bgp_update.h"
16 : #include "bgp/ermvpn/ermvpn_table.h"
17 : #include "bgp/mvpn/mvpn_route.h"
18 : #include "bgp/routing-instance/routing_instance.h"
19 : #include "bgp/routing-instance/routing_instance_analytics_types.h"
20 : #include "bgp/routing-instance/routing_instance_log.h"
21 : #include "bgp/tunnel_encap/tunnel_encap.h"
22 :
23 : using std::string;
24 : using std::vector;
25 : using namespace boost::placeholders;
26 :
27 : class McastTreeManager::DeleteActor : public LifetimeActor {
28 : public:
29 0 : explicit DeleteActor(McastTreeManager *tree_manager)
30 0 : : LifetimeActor(tree_manager->table_->routing_instance()->server()->
31 : lifetime_manager()),
32 0 : tree_manager_(tree_manager) {
33 0 : }
34 0 : virtual ~DeleteActor() {
35 0 : }
36 :
37 0 : virtual bool MayDelete() const {
38 0 : return tree_manager_->MayDelete();
39 : }
40 :
41 0 : virtual void Shutdown() {
42 0 : tree_manager_->Shutdown();
43 0 : }
44 :
45 0 : virtual void Destroy() {
46 0 : tree_manager_->table_->DestroyTreeManager();
47 0 : }
48 :
49 : private:
50 : McastTreeManager *tree_manager_;
51 : };
52 :
53 : //
54 : // Constructor for McastForwarder. The level is determined by the route type.
55 : // We get the address of the forwarder and the label_block from the attributes
56 : // of the active path. The LabelBLockPtr needs to be copied so that we can
57 : // release the label when processing a delete notification - we won't have the
58 : // path at that point.
59 : //
60 : // The RD will be zero for BGP learnt routes and the RouterId will be zero for
61 : // XMPP learnt routes.
62 : //
63 0 : McastForwarder::McastForwarder(McastSGEntry *sg_entry, ErmVpnRoute *route)
64 0 : : sg_entry_(sg_entry),
65 0 : route_(route),
66 0 : global_tree_route_(NULL),
67 0 : label_(0),
68 0 : address_(0),
69 0 : rd_(route->GetPrefix().route_distinguisher()),
70 0 : router_id_(route->GetPrefix().router_id()) {
71 0 : const BgpPath *path = route->BestPath();
72 0 : const BgpAttr *attr = path->GetAttr();
73 :
74 0 : if (route_->GetPrefix().type() == ErmVpnPrefix::NativeRoute) {
75 0 : level_ = McastTreeManager::LevelNative;
76 0 : address_ = attr->nexthop().to_v4();
77 0 : label_block_ = attr->label_block();
78 : } else {
79 0 : level_ = McastTreeManager::LevelLocal;
80 0 : const EdgeDiscovery::Edge *edge = attr->edge_discovery()->edge_list[0];
81 0 : address_ = edge->address;
82 0 : label_block_ = edge->label_block;
83 : }
84 :
85 0 : if (path->GetAttr()->ext_community())
86 0 : encap_ = path->GetAttr()->ext_community()->GetTunnelEncap();
87 0 : }
88 :
89 : //
90 : // Destructor for McastForwarder. Flushes forward and reverse links to and
91 : // from other McastForwarders.
92 : //
93 0 : McastForwarder::~McastForwarder() {
94 0 : DeleteGlobalTreeRoute();
95 0 : FlushLinks();
96 0 : ReleaseLabel();
97 0 : }
98 :
99 : //
100 : // Update the McastForwarder based on information in the ErmVpnRoute.
101 : // Return true if something changed.
102 : //
103 0 : bool McastForwarder::Update(ErmVpnRoute *route) {
104 0 : McastForwarder forwarder(sg_entry_, route);
105 :
106 0 : bool changed = false;
107 0 : if (label_block_ != forwarder.label_block_) {
108 0 : ReleaseLabel();
109 0 : label_block_ = forwarder.label_block_;
110 0 : changed = true;
111 : }
112 0 : if (address_ != forwarder.address_) {
113 0 : address_ = forwarder.address_;
114 0 : changed = true;
115 : }
116 0 : if (encap_ != forwarder.encap_) {
117 0 : encap_ = forwarder.encap_;
118 0 : changed = true;
119 : }
120 :
121 0 : return changed;
122 0 : }
123 :
124 : //
125 : // Printable string for McastForwarder.
126 : //
127 0 : std::string McastForwarder::ToString() const {
128 0 : if (level_ == McastTreeManager::LevelNative) {
129 0 : return rd_.ToString() + " -> " + integerToString(label_);
130 : } else {
131 0 : return router_id_.to_string() + " -> " + integerToString(label_);
132 : }
133 : }
134 :
135 : //
136 : // Find a link to the given McastForwarder.
137 : //
138 0 : McastForwarder *McastForwarder::FindLink(McastForwarder *forwarder) {
139 0 : for (McastForwarderList::iterator it = tree_links_.begin();
140 0 : it != tree_links_.end(); ++it) {
141 0 : if (*it == forwarder) return forwarder;
142 : }
143 0 : return NULL;
144 : }
145 :
146 : //
147 : // Add a link to the given McastForwarder.
148 : //
149 0 : void McastForwarder::AddLink(McastForwarder *forwarder) {
150 0 : assert(!FindLink(forwarder));
151 0 : tree_links_.push_back(forwarder);
152 0 : }
153 :
154 : //
155 : // Remove a link to the given McastForwarder.
156 : //
157 0 : void McastForwarder::RemoveLink(McastForwarder *forwarder) {
158 0 : for (McastForwarderList::iterator it = tree_links_.begin();
159 0 : it != tree_links_.end(); ++it) {
160 0 : if (*it == forwarder) {
161 0 : tree_links_.erase(it);
162 0 : return;
163 : }
164 : }
165 : }
166 :
167 : //
168 : // Flush all links from this McastForwarder. Takes care of removing the
169 : // reverse links as well.
170 : //
171 0 : void McastForwarder::FlushLinks() {
172 0 : for (McastForwarderList::iterator it = tree_links_.begin();
173 0 : it != tree_links_.end(); ++it) {
174 0 : (*it)->RemoveLink(this);
175 : }
176 0 : tree_links_.clear();
177 0 : }
178 :
179 : //
180 : // Allocate a label for this McastForwarder. The label gets allocated from
181 : // the LabelBlock corresponding to the label range advertised by the peer.
182 : // This is used when updating the distribution tree for the McastSGEntry to
183 : // this McastForwarder belongs.
184 : //
185 0 : void McastForwarder::AllocateLabel() {
186 0 : label_ = label_block_->AllocateLabel();
187 0 : }
188 :
189 : //
190 : // Release the label, if any, for this McastForwarder. This is required when
191 : // updating the distribution tree for the McastSGEntry to which we belong.
192 : //
193 0 : void McastForwarder::ReleaseLabel() {
194 0 : if (label_ != 0) {
195 0 : label_block_->ReleaseLabel(label_);
196 0 : label_ = 0;
197 : }
198 0 : }
199 :
200 : //
201 : // Add the GlobalTreeRoute for this McastForwarder. The GlobalTreeRoute is
202 : // used by the tree builder to tell the associated control-node about the
203 : // forwarding edges for Native McastForwarders attached it.
204 : //
205 0 : void McastForwarder::AddGlobalTreeRoute() {
206 0 : assert(level_ == McastTreeManager::LevelLocal);
207 0 : assert(!global_tree_route_);
208 :
209 : // Bail if there's no label allocated.
210 0 : if (label_ == 0)
211 0 : return;
212 :
213 : // Bail if we can't build a source RD.
214 0 : if (sg_entry_->GetSourceRd().IsZero())
215 0 : return;
216 :
217 : // Construct the prefix and route key.
218 0 : BgpTable *table = static_cast<BgpTable *>(route_->get_table());
219 : ErmVpnPrefix prefix(ErmVpnPrefix::GlobalTreeRoute,
220 0 : RouteDistinguisher::kZeroRd, router_id_,
221 0 : sg_entry_->group(), sg_entry_->source());
222 0 : ErmVpnRoute rt_key(prefix);
223 :
224 : // Find or create the route.
225 0 : McastManagerPartition *partition = sg_entry_->partition();
226 : DBTablePartition *tbl_partition =
227 0 : static_cast<DBTablePartition *>(partition->GetTablePartition());
228 : ErmVpnRoute *route =
229 0 : static_cast<ErmVpnRoute *>(tbl_partition->Find(&rt_key));
230 0 : if (!route) {
231 0 : route = new ErmVpnRoute(prefix);
232 0 : tbl_partition->Add(route);
233 : } else {
234 0 : route->ClearDelete();
235 : }
236 :
237 : // Build the attributes. Need to go through the tree links to build the
238 : // EdgeForwardingSpec.
239 0 : BgpServer *server = table->routing_instance()->server();
240 0 : BgpAttrSpec attr_spec;
241 0 : BgpAttrNextHop nexthop(server->bgp_identifier());
242 0 : attr_spec.push_back(&nexthop);
243 0 : BgpAttrSourceRd source_rd(sg_entry_->GetSourceRd());
244 0 : attr_spec.push_back(&source_rd);
245 0 : EdgeForwardingSpec efspec;
246 0 : for (McastForwarderList::const_iterator it = tree_links_.begin();
247 0 : it != tree_links_.end(); ++it) {
248 0 : EdgeForwardingSpec::Edge *edge = new EdgeForwardingSpec::Edge;
249 0 : edge->SetInboundIp4Address(address_);
250 0 : edge->inbound_label = label_;
251 0 : edge->SetOutboundIp4Address((*it)->address());
252 0 : edge->outbound_label = (*it)->label();
253 0 : efspec.edge_list.push_back(edge);
254 : }
255 0 : attr_spec.push_back(&efspec);
256 : // Add tunnel encaps for remote nodes
257 0 : ExtCommunitySpec ext;
258 0 : ext.AddTunnelEncaps(encap_);
259 0 : if (!ext.communities.empty())
260 0 : attr_spec.push_back(&ext);
261 0 : BgpAttrPtr attr = server->attr_db()->Locate(attr_spec);
262 :
263 : // Add a path with source BgpPath::Local.
264 0 : BgpPath *path = new BgpPath(0, BgpPath::Local, attr);
265 0 : route->InsertPath(path);
266 0 : tbl_partition->Notify(route);
267 0 : global_tree_route_ = route;
268 0 : }
269 :
270 : //
271 : // Delete the GlobalTreeRoute for this McastForwarder.
272 : //
273 0 : void McastForwarder::DeleteGlobalTreeRoute() {
274 0 : if (!global_tree_route_)
275 0 : return;
276 :
277 0 : McastManagerPartition *partition = sg_entry_->partition();
278 : DBTablePartition *tbl_partition =
279 0 : static_cast<DBTablePartition *>(partition->GetTablePartition());
280 0 : global_tree_route_->RemovePath(BgpPath::Local);
281 :
282 0 : if (!global_tree_route_->HasPaths()) {
283 0 : tbl_partition->Delete(global_tree_route_);
284 : } else {
285 0 : tbl_partition->Notify(global_tree_route_);
286 : }
287 0 : global_tree_route_ = NULL;
288 : }
289 :
290 : //
291 : // Append list of BgpOListElems from the Local tree to the BgpOListSpec. The
292 : // list is built based on the tree links in this McastForwarder.
293 : //
294 0 : void McastForwarder::AddLocalOListElems(BgpOListSpec *olist_spec) {
295 0 : assert(level_ == McastTreeManager::LevelNative);
296 :
297 0 : for (McastForwarderList::const_iterator it = tree_links_.begin();
298 0 : it != tree_links_.end(); ++it) {
299 0 : BgpOListElem elem((*it)->address(), (*it)->label(), (*it)->encap());
300 0 : olist_spec->elements.push_back(elem);
301 0 : }
302 0 : }
303 :
304 : //
305 : // Append list of BgpOListElems from the Global tree to the BgpOListSpec. The
306 : // list is built based on EdgeForwarding attribute in the GlobalTreeRoute.
307 : //
308 0 : void McastForwarder::AddGlobalOListElems(BgpOListSpec *olist_spec) {
309 0 : assert(level_ == McastTreeManager::LevelNative);
310 :
311 : // Bail if this is not the forest node for the Local tree.
312 0 : if (!sg_entry_->IsForestNode(this))
313 0 : return;
314 :
315 0 : const ErmVpnRoute *route = sg_entry_->tree_result_route();
316 0 : if (!route)
317 0 : return;
318 :
319 0 : const BgpPath *path = route->BestPath();
320 0 : if (!path)
321 0 : return;
322 0 : const BgpAttr *attr = path->GetAttr();
323 0 : vector<string> encaps;
324 0 : if (attr && attr->ext_community())
325 0 : encaps = attr->ext_community()->GetTunnelEncap();
326 :
327 : // Go through each forwarding edge and add it to the list.
328 0 : const EdgeForwarding *eforwarding = path->GetAttr()->edge_forwarding();
329 0 : for (EdgeForwarding::EdgeList::const_iterator it =
330 0 : eforwarding->edge_list.begin(); it != eforwarding->edge_list.end();
331 0 : ++it) {
332 0 : const EdgeForwarding::Edge *edge = *it;
333 0 : if (edge->inbound_address == address_) {
334 0 : BgpOListElem elem(edge->outbound_address, edge->outbound_label,
335 0 : encaps);
336 0 : olist_spec->elements.push_back(elem);
337 0 : }
338 : }
339 0 : }
340 :
341 : //
342 : // Construct an UpdateInfo with the RibOutAttr that needs to be advertised to
343 : // the IPeer for the ErmVpnRoute associated with this McastForwarder. This is
344 : // used as Export method of the ErmVpnTable. It is expected that the caller
345 : // fills in the target RibPeerSet in the UpdateInfo.
346 : //
347 : // The main functionality here is to transform the McastForwarderList for the
348 : // distribution tree and the EdgeForwarding attribute from the GlobalTreeRoute
349 : // into a BgpOList.
350 : //
351 0 : UpdateInfo *McastForwarder::GetUpdateInfo(ErmVpnTable *table) {
352 0 : CHECK_CONCURRENCY("db::DBTable");
353 :
354 0 : assert(level_ == McastTreeManager::LevelNative);
355 :
356 0 : BgpOListSpec olist_spec(BgpAttribute::OList);
357 0 : AddLocalOListElems(&olist_spec);
358 0 : AddGlobalOListElems(&olist_spec);
359 :
360 : // Bail if there is no label allocated.
361 0 : if (label_ == 0)
362 0 : return NULL;
363 :
364 0 : BgpAttrSpec attr_spec;
365 0 : attr_spec.push_back(&olist_spec);
366 0 : BgpAttrPtr attr = table->server()->attr_db()->Locate(attr_spec);
367 :
368 0 : UpdateInfo *uinfo = new UpdateInfo;
369 0 : uinfo->roattr = RibOutAttr(table, route_, attr.get(), label_, true, true);
370 0 : if (route_ && sg_entry_->IsForestNode(this) &&
371 0 : sg_entry_->IsTreeBuilder(McastTreeManager::LevelLocal)) {
372 0 : table->GetMvpnSourceAddress(route_, uinfo->roattr.source_address());
373 : }
374 0 : return uinfo;
375 0 : }
376 :
377 : //
378 : // Constructor for McastSGEntry.
379 : //
380 0 : McastSGEntry::McastSGEntry(McastManagerPartition *partition,
381 0 : Ip4Address group, Ip4Address source)
382 0 : : partition_(partition),
383 0 : group_(group),
384 0 : source_(source),
385 0 : forest_node_(NULL),
386 0 : local_tree_route_(NULL),
387 0 : tree_result_route_(NULL),
388 0 : on_work_queue_(false) {
389 0 : for (int level = McastTreeManager::LevelFirst;
390 0 : level < McastTreeManager::LevelCount; ++level) {
391 0 : ForwarderSet *forwarders = new ForwarderSet;
392 0 : forwarder_sets_.push_back(forwarders);
393 0 : update_needed_.push_back(false);
394 : }
395 0 : }
396 :
397 : //
398 : // Destructor for McastSGEntry.
399 : //
400 0 : McastSGEntry::~McastSGEntry() {
401 0 : STLDeleteValues(&forwarder_sets_);
402 0 : }
403 :
404 : //
405 : // Printable string for McastSGEntry.
406 : //
407 0 : std::string McastSGEntry::ToString() const {
408 0 : return group_.to_string() + "," + source_.to_string();
409 : }
410 :
411 : //
412 : // Add the given McastForwarder under this McastSGEntry and trigger update
413 : // of the distribution tree.
414 : //
415 0 : void McastSGEntry::AddForwarder(McastForwarder *forwarder) {
416 0 : uint8_t level = forwarder->level();
417 0 : forwarder_sets_[level]->insert(forwarder);
418 0 : update_needed_[level] = true;
419 0 : partition_->EnqueueSGEntry(this);
420 0 : }
421 :
422 : //
423 : // Handle change for the given McastForwarder under this McastSGEntry. Trigger
424 : // update of the distribution tree.
425 : //
426 : // Note that this method only handles the change = the caller determines that
427 : // there has been a change.
428 : //
429 0 : void McastSGEntry::ChangeForwarder(McastForwarder *forwarder) {
430 0 : uint8_t level = forwarder->level();
431 0 : update_needed_[level] = true;
432 0 : partition_->EnqueueSGEntry(this);
433 0 : }
434 :
435 : //
436 : // Delete the given McastForwarder from this McastSGEntry and trigger update
437 : // of the distribution tree.
438 : //
439 0 : void McastSGEntry::DeleteForwarder(McastForwarder *forwarder) {
440 0 : if (forwarder == forest_node_)
441 0 : forest_node_ = NULL;
442 0 : uint8_t level = forwarder->level();
443 0 : forwarder_sets_[level]->erase(forwarder);
444 0 : update_needed_[level] = true;
445 0 : partition_->EnqueueSGEntry(this);
446 0 : }
447 :
448 : //
449 : // Get the SourceRD to be used when adding [Local|Global]TreeRoutes. This
450 : // SourceRD gets used as the RD when the ErmVpnRoute is replicated from the
451 : // VRF table to the VPN table.
452 : //
453 : // We simply use the RD for the forest node.
454 : //
455 0 : const RouteDistinguisher &McastSGEntry::GetSourceRd() const {
456 0 : if (!forest_node_)
457 0 : return RouteDistinguisher::kZeroRd;
458 0 : return forest_node_->route()->GetPrefix().route_distinguisher();
459 : }
460 :
461 : //
462 : // Add the LocalTreeRoute for this McastSGEntry. This route advertises a set
463 : // of candidate edges from McastForwarders attached to this control-node that
464 : // can be used by the tree builder to build the higher level tree. We simply
465 : // advertise edges McastTreeManager::kDegree - 1 edges from the forest node.
466 : //
467 : // We advertise kDegree-1 candidate edges via the EdgeDiscovery attribute. All
468 : // the edges are for the forest node for the tree of native McastForwarders.
469 : // The label block for each edge in the EdgeDiscovery attribute is of size 1 -
470 : // this is label that has been allocated for the forest node. Using a single
471 : // label is acceptable because the tree builder algorithm does not change the
472 : // relative order of nodes in the tree.
473 : //
474 0 : void McastSGEntry::AddLocalTreeRoute() {
475 0 : assert(!forest_node_);
476 0 : assert(!local_tree_route_);
477 :
478 : // Select last usable leaf in the distribution tree as the forest node.
479 : // A leaf is considered usable if it has a valid label i.e. it has not
480 : // run out of labels.
481 0 : uint8_t level = McastTreeManager::LevelNative;
482 0 : ForwarderSet *forwarders = forwarder_sets_[level];
483 0 : for (ForwarderSet::reverse_iterator rit = forwarders->rbegin();
484 0 : rit != forwarders->rend(); ++rit) {
485 0 : McastForwarder *forwarder = *rit;
486 0 : if (forwarder->label()) {
487 0 : forest_node_ = forwarder;
488 0 : break;
489 : }
490 : }
491 :
492 : // Bail if we couldn't designate a forest node.
493 0 : if (!forest_node_)
494 0 : return;
495 :
496 : // Construct the prefix and route key.
497 0 : BgpServer *server = partition_->server();
498 0 : Ip4Address router_id(server->bgp_identifier());
499 : ErmVpnPrefix prefix(ErmVpnPrefix::LocalTreeRoute,
500 0 : RouteDistinguisher::kZeroRd, router_id, group_, source_);
501 0 : ErmVpnRoute rt_key(prefix);
502 :
503 : // Find or create the route.
504 : DBTablePartition *tbl_partition =
505 0 : static_cast<DBTablePartition *>(partition_->GetTablePartition());
506 : ErmVpnRoute *route =
507 0 : static_cast<ErmVpnRoute *>(tbl_partition->Find(&rt_key));
508 0 : if (!route) {
509 0 : route = new ErmVpnRoute(prefix);
510 0 : tbl_partition->Add(route);
511 : } else {
512 0 : route->ClearDelete();
513 : }
514 :
515 : // Build the attributes.
516 0 : BgpAttrSpec attr_spec;
517 0 : BgpAttrNextHop nexthop(server->bgp_identifier());
518 0 : attr_spec.push_back(&nexthop);
519 0 : BgpAttrSourceRd source_rd(GetSourceRd());
520 0 : attr_spec.push_back(&source_rd);
521 0 : EdgeDiscoverySpec edspec;
522 0 : for (int idx = 1; idx <= McastTreeManager::kDegree - 1; ++idx) {
523 0 : EdgeDiscoverySpec::Edge *edge = new EdgeDiscoverySpec::Edge;
524 0 : edge->SetIp4Address(forest_node_->address());
525 0 : edge->SetLabels(forest_node_->label(), forest_node_->label());
526 0 : edspec.edge_list.push_back(edge);
527 : }
528 0 : attr_spec.push_back(&edspec);
529 : // Add tunnel encaps for remote nodes
530 0 : ExtCommunitySpec ext;
531 0 : ext.AddTunnelEncaps(forest_node_->encap());
532 0 : if (!ext.communities.empty())
533 0 : attr_spec.push_back(&ext);
534 0 : BgpAttrPtr attr = server->attr_db()->Locate(attr_spec);
535 :
536 : // Add a path with source BgpPath::Local.
537 0 : BgpPath *path = new BgpPath(0, BgpPath::Local, attr);
538 0 : route->InsertPath(path);
539 0 : tbl_partition->Notify(route);
540 0 : local_tree_route_ = route;
541 0 : }
542 :
543 : //
544 : // Delete the LocalTreeRoute for this McastSGEntry.
545 : //
546 0 : void McastSGEntry::DeleteLocalTreeRoute() {
547 0 : if (!local_tree_route_)
548 0 : return;
549 :
550 0 : forest_node_ = NULL;
551 : DBTablePartition *tbl_partition =
552 0 : static_cast<DBTablePartition *>(partition_->GetTablePartition());
553 0 : local_tree_route_->RemovePath(BgpPath::Local);
554 0 : if (!local_tree_route_->HasPaths()) {
555 0 : tbl_partition->Delete(local_tree_route_);
556 : } else {
557 0 : tbl_partition->Notify(local_tree_route_);
558 : }
559 0 : local_tree_route_ = NULL;
560 : }
561 :
562 : //
563 : // Update the LocalTreeRoute for this McastSGEntry if RouterId has changed.
564 : //
565 0 : void McastSGEntry::UpdateLocalTreeRoute() {
566 0 : if (!local_tree_route_)
567 0 : return;
568 :
569 : // Bail if the RouterId hasn't changed.
570 0 : const BgpServer *server = partition_->server();
571 0 : Ip4Address router_id = local_tree_route_->GetPrefix().router_id();
572 0 : if (router_id.to_ulong() == server->bgp_identifier())
573 0 : return;
574 :
575 : // Add and delete the route.
576 0 : DeleteLocalTreeRoute();
577 0 : AddLocalTreeRoute();
578 : }
579 :
580 : //
581 : // Update relevant [Local|Global]TreeRoutes for the McastSGEntry.
582 : //
583 0 : void McastSGEntry::UpdateRoutes(uint8_t level) {
584 0 : if (level == McastTreeManager::LevelNative) {
585 0 : DeleteLocalTreeRoute();
586 0 : AddLocalTreeRoute();
587 : } else {
588 0 : ForwarderSet *forwarders = forwarder_sets_[level];
589 0 : for (ForwarderSet::iterator it = forwarders->begin();
590 0 : it != forwarders->end(); ++it) {
591 0 : (*it)->DeleteGlobalTreeRoute();
592 0 : (*it)->AddGlobalTreeRoute();
593 : }
594 : }
595 0 : }
596 :
597 0 : ErmVpnRoute *McastSGEntry::GetGlobalTreeRootRoute() const {
598 0 : if (!IsTreeBuilder(McastTreeManager::LevelLocal))
599 0 : return NULL;
600 0 : ForwarderSet *forwarders = forwarder_sets_[McastTreeManager::LevelLocal];
601 0 : assert(!forwarders->empty());
602 0 : ForwarderSet::const_iterator it = forwarders->begin();
603 0 : return (*it)->global_tree_route();
604 : }
605 :
606 : //
607 : // Implement tree builder election.
608 : //
609 0 : bool McastSGEntry::IsTreeBuilder(uint8_t level) const {
610 0 : if (level == McastTreeManager::LevelNative)
611 0 : return true;
612 :
613 0 : const ForwarderSet *forwarders = forwarder_sets_[level];
614 0 : ForwarderSet::const_iterator it = forwarders->begin();
615 0 : if (it == forwarders->end())
616 0 : return false;
617 :
618 0 : Ip4Address router_id(partition_->server()->bgp_identifier());
619 0 : if ((*it)->router_id() != router_id)
620 0 : return false;
621 :
622 0 : return true;
623 : }
624 :
625 : //
626 : //
627 : // Update specified distribution tree for the McastSGEntry. We traverse all
628 : // McastForwarders in sorted order and arrange them in breadth first fashion
629 : // in a k-ary tree. Building the tree in this manner guarantees that we get
630 : // the same tree for a given set of forwarders, independent of the order in
631 : // in which they joined. This predictability is deemed to be more important
632 : // than other criteria such as minimizing disruption of traffic, minimizing
633 : // the cost/weight of the tree etc.
634 : //
635 0 : void McastSGEntry::UpdateTree(uint8_t level) {
636 0 : CHECK_CONCURRENCY("db::DBTable");
637 :
638 0 : if (!update_needed_[level])
639 0 : return;
640 0 : update_needed_[level] = false;
641 :
642 : int degree;
643 0 : if (level == McastTreeManager::LevelNative) {
644 0 : degree = McastTreeManager::kDegree;
645 : } else {
646 0 : degree = McastTreeManager::kDegree - 1;
647 : }
648 :
649 : // First get rid of the previous distribution tree and enqueue all the
650 : // associated ErmVpnRoutes for notification. Note that DBListeners will
651 : // not get invoked until after this routine is done.
652 0 : ForwarderSet *forwarders = forwarder_sets_[level];
653 0 : for (ForwarderSet::iterator it = forwarders->begin();
654 0 : it != forwarders->end(); ++it) {
655 0 : (*it)->FlushLinks();
656 0 : (*it)->ReleaseLabel();
657 0 : partition_->GetTablePartition()->Notify((*it)->route());
658 : }
659 :
660 : // Bail if we're not the tree builder.
661 0 : if (!IsTreeBuilder(level)) {
662 0 : UpdateRoutes(level);
663 0 : return;
664 : }
665 :
666 : // Create a vector of pointers to the McastForwarders in sorted order.
667 : // We do this because std::set doesn't support random access iterators.
668 : // Skip if we can't allocate a label for the McastForwarder.
669 0 : McastForwarderList vec;
670 0 : vec.reserve(forwarders->size());
671 0 : for (ForwarderSet::iterator it = forwarders->begin();
672 0 : it != forwarders->end(); ++it) {
673 0 : McastForwarder *forwarder = *it;
674 0 : forwarder->AllocateLabel();
675 0 : if (!forwarder->label())
676 0 : continue;
677 0 : vec.push_back(forwarder);
678 : }
679 :
680 : // Go through each McastForwarder in the vector and link it to it's parent
681 : // McastForwarder in the k-ary tree. We also add a link from the parent to
682 : // the entry in question.
683 0 : for (McastForwarderList::iterator it = vec.begin(); it != vec.end(); ++it) {
684 0 : int idx = it - vec.begin();
685 0 : if (idx == 0)
686 0 : continue;
687 :
688 0 : int parent_idx = (idx - 1) / degree;
689 0 : McastForwarderList::iterator parent_it = vec.begin() + parent_idx;
690 0 : assert(parent_it != vec.end());
691 0 : McastForwarder *forwarder = *it;
692 0 : McastForwarder *parent_forwarder = *parent_it;
693 0 : forwarder->AddLink(parent_forwarder);
694 0 : parent_forwarder->AddLink(forwarder);
695 : }
696 :
697 : // Update [Local|Global]TreeRoutes.
698 0 : UpdateRoutes(level);
699 0 : }
700 :
701 : //
702 : // Update distribution trees for both levels.
703 : //
704 0 : void McastSGEntry::UpdateTree() {
705 0 : for (uint8_t level = McastTreeManager::LevelFirst;
706 0 : level < McastTreeManager::LevelCount; ++level) {
707 0 : UpdateTree(level);
708 : }
709 0 : }
710 :
711 : //
712 : // Trigger notification of the ErmVpnRoute associated with the McastForwarder
713 : // that is the forest node. This is used to trigger a rebuild of the BgpOlist
714 : // when the GlobalTreeRoute is updated.
715 : //
716 0 : void McastSGEntry::NotifyForestNode() {
717 0 : if (!forest_node_)
718 0 : return;
719 0 : partition_->GetTablePartition()->Notify(forest_node_->route());
720 : }
721 :
722 0 : bool McastSGEntry::GetForestNodePMSI(uint32_t *label, Ip4Address *address,
723 : vector<string> *tunnel_encap) const {
724 0 : if (!forest_node_)
725 0 : return false;
726 0 : *label = forest_node_->label();
727 0 : *address = forest_node_->address();
728 0 : *tunnel_encap = forest_node_->encap();
729 0 : return true;
730 : }
731 :
732 0 : bool McastSGEntry::IsForestNode(McastForwarder *forwarder) {
733 0 : return (forwarder == forest_node_);
734 : }
735 :
736 0 : bool McastSGEntry::empty() const {
737 0 : if (local_tree_route_ || tree_result_route_)
738 0 : return false;
739 0 : if (!forwarder_sets_[McastTreeManager::LevelNative]->empty())
740 0 : return false;
741 0 : if (!forwarder_sets_[McastTreeManager::LevelLocal]->empty())
742 0 : return false;
743 0 : return true;
744 : }
745 :
746 : //
747 : // Constructor for McastManagerPartition.
748 : //
749 0 : McastManagerPartition::McastManagerPartition(McastTreeManager *tree_manager,
750 0 : size_t part_id)
751 0 : : tree_manager_(tree_manager),
752 0 : part_id_(part_id),
753 0 : update_count_(0),
754 0 : work_queue_(TaskScheduler::GetInstance()->GetTaskId("db::DBTable"),
755 0 : part_id_,
756 0 : boost::bind(&McastManagerPartition::ProcessSGEntry, this, _1)) {
757 0 : }
758 :
759 : //
760 : // Destructor for McastManagerPartition.
761 : //
762 0 : McastManagerPartition::~McastManagerPartition() {
763 0 : work_queue_.Shutdown();
764 0 : }
765 :
766 : // Find the McastSGEntry for the given group and source.
767 0 : McastSGEntry *McastManagerPartition::FindSGEntry(
768 : const Ip4Address &group, const Ip4Address &source) {
769 : return const_cast<McastSGEntry *>(
770 0 : static_cast<const McastManagerPartition *>(this)->FindSGEntry(group,
771 0 : source));
772 : }
773 :
774 : //
775 : // Find the McastSGEntry for the given group and source.
776 : //
777 0 : const McastSGEntry *McastManagerPartition::FindSGEntry(
778 : const Ip4Address &group, const Ip4Address &source) const {
779 : McastSGEntry temp_sg_entry(const_cast<McastManagerPartition *>(this),
780 0 : group, source);
781 0 : SGList::const_iterator it = sg_list_.find(&temp_sg_entry);
782 0 : return (it != sg_list_.end() ? *it : NULL);
783 0 : }
784 :
785 : //
786 : // Find or create the McastSGEntry for the given group and source.
787 : //
788 0 : McastSGEntry *McastManagerPartition::LocateSGEntry(
789 : Ip4Address group, Ip4Address source) {
790 0 : McastSGEntry *sg_entry = FindSGEntry(group, source);
791 0 : if (!sg_entry) {
792 0 : sg_entry = new McastSGEntry(this, group, source);
793 0 : sg_list_.insert(sg_entry);
794 : }
795 0 : return sg_entry;
796 : }
797 :
798 0 : ErmVpnRoute *McastManagerPartition::GetGlobalTreeRootRoute(
799 : const Ip4Address &source, const Ip4Address &group) const {
800 0 : const McastSGEntry *sg = FindSGEntry(group, source);
801 0 : return sg ? sg->GetGlobalTreeRootRoute() : NULL;
802 : }
803 :
804 0 : void McastManagerPartition::NotifyForestNode(
805 : const Ip4Address &source, const Ip4Address &group) {
806 0 : McastSGEntry *sg = FindSGEntry(group, source);
807 0 : if (sg)
808 0 : sg->NotifyForestNode();
809 0 : }
810 :
811 0 : bool McastManagerPartition::GetForestNodePMSI(ErmVpnRoute *rt, uint32_t *label,
812 : Ip4Address *address, vector<string> *encap) const {
813 0 : const McastSGEntry *sg = FindSGEntry(rt->GetPrefix().group(),
814 0 : rt->GetPrefix().source());
815 0 : return sg ? sg->GetForestNodePMSI(label, address, encap) : false;
816 : }
817 :
818 : //
819 : // Enqueue the given McastSGEntry on the WorkQueue if it's not already on it.
820 : //
821 0 : void McastManagerPartition::EnqueueSGEntry(McastSGEntry *sg_entry) {
822 0 : if (sg_entry->on_work_queue())
823 0 : return;
824 0 : work_queue_.Enqueue(sg_entry);
825 0 : sg_entry->set_on_work_queue();
826 : }
827 :
828 : //
829 : // Callback for the WorkQueue. Updates distribution trees for the McastSGEntry.
830 : // Also gets rid of the McastSGEntry if it is eligible to be deleted.
831 : //
832 0 : bool McastManagerPartition::ProcessSGEntry(McastSGEntry *sg_entry) {
833 0 : CHECK_CONCURRENCY("db::DBTable");
834 :
835 0 : sg_entry->clear_on_work_queue();
836 0 : sg_entry->UpdateTree();
837 0 : update_count_++;
838 :
839 0 : if (sg_entry->empty()) {
840 0 : sg_list_.erase(sg_entry);
841 0 : delete sg_entry;
842 : }
843 :
844 0 : if (sg_list_.empty())
845 0 : tree_manager_->RetryDelete();
846 :
847 0 : return true;
848 : }
849 :
850 : //
851 : // Get the DBTablePartBase for the ErmVpnTable for our partition id.
852 : //
853 0 : DBTablePartBase *McastManagerPartition::GetTablePartition() {
854 0 : return tree_manager_->GetTablePartition(part_id_);
855 : }
856 :
857 0 : const RoutingInstance *McastManagerPartition::routing_instance() const {
858 0 : return tree_manager_->table()->routing_instance();
859 : }
860 :
861 0 : BgpServer *McastManagerPartition::server() {
862 0 : return tree_manager_->table()->server();
863 : }
864 :
865 0 : const BgpServer *McastManagerPartition::server() const {
866 0 : return tree_manager_->table()->server();
867 : }
868 :
869 : //
870 : // Constructor for McastTreeManager.
871 : //
872 0 : McastTreeManager::McastTreeManager(ErmVpnTable *table)
873 0 : : table_(table),
874 0 : listener_id_(DBTable::kInvalidId),
875 0 : table_delete_ref_(this, table->deleter()) {
876 0 : deleter_.reset(new DeleteActor(this));
877 0 : }
878 :
879 : //
880 : // Destructor for McastTreeManager.
881 : //
882 0 : McastTreeManager::~McastTreeManager() {
883 0 : }
884 :
885 : //
886 : // Initialize the McastTreeManager. We allocate the McastManagerPartitions
887 : // and register a DBListener for the ErmVpnTable.
888 : //
889 0 : void McastTreeManager::Initialize() {
890 0 : AllocPartitions();
891 0 : listener_id_ = table_->Register(
892 : boost::bind(&McastTreeManager::RouteListener, this, _1, _2),
893 : "McastTreeManager");
894 0 : }
895 :
896 : //
897 : // Terminate the McastTreeManager. We free the McastManagerPartitions
898 : // and unregister from the ErmVpnTable.
899 : //
900 0 : void McastTreeManager::Terminate() {
901 0 : table_->Unregister(listener_id_);
902 0 : FreePartitions();
903 0 : }
904 :
905 : //
906 : // Allocate the McastManagerPartitions.
907 : //
908 0 : void McastTreeManager::AllocPartitions() {
909 0 : for (int part_id = 0; part_id < table_->PartitionCount(); part_id++) {
910 0 : partitions_.push_back(new McastManagerPartition(this, part_id));
911 : }
912 0 : }
913 :
914 : //
915 : // Free the McastManagerPartitions.
916 : //
917 0 : void McastTreeManager::FreePartitions() {
918 0 : for (size_t part_id = 0; part_id < partitions_.size(); part_id++) {
919 0 : delete partitions_[part_id];
920 : }
921 0 : partitions_.clear();
922 0 : }
923 :
924 0 : McastManagerPartition *McastTreeManager::GetPartition(int part_id) {
925 0 : return partitions_[part_id];
926 : }
927 :
928 0 : const McastManagerPartition *McastTreeManager::GetPartition(int part_id) const {
929 0 : return partitions_[part_id];
930 : }
931 :
932 : //
933 : // Get the DBTablePartBase for the ErmVpnTable for given partition id.
934 : //
935 0 : DBTablePartBase *McastTreeManager::GetTablePartition(size_t part_id) {
936 0 : return table_->GetTablePartition(part_id);
937 : }
938 :
939 : //
940 : // Construct export state for the given ErmVpnRoute. Note that the route
941 : // only needs to be exported to the IPeer from which it was learnt.
942 : //
943 0 : UpdateInfo *McastTreeManager::GetUpdateInfo(ErmVpnRoute *route) {
944 0 : CHECK_CONCURRENCY("db::DBTable");
945 :
946 0 : DBState *dbstate = route->GetState(table_, listener_id_);
947 0 : McastForwarder *forwarder = dynamic_cast<McastForwarder *>(dbstate);
948 :
949 0 : if (!forwarder)
950 0 : return NULL;
951 :
952 0 : return forwarder->GetUpdateInfo(table_);
953 : }
954 :
955 : //
956 : // DBListener callback handler for Native and Local routes in the ErmVpnTable.
957 : // It creates, updates or deletes the associated McastForwarder as appropriate.
958 : //
959 : // Creates a McastSGEntry if one doesn't already exist. However, McastSGEntrys
960 : // don't get deleted from here. They only get deleted from WorkQueue callback
961 : // routine i.e. McastManagerPartition::ProcessSGEntry.
962 : //
963 0 : void McastTreeManager::TreeNodeListener(McastManagerPartition *partition,
964 : ErmVpnRoute *route) {
965 0 : CHECK_CONCURRENCY("db::DBTable");
966 :
967 0 : DBState *dbstate = route->GetState(table_, listener_id_);
968 0 : if (!dbstate) {
969 : // We have no previous DBState for this route.
970 : // Bail if the route is not valid.
971 0 : if (!route->IsValid())
972 0 : return;
973 :
974 : // Create a new McastForwarder and associate it with the route.
975 0 : McastSGEntry *sg_entry = partition->LocateSGEntry(
976 0 : route->GetPrefix().group(), route->GetPrefix().source());
977 0 : McastForwarder *forwarder = new McastForwarder(sg_entry, route);
978 0 : sg_entry->AddForwarder(forwarder);
979 0 : route->SetState(table_, listener_id_, forwarder);
980 :
981 : // Update local tree route if our RouterId has changed. Ideally,
982 : // we should trigger an update of all local trees routes when we
983 : // detect a change in RouterId. Instead, we currently check and
984 : // update the local route when we detect a new local route from
985 : // another node.
986 0 : if (route->GetPrefix().type() == ErmVpnPrefix::LocalTreeRoute)
987 0 : sg_entry->UpdateLocalTreeRoute();
988 : } else {
989 0 : McastSGEntry *sg_entry = partition->FindSGEntry(
990 0 : route->GetPrefix().group(), route->GetPrefix().source());
991 0 : assert(sg_entry);
992 0 : McastForwarder *forwarder = dynamic_cast<McastForwarder *>(dbstate);
993 0 : assert(forwarder);
994 :
995 0 : if (!route->IsValid()) {
996 : // Delete the McastForwarder associated with the route.
997 0 : route->ClearState(table_, listener_id_);
998 0 : sg_entry->DeleteForwarder(forwarder);
999 0 : delete forwarder;
1000 0 : } else if (forwarder->Update(route)) {
1001 : // Trigger update of the distribution tree.
1002 0 : sg_entry->ChangeForwarder(forwarder);
1003 : }
1004 : }
1005 : }
1006 :
1007 : //
1008 : // DBListener callback handler for GlobalTreeRoutes in the ErmVpnTable. It
1009 : // updates the tree_result_route_ and triggers re-evaluation of the forest
1010 : // node McastForwarder's BgpOlist.
1011 : //
1012 0 : void McastTreeManager::TreeResultListener(McastManagerPartition *partition,
1013 : ErmVpnRoute *route) {
1014 0 : CHECK_CONCURRENCY("db::DBTable");
1015 :
1016 0 : DBState *dbstate = route->GetState(table_, listener_id_);
1017 0 : if (!dbstate) {
1018 : // We have no previous DBState for this route.
1019 : // Bail if the route is not valid.
1020 0 : if (!route->IsValid())
1021 0 : return;
1022 :
1023 : // Ignore GlobalTreeRoute if it's not applicable to this control-node.
1024 0 : BgpServer *server = table_->routing_instance()->server();
1025 0 : if (route->GetPrefix().router_id().to_ulong() !=
1026 0 : server->bgp_identifier())
1027 0 : return;
1028 :
1029 0 : McastSGEntry *sg_entry = partition->LocateSGEntry(
1030 0 : route->GetPrefix().group(), route->GetPrefix().source());
1031 0 : route->SetState(table_, listener_id_, sg_entry);
1032 0 : sg_entry->set_tree_result_route(route);
1033 0 : sg_entry->NotifyForestNode();
1034 : } else {
1035 0 : McastSGEntry *sg_entry = dynamic_cast<McastSGEntry *>(dbstate);
1036 0 : assert(sg_entry);
1037 :
1038 0 : if (!route->IsValid()) {
1039 0 : sg_entry->clear_tree_result_route();
1040 0 : route->ClearState(table_, listener_id_);
1041 0 : partition->EnqueueSGEntry(sg_entry);
1042 : }
1043 0 : sg_entry->NotifyForestNode();
1044 : }
1045 : }
1046 :
1047 : //
1048 : // DBListener callback handler for the ErmVpnTable. GlobalTreeRoutes provide
1049 : // result information and hence are handled differently than Native and Local
1050 : // routes, which result in update of a McastForwarder.
1051 : //
1052 0 : void McastTreeManager::RouteListener(
1053 : DBTablePartBase *tpart, DBEntryBase *db_entry) {
1054 0 : CHECK_CONCURRENCY("db::DBTable");
1055 :
1056 0 : McastManagerPartition *partition = partitions_[tpart->index()];
1057 0 : ErmVpnRoute *route = dynamic_cast<ErmVpnRoute *>(db_entry);
1058 0 : if (route->GetPrefix().type() == ErmVpnPrefix::GlobalTreeRoute) {
1059 0 : TreeResultListener(partition, route);
1060 : } else {
1061 0 : TreeNodeListener(partition, route);
1062 : }
1063 0 : }
1064 :
1065 :
1066 : //
1067 : // Check if the McastTreeManager can be deleted. This can happen only if all
1068 : // the McastManagerPartitions are empty.
1069 : //
1070 0 : bool McastTreeManager::MayDelete() const {
1071 0 : CHECK_CONCURRENCY("bgp::Config");
1072 :
1073 0 : for (PartitionList::const_iterator it = partitions_.begin();
1074 0 : it != partitions_.end(); ++it) {
1075 0 : if (!(*it)->empty())
1076 0 : return false;
1077 : }
1078 :
1079 0 : return true;
1080 : }
1081 :
1082 : //
1083 : // Initiate shutdown for the McastTreeManager.
1084 : //
1085 0 : void McastTreeManager::Shutdown() {
1086 0 : CHECK_CONCURRENCY("bgp::Config");
1087 0 : }
1088 :
1089 : //
1090 : // Trigger deletion of the McastTreeManager and propagate the delete to any
1091 : // dependents.
1092 : //
1093 0 : void McastTreeManager::ManagedDelete() {
1094 0 : deleter_->Delete();
1095 0 : }
1096 :
1097 : //
1098 : // Attempt to enqueue a delete for the McastTreeManager.
1099 : //
1100 0 : void McastTreeManager::RetryDelete() {
1101 0 : if (!deleter()->IsDeleted())
1102 0 : return;
1103 0 : deleter()->RetryDelete();
1104 : }
1105 :
1106 : //
1107 : // Return the LifetimeActor for the McastTreeManager.
1108 : //
1109 0 : LifetimeActor *McastTreeManager::deleter() {
1110 0 : return deleter_.get();
1111 : }
1112 :
1113 : //
1114 : // Return the LifetimeActor for the McastTreeManager.
1115 : // Const version.
1116 : //
1117 0 : const LifetimeActor *McastTreeManager::deleter() const {
1118 0 : return deleter_.get();
1119 : }
1120 :
1121 : //
1122 : // Return true if the McastTreeManager is deleted.
1123 : //
1124 0 : bool McastTreeManager::deleted() const {
1125 0 : return deleter_->IsDeleted();
1126 : }
1127 :
1128 0 : ErmVpnRoute *McastTreeManager::GetGlobalTreeRootRoute(
1129 : const Ip4Address &source, const Ip4Address &group) const {
1130 0 : const McastManagerPartition *partition = GetPartition(table_->Hash(group));
1131 0 : return partition->GetGlobalTreeRootRoute(source, group);
1132 : }
1133 :
1134 0 : void McastTreeManager::NotifyForestNode(int part_id, const Ip4Address &source,
1135 : const Ip4Address &group) {
1136 0 : McastManagerPartition *partition = GetPartition(part_id);
1137 0 : partition->NotifyForestNode(source, group);
1138 0 : }
1139 :
1140 0 : bool McastTreeManager::GetForestNodePMSI(ErmVpnRoute *rt, uint32_t *label,
1141 : Ip4Address *address, vector<string> *encap) const {
1142 0 : if (!rt || !rt->IsUsable())
1143 0 : return false;
1144 : const McastManagerPartition *partition =
1145 0 : GetPartition(rt->get_table_partition()->index());
1146 0 : return partition->GetForestNodePMSI(rt, label, address, encap);
1147 : }
|
