swapexp.in 14 KB
Newer Older
1
#!/usr/bin/perl -wT
Leigh B. Stoller's avatar
Leigh B. Stoller committed
2 3 4

#
# EMULAB-COPYRIGHT
5
# Copyright (c) 2000-2003 University of Utah and the Flux Group.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
6 7 8
# All rights reserved.
#

9 10 11 12
use English;
use Getopt::Std;

#
Chad Barb's avatar
Chad Barb committed
13
# This gets invoked from the Web interface.
Chad Barb's avatar
 
Chad Barb committed
14
# Swap an experiment in, swap it out, restart or modify.
15
#
Chad Barb's avatar
Chad Barb committed
16

17 18
sub usage()
{
19 20
    print STDOUT "Usage: swapexp [-b] [-i] [-r] ".
	"<-s in | out | restart | modify> <pid> <eid> [<nsfile>]\n";
21 22
    exit(-1);
}
23
my  $optlist = "s:irb";
24 25 26 27 28 29 30

#
# Configure variables
#
my $TB     = "@prefix@";
my $TBOPS  = "@TBOPSEMAIL@";
my $TBLOGS = "@TBLOGSEMAIL@";
31
my $TBINFO = "$TB/expinfo";
32 33 34 35 36 37 38 39 40

#
# Testbed Support libraries
#
use lib "@prefix@/lib";
use libdb;
use libtestbed;

my $tbdir    = "$TB/bin/";
41
my $tbdata   = "tbdata";
42
my $batch    = 0;
43
my $idleswap = 0;
Chad Barb's avatar
Chad Barb committed
44
my $reboot   = 0;
45
my $errorstat= -1;
Chad Barb's avatar
 
Chad Barb committed
46

47 48 49 50 51
my $inout;
my $logname;
my $dbuid;
my $user_name;
my $user_email;
52
my @allnodes;
53
my @row;
54
my $action;
Chad Barb's avatar
 
Chad Barb committed
55

56 57 58 59 60 61 62 63 64 65 66
#
# Untaint the path
# 
$ENV{'PATH'} = '/bin:/usr/bin';
delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};

#
# Turn off line buffering on output
#
$| = 1;

67 68 69 70 71 72 73
#
# Set umask for start/swap. We want other members in the project to be
# able to swap/end experiments, so the log and intermediate files need
# to be 664 since some are opened for append.
#
umask(0002);

74 75 76 77 78 79 80 81
#
# Parse command arguments. Once we return from getopts, all that should
# left are the required arguments.
#
%options = ();
if (! getopts($optlist, \%options)) {
    usage();
}
82 83 84
if (defined($options{"i"})) {
    $idleswap = 1;
}
85 86 87
if (defined($options{"b"})) {
    $batch = 1;
}
Chad Barb's avatar
 
Chad Barb committed
88 89 90
if (defined($options{"r"})) {
    $reboot = 1;
}
91 92 93
if (defined($options{"s"})) {
    $inout = $options{"s"};

Chad Barb's avatar
Chad Barb committed
94 95 96
    if ($inout ne "out"     &&
	$inout ne "in"      &&
	$inout ne "restart" &&
Chad Barb's avatar
 
Chad Barb committed
97
	$inout ne "modify") {
98 99
	usage();
    }
100 101 102 103
    if ($batch &&
	($inout ne "out" && $inout ne "in")) {
	usage();
    }
104 105 106 107 108
}
else {
    usage();
}

Chad Barb's avatar
 
Chad Barb committed
109 110 111 112 113 114 115 116
if (@ARGV != (($inout eq "modify") ? 3 : 2)) {
    usage();
}
my $pid   = $ARGV[0];
my $eid   = $ARGV[1];

my $nsfile;

Chad Barb's avatar
Chad Barb committed
117
if ($inout eq "modify") {
Chad Barb's avatar
 
Chad Barb committed
118 119 120 121 122 123 124 125 126 127 128 129
    $nsfile = $ARGV[2];

    #
    # Untaint nsfile argument; Allow slash.
    #
    if ($nsfile =~ /^([-\w.\/]+)$/) {
	$nsfile = $1;
    } else {
	die("Tainted nsfile name: $nsfile");
    }
}

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
#
# Untaint the arguments.
#
if ($pid =~ /^([-\@\w.]+)$/) {
    $pid = $1;
}
else {
    die("Tainted argument $pid!\n");
}
if ($eid =~ /^([-\@\w.]+)$/) {
    $eid = $1;
}
else {
    die("Tainted argument $eid!\n");
}
145
my $repfile = "$eid.report";
146 147
my $workdir = TBExptWorkDir($pid, $eid);
my $userdir = TBExptUserDir($pid, $eid);
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165

