batchexp.in 35.7 KB
Newer Older
1
#!/usr/bin/perl -wT
Leigh B. Stoller's avatar
Leigh B. Stoller committed
2 3
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2000-2007 University of Utah and the Flux Group.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
5 6
# All rights reserved.
#
7 8
use English;
use Getopt::Std;
9
use POSIX qw(isatty setsid);
10
use POSIX qw(strftime);
11
use Errno qw(EDQUOT);
12 13

#
14 15 16 17
# Create an experiment. The experiment is either run immediately, or
# placed into the batch system to be run later. If no NS file is
# supplied, an experiment shell is created (this is currently an admin
# only option).
18
#
19
# TODO: Remove expt_expires and priority.
20
#       Add calls to check_slot() to verify inputs.
21
# 
Leigh B. Stoller's avatar
Leigh B. Stoller committed
22 23 24 25 26 27 28 29 30
# Exit codes are important; they tell the web page what has happened so
# it can say something useful to the user. Fatal errors are mostly done
# with die(), but expected errors use this routine. At some point we will
# use the DB to communicate the actual error.
#
# $status < 0 - Fatal error. Something went wrong we did not expect.
# $status = 0 - Everything okay.
# $status > 0 - Expected error. User not allowed for some reason. 
# 
31 32
sub usage()
{
33
    print(STDERR
34
	  "Usage: batchexp [-q] [-i [-w]] [-n] [-f] [-E description] [-g gid]\n".
35
	  "                [-S reason] [-L reason] [-a <time>] [-l <time>]\n".
36
	  "                -p <pid> -e <eid> <nsfile>\n".
37
	  "switches and arguments:\n".
38 39 40
	  "-i       - swapin immediately; by default experiment is batched\n".
	  "-w       - wait for non-batchmode experiment to preload or swapin\n".
	  "-f       - preload experiment (do not swapin or queue yet)\n".
41
	  "-q       - be less chatty\n".
42 43
	  "-S <str> - Experiment cannot be swapped; must provide reason\n".
	  "-L <str> - Experiment cannot be IDLE swapped; must provide reason\n".
44
	  "-n       - Do not send idle email (internal option only)\n".
45 46
	  "-a <nnn> - Auto swapout nnn minutes after experiment is swapped in\n".
	  "-l <nnn> - Auto swapout nnn minutes after experiment goes idle\n".
47
	  "-s       - Save disk state on swapout\n".
48 49 50 51 52 53 54 55
	  "-E <str> - A pithy sentence describing your experiment\n".
	  "-p <pid> - The project in which to create the experiment\n".
	  "-g <gid> - The group in which to create the experiment\n".
	  "-e <eid> - The experiment name (unique, alphanumeric, no blanks)\n".
	  "<nsfile> - NS file to parse for experiment.\n");
    exit(-1);
}

56
sub ParseArgs();
57 58
sub CheckCopyArgs();
sub CopyInArchive();
59
sub fatal($;$);
60

61
my $optlist = "iE:g:e:p:S:L:a:l:sfwqt:nzc:bx:y:";	# Enough options?
62
my $batchmode= 1;
63 64
my $frontend = 0;
my $waitmode = 0;
65
my $quiet    = 0;
66
my $linktest = 0;	# non-zero means level to run at.
67 68
my $zeemode  = 0;	# Hey, out of options.
my $zeeopt   = "";	# To pass along.
69
my $savestate= 0;
70 71 72
my $template;		# New stuff; experiment templates.
my $branch_template;    # New stuff; experiment templates.
my $instance;		# New stuff; experiment templates.
73 74 75 76 77 78 79 80 81
# All of these are for experiment dup and branch. Really mucks things up.
# These globals are set when we parse the -c argument, but used later
my $copyfrom;		# Copy from where, archive or current experiment.
my $copyarg;            # The -c argument.
my $copyidx;            # The index of the experiment copied.
my $copypid;		# The pid of the experiment copied.
my $copyeid;		# The eid of the experiment copied.
my $copytag;		# The archive tag to us.
my $copydir;		# Directory extracted from archive, to delete.
82 83 84 85 86

#
# Configure variables
#
my $TB       = "@prefix@";
87
my $EVENTSYS = @EVENTSYS@;
88 89
my $TBOPS    = "@TBOPSEMAIL@";
my $TBLOGS   = "@TBLOGSEMAIL@";
90 91
my $TBDOCBASE = "@TBDOCBASE@";
my $TBBASE   = "@TBBASE@";
92
my $CONTROL  = "@USERNODE@";
93

94 95 96 97 98 99
#
# Testbed Support libraries
#
use lib "@prefix@/lib";
use libdb;
use libtestbed;
Kevin Atkinson's avatar
Kevin Atkinson committed
100
use libtblog;
101
use libArchive;
102
use Experiment;
103
use Template;
104
use User;
105
use Group;
106

