parse.tcl.in 8.9 KB
Newer Older
Mac Newbold's avatar
Mac Newbold committed
1
#!/usr/local/bin/otclsh
Leigh B. Stoller's avatar
Leigh B. Stoller committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15
######################################################################
# parse.tcl.in
#
# This is the testbed parser.  It takes a project id, an experiment
# id and a NS file.  It will parse the NS file and update the DB.
# It also displays warnings for unsupported functionality.
#
# See README for extensive discussion of the structure and 
# implementation.
#
# -q will supress all the unsupported messages.
# -n will cause the parser to output error/warning messages and exit
#    without updating the database.
######################################################################
Mac Newbold's avatar
Mac Newbold committed
16

Leigh B. Stoller's avatar
Leigh B. Stoller committed
17
package require sql
Mac Newbold's avatar
Mac Newbold committed
18

Leigh B. Stoller's avatar
Leigh B. Stoller committed
19
# Initial Procedures
20

Leigh B. Stoller's avatar
Leigh B. Stoller committed
21 22 23 24 25 26 27 28 29 30 31
###
# lpop <listname>
# This takes the *name* of a list variable and pops the first element
# off of it, returning that element.
###
proc lpop {lv} {
    upvar $lv l
    set ret [lindex $l 0]
    set l [lrange $l 1 end]
    return $ret
}
Mac Newbold's avatar
Mac Newbold committed
32 33

###
Leigh B. Stoller's avatar
Leigh B. Stoller committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47
# var_import <varspec>
# This procedure takes a fully qualified variable name (::x::y::z..) and
# creates a variable z which is the same as the variable specified.  This
# fills the lack of variable importing support in 'namespace import'.
#
# Example:
#  proc a {} {
#    var_import ::GLOBALS::verbose
#    if {$verbose == 1} {puts "verbose is on."}
#  }
# is functionally identical to:
#  proc a {} {
#    if {${::GLOBALS::verbose} == 1} {puts "verbose is on."}
#  }
Mac Newbold's avatar
Mac Newbold committed
48
###
Leigh B. Stoller's avatar
Leigh B. Stoller committed
49 50 51 52 53 54 55 56 57
proc var_import {varspec} {
    uplevel "upvar $varspec [namespace tail $varspec]"
}

###
# perror <msg>
# Print an error message and mark as failed run.
###
proc perror {msg} {
58 59
    var_import ::GLOBALS::errors 
    global argv0
60
    puts stderr "$argv0: *** $msg"
Leigh B. Stoller's avatar
Leigh B. Stoller committed
61 62 63
    set errors 1
}

64 65 66 67 68 69 70 71 72 73
###
# punsup {msg}
# Print an unsupported message if verbose is on.
###
proc punsup {msg} {
	global ::GLOBALS::verbose
	if {${::GLOBALS::verbose}} {
	    puts stderr "Unsupported: $msg"
	}
}	
Leigh B. Stoller's avatar
Leigh B. Stoller committed
74 75 76 77 78 79 80 81

# Parse Arguments

# We setup a few globals that we need for argument parsing.
namespace eval GLOBALS {
variable verbose 1
variable impotent 0
variable anonymous 0
82
variable vtype_list {}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
}

