mapper.in 16.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#!/usr/bin/perl -w
#
# EMULAB-COPYRIGHT
# Copyright (c) 2000-2009 University of Utah and the Flux Group.
# All rights reserved.
#
use strict;
use English;
use Getopt::Std;
use POSIX qw(setsid ceil);
use POSIX ":sys_wait_h";

#
# This function as the main assign loop.  It converts the virtual
# topology into a top input including LAN and delay translation.  It
# then snapshots the current testbed physical state and runs assign,
# looping a couple times if assign fails.  When assign successfully
# completes it will interpret the results.  Attempt to match any
# existing portmap entries and then update the delays and vlans table.
#
# XXX Internally created nodes (jailhost,delay,sim) are not treated
#     consistently. Needs more thought.
#
# Return codes: We catch all errors with the END block below, and if
# anyone calls die() (exit value is 255) we add in the CANRECOVER bit.
# Failures in assign always cause the caller to stop retrying. 
#
# The CANRECOVER bit indicates 'recoverability' (no db or physical
29
# state was modified by the time the error occurred). This is relevant
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# to only modify operations (update).
#
my $WRAPPER_SUCCESS		 = 0x00;
my $WRAPPER_FAILED		 = 0x01;	# Failed (Add other values)
my  $WRAPPER_FAILED_CANRECOVER   = 0x40;        # Can recover from update
my  $WRAPPER_FAILED_FATALLY      = 0x80;	# Do not use this.
# Set this once we modify DB state; forces no recover in fatal().
my $NoRecover = 0;

sub usage ()
{
    print STDERR "Usage: $0 [-v] [-u [-f] | -n] pid eid\n";
    print STDERR " -v   - Enables verbose output\n";
    print STDERR " -u   - Enables update mode\n";
    print STDERR " -f   - Fix current resources during update mode\n";
    print STDERR " -n   - Run assign, but do not reserve/modify resources.\n";
46
    print STDERR " -r   - Regression mode.\n";
47
48
49
50
    print STDERR " -p   - Do a precheck for mapability on an empty testbed - ".
		 "implies -n\n";
    exit($WRAPPER_FAILED);
}
51
52
53
54
55
56
57
58
59
60
61
62
my $optlist    = "dvunfprqc";
my $verbose    = 0;
my $debug      = 0;
my $fixmode    = 0;
my $updating   = 0;
my $impotent   = 0;
my $precheck   = 0;
my $regression = 0;
my $quiet      = 0;
my $clear      = 0;
my $warnings   = 0;
my $maxrun     = 3;		# Maximum number of times we run assign.
63
64
65
66
67

#
# Configure variables
#
my $TB		= "@prefix@";
68
my $DBNAME	= "@TBDBNAME@";
69
70
71
72
73
my $TBOPS       = "@TBOPSEMAIL@";
my $ASSIGN      = "$TB/libexec/assign";
my $WRAPPER2    = "$TB/libexec/assign_wrapper2";
my $PTOPGEN     = "$TB/libexec/ptopgen";
my $VTOPGEN     = "$TB/bin/vtopgen";
74
my $NFREE       = "$TB/bin/nfree";
75
76
77
78
79
80
81
82
83
84

#
# Load the Testbed support stuff. 
#
use lib "@prefix@/lib";
use libdb;
use libtestbed;
use libtblog;
use libvtop;
use libadminctrl;
85
use User;
86
87
88
89
90
91

# Protos
sub fatal(@);
sub debug($);
sub chat($);
sub RunAssign($$);
92
sub FinalizeRegression($);
93
94
95
96
97
98

# un-taint path
$ENV{'PATH'} = '/bin:/usr/bin:/usr/local/bin';
delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};

# Turn off line buffering on output
99
100
101
102
103
104
105
106
107
108
$| = 1;

#
# We want warnings to cause assign_wrapper to exit abnormally.
# 
# FIXME: Is this still needed.  "warn" is only used once.  Also this
#  will cause perl internal warnings (such as "Use of uninitialized
#  value ..."  to cause assign_wrapper to fail. -- kevina
#
$SIG{__WARN__} = sub { tbwarn $_[0];$warnings++; };
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

