Network Simulator 2 script for a complex scenario

#This is an example for DSDV routing with 50 nodes in a 670*670 m2 area

#

# Note that all options listed in the beginning of the file could be initialized 

# with command line arguments by using "getopt $argc $argv"

# ======================================================================
# Default Script Options
# ======================================================================
set opt(chan)  Channel/WirelessChannel
set opt(prop)  Propagation/TwoRayGround
#set opt(netif)  NetIf/SharedMedia
set opt(netif)  Phy/WirelessPhy
#set opt(mac)  Mac/802_11
set opt(mac)  Mac/802_11
set opt(ifq)  Queue/DropTail/PriQueue
set opt(ll)  LL
set opt(ant)            Antenna/OmniAntenna

set opt(x)  670 ;# X dimension of the topography
set opt(y)  670  ;# Y dimension of the topography
set opt(cp)  "../mobility/scene/cbr-50-10-4-512"
set opt(sc)  "../mobility/scene/scen-670x670-50-600-20-0"

set opt(ifqlen)  50  ;# max packet in ifq
set opt(nn)  50  ;# number of nodes
set opt(seed)  0.0
set opt(stop)  1000.0  ;# simulation time
set opt(tr)  out.tr  ;# trace file
set opt(rp)             dsdv            ;# routing protocol script
set opt(lm)             "off"           ;# log movement

# ======================================================================

#set AgentTrace   ON
#set RouterTrace  ON
#set MacTrace   OFF     #useless code, the only way to toggle Mac trace on is to use node-config

LL set mindelay_  50us
LL set delay_   25us
LL set bandwidth_  0 ;# not used
LL set off_prune_  0 ;# not used
LL set off_CtrMcast_  0 ;# not used

Agent/Null set sport_  0
Agent/Null set dport_  0

Agent/CBR set sport_  0
Agent/CBR set dport_  0

Agent/TCPSink set sport_ 0
Agent/TCPSink set dport_ 0

Agent/TCP set sport_  0
Agent/TCP set dport_  0
Agent/TCP set packetSize_ 1460

Queue/DropTail/PriQueue set Prefer_Routing_Protocols    1

# unity gain, omni-directional antennas
# set up the antennas to be centered in the node and 1.5 meters above it
Antenna/OmniAntenna set X_ 0
Antenna/OmniAntenna set Y_ 0
Antenna/OmniAntenna set Z_ 1.5
Antenna/OmniAntenna set Gt_ 1.0
Antenna/OmniAntenna set Gr_ 1.0

# Initialize the SharedMedia interface with parameters to make
# it work like the 914MHz Lucent WaveLAN DSSS radio interface
Phy/WirelessPhy set CPThresh_ 10.0
Phy/WirelessPhy set CSThresh_ 1.559e-11
Phy/WirelessPhy set RXThresh_ 3.652e-10
Phy/WirelessPhy set Rb_ 2*1e6
Phy/WirelessPhy set Pt_ 0.2818
Phy/WirelessPhy set freq_ 914e+6 
Phy/WirelessPhy set L_ 1.0

# ======================================================================

proc usage { argv0 }  {
 puts "Usage: $argv0"
 puts "\tmandatory arguments:"
 puts "\t\t\[-x MAXX\] \[-y MAXY\]"
 puts "\toptional arguments:"
 puts "\t\t\[-cp conn pattern\] \[-sc scenario\] \[-nn nodes\]"
 puts "\t\t\[-seed seed\] \[-stop sec\] \[-tr tracefile\]\n"
}


proc getopt {argc argv} {
 global opt
 lappend optlist cp nn seed sc stop tr x y

 for {set i 0} {$i < $argc} {incr i} {
  set arg [lindex $argv $i]
  if {[string range $arg 0 0] != "-"} continue

  set name [string range $arg 1 end]
  set opt($name) [lindex $argv [expr $i+1]]
 }
}

