# 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
#
+# 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
+#
+# To print the current contents into the debug log: show/debug_ring
+#
+# On exit or serious error the ring buffer is printed to the current debug log
+#
+# In Progress:
+# Expose a localhost listener on port (default) 27755 to things like watchdbg so that they can carry on
+# as normal, possibly with a "remember" button to permanently capture stuff observed.
+#
+# Future:
+# This is likely to be some form of triggering or filtering controlling (some portion
+# of) ring_buffer dumping.
#
#
package DXDebug;
+use 5.10.1;
+
require Exporter;
@ISA = qw(Exporter);
-@EXPORT = qw(dbginit dbg dbgadd dbgsub dbglist dbgdump isdbg dbgclose confess croak cluck);
+@EXPORT = qw(dbginit dbg dbgadd dbgsub dbglist dbgdump isdbg dbgclose dbgtrace dbgprintring confess croak cluck carp);
use strict;
-use vars qw(%dbglevel $fp $callback $cleandays $keepdays);
+use vars qw(%dbglevel $fp $callback $cleandays $keepdays $dbgringlth);
use DXUtil;
use DXLog ();
$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):
local $^W=0;
eval qq( sub confess {
\$SIG{__DIE__} = 'DEFAULT';
+ DXDebug::dbgprintring() if DXDebug::isdbg('nologchan');
DXDebug::dbg(\$@);
- DXDebug::dbg(Carp::shortmess(\@_));
+# DXDebug::dbg(Carp::shortmess(\@_));
+ DXDebug::longmess(\@_);
exit(-1);
}
sub croak {
\$SIG{__DIE__} = 'DEFAULT';
+ DXDebug::dbgprintring() if DXDebug::isdbg('nologchan');
DXDebug::dbg(\$@);
- DXDebug::dbg(Carp::longmess(\@_));
+# DXDebug::dbg(Carp::longmess(\@_));
+ DXDebug::shortmess(\@_);
exit(-1);
}
- sub carp { DXDebug::dbg(Carp::shortmess(\@_)); }
- sub cluck { DXDebug::dbg(Carp::longmess(\@_)); }
- );
+ sub carp {
+ DXDebug::dbgprintring(25) if DXDebug('nologchan');
+# DXDebug::dbg(Carp::shortmess(\@_));
+ DXDebug::longmess(\@_);
+ }
+ sub cluck {
+ DXDebug::dbgprintring(25) if DXDebug('nologchan');
+# DXDebug::dbg(Carp::longmess(\@_));
+ DXDebug::longmess(\@_);
+ } );
CORE::die(Carp::shortmess($@)) if $@;
} else {
}
-sub dbg($)
+my $_isdbg = ''; # current dbg level we are processing
+
+# print stack trace
+sub dbgtrace
{
- return unless $fp;
+# say "*** in dbgtrace";
+ $_isdbg = 'trace';
+ dbg(@_);
+ for (my $i = 1; (my ($pkg, $fn, $l, $subr) = caller($i)); ++$i) {
+# say "*** in dbgtrace $i";
+ next if $pkg eq 'DXDebug';
+# say "*** in dbgtrace after package";
+ last if $pkg =~ /Mojo/;
+# say "*** in dbgtrace $i after mojo";
+ $_isdbg = 'trace';
+ dbg("Stack ($i): $pkg::$subr in $fn line: $l");
+ }
+ $_isdbg = '';
+}
+
+sub dbg
+{
+# return unless $fp;
my $t = time;
for (@_) {
my $r = $_;
chomp $r;
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 && !$no_stdout;
- my $str = "$t^$_";
+ foreach my $l (@l) {
+ $l =~ s/([\x00-\x08\x0B-\x1f\x7f-\xff])/sprintf("%%%02X",ord($1))/eg;
+ my $tag = $_isdbg ? "($_isdbg) " : '(*) ';
+ print "$tag$l\n" if defined \*STDOUT && !$no_stdout;
+ my $str = "$t^$tag$l";
&$callback($str) if $callback;
- $fp->writeunix($t, $str);
+ if ($dbgringlth) {
+ shift @dbgring while (@dbgring > $dbgringlth);
+ push @dbgring, $str;
+ }
+ $fp->writeunix($t, $str) unless !$fp || $dbglevel{"nolog$_isdbg"} ;
}
}
+ $_isdbg = '';
}
sub dbginit
{
+ my $basename = shift || 'debug';
$callback = shift;
# add sig{__DIE__} handling
dbg($@);
dbg(Carp::longmess(@_));
CORE::die;
- } else {
+ }
+ else {
dbg($@);
dbg(Carp::shortmess(@_));
}
}
}
- $fp = DXLog::new('debug', 'dat', 'd');
+ $fp = DXLog::new($basename, '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;
}
my $l = shift;
my $m = shift;
if ($dbglevel{$l} || $l eq 'err') {
+ my @out;
foreach my $l (@_) {
for (my $o = 0; $o < length $l; $o += 16) {
my $c = substr $l, $o, 16;
$c =~ s/[\x00-\x1f\x7f-\xff]/./g;
my $left = 16 - length $c;
$h .= ' ' x (2 * $left) if $left > 0;
- dbg($m . sprintf("%4d:", $o) . "$h $c");
+ push @out, $m . sprintf("%4d:", $o) . "$h $c";
$m = ' ' x (length $m);
}
}
- }
+ dbg(@out) if isdbg($l); # yes, I know, I have my reasons;
+ }
}
sub dbgadd
sub isdbg($)
{
return unless $fp;
- return $dbglevel{$_[0]};
+ if ($dbglevel{$_[0]}) {
+ $_isdbg = $_[0];
+ return 1;
+ }
}
sub shortmess
{
- return Carp::shortmess(@_);
+ return dbgtrace(@_);
}
sub longmess
-{
- return Carp::longmess(@_);
+{
+ return dbgtrace(@_);
+}
+
+sub dbgprintring
+{
+ return unless $fp;
+ my $i = shift || 0;
+ my $count = @dbgring;
+ $i = @dbgring-$i if $i;
+ return 0 unless $i < $count; # do nothing if there is nothing to print
+
+ my $first;
+ my $l;
+ for ( ; $i < $count; ++$i) {
+ my ($t, $str) = split /\^/, $dbgring[$i], 2;
+ next unless $t;
+ my $lt = time;
+ unless ($first) {
+ $fp->writeunix($lt, "$lt^###");
+ $fp->writeunix($lt, "$lt^### RINGBUFFER START at line $i (zero base)");
+ $fp->writeunix($lt, "$lt^###");
+ $first = $t;
+ }
+ my $buf = sprintf "%02d:%02d:%02d", (gmtime($t))[2,1,0];
+ $fp->writeunix($lt, "$lt^RING: $buf^$str");
+ ++$l;
+ }
+ my $et = time;
+ $fp->writeunix($et, "$et^###");
+ $fp->writeunix($et, "$et^### RINGBUFFER END $l debug lines written");
+ $fp->writeunix($et, "$et^###");
+ return $l;
+}
+
+sub dbgclearring
+{
+ @dbgring = ();
}
# clean out old debug files, stop when you get a gap of more than a month
if (-e $fn) {
unlink $fn;
$i = 0;
- } else {
+ }
+ else {
$i++;
}
$date = $date->sub(1);
projects / spider.git / blobdiff