stated.in 9.59 KB
Newer Older
Robert Ricci's avatar
Robert Ricci committed
1
#!/usr/bin/perl -w
Leigh B. Stoller's avatar
Leigh B. Stoller committed
2 3 4 5 6 7
#
# EMULAB-COPYRIGHT
# Copyright (c) 2000-2002 University of Utah and the Flux Group.
# All rights reserved.
#

Robert Ricci's avatar
Robert Ricci committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
#
# stated - A daemon to monitor the states of nodes in the testbed. Recives
# state change notification through the event system, and writes the new
# state into the database.
#
# In the future, will watch for invalid state transitions, and watch for nodes
# that time out.
#
# Send it a HUP signal to get it to reload the timeout and transition
# information. Periodically reloads this information regardless, though.
#

#
# Configure variables
#
use lib '@prefix@/lib';
my $BOSSNODE = "@BOSSNODE@";
my $TBOPS = "@TBOPSEMAIL@";
26
my $TBDBNAME = "@TBDBNAME@";
Robert Ricci's avatar
Robert Ricci committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

$| = 1;

use event;
use libdb;
use libtestbed;
use Getopt::Std;
use strict;
use English;

#
# Number of iterations (roughly, seconds) after which we'll reload 
# information from the database. This is so we don't end up with information
# that's _too_ out of sync.
#
42
my $reload_time = 3600;
Robert Ricci's avatar
Robert Ricci committed
43 44 45 46 47 48 49

#
# Process command-line arguments
#

sub usage {
	print << "END";
50
Usage: $0 [-d] [-s server] [-p port] [-f] [-h]
Robert Ricci's avatar
Robert Ricci committed
51 52 53
-s server       Use specified server, instead of this site's bossnode
-p port	        Use specified port
-d              Turn on debugging output, and don't go into the background
54
-f              Stay in the foreground, rather than forking
Robert Ricci's avatar
Robert Ricci committed
55 56 57 58 59
-h              This message
END
}

my %opt = ();
60
getopts("ds:p:hf",\%opt);
Robert Ricci's avatar
Robert Ricci committed
61 62 63 64

if ($opt{h}) { exit &usage; }
if (@ARGV) { exit &usage; }

65
my ($server,$port,$debug,$nofork);
Robert Ricci's avatar
Robert Ricci committed
66 67 68
if ($opt{s}) { $server = $opt{s}; } else { $server = $BOSSNODE; }
if ($opt{p}) { $port = $opt{p}; }
if ($opt{d}) { $debug = 1; } else { $debug = 0; }
69
if ($opt{f}) { $nofork = 1; } else { $nofork = 0; }
Robert Ricci's avatar
Robert Ricci committed
70 71 72 73

#
# Background
#
74 75 76
my $logname = "@prefix@/log/stated.log";
if (!$debug && !$nofork) {
	if (TBBackGround($logname)) {
Robert Ricci's avatar
Robert Ricci committed
77 78
		exit(0);
	}
79 80 81 82 83 84 85 86
} else {
    if ($nofork) {
	#
	# Open our log file manually
	#
	open(STDERR, ">> $logname") or die("opening $logname for STDERR: $!");
	open(STDOUT, ">> $logname") or die("opening $logname for STDOUT: $!");
    }
Robert Ricci's avatar
Robert Ricci committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100
}

my $URL = "elvin://$server";
if ($port) { $URL .= ":$port"; }

#
# Connect to the event system, and subscribe the the events we want 
#
my $handle = event_register($URL,0);
if (!$handle) { die "Unable to register with event system\n"; }

my $tuple = address_tuple_alloc();
if (!$tuple) { die "Could not allocate an address tuple\n"; }

101 102 103 104 105 106
#
# Unfortunately, we can't subscribe to multiple objtypes - so, we subscribe
# to all events to $BOSSNODE, and throw away notificattions whose objtypes
# do not match the ones we care about.
#
%$tuple = ( host => $BOSSNODE );
Robert Ricci's avatar
Robert Ricci committed
107 108

if (!event_subscribe($handle,\&handleEvent,$tuple)) {
109
	die "Could not subscribe to events\n";
Robert Ricci's avatar
Robert Ricci committed
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
}

#
# Read in the pre-existing node states, and timeout and valid transition
# information from the database
#
my %nodes    = readStates();
my %timeouts = getTimeouts();
my %valid    = getValid();

#
# Gets set if a reload of state from the database should happen.
#
my $do_reload = 0;

#
# Make the daemon reload database state on a sighup - but I'm worried
# about what would happen if we tried to do this mid-loop. So, we'll
# just set a flag and do it when we're done with our current pass.
#
$SIG{HUP} = sub { print "Recieved a SIGHUP\n"; $do_reload = 1; };

print "stated starting up\n";