proc cmu-trace { ttype atype node } {
 global ns_ tracefd

 if { $tracefd == "" } {
  return ""
 }
 set T [new CMUTrace/$ttype $atype]
 $T target [$ns_ set nullAgent_]
 $T attach $tracefd
        $T set src_ [$node id]

        $T node $node

 return $T
}




proc log-movement {} {
    global logtimer ns_ ns

    set ns $ns_
    source ../mobility/timer.tcl
    Class LogTimer -superclass Timer
    LogTimer instproc timeout {} {
 global opt node_;
 for {set i 0} {$i < $opt(nn)} {incr i} {
     $node_($i) log-movement
 }
 $self sched 0.1
    }

    set logtimer [new LogTimer]
    $logtimer sched 0.1
}

# ======================================================================
# Main Program
# ======================================================================
getopt $argc $argv

#
# Source External TCL Scripts
#
#source ../lib/ns-mobilenode.tcl

#if { $opt(rp) != "" } {
 #source ../mobility/$opt(rp).tcl
 #} elseif { [catch { set env(NS_PROTO_SCRIPT) } ] == 1 } {
 #puts "\nenvironment variable NS_PROTO_SCRIPT not set!\n"
 #exit
#} else {
 #puts "\n*** using script $env(NS_PROTO_SCRIPT)\n\n";
        #source $env(NS_PROTO_SCRIPT)
#}
#source ../lib/ns-cmutrace.tcl
source ../lib/ns-bsnode.tcl
source ../mobility/com.tcl

# do the get opt again incase the routing protocol file added some more
# options to look for
getopt $argc $argv

if { $opt(x) == 0 || $opt(y) == 0 } {
 usage $argv0
 exit 1
}

if {$opt(seed) > 0} {
 puts "Seeding Random number generator with $opt(seed)\n"
 ns-random $opt(seed)
}

#
# Initialize Global Variables
#
set ns_  [new Simulator]
set chan [new $opt(chan)]
set prop [new $opt(prop)]
set topo [new Topography]
set tracefd [open $opt(tr) w]

$topo load_flatgrid $opt(x) $opt(y)

$prop topography $topo

#
# Create God
#
create-god $opt(nn)


#
# log the mobile nodes movements if desired
#
if { $opt(lm) == "on" } {
    log-movement
}

 $ns_ node-config -macTrace ON


#
#  Create the specified number of nodes $opt(nn) and "attach" them
#  the channel.
#  Each routing protocol script is expected to have defined a proc
#  create-mobile-node that builds a mobile node and inserts it into the
#  array global $node_($i)
#

if { [string compare $opt(rp) "dsr"] == 0} { 
 for {set i 0} {$i < $opt(nn) } {incr i} {
  dsr-create-mobile-node $i
 }
} elseif { [string compare $opt(rp) "dsdv"] == 0} { 
 for {set i 0} {$i < $opt(nn) } {incr i} {
  dsdv-create-mobile-node $i
 }
}



#
# Source the Connection and Movement scripts
#
if { $opt(cp) == "" } {
 puts "*** NOTE: no connection pattern specified."
        set opt(cp) "none"
} else {
 puts "Loading connection pattern..."
 source $opt(cp)
}


#
# Tell all the nodes when the simulation ends
#
for {set i 0} {$i < $opt(nn) } {incr i} {
    $ns_ at $opt(stop).000000001 "$node_($i) reset";
}
$ns_ at $opt(stop).00000001 "puts \"NS EXITING...\" ; $ns_ halt"


if { $opt(sc) == "" } {
 puts "*** NOTE: no scenario file specified."
        set opt(sc) "none"
} else {
 puts "Loading scenario file..."
 source $opt(sc)
 puts "Load complete..."
}

puts $tracefd "M 0.0 nn $opt(nn) x $opt(x) y $opt(y) rp $opt(rp)"
puts $tracefd "M 0.0 sc $opt(sc) cp $opt(cp) seed $opt(seed)"
puts $tracefd "M 0.0 prop $opt(prop) ant $opt(ant)"

puts "Starting Simulation..."
$ns_ run