tor/src/or/hibernate.c

/* Copyright 2001,2002,2003 Roger Dingledine, Matej Pfajfar. */
/* See LICENSE for licensing information */
/* $Id$ */

/**
 * \file hibernate.c
 * \brief Functions to close listeners, stop allowing new circuits,
 * etc in preparation for closing down or going dormant; and to track
 * bandwidth and time intervals to know when to hibernate and when to
 * stop hibernating.
 **/

/*
hibernating, phase 1:
  - send destroy in response to create cells
  - send end (policy failed) in response to begin cells
  - close an OR conn when it has no circuits

hibernating, phase 2:
  (entered when bandwidth hard limit reached)
  - close all OR/AP/exit conns)
*/

#include "or.h"

#define HIBERNATE_STATE_LIVE 1
#define HIBERNATE_STATE_EXITING 2
#define HIBERNATE_STATE_LOWBANDWIDTH 3
#define HIBERNATE_STATE_DORMANT 4

#define SHUTDOWN_WAIT_LENGTH 30 /* seconds */

extern or_options_t options;

static int hibernate_state = HIBERNATE_STATE_LIVE;
static time_t hibernate_timeout = 0;

/** How many bytes have we read/written in this accounting interval? */
static uint64_t n_bytes_read_in_interval = 0;
static uint64_t n_bytes_written_in_interval = 0;
static uint32_t n_seconds_active_in_interval = 0;
/** When did this accounting interval start? */
static time_t interval_start_time = 0;
/** When will this accounting interval end? */
static time_t interval_end_time = 0;
/** How far into the accounting interval should we hibernate? */
static time_t interval_wakeup_time = 0;

static int read_bandwidth_usage(void);
static int record_bandwidth_usage(time_t now);
static time_t start_of_accounting_period_after(time_t now);
static time_t start_of_accounting_period_containing(time_t now);
static void accounting_set_wakeup_time(void);

/* ************
 * Functions for bandwidth accounting.
 * ************/

void accounting_add_bytes(size_t n_read, size_t n_written, int seconds)
{
  n_bytes_read_in_interval += n_read;
  n_bytes_written_in_interval += n_written;
  /* If we haven't been called in 10 seconds, we're probably jumping
   * around in time. */
  n_seconds_active_in_interval += (seconds < 10) ? seconds : 0;
}

static time_t start_of_accounting_period_containing(time_t now)
{
  struct tm *tm;
  /* Only months are supported. */
  tm = gmtime(&now);
  /* If this is before the Nth, we want the Nth of last month. */
  if (tm->tm_mday < options.AccountingStart) {
    if (--tm->tm_mon < 0) {
      tm->tm_mon = 11;
      --tm->tm_year;
    }
  }
  /* Otherwise, the month and year are correct.*/

  tm->tm_mday = options.AccountingStart;
  tm->tm_hour = 0;
  tm->tm_min = 0;
  tm->tm_sec = 0;
  return tor_timegm(tm);
}
static time_t start_of_accounting_period_after(time_t now)
{
  time_t start;
  struct tm *tm;
  start = start_of_accounting_period_containing(now);

  tm = gmtime(&start);
  if (++tm->tm_mon > 11) {
    tm->tm_mon = 0;
    ++tm->tm_year;
  }
  return tor_timegm(tm);
}

void configure_accounting(time_t now)
{
  if (!interval_start_time)
    read_bandwidth_usage(); /* XXXX009 check warning? */
  if (!interval_start_time ||
      start_of_accounting_period_after(interval_start_time) <= now) {
    /* We start a new interval. */
    log_fn(LOG_INFO, "Starting new accounting interval.");
    interval_start_time = start_of_accounting_period_containing(now);
    interval_end_time = start_of_accounting_period_after(interval_start_time);
    n_bytes_read_in_interval = 0;
    n_bytes_written_in_interval = 0;
  } if (interval_start_time ==
        start_of_accounting_period_containing(interval_start_time)) {
    log_fn(LOG_INFO, "Continuing accounting interval.");
    /* We are in the interval we thought we were in. Do nothing.*/
  } else {
    /* XXXX009 We are in an incompatible interval; we must have
     * changed our configuration.  Do we reset the interval, or
     * what? */
    log_fn(LOG_INFO, "Mismatched accounting interval.");
  }
  accounting_set_wakeup_time();
}

static INLINE int time_to_record_bandwidth_usage(time_t now)
{
  /* Note every 5 minutes */
#define NOTE_INTERVAL (5*60)
  /* Or every 20 megabytes */
#define NOTE_BYTES 20*(1024*1024)
  static uint64_t last_read_bytes_noted = 0;
  static uint64_t last_written_bytes_noted = 0;
  static time_t last_time_noted = 0;

  if ((options.AccountingMaxKB || 1)&&
      (last_time_noted + NOTE_INTERVAL <= now ||
       last_read_bytes_noted + NOTE_BYTES <= n_bytes_read_in_interval ||
       last_written_bytes_noted + NOTE_BYTES <=
           n_bytes_written_in_interval ||
       (interval_end_time && interval_end_time <= now))) {
    last_time_noted = now;
    last_read_bytes_noted = n_bytes_read_in_interval;
    last_written_bytes_noted = n_bytes_written_in_interval;
    return 1;
  }
  return 0;
}

