src/or/hibernate.h

   1 /* Copyright (c) 2001 Matej Pfajfar.
   2  * Copyright (c) 2001-2004, Roger Dingledine.
   3  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
   4  * Copyright (c) 2007-2013, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file hibernate.h
   9  * \brief Header file for hibernate.c.
  10  **/
  11
  12 #ifndef TOR_HIBERNATE_H
  13 #define TOR_HIBERNATE_H
  14
  15 #include "testsupport.h"
  16
  17 int accounting_parse_options(const or_options_t *options, int validate_only);
  18 MOCK_DECL(int, accounting_is_enabled, (const or_options_t *options));
  19 int accounting_get_interval_length(void);
  20 MOCK_DECL(time_t, accounting_get_end_time, (void));
  21 void configure_accounting(time_t now);
  22 void accounting_run_housekeeping(time_t now);
  23 void accounting_add_bytes(size_t n_read, size_t n_written, int seconds);
  24 int accounting_record_bandwidth_usage(time_t now, or_state_t *state);
  25 void hibernate_begin_shutdown(void);
  26 MOCK_DECL(int, we_are_hibernating, (void));
  27 void consider_hibernation(time_t now);
  28 int getinfo_helper_accounting(control_connection_t *conn,
  29                               const char *question, char **answer,
  30                               const char **errmsg);
  31
  32 #ifdef HIBERNATE_PRIVATE
  33 /** Possible values of hibernate_state */
  34 typedef enum {
  35   /** We are running normally. */
  36   HIBERNATE_STATE_LIVE=1,
  37   /** We're trying to shut down cleanly, and we'll kill all active connections
  38    * at shutdown_time. */
  39   HIBERNATE_STATE_EXITING=2,
  40   /** We're running low on allocated bandwidth for this period, so we won't
  41    * accept any new connections. */
  42   HIBERNATE_STATE_LOWBANDWIDTH=3,
  43   /** We are hibernating, and we won't wake up till there's more bandwidth to
  44    * use. */
  45   HIBERNATE_STATE_DORMANT=4,
  46   /** We start out in state default, which means we havent decided which state
  47    * we're in. */
  48   HIBERNATE_STATE_INITIAL=5
  49 } hibernate_state_t;
  50
  51 #ifdef TOR_UNIT_TESTS
  52 void hibernate_set_state_for_testing_(hibernate_state_t newstate);
  53 #endif
  54 #endif
  55
  56 #endif
  57