power_powduino.pm.in 10.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
#!/usr/bin/perl -wT

#
# Copyright (c) 2000-2018 University of Utah and the Flux Group.
# 
# {{{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/>.
# 
# }}}
#


package power_powduino;

use Exporter;
@ISA = ("Exporter");
31
@EXPORT = qw( powduinoctrl powduinostatus powduinotemp );
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

use Socket;
use IO::Handle;
use lib "@prefix@/lib";
use libdb;
use Node;
use POSIX qw(strftime);

#
# A little perl module for using Jon's arduino relay on a Powder node.
#

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

# Number of times to try sending command in the face of "Input error"
my $ntries = 3;

# Set for more output.
my $debug = 0;

# Prompt string
my $PROMPT = 'power> ';

my %CMDS =
  ("cycle"  => "power cycle",
   "on"     => "power on",
   "off"    => "power off");

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
sub powduinostatus {
    my ($controller, $statusp) = @_;

    my($TIP, $i, $insync);

    #
    # Form the connection to the controller via a "tip" line to the
    # capture process. Once we have that, we can just talk to the
    # controller directly.
    #
    if (!($TIP = tipconnect($controller))) {
	print STDERR "*** Could not form TIP connection to $controller\n";
	return 1;
    }

    #
    # Send the command.  Try again a few times if there is a retryable error.
    #
    my $status;
    for my $try (1..$ntries) {
	$status = syncandsend($controller, $TIP, "status", $statusp);
	last
	    if $status >= 0;
    }
    close($TIP);
    return $status ? 1 : 0;
}

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
sub powduinotemp {
    my ($controller, $statusp) = @_;

    my($TIP, $i, $insync);

    #
    # Form the connection to the controller via a "tip" line to the
    # capture process. Once we have that, we can just talk to the
    # controller directly.
    #
    if (!($TIP = tipconnect($controller))) {
	print STDERR "*** Could not form TIP connection to $controller\n";
	return 1;
    }

    #
    # Send the command.  Try again a few times if there is a retryable error.
    #
    my $status;
    for my $try (1..$ntries) {
	$status = syncandsend($controller, $TIP, "temp", $statusp);
	last
	    if $status >= 0;
    }
    close($TIP);
    return $status ? 1 : 0;
}

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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 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 203
# Main routine.
# usage: powduinoctrl(cmd, controller, outlet)
# cmd = { "cycle" | "on" | "off" }
# controller = <node_id>
# outlet = int, 0 <= outlet < N
#
# Returns 0 on success. Non-zero on failure.
# 
sub powduinoctrl {
    my($cmd, $controller, @outlets) = @_;

    #
    # Check parameters
    #
    if (!defined($CMDS{$cmd})) {
	print STDERR "*** Undefined command: '$cmd'\n";
	return 1;
    }
    if (grep {$_ < 0 || $_ > 3} @outlets) {
	print STDERR "*** Invalid outlet '$outlet': Must be 0-3\n";
	return 1;
    }

    if ($debug) {
	print "outlets: ", join(" ",map("($_)",@outlets)), "\n";
    }

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

    if ($syspid) {
	local $SIG{ALRM} = sub { kill("TERM", $syspid); };
	#
	# Give it 30 seconds for initial connect plus time per outlet.
	# Probably too long.
	#
	alarm 30 + (10 * scalar(@outlets));
	waitpid($syspid, 0);
	alarm 0;
	my $exitstatus = $?;

	if ($exitstatus == 15) {
	    print STDERR "*** power: $controller is wedged.\n";
	}
	return($exitstatus);
    }
    TBdbfork();

    #
    # Form the connection to the controller via a "tip" line to the
    # capture process. Once we have that, we can just talk to the
    # controller directly.
    #
    if (! ($TIP = tipconnect($controller))) {
	print STDERR "*** Could not form TIP connection to $controller\n";
	exit(1);
    }

    foreach my $outlet (@outlets) {
	my $command = "$CMDS{$cmd} $outlet";
	my $status;
	for my $try (1..$ntries) {
	    $status = syncandsend($controller, $TIP, $command);
	    last
		if $status >= 0;
	}
	if ($status) {
	    close($TIP);
	    exit(1);
	}
    }
    close($TIP);
    exit(0);
}

