sim.tcl.in 23.3 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
31
32
33

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

    # A counter for subnets.  This is the lowest unused subnet
    # suffix.
    $self set subnet_counter 1
34
    $self set wa_subnet_counter 1
Leigh B. Stoller's avatar
Leigh B. Stoller committed
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

    # 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 {}
54
55
56

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

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

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

    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
74
75
76
77
78
79
80
}

# 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
81
    var_import ::GLOBALS::simulated
Leigh B. Stoller's avatar
Leigh B. Stoller committed
82
83
84
    $self instvar id_counter
    $self instvar node_list

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

Shashi Guruprasad's avatar
Shashi Guruprasad committed
92
93
94
    # simulated nodes have type 'sim'
    if { $simulated == 1 } {
        tb-set-hardware $curnode sim
95
    } 
Shashi Guruprasad's avatar
Shashi Guruprasad committed
96
    set node_list($curnode) {}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
97
98
99
100
101
102
103
104
105
106
107
    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
108
    var_import ::GLOBALS::simulated
Leigh B. Stoller's avatar
Leigh B. Stoller committed
109
110
111
112
    $self instvar id_counter
    $self instvar lanlink_list
    $self instvar link_map

113
114
    if {($args != {})} {
	punsup "Arguments for duplex-link: $args"
Leigh B. Stoller's avatar
Leigh B. Stoller committed
115
116
117
    }
    set error 0
    if {! [$n1 info class Node]} {
118
	perror "\[duplex-link] $n1 is not a node."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
119
120
121
	set error 1
    }
    if {! [$n2 info class Node]} {
122
	perror "\[duplex-link] $n2 is not a node."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
123
124
	set error 1
    }
125
126
127
128
#    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
129
130
131
132
133
134
135
136

    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
137
138
139
140
141
142
    if {$error} {return}

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

143
    set curlink tblink-l[incr id_counter]
144

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
150
151
152
153
154
155
156
157
158
159
    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
160
    var_import ::GLOBALS::simulated
Leigh B. Stoller's avatar
Leigh B. Stoller committed
161
162
163
    $self instvar id_counter
    $self instvar lanlink_list

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

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

Shashi Guruprasad's avatar
Shashi Guruprasad committed
193
194
195
196
197
198
199
	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 ""
	    }
200
201
	}
    }
Shashi Guruprasad's avatar
Shashi Guruprasad committed
202
203
204
205
206
207
208
209
210
211
212
213

    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
214
215
216
217
218
219
220
221
222
223
}

# 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
224
    $self instvar event_list
225
    $self instvar prog_list
Shashi Guruprasad's avatar
Shashi Guruprasad committed
226
227
    $self instvar simulated
    $self instvar nseconfig
228
229
    var_import ::GLOBALS::pid
    var_import ::GLOBALS::eid
Leigh B. Stoller's avatar
Leigh B. Stoller committed
230
231
232
233
    var_import ::GLOBALS::errors
    var_import ::GLOBALS::irfile
    var_import ::GLOBALS::ran
    var_import ::GLOBALS::impotent
234
    var_import ::GLOBALS::passmode
235
    var_import ::GLOBALS::vtypes
236
    var_import ::GLOBALS::uselatestwadata
237
    var_import ::GLOBALS::usewatunnels
238
239
240
    var_import ::GLOBALS::wa_delay_solverweight
    var_import ::GLOBALS::wa_bw_solverweight
    var_import ::GLOBALS::wa_plr_solverweight
241
242
    var_import ::GLOBALS::uselinkdelays
    var_import ::GLOBALS::forcelinkdelays
243
    var_import ::GLOBALS::multiplex_factor
244
245
246
    var_import ::TBCOMPAT::objtypes
    var_import ::TBCOMPAT::eventtypes
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
247
248
249
250
251
252
253
254
255
256
257
    # Fill out IPs
    foreach obj [concat [array names lanlink_list]] {
	$obj fill_ips
    }

    # 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]} {
258
	    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
259
260
261
262
	}
    }
    foreach lan [lsort [array names lanlink_list]] {
	if {! [regexp {^[-0-9A-Za-z]+$} $lan]} {
263
	    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
264
265
266
	}
    }

