loncom/loncnew - diff

Return to loncnew CVS log

Up to [LON-CAPA] / loncom

Diff for /loncom/loncnew between versions 1.1 and 1.10

-version 1.1, 2003/04/18 02:39:20
+version 1.10, 2003/06/24 02:46:04
  Line 1
  #!/usr/bin/perl
+ # The LearningOnline Network with CAPA
+ # lonc maintains the connections to remote computers
+ #
+ # $Id$
+ #
+ # Copyright Michigan State University Board of Trustees
+ #
+ # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
+ #
+ # LON-CAPA is free software; you can redistribute it and/or modify
+ # it under the terms of the GNU General Public License as published by
+ # the Free Software Foundation; either version 2 of the License, or
+ # (at your option) any later version.
+ #
+ # LON-CAPA 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 General Public License for more details.
+ #
+ # You should have received a copy of the GNU General Public License
+ # along with LON-CAPA; if not, write to the Free Software
+ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ #
+ # /home/httpd/html/adm/gpl.txt
+ #
+ # http://www.lon-capa.org/
+ #
  #
  # new lonc handles n requestors spread out bver m connections to londs.
  # This module is based on the Event class.
- Line 7
+ Line 34
  #    - Add timer dispatch.       (done)
  #    - Add ability to accept lonc UNIX domain sockets.  (done)
  #    - Add ability to create/negotiate lond connections (done).
- #    - Add general logic for dispatching requests and timeouts.
+ #    - Add general logic for dispatching requests and timeouts. (done).
- #    - Add support for the lonc/lond requests.
+ #    - Add support for the lonc/lond requests.          (done).
  #    - Add logging/status monitoring.
  #    - Add Signal handling - HUP restarts. USR1 status report.
- #    - Add Configuration file I/O
+ #    - Add Configuration file I/O                       (done).
- #    - Add Pending request processing on startup.
  #    - Add management/status request interface.
+ #    - Add deferred request capability.                  (done)
+ #    - Detect transmission timeouts.
+ #
+ # Change log:
+ #    $Log$
+ #    Revision 1.10  2003/06/24 02:46:04  foxr
+ #    Put a limit on  the number of times we'll retry a connection.
+ #    Start getting the signal stuff put in as well...note that need to get signals
+ #    going or else 6the client will permanently give up on dead servers.
+ #
+ #    Revision 1.9  2003/06/13 02:38:43  foxr
+ #    Add logging in 'expected format'
+ #
+ #    Revision 1.8  2003/06/11 02:04:35  foxr
+ #    Support delayed transactions... this is done uniformly by encapsulating
+ #    transactions in an object ... a LondTransaction that is implemented by
+ #    LondTransaction.pm
+ #
+ #    Revision 1.7  2003/06/03 01:59:39  foxr
+ #    complete coding to support deferred transactions.
+ #
+ #
  use lib "/home/httpd/lib/perl/";
  use lib "/home/foxr/newloncapa/types";
- Line 22  use POSIX qw(:signal_h);
+ Line 71  use POSIX qw(:signal_h);
  use IO::Socket;
  use IO::Socket::INET;
  use IO::Socket::UNIX;
+ use IO::File;
+ use IO::Handle;
  use Socket;
  use Crypt::IDEA;
  use LONCAPA::Queue;
  use LONCAPA::Stack;
  use LONCAPA::LondConnection;
+ use LONCAPA::LondTransaction;
  use LONCAPA::Configuration;
  use LONCAPA::HashIterator;
- print "Loncnew starting\n";
  #
  #   Disable all signals we might receive from outside for now.
- Line 55  my %perlvar    = %{$perlvarref};
+ Line 106  my %perlvar    = %{$perlvarref};
  my %ChildHash;			# by pid -> host.
- my $MaxConnectionCount = 5;	# Will get from config later.
+ my $MaxConnectionCount = 10;	# Will get from config later.
  my $ClientConnection = 0;	# Uniquifier for client events.
- my $DebugLevel = 5;
+ my $DebugLevel = 0;
  my $IdleTimeout= 3600;		# Wait an hour before pruning connections.
  #
- Line 68  my $RemoteHost;   # Name of host child i
+ Line 119  my $RemoteHost;   # Name of host child i
  my $UnixSocketDir= "/home/httpd/sockets";
  my $IdleConnections = Stack->new(); # Set of idle connections
  my %ActiveConnections;		# Connections to the remote lond.
- my %ActiveTransactions;		# Transactions in flight.
+ my %ActiveTransactions;		# LondTransactions in flight.
  my %ActiveClients;		# Serial numbers of active clients by socket.
  my $WorkQueue       = Queue->new(); # Queue of pending transactions.
- my $ClientQueue     = Queue->new(); # Queue of clients causing xactinos.
  my $ConnectionCount = 0;
+ my $IdleSeconds     = 0;	# Number of seconds idle.
+ my $Status          = "";	# Current status string.
+ my $ConnectionRetries=5;	# Number of connection retries allowed.
+ my $ConnectionRetriesLeft=5;	# Number of connection retries remaining.
  #
+ #   The hash below gives the HTML format for log messages
+ #   given a severity.
+ #
+ my %LogFormats;
+ $LogFormats{"CRITICAL"} = "<font color=red>CRITICAL: %s</font>";
+ $LogFormats{"SUCCESS"}  = "<font color=green>SUCCESS: %s</font>";
+ $LogFormats{"INFO"}     = "<font color=yellow>INFO: %s</font>";
+ $LogFormats{"WARNING"}  = "<font color=blue>WARNING: %s</font>";
+ $LogFormats{"DEFAULT"}  = " %s ";
+ =pod
+ =head2 LogPerm
+ Makes an entry into the permanent log file.
+ =cut
+ sub LogPerm {
+     my $message=shift;
+     my $execdir=$perlvar{'lonDaemons'};
+     my $now=time;
+     my $local=localtime($now);
+     my $fh=IO::File->new(">>$execdir/logs/lonnet.perm.log");
+     print $fh "$now:$message:$local\n";
+ }
+ =pod
+ =head2 Log
+ Logs a message to the log file.
+ Parameters:
+ =item severity
+ One of CRITICAL, WARNING, INFO, SUCCESS used to select the
+ format string used to format the message.  if the severity is
+ not a defined severity the Default format string is used.
+ =item message
+ The base message.  In addtion to the format string, the message
+ will be appended to a string containing the name of our remote
+ host and the time will be formatted into the message.
+ =cut
+ sub Log {
+     my $severity = shift;
+     my $message  = shift;
+     if(!$LogFormats{$severity}) {
+ 	$severity = "DEFAULT";
+     }
+     my $format = $LogFormats{$severity};
+     #  Put the window dressing in in front of the message format:
+     my $now   = time;
+     my $local = localtime($now);
+     my $finalformat = "$local ($$) [$RemoteHost] [$Status] ";
+     my $finalformat = $finalformat.$format."\n";
+     # open the file and put the result.
+     my $execdir = $perlvar{'lonDaemons'};
+     my $fh      = IO::File->new(">>$execdir/logs/lonc.log");
+     my $msg = sprintf($finalformat, $message);
+     print $fh $msg;
+ }
  =pod
