Diff for /loncom/loncnew between versions 1.36 and 1.46

version 1.36, 2003/12/15 23:30:57 version 1.46, 2004/05/25 15:32:13
Line 35 Line 35
 #    - Add ability to create/negotiate lond connections (done).  #    - Add ability to create/negotiate lond connections (done).
 #    - Add general logic for dispatching requests and timeouts. (done).  #    - Add general logic for dispatching requests and timeouts. (done).
 #    - Add support for the lonc/lond requests.          (done).  #    - Add support for the lonc/lond requests.          (done).
 #    - Add logging/status monitoring.  #    - Add logging/status monitoring.                    (done)
 #    - Add Signal handling - HUP restarts. USR1 status report.  #    - Add Signal handling - HUP restarts. USR1 status report. (done)
 #    - Add Configuration file I/O                       (done).  #    - Add Configuration file I/O                       (done).
 #    - Add management/status request interface.  #    - Add management/status request interface.         (done)
 #    - Add deferred request capability.                  (done)  #    - Add deferred request capability.                  (done)
 #    - Detect transmission timeouts.  #    - Detect transmission timeouts.                     (done)
 #  #
   
 use strict;  use strict;
Line 63  use LONCAPA::Configuration; Line 63  use LONCAPA::Configuration;
 use LONCAPA::HashIterator;  use LONCAPA::HashIterator;
   
   
 #  
 #   Disable all signals we might receive from outside for now.  
 #  
   
   
 # Read the httpd configuration file to get perl variables  # Read the httpd configuration file to get perl variables
 # normally set in apache modules:  # normally set in apache modules:
   
Line 89  my $DebugLevel = 0; Line 84  my $DebugLevel = 0;
 my $NextDebugLevel= 2; # So Sigint can toggle this.  my $NextDebugLevel= 2; # So Sigint can toggle this.
 my $IdleTimeout= 3600; # Wait an hour before pruning connections.  my $IdleTimeout= 3600; # Wait an hour before pruning connections.
   
   my $LogTransactions = 0; # When True, all transactions/replies get logged.
   
 #  #
 #  The variables below are only used by the child processes.  #  The variables below are only used by the child processes.
 #  #
Line 105  my $Status          = ""; # Current stat Line 102  my $Status          = ""; # Current stat
 my $RecentLogEntry  = "";  my $RecentLogEntry  = "";
 my $ConnectionRetries=2; # Number of connection retries allowed.  my $ConnectionRetries=2; # Number of connection retries allowed.
 my $ConnectionRetriesLeft=2; # Number of connection retries remaining.  my $ConnectionRetriesLeft=2; # Number of connection retries remaining.
   my $LondVersion     = "unknown"; # Version of lond we talk with.
   
 #  #
 #   The hash below gives the HTML format for log messages  #   The hash below gives the HTML format for log messages
Line 112  my $ConnectionRetriesLeft=2; # Number of Line 110  my $ConnectionRetriesLeft=2; # Number of
 #      #    
 my %LogFormats;  my %LogFormats;
   
 $LogFormats{"CRITICAL"} = "<font color=red>CRITICAL: %s</font>";  $LogFormats{"CRITICAL"} = "<font color='red'>CRITICAL: %s</font>";
 $LogFormats{"SUCCESS"}  = "<font color=green>SUCCESS: %s</font>";  $LogFormats{"SUCCESS"}  = "<font color='green'>SUCCESS: %s</font>";
 $LogFormats{"INFO"}     = "<font color=yellow>INFO: %s</font>";  $LogFormats{"INFO"}     = "<font color='yellow'>INFO: %s</font>";
 $LogFormats{"WARNING"}  = "<font color=blue>WARNING: %s</font>";  $LogFormats{"WARNING"}  = "<font color='blue'>WARNING: %s</font>";
 $LogFormats{"DEFAULT"}  = " %s ";  $LogFormats{"DEFAULT"}  = " %s ";
   
   