267
268
269
270
271
272
273
    # 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
274
275
276
277
    # If any errors occur stop here.
    if {$errors == 1} {return}

    # If we are running in impotent mode we stop here
278
    if {$impotent == 1 && $passmode == 0} {return}
Shashi Guruprasad's avatar
Shashi Guruprasad committed
279

280
281
    $self spitxml_init

Shashi Guruprasad's avatar
Shashi Guruprasad committed
282
283
284
285
286
287
288
289
290
291
292
293
    # 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
294
295

	$self spitxml_data "nseconfigs" [list "vname" "nseconfig" ] [list $self $nsecfg_script ]
Shashi Guruprasad's avatar
Shashi Guruprasad committed
296
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
297
298
299
    
    # Update the DB
    foreach node [lsort [array names node_list]] {
300
	$node updatedb "sql"
Leigh B. Stoller's avatar
Leigh B. Stoller committed
301
302
    }
    foreach lan [concat [array names lanlink_list]] {
303
	$lan updatedb "sql"
Leigh B. Stoller's avatar
Leigh B. Stoller committed
304
    }
305
    foreach vtype [array names vtypes] {
306
	$vtype updatedb "sql"
307
    }
308
    foreach prog [array names prog_list] {
309
	$prog updatedb "sql"
310
    }
311
312
313
314

    set fields [list "forcelinkdelays" "uselinkdelays" "usewatunnels" "uselatestwadata" "wa_delay_solverweight" "wa_bw_solverweight" "wa_plr_solverweight" ]
    set values [list $forcelinkdelays $uselinkdelays $usewatunnels $uselatestwadata $wa_delay_solverweight $wa_bw_solverweight $wa_plr_solverweight ]

315
    if { $multiplex_factor != {} } {
316
317
	lappend fields "multiplex_factor"
	lappend values $multiplex_factor
318
    }
319
320
    
    $self spitxml_data "experiments" $fields $values
321
322

    # This could probably be elsewhere.
323
    $self spitxml_data "virt_agents" [list "vnode" "vname" "objecttype" ] [list "*" $self $objtypes(SIMULATOR) ]
324
325
    
    foreach event $event_list {
326
	$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] ]
327
    }
328
329

    $self spitxml_finish
Leigh B. Stoller's avatar
Leigh B. Stoller committed
330
331
332
333
334
}

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
337
    if {! [$agent info class Agent]} {
338
	perror "\[attach-agent] $agent is not an Agent."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
339
340
341
	return
    }
    if {! [$node info class Node]} {
342
	perror "\[attach-agent] $node is not a Node."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
343
344
	return
    }
345
346
347
348
349
350
351
352
353
354

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

355
    $node attach-agent $agent
Leigh B. Stoller's avatar
Leigh B. Stoller committed
356
357
358
359
360
361
362
}

# connect <src> <dst>
# Connects two agents together.
Simulator instproc connect {src dst} {
    set error 0
    if {! [$src info class Agent]} {
363
	perror "\[connect] $src is not an Agent."
364
	set error 1
Leigh B. Stoller's avatar
Leigh B. Stoller committed
365
366
    }
    if {! [$dst info class Agent]} {
367
	perror "\[connect] $dst is not an Agent."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
368
369
370
371
372
373
374
	set error 1
    }
    if {$error} {return}
    $src connect $dst
    $dst connect $src
}

