swapexp.in 9.05 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 13 14 15 16
use English;
use Getopt::Std;

#
# This gets invoked from the Web interface. Swap an experiment in or out.
#
sub usage()
{
17
    print STDOUT "Usage: swapexp <-s in | out | restart> <pid> <eid>\n";
18 19
    exit(-1);
}
20
my  $optlist = "s:";
21 22 23 24 25 26 27 28

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

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

my $tbdir    = "$TB/bin/";
39
my $tbdata   = "tbdata";
40 41 42 43 44 45 46
my $batch    = 0;
my $inout;
my $logname;
my $dbuid;
my $user_name;
my $user_email;
my @row;
47
my $action;
48 49 50 51 52 53 54 55 56 57 58 59
    
#
# Untaint the path
# 
$ENV{'PATH'} = '/bin:/usr/bin';
delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};

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

60 61 62 63 64 65 66
#
# 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);

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
#
# Parse command arguments. Once we return from getopts, all that should
# left are the required arguments.
#
%options = ();
if (! getopts($optlist, \%options)) {
    usage();
}
if (@ARGV != 2) {
    usage();
}
my $pid   = $ARGV[0];
my $eid   = $ARGV[1];
if (defined($options{"s"})) {
    $inout = $options{"s"};

83
    if ($inout ne "out" && $inout ne "in" && $inout ne "restart") {
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
	usage();
    }
}
else {
    usage();
}

#
# 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");
}
106
my $repfile = "$eid.report";
107 108
my $workdir = TBExptWorkDir($pid, $eid);
my $userdir = TBExptUserDir($pid, $eid);
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132

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

#
# Verify that this person is allowed to end the experiment.
# 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".
133
	"    You do not have permission to swap this experiment!\n");
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
}

#
# 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
# the tb scripts. 
#
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'};

159
if (! chdir($workdir)) {
160
    die("*** $0:\n".
161
	"    Could not chdir to $workdir: $!\n");
162 163
}

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
if (defined($hashrow{'expt_locked'})) {
    $val = $hashrow{'expt_locked'};
    
    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");
}

#
# Disallow batch experiment swaps for now.
#
if ($isbatchexpt) {
    die("*** $0:\n".
	"    Batch experiments cannot be swapped yet!");
}

#
# Okay, check state. We do not allow swapping to start when the
# 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!");
}
203 204 205 206
if ($inout eq "restart" && $estate ne EXPTSTATE_ACTIVE) {
    die("*** $0:\n".
	"    It appears that experiment $pid/$eid is not active!");
}
207 208 209 210 211 212 213 214 215 216 217 218 219 220

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

221 222 223 224 225 226 227 228 229 230
if ($inout eq "in") {
    $action = "swapped in";
}
if ($inout eq "out") {
    $action = "swapped out";
}
if ($inout eq "restart") {
    $action = "restarted";
}

231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
#
# 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) {
250
    $logname = TBExptCreateLogFile($pid, $eid, "swapexp");
251
    TBExptSetLogFile($pid, $eid, $logname);
252
    TBExptOpenLogFile($pid, $eid);
253 254 255 256 257
    
    if (TBBackGround($logname)) {
	#
	# Parent exits normally
	#
258 259
	print "Experiment $pid/$eid is now being $action.\n".
	    "You will be notified via email when the this is done.\n";
260 261 262 263
	exit(0);
    }
}

264 265 266
#
# Remove old report file since its contents are going to be invalid.
#
267
if ($inout ne "restart" && -e $repfile) {
268 269 270
    unlink("$repfile");
}

271 272 273 274
#
# Sanity check states in case someone changes something.
#
if ($inout eq "out") {
Chad Barb's avatar
 
Chad Barb committed
275 276 277
    print STDOUT "Running 'tbswap out' with arguments: $pid $eid\n";
    if (system("$tbdir/tbswap out $pid $eid") != 0) {
	fatal("tbswap out failed!\n");
278 279 280 281 282 283 284
    }
    
    $estate = ExpState($pid,$eid);
    if ($estate ne EXPTSTATE_SWAPPED) {
	fatal("Experiment is in the wrong state: $estate\n");
    }
}
285
elsif ($inout eq "in") {
Chad Barb's avatar
 
Chad Barb committed
286 287 288
    print STDOUT "Running 'tbswap in' with arguments: $pid $eid\n";
    if (system("$tbdir/tbswap in $pid $eid") != 0) {
	fatal("tbswap in failed!\n");
289 290 291 292 293 294
    }
    
    $estate = ExpState($pid,$eid);
    if ($estate ne EXPTSTATE_ACTIVE) {
	fatal("Experiment is in the wrong state: $estate\n");
    }
295

296
    system("$tbdir/tbreport -b $pid $eid 2>&1 > $repfile");
297
}
298 299 300 301 302 303
else {
    print STDOUT "Running tbrestart with arguments: $pid $eid\n";
    if (system("$tbdir/tbrestart $pid $eid") != 0) {
	fatal("tbrestart failed!\n");
    }
}
304

305 306 307 308 309 310 311 312 313 314
#
# 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.
#
315
system("cp -Rfp $workdir/ $userdir/tbdata/");
316

317 318
#
# Must unlock before exit.
319 320
#
TBUnLockExp($pid, $eid);
321

322
print "Done!\n";
323 324 325 326 327 328 329 330

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

331 332 333 334 335 336 337
#
# Clear the log file so the web page stops spewing. 
#
if (defined($logname)) {
    TBExptCloseLogFile($pid, $eid);
}

338 339 340 341
#
# Send email notification to user.
#
my $message =
342 343 344
    "Experiment `$eid' in project `$pid' has been $action.\n\n" .
    "Appended below is the output. If you have any questions or comments,\n" .
    "please include the output in your message to $TBOPS\n";
345 346

SENDMAIL("$user_name <$user_email>",
347
	 "Experiment $pid/$eid $action",
348 349 350 351
	 $message,
	 "$user_name <$user_email>",
	 "Cc:  $expt_head_name <$expt_head_email>\n".
	 "Bcc: $TBLOGS",
352
	 (($inout eq "restart") ? ($logname) : ($repfile, $logname)));
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367

exit 0;

sub fatal($)
{
    my($mesg) = $_[0];
    
    print STDOUT $mesg;

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

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

371 372 373 374
    #
    # In batch mode, exit without sending the email. 
    #
    if ($batch) {
375
	TBUnLockExp($pid, $eid);
376 377 378
	exit(-1);
    }

379 380 381 382 383 384 385
    #
    # Clear the log file so the web page stops spewing. 
    #
    if (defined($logname)) {
	TBExptCloseLogFile($pid, $eid);
    }

386 387 388 389
    #
    # Send a message to the testbed list. Append the logfile.
    #
    SENDMAIL("$user_name <$user_email>",
390
	     "Swap ${inout} Failure: $pid/$eid",
391 392 393
	     $mesg,
	     "$user_name <$user_email>",
	     "Cc:  $expt_head_name <$expt_head_email>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
394
	     "Cc:  $TBOPS",
395 396 397 398 399
	     ($logname));

    exit(-1);
}