batchexp.in 38.4 KB
Newer Older
1
#!/usr/bin/perl -wT
Leigh B. Stoller's avatar
Leigh B. Stoller committed
2
#
3
# Copyright (c) 2000-2013 University of Utah and the Flux Group.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
# 
# {{{EMULAB-LICENSE
# 
# This file is part of the Emulab network testbed software.
# 
# This file is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
# 
# This file is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
# License for more details.
# 
# You should have received a copy of the GNU Affero General Public License
# along with this file.  If not, see <http://www.gnu.org/licenses/>.
# 
# }}}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
23
#
24 25
use English;
use Getopt::Std;
26
use POSIX qw(isatty setsid);
27
use POSIX qw(strftime);
28
use Errno qw(EDQUOT);
29
use RPC::XML;
30 31

#
32 33 34 35
# 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).
36
#
37
# TODO: Remove expt_expires and priority.
38
#       Add calls to check_slot() to verify inputs.
39
# 
Leigh B. Stoller's avatar
Leigh B. Stoller committed
40 41 42 43 44 45 46 47 48
# 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. 
# 
49 50
sub usage()
{
51
    print(STDERR
52
	  "Usage: batchexp [-q] [-i [-w]] [-n] [-f] [-N] [-E description] [-g gid]\n".
53
	  "                [-S reason] [-L reason] [-a <time>] [-l <time>]\n".
54
	  "                -p <pid> -e <eid> <nsfile>\n".
55
	  "switches and arguments:\n".
56 57 58
	  "-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".
59
	  "-q       - be less chatty\n".
60 61
	  "-S <str> - Experiment cannot be swapped; must provide reason\n".
	  "-L <str> - Experiment cannot be IDLE swapped; must provide reason\n".
62
	  "-n       - Do not send idle email (internal option only)\n".
63 64
	  "-a <nnn> - Auto swapout nnn minutes after experiment is swapped in\n".
	  "-l <nnn> - Auto swapout nnn minutes after experiment goes idle\n".
65
	  "-s       - Save disk state on swapout\n".
66 67 68 69
	  "-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".
70
	  "-N       - Suppress most email to the user and testbed-ops\n".
71 72 73 74
	  "<nsfile> - NS file to parse for experiment.\n");
    exit(-1);
}

75
sub ParseArgs();
76 77
sub CheckCopyArgs();
sub CopyInArchive();
78
sub fatal($;$);
79

80
my $optlist = "iE:g:e:p:S:L:a:l:sfwqt:nzc:bx:y:h:jkNX";	# Enough options?
81
my $batchmode= 1;
82 83
my $frontend = 0;
my $waitmode = 0;
84
my $quiet    = 0;
85
my $lockdown = 0;
86
my $linktest = 0;	# non-zero means level to run at.
87 88
my $zeemode  = 0;	# Hey, out of options.
my $zeeopt   = "";	# To pass along.
89
my $genimode;           # Allow creation with no NS file, uuid given.
90
my $savestate= 0;
91
my $nonsfile = 0;	# Admin only option to activate experiment anyway.
92 93 94
my $template;		# New stuff; experiment templates.
my $branch_template;    # New stuff; experiment templates.
my $instance;		# New stuff; experiment templates.
95 96 97 98 99 100 101 102 103
# 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.
104 105 106 107 108

#
# Configure variables
#
my $TB       = "@prefix@";
109
my $EVENTSYS = @EVENTSYS@;
110 111
my $TBOPS    = "@TBOPSEMAIL@";
my $TBLOGS   = "@TBLOGSEMAIL@";
112 113
my $TBDOCBASE = "@TBDOCBASE@";
my $TBBASE   = "@TBBASE@";
114
my $CONTROL  = "@USERNODE@";
115

116 117 118 119 120 121
#
# Testbed Support libraries
#
use lib "@prefix@/lib";
use libdb;
use libtestbed;
Kevin Atkinson's avatar
Kevin Atkinson committed
122
use libtblog;
123
use libArchive;
124
use Experiment;
125
use Template;
126
use User;
127
use Project;
128
use Group;
129

130 131 132 133
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
134
my $errorstat=-1;
135
my $exptidx;
136
my $logfile;
137
my $logname;
138

139 140 141 142
# For the END block below.
my $cleaning = 0;
my $justexit = 1;
my $signaled = 0;
143 144 145 146 147 148

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

