vnode_setup.in 16.8 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-2009 University of Utah and the Flux Group.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
6 7
# All rights reserved.
#
8 9 10 11 12 13 14 15 16 17 18 19 20
use English;
use Getopt::Std;

#
# Set up the vnode state on a virtual (multiplexed) node.
#
# XXX - This script should only be run from os_setup!
#
# The output is all jumbled together since the updates are issued in parallel.
# Might be a pain when debugging. 
# 
sub usage()
{
21
    print STDOUT "Usage: vnode_setup [-m] [-q] [-f] [-k] [-j] [-p] [-n <numbatch>] [-w <wait_time>] <pid> <eid> [node ...]\n";
22 23
    exit(-1);
}
24
my  $optlist = "fdkjpn:w:mq";
25 26 27 28 29 30 31 32 33 34

#
# We don't want to run this script unless its the real version.
# That is, it must be setuid root. 
#
if ($EUID != 0) {
    die("*** $0:\n".
	"    Must be root! Maybe its a development version?\n");
}

35 36 37 38 39 40 41
#
# Configure variables
#
my $TB		= "@prefix@";
my $TESTMODE    = @TESTMODE@;
my $TBOPS       = "@TBOPSEMAIL@";
my $TBLOGS      = "@TBLOGSEMAIL@";
42
my $CLIENT_BIN  = "@CLIENT_BINDIR@";
43
my $PGENISUPPORT= @PROTOGENI_SUPPORT@;
44

45
my $SAVEUID     = $UID;
46 47 48 49 50
my $ssh		= "$TB/bin/sshtb -n";
my $debug       = 0;
my $force       = 0;
my $failed      = 0;
my $killmode    = 0;
51
my $jailonly    = 0;
52 53
my $sendemail   = 0;
my $quiet       = 0;
54
my $plabonly    = 0;
Kirk Webb's avatar
Kirk Webb committed
55
my $numbatch    = 10;
56
my $childwait   = 3000;
57 58 59 60 61 62 63 64
my $dbuid;

#
# Load the Testbed support stuff. 
#
use lib "@prefix@/lib";
use libdb;
use libtestbed;
65 66 67
use libtblog;
use Experiment;
use Node;
68
if ($PGENISUPPORT) {
69
    require libGeni;
70
}
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86

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

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

#
# Parse command arguments. Once we return from getopts, all that should be
# left are the required arguments.
#
%options = ();
if (! getopts($optlist, \%options)) {
    usage();
}
87
if (@ARGV < 2) {
88 89 90 91 92
    usage();
}
if (defined($options{"f"})) {
    $force = 1;
}
93 94 95 96 97 98
if (defined($options{"m"})) {
    $sendemail = 1;
}
if (defined($options{"q"})) {
    $quiet = 1;
}
99 100 101 102 103 104
if (defined($options{"d"})) {
    $debug = 1;
}
if (defined($options{"k"})) {
    $killmode = 1;
}
105 106 107 108 109 110
if (defined($options{"j"})) {
    $jailonly = 1;
}
if (defined($options{"p"})) {
    $plabonly = 1;
}
Kirk Webb's avatar
Kirk Webb committed
111 112 113 114 115 116 117 118
if (defined($options{"n"})) {
    if ($options{"n"} =~ /^(\d+)$/) {
        $numbatch = $1;
    }
    else {
        die ("*** Bad data in numbatch: $options{'n'}");
    }
}
Kirk Webb's avatar
Kirk Webb committed
119 120 121 122 123 124 125 126
if (defined($options{"w"})) {
    if ($options{"w"} =~ /^(\d+)$/) {
        $childwait = $1;
    }
    else {
        die ("*** Bad data in wait_time: $options{'w'}");
    }
}
Kirk Webb's avatar
Kirk Webb committed
127

128 129
my $pid   = shift(@ARGV);
my $eid   = shift(@ARGV);
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146

#
# Untaint the arguments.
#
if ($pid =~ /^([-\@\w]+)$/) {
    $pid = $1;
}
else {
    die("*** Bad data in pid: $pid\n");
}	
if ($eid =~ /^([-\@\w]+)$/) {
    $eid = $1;
}
else {
    die("*** Bad data in eid: $eid\n");
}