107 108 109 110
my $parser      = "$TB/libexec/parse-ns";
my $checkquota  = "$TB/sbin/checkquota";
my $tbbindir    = "$TB/bin/";
my $RSYNC	= "/usr/local/bin/rsync";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
111
my $errorstat=-1;
112
my $exptidx;
113
my $logname;
114

115 116 117 118
# For the END block below.
my $cleaning = 0;
my $justexit = 1;
my $signaled = 0;
119 120 121 122 123 124

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

125 126 127 128 129 130 131
#
# 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);

132 133
#
# Untaint the path
134
#
135 136
# un-taint path
$ENV{'PATH'} = '/bin:/usr/bin:/usr/local/bin';
137 138
delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};

139 140 141 142 143
my $eid;
my $pid;
my $gid;
my $description;
my $tempnsfile;
144 145 146
my $swappable    = 1;
my $noswap_reason;
my $idleswap     = 1;
147
my $idleswaptime = 60 * TBGetSiteVar("idle/threshold");
148
my $noidleswap_reason;
149
my $autoswap     = 0;
150
my $autoswaptime = 10 * 60;
151 152 153
my $idleignore   = 0;
my $priority     = TB_EXPTPRIORITY_LOW;
my $exptstate    = EXPTSTATE_NEW();
154
my $batchstate   = BATCHSTATE_UNLOCKED();
155 156
my $now          = localtime();
my $committed    = 0;
157 158
my $experiment;
my $copy_experiment;
159

160
#
161
# Verify user and get his DB uid and other info for later.
162
#
163 164 165
my $this_user = User->ThisUser();
if (! defined($this_user)) {
    tbdie("You ($UID) do not exist!");
166
}
167 168 169 170
my $user_dbid  = $this_user->dbid();
my $user_uid   = $this_user->uid();
my $user_name  = $this_user->name();
my $user_email = $this_user->email();
171

172 173 174 175
#
# Before doing anything else, check for overquota ... lets not waste
# our time. Make sure user sees the error by exiting with 1.
#
176
if (system("$checkquota $user_uid") != 0) {
177 178
    tberror({cause => 'user', type => 'primary', severity => SEV_ERROR,
	     error => ['over_disk_quota', $CONTROL]},
179 180
	    "You are over your disk quota on $CONTROL; ".
	    "please login there and cleanup!");
181 182 183
    exit(1);
}

184
#
185
# Parse command arguments.
186
#
187
ParseArgs();
188
CheckCopyArgs();
189 190 191

#
# Sanity check them.
192
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
193 194 195
usage()
    if (!defined($pid) || !defined($eid));
usage()
196
    if (defined($tempnsfile) && defined($copyarg));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
197

198 199 200
if (!defined($gid)) {
    $gid = $pid;
}
201
if (!defined($description)) {
202
    $description = "Created by $user_uid";
203
}
204
if (! $swappable && (!defined($noswap_reason) || $noswap_reason eq "")) {
Kevin Atkinson's avatar
 
Kevin Atkinson committed
205
    tbdie("Must provide a reason with -S option (not swappable reason)!");
206
}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
207
if (! $idleswap && (!defined($noidleswap_reason) || $noidleswap_reason eq "")){
Kevin Atkinson's avatar
 
Kevin Atkinson committed
208
    tbdie("Must provide a reason with -L option (no idleswap reason)!");
209
}
210
if (!defined($tempnsfile) && !defined($copyarg) && !TBAdmin()) {
Kevin Atkinson's avatar
 
Kevin Atkinson committed
211
    tbdie("Only admins can create experiments with no NS file");
212
}
213
my $nsfile  = "$eid.ns";
214
my $repfile = "report";
215

216
# Defaults for the DB and for the email message. 
217
$noswap_reason = "None Given"
218
    if (!defined($noswap_reason));
219
$noidleswap_reason = "None Given"
220 221
    if (!defined($noidleswap_reason));

222 223 224 225 226 227
# Need the group
my $group = Group->Lookup($pid, $gid);
if (!defined($group)) {
    die("No such group $pid/$gid!");
}

228
#
229
# Make sure UID is allowed to create experiments in this project.
230
#
231
if (! $group->AccessCheck($this_user, TB_PROJECT_CREATEEXPT)) {
Kevin Atkinson's avatar
 
Kevin Atkinson committed
232
    die("You do not have permission to create experiments in $pid/$gid");
233 234
}

235 236 237
if (defined($copyarg)) {
    # This will be handled below.
    ;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
238 239 240
}
elsif (!defined($tempnsfile)) {
    # If no NS file, then override swap/idle stuff. 
241 242 243
    $swappable     = 0;
    $idleswap      = 0;
}
244
elsif (! -f $tempnsfile || ! -r $tempnsfile || -z $tempnsfile) {
245
    # Exit so that user sees the error, not us.
246 247 248
    tberror({type => 'primary', severity => SEV_ERROR,
	     error => ['bogus_ns_file', $tempnsfile]},
	    "$tempnsfile does not exist or is not a readable file!");
249 250
    exit(1);
}
251