149 150 151 152 153 154 155
#
# 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);

156 157
#
# Untaint the path
158
#
159 160
# un-taint path
$ENV{'PATH'} = '/bin:/usr/bin:/usr/local/bin';
161 162
delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};

163 164 165 166 167
my $eid;
my $pid;
my $gid;
my $description;
my $tempnsfile;
168 169 170
my $swappable    = 1;
my $noswap_reason;
my $idleswap     = 1;
171
my $idleswaptime = 60 * TBGetSiteVar("idle/threshold");
172
my $noidleswap_reason;
173
my $autoswap     = 0;
174
my $autoswaptime = 10 * 60;
175 176 177
my $idleignore   = 0;
my $priority     = TB_EXPTPRIORITY_LOW;
my $exptstate    = EXPTSTATE_NEW();
178
my $batchstate   = BATCHSTATE_UNLOCKED();
179 180
my $now          = localtime();
my $committed    = 0;
181 182
my $experiment;
my $copy_experiment;
183
my $noemail      = 0;
184
my $xmlout       = 0;
185

186
#
187
# Verify user and get his DB uid and other info for later.
188
#
189 190 191
my $this_user = User->ThisUser();
if (! defined($this_user)) {
    tbdie("You ($UID) do not exist!");
192
}
193 194 195 196
my $user_dbid  = $this_user->dbid();
my $user_uid   = $this_user->uid();
my $user_name  = $this_user->name();
my $user_email = $this_user->email();
197

198 199 200 201
#
# Before doing anything else, check for overquota ... lets not waste
# our time. Make sure user sees the error by exiting with 1.
#
202
if (system("$checkquota $user_uid") != 0) {
203 204
    tberror({cause => 'user', type => 'primary', severity => SEV_ERROR,
	     error => ['over_disk_quota', $CONTROL]},
205 206
	    "You are over your disk quota on $CONTROL; ".
	    "please login there and cleanup!");
207 208 209
    exit(1);
}

210
#
211
# Parse command arguments.
212
#
213
ParseArgs();
214
CheckCopyArgs();
215 216 217

#
# Sanity check them.
218
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
219 220 221
usage()
    if (!defined($pid) || !defined($eid));
usage()
222
    if (defined($tempnsfile) && defined($copyarg));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
223

224 225 226 227 228 229
if (! -e "$TB/expinfo/$pid") {
    die("*** $0:\n".
	"    $TB/expinfo/$pid has not been created yet!\n".
	"    Did you run 'fixexpinfo' like you were supposed to?\n");
}

230 231 232
if (!defined($gid)) {
    $gid = $pid;
}
233
if (!defined($description)) {
234
    $description = "Created by $user_uid";
235
}
236
if (! $swappable && (!defined($noswap_reason) || $noswap_reason eq "")) {
237
    tbdie("Must provide a reason with -S option (not swappable reason)!");
238
}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
239
if (! $idleswap && (!defined($noidleswap_reason) || $noidleswap_reason eq "")){
240
    tbdie("Must provide a reason with -L option (no idleswap reason)!");
241
}
242 243
if (!defined($tempnsfile) && !defined($copyarg)
    && !TBAdmin() && !defined($genimode)) {
244
    tbdie("Only admins can create experiments with no NS file");
245
}
246
my $nsfile  = "$eid.ns";
247
my $repfile = "report";
248

249
# Defaults for the DB and for the email message. 
250
$noswap_reason = "None Given"
251
    if (!defined($noswap_reason));
252
$noidleswap_reason = "None Given"
253 254
    if (!defined($noidleswap_reason));

255 256 257 258 259 260
# Need the group
my $group = Group->Lookup($pid, $gid);
if (!defined($group)) {
    die("No such group $pid/$gid!");
}

261
#
262
# Make sure UID is allowed to create experiments in this project.
263
#
264
if (! $group->AccessCheck($this_user, TB_PROJECT_CREATEEXPT)) {
265
    die("You do not have permission to create experiments in $pid/$gid");
266 267
}

