ns-2 Tutorial
Polly Huang
AT&T Labs Research
huang@[Link]
[Link]
11 August, 1999
1
Essentials & Getting Started
2
Outlines
• Essentials
• Getting Started
• Fundamental tcl, otcl and ns
• Case Studies
– Web, TCP, Routing, Queuing
3
Object-Oriented
+ Reusability
+ Maintainability
– Careful Planning Ahead
4
C++ and otcl Separation
• C++ for data
– per packet action
• otcl for control
– periodic or triggered action
+ Compromize between composibility and
speed
– Learning & debugging
5
otcl and C++: The Duality
C++
otcl
6
tcl Interpreter With Extents
Event ns-2
Scheduler
tclcl
Component
Network
otcl
tcl8.0
• otcl: Object-oriented support
• tclcl: C++ and otcl linkage
• Discrete event scheduler
• Data network (the Internet) components 7
Outlines
• Essentials
• Getting Started
• Fundamental tcl, otcl and ns
• Case Studies
– Web, TCP, Routing, Queuing
8
Installation
• Getting the pieces
– tcl/tk8.0, otcl, tclcl, ns-2, (and nam-1)
• [Link]
[Link]
• ns-users@[Link]
– majordomo@[Link]
– subscribe ns-users yourname@address
9
Hello World - Interactive Mode
swallow 71% ns
% set ns [new Simulator]
_o3
% $ns at 1 “puts \“Hello World!\””
1
% $ns at 1.5 “exit”
2
% $ns run
Hello World!
swallow 72%
10
Hello World - Passive Mode
[Link]
set ns [new Simulator]
$ns at 1 “puts \“Hello World!\””
$ns at 1.5 “exit”
$ns run
swallow 74% ns [Link]
Hello World!
swallow 75%
11
Outlines
• Essentials
• Getting Started
• Fundamental tcl, otcl and ns
• Case Studies
– Web, TCP, Routing, Queuing, Wireless
12
Fundamentals
• tcl
• otcl:
– [Link]
• ns-2
– [Link]
– [Link]
13
proc test {} {
Basic tcl
set a 43
set b 27
set c [expr $a + $b]
set d [expr [expr $a - $b] * $c]
for {set k 0} {$k < 10} {incr k} {
if {$k < 5} {
puts “k < 5, pow= [expr pow($d, $k)]”
} else {
puts “k >= 5, mod= [expr $d % $k]”
}
}
}
test 14
Basic otcl
Class mom
mom instproc greet {} { set a [new mom]
$self instvar age_ $a set age_ 45
puts “$age_ years old mom: set b [new kid]
How are you doing?” $b set age_ 15
}
$a greet
Class kid -superclass mom $b greet
kid instproc greet {} {
$self instvar age_
puts “$age_ years old kid:
What’s up, dude?”
}
15
Basic ns-2
• Creating the event scheduler
• Creating network
• Computing routes
• Creating connection
• Creating traffic
• Inserting errors
• Tracing
16
Creating Event Scheduler
• Create scheduler
– set ns [new Simulator]
• Schedule event
– $ns at <time> <event>
– <event>: any legitimate ns/tcl commands
• Start scheduler
– $ns run
17
Creating Network
• Nodes
– set n0 [$ns node]
– set n1 [$ns node]
• Links & Queuing
– $ns duplex-link $n0 $n1 <bandwidth> <delay>
<queue_type>
– <queue_type>: DropTail, RED, CBQ, FQ,
SFQ, DRR
18
Creating Network: LAN
• LAN
– $ns make-lan <node_list> <bandwidth>
<delay> <ll_type> <ifq_type> <mac_type>
<channel_type>
– <ll_type>: LL
– <ifq_type>: Queue/DropTail,
– <mac_type>: MAC/802_3
– <channel_type>: Channel
19
Computing routes
• Unicast
– $ns rtproto <type>
– <type>: Static, Session, DV, cost, multi-path
• Multicast
– $ns multicast (right after [new Simulator])
– $ns mrtproto <type>
– <type>: CtrMcast, DM, ST, BST
20
Creating Connection: UDP
• UDP
– set udp [new Agent/UDP]
– set null [new Agent/NULL]
– $ns attach-agent $n0 $udp
– $ns attach-agent $n1 $null
– $ns connect $udp $null
21
Creating Connection: TCP
• TCP
– set tcp [new Agent/TCP]
– set tcpsink [new Agent/TCPSink]
– $ns attach-agent $n0 $tcp
– $ns attach-agent $n1 $tcpsink
– $ns connect $tcp $tcpsink
22
Creating Traffic: On Top of TCP
• FTP
– set ftp [new Application/FTP]
– $ftp attach-agent $tcp
• Telnet
– set telnet [new Application/Telnet]
– $telnet attach-agent $tcp
23
Creating Traffic: On Top of UDP
• CBR
– set src [new Application/Traffic/CBR]
• Exponential or Pareto on-off
– set src [new Application/Traffic/Exponential]
– set src [new Application/Traffic/Pareto]
24
Creating Traffic: Trace Driven
• Trace driven
– set tfile [new Tracefile]
– $tfile filename <file>
– set src [new Application/Traffic/Trace]
– $src attach-tracefile $tfile
• <file>:
– Binary format
– inter-packet time (msec) and packet size (byte)
25
Inserting Errors
• Creating Error Module
– set loss_module [new ErrorModel]
– $loss_module set rate_ 0.01
– $loss_module unit pkt
– $loss_module ranvar [new
RandomVariable/Uniform]
– $loss_module drop-target [new Agent/Null]
• Inserting Error Module
– $ns lossmodel $loss_module $n0 $n1
26
Tracing
• Trace packets on all links
– $ns trace-all [open [Link] w]
<event> <time> <from> <to> <pkt> <size>--<flowid> <src> <dst> <seqno> <aseqno>
+ 1 0 2 cbr 210 ------- 0 0.0 3.1 0 0
- 1 0 2 cbr 210 ------- 0 0.0 3.1 0 0
r 1.00234 0 2 cbr 210 ------- 0 0.0 3.1 0 0
• Trace packets on all links in nam-1 format
– $ns namtrace-all [open [Link] w]
27
Outlines
• Essentials
• Getting Started
• Fundamental tcl, otcl and ns-2
• Case Studies
28
Case Studies
• Routing - Multicast ([Link])
• TCP ([Link])
• Web ([Link] & [Link])
• Queuing - RED ([Link])
29
Visualization Tools
• nam-1 (Network AniMator Version 1)
• xgraph
30
ns-2 Internal
31
Internals
• Discrete Event Scheduler
• Network Topology
• Routing
• Transport
• Application
• Packet Flow
• Packet Format
32
Discrete Event Scheduler
time_, uid_, next_, handler_
head_ ->
head_ ->
handler_ -> handle()
insert time_, uid_, next_, handler_
33
Network Topology - Node
n0 n1
Port
Classifier Unicast Multicast dmux_
Addr Node Node classifier_
Classifier
Node entry Node entry
dmux_
entry_ entry_ Multicast
classifier_ Classifier
multiclassifier_
34
Network Topology - Link
n0 n1
n1
head_ entry_
enqT_ queue_ deqT_ link_ ttl_
drophead_ drpT_
35
Routing
n0 n1
Port
Classifier
Addr
Classifier
Node entry n1
0 dmux_ head_ entry_
enqT_ queue_ deqT_ link_ ttl_
entry_ 1
classifier_ drophead_ drpT_
36
Routing (cont.)
n0 n1
Port Port
Classifier Classifier
Addr Addr
Classifier Classifier
0 dmux_ 1 dmux_
Link n0-n1
entry_ 1 entry_ 0
classifier_ classifier_
Link n1-n0
37
Transport
n0 n1
Port Port
Classifier dst_=1.0 Classifier dst_=0.0
Addr Agent/TCP Addr Agent/TCPSink
Classifier 0 agents_
Classifier 0 agents_
0 dmux_ 1 dmux_
Link n0-n1
entry_ 1 entry_ 0
classifier_ classifier_
Link n1-n0
38
Application
n0 n1
Port Application/FTP Port
Classifier dst_=1.0 Classifier dst_=0.0
Addr Agent/TCP Addr Agent/TCPSink
Classifier 0 agents_
Classifier 0 agents_
0 dmux_ 1 dmux_
Link n0-n1
entry_ 1 entry_ 0
classifier_ classifier_
Link n1-n0
39
Packet Flow
n0 n1
Port Application/FTP Port
Classifier dst_=1.0 Classifier dst_=0.0
Addr Agent/TCP Addr Agent/TCPSink
Classifier 0 Classifier 0
0 1
Link n0-n1
entry_ 1 entry_ 0
Link n1-n0
40
Packet Format
ts_
cmn header
header ptype_
ip header
data uid_
tcp header
size_
rtp header
iface_
trace header
...
41
Extending ns-2 Simulator
42
Outline
• Making changes
• Creating new components
43
ns-2 Directory Structure
sim
tcl8.0 tk8.0 otcl Tcl ns-2 nam-1
tcl code C++ code
tcl ...
example
ex test lib ...
validation test tcl code core
44
Making Changes in C++ Space
• Existing code
– recompile
• Addition
– change Makefile and recompile
45
Making Changes in otcl Space
• Existing code
– recompile
– source
• Addition
– source
– change Makefile (NS_TCL_LIB), tcl/[Link]
(source) and recompile
46
Outline
• Making changes
• Creating new components
47
Creating New Components
• Guidelines
• Inheritance Hierarchy
• C++ and otcl Interface
• Examples
– Network layer
– Transport layer
– Application layer
48
Guidelines
• Decide its inheritance structure
• Create the class and fill in the API virtual
functions
• Define otcl linkage functions
• Write the necessary otcl code to access your
agent
49
Class Hierarchy (Partial)
TclObject
NsObject
Connector Classifier
Queue Delay Agent Trace AddrClassifier McastClasifier
DropTail RED TCP Enq Dnq Drop
Reno SACK
50
C++ and otcl Linkage
• TclClass
• TclObject: bind() method
• TclObject: command() method
• class Tcl
51
TclClass
C++ Static classTcpClass
mirroring
Static class TcpClass
OTcl ::public
publicTclClass
TclClass{{
public:
public:
TclObject TcpClass()TclObject
TcpClass() :: TclClass(“Agent/TCP”)
TclClass(“Agent/TCP”){}{}
TclObject*create(int,
TclObject* create(int, const
const char*const*)
char*const*) {{
return(new
return (newTcpAgent());
TcpAgent());
NsObject ??
}}
}}class_tcp;
class_tcp;
Agent Agent
TcpAgent Agent/TCP
52
TclObject: bind()
• C++
TcpAgent::TcpAgent() {
bind(“window_”, $wnd_);
…
}
• otcl
Agent/TCP set window_ 50
53
TclObject: command()
• C++
Int TcpAgent::command(int argc, const char*const* argv) {
if (argc == 3) {
if (strcomp(argv[1], “advance”) == 0) {
int newseq = atoi(argv[2]);
…
return(TCL_OK);
}
}
return (Agent::command(argc, argv);
}
• otcl
set tcp [new Agent/TCP]
$tcp advance 10
54
Class Tcl
• C++
Tcl& tcl = Tcl::instance();
if (argc==2) {
if (strcmp (argv[1], “now”) == 0) {
[Link](“%g”, clock());
return TCL_OK;
}
[Link](“puts hello, world”);
[Link](“command not found”);
}
• otcl
foo now
foo whatever
55
Debugging
• printf() and puts “”
• gdb
• tcl debugger
– [Link]
– place debug 1 at the appropriate location
– trap to debugger from the script
– single stepping through lines of codes
– examine data and code using Tcl-ish commands
56
Case Studies
• Network Layer: Network Interface (packet
labeler)
• Transport Layer: TCP Jump Start
• Application Layer: Message agent (ping)
57
Case 1: Network Layer
• Network Interface - Packet Labeler
n0 n1 n2
NetworkInterface A NetworkInterface B
58
Class Hierarchy
TclObject
NsObject
Network
Interface Connector Classifier
Queue Delay Agent Trace AddrClassifier McastClasifier
DropTail RED TCP Enq Dnq Drop
Reno SACK
59
Network Interface Labeler
• class NetworkInterface
– NetworkInterface()
– recv(pkt) NetworkInterface networkinterface
• pkt->iface() = label_
– send(pkt) command(): label
• target->recv(pkt) otcl
C++
– command()
set iface [new networkinteface]
• label argv {label_ = argv} $iface label A
• TclClass(“networkinterface”)
60
Case 2: Transport Layer
• TCP Jump Start
– from cwnd += 1
– to cwnd = maxwin
61
Class Hierarchy
TclObject
NsObject
Connector Classifier
Queue Delay Agent Trace AddrClassifier McastClasifier
DropTail RED TCP Enq Dnq Drop
Reno SACK JS
62
TCP Jump Start
• class JSTcpAgent
– openwin()
– slowdown()
• TclClass(“Agent/TCP/JS”)
63
Case 3: Application Layer
• Message sender (ping)
Message Sender Message Sender
n0 n1 n2
64
Class Hierarchy
TclObject
NsObject
Connector Classifier
Queue Delay Agent Trace AddrClassifier McastClasifier
DropTail RED TCP Enq Dnq Drop
Reno SACK MessageAgent
65
Message Sender
• class MessageAgent
– MessageAgent()
– recv() MessageAgent Agent/Message
– send()
command(): send
– command()
• send {send()} C++ otcl
• TclClass(“Agent/Message”) set msg [new Agent/Message]
$msg send
66
Special Topics
67
Special Topics
• Application Level Support
• Topology and Scenario Generation
• Wireless/Mobility Support
68
Application: Two-way TCP
• FullTcp connection
– set tcp1 [new Agent/TCP/FullTcp]
– set tcp2 [new Agent/TCP/FullTcp]
– $ns attach-agent $n1 $tcp1
– $ns attach-agent $n2 $tcp2
– $ns connect $tcp1 $tcp2
– $tcp2 listen
69
Application: TcpApp
• User data transfer
– set app1 [new Application/TcpApp $tcp1]
– set app2 [new Application/TcpApp $tcp2]
– $app1 connect $app2
– $ns at 1.0 “$app1 send <data_byte> \”<ns-2
command>\””
– <ns-2 command>: will be executed when
received at the receiver TcpApp
70
Topology Generation
• [Link]
[Link]
Packages Graph Type Edge Method
• ntg • n-level • prob
• GT-ITM • flat, ts, n • various
• TIERS • 3-level • spanning t
• rtg • flat • waxman
71
Scenario Generation
• [Link]
[Link]
• [Link]
• Source generator files
– source [Link]
– source [Link]
– source [Link]
72
[Link]
• GT-ITM
• topology
– outfile <file>
– type <graph_type> : random or transit_stub
– nodes <num_nodes>
– connection_prob <probability>
73
[Link]
• Routing
– outfile <file>
– unicast <ucast_type>
– multicast <mcast_type>
74
[Link]
• Agents
– outfile <file>
– transport <transport_type>
– src <application_type>
– sink <transport_sink_type>
– num <num_connections or %>
– start <start_time>
– stop <stop_time>
75
Wireless Support: Setup
• set ns [new Simulator]
• set chan [new Channel/WirelessChannel]
• set prop [new Propagation/TwoRayGround]
• set topo [new Topography]
• $topo load_flatgrid <length> <width>
• $prop topology $topo
76
Wireless Support: MobileNode
• Creating mobile nodes
– set mnode [<routing>-create-mobile-node
<node_id>]
– <routing>: dsdv or dsr
• Node coordinates
– $mnode set X_ <x>
– $mnode set Y_ <y>
– $mnode set Z_ 0
77
Mobility Support: Movement
• Specified
– $ns at 1.0 “$mnode setdest <x> <y> <speed>”
• Random
– $ns at 1.0 “$mnode start”
78