252 253 254 255
#
# Batch jobs get a shorter idle time
#
my $swaptime = $idleswaptime;
256
if ($batchmode && TBSiteVarExists("idle/batch_threshold")) {
257 258 259 260 261 262
    my $batchidleswaptime = TBGetSiteVar("idle/batch_threshold");
    if ($swaptime > $batchidleswaptime) {
	$swaptime = $batchidleswaptime;
    }
}

263
#
264 265
# Grab me a secret key for accessing tar/rpm files via the web interface.
# Grab another secret key for the event system HMACs.
266
#
267 268
my $webkey   = TBGenSecretKey();
my $eventkey = TBGenSecretKey();
269

270 271 272 273 274 275 276 277 278
#
# In wait mode, block SIGINT until we spin off the background process.
#
if ($waitmode) {
    $SIG{QUIT} = 'IGNORE';
    $SIG{TERM} = 'IGNORE';
    $SIG{INT}  = 'IGNORE';
}

279
#
280 281 282 283
# Create an arg array of parameters.
#
my %args = ();

284 285 286 287
$args{'expt_head_uid'}	   = $user_uid;
$args{'expt_swap_uid'}	   = $user_uid;
$args{'creator_idx'}	   = $user_dbid;
$args{'swapper_idx'}	   = $user_dbid;
288 289 290 291 292 293 294 295 296 297 298 299 300 301
$args{'state'}		   = $exptstate;
$args{'priority'}	   = $priority;
$args{'swappable'}	   = $swappable;
$args{'idleswap'}	   = $idleswap;
$args{'idleswap_timeout'}  = $swaptime;
$args{'autoswap'}	   = $autoswap;
$args{'autoswap_timeout'}  = $autoswaptime;
$args{'idle_ignore'}	   = $idleignore;
$args{'keyhash'}	   = $webkey;
$args{'eventkey'}	   = $eventkey;
$args{'batchmode'}	   = $batchmode;
$args{'batchstate'}	   = $batchstate;
$args{'linktest_level'}    = $linktest;
$args{'savedisk'}	   = $savestate;
302
$args{'instance_idx'}	   = (defined($instance) ? $instance->idx() : 0);
303 304 305 306 307 308
# These are special; the library will DBQuote them. 
$args{'expt_name'}	   = $description;
$args{'noswap_reason'}	   = $noswap_reason;
$args{'noidleswap_reason'} = $noidleswap_reason;

# Now create the experiment; we get back a perl class instance.
309
if (! ($experiment = Experiment->Create($group, $eid, \%args))) {
310 311 312
    tbdie({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['create_experiment_record_failed']},
	  "Could not create a new experiment record!");
313 314
}

315 316 317 318 319 320
#
# At this point, we need to force a cleanup no matter how we exit.
# See the END block below.
#
$justexit = 0;

Kevin Atkinson's avatar
Kevin Atkinson committed
321 322 323 324 325
#
# Set error reporting info
# 
tblog_set_info($pid,$eid,$UID);

326
#
327
# Create a directory structure for the experiment.
328 329 330 331 332
#
if ($experiment->CreateDirectory() != 0) {
    if (($? >> 8) == EDQUOT()) {
	# Obey exit status protocol for web page; User should see this.
	$errorstat = 1;
333
    }
334 335 336
    fatal({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['create_experiment_directory_failed']},
	  "Failed to created experiment directory");
337
}
338 339 340
if (defined($instance)) {
    # Need to cross-mark the instance right away so that it is flagged.
    # Would be better to do this with a plain flag.
341
    my %args = ();
342
    $args{'exptidx'} = $experiment->idx();
343
    
344 345 346 347 348
    $instance->Update(0, \%args) == 0
	or fatal("Could not update experiment instance record!");
}
elsif (defined($template)) {
    # Tell the template with the new experiment index.
349 350 351 352 353
    %args = ();
    $args{'exptidx'} = $experiment->idx();

    $template->Update(\%args) == 0
	or fatal("Could not update template record!");
354 355
}

356 357 358 359
#
# Grab the working directory path, and thats where we work.
# The user's experiment directory is off in /proj space.
#
360 361
my $workdir = $experiment->WorkDir();
my $userdir = $experiment->UserDir();
362 363 364 365

chdir("$workdir") or
    fatal("Could not chdir to $workdir: $!");

366 367 368 369
#
# Create a new archive, which might actually be a branch of an existing one
# when doing an experiment branch (fork).
#
370 371 372
if (defined($branch_template)) {
    my $archive_eid = $branch_template->eid();
    
373 374 375
    fatal({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['archive_op_failed', 'create', undef, undef]},
	  "Could not create experiment archive!")
Leigh B. Stoller's avatar
Leigh B. Stoller committed
376 377 378 379
	if (libArchive::TBForkExperimentArchive($pid, $eid,
						$pid, $archive_eid, undef)
	    < 0);
}
380
elsif (libArchive::TBCreateExperimentArchive($pid, $eid) < 0) {
381 382 383
    fatal({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['archive_op_failed', 'create', undef, undef]},
	  "Could not create experiment archive!");
384 385 386 387 388 389 390 391 392 393 394 395
}

