hibernate.c 42 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267
  1. /* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  2. * Copyright (c) 2007-2019, The Tor Project, Inc. */
  3. /* See LICENSE for licensing information */
  4. /**
  5. * \file hibernate.c
  6. * \brief Functions to close listeners, stop allowing new circuits,
  7. * etc in preparation for closing down or going dormant; and to track
  8. * bandwidth and time intervals to know when to hibernate and when to
  9. * stop hibernating.
  10. *
  11. * Ordinarily a Tor relay is "Live".
  12. *
  13. * A live relay can stop accepting connections for one of two reasons: either
  14. * it is trying to conserve bandwidth because of bandwidth accounting rules
  15. * ("soft hibernation"), or it is about to shut down ("exiting").
  16. **/
  17. /*
  18. hibernating, phase 1:
  19. - send destroy in response to create cells
  20. - send end (policy failed) in response to begin cells
  21. - close an OR conn when it has no circuits
  22. hibernating, phase 2:
  23. (entered when bandwidth hard limit reached)
  24. - close all OR/AP/exit conns)
  25. */
  26. #define HIBERNATE_PRIVATE
  27. #include "core/or/or.h"
  28. #include "core/or/channel.h"
  29. #include "core/or/channeltls.h"
  30. #include "app/config/config.h"
  31. #include "core/mainloop/connection.h"
  32. #include "core/or/connection_edge.h"
  33. #include "core/or/connection_or.h"
  34. #include "feature/control/control.h"
  35. #include "lib/crypt_ops/crypto_rand.h"
  36. #include "feature/hibernate/hibernate.h"
  37. #include "core/mainloop/mainloop.h"
  38. #include "feature/relay/router.h"
  39. #include "app/config/statefile.h"
  40. #include "lib/evloop/compat_libevent.h"
  41. #include "core/or/or_connection_st.h"
  42. #include "app/config/or_state_st.h"
  43. #ifdef HAVE_UNISTD_H
  44. #include <unistd.h>
  45. #endif
  46. #ifdef HAVE_SYSTEMD
  47. # if defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__)
  48. /* Systemd's use of gcc's __INCLUDE_LEVEL__ extension macro appears to confuse
  49. * Coverity. Here's a kludge to unconfuse it.
  50. */
  51. # define __INCLUDE_LEVEL__ 2
  52. # endif /* defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__) */
  53. #include <systemd/sd-daemon.h>
  54. #endif /* defined(HAVE_SYSTEMD) */
  55. /** Are we currently awake, asleep, running out of bandwidth, or shutting
  56. * down? */
  57. static hibernate_state_t hibernate_state = HIBERNATE_STATE_INITIAL;
  58. /** If are hibernating, when do we plan to wake up? Set to 0 if we
  59. * aren't hibernating. */
  60. static time_t hibernate_end_time = 0;
  61. /** If we are shutting down, when do we plan finally exit? Set to 0 if
  62. * we aren't shutting down. */
  63. static time_t shutdown_time = 0;
  64. /** A timed event that we'll use when it's time to wake up from
  65. * hibernation. */
  66. static mainloop_event_t *wakeup_event = NULL;
  67. /** Possible accounting periods. */
  68. typedef enum {
  69. UNIT_MONTH=1, UNIT_WEEK=2, UNIT_DAY=3,
  70. } time_unit_t;
  71. /*
  72. * @file hibernate.c
  73. *
  74. * <h4>Accounting</h4>
  75. * Accounting is designed to ensure that no more than N bytes are sent in
  76. * either direction over a given interval (currently, one month, one week, or
  77. * one day) We could
  78. * try to do this by choking our bandwidth to a trickle, but that
  79. * would make our streams useless. Instead, we estimate what our
  80. * bandwidth usage will be, and guess how long we'll be able to
  81. * provide that much bandwidth before hitting our limit. We then
  82. * choose a random time within the accounting interval to come up (so
  83. * that we don't get 50 Tors running on the 1st of the month and none
  84. * on the 30th).
  85. *
  86. * Each interval runs as follows:
  87. *
  88. * <ol>
  89. * <li>We guess our bandwidth usage, based on how much we used
  90. * last time. We choose a "wakeup time" within the interval to come up.
  91. * <li>Until the chosen wakeup time, we hibernate.
  92. * <li> We come up at the wakeup time, and provide bandwidth until we are
  93. * "very close" to running out.
  94. * <li> Then we go into low-bandwidth mode, and stop accepting new
  95. * connections, but provide bandwidth until we run out.
  96. * <li> Then we hibernate until the end of the interval.
  97. *
  98. * If the interval ends before we run out of bandwidth, we go back to
  99. * step one.
  100. *
  101. * Accounting is controlled by the AccountingMax, AccountingRule, and
  102. * AccountingStart options.
  103. */
  104. /** How many bytes have we read in this accounting interval? */
  105. static uint64_t n_bytes_read_in_interval = 0;
  106. /** How many bytes have we written in this accounting interval? */
  107. static uint64_t n_bytes_written_in_interval = 0;
  108. /** How many seconds have we been running this interval? */
  109. static uint32_t n_seconds_active_in_interval = 0;
  110. /** How many seconds were we active in this interval before we hit our soft
  111. * limit? */
  112. static int n_seconds_to_hit_soft_limit = 0;
  113. /** When in this interval was the soft limit hit. */
  114. static time_t soft_limit_hit_at = 0;
  115. /** How many bytes had we read/written when we hit the soft limit? */
  116. static uint64_t n_bytes_at_soft_limit = 0;
  117. /** When did this accounting interval start? */
  118. static time_t interval_start_time = 0;
  119. /** When will this accounting interval end? */
  120. static time_t interval_end_time = 0;
  121. /** How far into the accounting interval should we hibernate? */
  122. static time_t interval_wakeup_time = 0;
  123. /** How much bandwidth do we 'expect' to use per minute? (0 if we have no
  124. * info from the last period.) */
  125. static uint64_t expected_bandwidth_usage = 0;
  126. /** What unit are we using for our accounting? */
  127. static time_unit_t cfg_unit = UNIT_MONTH;
  128. /** How many days,hours,minutes into each unit does our accounting interval
  129. * start? */
  130. /** @{ */
  131. static int cfg_start_day = 0,
  132. cfg_start_hour = 0,
  133. cfg_start_min = 0;
  134. /** @} */
  135. static const char *hibernate_state_to_string(hibernate_state_t state);
  136. static void reset_accounting(time_t now);
  137. static int read_bandwidth_usage(void);
  138. static time_t start_of_accounting_period_after(time_t now);
  139. static time_t start_of_accounting_period_containing(time_t now);
  140. static void accounting_set_wakeup_time(void);
  141. static void on_hibernate_state_change(hibernate_state_t prev_state);
  142. static void hibernate_schedule_wakeup_event(time_t now, time_t end_time);
  143. static void wakeup_event_callback(mainloop_event_t *ev, void *data);
  144. /**
  145. * Return the human-readable name for the hibernation state <b>state</b>
  146. */
  147. static const char *
  148. hibernate_state_to_string(hibernate_state_t state)
  149. {
  150. static char buf[64];
  151. switch (state) {
  152. case HIBERNATE_STATE_EXITING: return "EXITING";
  153. case HIBERNATE_STATE_LOWBANDWIDTH: return "SOFT";
  154. case HIBERNATE_STATE_DORMANT: return "HARD";
  155. case HIBERNATE_STATE_INITIAL:
  156. case HIBERNATE_STATE_LIVE:
  157. return "AWAKE";
  158. default:
  159. log_warn(LD_BUG, "unknown hibernate state %d", state);
  160. tor_snprintf(buf, sizeof(buf), "unknown [%d]", state);
  161. return buf;
  162. }
  163. }
  164. /* ************
  165. * Functions for bandwidth accounting.
  166. * ************/
  167. /** Configure accounting start/end time settings based on
  168. * options->AccountingStart. Return 0 on success, -1 on failure. If
  169. * <b>validate_only</b> is true, do not change the current settings. */
  170. int
  171. accounting_parse_options(const or_options_t *options, int validate_only)
  172. {
  173. time_unit_t unit;
  174. int ok, idx;
  175. long d,h,m;
  176. smartlist_t *items;
  177. const char *v = options->AccountingStart;
  178. const char *s;
  179. char *cp;
  180. if (!v) {
  181. if (!validate_only) {
  182. cfg_unit = UNIT_MONTH;
  183. cfg_start_day = 1;
  184. cfg_start_hour = 0;
  185. cfg_start_min = 0;
  186. }
  187. return 0;
  188. }
  189. items = smartlist_new();
  190. smartlist_split_string(items, v, NULL,
  191. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK,0);
  192. if (smartlist_len(items)<2) {
  193. log_warn(LD_CONFIG, "Too few arguments to AccountingStart");
  194. goto err;
  195. }
  196. s = smartlist_get(items,0);
  197. if (0==strcasecmp(s, "month")) {
  198. unit = UNIT_MONTH;
  199. } else if (0==strcasecmp(s, "week")) {
  200. unit = UNIT_WEEK;
  201. } else if (0==strcasecmp(s, "day")) {
  202. unit = UNIT_DAY;
  203. } else {
  204. log_warn(LD_CONFIG,
  205. "Unrecognized accounting unit '%s': only 'month', 'week',"
  206. " and 'day' are supported.", s);
  207. goto err;
  208. }
  209. switch (unit) {
  210. case UNIT_WEEK:
  211. d = tor_parse_long(smartlist_get(items,1), 10, 1, 7, &ok, NULL);
  212. if (!ok) {
  213. log_warn(LD_CONFIG, "Weekly accounting must begin on a day between "
  214. "1 (Monday) and 7 (Sunday)");
  215. goto err;
  216. }
  217. break;
  218. case UNIT_MONTH:
  219. d = tor_parse_long(smartlist_get(items,1), 10, 1, 28, &ok, NULL);
  220. if (!ok) {
  221. log_warn(LD_CONFIG, "Monthly accounting must begin on a day between "
  222. "1 and 28");
  223. goto err;
  224. }
  225. break;
  226. case UNIT_DAY:
  227. d = 0;
  228. break;
  229. /* Coverity dislikes unreachable default cases; some compilers warn on
  230. * switch statements missing a case. Tell Coverity not to worry. */
  231. /* coverity[dead_error_begin] */
  232. default:
  233. tor_assert(0);
  234. }
  235. idx = unit==UNIT_DAY?1:2;
  236. if (smartlist_len(items) != (idx+1)) {
  237. log_warn(LD_CONFIG,"Accounting unit '%s' requires %d argument%s.",
  238. s, idx, (idx>1)?"s":"");
  239. goto err;
  240. }
  241. s = smartlist_get(items, idx);
  242. h = tor_parse_long(s, 10, 0, 23, &ok, &cp);
  243. if (!ok) {
  244. log_warn(LD_CONFIG,"Accounting start time not parseable: bad hour.");
  245. goto err;
  246. }
  247. if (!cp || *cp!=':') {
  248. log_warn(LD_CONFIG,
  249. "Accounting start time not parseable: not in HH:MM format");
  250. goto err;
  251. }
  252. m = tor_parse_long(cp+1, 10, 0, 59, &ok, &cp);
  253. if (!ok) {
  254. log_warn(LD_CONFIG, "Accounting start time not parseable: bad minute");
  255. goto err;
  256. }
  257. if (!cp || *cp!='\0') {
  258. log_warn(LD_CONFIG,
  259. "Accounting start time not parseable: not in HH:MM format");
  260. goto err;
  261. }
  262. if (!validate_only) {
  263. cfg_unit = unit;
  264. cfg_start_day = (int)d;
  265. cfg_start_hour = (int)h;
  266. cfg_start_min = (int)m;
  267. }
  268. SMARTLIST_FOREACH(items, char *, item, tor_free(item));
  269. smartlist_free(items);
  270. return 0;
  271. err:
  272. SMARTLIST_FOREACH(items, char *, item, tor_free(item));
  273. smartlist_free(items);
  274. return -1;
  275. }
  276. /** If we want to manage the accounting system and potentially
  277. * hibernate, return 1, else return 0.
  278. */
  279. MOCK_IMPL(int,
  280. accounting_is_enabled,(const or_options_t *options))
  281. {
  282. if (options->AccountingMax)
  283. return 1;
  284. return 0;
  285. }
  286. /** If accounting is enabled, return how long (in seconds) this
  287. * interval lasts. */
  288. int
  289. accounting_get_interval_length(void)
  290. {
  291. return (int)(interval_end_time - interval_start_time);
  292. }
  293. /** Return the time at which the current accounting interval will end. */
  294. MOCK_IMPL(time_t,
  295. accounting_get_end_time,(void))
  296. {
  297. return interval_end_time;
  298. }
  299. /** Called from connection.c to tell us that <b>seconds</b> seconds have
  300. * passed, <b>n_read</b> bytes have been read, and <b>n_written</b>
  301. * bytes have been written. */
  302. void
  303. accounting_add_bytes(size_t n_read, size_t n_written, int seconds)
  304. {
  305. n_bytes_read_in_interval += n_read;
  306. n_bytes_written_in_interval += n_written;
  307. /* If we haven't been called in 10 seconds, we're probably jumping
  308. * around in time. */
  309. n_seconds_active_in_interval += (seconds < 10) ? seconds : 0;
  310. }
  311. /** If get_end, return the end of the accounting period that contains
  312. * the time <b>now</b>. Else, return the start of the accounting
  313. * period that contains the time <b>now</b> */
  314. static time_t
  315. edge_of_accounting_period_containing(time_t now, int get_end)
  316. {
  317. int before;
  318. struct tm tm;
  319. tor_localtime_r(&now, &tm);
  320. /* Set 'before' to true iff the current time is before the hh:mm
  321. * changeover time for today. */
  322. before = tm.tm_hour < cfg_start_hour ||
  323. (tm.tm_hour == cfg_start_hour && tm.tm_min < cfg_start_min);
  324. /* Dispatch by unit. First, find the start day of the given period;
  325. * then, if get_end is true, increment to the end day. */
  326. switch (cfg_unit)
  327. {
  328. case UNIT_MONTH: {
  329. /* If this is before the Nth, we want the Nth of last month. */
  330. if (tm.tm_mday < cfg_start_day ||
  331. (tm.tm_mday == cfg_start_day && before)) {
  332. --tm.tm_mon;
  333. }
  334. /* Otherwise, the month is correct. */
  335. tm.tm_mday = cfg_start_day;
  336. if (get_end)
  337. ++tm.tm_mon;
  338. break;
  339. }
  340. case UNIT_WEEK: {
  341. /* What is the 'target' day of the week in struct tm format? (We
  342. say Sunday==7; struct tm says Sunday==0.) */
  343. int wday = cfg_start_day % 7;
  344. /* How many days do we subtract from today to get to the right day? */
  345. int delta = (7+tm.tm_wday-wday)%7;
  346. /* If we are on the right day, but the changeover hasn't happened yet,
  347. * then subtract a whole week. */
  348. if (delta == 0 && before)
  349. delta = 7;
  350. tm.tm_mday -= delta;
  351. if (get_end)
  352. tm.tm_mday += 7;
  353. break;
  354. }
  355. case UNIT_DAY:
  356. if (before)
  357. --tm.tm_mday;
  358. if (get_end)
  359. ++tm.tm_mday;
  360. break;
  361. default:
  362. tor_assert(0);
  363. }
  364. tm.tm_hour = cfg_start_hour;
  365. tm.tm_min = cfg_start_min;
  366. tm.tm_sec = 0;
  367. tm.tm_isdst = -1; /* Autodetect DST */
  368. return mktime(&tm);
  369. }
  370. /** Return the start of the accounting period containing the time
  371. * <b>now</b>. */
  372. static time_t
  373. start_of_accounting_period_containing(time_t now)
  374. {
  375. return edge_of_accounting_period_containing(now, 0);
  376. }
  377. /** Return the start of the accounting period that comes after the one
  378. * containing the time <b>now</b>. */
  379. static time_t
  380. start_of_accounting_period_after(time_t now)
  381. {
  382. return edge_of_accounting_period_containing(now, 1);
  383. }
  384. /** Return the length of the accounting period containing the time
  385. * <b>now</b>. */
  386. static long
  387. length_of_accounting_period_containing(time_t now)
  388. {
  389. return edge_of_accounting_period_containing(now, 1) -
  390. edge_of_accounting_period_containing(now, 0);
  391. }
  392. /** Initialize the accounting subsystem. */
  393. void
  394. configure_accounting(time_t now)
  395. {
  396. time_t s_now;
  397. /* Try to remember our recorded usage. */
  398. if (!interval_start_time)
  399. read_bandwidth_usage(); /* If we fail, we'll leave values at zero, and
  400. * reset below.*/
  401. s_now = start_of_accounting_period_containing(now);
  402. if (!interval_start_time) {
  403. /* We didn't have recorded usage; Start a new interval. */
  404. log_info(LD_ACCT, "Starting new accounting interval.");
  405. reset_accounting(now);
  406. } else if (s_now == interval_start_time) {
  407. log_info(LD_ACCT, "Continuing accounting interval.");
  408. /* We are in the interval we thought we were in. Do nothing.*/
  409. interval_end_time = start_of_accounting_period_after(interval_start_time);
  410. } else {
  411. long duration =
  412. length_of_accounting_period_containing(interval_start_time);
  413. double delta = ((double)(s_now - interval_start_time)) / duration;
  414. if (-0.50 <= delta && delta <= 0.50) {
  415. /* The start of the period is now a little later or earlier than we
  416. * remembered. That's fine; we might lose some bytes we could otherwise
  417. * have written, but better to err on the side of obeying accounting
  418. * settings. */
  419. log_info(LD_ACCT, "Accounting interval moved by %.02f%%; "
  420. "that's fine.", delta*100);
  421. interval_end_time = start_of_accounting_period_after(now);
  422. } else if (delta >= 0.99) {
  423. /* This is the regular time-moved-forward case; don't be too noisy
  424. * about it or people will complain */
  425. log_info(LD_ACCT, "Accounting interval elapsed; starting a new one");
  426. reset_accounting(now);
  427. } else {
  428. log_warn(LD_ACCT,
  429. "Mismatched accounting interval: moved by %.02f%%. "
  430. "Starting a fresh one.", delta*100);
  431. reset_accounting(now);
  432. }
  433. }
  434. accounting_set_wakeup_time();
  435. }
  436. /** Return the relevant number of bytes sent/received this interval
  437. * based on the set AccountingRule */
  438. uint64_t
  439. get_accounting_bytes(void)
  440. {
  441. if (get_options()->AccountingRule == ACCT_SUM)
  442. return n_bytes_read_in_interval+n_bytes_written_in_interval;
  443. else if (get_options()->AccountingRule == ACCT_IN)
  444. return n_bytes_read_in_interval;
  445. else if (get_options()->AccountingRule == ACCT_OUT)
  446. return n_bytes_written_in_interval;
  447. else
  448. return MAX(n_bytes_read_in_interval, n_bytes_written_in_interval);
  449. }
  450. /** Set expected_bandwidth_usage based on how much we sent/received
  451. * per minute last interval (if we were up for at least 30 minutes),
  452. * or based on our declared bandwidth otherwise. */
  453. static void
  454. update_expected_bandwidth(void)
  455. {
  456. uint64_t expected;
  457. const or_options_t *options= get_options();
  458. uint64_t max_configured = (options->RelayBandwidthRate > 0 ?
  459. options->RelayBandwidthRate :
  460. options->BandwidthRate) * 60;
  461. /* max_configured is the larger of bytes read and bytes written
  462. * If we are accounting based on sum, worst case is both are
  463. * at max, doubling the expected sum of bandwidth */
  464. if (get_options()->AccountingRule == ACCT_SUM)
  465. max_configured *= 2;
  466. #define MIN_TIME_FOR_MEASUREMENT (1800)
  467. if (soft_limit_hit_at > interval_start_time && n_bytes_at_soft_limit &&
  468. (soft_limit_hit_at - interval_start_time) > MIN_TIME_FOR_MEASUREMENT) {
  469. /* If we hit our soft limit last time, only count the bytes up to that
  470. * time. This is a better predictor of our actual bandwidth than
  471. * considering the entirety of the last interval, since we likely started
  472. * using bytes very slowly once we hit our soft limit. */
  473. expected = n_bytes_at_soft_limit /
  474. (soft_limit_hit_at - interval_start_time);
  475. expected /= 60;
  476. } else if (n_seconds_active_in_interval >= MIN_TIME_FOR_MEASUREMENT) {
  477. /* Otherwise, we either measured enough time in the last interval but
  478. * never hit our soft limit, or we're using a state file from a Tor that
  479. * doesn't know to store soft-limit info. Just take rate at which
  480. * we were reading/writing in the last interval as our expected rate.
  481. */
  482. uint64_t used = get_accounting_bytes();
  483. expected = used / (n_seconds_active_in_interval / 60);
  484. } else {
  485. /* If we haven't gotten enough data last interval, set 'expected'
  486. * to 0. This will set our wakeup to the start of the interval.
  487. * Next interval, we'll choose our starting time based on how much
  488. * we sent this interval.
  489. */
  490. expected = 0;
  491. }
  492. if (expected > max_configured)
  493. expected = max_configured;
  494. expected_bandwidth_usage = expected;
  495. }
  496. /** Called at the start of a new accounting interval: reset our
  497. * expected bandwidth usage based on what happened last time, set up
  498. * the start and end of the interval, and clear byte/time totals.
  499. */
  500. static void
  501. reset_accounting(time_t now)
  502. {
  503. log_info(LD_ACCT, "Starting new accounting interval.");
  504. update_expected_bandwidth();
  505. interval_start_time = start_of_accounting_period_containing(now);
  506. interval_end_time = start_of_accounting_period_after(interval_start_time);
  507. n_bytes_read_in_interval = 0;
  508. n_bytes_written_in_interval = 0;
  509. n_seconds_active_in_interval = 0;
  510. n_bytes_at_soft_limit = 0;
  511. soft_limit_hit_at = 0;
  512. n_seconds_to_hit_soft_limit = 0;
  513. }
  514. /** Return true iff we should save our bandwidth usage to disk. */
  515. static inline int
  516. time_to_record_bandwidth_usage(time_t now)
  517. {
  518. /* Note every 600 sec */
  519. #define NOTE_INTERVAL (600)
  520. /* Or every 20 megabytes */
  521. #define NOTE_BYTES 20*(1024*1024)
  522. static uint64_t last_read_bytes_noted = 0;
  523. static uint64_t last_written_bytes_noted = 0;
  524. static time_t last_time_noted = 0;
  525. if (last_time_noted + NOTE_INTERVAL <= now ||
  526. last_read_bytes_noted + NOTE_BYTES <= n_bytes_read_in_interval ||
  527. last_written_bytes_noted + NOTE_BYTES <= n_bytes_written_in_interval ||
  528. (interval_end_time && interval_end_time <= now)) {
  529. last_time_noted = now;
  530. last_read_bytes_noted = n_bytes_read_in_interval;
  531. last_written_bytes_noted = n_bytes_written_in_interval;
  532. return 1;
  533. }
  534. return 0;
  535. }
  536. /** Invoked once per second. Checks whether it is time to hibernate,
  537. * record bandwidth used, etc. */
  538. void
  539. accounting_run_housekeeping(time_t now)
  540. {
  541. if (now >= interval_end_time) {
  542. configure_accounting(now);
  543. }
  544. if (time_to_record_bandwidth_usage(now)) {
  545. if (accounting_record_bandwidth_usage(now, get_or_state())) {
  546. log_warn(LD_FS, "Couldn't record bandwidth usage to disk.");
  547. }
  548. }
  549. }
  550. /** Based on our interval and our estimated bandwidth, choose a
  551. * deterministic (but random-ish) time to wake up. */
  552. static void
  553. accounting_set_wakeup_time(void)
  554. {
  555. char digest[DIGEST_LEN];
  556. crypto_digest_t *d_env;
  557. uint64_t time_to_exhaust_bw;
  558. int time_to_consider;
  559. if (! server_identity_key_is_set()) {
  560. if (init_keys() < 0) {
  561. log_err(LD_BUG, "Error initializing keys");
  562. tor_assert(0);
  563. }
  564. }
  565. if (server_identity_key_is_set()) {
  566. char buf[ISO_TIME_LEN+1];
  567. format_iso_time(buf, interval_start_time);
  568. if (crypto_pk_get_digest(get_server_identity_key(), digest) < 0) {
  569. log_err(LD_BUG, "Error getting our key's digest.");
  570. tor_assert(0);
  571. }
  572. d_env = crypto_digest_new();
  573. crypto_digest_add_bytes(d_env, buf, ISO_TIME_LEN);
  574. crypto_digest_add_bytes(d_env, digest, DIGEST_LEN);
  575. crypto_digest_get_digest(d_env, digest, DIGEST_LEN);
  576. crypto_digest_free(d_env);
  577. } else {
  578. crypto_rand(digest, DIGEST_LEN);
  579. }
  580. if (!expected_bandwidth_usage) {
  581. char buf1[ISO_TIME_LEN+1];
  582. char buf2[ISO_TIME_LEN+1];
  583. format_local_iso_time(buf1, interval_start_time);
  584. format_local_iso_time(buf2, interval_end_time);
  585. interval_wakeup_time = interval_start_time;
  586. log_notice(LD_ACCT,
  587. "Configured hibernation. This interval begins at %s "
  588. "and ends at %s. We have no prior estimate for bandwidth, so "
  589. "we will start out awake and hibernate when we exhaust our quota.",
  590. buf1, buf2);
  591. return;
  592. }
  593. time_to_exhaust_bw =
  594. (get_options()->AccountingMax/expected_bandwidth_usage)*60;
  595. if (time_to_exhaust_bw > INT_MAX) {
  596. time_to_exhaust_bw = INT_MAX;
  597. time_to_consider = 0;
  598. } else {
  599. time_to_consider = accounting_get_interval_length() -
  600. (int)time_to_exhaust_bw;
  601. }
  602. if (time_to_consider<=0) {
  603. interval_wakeup_time = interval_start_time;
  604. } else {
  605. /* XXX can we simplify this just by picking a random (non-deterministic)
  606. * time to be up? If we go down and come up, then we pick a new one. Is
  607. * that good enough? -RD */
  608. /* This is not a perfectly unbiased conversion, but it is good enough:
  609. * in the worst case, the first half of the day is 0.06 percent likelier
  610. * to be chosen than the last half. */
  611. interval_wakeup_time = interval_start_time +
  612. (get_uint32(digest) % time_to_consider);
  613. }
  614. {
  615. char buf1[ISO_TIME_LEN+1];
  616. char buf2[ISO_TIME_LEN+1];
  617. char buf3[ISO_TIME_LEN+1];
  618. char buf4[ISO_TIME_LEN+1];
  619. time_t down_time;
  620. if (interval_wakeup_time+time_to_exhaust_bw > TIME_MAX)
  621. down_time = TIME_MAX;
  622. else
  623. down_time = (time_t)(interval_wakeup_time+time_to_exhaust_bw);
  624. if (down_time>interval_end_time)
  625. down_time = interval_end_time;
  626. format_local_iso_time(buf1, interval_start_time);
  627. format_local_iso_time(buf2, interval_wakeup_time);
  628. format_local_iso_time(buf3, down_time);
  629. format_local_iso_time(buf4, interval_end_time);
  630. log_notice(LD_ACCT,
  631. "Configured hibernation. This interval began at %s; "
  632. "the scheduled wake-up time %s %s; "
  633. "we expect%s to exhaust our quota for this interval around %s; "
  634. "the next interval begins at %s (all times local)",
  635. buf1,
  636. time(NULL)<interval_wakeup_time?"is":"was", buf2,
  637. time(NULL)<down_time?"":"ed", buf3,
  638. buf4);
  639. }
  640. }
  641. /* This rounds 0 up to 1000, but that's actually a feature. */
  642. #define ROUND_UP(x) (((x) + 0x3ff) & ~0x3ff)
  643. /** Save all our bandwidth tracking information to disk. Return 0 on
  644. * success, -1 on failure. */
  645. int
  646. accounting_record_bandwidth_usage(time_t now, or_state_t *state)
  647. {
  648. /* Just update the state */
  649. state->AccountingIntervalStart = interval_start_time;
  650. state->AccountingBytesReadInInterval = ROUND_UP(n_bytes_read_in_interval);
  651. state->AccountingBytesWrittenInInterval =
  652. ROUND_UP(n_bytes_written_in_interval);
  653. state->AccountingSecondsActive = n_seconds_active_in_interval;
  654. state->AccountingExpectedUsage = expected_bandwidth_usage;
  655. state->AccountingSecondsToReachSoftLimit = n_seconds_to_hit_soft_limit;
  656. state->AccountingSoftLimitHitAt = soft_limit_hit_at;
  657. state->AccountingBytesAtSoftLimit = n_bytes_at_soft_limit;
  658. or_state_mark_dirty(state,
  659. now+(get_options()->AvoidDiskWrites ? 7200 : 60));
  660. return 0;
  661. }
  662. #undef ROUND_UP
  663. /** Read stored accounting information from disk. Return 0 on success;
  664. * return -1 and change nothing on failure. */
  665. static int
  666. read_bandwidth_usage(void)
  667. {
  668. or_state_t *state = get_or_state();
  669. {
  670. char *fname = get_datadir_fname("bw_accounting");
  671. int res;
  672. res = unlink(fname);
  673. if (res != 0 && errno != ENOENT) {
  674. log_warn(LD_FS,
  675. "Failed to unlink %s: %s",
  676. fname, strerror(errno));
  677. }
  678. tor_free(fname);
  679. }
  680. if (!state)
  681. return -1;
  682. log_info(LD_ACCT, "Reading bandwidth accounting data from state file");
  683. n_bytes_read_in_interval = state->AccountingBytesReadInInterval;
  684. n_bytes_written_in_interval = state->AccountingBytesWrittenInInterval;
  685. n_seconds_active_in_interval = state->AccountingSecondsActive;
  686. interval_start_time = state->AccountingIntervalStart;
  687. expected_bandwidth_usage = state->AccountingExpectedUsage;
  688. /* Older versions of Tor (before 0.2.2.17-alpha or so) didn't generate these
  689. * fields. If you switch back and forth, you might get an
  690. * AccountingSoftLimitHitAt value from long before the most recent
  691. * interval_start_time. If that's so, then ignore the softlimit-related
  692. * values. */
  693. if (state->AccountingSoftLimitHitAt > interval_start_time) {
  694. soft_limit_hit_at = state->AccountingSoftLimitHitAt;
  695. n_bytes_at_soft_limit = state->AccountingBytesAtSoftLimit;
  696. n_seconds_to_hit_soft_limit = state->AccountingSecondsToReachSoftLimit;
  697. } else {
  698. soft_limit_hit_at = 0;
  699. n_bytes_at_soft_limit = 0;
  700. n_seconds_to_hit_soft_limit = 0;
  701. }
  702. {
  703. char tbuf1[ISO_TIME_LEN+1];
  704. char tbuf2[ISO_TIME_LEN+1];
  705. format_iso_time(tbuf1, state->LastWritten);
  706. format_iso_time(tbuf2, state->AccountingIntervalStart);
  707. log_info(LD_ACCT,
  708. "Successfully read bandwidth accounting info from state written at %s "
  709. "for interval starting at %s. We have been active for %lu seconds in "
  710. "this interval. At the start of the interval, we expected to use "
  711. "about %lu KB per second. (%"PRIu64" bytes read so far, "
  712. "%"PRIu64" bytes written so far)",
  713. tbuf1, tbuf2,
  714. (unsigned long)n_seconds_active_in_interval,
  715. (unsigned long)(expected_bandwidth_usage*1024/60),
  716. (n_bytes_read_in_interval),
  717. (n_bytes_written_in_interval));
  718. }
  719. return 0;
  720. }
  721. /** Return true iff we have sent/received all the bytes we are willing
  722. * to send/receive this interval. */
  723. static int
  724. hibernate_hard_limit_reached(void)
  725. {
  726. uint64_t hard_limit = get_options()->AccountingMax;
  727. if (!hard_limit)
  728. return 0;
  729. return get_accounting_bytes() >= hard_limit;
  730. }
  731. /** Return true iff we have sent/received almost all the bytes we are willing
  732. * to send/receive this interval. */
  733. static int
  734. hibernate_soft_limit_reached(void)
  735. {
  736. const uint64_t acct_max = get_options()->AccountingMax;
  737. #define SOFT_LIM_PCT (.95)
  738. #define SOFT_LIM_BYTES (500*1024*1024)
  739. #define SOFT_LIM_MINUTES (3*60)
  740. /* The 'soft limit' is a fair bit more complicated now than once it was.
  741. * We want to stop accepting connections when ALL of the following are true:
  742. * - We expect to use up the remaining bytes in under 3 hours
  743. * - We have used up 95% of our bytes.
  744. * - We have less than 500MB of bytes left.
  745. */
  746. uint64_t soft_limit = (uint64_t) (acct_max * SOFT_LIM_PCT);
  747. if (acct_max > SOFT_LIM_BYTES && acct_max - SOFT_LIM_BYTES > soft_limit) {
  748. soft_limit = acct_max - SOFT_LIM_BYTES;
  749. }
  750. if (expected_bandwidth_usage) {
  751. const uint64_t expected_usage =
  752. expected_bandwidth_usage * SOFT_LIM_MINUTES;
  753. if (acct_max > expected_usage && acct_max - expected_usage > soft_limit)
  754. soft_limit = acct_max - expected_usage;
  755. }
  756. if (!soft_limit)
  757. return 0;
  758. return get_accounting_bytes() >= soft_limit;
  759. }
  760. #define TOR_USEC_PER_SEC (1000000)
  761. /** Called when we get a SIGINT, or when bandwidth soft limit is
  762. * reached. Puts us into "loose hibernation": we don't accept new
  763. * connections, but we continue handling old ones. */
  764. static void
  765. hibernate_begin(hibernate_state_t new_state, time_t now)
  766. {
  767. const or_options_t *options = get_options();
  768. if (new_state == HIBERNATE_STATE_EXITING &&
  769. hibernate_state != HIBERNATE_STATE_LIVE) {
  770. log_notice(LD_GENERAL,"SIGINT received %s; exiting now.",
  771. hibernate_state == HIBERNATE_STATE_EXITING ?
  772. "a second time" : "while hibernating");
  773. tor_shutdown_event_loop_and_exit(0);
  774. return;
  775. }
  776. if (new_state == HIBERNATE_STATE_LOWBANDWIDTH &&
  777. hibernate_state == HIBERNATE_STATE_LIVE) {
  778. soft_limit_hit_at = now;
  779. n_seconds_to_hit_soft_limit = n_seconds_active_in_interval;
  780. n_bytes_at_soft_limit = get_accounting_bytes();
  781. }
  782. /* close listeners. leave control listener(s). */
  783. connection_mark_all_noncontrol_listeners();
  784. /* XXX kill intro point circs */
  785. /* XXX upload rendezvous service descriptors with no intro points */
  786. if (new_state == HIBERNATE_STATE_EXITING) {
  787. log_notice(LD_GENERAL,"Interrupt: we have stopped accepting new "
  788. "connections, and will shut down in %d seconds. Interrupt "
  789. "again to exit now.", options->ShutdownWaitLength);
  790. shutdown_time = time(NULL) + options->ShutdownWaitLength;
  791. #ifdef HAVE_SYSTEMD
  792. /* tell systemd that we may need more than the default 90 seconds to shut
  793. * down so they don't kill us. add some extra time to actually finish
  794. * shutting down, otherwise systemd will kill us immediately after the
  795. * EXTEND_TIMEOUT_USEC expires. this is an *upper* limit; tor will probably
  796. * only take one or two more seconds, but assume that maybe we got swapped
  797. * out and it takes a little while longer.
  798. *
  799. * as of writing, this is a no-op with all-defaults: ShutdownWaitLength is
  800. * 30 seconds, so this will extend the timeout to 60 seconds.
  801. * default systemd DefaultTimeoutStopSec is 90 seconds, so systemd will
  802. * wait (up to) 90 seconds anyways.
  803. *
  804. * 2^31 usec = ~2147 sec = ~35 min. probably nobody will actually set
  805. * ShutdownWaitLength to more than that, but use a longer type so we don't
  806. * need to think about UB on overflow
  807. */
  808. sd_notifyf(0, "EXTEND_TIMEOUT_USEC=%" PRIu64,
  809. ((uint64_t)(options->ShutdownWaitLength) + 30) * TOR_USEC_PER_SEC);
  810. #endif
  811. } else { /* soft limit reached */
  812. hibernate_end_time = interval_end_time;
  813. }
  814. hibernate_state = new_state;
  815. accounting_record_bandwidth_usage(now, get_or_state());
  816. or_state_mark_dirty(get_or_state(),
  817. get_options()->AvoidDiskWrites ? now+600 : 0);
  818. }
  819. /** Called when we've been hibernating and our timeout is reached. */
  820. static void
  821. hibernate_end(hibernate_state_t new_state)
  822. {
  823. tor_assert(hibernate_state == HIBERNATE_STATE_LOWBANDWIDTH ||
  824. hibernate_state == HIBERNATE_STATE_DORMANT ||
  825. hibernate_state == HIBERNATE_STATE_INITIAL);
  826. /* listeners will be relaunched in run_scheduled_events() in main.c */
  827. if (hibernate_state != HIBERNATE_STATE_INITIAL)
  828. log_notice(LD_ACCT,"Hibernation period ended. Resuming normal activity.");
  829. hibernate_state = new_state;
  830. hibernate_end_time = 0; /* no longer hibernating */
  831. reset_uptime(); /* reset published uptime */
  832. }
  833. /** A wrapper around hibernate_begin, for when we get SIGINT. */
  834. void
  835. hibernate_begin_shutdown(void)
  836. {
  837. hibernate_begin(HIBERNATE_STATE_EXITING, time(NULL));
  838. }
  839. /**
  840. * Return true iff we are currently hibernating -- that is, if we are in
  841. * any non-live state.
  842. */
  843. MOCK_IMPL(int,
  844. we_are_hibernating,(void))
  845. {
  846. return hibernate_state != HIBERNATE_STATE_LIVE;
  847. }
  848. /**
  849. * Return true iff we are currently _fully_ hibernating -- that is, if we are
  850. * in a state where we expect to handle no network activity at all.
  851. */
  852. MOCK_IMPL(int,
  853. we_are_fully_hibernating,(void))
  854. {
  855. return hibernate_state == HIBERNATE_STATE_DORMANT;
  856. }
  857. /** If we aren't currently dormant, close all connections and become
  858. * dormant. */
  859. static void
  860. hibernate_go_dormant(time_t now)
  861. {
  862. connection_t *conn;
  863. if (hibernate_state == HIBERNATE_STATE_DORMANT)
  864. return;
  865. else if (hibernate_state == HIBERNATE_STATE_LOWBANDWIDTH)
  866. hibernate_state = HIBERNATE_STATE_DORMANT;
  867. else
  868. hibernate_begin(HIBERNATE_STATE_DORMANT, now);
  869. log_notice(LD_ACCT,"Going dormant. Blowing away remaining connections.");
  870. /* Close all OR/AP/exit conns. Leave dir conns because we still want
  871. * to be able to upload server descriptors so clients know we're still
  872. * running, and download directories so we can detect if we're obsolete.
  873. * Leave control conns because we still want to be controllable.
  874. */
  875. while ((conn = connection_get_by_type(CONN_TYPE_OR)) ||
  876. (conn = connection_get_by_type(CONN_TYPE_AP)) ||
  877. (conn = connection_get_by_type(CONN_TYPE_EXIT))) {
  878. if (CONN_IS_EDGE(conn)) {
  879. connection_edge_end(TO_EDGE_CONN(conn), END_STREAM_REASON_HIBERNATING);
  880. }
  881. log_info(LD_NET,"Closing conn type %d", conn->type);
  882. if (conn->type == CONN_TYPE_AP) {
  883. /* send socks failure if needed */
  884. connection_mark_unattached_ap(TO_ENTRY_CONN(conn),
  885. END_STREAM_REASON_HIBERNATING);
  886. } else if (conn->type == CONN_TYPE_OR) {
  887. if (TO_OR_CONN(conn)->chan) {
  888. connection_or_close_normally(TO_OR_CONN(conn), 0);
  889. } else {
  890. connection_mark_for_close(conn);
  891. }
  892. } else {
  893. connection_mark_for_close(conn);
  894. }
  895. }
  896. if (now < interval_wakeup_time)
  897. hibernate_end_time = interval_wakeup_time;
  898. else
  899. hibernate_end_time = interval_end_time;
  900. accounting_record_bandwidth_usage(now, get_or_state());
  901. or_state_mark_dirty(get_or_state(),
  902. get_options()->AvoidDiskWrites ? now+600 : 0);
  903. hibernate_schedule_wakeup_event(now, hibernate_end_time);
  904. }
  905. /**
  906. * Schedule a mainloop event at <b>end_time</b> to wake up from a dormant
  907. * state. We can't rely on this happening from second_elapsed_callback,
  908. * since second_elapsed_callback will be shut down when we're dormant.
  909. *
  910. * (Note that We might immediately go back to sleep after we set the next
  911. * wakeup time.)
  912. */
  913. static void
  914. hibernate_schedule_wakeup_event(time_t now, time_t end_time)
  915. {
  916. struct timeval delay = { 0, 0 };
  917. if (now >= end_time) {
  918. // In these cases we always wait at least a second, to avoid running
  919. // the callback in a tight loop.
  920. delay.tv_sec = 1;
  921. } else {
  922. delay.tv_sec = (end_time - now);
  923. }
  924. if (!wakeup_event) {
  925. wakeup_event = mainloop_event_postloop_new(wakeup_event_callback, NULL);
  926. }
  927. mainloop_event_schedule(wakeup_event, &delay);
  928. }
  929. /**
  930. * Called at the end of the interval, or at the wakeup time of the current
  931. * interval, to exit the dormant state.
  932. **/
  933. static void
  934. wakeup_event_callback(mainloop_event_t *ev, void *data)
  935. {
  936. (void) ev;
  937. (void) data;
  938. const time_t now = time(NULL);
  939. accounting_run_housekeeping(now);
  940. consider_hibernation(now);
  941. if (hibernate_state != HIBERNATE_STATE_DORMANT) {
  942. /* We woke up, so everything's great here */
  943. return;
  944. }
  945. /* We're still dormant. */
  946. if (now < interval_wakeup_time)
  947. hibernate_end_time = interval_wakeup_time;
  948. else
  949. hibernate_end_time = interval_end_time;
  950. hibernate_schedule_wakeup_event(now, hibernate_end_time);
  951. }
  952. /** Called when hibernate_end_time has arrived. */
  953. static void
  954. hibernate_end_time_elapsed(time_t now)
  955. {
  956. char buf[ISO_TIME_LEN+1];
  957. /* The interval has ended, or it is wakeup time. Find out which. */
  958. accounting_run_housekeeping(now);
  959. if (interval_wakeup_time <= now) {
  960. /* The interval hasn't changed, but interval_wakeup_time has passed.
  961. * It's time to wake up and start being a server. */
  962. hibernate_end(HIBERNATE_STATE_LIVE);
  963. return;
  964. } else {
  965. /* The interval has changed, and it isn't time to wake up yet. */
  966. hibernate_end_time = interval_wakeup_time;
  967. format_iso_time(buf,interval_wakeup_time);
  968. if (hibernate_state != HIBERNATE_STATE_DORMANT) {
  969. /* We weren't sleeping before; we should sleep now. */
  970. log_notice(LD_ACCT,
  971. "Accounting period ended. Commencing hibernation until "
  972. "%s UTC", buf);
  973. hibernate_go_dormant(now);
  974. } else {
  975. log_notice(LD_ACCT,
  976. "Accounting period ended. This period, we will hibernate"
  977. " until %s UTC",buf);
  978. }
  979. }
  980. }
  981. /** Consider our environment and decide if it's time
  982. * to start/stop hibernating.
  983. */
  984. void
  985. consider_hibernation(time_t now)
  986. {
  987. int accounting_enabled = get_options()->AccountingMax != 0;
  988. char buf[ISO_TIME_LEN+1];
  989. hibernate_state_t prev_state = hibernate_state;
  990. /* If we're in 'exiting' mode, then we just shut down after the interval
  991. * elapses. */
  992. if (hibernate_state == HIBERNATE_STATE_EXITING) {
  993. tor_assert(shutdown_time);
  994. if (shutdown_time <= now) {
  995. log_notice(LD_GENERAL, "Clean shutdown finished. Exiting.");
  996. tor_shutdown_event_loop_and_exit(0);
  997. }
  998. return; /* if exiting soon, don't worry about bandwidth limits */
  999. }
  1000. if (hibernate_state == HIBERNATE_STATE_DORMANT) {
  1001. /* We've been hibernating because of bandwidth accounting. */
  1002. tor_assert(hibernate_end_time);
  1003. if (hibernate_end_time > now && accounting_enabled) {
  1004. /* If we're hibernating, don't wake up until it's time, regardless of
  1005. * whether we're in a new interval. */
  1006. return ;
  1007. } else {
  1008. hibernate_end_time_elapsed(now);
  1009. }
  1010. }
  1011. /* Else, we aren't hibernating. See if it's time to start hibernating, or to
  1012. * go dormant. */
  1013. if (hibernate_state == HIBERNATE_STATE_LIVE ||
  1014. hibernate_state == HIBERNATE_STATE_INITIAL) {
  1015. if (hibernate_soft_limit_reached()) {
  1016. log_notice(LD_ACCT,
  1017. "Bandwidth soft limit reached; commencing hibernation. "
  1018. "No new connections will be accepted");
  1019. hibernate_begin(HIBERNATE_STATE_LOWBANDWIDTH, now);
  1020. } else if (accounting_enabled && now < interval_wakeup_time) {
  1021. format_local_iso_time(buf,interval_wakeup_time);
  1022. log_notice(LD_ACCT,
  1023. "Commencing hibernation. We will wake up at %s local time.",
  1024. buf);
  1025. hibernate_go_dormant(now);
  1026. } else if (hibernate_state == HIBERNATE_STATE_INITIAL) {
  1027. hibernate_end(HIBERNATE_STATE_LIVE);
  1028. }
  1029. }
  1030. if (hibernate_state == HIBERNATE_STATE_LOWBANDWIDTH) {
  1031. if (!accounting_enabled) {
  1032. hibernate_end_time_elapsed(now);
  1033. } else if (hibernate_hard_limit_reached()) {
  1034. hibernate_go_dormant(now);
  1035. } else if (hibernate_end_time <= now) {
  1036. /* The hibernation period ended while we were still in lowbandwidth.*/
  1037. hibernate_end_time_elapsed(now);
  1038. }
  1039. }
  1040. /* Dispatch a controller event if the hibernation state changed. */
  1041. if (hibernate_state != prev_state)
  1042. on_hibernate_state_change(prev_state);
  1043. }
  1044. /** Helper function: called when we get a GETINFO request for an
  1045. * accounting-related key on the control connection <b>conn</b>. If we can
  1046. * answer the request for <b>question</b>, then set *<b>answer</b> to a newly
  1047. * allocated string holding the result. Otherwise, set *<b>answer</b> to
  1048. * NULL. */
  1049. int
  1050. getinfo_helper_accounting(control_connection_t *conn,
  1051. const char *question, char **answer,
  1052. const char **errmsg)
  1053. {
  1054. (void) conn;
  1055. (void) errmsg;
  1056. if (!strcmp(question, "accounting/enabled")) {
  1057. *answer = tor_strdup(accounting_is_enabled(get_options()) ? "1" : "0");
  1058. } else if (!strcmp(question, "accounting/hibernating")) {
  1059. *answer = tor_strdup(hibernate_state_to_string(hibernate_state));
  1060. tor_strlower(*answer);
  1061. } else if (!strcmp(question, "accounting/bytes")) {
  1062. tor_asprintf(answer, "%"PRIu64" %"PRIu64,
  1063. (n_bytes_read_in_interval),
  1064. (n_bytes_written_in_interval));
  1065. } else if (!strcmp(question, "accounting/bytes-left")) {
  1066. uint64_t limit = get_options()->AccountingMax;
  1067. if (get_options()->AccountingRule == ACCT_SUM) {
  1068. uint64_t total_left = 0;
  1069. uint64_t total_bytes = get_accounting_bytes();
  1070. if (total_bytes < limit)
  1071. total_left = limit - total_bytes;
  1072. tor_asprintf(answer, "%"PRIu64" %"PRIu64,
  1073. (total_left), (total_left));
  1074. } else if (get_options()->AccountingRule == ACCT_IN) {
  1075. uint64_t read_left = 0;
  1076. if (n_bytes_read_in_interval < limit)
  1077. read_left = limit - n_bytes_read_in_interval;
  1078. tor_asprintf(answer, "%"PRIu64" %"PRIu64,
  1079. (read_left), (limit));
  1080. } else if (get_options()->AccountingRule == ACCT_OUT) {
  1081. uint64_t write_left = 0;
  1082. if (n_bytes_written_in_interval < limit)
  1083. write_left = limit - n_bytes_written_in_interval;
  1084. tor_asprintf(answer, "%"PRIu64" %"PRIu64,
  1085. (limit), (write_left));
  1086. } else {
  1087. uint64_t read_left = 0, write_left = 0;
  1088. if (n_bytes_read_in_interval < limit)
  1089. read_left = limit - n_bytes_read_in_interval;
  1090. if (n_bytes_written_in_interval < limit)
  1091. write_left = limit - n_bytes_written_in_interval;
  1092. tor_asprintf(answer, "%"PRIu64" %"PRIu64,
  1093. (read_left), (write_left));
  1094. }
  1095. } else if (!strcmp(question, "accounting/interval-start")) {
  1096. *answer = tor_malloc(ISO_TIME_LEN+1);
  1097. format_iso_time(*answer, interval_start_time);
  1098. } else if (!strcmp(question, "accounting/interval-wake")) {
  1099. *answer = tor_malloc(ISO_TIME_LEN+1);
  1100. format_iso_time(*answer, interval_wakeup_time);
  1101. } else if (!strcmp(question, "accounting/interval-end")) {
  1102. *answer = tor_malloc(ISO_TIME_LEN+1);
  1103. format_iso_time(*answer, interval_end_time);
  1104. } else {
  1105. *answer = NULL;
  1106. }
  1107. return 0;
  1108. }
  1109. /**
  1110. * Helper function: called when the hibernation state changes, and sends a
  1111. * SERVER_STATUS event to notify interested controllers of the accounting
  1112. * state change.
  1113. */
  1114. static void
  1115. on_hibernate_state_change(hibernate_state_t prev_state)
  1116. {
  1117. control_event_server_status(LOG_NOTICE,
  1118. "HIBERNATION_STATUS STATUS=%s",
  1119. hibernate_state_to_string(hibernate_state));
  1120. /* We are changing hibernation state, this can affect the main loop event
  1121. * list. Rescan it to update the events state. We do this whatever the new
  1122. * hibernation state because they can each possibly affect an event. The
  1123. * initial state means we are booting up so we shouldn't scan here because
  1124. * at this point the events in the list haven't been initialized. */
  1125. if (prev_state != HIBERNATE_STATE_INITIAL) {
  1126. rescan_periodic_events(get_options());
  1127. }
  1128. reschedule_per_second_timer();
  1129. }
  1130. /** Free all resources held by the accounting module */
  1131. void
  1132. accounting_free_all(void)
  1133. {
  1134. mainloop_event_free(wakeup_event);
  1135. hibernate_state = HIBERNATE_STATE_INITIAL;
  1136. hibernate_end_time = 0;
  1137. shutdown_time = 0;
  1138. }
  1139. #ifdef TOR_UNIT_TESTS
  1140. /**
  1141. * Manually change the hibernation state. Private; used only by the unit
  1142. * tests.
  1143. */
  1144. void
  1145. hibernate_set_state_for_testing_(hibernate_state_t newstate)
  1146. {
  1147. hibernate_state = newstate;
  1148. }
  1149. #endif /* defined(TOR_UNIT_TESTS) */