blob: 9fc02f44142aad33bddb22c305beccc2ae27ed2d [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 Afanasyev11453142011-11-25 16:13:33 -080043#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");
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -070064}
65
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070066CcnxStackHelper::~CcnxStackHelper ()
67{
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070068}
69
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070070void
Alexander Afanasyev11453142011-11-25 16:13:33 -080071CcnxStackHelper::SetForwardingStrategy (std::string strategy)
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070072{
Alexander Afanasyev11453142011-11-25 16:13:33 -080073 m_strategyFactory.SetTypeId (strategy);
74}
75
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -080076
77void
78CcnxStackHelper::SetDefaultRoutes (bool needSet)
79{
80 NS_LOG_FUNCTION (this << needSet);
81 m_needSetDefaultRoutes = needSet;
82}
83
Alexander Afanasyev11453142011-11-25 16:13:33 -080084void
Alexander Afanasyev33d62312012-01-09 13:50:20 -080085CcnxStackHelper::EnableLimits (bool enable/* = true*/,
86 Time avgRtt/*=Seconds(0.1)*/,
87 uint32_t avgContentObject/*=1100*/,
88 uint32_t avgInterest/*=40*/)
Alexander Afanasyev11453142011-11-25 16:13:33 -080089{
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -080090 NS_LOG_INFO ("EnableLimits: " << enable);
Alexander Afanasyev11453142011-11-25 16:13:33 -080091 m_limitsEnabled = enable;
Alexander Afanasyev8f5a9bb2011-12-18 19:49:02 -080092 m_avgRtt = avgRtt;
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -080093 m_avgContentObjectSize = avgContentObject;
94 m_avgInterestSize = avgInterest;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070095}
96
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070097Ptr<CcnxFaceContainer>
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070098CcnxStackHelper::Install (NodeContainer c) const
99{
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700100 Ptr<CcnxFaceContainer> faces = Create<CcnxFaceContainer> ();
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700101 for (NodeContainer::Iterator i = c.Begin (); i != c.End (); ++i)
102 {
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700103 faces->AddAll (Install (*i));
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700104 }
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700105 return faces;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700106}
107
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700108Ptr<CcnxFaceContainer>
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700109CcnxStackHelper::InstallAll (void) const
110{
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700111 return Install (NodeContainer::GetGlobal ());
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::Install (Ptr<Node> node) const
116{
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700117 // NS_ASSERT_MSG (m_forwarding, "SetForwardingHelper() should be set prior calling Install() method");
118 Ptr<CcnxFaceContainer> faces = Create<CcnxFaceContainer> ();
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700119
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700120 if (node->GetObject<Ccnx> () != 0)
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700121 {
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700122 NS_FATAL_ERROR ("CcnxStackHelper::Install (): Installing "
123 "a CcnxStack to a node with an existing Ccnx object");
124 return 0;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700125 }
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700126
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700127 Ptr<CcnxFib> fib = CreateObject<CcnxFib> ();
128 node->AggregateObject (fib);
129
Ilya Moiseenkofbd0a8b2011-10-28 13:07:16 -0700130 Ptr<CcnxL3Protocol> ccnx = CreateObject<CcnxL3Protocol> ();
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700131 node->AggregateObject (ccnx);
132
Alexander Afanasyevf377b332011-12-16 15:32:12 -0800133 ccnx->SetForwardingStrategy (m_strategyFactory.Create<CcnxForwardingStrategy> ());
Alexander Afanasyev11453142011-11-25 16:13:33 -0800134
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700135 for (uint32_t index=0; index < node->GetNDevices (); index++)
136 {
Alexander Afanasyev11453142011-11-25 16:13:33 -0800137 Ptr<NetDevice> device = node->GetDevice (index);
138 if (DynamicCast<LoopbackNetDevice> (device) != 0)
139 continue; // don't create face for a LoopbackNetDevice
140
Alexander Afanasyevcbe92ae2011-12-16 13:06:18 -0800141 Ptr<CcnxNetDeviceFace> face = CreateObject<CcnxNetDeviceFace> (node, device);
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800142
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800143 ccnx->AddFace (face);
144 NS_LOG_LOGIC ("Node " << node->GetId () << ": added CcnxNetDeviceFace as face #" << *face);
Alexander Afanasyev11453142011-11-25 16:13:33 -0800145
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800146 if (m_needSetDefaultRoutes)
147 {
148 // default route with lowest priority possible
Alexander Afanasyev7f3e49e2012-04-30 00:17:07 -0700149 AddRoute (node, "/bcast", face, std::numeric_limits<int32_t>::max ());
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800150 }
151
Alexander Afanasyev11453142011-11-25 16:13:33 -0800152 if (m_limitsEnabled)
153 {
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800154 NS_LOG_INFO ("Limits are enabled");
Alexander Afanasyev11453142011-11-25 16:13:33 -0800155 Ptr<PointToPointNetDevice> p2p = DynamicCast<PointToPointNetDevice> (device);
Alexander Afanasyev3f1c8b02012-01-19 19:41:34 -0800156 if (p2p != 0)
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800157 {
Alexander Afanasyev3f1c8b02012-01-19 19:41:34 -0800158 // Setup bucket filtering
159 // Assume that we know average data packet size, and this size is equal default size
160 // Set maximum buckets (averaging over 1 second)
Ilya Moiseenkoc9266042011-11-02 17:49:21 -0700161
Alexander Afanasyev3f1c8b02012-01-19 19:41:34 -0800162 DataRateValue dataRate; device->GetAttribute ("DataRate", dataRate);
Alexander Afanasyev11453142011-11-25 16:13:33 -0800163
Alexander Afanasyev3f1c8b02012-01-19 19:41:34 -0800164 NS_LOG_INFO("DataRate for this link is " << dataRate.Get());
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800165
Alexander Afanasyev3f1c8b02012-01-19 19:41:34 -0800166 double maxInterestPackets = 1.0 * dataRate.Get ().GetBitRate () / 8.0 / (m_avgContentObjectSize + m_avgInterestSize);
167 NS_LOG_INFO ("Max packets per second: " << maxInterestPackets);
168 NS_LOG_INFO ("Max burst: " << m_avgRtt.ToDouble (Time::S) * maxInterestPackets);
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800169
Alexander Afanasyev3f1c8b02012-01-19 19:41:34 -0800170 // Set bucket max to BDP
171 face->SetBucketMax (m_avgRtt.ToDouble (Time::S) * maxInterestPackets); // number of interests allowed
172 face->SetBucketLeak (maxInterestPackets);
173 }
Alexander Afanasyev11453142011-11-25 16:13:33 -0800174 }
Ilya Moiseenkoc9266042011-11-02 17:49:21 -0700175
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -0700176 face->SetUp ();
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700177 faces->Add (face);
178 }
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -0700179
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700180 return faces;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700181}
182
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700183Ptr<CcnxFaceContainer>
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700184CcnxStackHelper::Install (std::string nodeName) const
185{
186 Ptr<Node> node = Names::Find<Node> (nodeName);
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700187 return Install (node);
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700188}
189
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700190
191void
Alexander Afanasyevb7626842012-01-12 13:43:33 -0800192CcnxStackHelper::AddRoute (Ptr<Node> node, std::string prefix, Ptr<CcnxFace> face, int32_t metric)
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800193{
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800194 NS_LOG_LOGIC ("[" << node->GetId () << "]$ route add " << prefix << " via " << *face << " metric " << metric);
195
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800196 Ptr<CcnxFib> fib = node->GetObject<CcnxFib> ();
197
198 CcnxNameComponentsValue prefixValue;
199 prefixValue.DeserializeFromString (prefix, MakeCcnxNameComponentsChecker ());
200 fib->Add (prefixValue.Get (), face, metric);
201}
202
203void
Alexander Afanasyevb7626842012-01-12 13:43:33 -0800204CcnxStackHelper::AddRoute (std::string nodeName, std::string prefix, uint32_t faceId, int32_t metric)
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700205{
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700206 Ptr<Node> node = Names::Find<Node> (nodeName);
207 NS_ASSERT_MSG (node != 0, "Node [" << nodeName << "] does not exist");
Alexander Afanasyeva4e3f852011-11-15 20:39:33 -0800208
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800209 Ptr<Ccnx> ccnx = node->GetObject<Ccnx> ();
210 NS_ASSERT_MSG (ccnx != 0, "Ccnx stack should be installed on the node");
211
212 Ptr<CcnxFace> face = ccnx->GetFace (faceId);
213 NS_ASSERT_MSG (face != 0, "Face with ID [" << faceId << "] does not exist on node [" << nodeName << "]");
214
215 AddRoute (node, prefix, face, metric);
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700216}
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800217
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700218
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700219} // namespace ns3