#
# Verify user and get his DB uid.
#
if (! UNIX2DBUID($UID, \$dbuid)) {
    die("*** $0:\n".
	"    You do not exist in the Emulab Database.\n");
}

#
# Get email info for user.
#
if (! UserDBInfo($dbuid, \$user_name, \$user_email)) {
    die("*** $0:\n".
	"    Cannot determine your name and email address.\n");
}

#
Chad Barb's avatar
 
Chad Barb committed
166
# Verify that this person can muck with the experiment.
167 168 169 170 171
# Note that any script down the line has to do an admin check also. 
#
if ($UID && !TBAdmin($UID) &&
    !TBExptAccessCheck($dbuid, $pid, $eid, TB_EXPT_DESTROY)) {
    die("*** $0:\n".
Chad Barb's avatar
 
Chad Barb committed
172
	"    You do not have permission to swap or modify this experiment!\n");
173 174 175 176 177 178 179
}

#
# We have to protect against trying to end an experiment that is currently
# in the process of being terminated. We use a "wrapper" state (actually
# a timestamp so we can say when termination was requested) since
# terminating consists of a couple of different experiment states down inside
Chad Barb's avatar
Chad Barb committed
180
# the tb scripts.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
#
DBQueryFatal("lock tables experiments write");

$query_result =
    DBQueryFatal("SELECT * FROM experiments WHERE eid='$eid' and pid='$pid'");

if (! $query_result->numrows) {
    die("*** $0:\n".
	"    No such experiment $pid/$eid exists!\n");
}
my %hashrow = $query_result->fetchhash();
my $expt_head_login = $hashrow{'expt_head_uid'};
my $estate          = $hashrow{'state'};
my $expt_path       = $hashrow{'path'};
my $isbatchexpt     = $hashrow{'batchmode'};
my $ebatchstate     = $hashrow{'batchstate'};

198
if (! chdir($workdir)) {
199
    die("*** $0:\n".
200
	"    Could not chdir to $workdir: $!\n");
201 202
}

203 204
if (defined($hashrow{'expt_locked'})) {
    $val = $hashrow{'expt_locked'};
Chad Barb's avatar
Chad Barb committed
205

206 207 208 209 210 211 212
    die("*** $0:\n".
	"    It appears that $pid/$eid went into transition at $val.\n".
	"    You will be notified via email when experiment transition ".
	"    is complete.\n");
}

#
213 214
# Do not allow the user to swap a batch experiment. It has to come via
# the batch daemon. 
215
#
216
if ($isbatchexpt && !$batch) {
217
    die("*** $0:\n".
Chad Barb's avatar
 
Chad Barb committed
218
	"    Batch experiments cannot be swapped or modified yet!");
219 220 221
}

#
Chad Barb's avatar
 
Chad Barb committed
222
# Okay, check state. We do not allow modification or swapping to start when the
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
# experiment is in transition. A future task would be to allow this,
# but for now the experiment must be in one of a few states to proceed
#
# Seems like too many states!
#
if ($estate ne EXPTSTATE_ACTIVE && $estate ne EXPTSTATE_SWAPPED) {
    die("*** $0:\n".
	"    It appears that experiment $pid/$eid is in transition.\n".
	"    The user that created the experiment will be notified via\n".
        "    email when the experiment is no longer in transition.\n");
}

if ($inout eq "in" && $estate eq EXPTSTATE_ACTIVE) {
    die("*** $0:\n".
	"    It appears that experiment $pid/$eid is already swapped in!");
}
if ($inout eq "out" && $estate eq EXPTSTATE_SWAPPED) {
    die("*** $0:\n".
	"    It appears that experiment $pid/$eid is already swapped out!");
}
243 244 245 246
if ($inout eq "restart" && $estate ne EXPTSTATE_ACTIVE) {
    die("*** $0:\n".
	"    It appears that experiment $pid/$eid is not active!");
}
247

Chad Barb's avatar
 
Chad Barb committed
248 249
# if $inout eq "modify", either EXPTSTATE_ACTIVE -or- EXPTSTATE_SWAPPED is ok.

250 251 252 253 254 255 256 257 258 259 260 261 262
#
# Set the timestamp now, and unlock the experiments table.
#
DBQueryFatal("UPDATE experiments SET expt_locked=now() ".
	     "WHERE eid='$eid' and pid='$pid'");

DBQueryFatal("unlock tables");

#
# XXX - At this point a failure is going to leave things in an
# inconsistent state.
#