#
# Sync up with the power controller, and set it a command. $controller is the
# controller name, for error message purposes, $TIP is the connection to
# the controller opened with tipconnect, and $command is the whole command
# (ie. 'reboot 20,40') to send.
#
# Returns 0 if successful, -1 if the caller should try again,
# 1 on an unexpected error.
#
204 205
sub syncandsend($$$;$) {
    my ($controller,$TIP,$cmd,$statusp) = @_;
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235

    #
    # Send a newline to get the command prompt, and then wait
    # for it to print out the command prompt. This loop is set for a small
    # number since if it cannot get the prompt quickly, then something has
    # gone wrong.
    #
    my $insync = 0;

    for (my $i = 0; $i < 20; $i++) {
	my $line;

	if (syswrite($TIP, "\r") == 0) {
	    print STDERR
		"*** Power control sync write failed ($controller/$outlet)\n";
	    return 1;
	}

	$line = rpc_readline($TIP);
	if (!defined($line)) {
	    print STDERR
		"*** Power control sync read failed ".
		    "($controller/$outlet)\n";
	    return 1;
	}
	if ($debug) {
	    print "Read: $line";
	}
	if ($line =~ /$PROMPT/) {
	    if ($debug) {
236
		print "Matched prompt '$PROMPT'!\n";
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
	    }
	    $insync = 1;
	    last;
	}
    }
    if (! $insync) {
	print STDERR "*** Could not sync with power controller! ".
	    "($controller)\n";
	return 1;
    }

    if ($debug) {
	print "Sending '$cmd' to $controller\n";
    }

    # Okay, got a prompt. Send it the string:
    if (syswrite($TIP, "$cmd\r") == 0) {
    	print STDERR "*** Power control write failed ($controller/$outlet)\n";
    	return 1;
    }

    #
    # Read and parse all the output until the next prompt to ensure that
260
    # there was no read error.  We also collect status here if desired.
261
    #
262
    my %status = ();
263
    my $gotcmd = 0;
264
    my $gotstatus = 0;
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
    print "Reading output following command\n"
	if ($debug);
    while (my $line = rpc_readline($TIP)) {
	print "Read: $line"
	    if ($debug);
	# skip echoed prompt+command
	if ($line =~ /$cmd/) {
	    $gotcmd = 1;
	    print "GotCmd\n" if ($debug);
	    next;
	}
	# didn't recognize our command for some reason, return failure
	if ($line =~ /Invalid/) {
	    print "Bad result\n" if ($debug);
	    return -1;
	}
	#
	# Got the following prompt, all done.
	#
284
	if (($gotcmd || $gotstatus) && $line =~ /$PROMPT/) {
285 286
	    last;
	}
287 288 289 290 291
	if ($statusp) {
	    if ($line =~ /^Pin\s+(\d+)\s+(on|off)/) {
		$status{"pin$1"} = $2;
		$gotstatus = 1;
		print "status 'pin$1' = ", $status{"pin$1"}, "\n" if ($debug);
292 293 294 295
	    } elsif ($line =~ /^(\d+(\.\d+)?)/) {
		$status{"tempC"} = $1;
		$gotstatus = 1;
		print "status 'temp' = ", $status{"tempC"}, "\n" if ($debug);
296 297 298 299 300 301
	    }
	}
    }

    if ($statusp) {
	%$statusp = %status;
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 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 381 382 383 384 385 386 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 431 432 433
    }
    return 0;
}

#
# Connect up to the capture process. This should probably be in a library
# someplace.
#
sub tipconnect($) {
    my($controller) = $_[0];
    my($server, $portnum, $keylen, $keydata, $capreturn);
    my($inetaddr, $paddr, $proto);
    my(%powerid_row);
    local *TIP;

    my $query_result =
      DBQueryWarn("select * from tiplines where node_id='$controller'");

    if ($query_result->numrows < 1) {
	print STDERR "*** No such tipline: $controller\n";
	return 0;
    }
    %powerid_row = $query_result->fetchhash();

    $server  = $powerid_row{'server'};
    $portnum = $powerid_row{'portnum'};
    $keylen  = $powerid_row{'keylen'};
    $keydata = $powerid_row{'keydata'};
    $disabled= $powerid_row{'disabled'};

    if ($disabled) {
	print STDERR "*** $controller tipline is disabled\n";
	return 0;
    }

    if ($debug) {
	print "tipconnect: $server $portnum $keylen $keydata\n";
    }

    #
    # We have to send over the key. This is a little hokey, since we have
    # to make it look like the C struct.
    #
    my $secretkey = pack("iZ256", $keylen, $keydata);
    my $capret    = pack("i", 0);

    #
    # This stuff from the PERLIPC manpage.
    # 
    if (! ($inetaddr = inet_aton($server))) {
	print STDERR "*** Cannot map $server to IP address\n";
	return 0;
    }
    $paddr    = sockaddr_in($portnum, $inetaddr);
    $proto    = getprotobyname('tcp');

    for (my $i = 0; $i < 20; $i++) {
	if (! socket(TIP, PF_INET, SOCK_STREAM, $proto)) {
	    print STDERR "*** Cannot create socket.\n";
	    return 0;
	}

	if (! connect(TIP, $paddr)) {
	    print STDERR
		"*** Cannot connect to $controller on $server($portnum)\n";
	    close(TIP);
	    return 0;
	}
	TIP->autoflush(1);

	#
	# While its a fatal error if the connect fails, the write and the
	# read that follows might fail because the tip is currently is
	# active. The handshake writes back a value and then immediately
	# closes the socket, which could manifest itself as a closed
	# connection on this end, even before we get a change to do these.
	# operations. In that case, just go around the loop again. We hope
	# to succeed at some point. 
	# 
	if (! syswrite(TIP, $secretkey)) {
	    print STDERR
		"*** Cannot write to $controller on $server($portnum)\n";
	    goto again;
	}
	if (! sysread(TIP, $capret, length($capret))) {
	    print STDERR
		"*** Cannot read from $controller on $server($portnum)\n";
	    goto again;
	}

	my $foo = unpack("i", $capret);
	if ($debug) {
	    print "Capture returned $foo\n";
	}
	if ($foo == 0) {
	    return(*TIP);
	}
	
      again:
	close(TIP);

	if ($i && (($i % 5) == 0)) {
	    printf STDERR
		"*** WARNING: $controller on $server($portnum) is busy\n".
		"    Waiting a bit before trying again. Pass $i.\n";
	}
	sleep(5);
    }
    
    print STDERR
	"*** $controller on $server($portnum) was busy for too long\n";
    return 0;
}

sub rpc_readline($)
{
    my ($TIP) = @_;
    my $line;

    my $cc = 0;
    while (1) {
	if (sysread($TIP, $line, 1, $cc) == 0) {
	    return undef;
	}
	print "got: =$line=\n" if ($debug > 1);
	$cc++;
	last if ($line =~ /\n/ || $line =~ /$PROMPT/ || $cc > 1023);
    }
    return $line;
}

1;