void accounting_run_housekeeping(time_t now)
{
  if (now >= interval_end_time) {
    configure_accounting(now);
  }
  if (time_to_record_bandwidth_usage(now)) {
    if (record_bandwidth_usage(now)) {
      log_fn(LOG_WARN, "Couldn't record bandwidth usage!");
      /* XXXX009 should this exit? */
    }
  }
}

void accounting_set_wakeup_time(void)
{
  struct tm *tm;
  char buf[ISO_TIME_LEN+1];
  char digest[DIGEST_LEN];
  crypto_digest_env_t *d;
  int n_days_in_interval;

  format_iso_time(buf, interval_start_time);
  crypto_pk_get_digest(get_identity_key(), digest);

  d = crypto_new_digest_env();
  crypto_digest_add_bytes(d, buf, ISO_TIME_LEN);
  crypto_digest_add_bytes(d, digest, DIGEST_LEN);
  crypto_digest_get_digest(d, digest, DIGEST_LEN);
  crypto_free_digest_env(d);

  /* XXXX009 This logic is  wrong.  Instead of choosing randomly
   * from the days in the interval, we should avoid days so close to the end
   * that we won't use up all our bandwidth.  This could potentially waste
   * 50% of all donated bandwidth.
   */
  tm = gmtime(&interval_start_time);
  if (++tm->tm_mon > 11) { tm->tm_mon = 0; ++tm->tm_year; }
  n_days_in_interval = (tor_timegm(tm)-interval_start_time+1)/(24*60*60);

  while (((unsigned char)digest[0]) > n_days_in_interval)
    crypto_digest(digest, digest, DIGEST_LEN);

  interval_wakeup_time = interval_start_time +
    24*60*60 * (unsigned char)digest[0];
}

static int record_bandwidth_usage(time_t now)
{
  char buf[128];
  char fname[512];
  char *cp = buf;

  *cp++ = '0';
  *cp++ = ' ';
  format_iso_time(cp, interval_start_time);
  cp += ISO_TIME_LEN;
  *cp++ = ' ';
  format_iso_time(cp, now);
  cp += ISO_TIME_LEN;
  tor_snprintf(cp, sizeof(buf)-ISO_TIME_LEN*2-3,
               " "U64_FORMAT" "U64_FORMAT" %lu\n",
               U64_PRINTF_ARG(n_bytes_read_in_interval),
               U64_PRINTF_ARG(n_bytes_written_in_interval),
               (unsigned long)n_seconds_active_in_interval);
  tor_snprintf(fname, sizeof(fname), "%s/bw_accounting",
               get_data_directory(&options));

  return write_str_to_file(fname, buf, 0);
}

static int read_bandwidth_usage(void)
{
  char *s = NULL;
  char fname[512];
  time_t scratch_time;
  unsigned long sec;

  /*
  if (!options.AccountingMaxKB)
    return 0;
  */
  tor_snprintf(fname, sizeof(fname), "%s/bw_accounting",
               get_data_directory(&options));
  if (!(s = read_file_to_str(fname, 0))) {
    return 0;
  }
  /* version, space, time, space, time, space, bw, space, bw, nl. */
  if (strlen(s) < ISO_TIME_LEN*2+6) {
    log_fn(LOG_WARN,
           "Recorded bandwidth usage file seems truncated or corrupted");
    goto err;
  }
  if (s[0] != '0' || s[1] != ' ') {
    log_fn(LOG_WARN, "Unrecognized version on bandwidth usage file");
    goto err;
  }
  if (parse_iso_time(s+2, &interval_start_time)) {
    log_fn(LOG_WARN, "Error parsing bandwidth usage start time.");
    goto err;
  }
  if (s[ISO_TIME_LEN+2] != ' ') {
    log_fn(LOG_WARN, "Expected space after start time.");
    goto err;
  }
  if (parse_iso_time(s+ISO_TIME_LEN+3, &scratch_time)) {
    log_fn(LOG_WARN, "Error parsing bandwidth usage last-written time");
    goto err;
  }
  if (s[ISO_TIME_LEN+3+ISO_TIME_LEN] != ' ') {
    log_fn(LOG_WARN, "Expected space after last-written time.");
    goto err;
  }
  if (sscanf(s+ISO_TIME_LEN*2+4, U64_FORMAT" "U64_FORMAT" %lu",
             U64_SCANF_ARG(&n_bytes_read_in_interval),
             U64_SCANF_ARG(&n_bytes_written_in_interval),
             &sec)<2) {
    log_fn(LOG_WARN, "Error reading bandwidth usage.");
    goto err;
  }
  n_seconds_active_in_interval = (uint32_t)sec;

  tor_free(s);
  accounting_set_wakeup_time();
  return 0;
 err:
  tor_free(s);
  return -1;
}

static int hibernate_hard_limit_reached(void)
{
  uint64_t hard_limit = options.AccountingMaxKB<<10;
  if (!hard_limit)
    return 0;
  return n_bytes_read_in_interval >= hard_limit
    || n_bytes_written_in_interval >= hard_limit;
}