263 264 265 266 267 268 269 270 271
if ($inout eq "in") {
    $action = "swapped in";
}
if ($inout eq "out") {
    $action = "swapped out";
}
if ($inout eq "restart") {
    $action = "restarted";
}
Chad Barb's avatar
 
Chad Barb committed
272 273 274
if ($inout eq "modify") {
    $action = "modified";
}
275

276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
#
# Get email address of the experiment head, which may be different than
# the person who is actually terminating the experiment, since its polite
# to let the original creator know whats going on. 
#
my $expt_head_name;
my $expt_head_email;

if (! UserDBInfo($expt_head_login, \$expt_head_name, \$expt_head_email)) {
    print STDERR "*** WARNING: ".
	         "Could not determine name/email for $expt_head_login.\n";
    $expt_head_name  = "TBOPS";
    $expt_head_email = $TBOPS;
}

#
# If not in batch mode, go into the background. Parent exits.
#
if (! $batch) {
295
    $logname = TBExptCreateLogFile($pid, $eid, "swapexp");
296
    TBExptSetLogFile($pid, $eid, $logname);
297
    TBExptOpenLogFile($pid, $eid);
Chad Barb's avatar
Chad Barb committed
298

299 300 301 302
    if (TBBackGround($logname)) {
	#
	# Parent exits normally
	#
303 304
	print "Experiment $pid/$eid is now being $action.\n".
	    "You will be notified via email when the this is done.\n";
305 306 307 308
	exit(0);
    }
}

309 310 311
#
# Remove old report file since its contents are going to be invalid.
#
312
if ($inout ne "restart" && -e $repfile) {
313 314 315
    unlink("$repfile");
}

316 317 318 319
#
# Sanity check states in case someone changes something.
#
if ($inout eq "out") {
Chad Barb's avatar
 
Chad Barb committed
320 321
    print STDOUT "Running 'tbswap out' with arguments: $pid $eid\n";
    if (system("$tbdir/tbswap out $pid $eid") != 0) {
322
	$errorstat = $? >> 8;
Chad Barb's avatar
 
Chad Barb committed
323
	fatal("tbswap out failed!\n");
324
    }
Chad Barb's avatar
Chad Barb committed
325

326 327 328 329 330
    $estate = ExpState($pid,$eid);
    if ($estate ne EXPTSTATE_SWAPPED) {
	fatal("Experiment is in the wrong state: $estate\n");
    }
}
331
elsif ($inout eq "in") {
Chad Barb's avatar
 
Chad Barb committed
332 333
    print STDOUT "Running 'tbswap in' with arguments: $pid $eid\n";
    if (system("$tbdir/tbswap in $pid $eid") != 0) {
334
	$errorstat = $? >> 8;
Chad Barb's avatar
 
Chad Barb committed
335
	fatal("tbswap in failed!\n");
336
    }
Chad Barb's avatar
Chad Barb committed
337

338 339 340 341
    $estate = ExpState($pid,$eid);
    if ($estate ne EXPTSTATE_ACTIVE) {
	fatal("Experiment is in the wrong state: $estate\n");
    }
342

343
    system("$tbdir/tbreport -b $pid $eid 2>&1 > $repfile");
Chad Barb's avatar
Chad Barb committed
344
}
Chad Barb's avatar
 