268 269 270
if (defined($copyarg)) {
    # This will be handled below.
    ;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
271 272
}
elsif (!defined($tempnsfile)) {
273 274 275 276 277
    if (! $genimode) {
	# If no NS file, then override swap/idle stuff. 
	$swappable     = 0;
	$idleswap      = 0;
    }
278
}
279
elsif (! -f $tempnsfile || ! -r $tempnsfile || -z $tempnsfile) {
280
    # Exit so that user sees the error, not us.
281 282 283
    tberror({type => 'primary', severity => SEV_ERROR,
	     error => ['bogus_ns_file', $tempnsfile]},
	    "$tempnsfile does not exist or is not a readable file!");
284 285
    exit(1);
}
286

287 288 289 290
#
# Batch jobs get a shorter idle time
#
my $swaptime = $idleswaptime;
291
if ($batchmode && TBSiteVarExists("idle/batch_threshold")) {
292 293 294 295 296 297
    my $batchidleswaptime = TBGetSiteVar("idle/batch_threshold");
    if ($swaptime > $batchidleswaptime) {
	$swaptime = $batchidleswaptime;
    }
}

298
#
299 300
# Grab me a secret key for accessing tar/rpm files via the web interface.
# Grab another secret key for the event system HMACs.
301
#
302 303
my $webkey   = TBGenSecretKey();
my $eventkey = TBGenSecretKey();
304

305 306 307 308 309 310 311 312 313
#
# In wait mode, block SIGINT until we spin off the background process.
#
if ($waitmode) {
    $SIG{QUIT} = 'IGNORE';
    $SIG{TERM} = 'IGNORE';
    $SIG{INT}  = 'IGNORE';
}

314
#
315 316 317 318
# Create an arg array of parameters.
#
my %args = ();

319 320 321 322
$args{'expt_head_uid'}	   = $user_uid;
$args{'expt_swap_uid'}	   = $user_uid;
$args{'creator_idx'}	   = $user_dbid;
$args{'swapper_idx'}	   = $user_dbid;
323 324 325 326
$args{'state'}		   = $exptstate;
$args{'priority'}	   = $priority;
$args{'swappable'}	   = $swappable;
$args{'idleswap'}	   = $idleswap;
327
$args{'idleswap_timeout'}  = ($genimode ? 2 * $swaptime : $swaptime);
328 329 330 331
$args{'autoswap'}	   = $autoswap;
$args{'autoswap_timeout'}  = $autoswaptime;
$args{'idle_ignore'}	   = $idleignore;
$args{'keyhash'}	   = $webkey;
332
$args{'lockdown'}	   = $lockdown;
333 334 335 336 337
$args{'eventkey'}	   = $eventkey;
$args{'batchmode'}	   = $batchmode;
$args{'batchstate'}	   = $batchstate;
$args{'linktest_level'}    = $linktest;
$args{'savedisk'}	   = $savestate;
338
$args{'instance_idx'}	   = (defined($instance) ? $instance->idx() : 0);
339 340 341 342
# These are special; the library will DBQuote them. 
$args{'expt_name'}	   = $description;
$args{'noswap_reason'}	   = $noswap_reason;
$args{'noidleswap_reason'} = $noidleswap_reason;
343 344
$args{'eid_uuid'}          = $genimode
    if (defined($genimode));
345 346

# Now create the experiment; we get back a perl class instance.
347
if (! ($experiment = Experiment->Create($group, $eid, \%args))) {
348 349 350
    tbdie({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['create_experiment_record_failed']},
	  "Could not create a new experiment record!");
351 352
}

353 354 355 356 357 358
#
# 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
359 360 361 362 363
#
# Set error reporting info
# 
tblog_set_info($pid,$eid,$UID);

364
#
365
# Create a directory structure for the experiment.
366 367 368 369 370
#
if ($experiment->CreateDirectory() != 0) {
    if (($? >> 8) == EDQUOT()) {
	# Obey exit status protocol for web page; User should see this.
	$errorstat = 1;
371
    }
372 373 374
    fatal({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['create_experiment_directory_failed']},
	  "Failed to created experiment directory");
375
}
376 377 378
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.
379
    my %args = ();
380
    $args{'exptidx'} = $experiment->idx();
381
    
