parse.tcl.in 11.7 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
    var_import ::GLOBALS::errors 
59
60
61
62
63
64
65
66
67
    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
    }

68
    global argv0
69
70
    puts stderr "*** $argv0: "
    puts stderr "    $msg"
Leigh B. Stoller's avatar
Leigh B. Stoller committed
71
72
73
    set errors 1
}

74
75
###
# punsup {msg}
76
# Print an unsupported message.
77
78
###
proc punsup {msg} {
79
    var_import ::GLOBALS::verbose
80
    var_import ::GLOBALS::WARN_FILE
81
82
83
84
85
86
    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} {
87
88
	puts stderr "*** WARNING: Unsupported NS Statement!"
	puts stderr "    $msg"
89
90
	puts $WARN_FILE "*** WARNING: Unsupported NS Statement!"
	puts $WARN_FILE "    $msg"
91
    }
92
}	
Leigh B. Stoller's avatar
Leigh B. Stoller committed
93

94
95
96
97
98
99
100
101
102
#
# 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
103
104
105
106
107
108
109
# 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
110
variable vtype_list {}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
}

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
126
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
}

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
149
    } else {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
150
151
152
	variable pid [lindex $argv 0]
	variable eid [lindex $argv 1]
	variable nsfile [lindex $argv 2]
Mac Newbold's avatar
Mac Newbold committed
153
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
154
155
156
157
158
159
160
161
162
    
    # 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
163
    variable disablense {@DISABLE_NSE@}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
164
165
166
167
168
169

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

170
171
172
    # 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
173
174
175
176
177
178
179
180
181
182
183
184
    # 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 {}
185
186
187

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

189
190
191
    # For remote nodes. Use latest widearea data.
    variable uselatestwadata 0

192
193
194
195
196
    # For remote nodes. The solver weights.
    variable wa_delay_solverweight 1
    variable wa_bw_solverweight	   7
    variable wa_plr_solverweight   500

197
198
    # This is the file handler for the warnings file
    variable WARN_FILE [open "$eid.warnings" w]
199
200
201
202
203
204
205
206
207

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

    # If simulated is 1, then curnsenode gives us the name
    # of the physical node on which the simulation script 
    # should go into
    variable curnsenode ""
Mac Newbold's avatar
Mac Newbold committed
208
209
}

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

214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
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
229
230
231
232
233
# Load all our classes
source ${GLOBALS::libdir}/nsobject.tcl
source ${GLOBALS::libdir}/sim.tcl
source ${GLOBALS::libdir}/lanlink.tcl
source ${GLOBALS::libdir}/node.tcl
234
source ${GLOBALS::libdir}/nsenode.tcl
Leigh B. Stoller's avatar
Leigh B. Stoller committed
235
236
source ${GLOBALS::libdir}/null.tcl
source ${GLOBALS::libdir}/traffic.tcl
237
source ${GLOBALS::libdir}/vtype.tcl
238
source ${GLOBALS::libdir}/program.tcl
Mac Newbold's avatar
Mac Newbold committed
239

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

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

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

    # 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
291
292
293
294
    if {$val == $last_class} {
	# Here we change ARRAY(INDEX) to ARRAY-INDEX
	regsub -all {[\(]} $var {-} out
	regsub -all {[\)]} $out {} val
295

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

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

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

    # 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
351
352
353
354
355
356
357
358
359
    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
360
# in Kbps.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
361
362
363
364
365
proc parse_bw {bspec} {
    # Default to bytes
    if {[scan $bspec "%f%s" bw unit] == 1} {
	set unit b
    }
366

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

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

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

412
# We first run the script through NSE to check syntax errors
413
414
415
416
417
if { ${GLOBALS::disablense} != 1 } {
    file copy -force ${GLOBALS::nstbcompat} tb_compat.tcl
    if { [catch {exec nse ${GLOBALS::nsfile}} errMsg] == 1 } {
	perror "Syntax check with NS failed\nerrorcode: $errorCode\n error msg: $errMsg"
    }
418
}
Mac Newbold's avatar
Mac Newbold committed
419

420
421
422
423
424
425
426
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
427

Leigh B. Stoller's avatar
Leigh B. Stoller committed
428
}
429

430
431
432
# Clean up
sql disconnect ${GLOBALS::DB}

433
434
close ${GLOBALS::WARN_FILE}

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