123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420 |
- /* * Copyright (c) 2012, The Tor Project, Inc. */
- /* See LICENSE for licensing information */
- /**
- * \file channel.c
- * \brief OR-to-OR channel abstraction layer
- **/
- /*
- * Define this so channel.h gives us things only channel_t subclasses
- * should touch.
- */
- #define _TOR_CHANNEL_INTERNAL
- #include "or.h"
- #include "channel.h"
- #include "channeltls.h"
- #include "circuitbuild.h"
- #include "circuitlist.h"
- #include "geoip.h"
- #include "nodelist.h"
- #include "relay.h"
- #include "rephist.h"
- #include "router.h"
- #include "routerlist.h"
- /* Cell queue structure */
- typedef struct cell_queue_entry_s cell_queue_entry_t;
- struct cell_queue_entry_s {
- enum {
- CELL_QUEUE_FIXED,
- CELL_QUEUE_VAR,
- CELL_QUEUE_PACKED
- } type;
- union {
- struct {
- cell_t *cell;
- } fixed;
- struct {
- var_cell_t *var_cell;
- } var;
- struct {
- packed_cell_t *packed_cell;
- } packed;
- } u;
- };
- /* Global lists of channels */
- /* All channel_t instances */
- static smartlist_t *all_channels = NULL;
- /* All channel_t instances not in ERROR or CLOSED states */
- static smartlist_t *active_channels = NULL;
- /* All channel_t instances in LISTENING state */
- static smartlist_t *listening_channels = NULL;
- /* All channel_t instances in ERROR or CLOSED states */
- static smartlist_t *finished_channels = NULL;
- /* Counter for ID numbers */
- static uint64_t n_channels_allocated = 0;
- /* Digest->channel map
- *
- * Similar to the one used in connection_or.c, this maps from the identity
- * digest of a remote endpoint to a channel_t to that endpoint. Channels
- * should be placed here when registered and removed when they close or error.
- * If more than one channel exists, follow the next_with_same_id pointer
- * as a linked list.
- */
- static digestmap_t *channel_identity_map = NULL;
- /* Functions to maintain the digest map */
- static void channel_add_to_digest_map(channel_t *chan);
- static void channel_remove_from_digest_map(channel_t *chan);
- /*
- * Flush cells from just the outgoing queue without trying to get them
- * from circuits; used internall by channel_flush_some_cells().
- */
- static ssize_t
- channel_flush_some_cells_from_outgoing_queue(channel_t *chan,
- ssize_t num_cells);
- /***********************************
- * Channel state utility functions *
- **********************************/
- /**
- * Indicate whether a given channel state is valid
- *
- * @param state A channel state
- * @return A boolean value indicating whether state is a valid channel state
- */
- int
- channel_state_is_valid(channel_state_t state)
- {
- int is_valid;
- switch (state) {
- case CHANNEL_STATE_CLOSED:
- case CHANNEL_STATE_CLOSING:
- case CHANNEL_STATE_ERROR:
- case CHANNEL_STATE_LISTENING:
- case CHANNEL_STATE_MAINT:
- case CHANNEL_STATE_OPENING:
- case CHANNEL_STATE_OPEN:
- is_valid = 1;
- break;
- case CHANNEL_STATE_LAST:
- default:
- is_valid = 0;
- }
- return is_valid;
- }
- /**
- * Indicate whether a channel state transition is valid
- *
- * This function takes two channel states and indicates whether a
- * transition between them is permitted (see the state definitions and
- * transition table in or.h at the channel_state_t typedef).
- *
- * @param from Proposed state to transition from
- * @param to Proposed state to transition to
- * @return A boolean value indicating whether the posposed transition is valid
- */
- int
- channel_state_can_transition(channel_state_t from, channel_state_t to)
- {
- int is_valid;
- switch (from) {
- case CHANNEL_STATE_CLOSED:
- is_valid = (to == CHANNEL_STATE_LISTENING ||
- to == CHANNEL_STATE_OPENING);
- break;
- case CHANNEL_STATE_CLOSING:
- is_valid = (to == CHANNEL_STATE_CLOSED ||
- to == CHANNEL_STATE_ERROR);
- break;
- case CHANNEL_STATE_ERROR:
- is_valid = 0;
- break;
- case CHANNEL_STATE_LISTENING:
- is_valid = (to == CHANNEL_STATE_CLOSING ||
- to == CHANNEL_STATE_ERROR);
- break;
- case CHANNEL_STATE_MAINT:
- is_valid = (to == CHANNEL_STATE_CLOSING ||
- to == CHANNEL_STATE_ERROR ||
- to == CHANNEL_STATE_OPEN);
- break;
- case CHANNEL_STATE_OPENING:
- is_valid = (to == CHANNEL_STATE_CLOSING ||
- to == CHANNEL_STATE_ERROR ||
- to == CHANNEL_STATE_OPEN);
- break;
- case CHANNEL_STATE_OPEN:
- is_valid = (to == CHANNEL_STATE_CLOSING ||
- to == CHANNEL_STATE_ERROR ||
- to == CHANNEL_STATE_MAINT);
- break;
- case CHANNEL_STATE_LAST:
- default:
- is_valid = 0;
- }
- return is_valid;
- }
- /**
- * Return a human-readable description for a channel state
- *
- * @param state A channel state
- * @return A pointer to a string with a human-readable description of state
- */
- const char *
- channel_state_to_string(channel_state_t state)
- {
- const char *descr;
- switch (state) {
- case CHANNEL_STATE_CLOSED:
- descr = "closed";
- break;
- case CHANNEL_STATE_CLOSING:
- descr = "closing";
- break;
- case CHANNEL_STATE_ERROR:
- descr = "channel error";
- break;
- case CHANNEL_STATE_LISTENING:
- descr = "listening";
- break;
- case CHANNEL_STATE_MAINT:
- descr = "temporarily suspended for maintenance";
- break;
- case CHANNEL_STATE_OPENING:
- descr = "opening";
- break;
- case CHANNEL_STATE_OPEN:
- descr = "open";
- break;
- case CHANNEL_STATE_LAST:
- default:
- descr = "unknown or invalid channel state";
- }
- return descr;
- }
- /***************************************
- * Channel registration/unregistration *
- ***************************************/
- /**
- * Register a channel
- *
- * This function registers a newly created channel in the global lists/maps
- * of active channels.
- *
- * @param chan A pointer to an unregistered channel
- */
- void
- channel_register(channel_t *chan)
- {
- tor_assert(chan);
- /* No-op if already registered */
- if (chan->registered) return;
- if (chan->is_listener) {
- log_debug(LD_CHANNEL,
- "Registering listener channel %p (ID %lu) in state %s (%d)",
- chan, chan->global_identifier,
- channel_state_to_string(chan->state), chan->state);
- } else {
- log_debug(LD_CHANNEL,
- "Registering cell channel %p (ID %lu) in state %s (%d) "
- "with digest %s",
- chan, chan->global_identifier,
- channel_state_to_string(chan->state), chan->state,
- hex_str(chan->u.cell_chan.identity_digest, DIGEST_LEN));
- }
- /* Make sure we have all_channels, then add it */
- if (!all_channels) all_channels = smartlist_new();
- smartlist_add(all_channels, chan);
- /* Is it finished? */
- if (chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR) {
- /* Put it in the finished list, creating it if necessary */
- if (!finished_channels) finished_channels = smartlist_new();
- smartlist_add(finished_channels, chan);
- } else {
- /* Put it in the active list, creating it if necessary */
- if (!active_channels) active_channels = smartlist_new();
- smartlist_add(active_channels, chan);
- /* Is it a listener? */
- if (chan->is_listener &&
- chan->state == CHANNEL_STATE_LISTENING) {
- /* Put it in the listening list, creating it if necessary */
- if (!listening_channels) listening_channels = smartlist_new();
- smartlist_add(listening_channels, chan);
- } else if (chan->state != CHANNEL_STATE_CLOSING) {
- if (!(chan->is_listener)) {
- /* It should have a digest set */
- if (!tor_digest_is_zero(chan->u.cell_chan.identity_digest)) {
- /* Yeah, we're good, add it to the map */
- channel_add_to_digest_map(chan);
- } else {
- log_info(LD_CHANNEL,
- "Channel %p (global ID %lu) in state %s (%d) registered "
- "with no identity digest",
- chan, chan->global_identifier,
- channel_state_to_string(chan->state), chan->state);
- }
- }
- }
- }
- /* Mark it as registered */
- chan->registered = 1;
- }
- /**
- * Unregister a channel
- *
- * This function removes a channel from the global lists and maps and is used
- * when freeing a closed/errored channel.
- *
- * @param chan A pointer to a channel to be unregistered
- */
- void
- channel_unregister(channel_t *chan)
- {
- tor_assert(chan);
- /* No-op if not registered */
- if (!(chan->registered)) return;
- /* Is it finished? */
- if (chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR) {
- /* Get it out of the finished list */
- if (finished_channels) smartlist_remove(finished_channels, chan);
- } else {
- /* Get it out of the active list */
- if (active_channels) smartlist_remove(active_channels, chan);
- /* Is it listening? */
- if (chan->state == CHANNEL_STATE_LISTENING) {
- /* Get it out of the listening list */
- if (listening_channels) smartlist_remove(listening_channels, chan);
- }
- }
- /* Get it out of all_channels */
- if (all_channels) smartlist_remove(all_channels, chan);
- /* Mark it as unregistered */
- chan->registered = 0;
- if (!(chan->is_listener)) {
- /* Should it be in the digest map? */
- if (!tor_digest_is_zero(chan->u.cell_chan.identity_digest) &&
- !(chan->state == CHANNEL_STATE_LISTENING ||
- chan->state == CHANNEL_STATE_CLOSING ||
- chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR)) {
- /* Remove it */
- channel_remove_from_digest_map(chan);
- }
- }
- }
- /*********************************
- * Channel digest map maintenance
- *********************************/
- /**
- * Add a channel to the digest map
- *
- * This function adds a channel to the digest map and inserts it into the
- * correct linked list if channels with that remote endpoint identity digest
- * already exist.
- *
- * @param chan A pointer to a channel to add
- */
- static void
- channel_add_to_digest_map(channel_t *chan)
- {
- channel_t *tmp;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- /* Assert that the state makes sense */
- tor_assert(!(chan->state == CHANNEL_STATE_LISTENING ||
- chan->state == CHANNEL_STATE_CLOSING ||
- chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR));
- /* Assert that there is a digest */
- tor_assert(!tor_digest_is_zero(chan->u.cell_chan.identity_digest));
- /* Allocate the identity map if we have to */
- if (!channel_identity_map) channel_identity_map = digestmap_new();
- /* Insert it */
- tmp = digestmap_set(channel_identity_map,
- chan->u.cell_chan.identity_digest,
- chan);
- if (tmp) {
- tor_assert(!(tmp->is_listener));
- /* There already was one, this goes at the head of the list */
- chan->u.cell_chan.next_with_same_id = tmp;
- chan->u.cell_chan.prev_with_same_id = NULL;
- tmp->u.cell_chan.prev_with_same_id = chan;
- } else {
- /* First with this digest */
- chan->u.cell_chan.next_with_same_id = NULL;
- chan->u.cell_chan.prev_with_same_id = NULL;
- }
- log_debug(LD_CHANNEL,
- "Added channel %p (%lu) to identity map in state %s (%d) "
- "with digest %s",
- chan, chan->global_identifier,
- channel_state_to_string(chan->state), chan->state,
- hex_str(chan->u.cell_chan.identity_digest, DIGEST_LEN));
- }
- /**
- * Remove a channel from the digest map
- *
- * This function removes a channel from the digest map and the linked list of
- * channels for that digest if more than one exists.
- *
- * @param chan A pointer to a channel to remove
- */
- static void
- channel_remove_from_digest_map(channel_t *chan)
- {
- channel_t *tmp, *head;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- /* Assert that there is a digest */
- tor_assert(!tor_digest_is_zero(chan->u.cell_chan.identity_digest));
- /* Make sure we have a map */
- if (!channel_identity_map) {
- /*
- * No identity map, so we can't find it by definition. This
- * case is similar to digestmap_get() failing below.
- */
- log_warn(LD_BUG,
- "Trying to remove channel %p (%lu) with digest %s from "
- "identity map, but didn't have any identity map",
- chan, chan->global_identifier,
- hex_str(chan->u.cell_chan.identity_digest, DIGEST_LEN));
- /* Clear out its next/prev pointers */
- if (chan->u.cell_chan.next_with_same_id) {
- tor_assert(!(chan->u.cell_chan.next_with_same_id->is_listener));
- chan->u.cell_chan.next_with_same_id->u.cell_chan.prev_with_same_id
- = chan->u.cell_chan.prev_with_same_id;
- }
- if (chan->u.cell_chan.prev_with_same_id) {
- tor_assert(!(chan->u.cell_chan.prev_with_same_id->is_listener));
- chan->u.cell_chan.prev_with_same_id->u.cell_chan.next_with_same_id
- = chan->u.cell_chan.next_with_same_id;
- }
- chan->u.cell_chan.next_with_same_id = NULL;
- chan->u.cell_chan.prev_with_same_id = NULL;
- return;
- }
- /* Look for it in the map */
- tmp = digestmap_get(channel_identity_map, chan->u.cell_chan.identity_digest);
- if (tmp) {
- /* Okay, it's here */
- head = tmp; /* Keep track of list head */
- /* Look for this channel */
- while (tmp && tmp != chan) {
- tor_assert(!(tmp->is_listener));
- tmp = tmp->u.cell_chan.next_with_same_id;
- }
- if (tmp == chan) {
- /* Found it, good */
- if (chan->u.cell_chan.next_with_same_id) {
- tor_assert(!(chan->u.cell_chan.next_with_same_id->is_listener));
- chan->u.cell_chan.next_with_same_id->u.cell_chan.prev_with_same_id
- = chan->u.cell_chan.prev_with_same_id;
- }
- /* else we're the tail of the list */
- if (chan->u.cell_chan.prev_with_same_id) {
- tor_assert(!(chan->u.cell_chan.prev_with_same_id->is_listener));
- /* We're not the head of the list, so we can *just* unlink */
- chan->u.cell_chan.prev_with_same_id->u.cell_chan.next_with_same_id
- = chan->u.cell_chan.next_with_same_id;
- } else {
- /* We're the head, so we have to point the digest map entry at our
- * next if we have one, or remove it if we're also the tail */
- if (chan->u.cell_chan.next_with_same_id) {
- tor_assert(!(chan->u.cell_chan.next_with_same_id->is_listener));
- digestmap_set(channel_identity_map,
- chan->u.cell_chan.identity_digest,
- chan->u.cell_chan.next_with_same_id);
- } else {
- digestmap_remove(channel_identity_map,
- chan->u.cell_chan.identity_digest);
- }
- }
- /* NULL out its next/prev pointers, and we're finished */
- chan->u.cell_chan.next_with_same_id = NULL;
- chan->u.cell_chan.prev_with_same_id = NULL;
- log_debug(LD_CHANNEL,
- "Removed channel %p (%lu) from identity map in state %s (%d) "
- "with digest %s",
- chan, chan->global_identifier,
- channel_state_to_string(chan->state), chan->state,
- hex_str(chan->u.cell_chan.identity_digest, DIGEST_LEN));
- } else {
- /* This is not good */
- log_warn(LD_BUG,
- "Trying to remove channel %p (%lu) with digest %s from "
- "identity map, but couldn't find it in the list for that "
- "digest",
- chan, chan->global_identifier,
- hex_str(chan->u.cell_chan.identity_digest, DIGEST_LEN));
- /* Unlink it and hope for the best */
- if (chan->u.cell_chan.next_with_same_id) {
- tor_assert(!(chan->u.cell_chan.next_with_same_id->is_listener));
- chan->u.cell_chan.next_with_same_id->u.cell_chan.prev_with_same_id
- = chan->u.cell_chan.prev_with_same_id;
- }
- if (chan->u.cell_chan.prev_with_same_id) {
- tor_assert(!(chan->u.cell_chan.prev_with_same_id->is_listener));
- chan->u.cell_chan.prev_with_same_id->u.cell_chan.next_with_same_id
- = chan->u.cell_chan.next_with_same_id;
- }
- chan->u.cell_chan.next_with_same_id = NULL;
- chan->u.cell_chan.prev_with_same_id = NULL;
- }
- } else {
- /* Shouldn't happen */
- log_warn(LD_BUG,
- "Trying to remove channel %p (%lu) with digest %s from "
- "identity map, but couldn't find any with that digest",
- chan, chan->global_identifier,
- hex_str(chan->u.cell_chan.identity_digest, DIGEST_LEN));
- /* Clear out its next/prev pointers */
- if (chan->u.cell_chan.next_with_same_id) {
- tor_assert(!(chan->u.cell_chan.next_with_same_id->is_listener));
- chan->u.cell_chan.next_with_same_id->u.cell_chan.prev_with_same_id
- = chan->u.cell_chan.prev_with_same_id;
- }
- if (chan->u.cell_chan.prev_with_same_id) {
- chan->u.cell_chan.prev_with_same_id->u.cell_chan.next_with_same_id
- = chan->u.cell_chan.next_with_same_id;
- }
- chan->u.cell_chan.next_with_same_id = NULL;
- chan->u.cell_chan.prev_with_same_id = NULL;
- }
- }
- /****************************
- * Channel lookup functions *
- ***************************/
- /**
- * Find channel by global ID
- *
- * This function searches for a channel by the global_identifier assigned
- * at initialization time. This identifier is unique for the lifetime of the
- * Tor process.
- *
- * @param global_identifier The global_identifier value to search for
- * @return A pointer to the channel with that global identifier, or NULL if
- * none exists.
- */
- channel_t *
- channel_find_by_global_id(uint64_t global_identifier)
- {
- channel_t *rv = NULL;
- if (all_channels && smartlist_len(all_channels) > 0) {
- SMARTLIST_FOREACH_BEGIN(all_channels, channel_t *, curr) {
- if (curr->global_identifier == global_identifier) {
- rv = curr;
- break;
- }
- } SMARTLIST_FOREACH_END(curr);
- }
- return rv;
- }
- /**
- * Find channel by digest of the remote endpoint
- *
- * This function looks up a channel by the digest of its remote endpoint in
- * the channel digest map. It's possible that more than one channel to a
- * given endpoint exists. Use channel_next_with_digest() and
- * channel_prev_with_digest() to walk the list.
- *
- * @param identity_digest A digest to search for
- * @return A channel pointer, or NULL if no channel to this endpoint exists.
- */
- channel_t *
- channel_find_by_remote_digest(const char *identity_digest)
- {
- channel_t *rv = NULL, *tmp;
- tor_assert(identity_digest);
- /* Search for it in the identity map */
- if (channel_identity_map) {
- tmp = digestmap_get(channel_identity_map, identity_digest);
- rv = tmp;
- }
- return rv;
- }
- /**
- * Find channel by remote nickname
- *
- * This function looks up a channel by the nickname of the remote
- * endpoint. It's possible that more than one channel to that endpoint
- * nickname exists, but there is not currently any supported way to iterate
- * them. Use digests.
- *
- * @param nickname A node nickname
- * @return A channel pointer to a channel to a node with that nickname, or
- * NULL if none is available.
- */
- channel_t *
- channel_find_by_remote_nickname(const char *nickname)
- {
- channel_t *rv = NULL;
- tor_assert(nickname);
- if (all_channels && smartlist_len(all_channels) > 0) {
- SMARTLIST_FOREACH_BEGIN(all_channels, channel_t *, curr) {
- if (!(curr->is_listener)) {
- if (curr->u.cell_chan.nickname &&
- strncmp(curr->u.cell_chan.nickname, nickname,
- MAX_NICKNAME_LEN) == 0) {
- rv = curr;
- break;
- }
- }
- } SMARTLIST_FOREACH_END(curr);
- }
- return rv;
- }
- /**
- * Next channel with digest
- *
- * This function takes a channel and finds the next channel in the list
- * with the same digest.
- *
- * @param chan Channel pointer to iterate
- * @return A pointer to the next channel after chan with the same remote
- * endpoint identity digest, or NULL if none exists.
- */
- channel_t *
- channel_next_with_digest(channel_t *chan)
- {
- channel_t *rv = NULL;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- if (chan->u.cell_chan.next_with_same_id)
- rv = chan->u.cell_chan.next_with_same_id;
- return rv;
- }
- /**
- * Previous channel with digest
- *
- * This function takes a channel and finds the previos channel in the list
- * with the same digest.
- *
- * @param chan Channel pointer to iterate
- * @return A pointer to the previous channel after chan with the same remote
- * endpoint identity digest, or NULL if none exists.
- */
- channel_t *
- channel_prev_with_digest(channel_t *chan)
- {
- channel_t *rv = NULL;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- if (chan->u.cell_chan.prev_with_same_id)
- rv = chan->u.cell_chan.prev_with_same_id;
- return rv;
- }
- /**
- * Internal-only channel init function for cell channels
- *
- * This function should be called by subclasses to set up some per-channel
- * variables. I.e., this is the superclass constructor. Before this, the
- * channel should be allocated with tor_malloc_zero().
- *
- * @param chan Pointer to a channel to initialize.
- */
- void
- channel_init_for_cells(channel_t *chan)
- {
- tor_assert(chan);
- /* Assign an ID and bump the counter */
- chan->global_identifier = n_channels_allocated++;
- /* Mark as a non-listener */
- chan->is_listener = 0;
- /* Init timestamp */
- chan->u.cell_chan.timestamp_last_added_nonpadding = time(NULL);
- /* Init next_circ_id */
- chan->u.cell_chan.next_circ_id = crypto_rand_int(1 << 15);
- /* Timestamp it */
- channel_timestamp_created(chan);
- }
- /**
- * Internal-only channel init function for listener channels
- *
- * This function should be called by subclasses to set up some per-channel
- * variables. I.e., this is the superclass constructor. Before this, the
- * channel should be allocated with tor_malloc_zero().
- *
- * @param chan Pointer to a channel to initialize.
- */
- void
- channel_init_listener(channel_t *chan)
- {
- tor_assert(chan);
- /* Assign an ID and bump the counter */
- chan->global_identifier = n_channels_allocated++;
- /* Mark as a listener */
- chan->is_listener = 1;
- /* Timestamp it */
- channel_timestamp_created(chan);
- }
- /**
- * Internal-only channel free function
- *
- * Nothing outside of channel.c should call this; it frees channels after
- * they have closed and been unregistered.
- *
- * @param chan Channel to free
- */
- void
- channel_free(channel_t *chan)
- {
- tor_assert(chan);
- /* It must be closed or errored */
- tor_assert(chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR);
- /* It must be deregistered */
- tor_assert(!(chan->registered));
- /* Call a free method if there is one */
- if (chan->free) chan->free(chan);
- if (!(chan->is_listener)) {
- channel_clear_remote_end(chan);
- if (chan->u.cell_chan.active_circuit_pqueue) {
- smartlist_free(chan->u.cell_chan.active_circuit_pqueue);
- chan->u.cell_chan.active_circuit_pqueue = NULL;
- }
- }
- /* We're in CLOSED or ERROR, so the cell queue is already empty */
- tor_free(chan);
- }
- /**
- * Internal-only forcible channel free function
- *
- * This is like channel_free, but doesn't do the state/registration asserts;
- * it should only be used from channel_free_all() when shutting down.
- */
- void
- channel_force_free(channel_t *chan)
- {
- cell_queue_entry_t *tmp = NULL;
- channel_t *tmpchan = NULL;
- tor_assert(chan);
- /* Call a free method if there is one */
- if (chan->free) chan->free(chan);
- if (chan->is_listener) {
- /*
- * The incoming list just gets emptied and freed; we request close on
- * any channels we find there, but since we got called while shutting
- * down they will get deregistered and freed elsewhere anyway.
- */
- if (chan->u.listener.incoming_list) {
- SMARTLIST_FOREACH_BEGIN(chan->u.listener.incoming_list,
- channel_t *, qchan) {
- tmpchan = qchan;
- SMARTLIST_DEL_CURRENT(chan->u.listener.incoming_list, qchan);
- channel_request_close(tmpchan);
- } SMARTLIST_FOREACH_END(qchan);
- smartlist_free(chan->u.listener.incoming_list);
- chan->u.listener.incoming_list = NULL;
- }
- } else {
- channel_clear_remote_end(chan);
- smartlist_free(chan->u.cell_chan.active_circuit_pqueue);
- /* We might still have a cell queue; kill it */
- if (chan->u.cell_chan.cell_queue) {
- SMARTLIST_FOREACH_BEGIN(chan->u.cell_chan.cell_queue,
- cell_queue_entry_t *, q) {
- tmp = q;
- SMARTLIST_DEL_CURRENT(chan->u.cell_chan.cell_queue, q);
- tor_free(q);
- } SMARTLIST_FOREACH_END(q);
- smartlist_free(chan->u.cell_chan.cell_queue);
- chan->u.cell_chan.cell_queue = NULL;
- }
- /* Outgoing cell queue is similar, but we can have to free packed cells */
- if (chan->u.cell_chan.outgoing_queue) {
- SMARTLIST_FOREACH_BEGIN(chan->u.cell_chan.outgoing_queue,
- cell_queue_entry_t *, q) {
- tmp = q;
- SMARTLIST_DEL_CURRENT(chan->u.cell_chan.outgoing_queue, q);
- if (tmp->type == CELL_QUEUE_PACKED) {
- if (tmp->u.packed.packed_cell) {
- packed_cell_free(tmp->u.packed.packed_cell);
- }
- }
- tor_free(tmp);
- } SMARTLIST_FOREACH_END(q);
- smartlist_free(chan->u.cell_chan.outgoing_queue);
- chan->u.cell_chan.outgoing_queue = NULL;
- }
- }
- tor_free(chan);
- }
- /**
- * Return the current registered listener for a channel
- *
- * This function returns a function pointer to the current registered
- * handler for new incoming channels on a listener channel.
- *
- * @param chan Channel to get listener for
- * @return Function pointer to an incoming channel handler
- */
- void
- (* channel_get_listener(channel_t *chan))
- (channel_t *, channel_t *)
- {
- tor_assert(chan);
- tor_assert(chan->is_listener);
- if (chan->state == CHANNEL_STATE_LISTENING)
- return chan->u.listener.listener;
- return NULL;
- }
- /**
- * Set the listener for a channel
- *
- * This function sets the handler for new incoming channels on a listener
- * channel.
- *
- * @param chan Listener channel to set handler on
- * @param listener Function pointer to new incoming channel handler
- */
- void
- channel_set_listener(channel_t *chan,
- void (*listener)(channel_t *, channel_t *) )
- {
- tor_assert(chan);
- tor_assert(chan->is_listener);
- tor_assert(chan->state == CHANNEL_STATE_LISTENING);
- log_debug(LD_CHANNEL,
- "Setting listener callback for channel %p to %p",
- chan, listener);
- chan->u.listener.listener = listener;
- if (chan->u.listener.listener) channel_process_incoming(chan);
- }
- /**
- * Return the fixed-length cell handler for a channel
- *
- * This function gets the handler for incoming fixed-length cells installed
- * on a channel.
- *
- * @param chan Channel to get the fixed-length cell handler for
- * @return A function pointer to chan's fixed-length cell handler, if any.
- */
- void
- (* channel_get_cell_handler(channel_t *chan))
- (channel_t *, cell_t *)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- if (chan->state == CHANNEL_STATE_OPENING ||
- chan->state == CHANNEL_STATE_OPEN ||
- chan->state == CHANNEL_STATE_MAINT)
- return chan->u.cell_chan.cell_handler;
- return NULL;
- }
- /**
- * Return the variable-length cell handler for a channel
- *
- * This function gets the handler for incoming variable-length cells
- * installed on a channel.
- *
- * @param chan Channel to get the variable-length cell handler for
- * @return A function pointer to chan's variable-length cell handler, if any.
- */
- void
- (* channel_get_var_cell_handler(channel_t *chan))
- (channel_t *, var_cell_t *)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- if (chan->state == CHANNEL_STATE_OPENING ||
- chan->state == CHANNEL_STATE_OPEN ||
- chan->state == CHANNEL_STATE_MAINT)
- return chan->u.cell_chan.var_cell_handler;
- return NULL;
- }
- /**
- * Set the fixed-length cell handler for a channel
- *
- * This function sets the fixed-length cell handler for a channel and
- * processes any incoming cells that had been blocked in the queue because
- * none was available.
- *
- * @param chan Channel to set the fixed-length cell handler for
- * @param cell_handler Function pointer to new fixed-length cell handler
- */
- void
- channel_set_cell_handler(channel_t *chan,
- void (*cell_handler)(channel_t *, cell_t *))
- {
- int changed = 0;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(chan->state == CHANNEL_STATE_OPENING ||
- chan->state == CHANNEL_STATE_OPEN ||
- chan->state == CHANNEL_STATE_MAINT);
- log_debug(LD_CHANNEL,
- "Setting cell_handler callback for channel %p to %p",
- chan, cell_handler);
- /*
- * Keep track whether we've changed it so we know if there's any point in
- * re-running the queue.
- */
- if (cell_handler != chan->u.cell_chan.cell_handler) changed = 1;
- /* Change it */
- chan->u.cell_chan.cell_handler = cell_handler;
- /* Re-run the queue if we have one and there's any reason to */
- if (chan->u.cell_chan.cell_queue &&
- (smartlist_len(chan->u.cell_chan.cell_queue) > 0) &&
- changed &&
- chan->u.cell_chan.cell_handler) channel_process_cells(chan);
- }
- /**
- * Set the both cell handlers for a channel
- *
- * This function sets both the fixed-length and variable length cell handlers
- * for a channel and processes any incoming cells that had been blocked in the
- * queue because none were available.
- *
- * @param chan Channel to set the fixed-length cell handler for
- * @param cell_handler Function pointer to new fixed-length cell handler
- * @param var_cell_handler Function pointer to new variable-length cell
- handler
- */
- void
- channel_set_cell_handlers(channel_t *chan,
- void (*cell_handler)(channel_t *, cell_t *),
- void (*var_cell_handler)(channel_t *,
- var_cell_t *))
- {
- int try_again = 0;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(chan->state == CHANNEL_STATE_OPENING ||
- chan->state == CHANNEL_STATE_OPEN ||
- chan->state == CHANNEL_STATE_MAINT);
- log_debug(LD_CHANNEL,
- "Setting cell_handler callback for channel %p to %p",
- chan, cell_handler);
- log_debug(LD_CHANNEL,
- "Setting var_cell_handler callback for channel %p to %p",
- chan, var_cell_handler);
- /* Should we try the queue? */
- if (cell_handler &&
- cell_handler != chan->u.cell_chan.cell_handler) try_again = 1;
- if (var_cell_handler &&
- var_cell_handler != chan->u.cell_chan.var_cell_handler) try_again = 1;
- /* Change them */
- chan->u.cell_chan.cell_handler = cell_handler;
- chan->u.cell_chan.var_cell_handler = var_cell_handler;
- /* Re-run the queue if we have one and there's any reason to */
- if (chan->u.cell_chan.cell_queue &&
- (smartlist_len(chan->u.cell_chan.cell_queue) > 0) &&
- try_again &&
- (chan->u.cell_chan.cell_handler ||
- chan->u.cell_chan.var_cell_handler)) channel_process_cells(chan);
- }
- /**
- * Set the variable-length cell handler for a channel
- *
- * This function sets the variable-length cell handler for a channel and
- * processes any incoming cells that had been blocked in the queue because
- * none was available.
- *
- * @param chan Channel to set the variable-length cell handler for
- * @param cell_handler Function pointer to new variable-length cell handler
- */
- void
- channel_set_var_cell_handler(channel_t *chan,
- void (*var_cell_handler)(channel_t *,
- var_cell_t *))
- {
- int changed = 0;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(chan->state == CHANNEL_STATE_OPENING ||
- chan->state == CHANNEL_STATE_OPEN ||
- chan->state == CHANNEL_STATE_MAINT);
- log_debug(LD_CHANNEL,
- "Setting var_cell_handler callback for channel %p to %p",
- chan, var_cell_handler);
- /*
- * Keep track whether we've changed it so we know if there's any point in
- * re-running the queue.
- */
- if (var_cell_handler != chan->u.cell_chan.var_cell_handler) changed = 1;
- /* Change it */
- chan->u.cell_chan.var_cell_handler = var_cell_handler;
- /* Re-run the queue if we have one and there's any reason to */
- if (chan->u.cell_chan.cell_queue &&
- (smartlist_len(chan->u.cell_chan.cell_queue) > 0) &&
- changed && chan->u.cell_chan.var_cell_handler)
- channel_process_cells(chan);
- }
- /**
- * Request a channel be closed
- *
- * This function tries to close a channel_t; it will go into the CLOSING
- * state, and eventually the lower layer should put it into the CLOSED or
- * ERROR state. Then, channel_run_cleanup() will eventually free it.
- *
- * @param chan Channel to close
- */
- void
- channel_request_close(channel_t *chan)
- {
- tor_assert(chan != NULL);
- tor_assert(chan->close != NULL);
- /* If it's already in CLOSING, CLOSED or ERROR, this is a no-op */
- if (chan->state == CHANNEL_STATE_CLOSING ||
- chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR) return;
- log_debug(LD_CHANNEL,
- "Closing channel %p by request",
- chan);
- /* Note closing by request from above */
- chan->reason_for_closing = CHANNEL_CLOSE_REQUESTED;
- /* Change state to CLOSING */
- channel_change_state(chan, CHANNEL_STATE_CLOSING);
- /* Tell the lower layer */
- chan->close(chan);
- /*
- * It's up to the lower layer to change state to CLOSED or ERROR when we're
- * ready; we'll try to free channels that are in the finished list from
- * channel_run_cleanup(). The lower layer should do this by calling
- * channel_closed().
- */
- }
- /**
- * Close a channel from the lower layer
- *
- * Notify the channel code that the channel is being closed due to a non-error
- * condition in the lower layer. This does not call the close() method, since
- * the lower layer already knows.
- *
- * @param chan Channel to notify for close
- */
- void
- channel_close_from_lower_layer(channel_t *chan)
- {
- tor_assert(chan != NULL);
- /* If it's already in CLOSING, CLOSED or ERROR, this is a no-op */
- if (chan->state == CHANNEL_STATE_CLOSING ||
- chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR) return;
- log_debug(LD_CHANNEL,
- "Closing channel %p due to lower-layer event",
- chan);
- /* Note closing by event from below */
- chan->reason_for_closing = CHANNEL_CLOSE_FROM_BELOW;
- /* Change state to CLOSING */
- channel_change_state(chan, CHANNEL_STATE_CLOSING);
- }
- /**
- * Notify that the channel is being closed due to an error condition
- *
- * This function is called by the lower layer implementing the transport
- * when a channel must be closed due to an error condition. This does not
- * call the channel's close method, since the lower layer already knows.
- *
- * @param chan Channel to notify for error
- */
- void
- channel_close_for_error(channel_t *chan)
- {
- tor_assert(chan != NULL);
- /* If it's already in CLOSING, CLOSED or ERROR, this is a no-op */
- if (chan->state == CHANNEL_STATE_CLOSING ||
- chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR) return;
- log_debug(LD_CHANNEL,
- "Closing channel %p due to lower-layer error",
- chan);
- /* Note closing by event from below */
- chan->reason_for_closing = CHANNEL_CLOSE_FOR_ERROR;
- /* Change state to CLOSING */
- channel_change_state(chan, CHANNEL_STATE_CLOSING);
- }
- /**
- * Notify that the lower layer is finished closing the channel
- *
- * This function should be called by the lower layer when a channel
- * is finished closing and it should be regarded as inactive and
- * freed by the channel code.
- *
- * @param chan Channel to notify closure on
- */
- void
- channel_closed(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(chan->state == CHANNEL_STATE_CLOSING ||
- chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR);
- /* No-op if already inactive */
- if (chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR) return;
- if (chan->reason_for_closing == CHANNEL_CLOSE_FOR_ERROR) {
- /* Inform any pending (not attached) circs that they should
- * give up. */
- circuit_n_chan_done(chan, 0);
- }
- /* Now close all the attached circuits on it. */
- circuit_unlink_all_from_channel(chan, END_CIRC_REASON_CHANNEL_CLOSED);
- if (chan->reason_for_closing != CHANNEL_CLOSE_FOR_ERROR) {
- channel_change_state(chan, CHANNEL_STATE_CLOSED);
- } else {
- channel_change_state(chan, CHANNEL_STATE_ERROR);
- }
- }
- /**
- * Clear the identity_digest of a channel
- *
- * This function clears the identity digest of the remote endpoint for a
- * channel; this is intended for use by the lower layer.
- *
- * @param chan Channel to clear
- */
- void
- channel_clear_identity_digest(channel_t *chan)
- {
- int state_not_in_map;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- log_debug(LD_CHANNEL,
- "Clearing remote endpoint digest on channel %p with "
- "global ID %lu",
- chan, chan->global_identifier);
- state_not_in_map =
- (chan->state == CHANNEL_STATE_LISTENING ||
- chan->state == CHANNEL_STATE_CLOSING ||
- chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR);
- if (!state_not_in_map && chan->registered &&
- !tor_digest_is_zero(chan->u.cell_chan.identity_digest))
- /* if it's registered get it out of the digest map */
- channel_remove_from_digest_map(chan);
- memset(chan->u.cell_chan.identity_digest, 0,
- sizeof(chan->u.cell_chan.identity_digest));
- }
- /**
- * Set the identity_digest of a channel
- *
- * This function sets the identity digest of the remote endpoint for a
- * channel; this is intended for use by the lower layer.
- *
- * @param chan Channel to clear
- * @param identity_digest New identity digest for chan
- */
- void
- channel_set_identity_digest(channel_t *chan,
- const char *identity_digest)
- {
- int was_in_digest_map, should_be_in_digest_map, state_not_in_map;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- log_debug(LD_CHANNEL,
- "Setting remote endpoint digest on channel %p with "
- "global ID %lu to digest %s",
- chan, chan->global_identifier,
- identity_digest ?
- hex_str(identity_digest, DIGEST_LEN) : "(null)");
- state_not_in_map =
- (chan->state == CHANNEL_STATE_LISTENING ||
- chan->state == CHANNEL_STATE_CLOSING ||
- chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR);
- was_in_digest_map =
- !state_not_in_map &&
- chan->registered &&
- !tor_digest_is_zero(chan->u.cell_chan.identity_digest);
- should_be_in_digest_map =
- !state_not_in_map &&
- chan->registered &&
- (identity_digest &&
- !tor_digest_is_zero(identity_digest));
- if (was_in_digest_map)
- /* We should always remove it; we'll add it back if we're writing
- * in a new digest.
- */
- channel_remove_from_digest_map(chan);
- if (identity_digest) {
- memcpy(chan->u.cell_chan.identity_digest,
- identity_digest,
- sizeof(chan->u.cell_chan.identity_digest));
- } else {
- memset(chan->u.cell_chan.identity_digest, 0,
- sizeof(chan->u.cell_chan.identity_digest));
- }
- /* Put it in the digest map if we should */
- if (should_be_in_digest_map)
- channel_add_to_digest_map(chan);
- }
- /**
- * Clear the remote end metadata (identity_digest/nickname) of a channel
- *
- * This function clears all the remote end info from a channel; this is
- * intended for use by the lower layer.
- *
- * @param chan Channel to clear
- */
- void
- channel_clear_remote_end(channel_t *chan)
- {
- int state_not_in_map;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- log_debug(LD_CHANNEL,
- "Clearing remote endpoint identity on channel %p with "
- "global ID %lu",
- chan, chan->global_identifier);
- state_not_in_map =
- (chan->state == CHANNEL_STATE_LISTENING ||
- chan->state == CHANNEL_STATE_CLOSING ||
- chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR);
- if (!state_not_in_map && chan->registered &&
- !tor_digest_is_zero(chan->u.cell_chan.identity_digest))
- /* if it's registered get it out of the digest map */
- channel_remove_from_digest_map(chan);
- memset(chan->u.cell_chan.identity_digest, 0,
- sizeof(chan->u.cell_chan.identity_digest));
- tor_free(chan->u.cell_chan.nickname);
- }
- /**
- * Set the remote end metadata (identity_digest/nickname) of a channel
- *
- * This function sets new remote end info on a channel; this is intended
- * for use by the lower layer.
- *
- * @chan Channel to set data on
- * @chan identity_digest New identity digest for chan
- * @chan nickname New remote nickname for chan
- */
- void
- channel_set_remote_end(channel_t *chan,
- const char *identity_digest,
- const char *nickname)
- {
- int was_in_digest_map, should_be_in_digest_map, state_not_in_map;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- log_debug(LD_CHANNEL,
- "Setting remote endpoint identity on channel %p with "
- "global ID %lu to nickname %s, digest %s",
- chan, chan->global_identifier,
- nickname ? nickname : "(null)",
- identity_digest ?
- hex_str(identity_digest, DIGEST_LEN) : "(null)");
- state_not_in_map =
- (chan->state == CHANNEL_STATE_LISTENING ||
- chan->state == CHANNEL_STATE_CLOSING ||
- chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR);
- was_in_digest_map =
- !state_not_in_map &&
- chan->registered &&
- !tor_digest_is_zero(chan->u.cell_chan.identity_digest);
- should_be_in_digest_map =
- !state_not_in_map &&
- chan->registered &&
- (identity_digest &&
- !tor_digest_is_zero(identity_digest));
- if (was_in_digest_map)
- /* We should always remove it; we'll add it back if we're writing
- * in a new digest.
- */
- channel_remove_from_digest_map(chan);
- if (identity_digest) {
- memcpy(chan->u.cell_chan.identity_digest,
- identity_digest,
- sizeof(chan->u.cell_chan.identity_digest));
- } else {
- memset(chan->u.cell_chan.identity_digest, 0,
- sizeof(chan->u.cell_chan.identity_digest));
- }
- tor_free(chan->u.cell_chan.nickname);
- if (nickname)
- chan->u.cell_chan.nickname = tor_strdup(nickname);
- /* Put it in the digest map if we should */
- if (should_be_in_digest_map)
- channel_add_to_digest_map(chan);
- }
- /**
- * Write a cell to a channel
- *
- * Write a fixed-length cell to a channel using the write_cell() method.
- * This is equivalent to the pre-channels connection_or_write_cell_to_buf().
- *
- * @param chan Channel to write a cell to
- * @param cell Cell to write to chan
- */
- void
- channel_write_cell(channel_t *chan, cell_t *cell)
- {
- cell_queue_entry_t *q;
- int sent = 0;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(cell);
- tor_assert(chan->u.cell_chan.write_cell);
- /* Assert that the state makes sense for a cell write */
- tor_assert(chan->state == CHANNEL_STATE_OPENING ||
- chan->state == CHANNEL_STATE_OPEN ||
- chan->state == CHANNEL_STATE_MAINT);
- log_debug(LD_CHANNEL,
- "Writing cell_t %p to channel %p with global ID %lu",
- cell, chan, chan->global_identifier);
- /* Increment the timestamp unless it's padding */
- if (!(cell->command == CELL_PADDING ||
- cell->command == CELL_VPADDING)) {
- chan->u.cell_chan.timestamp_last_added_nonpadding = approx_time();
- }
- /* Can we send it right out? If so, try */
- if (!(chan->u.cell_chan.outgoing_queue &&
- (smartlist_len(chan->u.cell_chan.outgoing_queue) > 0)) &&
- chan->state == CHANNEL_STATE_OPEN) {
- if (chan->u.cell_chan.write_cell(chan, cell)) {
- sent = 1;
- /* Timestamp for transmission */
- channel_timestamp_xmit(chan);
- /* If we're here the queue is empty, so it's drained too */
- channel_timestamp_drained(chan);
- }
- }
- if (!sent) {
- /* Not sent, queue it */
- if (!(chan->u.cell_chan.outgoing_queue))
- chan->u.cell_chan.outgoing_queue = smartlist_new();
- q = tor_malloc(sizeof(*q));
- q->type = CELL_QUEUE_FIXED;
- q->u.fixed.cell = cell;
- smartlist_add(chan->u.cell_chan.outgoing_queue, q);
- /* Try to process the queue? */
- if (chan->state == CHANNEL_STATE_OPEN) channel_flush_cells(chan);
- }
- }
- /**
- * Write a packed cell to a channel
- *
- * Write a packed cell to a channel using the write_cell() method.
- *
- * @param chan Channel to write a cell to
- * @param packed_cell Cell to write to chan
- */
- void
- channel_write_packed_cell(channel_t *chan, packed_cell_t *packed_cell)
- {
- cell_queue_entry_t *q;
- int sent = 0;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(packed_cell);
- tor_assert(chan->u.cell_chan.write_packed_cell);
- /* Assert that the state makes sense for a cell write */
- tor_assert(chan->state == CHANNEL_STATE_OPENING ||
- chan->state == CHANNEL_STATE_OPEN ||
- chan->state == CHANNEL_STATE_MAINT);
- log_debug(LD_CHANNEL,
- "Writing packed_cell_t %p to channel %p with global ID %lu",
- packed_cell, chan, chan->global_identifier);
- /* Increment the timestamp */
- chan->u.cell_chan.timestamp_last_added_nonpadding = approx_time();
- /* Can we send it right out? If so, try */
- if (!(chan->u.cell_chan.outgoing_queue &&
- (smartlist_len(chan->u.cell_chan.outgoing_queue) > 0)) &&
- chan->state == CHANNEL_STATE_OPEN) {
- if (chan->u.cell_chan.write_packed_cell(chan, packed_cell)) {
- sent = 1;
- /* Timestamp for transmission */
- channel_timestamp_xmit(chan);
- /* If we're here the queue is empty, so it's drained too */
- channel_timestamp_drained(chan);
- }
- }
- if (!sent) {
- /* Not sent, queue it */
- if (!(chan->u.cell_chan.outgoing_queue))
- chan->u.cell_chan.outgoing_queue = smartlist_new();
- q = tor_malloc(sizeof(*q));
- q->type = CELL_QUEUE_PACKED;
- q->u.packed.packed_cell = packed_cell;
- smartlist_add(chan->u.cell_chan.outgoing_queue, q);
- /* Try to process the queue? */
- if (chan->state == CHANNEL_STATE_OPEN) channel_flush_cells(chan);
- }
- }
- /**
- * Write a variable-length cell to a channel
- *
- * Write a variable-length cell to a channel using the write_cell() method.
- * This is equivalent to the pre-channels
- * connection_or_write_var_cell_to_buf().
- *
- * @param chan Channel to write a cell to
- * @param var_cell Cell to write to chan
- */
- void
- channel_write_var_cell(channel_t *chan, var_cell_t *var_cell)
- {
- cell_queue_entry_t *q;
- int sent = 0;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(var_cell);
- tor_assert(chan->u.cell_chan.write_var_cell);
- /* Assert that the state makes sense for a cell write */
- tor_assert(chan->state == CHANNEL_STATE_OPENING ||
- chan->state == CHANNEL_STATE_OPEN ||
- chan->state == CHANNEL_STATE_MAINT);
- log_debug(LD_CHANNEL,
- "Writing var_cell_t %p to channel %p with global ID %lu",
- var_cell, chan, chan->global_identifier);
- /* Increment the timestamp unless it's padding */
- if (!(var_cell->command == CELL_PADDING ||
- var_cell->command == CELL_VPADDING)) {
- chan->u.cell_chan.timestamp_last_added_nonpadding = approx_time();
- }
- /* Can we send it right out? If so, then try */
- if (!(chan->u.cell_chan.outgoing_queue &&
- (smartlist_len(chan->u.cell_chan.outgoing_queue) > 0)) &&
- chan->state == CHANNEL_STATE_OPEN) {
- if (chan->u.cell_chan.write_var_cell(chan, var_cell)) {
- sent = 1;
- /* Timestamp for transmission */
- channel_timestamp_xmit(chan);
- /* If we're here the queue is empty, so it's drained too */
- channel_timestamp_drained(chan);
- }
- }
- if (!sent) {
- /* Not sent, queue it */
- if (!(chan->u.cell_chan.outgoing_queue))
- chan->u.cell_chan.outgoing_queue = smartlist_new();
- q = tor_malloc(sizeof(*q));
- q->type = CELL_QUEUE_VAR;
- q->u.var.var_cell = var_cell;
- smartlist_add(chan->u.cell_chan.outgoing_queue, q);
- /* Try to process the queue? */
- if (chan->state == CHANNEL_STATE_OPEN) channel_flush_cells(chan);
- }
- }
- /**
- * Change channel state
- *
- * This internal and subclass use only function is used to change channel
- * state, performing all transition validity checks and whatever actions
- * are appropriate to the state transition in question.
- *
- * @param chan Channel to change state on
- * @param to_state State to change chan to
- */
- void
- channel_change_state(channel_t *chan, channel_state_t to_state)
- {
- channel_state_t from_state;
- unsigned char was_active, is_active, was_listening, is_listening;
- unsigned char was_in_id_map, is_in_id_map;
- tor_assert(chan);
- from_state = chan->state;
- tor_assert(channel_state_is_valid(from_state));
- tor_assert(channel_state_is_valid(to_state));
- tor_assert(channel_state_can_transition(chan->state, to_state));
- if (chan->is_listener) {
- tor_assert(from_state == CHANNEL_STATE_LISTENING ||
- from_state == CHANNEL_STATE_CLOSING ||
- from_state == CHANNEL_STATE_CLOSED ||
- from_state == CHANNEL_STATE_ERROR);
- tor_assert(to_state == CHANNEL_STATE_LISTENING ||
- to_state == CHANNEL_STATE_CLOSING ||
- to_state == CHANNEL_STATE_CLOSED ||
- to_state == CHANNEL_STATE_ERROR);
- } else {
- tor_assert(from_state != CHANNEL_STATE_LISTENING);
- tor_assert(to_state != CHANNEL_STATE_LISTENING);
- }
- /* Check for no-op transitions */
- if (from_state == to_state) {
- log_debug(LD_CHANNEL,
- "Got no-op transition from \"%s\" to itself on channel %p",
- channel_state_to_string(to_state),
- chan);
- return;
- }
- /* If we're going to a closing or closed state, we must have a reason set */
- if (to_state == CHANNEL_STATE_CLOSING ||
- to_state == CHANNEL_STATE_CLOSED ||
- to_state == CHANNEL_STATE_ERROR) {
- tor_assert(chan->reason_for_closing != CHANNEL_NOT_CLOSING);
- }
- /*
- * We need to maintain the queues here for some transitions:
- * when we enter CHANNEL_STATE_OPEN (especially from CHANNEL_STATE_MAINT)
- * we may have a backlog of cells to transmit, so drain the queues in
- * that case, and when going to CHANNEL_STATE_CLOSED the subclass
- * should have made sure to finish sending things (or gone to
- * CHANNEL_STATE_ERROR if not possible), so we assert for that here.
- */
- log_debug(LD_CHANNEL,
- "Changing state of channel %p from \"%s\" to \"%s\"",
- chan,
- channel_state_to_string(chan->state),
- channel_state_to_string(to_state));
- chan->state = to_state;
- /* Need to add to the right lists if the channel is registered */
- if (chan->registered) {
- was_active = !(from_state == CHANNEL_STATE_CLOSED ||
- from_state == CHANNEL_STATE_ERROR);
- is_active = !(to_state == CHANNEL_STATE_CLOSED ||
- to_state == CHANNEL_STATE_ERROR);
- /* Need to take off active list and put on finished list? */
- if (was_active && !is_active) {
- if (active_channels) smartlist_remove(active_channels, chan);
- if (!finished_channels) finished_channels = smartlist_new();
- smartlist_add(finished_channels, chan);
- }
- /* Need to put on active list? */
- else if (!was_active && is_active) {
- if (finished_channels) smartlist_remove(finished_channels, chan);
- if (!active_channels) active_channels = smartlist_new();
- smartlist_add(active_channels, chan);
- }
- was_listening = (from_state == CHANNEL_STATE_LISTENING);
- is_listening = (to_state == CHANNEL_STATE_LISTENING);
- /* Need to put on listening list? */
- if (!was_listening && is_listening) {
- if (!listening_channels) listening_channels = smartlist_new();
- smartlist_add(listening_channels, chan);
- }
- /* Need to remove from listening list? */
- else if (was_listening && !is_listening) {
- if (listening_channels) smartlist_remove(listening_channels, chan);
- }
- if (!(chan->is_listener) &&
- !tor_digest_is_zero(chan->u.cell_chan.identity_digest)) {
- /* Now we need to handle the identity map */
- was_in_id_map = !(from_state == CHANNEL_STATE_LISTENING ||
- from_state == CHANNEL_STATE_CLOSING ||
- from_state == CHANNEL_STATE_CLOSED ||
- from_state == CHANNEL_STATE_ERROR);
- is_in_id_map = !(to_state == CHANNEL_STATE_LISTENING ||
- to_state == CHANNEL_STATE_CLOSING ||
- to_state == CHANNEL_STATE_CLOSED ||
- to_state == CHANNEL_STATE_ERROR);
- if (!was_in_id_map && is_in_id_map) channel_add_to_digest_map(chan);
- else if (was_in_id_map && !is_in_id_map)
- channel_remove_from_digest_map(chan);
- }
- }
- /* Tell circuits if we opened and stuff */
- if (to_state == CHANNEL_STATE_OPEN) channel_do_open_actions(chan);
- if (!(chan->is_listener) &&
- to_state == CHANNEL_STATE_OPEN) {
- /* Check for queued cells to process */
- if (chan->u.cell_chan.cell_queue &&
- smartlist_len(chan->u.cell_chan.cell_queue) > 0)
- channel_process_cells(chan);
- if (chan->u.cell_chan.outgoing_queue &&
- smartlist_len(chan->u.cell_chan.outgoing_queue) > 0)
- channel_flush_cells(chan);
- } else if (to_state == CHANNEL_STATE_CLOSED ||
- to_state == CHANNEL_STATE_ERROR) {
- /* Assert that all queues are empty */
- if (chan->is_listener) {
- tor_assert(!(chan->u.listener.incoming_list) ||
- smartlist_len(chan->u.listener.incoming_list) == 0);
- } else {
- tor_assert(!(chan->u.cell_chan.cell_queue) ||
- smartlist_len(chan->u.cell_chan.cell_queue) == 0);
- tor_assert(!(chan->u.cell_chan.outgoing_queue) ||
- smartlist_len(chan->u.cell_chan.outgoing_queue) == 0);
- }
- }
- }
- /**
- * Try to flush cells to the lower layer
- *
- * this is called by the lower layer to indicate that it wants more cells;
- * it will try to write up to num_cells cells from the channel's cell queue or
- * from circuits active on that channel, or as many as it has available if
- * num_cells == -1.
- *
- * @param chan Channel to flush from
- * @param num_cells Maximum number of cells to flush, or -1 for unlimited
- * @return Number of cells flushed
- */
- #define MAX_CELLS_TO_GET_FROM_CIRCUITS_FOR_UNLIMITED 256
- ssize_t
- channel_flush_some_cells(channel_t *chan, ssize_t num_cells)
- {
- unsigned int unlimited = 0;
- ssize_t flushed = 0;
- int num_cells_from_circs;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- if (num_cells < 0) unlimited = 1;
- if (!unlimited && num_cells <= flushed) goto done;
- /* If we aren't in CHANNEL_STATE_OPEN, nothing goes through */
- if (chan->state == CHANNEL_STATE_OPEN) {
- /* Try to flush as much as we can that's already queued */
- flushed += channel_flush_some_cells_from_outgoing_queue(chan,
- (unlimited ? -1 : num_cells - flushed));
- if (!unlimited && num_cells <= flushed) goto done;
- if (chan->u.cell_chan.active_circuits) {
- /* Try to get more cells from any active circuits */
- num_cells_from_circs =
- channel_flush_from_first_active_circuit(chan,
- (unlimited ? MAX_CELLS_TO_GET_FROM_CIRCUITS_FOR_UNLIMITED :
- (num_cells - flushed)));
- /* If it claims we got some, process the queue again */
- if (num_cells_from_circs > 0) {
- flushed += channel_flush_some_cells_from_outgoing_queue(chan,
- (unlimited ? -1 : num_cells - flushed));
- }
- }
- }
- done:
- return flushed;
- }
- /**
- * Flush cells from just the channel's out going cell queue
- *
- * This gets called from channel_flush_some_cells() above to flush cells
- * just from the queue without trying for active_circuits.
- *
- * @param chan Channel to flush from
- * @param num_cells Maximum number of cells to flush, or -1 for unlimited
- * @return Number of cells flushed
- */
- static ssize_t
- channel_flush_some_cells_from_outgoing_queue(channel_t *chan,
- ssize_t num_cells)
- {
- unsigned int unlimited = 0;
- ssize_t flushed = 0;
- cell_queue_entry_t *q = NULL;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(chan->u.cell_chan.write_cell);
- tor_assert(chan->u.cell_chan.write_packed_cell);
- tor_assert(chan->u.cell_chan.write_var_cell);
- if (num_cells < 0) unlimited = 1;
- if (!unlimited && num_cells <= flushed) return 0;
- /* If we aren't in CHANNEL_STATE_OPEN, nothing goes through */
- if (chan->state == CHANNEL_STATE_OPEN) {
- while ((unlimited || num_cells > flushed) &&
- (chan->u.cell_chan.outgoing_queue &&
- (smartlist_len(chan->u.cell_chan.outgoing_queue) > 0))) {
- /*
- * Ewww, smartlist_del_keeporder() is O(n) in list length; maybe a
- * a linked list would make more sense for the queue.
- */
- /* Get the head of the queue */
- q = smartlist_get(chan->u.cell_chan.outgoing_queue, 0);
- /* That shouldn't happen; bail out */
- if (q) {
- /*
- * Okay, we have a good queue entry, try to give it to the lower
- * layer.
- */
- switch (q->type) {
- case CELL_QUEUE_FIXED:
- if (q->u.fixed.cell) {
- if (chan->u.cell_chan.write_cell(chan,
- q->u.fixed.cell)) {
- tor_free(q);
- ++flushed;
- channel_timestamp_xmit(chan);
- }
- /* Else couldn't write it; leave it on the queue */
- } else {
- /* This shouldn't happen */
- log_info(LD_CHANNEL,
- "Saw broken cell queue entry of type CELL_QUEUE_FIXED "
- "with no cell on channel %p.",
- chan);
- /* Throw it away */
- tor_free(q);
- }
- break;
- case CELL_QUEUE_PACKED:
- if (q->u.packed.packed_cell) {
- if (chan->u.cell_chan.write_packed_cell(chan,
- q->u.packed.packed_cell)) {
- tor_free(q);
- ++flushed;
- channel_timestamp_xmit(chan);
- }
- /* Else couldn't write it; leave it on the queue */
- } else {
- /* This shouldn't happen */
- log_info(LD_CHANNEL,
- "Saw broken cell queue entry of type CELL_QUEUE_PACKED "
- "with no cell on channel %p.",
- chan);
- /* Throw it away */
- tor_free(q);
- }
- break;
- case CELL_QUEUE_VAR:
- if (q->u.var.var_cell) {
- if (chan->u.cell_chan.write_var_cell(chan,
- q->u.var.var_cell)) {
- tor_free(q);
- ++flushed;
- channel_timestamp_xmit(chan);
- }
- /* Else couldn't write it; leave it on the queue */
- } else {
- /* This shouldn't happen */
- log_info(LD_CHANNEL,
- "Saw broken cell queue entry of type CELL_QUEUE_VAR "
- "with no cell on channel %p.",
- chan);
- /* Throw it away */
- tor_free(q);
- }
- break;
- default:
- /* Unknown type, log and free it */
- log_info(LD_CHANNEL,
- "Saw an unknown cell queue entry type %d on channel %p; "
- "ignoring it. Someone should fix this.",
- q->type, chan);
- tor_free(q); /* tor_free() NULLs it out */
- }
- } else {
- /* This shouldn't happen; log and throw it away */
- log_info(LD_CHANNEL,
- "Saw a NULL entry in the outgoing cell queue on channel %p; "
- "this is definitely a bug.",
- chan);
- /* q is already NULL, so we know to delete that queue entry */
- }
- /* if q got NULLed out, we used it and should remove the queue entry */
- if (!q) smartlist_del_keeporder(chan->u.cell_chan.outgoing_queue, 0);
- /* No cell removed from list, so we can't go on any further */
- else break;
- }
- }
- /* Did we drain the queue? */
- if (!(chan->u.cell_chan.outgoing_queue) ||
- smartlist_len(chan->u.cell_chan.outgoing_queue) == 0) {
- /* Timestamp it */
- channel_timestamp_drained(chan);
- }
- return flushed;
- }
- /**
- * Try to flush as many cells as we possibly can from the queue
- *
- * This tries to flush as many cells from the queue as the lower layer
- * will take. It just calls channel_flush_some_cells_from_outgoing_queue()
- * in unlimited mode.
- *
- * @param chan Channel to flush
- */
- void
- channel_flush_cells(channel_t *chan)
- {
- channel_flush_some_cells_from_outgoing_queue(chan, -1);
- }
- /**
- * Check if any cells are available
- *
- * This gets used from the lower layer to check if any more cells are
- * available.
- *
- * @param chan Channel to check on
- * @return 1 if cells are available, 0 otherwise
- */
- int
- channel_more_to_flush(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- /* Check if we have any queued */
- if (chan->u.cell_chan.cell_queue &&
- smartlist_len(chan->u.cell_chan.cell_queue) > 0) return 1;
- /* Check if any circuits would like to queue some */
- if (chan->u.cell_chan.active_circuits) return 1;
- /* Else no */
- return 0;
- }
- /**
- * Notify the channel we're done flushing the output in the lower layer
- *
- * Connection.c will call this when we've flushed the output; there's some
- * dirreq-related maintenance to do.
- *
- * @param chan Channel to notify
- */
- void
- channel_notify_flushed(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- if (chan->u.cell_chan.dirreq_id != 0)
- geoip_change_dirreq_state(chan->u.cell_chan.dirreq_id,
- DIRREQ_TUNNELED,
- DIRREQ_CHANNEL_BUFFER_FLUSHED);
- }
- /**
- * Process the queue of incoming channels on a listener
- *
- * Use a listener's registered callback to process as many entries in the
- * queue of incoming channels as possible.
- *
- * @param listener Pointer to a listening channel.
- */
- void
- channel_process_incoming(channel_t *listener)
- {
- tor_assert(listener);
- tor_assert(listener->is_listener);
- /*
- * CHANNEL_STATE_CLOSING permitted because we drain the queue while
- * closing a listener.
- */
- tor_assert(listener->state == CHANNEL_STATE_LISTENING ||
- listener->state == CHANNEL_STATE_CLOSING);
- tor_assert(listener->u.listener.listener);
- log_debug(LD_CHANNEL,
- "Processing queue of incoming connections for listening "
- "channel %p (global ID %lu)",
- listener, listener->global_identifier);
- if (!(listener->u.listener.incoming_list)) return;
- SMARTLIST_FOREACH_BEGIN(listener->u.listener.incoming_list,
- channel_t *, chan) {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- log_debug(LD_CHANNEL,
- "Handling incoming connection %p (%lu) for listener %p (%lu)",
- chan, chan->global_identifier,
- listener, listener->global_identifier);
- /* Make sure this is set correctly */
- channel_mark_incoming(chan);
- listener->u.listener.listener(listener, chan);
- SMARTLIST_DEL_CURRENT(listener->u.listener.incoming_list, chan);
- } SMARTLIST_FOREACH_END(chan);
- tor_assert(smartlist_len(listener->u.listener.incoming_list) == 0);
- smartlist_free(listener->u.listener.incoming_list);
- listener->u.listener.incoming_list = NULL;
- }
- /**
- * Take actions required when a channel becomes open
- *
- * Handle actions we should do when we know a channel is open; a lot of
- * this comes from the old connection_or_set_state_open() of connection_or.c.
- *
- * Because of this mechanism, future channel_t subclasses should take care
- * not to change a channel to from CHANNEL_STATE_OPENING to CHANNEL_STATE_OPEN
- * until there is positive confirmation that the network is operational.
- * In particular, anything UDP-based should not make this transition until a
- * packet is received from the other side.
- *
- * @param chan Channel that has become open
- */
- void
- channel_do_open_actions(channel_t *chan)
- {
- tor_addr_t remote_addr;
- int started_here, not_using = 0;
- time_t now = time(NULL);
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- started_here = channel_is_outgoing(chan);
- if (started_here) {
- circuit_build_times_network_is_live(&circ_times);
- rep_hist_note_connect_succeeded(chan->u.cell_chan.identity_digest, now);
- if (entry_guard_register_connect_status(
- chan->u.cell_chan.identity_digest, 1, 0, now) < 0) {
- /* Close any circuits pending on this channel. We leave it in state
- * 'open' though, because it didn't actually *fail* -- we just
- * chose not to use it. */
- log_debug(LD_OR,
- "New entry guard was reachable, but closing this "
- "connection so we can retry the earlier entry guards.");
- circuit_n_chan_done(chan, 0);
- not_using = 1;
- }
- router_set_status(chan->u.cell_chan.identity_digest, 1);
- } else {
- /* only report it to the geoip module if it's not a known router */
- if (!router_get_by_id_digest(chan->u.cell_chan.identity_digest)) {
- if (channel_get_addr_if_possible(chan, &remote_addr)) {
- geoip_note_client_seen(GEOIP_CLIENT_CONNECT, &remote_addr,
- now);
- }
- /* Otherwise the underlying transport can't tell us this, so skip it */
- }
- }
- if (!not_using) circuit_n_chan_done(chan, 1);
- }
- /**
- * Queue an incoming channel on a listener
- *
- * Internal and subclass use only function to queue an incoming channel from
- * a listening one. A subclass of channel_t should call this when a new
- * incoming channel is created.
- *
- * @param listener Listening channel to queue on
- * @param incoming New incoming channel
- */
- void
- channel_queue_incoming(channel_t *listener, channel_t *incoming)
- {
- int need_to_queue = 0;
- tor_assert(listener);
- tor_assert(listener->is_listener);
- tor_assert(listener->state == CHANNEL_STATE_LISTENING);
- tor_assert(incoming);
- tor_assert(!(incoming->is_listener));
- /*
- * Other states are permitted because subclass might process activity
- * on a channel at any time while it's queued, but a listener returning
- * another listener makes no sense.
- */
- tor_assert(incoming->state != CHANNEL_STATE_LISTENING);
- log_debug(LD_CHANNEL,
- "Queueing incoming channel %p on listening channel %p",
- incoming, listener);
- /* Do we need to queue it, or can we just call the listener right away? */
- if (!(listener->u.listener.listener)) need_to_queue = 1;
- if (listener->u.listener.incoming_list &&
- (smartlist_len(listener->u.listener.incoming_list) > 0))
- need_to_queue = 1;
- /* If we need to queue and have no queue, create one */
- if (need_to_queue && !(listener->u.listener.incoming_list)) {
- listener->u.listener.incoming_list = smartlist_new();
- }
- /* If we don't need to queue, process it right away */
- if (!need_to_queue) {
- tor_assert(listener->u.listener.listener);
- listener->u.listener.listener(listener, incoming);
- }
- /*
- * Otherwise, we need to queue; queue and then process the queue if
- * we can.
- */
- else {
- tor_assert(listener->u.listener.incoming_list);
- smartlist_add(listener->u.listener.incoming_list, incoming);
- if (listener->u.listener.listener) channel_process_incoming(listener);
- }
- }
- /**
- * Process queued incoming cells
- *
- * Process as many queued cells as we can from the incoming
- * cell queue.
- *
- * @param chan Channel to process incoming cell queue on
- */
- void
- channel_process_cells(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(chan->state == CHANNEL_STATE_CLOSING ||
- chan->state == CHANNEL_STATE_MAINT ||
- chan->state == CHANNEL_STATE_OPEN);
- log_debug(LD_CHANNEL,
- "Processing as many incoming cells as we can for channel %p",
- chan);
- /* Nothing we can do if we have no registered cell handlers */
- if (!(chan->u.cell_chan.cell_handler ||
- chan->u.cell_chan.var_cell_handler)) return;
- /* Nothing we can do if we have no cells */
- if (!(chan->u.cell_chan.cell_queue)) return;
- /*
- * Process cells until we're done or find one we have no current handler
- * for.
- */
- SMARTLIST_FOREACH_BEGIN(chan->u.cell_chan.cell_queue,
- cell_queue_entry_t *, q) {
- tor_assert(q);
- tor_assert(q->type == CELL_QUEUE_FIXED ||
- q->type == CELL_QUEUE_VAR);
- if (q->type == CELL_QUEUE_FIXED &&
- chan->u.cell_chan.cell_handler) {
- /* Handle a fixed-length cell */
- tor_assert(q->u.fixed.cell);
- log_debug(LD_CHANNEL,
- "Processing incoming cell_t %p for channel %p",
- q->u.fixed.cell, chan);
- chan->u.cell_chan.cell_handler(chan, q->u.fixed.cell);
- SMARTLIST_DEL_CURRENT(chan->u.cell_chan.cell_queue, q);
- tor_free(q);
- } else if (q->type == CELL_QUEUE_VAR &&
- chan->u.cell_chan.var_cell_handler) {
- /* Handle a variable-length cell */
- tor_assert(q->u.var.var_cell);
- log_debug(LD_CHANNEL,
- "Processing incoming var_cell_t %p for channel %p",
- q->u.var.var_cell, chan);
- chan->u.cell_chan.var_cell_handler(chan, q->u.var.var_cell);
- SMARTLIST_DEL_CURRENT(chan->u.cell_chan.cell_queue, q);
- tor_free(q);
- } else {
- /* Can't handle this one */
- break;
- }
- } SMARTLIST_FOREACH_END(q);
- /* If the list is empty, free it */
- if (smartlist_len(chan->u.cell_chan.cell_queue) == 0 ) {
- smartlist_free(chan->u.cell_chan.cell_queue);
- chan->u.cell_chan.cell_queue = NULL;
- }
- }
- /**
- * Queue incoming cell
- *
- * This should be called by a channel_t subclass to queue an incoming fixed-
- * length cell for processing, and process it if possible.
- *
- * @param chan Channel the cell is arriving on
- * @param cell Incoming cell to queue and process
- */
- void
- channel_queue_cell(channel_t *chan, cell_t *cell)
- {
- int need_to_queue = 0;
- cell_queue_entry_t *q;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(cell);
- tor_assert(chan->state == CHANNEL_STATE_OPEN);
- /* Do we need to queue it, or can we just call the handler right away? */
- if (!(chan->u.cell_chan.cell_handler)) need_to_queue = 1;
- if (chan->u.cell_chan.cell_queue &&
- (smartlist_len(chan->u.cell_chan.cell_queue) > 0))
- need_to_queue = 1;
- /* If we need to queue and have no queue, create one */
- if (need_to_queue && !(chan->u.cell_chan.cell_queue)) {
- chan->u.cell_chan.cell_queue = smartlist_new();
- }
- /* Timestamp for receiving */
- channel_timestamp_recv(chan);
- /* If we don't need to queue we can just call cell_handler */
- if (!need_to_queue) {
- tor_assert(chan->u.cell_chan.cell_handler);
- log_debug(LD_CHANNEL,
- "Directly handling incoming cell_t %p for channel %p",
- cell, chan);
- chan->u.cell_chan.cell_handler(chan, cell);
- } else {
- /* Otherwise queue it and then process the queue if possible. */
- tor_assert(chan->u.cell_chan.cell_queue);
- q = tor_malloc(sizeof(*q));
- q->type = CELL_QUEUE_FIXED;
- q->u.fixed.cell = cell;
- log_debug(LD_CHANNEL,
- "Queueing incoming cell_t %p for channel %p",
- cell, chan);
- smartlist_add(chan->u.cell_chan.cell_queue, q);
- if (chan->u.cell_chan.cell_handler ||
- chan->u.cell_chan.var_cell_handler) {
- channel_process_cells(chan);
- }
- }
- }
- /**
- * Queue incoming variable-length cell
- *
- * This should be called by a channel_t subclass to queue an incoming
- * variable-length cell for processing, and process it if possible.
- *
- * @param chan Channel the cell is arriving on
- * @param var_cell Incoming cell to queue and process
- */
- void
- channel_queue_var_cell(channel_t *chan, var_cell_t *var_cell)
- {
- int need_to_queue = 0;
- cell_queue_entry_t *q;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(var_cell);
- tor_assert(chan->state == CHANNEL_STATE_OPEN);
- /* Do we need to queue it, or can we just call the handler right away? */
- if (!(chan->u.cell_chan.var_cell_handler)) need_to_queue = 1;
- if (chan->u.cell_chan.cell_queue &&
- (smartlist_len(chan->u.cell_chan.cell_queue) > 0))
- need_to_queue = 1;
- /* If we need to queue and have no queue, create one */
- if (need_to_queue && !(chan->u.cell_chan.cell_queue)) {
- chan->u.cell_chan.cell_queue = smartlist_new();
- }
- /* Timestamp for receiving */
- channel_timestamp_recv(chan);
- /* If we don't need to queue we can just call cell_handler */
- if (!need_to_queue) {
- tor_assert(chan->u.cell_chan.var_cell_handler);
- log_debug(LD_CHANNEL,
- "Directly handling incoming var_cell_t %p for channel %p",
- var_cell, chan);
- chan->u.cell_chan.var_cell_handler(chan, var_cell);
- } else {
- /* Otherwise queue it and then process the queue if possible. */
- tor_assert(chan->u.cell_chan.cell_queue);
- q = tor_malloc(sizeof(*q));
- q->type = CELL_QUEUE_VAR;
- q->u.var.var_cell = var_cell;
- log_debug(LD_CHANNEL,
- "Queueing incoming var_cell_t %p for channel %p",
- var_cell, chan);
- smartlist_add(chan->u.cell_chan.cell_queue, q);
- if (chan->u.cell_chan.cell_handler ||
- chan->u.cell_chan.var_cell_handler) {
- channel_process_cells(chan);
- }
- }
- }
- /**
- * Send destroy cell on a channel
- *
- * Write a destroy cell with circ ID <b>circ_id</b> and reason <b>reason</b>
- * onto channel <b>chan</b>. Don't perform range-checking on reason:
- * we may want to propagate reasons from other cells.
- *
- * @param circ_id Circuit ID to destroy
- * @param chan Channel to send on
- * @param reason Reason code
- * @return Always 0
- */
- int
- channel_send_destroy(circid_t circ_id, channel_t *chan, int reason)
- {
- cell_t cell;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- memset(&cell, 0, sizeof(cell_t));
- cell.circ_id = circ_id;
- cell.command = CELL_DESTROY;
- cell.payload[0] = (uint8_t) reason;
- log_debug(LD_OR,"Sending destroy (circID %d).", circ_id);
- channel_write_cell(chan, &cell);
- return 0;
- }
- /**
- * Channel cleanup
- *
- * This gets called periodically from run_scheduled_events() in main.c;
- * it cleans up after closed channels.
- */
- void
- channel_run_cleanup(void)
- {
- channel_t *tmp = NULL;
- /* Check if we need to do anything */
- if (!finished_channels || smartlist_len(finished_channels) == 0) return;
- /* Iterate through finished_channels and get rid of them */
- SMARTLIST_FOREACH_BEGIN(finished_channels, channel_t *, curr) {
- tmp = curr;
- /* Remove it from the list */
- SMARTLIST_DEL_CURRENT(finished_channels, curr);
- /* Also unregister it */
- channel_unregister(tmp);
- /* ... and free it */
- channel_free(tmp);
- } SMARTLIST_FOREACH_END(curr);
- }
- /**
- * Close all channels and free everything
- *
- * This gets called from tor_free_all() in main.c to clean up on exit.
- * It will close all registered channels and free associated storage,
- * then free the all_channels, active_channels, listening_channels and
- * finished_channels lists and also channel_identity_map.
- */
- void
- channel_free_all(void)
- {
- channel_t *tmp = NULL;
- log_debug(LD_CHANNEL,
- "Shutting down channels...");
- /* First, let's go for finished channels */
- if (finished_channels) {
- SMARTLIST_FOREACH_BEGIN(finished_channels, channel_t *, curr) {
- tmp = curr;
- /* Remove it from the list */
- SMARTLIST_DEL_CURRENT(finished_channels, curr);
- /* Deregister and free it */
- tor_assert(tmp);
- log_debug(LD_CHANNEL,
- "Cleaning up finished channel %p (ID %lu) in state %s (%d)",
- tmp, tmp->global_identifier,
- channel_state_to_string(tmp->state), tmp->state);
- channel_unregister(tmp);
- channel_free(tmp);
- } SMARTLIST_FOREACH_END(curr);
- smartlist_free(finished_channels);
- finished_channels = NULL;
- tmp = NULL;
- }
- /* Now the listeners */
- if (listening_channels) {
- SMARTLIST_FOREACH_BEGIN(listening_channels, channel_t *, curr) {
- tmp = curr;
- /* Remove it from the list */
- SMARTLIST_DEL_CURRENT(listening_channels, curr);
- /* Close, deregister and free it */
- tor_assert(tmp);
- log_debug(LD_CHANNEL,
- "Cleaning up listening channel %p (ID %lu) in state %s (%d)",
- tmp, tmp->global_identifier,
- channel_state_to_string(tmp->state), tmp->state);
- /*
- * We have to unregister first so we don't put it in finished_channels
- * and allocate that again on close.
- */
- channel_unregister(tmp);
- channel_request_close(tmp);
- channel_force_free(tmp);
- } SMARTLIST_FOREACH_END(curr);
- smartlist_free(listening_channels);
- listening_channels = NULL;
- }
- /* Now all active channels */
- if (active_channels) {
- SMARTLIST_FOREACH_BEGIN(active_channels, channel_t *, curr) {
- tmp = curr;
- /* Remove it from the list */
- SMARTLIST_DEL_CURRENT(active_channels, curr);
- /* Close, deregister and free it */
- tor_assert(tmp);
- log_debug(LD_CHANNEL,
- "Cleaning up active channel %p (ID %lu) in state %s (%d)",
- tmp, tmp->global_identifier,
- channel_state_to_string(tmp->state), tmp->state);
- /*
- * We have to unregister first so we don't put it in finished_channels
- * and allocate that again on close.
- */
- channel_unregister(tmp);
- channel_request_close(tmp);
- channel_force_free(tmp);
- } SMARTLIST_FOREACH_END(curr);
- smartlist_free(active_channels);
- active_channels = NULL;
- }
- /* Now all channels, in case any are left over */
- if (all_channels) {
- SMARTLIST_FOREACH_BEGIN(all_channels, channel_t *, curr) {
- tmp = curr;
- /* Remove it from the list */
- SMARTLIST_DEL_CURRENT(all_channels, curr);
- /* Close, deregister and free it */
- tor_assert(tmp);
- log_debug(LD_CHANNEL,
- "Cleaning up leftover channel %p (ID %lu) in state %s (%d)",
- tmp, tmp->global_identifier,
- channel_state_to_string(tmp->state), tmp->state);
- channel_unregister(tmp);
- if (!(tmp->state == CHANNEL_STATE_CLOSING ||
- tmp->state == CHANNEL_STATE_CLOSED ||
- tmp->state == CHANNEL_STATE_ERROR)) {
- channel_request_close(tmp);
- }
- channel_force_free(tmp);
- } SMARTLIST_FOREACH_END(curr);
- smartlist_free(all_channels);
- all_channels = NULL;
- }
- /* Now free channel_identity_map */
- if (channel_identity_map) {
- log_debug(LD_CHANNEL,
- "Freeing channel_identity_map");
- /* Geez, anything still left over just won't die ... let it leak then */
- digestmap_free(channel_identity_map, NULL);
- channel_identity_map = NULL;
- }
- log_debug(LD_CHANNEL,
- "Done cleaning up after channels");
- }
- /**
- * Connect to a given addr/port/digest
- *
- * This sets up a new outgoing channel; in the future if multiple
- * channel_t subclasses are available, this is where the selection policy
- * should go. It may also be desirable to fold port into tor_addr_t
- * or make a new type including a tor_addr_t and port, so we have a
- * single abstract object encapsulating all the protocol details of
- * how to contact an OR.
- *
- * @param addr Address of remote node to establish a channel to
- * @param port ORport of remote OR
- * @param id_digest Identity digest of remote OR
- * @return New channel, or NULL if failure
- */
- channel_t *
- channel_connect(const tor_addr_t *addr, uint16_t port,
- const char *id_digest)
- {
- return channel_tls_connect(addr, port, id_digest);
- }
- /**
- * Decide which of two channels to prefer for extending a circuit
- *
- * This function is called while extending a circuit and returns true iff
- * a is 'better' than b. The most important criterion here is that a
- * canonical channel is always better than a non-canonical one, but the
- * number of circuits and the age are used as tie-breakers.
- *
- * This is based on the former connection_or_is_better() of connection_or.c
- *
- * @param now Current time to use for deciding grace period for new channels
- * @param a Channel A for comparison
- * @param b Channel B for comparison
- * @param forgive_new_connections Whether to use grace period for new channels
- * @return 1 iff a is better than b
- */
- int
- channel_is_better(time_t now, channel_t *a, channel_t *b,
- int forgive_new_connections)
- {
- int a_grace, b_grace;
- int a_is_canonical, b_is_canonical;
- int a_has_circs, b_has_circs;
- /*
- * Do not definitively deprecate a new channel with no circuits on it
- * until this much time has passed.
- */
- #define NEW_CHAN_GRACE_PERIOD (15*60)
- tor_assert(a);
- tor_assert(b);
- tor_assert(!(a->is_listener));
- tor_assert(!(b->is_listener));
- /* Check if one is canonical and the other isn't first */
- a_is_canonical = channel_is_canonical(a);
- b_is_canonical = channel_is_canonical(b);
- if (a_is_canonical && !b_is_canonical) return 1;
- if (!a_is_canonical && b_is_canonical) return 0;
- /*
- * Okay, if we're here they tied on canonicity. Next we check if
- * they have any circuits, and if one does and the other doesn't,
- * we prefer the one that does, unless we are forgiving and the
- * one that has no circuits is in its grace period.
- */
- a_has_circs = (a->u.cell_chan.n_circuits > 0);
- b_has_circs = (b->u.cell_chan.n_circuits > 0);
- a_grace = (forgive_new_connections &&
- (now < channel_when_created(a) + NEW_CHAN_GRACE_PERIOD));
- b_grace = (forgive_new_connections &&
- (now < channel_when_created(b) + NEW_CHAN_GRACE_PERIOD));
- if (a_has_circs && !b_has_circs && !b_grace) return 1;
- if (!a_has_circs && b_has_circs && !a_grace) return 0;
- /* They tied on circuits too; just prefer whichever is newer */
- if (channel_when_created(a) > channel_when_created(b)) return 1;
- else return 0;
- }
- /**
- * Get a channel to extend a circuit
- *
- * Pick a suitable channel to extend a circuit to given the desired digest
- * the address we believe is correct for that digest; this tries to see
- * if we already have one for the requested endpoint, but if there is no good
- * channel, set *msg_out to a message describing the channel's state
- * and our next action, and set *launch_out to a boolean indicated whether
- * the caller should try to launch a new channel with channel_connect().
- *
- * @param digest Endpoint digest we want
- * @param target_addr Endpoint address we want
- * @param msg_out Write out status message here if we fail
- * @param launch_out Write 1 here if caller should try to connect a new
- * channel.
- * @return Pointer to selected channel, or NULL if none available
- */
- channel_t *
- channel_get_for_extend(const char *digest,
- const tor_addr_t *target_addr,
- const char **msg_out,
- int *launch_out)
- {
- channel_t *chan, *best = NULL;
- int n_inprogress_goodaddr = 0, n_old = 0;
- int n_noncanonical = 0, n_possible = 0;
- time_t now = approx_time();
- tor_assert(msg_out);
- tor_assert(launch_out);
- if (!channel_identity_map) {
- *msg_out = "Router not connected (nothing is). Connecting.";
- *launch_out = 1;
- return NULL;
- }
- chan = channel_find_by_remote_digest(digest);
- /* Walk the list, unrefing the old one and refing the new at each
- * iteration.
- */
- for (; chan; chan = channel_next_with_digest(chan)) {
- tor_assert(!(chan->is_listener));
- tor_assert(tor_memeq(chan->u.cell_chan.identity_digest,
- digest, DIGEST_LEN));
- if (chan->state == CHANNEL_STATE_CLOSING ||
- chan->state == CHANNEL_STATE_CLOSED ||
- chan->state == CHANNEL_STATE_ERROR ||
- chan->state == CHANNEL_STATE_LISTENING)
- continue;
- /* Never return a channel on which the other end appears to be
- * a client. */
- if (channel_is_client(chan)) {
- continue;
- }
- /* Never return a non-open connection. */
- if (chan->state != CHANNEL_STATE_OPEN) {
- /* If the address matches, don't launch a new connection for this
- * circuit. */
- if (!channel_matches_target_addr_for_extend(chan, target_addr))
- ++n_inprogress_goodaddr;
- continue;
- }
- /* Never return a connection that shouldn't be used for circs. */
- if (channel_is_bad_for_new_circs(chan)) {
- ++n_old;
- continue;
- }
- /* Never return a non-canonical connection using a recent link protocol
- * if the address is not what we wanted.
- *
- * The channel_is_canonical_is_reliable() function asks the lower layer
- * if we should trust channel_is_canonical(). The below is from the
- * comments of the old circuit_or_get_for_extend() and applies when
- * the lower-layer transport is channel_tls_t.
- *
- * (For old link protocols, we can't rely on is_canonical getting
- * set properly if we're talking to the right address, since we might
- * have an out-of-date descriptor, and we will get no NETINFO cell to
- * tell us about the right address.)
- */
- if (!channel_is_canonical(chan) &&
- channel_is_canonical_is_reliable(chan) &&
- !channel_matches_target_addr_for_extend(chan, target_addr)) {
- ++n_noncanonical;
- continue;
- }
- ++n_possible;
- if (!best) {
- best = chan; /* If we have no 'best' so far, this one is good enough. */
- continue;
- }
- if (channel_is_better(now, chan, best, 0))
- best = chan;
- }
- if (best) {
- *msg_out = "Connection is fine; using it.";
- *launch_out = 0;
- return best;
- } else if (n_inprogress_goodaddr) {
- *msg_out = "Connection in progress; waiting.";
- *launch_out = 0;
- return NULL;
- } else if (n_old || n_noncanonical) {
- *msg_out = "Connections all too old, or too non-canonical. "
- " Launching a new one.";
- *launch_out = 1;
- return NULL;
- } else {
- *msg_out = "Not connected. Connecting.";
- *launch_out = 1;
- return NULL;
- }
- }
- /**
- * Return text description of the remote endpoint
- *
- * This function return a test provided by the lower layer of the remote
- * endpoint for this channel; it should specify the actual address connected
- * to/from.
- *
- * @param chan Channel to describe
- * @return Pointer to string description
- */
- const char *
- channel_get_actual_remote_descr(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(chan->u.cell_chan.get_remote_descr);
- /* Param 1 indicates the actual description */
- return chan->u.cell_chan.get_remote_descr(chan, 1);
- }
- /**
- * Return text description of the remote endpoint canonical address
- *
- * This function return a test provided by the lower layer of the remote
- * endpoint for this channel; it should use the known canonical address for
- * this OR's identity digest if possible.
- *
- * @param chan Channel to describe
- * @return Pointer to string description
- */
- const char *
- channel_get_canonical_remote_descr(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(chan->u.cell_chan.get_remote_descr);
- /* Param 0 indicates the canonicalized description */
- return chan->u.cell_chan.get_remote_descr(chan, 0);
- }
- /**
- * Get remote address if possible
- *
- * Write the remote address out to a tor_addr_t if the underlying transport
- * supports this operation.
- *
- * @param chan Channel to request remote address from
- * @param addr_out Write the address out here
- * @return 1 if successful, 0 if not
- */
- int
- channel_get_addr_if_possible(channel_t *chan, tor_addr_t *addr_out)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(addr_out);
- if (chan->u.cell_chan.get_remote_addr)
- return chan->u.cell_chan.get_remote_addr(chan, addr_out);
- /* Else no support, method not implemented */
- else return 0;
- }
- /**
- * Check if there are outgoing queue writes on this channel
- *
- * Indicate if either we have queued cells, or if not, whether the underlying
- * lower-layer transport thinks it has an output queue.
- *
- * @param chan Channel to query
- * @return 1 if there are queued writes, 0 otherwise
- */
- int
- channel_has_queued_writes(channel_t *chan)
- {
- int has_writes = 0;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(chan->u.cell_chan.has_queued_writes);
- if (chan->u.cell_chan.outgoing_queue &&
- smartlist_len(chan->u.cell_chan.outgoing_queue) > 0) {
- has_writes = 1;
- } else {
- /* Check with the lower layer */
- has_writes = chan->u.cell_chan.has_queued_writes(chan);
- }
- return has_writes;
- }
- /**
- * Check the is_bad_for_new_circs flag
- *
- * This function returns the is_bad_for_new_circs flag of the specified
- * channel.
- *
- * @param chan Channel to get flag on
- * @return Flag value
- */
- int
- channel_is_bad_for_new_circs(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- return chan->u.cell_chan.is_bad_for_new_circs;
- }
- /**
- * Mark a channel as bad for new circuits
- *
- * Set the is_bad_for_new_circs_flag on chan.
- *
- * @param chan Channel to mark
- */
- void
- channel_mark_bad_for_new_circs(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- chan->u.cell_chan.is_bad_for_new_circs = 1;
- }
- /**
- * Get the client flag
- *
- * This returns the client flag of a channel, which will be set if
- * command_process_create_cell() in command.c thinks this is a connection
- * from a client.
- *
- * @param chan Channel to query flag
- * @return Flag value
- */
- int
- channel_is_client(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- return chan->u.cell_chan.is_client;
- }
- /**
- * Set the client flag
- *
- * Mark a channel as being from a client
- *
- * @param chan Channel to mark
- */
- void
- channel_mark_client(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- chan->u.cell_chan.is_client = 1;
- }
- /**
- * Get the canonical flag for a channel
- *
- * This returns the is_canonical for a channel; this flag is determined by
- * the lower layer and can't be set in a transport-independent way.
- *
- * @param chan Channel to query
- * @return Flag value
- */
- int
- channel_is_canonical(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(chan->u.cell_chan.is_canonical);
- return chan->u.cell_chan.is_canonical(chan, 0);
- }
- /**
- * Test if the canonical flag is reliable
- *
- * This function asks if the lower layer thinks it's safe to trust the
- * result of channel_is_canonical()
- *
- * @param chan Channel to query
- * @return 1 if the lower layer thinks the is_canonical flag is reliable, 0
- * otherwise.
- */
- int
- channel_is_canonical_is_reliable(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(chan->u.cell_chan.is_canonical);
- return chan->u.cell_chan.is_canonical(chan, 1);
- }
- /**
- * Test incoming flag
- *
- * This function gets the incoming flag; this is set when a listener spawns
- * a channel. If this returns true the channel was remotely initiated.
- *
- * @param chan Channel to query
- * @return Flag value
- */
- int
- channel_is_incoming(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- return chan->u.cell_chan.is_incoming;
- }
- /**
- * Set the incoming flag
- *
- * This function is called when a channel arrives on a listening channel
- * to mark it as incoming.
- *
- * @param chan Channel to mark
- */
- void
- channel_mark_incoming(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- chan->u.cell_chan.is_incoming = 1;
- }
- /**
- * Test local flag
- *
- * This function gets the local flag; the lower layer should set this when
- * setting up the channel if is_local_addr() is true for all of the
- * destinations it will communicate with on behalf of this channel. It's
- * used to decide whether to declare the network reachable when seeing incoming
- * traffic on the channel.
- *
- * @param chan Channel to query
- * @return Flag value
- */
- int
- channel_is_local(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- return chan->u.cell_chan.is_local;
- }
- /**
- * Set the local flag
- *
- * This internal-only function should be called by the lower layer if the
- * channel is to a local address. See channel_is_local() above or the
- * description of the is_local bit in channel.h
- *
- * @param chan Channel to mark
- */
- void
- channel_mark_local(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- chan->u.cell_chan.is_local = 1;
- }
- /**
- * Test outgoing flag
- *
- * This function gets the outgoing flag; this is the inverse of the incoming
- * bit set when a listener spawns a channel. If this returns true the channel
- * was locally initiated.
- *
- * @param chan Channel to query
- * @return Flag value
- */
- int
- channel_is_outgoing(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- return !(chan->u.cell_chan.is_incoming);
- }
- /**
- * Mark a channel as outgoing
- *
- * This function clears the incoming flag and thus marks a channel as
- * outgoing.
- *
- * @param chan Channel to mark
- */
- void
- channel_mark_outgoing(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- chan->u.cell_chan.is_incoming = 0;
- }
- /*********************
- * Timestamp updates *
- ********************/
- /**
- * Update the created timestamp
- *
- * This updates the channel's created timestamp and should only be called
- * from channel_init().
- *
- * @param chan Channel to update
- */
- void
- channel_timestamp_created(channel_t *chan)
- {
- time_t now = time(NULL);
- tor_assert(chan);
- chan->timestamp_created = now;
- }
- /**
- * Update the last active timestamp.
- *
- * This function updates the channe's last active timestamp; it should be
- * called by the lower layer whenever there is activity on the channel which
- * does not lead to a cell being transmitted or received; the active timestamp
- * is also updated from channel_timestamp_recv() and channel_timestamp_xmit(),
- * but it should be updated for things like the v3 handshake and stuff that
- * produce activity only visible to the lower layer.
- *
- * @param chan Channel to update
- */
- void
- channel_timestamp_active(channel_t *chan)
- {
- time_t now = time(NULL);
- tor_assert(chan);
- chan->timestamp_active = now;
- }
- /**
- * Update client timestamp
- *
- * This function is called by relay.c to timestamp a channel that appears to
- * be used as a client.
- *
- * @param chan Channel to update
- */
- void
- channel_timestamp_client(channel_t *chan)
- {
- time_t now = time(NULL);
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- chan->u.cell_chan.timestamp_client = now;
- }
- /**
- * Update the last drained timestamp
- *
- * This is called whenever we transmit a cell which leaves the outgoing cell
- * queue completely empty. It also updates the xmit time and the active time.
- *
- * @param chan Channel to update
- */
- void
- channel_timestamp_drained(channel_t *chan)
- {
- time_t now = time(NULL);
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- chan->timestamp_active = now;
- chan->u.cell_chan.timestamp_drained = now;
- chan->u.cell_chan.timestamp_xmit = now;
- }
- /**
- * Update the recv timestamp
- *
- * This is called whenever we get an incoming cell from the lower layer.
- * This also updates the active timestamp.
- *
- * @param chan Channel to update
- */
- void
- channel_timestamp_recv(channel_t *chan)
- {
- time_t now = time(NULL);
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- chan->timestamp_active = now;
- chan->u.cell_chan.timestamp_recv = now;
- }
- /**
- * Update the xmit timestamp
- * This is called whenever we pass an outgoing cell to the lower layer. This
- * also updates the active timestamp.
- *
- * @param chan Channel to update
- */
- void
- channel_timestamp_xmit(channel_t *chan)
- {
- time_t now = time(NULL);
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- chan->timestamp_active = now;
- chan->u.cell_chan.timestamp_xmit = now;
- }
- /***************************************************************
- * Timestamp queries - see above for definitions of timestamps *
- **************************************************************/
- /**
- * Query created timestamp
- *
- * @param chan Channel to query
- * @return Created timestamp value for chan
- */
- time_t
- channel_when_created(channel_t *chan)
- {
- tor_assert(chan);
- return chan->timestamp_created;
- }
- /**
- * Query last active timestamp
- *
- * @param chan Channel to query
- * @return Last active timestamp value for chan
- */
- time_t
- channel_when_last_active(channel_t *chan)
- {
- tor_assert(chan);
- return chan->timestamp_active;
- }
- /**
- * Query client timestamp
- *
- * @param chan Channel to query
- * @return Client timestamp value for chan
- */
- time_t
- channel_when_last_client(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- return chan->u.cell_chan.timestamp_client;
- }
- /**
- * Query drained timestamp
- *
- * @param chan Channel to query
- * @return drained timestamp value for chan
- */
- time_t
- channel_when_last_drained(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- return chan->u.cell_chan.timestamp_drained;
- }
- /**
- * Query recv timestamp
- *
- * @param chan Channel to query
- * @return Recv timestamp value for chan
- */
- time_t
- channel_when_last_recv(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- return chan->u.cell_chan.timestamp_recv;
- }
- /**
- * Query xmit timestamp
- *
- * @param chan Channel to query
- * @return Xmit timestamp value for chan
- */
- time_t
- channel_when_last_xmit(channel_t *chan)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- return chan->u.cell_chan.timestamp_xmit;
- }
- /**
- * Check if a channel matches an extend_info_t
- *
- * This function calls the lower layer and asks if this channel matches a
- * given extend_info_t.
- *
- * @param chan Channel to test
- * @param extend_info Pointer to extend_info_t to match
- * @return 1 if they match, 0 otherwise
- */
- int
- channel_matches_extend_info(channel_t *chan, extend_info_t *extend_info)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(chan->u.cell_chan.matches_extend_info);
- tor_assert(extend_info);
- return chan->u.cell_chan.matches_extend_info(chan, extend_info);
- }
- /**
- * Check if a channel matches a given target address
- *
- * This function calls into the lower layer and asks if this channel thinks
- * it matches a given target address for circuit extension purposes.
- *
- * @param chan Channel to test
- * @param target Address to match
- * @return 1 if they match, 0 otherwise
- */
- int
- channel_matches_target_addr_for_extend(channel_t *chan,
- const tor_addr_t *target)
- {
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- tor_assert(chan->u.cell_chan.matches_target);
- tor_assert(target);
- return chan->u.cell_chan.matches_target(chan, target);
- }
- /**
- * Set up circuit ID generation
- *
- * This is called when setting up a channel and replaces the old
- * connection_or_set_circid_type()
- *
- * @param chan Channel to set up
- * @param identity_rcvd Remote end's identity public key
- */
- void
- channel_set_circid_type(channel_t *chan, crypto_pk_t *identity_rcvd)
- {
- int started_here;
- crypto_pk_t *our_identity;
- tor_assert(chan);
- tor_assert(!(chan->is_listener));
- started_here = channel_is_outgoing(chan);
- our_identity = started_here ?
- get_tlsclient_identity_key() : get_server_identity_key();
- if (identity_rcvd) {
- if (crypto_pk_cmp_keys(our_identity, identity_rcvd) < 0) {
- chan->u.cell_chan.circ_id_type = CIRC_ID_TYPE_LOWER;
- } else {
- chan->u.cell_chan.circ_id_type = CIRC_ID_TYPE_HIGHER;
- }
- } else {
- chan->u.cell_chan.circ_id_type = CIRC_ID_TYPE_NEITHER;
- }
- }
|