382 383 384 385 386
    $instance->Update(0, \%args) == 0
	or fatal("Could not update experiment instance record!");
}
elsif (defined($template)) {
    # Tell the template with the new experiment index.
387 388 389 390 391
    %args = ();
    $args{'exptidx'} = $experiment->idx();

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

394 395 396 397
#
# Grab the working directory path, and thats where we work.
# The user's experiment directory is off in /proj space.
#
398 399
my $workdir = $experiment->WorkDir();
my $userdir = $experiment->UserDir();
400 401 402 403

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

404 405 406 407
#
# Create a new archive, which might actually be a branch of an existing one
# when doing an experiment branch (fork).
#
408 409 410
if (defined($branch_template)) {
    my $archive_eid = $branch_template->eid();
    
411 412 413
    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
414 415 416 417
	if (libArchive::TBForkExperimentArchive($pid, $eid,
						$pid, $archive_eid, undef)
	    < 0);
}
418
elsif (libArchive::TBCreateExperimentArchive($pid, $eid) < 0) {
419 420 421
    fatal({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['archive_op_failed', 'create', undef, undef]},
	  "Could not create experiment archive!");
422 423 424 425 426 427 428 429 430 431 432 433
}

#
# 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();
}

434 435 436 437 438 439 440 441 442 443
#
# 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).
# 

444 445 446 447
#
# Dump the eventkey into a file in the experiment directory. 
#
if ($EVENTSYS) {
448
    open(KEY, ">" . $experiment->EventKeyPath()) or
449 450 451 452 453
	fatal("Could not create eventkey file: $!");
    print KEY $eventkey;
    close(KEY);
}

454
# And dump the web key too.
455
open(KEY, ">" . $experiment->WebKeyPath()) or
456 457 458 459
    fatal("Could not create webkey file: $!");
print KEY $webkey;
close(KEY);

460
#
461 462 463
# 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). 
464
#
465
if (!defined($tempnsfile)) {
466 467 468 469 470 471 472 473 474 475
    #
    # In GeniMode, we skip past the nsfile stuff.
    #
    if (defined($genimode)) {
	$nonsfile = 1;
    }
    if (!$nonsfile) {
	$experiment->Unlock(EXPTSTATE_NEW());
	exit(0);
    }
476
}
477

478 479 480 481 482 483 484 485 486 487
if (!$nonsfile) {
    #
    # Now we can get the NS file!
    #
    if (system("/bin/cp", "$tempnsfile", "$nsfile")) {
	fatal({type => 'primary', severity => SEV_ERROR,
	       error => ['copy_ns_file_failed', $tempnsfile, $nsfile]},
	      "Could not copy $tempnsfile to $workdir/$nsfile");
    }
    chmod(0664, "$nsfile");
488

489 490 491 492 493 494
    # 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");
    }
495 496 497 498 499 500 501 502 503 504
}
# 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);
}

505
#
506 507
# Run parse in impotent mode on the NS file.  This has no effect but
# will display any errors.
508
#
509 510
if (!$nonsfile &&
    system("$parser -n $zeeopt $pid $gid $eid $nsfile") != 0) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
511 512
    # Obey exit status protocol for web page.
    $errorstat = 1;
513 514 515
    fatal({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['ns_parse_failed']},
	  "NS Parse failed!");
516 517
}

518 519 520
#
# Gather statistics; start the clock ticking.
#
521
if ($frontend || $batchmode || $genimode) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
522
    $experiment->PreSwap($this_user, TBDB_STATS_PRELOAD, $exptstate) == 0 or
523
	fatal("Preswap failed!");
524 525
}
else {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
526
    $experiment->PreSwap($this_user, TBDB_STATS_START, $exptstate) == 0 or
527
	fatal("Preswap failed!");
528 529
}

530
goto skiplog
531
    if (defined($template));
532

533 534 535 536 537 538
#
# 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.
#
539 540
$logfile = $experiment->CreateLogFile("startexp");
if (!defined($logfile)) {
541 542
    fatal("Could not create logfile!");
}
543 544 545 546 547
$logname = $logfile->filename();
# We want it to spew to the web.
$experiment->SetLogFile($logfile);
# Mark it open since we are going to start using it right away.
$logfile->Open();
548

549 550
if (my $childpid = TBBackGround($logname)) {
    #
551 552
    # Parent exits normally, unless in waitmode. We have to set
    # justexit to make sure the END block below does not run.
553
    #
554 555
    $justexit = 1;
    
556 557 558
    if (!$waitmode) {
	print("Experiment $pid/$eid is now configuring\n".
 	      "You will be notified via email when the experiment is ".
559 560
	      "ready to use\n")
	    if (! $quiet);
561 562
	exit(0);
    }
563
    print("Waiting for " . ($batchmode ? "batch " : "") . "experiment $eid ".
564 565 566 567 568 569 570
	  "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");
    }
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587

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