static int hibernate_soft_limit_reached(void)
{
  uint64_t soft_limit = (uint64_t) ((options.AccountingMaxKB<<10) * .99);
  if (!soft_limit)
    return 0;
  return n_bytes_read_in_interval >= soft_limit
    || n_bytes_written_in_interval >= soft_limit;
}

static time_t hibernate_calc_wakeup_time(void)
{
  if (interval_wakeup_time > time(NULL))
    return interval_wakeup_time;
  else
    /*XXXX009 this means that callers must check for wakeup time again
    * at the start of the next interval.  Not right! */
    return interval_end_time;
}

#if 0
static int accounting_should_hibernate(void)
{
  return hibernate_limit_reached() || interval_wakeup_time > time(NULL);
}
#endif


/** Called when we get a SIGINT, or when bandwidth soft limit
 * is reached. */
static void hibernate_begin(int new_state) {
  connection_t *conn;

  if(hibernate_state == HIBERNATE_STATE_EXITING) {
    /* we've been called twice now. close immediately. */
    log(LOG_NOTICE,"Second sigint received; exiting now.");
    tor_cleanup();
    exit(0);
  }

  tor_assert(hibernate_state == HIBERNATE_STATE_LIVE);

  /* close listeners */
  while((conn = connection_get_by_type(CONN_TYPE_OR_LISTENER)) ||
        (conn = connection_get_by_type(CONN_TYPE_AP_LISTENER)) ||
        (conn = connection_get_by_type(CONN_TYPE_DIR_LISTENER))) {
    log_fn(LOG_INFO,"Closing listener type %d", conn->type);
    connection_mark_for_close(conn);
  }

  /* XXX kill intro point circs */
  /* XXX upload rendezvous service descriptors with no intro points */

  if(new_state == HIBERNATE_STATE_EXITING) {
    log(LOG_NOTICE,"Interrupt: will shut down in %d seconds. Interrupt again to exit now.", SHUTDOWN_WAIT_LENGTH);
    hibernate_timeout = time(NULL) + SHUTDOWN_WAIT_LENGTH;
  } else { /* soft limit reached */
    log_fn(LOG_NOTICE,"Bandwidth limit reached; beginning hibernation.");
    hibernate_timeout = hibernate_calc_wakeup_time();
  }

  hibernate_state = new_state;
}

/** Called when we've been hibernating and our timeout is reached. */
static void hibernate_end(int new_state) {

  tor_assert(hibernate_state == HIBERNATE_STATE_LOWBANDWIDTH ||
             hibernate_state == HIBERNATE_STATE_DORMANT);

  /* listeners will be relaunched in run_scheduled_events() in main.c */
  log_fn(LOG_NOTICE,"Hibernation period ended. Resuming normal activity.");

  hibernate_state = new_state;
  hibernate_timeout = 0; /* no longer hibernating */
}

/** A wrapper around hibernate_begin, for when we get SIGINT. */
void hibernate_begin_shutdown(void) {
  hibernate_begin(HIBERNATE_STATE_EXITING);
}

/** A wrapper to expose whether we're hibernating. */
int we_are_hibernating(void) {
  return hibernate_state != HIBERNATE_STATE_LIVE;
}

/** The big function. Consider our environment and decide if it's
 * time to start/stop hibernating.
 */
void consider_hibernation(time_t now) {
  connection_t *conn;

  if (hibernate_state != HIBERNATE_STATE_LIVE)
    tor_assert(hibernate_timeout);

  if (hibernate_state == HIBERNATE_STATE_EXITING) {
    if(hibernate_timeout <= now) {
      log(LOG_NOTICE,"Clean shutdown finished. Exiting.");
      tor_cleanup();
      exit(0);
    }
    return; /* if exiting soon, don't worry about bandwidth limits */
  }

  if(hibernate_timeout && hibernate_timeout <= now) {
    /* we've been hibernating; time to wake up. */
    hibernate_end(HIBERNATE_STATE_LIVE);
    return;
  }

  /* else, see if it's time to start hibernating */

  if (hibernate_state == HIBERNATE_STATE_LIVE &&
      hibernate_soft_limit_reached()) {
    log_fn(LOG_NOTICE,"Bandwidth soft limit reached; commencing hibernation.");
    hibernate_begin(HIBERNATE_STATE_LOWBANDWIDTH);
  }

  if (hibernate_state == HIBERNATE_STATE_LOWBANDWIDTH &&
      hibernate_hard_limit_reached()) {
    hibernate_state = HIBERNATE_STATE_DORMANT;
    log_fn(LOG_NOTICE,"Going dormant. Blowing away remaining connections.");

    /* Close all OR/AP/exit conns. Leave dir conns. */
    while((conn = connection_get_by_type(CONN_TYPE_OR)) ||
          (conn = connection_get_by_type(CONN_TYPE_AP)) ||
          (conn = connection_get_by_type(CONN_TYPE_EXIT))) {
      log_fn(LOG_INFO,"Closing conn type %d", conn->type);
      connection_mark_for_close(conn);
    }
  }
}