/usr/share/perl5/Log/Log4perl/Util/TimeTracker.pm is in liblog-log4perl-perl 1.41-1.1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 31 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 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 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 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 204 205 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 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 | ##################################################
package Log::Log4perl::Util::TimeTracker;
##################################################
use 5.006;
use strict;
use warnings;
use Log::Log4perl::Util;
use Carp;
our $TIME_HIRES_AVAILABLE;
BEGIN {
# Check if we've got Time::HiRes. If not, don't make a big fuss,
# just set a flag so we know later on that we can't have fine-grained
# time stamps
$TIME_HIRES_AVAILABLE = 0;
if(Log::Log4perl::Util::module_available("Time::HiRes")) {
require Time::HiRes;
$TIME_HIRES_AVAILABLE = 1;
}
}
##################################################
sub new {
##################################################
my $class = shift;
$class = ref ($class) || $class;
my $self = {
reset_time => undef,
@_,
};
$self->{time_function} = \&_gettimeofday unless
defined $self->{time_function};
bless $self, $class;
$self->reset();
return $self;
}
##################################################
sub hires_available {
##################################################
return $TIME_HIRES_AVAILABLE;
}
##################################################
sub _gettimeofday {
##################################################
# Return secs and optionally msecs if we have Time::HiRes
if($TIME_HIRES_AVAILABLE) {
return (Time::HiRes::gettimeofday());
} else {
return (time(), 0);
}
}
##################################################
sub gettimeofday {
##################################################
my($self) = @_;
my($seconds, $microseconds) = $self->{time_function}->();
$microseconds = 0 if ! defined $microseconds;
return($seconds, $microseconds);
}
##################################################
sub reset {
##################################################
my($self) = @_;
my $current_time = [$self->gettimeofday()];
$self->{reset_time} = $current_time;
$self->{last_call_time} = $current_time;
return $current_time;
}
##################################################
sub time_diff {
##################################################
my($time_from, $time_to) = @_;
my $seconds = $time_to->[0] -
$time_from->[0];
my $milliseconds = int(( $time_to->[1] -
$time_from->[1] ) / 1000);
if($milliseconds < 0) {
$milliseconds = 1000 + $milliseconds;
$seconds--;
}
return($seconds, $milliseconds);
}
##################################################
sub milliseconds {
##################################################
my($self, $current_time) = @_;
$current_time = [ $self->gettimeofday() ] unless
defined $current_time;
my($seconds, $milliseconds) = time_diff(
$self->{reset_time},
$current_time);
return $seconds*1000 + $milliseconds;
}
##################################################
sub delta_milliseconds {
##################################################
my($self, $current_time) = @_;
$current_time = [ $self->gettimeofday() ] unless
defined $current_time;
my($seconds, $milliseconds) = time_diff(
$self->{last_call_time},
$current_time);
$self->{last_call_time} = $current_time;
return $seconds*1000 + $milliseconds;
}
1;
__END__
=head1 NAME
Log::Log4perl::Util::TimeTracker - Track time elapsed
=head1 SYNOPSIS
use Log::Log4perl::Util::TimeTracker;
my $timer = Log::Log4perl::Util::TimeTracker->new();
# equivalent to Time::HiRes::gettimeofday(), regardless
# if Time::HiRes is present or not.
my($seconds, $microseconds) = $timer->gettimeofday();
# reset internal timer
$timer->reset();
# return milliseconds since last reset
$msecs = $timer->milliseconds();
# return milliseconds since last call
$msecs = $timer->delta_milliseconds();
=head1 DESCRIPTION
This utility module helps tracking time elapsed for PatternLayout's
date and time placeholders. Its accuracy depends on the availability
of the Time::HiRes module. If it's available, its granularity is
milliseconds, if not, seconds.
The most common use of this module is calling the gettimeofday()
method:
my($seconds, $microseconds) = $timer->gettimeofday();
It returns seconds and microseconds of the current epoch time. If
Time::HiRes is installed, it will simply defer to its gettimeofday()
function, if it's missing, time() will be called instead and $microseconds
will always be 0.
To measure time elapsed in milliseconds, use the reset() method to
reset the timer to the current time, followed by one or more calls to
the milliseconds() method:
# reset internal timer
$timer->reset();
# return milliseconds since last reset
$msecs = $timer->milliseconds();
On top of the time span between the last reset and the current time,
the module keeps track of the time between calls to delta_milliseconds():
$msecs = $timer->delta_milliseconds();
On the first call, this will return the number of milliseconds since the
last reset(), on subsequent calls, it will return the time elapsed in
milliseconds since the last call to delta_milliseconds() instead. Note
that reset() also resets the time of the last call.
The internal timer of this module gets its time input from the POSIX time()
function, or, if the Time::HiRes module is available, from its
gettimeofday() function. To figure out which one it is, use
if( $timer->hires_available() ) {
print "Hooray, we get real milliseconds!\n";
} else {
print "Milliseconds are just bogus\n";
}
For testing purposes, a different time source can be provided, so test
suites can simulate time passing by without actually having to wait:
my $start_time = time();
my $timer = Log::Log4perl::Util::TimeTracker->new(
time_function => sub {
return $start_time++;
},
);
Every call to $timer->epoch() will then return a time value that is one
second ahead of the the value returned on the previous call. This also means
that every call to delta_milliseconds() will return a value that exceeds
the value returned on the previous call by 1000.
=head1 LICENSE
Copyright 2002-2013 by Mike Schilli E<lt>m@perlmeister.comE<gt>
and Kevin Goess E<lt>cpan@goess.orgE<gt>.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 AUTHOR
Please contribute patches to the project on Github:
http://github.com/mschilli/log4perl
Send bug reports or requests for enhancements to the authors via our
MAILING LIST (questions, bug reports, suggestions/patches):
log4perl-devel@lists.sourceforge.net
Authors (please contact them via the list above, not directly):
Mike Schilli <m@perlmeister.com>,
Kevin Goess <cpan@goess.org>
Contributors (in alphabetical order):
Ateeq Altaf, Cory Bennett, Jens Berthold, Jeremy Bopp, Hutton
Davidson, Chris R. Donnelly, Matisse Enzer, Hugh Esco, Anthony
Foiani, James FitzGibbon, Carl Franks, Dennis Gregorovic, Andy
Grundman, Paul Harrington, Alexander Hartmaier David Hull,
Robert Jacobson, Jason Kohles, Jeff Macdonald, Markus Peter,
Brett Rann, Peter Rabbitson, Erik Selberg, Aaron Straup Cope,
Lars Thegler, David Viner, Mac Yang.
|