Line 261  sub ShowStatus { Line 259  sub ShowStatus {
 =cut  =cut
 sub SocketTimeout {  sub SocketTimeout {
     my $Socket = shift;      my $Socket = shift;
           Log("WARNING", "A socket timeout was detected");
       Debug(0, " SocketTimeout called: ");
       $Socket->Dump();
       if(exists($ActiveTransactions{$Socket})) {
    FailTransaction($ActiveTransactions{$Socket});
       }
     KillSocket($Socket); # A transaction timeout also counts as      KillSocket($Socket); # A transaction timeout also counts as
                                 # a connection failure:                                  # a connection failure:
     $ConnectionRetriesLeft--;      $ConnectionRetriesLeft--;
       if($ConnectionRetriesLeft <= 0) {
    Log("CRITICAL", "Host marked dead: ".GetServerHost());
       }
   
 }  }
 #----------------------------- Timer management ------------------------  #----------------------------- Timer management ------------------------
   
Line 326  sub Tick { Line 333  sub Tick {
     if($successCount == 0) { # All connections failed:      if($successCount == 0) { # All connections failed:
  Debug(5,"Work in queue failed to make any connectiouns\n");   Debug(5,"Work in queue failed to make any connectiouns\n");
  EmptyQueue(); # Fail pending transactions with con_lost.   EmptyQueue(); # Fail pending transactions with con_lost.
    CloseAllLondConnections(); # Should all be closed but....
     }      }
  } else {   } else {
     ShowStatus(GetServerHost()." >>> DEAD!!! <<<");      ShowStatus(GetServerHost()." >>> DEAD!!! <<<");
     Debug(5,"Work in queue, but gave up on connections..flushing\n");      Debug(5,"Work in queue, but gave up on connections..flushing\n");
     EmptyQueue(); # Connections can't be established.      EmptyQueue(); # Connections can't be established.
       CloseAllLondConnections(); # Should all already be closed but...
  }   }
                 
     }      }
