blob: 85cef6c32f490b5d91e9a16a29532bcd73eaf1de [file] [log] [blame]
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
Alexander Afanasyev45b92d42011-08-14 23:11:38 -07002/*
3 * Copyright (c) 2011 UCLA
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -070018 * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
Ilya Moiseenkofbd0a8b2011-10-28 13:07:16 -070019 * Ilya Moiseenko <iliamo@cs.ucla.edu>
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070020 */
21
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070022#include "ns3/assert.h"
23#include "ns3/log.h"
24#include "ns3/object.h"
25#include "ns3/names.h"
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070026#include "ns3/packet-socket-factory.h"
27#include "ns3/config.h"
28#include "ns3/simulator.h"
29#include "ns3/string.h"
30#include "ns3/net-device.h"
31#include "ns3/callback.h"
32#include "ns3/node.h"
33#include "ns3/core-config.h"
Alexander Afanasyev07827182011-12-13 01:07:32 -080034#include "ns3/point-to-point-net-device.h"
35#include "ns3/point-to-point-helper.h"
36
37#include "../model/ccnx-forwarding-strategy.h"
Alexander Afanasyevf9f4eb02011-12-16 01:51:14 -080038#include "../model/ccnx-net-device-face.h"
39#include "../model/ccnx-l3-protocol.h"
40#include "../model/ccnx-fib.h"
Alexander Afanasyev07827182011-12-13 01:07:32 -080041
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -080042#include "ns3/node-list.h"
Alexander Afanasyev57bcbc32012-06-01 01:46:24 -070043// #include "ns3/loopback-net-device.h"
Alexander Afanasyevf9f4eb02011-12-16 01:51:14 -080044
Alexander Afanasyev11453142011-11-25 16:13:33 -080045#include "ns3/data-rate.h"
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070046
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070047#include "ccnx-face-container.h"
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070048#include "ccnx-stack-helper.h"
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070049
50#include <limits>
51#include <map>
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -080052#include <boost/foreach.hpp>
Alexander Afanasyevb7626842012-01-12 13:43:33 -080053#include <boost/lexical_cast.hpp>
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -080054
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070055NS_LOG_COMPONENT_DEFINE ("CcnxStackHelper");
56
57namespace ns3 {
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -070058
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070059CcnxStackHelper::CcnxStackHelper ()
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -080060 : m_limitsEnabled (false)
61 , m_needSetDefaultRoutes (false)
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070062{
Alexander Afanasyev11453142011-11-25 16:13:33 -080063 m_strategyFactory.SetTypeId ("ns3::CcnxFloodingStrategy");
Alexander Afanasyevd9fecdd2012-06-08 16:22:24 -070064 m_contentStoreFactory.SetTypeId ("ns3::CcnxContentStoreLru");
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -070065}
66
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070067CcnxStackHelper::~CcnxStackHelper ()
68{
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070069}
70
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070071void
Alexander Afanasyevd9fecdd2012-06-08 16:22:24 -070072CcnxStackHelper::SetForwardingStrategy (const std::string &strategy)
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070073{
Alexander Afanasyev11453142011-11-25 16:13:33 -080074 m_strategyFactory.SetTypeId (strategy);
75}
76
Alexander Afanasyevd9fecdd2012-06-08 16:22:24 -070077void
78CcnxStackHelper::SetContentStore (const std::string &contentStore)
79{
80 m_contentStoreFactory.SetTypeId (contentStore);
81}
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -080082
83void
84CcnxStackHelper::SetDefaultRoutes (bool needSet)
85{
86 NS_LOG_FUNCTION (this << needSet);
87 m_needSetDefaultRoutes = needSet;
88}
89
Alexander Afanasyev11453142011-11-25 16:13:33 -080090void
Alexander Afanasyev33d62312012-01-09 13:50:20 -080091CcnxStackHelper::EnableLimits (bool enable/* = true*/,
92 Time avgRtt/*=Seconds(0.1)*/,
93 uint32_t avgContentObject/*=1100*/,
94 uint32_t avgInterest/*=40*/)
Alexander Afanasyev11453142011-11-25 16:13:33 -080095{
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -080096 NS_LOG_INFO ("EnableLimits: " << enable);
Alexander Afanasyev11453142011-11-25 16:13:33 -080097 m_limitsEnabled = enable;
Alexander Afanasyev8f5a9bb2011-12-18 19:49:02 -080098 m_avgRtt = avgRtt;
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -080099 m_avgContentObjectSize = avgContentObject;
100 m_avgInterestSize = avgInterest;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700101}
102
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700103Ptr<CcnxFaceContainer>
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700104CcnxStackHelper::Install (NodeContainer c) const
105{
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700106 Ptr<CcnxFaceContainer> faces = Create<CcnxFaceContainer> ();
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700107 for (NodeContainer::Iterator i = c.Begin (); i != c.End (); ++i)
108 {
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700109 faces->AddAll (Install (*i));
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700110 }
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700111 return faces;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700112}
113
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700114Ptr<CcnxFaceContainer>
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700115CcnxStackHelper::InstallAll (void) const
116{
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700117 return Install (NodeContainer::GetGlobal ());
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700118}
119
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700120Ptr<CcnxFaceContainer>
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700121CcnxStackHelper::Install (Ptr<Node> node) const
122{
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700123 // NS_ASSERT_MSG (m_forwarding, "SetForwardingHelper() should be set prior calling Install() method");
124 Ptr<CcnxFaceContainer> faces = Create<CcnxFaceContainer> ();
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700125
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700126 if (node->GetObject<Ccnx> () != 0)
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700127 {
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700128 NS_FATAL_ERROR ("CcnxStackHelper::Install (): Installing "
129 "a CcnxStack to a node with an existing Ccnx object");
130 return 0;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700131 }
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700132
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700133 Ptr<CcnxFib> fib = CreateObject<CcnxFib> ();
134 node->AggregateObject (fib);
135
Ilya Moiseenkofbd0a8b2011-10-28 13:07:16 -0700136 Ptr<CcnxL3Protocol> ccnx = CreateObject<CcnxL3Protocol> ();
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700137 node->AggregateObject (ccnx);
138
Alexander Afanasyev39485d82012-06-08 17:51:47 -0700139 // Create and set forwarding strategy
Alexander Afanasyevf377b332011-12-16 15:32:12 -0800140 ccnx->SetForwardingStrategy (m_strategyFactory.Create<CcnxForwardingStrategy> ());
Alexander Afanasyev39485d82012-06-08 17:51:47 -0700141
142 // Create and set content store
143 node->AggregateObject (m_contentStoreFactory.Create ());
Alexander Afanasyev11453142011-11-25 16:13:33 -0800144
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700145 for (uint32_t index=0; index < node->GetNDevices (); index++)
146 {
Alexander Afanasyev11453142011-11-25 16:13:33 -0800147 Ptr<NetDevice> device = node->GetDevice (index);
Alexander Afanasyev57bcbc32012-06-01 01:46:24 -0700148 // This check does not make sense: LoopbackNetDevice is installed only if IP stack is installed,
149 // Normally, ndnSIM works without IP stack, so no reason to check
150 // if (DynamicCast<LoopbackNetDevice> (device) != 0)
151 // continue; // don't create face for a LoopbackNetDevice
Alexander Afanasyev11453142011-11-25 16:13:33 -0800152
Alexander Afanasyevcbe92ae2011-12-16 13:06:18 -0800153 Ptr<CcnxNetDeviceFace> face = CreateObject<CcnxNetDeviceFace> (node, device);
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800154
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800155 ccnx->AddFace (face);
156 NS_LOG_LOGIC ("Node " << node->GetId () << ": added CcnxNetDeviceFace as face #" << *face);
Alexander Afanasyev11453142011-11-25 16:13:33 -0800157
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800158 if (m_needSetDefaultRoutes)
159 {
160 // default route with lowest priority possible
Alexander Afanasyev463fe222012-05-31 13:46:51 -0700161 AddRoute (node, "/", face, std::numeric_limits<int32_t>::max ());
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800162 }
163
Alexander Afanasyev11453142011-11-25 16:13:33 -0800164 if (m_limitsEnabled)
165 {
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800166 NS_LOG_INFO ("Limits are enabled");
Alexander Afanasyev11453142011-11-25 16:13:33 -0800167 Ptr<PointToPointNetDevice> p2p = DynamicCast<PointToPointNetDevice> (device);
Alexander Afanasyev3f1c8b02012-01-19 19:41:34 -0800168 if (p2p != 0)
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800169 {
Alexander Afanasyev3f1c8b02012-01-19 19:41:34 -0800170 // Setup bucket filtering
171 // Assume that we know average data packet size, and this size is equal default size
172 // Set maximum buckets (averaging over 1 second)
Ilya Moiseenkoc9266042011-11-02 17:49:21 -0700173
Alexander Afanasyev3f1c8b02012-01-19 19:41:34 -0800174 DataRateValue dataRate; device->GetAttribute ("DataRate", dataRate);
Alexander Afanasyev11453142011-11-25 16:13:33 -0800175
Alexander Afanasyev3f1c8b02012-01-19 19:41:34 -0800176 NS_LOG_INFO("DataRate for this link is " << dataRate.Get());
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800177
Alexander Afanasyev3f1c8b02012-01-19 19:41:34 -0800178 double maxInterestPackets = 1.0 * dataRate.Get ().GetBitRate () / 8.0 / (m_avgContentObjectSize + m_avgInterestSize);
179 NS_LOG_INFO ("Max packets per second: " << maxInterestPackets);
180 NS_LOG_INFO ("Max burst: " << m_avgRtt.ToDouble (Time::S) * maxInterestPackets);
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800181
Alexander Afanasyev3f1c8b02012-01-19 19:41:34 -0800182 // Set bucket max to BDP
183 face->SetBucketMax (m_avgRtt.ToDouble (Time::S) * maxInterestPackets); // number of interests allowed
184 face->SetBucketLeak (maxInterestPackets);
185 }
Alexander Afanasyev11453142011-11-25 16:13:33 -0800186 }
Ilya Moiseenkoc9266042011-11-02 17:49:21 -0700187
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -0700188 face->SetUp ();
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700189 faces->Add (face);
190 }
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -0700191
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700192 return faces;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700193}
194
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700195Ptr<CcnxFaceContainer>
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700196CcnxStackHelper::Install (std::string nodeName) const
197{
198 Ptr<Node> node = Names::Find<Node> (nodeName);
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700199 return Install (node);
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700200}
201
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700202
203void
Alexander Afanasyevb7626842012-01-12 13:43:33 -0800204CcnxStackHelper::AddRoute (Ptr<Node> node, std::string prefix, Ptr<CcnxFace> face, int32_t metric)
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800205{
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800206 NS_LOG_LOGIC ("[" << node->GetId () << "]$ route add " << prefix << " via " << *face << " metric " << metric);
207
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800208 Ptr<CcnxFib> fib = node->GetObject<CcnxFib> ();
209
210 CcnxNameComponentsValue prefixValue;
211 prefixValue.DeserializeFromString (prefix, MakeCcnxNameComponentsChecker ());
212 fib->Add (prefixValue.Get (), face, metric);
213}
214
215void
Alexander Afanasyevb7626842012-01-12 13:43:33 -0800216CcnxStackHelper::AddRoute (std::string nodeName, std::string prefix, uint32_t faceId, int32_t metric)
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700217{
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700218 Ptr<Node> node = Names::Find<Node> (nodeName);
219 NS_ASSERT_MSG (node != 0, "Node [" << nodeName << "] does not exist");
Alexander Afanasyeva4e3f852011-11-15 20:39:33 -0800220
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800221 Ptr<Ccnx> ccnx = node->GetObject<Ccnx> ();
222 NS_ASSERT_MSG (ccnx != 0, "Ccnx stack should be installed on the node");
223
224 Ptr<CcnxFace> face = ccnx->GetFace (faceId);
225 NS_ASSERT_MSG (face != 0, "Face with ID [" << faceId << "] does not exist on node [" << nodeName << "]");
226
227 AddRoute (node, prefix, face, metric);
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700228}
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800229
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700230
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700231} // namespace ns3