375
376
377
378
379
380
381
# at <time> <event>
# Known events:
#   <traffic> start
#   <traffic> stop
#   <link> up
#   <link> down
#   ...
382
Simulator instproc at {time eventstring} {
383
384
385
386
387
388
389
    var_import ::GLOBALS::simulated

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

390
391
392
393
394
    # Check that time is float
    if {[regexp {(^[0-9]+(\.[0-9]+)?$)|(^\.[0-9]+$)} $time] == 0} {
	perror "Invalid time spec: $time"
	return
    }
395
    $self instvar event_list
396
    $self instvar event_count
397

398
399
400
401
    if {$event_count > 4000} {
	perror "Too many events in your NS file!"
	exit 1
    }
402
    set eventlist [split $eventstring ";"]
403

404
  foreach event $eventlist {
405
406
407
    # Check otype/command
    set obj [lindex $event 0]
    set cmd [lindex $event 1]
408
    set atstring "$event"
409
    set args {}
410
411
412
413
414
    set okargs 0
    switch -- [$obj info class] {
	"Application/Traffic/CBR" {
	    set otype TRAFGEN
	    switch -- $cmd {
415
416
417
418
419
420
421
422
		"start" {
                    set params [$obj get_params]
		    set etype START
		    set args  $params
		}
		"stop" {
		    set etype STOP
		}
423
424
425
		"reset" {
		    set etype RESET
		}
426
427
                "set" {
		    if {[llength $event] < 4} {
428
			perror "Wrong number of arguments: at $time $event"
429
430
431
432
433
434
435
436
437
			return
		    }
		    set etype MODIFY
	            set arg [lindex $event 3]
                    switch -- [lindex $event 2] {
                        "packetSize_" {
	                    set args  "PACKETSIZE=$arg"
                        }
                        "rate_" {
438
439
			    set bw [parse_bw $arg]
	                    set args  "RATE=$bw"
440
441
442
443
                        }
                        "interval_" {
	                    set args  "INTERVAL=$arg"
                        }
444
                        "iptos_" {
445
	                    set args  "IPTOS=$arg"
446
                        }
447
448
449
450
451
452
			unknown {
		            punsup "at $time $event"
		            return
			}
		    }
                }
453
454
455
456
457
		unknown {
		    punsup "at $time $event"
		    return
		}
	    }
458
459
	    set vnode [$obj get_node]
	    set vname $obj
460
	}
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
	"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
	    set otype TRAFGEN
	    set etype MODIFY
	    set args "\$$obj $cmd [lrange $event 2 end]"
	    set vnode [$obj get_node]
	    set vname $obj
	}
481
482
483
	"Link" {
	    set otype LINK
	    switch -- $cmd {
484
485
486
487
		"up"	    {set etype UP}
		"down"	    {set etype DOWN}
		"bandwidth" {
		    if {[llength $event] < 4} {
488
			perror "Wrong number of arguments: at $time $event"
489
490
			return
		    }
491
                    set arg   [lindex $event 2]
492
493
		    set bw [parse_bw $arg]
                    set args  "BANDWIDTH=$bw"
494
495
496
497
		    set etype MODIFY
		}
		"delay" {
		    if {[llength $event] < 3} {
498
			perror "Wrong number of arguments: at $time $event"
499
500
501
502
			return
		    }
                    set arg   [lindex $event 2]
                    set args  "DELAY=$arg"
503
504
		    set etype MODIFY
		}
505
506
		"plr" {
		    if {[llength $event] < 3} {
507
			perror "Wrong number of arguments: at $time $event"
508
509
510
511
			return
		    }
                    if {[scan [lindex $event 2] "%f" plr] != 1 ||
                        $plr < 0 || $plr > 1} {
512
			perror "Improper argument: at $time $event"
513
514
515
516
517
			return
                    }
                    set args  "PLR=$plr"
		    set etype MODIFY
		}
518
519
520
521
522
523
524
525
526
527
		unknown {
		    punsup "at $time $event"
		    return
		}
	    }
	    set vnode {}
	    set vname $obj
	}
	"Queue" {
	    set otype LINK
528
	    set pipe [$obj get_pipe]
529
530
531
	    set obj [$obj get_link]
	    switch -- $cmd {
                "set" {
532
		    if {[llength $event] < 4} {
533
			perror "Wrong number of arguments: at $time $event"
534
535
536
			return
		    }
		    set etype MODIFY
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
	            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
559
	                    set args  "Q_WEIGHT=$w"
560
561
562
563
564
                        }
			unknown {
		            punsup "at $time $event"
		            return
			}
565
		    }
566
                }
567
568
569
570
571
		unknown {
		    punsup "at $time $event"
		    return
		}
	    }
572
	    set args "PIPE=$pipe $args"
573
574
575
	    set vnode {}
	    set vname $obj
	}
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
	"Program" {
	    set otype PROGRAM
	    set vname $obj
	    set vnode [$obj set node]
    
	    switch -- $cmd {
		"start" {
		    set etype START
		    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
	}
606
	"Simulator" {
607
608
609
	    set vnode "*"
	    set vname $self
	    
610
611
	    switch -- $cmd {
		"bandwidth" {
612
		    set otype LINK
613
		    set etype MODIFY
614
615
616
617
618
619
620
		    set vnode {}
		    set vname {}
		}
		"halt" {
		    set otype SIMULATOR
		    set etype HALT
		}
621
622
623
624
		"terminate" {
		    set otype SIMULATOR
		    set etype HALT
		}
625
626
627
		"swapout" {
		    set otype SIMULATOR
		    set etype SWAPOUT
628
629
630
631
632
633
634
635
636
637
638
639
640
		}
		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
641

642
    set event_count [expr $event_count + 1]
643
    lappend event_list [list $time $vnode $vname $otype $etype $args $atstring]
644
  }
645
646
}

647
#
648
# Routing control.
649
650
651
#
Simulator instproc rtproto {type args} {
    var_import ::GLOBALS::default_ip_routing_type
652
653
654
655
656
657
    var_import ::GLOBALS::simulated

    # ignore at statement for simulated case
    if { $simulated == 1 } {
	return
    }
658
659
660
661
662
663
664

    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
665
666
    } elseif {($type == "Manual")} {
	set default_ip_routing_type "manual"
667
668
    } elseif {($type == "Static")} {
	set default_ip_routing_type "static"
669
670
671
672
673
674
    } else {
	punsup "rtproto: unsupported routing protocol ignored: $type"
	return
    }
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
675
676
677
678
679
680
681
# 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
682
    punsup "Object $m"
683
    NullClass tbnull-null[incr id_counter] $m
Leigh B. Stoller's avatar
Leigh B. Stoller committed
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
}

# 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
707
708
709
710
711
712

    # 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
713
714
}