588 589
    print("Done. Exited with status: $?\n")
	if (! $quiet);
590 591 592 593 594

    my $exit_code = $? >> 8;
    
    if ($exit_code != 0) {
	my $d = tblog_lookup_error();
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
	my $output = tblog_format_error($d);
	if ($xmlout) {
	    use libtblog '*SOUT'; # to avoid an unnecessary, and large, 
                                  # log entry
	    if (open(IN, "$logname")) {
		$d->{log} = '';
		while (<IN>) {
		    $d->{log} .= $_;
		}
		close IN;
	    }
	    $d->{output} = $output;
	    print SOUT RPC::XML::response->new($d)->as_string(), "\n";
	} else {
	    print $output;
	}
611 612 613
    }
    
    exit $exit_code;
614
}
615
TBdbfork();
616 617 618 619 620 621 622 623

#
# 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();
}
624 625 626 627
skiplog:

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

629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
#
# 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';

649 650
#
# The guts of starting an experiment!
651
#
652 653
# A batch experiment is essentially preloaded (frontend mode) and then
# dropped into the batch queue, unless the user requested only preload.
654 655
#

656
#
657
# Run the various scripts. We want to propagate the error from tbprerun
658 659
# and tbrun back out, hence the bogus looking errorstat variable.
#
660
$experiment->SetState(EXPTSTATE_PRERUN) == 0
661
    or fatal("Failed to set experiment state to " . EXPTSTATE_PRERUN());
662

663 664
if (!$nonsfile &&
    $experiment->PreRun($nsfile, ($zeeopt ? "-z" : ""))) {
665
    $errorstat = $? >> 8;
666 667 668
    fatal({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['tbprerun_failed']},
	  "tbprerun failed!");
669
}
670 671

$experiment->SetState(EXPTSTATE_SWAPPED) == 0
672
    or fatal("Failed to set experiment state to " . EXPTSTATE_SWAPPED());
673 674 675 676

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

681 682
    if (!$nonsfile &&
	$experiment->Swap($Experiment::EXPT_SWAPIN) != 0) {
683
	$errorstat = $? >> 8;
684 685 686
	fatal({type => 'secondary', severity => SEV_SECONDARY,
	       error => ['tbswap_in_failed']},
	      "tbswap in failed!");
687
    }
688 689
    
    $experiment->SetState(EXPTSTATE_ACTIVE) == 0
690
	or fatal("Failed to set experiment state to " . EXPTSTATE_ACTIVE());
