sim.tcl.in 26.1 KB
Newer Older
1
# -*- tcl -*-
Leigh B. Stoller's avatar
Leigh B. Stoller committed
2
3
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2000-2003 University of Utah and the Flux Group.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
5
6
7
# All rights reserved.
#

Leigh B. Stoller's avatar
Leigh B. Stoller committed
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
######################################################################
# sim.tcl
#
# Defines the Simulator class.  For our purpose a Simulator is a
# topology.  This contains a number nodes, lans, and links.  It
# provides methods for the creation of these objects as well as
# routines to locate the objects.  It also stores common state (such
# as IP subnet usage).  Finally it defines the import 'run' method
# which causes all remaining calculations to be done and updates the
# DB state.
#
# Note: Although NS distinguishs between LANs and Links, we do not.
# We merge both types of objects into a single one called LanLink.  
# See lanlink.tcl and README for more information.
######################################################################

Class Simulator
25
Class Program -superclass NSObject
Leigh B. Stoller's avatar
Leigh B. Stoller committed
26
27
28
29
30

Simulator instproc init {args} {
    # A counter for internal ids
    $self set id_counter 0

31
    # Counters for subnets. 
Leigh B. Stoller's avatar
Leigh B. Stoller committed
32
    $self set subnet_counter 1
33
    $self set wa_subnet_counter 1
Leigh B. Stoller's avatar
Leigh B. Stoller committed
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

    # This is the prefix used to fill any unassigned IP addresses.
    $self set subnet_base "@IPBASE@"

    # The following are sets.  I.e. they map to no value, all
    # we care about is membership.
    $self instvar node_list;		# Indexed by node id
    array set node_list {}
    $self instvar lanlink_list;		# Indexed by lanlink id
    array set lanlink_list {}
    $self instvar subnets;		# Indexed by IP subnet
    array set subnets {}

    # link_map is indexed by <node1>:<node2> and contains the
    # id of the lanlink connecting them.  In the case of
    # multiple links between two nodes this contains
    # the last one created.
    $self instvar link_map
    array set link_map {}
53
54
55

    # event list is a list of {time vnode vname otype etype args atstring}
    $self set event_list {}
56
    $self set event_count 0
57

Shashi Guruprasad's avatar
Shashi Guruprasad committed
58
59
60
    # global nse config file. to be split later
    $self set nseconfig ""

61
62
63
    # Program list.
    $self instvar prog_list;
    array set prog_list {}
64
65
66
67
68
69
70
71
72

    var_import ::GLOBALS::last_class
    set last_class $self
}

# renaming the simulator instance
# needed to find the name of the instance
# for use in NSE code
Simulator instproc rename {old new} {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
73
74
75
76
77
78
79
}

# node
# This method adds a new node to the topology and returns the id
# of the node.
Simulator instproc node {args} {
    var_import ::GLOBALS::last_class
80
    var_import ::GLOBALS::simulated
Leigh B. Stoller's avatar
Leigh B. Stoller committed
81
82
83
    $self instvar id_counter
    $self instvar node_list

84
85
    if {($args != {})} {
	punsup "Arguments for node: $args"
Leigh B. Stoller's avatar
Leigh B. Stoller committed
86
87
    }
    
88
    set curnode tbnode-n[incr id_counter]
Leigh B. Stoller's avatar
Leigh B. Stoller committed
89
    Node $curnode $self
90

Shashi Guruprasad's avatar
Shashi Guruprasad committed
91
92
93
    # simulated nodes have type 'sim'
    if { $simulated == 1 } {
        tb-set-hardware $curnode sim
94
    } 
Shashi Guruprasad's avatar
Shashi Guruprasad committed
95
    set node_list($curnode) {}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
96
97
98
99
100
101
102
103
104
105
106
    set last_class $curnode

    return $curnode
}