#
# Okay, if copying/branching an experiment, we have to go find the
# NS file, extracting the special (currently by convention) archive
# directory into the new experiment. This will set the tempnsfile
# variable needed below.
#
if ($copyarg) {
    CopyInArchive();
}

396 397 398 399 400 401 402 403 404 405
#
# It would be nice to check for overquota during the rest of this
# setup, but thats going to be a pain. Besides, its very unlikely
# that someone goes overquota at this point. Typically, the person
# is already overquota at this point. If this turns out to be wrong,
# it will be easy to add a little test to make sure there is at least
# a reasonable amount of room to proceed (create temp file and stick
# some data in it).
# 

406 407 408 409
#
# Dump the eventkey into a file in the experiment directory. 
#
if ($EVENTSYS) {
410
    open(KEY, ">" . $experiment->EventKeyPath()) or
411 412 413 414 415
	fatal("Could not create eventkey file: $!");
    print KEY $eventkey;
    close(KEY);
}

416
# And dump the web key too.
417
open(KEY, ">" . $experiment->WebKeyPath()) or
418 419 420 421
    fatal("Could not create webkey file: $!");
print KEY $webkey;
close(KEY);

422
#
423 424 425
# If no NS file, we are done. We must unlock it and reset its state
# appropriately. We leave the experiment in the "new" state so that
# the user is forced to do a modify first (to give it a topology). 
426
#
427
if (!defined($tempnsfile)) {
428
    $experiment->Unlock(EXPTSTATE_NEW());
429 430
    exit(0);
}
431

432
#
433
# Now we can get the NS file!
434
#
435
if (system("/bin/cp", "$tempnsfile", "$nsfile")) {
436 437 438
    fatal({type => 'primary', severity => SEV_ERROR,
	   error => ['copy_ns_file_failed', $tempnsfile, $nsfile]},
	  "Could not copy $tempnsfile to $workdir/$nsfile");
439
}
440
chmod(0664, "$nsfile");
441

442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
# Future; do not name the ns as above, but use generic name.
if (system("/bin/cp", "$tempnsfile", "nsfile.ns")) {
    fatal({type => 'primary', severity => SEV_ERROR,
	   error => ['copy_ns_file_failed', $tempnsfile, "nsfile.ns"]},
	  "Could not copy $tempnsfile to $workdir/$nsfile");
}

# We created this file below so kill it.
if ($copyarg) {
    # This is tainted for reasons I do not understand.
    if ($tempnsfile =~ /^([-\w\.\/]+)$/) {
	$tempnsfile = $1;
    }
    unlink($tempnsfile);
}

458
#
459 460
# Run parse in impotent mode on the NS file.  This has no effect but
# will display any errors.
461
#
462
if (system("$parser -n $zeeopt $pid $gid $eid $nsfile") != 0) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
463 464
    # Obey exit status protocol for web page.
    $errorstat = 1;
465 466 467
    fatal({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['ns_parse_failed']},
	  "NS Parse failed!");
468 469
}

470 471 472
#
# Gather statistics; start the clock ticking.
#
473
if ($frontend || $batchmode) {
474 475
    $experiment->PreSwap($this_user, TBDB_STATS_PRELOAD) == 0 or
	fatal("Preswap failed!");
476 477
}
else {
478 479
    $experiment->PreSwap($this_user, TBDB_STATS_START) == 0 or
	fatal("Preswap failed!");
480 481
}

482
goto skiplog
483
    if (defined($template));
484

485 486 487 488 489 490
#
# The rest of this goes into the background so that the user sees
# immediate response. We will send email later when the experiment
# is ready. In waitmode, we hold the parent waiting so that the user
# can script it. Must protect against async (^C) termination though.
#
491 492
if ($experiment->CreateLogFile("startexp", \$logname) != 0) {
    fatal("Could not create logfile!");
493
    
494 495 496 497
}
$experiment->SetLogFile($logname);
$experiment->OpenLogFile($logname);

