12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154 |
- /* Copyright (c) 2013, The Tor Project, Inc. */
- /* See LICENSE for licensing information */
- #define TOR_CHANNEL_INTERNAL_
- #define CHANNEL_PRIVATE_
- #include "or.h"
- #include "channel.h"
- /* For channel_note_destroy_not_pending */
- #include "circuitlist.h"
- #include "circuitmux.h"
- /* For var_cell_free */
- #include "connection_or.h"
- /* For packed_cell stuff */
- #define RELAY_PRIVATE
- #include "relay.h"
- /* For init/free stuff */
- #include "scheduler.h"
- /* Test suite stuff */
- #include "test.h"
- #include "fakechans.h"
- /* This comes from channel.c */
- extern uint64_t estimated_total_queue_size;
- static int test_chan_accept_cells = 0;
- static int test_cells_written = 0;
- static int test_destroy_not_pending_calls = 0;
- static int test_doesnt_want_writes_count = 0;
- static int test_has_waiting_cells_count = 0;
- static double test_overhead_estimate = 1.0f;
- static int test_releases_count = 0;
- static void channel_note_destroy_not_pending_mock(channel_t *ch,
- circid_t circid);
- static void chan_test_close(channel_t *ch);
- static void chan_test_error(channel_t *ch);
- static void chan_test_finish_close(channel_t *ch);
- static size_t chan_test_num_bytes_queued(channel_t *ch);
- static int chan_test_num_cells_writeable(channel_t *ch);
- static int chan_test_write_cell(channel_t *ch, cell_t *cell);
- static int chan_test_write_packed_cell(channel_t *ch,
- packed_cell_t *packed_cell);
- static int chan_test_write_var_cell(channel_t *ch, var_cell_t *var_cell);
- static void scheduler_channel_doesnt_want_writes_mock(channel_t *ch);
- static void test_channel_flush(void *arg);
- static void test_channel_lifecycle(void *arg);
- static void test_channel_multi(void *arg);
- static void test_channel_queue_size(void *arg);
- static void test_channel_write(void *arg);
- static void
- channel_note_destroy_not_pending_mock(channel_t *ch,
- circid_t circid)
- {
- (void)ch;
- (void)circid;
- ++test_destroy_not_pending_calls;
- }
- static void
- chan_test_close(channel_t *ch)
- {
- test_assert(ch);
- done:
- return;
- }
- /*
- * Close a channel through the error path
- */
- static void
- chan_test_error(channel_t *ch)
- {
- test_assert(ch);
- test_assert(!(ch->state == CHANNEL_STATE_CLOSING ||
- ch->state == CHANNEL_STATE_ERROR ||
- ch->state == CHANNEL_STATE_CLOSED));
- channel_close_for_error(ch);
- done:
- return;
- }
- /*
- * Finish closing a channel from CHANNEL_STATE_CLOSING
- */
- static void
- chan_test_finish_close(channel_t *ch)
- {
- test_assert(ch);
- test_assert(ch->state == CHANNEL_STATE_CLOSING);
- channel_closed(ch);
- done:
- return;
- }
- static double
- chan_test_get_overhead_estimate(channel_t *ch)
- {
- test_assert(ch);
- done:
- return test_overhead_estimate;
- }
- static size_t
- chan_test_num_bytes_queued(channel_t *ch)
- {
- test_assert(ch);
- done:
- return 0;
- }
- static int
- chan_test_num_cells_writeable(channel_t *ch)
- {
- test_assert(ch);
- done:
- return 32;
- }
- static int
- chan_test_write_cell(channel_t *ch, cell_t *cell)
- {
- int rv = 0;
- test_assert(ch);
- test_assert(cell);
- if (test_chan_accept_cells) {
- /* Free the cell and bump the counter */
- tor_free(cell);
- ++test_cells_written;
- rv = 1;
- }
- /* else return 0, we didn't accept it */
- done:
- return rv;
- }
- static int
- chan_test_write_packed_cell(channel_t *ch,
- packed_cell_t *packed_cell)
- {
- int rv = 0;
- test_assert(ch);
- test_assert(packed_cell);
- if (test_chan_accept_cells) {
- /* Free the cell and bump the counter */
- packed_cell_free(packed_cell);
- ++test_cells_written;
- rv = 1;
- }
- /* else return 0, we didn't accept it */
- done:
- return rv;
- }
- static int
- chan_test_write_var_cell(channel_t *ch, var_cell_t *var_cell)
- {
- int rv = 0;
- test_assert(ch);
- test_assert(var_cell);
- if (test_chan_accept_cells) {
- /* Free the cell and bump the counter */
- var_cell_free(var_cell);
- ++test_cells_written;
- rv = 1;
- }
- /* else return 0, we didn't accept it */
- done:
- return rv;
- }
- /**
- * Fill out c with a new fake cell for test suite use
- */
- void
- make_fake_cell(cell_t *c)
- {
- test_assert(c != NULL);
- c->circ_id = 1;
- c->command = CELL_RELAY;
- memset(c->payload, 0, CELL_PAYLOAD_SIZE);
- done:
- return;
- }
- /**
- * Fill out c with a new fake var_cell for test suite use
- */
- void
- make_fake_var_cell(var_cell_t *c)
- {
- test_assert(c != NULL);
- c->circ_id = 1;
- c->command = CELL_VERSIONS;
- c->payload_len = CELL_PAYLOAD_SIZE / 2;
- memset(c->payload, 0, c->payload_len);
- done:
- return;
- }
- /**
- * Set up a new fake channel for the test suite
- */
- channel_t *
- new_fake_channel(void)
- {
- channel_t *chan = tor_malloc_zero(sizeof(channel_t));
- channel_init(chan);
- chan->close = chan_test_close;
- chan->get_overhead_estimate = chan_test_get_overhead_estimate;
- chan->num_bytes_queued = chan_test_num_bytes_queued;
- chan->num_cells_writeable = chan_test_num_cells_writeable;
- chan->write_cell = chan_test_write_cell;
- chan->write_packed_cell = chan_test_write_packed_cell;
- chan->write_var_cell = chan_test_write_var_cell;
- chan->state = CHANNEL_STATE_OPEN;
- return chan;
- }
- /**
- * Counter query for scheduler_channel_has_waiting_cells_mock()
- */
- int
- get_mock_scheduler_has_waiting_cells_count(void)
- {
- return test_has_waiting_cells_count;
- }
- /**
- * Mock for scheduler_channel_has_waiting_cells()
- */
- void
- scheduler_channel_has_waiting_cells_mock(channel_t *ch)
- {
- (void)ch;
- /* Increment counter */
- ++test_has_waiting_cells_count;
- return;
- }
- static void
- scheduler_channel_doesnt_want_writes_mock(channel_t *ch)
- {
- (void)ch;
- /* Increment counter */
- ++test_doesnt_want_writes_count;
- return;
- }
- /**
- * Counter query for scheduler_release_channel_mock()
- */
- int
- get_mock_scheduler_release_channel_count(void)
- {
- return test_releases_count;
- }
- /**
- * Mock for scheduler_release_channel()
- */
- void
- scheduler_release_channel_mock(channel_t *ch)
- {
- (void)ch;
- /* Increment counter */
- ++test_releases_count;
- return;
- }
- static void
- test_channel_flush(void *arg)
- {
- channel_t *ch = NULL;
- cell_t *cell = NULL;
- packed_cell_t *p_cell = NULL;
- var_cell_t *v_cell = NULL;
- int init_count;
- (void)arg;
- init_cell_pool();
- ch = new_fake_channel();
- test_assert(ch);
- /* Cache the original count */
- init_count = test_cells_written;
- /* Stop accepting so we can queue some */
- test_chan_accept_cells = 0;
- /* Queue a regular cell */
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- channel_write_cell(ch, cell);
- /* It should be queued, so assert that we didn't write it */
- test_eq(test_cells_written, init_count);
- /* Queue a var cell */
- v_cell = tor_malloc_zero(sizeof(var_cell_t) + CELL_PAYLOAD_SIZE);
- make_fake_var_cell(v_cell);
- channel_write_var_cell(ch, v_cell);
- /* It should be queued, so assert that we didn't write it */
- test_eq(test_cells_written, init_count);
- /* Try a packed cell now */
- p_cell = packed_cell_new();
- test_assert(p_cell);
- channel_write_packed_cell(ch, p_cell);
- /* It should be queued, so assert that we didn't write it */
- test_eq(test_cells_written, init_count);
- /* Now allow writes through again */
- test_chan_accept_cells = 1;
- /* ...and flush */
- channel_flush_cells(ch);
- /* All three should have gone through */
- test_eq(test_cells_written, init_count + 3);
- done:
- tor_free(ch);
- free_cell_pool();
- return;
- }
- /**
- * Normal channel lifecycle test:
- *
- * OPENING->OPEN->MAINT->OPEN->CLOSING->CLOSED
- */
- static void
- test_channel_lifecycle(void *arg)
- {
- channel_t *ch1 = NULL, *ch2 = NULL;
- cell_t *cell = NULL;
- int old_count, init_doesnt_want_writes_count;
- int init_releases_count;
- (void)arg;
- /* Mock these for the whole lifecycle test */
- MOCK(scheduler_channel_doesnt_want_writes,
- scheduler_channel_doesnt_want_writes_mock);
- MOCK(scheduler_release_channel,
- scheduler_release_channel_mock);
- /* Cache some initial counter values */
- init_doesnt_want_writes_count = test_doesnt_want_writes_count;
- init_releases_count = test_releases_count;
- /* Accept cells to lower layer */
- test_chan_accept_cells = 1;
- /* Use default overhead factor */
- test_overhead_estimate = 1.0f;
- ch1 = new_fake_channel();
- test_assert(ch1);
- /* Start it off in OPENING */
- ch1->state = CHANNEL_STATE_OPENING;
- /* We'll need a cmux */
- ch1->cmux = circuitmux_alloc();
- /* Try to register it */
- channel_register(ch1);
- test_assert(ch1->registered);
- /* Try to write a cell through (should queue) */
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- old_count = test_cells_written;
- channel_write_cell(ch1, cell);
- test_eq(old_count, test_cells_written);
- /* Move it to OPEN and flush */
- channel_change_state(ch1, CHANNEL_STATE_OPEN);
- /* Queue should drain */
- test_eq(old_count + 1, test_cells_written);
- /* Get another one */
- ch2 = new_fake_channel();
- test_assert(ch2);
- ch2->state = CHANNEL_STATE_OPENING;
- ch2->cmux = circuitmux_alloc();
- /* Register */
- channel_register(ch2);
- test_assert(ch2->registered);
- /* Check counters */
- test_eq(test_doesnt_want_writes_count, init_doesnt_want_writes_count);
- test_eq(test_releases_count, init_releases_count);
- /* Move ch1 to MAINT */
- channel_change_state(ch1, CHANNEL_STATE_MAINT);
- test_eq(test_doesnt_want_writes_count, init_doesnt_want_writes_count + 1);
- test_eq(test_releases_count, init_releases_count);
- /* Move ch2 to OPEN */
- channel_change_state(ch2, CHANNEL_STATE_OPEN);
- test_eq(test_doesnt_want_writes_count, init_doesnt_want_writes_count + 1);
- test_eq(test_releases_count, init_releases_count);
- /* Move ch1 back to OPEN */
- channel_change_state(ch1, CHANNEL_STATE_OPEN);
- test_eq(test_doesnt_want_writes_count, init_doesnt_want_writes_count + 1);
- test_eq(test_releases_count, init_releases_count);
- /* Mark ch2 for close */
- channel_mark_for_close(ch2);
- test_eq(ch2->state, CHANNEL_STATE_CLOSING);
- test_eq(test_doesnt_want_writes_count, init_doesnt_want_writes_count + 1);
- test_eq(test_releases_count, init_releases_count + 1);
- /* Shut down channels */
- channel_free_all();
- ch1 = ch2 = NULL;
- test_eq(test_doesnt_want_writes_count, init_doesnt_want_writes_count + 1);
- /* channel_free() calls scheduler_release_channel() */
- test_eq(test_releases_count, init_releases_count + 4);
- done:
- tor_free(ch1);
- tor_free(ch2);
- UNMOCK(scheduler_channel_doesnt_want_writes);
- UNMOCK(scheduler_release_channel);
- return;
- }
- /**
- * Weird channel lifecycle test:
- *
- * OPENING->CLOSING->CLOSED
- * OPENING->OPEN->CLOSING->ERROR
- * OPENING->OPEN->MAINT->CLOSING->CLOSED
- * OPENING->OPEN->MAINT->CLOSING->ERROR
- */
- static void
- test_channel_lifecycle_2(void *arg)
- {
- channel_t *ch = NULL;
- (void)arg;
- /* Mock these for the whole lifecycle test */
- MOCK(scheduler_channel_doesnt_want_writes,
- scheduler_channel_doesnt_want_writes_mock);
- MOCK(scheduler_release_channel,
- scheduler_release_channel_mock);
- /* Accept cells to lower layer */
- test_chan_accept_cells = 1;
- /* Use default overhead factor */
- test_overhead_estimate = 1.0f;
- ch = new_fake_channel();
- test_assert(ch);
- /* Start it off in OPENING */
- ch->state = CHANNEL_STATE_OPENING;
- /* The full lifecycle test needs a cmux */
- ch->cmux = circuitmux_alloc();
- /* Try to register it */
- channel_register(ch);
- test_assert(ch->registered);
- /* Try to close it */
- channel_mark_for_close(ch);
- test_eq(ch->state, CHANNEL_STATE_CLOSING);
- /* Finish closing it */
- chan_test_finish_close(ch);
- test_eq(ch->state, CHANNEL_STATE_CLOSED);
- channel_run_cleanup();
- ch = NULL;
- /* Now try OPENING->OPEN->CLOSING->ERROR */
- ch = new_fake_channel();
- test_assert(ch);
- ch->state = CHANNEL_STATE_OPENING;
- ch->cmux = circuitmux_alloc();
- channel_register(ch);
- test_assert(ch->registered);
- /* Finish opening it */
- channel_change_state(ch, CHANNEL_STATE_OPEN);
- /* Error exit from lower layer */
- chan_test_error(ch);
- test_eq(ch->state, CHANNEL_STATE_CLOSING);
- chan_test_finish_close(ch);
- test_eq(ch->state, CHANNEL_STATE_ERROR);
- channel_run_cleanup();
- ch = NULL;
- /* OPENING->OPEN->MAINT->CLOSING->CLOSED close from maintenance state */
- ch = new_fake_channel();
- test_assert(ch);
- ch->state = CHANNEL_STATE_OPENING;
- ch->cmux = circuitmux_alloc();
- channel_register(ch);
- test_assert(ch->registered);
- /* Finish opening it */
- channel_change_state(ch, CHANNEL_STATE_OPEN);
- test_eq(ch->state, CHANNEL_STATE_OPEN);
- /* Go to maintenance state */
- channel_change_state(ch, CHANNEL_STATE_MAINT);
- test_eq(ch->state, CHANNEL_STATE_MAINT);
- /* Lower layer close */
- channel_mark_for_close(ch);
- test_eq(ch->state, CHANNEL_STATE_CLOSING);
- /* Finish */
- chan_test_finish_close(ch);
- test_eq(ch->state, CHANNEL_STATE_CLOSED);
- channel_run_cleanup();
- ch = NULL;
- /*
- * OPENING->OPEN->MAINT->CLOSING->CLOSED lower-layer close during
- * maintenance state
- */
- ch = new_fake_channel();
- test_assert(ch);
- ch->state = CHANNEL_STATE_OPENING;
- ch->cmux = circuitmux_alloc();
- channel_register(ch);
- test_assert(ch->registered);
- /* Finish opening it */
- channel_change_state(ch, CHANNEL_STATE_OPEN);
- test_eq(ch->state, CHANNEL_STATE_OPEN);
- /* Go to maintenance state */
- channel_change_state(ch, CHANNEL_STATE_MAINT);
- test_eq(ch->state, CHANNEL_STATE_MAINT);
- /* Lower layer close */
- channel_close_from_lower_layer(ch);
- test_eq(ch->state, CHANNEL_STATE_CLOSING);
- /* Finish */
- chan_test_finish_close(ch);
- test_eq(ch->state, CHANNEL_STATE_CLOSED);
- channel_run_cleanup();
- ch = NULL;
- /* OPENING->OPEN->MAINT->CLOSING->ERROR */
- ch = new_fake_channel();
- test_assert(ch);
- ch->state = CHANNEL_STATE_OPENING;
- ch->cmux = circuitmux_alloc();
- channel_register(ch);
- test_assert(ch->registered);
- /* Finish opening it */
- channel_change_state(ch, CHANNEL_STATE_OPEN);
- test_eq(ch->state, CHANNEL_STATE_OPEN);
- /* Go to maintenance state */
- channel_change_state(ch, CHANNEL_STATE_MAINT);
- test_eq(ch->state, CHANNEL_STATE_MAINT);
- /* Lower layer close */
- chan_test_error(ch);
- test_eq(ch->state, CHANNEL_STATE_CLOSING);
- /* Finish */
- chan_test_finish_close(ch);
- test_eq(ch->state, CHANNEL_STATE_ERROR);
- channel_run_cleanup();
- ch = NULL;
- /* Shut down channels */
- channel_free_all();
- done:
- tor_free(ch);
- UNMOCK(scheduler_channel_doesnt_want_writes);
- UNMOCK(scheduler_release_channel);
- return;
- }
- static void
- test_channel_multi(void *arg)
- {
- channel_t *ch1 = NULL, *ch2 = NULL;
- uint64_t global_queue_estimate;
- cell_t *cell = NULL;
- (void)arg;
- /* Accept cells to lower layer */
- test_chan_accept_cells = 1;
- /* Use default overhead factor */
- test_overhead_estimate = 1.0f;
- ch1 = new_fake_channel();
- test_assert(ch1);
- ch2 = new_fake_channel();
- test_assert(ch2);
- /* Initial queue size update */
- channel_update_xmit_queue_size(ch1);
- test_eq(ch1->bytes_queued_for_xmit, 0);
- channel_update_xmit_queue_size(ch2);
- test_eq(ch2->bytes_queued_for_xmit, 0);
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 0);
- /* Queue some cells, check queue estimates */
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- channel_write_cell(ch1, cell);
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- channel_write_cell(ch2, cell);
- channel_update_xmit_queue_size(ch1);
- channel_update_xmit_queue_size(ch2);
- test_eq(ch1->bytes_queued_for_xmit, 0);
- test_eq(ch2->bytes_queued_for_xmit, 0);
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 0);
- /* Stop accepting cells at lower layer */
- test_chan_accept_cells = 0;
- /* Queue some cells and check queue estimates */
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- channel_write_cell(ch1, cell);
- channel_update_xmit_queue_size(ch1);
- test_eq(ch1->bytes_queued_for_xmit, 512);
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 512);
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- channel_write_cell(ch2, cell);
- channel_update_xmit_queue_size(ch2);
- test_eq(ch2->bytes_queued_for_xmit, 512);
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 1024);
- /* Allow cells through again */
- test_chan_accept_cells = 1;
- /* Flush chan 2 */
- channel_flush_cells(ch2);
- /* Update and check queue sizes */
- channel_update_xmit_queue_size(ch1);
- channel_update_xmit_queue_size(ch2);
- test_eq(ch1->bytes_queued_for_xmit, 512);
- test_eq(ch2->bytes_queued_for_xmit, 0);
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 512);
- /* Flush chan 1 */
- channel_flush_cells(ch1);
- /* Update and check queue sizes */
- channel_update_xmit_queue_size(ch1);
- channel_update_xmit_queue_size(ch2);
- test_eq(ch1->bytes_queued_for_xmit, 0);
- test_eq(ch2->bytes_queued_for_xmit, 0);
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 0);
- /* Now block again */
- test_chan_accept_cells = 0;
- /* Queue some cells */
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- channel_write_cell(ch1, cell);
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- channel_write_cell(ch2, cell);
- /* Check the estimates */
- channel_update_xmit_queue_size(ch1);
- channel_update_xmit_queue_size(ch2);
- test_eq(ch1->bytes_queued_for_xmit, 512);
- test_eq(ch2->bytes_queued_for_xmit, 512);
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 1024);
- /* Now close channel 2; it should be subtracted from the global queue */
- MOCK(scheduler_release_channel, scheduler_release_channel_mock);
- channel_mark_for_close(ch2);
- UNMOCK(scheduler_release_channel);
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 512);
- /*
- * Since the fake channels aren't registered, channel_free_all() can't
- * see them properly.
- */
- MOCK(scheduler_release_channel, scheduler_release_channel_mock);
- channel_mark_for_close(ch1);
- UNMOCK(scheduler_release_channel);
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 0);
- /* Now free everything */
- MOCK(scheduler_release_channel, scheduler_release_channel_mock);
- channel_free_all();
- UNMOCK(scheduler_release_channel);
- done:
- tor_free(ch1);
- tor_free(ch2);
- return;
- }
- /**
- * Check some hopefully-impossible edge cases in the channel queue we
- * can only trigger by doing evil things to the queue directly.
- */
- static void
- test_channel_queue_impossible(void *arg)
- {
- channel_t *ch = NULL;
- cell_t *cell = NULL;
- packed_cell_t *packed_cell = NULL;
- var_cell_t *var_cell = NULL;
- int old_count;
- cell_queue_entry_t *q = NULL;
- uint64_t global_queue_estimate;
- /* Cache the global queue size (see below) */
- global_queue_estimate = channel_get_global_queue_estimate();
- (void)arg;
- init_cell_pool();
- packed_cell = packed_cell_new();
- test_assert(packed_cell);
- ch = new_fake_channel();
- test_assert(ch);
- /* We test queueing here; tell it not to accept cells */
- test_chan_accept_cells = 0;
- /* ...and keep it from trying to flush the queue */
- ch->state = CHANNEL_STATE_MAINT;
- /* Cache the cell written count */
- old_count = test_cells_written;
- /* Assert that the queue is initially empty */
- test_eq(chan_cell_queue_len(&(ch->outgoing_queue)), 0);
- /* Get a fresh cell and write it to the channel*/
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- channel_write_cell(ch, cell);
- /* Now it should be queued */
- test_eq(chan_cell_queue_len(&(ch->outgoing_queue)),1);
- q = TOR_SIMPLEQ_FIRST(&(ch->outgoing_queue));
- test_assert(q);
- if (q) {
- test_eq(q->type, CELL_QUEUE_FIXED);
- test_eq(q->u.fixed.cell, cell);
- }
- /* Do perverse things to it */
- tor_free(q->u.fixed.cell);
- q->u.fixed.cell = NULL;
- /*
- * Now change back to open with channel_change_state() and assert that it
- * gets thrown away properly.
- */
- test_chan_accept_cells = 1;
- channel_change_state(ch, CHANNEL_STATE_OPEN);
- test_assert(test_cells_written == old_count);
- test_eq(chan_cell_queue_len(&(ch->outgoing_queue)), 0);
- /* Same thing but for a var_cell */
- test_chan_accept_cells = 0;
- ch->state = CHANNEL_STATE_MAINT;
- var_cell = tor_malloc_zero(sizeof(var_cell_t) + CELL_PAYLOAD_SIZE);
- make_fake_var_cell(var_cell);
- channel_write_var_cell(ch, var_cell);
- /* Check that it's queued */
- test_eq(chan_cell_queue_len(&(ch->outgoing_queue)), 1);
- q = TOR_SIMPLEQ_FIRST(&(ch->outgoing_queue));
- test_assert(q);
- if (q) {
- test_eq(q->type, CELL_QUEUE_VAR);
- test_eq(q->u.var.var_cell, var_cell);
- }
- /* Remove the cell from the queue entry */
- tor_free(q->u.var.var_cell);
- q->u.var.var_cell = NULL;
- /* Let it drain and check that the bad entry is discarded */
- test_chan_accept_cells = 1;
- channel_change_state(ch, CHANNEL_STATE_OPEN);
- test_assert(test_cells_written == old_count);
- test_eq(chan_cell_queue_len(&(ch->outgoing_queue)), 0);
- /* Same thing with a packed_cell */
- test_chan_accept_cells = 0;
- ch->state = CHANNEL_STATE_MAINT;
- packed_cell = packed_cell_new();
- test_assert(packed_cell);
- channel_write_packed_cell(ch, packed_cell);
- /* Check that it's queued */
- test_eq(chan_cell_queue_len(&(ch->outgoing_queue)), 1);
- q = TOR_SIMPLEQ_FIRST(&(ch->outgoing_queue));
- test_assert(q);
- if (q) {
- test_eq(q->type, CELL_QUEUE_PACKED);
- test_eq(q->u.packed.packed_cell, packed_cell);
- }
- /* Remove the cell from the queue entry */
- packed_cell_free(q->u.packed.packed_cell);
- q->u.packed.packed_cell = NULL;
- /* Let it drain and check that the bad entry is discarded */
- test_chan_accept_cells = 1;
- channel_change_state(ch, CHANNEL_STATE_OPEN);
- test_assert(test_cells_written == old_count);
- test_eq(chan_cell_queue_len(&(ch->outgoing_queue)), 0);
- done:
- tor_free(ch);
- free_cell_pool();
- /*
- * Doing that meant that we couldn't correctly adjust the queue size
- * for the var cell, so manually reset the global queue size estimate
- * so the next test doesn't break if we run with --no-fork.
- */
- estimated_total_queue_size = global_queue_estimate;
- return;
- }
- static void
- test_channel_queue_size(void *arg)
- {
- channel_t *ch = NULL;
- cell_t *cell = NULL;
- int n, old_count;
- uint64_t global_queue_estimate;
- (void)arg;
- ch = new_fake_channel();
- test_assert(ch);
- /* Initial queue size update */
- channel_update_xmit_queue_size(ch);
- test_eq(ch->bytes_queued_for_xmit, 0);
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 0);
- /* Test the call-through to our fake lower layer */
- n = channel_num_cells_writeable(ch);
- /* chan_test_num_cells_writeable() always returns 32 */
- test_eq(n, 32);
- /*
- * Now we queue some cells and check that channel_num_cells_writeable()
- * adjusts properly
- */
- /* tell it not to accept cells */
- test_chan_accept_cells = 0;
- /* ...and keep it from trying to flush the queue */
- ch->state = CHANNEL_STATE_MAINT;
- /* Get a fresh cell */
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- old_count = test_cells_written;
- channel_write_cell(ch, cell);
- /* Assert that it got queued, not written through, correctly */
- test_eq(test_cells_written, old_count);
- /* Now check chan_test_num_cells_writeable() again */
- n = channel_num_cells_writeable(ch);
- test_eq(n, 0); /* Should return 0 since we're in CHANNEL_STATE_MAINT */
- /* Update queue size estimates */
- channel_update_xmit_queue_size(ch);
- /* One cell, times an overhead factor of 1.0 */
- test_eq(ch->bytes_queued_for_xmit, 512);
- /* Try a different overhead factor */
- test_overhead_estimate = 0.5f;
- /* This one should be ignored since it's below 1.0 */
- channel_update_xmit_queue_size(ch);
- test_eq(ch->bytes_queued_for_xmit, 512);
- /* Now try a larger one */
- test_overhead_estimate = 2.0f;
- channel_update_xmit_queue_size(ch);
- test_eq(ch->bytes_queued_for_xmit, 1024);
- /* Go back to 1.0 */
- test_overhead_estimate = 1.0f;
- channel_update_xmit_queue_size(ch);
- test_eq(ch->bytes_queued_for_xmit, 512);
- /* Check the global estimate too */
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 512);
- /* Go to open */
- old_count = test_cells_written;
- channel_change_state(ch, CHANNEL_STATE_OPEN);
- /*
- * It should try to write, but we aren't accepting cells right now, so
- * it'll requeue
- */
- test_eq(test_cells_written, old_count);
- /* Check the queue size again */
- channel_update_xmit_queue_size(ch);
- test_eq(ch->bytes_queued_for_xmit, 512);
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 512);
- /*
- * Now the cell is in the queue, and we're open, so we should get 31
- * writeable cells.
- */
- n = channel_num_cells_writeable(ch);
- test_eq(n, 31);
- /* Accept cells again */
- test_chan_accept_cells = 1;
- /* ...and re-process the queue */
- old_count = test_cells_written;
- channel_flush_cells(ch);
- test_eq(test_cells_written, old_count + 1);
- /* Should have 32 writeable now */
- n = channel_num_cells_writeable(ch);
- test_eq(n, 32);
- /* Should have queue size estimate of zero */
- channel_update_xmit_queue_size(ch);
- test_eq(ch->bytes_queued_for_xmit, 0);
- global_queue_estimate = channel_get_global_queue_estimate();
- test_eq(global_queue_estimate, 0);
- /* Okay, now we're done with this one */
- MOCK(scheduler_release_channel, scheduler_release_channel_mock);
- channel_mark_for_close(ch);
- UNMOCK(scheduler_release_channel);
- done:
- tor_free(ch);
- return;
- }
- static void
- test_channel_write(void *arg)
- {
- channel_t *ch = NULL;
- cell_t *cell = tor_malloc_zero(sizeof(cell_t));
- packed_cell_t *packed_cell = NULL;
- var_cell_t *var_cell =
- tor_malloc_zero(sizeof(var_cell_t) + CELL_PAYLOAD_SIZE);
- int old_count;
- (void)arg;
- init_cell_pool();
- packed_cell = packed_cell_new();
- test_assert(packed_cell);
- ch = new_fake_channel();
- test_assert(ch);
- make_fake_cell(cell);
- make_fake_var_cell(var_cell);
- /* Tell it to accept cells */
- test_chan_accept_cells = 1;
- old_count = test_cells_written;
- channel_write_cell(ch, cell);
- test_assert(test_cells_written == old_count + 1);
- channel_write_var_cell(ch, var_cell);
- test_assert(test_cells_written == old_count + 2);
- channel_write_packed_cell(ch, packed_cell);
- test_assert(test_cells_written == old_count + 3);
- /* Now we test queueing; tell it not to accept cells */
- test_chan_accept_cells = 0;
- /* ...and keep it from trying to flush the queue */
- ch->state = CHANNEL_STATE_MAINT;
- /* Get a fresh cell */
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- old_count = test_cells_written;
- channel_write_cell(ch, cell);
- test_assert(test_cells_written == old_count);
- /*
- * Now change back to open with channel_change_state() and assert that it
- * gets drained from the queue.
- */
- test_chan_accept_cells = 1;
- channel_change_state(ch, CHANNEL_STATE_OPEN);
- test_assert(test_cells_written == old_count + 1);
- /*
- * Check the note destroy case
- */
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- cell->command = CELL_DESTROY;
- /* Set up the mock */
- MOCK(channel_note_destroy_not_pending,
- channel_note_destroy_not_pending_mock);
- old_count = test_destroy_not_pending_calls;
- channel_write_cell(ch, cell);
- test_assert(test_destroy_not_pending_calls == old_count + 1);
- /* Now send a non-destroy and check we don't call it */
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- channel_write_cell(ch, cell);
- test_assert(test_destroy_not_pending_calls == old_count + 1);
- UNMOCK(channel_note_destroy_not_pending);
- /*
- * Now switch it to CLOSING so we can test the discard-cells case
- * in the channel_write_*() functions.
- */
- MOCK(scheduler_release_channel, scheduler_release_channel_mock);
- channel_mark_for_close(ch);
- UNMOCK(scheduler_release_channel);
- /* Send cells that will drop in the closing state */
- old_count = test_cells_written;
- cell = tor_malloc_zero(sizeof(cell_t));
- make_fake_cell(cell);
- channel_write_cell(ch, cell);
- test_assert(test_cells_written == old_count);
- var_cell = tor_malloc_zero(sizeof(var_cell_t) + CELL_PAYLOAD_SIZE);
- make_fake_var_cell(var_cell);
- channel_write_var_cell(ch, var_cell);
- test_assert(test_cells_written == old_count);
- packed_cell = packed_cell_new();
- channel_write_packed_cell(ch, packed_cell);
- test_assert(test_cells_written == old_count);
- free_cell_pool();
- done:
- tor_free(ch);
- return;
- }
- struct testcase_t channel_tests[] = {
- { "flush", test_channel_flush, TT_FORK, NULL, NULL },
- { "lifecycle", test_channel_lifecycle, TT_FORK, NULL, NULL },
- { "lifecycle_2", test_channel_lifecycle_2, TT_FORK, NULL, NULL },
- { "multi", test_channel_multi, TT_FORK, NULL, NULL },
- { "queue_impossible", test_channel_queue_impossible, TT_FORK, NULL, NULL },
- { "queue_size", test_channel_queue_size, TT_FORK, NULL, NULL },
- { "write", test_channel_write, TT_FORK, NULL, NULL },
- END_OF_TESTCASES
- };
|