Chad Barb committed
345
elsif ($inout eq "modify") {
Chad Barb's avatar
Chad Barb committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
    my $modifyError = "";

    print "Backing up old experiment state ... " . TBTimeStamp() . "\n";
    if (TBExptBackupVirtualState($pid, $eid, $$)) {
	fatal("*** $0:\n".
	      "    Could not backup experiment state; cannot safely continue!\n");
    }
    TBExptRemoveVirtualState($pid, $eid);

    #
    # Rerun tbprerun if modifying.
    #
    if (system("$tbdir/tbprerun -m $pid $eid $nsfile") != 0) {
	$modifyError = "tbprerun failed!";
    }

Chad Barb's avatar
 
Chad Barb committed
362 363 364 365
    #
    # If experiment is currently swapped out, no need to do an update 
    # after modifying it.
    #
Chad Barb's avatar
Chad Barb committed
366
    if (! $modifyError && $estate eq EXPTSTATE_ACTIVE) {
Chad Barb's avatar
 
Chad Barb committed
367
	print STDOUT "Running 'tbswap update' with arguments: $pid $eid\n";
Chad Barb's avatar
Chad Barb committed
368 369 370 371

	my $rebootSwitch = "";
	if ($reboot) {
	    $rebootSwitch = "-reboot";
Chad Barb's avatar
 
Chad Barb committed
372 373
	}

Chad Barb's avatar
Chad Barb committed
374 375 376
	if (system("$tbdir/tbswap update $rebootSwitch $pid $eid") != 0) {
	    $errorstat = $? >> 8;
	    $modifyError = "tbswap update failed!";
Chad Barb's avatar
 
Chad Barb committed
377
	}
Chad Barb's avatar
 
Chad Barb committed
378

Chad Barb's avatar
Chad Barb committed
379 380 381 382
	if (! $modifyError) {
	    $estate = ExpState($pid, $eid);
	    if ($estate ne EXPTSTATE_ACTIVE) {
		fatal("Experiment is in the wrong state: $estate!");
Chad Barb's avatar
 
Chad Barb committed
383 384
	    }
	}
Chad Barb's avatar
Chad Barb committed
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402

	if (! $modifyError) {
	    system("$tbdir/tbreport -b $pid $eid 2>&1 > $repfile");
	}
    }

    if ($modifyError) {
	print STDERR "*** $0:\n".
	             "    $modifyError\n";
	print STDOUT "Recovering experiment state...\n";
	TBExptRemoveVirtualState($pid, $eid );
	if (0 == TBExptRestoreVirtualState($pid, $eid, $$)) {
	    fatal("*** Update aborted; old state restored.\n");
	} else {
	    # Set state to NEW so experiment will get wiped.
	    SetExpState($pid, $eid, EXPTSTATE_NEW);
	    fatal("*** Experiment state could not be restored!\n");
	}
Chad Barb's avatar
 
Chad Barb committed
403
    }
404
}
Chad Barb's avatar
 
Chad Barb committed
405
else { # $inout eq "restart" assumed.
406 407 408 409 410
    print STDOUT "Running tbrestart with arguments: $pid $eid\n";
    if (system("$tbdir/tbrestart $pid $eid") != 0) {
	fatal("tbrestart failed!\n");
    }
}
411

412 413 414 415 416 417 418 419 420 421
#
# Try to copy off the files for testbed information gathering.
#
TBSaveExpLogFiles($pid, $eid);

#
# Make a copy of the work dir in the user visible space so the user
# can see the log files. This overwrites existing files of course,
# but thats okay.
#
422
system("cp -Rfp $workdir/ $userdir/tbdata/");
423

424 425
#
# Must unlock before exit.
426 427
#
TBUnLockExp($pid, $eid);
428

429 430 431 432
#
# Gather stats. 
#
if ($inout eq "in") {
433
    GatherSwapStats($pid, $eid, $dbuid, TBDB_STATS_SWAPIN, 0);
434 435
}
elsif ($inout eq "out") {
436
    GatherSwapStats($pid, $eid, $dbuid, TBDB_STATS_SWAPOUT, 0,
437
		    ($idleswap ? TBDB_STATS_FLAGS_IDLESWAP() : 0));
438 439
}
elsif ($inout eq "modify") {
440
    GatherSwapStats($pid, $eid, $dbuid, TBDB_STATS_SWAPMODIFY, 0);
441 442
}

443
print "Done!\n";
444 445 446 447 448 449 450 451

#
# In batch mode, just exit without sending email.
#
if ($batch) {
    exit(0);
}

Chad Barb's avatar
 
Chad Barb committed
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
#
# HACK! if successful, put new NS file in DB.
#

if ($inout eq "modify") {
    $nsdata_string = `cat $nsfile`;
    if (defined($nsdata_string)) {
	$nsdata_string = DBQuoteSpecial($nsdata_string);

	DBQueryWarn("delete from nsfiles WHERE eid='$eid' and pid='$pid'");
	DBQueryWarn("insert into nsfiles (pid, eid, nsfile) ".
		    "VALUES('$pid', '$eid', $nsdata_string)");
    } else {
	print "Warning!! Couldn't read nsfile '$nsfile'!\n";
    }
}

469 470 471 472 473 474 475
#
# Clear the log file so the web page stops spewing. 
#
if (defined($logname)) {
    TBExptCloseLogFile($pid, $eid);
}

476 477 478 479
#
# Send email notification to user.
#
my $message =
480 481 482 483 484 485 486 487 488 489 490 491
    "Experiment $eid in project $pid has been ";

if ($idleswap) {
    $message .= "forcibly swapped out by\n".
	"Testbed Operations because it was idle for too long.\n";
}
else {
    $message .= "$action.\n";
}

$message .=
    "\n".
492 493
    "Appended below is the output. If you have any questions or comments,\n" .
    "please include the output in your message to $TBOPS\n";
494 495