147
if ($plabonly && $jailonly) {
148 149 150 151 152 153 154 155 156 157 158 159 160
    tbdie("*** '-j' and '-p' are mutually exclusive.");
}

#
# Verify user and get his DB uid and other info for later.
#
my $this_user = User->ThisUser();
if (!defined($this_user) && $UID) {
    tbdie("You ($UID) do not exist!");
}
my $experiment = Experiment->Lookup($pid, $eid);
if (!defined($experiment)) {
    tbdie("Could not locate object for experiment $pid/$eid");
161 162
}

163
#
164 165
# Verify permission to muck with this experiment. Note that this script
# is run as root from the plab monitor daemon.
166
#
167 168 169
if (defined($this_user) && !$this_user->IsAdmin() &&
    !$experiment->AccessCheck($this_user, TB_EXPT_DESTROY)) {
    tbdie("You do not have permission to mess with $pid/$eid!");
170 171 172
}

#
173
# Get the list of nodes in this experiment.
174
#
175
my @nodes = $experiment->NodeList(1, 1);
176
if (! @nodes) {
177
    tbwarn("No allocated nodes in experiment $pid/$eid.");
178
    exit(0);
179
}
180 181

# Nodes on the command line. Operate only on this set.
182 183 184 185 186 187 188 189 190 191 192 193 194 195
if (@ARGV) {
    my %fulllist = ();

    # Temporary hash list for searching.
    foreach my $node ( @nodes ) {
	$fulllist{$node} = 1;
    }
    @nodes = ();

    foreach my $node ( @ARGV ) {
	if ($node =~ /^([-\@\w]+)$/) {
	    $node = $1;

	    if (!defined($fulllist{$node})) {
196
		tbdie("Node $node is not allocated to $pid/$eid!");
197 198 199
	    }
	}
	else {
200
	    tbdie("Bad node name: $node.");
201 202 203 204
	}
	push(@nodes, $node);
    }
}
205
my $exptstate = $experiment->state();
206 207 208

