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 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
|
/***************************************************************************
* timing.cc -- Functions related to computing scan timing (such as *
* keeping track of and adjusting smoothed round trip times, statistical *
* deviations, timeout values, etc. Various user options (such as the *
* timing policy (-T)) also play a role in these calculations *
* *
***********************IMPORTANT NMAP LICENSE TERMS************************
* *
* The Nmap Security Scanner is (C) 1996-2012 Insecure.Com LLC. Nmap is *
* also a registered trademark of Insecure.Com LLC. This program is free *
* software; you may redistribute and/or modify it under the terms of the *
* GNU General Public License as published by the Free Software *
* Foundation; Version 2 with the clarifications and exceptions described *
* below. This guarantees your right to use, modify, and redistribute *
* this software under certain conditions. If you wish to embed Nmap *
* technology into proprietary software, we sell alternative licenses *
* (contact sales@insecure.com). Dozens of software vendors already *
* license Nmap technology such as host discovery, port scanning, OS *
* detection, version detection, and the Nmap Scripting Engine. *
* *
* Note that the GPL places important restrictions on "derived works", yet *
* it does not provide a detailed definition of that term. To avoid *
* misunderstandings, we interpret that term as broadly as copyright law *
* allows. For example, we consider an application to constitute a *
* "derivative work" for the purpose of this license if it does any of the *
* following: *
* o Integrates source code from Nmap *
* o Reads or includes Nmap copyrighted data files, such as *
* nmap-os-db or nmap-service-probes. *
* o Executes Nmap and parses the results (as opposed to typical shell or *
* execution-menu apps, which simply display raw Nmap output and so are *
* not derivative works.) *
* o Integrates/includes/aggregates Nmap into a proprietary executable *
* installer, such as those produced by InstallShield. *
* o Links to a library or executes a program that does any of the above *
* *
* The term "Nmap" should be taken to also include any portions or derived *
* works of Nmap, as well as other software we distribute under this *
* license such as Zenmap, Ncat, and Nping. This list is not exclusive, *
* but is meant to clarify our interpretation of derived works with some *
* common examples. Our interpretation applies only to Nmap--we don't *
* speak for other people's GPL works. *
* *
* If you have any questions about the GPL licensing restrictions on using *
* Nmap in non-GPL works, we would be happy to help. As mentioned above, *
* we also offer alternative license to integrate Nmap into proprietary *
* applications and appliances. These contracts have been sold to dozens *
* of software vendors, and generally include a perpetual license as well *
* as providing for priority support and updates. They also fund the *
* continued development of Nmap. Please email sales@insecure.com for *
* further information. *
* *
* As a special exception to the GPL terms, Insecure.Com LLC grants *
* permission to link the code of this program with any version of the *
* OpenSSL library which is distributed under a license identical to that *
* listed in the included docs/licenses/OpenSSL.txt file, and distribute *
* linked combinations including the two. You must obey the GNU GPL in all *
* respects for all of the code used other than OpenSSL. If you modify *
* this file, you may extend this exception to your version of the file, *
* but you are not obligated to do so. *
* *
* If you received these files with a written license agreement or *
* contract stating terms other than the terms above, then that *
* alternative license agreement takes precedence over these comments. *
* *
* Source is provided to this software because we believe users have a *
* right to know exactly what a program is going to do before they run it. *
* This also allows you to audit the software for security holes (none *
* have been found so far). *
* *
* Source code also allows you to port Nmap to new platforms, fix bugs, *
* and add new features. You are highly encouraged to send your changes *
* to nmap-dev@insecure.org for possible incorporation into the main *
* distribution. By sending these changes to Fyodor or one of the *
* Insecure.Org development mailing lists, or checking them into the Nmap *
* source code repository, it is understood (unless you specify otherwise) *
* that you are offering the Nmap Project (Insecure.Com LLC) the *
* unlimited, non-exclusive right to reuse, modify, and relicense the *
* code. Nmap will always be available Open Source, but this is important *
* because the inability to relicense code has caused devastating problems *
* for other Free Software projects (such as KDE and NASM). We also *
* occasionally relicense the code to third parties as discussed above. *
* If you wish to specify special license conditions of your *
* contributions, just say so when you send them. *
* *
* This program 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 v2.0 for more details at *
* http://www.gnu.org/licenses/gpl-2.0.html , or in the COPYING file *
* included with Nmap. *
* *
***************************************************************************/
/* $Id: timing.cc 28415 2012-04-07 08:16:08Z david $ */
#include "timing.h"
#include "NmapOps.h"
#include "utils.h"
#include "xml.h"
extern NmapOps o;
/* Call this function on a newly allocated struct timeout_info to
initialize the values appropriately */
void initialize_timeout_info(struct timeout_info *to) {
to->srtt = -1;
to->rttvar = -1;
to->timeout = o.initialRttTimeout() * 1000;
}
/* Adjust our timeout values based on the time the latest probe took for a
response. We update our RTT averages, etc. */
void adjust_timeouts(struct timeval sent, struct timeout_info *to) {
struct timeval received;
gettimeofday(&received, NULL);
adjust_timeouts2(&sent, &received, to);
return;
}
/* Same as adjust_timeouts(), except this one allows you to specify
the receive time too (which could be because it was received a while
back or it could be for efficiency because the caller already knows
the current time */
void adjust_timeouts2(const struct timeval *sent,
const struct timeval *received,
struct timeout_info *to) {
long delta = 0;
if (o.debugging > 3) {
log_write(LOG_STDOUT, "Timeout vals: srtt: %d rttvar: %d to: %d ", to->srtt, to->rttvar, to->timeout);
}
delta = TIMEVAL_SUBTRACT(*received, *sent);
/* Argh ... pcap receive time is sometimes a little off my
getimeofday() results on various platforms :(. So a packet may
appear to be received as much as a hundredth of a second before
it was sent. So I will allow small negative RTT numbers */
if (delta < 0 && delta > -50000) {
if (o.debugging > 2)
log_write(LOG_STDOUT, "Small negative delta (probably due to libpcap time / gettimeofday() discrepancy) - adjusting from %lius to %dus\n", delta, 10000);
delta = 10000;
}
if (to->srtt == -1 && to->rttvar == -1) {
/* We need to initialize the sucker ... */
to->srtt = delta;
to->rttvar = MAX(5000, MIN(to->srtt, 2000000));
to->timeout = to->srtt + (to->rttvar << 2);
} else {
long rttdelta;
if (delta >= 8000000 || delta < 0) {
if (o.verbose)
error("%s: packet supposedly had rtt of %ld microseconds. Ignoring time.", __func__, delta);
return;
}
rttdelta = delta - to->srtt;
/* sanity check 2*/
if (rttdelta > 1500000 && rttdelta > 3 * to->srtt + 2 * to->rttvar) {
if (o.debugging) {
log_write(LOG_STDOUT, "Bogus rttdelta: %ld (srtt %d) ... ignoring\n", rttdelta, to->srtt);
}
return;
}
to->srtt += rttdelta >> 3;
to->rttvar += (ABS(rttdelta) - to->rttvar) >> 2;
to->timeout = to->srtt + (to->rttvar << 2);
}
if (to->rttvar > 2300000) {
error("RTTVAR has grown to over 2.3 seconds, decreasing to 2.0");
to->rttvar = 2000000;
}
/* It hurts to do this ... it really does ... but otherwise we are being
too risky */
to->timeout = box(o.minRttTimeout() * 1000, o.maxRttTimeout() * 1000,
to->timeout);
if (o.scan_delay)
to->timeout = MAX((unsigned) to->timeout, o.scan_delay * 1000);
if (o.debugging > 3) {
log_write(LOG_STDOUT, "delta %ld ==> srtt: %d rttvar: %d to: %d\n", delta, to->srtt, to->rttvar, to->timeout);
}
/* if (to->srtt < 0 || to->rttvar < 0 || to->timeout < 0 || delta < -50000000 ||
sent->tv_sec == 0 || received->tv_sec == 0 ) {
fatal("Serious time computation problem in adjust_timeout ... received = (%ld, %ld) sent=(%ld,%ld) delta = %ld srtt = %d rttvar = %d to = %d", (long) received->tv_sec, (long)received->tv_usec, (long) sent->tv_sec, (long) sent->tv_usec, delta, to->srtt, to->rttvar, to->timeout);
} */
}
/* Sleeps if necessary to ensure that it isn't called twice within less
time than o.send_delay. If it is passed a non-null tv, the POST-SLEEP
time is recorded in it */
void enforce_scan_delay(struct timeval *tv) {
static int init = -1;
static struct timeval lastcall;
struct timeval now;
int time_diff;
if (!o.scan_delay) {
if (tv) gettimeofday(tv, NULL);
return;
}
if (init == -1) {
gettimeofday(&lastcall, NULL);
init = 0;
if (tv)
memcpy(tv, &lastcall, sizeof(struct timeval));
return;
}
gettimeofday(&now, NULL);
time_diff = TIMEVAL_MSEC_SUBTRACT(now, lastcall);
if (time_diff < (int) o.scan_delay) {
if (o.debugging > 1) {
log_write(LOG_PLAIN, "Sleeping for %d milliseconds in %s()\n", o.scan_delay - time_diff, __func__);
}
usleep((o.scan_delay - time_diff) * 1000);
gettimeofday(&lastcall, NULL);
} else
memcpy(&lastcall, &now, sizeof(struct timeval));
if (tv) {
memcpy(tv, &lastcall, sizeof(struct timeval));
}
return;
}
/* Returns the scaling factor to use when incrementing the congestion
window. */
double ultra_timing_vals::cc_scale(const struct scan_performance_vars *perf) {
double ratio;
assert(num_replies_received > 0);
ratio = (double) num_replies_expected / num_replies_received;
return MIN(ratio, perf->cc_scale_max);
}
/* Update congestion variables for the receipt of a reply. */
void ultra_timing_vals::ack(const struct scan_performance_vars *perf, double scale) {
num_replies_received++;
if (cwnd < ssthresh) {
/* In slow start mode. "During slow start, a TCP increments cwnd by at most
SMSS bytes for each ACK received that acknowledges new data." */
cwnd += perf->slow_incr * cc_scale(perf) * scale;
if (cwnd > ssthresh)
cwnd = ssthresh;
} else {
/* Congestion avoidance mode. "During congestion avoidance, cwnd is
incremented by 1 full-sized segment per round-trip time (RTT). The
equation
cwnd += SMSS*SMSS/cwnd
provides an acceptable approximation to the underlying principle of
increasing cwnd by 1 full-sized segment per RTT." */
cwnd += perf->ca_incr / cwnd * cc_scale(perf) * scale;
}
if (cwnd > perf->max_cwnd)
cwnd = perf->max_cwnd;
}
/* Update congestion variables for a detected drop. */
void ultra_timing_vals::drop(unsigned in_flight,
const struct scan_performance_vars *perf, const struct timeval *now) {
/* "When a TCP sender detects segment loss using the retransmission timer, the
value of ssthresh MUST be set to no more than the value
ssthresh = max (FlightSize / 2, 2*SMSS)
Furthermore, upon a timeout cwnd MUST be set to no more than the loss
window, LW, which equals 1 full-sized segment (regardless of the value of
IW)." */
cwnd = perf->low_cwnd;
ssthresh = (int) MAX(in_flight / perf->host_drop_ssthresh_divisor, 2);
last_drop = *now;
}
/* Update congestion variables for a detected drop, but less aggressively for
group congestion control. */
void ultra_timing_vals::drop_group(unsigned in_flight,
const struct scan_performance_vars *perf, const struct timeval *now) {
cwnd = MAX(perf->low_cwnd, cwnd / perf->group_drop_cwnd_divisor);
ssthresh = (int) MAX(in_flight / perf->group_drop_ssthresh_divisor, 2);
last_drop = *now;
}
/* Do initialization after the global NmapOps table has been filled in. */
void scan_performance_vars::init() {
/* TODO: I should revisit these values for tuning. They should probably
at least be affected by -T. */
low_cwnd = o.min_parallelism ? o.min_parallelism : 1;
max_cwnd = MAX(low_cwnd, o.max_parallelism ? o.max_parallelism : 300);
group_initial_cwnd = box(low_cwnd, max_cwnd, 10);
host_initial_cwnd = group_initial_cwnd;
slow_incr = 1;
/* The congestion window grows faster with more aggressive timing. */
if (o.timing_level < 4)
ca_incr = 1;
else
ca_incr = 2;
cc_scale_max = 50;
initial_ssthresh = 75;
group_drop_cwnd_divisor = 2.0;
/* Change the amount that ssthresh drops based on the timing level. */
double ssthresh_divisor;
if (o.timing_level <= 3)
ssthresh_divisor = (3.0 / 2.0);
else if (o.timing_level <= 4)
ssthresh_divisor = (4.0 / 3.0);
else
ssthresh_divisor = (5.0 / 4.0);
group_drop_ssthresh_divisor = ssthresh_divisor;
host_drop_ssthresh_divisor = ssthresh_divisor;
}
/* current_rate_history defines how far back (in seconds) we look when
calculating the current rate. */
RateMeter::RateMeter(double current_rate_history) {
this->current_rate_history = current_rate_history;
start_tv.tv_sec = 0;
start_tv.tv_usec = 0;
stop_tv.tv_sec = 0;
stop_tv.tv_usec = 0;
last_update_tv.tv_sec = 0;
last_update_tv.tv_usec = 0;
total = 0.0;
current_rate = 0.0;
assert(!isSet(&start_tv));
assert(!isSet(&stop_tv));
}
void RateMeter::start(const struct timeval *now) {
assert(!isSet(&start_tv));
assert(!isSet(&stop_tv));
if (now == NULL)
gettimeofday(&start_tv, NULL);
else
start_tv = *now;
}
void RateMeter::stop(const struct timeval *now) {
assert(isSet(&start_tv));
assert(!isSet(&stop_tv));
if (now == NULL)
gettimeofday(&stop_tv, NULL);
else
stop_tv = *now;
}
/* Update the rates to reflect the given amount added to the total at the time
now. If now is NULL, get the current time with gettimeofday. */
void RateMeter::update(double amount, const struct timeval *now) {
struct timeval tv;
double diff;
double interval;
double count;
assert(isSet(&start_tv));
assert(!isSet(&stop_tv));
/* Update the total. */
total += amount;
if (now == NULL) {
gettimeofday(&tv, NULL);
now = &tv;
}
if (!isSet(&last_update_tv))
last_update_tv = start_tv;
/* Calculate the approximate moving average of how much was recorded in the
last current_rate_history seconds. This average is what is returned as the
"current" rate. */
/* How long since the last update? */
diff = TIMEVAL_SUBTRACT(*now, last_update_tv) / 1000000.0;
if (diff < -current_rate_history)
/* This happened farther in the past than we care about. */
return;
if (diff < 0.0) {
/* If the event happened in the past, just add it into the total and don't
change last_update_tv, as if it had happened at the same time as the most
recent event. */
now = &last_update_tv;
diff = 0.0;
}
/* Find out how far back in time to look. We want to look back
current_rate_history seconds, or to when the last update occurred,
whichever is longer. However, we never look past the start. */
struct timeval tmp;
/* Find the time current_rate_history seconds after the start. That's our
threshold for deciding how far back to look. */
TIMEVAL_ADD(tmp, start_tv, (time_t) (current_rate_history * 1000000.0));
if (TIMEVAL_AFTER(*now, tmp))
interval = MAX(current_rate_history, diff);
else
interval = TIMEVAL_SUBTRACT(*now, start_tv) / 1000000.0;
assert(diff <= interval);
/* If we record an amount in the very same instant that the timer is started,
there's no way to calculate meaningful rates. Ignore it. */
if (interval == 0.0)
return;
/* To calculate the approximate average of the rate over the last
interval seconds, we assume that the rate was constant over that interval.
We calculate how much would have been received in that interval, ignoring
the first diff seconds' worth:
(interval - diff) * current_rate.
Then we add how much was received in the most recent diff seconds. Divide
by the width of the interval to get the average. */
count = (interval - diff) * current_rate + amount;
current_rate = count / interval;
last_update_tv = *now;
}
double RateMeter::getOverallRate(const struct timeval *now) const {
double elapsed;
elapsed = elapsedTime(now);
if (elapsed <= 0.0)
return 0.0;
else
return total / elapsed;
}
/* Get the "current" rate (actually a moving average of the last
current_rate_history seconds). If update is true (its default value), lower
the rate to account for the time since the last record. */
double RateMeter::getCurrentRate(const struct timeval *now, bool update) {
if (update)
this->update(0.0, now);
return current_rate;
}
double RateMeter::getTotal(void) const {
return total;
}
/* Get the number of seconds the meter has been running: if it has been stopped,
the amount of time between start and stop, or if it is still running, the
amount of time between start and now. */
double RateMeter::elapsedTime(const struct timeval *now) const {
struct timeval tv;
const struct timeval *end_tv;
assert(isSet(&start_tv));
if (isSet(&stop_tv)) {
end_tv = &stop_tv;
} else if (now == NULL) {
gettimeofday(&tv, NULL);
end_tv = &tv;
} else {
end_tv = now;
}
return TIMEVAL_SUBTRACT(*end_tv, start_tv) / 1000000.0;
}
/* Returns true if tv has been initialized; i.e., its members are not all
zero. */
bool RateMeter::isSet(const struct timeval *tv) {
return tv->tv_sec != 0 || tv->tv_usec != 0;
}
PacketRateMeter::PacketRateMeter(double current_rate_history) {
packet_rate_meter = RateMeter(current_rate_history);
byte_rate_meter = RateMeter(current_rate_history);
}
void PacketRateMeter::start(const struct timeval *now) {
packet_rate_meter.start(now);
byte_rate_meter.start(now);
}
void PacketRateMeter::stop(const struct timeval *now) {
packet_rate_meter.stop(now);
byte_rate_meter.stop(now);
}
/* Record one packet of length len. */
void PacketRateMeter::update(u32 len, const struct timeval *now) {
packet_rate_meter.update(1, now);
byte_rate_meter.update(len, now);
}
double PacketRateMeter::getOverallPacketRate(const struct timeval *now) const {
return packet_rate_meter.getOverallRate(now);
}
double PacketRateMeter::getCurrentPacketRate(const struct timeval *now, bool update) {
return packet_rate_meter.getCurrentRate(now, update);
}
double PacketRateMeter::getOverallByteRate(const struct timeval *now) const {
return byte_rate_meter.getOverallRate(now);
}
double PacketRateMeter::getCurrentByteRate(const struct timeval *now, bool update) {
return byte_rate_meter.getCurrentRate(now, update);
}
unsigned long long PacketRateMeter::getNumPackets(void) const {
return (unsigned long long) packet_rate_meter.getTotal();
}
unsigned long long PacketRateMeter::getNumBytes(void) const {
return (unsigned long long) byte_rate_meter.getTotal();
}
ScanProgressMeter::ScanProgressMeter(const char *stypestr) {
scantypestr = strdup(stypestr);
gettimeofday(&begin, NULL);
last_print_test = begin;
memset(&last_print, 0, sizeof(last_print));
memset(&last_est, 0, sizeof(last_est));
beginOrEndTask(&begin, NULL, true);
}
ScanProgressMeter::~ScanProgressMeter() {
if (scantypestr) {
free(scantypestr);
scantypestr = NULL;
}
}
/* Decides whether a timing report is likely to even be
printed. There are stringent limitations on how often they are
printed, as well as the verbosity level that must exist. So you
might as well check this before spending much time computing
progress info. now can be NULL if caller doesn't have the current
time handy. Just because this function returns true does not mean
that the next printStatsIfNecessary will always print something.
It depends on whether time estimates have changed, which this func
doesn't even know about. */
bool ScanProgressMeter::mayBePrinted(const struct timeval *now) {
struct timeval tv;
if (!o.verbose)
return false;
if (!now) {
gettimeofday(&tv, NULL);
now = (const struct timeval *) &tv;
}
if (last_print.tv_sec == 0) {
/* We've never printed before -- the rules are less stringent */
if (difftime(now->tv_sec, begin.tv_sec) > 30)
return true;
else
return false;
}
if (difftime(now->tv_sec, last_print_test.tv_sec) < 3)
return false; /* No point even checking too often */
/* We'd never want to print more than once per 30 seconds */
if (difftime(now->tv_sec, last_print.tv_sec) < 30)
return false;
return true;
}
/* Return an estimate of the time remaining if a process was started at begin
and is perc_done of the way finished. Returns inf if perc_done == 0.0. */
static double estimate_time_left(double perc_done,
const struct timeval *begin,
const struct timeval *now) {
double time_used_s;
double time_needed_s;
time_used_s = difftime(now->tv_sec, begin->tv_sec);
time_needed_s = time_used_s / perc_done;
return time_needed_s - time_used_s;
}
/* Prints an estimate of when this scan will complete. It only does
so if mayBePrinted() is true, and it seems reasonable to do so
because the estimate has changed significantly. Returns whether
or not a line was printed.*/
bool ScanProgressMeter::printStatsIfNecessary(double perc_done,
const struct timeval *now) {
struct timeval tvtmp;
double time_left_s;
bool printit = false;
if (!now) {
gettimeofday(&tvtmp, NULL);
now = (const struct timeval *) &tvtmp;
}
if (!mayBePrinted(now))
return false;
last_print_test = *now;
if (perc_done <= 0.003)
return false; /* Need more info first */
assert(perc_done <= 1.0);
time_left_s = estimate_time_left(perc_done, &begin, now);
if (time_left_s < 30)
return false; /* No point in updating when it is virtually finished. */
if (last_est.tv_sec == 0) {
/* We don't have an estimate yet (probably means a low completion). */
printit = true;
} else if (TIMEVAL_AFTER(*now, last_est)) {
/* The last estimate we printed has passed. Print a new one. */
printit = true;
} else {
/* If the estimate changed by more than 3 minutes, and if that change
represents at least 5% of the total time, print it. */
double prev_est_total_time_s = difftime(last_est.tv_sec, begin.tv_sec);
double prev_est_time_left_s = difftime(last_est.tv_sec, last_print.tv_sec);
double change_abs_s = ABS(prev_est_time_left_s - time_left_s);
if (o.debugging || (change_abs_s > 15 && change_abs_s > .05 * prev_est_total_time_s))
printit = true;
}
if (printit) {
return printStats(perc_done, now);
}
return false;
}
/* Prints an estimate of when this scan will complete. */
bool ScanProgressMeter::printStats(double perc_done,
const struct timeval *now) {
struct timeval tvtmp;
double time_left_s;
time_t timet;
struct tm *ltime;
if (!now) {
gettimeofday(&tvtmp, NULL);
now = (const struct timeval *) &tvtmp;
}
last_print = *now;
// If we're less than 1% done we probably don't have enough
// data for decent timing estimates. Also with perc_done == 0
// these elements will be nonsensical.
if (perc_done < 0.01) {
log_write(LOG_STDOUT, "%s Timing: About %.2f%% done\n",
scantypestr, perc_done * 100);
log_flush(LOG_STDOUT);
return true;
}
/* Add 0.5 to get the effect of rounding in integer calculations. */
time_left_s = estimate_time_left(perc_done, &begin, now) + 0.5;
last_est = *now;
last_est.tv_sec += (time_t)time_left_s;
/* Get the estimated time of day at completion */
timet = last_est.tv_sec;
ltime = localtime(&timet);
assert(ltime);
log_write(LOG_STDOUT, "%s Timing: About %.2f%% done; ETC: %02d:%02d (%.f:%02.f:%02.f remaining)\n",
scantypestr, perc_done * 100, ltime->tm_hour, ltime->tm_min,
floor(time_left_s / 60.0 / 60.0),
floor(fmod(time_left_s / 60.0, 60.0)),
floor(fmod(time_left_s, 60.0)));
xml_open_start_tag("taskprogress");
xml_attribute("task", "%s", scantypestr);
xml_attribute("time", "%lu", (unsigned long) now->tv_sec);
xml_attribute("percent", "%.2f", perc_done * 100);
xml_attribute("remaining", "%.f", time_left_s);
xml_attribute("etc", "%lu", (unsigned long) last_est.tv_sec);
xml_close_empty_tag();
xml_newline();
log_flush(LOG_STDOUT|LOG_XML);
return true;
}
/* Indicates that the task is beginning or ending, and that a message should
be generated if appropriate. Returns whether a message was printed.
now may be NULL, if the caller doesn't have the current time handy.
additional_info may be NULL if no additional information is necessary. */
bool ScanProgressMeter::beginOrEndTask(const struct timeval *now, const char *additional_info, bool beginning) {
struct timeval tvtmp;
struct tm *tm;
time_t tv_sec;
if (!o.verbose) {
return false;
}
if (!now) {
gettimeofday(&tvtmp, NULL);
now = (const struct timeval *) &tvtmp;
}
tv_sec = now->tv_sec;
tm = localtime(&tv_sec);
if (beginning) {
log_write(LOG_STDOUT, "Initiating %s at %02d:%02d", scantypestr, tm->tm_hour, tm->tm_min);
xml_open_start_tag("taskbegin");
xml_attribute("task", "%s", scantypestr);
xml_attribute("time", "%lu", (unsigned long) now->tv_sec);
if (additional_info) {
log_write(LOG_STDOUT, " (%s)", additional_info);
xml_attribute("extrainfo", "%s", additional_info);
}
log_write(LOG_STDOUT, "\n");
xml_close_empty_tag();
xml_newline();
} else {
log_write(LOG_STDOUT, "Completed %s at %02d:%02d, %.2fs elapsed", scantypestr, tm->tm_hour, tm->tm_min, TIMEVAL_MSEC_SUBTRACT(*now, begin) / 1000.0);
xml_open_start_tag("taskend");
xml_attribute("task", "%s", scantypestr);
xml_attribute("time", "%lu", (unsigned long) now->tv_sec);
if (additional_info) {
log_write(LOG_STDOUT, " (%s)", additional_info);
xml_attribute("extrainfo", "%s", additional_info);
}
log_write(LOG_STDOUT, "\n");
xml_close_empty_tag();
xml_newline();
}
log_flush(LOG_STDOUT|LOG_XML);
return true;
}
|