A Discrete-Event Network Simulator
API
point-to-point-helper.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 INRIA
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  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #include "ns3/abort.h"
22 #include "ns3/log.h"
23 #include "ns3/simulator.h"
24 #include "ns3/point-to-point-net-device.h"
25 #include "ns3/point-to-point-channel.h"
26 #include "ns3/point-to-point-remote-channel.h"
27 #include "ns3/queue.h"
28 #include "ns3/net-device-queue-interface.h"
29 #include "ns3/config.h"
30 #include "ns3/packet.h"
31 #include "ns3/names.h"
32 #include "ns3/mpi-interface.h"
33 #include "ns3/mpi-receiver.h"
34 
35 #include "ns3/trace-helper.h"
36 #include "point-to-point-helper.h"
37 
38 namespace ns3 {
39 
40 NS_LOG_COMPONENT_DEFINE ("PointToPointHelper");
41 
43 {
44  m_queueFactory.SetTypeId ("ns3::DropTailQueue<Packet>");
45  m_deviceFactory.SetTypeId ("ns3::PointToPointNetDevice");
46  m_channelFactory.SetTypeId ("ns3::PointToPointChannel");
47  m_remoteChannelFactory.SetTypeId ("ns3::PointToPointRemoteChannel");
48 }
49 
50 void
51 PointToPointHelper::SetQueue (std::string type,
52  std::string n1, const AttributeValue &v1,
53  std::string n2, const AttributeValue &v2,
54  std::string n3, const AttributeValue &v3,
55  std::string n4, const AttributeValue &v4)
56 {
58 
60  m_queueFactory.Set (n1, v1);
61  m_queueFactory.Set (n2, v2);
62  m_queueFactory.Set (n3, v3);
63  m_queueFactory.Set (n4, v4);
64 }
65 
66 void
68 {
69  m_deviceFactory.Set (n1, v1);
70 }
71 
72 void
74 {
75  m_channelFactory.Set (n1, v1);
76  m_remoteChannelFactory.Set (n1, v1);
77 }
78 
79 void
80 PointToPointHelper::EnablePcapInternal (std::string prefix, Ptr<NetDevice> nd, bool promiscuous, bool explicitFilename)
81 {
82  //
83  // All of the Pcap enable functions vector through here including the ones
84  // that are wandering through all of devices on perhaps all of the nodes in
85  // the system. We can only deal with devices of type PointToPointNetDevice.
86  //
87  Ptr<PointToPointNetDevice> device = nd->GetObject<PointToPointNetDevice> ();
88  if (device == 0)
89  {
90  NS_LOG_INFO ("PointToPointHelper::EnablePcapInternal(): Device " << device << " not of type ns3::PointToPointNetDevice");
91  return;
92  }
93 
94  PcapHelper pcapHelper;
95 
96  std::string filename;
97  if (explicitFilename)
98  {
99  filename = prefix;
100  }
101  else
102  {
103  filename = pcapHelper.GetFilenameFromDevice (prefix, device);
104  }
105 
106  Ptr<PcapFileWrapper> file = pcapHelper.CreateFile (filename, std::ios::out,
108  pcapHelper.HookDefaultSink<PointToPointNetDevice> (device, "PromiscSniffer", file);
109 }
110 
111 void
113  Ptr<OutputStreamWrapper> stream,
114  std::string prefix,
115  Ptr<NetDevice> nd,
116  bool explicitFilename)
117 {
118  //
119  // All of the ascii enable functions vector through here including the ones
120  // that are wandering through all of devices on perhaps all of the nodes in
121  // the system. We can only deal with devices of type PointToPointNetDevice.
122  //
123  Ptr<PointToPointNetDevice> device = nd->GetObject<PointToPointNetDevice> ();
124  if (device == 0)
125  {
126  NS_LOG_INFO ("PointToPointHelper::EnableAsciiInternal(): Device " << device <<
127  " not of type ns3::PointToPointNetDevice");
128  return;
129  }
130 
131  //
132  // Our default trace sinks are going to use packet printing, so we have to
133  // make sure that is turned on.
134  //
136 
137  //
138  // If we are not provided an OutputStreamWrapper, we are expected to create
139  // one using the usual trace filename conventions and do a Hook*WithoutContext
140  // since there will be one file per context and therefore the context would
141  // be redundant.
142  //
143  if (stream == 0)
144  {
145  //
146  // Set up an output stream object to deal with private ofstream copy
147  // constructor and lifetime issues. Let the helper decide the actual
148  // name of the file given the prefix.
149  //
150  AsciiTraceHelper asciiTraceHelper;
151 
152  std::string filename;
153  if (explicitFilename)
154  {
155  filename = prefix;
156  }
157  else
158  {
159  filename = asciiTraceHelper.GetFilenameFromDevice (prefix, device);
160  }
161 
162  Ptr<OutputStreamWrapper> theStream = asciiTraceHelper.CreateFileStream (filename);
163 
164  //
165  // The MacRx trace source provides our "r" event.
166  //
167  asciiTraceHelper.HookDefaultReceiveSinkWithoutContext<PointToPointNetDevice> (device, "MacRx", theStream);
168 
169  //
170  // The "+", '-', and 'd' events are driven by trace sources actually in the
171  // transmit queue.
172  //
173  Ptr<Queue<Packet> > queue = device->GetQueue ();
174  asciiTraceHelper.HookDefaultEnqueueSinkWithoutContext<Queue<Packet> > (queue, "Enqueue", theStream);
175  asciiTraceHelper.HookDefaultDropSinkWithoutContext<Queue<Packet> > (queue, "Drop", theStream);
176  asciiTraceHelper.HookDefaultDequeueSinkWithoutContext<Queue<Packet> > (queue, "Dequeue", theStream);
177 
178  // PhyRxDrop trace source for "d" event
179  asciiTraceHelper.HookDefaultDropSinkWithoutContext<PointToPointNetDevice> (device, "PhyRxDrop", theStream);
180 
181  return;
182  }
183 
184  //
185  // If we are provided an OutputStreamWrapper, we are expected to use it, and
186  // to providd a context. We are free to come up with our own context if we
187  // want, and use the AsciiTraceHelper Hook*WithContext functions, but for
188  // compatibility and simplicity, we just use Config::Connect and let it deal
189  // with the context.
190  //
191  // Note that we are going to use the default trace sinks provided by the
192  // ascii trace helper. There is actually no AsciiTraceHelper in sight here,
193  // but the default trace sinks are actually publicly available static
194  // functions that are always there waiting for just such a case.
195  //
196  uint32_t nodeid = nd->GetNode ()->GetId ();
197  uint32_t deviceid = nd->GetIfIndex ();
198  std::ostringstream oss;
199 
200  oss << "/NodeList/" << nd->GetNode ()->GetId () << "/DeviceList/" << deviceid << "/$ns3::PointToPointNetDevice/MacRx";
202 
203  oss.str ("");
204  oss << "/NodeList/" << nodeid << "/DeviceList/" << deviceid << "/$ns3::PointToPointNetDevice/TxQueue/Enqueue";
206 
207  oss.str ("");
208  oss << "/NodeList/" << nodeid << "/DeviceList/" << deviceid << "/$ns3::PointToPointNetDevice/TxQueue/Dequeue";
210 
211  oss.str ("");
212  oss << "/NodeList/" << nodeid << "/DeviceList/" << deviceid << "/$ns3::PointToPointNetDevice/TxQueue/Drop";
214 
215  oss.str ("");
216  oss << "/NodeList/" << nodeid << "/DeviceList/" << deviceid << "/$ns3::PointToPointNetDevice/PhyRxDrop";
218 }
219 
222 {
223  NS_ASSERT (c.GetN () == 2);
224  return Install (c.Get (0), c.Get (1));
225 }
226 
229 {
230  NetDeviceContainer container;
231 
233  devA->SetAddress (Mac48Address::Allocate ());
234  a->AddDevice (devA);
236  devA->SetQueue (queueA);
238  devB->SetAddress (Mac48Address::Allocate ());
239  b->AddDevice (devB);
241  devB->SetQueue (queueB);
242  // Aggregate NetDeviceQueueInterface objects
243  Ptr<NetDeviceQueueInterface> ndqiA = CreateObject<NetDeviceQueueInterface> ();
244  ndqiA->GetTxQueue (0)->ConnectQueueTraces (queueA);
245  devA->AggregateObject (ndqiA);
246  Ptr<NetDeviceQueueInterface> ndqiB = CreateObject<NetDeviceQueueInterface> ();
247  ndqiB->GetTxQueue (0)->ConnectQueueTraces (queueB);
248  devB->AggregateObject (ndqiB);
249 
250  // If MPI is enabled, we need to see if both nodes have the same system id
251  // (rank), and the rank is the same as this instance. If both are true,
252  //use a normal p2p channel, otherwise use a remote channel
253  bool useNormalChannel = true;
255 
257  {
258  uint32_t n1SystemId = a->GetSystemId ();
259  uint32_t n2SystemId = b->GetSystemId ();
260  uint32_t currSystemId = MpiInterface::GetSystemId ();
261  if (n1SystemId != currSystemId || n2SystemId != currSystemId)
262  {
263  useNormalChannel = false;
264  }
265  }
266  if (useNormalChannel)
267  {
269  }
270  else
271  {
273  Ptr<MpiReceiver> mpiRecA = CreateObject<MpiReceiver> ();
274  Ptr<MpiReceiver> mpiRecB = CreateObject<MpiReceiver> ();
275  mpiRecA->SetReceiveCallback (MakeCallback (&PointToPointNetDevice::Receive, devA));
276  mpiRecB->SetReceiveCallback (MakeCallback (&PointToPointNetDevice::Receive, devB));
277  devA->AggregateObject (mpiRecA);
278  devB->AggregateObject (mpiRecB);
279  }
280 
281  devA->Attach (channel);
282  devB->Attach (channel);
283  container.Add (devA);
284  container.Add (devB);
285 
286  return container;
287 }
288 
291 {
292  Ptr<Node> b = Names::Find<Node> (bName);
293  return Install (a, b);
294 }
295 
298 {
299  Ptr<Node> a = Names::Find<Node> (aName);
300  return Install (a, b);
301 }
302 
304 PointToPointHelper::Install (std::string aName, std::string bName)
305 {
306  Ptr<Node> a = Names::Find<Node> (aName);
307  Ptr<Node> b = Names::Find<Node> (bName);
308  return Install (a, b);
309 }
310 
311 } // namespace ns3
virtual void EnablePcapInternal(std::string prefix, Ptr< NetDevice > nd, bool promiscuous, bool explicitFilename)
Enable pcap output the indicated net device.
Manage ASCII trace files for device models.
Definition: trace-helper.h:161
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
static void DefaultEnqueueSinkWithContext(Ptr< OutputStreamWrapper > file, std::string context, Ptr< const Packet > p)
Basic Enqueue default trace sink.
void HookDefaultDropSinkWithoutContext(Ptr< T > object, std::string traceName, Ptr< OutputStreamWrapper > stream)
Hook a trace source to the default drop operation trace sink that does not accept nor log a trace con...
Definition: trace-helper.h:483
NetDeviceContainer Install(NodeContainer c)
Hold a value for an Attribute.
Definition: attribute.h:68
Manage pcap files for device models.
Definition: trace-helper.h:38
Callback< R > MakeBoundCallback(R(*fnPtr)(TX), ARG a1)
Make Callbacks with one bound argument.
Definition: callback.h:1686
void SetQueue(std::string type, std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue())
Each point to point net device must have a queue to pass packets through.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:67
static void DefaultDropSinkWithContext(Ptr< OutputStreamWrapper > file, std::string context, Ptr< const Packet > p)
Basic Drop default trace sink.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:204
void SetTypeId(TypeId tid)
Set the TypeId of the Objects to be created by this factory.
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:280
Ptr< OutputStreamWrapper > CreateFileStream(std::string filename, std::ios::openmode filemode=std::ios::out)
Create and initialize an output stream object we&#39;ll use to write the traced bits. ...
ObjectFactory m_channelFactory
Channel Factory.
void HookDefaultEnqueueSinkWithoutContext(Ptr< T > object, std::string traceName, Ptr< OutputStreamWrapper > stream)
Hook a trace source to the default enqueue operation trace sink that does not accept nor log a trace ...
Definition: trace-helper.h:461
std::string GetFilenameFromDevice(std::string prefix, Ptr< NetDevice > device, bool useObjectNames=true)
Let the ascii trace helper figure out a reasonable filename to use for an ascii trace file associated...
Ptr< PcapFileWrapper > CreateFile(std::string filename, std::ios::openmode filemode, DataLinkType dataLinkType, uint32_t snapLen=std::numeric_limits< uint32_t >::max(), int32_t tzCorrection=0)
Create and initialize a pcap file.
Definition: trace-helper.cc:49
void SetDeviceAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each NetDevice created by the helper.
static void AppendItemTypeIfNotPresent(std::string &typeId, const std::string &itemType)
Append the item type to the provided type ID if the latter does not end with &#39;>&#39;. ...
Definition: queue.cc:78
channel
Definition: third.py:92
PointToPointHelper()
Create a PointToPointHelper to make life easier when creating point to point networks.
std::string GetFilenameFromDevice(std::string prefix, Ptr< NetDevice > device, bool useObjectNames=true)
Let the pcap helper figure out a reasonable filename to use for a pcap file associated with a device...
Definition: trace-helper.cc:80
A Remote Point-To-Point Channel.
static Mac48Address Allocate(void)
Allocate a new Mac48Address.
static void EnablePrinting(void)
Enable printing packets metadata.
Definition: packet.cc:572
Ptr< Object > Create(void) const
Create an Object instance of the configured TypeId.
virtual void EnableAsciiInternal(Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< NetDevice > nd, bool explicitFilename)
Enable ascii trace output on the indicated net device.
void Add(NetDeviceContainer other)
Append the contents of another NetDeviceContainer to the end of this container.
static bool IsEnabled()
holds a vector of ns3::NetDevice pointers
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1489
ObjectFactory m_deviceFactory
Device Factory.
void Connect(std::string path, const CallbackBase &cb)
Definition: config.cc:871
static void DefaultReceiveSinkWithContext(Ptr< OutputStreamWrapper > file, std::string context, Ptr< const Packet > p)
Basic Receive default trace sink.
uint32_t GetN(void) const
Get the number of Ptr<Node> stored in this container.
static void DefaultDequeueSinkWithContext(Ptr< OutputStreamWrapper > file, std::string context, Ptr< const Packet > p)
Basic Dequeue default trace sink.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< Queue< Packet > > GetQueue(void) const
Get a copy of the attached Queue.
keep track of a set of node pointers.
uint32_t GetSystemId(void) const
Definition: node.cc:121
void Set(std::string name, const AttributeValue &value)
Set an attribute to be set during construction.
ObjectFactory m_remoteChannelFactory
Remote Channel Factory.
void HookDefaultReceiveSinkWithoutContext(Ptr< T > object, std::string traceName, Ptr< OutputStreamWrapper > stream)
Hook a trace source to the default receive operation trace sink that does not accept nor log a trace ...
Definition: trace-helper.h:527
void SetChannelAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each Channel created by the helper.
uint32_t AddDevice(Ptr< NetDevice > device)
Associate a NetDevice to this node.
Definition: node.cc:128
Simple Point To Point Channel.
static uint32_t GetSystemId()
void Receive(Ptr< Packet > p)
Receive a packet from a connected PointToPointChannel.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
ObjectFactory m_queueFactory
Queue Factory.
void HookDefaultSink(Ptr< T > object, std::string traceName, Ptr< PcapFileWrapper > file)
Hook a trace source to the default trace sink.
Definition: trace-helper.h:147
void HookDefaultDequeueSinkWithoutContext(Ptr< T > object, std::string traceName, Ptr< OutputStreamWrapper > stream)
Hook a trace source to the default dequeue operation trace sink that does not accept nor log a trace ...
Definition: trace-helper.h:505