- =head 2 GetPeerName
-    Returns the name of the host that a socket object is connected
+ =head2 GetPeerName
-    to.
+ Returns the name of the host that a socket object is connected to.
  =cut
  sub GetPeername {
- Line 100  sub GetPeername {
+ Line 233  sub GetPeername {
  }
  #----------------------------- Timer management ------------------------
  =pod
  =head2 Debug
-    Invoked to issue a debug message.
+ Invoked to issue a debug message.
  =cut
  sub Debug {
      my $level   = shift;
      my $message = shift;
- Line 118  sub SocketDump {
+ Line 255  sub SocketDump {
  	$socket->Dump();
      }
  }
  =pod
+ =head2 ShowStatus
+  Place some text as our pid status.
+  and as what we return in a SIGUSR1
+ =cut
+ sub ShowStatus {
+     my $state = shift;
+     my $now = time;
+     my $local = localtime($now);
+     $Status   = $local.": ".$state;
+     $0='lonc: '.$state.' '.$local;
+ }
+ =pod
  =head2 Tick
-     Invoked  each timer tick.
+ Invoked  each timer tick.
  =cut
  sub Tick {
      my $client;
+     ShowStatus(GetServerHost()." Connection count: ".$ConnectionCount);
      Debug(6, "Tick");
      Debug(6, "    Current connection count: ".$ConnectionCount);
      foreach $client (keys %ActiveClients) {
  	Debug(7, "    Have client:  with id: ".$ActiveClients{$client});
      }
+     # Is it time to prune connection count:
+     if($IdleConnections->Count()  &&
+        ($WorkQueue->Count() == 0)) { # Idle connections and nothing to do?
+ 	$IdleSeconds++;
+ 	if($IdleSeconds > $IdleTimeout) { # Prune a connection...
+ 	    $Socket = $IdleConnections->pop();
+ 	    KillSocket($Socket);
+ 	}
+     } else {
+ 	$IdleSeconds = 0;	# Reset idle count if not idle.
+     }
+     # Do we have work in the queue, but no connections to service them?
+     # If so, try to make some new connections to get things going again.
+     #
+     my $Requests = $WorkQueue->Count();
+     if (($ConnectionCount == 0)  && ($Requests > 0)) {
+ 	if ($ConnectionRetriesLeft > 0) {
+ 	    my $Connections = ($Requests <= $MaxConnectionCount) ?
+ 		$Requests : $MaxConnectionCount;
+ 	    Debug(1,"Work but no connections, start ".$Connections." of them");
+ 	    for ($i =0; $i < $Connections; $i++) {
+ 		MakeLondConnection();
+ 	    }
+ 	} else {
+ 	    Debug(1,"Work in queue, but gave up on connections..flushing\n");
+ 	    EmptyQueue();	# Connections can't be established.
+ 	}
+     }
  }
  =pod
  =head2 SetupTimer
-    Sets up a 1 per sec recurring timer event.  The event handler is used to:
- =item Trigger timeouts on communications along active sockets.
+ Sets up a 1 per sec recurring timer event.  The event handler is used to:
- =item Trigger disconnections of idle sockets.
+ =item
+ Trigger timeouts on communications along active sockets.
+ =item
+ Trigger disconnections of idle sockets.
  =cut
- Line 146  sub SetupTimer {
+ Line 344  sub SetupTimer {
      Debug(6, "SetupTimer");
      Event->timer(interval => 1, debug => 1, cb => \&Tick );
  }
  =pod
  =head2 ServerToIdle
-    This function is called when a connection to the server is
- ready for more work.
+ This function is called when a connection to the server is
-    If there is work in the Work queue the top element is dequeued
+ ready for more work.
+ If there is work in the Work queue the top element is dequeued
  and the connection will start to work on it.  If the work queue is
  empty, the connection is pushed on the idle connection stack where
  it will either get another work unit, or alternatively, if it sits there
  long enough, it will be shut down and released.
  =cut
  sub ServerToIdle {
      my $Socket   = shift;	# Get the socket.
+     delete($ActiveTransactions{$Socket}); # Server has no transaction
      &Debug(6, "Server to idle");
      #  If there's work to do, start the transaction:
-     $reqdata = $WorkQueue->dequeue();
+     $reqdata = $WorkQueue->dequeue(); # This is a LondTransaction
-     Debug(9, "Queue gave request data: ".$reqdata);
      unless($reqdata eq undef)  {
- 	my $unixSocket = $ClientQueue->dequeue();
+ 	Debug(9, "Queue gave request data: ".$reqdata->getRequest());
- 	&Debug(6, "Starting new work request");
+ 	&StartRequest($Socket,  $reqdata);
- 	&Debug(7, "Request: ".$reqdata);
- 	&StartRequest($Socket, $unixSocket, $reqdata);
      } else {
      #  There's no work waiting, so push the server to idle list.
  	&Debug(8, "No new work requests, server connection going idle");
- 	delete($ActiveTransactions{$Socket});
  	$IdleConnections->push($Socket);
      }
  }
  =pod
  =head2 ClientWritable
-   Event callback for when a client socket is writable.
-   This callback is established when a transaction reponse is
+ Event callback for when a client socket is writable.
-   avaiable from lond.  The response is forwarded to the unix socket
-   as it becomes writable in this sub.
+ This callback is established when a transaction reponse is
+ avaiable from lond.  The response is forwarded to the unix socket
+ as it becomes writable in this sub.
  Parameters:
- =item Event - The event that has been triggered. Event->w->data is
+ =item Event
-               the data and Event->w->fd is the socket to write.
+ The event that has been triggered. Event->w->data is
+ the data and Event->w->fd is the socket to write.
  =cut
  sub ClientWritable {
      my $Event    = shift;
      my $Watcher  = $Event->w;
- Line 204  sub ClientWritable {
+ Line 411  sub ClientWritable {
      &Debug(6, "ClientWritable writing".$Data);
      &Debug(9, "Socket is: ".$Socket);
-     my $result = $Socket->send($Data, 0);
+     if($Socket->connected) {
+ 	my $result = $Socket->send($Data, 0);
-     # $result undefined: the write failed.
-     # otherwise $result is the number of bytes written.
-     # Remove that preceding string from the data.
-     # If the resulting data is empty, destroy the watcher
-     # and set up a read event handler to accept the next
-     # request.
-     &Debug(9,"Send result is ".$result." Defined: ".defined($result));
-     if(defined($result)) {
- 	&Debug(9, "send result was defined");
- 	if($result == length($Data)) { # Entire string sent.
- 	    &Debug(9, "ClientWritable data all written");
- 	    $Watcher->cancel();
- 	    #
- 	    #  Set up to read next request from socket:
- 	    my $descr     = sprintf("Connection to lonc client %d",
- 				    $ActiveClients{$Socket});
- 	    Event->io(cb    => \&ClientRequest,
- 		      poll  => 'r',
- 		      desc  => $descr,
- 		      data  => "",
- 		      fd    => $Socket);
- 	} else {		# Partial string sent.
- 	    $Watcher->data(substr($Data, $result));
- 	}
-     } else {			# Error of some sort...
+ 	# $result undefined: the write failed.
+ 	# otherwise $result is the number of bytes written.
- 	# Some errnos are possible:
+ 	# Remove that preceding string from the data.
- 	my $errno = $!;
+ 	# If the resulting data is empty, destroy the watcher
- 	if($errno == POSIX::EWOULDBLOCK   ||
+ 	# and set up a read event handler to accept the next
- 	   $errno == POSIX::EAGAIN        ||
+ 	# request.
- 	   $errno == POSIX::EINTR) {
- 	    # No action taken?
- 	} else {		# Unanticipated errno.
- 	    &Debug(5,"ClientWritable error or peer shutdown".$RemoteHost);
- 	    $Watcher->cancel;	# Stop the watcher.
- 	    $Socket->shutdown(2); # Kill connection
- 	    $Socket->close();	# Close the socket.
- 	}
+ 	&Debug(9,"Send result is ".$result." Defined: ".defined($result));
+ 	if(defined($result)) {
+ 	    &Debug(9, "send result was defined");
+ 	    if($result == length($Data)) { # Entire string sent.
+ 		&Debug(9, "ClientWritable data all written");
+ 		$Watcher->cancel();
+ 		#
+ 		#  Set up to read next request from socket:
+ 		my $descr     = sprintf("Connection to lonc client %d",
+ 					$ActiveClients{$Socket});
+ 		Event->io(cb    => \&ClientRequest,
+ 			  poll  => 'r',
+ 			  desc  => $descr,
+ 			  data  => "",
+ 			  fd    => $Socket);
+ 	    } else {		# Partial string sent.
+ 		$Watcher->data(substr($Data, $result));
+ 	    }
+ 	} else {			# Error of some sort...
+ 	    # Some errnos are possible:
+ 	    my $errno = $!;
+ 	    if($errno == POSIX::EWOULDBLOCK   ||
+ 	       $errno == POSIX::EAGAIN        ||
+ 	       $errno == POSIX::EINTR) {
+ 		# No action taken?
+ 	    } else {		# Unanticipated errno.
+ 		&Debug(5,"ClientWritable error or peer shutdown".$RemoteHost);
+ 		$Watcher->cancel;	# Stop the watcher.
+ 		$Socket->shutdown(2); # Kill connection
+ 		$Socket->close();	# Close the socket.
+ 	    }
+ 	}
+     } else {
+ 	$Watcher->cancel();	# A delayed request...just cancel.
      }
  }
  =pod
  =head2 CompleteTransaction
-   Called when the reply data has been received for a lond
+ Called when the reply data has been received for a lond
  transaction.   The reply data must now be sent to the
  ultimate client on the other end of the Unix socket.  This is
  done by setting up a writable event for the socket with the
  data the reply data.
  Parameters:
- =item Socket - Socket on which the lond transaction occured.  This
-       is a LondConnection. The data received is in the
+ =item Socket
- 	TransactionReply member.
- =item Client - Unix domain socket open on the ultimate client.
+ Socket on which the lond transaction occured.  This is a
+ LondConnection. The data received is in the TransactionReply member.
+ =item Transaction
+ The transaction that is being completed.
  =cut
  sub CompleteTransaction {
      &Debug(6,"Complete transaction");
      my $Socket = shift;
-     my $Client = shift;
+     my $Transaction = shift;
+     if (!$Transaction->isDeferred()) { # Normal transaction
+ 	my $data   = $Socket->GetReply(); # Data to send.
+ 	StartClientReply($Transaction, $data);
+     } else {			# Delete deferred transaction file.
+ 	Log("SUCCESS", "A delayed transaction was completed");
+ 	LogPerm("S:$Client:".$Transaction->getRequest());
+ 	unlink $Transaction->getFile();
+     }
+ }
+ =pod
+ =head1 StartClientReply
+    Initiates a reply to a client where the reply data is a parameter.
-     my $data   = $Socket->GetReply(); # Data to send.
+ =head2  parameters:
+ =item Transaction
+     The transaction for which we are responding to the client.
+ =item data
+     The data to send to apached client.
+ =cut
+ sub StartClientReply {
+     my $Transaction   = shift;
+     my $data     = shift;
+     my $Client   = $Transaction->getClient();
      &Debug(8," Reply was: ".$data);
      my $Serial         = $ActiveClients{$Client};
      my $desc           = sprintf("Connection to lonc client %d",
  				 $Serial);
      Event->io(fd       => $Client,
  	      poll     => "w",
- Line 283  sub CompleteTransaction {
+ Line 533  sub CompleteTransaction {
  	      cb       => \&ClientWritable,
  	      data     => $data);
  }
+ =pod
+ =head2 FailTransaction
+   Finishes a transaction with failure because the associated lond socket
+   disconnected.  There are two possibilities:
+   - The transaction is deferred: in which case we just quietly
+     delete the transaction since there is no client connection.
+   - The transaction is 'live' in which case we initiate the sending
+     of "con_lost" to the client.
+ Deleting the transaction means killing it from the
+ %ActiveTransactions hash.
+ Parameters:
+ =item client
+    The LondTransaction we are failing.
+ =cut
+ sub FailTransaction {
+     my $transaction = shift;
+     Debug(1, "Failing transaction: ".$transaction->getRequest());
+     if (!$transaction->isDeferred()) { # If the transaction is deferred we'll get to it.
+ 	my $client  = $transcation->getClient();
+ 	Debug(1," Replying con_lost to ".$transaction->getRequest());
+ 	StartClientReply($client, "con_lost\n");
+     }
+ }
+ =pod
+ =head1  EmptyQueue
+   Fails all items in the work queue with con_lost.
+   Note that each item in the work queue is a transaction.
+ =cut
+ sub EmptyQueue {
+     while($WorkQueue->Count()) {
+ 	my $request = $WorkQueue->dequeue(); # This is a transaction
+ 	FailTransaction($request);
+     }
+ }
+ =pod
+ =head2 CloseAllLondConnections
+ Close all connections open on lond prior to exit e.g.
+ =cut
+ sub CloseAllLondConnections {
+     foreach $Socket (keys %ActiveConnections) {
+ 	KillSocket($Socket);
+     }
+ }
+ =cut
+ =pod
+ =head2 KillSocket
+ Destroys a socket.  This function can be called either when a socket
+ has died of 'natural' causes or because a socket needs to be pruned due to
+ idleness.  If the socket has died naturally, if there are no longer any
+ live connections a new connection is created (in case there are transactions
+ in the queue).  If the socket has been pruned, it is never re-created.
+ Parameters:
+ =item Socket
+   The socket to kill off.
+ =item Restart
+ nonzero if we are allowed to create a new connection.
+ =cut
+ sub KillSocket {
+     my $Socket = shift;
+     $Socket->Shutdown();
+     #  If the socket came from the active connection set,
+     #  delete its transaction... note that FailTransaction should
+     #  already have been called!!!
+     #  otherwise it came from the idle set.
+     #
+     if(exists($ActiveTransactions{$Socket})) {
+ 	delete ($ActiveTransactions{$Socket});
+     }
+     if(exists($ActiveConnections{$Socket})) {
+ 	delete($ActiveConnections{$Socket});
+     }
+     $ConnectionCount--;
+     #  If the connection count has gone to zero and there is work in the
+     #  work queue, the work all gets failed with con_lost.
+     #
+     if($ConnectionCount == 0) {
+ 	EmptyQueue;
+     }
+ }
  =pod
  =head2 LondReadable
  This function is called whenever a lond connection
  is readable.  The action is state dependent:
- =head3 State = Initialized
+ =head3 State=Initialized
-     We''re waiting for the challenge, this is a no-op until the
+ We''re waiting for the challenge, this is a no-op until the
  state changes.
  =head3 State=Challenged
-     The challenge has arrived we need to transition to Writable.
+ The challenge has arrived we need to transition to Writable.
  The connection must echo the challenge back.
  =head3 State=ChallengeReplied
-     The challenge has been replied to.  The we are receiveing the
+ The challenge has been replied to.  The we are receiveing the
  'ok' from the partner.
  =head3 State=RequestingKey
-     The ok has been received and we need to send the request for
+ The ok has been received and we need to send the request for
  an encryption key.  Transition to writable for that.
  =head3 State=ReceivingKey
-     The the key has been requested, now we are reading the new key.
+ The the key has been requested, now we are reading the new key.
  =head3 State=Idle
-     The encryption key has been negotiated or we have finished
+ The encryption key has been negotiated or we have finished
  reading data from the a transaction.   If the callback data has
  a client as well as the socket iformation, then we are
  doing a transaction and the data received is relayed to the client
  before the socket is put on the idle list.
  =head3 State=SendingRequest
-     I do not think this state can be received here, but if it is,
+ I do not think this state can be received here, but if it is,
  the appropriate thing to do is to transition to writable, and send
  the request.
  =head3 State=ReceivingReply
-     We finished sending the request to the server and now transition
+ We finished sending the request to the server and now transition
  to readable to receive the reply.
  The parameter to this function are:
  The event. Implicit in this is the watcher and its data.  The data
  contains at least the lond connection object and, if a
  transaction is in progress, the socket attached to the local client.
  =cut
  sub LondReadable {
      my $Event      = shift;
      my $Watcher    = $Event->w;
      my $Socket     = $Watcher->data;
      my $client     = undef;
+     &Debug(6,"LondReadable called state = ".$State);
      my $State = $Socket->GetState(); # All action depends on the state.
-     &Debug(6,"LondReadable called state = ".$State);
      SocketDump(6, $Socket);
      if($Socket->Readable() != 0) {
- 	 # bad return from socket read.
+ 	 # bad return from socket read. Currently this means that
+ 	# The socket has become disconnected. We fail the transaction.
+ 	if(exists($ActiveTransactions{$Socket})) {
+ 	    Debug(3,"Lond connection lost failing transaction");
+ 	    FailTransaction($ActiveTransactions{$Socket});
+ 	}
+ 	$Watcher->cancel();
+ 	KillSocket($Socket);
+ 	return;
      }
      SocketDump(6,$Socket);
- Line 353  sub LondReadable {
+ Line 739  sub LondReadable {
  	# in the connection takes care of setting that up.  Just
  	# need to transition to writable:
- 	$Watcher->poll("w");
  	$Watcher->cb(\&LondWritable);
+ 	$Watcher->poll("w");
      } elsif ($State eq "ChallengeReplied") {
- Line 363  sub LondReadable {
+ Line 749  sub LondReadable {
  	#  The ok was received.  Now we need to request the key
  	#  That requires us to be writable:
- 	$Watcher->poll("w");
  	$Watcher->cb(\&LondWritable);
+ 	$Watcher->poll("w");
      } elsif ($State eq "ReceivingKey") {
      } elsif ($State eq "Idle") {
  	# If necessary, complete a transaction and then go into the
  	# idle queue.
+ 	$Watcher->cancel();
  	if(exists($ActiveTransactions{$Socket})) {
  	    Debug(8,"Completing transaction!!");
  	    CompleteTransaction($Socket,
  				$ActiveTransactions{$Socket});
+ 	} else {
+ 	    Log("SUCCESS", "Connection ".$ConnectionCount." to "
+ 		.$RemoteHost." now ready for action");
  	}
- 	$Watcher->cancel();
  	ServerToIdle($Socket);	# Next work unit or idle.
      } elsif ($State eq "SendingRequest") {
  	#  We need to be writable for this and probably don't belong
  	#  here inthe first place.
- Line 395  sub LondReadable {
+ Line 784  sub LondReadable {
  	Debug(4, "Invalid state in LondReadable");
      }
  }
  =pod
  =head2 LondWritable
  This function is called whenever a lond connection
  becomes writable while there is a writeable monitoring
  event.  The action taken is very state dependent:
  =head3 State = Connected
-   The connection is in the process of sending the
-   'init' hailing to the lond on the remote end.
+ The connection is in the process of sending the 'init' hailing to the
-    The connection object''s Writable member is called.
+ lond on the remote end.  The connection object''s Writable member is
-    On error, ConnectionError is called to destroy
+ called.  On error, ConnectionError is called to destroy the connection
-    the connection and remove it from the ActiveConnections
+ and remove it from the ActiveConnections hash
-    hash
  =head3 Initialized
-    'init' has been sent, writability monitoring is
-     removed and readability monitoring is started
+ 'init' has been sent, writability monitoring is removed and
-     with LondReadable as the callback.
+ readability monitoring is started with LondReadable as the callback.
  =head3 ChallengeReceived
-     The connection has received the who are you
-    challenge from the remote system, and is in the
+ The connection has received the who are you challenge from the remote
-     process of sending the challenge response.
+ system, and is in the process of sending the challenge
-     Writable is called.
+ response. Writable is called.
  =head3 ChallengeReplied
-     The connection has replied to the initial challenge
-     The we switch to monitoring readability looking
+ The connection has replied to the initial challenge The we switch to
-     for the server to reply with 'ok'.
+ monitoring readability looking for the server to reply with 'ok'.
  =head3 RequestingKey
-     The connection is in the process of requesting its
-     encryption key.  Writable is called.
+ The connection is in the process of requesting its encryption key.
+ Writable is called.
  =head3 ReceivingKey
-     The connection has sent the request for a key.
-     Switch to readability monitoring to accept the key
+ The connection has sent the request for a key.  Switch to readability
+ monitoring to accept the key
  =head3 SendingRequest
-     The connection is in the process of sending a
-     request to the server.  This request is part of
+ The connection is in the process of sending a request to the server.
-     a client transaction.  All the states until now
+ This request is part of a client transaction.  All the states until
-     represent the client setup protocol. Writable
+ now represent the client setup protocol. Writable is called.
-     is called.
  =head3 ReceivingReply
-     The connection has sent a request.  Now it must
-     receive a reply.  Readability monitoring is
-     requested.
-  This function is an event handler and therefore receives as
+ The connection has sent a request.  Now it must receive a reply.
+ Readability monitoring is requested.
+ This function is an event handler and therefore receives as
  a parameter the event that has fired.  The data for the watcher
  of this event is a reference to a list of one or two elements,
  depending on state. The first (and possibly only) element is the
- Line 445  socket.  The second (present only if a r
+ Line 845  socket.  The second (present only if a r
  is the socket on which to return a reply to the caller.
  =cut
  sub LondWritable {
      my $Event   = shift;
      my $Watcher = $Event->w;
-     my @data    = $Watcher->data;
+     my $Socket  = $Watcher->data;
-     Debug(6,"LondWritable State = ".$State." data has ".@data." elts.\n");
+     my $State   = $Socket->GetState();
-     my $Socket  = $data[0];	# I know there's at least a socket.
+     Debug(6,"LondWritable State = ".$State."\n");
      #  Figure out what to do depending on the state of the socket:
-     my $State   = $Socket->GetState();
      SocketDump(6,$Socket);
      if      ($State eq "Connected")         {
- 	#  "init" is being sent...
  	if ($Socket->Writable() != 0) {
  	    #  The write resulted in an error.
+ 	    # We'll treat this as if the socket got disconnected:
+ 	    Log("WARNING", "Connection to ".$RemoteHost.
+ 		" has been disconnected");
+ 	    $Watcher->cancel();
+ 	    KillSocket($Socket);
+ 	    return;
  	}
+ 	#  "init" is being sent...
      } elsif ($State eq "Initialized")       {
  	# Now that init was sent, we switch
  	# to watching for readability:
- 	$Watcher->poll("r");
  	$Watcher->cb(\&LondReadable);
+ 	$Watcher->poll("r");
      } elsif ($State eq "ChallengeReceived") {
  	# We received the challenge, now we
- Line 482  sub LondWritable {
+ Line 890  sub LondWritable {
  	# we're waiting for the state to change
  	if($Socket->Writable() != 0) {
- 	    # Write of the next chunk resulted in an error.
+ 	    $Watcher->cancel();
+ 	    KillSocket($Socket);
+ 	    return;
  	}
      } elsif ($State eq "ChallengeReplied")  {
  	# The echo was sent back, so we switch
  	# to watching readability.
- 	$Watcher->poll("r");
  	$Watcher->cb(\&LondReadable);
+ 	$Watcher->poll("r");
      } elsif ($State eq "RequestingKey")     {
  	# At this time we're requesting the key.
- Line 500  sub LondWritable {
+ Line 911  sub LondWritable {
  	if($Socket->Writable() != 0) {
  	    # Write resulted in an error.
- 	}
+ 	    $Watcher->cancel();
+ 	    KillSocket($Socket);
+ 	    return;
+ 	}
      } elsif ($State eq "ReceivingKey")      {
  	# Now we need to wait for the key
  	# to come back from the peer:
- 	$Watcher->poll("r");
  	$Watcher->cb(\&LondReadable);
+ 	$Watcher->poll("r");
      } elsif ($State eq "SendingRequest")    {
  	# At this time we are sending a request to the
  	# peer... write the next chunk:
  	if($Socket->Writable() != 0) {
- 	    # Write resulted in an error.
+ 	    if(exists($ActiveTransactions{$Socket})) {
+ 		Debug(3, "Lond connection lost, failing transactions");
+ 		FailTransaction($ActiveTransactions{$Socket});
+ 	    }
+ 	    $Watcher->cancel();
+ 	    KillSocket($Socket);
+ 	    return;
  	}
      } elsif ($State eq "ReceivingReply")    {
  	# The send has completed.  Wait for the
  	# data to come in for a reply.
  	Debug(8,"Writable sent request/receiving reply");
- 	$Watcher->poll("r");
  	$Watcher->cb(\&LondReadable);
+ 	$Watcher->poll("r");
      } else {
  	#  Control only passes here on an error:
- Line 535  sub LondWritable {
+ Line 957  sub LondWritable {
      }
  }
+ =pod
+ =cut
+ sub QueueDelayed {
+     Debug(3,"QueueDelayed called");
+     my $path = "$perlvar{'lonSockDir'}/delayed";
+     Debug(4, "Delayed path: ".$path);
+     opendir(DIRHANDLE, $path);
+     @alldelayed = grep /\.$RemoteHost$/, readdir DIRHANDLE;
+     Debug(4, "Got ".$alldelayed." delayed files");
+     closedir(DIRHANDLE);
+     my $dfname;
+     my $reqfile;
+     foreach $dfname (sort  @alldelayed) {
+ 	$reqfile = "$path/$dfname";
+ 	Debug(4, "queueing ".$reqfile);
+ 	my $Handle = IO::File->new($reqfile);
+ 	my $cmd    = <$Handle>;
+ 	chomp $cmd;		# There may or may not be a newline...
+ 	$cmd = $cmd."\ny";	# now for sure there's exactly one newline.
+ 	my $Transaction = LondTransaction->new($cmd);
+ 	$Transaction->SetDeferred($reqfile);
+ 	QueueTransaction($Transaction);
+     }
+ }
  =pod
  =head2 MakeLondConnection
-     Create a new lond connection object, and start it towards
-     its initial idleness.  Once idle, it becomes elligible to
+ Create a new lond connection object, and start it towards its initial
-     receive transactions from the work queue.  If the work queue
+ idleness.  Once idle, it becomes elligible to receive transactions
-     is not empty when the connection is completed and becomes idle,
+ from the work queue.  If the work queue is not empty when the
-     it will dequeue an entry and start off on it.
+ connection is completed and becomes idle, it will dequeue an entry and
+ start off on it.
  =cut
  sub MakeLondConnection {
      Debug(4,"MakeLondConnection to ".GetServerHost()." on port "
  	  .GetServerPort());
- Line 552  sub MakeLondConnection {
+ Line 1007  sub MakeLondConnection {
  					 &GetServerPort());
      if($Connection == undef) {	# Needs to be more robust later.
- 	die "Failed to make a connection!!".$!."\n";
+ 	Log("CRITICAL","Failed to make a connection with lond.");
+ 	$ConnectionRetriesLeft--;
+ 	return 0;		# Failure.
+     }  else {
+ 	$ConnectionRetriesLeft = $ConnectionRetries; # success resets the count
+ 	# The connection needs to have writability
+ 	# monitored in order to send the init sequence
+ 	# that starts the whole authentication/key
+ 	# exchange underway.
+ 	#
+ 	my $Socket = $Connection->GetSocket();
+ 	if($Socket == undef) {
+ 	    die "did not get a socket from the connection";
+ 	} else {
+ 	    &Debug(9,"MakeLondConnection got socket: ".$Socket);
+ 	}
-     }
-     # The connection needs to have writability
+ 	$event = Event->io(fd       => $Socket,
-     # monitored in order to send the init sequence
+ 			   poll     => 'w',
-     # that starts the whole authentication/key
+ 			   cb       => \&LondWritable,
-     # exchange underway.
+ 			   data     => $Connection,
-     #
+ 			   desc => 'Connection to lond server');
-     my $Socket = $Connection->GetSocket();
+ 	$ActiveConnections{$Connection} = $event;
-     if($Socket == undef) {
- 	die "did not get a socket from the connection";
+ 	$ConnectionCount++;
-     } else {
+ 	Debug(4, "Connection count = ".$ConnectionCount);
- 	&Debug(9,"MakeLondConnection got socket: ".$Socket);
+ 	if($ConnectionCount == 1) { # First Connection:
+ 	    QueueDelayed;
+ 	}
+ 	Log("SUCESS", "Created connection ".$ConnectionCount
+ 	    ." to host ".GetServerHost());
+ 	return 1;		# Return success.
      }
-     $event = Event->io(fd       => $Socket,
- 		       poll     => 'w',
- 		       cb       => \&LondWritable,
- 		       data     => ($Connection, undef),
- 		       desc => 'Connection to lond server');
-     $ActiveConnections{$Lond} = $event;
-     $ConnectionCount++;
  }
  =pod
  =head2 StartRequest
-    Starts a lond request going on a specified lond connection.
-     parameters are:
+ Starts a lond request going on a specified lond connection.
- =item $Lond - Connection to the lond that will send the transaction
+ parameters are:
-     and receive the reply.
- =item $Client - Connection to the client that is making this request
+ =item $Lond
-     We got the request from this socket, and when the request has
-     been relayed to lond and we get a reply back from lond it will
+ Connection to the lond that will send the transaction and receive the
-     get sent to this socket.
+ reply.
- =item $Request - The text of the request to send.
+ =item $Client
+ Connection to the client that is making this request We got the
+ request from this socket, and when the request has been relayed to
+ lond and we get a reply back from lond it will get sent to this
+ socket.
+ =item $Request
+ The text of the request to send.
  =cut
  sub StartRequest {
      my $Lond     = shift;
-     my $Client   = shift;
+     my $Request  = shift;	# This is a LondTransaction.
-     my $Request  = shift;
-     Debug(6, "StartRequest: ".$Request);
+     Debug(6, "StartRequest: ".$Request->getRequest());
      my $Socket = $Lond->GetSocket();
-     $ActiveTransactions{$Lond} = $Client; # Socket to relay to client.
+     $Request->Activate($Lond);
+     $ActiveTransactions{$Lond} = $Request;
-     $Lond->InitiateTransaction($Request);
+     $Lond->InitiateTransaction($Request->getRequest());
-     $event = Event->io(fd      => $Lond->GetSocket(),
+     $event = Event->io(fd      => $Socket,
  		       poll    => "w",
  		       cb      => \&LondWritable,
  		       data    => $Lond,
- Line 614  sub StartRequest {
+ Line 1091  sub StartRequest {
  }
  =pod
  =head2 QueueTransaction
-     - If there is an idle lond connection, it is put to
-     work doing this transaction.  Otherwise, the transaction is
+ If there is an idle lond connection, it is put to work doing this
-     placed in the work queue.  If placed in the work queue and the
+ transaction.  Otherwise, the transaction is placed in the work queue.
-     maximum number of connections has not yet been created, a new
+ If placed in the work queue and the maximum number of connections has
-     connection will be started.  Our goal is to eventually have
+ not yet been created, a new connection will be started.  Our goal is
-     a sufficient number of connections that the work queue will
+ to eventually have a sufficient number of connections that the work
-     typically be empty.
+ queue will typically be empty.  parameters are:
-     parameters are:
- =item Socket open on the lonc client.
+ =item Socket
- =item Request data to send to the lond.
+ open on the lonc client.
+ =item Request
+ data to send to the lond.
  =cut
  sub QueueTransaction {
-     my $requestSocket = shift;
-     my $requestData   = shift;
-     Debug(6,"QueueTransaction: ".$requestData);
+     my $requestData   = shift;	# This is a LondTransaction.
+     my $cmd           = $requestData->getRequest();
+     Debug(6,"QueueTransaction: ".$cmd);
      my $LondSocket    = $IdleConnections->pop();
      if(!defined $LondSocket) {	# Need to queue request.
  	Debug(8,"Must queue...");
- 	$ClientQueue->enqueue($requestSocket);
  	$WorkQueue->enqueue($requestData);
  	if($ConnectionCount < $MaxConnectionCount) {
  	    Debug(4,"Starting additional lond connection");
- Line 644  sub QueueTransaction {
+ Line 1128  sub QueueTransaction {
  	}
      } else {			# Can start the request:
  	Debug(8,"Can start...");
- 	StartRequest($LondSocket, $requestSocket, $requestData);
+ 	StartRequest($LondSocket,  $requestData);
      }
  }
  #-------------------------- Lonc UNIX socket handling ---------------------
  =pod
  =head2 ClientRequest
-    Callback that is called when data can be read from the
+ Callback that is called when data can be read from the UNIX domain
-    UNIX domain socket connecting us with an apache server process.
+ socket connecting us with an apache server process.
  =cut
- Line 675  sub ClientRequest {
+ Line 1161  sub ClientRequest {
  	close($socket);
  	$watcher->cancel();
  	delete($ActiveClients{$socket});
+ 	return;
      }
      Debug(8,"Data: ".$data." this read: ".$thisread);
      $data = $data.$thisread;	# Append new data.
      $watcher->data($data);
      if($data =~ /(.*\n)/) {	# Request entirely read.
+ 	if($data eq "close_connection_exit\n") {
+ 	    Log("CRITICAL",
+ 		"Request Close Connection ... exiting");
+ 	    CloseAllLondConnections();
+ 	    exit;
+ 	}
  	Debug(8, "Complete transaction received: ".$data);
- 	QueueTransaction($socket, $data);
+ 	my $Transaction = LondTransaction->new($data);
+ 	$Transaction->SetClient($socket);
+ 	QueueTransaction($Transaction);
  	$watcher->cancel();	# Done looking for input data.
      }
- Line 689  sub ClientRequest {
+ Line 1184  sub ClientRequest {
  =pod
  =head2  NewClient
-     Callback that is called when a connection is received on the
-     unix socket for a new client of lonc.  The callback is parameterized
+ Callback that is called when a connection is received on the unix
-     by the event.. which is a-priori assumed to be an  io event, and therefore
+ socket for a new client of lonc.  The callback is parameterized by the
-     has an fd member that is the Listener socket.   We Accept the connection
+ event.. which is a-priori assumed to be an io event, and therefore has
-     and register a new event on the readability of that socket:
+ an fd member that is the Listener socket.  We Accept the connection
+ and register a new event on the readability of that socket:
  =cut
  sub NewClient {
      Debug(6, "NewClient");
      my $event      = shift;		# Get the event parameters.
- Line 717  sub NewClient {
+ Line 1216  sub NewClient {
      $ActiveClients{$connection} = $ClientConnection;
      $ClientConnection++;
  }
- =pod GetLoncSocketPath
-     Returns the name of the UNIX socket on which to listen for client
+ =pod
-     connections.
+ =head2 GetLoncSocketPath
+ Returns the name of the UNIX socket on which to listen for client
+ connections.
  =cut
  sub GetLoncSocketPath {
      return $UnixSocketDir."/".GetServerHost();
  }
- =pod GetServerHost
+ =pod
-    Returns the host whose lond we talk with.
+ =head2 GetServerHost
+ Returns the host whose lond we talk with.
  =cut
- sub GetServerHost {		# Stub - get this from config.
+ sub GetServerHost {
      return $RemoteHost;		# Setup by the fork.
  }
- =pod GetServerPort
-    Returns the lond port number.
+ =pod
+ =head2 GetServerPort
+ Returns the lond port number.
  =cut
- sub GetServerPort {		# Stub - get this from config.
+ sub GetServerPort {
      return $perlvar{londPort};
  }
- =pod SetupLoncListener
-    Setup a lonc listener event.  The event is called when
+ =pod
-    the socket becomes readable.. that corresponds to the
-    receipt of a new connection.  The event handler established
+ =head2 SetupLoncListener
-    will accept the connection (creating a communcations channel), that
-    int turn will establish another event handler to subess requests.
+ Setup a lonc listener event.  The event is called when the socket
+ becomes readable.. that corresponds to the receipt of a new
+ connection.  The event handler established will accept the connection
+ (creating a communcations channel), that int turn will establish
+ another event handler to subess requests.
  =cut
  sub SetupLoncListener {
      my $socket;
      my $SocketName = GetLoncSocketPath();
      unlink($SocketName);
-     unless ($socket = IO::Socket::UNIX->new(Local  => $SocketName,
+     unless ($socket =IO::Socket::UNIX->new(Local  => $SocketName,
  					    Listen => 10,
  					    Type   => SOCK_STREAM)) {
  	die "Failed to create a lonc listner socket";
- Line 763  sub SetupLoncListener {
+ Line 1283  sub SetupLoncListener {
  }
  =pod
+ =head2 SignalledToDeath
+ Called in response to a signal that causes a chid process to die.
+ =cut
+ =pod
+ sub SignalledToDeath {
+     my ($signal) = @_;
+     chomp($signal);
+     Log("CRITICAL", "Abnormal exit.  Child $$ for $RemoteHost "
+ 	."died through "."\"$signal\"");
+     LogPerm("F:lonc: $$ on $RemoteHost signalled to death: "
+ 	    ."\"$signal\"");
+     die("Signal abnormal end");
+ }
  =head2 ChildProcess
  This sub implements a child process for a single lonc daemon.
- Line 771  This sub implements a child process for
+ Line 1310  This sub implements a child process for
  sub ChildProcess {
-     print "Loncnew\n";
      # For now turn off signals.
-     $SIG{QUIT}  = IGNORE;
+     $SIG{QUIT}  = \&SignalledToDeath;
      $SIG{HUP}   = IGNORE;
      $SIG{USR1}  = IGNORE;
      $SIG{INT}   = IGNORE;
      $SIG{CHLD}  = IGNORE;
-     $SIG{__DIE__}  = IGNORE;
+     $SIG{__DIE__}  = \&SignalledToDeath;
      SetupTimer();
- Line 792  sub ChildProcess {
+ Line 1330  sub ChildProcess {
  # Setup the initial server connection:
-     &MakeLondConnection();
+      # &MakeLondConnection(); // let first work requirest do it.
      Debug(9,"Entering event loop");
      my $ret = Event::loop();		#  Start the main event loop.
- Line 806  sub ChildProcess {
+ Line 1345  sub ChildProcess {
  sub CreateChild {
      my $host = shift;
      $RemoteHost = $host;
-     Debug(3, "Forking off child for ".$RemoteHost);
+     Log("CRITICAL", "Forking server for ".$host);
-     sleep(5);
      $pid          = fork;
      if($pid) {			# Parent
  	$ChildHash{$pid} = $RemoteHost;
      } else {			# child.
+ 	ShowStatus("Connected to ".$RemoteHost);
  	ChildProcess;
      }
- Line 826  sub CreateChild {
+ Line 1365  sub CreateChild {
  #  Each exit gets logged and the child gets restarted.
  #
+ #
+ #   Fork and start in new session so hang-up isn't going to
+ #   happen without intent.
+ #
+ ShowStatus("Forming new session");
+ my $childpid = fork;
+ if ($childpid != 0) {
+     sleep 4;			# Give child a chacne to break to
+     exit 0;			# a new sesion.
+ }
+ #
+ #   Write my pid into the pid file so I can be located
+ #
+ ShowStatus("Parent writing pid file:");
+ $execdir = $perlvar{'lonDaemons'};
+ open (PIDSAVE, ">$execdir/logs/lonc.pid");
+ print PIDSAVE "$$\n";
+ close(PIDSAVE);
+ if (POSIX::setsid() < 0) {
+     print "Could not create new session\n";
+     exit -1;
+ }
+ ShowStatus("Forking node servers");
+ Log("CRITICAL", "--------------- Starting children ---------------");
  my $HostIterator = LondConnection::GetHostIterator;
  while (! $HostIterator->end()) {
- Line 836  while (! $HostIterator->end()) {
+ Line 1410  while (! $HostIterator->end()) {
  # Maintain the population:
+ ShowStatus("Parent keeping the flock");
+ #
+ #   Set up parent signals:
+ #
+ $SIG{INT}  = &KillThemAll;
+ $SIG{TERM} = &KillThemAll;
  while(1) {
      $deadchild = wait();
      if(exists $ChildHash{$deadchild}) {	# need to restart.
  	$deadhost = $ChildHash{$deadchild};
  	delete($ChildHash{$deadchild});
- 	Debug(4,"Lost child pid= ".$deadchild.
+ 	Log("WARNING","Lost child pid= ".$deadchild.
  	      "Connected to host ".$deadhost);
+ 	Log("INFO", "Restarting child procesing ".$deadhost);
  	CreateChild($deadhost);
      }
  }
+ sub KillThemAll {
+ }
  =head1 Theory
-    The event class is used to build this as a single process with
-    an event driven model.  The following events are handled:
+ The event class is used to build this as a single process with an
+ event driven model.  The following events are handled:
  =item UNIX Socket connection Received
- Line 863  All sockets are run in non-blocking mode
+ Line 1449  All sockets are run in non-blocking mode
  handler prevents hung connections.
  Key data structures:
- =item RequestQueue - A queue of requests received from UNIX sockets that are
-     waiting for a chance to be forwarded on a lond connection socket.
- =item ActiveConnections - A hash of lond connections that have transactions
+ =item RequestQueue
-     in process that are available to be timed out.
+ A queue of requests received from UNIX sockets that are
+ waiting for a chance to be forwarded on a lond connection socket.
+ =item ActiveConnections
+ A hash of lond connections that have transactions in process that are
+ available to be timed out.
+ =item ActiveTransactions
+ A hash indexed by lond connections that contain the client reply
+ socket for each connection that has an active transaction on it.
+ =item IdleConnections
+ A hash of lond connections that have no work to do.  These connections
+ can be closed if they are idle for a long enough time.
- =item ActiveTransactions - A hash indexed by lond connections that
-     contain the client reply socket for each connection that has an active
-     transaction on it.
- =item IdleConnections - A hash of lond connections that have no work
-     to do.  These connections can be closed if they are idle for a long
-     enough time.
  =cut

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.1
changed lines
	Added in v.1.10