498 499
if (my $childpid = TBBackGround($logname)) {
    #
500 501
    # Parent exits normally, unless in waitmode. We have to set
    # justexit to make sure the END block below does not run.
502
    #
503 504
    $justexit = 1;
    
505 506 507
    if (!$waitmode) {
	print("Experiment $pid/$eid is now configuring\n".
 	      "You will be notified via email when the experiment is ".
508 509
	      "ready to use\n")
	    if (! $quiet);
510 511
	exit(0);
    }
512
    print("Waiting for " . ($batchmode ? "batch " : "") . "experiment $eid ".
513 514 515 516 517 518 519
	  "to finish " . ($frontend ? "preloading." : "swapping in.") . "\n")
	if (! $quiet);

    if (isatty(STDIN) && !$quiet) {
	print("You may type ^C at anytime; you will be notified via email.\n".
	      "You will not actually interrupt the experiment itself.\n");
    }
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536

    # Give child a chance to run.
    select(undef, undef, undef, 0.25);
	
    #
    # Reset signal handlers. User can now kill this process, without
    # stopping the child.
    #
    $SIG{TERM} = 'DEFAULT';
    $SIG{QUIT} = 'DEFAULT';
    $SIG{INT}  = 'DEFAULT';

    #
    # Wait until child exits or until user gets bored and types ^C.
    #
    waitpid($childpid, 0);

537 538
    print("Done. Exited with status: $?\n")
	if (! $quiet);
Kevin Atkinson's avatar
 
Kevin Atkinson committed
539 540 541 542 543 544 545 546 547

    my $exit_code = $? >> 8;
    
    if ($exit_code != 0) {
	my $d = tblog_lookup_error();
	print tblog_format_error($d);
    }
    
    exit $exit_code;
548
}
549
TBdbfork();
550
skiplog:
551 552 553 554 555 556 557 558 559 560 561 562

# We are committed now. Affects how fatal() operates.
$committed = 1;

#
# When in waitmode, must put ourselves in another process group so that
# an interrupt to the parent will not have any effect on the backend.
#
if ($waitmode) {
    POSIX::setsid();
}

563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
#
# We need to catch TERM cause sometimes shit happens and we have to kill
# an experiment setup that is hung or otherwise scrogged. Rather then 
# trying to kill off the children one by one, lets arrange to catch it
# here and send a killpg to the children. This is not to be done lightly,
# cause it can leave things worse then they were before!
#
sub handler ($) {
    my ($signame) = @_;
    
    $SIG{TERM} = 'IGNORE';
    my $pgrp = getpgrp(0);
    kill('TERM', -$pgrp);
    sleep(1);
    $signaled = 1;
    fatal("Caught SIG${signame}! Killing experiment setup ...");
}
$SIG{TERM} = \&handler;
$SIG{QUIT} = 'DEFAULT';

583 584
#
# The guts of starting an experiment!
585
#
586 587
# A batch experiment is essentially preloaded (frontend mode) and then
# dropped into the batch queue, unless the user requested only preload.
588 589
#

590
#
591
# Run the various scripts. We want to propagate the error from tbprerun
592 593
# and tbrun back out, hence the bogus looking errorstat variable.
#
594
$experiment->SetState(EXPTSTATE_PRERUN) == 0
595
    or fatal("Failed to set experiment state to " . EXPTSTATE_PRERUN());
596 597

if ($experiment->PreRun($nsfile, ($zeeopt ? "-z" : ""))) {
598
    $errorstat = $? >> 8;
599 600 601
    fatal({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['tbprerun_failed']},
	  "tbprerun failed!");
602
}
603 604

$experiment->SetState(EXPTSTATE_SWAPPED) == 0
605
    or fatal("Failed to set experiment state to " . EXPTSTATE_SWAPPED());
606 607 608 609

#
# If not in frontend mode (preload only) continue to swapping exp in.
# 
610
if (! ($frontend || $batchmode)) {
611
    $experiment->SetState(EXPTSTATE_ACTIVATING) == 0
612
	or fatal("Failed to set experiment state to ". EXPTSTATE_ACTIVATING());
613

614
    if ($experiment->Swap($Experiment::EXPT_SWAPIN) != 0) {
615
	$errorstat = $? >> 8;
616 617 618
	fatal({type => 'secondary', severity => SEV_SECONDARY,
	       error => ['tbswap_in_failed']},
	      "tbswap in failed!");
619
    }
620 621
    
    $experiment->SetState(EXPTSTATE_ACTIVE) == 0
622
	or fatal("Failed to set experiment state to " . EXPTSTATE_ACTIVE());
623 624 625 626 627

    #
    # Look for the unsual case of more than 2 nodes and no vlans. Send a
    # warning message.
    #
628 629
    my @localnodes = ();
    fatal("Could not get local node list for $pid/$eid")
630
	if ($experiment->LocalNodeListNames(\@localnodes));
631

Leigh B. Stoller's avatar
Leigh B. Stoller committed
632
    if (@localnodes && scalar(@localnodes) > 2) {
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
	my $vlans_result =
	    DBQueryFatal("select pid from virt_lans ".
			 "where pid='$pid' and eid='$eid'");
    
	if (!$vlans_result->numrows) {
	    SENDMAIL("$user_name <$user_email>",
		     "WARNING: Experiment Configuration: $pid/$eid",
		     "This experiment has zero network links defined.\n".
		     "Please check your NS file to verify this is what you ".
		     "want!\n",
		     "$user_name <$user_email>",
		     "Cc: $TBOPS", ($nsfile));
	}
    }
}

