parse.tcl.in 11.3 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

#
# EMULAB-COPYRIGHT
# Copyright (c) 2000-2002 University of Utah and the Flux Group.
# All rights reserved.
#

Leigh B. Stoller's avatar
Leigh B. Stoller committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22
######################################################################
# 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
23

Leigh B. Stoller's avatar
Leigh B. Stoller committed
24
package require sql
Mac Newbold's avatar
Mac Newbold committed
25

Leigh B. Stoller's avatar
Leigh B. Stoller committed
26
# Initial Procedures
27

Leigh B. Stoller's avatar
Leigh B. Stoller committed
28 29 30 31 32 33 34 35 36 37 38
###
# 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
39 40

###
Leigh B. Stoller's avatar
Leigh B. Stoller committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54
# 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
55
###
Leigh B. Stoller's avatar
Leigh B. Stoller committed
56 57 58 59 60 61 62 63 64
proc var_import {varspec} {
    uplevel "upvar $varspec [namespace tail $varspec]"
}

###
# perror <msg>
# Print an error message and mark as failed run.
###
proc perror {msg} {
65
    var_import ::GLOBALS::errors 
66 67 68 69 70 71 72 73 74
    var_import ::GLOBALS::simulated

    # If this was a true error in specifying
    # the simulation, it would have been
    # caught when run with NSE
    if { $simulated == 1 } {
	return 0
    }

75
    global argv0
76 77
    puts stderr "*** $argv0: "
    puts stderr "    $msg"
Leigh B. Stoller's avatar
Leigh B. Stoller committed
78 79 80
    set errors 1
}

81 82
###
# punsup {msg}
83
# Print an unsupported message.
84 85
###
proc punsup {msg} {
86
    var_import ::GLOBALS::verbose
87
    var_import ::GLOBALS::WARN_FILE
88 89 90 91 92 93
    var_import ::GLOBALS::simulated

    # If this was a true error in specifying
    # the simulation, it would have been
    # caught when run with NSE
    if {$simulated == 0 && $verbose == 1} {
94 95
	puts stderr "*** WARNING: Unsupported NS Statement!"
	puts stderr "    $msg"
96 97
	puts $WARN_FILE "*** WARNING: Unsupported NS Statement!"
	puts $WARN_FILE "    $msg"
98
    }
99
}	
Leigh B. Stoller's avatar
Leigh B. Stoller committed
100