# duplex-link <node1> <node2> <bandwidth> <delay> <type>
# This adds a new link to the topology.  <bandwidth> can be in any
# form accepted by parse_bw and <delay> in any form accepted by
# parse_delay.  Currently only the type 'DropTail' is supported.
Simulator instproc duplex-link {n1 n2 bw delay type args} {
    var_import ::GLOBALS::last_class
107
    var_import ::GLOBALS::simulated
Leigh B. Stoller's avatar
Leigh B. Stoller committed
108
109
110
111
    $self instvar id_counter
    $self instvar lanlink_list
    $self instvar link_map

112
113
    if {($args != {})} {
	punsup "Arguments for duplex-link: $args"
Leigh B. Stoller's avatar
Leigh B. Stoller committed
114
115
116
    }
    set error 0
    if {! [$n1 info class Node]} {
117
	perror "\[duplex-link] $n1 is not a node."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
118
119
120
	set error 1
    }
    if {! [$n2 info class Node]} {
121
	perror "\[duplex-link] $n2 is not a node."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
122
123
	set error 1
    }
124
125
126
127
#    if { [$n1 set isvirt] != [$n2 set isvirt] } {
#	perror "\[duplex-link] Bad link between real and virtual node!"
#	set error 1
#    }
Shashi Guruprasad's avatar
Shashi Guruprasad committed
128
129
130
131
132
133
134
135

    if { $simulated == 1 && ( [$n1 set simulated] == 0 || [$n2 set simulated] == 0 ) } {
	set simulated 0
	perror "\[duplex-link] Please define links between real and simulated nodes outside make-simulated"
	set simulated 1
	set error 1
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
136
137
138
139
140
141
    if {$error} {return}

    # Convert bandwidth and delay
    set rbw [parse_bw $bw]
    set rdelay [parse_delay $delay]

142
    set curlink tblink-l[incr id_counter]
143

Shashi Guruprasad's avatar
Shashi Guruprasad committed
144
    Link $curlink $self "$n1 $n2" $rbw $rdelay $type	
145
    set lanlink_list($curlink) {}
Shashi Guruprasad's avatar
Shashi Guruprasad committed
146
147
148
    set link_map($n1:$n2) $curlink
    set link_map($n2:$n1) $curlink

Leigh B. Stoller's avatar
Leigh B. Stoller committed
149
150
151
152
153
154
155
156
157
158
    set last_class $curlink
    return $curlink
}

# make-lan <nodelist> <bw> <delay>
# This adds a new lan to the topology. <bandwidth> can be in any
# form accepted by parse_bw and <delay> in any form accepted by
# parse_delay.
Simulator instproc make-lan {nodelist bw delay args} {
    var_import ::GLOBALS::last_class
159
    var_import ::GLOBALS::simulated
Leigh B. Stoller's avatar
Leigh B. Stoller committed
160
161
162
    $self instvar id_counter
    $self instvar lanlink_list

163
164
    if {($args != {})} {
	punsup "Arguments for make-lan: $args"
Leigh B. Stoller's avatar
Leigh B. Stoller committed
165
    }
166

167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
    #
    # The number of virtual nodes has to be zero, or equal to the number
    # of nodes (In other word, no mixing of real and virtual nodes).
    #
#    set acount 0
#    set vcount 0
#    foreach node $nodelist {
#	if { [$node set isvirt] } {
#	    incr vcount
#	}
#	incr acount
#    }
#    if { ($vcount != 0) && ($vcount != $acount) } {
#	perror "\[duplex-link] Bad lan between real and virtual nodes!"
#	set error 1
#	return ""
#    }

Shashi Guruprasad's avatar
Shashi Guruprasad committed
185
186
187
188
189
190
    # At this point we have one of the nodes of
    # the lan to be real. We need to make sure
    # that this is not being defined in make-simulated.
    # In other words links or lans from real nodes and
    # simulated nodes should happen outside make-simulated
    if { $simulated == 1 } {
191

Shashi Guruprasad's avatar
Shashi Guruprasad committed
192
193
194
195
196
197
198
	foreach node $nodelist {
	    if { [$node set simulated] == 0 } {	
		set simulated 0
		perror "Please define lans between real and simulated nodes outside make-simulated"
		set simulated 1
		return ""
	    }
199
200
	}
    }
Shashi Guruprasad's avatar
Shashi Guruprasad committed
201
202
203
204
205
206
207
208
209
210
211
212

    set curlan tblan-lan[incr id_counter]
    
    # Convert bandwidth and delay
    set rbw [parse_bw $bw]
    set rdelay [parse_delay $delay]
    
    Lan $curlan $self $nodelist $rbw $rdelay {}
    set lanlink_list($curlan) {}
    set last_class $curlan
    
    return $curlan
Leigh B. Stoller's avatar
Leigh B. Stoller committed
213
214
215
216
217
218
219
220
221
222
}

# run
# This method causes the fill_ips method to be invoked on all 
# lanlinks and then, if not running in impotent mode, calls the
# updatedb method on all nodes and lanlinks.  Invocation of this
# method casues the 'ran' variable to be set to 1.
Simulator instproc run {} {
    $self instvar lanlink_list
    $self instvar node_list
223
    $self instvar event_list
224
    $self instvar prog_list
Shashi Guruprasad's avatar
Shashi Guruprasad committed
225
226
    $self instvar simulated
    $self instvar nseconfig
227
228
    var_import ::GLOBALS::pid
    var_import ::GLOBALS::eid
Leigh B. Stoller's avatar
Leigh B. Stoller committed
229
230
231
232
    var_import ::GLOBALS::errors
    var_import ::GLOBALS::irfile
    var_import ::GLOBALS::ran
    var_import ::GLOBALS::impotent
233
    var_import ::GLOBALS::passmode
234
    var_import ::GLOBALS::vtypes
235
    var_import ::GLOBALS::uselatestwadata
236
    var_import ::GLOBALS::usewatunnels
237
238
239
    var_import ::GLOBALS::wa_delay_solverweight
    var_import ::GLOBALS::wa_bw_solverweight
    var_import ::GLOBALS::wa_plr_solverweight
240
241
    var_import ::GLOBALS::uselinkdelays
    var_import ::GLOBALS::forcelinkdelays
242
    var_import ::GLOBALS::multiplex_factor
243
    var_import ::GLOBALS::sync_server
244
245
    var_import ::GLOBALS::cpu_usage
    var_import ::GLOBALS::mem_usage
246
247
248
    var_import ::TBCOMPAT::objtypes
    var_import ::TBCOMPAT::eventtypes
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
249
250
251
252
253
    # Fill out IPs
    foreach obj [concat [array names lanlink_list]] {
	$obj fill_ips
    }

254
255
256
257
258
259
260
261
262
263
    # Go through the list of nodes, and find subnode hosts - we have to add a
    # desire to them to have the hosts-<type-of-child> feature
    foreach node [lsort [array names node_list]] {
	if { [$node set subnodehost] == 1 } {
	    set child [$node set subnodechild]
	    set childtype [$child set type]
	    $node add-desire "hosts-$childtype" 1.0
	}
    }

264
265
    # Default sync server.
    set default_sync_server {}
266

Leigh B. Stoller's avatar
Leigh B. Stoller committed
267
268
269
270
271
272
    # Mark that a run statement exists
    set ran 1

    # Check node names.
    foreach node [lsort [array names node_list]] {
	if {! [regexp {^[-0-9A-Za-z]+$} $node]} {
273
	    perror "\[run] Invalid node name $node.  Can only contain \[-0-9A-Za-z\] due to DNS limitations."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
274
275
276
277
	}
    }
    foreach lan [lsort [array names lanlink_list]] {
	if {! [regexp {^[-0-9A-Za-z]+$} $lan]} {
278
	    perror "\[run] Invalid lan/link name $lan.  Can only contain \[-0-9A-Za-z\] for symmetry with node DNS limitations."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
279
280
281
	}
    }

282
283
284
285
286
287
288
    # Check for one node lans
    foreach lan [array names lanlink_list] {
	if {[llength [$lan set nodelist]] <= 1} {
	    perror "\[run] $lan has only a single node.  LANs must have at least 2 nodes in them."
	}
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
289
290
291
292
    # If any errors occur stop here.
    if {$errors == 1} {return}

    # If we are running in impotent mode we stop here
293
    if {$impotent == 1 && $passmode == 0} {return}
294
    
295
296
    $self spitxml_init

Shashi Guruprasad's avatar
Shashi Guruprasad committed
297
298
299
300
301
302
303
304
305
306
307
308
    # update the global nseconfigs using a bogus vname
    # i.e. instead of the node on which nse is gonna run
    # which was the original vname field, we just put $ns
    # for now. Once assign runs, the correct value will be
    # entered into the database
    if { $nseconfig != {} } {
 
 	set nsecfg_script ""
 	set simu [lindex [Simulator info instances] 0]
 	append nsecfg_script "set $simu \[new Simulator]\n"
 	append nsecfg_script "\$$simu use-scheduler RealTime\n\n"
 	append nsecfg_script $nseconfig
309

310
	$self spitxml_data "nseconfigs" [list "vname" "nseconfig" ] [list fullsim $nsecfg_script ]
Shashi Guruprasad's avatar
Shashi Guruprasad committed
311
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
312
313
314
    
    # Update the DB
    foreach node [lsort [array names node_list]] {
315
	$node updatedb "sql"
316
317
318
319

	if { $default_sync_server == {} } {
	    set default_sync_server $node
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
320
    }
321
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
322
    foreach lan [concat [array names lanlink_list]] {
323
	$lan updatedb "sql"
Leigh B. Stoller's avatar
Leigh B. Stoller committed
324
    }
325
    foreach vtype [array names vtypes] {
326
	$vtype updatedb "sql"
327
    }
328
    foreach prog [array names prog_list] {
329
	$prog updatedb "sql"
330
    }
331

332
333
    set fields [list "mem_usage" "cpu_usage" "forcelinkdelays" "uselinkdelays" "usewatunnels" "uselatestwadata" "wa_delay_solverweight" "wa_bw_solverweight" "wa_plr_solverweight" ]
    set values [list $mem_usage $cpu_usage $forcelinkdelays $uselinkdelays $usewatunnels $uselatestwadata $wa_delay_solverweight $wa_bw_solverweight $wa_plr_solverweight ]
334

335
    if { $multiplex_factor != {} } {
336
337
	lappend fields "multiplex_factor"
	lappend values $multiplex_factor
338
    }
339
    
340
341
342
    if { $sync_server != {} } {
	lappend fields "sync_server"
	lappend values $sync_server
343
344
345
    } elseif { $default_sync_server != {} } {
	lappend fields "sync_server"
	lappend values $default_sync_server
346
347
    }
    
348
    $self spitxml_data "experiments" $fields $values
349
350

    # This could probably be elsewhere.
351
    $self spitxml_data "virt_agents" [list "vnode" "vname" "objecttype" ] [list "*" $self $objtypes(SIMULATOR) ]
352
353
354

    # This will eventually be under user control.
    $self spitxml_data "virt_agents" [list "vnode" "vname" "objecttype" ] [list "*" "linktest" $objtypes(LINKTEST) ]
355
356
    
    foreach event $event_list {
357
	$self spitxml_data "eventlist" [list "time" "vnode" "vname" "objecttype" "eventtype" "arguments" "atstring" ] [list [lindex $event 0] [lindex $event 1] [lindex $event 2] $objtypes([lindex $event 3]) $eventtypes([lindex $event 4]) [lindex $event 5] [lindex $event 6] ]
358
    }
359
360

    $self spitxml_finish
Leigh B. Stoller's avatar
Leigh B. Stoller committed
361
362
363
364
365
}

# attach-agent <node> <agent>
# This creates an attachment between <node> and <agent>.
Simulator instproc attach-agent {node agent} {
366
367
    var_import ::GLOBALS::simulated

Leigh B. Stoller's avatar
Leigh B. Stoller committed
368
    if {! [$agent info class Agent]} {
369
	perror "\[attach-agent] $agent is not an Agent."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
370
371
372
	return
    }
    if {! [$node info class Node]} {
373
	perror "\[attach-agent] $node is not a Node."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
374
375
	return
    }
376
377
378
379
380
381
382
383
384
385

    # If the node is real and yet this code is in make-simulated
    # we don't allow it
    if { [$node set simulated] == 0 && $simulated == 1 } {
	set simulated 0
	perror "Please attach agents on to real nodes outside make-simulated"
	set simulated 1
	return ""
    }

386
    $node attach-agent $agent
Leigh B. Stoller's avatar
Leigh B. Stoller committed
387
388
389
390
391
392
393
}

# connect <src> <dst>
# Connects two agents together.
Simulator instproc connect {src dst} {
    set error 0
    if {! [$src info class Agent]} {
394
	perror "\[connect] $src is not an Agent."
395
	set error 1
Leigh B. Stoller's avatar
Leigh B. Stoller committed
396
397
    }
    if {! [$dst info class Agent]} {
398
	perror "\[connect] $dst is not an Agent."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
399
400
401
402
403
404
405
	set error 1
    }
    if {$error} {return}
    $src connect $dst
    $dst connect $src
}

406
407
408
409
410
411
412
# at <time> <event>
# Known events:
#   <traffic> start
#   <traffic> stop
#   <link> up
#   <link> down
#   ...
413
Simulator instproc at {time eventstring} {
414
415
416
417
418
419
420
    var_import ::GLOBALS::simulated

    # ignore at statement for simulated case
    if { $simulated == 1 } {
	return
    }

421
422
423
424
425
    # Check that time is float
    if {[regexp {(^[0-9]+(\.[0-9]+)?$)|(^\.[0-9]+$)} $time] == 0} {
	perror "Invalid time spec: $time"
	return
    }
426
    $self instvar event_list
427
    $self instvar event_count
428

429
430
431
432
    if {$event_count > 4000} {
	perror "Too many events in your NS file!"
	exit 1
    }
433
    set eventlist [split $eventstring ";"]
434

435
  foreach event $eventlist {
436
437
438
    # Check otype/command
    set obj [lindex $event 0]
    set cmd [lindex $event 1]
439
    set atstring "$event"
440
    set args {}
441
442
443
444
445
    set okargs 0
    switch -- [$obj info class] {
	"Application/Traffic/CBR" {
	    set otype TRAFGEN
	    switch -- $cmd {
446
447
448
449
450
451
452
453
		"start" {
                    set params [$obj get_params]
		    set etype START
		    set args  $params
		}
		"stop" {
		    set etype STOP
		}
454
455
456
		"reset" {
		    set etype RESET
		}
457
458
                "set" {
		    if {[llength $event] < 4} {
459
			perror "Wrong number of arguments: at $time $event"
460
461
462
463
464
465
466
467
468
			return
		    }
		    set etype MODIFY
	            set arg [lindex $event 3]
                    switch -- [lindex $event 2] {
                        "packetSize_" {
	                    set args  "PACKETSIZE=$arg"
                        }
                        "rate_" {
469
470
			    set bw [parse_bw $arg]
	                    set args  "RATE=$bw"
471
472
473
474
                        }
                        "interval_" {
	                    set args  "INTERVAL=$arg"
                        }
475
                        "iptos_" {
476
	                    set args  "IPTOS=$arg"
477
                        }
478
479
480
481
482
483
			unknown {
		            punsup "at $time $event"
		            return
			}
		    }
                }
484
485
486
487
488
		unknown {
		    punsup "at $time $event"
		    return
		}
	    }
489
490
	    set vnode [$obj get_node]
	    set vname $obj
491
	}
492
493
494
495
496
497
498
499
500
501
502
503
504
505
	"Agent/TCP/FullTcp" -
	"Agent/TCP/FullTcp/Reno" -
	"Agent/TCP/FullTcp/Newreno" -
	"Agent/TCP/FullTcp/Tahoe" -
	"Agent/TCP/FullTcp/Sack" - 
	"Application/FTP" -
	"Application/Telnet" {
	    # For events sent to NSE, we don't distinguish
	    # between START, STOP and MODIFY coz the entire
	    # string passed to '$ns at' is sent for evaluation to the node
	    # on which NSE is running: fix needed for the
	    # case when the above string has syntax errors. Maybe
	    # just have a way reporting errors back to the
	    # the user from the NSE that finds the syntax errors
506
507
	    set otype NSE
	    set etype NSEEVENT
508
509
510
511
	    set args "\$$obj $cmd [lrange $event 2 end]"
	    set vnode [$obj get_node]
	    set vname $obj
	}
512
513
514
	"Link" {
	    set otype LINK
	    switch -- $cmd {
515
516
517
518
		"up"	    {set etype UP}
		"down"	    {set etype DOWN}
		"bandwidth" {
		    if {[llength $event] < 4} {
519
			perror "Wrong number of arguments: at $time $event"
520
521
			return
		    }
522
                    set arg   [lindex $event 2]
523
524
		    set bw [parse_bw $arg]
                    set args  "BANDWIDTH=$bw"
525
526
527
528
		    set etype MODIFY
		}
		"delay" {
		    if {[llength $event] < 3} {
529
			perror "Wrong number of arguments: at $time $event"
530
531
532
533
			return
		    }
                    set arg   [lindex $event 2]
                    set args  "DELAY=$arg"
534
535
		    set etype MODIFY
		}
536
537
		"plr" {
		    if {[llength $event] < 3} {
538
			perror "Wrong number of arguments: at $time $event"
539
540
541
542
			return
		    }
                    if {[scan [lindex $event 2] "%f" plr] != 1 ||
                        $plr < 0 || $plr > 1} {
543
			perror "Improper argument: at $time $event"
544
545
546
547
548
			return
                    }
                    set args  "PLR=$plr"
		    set etype MODIFY
		}
549
550
551
552
553
554
555
556
557
558
		unknown {
		    punsup "at $time $event"
		    return
		}
	    }
	    set vnode {}
	    set vname $obj
	}
	"Queue" {
	    set otype LINK
559
	    set pipe [$obj get_pipe]
560
561
562
	    set obj [$obj get_link]
	    switch -- $cmd {
                "set" {
563
		    if {[llength $event] < 4} {
564
			perror "Wrong number of arguments: at $time $event"
565
566
567
			return
		    }
		    set etype MODIFY
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
	            set arg [lindex $event 3]
                    switch -- [lindex $event 2] {
                        "queue-in-bytes_" {
	                    set args  "QUEUE-IN-BYTES=$arg"
                        }
                        "limit_" {
	                    set args  "LIMIT=$arg"
                        }
                        "maxthresh_" {
	                    set args  "MAXTHRESH=$arg"
                        }
                        "thresh_" {
	                    set args  "THRESH=$arg"
                        }
                        "linterm_" {
	                    set args  "LINTERM=$arg"
                        }
                        "q_weight_" {
			    if {[scan $arg "%f" w] != 1} {
				perror "Improper argument: at $time $event"
				return
			    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
590
	                    set args  "Q_WEIGHT=$w"
591
592
593
594
595
                        }
			unknown {
		            punsup "at $time $event"
		            return
			}
596
		    }
597
                }
598
599
600
601
602
		unknown {
		    punsup "at $time $event"
		    return
		}
	    }
603
	    set args "PIPE=$pipe $args"
604
605
606
	    set vnode {}
	    set vname $obj
	}
607
608
609
610
611
612
613
614
	"Program" {
	    set otype PROGRAM
	    set vname $obj
	    set vnode [$obj set node]
    
	    switch -- $cmd {
		"start" {
		    set etype START
615
616
		    # Must leave this here for the benefit of old
		    # images that expect the command line in the event. 
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
		    set arg  [$obj set command]
		    set args "COMMAND=$arg"
		}
		"stop" {
		    set etype STOP
		}
		"kill" {
		    set etype KILL
		    if {[llength $event] < 3} {
			perror "Wrong number of arguments: at $time $event"
			return
		    }
	            set arg [lindex $event 2]
		    set args "SIGNAL=$arg"
		}
		unknown {
		    punsup "at $time $event"
		    return
		}
	    }
	    set okargs 1
	}
639
	"Simulator" {
640
641
642
	    set vnode "*"
	    set vname $self
	    
643
644
	    switch -- $cmd {
		"bandwidth" {
645
		    set otype LINK
646
		    set etype MODIFY
647
648
649
650
651
652
653
		    set vnode {}
		    set vname {}
		}
		"halt" {
		    set otype SIMULATOR
		    set etype HALT
		}
654
655
656
657
		"terminate" {
		    set otype SIMULATOR
		    set etype HALT
		}
658
659
660
		"swapout" {
		    set otype SIMULATOR
		    set etype SWAPOUT
661
662
663
664
665
666
667
668
669
670
671
672
673
		}
		unknown {
		    punsup "at $time $event"
		    return
		}
	    }
	    set okargs 1
	}
	unknown {
	    punsup "Unknown object type: at $time $event"
	    return
	}
    }
Shashi Guruprasad's avatar
Shashi Guruprasad committed
674

675
    set event_count [expr $event_count + 1]
676
    lappend event_list [list $time $vnode $vname $otype $etype $args $atstring]
677
  }
678
679
}

680
#
681
# Routing control.
682
683
684
#
Simulator instproc rtproto {type args} {
    var_import ::GLOBALS::default_ip_routing_type
685
686
687
688
689
690
    var_import ::GLOBALS::simulated

    # ignore at statement for simulated case
    if { $simulated == 1 } {
	return
    }
691
692
693
694
695
696
697

    if {$args != {}} {
	punsup "rtproto: arguments ignored: $args"
    }

    if {($type == "Session") ||	($type == "ospf")} {
	set default_ip_routing_type "ospf"
Leigh B. Stoller's avatar
Leigh B. Stoller committed
698
699
    } elseif {($type == "Manual")} {
	set default_ip_routing_type "manual"
700
701
    } elseif {($type == "Static")} {
	set default_ip_routing_type "static"
702
703
704
705
706
707
    } else {
	punsup "rtproto: unsupported routing protocol ignored: $type"
	return
    }
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
708
709
710
711
712
713
714
# unknown 
# This is invoked whenever any method is called on the simulator
# object that is not defined.  We interpret such a call to be a
# request to create an object of that type.  We create display an
# unsupported message and create a NullClass to fulfill the request.
Simulator instproc unknown {m args} {
    $self instvar id_counter
715
    punsup "Object $m"
716
    NullClass tbnull-null[incr id_counter] $m
Leigh B. Stoller's avatar
Leigh B. Stoller committed
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
}

# rename_* <old> <new>
# The following two procedures handle when an object is being renamed.
# They update the internal datastructures to reflect the new name.
Simulator instproc rename_lanlink {old new} {
    $self instvar lanlink_list
    $self instvar link_map

    unset lanlink_list($old)
    set lanlink_list($new) {}

    # In the case of a link we need to update the link_map as well.
    if {[$new info class] == "Link"} {
	$new instvar nodelist
	set src [lindex [lindex $nodelist 0] 0]
	set dst [lindex [lindex $nodelist 1] 0]
	set link_map($src:$dst) $new
	set link_map($dst:$src) $new
    }
}
Simulator instproc rename_node {old new} {
    $self instvar node_list
740
741
742
743
744
745

    # simulated nodes won't exist in the node_list
    if { [info exists node_list($old)] } {
	unset node_list($old)
	set node_list($new) {}
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
746
747
}

748
749
750
751
752
753
Simulator instproc rename_program {old new} {
    $self instvar prog_list
    unset prog_list($old)
    set prog_list($new) {}
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
754
755
756
757
758
759
760
761
762
763
764
765
# find_link <node1> <node2>
# This is just an accesor to the link_map datastructure.  If no
# link is known between <node1> and <node2> the empty list is returned.
Simulator instproc find_link {src dst} {
    $self instvar link_map
    if {[info exists link_map($src:$dst)]} {
	return $link_map($src:$dst)
    } else {
	return ""
    }
}

766
767
Simulator instproc link {src dst} {
    set reallink [$self find_link $src $dst]
768
769
770
771
772
773
774
775
776
777
778
	
    if {$src == [$reallink set src_node]} {
	set dir "to"
    } else {
	set dir "from"
    }
    
    var_import GLOBALS::new_counter
    set name sl[incr new_counter]
    
    return [SimplexLink $name $reallink $dir]
779
780
}

781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
Simulator instproc lanlink {lan node} {
    if {[$node info class] != "Node"} {
	perror "\[lanlink] $node is not a node."
	return
    }
    if {[$lan info class] != "Lan"} {
	perror "\[lanlink] $lan is not a lan."
	return
    }
    set port [$lan get_port $node]
    if {$port == {}} {
	perror "\[lanlink] $node is not in $lan."
	return
    }
    var_import GLOBALS::new_counter
    set name ll[incr new_counter]
    
    return [LLink $name $lan $node]
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
801
802
803
# get_subnet
# This is called by lanlinks.  When called get_subnet will find an available
# IP subnet, mark it as used, and return it to the caller.
804
Simulator instproc get_subnet {netmask} {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
805
806
807
    $self instvar subnet_base
    $self instvar subnets

808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
    set netmaskint [inet_atohl $netmask]

    set A $subnet_base
    set C [expr ($netmaskint >> 8) & 0xff]
    set D [expr $netmaskint & 0xff]
    set minB 1
    set maxB 254
    set minC 0
    set maxC 1
    set incC 1
    set minD 0
    set maxD 1
    set incD 1

    # allow for 10. or 192.168. I know, could be more general.
    if {[expr [llength [split $subnet_base .]]] == 2} {
	# 192.168.
	set A    [expr [lindex [split $subnet_base .] 0]]
	set minB [expr [lindex [split $subnet_base .] 1]]
	set maxB [expr $minB + 1]
    }
    if {$C != 0} {	
	set minC [expr 256 - $C]
	set maxC 255
	set incC $minC
    } 
    if {$D != 0} {	
	set minD [expr 256 - $D]
	set maxD 255
	set incD $minD
    }

    # We never let the user change the second octet. See tb-set-netmask.
    for {set i $minB} {$i < $maxB} {incr i} {
	for {set j $minC} {$j < $maxC} {set j [expr $j + $incC]} {
	    for {set k $minD} {$k < $maxD} {set k [expr $k + $incD]} {
		set subnet "$A.$i.$j.$k"
		set subnetint [inet_atohl $subnet]

		# No such subnet exists?
		if {! [info exists subnets($subnetint)]} {
		    set okay 1

		    #
		    # See if this subnet violates any existing subnet masks
		    # Is this overly restrictive? Totally wrong?
		    #
		    foreach osubnetint [concat [array names subnets]] {
			set onetmaskint $subnets($osubnetint)

			if {[expr $subnetint & $onetmaskint] == $osubnetint ||
 			    [expr $osubnetint & $netmaskint] == $subnetint} {
			    set okay 0
			    break
			}
		    }
		    if {$okay} {
			$self use_subnet $subnet $netmask
			return $subnet
		    }
		}
	    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
870
871
	}
    }
872
    perror "Ran out of subnets."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
873
874
}

875
876
877
878
# get_subnet_remote
# This is called by lanlinks.  When called get_subnet will find an available
# IP subnet, mark it as used, and return it to the caller.
Simulator instproc get_subnet_remote {} {
879
    $self instvar wa_subnet_counter
880

881
882
883
884
    if {$wa_subnet_counter > 255} {
	perror "Ran out of widearea subnets."
	return 0
    }
885
886
    set subnet $wa_subnet_counter
    incr wa_subnet_counter
887
    return "1.1.$subnet.0"
888
889
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
890
891
892
# use_subnet
# This is called by the ip method of nodes.  It marks the passed subnet
# as used and thus should never be returned by get_subnet.
893
Simulator instproc use_subnet {subnet netmask} {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
894
    $self instvar subnets
895
896
897
898
899

    set subnetint [inet_atohl $subnet]
    set netmaskint [inet_atohl $netmask]
    
    set subnets($subnetint) $netmaskint
900
}
901

902
903
904
# add_program
# Link to a new program object.
Simulator instproc add_program {prog} {
905
    $self instvar prog_list
906
    set prog_list($prog) {}
907
}
908
909
910
911
912
913
914

# cost
# Set the cost for a link
Simulator instproc cost {src dst c} {
    set reallink [$self find_link $src $dst]
    $reallink set cost([list $src [$reallink get_port $src]]) $c
}
Shashi Guruprasad's avatar
Shashi Guruprasad committed
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940

# Now we have an experiment wide 
# simulation specification. Virtual to physical
# mapping will be done in later stages
Simulator instproc make-simulated {args} {

    var_import ::GLOBALS::simulated
    $self instvar nseconfig
    $self instvar simcode_present

    set simulated 1
    global script
    set script [string trim $args "\{\}"]

    if { $script == {} } {
        set simulated 0
        return
    }

    set simcode_present 1

    # we ignore any type of errors coz they have
    # been caught when we ran the script through NSE
    uplevel 1 eval $script

    append nseconfig $script
941
    append nseconfig \n
Shashi Guruprasad's avatar
Shashi Guruprasad committed
942
943
944

    set simulated 0
}
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961

#
# Spit out XML
#
Simulator instproc spitxml_init {} {
    var_import ::GLOBALS::pid
    var_import ::GLOBALS::eid

    puts "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>"
    puts "<virtual_experiment pid='$pid' eid='$eid'>"
}

Simulator instproc spitxml_finish {} {
    puts "</virtual_experiment>"
}

Simulator instproc spitxml_data {tag fields values} {
962
    ::spitxml_data $tag $fields $values
963
964
965
966
967
968
969
970
971
972
973
974
}

#
# Global function, cause some objects do not hold a sim pointer.
# Should fix.
# 
proc spitxml_data {tag fields values} {
    puts "  <$tag>"
    puts "    <row>"
    foreach field $fields {
	set value  [lindex $values 0]
	set values [lrange $values 1 end]
975
	set value_esc [xmlencode $value]
976

977
	puts "      <$field>$value_esc</$field>"
978
979
980
981
    }
    puts "    </row>"
    puts "  </$tag>"
}
982
983

proc xmlencode {args} {
984
985
986
987
988
989
    set retval [eval append retval $args]
    regsub -all "&" $retval "\\&amp;" retval
    regsub -all "<" $retval "\\&lt;" retval
    regsub -all ">" $retval "\\&gt;" retval
    regsub -all "\"" $retval "\\&\#34;" retval
    regsub -all "]" $retval "\\&\#93;" retval
990
    
991
    return $retval
992
}