SENDMAIL("$user_name <$user_email>",
496
	 "Experiment $pid/$eid \u$action",
497
	 $message,
498
	 ($idleswap ? $TBOPS : "$user_name <$user_email>"),
499 500
	 "Cc:  $expt_head_name <$expt_head_email>\n".
	 "Bcc: $TBLOGS",
501
	 (($inout eq "restart") ? ($logname) : ($repfile, $logname)));
502 503 504 505 506 507

exit 0;

sub fatal($)
{
    my($mesg) = $_[0];
Chad Barb's avatar
Chad Barb committed
508

509 510
    print STDOUT $mesg;

511 512 513 514 515 516 517 518 519 520 521 522 523
    #
    # Gather stats. 
    #
    if ($inout eq "in") {
	GatherSwapStats($pid, $eid, $dbuid, TBDB_STATS_SWAPIN, $errorstat);
    }
    elsif ($inout eq "out") {
	GatherSwapStats($pid, $eid, $dbuid, TBDB_STATS_SWAPOUT, $errorstat);
    }
    elsif ($inout eq "modify") {
	GatherSwapStats($pid, $eid, $dbuid, TBDB_STATS_SWAPMODIFY, $errorstat);
    }

Chad Barb's avatar
 
Chad Barb committed
524 525 526 527 528 529 530 531 532 533 534 535
    #
    # if $hosed == 1, we entirely terminate the experiment.
    #
    my $hosed = 0;

    # If we're doing a modify,
    # and tbprerun sent the experiment to "NEW",
    # we're hosed.
    if ($inout eq "modify" && ExpState($pid,$eid) eq EXPTSTATE_NEW) {
	$hosed = 1;
    }

Chad Barb's avatar
Chad Barb committed
536
    if ($hosed) {
Chad Barb's avatar
 
Chad Barb committed
537 538 539 540 541 542 543 544 545 546
	#
	# Note: $estate is still set to the state which the experiment was in
	# when we began.
	#
	if ($estate eq EXPTSTATE_ACTIVE) {
	    print "Running 'tbswap out' with arguments: $pid $eid\n";
	    if (system("$tbdir/tbswap out -force $pid $eid") != 0) {
		print "tbswap out failed!\n";
	    }
	}
Chad Barb's avatar
Chad Barb committed
547

Chad Barb's avatar
 
Chad Barb committed
548 549 550 551 552 553
	print "Running tbend with arguments: -force $pid $eid\n";
	if (system("$tbdir/tbend -force $pid $eid") != 0) {
	    print "tbend failed!\n";
	}
    }

554 555 556 557 558 559
    #
    # Kill this for convenience later.
    # 
    DBQueryWarn("update experiments set expt_locked=NULL ".
		"WHERE eid='$eid' and pid='$pid'");

560 561 562
    # Copy over the log files so the user can see them.
    system("/bin/cp -Rfp $workdir/ $userdir/tbdata");

563
    #
Chad Barb's avatar
Chad Barb committed
564
    # In batch mode, exit without sending the email.
565 566
    #
    if ($batch) {
567
	TBUnLockExp($pid, $eid);
568
	exit($errorstat);
569 570
    }

571
    #
Chad Barb's avatar
Chad Barb committed
572
    # Clear the log file so the web page stops spewing.
573 574 575 576 577
    #
    if (defined($logname)) {
	TBExptCloseLogFile($pid, $eid);
    }

578 579 580 581
    #
    # Send a message to the testbed list. Append the logfile.
    #
    SENDMAIL("$user_name <$user_email>",
582
	     "Swap ${inout} Failure: $pid/$eid",
583
	     $mesg,
584
	     ($idleswap ? $TBOPS : "$user_name <$user_email>"),
585
	     "Cc:  $expt_head_name <$expt_head_email>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
586
	     "Cc:  $TBOPS",
587 588
	     ($logname));

Chad Barb's avatar
 
Chad Barb committed
589 590 591 592 593 594 595 596 597 598
    if ($hosed) {
	#
	# Copy off the workdir to the user directory, Then back up both of
	# them for post-mortem debugging.
	#
	system("/bin/cp -Rfp $workdir/ $userdir/tbdata");
	system("/bin/rm -rf  ${workdir}-failed");
	system("/bin/mv -f   $workdir ${workdir}-failed");
	system("/bin/rm -rf  ${userdir}-failed");
	system("/bin/mv -f   $userdir ${userdir}-failed");
Chad Barb's avatar
Chad Barb committed
599
	TBExptDestroy($pid, $eid);
Chad Barb's avatar
 
Chad Barb committed
600 601
    }

602
    exit($errorstat);
603 604
}

Chad Barb's avatar
Chad Barb committed
605 606