Add a ring buffer to debugging + other things

[spider.git] / perl / DXDebug.pm

diff --git a/perl/DXDebug.pm b/perl/DXDebug.pm
index 40cb3a257e1128651683a59dfe6fe0830d3334e3..08703d7c8230e49b780d71821d60cbd65719a1d4 100644 (file)
--- a/perl/DXDebug.pm
+++ b/perl/DXDebug.pm
@@ -2,9 +2,11 @@
 # The system variables - those indicated will need to be changed to suit your
 # circumstances (and callsign)
 #
-# Copyright (c) 1998 - Dirk Koopman G1TLH
+# Copyright (c) 1998-2019 - Dirk Koopman G1TLH
 #
-# $Id$
+# Note: Everything is recorded into the ring buffer (in perl terms: a numerically max sized array).
+#       To allow debugging of a category (e.g. 'chan') but not onto disc (just into the ring buffer)
+#       do: set/debug chan nologchan
 #
 
 package DXDebug;
@@ -14,17 +16,22 @@ require Exporter;
 @EXPORT = qw(dbginit dbg dbgadd dbgsub dbglist dbgdump isdbg dbgclose confess croak cluck);
 
 use strict;
-use vars qw(%dbglevel $fp $callback $cleandays $keepdays);
+use vars qw(%dbglevel $fp $callback $cleandays $keepdays $dbgringlth);
 
 use DXUtil;
 use DXLog ();
 use Carp ();
+use POSIX qw(isatty);
 
 %dbglevel = ();
 $fp = undef;
 $callback = undef;
 $keepdays = 10;
 $cleandays = 100;
+$dbgringlth = 500;
+
+our $no_stdout;                                        # set if not running in a terminal
+our @dbgring;
 
 # Avoid generating "subroutine redefined" warnings with the following
 # hack (from CGI::Carp):
@@ -32,12 +39,16 @@ if (!defined $DB::VERSION) {
        local $^W=0;
        eval qq( sub confess { 
            \$SIG{__DIE__} = 'DEFAULT'; 
+        DXDebug::dbgprintring() unless DXDebug::isdbg('chan');
+        DXDebug::dbgclearring();
         DXDebug::dbg(\$@);
                DXDebug::dbg(Carp::shortmess(\@_));
            exit(-1); 
        }
        sub croak { 
                \$SIG{__DIE__} = 'DEFAULT'; 
+        DXDebug::dbgprintring() unless DXDebug::isdbg('chan');
+        DXDebug::dbgclearring();
         DXDebug::dbg(\$@);
                DXDebug::dbg(Carp::longmess(\@_));
                exit(-1); 
@@ -47,7 +58,8 @@ if (!defined $DB::VERSION) {
        );
 
     CORE::die(Carp::shortmess($@)) if $@;
-} else {
+}
+else {
     eval qq( sub confess { die Carp::longmess(\@_); }; 
                         sub croak { die Carp::shortmess(\@_); }; 
                         sub cluck { warn Carp::longmess(\@_); }; 
@@ -56,6 +68,8 @@ if (!defined $DB::VERSION) {
 } 
 
 
+my $_isdbg;                                            # current dbg level we are processing
+
 sub dbg($)
 {
        return unless $fp;
@@ -66,12 +80,17 @@ sub dbg($)
                my @l = split /\n/, $r;
                for (@l) {
                        s/([\x00-\x08\x0B-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
-                       print "$_\n" if defined \*STDOUT;
+                       print "$_\n" if defined \*STDOUT && !$no_stdout;
                        my $str = "$t^$_";
                        &$callback($str) if $callback;
-                       $fp->writeunix($t, $str); 
+                       if ($dbgringlth) {
+                               shift @dbgring while (@dbgring > $dbgringlth);
+                               push @dbgring, $str;
+                       }
+                       $fp->writeunix($t, $str) unless $dbglevel{"nolog$_isdbg"}; 
                }
        }
+       $_isdbg = '';
 }
 
 sub dbginit
@@ -79,36 +98,51 @@ sub dbginit
        $callback = shift;
        
        # add sig{__DIE__} handling
-       if (!defined $DB::VERSION) {
+       unless (defined $DB::VERSION) {
                $SIG{__WARN__} = sub { 
                        if ($_[0] =~ /Deep\s+recursion/i) {
                                dbg($@);
                                dbg(Carp::longmess(@_)); 
                                CORE::die;
-                       } else { 
+                       }
+                       else { 
                                dbg($@);
                                dbg(Carp::shortmess(@_));
                        }
                };
                
                $SIG{__DIE__} = sub { dbg($@); dbg(Carp::longmess(@_)); };
+
+               # switch off STDOUT printing if we are not talking to a TTY
+               unless ($^O =~ /^MS/ || $^O =~ /^OS-2/) {
+                       unless (isatty(STDOUT->fileno)) {
+                               ++$no_stdout;
+                       }
+               }
        }
 
        $fp = DXLog::new('debug', 'dat', 'd');
+       dbgclearring();
 }
 
 sub dbgclose
 {
        $SIG{__DIE__} = $SIG{__WARN__} = 'DEFAULT';
-       $fp->close() if $fp;
+       if ($fp) {
+               dbgprintring() if grep /nolog/, keys %dbglevel;
+               $fp->close();
+       }
+       dbgclearring();
        undef $fp;
 }
 
 sub dbgdump
 {
+       return unless $fp;
+       
        my $l = shift;
        my $m = shift;
-       if ($fp && ($dbglevel{$l} || $l eq 'err')) {
+       if ($dbglevel{$l} || $l eq 'err') {
                foreach my $l (@_) {
                        for (my $o = 0; $o < length $l; $o += 16) {
                                my $c = substr $l, $o, 16;
@@ -149,7 +183,10 @@ sub dbglist
 sub isdbg($)
 {
        return unless $fp;
-       return $dbglevel{$_[0]};
+       if ($dbglevel{$_[0]}) {
+               $_isdbg = $_[0];
+               return 1;
+    }
 }
 
 sub shortmess 
@@ -158,10 +195,38 @@ sub shortmess
 }
 
 sub longmess 
-{ 
+{
        return Carp::longmess(@_);
 }
 
+sub dbgprintring
+{
+       return unless $fp;
+       my $first;
+       while (my $l = shift @dbgring) {
+               my ($t, $str) = split /\^/, $l, 2;
+               next unless $t;
+               my $lt = time;
+               unless ($first) {
+                       $fp->writeunix($lt, "$lt^###");
+                       $fp->writeunix($lt, "$lt^### RINGBUFFER START");
+                       $fp->writeunix($lt, "$lt^###");
+                       $first = $t;
+               }
+               my $buf = sprintf "%02d:%02d:%02d", (gmtime($t))[2,1,0];
+               $fp->writeunix($lt, "$lt^RING: $buf^$str");
+       }
+       my $et = time;
+       $fp->writeunix($et, "$et^###");
+       $fp->writeunix($et, "$et^### RINGBUFFER END");
+       $fp->writeunix($et, "$et^###");
+}
+
+sub dbgclearring
+{
+       @dbgring = ();
+}
+
 # clean out old debug files, stop when you get a gap of more than a month
 sub dbgclean
 {
@@ -173,7 +238,8 @@ sub dbgclean
                if (-e $fn) {
                        unlink $fn;
                        $i = 0;
-               } else {
+               }
+               else {
                        $i++;
                }
                $date = $date->sub(1);