691 692 693 694 695

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
700
    if (@localnodes && scalar(@localnodes) > 2) {
701 702 703 704
	my $vlans_result =
	    DBQueryFatal("select pid from virt_lans ".
			 "where pid='$pid' and eid='$eid'");
    
705
	if (!$vlans_result->numrows && !$noemail) {
706 707 708 709 710 711 712 713 714 715 716 717
	    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.
718
if ($experiment->Report($repfile, "-b") != 0) {
719 720 721
    fatal({type => 'secondary', severity => SEV_SECONDARY,
	   error => ['tbreport_failed']},
	  "tbreport failed!");
722 723
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
724 725 726 727 728
# Latest log is always called the same thing.
if (defined($logname)) {
    system("cp -fp $logname $workdir/" . EXPTLOGNAME());
}

729
#
730 731 732
# Save the final experiment state so that we get a running record of
# the state on disk, for post-mortem debugging. This will get copied
# to the expinfo directory in the next line. 
733
#
734
$experiment->SaveExperimentState();
735

736 737 738
#
# Save a copy of the files for testbed information gathering (long term).
#
739
$experiment->SaveLogFiles();
740 741 742 743 744

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

747
# Tell the archive library to add all files to the archive. 
748 749
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
750

751
#
752 753
# Do a SavePoint on the experiment files. In template mode, let the wrapper
# deal with this. Avoids duplication of work.
754
#
755
if (! defined($template)) {
756 757 758 759 760 761
    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!");
    }
762 763
}

764
#
765 766
# 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!
767 768
#
if ($frontend || $batchmode) {
769 770
    $experiment->PostSwap($this_user, TBDB_STATS_PRELOAD) == 0 or
	fatal("Postswap failed!");
771 772
}
else {
773 774
    $experiment->PostSwap($this_user, TBDB_STATS_START) == 0 or
	fatal("Postswap failed!");
775 776
}

777
#
778
# Set accounting stuff, but on success only, and *after* gathering swap stats!
779
#
780
$experiment->SetSwapInfo($this_user);
781

782 783 784
#
# Close up the log file so the webpage stops.
#
785
if (!defined($template)) {
786
    print "Experiment $pid/$eid has been successfully created!\n";
787
    $experiment->CloseLogFile();
788
}
789 790 791 792

#
# Must unlock and drop batch experiments into the queue before exit.
#
793
if ($batchmode && !$frontend) {
794
    $experiment->Unlock(EXPTSTATE_QUEUED());
795 796
}
else {
797
    $experiment->Unlock();
798 799 800 801 802 803
}

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

806 807 808 809
#
# In template_mode we are done; the caller finishes up.
#
exit(0)
810
    if (defined($template));
811

812 813 814
#
# Dump the report file and the log file to the user via email. 
#
815
my ($expt_created) = $experiment->created();
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
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";
834
}
835 836 837 838 839 840 841 842
$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") .
843
    "Idle-Swap:   " . ($idleswap  ? "Yes, at " . $idleswaptime/60.0 . " hours\n":
844
		                    "No  (Reason: $noidleswap_reason)\n") .
845
    "Auto-Swap:   " . ($autoswap  ? "Yes, at " . $autoswaptime/60.0 . " hours\n":
846 847 848 849 850 851 852 853
		                    "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";

854
SENDMAIL(($noemail ? $TBLOGS : "$user_name <$user_email>"),
855 856 857 858
	 "New Experiment " . (($frontend == 0) ? "Started" : "Created") .
	 ": $pid/$eid",
	 $message,
	 "$user_name <$user_email>",
859
	 ($noemail ? "" : "Bcc: $TBLOGS"),
860
	 ($repfile, $logname, $nsfile))
861
    if (! ($zeemode || $genimode));
862 863

# Done!
864
exit(0);
865

866 867 868
#
#
#
869
sub cleanup()
870
{
871
    #
872 873 874 875 876 877
    # 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) {
878 879 880
	# Completely remove all trace of the archive.
        libArchive::TBDestroyExperimentArchive($pid, $eid);

881
	#
882
	# Clear the experiment record and cleanup directories
883
	#
884 885
	$experiment->Delete(1)
	    if (defined($experiment));
886

887
	return;
888
    }
889

890 891 892 893
    #
    # Gather statistics.
    #
    if ($frontend) {
894
	$experiment->SwapFail($this_user, TBDB_STATS_PRELOAD, $errorstat);
895 896
    }
    else {
897
	$experiment->SwapFail($this_user, TBDB_STATS_START, $errorstat);
898
    }
899

900 901 902
    #
    # Must clean up the experiment if it made it our of NEW state.
    #
903
    my $estate = $experiment->state();
904 905 906 907 908 909 910 911
    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)) {
912 913
	    if ($experiment->Swap("out", "-force") != 0) {
		print "tbswap out -force failed!\n";
914
	    }
915
	    $experiment->SetState(EXPTSTATE_SWAPPED);
916
	}
917
	
918
	if ($experiment->End("-f") != 0) {
919
	    print "tbend failed!\n";
920 921
	}
    }
922
    $experiment->SetState(EXPTSTATE_TERMINATED);
923

924 925
    # Old swap gathering stuff.
    $experiment->GatherSwapStats($this_user, TBDB_STATS_TERMINATE, 0);
926

927 928
    # Clear the logfile so the webpage stops.
    $experiment->CloseLogFile();
929

Kevin Atkinson's avatar
Kevin Atkinson committed
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
    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",
			  "",
946 947
			  ($logname, "assign.log", "wanassign.log", $nsfile))
	    unless $noemail;
Kevin Atkinson's avatar
Kevin Atkinson committed
948 949
    } 	
	
950
    #