101 102 103 104 105 106 107 108 109
#
# We ignore unsupported tcl commands if it is inside
# make-simulated else error is flagged i.e. we call 
# perror which does the right thing
#
proc unknown {args} {
    perror "$args"
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
110 111 112 113 114 115 116
# 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
117
variable vtype_list {}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
}

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
133
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
}

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
156
    } else {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
157 158 159
	variable pid [lindex $argv 0]
	variable eid [lindex $argv 1]
	variable nsfile [lindex $argv 2]
Mac Newbold's avatar
Mac Newbold committed
160
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
161 162 163 164 165 166 167 168 169
    
    # 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
170
    variable disablense {@DISABLE_NSE@}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
171 172 173 174 175 176

    # 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"

177 178 179
    # This is used in running the script through nse for syntax errors
    variable nstbcompat "$libdir/nstb_compat.tcl"

Leigh B. Stoller's avatar
Leigh B. Stoller committed
180 181 182 183 184 185 186 187 188 189 190 191
    # 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 {}
192 193 194

    # These are going to be default values within the NS file.
    variable default_ip_routing_type "none"
195

196 197 198
    # For remote nodes. Use latest widearea data.
    variable uselatestwadata 0

199 200 201 202 203
    # For remote nodes. The solver weights.
    variable wa_delay_solverweight 1
    variable wa_bw_solverweight	   7
    variable wa_plr_solverweight   500

204 205
    # This is the file handler for the warnings file
    variable WARN_FILE [open "$eid.warnings" w]
206 207 208 209 210

    # This distinguishes whether the script that
    # is being parsed should go into a NSE simulation or not
    variable simulated 0

Mac Newbold's avatar
Mac Newbold committed
211 212
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
213 214 215
# Connect to the DB
set GLOBALS::DB [sql conn]
sql selectdb ${GLOBALS::DB} @TBDBNAME@
Mac Newbold's avatar
Mac Newbold committed
216

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
namespace eval GLOBALS {
    # A mapping of event objects.
    variable objtypes

    sql query $DB \
	    "select idx,type from event_objecttypes"
    
    while {[set row [sql fetchrow $DB]] != ""} {
	set idx [lindex $row 0]
	set type [lindex $row 1]
	set objtypes($type) $idx
    }
    sql endquery $DB
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
232 233 234 235 236 237 238
# 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
239
source ${GLOBALS::libdir}/vtype.tcl
240
source ${GLOBALS::libdir}/program.tcl
Mac Newbold's avatar
Mac Newbold committed
241

Leigh B. Stoller's avatar
Leigh B. Stoller committed
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
##################################################
# 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
266

Leigh B. Stoller's avatar
Leigh B. Stoller committed
267 268 269
    # 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]\}]
270
    } elseif {($last_class == {})} {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
271 272
	return [uplevel real_set \{[lindex $args 0]\} \{[lindex $args 1]\}]
    }
Mac Newbold's avatar
Mac Newbold committed
273

Leigh B. Stoller's avatar
Leigh B. Stoller committed
274 275
    real_set var [lindex $args 0]
    real_set val [lindex $args 1]
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292

    # Run the set to make sure variables declared as global get registered
    # as global (does not happen until first set).
    real_set ret [uplevel real_set \{$var\} \{$val\}]

    # Rename happens only when assigning to a global variable. Because of
    # array syntax, must strip parens and indices to get the base variable
    # name (has no effect if not an array access).
    real_set l [split $var \(]
    real_set base_var [lindex $l 0]

    # Now check to see if its a global. No renaming if not a global.
    if {[uplevel info globals $base_var] == {}} {
        return $ret
    }
    
    # At this point this is an assignment immediately after class creation.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
293 294 295 296
    if {$val == $last_class} {
	# Here we change ARRAY(INDEX) to ARRAY-INDEX
	regsub -all {[\(]} $var {-} out
	regsub -all {[\)]} $out {} val
297

Leigh B. Stoller's avatar
Leigh B. Stoller committed
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
	# 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
314

Leigh B. Stoller's avatar
Leigh B. Stoller committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
###
# 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::new_classes
    if {! [info exists new_classes($class)]} {
337
	punsup "Object: $class"
Leigh B. Stoller's avatar
Leigh B. Stoller committed
338
	set id null[incr new_counter]
339
	NullClass $id $class
Leigh B. Stoller's avatar
Leigh B. Stoller committed
340 341
	return $id
    }
342

Leigh B. Stoller's avatar
Leigh B. Stoller committed
343
    set id $class[incr new_counter]
344 345 346 347 348 349 350 351 352

    # XXX Hack!
    if {[llength $args] > 1} {
	punsup "arguments for $class"
    } elseif {[llength $args] == 1} {
	eval $class $id [lindex $args 0]
    } else {
	eval $class $id 
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
353 354 355 356 357 358 359 360 361
    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
362
# in Kbps.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
363 364 365 366 367
proc parse_bw {bspec} {
    # Default to bytes
    if {[scan $bspec "%f%s" bw unit] == 1} {
	set unit b
    }
368

Leigh B. Stoller's avatar
Leigh B. Stoller committed
369
    switch -- $unit {
370 371 372 373 374 375 376 377
	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
378
	default {
379
	    perror "Unknown bandwidth unit $unit."
380
	    set val 100000
Leigh B. Stoller's avatar
Leigh B. Stoller committed
381 382
	}
    }
383 384 385 386 387 388

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
391 392 393 394 395 396 397 398 399 400 401 402 403 404
# 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 {
405
	    perror "Unknown delay unit $unit."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
406 407 408 409 410 411 412
	    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
413

414 415 416 417 418 419 420
if { ${GLOBALS::errors} != 1 } {
    file copy -force ${GLOBALS::tbcompat} .
    source ${GLOBALS::nsfile}

    if {${GLOBALS::ran} == 0} {
	perror "No 'Simulator run' statement found."
    }
Mac Newbold's avatar
Mac Newbold committed
421

Leigh B. Stoller's avatar
Leigh B. Stoller committed
422
}
423

424 425 426
# Clean up
sql disconnect ${GLOBALS::DB}

427 428
close ${GLOBALS::WARN_FILE}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
429
exit ${GLOBALS::errors}