blob: 274853ef2ebea643da63fa81edc2dc0137b57074 [file] [log] [blame]
akmhoque3d06e792014-05-27 16:23:20 -05001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Nick Gordonc6a85222017-01-03 16:54:34 -06003 * Copyright (c) 2014-2017, The University of Memphis,
Nick Gordonf8b5bcd2016-08-11 15:06:50 -05004 * Regents of the University of California
akmhoque3d06e792014-05-27 16:23:20 -05005 *
6 * This file is part of NLSR (Named-data Link State Routing).
7 * See AUTHORS.md for complete list of NLSR authors and contributors.
8 *
9 * NLSR is free software: you can redistribute it and/or modify it under the terms
10 * of the GNU General Public License as published by the Free Software Foundation,
11 * either version 3 of the License, or (at your option) any later version.
12 *
13 * NLSR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
14 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along with
18 * NLSR, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
19 *
akmhoque3d06e792014-05-27 16:23:20 -050020 **/
Nick Gordonb7b58392017-08-17 16:29:21 -050021
akmhoquefdbddb12014-05-02 18:35:19 -050022#ifndef NLSR_ROUTING_TABLE_HPP
23#define NLSR_ROUTING_TABLE_HPP
akmhoque53353462014-04-22 08:43:45 -050024
Nick Gordond0a7df32017-05-30 16:44:34 -050025#include "conf-parameter.hpp"
26#include "routing-table-entry.hpp"
Nick Gordonb7b58392017-08-17 16:29:21 -050027#include "signals.hpp"
Nick Gordond0a7df32017-05-30 16:44:34 -050028
akmhoque53353462014-04-22 08:43:45 -050029#include <iostream>
30#include <utility>
31#include <string>
akmhoquefdbddb12014-05-02 18:35:19 -050032#include <boost/cstdint.hpp>
Vince Lehman7c603292014-09-11 17:48:16 -050033#include <ndn-cxx/util/scheduler.hpp>
akmhoque53353462014-04-22 08:43:45 -050034
akmhoque53353462014-04-22 08:43:45 -050035namespace nlsr {
36
37class Nlsr;
38class NextHop;
39
40class RoutingTable
41{
42public:
Nick Gordonb7b58392017-08-17 16:29:21 -050043 RoutingTable(ndn::Scheduler& scheduler);
Vince Lehman7b616582014-10-17 16:25:39 -050044
Nick G97e34942016-07-11 14:46:27 -050045 /*! \brief Calculates a list of next hops for each router in the network.
Nick Gordond0a7df32017-05-30 16:44:34 -050046 * \param pnlsr The NLSR object that contains the LSAs needed for adj. info.
47 *
48 * Calculates the list of next hops to every other router in the network.
49 */
akmhoque53353462014-04-22 08:43:45 -050050 void
51 calculate(Nlsr& pnlsr);
52
Nick G97e34942016-07-11 14:46:27 -050053 /*! \brief Adds a next hop to a routing table entry.
Nick Gordond0a7df32017-05-30 16:44:34 -050054 * \param destRouter The destination router whose RTE we want to modify.
55 * \param nh The next hop to add to the RTE.
56 */
akmhoque53353462014-04-22 08:43:45 -050057 void
akmhoque31d1d4b2014-05-05 22:08:14 -050058 addNextHop(const ndn::Name& destRouter, NextHop& nh);
akmhoque53353462014-04-22 08:43:45 -050059
Nick G97e34942016-07-11 14:46:27 -050060 /*! \brief Adds a next hop to a routing table entry in a dry run scenario.
Nick Gordond0a7df32017-05-30 16:44:34 -050061 * \param destRouter The destination router whose RTE we want to modify.
62 * \param nh The next hop to add to the router.
63 */
akmhoque53353462014-04-22 08:43:45 -050064 void
akmhoque31d1d4b2014-05-05 22:08:14 -050065 addNextHopToDryTable(const ndn::Name& destRouter, NextHop& nh);
akmhoque53353462014-04-22 08:43:45 -050066
akmhoqueb6450b12014-04-24 00:01:03 -050067 RoutingTableEntry*
akmhoque31d1d4b2014-05-05 22:08:14 -050068 findRoutingTableEntry(const ndn::Name& destRouter);
akmhoque53353462014-04-22 08:43:45 -050069
Nick Gordond0a7df32017-05-30 16:44:34 -050070 /*! \brief Schedules a calculation event in the event scheduler only
71 * if one isn't already scheduled.
72 * \param pnlsr The NLSR whose scheduling status is needed.
73 */
akmhoque53353462014-04-22 08:43:45 -050074 void
75 scheduleRoutingTableCalculation(Nlsr& pnlsr);
76
77 int
78 getNoNextHop()
79 {
80 return m_NO_NEXT_HOP;
81 }
82
Vince Lehman7b616582014-10-17 16:25:39 -050083 void
84 setRoutingCalcInterval(uint32_t interval)
85 {
86 m_routingCalcInterval = ndn::time::seconds(interval);
87 }
88
89 const ndn::time::seconds&
90 getRoutingCalcInterval() const
91 {
92 return m_routingCalcInterval;
93 }
94
akmhoque53353462014-04-22 08:43:45 -050095private:
Nick G97e34942016-07-11 14:46:27 -050096 /*! \brief Calculates a link-state routing table. */
akmhoque53353462014-04-22 08:43:45 -050097 void
98 calculateLsRoutingTable(Nlsr& pnlsr);
99
Nick G97e34942016-07-11 14:46:27 -0500100 /*! \brief Calculates a HR routing table. */
akmhoque53353462014-04-22 08:43:45 -0500101 void
102 calculateHypRoutingTable(Nlsr& pnlsr);
103
Nick G97e34942016-07-11 14:46:27 -0500104 /*! \brief Calculates a dry-run HR routing table. */
akmhoque53353462014-04-22 08:43:45 -0500105 void
106 calculateHypDryRoutingTable(Nlsr& pnlsr);
107
108 void
109 clearRoutingTable();
110
111 void
112 clearDryRoutingTable();
113
akmhoque674b0b12014-05-20 14:33:28 -0500114 void
akmhoquedcee9362014-08-05 22:58:01 -0500115 writeLog(int hyperbolicState);
akmhoque674b0b12014-05-20 14:33:28 -0500116
Nick Gordonb7b58392017-08-17 16:29:21 -0500117public:
118 std::shared_ptr<AfterRoutingChange> afterRoutingChange;
119
120PUBLIC_WITH_TESTS_ELSE_PRIVATE:
121 std::list<RoutingTableEntry> m_rTable;
122
Vince Lehman7c603292014-09-11 17:48:16 -0500123private:
124 ndn::Scheduler& m_scheduler;
125
akmhoque53353462014-04-22 08:43:45 -0500126 const int m_NO_NEXT_HOP;
127
akmhoque53353462014-04-22 08:43:45 -0500128 std::list<RoutingTableEntry> m_dryTable;
Vince Lehman7b616582014-10-17 16:25:39 -0500129
130 ndn::time::seconds m_routingCalcInterval;
akmhoque53353462014-04-22 08:43:45 -0500131};
132
Nick Gordonfad8e252016-08-11 14:21:38 -0500133} // namespace nlsr
akmhoque53353462014-04-22 08:43:45 -0500134
Nick Gordond0a7df32017-05-30 16:44:34 -0500135#endif // NLSR_ROUTING_TABLE_HPP