template_swapout.in 9.63 KB
Newer Older
1 2 3
#!/usr/bin/perl -wT
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2006, 2007 University of Utah and the Flux Group.
5 6 7
# All rights reserved.
#
use English;
8
use strict;
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
use Getopt::Std;
use POSIX qw(isatty setsid);
use POSIX qw(strftime);
use Errno qw(EDQUOT);

#
# Terminate a template instance (okay, swap it out and remove it).
#
# 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. 
# 
sub usage()
{
    print(STDERR
	  "Usage: template_swapout [-q] [-w] -e <id> <guid/vers>\n".
	  "switches and arguments:\n".
	  "-w       - wait for template instance to be terminated\n".
	  "-q       - be less chatty\n".
	  "-e <id>  - The instance ID (aka eid)\n".
	  "<guid/vers> - GUID and version to swapin\n");
    exit(-1);
}
37
my $optlist	 = "qwaie:bf";
38 39
my %options      = ();
my $quiet        = 0;
40
my $force        = 0;
41
my $waitmode     = 0;
42
my $batchmode    = 0;	# Called from the batch daemon.
43 44 45 46 47 48 49 50 51 52 53 54 55
my $eid;
my $guid;
my $version;

#
# Configure variables
#
my $TB		= "@prefix@";
my $EVENTSYS	= @EVENTSYS@;
my $TBOPS	= "@TBOPSEMAIL@";
my $TBLOGS	= "@TBLOGSEMAIL@";
my $TBDOCBASE	= "@TBDOCBASE@";
my $TBBASE	= "@TBBASE@";
56
my $STAMPS      = @STAMPS@;
57 58

# Locals
59
my $pid;
60
my $logname;
61
my $logfile;
62
my $exptidx;
63 64
my $template;
my $instance;
65
my $neveractive = 0;
66 67 68 69 70 71
# For the END block below.
my $cleaning    = 0;
my $justexit    = 1;

# Programs we need
my $endexp      = "$TB/bin/endexp";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
72 73
my $swapexp     = "$TB/bin/swapexp";
my $endrun      = "$TB/bin/template_exprun";
74 75 76 77 78 79 80 81 82 83 84 85 86

# Protos
sub ParseArgs();
sub fatal($$);
sub sighandler($);

#
# Testbed Support libraries
#
use lib "@prefix@/lib";
use libdb;
use libtestbed;
use libtblog;
87
use Template;
88
use Experiment;
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112

# Be careful not to exit on transient error
$libdb::DBQUERY_MAXTRIES = 0;

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

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

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

#
113
# Verify user and get his DB uid and other info for later.
114
#
115 116 117
my $this_user = User->ThisUser();
if (! defined($this_user)) {
    tbdie("You ($UID) do not exist!");
118
}
119
my $user_uid   = $this_user->uid();
120 121 122 123 124 125 126 127 128 129 130 131 132 133

# Now parse arguments.
ParseArgs();

#
# In wait mode, block SIGINT until we spin off the background process.
#
if ($waitmode) {
    $SIG{QUIT} = 'IGNORE';
    $SIG{TERM} = 'IGNORE';
    $SIG{INT}  = 'IGNORE';
}

#
134
# Grab template info and do access check.
135
#
136
$template = Template->Lookup($guid, $version);
137

138 139
if (!defined($template)) {
    tbdie("Experiment template $guid/$version does not exist!");
140
}
141
if (! $template->AccessCheck($this_user, TB_EXPT_DESTROY)) {
142 143 144
    tberror("You do not have permission to terminate template instance ".
	    "$eid in template $guid/$version");
    exit(1);
145
}
146
$pid = $template->pid();
147

148
#
149 150 151
# Now we need to find the experiment index so we can find the instance.
# This is wrong, but necessary cause of how templates are layered over
# the existing experiment structure.
152
#
153 154
if (! TBExptIDX($template->pid(), $eid, \$exptidx)) {
    fatal(-1, "Could not get experiment index for $pid,$eid!");
155
}
156 157 158 159 160 161

$instance = Template::Instance->LookupByExptidx($exptidx);
if (!defined($instance)) {
    fatal(-1, "Could not get instance record for experiment $exptidx!");
}