#
# Parse command arguments. Once we return from getopts, all that should be
# left are the required arguments.
#
my %options = ();
if (! getopts($optlist, \%options)) {
    usage();
}
if (@ARGV < 2) {
    usage();
}
if (defined($options{"v"})) {
    $verbose++;
}
124
125
126
if (defined($options{"d"})) {
    $debug++;
}
127
128
129
130
131
132
133
134
135
136
137
138
if (defined($options{"u"})) {
    $updating = 1;
}
if (defined($options{"n"})) {
    $impotent = 1;
}
if (defined($options{"f"})) {
    $fixmode = 1;
}
if (defined($options{"p"})) {
    $precheck = 1;
}
139
140
141
142
143
144
145
146
147
148
149
150
151
if (defined($options{"r"})) {
    if ($DBNAME eq "tbdb") {
	fatal("Cannot use regression mode on main DB");
    }
    $regression = 1;
    $clear = 1;
}
if (defined($options{"q"})) {
    $quiet = 1;
}
if (defined($options{"c"})) {
    $clear = 1;
}
152
153
154
155
156
157
158

my $pid = $ARGV[0];
my $eid = $ARGV[1];
my $experiment = Experiment->Lookup($pid, $eid);
if (!defined($experiment)) {
    fatal("Could not lookup experiment object $pid,$eid!")
}
159
160
161
162
163
164
165
166
167
168
169
#
# Verify that this person can muck with the experiment.
#
my $this_user = User->ThisUser();
if (! defined($this_user)) {
    tbdie("You ($UID) do not exist!");
}
if (!TBAdmin() &&
    ! $experiment->AccessCheck($this_user, TB_EXPT_DESTROY)) {
    fatal("You do not have permission to map this experiment!");
}
170
171
172
173
174
175
176
177
178
179
180

#
# These are the flags to the vtop creation code. 
#
my $vtopflags = 0;
$vtopflags |= $libvtop::VTOP_FLAGS_VERBOSE
    if ($verbose);
$vtopflags |= $libvtop::VTOP_FLAGS_UPDATE
    if ($updating);
$vtopflags |= $libvtop::VTOP_FLAGS_FIXNODES
    if ($fixmode);
181
182
$vtopflags |= $libvtop::VTOP_FLAGS_IMPOTENT
    if ($impotent);
183
184
$vtopflags |= $libvtop::VTOP_FLAGS_REGRESSION
    if ($regression);
185
186
187
188
189
190
191

chat("Starting the new and improved mapper wrapper.\n");

my $vtop = libvtop->Create($experiment, $vtopflags);
if (!defined($vtop)) {
    fatal("Could not create vtop structure for $experiment");
}
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209

#
# If updating, load current experiment resources. We have to be careful
# of how this is merged in with the (new) desired topology.
#
if ($updating) {
    $vtop->LoadCurrentResources() == 0
	or fatal("Could not load current resources into mapper");
}
if (!$impotent && ($updating || $clear)) {
    if ($regression) {
	chat("Freeing reserved nodes in regression mode\n");
	system("export NORELOAD=1; $NFREE -x -a $pid $eid") == 0
	    or fatal("Could not release nodes in regression mode");
    }
    chat("Clearing physical state before updating.\n");
    $experiment->RemovePhysicalState();
}
210
211
212
213
TBDebugTimeStamp("vtopgen started");
$vtop->CreateVtop() == 0
    or fatal("Could not create vtop for $experiment");
TBDebugTimeStamp("vtopgen finished");
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234

#
# The assign loop. 
#
my $currentrun     = 1;
my $canceled       = 0;
my $tried_precheck = 0;
# Admission control counts
my %admission_control = ();


# XXX plab hack - only run assign once on plab topologies, since they're easy
# to map and the physical topology does not change frequently.
if ($vtop->plabcount() && $vtop->plabcount == $vtop->virtnodecount()) {
    $maxrun = 2;
}