# Just the vnodes mam.
foreach my $node (@nodes) {
209
    my $mode = ($killmode ? "teardown" : "setup");
210 211 212 213
    
    my $nodeobj = Node->Lookup($node);
    if (!defined($nodeobj)) {
	tbdie("Could not map $node to its object");
214
    }
215 216 217 218 219 220
    my $jailed     = $nodeobj->jailflag();
    my $plab       = $nodeobj->isplabdslice();
    my $remote     = $nodeobj->isremotenode();
    my $pnode      = $nodeobj->phys_nodeid();
    my $allocstate = $nodeobj->allocstate();
    my $geninode   = $nodeobj->isfednode();
221
    my $shared     = defined($nodeobj->sharing_mode());
222 223 224
    next
	if (!$nodeobj->isvirtnode());

225
    if (($plabonly || $jailonly) and 
226
        !(($plabonly && $plab) || ($jailonly && (($jailed || $remote) 
227
						 && !($plab || $geninode))))) {
228 229
        next;
    }
230 231
    if (!defined($pnode)) {
	tbdie("No physical node for $node!");
232
    }
233

234 235 236
    #
    # On remote nodes, or when forcemode is on, always do the deed.
    # Otherwise, look at experiment state.
237 238
    #
    if (!$force) {
239 240 241 242
	if ($exptstate eq EXPTSTATE_SWAPPING) {
	    #
	    # When swapping, local vnodes go down with the physnode.
	    #
243
	    if (! ($remote || $shared)) {
244 245 246 247
		print "$node will $mode with local node $pnode.\n";
		next;
	    }
	    elsif ($allocstate eq TBDB_ALLOCSTATE_DOWN) {
248 249 250 251 252 253 254
		if (!$plab) {
		    print "$node failed to boot; skipping $mode.\n";
		    next;
		}
		# Plab nodes need to be cleaned up.
		print "$node failed to boot; changing to cleanup.\n";
		$mode = "cleanup";
255
	    }
256
	}
257 258
	elsif ($exptstate eq EXPTSTATE_ACTIVATING ||
	       $exptstate eq EXPTSTATE_MODIFY_RESWAP) {
259
	    #
260 261 262 263 264 265 266 267 268 269 270
	    # The allocstate determines if the vnode actually needs to
	    # be setup or torndown. Note that a failed experiment will
	    # cause a bunch of vnodes to be torndown, while in the
	    # ACTIVATING state. See os_setup and assign_wrapper; the
	    # idea is to avoid doing setup/teardown up vnodes on
	    # machines that are rebooting anyway, or that failed.
	    # Complicated by modify which could add/subtract a vnode on
	    # an existing machine, but not reboot the machine. Note that
	    # free (now unused) vnodes will land in RES_TEARDOWN. It is
	    # assumed that these booted okay, and need to be torndown,
	    # even though they are not RES_READY.
271
	    #
272
	    if (! ($remote || $shared)) {
273 274
		if ($killmode) {
		    if ($allocstate eq TBDB_ALLOCSTATE_DOWN) {
275 276 277 278
			print "$node failed to boot; skipping $mode.\n";
			next;
		    }
		    elsif ($allocstate eq TBDB_ALLOCSTATE_RES_INIT_CLEAN()) {
279 280 281
			print "$node never booted; skipping $mode.\n";
			next;
		    }
282 283 284 285
		    elsif ($allocstate eq TBDB_ALLOCSTATE_RES_READY()) {
			print "$node will $mode with local node $pnode.\n";
			next;
		    }
286 287
		}
		elsif ($allocstate eq TBDB_ALLOCSTATE_RES_READY()) {
288
		    print "$node is already setting up on local node $pnode\n";
289 290 291
		    next;
		}
	    }
292 293
	    else {
		if ($killmode) {
294 295 296
		    if ($allocstate eq TBDB_ALLOCSTATE_DEAD) {
			# plab only. See below.
			print "$node failed to initialize; skipping $mode.\n";
297 298
			next;
		    }
299 300 301 302 303 304 305 306 307
		    elsif ($allocstate eq TBDB_ALLOCSTATE_DOWN) {
			if (!$plab) {
			    print "$node failed to boot; skipping $mode.\n";
			    next;
			}
			# Plab nodes need to be cleaned up.
			print "$node failed to boot; changing to cleanup.\n";
			$mode = "cleanup";
		    }
308 309 310 311
		    elsif ($allocstate eq TBDB_ALLOCSTATE_RES_INIT_CLEAN()) {
			print "$node never booted; skipping $mode.\n";
			next;
		    }
312
		}
313
		elsif ($allocstate eq TBDB_ALLOCSTATE_RES_READY()) {
314
		    print "$node is already set up on $pnode\n";
315 316
		    next;
		}
317
		elsif ($allocstate eq TBDB_ALLOCSTATE_RES_INIT_DIRTY()) {
318
		    print "$node needs a reboot on $pnode\n";
319 320
		    $mode = "reboot";
		}
321
		elsif ($allocstate eq TBDB_ALLOCSTATE_RES_RECONFIG()) {
322
		    print "$node needs a reconfig on $pnode\n";
323 324 325 326 327
		    # We do not actually reconfig virtual nodes; just
		    # reboot them. Might reconfig someday, in which case
		    # this would move up into os_setup.
		    $mode = "reboot";
		}
328 329 330 331 332 333 334 335 336 337 338 339 340
		elsif ($plab && $allocstate eq TBDB_ALLOCSTATE_RES_INIT_CLEAN()) {
		    # This is a special case.  If we reuse one of the plab 
		    # nodes, but use a different vname in the topo, there will
		    # be an entry in the database and a slice will be reserved
		    # because it's never torn down.  However, we need to 
		    # skip plabnode alloc and go straight to vnodesetup.
		    #
		    # BUT, we only can do this if the sliver entry is already
		    # in the database!
		    # Also note that this could eventually cause problems
		    # if there is a mistaken sliver entry in the DB.

		    $res = DBQueryFatal(
341 342 343 344 345 346 347
			"select ps.slicename,psn.node_id".
			" from plab_slices as ps" . 
			" left join plab_slice_nodes as psn" . 
			"   on (ps.slicename=psn.slicename" . 
			"       and ps.plc_idx=psn.plc_idx)" . 
			" where ps.pid='$pid' and ps.eid='$eid'" . 
                        "   and psn.node_id='$node'");
348 349 350 351 352 353 354
		    if ($res->numrows == 1) {
			# node exists; change mode to resetup
			$mode = "resetup";
			print "Doing a resetup on '$node'\n";
		    }
		    
		}
355 356
	    }
	}
357 358 359 360 361 362
    }

    #
    # When setting up a vnode, force its event state into SHUTDOWN since
    # no telling what its initial state is. 
    # 
Kirk Webb's avatar
Kirk Webb committed
363 364
    # XXX: Don't we always want to set this?
    #
365
    if ($mode eq "teardown" || $mode eq "reboot") {
366
	$nodeobj->SetEventState(TBDB_NODESTATE_SHUTDOWN);
367
    }
368 369

    #
370 371
    # Put this into the list of calls we have to make in the next loop
    #
372
    push @vnodes, [$nodeobj, $mode];
373 374 375

}