#
# Now, we just poll for events, and watch for 
#
my $iterations = 0;
while (1) {
	event_poll($handle);
	my $now = time();
	#
	# Look for nodes that have passed their timeout
	#
	while (my ($node, $value) = each %nodes) {
		my $state    = $value->{state};
146 147
		my $mode     = $value->{mode};
		my $time     = $value->{timestamp};
Robert Ricci's avatar
Robert Ricci committed
148 149
		my $notified = $value->{notified};
		my ($timeout,$action);
150 151 152
		if ($mode && $state && $timeouts{$mode} &&
				$timeouts{$mode}{$state}) {
			($timeout, $action) = @{$timeouts{$mode}{$state}};
Robert Ricci's avatar
Robert Ricci committed
153 154 155 156 157 158
		}
		if ((!$notified) && $time && $timeout &&
				(($time + $timeout) < $now)) {
			   #
			   # TODO: Need to actually do something!
			   #
159 160
			   notify("Node $node has timed out in state $state" .
			   	  ", mode $mode\n");
Robert Ricci's avatar
Robert Ricci committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
			   $value->{notified} = 1;
		}
	}

	if ($do_reload || ($iterations > $reload_time)) {
		reload();
		$do_reload = 0;
		$iterations = 0;
	}

	$iterations++;
	sleep(1);
}

#
# Read the current states of nodes from the database
#
178 179 180
sub readStates(;@) {
    	my %oldnodes = @_;

181 182 183 184 185 186 187
	#
	# Guard against undefined variable warnings
	#
	if (! defined(%oldnodes)) {
		%oldnodes = ();
	}

Robert Ricci's avatar
Robert Ricci committed
188 189
	debug("readStates called\n");
	my $result = DBQueryFatal("SELECT node_id, eventstate, " .
190 191
				  "state_timestamp, op_mode, " .
				  "op_mode_timestamp FROM nodes");
Robert Ricci's avatar
Robert Ricci committed
192 193

	my %nodes;
194 195
	while (my ($node_id, $state, $timestamp, $mode, $mode_timestamp)
			= $result->fetchrow()) {
196 197 198 199 200 201
	    	#
		# If there's an entry in oldnodes for this node, and it
		# hasn't changed state or time, use the old entry (so that
		# we don't lose information about which nodes we've already
		# notified the ops about, etc.)
		#
202 203 204
		if ($oldnodes{$node_id} && $state && $timestamp &&
		   ($oldnodes{$node_id}{state} eq $state) &&
		   ($oldnodes{$node_id}{timestamp} == $timestamp)) {
205 206
		       $nodes{$node_id} = $oldnodes{$node_id};
		} else { 
207 208 209 210
		    $nodes{$node_id}{state}          = $state;
		    $nodes{$node_id}{timestamp}      = $timestamp;
		    $nodes{$node_id}{mode}           = $mode;
		    $nodes{$node_id}{mode_timestamp} = $mode_timestamp;
211
		}
Robert Ricci's avatar
Robert Ricci committed
212 213 214 215 216 217 218 219 220
	}
	return %nodes;
}

#
# Read timeouts for various states from the database
#
sub getTimeouts() {
	debug("getTimeouts called\n");
221
	my $result = DBQueryFatal("SELECT op_mode, state, timeout, action " .
Robert Ricci's avatar
Robert Ricci committed
222 223 224
				  "FROM state_timeouts");

	my %timeouts;
225 226
	while (my ($op_mode, $state, $timeout, $action) = $result->fetchrow()) {
		$timeouts{$op_mode}{$state} = [ $timeout, $action ];
Robert Ricci's avatar
Robert Ricci committed
227 228 229 230 231 232 233 234 235
	}
	return %timeouts;
}

#
# Read the list of valid state transitions from the database
#
sub getValid() {
	debug("getValid called\n");
236
	my $result = DBQueryFatal("SELECT op_mode, state1, state2 " .
Robert Ricci's avatar
Robert Ricci committed
237 238 239
				  "FROM state_transitions");

	my %valid;
240 241
	while (my ($mode,$state1, $state2) = $result->fetchrow()) {
		$valid{$mode}{$state1}{$state2} = 1;
Robert Ricci's avatar
Robert Ricci committed
242 243 244 245 246 247 248 249 250
	}
	return %valid;
}