TBDebugTimeStamp("mapper loop started");
while (1) {
    chat("Assign run $currentrun\n");

235
    my $prefix = ($debug || $regression ? "$pid-$eid" : "$pid-$eid-$$");
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257

    #
    # When precheck is on, we only do one run in impotent mode and exit.
    #
    if ($precheck) {
	$prefix  .= ".empty";
	$impotent = 1;
	chat("Trying assign on an empty testbed.\n");
    }

    #
    # RunAssign returns  0 if successful.
    #           returns -1 if failure, but assign says to stop trying.
    #           returns  1 if failure, but assign says to try again.
    #           returns  2 if we made some forward progress.
    #
    my $retval = RunAssign($precheck, $prefix);

    # Success!
    last
	if ($retval == 0);

258
    if ($retval < 0 || $regression) {
259
260
261
	#
	# Failure in assign.
	#
262
263
264
	FinalizeRegression(1)
	    if ($regression);

265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
	fatal({type => 'primary', severity => SEV_ERROR,
	       error => ['unretriable_assign_error']},
	      "Unretriable error. Giving up.");
    }
    
    #
    # When precheck is off, we do a precheck run if the first try fails
    # to find a solution. This avoids looping on an unsolvable topology.
    #
    if (!$precheck && !$tried_precheck) {
	chat("Trying assign on an empty testbed to verify mapability.\n");
	my $save_impotent = $impotent;
	$impotent  = 1;
	my $retval = RunAssign(1, $prefix . ".empty");
	if ($retval != 0) {
	    fatal({type=>'extra', cause=>'user', severity=>SEV_ERROR,
	           error=>['infeasible_resource_assignment']}, 
		  "This experiment cannot be instantiated on this ".
                  "testbed. You have most likely asked for hardware ".
                  "this testbed does not have, such as nodes of a type ".
                  "it does not contain, or nodes with too many network ".
                  "interfaces.  You will need to modify this experiment ".
                  "before it can be swapped in - re-submitting the ".
                  "experiment as-is will always result in failure.");
	}
	chat("Assign succeeded on an empty testbed.\n");
	$impotent = $save_impotent;
	$tried_precheck = 1;
    }

    if ($currentrun >= $maxrun && $retval != 2) {
	fatal({type => 'primary', severity => SEV_ERROR,
	       error => ['reached_assign_run_limit']},
	      "Reached run limit. Giving up.");
    }

    chat("Waiting 5 seconds and trying again...\n");
    sleep(5);
    $currentrun++;
}
TBDebugTimeStamp("mapper loop finished");
306
307
FinalizeRegression(0)
    if ($regression);
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
exit(0);

