F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update tutorial for tracing rework

Browse Source
This commit is contained in:
Craig Dowell
2010-01-25 15:28:43 -08:00
parent d8749d3cb3
commit f49092e36a
2 changed files with 27 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/tutorial/building-topologies.texi
View File

@@ -316,8 +316,8 @@ line enables pcap tracing in the CSMA helper and there is an extra parameter
you haven't encountered yet.
@verbatim
PointToPointHelper::EnablePcapAll ("second");
CsmaHelper::EnablePcap ("second", csmaDevices.Get (1), true);
pointToPoint.EnablePcapAll ("second");
csma.EnablePcap ("second", csmaDevices.Get (1), true);
@end verbatim
The CSMA network is a multi-point-to-point network. This means that there
@@ -582,9 +582,9 @@ number and device number as parameters. Go ahead and replace the
@code{EnablePcap} calls with the calls below.
@verbatim
PointToPointHelper::EnablePcap ("second", p2pNodes.Get (0)->GetId (), 0);
CsmaHelper::EnablePcap ("second", csmaNodes.Get (nCsma)->GetId (), 0, false);
CsmaHelper::EnablePcap ("second", csmaNodes.Get (nCsma-1)->GetId (), 0, false);
pointToPoint.EnablePcap ("second", p2pNodes.Get (0)->GetId (), 0);
csma.EnablePcap ("second", csmaNodes.Get (nCsma)->GetId (), 0, false);
csma.EnablePcap ("second", csmaNodes.Get (nCsma-1)->GetId (), 0, false);
@end verbatim
We know that we want to create a pcap file with the base name "second" and
@@ -1082,9 +1082,9 @@ loop.
We create just enough tracing to cover all three networks:
@verbatim
PointToPointHelper::EnablePcapAll ("third");
pointToPoint.EnablePcapAll ("third");
phy.EnablePcap ("third", apDevices.Get (0));
CsmaHelper::EnablePcap ("third", csmaDevices.Get (0), true);
csma.EnablePcap ("third", csmaDevices.Get (0), true);
@end verbatim
These three lines of code will start pcap tracing on both of the point-to-point

42
doc/tutorial/tweaking.texi
View File

@@ -812,32 +812,30 @@ generated by many scripts.
@cindex tracing packets
Let's just jump right in and add some ASCII tracing output to our
@code{scratch/myfirst.cc} script.
The first thing you need to do is to add the following include to the top of
the script just after the GNU GPL comment:
@code{scratch/myfirst.cc} script. Right before the call to
@code{Simulator::Run ()}, add the following line of code:
@verbatim
#include <fstream>
pointToPoint.EnableAsciiAll (ascii.CreateFileStream ("myfirst.tr"));
@end verbatim
Then, right before the call to @code{Simulator::Run ()}, add the
following lines of code:
This line of code contains two nested method calls. The inside method,
@code{CreateFileStream()} uses an unnamed object idiom to create a file stream
object on the stack (without an object name) and pass it down to the called
method. We'll go into this more in the future, but all you have to know at
this point is that you are creating an object representing a file named
``myfirst.tr'' and passing it into @code{ns-3}. You are telling @code{ns-3}
to deal with the lifetime issues of the created object and also to deal with
problems caused by a little-known (intentional) limitation of C++ ofstream
objects relating to copy constructors.
@verbatim
std::ofstream ascii;
ascii.open ("myfirst.tr");
PointToPointHelper::EnableAsciiAll (ascii);
@end verbatim
The outside call, to @code{EnableAsciiAll()}, tells the helper that you
want to enable ASCII tracing on all point-to-point devices in your simulation;
and you want the (provided) trace sinks to write out information about packet
movement in ASCII format.
The first two lines are just vanilla C++ code to open a stream that will be
written to a file named ``myfirst.tr''. See your favorite C++ tutorial if you
are unfamiliar with this code. The last line of code in the snippet above
tells @command{ns-3} that you want to enable ASCII tracing on all
point-to-point devices in your simulation; and you want the (provided) trace
sinks to write out information about packet movement in ASCII format to the
stream provided. For those familiar with @command{ns-2}, the traced events are
equivalent to the popular trace points that log "+", "-", "d", and "r" events.
For those familiar with @command{ns-2}, the traced events are equivalent to
the popular trace points that log "+", "-", "d", and "r" events.
You can now build the script and run it from the command line:
@@ -984,7 +982,7 @@ traces. In this tutorial, we concentrate on viewing pcap traces with tcpdump.
The code used to enable pcap tracing is a one-liner.
@verbatim
PointToPointHelper::EnablePcapAll ("myfirst");
pointToPoint.EnablePcapAll ("myfirst");
@end verbatim
Go ahead and insert this line of code after the ASCII tracing code we just
@@ -993,7 +991,7 @@ added to @code{scratch/myfirst.cc}. Notice that we only passed the string
parameter is a prefix, not a complete file name. The helper will actually
create a trace file for every point-to-point device in the simulation. The
file names will be built using the prefix, the node number, the device number
and a ``.pcap'' suffix.
and a ``.pcap'' suffix.
In our example script, we will eventually see files named ``myfirst-0-0.pcap''
and ``myfirst-1-0.pcap'' which are the pcap traces for node 0-device 0 and