162 163 164 165 166 167
# Grab the experiment record for below.
my $experiment = Experiment->Lookup($pid, $eid);
if (!defined($experiment)) {
    fatal(-1, "Experiment $pid/$eid object could not be found!");
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
168
# Check for cancel and dequeue.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
169 170
if (! $batchmode) {
    if ($experiment->state() eq EXPTSTATE_ACTIVATING) {
171
	system("$swapexp -x -s out $pid $eid");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
172 173
	exit($? >> 8);
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
174 175 176 177 178 179
    elsif ($experiment->batchmode() &&
	   $experiment->state() eq EXPTSTATE_QUEUED) {
	# User wants to dequeue a batch experiment that is waiting to go.
	system("$swapexp -x -s pause $pid $eid");
	exit($? >> 8);
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
180 181
}

182 183 184 185 186 187
#
# At this point, we need to force a cleanup no matter how we exit.
# See the END block below.
#
$justexit = 0;

188 189 190 191
if ($STAMPS) {
    $instance->Stamp("template_swapout", "starting");
}

192 193 194 195 196 197 198 199
#
# Catch this so we can clean up.
#
$SIG{TERM} = \&sighandler;

#
# If not in batch mode, go into the background. Parent exits.
#
200
if (! $batchmode) {
201 202
    # Cleanup
    $experiment->CleanLogFiles() == 0
Leigh B. Stoller's avatar
Leigh B. Stoller committed
203
	or fatal(-1, "Could not clean up logfiles!");
204
    
205 206 207 208 209 210 211 212 213
    $logfile = $experiment->CreateLogFile("swapout");
    if (!defined($logfile)) {
	fatal(-1, "Could not create logfile!");
    }
    $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();
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230

    if (my $childpid = TBBackGround($logname)) {
	#
	# Parent exits normally, unless in waitmode. We have to set
	# justexit to make sure the END block below does not run.
	#
	$justexit = 1;

	if (!$waitmode) {
	    print("Template instance is now being terminated.\n".
		  "You will be notified via email when the this is done.\n")
		if (! $quiet);
	    exit(0);
	}
	print("Waiting for template instance to terminate.\n")
	    if (! $quiet);
	    
231
	if (-f STDIN && !$quiet) {
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
	    print("You may type ^C at anytime; you will be notified via email.".
		  "\n".
		  "You will not actually interrupt the experiment itself.\n");
	}
	
	# 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{INT}  = 'DEFAULT';
	$SIG{QUIT} = 'DEFAULT';

	#
	# Wait until child exits or until user gets bored and types ^C.
	#
	waitpid($childpid, 0);
	
	print("Done. Exited with status: $?\n")
	    if (! $quiet);
	exit($? >> 8);
    }
    TBdbfork();
}
259 260 261
# Give the web page a chance to start looking at the log file before
# the entire experiment is gone.
sleep(1);
262 263 264 265 266 267 268 269 270

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
271
#
272
# Stop the current run, but only if the instance was actually instantiated.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
273
#
274 275
if (defined($instance->start_time())) {
    my $opt = ($force ? "-i" : "");
276

277 278 279 280
    if ($STAMPS) {
	$instance->Stamp("template_swapout", "stoprun starting");
    }

281 282
    system("$endrun $opt -a stop -f -e $eid $guid/$version") == 0
	or fatal(-1, "Could not stop the current run!");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
283

284 285 286 287
    if ($STAMPS) {
	$instance->Stamp("template_swapout", "stoprun done");
    }

288 289 290 291
    # This sets the stop time.
    $instance->Stop() == 0
	or fatal(-1, "Could not stop experiment instance!");
}
292

293 294 295 296
if ($STAMPS) {
    $instance->Stamp("template_swapout", "endexp starting");
}

297
#
298
# Now do the swapout (or just the termination).
299 300 301
#
# Note special -x option.
#
302 303 304
my @arguments = ($endexp, "-x", "-q");
push(@arguments, "-b")
    if ($batchmode);
305
push(@arguments, ($exptidx));
306 307 308 309 310 311

# Now invoke.
system(@arguments);
fatal($? >> 8, "Could not terminate template instance")
    if ($?);

312 313 314 315
if ($STAMPS) {
    $instance->Stamp("template_swapout", "endexp done");
}

316 317 318 319 320 321 322 323 324 325 326
if (defined($instance->start_time())) {
    # Reminder; instance records are not deleted.
    $instance->Finalize() == 0
	or fatal(-1, "Could not finalize experiment instance!");
}
else {
    # Okay, we *do* delete if the instance was never instantiated.
    print("Deleting instance since it was never swapped in!\n");
    $instance->Delete() == 0
	or fatal(-1, "Could not delete instance!");
}
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380

exit(0);

#
# Parse command arguments. Once we return from getopts, all that are
# left are the required arguments.
#
sub ParseArgs()
{
    if (! getopts($optlist, \%options)) {
	usage();
    }

    if (@ARGV != 1) {
	usage();
    }
    #
    # Pick up guid/version first and untaint.
    #
    my $tmp = shift(@ARGV);

    if ($tmp =~ /^([\w]*)\/([\d]*)$/) {
	$guid = $1;
	$version = $2;
    }
    else {
	tbdie("Bad data in argument: $tmp");
    }

    if (defined($options{"e"})) {
	$eid = $options{"e"};

	if ($eid =~ /^([-\w]+)$/) {
	    $eid = $1;
	}
	else {
	    tbdie("Bad data in argument: $eid.");
	}
	if (! TBcheck_dbslot($eid, "experiments", "eid",
			   TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
	    tbdie("Improper experiment name (id)!");
	}
    }
    else {
	tberror("Must provide an instance ID!");
	exit(1);
    }

    if (defined($options{"q"})) {
	$quiet = 1;
    }
    if (defined($options{"w"})) {
	$waitmode = 1;
    }
381 382 383
    if (defined($options{"b"})) {
	$batchmode = 1;
    }
384 385 386
    if (defined($options{"f"})) {
	$force = 1;
    }
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
}

#
# Cleanup the mess.
#
sub cleanup()
{
}

sub fatal($$)
{
    my ($errorstat, $msg) = @_;
    
    tberror $msg;
    tbinfo "Cleaning up and exiting with status $errorstat ...";

    #
    # This exit will drop into the END block below.
    # 
    exit($errorstat);
}

sub sighandler ($) {
    my ($signame) = @_;
    
    $SIG{TERM} = 'IGNORE';
    my $pgrp = getpgrp(0);
    kill('TERM', -$pgrp);
    sleep(1);
    fatal(-1, "Caught SIG${signame}!");
}

END {
    # Normal exit, nothing to do.
    if (!$? || $justexit) {
	return;
    }
    my $saved_exitcode = $?;
    
    if ($cleaning) {
	#
	# We are screwed; a recursive error. Someone will have to clean
	# up by hand. 
	#
431 432
	SENDMAIL($TBOPS, 
		 "Instance Termination Failure: $pid/$eid",
433 434 435 436 437 438 439 440 441
		 "Recursive error in cleanup! This is very bad.");
	$? = $saved_exitcode;
	return;
    }
    $cleaning = 1;
    cleanup();
    $? = $saved_exitcode;
}