715
716
717
718
719
720
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
721
722
723
724
725
726
727
728
729
730
731
732
# 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 ""
    }
}

733
734
Simulator instproc link {src dst} {
    set reallink [$self find_link $src $dst]
735
736
737
738
739
740
741
742
743
744
745
	
    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]
746
747
}

748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
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
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# 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.
Simulator instproc get_subnet {} {
    $self instvar subnet_base
    $self instvar subnets
    $self instvar subnet_counter

    for {set i $subnet_counter} {$i < 255} {incr i} {
	if {! [info exists subnets($subnet_base.$i)]} {
	    set subnet_counter $i
	    return $subnet_base.$i
	}
    }
782
    perror "Ran out of subnets."
Leigh B. Stoller's avatar
Leigh B. Stoller committed
783
784
}

785
786
787
788
# 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 {} {
789
    $self instvar wa_subnet_counter
790

791
792
793
794
    set subnet $wa_subnet_counter
    incr wa_subnet_counter
    set b [expr [expr $subnet & 0xff00] >> 8]
    set c [expr $subnet & 0xff]
795
796
797
    return 10.$b.$c
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
798
799
800
801
802
803
# 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.
Simulator instproc use_subnet {subnet} {
    $self instvar subnets
    set subnets($subnet) {}
804
}
805

806
807
808
# add_program
# Link to a new program object.
Simulator instproc add_program {prog} {
809
    $self instvar prog_list
810
    set prog_list($prog) {}
811
}
812
813
814
815
816
817
818

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

# 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

    set simulated 0
}
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892

#
# 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} {
    puts "  <$tag>"
    puts "    <row>"
    foreach field $fields {
	set value  [lindex $values 0]
	set values [lrange $values 1 end]

	puts "      <$field>$value</$field>"
    }
    puts "    </row>"
    puts "  </$tag>"
}

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

	puts "      <$field>$value</$field>"
    }
    puts "    </row>"
    puts "  </$tag>"
}