#
# Gets called for every event that we recieve
#
sub handleEvent($$$) {
	my ($handle,$notification,$data) = @_;
251
	my $objtype = event_notification_get_objtype($handle,$notification);
Robert Ricci's avatar
Robert Ricci committed
252 253 254
	my $objname = event_notification_get_objname($handle,$notification);
	my $eventtype = event_notification_get_eventtype($handle,$notification);

255 256
	print "Got an event: ($objtype,$objname,$eventtype)\n";

257 258 259 260 261 262 263 264
	#
	# Check to see if another instance is supposed to be handling this node
	#
	if (!checkDBRedirect($objname)) {
	    print "Got an event for node $objname, which isn't mine\n";
	    return;
	}

265 266
	SWITCH: for ($objtype) {

267 268 269 270 271
	    #
	    # Handle both the new TBNODEOPMODE and the old TBCONTROL events, 
	    # for backward compatibility.
	    #
	    (/TBNODESTATE/ || /TBCONTROL/) && do {
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
		stateTransition($objname,$eventtype);
		last;
	    };
	    (/TBNODEOPMODE/) && do {
		opModeTransition($objname,$eventtype);
		last;
	    };

	}

}

sub stateTransition($$) {

	my ($node,$newstate) = @_;
Robert Ricci's avatar
Robert Ricci committed
287 288

	# Check for invalid transitions
289 290 291 292
	my ($oldstate, $mode);
	if ($nodes{$node}) {
		$oldstate = $nodes{$node}{state};
		$mode = $nodes{$node}{mode};
Robert Ricci's avatar
Robert Ricci committed
293
	} else {
294 295 296 297 298 299 300 301 302 303 304
		#
		# Try reloading the cache once before we give up on this node
		#
		reload();
		if ($nodes{$node}) {
				$oldstate = $nodes{$node}{state};
				$mode = $nodes{$node}{mode};
		} else {
			notify("Got an event for a node ($node) I don't know ".
					"about\n");
		}
Robert Ricci's avatar
Robert Ricci committed
305
	}
306
	if ($oldstate && $mode && $valid{$mode} && $valid{$mode}{$oldstate} &&
307 308 309
			!$valid{$mode}{$oldstate}{$newstate}) {
		notify("Invalid transition for node $node from $oldstate " .
		       " to $newstate\n");
Robert Ricci's avatar
Robert Ricci committed
310 311 312
	}

	my $now = time();
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
	$nodes{$node}{state}     = $newstate;
	$nodes{$node}{timestamp} = $now;
	$nodes{$node}{notified}  = 0;

	DBQueryFatal("UPDATE nodes SET eventstate='$newstate', " .
		     "state_timestamp='$now' WHERE node_id='$node'");

}

sub opModeTransition($$) {

	my ($node,$newmode) = @_;

	print "opModeTransition: $node, $newmode\n";

	my $now = time();
	$nodes{$node}{mode}           = $newmode;
	$nodes{$node}{mode_timestamp} = $now;
	$nodes{$node}{notified}       = 0;
Robert Ricci's avatar
Robert Ricci committed
332

333 334
	DBQueryFatal("UPDATE nodes SET op_mode='$newmode', " .
		     "op_mode_timestamp='$now' WHERE node_id='$node'");
Robert Ricci's avatar
Robert Ricci committed
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
#
# Figure out if this node belongs to us (ie. if it's using our database.)
# Returns 1 if it does, 0 if not
#
sub checkDBRedirect($) {

	my ($node) = @_;

	#
	# XXX: I don't want to do this every time, for performance reaons,
	# but we need to make sure that we don't get into an inconsistent 
	# state
	#
	my $result = DBQueryFatal("SELECT testdb FROM nodes as n " .
		"LEFT JOIN reserved as r ON n.node_id = r.node_id " .
		"LEFT JOIN experiments as e ON r.pid = e.pid " .
			"AND r.eid = e.eid " .
		"WHERE n.node_id = '$node'");

	if (!$result->num_rows()) {
		notify("Got an event for a node ($node) I don't know about\n");
		return 0;
	}

	my ($testdb) = $result->fetchrow();

	#
	# XXX: It's hokey to hardcode tbdb here, but....
	#
	if ((!$testdb && ($TBDBNAME eq "tbdb")) ||
	    ($testdb && ($testdb eq $TBDBNAME))) {
		return 1;
	} else {
		return 0;
	}
}

Robert Ricci's avatar
Robert Ricci committed
375 376 377 378 379
#
# Reload state from the database
#
sub reload() {
    	print "Reloading state from database\n";
380
	%nodes    = readStates(%nodes);
Robert Ricci's avatar
Robert Ricci committed
381 382 383 384 385 386 387 388 389 390 391
	%timeouts = getTimeouts();
	%valid     = getValid();
}

sub debug(@) {
	if ($debug) { print @_; }
}

sub notify($) {
    	my $message = shift;
	if (!$debug) {
392
	    	SENDMAIL($TBOPS,"Node State Daemon Messsage",$message,$TBOPS);
Robert Ricci's avatar
Robert Ricci committed
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
	}
	print $message;
}

#
# This gets called if we die of 'natural causes' (exit, die, etc.)
#
END {
    	if ($handle) {
		print "Exiting, cleaning up\n";
		if (event_unregister($handle) == 0) {
			die "Unable to unregister with event system\n";
		}
	}

}