# We append this report in the email message below.
650
if ($experiment->Report($repfile, "-b") != 0) {
651 652 653
    fatal({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['tbreport_failed']},
	  "tbreport failed!");
654 655
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
656 657 658 659 660
# Latest log is always called the same thing.
if (defined($logname)) {
    system("cp -fp $logname $workdir/" . EXPTLOGNAME());
}

661
#
662
# Save a copy of the files for testbed information gathering (long term).
663
#
664
$experiment->SaveLogFiles();
665 666 667 668 669

#
# Make a copy of the work dir in the user visible space so the user
# can see the log files.
#
670
$experiment->CopyLogFiles();
671

672
# Tell the archive library to add all files to the archive. 
673 674
libArchive::TBExperimentArchiveAddUserFiles($pid, $eid) == 0
    or fatal("Failed to add user archive files to the archive!");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
675

676
#
677 678
# Do a SavePoint on the experiment files. In template mode, let the wrapper
# deal with this. Avoids duplication of work.
679
#
680
if (! defined($template)) {
681 682 683 684 685 686
    print "Doing a savepoint on the experiment archive ...\n";
    if (libArchive::TBExperimentArchiveSavePoint($pid, $eid, "startexp") < 0) {
	fatal({type => 'secondary', severity => SEV_SECONDARY,
	       error => ['archive_op_failed', 'savepoint', undef, undef]},
	      "Failed to do a savepoint on the experiment archive!");
    }
687 688
}

689
#
690 691
# Gather statistics. This is not likely to fail, but if it does I want to
# bail cause the inconsistent records are a pain in the ass to deal with!
692 693
#
if ($frontend || $batchmode) {
694 695
    $experiment->PostSwap($this_user, TBDB_STATS_PRELOAD) == 0 or
	fatal("Postswap failed!");
696 697
}
else {
698 699
    $experiment->PostSwap($this_user, TBDB_STATS_START) == 0 or
	fatal("Postswap failed!");
700 701
}

702
#
703
# Set accounting stuff, but on success only, and *after* gathering swap stats!
704
#
705
$experiment->SetSwapInfo($this_user);
706

707 708 709
#
# Close up the log file so the webpage stops.
#
710
if (!defined($template)) {
711
    print "Experiment $pid/$eid has been successfully created!\n";
712
    $experiment->CloseLogFile();
713
}
714 715 716 717

#
# Must unlock and drop batch experiments into the queue before exit.
#
718
if ($batchmode && !$frontend) {
719
    $experiment->Unlock(EXPTSTATE_QUEUED());
720 721
}
else {
722
    $experiment->Unlock();
723 724 725 726 727 728
}

#
# Clear the cancel flag now that the operation is complete. Must be
# done after we change the experiment state (above).
#
729
$experiment->SetCancelFlag(EXPTCANCEL_CLEAR());
730

731 732 733 734
#
# In template_mode we are done; the caller finishes up.
#
exit(0)
735
    if (defined($template));
736

737 738 739
#
# Dump the report file and the log file to the user via email. 
#
740
my ($expt_created) = $experiment->created();
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
my $message;

if ($frontend) {
    $message =
	"Your experiment `$eid' in project `$pid' has been created.\n" .
	"You can check the web interface to see if it looks the way\n" .
	"you expected it to. If so, you may swap the experiment in,\n" .
	"or terminate it, at any time.\n" .
        "\n";
}
else {
    $message =
	"Your experiment `$eid' in project `$pid' has been started.\n" .
	"Here is the experiment summary detailing the nodes that were\n" .
	"allocated to you. You may use the `Qualified Name' to log on\n" .
	"to your nodes. See /etc/hosts on your nodes (when running\n" .
	"FreeBSD, Linux, or NetBSD) for the IP mapping on each node.\n" .
        "\n";
759
}
760 761 762 763 764 765 766 767
$message .=
    "User:        $user_name\n" .
    "EID:         $eid\n" .
    "PID:         $pid\n" .
    "GID:         $gid\n" .
    "Description: $description\n" .
    "Swappable:   " . ($swappable ? "Yes\n" :
		                    "No  (Reason: $noswap_reason)\n") .
768
    "Idle-Swap:   " . ($idleswap  ? "Yes, at " . $idleswaptime/60.0 . " hours\n":
769
		                    "No  (Reason: $noidleswap_reason)\n") .
770
    "Auto-Swap:   " . ($autoswap  ? "Yes, at " . $autoswaptime/60.0 . " hours\n":
771 772 773 774 775 776 777 778 779 780 781 782 783 784
		                    "No\n") .
    "Created:     $expt_created\n".
    "Directory:   $userdir\n".
    "\n".
    "Appended at the end is the output of the experiment setup. If you\n" .
    "have any questions or comments, please include the output below\n" .
    "in your message to $TBOPS";

SENDMAIL("$user_name <$user_email>",
	 "New Experiment " . (($frontend == 0) ? "Started" : "Created") .
	 ": $pid/$eid",
	 $message,
	 "$user_name <$user_email>",
	 "Bcc: $TBLOGS",
785 786
	 ($repfile, $logname, $nsfile))
    if (!$zeemode);
787 788

# Done!
789
exit(0);
790

791 792 793
#
#
#
794
sub cleanup()
795
{
796
    #
797 798 799 800 801 802
    # Failed early (say, in parsing). No point in keeping any of the
    # stats or resource records. Just a waste of space since the
    # testbed_stats log indicates there was a failure and why (sorta,
    # via the exit code).
    # 
    if (!$committed) {
803 804 805
	# Completely remove all trace of the archive.
        libArchive::TBDestroyExperimentArchive($pid, $eid);

806
	#
807
	# Clear the experiment record and cleanup directories
808
	#
809 810
	$experiment->Delete(1)
	    if (defined($experiment));
811

812
	return;
813
    }
814

815 816 817 818
    #
    # Gather statistics.
    #
    if ($frontend) {
819
	$experiment->SwapFail($this_user, TBDB_STATS_PRELOAD, $errorstat);
820 821
    }
    else {
822
	$experiment->SwapFail($this_user, TBDB_STATS_START, $errorstat);
823
    }
824

825 826 827
    #
    # Must clean up the experiment if it made it our of NEW state.
    #
828
    my $estate = $experiment->state();
829 830 831 832 833 834 835 836
    if ($estate ne EXPTSTATE_NEW) {
	#
	# We do not know exactly where things stopped, so if the
	# experiment was activating when the signal was delivered,
	# run tbswap on it. 
	# 
	if ($estate eq EXPTSTATE_ACTIVE ||
	    ($estate eq EXPTSTATE_ACTIVATING && $signaled)) {
837 838
	    if ($experiment->Swap("out", "-force") != 0) {
		print "tbswap out -force failed!\n";
839
	    }
840
	    $experiment->SetState(EXPTSTATE_SWAPPED);
841
	}
842
	
843
	if ($experiment->End("-f") != 0) {
844
	    print "tbend failed!\n";
845 846
	}
    }
847
    $experiment->SetState(EXPTSTATE_TERMINATED);
848

849 850
    # Old swap gathering stuff.
    $experiment->GatherSwapStats($this_user, TBDB_STATS_TERMINATE, 0);
851

852 853
    # Clear the logfile so the webpage stops.
    $experiment->CloseLogFile();
854

Kevin Atkinson's avatar
Kevin Atkinson committed
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
    if (!$ENV{'TBAUDITON'}) {
	#
	# Figure out the error if possible
	#
	my $error_data = tblog_find_error();
	
	#
	# Send a message to the testbed list. 
	#
	tblog_email_error($error_data,
			  "$user_name <$user_email>",
			  "Config Failure", "$pid/$eid",
			  "$user_name <$user_email>",
			  "",
			  "Cc: $TBOPS",
			  "",
			  ($logname, "assign.log", "wanassign.log", $nsfile));
    } 	
	
874
    #
875 876 877 878
    # Back up the work dir for post-mortem debugging. 
    #
    system("/bin/rm -rf  ${workdir}-failed");
    system("/bin/mv -f   $workdir ${workdir}-failed");
879

880 881
    #
    # Clear the record and cleanup.
882 883
    #
    $experiment->Delete();
884 885 886
}

#
887 888
# Parse command arguments. Once we return from getopts, all that should
# left are the required arguments.
889
#
890
sub ParseArgs()
891
{
892 893 894 895
    my %options = ();
    if (! getopts($optlist, \%options)) {
	usage();
    }
896

897
    if (@ARGV > 1) {
898 899
	usage();
    }
900 901
    if (@ARGV == 1) {
	$tempnsfile = $ARGV[0];
902

903
	# Note different taint check (allow /).
904
	if ($tempnsfile =~ /^([-\w\.\/]+)$/) {
905 906 907
	    $tempnsfile = $1;
	}
	else {
Kevin Atkinson's avatar
 
Kevin Atkinson committed
908
	    tbdie("Bad data in nsfile: $tempnsfile");
909
	}
910

911
	#
912 913
	# Called from ops interactively. Make sure NS file resides in an
	# appropriate location.
914 915 916 917 918 919 920 921
	#
	# Use realpath to resolve any symlinks.
	#
	my $translated = `realpath $tempnsfile`;
	if ($translated =~ /^([-\w\.\/]+)$/) {
	    $tempnsfile = $1;
	}
	else {
922 923 924
	    tbdie({type => 'primary', severity => SEV_ERROR,
		   error => ['bad_data', 'realpath', $translated]},
		  "Bad data returned by realpath: $translated");
925 926 927
	}

	#
928 929 930 931 932 933 934
	# The file must reside in an acceptible location. Since this script
	# runs as the caller, regular file permission checks ensure it is a
	# file the user is allowed to use.  So we don't have to be too tight
	# with the RE matching /tmp and /var/tmp files.  Note that
	# /tmp/$guid-$nsref.nsfile is also allowed since this script is
	# invoked directly from web interface which generates a name that
	# should not be guessable.
935 936
	#
	if (! ($tempnsfile =~ /^\/tmp\/[-\w]+-\d+\.nsfile/) &&
937
	    ! ($tempnsfile =~ /^\/tmp\/\d+\.ns/) &&
938
	    ! ($tempnsfile =~ /^\/var\/tmp\/php[-\w]+/) &&
939
	    ! TBValidUserDir($tempnsfile, 0)) {
940 941 942
	    tberror({type => 'primary', severity => SEV_ERROR,
		     error => ['disallowed_directory', $tempnsfile]},
		    "$tempnsfile does not resolve to an allowed directory!");
943 944 945 946 947
	    # Note positive status; so error goes to user not tbops.
	    exit(1);
	}
    }
    
948
    if (defined($options{"i"})) {
949
	$batchmode = 0;
950
    }
951 952 953
    if (defined($options{"f"})) {
	$frontend = 1;
    }
954 955 956
    if (defined($options{"q"})) {
	$quiet = 1;
    }
957 958 959 960
    if (defined($options{"z"})) {
	$zeemode = 1;
	$zeeopt  = "-p";
    }
961 962 963 964
    # This option should not be exported via the XMLRPC server. 
    if (defined($options{"n"})) {
	$idleignore = 1;
    }
965

966 967 968 969
    if (defined($options{"s"})) {
	$savestate = 1;
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
970 971 972 973 974
    #
    # Clone an experiment, either an existing experiment or an old one
    # (using the archive). 
    #
    if (defined($options{"c"})) {
975
	$copyarg = $options{"c"};
Leigh B. Stoller's avatar
Leigh B. Stoller committed
976

977 978
	if (! (($copyarg =~ /^([-\w]+),([-\w]+)(?::[-\w]*)?$/) ||
	       ($copyarg =~ /^(\d+)(?::[-\w]*)?$/))) {
979 980 981
	    tbdie({type => 'primary', severity => SEV_ERROR,
		   error => ['bad_data', 'argument', $copyarg]},
		  "Bad data in argument: $copyarg");
982
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
983 984
    }

985 986 987
    #
    # pid,eid,gid get passed along as shell commands args; must taint check.
    # 
988 989
    if (defined($options{"p"})) {
	$pid = $options{"p"};
990

991
	if ($pid =~ /^([-\w]+)$/) {
992 993
	    $pid = $1;
	}
994
	else {
995 996 997
	    tbdie({type => 'primary', severity => SEV_ERROR,
		   error => ['bad_data', 'argument', $pid]},
		  "Bad data in argument: $pid.");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
998
	}
999 1000 1001 1002
    }
    if (defined($options{"e"})) {
	$eid = $options{"e"};

1003
	if ($eid =~ /^([-\w]+)$/) {
1004 1005 1006
	    $eid = $1;
	}
	else {
1007 1008 1009
	    tbdie({type => 'primary', severity => SEV_ERROR,
		   error => ['bad_data', 'argument', $eid]},
		  "Bad data in argument: $eid.");
1010
	}
1011 1012
	if (! TBcheck_dbslot($eid, "experiments", "eid",
			   TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
1013 1014 1015
	    tbdie({type => 'primary', severity => SEV_ERROR,
		   error => ['bad_data', 'eid', $eid]},
		  "Improper experiment name (id)!");
1016
	}
1017 1018 1019 1020
    }
    if (defined($options{"g"})) {
	$gid = $options{"g"};

1021
	if ($gid =~ /^([-\w]+)$/) {
1022
	    $gid = $1;
1023
	}
1024
	else {
1025 1026 1027
	    tbdie({type => 'primary', severity => SEV_ERROR,
		   error => ['bad_data', 'argument', $gid]},
		  "Bad data in argument: $gid.");
1028 1029
	}
    }
1030
    if (defined($options{"E"})) {
1031 1032
	if (! TBcheck_dbslot($options{"E"}, "experiments", "expt_name",
			   TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
Kevin Atkinson's avatar
 
Kevin Atkinson committed
1033
	    tbdie("Improper experiment description!");
1034
	}
1035
	$description = $options{"E"};
1036
    }
1037 1038 1039
    if (defined($options{"S"})) {
	if (! TBcheck_dbslot($options{"S"}, "experiments", "noswap_reason",
			   TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
Kevin Atkinson's avatar
 
Kevin Atkinson committed
1040
	    tbdie("Improper noswap reason!");
1041 1042
	}
	$swappable     = 0;
1043
	$noswap_reason = $options{"S"};
1044 1045 1046 1047
    }
    if (defined($options{"L"})) {
	if (! TBcheck_dbslot($options{"L"}, "experiments", "noidleswap_reason",
			   TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
Kevin Atkinson's avatar
 
Kevin Atkinson committed
1048
	    tbdie("Improper noidleswap reason!");
1049 1050
	}
	$idleswap          = 0;
Leigh B. Stoller's avatar