/* Copyright (c) 2010-2013, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file status.c
* \brief Keep status information and log the heartbeat messages.
**/
#include "or.h"
#include "config.h"
#include "status.h"
#include "nodelist.h"
#include "relay.h"
#include "router.h"
#include "circuitlist.h"
#include "main.h"
#include "rephist.h"
#include "hibernate.h"
#include "rephist.h"
#include "statefile.h"
static void log_accounting(const time_t now, const or_options_t *options);
/** Return the total number of circuits. */
static int
count_circuits(void)
{
circuit_t *circ;
int nr=0;
TOR_LIST_FOREACH(circ, circuit_get_global_list(), head)
nr++;
return nr;
}
/** Take seconds secs and return a newly allocated human-readable
* uptime string */
static char *
secs_to_uptime(long secs)
{
long int days = secs / 86400;
int hours = (int)((secs - (days * 86400)) / 3600);
int minutes = (int)((secs - (days * 86400) - (hours * 3600)) / 60);
char *uptime_string = NULL;
switch (days) {
case 0:
tor_asprintf(&uptime_string, "%d:%02d hours", hours, minutes);
break;
case 1:
tor_asprintf(&uptime_string, "%ld day %d:%02d hours",
days, hours, minutes);
break;
default:
tor_asprintf(&uptime_string, "%ld days %d:%02d hours",
days, hours, minutes);
break;
}
return uptime_string;
}
/** Take bytes and returns a newly allocated human-readable usage
* string. */
static char *
bytes_to_usage(uint64_t bytes)
{
char *bw_string = NULL;
if (bytes < (1<<20)) { /* Less than a megabyte. */
tor_asprintf(&bw_string, U64_FORMAT" kB", U64_PRINTF_ARG(bytes>>10));
} else if (bytes < (1<<30)) { /* Megabytes. Let's add some precision. */
double bw = U64_TO_DBL(bytes);
tor_asprintf(&bw_string, "%.2f MB", bw/(1<<20));
} else { /* Gigabytes. */
double bw = U64_TO_DBL(bytes);
tor_asprintf(&bw_string, "%.2f GB", bw/(1<<30));
}
return bw_string;
}
/** Log a "heartbeat" message describing Tor's status and history so that the
* user can know that there is indeed a running Tor. Return 0 on success and
* -1 on failure. */
int
log_heartbeat(time_t now)
{
char *bw_sent = NULL;
char *bw_rcvd = NULL;
char *uptime = NULL;
const routerinfo_t *me;
double r = tls_get_write_overhead_ratio();
const int hibernating = we_are_hibernating();
const or_options_t *options = get_options();
(void)now;
if (public_server_mode(options) && !hibernating) {
/* Let's check if we are in the current cached consensus. */
if (!(me = router_get_my_routerinfo()))
return -1; /* Something stinks, we won't even attempt this. */
else
if (!node_get_by_id(me->cache_info.identity_digest))
log_fn(LOG_NOTICE, LD_HEARTBEAT, "Heartbeat: It seems like we are not "
"in the cached consensus.");
}
uptime = secs_to_uptime(get_uptime());
bw_rcvd = bytes_to_usage(get_bytes_read());
bw_sent = bytes_to_usage(get_bytes_written());
log_fn(LOG_NOTICE, LD_HEARTBEAT, "Heartbeat: Tor's uptime is %s, with %d "
"circuits open. I've sent %s and received %s.%s",
uptime, count_circuits(),bw_sent,bw_rcvd,
hibernating?" We are currently hibernating.":"");
if (server_mode(options) && accounting_is_enabled(options) && !hibernating) {
log_accounting(now, options);
}
if (stats_n_data_cells_packaged && !hibernating)
log_notice(LD_HEARTBEAT, "Average packaged cell fullness: %2.3f%%",
100*(U64_TO_DBL(stats_n_data_bytes_packaged) /
U64_TO_DBL(stats_n_data_cells_packaged*RELAY_PAYLOAD_SIZE)) );
if (r > 1.0) {
double overhead = ( r - 1.0 ) * 100.0;
log_notice(LD_HEARTBEAT, "TLS write overhead: %.f%%", overhead);
}
if (public_server_mode(options))
rep_hist_log_circuit_handshake_stats(now);
tor_free(uptime);
tor_free(bw_sent);
tor_free(bw_rcvd);
return 0;
}
static void
log_accounting(const time_t now, const or_options_t *options)
{
or_state_t *state = get_or_state();
char *acc_rcvd = bytes_to_usage(state->AccountingBytesReadInInterval);
char *acc_sent = bytes_to_usage(state->AccountingBytesWrittenInInterval);
char *acc_max = bytes_to_usage(options->AccountingMax);
time_t interval_end = accounting_get_end_time();
char end_buf[ISO_TIME_LEN + 1];
char *remaining = NULL;
format_local_iso_time(end_buf, interval_end);
remaining = secs_to_uptime(interval_end - now);
log_notice(LD_HEARTBEAT, "Heartbeat: Accounting enabled. "
"Sent: %s / %s, Received: %s / %s. The "
"current accounting interval ends on %s, in %s.",
acc_sent, acc_max, acc_rcvd, acc_max, end_buf, remaining);
tor_free(acc_rcvd);
tor_free(acc_sent);
tor_free(acc_max);
tor_free(remaining);
}