#
# The guts of an assign run.
#
sub RunAssign($$)
{
    my ($precheck, $prefix) = @_;

    my $ptopfile = $prefix . ".ptop";
    my $vtopfile = $prefix . ".vtop";
    my $assignexitcode = 0;

    #
    # Do admission control test, and gather the info.
    #
    my %admission_control;
325
326
327
328
329
330
    if (!$regression) {
	if (!TBAdmissionControlCheck(undef, $experiment, \%admission_control)){
	    tberror("Failed admission control checks!\n");
	    return -1;
	}
    }
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359

    #
    # Snapshot physical resources.
    #
    # if updating (-u), include any resources that may already be
    # allocated to experiment in the PTOP results.
    #
    my $ptopargs = "-p $pid ";
    $ptopargs   .= "-e $eid "
	if ($updating);
    $ptopargs   .= "-u "
	if ($updating && $experiment->elabinelab());
    $ptopargs   .= "-m " . $experiment->multiplex_factor() . " "
	if (defined($experiment->multiplex_factor()));
    $ptopargs   .= "-v "
	if ($vtop->virtnodecount());
    $ptopargs   .= "-r "
	if ($vtop->remotenodecount());
    $ptopargs   .= "-S "
	if ($vtop->simnodecount());
    $ptopargs	.= "-a "
    	if ($precheck);
    $ptopargs	.= "-c " . $experiment->delay_capacity() . " "
    	if (defined($experiment->delay_capacity()));

    chat("ptopargs: '$ptopargs'\n");
    TBDebugTimeStamp("ptopgen started");
    system("$PTOPGEN $ptopargs > $ptopfile");
    if ($?) {
360
361
	tberror("Failure in ptopgen\n");
	return -1;
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
    }
    TBDebugTimeStamp("ptopgen finished");

    #
    # Append this admission control results to ptopgen.
    #
    if (scalar(keys(%admission_control))) {
	open(PTOP, ">> $ptopfile") or
	    return -1;

	foreach my $typeclass (keys(%admission_control)) {
	    my $count = $admission_control{$typeclass};

	    print PTOP "set-type-limit $typeclass $count\n";
	}
	close(PTOP);
    }

    #
    # Now generate a vtop file and dump it to a file.
    #
383
384
385
386
387
388
389
390
    if (! open(VTOPFILE, "> $vtopfile")) {
	tberror("Could not open $vtopfile: $!\n");
	return -1;
    }
    if ($vtop->PrintTop(*VTOPFILE) != 0) {
	tberror("Could not print vtop file for $experiment\n");
	return -1;
    }
391
392
    close(VTOPFILE);

393
394
395
396
397
398
    if (! ($impotent || $regression)) {
	if ($experiment->Update({"maximum_nodes" => $vtop->maximum_nodes(),
				 "minimum_nodes" => $vtop->minimum_nodes() })){
	    tberror("Could not update min/max nodes for $experiment\n");
	    return -1;
	}
399
400
401
    }

    # Run assign
402
    my $cmd  = "assign";
403
404
405
406
407
    my $args = "-P $ptopfile $vtopfile";
    $args = "-uod -c .75 $args"
	if ($vtop->virtnodecount() || $vtop->simnodecount());
    $args = "-n $args"
    	if ($precheck);
408
409
    $args = "-s 123456 $args"
	if ($regression);
410
411
412
413
414
415
    chat("assign command: '$cmd $args'\n");

    #
    # Fork a child to run assign. Parent spins watching the cancel flag
    # and waiting for assign to finish.
    #
416
    TBDebugTimeStamp("assign started");
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
    if (my $childpid = fork()) {
	while (1) {
	    sleep(2);

	    if (waitpid($childpid, &WNOHANG) == $childpid) {
		$assignexitcode = $? >> 8;
		last;
	    }

	    # Check cancel flag.
	    if ($experiment->canceled()) {
		if ((my $pgrp = getpgrp($childpid)) > 0) {
		    kill('TERM', -$pgrp);
		    waitpid($childpid, 0);

432
433
434
		    tberror({cause => 'canceled', severity => SEV_IMMEDIATE,
			     error => ['cancel_flag']},
			    "Cancel flag set; aborting assign run!\n");
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
		    return -1;
		}
		# Loop again to reap child above before exit.
	    }
	}
    }
    else {
	#
	# Change our session so the child can get a killpg without killing
	# the parent. 
	#
        POSIX::setsid();
	exec("nice $WRAPPER2 $cmd $args > assign.log");
	die("Could not start assign!\n");
    }
450
    TBDebugTimeStamp("assign finished");
451
452
453

    # Check cancel flag before continuing. 
    if ($experiment->canceled()) {
454
455
456
	tberror({cause => 'canceled', severity => SEV_IMMEDIATE,
		 error => ['cancel_flag']},
		"Cancel flag set; aborting assign run!\n");
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
	return -1;
    }

    # Check for possible full filesystem ...
    if (-z "assign.log") {
	tbnotice("assign.log is zero length! Stopping ...\n");
	return -1;
    }

    #
    # Saving up assign.log coz each swapin/modify is different and it
    # is nice to have every mapping for debugging and archiving
    # purposes We do not call it .log though, since we do not want it
    # copied out to the user directory every swapin. See Experiment.pm
    #
    system("/bin/cp assign.log ${prefix}.assign");

    #
    # We no longer care what assign has to say when it fails.
    # Any relevent info was already sent to stderr so just 
    # tell the caller whether we want to keep trying or not.
    #
    if ($assignexitcode) {
	return (($assignexitcode == 1) ? 1 : -1);
    }
    #
    # If we were doing the precheck, go ahead and exit now - there is no
    # useful information to parse out
    #
    if ($precheck) {
487
	chat("Precheck succeeded.\n");
488
489
490
	return 0;
    }

491
    chat("Reading assign results.\n");
492
493
494
495
    if (!open(ASSIGNFP, "assign.log")) {
	print("Could not open assign logfile! $!\n");
	return -1;
    }
496
497
498
499
500
501
502
503
504
505
506
    if ($vtop->ReadSolution(*ASSIGNFP) != 0) {
	print("Could not parse assign logfile! $!\n");
	return -1;
    }
    close(ASSIGNFP);
    if ($vtop->InterpNodes() != 0) {
	print("Could not interpret nodes.\n");
	return -1;
    }
    # Check cancel flag before continuing. 
    if ($experiment->canceled()) {
507
508
509
	tberror({cause => 'canceled', severity => SEV_IMMEDIATE,
		 error => ['cancel_flag']},
		"Cancel flag set; aborting assign run!\n");
510
511
512
513
514
515
	return -1;
    }
    if ($vtop->AllocNodes() != 0) {
	print("Could not allocate nodes.\n");
	return -1;
    }
516
517
518
519
    if ($vtop->InterpLinks() != 0) {
	print("Could not setup links\n");
	return -1;
    }
520
521
522
523
    if ($vtop->InitializePhysNodes() != 0) {
	print("Could not InitializePhysNodes\n");
	return -1;
    }
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
    return 0;
}