Line 511  sub CompleteTransaction { Line 520  sub CompleteTransaction {
   
     if (!$Transaction->isDeferred()) { # Normal transaction      if (!$Transaction->isDeferred()) { # Normal transaction
  my $data   = $Socket->GetReply(); # Data to send.   my $data   = $Socket->GetReply(); # Data to send.
    if($LogTransactions) {
       Log("SUCCESS", "Reply from lond: '$data'");
    }
  StartClientReply($Transaction, $data);   StartClientReply($Transaction, $data);
     } else { # Delete deferred transaction file.      } else { # Delete deferred transaction file.
  Log("SUCCESS", "A delayed transaction was completed");   Log("SUCCESS", "A delayed transaction was completed");
Line 518  sub CompleteTransaction { Line 530  sub CompleteTransaction {
  unlink $Transaction->getFile();   unlink $Transaction->getFile();
     }      }
 }  }
   
 =pod  =pod
   
 =head1 StartClientReply  =head1 StartClientReply
   
    Initiates a reply to a client where the reply data is a parameter.     Initiates a reply to a client where the reply data is a parameter.
Line 534  sub CompleteTransaction { Line 548  sub CompleteTransaction {
     The data to send to apached client.      The data to send to apached client.
   
 =cut  =cut
   
 sub StartClientReply {  sub StartClientReply {
     my $Transaction   = shift;      my $Transaction   = shift;
     my $data     = shift;      my $data     = shift;
Line 551  sub StartClientReply { Line 566  sub StartClientReply {
       cb       => \&ClientWritable,        cb       => \&ClientWritable,
       data     => $data);        data     => $data);
 }  }
   
 =pod  =pod
   
 =head2 FailTransaction  =head2 FailTransaction
   
   Finishes a transaction with failure because the associated lond socket    Finishes a transaction with failure because the associated lond socket
Line 561  sub StartClientReply { Line 578  sub StartClientReply {
   - The transaction is 'live' in which case we initiate the sending    - The transaction is 'live' in which case we initiate the sending
     of "con_lost" to the client.      of "con_lost" to the client.
   
 Deleting the transaction means killing it from the   Deleting the transaction means killing it from the %ActiveTransactions hash.
 %ActiveTransactions hash.  
   
 Parameters:  Parameters:
   
Line 570  Parameters: Line 586  Parameters:
     
    The LondTransaction we are failing.     The LondTransaction we are failing.
     
   
 =cut  =cut
   
 sub FailTransaction {  sub FailTransaction {
Line 581  sub FailTransaction { Line 598  sub FailTransaction {
  Debug(1," Replying con_lost to ".$transaction->getRequest());   Debug(1," Replying con_lost to ".$transaction->getRequest());
  StartClientReply($transaction, "con_lost\n");   StartClientReply($transaction, "con_lost\n");
     }      }
     if($ConnectionRetriesLeft <= 0) {  
  Log("CRITICAL", "Host marked dead: ".GetServerHost());  
     }  
   
 }  }
   
Line 611  Close all connections open on lond prior Line 625  Close all connections open on lond prior
 =cut  =cut
 sub CloseAllLondConnections {  sub CloseAllLondConnections {
     foreach my $Socket (keys %ActiveConnections) {      foreach my $Socket (keys %ActiveConnections) {
  KillSocket($Socket);        if(exists($ActiveTransactions{$Socket})) {
    FailTransaction($ActiveTransactions{$Socket});
         }
         KillSocket($Socket);
     }      }
 }  }
 =cut  =cut
Line 655  sub KillSocket { Line 672  sub KillSocket {
     }      }
     if(exists($ActiveConnections{$Socket})) {      if(exists($ActiveConnections{$Socket})) {
  delete($ActiveConnections{$Socket});   delete($ActiveConnections{$Socket});
    $ConnectionCount--;
    if ($ConnectionCount < 0) { $ConnectionCount = 0; }
     }      }
     $ConnectionCount--;  
     if ($ConnectionCount < 0) { $ConnectionCount = 0; }  
     #  If the connection count has gone to zero and there is work in the      #  If the connection count has gone to zero and there is work in the
     #  work queue, the work all gets failed with con_lost.      #  work queue, the work all gets failed with con_lost.
     #      #
     if($ConnectionCount == 0) {      if($ConnectionCount == 0) {
  EmptyQueue();   EmptyQueue();
    CloseAllLondConnections; # Should all already be closed but...
     }      }
 }  }
   
Line 688  The connection must echo the challenge b Line 706  The connection must echo the challenge b
 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.  'ok' from the partner.
   
   =head3  State=ReadingVersionString
   
   We have requested the lond version and are reading the
   version back.  Upon completion, we'll store the version away
   for future use(?).
   
   =head3 State=HostSet
   
   We have selected the domain name of our peer (multhomed hosts)
   and are getting the reply (presumably ok) back.
   
 =head3 State=RequestingKey  =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
Line 742  sub LondReadable { Line 771  sub LondReadable {
     &Debug(2, "Socket->Readable returned: $status");      &Debug(2, "Socket->Readable returned: $status");
   
     if($status != 0) {      if($status != 0) {
  # bad return from socket read. Currently this means that   # bad return from socket read. Currently this means that
  # The socket has become disconnected. We fail the transaction.   # The socket has become disconnected. We fail the transaction.
   
  Log("WARNING",   Log("WARNING",
Line 760  sub LondReadable { Line 789  sub LondReadable {
     $State = $Socket->GetState(); # Update in case of transition.      $State = $Socket->GetState(); # Update in case of transition.
     &Debug(6, "After read, state is ".$State);      &Debug(6, "After read, state is ".$State);
   
    if($State eq "Initialized") {      if($State eq "Initialized") {
   
   
     } elsif ($State eq "ChallengeReceived") {      } elsif ($State eq "ChallengeReceived") {
  #  The challenge must be echoed back;  The state machine   #  The challenge must be echoed back;  The state machine
  # in the connection takes care of setting that up.  Just   # in the connection takes care of setting that up.  Just
  # need to transition to writable:   # need to transition to writable:
   
  $Watcher->cb(\&LondWritable);   $Watcher->cb(\&LondWritable);
  $Watcher->poll("w");   $Watcher->poll("w");
   
     } elsif ($State eq "ChallengeReplied") {      } elsif ($State eq "ChallengeReplied") {
   
       } elsif ($State eq "RequestingVersion") {
    # Need to ask for the version... that is writiability:
   
    $Watcher->cb(\&LondWritable);
    $Watcher->poll("w");
   
       } elsif ($State eq "ReadingVersionString") {
    # Read the rest of the version string... 
       } elsif ($State eq "SetHost") {
    # Need to request the actual domain get set...
   
    $Watcher->cb(\&LondWritable);
    $Watcher->poll("w");
       } elsif ($State eq "HostSet") {
    # Reading the 'ok' from the peer.
   
     } elsif ($State eq "RequestingKey") {      } elsif ($State eq "RequestingKey") {
  #  The ok was received.  Now we need to request the key   #  The ok was received.  Now we need to request the key
Line 784  sub LondReadable { Line 828  sub LondReadable {
     } elsif ($State eq "ReceivingKey") {      } elsif ($State eq "ReceivingKey") {
   
     } elsif ($State eq "Idle") {      } elsif ($State eq "Idle") {
      
    # This is as good a spot as any to get the peer version
    # string:
      
    if($LondVersion eq "unknown") {
       $LondVersion = $Socket->PeerVersion();
       Log("INFO", "Connected to lond version: $LondVersion");
    }
  # If necessary, complete a transaction and then go into the   # If necessary, complete a transaction and then go into the
  # idle queue.   # idle queue.
  #  Note that a trasition to idle indicates a live lond   #  Note that a trasition to idle indicates a live lond
Line 813  sub LondReadable { Line 865  sub LondReadable {
   
   
     } else {      } else {
  # Invalid state.   # Invalid state.
  Debug(4, "Invalid state in LondReadable");   Debug(4, "Invalid state in LondReadable");
     }      }
 }  }
Line 895  sub LondWritable { Line 947  sub LondWritable {
   
     SocketDump(6,$Socket);      SocketDump(6,$Socket);
   
     if      ($State eq "Connected")         {      #  If the socket is writable, we must always write.
       # Only by writing will we undergo state transitions.
  if ($Socket->Writable() != 0) {      # Old logic wrote in state specific code below, however
     #  The write resulted in an error.      # That forces us at least through another invocation of
     # We'll treat this as if the socket got disconnected:      # this function after writability is possible again.
     Log("WARNING", "Connection to ".$RemoteHost.      # This logic also factors out common code for handling
  " has been disconnected");      # write failures... in all cases, write failures 
       # Kill the socket.
       #  This logic makes the branches of the >big< if below
       # so that the writing states are actually NO-OPs.
   
       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");
    if(exists($ActiveTransactions{$Socket})) {
     FailTransaction($ActiveTransactions{$Socket});      FailTransaction($ActiveTransactions{$Socket});
     $Watcher->cancel();  
     KillSocket($Socket);  
     return;  
  }   }
  #  "init" is being sent...   $Watcher->cancel();
    KillSocket($Socket);
    return;
       }
   
   
   
       if      ($State eq "Connected")         {
   
    #  "init" is being sent...
    
     } elsif ($State eq "Initialized")       {      } elsif ($State eq "Initialized")       {
   
  # Now that init was sent, we switch    # Now that init was sent, we switch 
Line 917  sub LondWritable { Line 984  sub LondWritable {
   
  $Watcher->cb(\&LondReadable);   $Watcher->cb(\&LondReadable);
  $Watcher->poll("r");   $Watcher->poll("r");
   
     } elsif ($State eq "ChallengeReceived") {      } elsif ($State eq "ChallengeReceived") {
  # We received the challenge, now we    # We received the challenge, now we 
  # are echoing it back. This is a no-op,   # are echoing it back. This is a no-op,
  # we're waiting for the state to change   # we're waiting for the state to change
   
  if($Socket->Writable() != 0) {  
   
     $Watcher->cancel();  
     KillSocket($Socket);  
     return;  
  }  
   
     } elsif ($State eq "ChallengeReplied")  {      } elsif ($State eq "ChallengeReplied")  {
  # The echo was sent back, so we switch   # The echo was sent back, so we switch
  # to watching readability.   # to watching readability.
   
  $Watcher->cb(\&LondReadable);   $Watcher->cb(\&LondReadable);
  $Watcher->poll("r");   $Watcher->poll("r");
       } elsif ($State eq "RequestingVersion") {
    # Sending the peer a version request...
   
       } elsif ($State eq "ReadingVersionString") {
    # Transition to read since we have sent the
    # version command and now just need to read the
    # version string from the peer:
         
    $Watcher->cb(\&LondReadable);
    $Watcher->poll("r");
         
       } elsif ($State eq "SetHost") {
    #  Setting the remote domain...
   
       } elsif ($State eq "HostSet") {
    # Back to readable to get the ok.
         
    $Watcher->cb(\&LondReadable);
    $Watcher->poll("r");
         
   
     } elsif ($State eq "RequestingKey")     {      } elsif ($State eq "RequestingKey")     {
  # At this time we're requesting the key.   # At this time we're requesting the key.
  # again, this is essentially a no-op.   # again, this is essentially a no-op.
  # we'll write the next chunk until the  
  # state changes.  
   
  if($Socket->Writable() != 0) {  
     # Write resulted in an error.  
   
     $Watcher->cancel();  
     KillSocket($Socket);  
     return;  
   
  }  
     } elsif ($State eq "ReceivingKey")      {      } elsif ($State eq "ReceivingKey")      {
  # Now we need to wait for the key   # Now we need to wait for the key
  # to come back from the peer:   # to come back from the peer:
Line 959  sub LondWritable { Line 1029  sub LondWritable {
  $Watcher->poll("r");   $Watcher->poll("r");
   
     } elsif ($State eq "SendingRequest")    {      } elsif ($State eq "SendingRequest")    {
    
  # At this time we are sending a request to the   # At this time we are sending a request to the
  # peer... write the next chunk:   # peer... write the next chunk:
   
  if($Socket->Writable() != 0) {  
   
     if(exists($ActiveTransactions{$Socket})) {  
  Debug(3, "Lond connection lost, failing transactions");  
  FailTransaction($ActiveTransactions{$Socket});  
     }  
     $Watcher->cancel();  
     KillSocket($Socket);  
     return;  
       
  }  
   
     } elsif ($State eq "ReceivingReply")    {      } elsif ($State eq "ReceivingReply")    {
  # The send has completed.  Wait for the   # The send has completed.  Wait for the
Line 1161  sub QueueTransaction { Line 1221  sub QueueTransaction {
  Debug(5,"Starting additional lond connection");   Debug(5,"Starting additional lond connection");
  if(MakeLondConnection() == 0) {   if(MakeLondConnection() == 0) {
     EmptyQueue(); # Fail transactions, can't make connection.      EmptyQueue(); # Fail transactions, can't make connection.
       CloseAllLondConnections; # Should all be closed but...
  }   }
     } else {      } else {
  ShowStatus(GetServerHost()." >>> DEAD !!!! <<<");   ShowStatus(GetServerHost()." >>> DEAD !!!! <<<");
  EmptyQueue(); # It's worse than that ... he's dead Jim.   EmptyQueue(); # It's worse than that ... he's dead Jim.
    CloseAllLondConnections; # Should all be closed but..
     }      }
  }   }
     } else { # Can start the request:      } else { # Can start the request:
Line 1207  sub ClientRequest { Line 1269  sub ClientRequest {
     Debug(8,"Data: ".$data." this read: ".$thisread);      Debug(8,"Data: ".$data." this read: ".$thisread);
     $data = $data.$thisread; # Append new data.      $data = $data.$thisread; # Append new data.
     $watcher->data($data);      $watcher->data($data);
     if($data =~ /(.*\n)/) { # Request entirely read.      if($data =~ /\n$/) { # Request entirely read.
  if($data eq "close_connection_exit\n") {   if($data eq "close_connection_exit\n") {
     Log("CRITICAL",      Log("CRITICAL",
  "Request Close Connection ... exiting");   "Request Close Connection ... exiting");
Line 1215  sub ClientRequest { Line 1277  sub ClientRequest {
     exit;      exit;
  }   }
  Debug(8, "Complete transaction received: ".$data);   Debug(8, "Complete transaction received: ".$data);
    if($LogTransactions) {
       Log("SUCCESS", "Transaction: '$data'"); # Transaction has \n.
    }
  my $Transaction = LondTransaction->new($data);   my $Transaction = LondTransaction->new($data);
  $Transaction->SetClient($socket);   $Transaction->SetClient($socket);
  QueueTransaction($Transaction);   QueueTransaction($Transaction);
Line 1323  sub SetupLoncListener { Line 1388  sub SetupLoncListener {
       fd     => $socket);        fd     => $socket);
 }  }
   
   #
   #   Toggle transaction logging.
   #  Implicit inputs:  
   #     LogTransactions
   #  Implicit Outputs:
   #     LogTransactions
   sub ToggleTransactionLogging {
       print STDERR "Toggle transaction logging...\n";
       if(!$LogTransactions) {
    $LogTransactions = 1;
       } else {
    $LogTransactions = 0;
       }
   
   
       Log("SUCCESS", "Toggled transaction logging: $LogTransactions \n");
   }
   
 =pod   =pod 
   
 =head2 ChildStatus  =head2 ChildStatus
Line 1333  into the status file. Line 1416  into the status file.
 We also use this to reset the retries count in order to allow the  We also use this to reset the retries count in order to allow the
 client to retry connections with a previously dead server.  client to retry connections with a previously dead server.
 =cut  =cut
   
 sub ChildStatus {  sub ChildStatus {
     my $event = shift;      my $event = shift;
     my $watcher = $event->w;      my $watcher = $event->w;
Line 1342  sub ChildStatus { Line 1426  sub ChildStatus {
     my $fh = IO::File->new(">>$docdir/lon-status/loncstatus.txt");      my $fh = IO::File->new(">>$docdir/lon-status/loncstatus.txt");
     print $fh $$."\t".$RemoteHost."\t".$Status."\t".      print $fh $$."\t".$RemoteHost."\t".$Status."\t".
  $RecentLogEntry."\n";   $RecentLogEntry."\n";
       #
       #  Write out information about each of the connections:
       #
       if ($DebugLevel > 2) {
    print $fh "Active connection statuses: \n";
    my $i = 1;
    print STDERR  "================================= Socket Status Dump:\n";
    foreach my $item (keys %ActiveConnections) {
       my $Socket = $ActiveConnections{$item}->data;
       my $state  = $Socket->GetState();
       print $fh "Connection $i State: $state\n";
       print STDERR "---------------------- Connection $i \n";
       $Socket->Dump();
       $i++;
    }
       }
     $ConnectionRetriesLeft = $ConnectionRetries;      $ConnectionRetriesLeft = $ConnectionRetries;
 }  }
   
Line 1406  sub ChildProcess { Line 1506  sub ChildProcess {
     Event->signal(signal   => "USR1",      Event->signal(signal   => "USR1",
   cb       => \&ChildStatus,    cb       => \&ChildStatus,
   data     => "USR1");    data     => "USR1");
       Event->signal(signal   => "USR2",
     cb       => \&ToggleTransactionLogging);
     Event->signal(signal   => "INT",      Event->signal(signal   => "INT",
   cb       => \&ToggleDebug,    cb       => \&ToggleDebug,
   data     => "INT");    data     => "INT");

Removed from v.1.36  
changed lines
  Added in v.1.46


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