test_oom.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348
  1. /* Copyright (c) 2014, The Tor Project, Inc. */
  2. /* See LICENSE for licensing information */
  3. /* Unit tests for OOM handling logic */
  4. #define RELAY_PRIVATE
  5. #define BUFFERS_PRIVATE
  6. #define CIRCUITLIST_PRIVATE
  7. #include "or.h"
  8. #include "buffers.h"
  9. #include "circuitlist.h"
  10. #include "compat_libevent.h"
  11. #include "connection.h"
  12. #include "config.h"
  13. #include "mempool.h"
  14. #include "relay.h"
  15. #include "test.h"
  16. /* small replacement mock for circuit_mark_for_close_ to avoid doing all
  17. * the other bookkeeping that comes with marking circuits. */
  18. static void
  19. circuit_mark_for_close_dummy_(circuit_t *circ, int reason, int line,
  20. const char *file)
  21. {
  22. (void) reason;
  23. if (circ->marked_for_close) {
  24. TT_FAIL(("Circuit already marked for close at %s:%d, but we are marking "
  25. "it again at %s:%d",
  26. circ->marked_for_close_file, (int)circ->marked_for_close,
  27. file, line));
  28. }
  29. circ->marked_for_close = line;
  30. circ->marked_for_close_file = file;
  31. }
  32. static circuit_t *
  33. dummy_or_circuit_new(int n_p_cells, int n_n_cells)
  34. {
  35. or_circuit_t *circ = or_circuit_new(0, NULL);
  36. int i;
  37. cell_t cell;
  38. for (i=0; i < n_p_cells; ++i) {
  39. crypto_rand((void*)&cell, sizeof(cell));
  40. cell_queue_append_packed_copy(TO_CIRCUIT(circ), &circ->p_chan_cells,
  41. 0, &cell, 1, 0);
  42. }
  43. for (i=0; i < n_n_cells; ++i) {
  44. crypto_rand((void*)&cell, sizeof(cell));
  45. cell_queue_append_packed_copy(TO_CIRCUIT(circ),
  46. &TO_CIRCUIT(circ)->n_chan_cells,
  47. 1, &cell, 1, 0);
  48. }
  49. TO_CIRCUIT(circ)->purpose = CIRCUIT_PURPOSE_OR;
  50. return TO_CIRCUIT(circ);
  51. }
  52. static circuit_t *
  53. dummy_origin_circuit_new(int n_cells)
  54. {
  55. origin_circuit_t *circ = origin_circuit_new();
  56. int i;
  57. cell_t cell;
  58. for (i=0; i < n_cells; ++i) {
  59. crypto_rand((void*)&cell, sizeof(cell));
  60. cell_queue_append_packed_copy(TO_CIRCUIT(circ),
  61. &TO_CIRCUIT(circ)->n_chan_cells,
  62. 1, &cell, 1, 0);
  63. }
  64. TO_CIRCUIT(circ)->purpose = CIRCUIT_PURPOSE_C_GENERAL;
  65. return TO_CIRCUIT(circ);
  66. }
  67. static void
  68. add_bytes_to_buf(generic_buffer_t *buf, size_t n_bytes)
  69. {
  70. char b[3000];
  71. while (n_bytes) {
  72. size_t this_add = n_bytes > sizeof(buf) ? sizeof(buf) : n_bytes;
  73. crypto_rand(b, sizeof(b));
  74. generic_buffer_add(buf, b, this_add);
  75. n_bytes -= this_add;
  76. }
  77. }
  78. static edge_connection_t *
  79. dummy_edge_conn_new(circuit_t *circ,
  80. int type, size_t in_bytes, size_t out_bytes)
  81. {
  82. edge_connection_t *conn;
  83. if (type == CONN_TYPE_EXIT)
  84. conn = edge_connection_new(type, AF_INET);
  85. else
  86. conn = ENTRY_TO_EDGE_CONN(entry_connection_new(type, AF_INET));
  87. /* We add these bytes directly to the buffers, to avoid all the
  88. * edge connection read/write machinery. */
  89. add_bytes_to_buf(TO_CONN(conn)->inbuf, in_bytes);
  90. add_bytes_to_buf(TO_CONN(conn)->outbuf, out_bytes);
  91. conn->on_circuit = circ;
  92. if (type == CONN_TYPE_EXIT) {
  93. or_circuit_t *oc = TO_OR_CIRCUIT(circ);
  94. conn->next_stream = oc->n_streams;
  95. oc->n_streams = conn;
  96. } else {
  97. origin_circuit_t *oc = TO_ORIGIN_CIRCUIT(circ);
  98. conn->next_stream = oc->p_streams;
  99. oc->p_streams = conn;
  100. }
  101. return conn;
  102. }
  103. /** Run unit tests for buffers.c */
  104. static void
  105. test_oom_circbuf(void *arg)
  106. {
  107. or_options_t *options = get_options_mutable();
  108. circuit_t *c1 = NULL, *c2 = NULL, *c3 = NULL, *c4 = NULL;
  109. struct timeval tv = { 1389631048, 0 };
  110. (void) arg;
  111. MOCK(circuit_mark_for_close_, circuit_mark_for_close_dummy_);
  112. init_cell_pool();
  113. /* Far too low for real life. */
  114. options->MaxMemInQueues = 256*packed_cell_mem_cost();
  115. options->CellStatistics = 0;
  116. tt_int_op(cell_queues_check_size(), ==, 0); /* We don't start out OOM. */
  117. tt_int_op(cell_queues_get_total_allocation(), ==, 0);
  118. tt_int_op(buf_get_total_allocation(), ==, 0);
  119. /* Now we're going to fake up some circuits and get them added to the global
  120. circuit list. */
  121. tv.tv_usec = 0;
  122. tor_gettimeofday_cache_set(&tv);
  123. c1 = dummy_origin_circuit_new(30);
  124. tv.tv_usec = 10*1000;
  125. tor_gettimeofday_cache_set(&tv);
  126. c2 = dummy_or_circuit_new(20, 20);
  127. tt_int_op(packed_cell_mem_cost(), ==,
  128. sizeof(packed_cell_t) + MP_POOL_ITEM_OVERHEAD);
  129. tt_int_op(cell_queues_get_total_allocation(), ==,
  130. packed_cell_mem_cost() * 70);
  131. tt_int_op(cell_queues_check_size(), ==, 0); /* We are still not OOM */
  132. tv.tv_usec = 20*1000;
  133. tor_gettimeofday_cache_set(&tv);
  134. c3 = dummy_or_circuit_new(100, 85);
  135. tt_int_op(cell_queues_check_size(), ==, 0); /* We are still not OOM */
  136. tt_int_op(cell_queues_get_total_allocation(), ==,
  137. packed_cell_mem_cost() * 255);
  138. tv.tv_usec = 30*1000;
  139. tor_gettimeofday_cache_set(&tv);
  140. /* Adding this cell will trigger our OOM handler. */
  141. c4 = dummy_or_circuit_new(2, 0);
  142. tt_int_op(cell_queues_get_total_allocation(), ==,
  143. packed_cell_mem_cost() * 257);
  144. tt_int_op(cell_queues_check_size(), ==, 1); /* We are now OOM */
  145. tt_assert(c1->marked_for_close);
  146. tt_assert(! c2->marked_for_close);
  147. tt_assert(! c3->marked_for_close);
  148. tt_assert(! c4->marked_for_close);
  149. tt_int_op(cell_queues_get_total_allocation(), ==,
  150. packed_cell_mem_cost() * (257 - 30));
  151. circuit_free(c1);
  152. tv.tv_usec = 0;
  153. tor_gettimeofday_cache_set(&tv); /* go back in time */
  154. c1 = dummy_or_circuit_new(90, 0);
  155. tv.tv_usec = 40*1000; /* go back to the future */
  156. tor_gettimeofday_cache_set(&tv);
  157. tt_int_op(cell_queues_check_size(), ==, 1); /* We are now OOM */
  158. tt_assert(c1->marked_for_close);
  159. tt_assert(! c2->marked_for_close);
  160. tt_assert(! c3->marked_for_close);
  161. tt_assert(! c4->marked_for_close);
  162. tt_int_op(cell_queues_get_total_allocation(), ==,
  163. packed_cell_mem_cost() * (257 - 30));
  164. done:
  165. circuit_free(c1);
  166. circuit_free(c2);
  167. circuit_free(c3);
  168. circuit_free(c4);
  169. UNMOCK(circuit_mark_for_close_);
  170. }
  171. /** Run unit tests for buffers.c */
  172. static void
  173. test_oom_streambuf(void *arg)
  174. {
  175. or_options_t *options = get_options_mutable();
  176. circuit_t *c1 = NULL, *c2 = NULL, *c3 = NULL, *c4 = NULL, *c5 = NULL;
  177. struct timeval tv = { 1389641159, 0 };
  178. uint32_t tvms;
  179. int i;
  180. (void) arg;
  181. MOCK(circuit_mark_for_close_, circuit_mark_for_close_dummy_);
  182. init_cell_pool();
  183. /* Far too low for real life. */
  184. options->MaxMemInQueues = 81*packed_cell_mem_cost() + 4096 * 34;
  185. options->CellStatistics = 0;
  186. tt_int_op(cell_queues_check_size(), ==, 0); /* We don't start out OOM. */
  187. tt_int_op(cell_queues_get_total_allocation(), ==, 0);
  188. tt_int_op(buf_get_total_allocation(), ==, 0);
  189. /* Start all circuits with a bit of data queued in cells */
  190. tv.tv_usec = 500*1000; /* go halfway into the second. */
  191. tor_gettimeofday_cache_set(&tv);
  192. c1 = dummy_or_circuit_new(10,10);
  193. tv.tv_usec = 510*1000;
  194. tor_gettimeofday_cache_set(&tv);
  195. c2 = dummy_origin_circuit_new(20);
  196. tv.tv_usec = 520*1000;
  197. tor_gettimeofday_cache_set(&tv);
  198. c3 = dummy_or_circuit_new(20,20);
  199. tv.tv_usec = 530*1000;
  200. tor_gettimeofday_cache_set(&tv);
  201. c4 = dummy_or_circuit_new(0,0);
  202. tt_int_op(cell_queues_get_total_allocation(), ==,
  203. packed_cell_mem_cost() * 80);
  204. tv.tv_usec = 600*1000;
  205. tor_gettimeofday_cache_set(&tv);
  206. /* Add some connections to c1...c4. */
  207. for (i = 0; i < 4; ++i) {
  208. edge_connection_t *ec;
  209. /* link it to a circuit */
  210. tv.tv_usec += 10*1000;
  211. tor_gettimeofday_cache_set(&tv);
  212. ec = dummy_edge_conn_new(c1, CONN_TYPE_EXIT, 1000, 1000);
  213. tt_assert(ec);
  214. tv.tv_usec += 10*1000;
  215. tor_gettimeofday_cache_set(&tv);
  216. ec = dummy_edge_conn_new(c2, CONN_TYPE_AP, 1000, 1000);
  217. tt_assert(ec);
  218. tv.tv_usec += 10*1000;
  219. tor_gettimeofday_cache_set(&tv);
  220. ec = dummy_edge_conn_new(c4, CONN_TYPE_EXIT, 1000, 1000); /* Yes, 4 twice*/
  221. tt_assert(ec);
  222. tv.tv_usec += 10*1000;
  223. tor_gettimeofday_cache_set(&tv);
  224. ec = dummy_edge_conn_new(c4, CONN_TYPE_EXIT, 1000, 1000);
  225. tt_assert(ec);
  226. }
  227. tv.tv_sec += 1;
  228. tv.tv_usec = 0;
  229. tvms = (uint32_t) tv_to_msec(&tv);
  230. tt_int_op(circuit_max_queued_cell_age(c1, tvms), ==, 500);
  231. tt_int_op(circuit_max_queued_cell_age(c2, tvms), ==, 490);
  232. tt_int_op(circuit_max_queued_cell_age(c3, tvms), ==, 480);
  233. tt_int_op(circuit_max_queued_cell_age(c4, tvms), ==, 0);
  234. tt_int_op(circuit_max_queued_data_age(c1, tvms), ==, 390);
  235. tt_int_op(circuit_max_queued_data_age(c2, tvms), ==, 380);
  236. tt_int_op(circuit_max_queued_data_age(c3, tvms), ==, 0);
  237. tt_int_op(circuit_max_queued_data_age(c4, tvms), ==, 370);
  238. tt_int_op(circuit_max_queued_item_age(c1, tvms), ==, 500);
  239. tt_int_op(circuit_max_queued_item_age(c2, tvms), ==, 490);
  240. tt_int_op(circuit_max_queued_item_age(c3, tvms), ==, 480);
  241. tt_int_op(circuit_max_queued_item_age(c4, tvms), ==, 370);
  242. tt_int_op(cell_queues_get_total_allocation(), ==,
  243. packed_cell_mem_cost() * 80);
  244. tt_int_op(buf_get_total_allocation(), ==, 4096*16*2);
  245. /* Now give c4 a very old buffer of modest size */
  246. {
  247. edge_connection_t *ec;
  248. tv.tv_sec -= 1;
  249. tv.tv_usec = 0;
  250. tor_gettimeofday_cache_set(&tv);
  251. ec = dummy_edge_conn_new(c4, CONN_TYPE_EXIT, 1000, 1000);
  252. tt_assert(ec);
  253. }
  254. tt_int_op(buf_get_total_allocation(), ==, 4096*17*2);
  255. tt_int_op(circuit_max_queued_item_age(c4, tvms), ==, 1000);
  256. tt_int_op(cell_queues_check_size(), ==, 0);
  257. /* And run over the limit. */
  258. tv.tv_usec = 800*1000;
  259. tor_gettimeofday_cache_set(&tv);
  260. c5 = dummy_or_circuit_new(0,5);
  261. tt_int_op(cell_queues_get_total_allocation(), ==,
  262. packed_cell_mem_cost() * 85);
  263. tt_int_op(buf_get_total_allocation(), ==, 4096*17*2);
  264. tt_int_op(cell_queues_check_size(), ==, 1); /* We are now OOM */
  265. /* C4 should have died. */
  266. tt_assert(! c1->marked_for_close);
  267. tt_assert(! c2->marked_for_close);
  268. tt_assert(! c3->marked_for_close);
  269. tt_assert(c4->marked_for_close);
  270. tt_assert(! c5->marked_for_close);
  271. tt_int_op(cell_queues_get_total_allocation(), ==,
  272. packed_cell_mem_cost() * 85);
  273. tt_int_op(buf_get_total_allocation(), ==, 4096*8*2);
  274. done:
  275. circuit_free(c1);
  276. circuit_free(c2);
  277. circuit_free(c3);
  278. circuit_free(c4);
  279. circuit_free(c5);
  280. UNMOCK(circuit_mark_for_close_);
  281. }
  282. struct testcase_t oom_tests[] = {
  283. { "circbuf", test_oom_circbuf, TT_FORK, NULL, NULL },
  284. { "streambuf", test_oom_streambuf, TT_FORK, NULL, NULL },
  285. END_OF_TESTCASES
  286. };