376

377 378
my $children = 0;
my %child_vnodes = ();
379 380 381
print STDOUT "vnode_setup running at parallelization: $numbatch ". 
    "wait_time: $childwait\n"
    if (!$quiet);
382 383
while (1) {

Kirk Webb's avatar
Kirk Webb committed
384
    # Space out the invocation of child processes a little.
Kirk Webb's avatar
Kirk Webb committed
385
    sleep(1);
Kirk Webb's avatar
Kirk Webb committed
386

387 388 389 390 391 392 393
    #
    # We're done when we've hit the last vnode, and we've outlived all of our
    # children
    #
    if ((!@vnodes) && ($children == 0)) {
	last;
    }
394

395 396 397
    #
    # There are more free slots
    #
Kirk Webb's avatar
Kirk Webb committed
398
    if (($children < $numbatch) && @vnodes) {
399 400 401 402
	#
	# Look for a vnode that is not on a pnode we're already working on
	# 
	# XXX - do this!
403 404 405 406 407 408 409 410

	my ($nodeobj, $mode) = @{pop @vnodes};
	my $vnode    = $nodeobj->node_id();
	my $jailed   = $nodeobj->jailflag();
	my $plab     = $nodeobj->isplabdslice();
	my $remote   = $nodeobj->isremotenode();
	my $pnode    = $nodeobj->phys_nodeid();
	my $geni     = $nodeobj->isfednode();
411
    
412 413
	print STDOUT "Doing $mode of vnode $vnode on $pnode ...\n"
	    if (!$quiet);
414 415 416 417 418 419 420 421 422 423 424 425

	#
	# Run an ssh command in a child process, protected by an alarm to
	# ensure that the ssh is not hung up forever if the machine is in some
	# funky state.
	# 
	my $syspid = fork();

	if ($syspid) {
	    #
	    # Just keep track of it, we'll wait for it finish down below
	    #
426
	    $child_vnodes{$syspid} = [$nodeobj, $mode, time()];
427 428
	    $children++;
	} else {
429 430
	    TBdbfork();	# So we get the event system fork too ...
	    
431
            my $exval = 0;
432 433 434
	    # Must change our real UID to root so that ssh will work.
	    $UID = 0;

435
	    if ($mode eq "setup" && ($plab || !$jailed || $geni)) {
Kirk Webb's avatar
Kirk Webb committed
436 437 438
                # Make sure vnode is in the proper state before trying to
                # bring it up.
                # XXX: do this for all vnodes (see above)?
439 440 441 442
                $nodeobj->SetEventState(TBDB_NODESTATE_SHUTDOWN);
		if ($geni) {
		    $UID  = $SAVEUID;
		    $EUID = $UID;
443
#		    $exval = GeniEmulab->StartSlivers($experiment, [$nodeobj]);
444 445
		}
		elsif ($plab) {
446 447 448 449 450 451 452 453 454 455 456 457 458 459
		    if (TBForkCmd("$TB/sbin/plabnode ". 
				  ($force ? "-f" : "").
				  " alloc $pid $eid $vnode", 1)) {
			print STDERR "*** $0:\n" .
			    "    Plab node allocation failed\n";
			# Should check DB state instead.
			exit(99);
		    }
		}
		else {
		    if (TBForkCmd("$ssh -host $pnode $CLIENT_BIN/vnodesetup ".
				  " -i $vnode", 1)) {
			exit(99);
		    }
460
		}
461
                # Make sure the system knows we now have state on the node!
462
		$nodeobj->SetAllocState(TBDB_ALLOCSTATE_RES_INIT_DIRTY);
463
	    }
464
	    
465 466 467 468
	    if ($geni && ($mode eq "teardown" || $mode eq "cleanup")) {
		$nodeobj->SetEventState(TBDB_NODESTATE_SHUTDOWN);
		$UID  = $SAVEUID;
		$EUID = $UID;
469
#		$exval = GeniEmulab->DestroySlivers($experiment, [ $nodeobj ]);
470 471
	    }
	    elsif (!($plab && ($mode eq "cleanup" || $mode eq "teardown"))
472
		&& !($mode eq "setup" && $remote && !$plab)) {
473 474 475 476
		# Cleanup is used only on plab nodes.
		# Don't try to teardown plab vnodes; it's just asking for
		# trouble as the shutdown may hang or take too long.  It's
		# best to simply try and free the vserver below.
477 478
		my $args = (($mode eq "teardown") ? "-k " :
			    ($mode eq "reboot" ? "-r " : " "));
479
		$args   .= ($jailed   ? "-jVt " : ($plab ? "-p " : "-i "));
480
		$args   .= "$vnode ";
481
		
482 483 484 485 486 487
		# If it's a plab node, we must ssh to the vnode, not pnode.
		my $pnodeOrVnode = $pnode;
		if ($plab) {
		    $pnodeOrVnode = $vnode;
		}
		$exval = TBForkCmd("$ssh -host $pnodeOrVnode ".
488 489 490 491 492
                                 "$CLIENT_BIN/vnodesetup $args",1);
            }

            # Free the plab node lease if necessary.
            if ($plab && ($mode eq "teardown" || $mode eq "cleanup")) {
493
		$nodeobj->SetEventState(TBDB_NODESTATE_SHUTDOWN);
494 495 496 497 498
                exec("$TB/sbin/plabnode free $pid $eid $vnode");
                die("*** $0:\n".
                    "    exec failed!\n");
            }
	    exit($exval);
499 500 501 502 503 504 505 506 507 508 509
	}
    } else {
	#
	# We have too many of the little rugrats, wait for one to die
	#

	#
	# Set up a timer - we want to kill processes after they hit 120 seconds
	# old (not much of a life, is it?), so we find the first one marked for
	# death.
	#
510
	my $oldest;
511
	my $oldestpid = 0;
Kirk Webb's avatar
Kirk Webb committed
512
        my $oldestvnode = "";
513
	while (my ($pid, $aref) = each %child_vnodes) {
514 515
	    my ($nodeobj, $mode, $birthtime) = @$aref;
	    my $vnode = $nodeobj->node_id();
516
	    if ((!$oldestpid) || ($birthtime < $oldest)) {
517 518
		$oldest = $birthtime;
		$oldestpid = $pid;
Kirk Webb's avatar
Kirk Webb committed
519
                $oldestvnode = $vnode;
520 521 522 523 524 525 526 527 528 529 530
	    }
	}

	#
	# Sanity check
	#
	if (!$oldest) {
	    die "*** $0\n".
	    	"Uh oh, I have no children left, something is wrong!\n";
	}

531
	#
Kirk Webb's avatar
Kirk Webb committed
532
	# If the oldest has already expired, just kill it off right now, and go
533 534 535
	# back around the loop
	#
	my $now = time();
Kirk Webb's avatar
Kirk Webb committed
536
	my $waittime = ($oldest + $childwait) - time();
537

538
	#
Kirk Webb's avatar
Kirk Webb committed
539
	# Kill off the oldest if it gets too old while we're waiting.
540
	#
Kirk Webb's avatar
Kirk Webb committed
541 542
        my $childpid = -1;
        my $exitstatus = -1;
543

Kirk Webb's avatar
Kirk Webb committed
544 545 546 547
        eval {
            local $SIG{ALRM} = sub { die "alarm clock" };

            if ($waittime <= 0) {
548 549
                print STDERR
		    "*** $0: timeout waiting for vnode: $oldestvnode\n";
Kirk Webb's avatar
Kirk Webb committed
550 551 552 553
                kill("TERM",$oldestpid);
            } else {
                alarm($waittime);
            }
554

Kirk Webb's avatar
Kirk Webb committed
555 556 557 558 559 560 561
            $childpid = wait();
            alarm 0;
            $exitstatus = $?;
        };
        if ($@) {
            die unless $@ =~ /alarm clock/;
            next;
562 563
        }

564 565 566 567 568 569 570 571 572 573 574 575 576
	#
	# Another sanity check
	#
	if ($childpid < 0) {
	    die "*** $0\n".
	    	"wait() returned <0, something is wrong!\n";
	}

	#
	# Look up to see what vnode, etc. this was associated with - if we
	# don't know about this child, ignore it
	#
	my $aref = $child_vnodes{$childpid};
577 578 579 580
	next unless @$aref;	
	my ($nodeobj, $mode, $birthtime) = @$aref;
	my $vnode = $nodeobj->node_id();
	my $pnode = $nodeobj->phys_nodeid();	
581 582 583
	$children--;
	delete $child_vnodes{$childpid};

584
	#
585
	# Look for setup failure, reported back through ssh.
586
	# 
587
	if ($exitstatus) {
588 589
	    print STDERR "vnode $vnode $mode on $pnode returned $?.\n"
		if $debug;
590

591
	    if ($exitstatus == 256) {
592
		print STDERR "$vnode is not running sshd.\n" if $debug;
593 594
	    }
	    elsif ($exitstatus == 15) {
595
		print STDERR "$vnode is wedged.\n" if $debug;
596
	    }
597 598 599
	    elsif ($exitstatus >> 8 == 99) {
		print STDERR "$vnode did not allocate properly.\n" if $debug;
	    }
600

601 602
	    push @failed_nodes, [$vnode, $pnode, $mode, $exitstatus];
	    
603 604
	    warn("*** $0:\n".
		 "    Virtual node $vnode $mode failure!\n");
605
	}
606

607
	if ($nodeobj->isplabdslice()) {
608 609 610 611 612 613 614 615
	    #
	    # If the node was in the setup process, then mark its allocstate
	    # as down so os_setup knows not to bother waiting for it. DEAD
	    # is a temp state, different then DOWN. It indicates the node
	    # was never instantiated (important distinction for plab). 
	    #
	    if ($exitstatus &&
		(($mode eq "setup") || ($mode eq "reboot"))) {
616
		$nodeobj->SetAllocState(TBDB_ALLOCSTATE_DEAD());
617 618
	    }
	}
619 620 621
    }
}

622 623 624 625
#
# In force node, do not bother with this other stuff. 
#
exit(scalar(@failed_nodes))
626
    if ($force && !$sendemail);
627

628 629 630 631 632 633
#
# Send mail to testbed-ops about failed nodes
#
if (@failed_nodes) { 
    my $failed_lines = join("\n",map { join("\t",@{$_}) } @failed_nodes);
    SENDMAIL($TBOPS, "Virtual Node failure for $pid/$eid",
634 635 636
	     "The following virtual nodes failed: \n" .
	     "vnode\t\tpnode\tmode\texit status\n" .
	     $failed_lines);
637 638
}

639
if ($killmode) {
640 641
    print STDOUT "Vnode teardown finished.\n"
	if (!$quiet);
642 643
}
else {
644 645
    print STDOUT "Vnode setup initiated on all nodes ...\n"
	if (!$quiet);
646
}
647
exit(0);