#
# In regression mode we want to save  the physical state and then clear
# the physical resources. 
#
sub FinalizeRegression($)
{
    my ($error) = @_;
    my $cwd;

    chomp($cwd = `/bin/pwd`);
    if (!$error) {
	chat("Saving physical state in regression mode\n");
539
540
	if ($experiment->BackupPhysicalState("$cwd/$pid-$eid.pstate", 1)
	    != 0) {
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
	    print STDERR "Could not save physical state!\n";
	    exit(1);
	}
    }
    chat("Removing physical state in regression mode\n");
    if ($experiment->RemovePhysicalState() != 0) {
	print STDERR "Could not remove physical state!\n";
	exit(1);
    }

    if ($vtop->newreservednodes()) {
	my @newreservednodes = $vtop->newreservednodes();
	system("export NORELOAD=1; $NFREE -x $pid $eid @newreservednodes");
	if ($?) {
	    exit(1);
	}
    }
    return 0;
559
}
560

561
562
563
564
# We will come through here no matter how we exit.
END {
    # Watch for getting here cause of a die()/exit() statement someplace.
    my $exitcode = $?;
565

566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
    if ($exitcode && $exitcode != $WRAPPER_FAILED) {
	$exitcode = $WRAPPER_FAILED|$WRAPPER_FAILED_FATALLY;
    }
    
    if ($warnings > 0) {
	tberror("$warnings warnings.\n");

	$exitcode |= $WRAPPER_FAILED;
    }

    # Set recover bit if we are going to fail.
    $exitcode = $exitcode|$WRAPPER_FAILED_CANRECOVER
	if ($exitcode && !$NoRecover);

    # And change the exitcode to be what we want it to be.
    $? = $exitcode;
582
583
584
585
}

sub fatal(@)
{
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
    #
    # Free any newly reserved nodes (in update mode) so that tbswap knows
    # it is safe to recover the experiment. If we bypass this and leave
    # through the END block then NoRecover will still be set and tbswap
    # will know to swap the experiment out. 
    #
    if ($updating) {
	if (defined($vtop)) {
	    my @newreservednodes = $vtop->newreservednodes();
	    my $NoRecover = $vtop->norecover();
	
	    if (@newreservednodes) {
		$NoRecover = 0
		    if (system("nfree -x $pid $eid @newreservednodes") == 0);
	    }
	    else {
		# When not updating this is meaningless to tbswap.
		$NoRecover = 0;
	    }
	}
    }
    
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
    tberror(@_);

    # We next go to the END block above.
    exit($WRAPPER_FAILED);
}
sub debug($)
{
    if ($verbose) {
	print $_[0];
    }
}
sub chat($)
{
    if (! $quiet) {
	print $_[0];
    }
}