while {$argv != {}} {
    set arg [lindex $argv 0]
    if {$arg == "-n"} {
	lpop argv
	set GLOBALS::impotent 1
    } elseif {$arg == "-q"} {
	lpop argv
	set GLOBALS::verbose 0
    } elseif {$arg == "-a"} {
	lpop argv
	set GLOBALS::anonymous 1
    } else {
	break
Mac Newbold's avatar
Mac Newbold committed
98
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
}

if {${GLOBALS::anonymous} && ! ${GLOBALS::impotent}} {
    puts stderr "-a can only be used with -n."
    exit 1
}

if {${GLOBALS::anonymous} && ([llength $argv] != 1)} {
    puts stderr "Syntax: $argv0 \[-q\] -n -a ns_file"
    exit 1
} elseif {(! ${GLOBALS::anonymous}) && ([llength $argv] != 3)} {
    puts stderr "Syntax: $argv0 \[-q\] \[-n \[-a\]\] pid eid ns_file"
    exit 1
}

# Now we can set up the rest of our global variables.
namespace eval GLOBALS {
    # Remaining arguments
    if {$anonymous} {
	variable pid "PID"
	variable eid "EID"
	variable nsfile [lindex $argv 0]
Mac Newbold's avatar
Mac Newbold committed
121
    } else {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
122 123 124
	variable pid [lindex $argv 0]
	variable eid [lindex $argv 1]
	variable nsfile [lindex $argv 2]
Mac Newbold's avatar
Mac Newbold committed
125
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
    
    # This is used to name class instances by the variables they
    # are stored in.  It contains the initial id of the most
    # recently created class.  See README
    variable last_class {}

    # Some settings taken from configure.
    variable tbroot @prefix@
    variable libdir @prefix@/lib/ns2ir

    # This is the location of the tb_compat.tcl file.  It is copied
    # into the same directory is the ns file so that the initial
    # 'source tb_compat.tcl' statement succeeds.
    variable tbcompat "$libdir/tb_compat.tcl"

    # Is 1 if any errors have occured so far.
    variable errors 0
    
    # Is 1 after a 'Simulator run' command.
    variable ran 0

    # This is a counter used by the 'new' procedure to create null
    # classes.
    variable new_counter 0

    # This will hold the handle for the database connection
    variable DB {}
153 154 155

    # These are going to be default values within the NS file.
    variable default_ip_routing_type "none"
Mac Newbold's avatar
Mac Newbold committed
156 157
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
158 159 160
# Connect to the DB
set GLOBALS::DB [sql conn]
sql selectdb ${GLOBALS::DB} @TBDBNAME@
Mac Newbold's avatar
Mac Newbold committed
161

Leigh B. Stoller's avatar
Leigh B. Stoller committed
162 163 164 165 166 167 168
# Load all our classes
source ${GLOBALS::libdir}/nsobject.tcl
source ${GLOBALS::libdir}/sim.tcl
source ${GLOBALS::libdir}/lanlink.tcl
source ${GLOBALS::libdir}/node.tcl
source ${GLOBALS::libdir}/null.tcl
source ${GLOBALS::libdir}/traffic.tcl
169
source ${GLOBALS::libdir}/vtype.tcl
Mac Newbold's avatar
Mac Newbold committed
170

Leigh B. Stoller's avatar
Leigh B. Stoller committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
##################################################
# Redifing Assignment
#
# Here we rewrite the set command.  The global variable 'last_class'
# holds the name instance created just before set.  If last_class is set
# and the value of the set call is last_class then the value should be
# changed to the variable and the class renamed to the variable.  I.e.
# we are making it so that NS objects are named by the variable they
# are stored in.
#
# We only do this if the level above is the global level.  I.e. if
# class are created in subroutines they keep their internal names
# no matter what.
#
# We munge array references from ARRAY(INDEX) to ARRAY-INDEX.
#
# Whenever we rename a class we call the rename method.  This method
# should update all references that it may have set up to itself.
#
# See README
##################################################
rename set real_set
proc set {args} {
    var_import GLOBALS::last_class
Mac Newbold's avatar
Mac Newbold committed
195

Leigh B. Stoller's avatar
Leigh B. Stoller committed
196 197 198 199 200 201
    # There are a bunch of cases where we just pass through to real set.
    if {[llength $args] == 1} {
	return [uplevel real_set \{[lindex $args 0]\}]
    } elseif {([info level] != 1) || ($last_class == {})} {
	return [uplevel real_set \{[lindex $args 0]\} \{[lindex $args 1]\}]
    }
Mac Newbold's avatar
Mac Newbold committed
202

Leigh B. Stoller's avatar
Leigh B. Stoller committed
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
    # At this point this is an assignment immediately after class creation.
    real_set var [lindex $args 0]
    real_set val [lindex $args 1]
    if {$val == $last_class} {
	# Here we change ARRAY(INDEX) to ARRAY-INDEX
	regsub -all {[\(]} $var {-} out
	regsub -all {[\)]} $out {} val
	# Sanity check
	if {! [catch "uplevel info args $val"]} {
	    error "Already have an object named $val."
	}
	# And now we rename the class.  After the class has been
	# renamed we call it its rename method.
	uplevel rename $last_class $val
	uplevel $val rename $last_class $val
    }
    
    # Reset last_class in all cases.
    real_set last_class {}
    
    # And finally we pass through to the actual assignment operator.
    return [uplevel real_set \{$var\} \{$val\}]
}
Mac Newbold's avatar
Mac Newbold committed
226

Leigh B. Stoller's avatar
Leigh B. Stoller committed
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
###
# new <class> ...
# NS defines the new command to create class instances.  If the call is
# for an object we know about we create and return an instance.  For 
# any classes we do not know about we create a null class and return it
# as well as display an unsupported message.
#
# new_classes is an array in globals that defines the classes
# new should support.  The index is the class name and the value
# is the argument list.
#
# TODO: Implement support for classes that take arguments.  None yet
# in supported NS subset.
###
namespace eval GLOBALS {
    variable new_classes
    set new_classes(Simulator) {}
}
proc new {class args} {
    var_import GLOBALS::new_counter
    var_import GLOBALS::verbose
    var_import GLOBALS::new_classes
    if {! [info exists new_classes($class)]} {
	if {$verbose} {
	    puts stderr "Unsupported object: $class"
	}
	set id null[incr new_counter]
	NullClass $id
	return $id
    }
    if {$args != {}} {
	if {$verbose} {
	    puts stderr "Unsupported args for $class."
	}
    }
    set id $class[incr new_counter]
    eval $class $id 
    return $id
}

# Useful routines.

# parse_bw bspec 
# This takes a bandwidth specifier in the form of <amt><unit> where
# <unit> is any of b, bps, kb, kbps, Mb, Mbps, Gb, or Gbps.  If no
# unit is given then bytes (b) is assumed.  It returns the bandwidth
273
# in Kbps.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
274 275 276 277 278
proc parse_bw {bspec} {
    # Default to bytes
    if {[scan $bspec "%f%s" bw unit] == 1} {
	set unit b
    }
279

Leigh B. Stoller's avatar
Leigh B. Stoller committed
280
    switch -- $unit {
281 282 283 284 285 286 287 288
	b {set val [expr int($bw/1000)]} 
	bps {set val [expr int($bw/1000)]} 
	kb {set val [expr int($bw)]}
	kbps {set val [expr int($bw)]}
	Mb {set val [expr int($bw*1000)]}
	Mbps {set val [expr int($bw*1000)]}
	Gb {set val [expr int($bw*1000000)]}
	Gbps {set val [expr int($bw*1000000)]}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
289
	default {
290
	    perror "Unknown bandwidth unit $unit."
291
	    set val 100000
Leigh B. Stoller's avatar
Leigh B. Stoller committed
292 293
	}
    }
294 295 296 297 298 299

    if {$val < 10} {
	perror "Bandwidth of $val Kbs is too low."
	return 0
    }
    return $val
Leigh B. Stoller's avatar
Leigh B. Stoller committed
300
}
301

Leigh B. Stoller's avatar
Leigh B. Stoller committed
302 303 304 305 306 307 308 309 310 311 312 313 314 315
# parse_delay dspec
# This takes a delay specifier in the form of <amt><unit> where <unit>
# is any of s, ms, ns.  If no unit is given then seconds (s) is
# assumed.  It returns the delay in ms.
proc parse_delay {dspec} {
    # Default to seconds
    if {[scan $dspec "%f%s" delay unit] == 1} {
	set unit s
    }
    switch $unit {
	s {return [expr int($delay*1000)]}
	ms {return [expr int($delay)]}
	ns {return [expr int($delay/1000)]}
	default {
316
	    perror "Unknown delay unit $unit."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
317 318 319 320 321 322 323
	    return 0
	}
    }
}

# We now have all our infrastructure in place.  We are ready to load
# the NS file.
Mac Newbold's avatar
Mac Newbold committed
324

325
file copy -force ${GLOBALS::tbcompat} .
Leigh B. Stoller's avatar
Leigh B. Stoller committed
326
source ${GLOBALS::nsfile}
Mac Newbold's avatar
Mac Newbold committed
327

Leigh B. Stoller's avatar
Leigh B. Stoller committed
328 329
# Clean up
sql disconnect ${GLOBALS::DB}
Mac Newbold's avatar
Mac Newbold committed
330

Leigh B. Stoller's avatar
Leigh B. Stoller committed
331
if {${GLOBALS::ran} == 0} {
332
    perror "No 'Simulator run' statement found."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
333 334
}
exit ${GLOBALS::errors}