hibernate.h 2.1 KB

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