951 952 953 954
    # Back up the work dir for post-mortem debugging. 
    #
    system("/bin/rm -rf  ${workdir}-failed");
    system("/bin/mv -f   $workdir ${workdir}-failed");
955

956 957
    #
    # Clear the record and cleanup.
958 959
    #
    $experiment->Delete();
960 961 962
}

#
963 964
# Parse command arguments. Once we return from getopts, all that should
# left are the required arguments.
965
#
966
sub ParseArgs()
967
{
968 969 970 971
    my %options = ();
    if (! getopts($optlist, \%options)) {
	usage();
    }
972

973
    if (@ARGV > 1) {
974 975
	usage();
    }
976 977
    if (@ARGV == 1) {
	$tempnsfile = $ARGV[0];
978

979
	# Note different taint check (allow /).
980
	if ($tempnsfile =~ /^([-\w\.\/]+)$/) {
981 982 983
	    $tempnsfile = $1;
	}
	else {
984
	    tbdie("Bad data in nsfile: $tempnsfile");
985
	}
986

987
	#
988 989
	# Called from ops interactively. Make sure NS file resides in an
	# appropriate location.
990 991 992 993 994 995 996 997
	#
	# Use realpath to resolve any symlinks.
	#
	my $translated = `realpath $tempnsfile`;
	if ($translated =~ /^([-\w\.\/]+)$/) {
	    $tempnsfile = $1;
	}
	else {
998 999 1000
	    tbdie({type => 'primary', severity => SEV_ERROR,
		   error => ['bad_data', 'realpath', $translated]},
		  "Bad data returned by realpath: $translated");
1001 1002 1003
	}

	#
1004 1005 1006 1007 1008 1009 1010
	# 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.
1011 1012
	#
	if (! ($tempnsfile =~ /^\/tmp\/[-\w]+-\d+\.nsfile/) &&
1013
	    ! ($tempnsfile =~ /^\/tmp\/\d+\.ns/) &&
1014
	    ! ($tempnsfile =~ /^\/var\/tmp\/php[-\w]+/) &&
1015
	    ! TBValidUserDir($tempnsfile, 0)) {
1016 1017 1018
	    tberror({type => 'primary', severity => SEV_ERROR,
		     error => ['disallowed_directory', $tempnsfile]},
		    "$tempnsfile does not resolve to an allowed directory!");
1019 1020 1021 1022 1023
	    # Note positive status; so error goes to user not tbops.
	    exit(1);
	}
    }
    
1024
    if (defined($options{"i"})) {
1025
	$batchmode = 0;
1026
    }
1027 1028 1029
    if (defined($options{"f"})) {
	$frontend = 1;
    }
1030 1031 1032
    if (defined($options{"q"})) {
	$quiet = 1;
    }
1033 1034 1035 1036
    if (defined($options{"z"})) {
	$zeemode = 1;
	$zeeopt  = "-p";
    }
1037 1038 1039 1040
    # This option should not be exported via the XMLRPC server. 
    if (defined($options{"n"})) {
	$idleignore = 1;
    }
1041

1042 1043 1044
    if (defined($options{"s"})) {
	$savestate = 1;
    }
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
    if (defined($options{"h"})) {
	$genimode = $options{"h"};
	if (! ($genimode =~ /^[-\w]+$/)) {
	    tbdie({type => 'primary', severity => SEV_ERROR,
		   error => ['bad_data', 'argument', $genimode]},
		  "Bad data in argument: $genimode.");
	}
    }
    if (defined($options{"j"})) {
	$nonsfile = 1;
    }
1056 1057 1058
    if (defined($options{"k"})) {
	$lockdown = 1;
    }
1059

Leigh B. Stoller's avatar
Leigh B. Stoller committed
1060 1061 1062 1063 1064
    #
    # Clone an experiment, either an existing experiment or an old one
    # (using the archive). 
    #
    if (defined($options{"c"})) {
1065
	$copyarg = $options{"c"};
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1066

1067 1068
	if (! (($copyarg =~ /^([-\w]+),([-\w]+)(?::[-\w]*)?$/) ||
	       ($copyarg =~ /^(\d+)(?::[-\w]*)?$/))) {
1069 1070 1071
	    tbdie({type => 'primary', severity => SEV_ERROR,
		   error => ['bad_data', 'argument', $copyarg]},
		  "Bad data in argument: $copyarg");