main.c 82 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516
  1. /* Copyright (c) 2001 Matej Pfajfar.
  2. * Copyright (c) 2001-2004, Roger Dingledine.
  3. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  4. * Copyright (c) 2007-2011, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7. * \file main.c
  8. * \brief Toplevel module. Handles signals, multiplexes between
  9. * connections, implements main loop, and drives scheduled events.
  10. **/
  11. #define MAIN_PRIVATE
  12. #include "or.h"
  13. #include "buffers.h"
  14. #include "circuitbuild.h"
  15. #include "circuitlist.h"
  16. #include "circuituse.h"
  17. #include "command.h"
  18. #include "config.h"
  19. #include "connection.h"
  20. #include "connection_edge.h"
  21. #include "connection_or.h"
  22. #include "control.h"
  23. #include "cpuworker.h"
  24. #include "directory.h"
  25. #include "dirserv.h"
  26. #include "dirvote.h"
  27. #include "dns.h"
  28. #include "dnsserv.h"
  29. #include "geoip.h"
  30. #include "hibernate.h"
  31. #include "main.h"
  32. #include "microdesc.h"
  33. #include "networkstatus.h"
  34. #include "nodelist.h"
  35. #include "ntmain.h"
  36. #include "onion.h"
  37. #include "policies.h"
  38. #include "relay.h"
  39. #include "rendclient.h"
  40. #include "rendcommon.h"
  41. #include "rendservice.h"
  42. #include "rephist.h"
  43. #include "router.h"
  44. #include "routerlist.h"
  45. #include "routerparse.h"
  46. #include "status.h"
  47. #ifdef USE_DMALLOC
  48. #include <dmalloc.h>
  49. #include <openssl/crypto.h>
  50. #endif
  51. #include "memarea.h"
  52. #ifdef HAVE_EVENT2_EVENT_H
  53. #include <event2/event.h>
  54. #else
  55. #include <event.h>
  56. #endif
  57. #ifdef USE_BUFFEREVENTS
  58. #include <event2/bufferevent.h>
  59. #endif
  60. void evdns_shutdown(int);
  61. /********* PROTOTYPES **********/
  62. static void dumpmemusage(int severity);
  63. static void dumpstats(int severity); /* log stats */
  64. static void conn_read_callback(evutil_socket_t fd, short event, void *_conn);
  65. static void conn_write_callback(evutil_socket_t fd, short event, void *_conn);
  66. static void second_elapsed_callback(periodic_timer_t *timer, void *args);
  67. static int conn_close_if_marked(int i);
  68. static void connection_start_reading_from_linked_conn(connection_t *conn);
  69. static int connection_should_read_from_linked_conn(connection_t *conn);
  70. /********* START VARIABLES **********/
  71. #ifndef USE_BUFFEREVENTS
  72. int global_read_bucket; /**< Max number of bytes I can read this second. */
  73. int global_write_bucket; /**< Max number of bytes I can write this second. */
  74. /** Max number of relayed (bandwidth class 1) bytes I can read this second. */
  75. int global_relayed_read_bucket;
  76. /** Max number of relayed (bandwidth class 1) bytes I can write this second. */
  77. int global_relayed_write_bucket;
  78. /** What was the read bucket before the last second_elapsed_callback() call?
  79. * (used to determine how many bytes we've read). */
  80. static int stats_prev_global_read_bucket;
  81. /** What was the write bucket before the last second_elapsed_callback() call?
  82. * (used to determine how many bytes we've written). */
  83. static int stats_prev_global_write_bucket;
  84. #else
  85. static uint64_t stats_prev_n_read = 0;
  86. static uint64_t stats_prev_n_written = 0;
  87. #endif
  88. /* XXX we might want to keep stats about global_relayed_*_bucket too. Or not.*/
  89. /** How many bytes have we read since we started the process? */
  90. static uint64_t stats_n_bytes_read = 0;
  91. /** How many bytes have we written since we started the process? */
  92. static uint64_t stats_n_bytes_written = 0;
  93. /** What time did this process start up? */
  94. time_t time_of_process_start = 0;
  95. /** How many seconds have we been running? */
  96. long stats_n_seconds_working = 0;
  97. /** When do we next launch DNS wildcarding checks? */
  98. static time_t time_to_check_for_correct_dns = 0;
  99. /** How often will we honor SIGNEWNYM requests? */
  100. #define MAX_SIGNEWNYM_RATE 10
  101. /** When did we last process a SIGNEWNYM request? */
  102. static time_t time_of_last_signewnym = 0;
  103. /** Is there a signewnym request we're currently waiting to handle? */
  104. static int signewnym_is_pending = 0;
  105. /** How many times have we called newnym? */
  106. static unsigned newnym_epoch = 0;
  107. /** Smartlist of all open connections. */
  108. static smartlist_t *connection_array = NULL;
  109. /** List of connections that have been marked for close and need to be freed
  110. * and removed from connection_array. */
  111. static smartlist_t *closeable_connection_lst = NULL;
  112. /** List of linked connections that are currently reading data into their
  113. * inbuf from their partner's outbuf. */
  114. static smartlist_t *active_linked_connection_lst = NULL;
  115. /** Flag: Set to true iff we entered the current libevent main loop via
  116. * <b>loop_once</b>. If so, there's no need to trigger a loopexit in order
  117. * to handle linked connections. */
  118. static int called_loop_once = 0;
  119. /** We set this to 1 when we've opened a circuit, so we can print a log
  120. * entry to inform the user that Tor is working. We set it to 0 when
  121. * we think the fact that we once opened a circuit doesn't mean we can do so
  122. * any longer (a big time jump happened, when we notice our directory is
  123. * heinously out-of-date, etc.
  124. */
  125. int can_complete_circuit=0;
  126. /** How often do we check for router descriptors that we should download
  127. * when we have too little directory info? */
  128. #define GREEDY_DESCRIPTOR_RETRY_INTERVAL (10)
  129. /** How often do we check for router descriptors that we should download
  130. * when we have enough directory info? */
  131. #define LAZY_DESCRIPTOR_RETRY_INTERVAL (60)
  132. /** How often do we 'forgive' undownloadable router descriptors and attempt
  133. * to download them again? */
  134. #define DESCRIPTOR_FAILURE_RESET_INTERVAL (60*60)
  135. /** How long do we let a directory connection stall before expiring it? */
  136. #define DIR_CONN_MAX_STALL (5*60)
  137. /** How long do we let OR connections handshake before we decide that
  138. * they are obsolete? */
  139. #define TLS_HANDSHAKE_TIMEOUT (60)
  140. /** Decides our behavior when no logs are configured/before any
  141. * logs have been configured. For 0, we log notice to stdout as normal.
  142. * For 1, we log warnings only. For 2, we log nothing.
  143. */
  144. int quiet_level = 0;
  145. /********* END VARIABLES ************/
  146. /****************************************************************************
  147. *
  148. * This section contains accessors and other methods on the connection_array
  149. * variables (which are global within this file and unavailable outside it).
  150. *
  151. ****************************************************************************/
  152. #if 0 && defined(USE_BUFFEREVENTS)
  153. static void
  154. free_old_inbuf(connection_t *conn)
  155. {
  156. if (! conn->inbuf)
  157. return;
  158. tor_assert(conn->outbuf);
  159. tor_assert(buf_datalen(conn->inbuf) == 0);
  160. tor_assert(buf_datalen(conn->outbuf) == 0);
  161. buf_free(conn->inbuf);
  162. buf_free(conn->outbuf);
  163. conn->inbuf = conn->outbuf = NULL;
  164. if (conn->read_event) {
  165. event_del(conn->read_event);
  166. tor_event_free(conn->read_event);
  167. }
  168. if (conn->write_event) {
  169. event_del(conn->read_event);
  170. tor_event_free(conn->write_event);
  171. }
  172. conn->read_event = conn->write_event = NULL;
  173. }
  174. #endif
  175. /** Add <b>conn</b> to the array of connections that we can poll on. The
  176. * connection's socket must be set; the connection starts out
  177. * non-reading and non-writing.
  178. */
  179. int
  180. connection_add_impl(connection_t *conn, int is_connecting)
  181. {
  182. tor_assert(conn);
  183. tor_assert(SOCKET_OK(conn->s) ||
  184. conn->linked ||
  185. (conn->type == CONN_TYPE_AP &&
  186. TO_EDGE_CONN(conn)->is_dns_request));
  187. tor_assert(conn->conn_array_index == -1); /* can only connection_add once */
  188. conn->conn_array_index = smartlist_len(connection_array);
  189. smartlist_add(connection_array, conn);
  190. #ifdef USE_BUFFEREVENTS
  191. if (connection_type_uses_bufferevent(conn)) {
  192. if (SOCKET_OK(conn->s) && !conn->linked) {
  193. conn->bufev = bufferevent_socket_new(
  194. tor_libevent_get_base(),
  195. conn->s,
  196. BEV_OPT_DEFER_CALLBACKS);
  197. if (!conn->bufev) {
  198. log_warn(LD_BUG, "Unable to create socket bufferevent");
  199. smartlist_del(connection_array, conn->conn_array_index);
  200. conn->conn_array_index = -1;
  201. return -1;
  202. }
  203. if (is_connecting) {
  204. /* Put the bufferevent into a "connecting" state so that we'll get
  205. * a "connected" event callback on successful write. */
  206. bufferevent_socket_connect(conn->bufev, NULL, 0);
  207. }
  208. connection_configure_bufferevent_callbacks(conn);
  209. } else if (conn->linked && conn->linked_conn &&
  210. connection_type_uses_bufferevent(conn->linked_conn)) {
  211. tor_assert(!(SOCKET_OK(conn->s)));
  212. if (!conn->bufev) {
  213. struct bufferevent *pair[2] = { NULL, NULL };
  214. if (bufferevent_pair_new(tor_libevent_get_base(),
  215. BEV_OPT_DEFER_CALLBACKS,
  216. pair) < 0) {
  217. log_warn(LD_BUG, "Unable to create bufferevent pair");
  218. smartlist_del(connection_array, conn->conn_array_index);
  219. conn->conn_array_index = -1;
  220. return -1;
  221. }
  222. tor_assert(pair[0]);
  223. conn->bufev = pair[0];
  224. conn->linked_conn->bufev = pair[1];
  225. } /* else the other side already was added, and got a bufferevent_pair */
  226. connection_configure_bufferevent_callbacks(conn);
  227. } else {
  228. tor_assert(!conn->linked);
  229. }
  230. if (conn->bufev)
  231. tor_assert(conn->inbuf == NULL);
  232. if (conn->linked_conn && conn->linked_conn->bufev)
  233. tor_assert(conn->linked_conn->inbuf == NULL);
  234. }
  235. #else
  236. (void) is_connecting;
  237. #endif
  238. if (!HAS_BUFFEREVENT(conn) && (SOCKET_OK(conn->s) || conn->linked)) {
  239. conn->read_event = tor_event_new(tor_libevent_get_base(),
  240. conn->s, EV_READ|EV_PERSIST, conn_read_callback, conn);
  241. conn->write_event = tor_event_new(tor_libevent_get_base(),
  242. conn->s, EV_WRITE|EV_PERSIST, conn_write_callback, conn);
  243. /* XXXX CHECK FOR NULL RETURN! */
  244. }
  245. log_debug(LD_NET,"new conn type %s, socket %d, address %s, n_conns %d.",
  246. conn_type_to_string(conn->type), (int)conn->s, conn->address,
  247. smartlist_len(connection_array));
  248. return 0;
  249. }
  250. /** Tell libevent that we don't care about <b>conn</b> any more. */
  251. void
  252. connection_unregister_events(connection_t *conn)
  253. {
  254. if (conn->read_event) {
  255. if (event_del(conn->read_event))
  256. log_warn(LD_BUG, "Error removing read event for %d", (int)conn->s);
  257. tor_free(conn->read_event);
  258. }
  259. if (conn->write_event) {
  260. if (event_del(conn->write_event))
  261. log_warn(LD_BUG, "Error removing write event for %d", (int)conn->s);
  262. tor_free(conn->write_event);
  263. }
  264. #ifdef USE_BUFFEREVENTS
  265. if (conn->bufev) {
  266. bufferevent_free(conn->bufev);
  267. conn->bufev = NULL;
  268. }
  269. #endif
  270. if (conn->type == CONN_TYPE_AP_DNS_LISTENER) {
  271. dnsserv_close_listener(conn);
  272. }
  273. }
  274. /** Remove the connection from the global list, and remove the
  275. * corresponding poll entry. Calling this function will shift the last
  276. * connection (if any) into the position occupied by conn.
  277. */
  278. int
  279. connection_remove(connection_t *conn)
  280. {
  281. int current_index;
  282. connection_t *tmp;
  283. tor_assert(conn);
  284. log_debug(LD_NET,"removing socket %d (type %s), n_conns now %d",
  285. (int)conn->s, conn_type_to_string(conn->type),
  286. smartlist_len(connection_array));
  287. tor_assert(conn->conn_array_index >= 0);
  288. current_index = conn->conn_array_index;
  289. connection_unregister_events(conn); /* This is redundant, but cheap. */
  290. if (current_index == smartlist_len(connection_array)-1) { /* at the end */
  291. smartlist_del(connection_array, current_index);
  292. return 0;
  293. }
  294. /* replace this one with the one at the end */
  295. smartlist_del(connection_array, current_index);
  296. tmp = smartlist_get(connection_array, current_index);
  297. tmp->conn_array_index = current_index;
  298. return 0;
  299. }
  300. /** If <b>conn</b> is an edge conn, remove it from the list
  301. * of conn's on this circuit. If it's not on an edge,
  302. * flush and send destroys for all circuits on this conn.
  303. *
  304. * Remove it from connection_array (if applicable) and
  305. * from closeable_connection_list.
  306. *
  307. * Then free it.
  308. */
  309. static void
  310. connection_unlink(connection_t *conn)
  311. {
  312. connection_about_to_close_connection(conn);
  313. if (conn->conn_array_index >= 0) {
  314. connection_remove(conn);
  315. }
  316. if (conn->linked_conn) {
  317. conn->linked_conn->linked_conn = NULL;
  318. if (! conn->linked_conn->marked_for_close &&
  319. conn->linked_conn->reading_from_linked_conn)
  320. connection_start_reading(conn->linked_conn);
  321. conn->linked_conn = NULL;
  322. }
  323. smartlist_remove(closeable_connection_lst, conn);
  324. smartlist_remove(active_linked_connection_lst, conn);
  325. if (conn->type == CONN_TYPE_EXIT) {
  326. assert_connection_edge_not_dns_pending(TO_EDGE_CONN(conn));
  327. }
  328. if (conn->type == CONN_TYPE_OR) {
  329. if (!tor_digest_is_zero(TO_OR_CONN(conn)->identity_digest))
  330. connection_or_remove_from_identity_map(TO_OR_CONN(conn));
  331. }
  332. connection_free(conn);
  333. }
  334. /** Schedule <b>conn</b> to be closed. **/
  335. void
  336. add_connection_to_closeable_list(connection_t *conn)
  337. {
  338. tor_assert(!smartlist_isin(closeable_connection_lst, conn));
  339. tor_assert(conn->marked_for_close);
  340. assert_connection_ok(conn, time(NULL));
  341. smartlist_add(closeable_connection_lst, conn);
  342. }
  343. /** Return 1 if conn is on the closeable list, else return 0. */
  344. int
  345. connection_is_on_closeable_list(connection_t *conn)
  346. {
  347. return smartlist_isin(closeable_connection_lst, conn);
  348. }
  349. /** Return true iff conn is in the current poll array. */
  350. int
  351. connection_in_array(connection_t *conn)
  352. {
  353. return smartlist_isin(connection_array, conn);
  354. }
  355. /** Set <b>*array</b> to an array of all connections, and <b>*n</b>
  356. * to the length of the array. <b>*array</b> and <b>*n</b> must not
  357. * be modified.
  358. */
  359. smartlist_t *
  360. get_connection_array(void)
  361. {
  362. if (!connection_array)
  363. connection_array = smartlist_create();
  364. return connection_array;
  365. }
  366. /** Provides the traffic read and written over the life of the process. */
  367. uint64_t
  368. get_bytes_read(void)
  369. {
  370. return stats_n_bytes_read;
  371. }
  372. uint64_t
  373. get_bytes_written(void)
  374. {
  375. return stats_n_bytes_written;
  376. }
  377. /** Set the event mask on <b>conn</b> to <b>events</b>. (The event
  378. * mask is a bitmask whose bits are READ_EVENT and WRITE_EVENT)
  379. */
  380. void
  381. connection_watch_events(connection_t *conn, watchable_events_t events)
  382. {
  383. IF_HAS_BUFFEREVENT(conn, {
  384. short ev = ((short)events) & (EV_READ|EV_WRITE);
  385. short old_ev = bufferevent_get_enabled(conn->bufev);
  386. if ((ev & ~old_ev) != 0) {
  387. bufferevent_enable(conn->bufev, ev);
  388. }
  389. if ((old_ev & ~ev) != 0) {
  390. bufferevent_disable(conn->bufev, old_ev & ~ev);
  391. }
  392. return;
  393. });
  394. if (events & READ_EVENT)
  395. connection_start_reading(conn);
  396. else
  397. connection_stop_reading(conn);
  398. if (events & WRITE_EVENT)
  399. connection_start_writing(conn);
  400. else
  401. connection_stop_writing(conn);
  402. }
  403. /** Return true iff <b>conn</b> is listening for read events. */
  404. int
  405. connection_is_reading(connection_t *conn)
  406. {
  407. tor_assert(conn);
  408. IF_HAS_BUFFEREVENT(conn,
  409. return (bufferevent_get_enabled(conn->bufev) & EV_READ) != 0;
  410. );
  411. return conn->reading_from_linked_conn ||
  412. (conn->read_event && event_pending(conn->read_event, EV_READ, NULL));
  413. }
  414. /** Tell the main loop to stop notifying <b>conn</b> of any read events. */
  415. void
  416. connection_stop_reading(connection_t *conn)
  417. {
  418. tor_assert(conn);
  419. IF_HAS_BUFFEREVENT(conn, {
  420. bufferevent_disable(conn->bufev, EV_READ);
  421. return;
  422. });
  423. tor_assert(conn->read_event);
  424. if (conn->linked) {
  425. conn->reading_from_linked_conn = 0;
  426. connection_stop_reading_from_linked_conn(conn);
  427. } else {
  428. if (event_del(conn->read_event))
  429. log_warn(LD_NET, "Error from libevent setting read event state for %d "
  430. "to unwatched: %s",
  431. (int)conn->s,
  432. tor_socket_strerror(tor_socket_errno(conn->s)));
  433. }
  434. }
  435. /** Tell the main loop to start notifying <b>conn</b> of any read events. */
  436. void
  437. connection_start_reading(connection_t *conn)
  438. {
  439. tor_assert(conn);
  440. IF_HAS_BUFFEREVENT(conn, {
  441. bufferevent_enable(conn->bufev, EV_READ);
  442. return;
  443. });
  444. tor_assert(conn->read_event);
  445. if (conn->linked) {
  446. conn->reading_from_linked_conn = 1;
  447. if (connection_should_read_from_linked_conn(conn))
  448. connection_start_reading_from_linked_conn(conn);
  449. } else {
  450. if (event_add(conn->read_event, NULL))
  451. log_warn(LD_NET, "Error from libevent setting read event state for %d "
  452. "to watched: %s",
  453. (int)conn->s,
  454. tor_socket_strerror(tor_socket_errno(conn->s)));
  455. }
  456. }
  457. /** Return true iff <b>conn</b> is listening for write events. */
  458. int
  459. connection_is_writing(connection_t *conn)
  460. {
  461. tor_assert(conn);
  462. IF_HAS_BUFFEREVENT(conn,
  463. return (bufferevent_get_enabled(conn->bufev) & EV_WRITE) != 0;
  464. );
  465. return conn->writing_to_linked_conn ||
  466. (conn->write_event && event_pending(conn->write_event, EV_WRITE, NULL));
  467. }
  468. /** Tell the main loop to stop notifying <b>conn</b> of any write events. */
  469. void
  470. connection_stop_writing(connection_t *conn)
  471. {
  472. tor_assert(conn);
  473. IF_HAS_BUFFEREVENT(conn, {
  474. bufferevent_disable(conn->bufev, EV_WRITE);
  475. return;
  476. });
  477. tor_assert(conn->write_event);
  478. if (conn->linked) {
  479. conn->writing_to_linked_conn = 0;
  480. if (conn->linked_conn)
  481. connection_stop_reading_from_linked_conn(conn->linked_conn);
  482. } else {
  483. if (event_del(conn->write_event))
  484. log_warn(LD_NET, "Error from libevent setting write event state for %d "
  485. "to unwatched: %s",
  486. (int)conn->s,
  487. tor_socket_strerror(tor_socket_errno(conn->s)));
  488. }
  489. }
  490. /** Tell the main loop to start notifying <b>conn</b> of any write events. */
  491. void
  492. connection_start_writing(connection_t *conn)
  493. {
  494. tor_assert(conn);
  495. IF_HAS_BUFFEREVENT(conn, {
  496. bufferevent_enable(conn->bufev, EV_WRITE);
  497. return;
  498. });
  499. tor_assert(conn->write_event);
  500. if (conn->linked) {
  501. conn->writing_to_linked_conn = 1;
  502. if (conn->linked_conn &&
  503. connection_should_read_from_linked_conn(conn->linked_conn))
  504. connection_start_reading_from_linked_conn(conn->linked_conn);
  505. } else {
  506. if (event_add(conn->write_event, NULL))
  507. log_warn(LD_NET, "Error from libevent setting write event state for %d "
  508. "to watched: %s",
  509. (int)conn->s,
  510. tor_socket_strerror(tor_socket_errno(conn->s)));
  511. }
  512. }
  513. /** Return true iff <b>conn</b> is linked conn, and reading from the conn
  514. * linked to it would be good and feasible. (Reading is "feasible" if the
  515. * other conn exists and has data in its outbuf, and is "good" if we have our
  516. * reading_from_linked_conn flag set and the other conn has its
  517. * writing_to_linked_conn flag set.)*/
  518. static int
  519. connection_should_read_from_linked_conn(connection_t *conn)
  520. {
  521. if (conn->linked && conn->reading_from_linked_conn) {
  522. if (! conn->linked_conn ||
  523. (conn->linked_conn->writing_to_linked_conn &&
  524. buf_datalen(conn->linked_conn->outbuf)))
  525. return 1;
  526. }
  527. return 0;
  528. }
  529. /** Helper: Tell the main loop to begin reading bytes into <b>conn</b> from
  530. * its linked connection, if it is not doing so already. Called by
  531. * connection_start_reading and connection_start_writing as appropriate. */
  532. static void
  533. connection_start_reading_from_linked_conn(connection_t *conn)
  534. {
  535. tor_assert(conn);
  536. tor_assert(conn->linked == 1);
  537. if (!conn->active_on_link) {
  538. conn->active_on_link = 1;
  539. smartlist_add(active_linked_connection_lst, conn);
  540. if (!called_loop_once) {
  541. /* This is the first event on the list; we won't be in LOOP_ONCE mode,
  542. * so we need to make sure that the event_base_loop() actually exits at
  543. * the end of its run through the current connections and lets us
  544. * activate read events for linked connections. */
  545. struct timeval tv = { 0, 0 };
  546. tor_event_base_loopexit(tor_libevent_get_base(), &tv);
  547. }
  548. } else {
  549. tor_assert(smartlist_isin(active_linked_connection_lst, conn));
  550. }
  551. }
  552. /** Tell the main loop to stop reading bytes into <b>conn</b> from its linked
  553. * connection, if is currently doing so. Called by connection_stop_reading,
  554. * connection_stop_writing, and connection_read. */
  555. void
  556. connection_stop_reading_from_linked_conn(connection_t *conn)
  557. {
  558. tor_assert(conn);
  559. tor_assert(conn->linked == 1);
  560. if (conn->active_on_link) {
  561. conn->active_on_link = 0;
  562. /* FFFF We could keep an index here so we can smartlist_del
  563. * cleanly. On the other hand, this doesn't show up on profiles,
  564. * so let's leave it alone for now. */
  565. smartlist_remove(active_linked_connection_lst, conn);
  566. } else {
  567. tor_assert(!smartlist_isin(active_linked_connection_lst, conn));
  568. }
  569. }
  570. /** Close all connections that have been scheduled to get closed. */
  571. static void
  572. close_closeable_connections(void)
  573. {
  574. int i;
  575. for (i = 0; i < smartlist_len(closeable_connection_lst); ) {
  576. connection_t *conn = smartlist_get(closeable_connection_lst, i);
  577. if (conn->conn_array_index < 0) {
  578. connection_unlink(conn); /* blow it away right now */
  579. } else {
  580. if (!conn_close_if_marked(conn->conn_array_index))
  581. ++i;
  582. }
  583. }
  584. }
  585. /** Libevent callback: this gets invoked when (connection_t*)<b>conn</b> has
  586. * some data to read. */
  587. static void
  588. conn_read_callback(evutil_socket_t fd, short event, void *_conn)
  589. {
  590. connection_t *conn = _conn;
  591. (void)fd;
  592. (void)event;
  593. log_debug(LD_NET,"socket %d wants to read.",(int)conn->s);
  594. /* assert_connection_ok(conn, time(NULL)); */
  595. if (connection_handle_read(conn) < 0) {
  596. if (!conn->marked_for_close) {
  597. #ifndef MS_WINDOWS
  598. log_warn(LD_BUG,"Unhandled error on read for %s connection "
  599. "(fd %d); removing",
  600. conn_type_to_string(conn->type), (int)conn->s);
  601. tor_fragile_assert();
  602. #endif
  603. if (CONN_IS_EDGE(conn))
  604. connection_edge_end_errno(TO_EDGE_CONN(conn));
  605. connection_mark_for_close(conn);
  606. }
  607. }
  608. assert_connection_ok(conn, time(NULL));
  609. if (smartlist_len(closeable_connection_lst))
  610. close_closeable_connections();
  611. }
  612. /** Libevent callback: this gets invoked when (connection_t*)<b>conn</b> has
  613. * some data to write. */
  614. static void
  615. conn_write_callback(evutil_socket_t fd, short events, void *_conn)
  616. {
  617. connection_t *conn = _conn;
  618. (void)fd;
  619. (void)events;
  620. LOG_FN_CONN(conn, (LOG_DEBUG, LD_NET, "socket %d wants to write.",
  621. (int)conn->s));
  622. /* assert_connection_ok(conn, time(NULL)); */
  623. if (connection_handle_write(conn, 0) < 0) {
  624. if (!conn->marked_for_close) {
  625. /* this connection is broken. remove it. */
  626. log_fn(LOG_WARN,LD_BUG,
  627. "unhandled error on write for %s connection (fd %d); removing",
  628. conn_type_to_string(conn->type), (int)conn->s);
  629. tor_fragile_assert();
  630. if (CONN_IS_EDGE(conn)) {
  631. /* otherwise we cry wolf about duplicate close */
  632. edge_connection_t *edge_conn = TO_EDGE_CONN(conn);
  633. if (!edge_conn->end_reason)
  634. edge_conn->end_reason = END_STREAM_REASON_INTERNAL;
  635. edge_conn->edge_has_sent_end = 1;
  636. }
  637. connection_close_immediate(conn); /* So we don't try to flush. */
  638. connection_mark_for_close(conn);
  639. }
  640. }
  641. assert_connection_ok(conn, time(NULL));
  642. if (smartlist_len(closeable_connection_lst))
  643. close_closeable_connections();
  644. }
  645. /** If the connection at connection_array[i] is marked for close, then:
  646. * - If it has data that it wants to flush, try to flush it.
  647. * - If it _still_ has data to flush, and conn->hold_open_until_flushed is
  648. * true, then leave the connection open and return.
  649. * - Otherwise, remove the connection from connection_array and from
  650. * all other lists, close it, and free it.
  651. * Returns 1 if the connection was closed, 0 otherwise.
  652. */
  653. static int
  654. conn_close_if_marked(int i)
  655. {
  656. connection_t *conn;
  657. int retval;
  658. time_t now;
  659. conn = smartlist_get(connection_array, i);
  660. if (!conn->marked_for_close)
  661. return 0; /* nothing to see here, move along */
  662. now = time(NULL);
  663. assert_connection_ok(conn, now);
  664. /* assert_all_pending_dns_resolves_ok(); */
  665. #ifdef USE_BUFFEREVENTS
  666. if (conn->bufev) {
  667. if (conn->hold_open_until_flushed &&
  668. evbuffer_get_length(bufferevent_get_output(conn->bufev))) {
  669. /* don't close yet. */
  670. return 0;
  671. }
  672. if (conn->linked_conn && ! conn->linked_conn->marked_for_close) {
  673. /* We need to do this explicitly so that the linked connection
  674. * notices that there was an EOF. */
  675. bufferevent_flush(conn->bufev, EV_WRITE, BEV_FINISHED);
  676. }
  677. }
  678. #endif
  679. log_debug(LD_NET,"Cleaning up connection (fd %d).",conn->s);
  680. /* If the connection we are about to close was trying to connect to
  681. a proxy server and failed, the client won't be able to use that
  682. proxy. We should warn the user about this. */
  683. if (conn->proxy_state == PROXY_INFANT)
  684. log_failed_proxy_connection(conn);
  685. IF_HAS_BUFFEREVENT(conn, goto unlink);
  686. if ((SOCKET_OK(conn->s) || conn->linked_conn) &&
  687. connection_wants_to_flush(conn)) {
  688. /* s == -1 means it's an incomplete edge connection, or that the socket
  689. * has already been closed as unflushable. */
  690. ssize_t sz = connection_bucket_write_limit(conn, now);
  691. if (!conn->hold_open_until_flushed)
  692. log_info(LD_NET,
  693. "Conn (addr %s, fd %d, type %s, state %d) marked, but wants "
  694. "to flush %d bytes. (Marked at %s:%d)",
  695. escaped_safe_str_client(conn->address),
  696. (int)conn->s, conn_type_to_string(conn->type), conn->state,
  697. (int)conn->outbuf_flushlen,
  698. conn->marked_for_close_file, conn->marked_for_close);
  699. if (conn->linked_conn) {
  700. retval = move_buf_to_buf(conn->linked_conn->inbuf, conn->outbuf,
  701. &conn->outbuf_flushlen);
  702. if (retval >= 0) {
  703. /* The linked conn will notice that it has data when it notices that
  704. * we're gone. */
  705. connection_start_reading_from_linked_conn(conn->linked_conn);
  706. }
  707. log_debug(LD_GENERAL, "Flushed last %d bytes from a linked conn; "
  708. "%d left; flushlen %d; wants-to-flush==%d", retval,
  709. (int)connection_get_outbuf_len(conn),
  710. (int)conn->outbuf_flushlen,
  711. connection_wants_to_flush(conn));
  712. } else if (connection_speaks_cells(conn)) {
  713. if (conn->state == OR_CONN_STATE_OPEN) {
  714. retval = flush_buf_tls(TO_OR_CONN(conn)->tls, conn->outbuf, sz,
  715. &conn->outbuf_flushlen);
  716. } else
  717. retval = -1; /* never flush non-open broken tls connections */
  718. } else {
  719. retval = flush_buf(conn->s, conn->outbuf, sz, &conn->outbuf_flushlen);
  720. }
  721. if (retval >= 0 && /* Technically, we could survive things like
  722. TLS_WANT_WRITE here. But don't bother for now. */
  723. conn->hold_open_until_flushed && connection_wants_to_flush(conn)) {
  724. if (retval > 0) {
  725. LOG_FN_CONN(conn, (LOG_INFO,LD_NET,
  726. "Holding conn (fd %d) open for more flushing.",
  727. (int)conn->s));
  728. conn->timestamp_lastwritten = now; /* reset so we can flush more */
  729. }
  730. return 0;
  731. }
  732. if (connection_wants_to_flush(conn)) {
  733. int severity;
  734. if (conn->type == CONN_TYPE_EXIT ||
  735. (conn->type == CONN_TYPE_OR && server_mode(get_options())) ||
  736. (conn->type == CONN_TYPE_DIR && conn->purpose == DIR_PURPOSE_SERVER))
  737. severity = LOG_INFO;
  738. else
  739. severity = LOG_NOTICE;
  740. /* XXXX Maybe allow this to happen a certain amount per hour; it usually
  741. * is meaningless. */
  742. log_fn(severity, LD_NET, "We stalled too much while trying to write %d "
  743. "bytes to address %s. If this happens a lot, either "
  744. "something is wrong with your network connection, or "
  745. "something is wrong with theirs. "
  746. "(fd %d, type %s, state %d, marked at %s:%d).",
  747. (int)connection_get_outbuf_len(conn),
  748. escaped_safe_str_client(conn->address),
  749. (int)conn->s, conn_type_to_string(conn->type), conn->state,
  750. conn->marked_for_close_file,
  751. conn->marked_for_close);
  752. }
  753. }
  754. #ifdef USE_BUFFEREVENTS
  755. unlink:
  756. #endif
  757. connection_unlink(conn); /* unlink, remove, free */
  758. return 1;
  759. }
  760. /** We've just tried every dirserver we know about, and none of
  761. * them were reachable. Assume the network is down. Change state
  762. * so next time an application connection arrives we'll delay it
  763. * and try another directory fetch. Kill off all the circuit_wait
  764. * streams that are waiting now, since they will all timeout anyway.
  765. */
  766. void
  767. directory_all_unreachable(time_t now)
  768. {
  769. connection_t *conn;
  770. (void)now;
  771. stats_n_seconds_working=0; /* reset it */
  772. while ((conn = connection_get_by_type_state(CONN_TYPE_AP,
  773. AP_CONN_STATE_CIRCUIT_WAIT))) {
  774. entry_connection_t *entry_conn = TO_ENTRY_CONN(conn);
  775. log_notice(LD_NET,
  776. "Is your network connection down? "
  777. "Failing connection to '%s:%d'.",
  778. safe_str_client(entry_conn->socks_request->address),
  779. entry_conn->socks_request->port);
  780. connection_mark_unattached_ap(entry_conn,
  781. END_STREAM_REASON_NET_UNREACHABLE);
  782. }
  783. control_event_general_status(LOG_ERR, "DIR_ALL_UNREACHABLE");
  784. }
  785. /** This function is called whenever we successfully pull down some new
  786. * network statuses or server descriptors. */
  787. void
  788. directory_info_has_arrived(time_t now, int from_cache)
  789. {
  790. const or_options_t *options = get_options();
  791. if (!router_have_minimum_dir_info()) {
  792. int quiet = directory_too_idle_to_fetch_descriptors(options, now);
  793. log(quiet ? LOG_INFO : LOG_NOTICE, LD_DIR,
  794. "I learned some more directory information, but not enough to "
  795. "build a circuit: %s", get_dir_info_status_string());
  796. update_all_descriptor_downloads(now);
  797. return;
  798. } else {
  799. if (directory_fetches_from_authorities(options)) {
  800. update_all_descriptor_downloads(now);
  801. }
  802. /* if we have enough dir info, then update our guard status with
  803. * whatever we just learned. */
  804. entry_guards_compute_status(options, now);
  805. /* Don't even bother trying to get extrainfo until the rest of our
  806. * directory info is up-to-date */
  807. if (options->DownloadExtraInfo)
  808. update_extrainfo_downloads(now);
  809. }
  810. if (server_mode(options) && !we_are_hibernating() && !from_cache &&
  811. (can_complete_circuit || !any_predicted_circuits(now)))
  812. consider_testing_reachability(1, 1);
  813. }
  814. /** How long do we wait before killing OR connections with no circuits?
  815. * In Tor versions up to 0.2.1.25 and 0.2.2.12-alpha, we waited 15 minutes
  816. * before cancelling these connections, which caused fast relays to accrue
  817. * many many idle connections. Hopefully 3 minutes is low enough that
  818. * it kills most idle connections, without being so low that we cause
  819. * clients to bounce on and off.
  820. */
  821. #define IDLE_OR_CONN_TIMEOUT 180
  822. /** Perform regular maintenance tasks for a single connection. This
  823. * function gets run once per second per connection by run_scheduled_events.
  824. */
  825. static void
  826. run_connection_housekeeping(int i, time_t now)
  827. {
  828. cell_t cell;
  829. connection_t *conn = smartlist_get(connection_array, i);
  830. const or_options_t *options = get_options();
  831. or_connection_t *or_conn;
  832. int past_keepalive =
  833. now >= conn->timestamp_lastwritten + options->KeepalivePeriod;
  834. if (conn->outbuf && !connection_get_outbuf_len(conn) &&
  835. conn->type == CONN_TYPE_OR)
  836. TO_OR_CONN(conn)->timestamp_lastempty = now;
  837. if (conn->marked_for_close) {
  838. /* nothing to do here */
  839. return;
  840. }
  841. /* Expire any directory connections that haven't been active (sent
  842. * if a server or received if a client) for 5 min */
  843. if (conn->type == CONN_TYPE_DIR &&
  844. ((DIR_CONN_IS_SERVER(conn) &&
  845. conn->timestamp_lastwritten + DIR_CONN_MAX_STALL < now) ||
  846. (!DIR_CONN_IS_SERVER(conn) &&
  847. conn->timestamp_lastread + DIR_CONN_MAX_STALL < now))) {
  848. log_info(LD_DIR,"Expiring wedged directory conn (fd %d, purpose %d)",
  849. (int)conn->s, conn->purpose);
  850. /* This check is temporary; it's to let us know whether we should consider
  851. * parsing partial serverdesc responses. */
  852. if (conn->purpose == DIR_PURPOSE_FETCH_SERVERDESC &&
  853. connection_get_inbuf_len(conn) >= 1024) {
  854. log_info(LD_DIR,"Trying to extract information from wedged server desc "
  855. "download.");
  856. connection_dir_reached_eof(TO_DIR_CONN(conn));
  857. } else {
  858. connection_mark_for_close(conn);
  859. }
  860. return;
  861. }
  862. if (!connection_speaks_cells(conn))
  863. return; /* we're all done here, the rest is just for OR conns */
  864. /* If we haven't written to an OR connection for a while, then either nuke
  865. the connection or send a keepalive, depending. */
  866. or_conn = TO_OR_CONN(conn);
  867. #ifdef USE_BUFFEREVENTS
  868. tor_assert(conn->bufev);
  869. #else
  870. tor_assert(conn->outbuf);
  871. #endif
  872. if (or_conn->is_bad_for_new_circs && !or_conn->n_circuits) {
  873. /* It's bad for new circuits, and has no unmarked circuits on it:
  874. * mark it now. */
  875. log_info(LD_OR,
  876. "Expiring non-used OR connection to fd %d (%s:%d) [Too old].",
  877. (int)conn->s, conn->address, conn->port);
  878. if (conn->state == OR_CONN_STATE_CONNECTING)
  879. connection_or_connect_failed(TO_OR_CONN(conn),
  880. END_OR_CONN_REASON_TIMEOUT,
  881. "Tor gave up on the connection");
  882. connection_mark_and_flush(conn);
  883. } else if (!connection_state_is_open(conn)) {
  884. if (past_keepalive) {
  885. /* We never managed to actually get this connection open and happy. */
  886. log_info(LD_OR,"Expiring non-open OR connection to fd %d (%s:%d).",
  887. (int)conn->s,conn->address, conn->port);
  888. connection_mark_for_close(conn);
  889. }
  890. } else if (we_are_hibernating() && !or_conn->n_circuits &&
  891. !connection_get_outbuf_len(conn)) {
  892. /* We're hibernating, there's no circuits, and nothing to flush.*/
  893. log_info(LD_OR,"Expiring non-used OR connection to fd %d (%s:%d) "
  894. "[Hibernating or exiting].",
  895. (int)conn->s,conn->address, conn->port);
  896. connection_mark_and_flush(conn);
  897. } else if (!or_conn->n_circuits &&
  898. now >= or_conn->timestamp_last_added_nonpadding +
  899. IDLE_OR_CONN_TIMEOUT) {
  900. log_info(LD_OR,"Expiring non-used OR connection to fd %d (%s:%d) "
  901. "[idle %d].", (int)conn->s,conn->address, conn->port,
  902. (int)(now - or_conn->timestamp_last_added_nonpadding));
  903. connection_mark_for_close(conn);
  904. } else if (
  905. now >= or_conn->timestamp_lastempty + options->KeepalivePeriod*10 &&
  906. now >= conn->timestamp_lastwritten + options->KeepalivePeriod*10) {
  907. log_fn(LOG_PROTOCOL_WARN,LD_PROTOCOL,
  908. "Expiring stuck OR connection to fd %d (%s:%d). (%d bytes to "
  909. "flush; %d seconds since last write)",
  910. (int)conn->s, conn->address, conn->port,
  911. (int)connection_get_outbuf_len(conn),
  912. (int)(now-conn->timestamp_lastwritten));
  913. connection_mark_for_close(conn);
  914. } else if (past_keepalive && !connection_get_outbuf_len(conn)) {
  915. /* send a padding cell */
  916. log_fn(LOG_DEBUG,LD_OR,"Sending keepalive to (%s:%d)",
  917. conn->address, conn->port);
  918. memset(&cell,0,sizeof(cell_t));
  919. cell.command = CELL_PADDING;
  920. connection_or_write_cell_to_buf(&cell, or_conn);
  921. }
  922. }
  923. /** Honor a NEWNYM request: make future requests unlinkable to past
  924. * requests. */
  925. static void
  926. signewnym_impl(time_t now)
  927. {
  928. const or_options_t *options = get_options();
  929. if (!proxy_mode(options)) {
  930. log_info(LD_CONTROL, "Ignoring SIGNAL NEWNYM because client functionality "
  931. "is disabled.");
  932. return;
  933. }
  934. circuit_expire_all_dirty_circs();
  935. addressmap_clear_transient();
  936. rend_client_purge_state();
  937. time_of_last_signewnym = now;
  938. signewnym_is_pending = 0;
  939. ++newnym_epoch;
  940. control_event_signal(SIGNEWNYM);
  941. }
  942. /** Return the number of times that signewnym has been called. */
  943. unsigned
  944. get_signewnym_epoch(void)
  945. {
  946. return newnym_epoch;
  947. }
  948. /** Perform regular maintenance tasks. This function gets run once per
  949. * second by second_elapsed_callback().
  950. */
  951. static void
  952. run_scheduled_events(time_t now)
  953. {
  954. static time_t last_rotated_x509_certificate = 0;
  955. static time_t time_to_check_v3_certificate = 0;
  956. static time_t time_to_check_listeners = 0;
  957. static time_t time_to_check_descriptor = 0;
  958. static time_t time_to_check_ipaddress = 0;
  959. static time_t time_to_shrink_memory = 0;
  960. static time_t time_to_try_getting_descriptors = 0;
  961. static time_t time_to_reset_descriptor_failures = 0;
  962. static time_t time_to_add_entropy = 0;
  963. static time_t time_to_write_bridge_status_file = 0;
  964. static time_t time_to_downrate_stability = 0;
  965. static time_t time_to_save_stability = 0;
  966. static time_t time_to_clean_caches = 0;
  967. static time_t time_to_recheck_bandwidth = 0;
  968. static time_t time_to_check_for_expired_networkstatus = 0;
  969. static time_t time_to_write_stats_files = 0;
  970. static time_t time_to_write_bridge_stats = 0;
  971. static time_t time_to_check_port_forwarding = 0;
  972. static time_t time_to_launch_reachability_tests = 0;
  973. static int should_init_bridge_stats = 1;
  974. static time_t time_to_retry_dns_init = 0;
  975. static time_t time_to_next_heartbeat = 0;
  976. const or_options_t *options = get_options();
  977. int is_server = server_mode(options);
  978. int i;
  979. int have_dir_info;
  980. /** 0. See if we've been asked to shut down and our timeout has
  981. * expired; or if our bandwidth limits are exhausted and we
  982. * should hibernate; or if it's time to wake up from hibernation.
  983. */
  984. consider_hibernation(now);
  985. #if 0
  986. {
  987. static time_t nl_check_time = 0;
  988. if (nl_check_time <= now) {
  989. nodelist_assert_ok();
  990. nl_check_time = now + 30;
  991. }
  992. }
  993. #endif
  994. /* 0b. If we've deferred a signewnym, make sure it gets handled
  995. * eventually. */
  996. if (signewnym_is_pending &&
  997. time_of_last_signewnym + MAX_SIGNEWNYM_RATE <= now) {
  998. log(LOG_INFO, LD_CONTROL, "Honoring delayed NEWNYM request");
  999. signewnym_impl(now);
  1000. }
  1001. /* 0c. If we've deferred log messages for the controller, handle them now */
  1002. flush_pending_log_callbacks();
  1003. /** 1a. Every MIN_ONION_KEY_LIFETIME seconds, rotate the onion keys,
  1004. * shut down and restart all cpuworkers, and update the directory if
  1005. * necessary.
  1006. */
  1007. if (is_server &&
  1008. get_onion_key_set_at()+MIN_ONION_KEY_LIFETIME < now) {
  1009. log_info(LD_GENERAL,"Rotating onion key.");
  1010. rotate_onion_key();
  1011. cpuworkers_rotate();
  1012. if (router_rebuild_descriptor(1)<0) {
  1013. log_info(LD_CONFIG, "Couldn't rebuild router descriptor");
  1014. }
  1015. if (advertised_server_mode())
  1016. router_upload_dir_desc_to_dirservers(0);
  1017. }
  1018. if (time_to_try_getting_descriptors < now) {
  1019. update_all_descriptor_downloads(now);
  1020. update_extrainfo_downloads(now);
  1021. if (router_have_minimum_dir_info())
  1022. time_to_try_getting_descriptors = now + LAZY_DESCRIPTOR_RETRY_INTERVAL;
  1023. else
  1024. time_to_try_getting_descriptors = now + GREEDY_DESCRIPTOR_RETRY_INTERVAL;
  1025. }
  1026. if (time_to_reset_descriptor_failures < now) {
  1027. router_reset_descriptor_download_failures();
  1028. time_to_reset_descriptor_failures =
  1029. now + DESCRIPTOR_FAILURE_RESET_INTERVAL;
  1030. }
  1031. if (options->UseBridges)
  1032. fetch_bridge_descriptors(options, now);
  1033. /** 1b. Every MAX_SSL_KEY_LIFETIME seconds, we change our TLS context. */
  1034. if (!last_rotated_x509_certificate)
  1035. last_rotated_x509_certificate = now;
  1036. if (last_rotated_x509_certificate+MAX_SSL_KEY_LIFETIME < now) {
  1037. log_info(LD_GENERAL,"Rotating tls context.");
  1038. if (tor_tls_context_init(public_server_mode(options),
  1039. get_tlsclient_identity_key(),
  1040. is_server ? get_server_identity_key() : NULL,
  1041. MAX_SSL_KEY_LIFETIME) < 0) {
  1042. log_warn(LD_BUG, "Error reinitializing TLS context");
  1043. /* XXX is it a bug here, that we just keep going? -RD */
  1044. }
  1045. last_rotated_x509_certificate = now;
  1046. /* We also make sure to rotate the TLS connections themselves if they've
  1047. * been up for too long -- but that's done via is_bad_for_new_circs in
  1048. * connection_run_housekeeping() above. */
  1049. }
  1050. if (time_to_add_entropy < now) {
  1051. if (time_to_add_entropy) {
  1052. /* We already seeded once, so don't die on failure. */
  1053. crypto_seed_rng(0);
  1054. }
  1055. /** How often do we add more entropy to OpenSSL's RNG pool? */
  1056. #define ENTROPY_INTERVAL (60*60)
  1057. time_to_add_entropy = now + ENTROPY_INTERVAL;
  1058. }
  1059. /** 1c. If we have to change the accounting interval or record
  1060. * bandwidth used in this accounting interval, do so. */
  1061. if (accounting_is_enabled(options))
  1062. accounting_run_housekeeping(now);
  1063. if (time_to_launch_reachability_tests < now &&
  1064. (authdir_mode_tests_reachability(options)) &&
  1065. !we_are_hibernating()) {
  1066. time_to_launch_reachability_tests = now + REACHABILITY_TEST_INTERVAL;
  1067. /* try to determine reachability of the other Tor relays */
  1068. dirserv_test_reachability(now);
  1069. }
  1070. /** 1d. Periodically, we discount older stability information so that new
  1071. * stability info counts more, and save the stability information to disk as
  1072. * appropriate. */
  1073. if (time_to_downrate_stability < now)
  1074. time_to_downrate_stability = rep_hist_downrate_old_runs(now);
  1075. if (authdir_mode_tests_reachability(options)) {
  1076. if (time_to_save_stability < now) {
  1077. if (time_to_save_stability && rep_hist_record_mtbf_data(now, 1)<0) {
  1078. log_warn(LD_GENERAL, "Couldn't store mtbf data.");
  1079. }
  1080. #define SAVE_STABILITY_INTERVAL (30*60)
  1081. time_to_save_stability = now + SAVE_STABILITY_INTERVAL;
  1082. }
  1083. }
  1084. /* 1e. Periodically, if we're a v3 authority, we check whether our cert is
  1085. * close to expiring and warn the admin if it is. */
  1086. if (time_to_check_v3_certificate < now) {
  1087. v3_authority_check_key_expiry();
  1088. #define CHECK_V3_CERTIFICATE_INTERVAL (5*60)
  1089. time_to_check_v3_certificate = now + CHECK_V3_CERTIFICATE_INTERVAL;
  1090. }
  1091. /* 1f. Check whether our networkstatus has expired.
  1092. */
  1093. if (time_to_check_for_expired_networkstatus < now) {
  1094. networkstatus_t *ns = networkstatus_get_latest_consensus();
  1095. /*XXXX RD: This value needs to be the same as REASONABLY_LIVE_TIME in
  1096. * networkstatus_get_reasonably_live_consensus(), but that value is way
  1097. * way too high. Arma: is the bridge issue there resolved yet? -NM */
  1098. #define NS_EXPIRY_SLOP (24*60*60)
  1099. if (ns && ns->valid_until < now+NS_EXPIRY_SLOP &&
  1100. router_have_minimum_dir_info()) {
  1101. router_dir_info_changed();
  1102. }
  1103. #define CHECK_EXPIRED_NS_INTERVAL (2*60)
  1104. time_to_check_for_expired_networkstatus = now + CHECK_EXPIRED_NS_INTERVAL;
  1105. }
  1106. /* 1g. Check whether we should write statistics to disk.
  1107. */
  1108. if (time_to_write_stats_files < now) {
  1109. #define CHECK_WRITE_STATS_INTERVAL (60*60)
  1110. time_t next_time_to_write_stats_files = (time_to_write_stats_files > 0 ?
  1111. time_to_write_stats_files : now) + CHECK_WRITE_STATS_INTERVAL;
  1112. if (options->CellStatistics) {
  1113. time_t next_write =
  1114. rep_hist_buffer_stats_write(time_to_write_stats_files);
  1115. if (next_write && next_write < next_time_to_write_stats_files)
  1116. next_time_to_write_stats_files = next_write;
  1117. }
  1118. if (options->DirReqStatistics) {
  1119. time_t next_write = geoip_dirreq_stats_write(time_to_write_stats_files);
  1120. if (next_write && next_write < next_time_to_write_stats_files)
  1121. next_time_to_write_stats_files = next_write;
  1122. }
  1123. if (options->EntryStatistics) {
  1124. time_t next_write = geoip_entry_stats_write(time_to_write_stats_files);
  1125. if (next_write && next_write < next_time_to_write_stats_files)
  1126. next_time_to_write_stats_files = next_write;
  1127. }
  1128. if (options->ExitPortStatistics) {
  1129. time_t next_write = rep_hist_exit_stats_write(time_to_write_stats_files);
  1130. if (next_write && next_write < next_time_to_write_stats_files)
  1131. next_time_to_write_stats_files = next_write;
  1132. }
  1133. if (options->ConnDirectionStatistics) {
  1134. time_t next_write = rep_hist_conn_stats_write(time_to_write_stats_files);
  1135. if (next_write && next_write < next_time_to_write_stats_files)
  1136. next_time_to_write_stats_files = next_write;
  1137. }
  1138. time_to_write_stats_files = next_time_to_write_stats_files;
  1139. }
  1140. /* 1h. Check whether we should write bridge statistics to disk.
  1141. */
  1142. if (should_record_bridge_info(options)) {
  1143. if (time_to_write_bridge_stats < now) {
  1144. if (should_init_bridge_stats) {
  1145. /* (Re-)initialize bridge statistics. */
  1146. geoip_bridge_stats_init(now);
  1147. time_to_write_bridge_stats = now + WRITE_STATS_INTERVAL;
  1148. should_init_bridge_stats = 0;
  1149. } else {
  1150. /* Possibly write bridge statistics to disk and ask when to write
  1151. * them next time. */
  1152. time_to_write_bridge_stats = geoip_bridge_stats_write(
  1153. time_to_write_bridge_stats);
  1154. }
  1155. }
  1156. } else if (!should_init_bridge_stats) {
  1157. /* Bridge mode was turned off. Ensure that stats are re-initialized
  1158. * next time bridge mode is turned on. */
  1159. should_init_bridge_stats = 1;
  1160. }
  1161. /* Remove old information from rephist and the rend cache. */
  1162. if (time_to_clean_caches < now) {
  1163. rep_history_clean(now - options->RephistTrackTime);
  1164. rend_cache_clean(now);
  1165. rend_cache_clean_v2_descs_as_dir(now);
  1166. microdesc_cache_rebuild(NULL, 0);
  1167. #define CLEAN_CACHES_INTERVAL (30*60)
  1168. time_to_clean_caches = now + CLEAN_CACHES_INTERVAL;
  1169. }
  1170. #define RETRY_DNS_INTERVAL (10*60)
  1171. /* If we're a server and initializing dns failed, retry periodically. */
  1172. if (time_to_retry_dns_init < now) {
  1173. time_to_retry_dns_init = now + RETRY_DNS_INTERVAL;
  1174. if (is_server && has_dns_init_failed())
  1175. dns_init();
  1176. }
  1177. /** 2. Periodically, we consider force-uploading our descriptor
  1178. * (if we've passed our internal checks). */
  1179. /** How often do we check whether part of our router info has changed in a way
  1180. * that would require an upload? */
  1181. #define CHECK_DESCRIPTOR_INTERVAL (60)
  1182. /** How often do we (as a router) check whether our IP address has changed? */
  1183. #define CHECK_IPADDRESS_INTERVAL (15*60)
  1184. /* 2b. Once per minute, regenerate and upload the descriptor if the old
  1185. * one is inaccurate. */
  1186. if (time_to_check_descriptor < now) {
  1187. static int dirport_reachability_count = 0;
  1188. time_to_check_descriptor = now + CHECK_DESCRIPTOR_INTERVAL;
  1189. check_descriptor_bandwidth_changed(now);
  1190. if (time_to_check_ipaddress < now) {
  1191. time_to_check_ipaddress = now + CHECK_IPADDRESS_INTERVAL;
  1192. check_descriptor_ipaddress_changed(now);
  1193. }
  1194. /** If our router descriptor ever goes this long without being regenerated
  1195. * because something changed, we force an immediate regenerate-and-upload. */
  1196. #define FORCE_REGENERATE_DESCRIPTOR_INTERVAL (18*60*60)
  1197. mark_my_descriptor_dirty_if_older_than(
  1198. now - FORCE_REGENERATE_DESCRIPTOR_INTERVAL);
  1199. consider_publishable_server(0);
  1200. /* also, check religiously for reachability, if it's within the first
  1201. * 20 minutes of our uptime. */
  1202. if (is_server &&
  1203. (can_complete_circuit || !any_predicted_circuits(now)) &&
  1204. !we_are_hibernating()) {
  1205. if (stats_n_seconds_working < TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT) {
  1206. consider_testing_reachability(1, dirport_reachability_count==0);
  1207. if (++dirport_reachability_count > 5)
  1208. dirport_reachability_count = 0;
  1209. } else if (time_to_recheck_bandwidth < now) {
  1210. /* If we haven't checked for 12 hours and our bandwidth estimate is
  1211. * low, do another bandwidth test. This is especially important for
  1212. * bridges, since they might go long periods without much use. */
  1213. const routerinfo_t *me = router_get_my_routerinfo();
  1214. if (time_to_recheck_bandwidth && me &&
  1215. me->bandwidthcapacity < me->bandwidthrate &&
  1216. me->bandwidthcapacity < 51200) {
  1217. reset_bandwidth_test();
  1218. }
  1219. #define BANDWIDTH_RECHECK_INTERVAL (12*60*60)
  1220. time_to_recheck_bandwidth = now + BANDWIDTH_RECHECK_INTERVAL;
  1221. }
  1222. }
  1223. /* If any networkstatus documents are no longer recent, we need to
  1224. * update all the descriptors' running status. */
  1225. /* purge obsolete entries */
  1226. networkstatus_v2_list_clean(now);
  1227. /* Remove dead routers. */
  1228. routerlist_remove_old_routers();
  1229. /* Also, once per minute, check whether we want to download any
  1230. * networkstatus documents.
  1231. */
  1232. update_networkstatus_downloads(now);
  1233. }
  1234. /** 2c. Let directory voting happen. */
  1235. if (authdir_mode_v3(options))
  1236. dirvote_act(options, now);
  1237. /** 3a. Every second, we examine pending circuits and prune the
  1238. * ones which have been pending for more than a few seconds.
  1239. * We do this before step 4, so it can try building more if
  1240. * it's not comfortable with the number of available circuits.
  1241. */
  1242. /* XXXX022 If our circuit build timeout is much lower than a second, maybe
  1243. * we should do this more often? -NM
  1244. * It can't be lower than 1.5 seconds currently; see
  1245. * circuit_build_times_min_timeout(). -RD
  1246. */
  1247. circuit_expire_building();
  1248. /** 3b. Also look at pending streams and prune the ones that 'began'
  1249. * a long time ago but haven't gotten a 'connected' yet.
  1250. * Do this before step 4, so we can put them back into pending
  1251. * state to be picked up by the new circuit.
  1252. */
  1253. connection_ap_expire_beginning();
  1254. /** 3c. And expire connections that we've held open for too long.
  1255. */
  1256. connection_expire_held_open();
  1257. /** 3d. And every 60 seconds, we relaunch listeners if any died. */
  1258. if (!we_are_hibernating() && time_to_check_listeners < now) {
  1259. retry_all_listeners(NULL, NULL);
  1260. time_to_check_listeners = now+60;
  1261. }
  1262. /** 4. Every second, we try a new circuit if there are no valid
  1263. * circuits. Every NewCircuitPeriod seconds, we expire circuits
  1264. * that became dirty more than MaxCircuitDirtiness seconds ago,
  1265. * and we make a new circ if there are no clean circuits.
  1266. */
  1267. have_dir_info = router_have_minimum_dir_info();
  1268. if (have_dir_info && !we_are_hibernating())
  1269. circuit_build_needed_circs(now);
  1270. /* every 10 seconds, but not at the same second as other such events */
  1271. if (now % 10 == 5)
  1272. circuit_expire_old_circuits_serverside(now);
  1273. /** 5. We do housekeeping for each connection... */
  1274. connection_or_set_bad_connections(NULL, 0);
  1275. for (i=0;i<smartlist_len(connection_array);i++) {
  1276. run_connection_housekeeping(i, now);
  1277. }
  1278. if (time_to_shrink_memory < now) {
  1279. SMARTLIST_FOREACH(connection_array, connection_t *, conn, {
  1280. if (conn->outbuf)
  1281. buf_shrink(conn->outbuf);
  1282. if (conn->inbuf)
  1283. buf_shrink(conn->inbuf);
  1284. });
  1285. clean_cell_pool();
  1286. buf_shrink_freelists(0);
  1287. /** How often do we check buffers and pools for empty space that can be
  1288. * deallocated? */
  1289. #define MEM_SHRINK_INTERVAL (60)
  1290. time_to_shrink_memory = now + MEM_SHRINK_INTERVAL;
  1291. }
  1292. /** 6. And remove any marked circuits... */
  1293. circuit_close_all_marked();
  1294. /** 7. And upload service descriptors if necessary. */
  1295. if (can_complete_circuit && !we_are_hibernating()) {
  1296. rend_consider_services_upload(now);
  1297. rend_consider_descriptor_republication();
  1298. }
  1299. /** 8. and blow away any connections that need to die. have to do this now,
  1300. * because if we marked a conn for close and left its socket -1, then
  1301. * we'll pass it to poll/select and bad things will happen.
  1302. */
  1303. close_closeable_connections();
  1304. /** 8b. And if anything in our state is ready to get flushed to disk, we
  1305. * flush it. */
  1306. or_state_save(now);
  1307. /** 9. and if we're a server, check whether our DNS is telling stories to
  1308. * us. */
  1309. if (is_server && time_to_check_for_correct_dns < now) {
  1310. if (!time_to_check_for_correct_dns) {
  1311. time_to_check_for_correct_dns = now + 60 + crypto_rand_int(120);
  1312. } else {
  1313. dns_launch_correctness_checks();
  1314. time_to_check_for_correct_dns = now + 12*3600 +
  1315. crypto_rand_int(12*3600);
  1316. }
  1317. }
  1318. /** 10b. write bridge networkstatus file to disk */
  1319. if (options->BridgeAuthoritativeDir &&
  1320. time_to_write_bridge_status_file < now) {
  1321. networkstatus_dump_bridge_status_to_file(now);
  1322. #define BRIDGE_STATUSFILE_INTERVAL (30*60)
  1323. time_to_write_bridge_status_file = now+BRIDGE_STATUSFILE_INTERVAL;
  1324. }
  1325. if (time_to_check_port_forwarding < now &&
  1326. options->PortForwarding &&
  1327. is_server) {
  1328. #define PORT_FORWARDING_CHECK_INTERVAL 5
  1329. tor_check_port_forwarding(options->PortForwardingHelper,
  1330. options->DirPort,
  1331. options->ORPort,
  1332. now);
  1333. time_to_check_port_forwarding = now+PORT_FORWARDING_CHECK_INTERVAL;
  1334. }
  1335. /** 11. write the heartbeat message */
  1336. if (options->HeartbeatPeriod &&
  1337. time_to_next_heartbeat < now) {
  1338. log_heartbeat(now);
  1339. time_to_next_heartbeat = now+options->HeartbeatPeriod;
  1340. }
  1341. }
  1342. /** Timer: used to invoke second_elapsed_callback() once per second. */
  1343. static periodic_timer_t *second_timer = NULL;
  1344. /** Number of libevent errors in the last second: we die if we get too many. */
  1345. static int n_libevent_errors = 0;
  1346. /** Libevent callback: invoked once every second. */
  1347. static void
  1348. second_elapsed_callback(periodic_timer_t *timer, void *arg)
  1349. {
  1350. /* XXXX This could be sensibly refactored into multiple callbacks, and we
  1351. * could use Libevent's timers for this rather than checking the current
  1352. * time against a bunch of timeouts every second. */
  1353. static time_t current_second = 0;
  1354. time_t now;
  1355. size_t bytes_written;
  1356. size_t bytes_read;
  1357. int seconds_elapsed;
  1358. #ifdef USE_BUFFEREVENTS
  1359. uint64_t cur_read,cur_written;
  1360. #endif
  1361. const or_options_t *options = get_options();
  1362. (void)timer;
  1363. (void)arg;
  1364. n_libevent_errors = 0;
  1365. /* log_notice(LD_GENERAL, "Tick."); */
  1366. now = time(NULL);
  1367. update_approx_time(now);
  1368. /* the second has rolled over. check more stuff. */
  1369. seconds_elapsed = current_second ? (int)(now - current_second) : 0;
  1370. #ifdef USE_BUFFEREVENTS
  1371. connection_get_rate_limit_totals(&cur_read, &cur_written);
  1372. bytes_written = (size_t)(cur_written - stats_prev_n_written);
  1373. bytes_read = (size_t)(cur_read - stats_prev_n_read);
  1374. #else
  1375. bytes_written = stats_prev_global_write_bucket - global_write_bucket;
  1376. bytes_read = stats_prev_global_read_bucket - global_read_bucket;
  1377. #endif
  1378. stats_n_bytes_read += bytes_read;
  1379. stats_n_bytes_written += bytes_written;
  1380. if (accounting_is_enabled(options) && seconds_elapsed >= 0)
  1381. accounting_add_bytes(bytes_read, bytes_written, seconds_elapsed);
  1382. control_event_bandwidth_used((uint32_t)bytes_read,(uint32_t)bytes_written);
  1383. control_event_stream_bandwidth_used();
  1384. if (seconds_elapsed > 0)
  1385. connection_bucket_refill(seconds_elapsed, now);
  1386. #ifdef USE_BUFFEREVENTS
  1387. stats_prev_n_written = cur_written;
  1388. stats_prev_n_read = cur_read;
  1389. #else
  1390. stats_prev_global_read_bucket = global_read_bucket;
  1391. stats_prev_global_write_bucket = global_write_bucket;
  1392. #endif
  1393. if (server_mode(options) &&
  1394. !we_are_hibernating() &&
  1395. seconds_elapsed > 0 &&
  1396. can_complete_circuit &&
  1397. stats_n_seconds_working / TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT !=
  1398. (stats_n_seconds_working+seconds_elapsed) /
  1399. TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT) {
  1400. /* every 20 minutes, check and complain if necessary */
  1401. const routerinfo_t *me = router_get_my_routerinfo();
  1402. if (me && !check_whether_orport_reachable()) {
  1403. log_warn(LD_CONFIG,"Your server (%s:%d) has not managed to confirm that "
  1404. "its ORPort is reachable. Please check your firewalls, ports, "
  1405. "address, /etc/hosts file, etc.",
  1406. me->address, me->or_port);
  1407. control_event_server_status(LOG_WARN,
  1408. "REACHABILITY_FAILED ORADDRESS=%s:%d",
  1409. me->address, me->or_port);
  1410. }
  1411. if (me && !check_whether_dirport_reachable()) {
  1412. log_warn(LD_CONFIG,
  1413. "Your server (%s:%d) has not managed to confirm that its "
  1414. "DirPort is reachable. Please check your firewalls, ports, "
  1415. "address, /etc/hosts file, etc.",
  1416. me->address, me->dir_port);
  1417. control_event_server_status(LOG_WARN,
  1418. "REACHABILITY_FAILED DIRADDRESS=%s:%d",
  1419. me->address, me->dir_port);
  1420. }
  1421. }
  1422. /** If more than this many seconds have elapsed, probably the clock
  1423. * jumped: doesn't count. */
  1424. #define NUM_JUMPED_SECONDS_BEFORE_WARN 100
  1425. if (seconds_elapsed < -NUM_JUMPED_SECONDS_BEFORE_WARN ||
  1426. seconds_elapsed >= NUM_JUMPED_SECONDS_BEFORE_WARN) {
  1427. circuit_note_clock_jumped(seconds_elapsed);
  1428. /* XXX if the time jumps *back* many months, do our events in
  1429. * run_scheduled_events() recover? I don't think they do. -RD */
  1430. } else if (seconds_elapsed > 0)
  1431. stats_n_seconds_working += seconds_elapsed;
  1432. run_scheduled_events(now);
  1433. current_second = now; /* remember which second it is, for next time */
  1434. }
  1435. #ifndef MS_WINDOWS
  1436. /** Called when a possibly ignorable libevent error occurs; ensures that we
  1437. * don't get into an infinite loop by ignoring too many errors from
  1438. * libevent. */
  1439. static int
  1440. got_libevent_error(void)
  1441. {
  1442. if (++n_libevent_errors > 8) {
  1443. log_err(LD_NET, "Too many libevent errors in one second; dying");
  1444. return -1;
  1445. }
  1446. return 0;
  1447. }
  1448. #endif
  1449. #define UPTIME_CUTOFF_FOR_NEW_BANDWIDTH_TEST (6*60*60)
  1450. /** Called when our IP address seems to have changed. <b>at_interface</b>
  1451. * should be true if we detected a change in our interface, and false if we
  1452. * detected a change in our published address. */
  1453. void
  1454. ip_address_changed(int at_interface)
  1455. {
  1456. int server = server_mode(get_options());
  1457. if (at_interface) {
  1458. if (! server) {
  1459. /* Okay, change our keys. */
  1460. init_keys();
  1461. }
  1462. } else {
  1463. if (server) {
  1464. if (stats_n_seconds_working > UPTIME_CUTOFF_FOR_NEW_BANDWIDTH_TEST)
  1465. reset_bandwidth_test();
  1466. stats_n_seconds_working = 0;
  1467. router_reset_reachability();
  1468. mark_my_descriptor_dirty("IP address changed");
  1469. }
  1470. }
  1471. dns_servers_relaunch_checks();
  1472. }
  1473. /** Forget what we've learned about the correctness of our DNS servers, and
  1474. * start learning again. */
  1475. void
  1476. dns_servers_relaunch_checks(void)
  1477. {
  1478. if (server_mode(get_options())) {
  1479. dns_reset_correctness_checks();
  1480. time_to_check_for_correct_dns = 0;
  1481. }
  1482. }
  1483. /** Called when we get a SIGHUP: reload configuration files and keys,
  1484. * retry all connections, and so on. */
  1485. static int
  1486. do_hup(void)
  1487. {
  1488. const or_options_t *options = get_options();
  1489. #ifdef USE_DMALLOC
  1490. dmalloc_log_stats();
  1491. dmalloc_log_changed(0, 1, 0, 0);
  1492. #endif
  1493. log_notice(LD_GENERAL,"Received reload signal (hup). Reloading config and "
  1494. "resetting internal state.");
  1495. if (accounting_is_enabled(options))
  1496. accounting_record_bandwidth_usage(time(NULL), get_or_state());
  1497. router_reset_warnings();
  1498. routerlist_reset_warnings();
  1499. /* first, reload config variables, in case they've changed */
  1500. if (options->ReloadTorrcOnSIGHUP) {
  1501. /* no need to provide argc/v, they've been cached in init_from_config */
  1502. if (options_init_from_torrc(0, NULL) < 0) {
  1503. log_err(LD_CONFIG,"Reading config failed--see warnings above. "
  1504. "For usage, try -h.");
  1505. return -1;
  1506. }
  1507. options = get_options(); /* they have changed now */
  1508. } else {
  1509. log_notice(LD_GENERAL, "Not reloading config file: the controller told "
  1510. "us not to.");
  1511. }
  1512. if (authdir_mode_handles_descs(options, -1)) {
  1513. /* reload the approved-routers file */
  1514. if (dirserv_load_fingerprint_file() < 0) {
  1515. /* warnings are logged from dirserv_load_fingerprint_file() directly */
  1516. log_info(LD_GENERAL, "Error reloading fingerprints. "
  1517. "Continuing with old list.");
  1518. }
  1519. }
  1520. /* Rotate away from the old dirty circuits. This has to be done
  1521. * after we've read the new options, but before we start using
  1522. * circuits for directory fetches. */
  1523. circuit_expire_all_dirty_circs();
  1524. /* retry appropriate downloads */
  1525. router_reset_status_download_failures();
  1526. router_reset_descriptor_download_failures();
  1527. update_networkstatus_downloads(time(NULL));
  1528. /* We'll retry routerstatus downloads in about 10 seconds; no need to
  1529. * force a retry there. */
  1530. if (server_mode(options)) {
  1531. /* Restart cpuworker and dnsworker processes, so they get up-to-date
  1532. * configuration options. */
  1533. cpuworkers_rotate();
  1534. dns_reset();
  1535. }
  1536. return 0;
  1537. }
  1538. /** Tor main loop. */
  1539. /* static */ int
  1540. do_main_loop(void)
  1541. {
  1542. int loop_result;
  1543. time_t now;
  1544. /* initialize dns resolve map, spawn workers if needed */
  1545. if (dns_init() < 0) {
  1546. if (get_options()->ServerDNSAllowBrokenConfig)
  1547. log_warn(LD_GENERAL, "Couldn't set up any working nameservers. "
  1548. "Network not up yet? Will try again soon.");
  1549. else {
  1550. log_err(LD_GENERAL,"Error initializing dns subsystem; exiting. To "
  1551. "retry instead, set the ServerDNSAllowBrokenResolvConf option.");
  1552. }
  1553. }
  1554. handle_signals(1);
  1555. /* load the private keys, if we're supposed to have them, and set up the
  1556. * TLS context. */
  1557. if (! client_identity_key_is_set()) {
  1558. if (init_keys() < 0) {
  1559. log_err(LD_BUG,"Error initializing keys; exiting");
  1560. return -1;
  1561. }
  1562. }
  1563. /* Set up the packed_cell_t memory pool. */
  1564. init_cell_pool();
  1565. /* Set up our buckets */
  1566. connection_bucket_init();
  1567. #ifndef USE_BUFFEREVENTS
  1568. stats_prev_global_read_bucket = global_read_bucket;
  1569. stats_prev_global_write_bucket = global_write_bucket;
  1570. #endif
  1571. /* initialize the bootstrap status events to know we're starting up */
  1572. control_event_bootstrap(BOOTSTRAP_STATUS_STARTING, 0);
  1573. if (trusted_dirs_reload_certs()) {
  1574. log_warn(LD_DIR,
  1575. "Couldn't load all cached v3 certificates. Starting anyway.");
  1576. }
  1577. if (router_reload_v2_networkstatus()) {
  1578. return -1;
  1579. }
  1580. if (router_reload_consensus_networkstatus()) {
  1581. return -1;
  1582. }
  1583. /* load the routers file, or assign the defaults. */
  1584. if (router_reload_router_list()) {
  1585. return -1;
  1586. }
  1587. /* load the networkstatuses. (This launches a download for new routers as
  1588. * appropriate.)
  1589. */
  1590. now = time(NULL);
  1591. directory_info_has_arrived(now, 1);
  1592. if (server_mode(get_options())) {
  1593. /* launch cpuworkers. Need to do this *after* we've read the onion key. */
  1594. cpu_init();
  1595. }
  1596. /* set up once-a-second callback. */
  1597. if (! second_timer) {
  1598. struct timeval one_second;
  1599. one_second.tv_sec = 1;
  1600. one_second.tv_usec = 0;
  1601. second_timer = periodic_timer_new(tor_libevent_get_base(),
  1602. &one_second,
  1603. second_elapsed_callback,
  1604. NULL);
  1605. tor_assert(second_timer);
  1606. }
  1607. for (;;) {
  1608. if (nt_service_is_stopping())
  1609. return 0;
  1610. #ifndef MS_WINDOWS
  1611. /* Make it easier to tell whether libevent failure is our fault or not. */
  1612. errno = 0;
  1613. #endif
  1614. /* All active linked conns should get their read events activated. */
  1615. SMARTLIST_FOREACH(active_linked_connection_lst, connection_t *, conn,
  1616. event_active(conn->read_event, EV_READ, 1));
  1617. called_loop_once = smartlist_len(active_linked_connection_lst) ? 1 : 0;
  1618. update_approx_time(time(NULL));
  1619. /* poll until we have an event, or the second ends, or until we have
  1620. * some active linked connections to trigger events for. */
  1621. loop_result = event_base_loop(tor_libevent_get_base(),
  1622. called_loop_once ? EVLOOP_ONCE : 0);
  1623. /* let catch() handle things like ^c, and otherwise don't worry about it */
  1624. if (loop_result < 0) {
  1625. int e = tor_socket_errno(-1);
  1626. /* let the program survive things like ^z */
  1627. if (e != EINTR && !ERRNO_IS_EINPROGRESS(e)) {
  1628. log_err(LD_NET,"libevent call with %s failed: %s [%d]",
  1629. tor_libevent_get_method(), tor_socket_strerror(e), e);
  1630. return -1;
  1631. #ifndef MS_WINDOWS
  1632. } else if (e == EINVAL) {
  1633. log_warn(LD_NET, "EINVAL from libevent: should you upgrade libevent?");
  1634. if (got_libevent_error())
  1635. return -1;
  1636. #endif
  1637. } else {
  1638. if (ERRNO_IS_EINPROGRESS(e))
  1639. log_warn(LD_BUG,
  1640. "libevent call returned EINPROGRESS? Please report.");
  1641. log_debug(LD_NET,"libevent call interrupted.");
  1642. /* You can't trust the results of this poll(). Go back to the
  1643. * top of the big for loop. */
  1644. continue;
  1645. }
  1646. }
  1647. }
  1648. }
  1649. #ifndef MS_WINDOWS /* Only called when we're willing to use signals */
  1650. /** Libevent callback: invoked when we get a signal.
  1651. */
  1652. static void
  1653. signal_callback(int fd, short events, void *arg)
  1654. {
  1655. uintptr_t sig = (uintptr_t)arg;
  1656. (void)fd;
  1657. (void)events;
  1658. process_signal(sig);
  1659. }
  1660. #endif
  1661. /** Do the work of acting on a signal received in <b>sig</b> */
  1662. void
  1663. process_signal(uintptr_t sig)
  1664. {
  1665. switch (sig)
  1666. {
  1667. case SIGTERM:
  1668. log_notice(LD_GENERAL,"Catching signal TERM, exiting cleanly.");
  1669. tor_cleanup();
  1670. exit(0);
  1671. break;
  1672. case SIGINT:
  1673. if (!server_mode(get_options())) { /* do it now */
  1674. log_notice(LD_GENERAL,"Interrupt: exiting cleanly.");
  1675. tor_cleanup();
  1676. exit(0);
  1677. }
  1678. hibernate_begin_shutdown();
  1679. break;
  1680. #ifdef SIGPIPE
  1681. case SIGPIPE:
  1682. log_debug(LD_GENERAL,"Caught SIGPIPE. Ignoring.");
  1683. break;
  1684. #endif
  1685. case SIGUSR1:
  1686. /* prefer to log it at INFO, but make sure we always see it */
  1687. dumpstats(get_min_log_level()<LOG_INFO ? get_min_log_level() : LOG_INFO);
  1688. control_event_signal(sig);
  1689. break;
  1690. case SIGUSR2:
  1691. switch_logs_debug();
  1692. log_debug(LD_GENERAL,"Caught USR2, going to loglevel debug. "
  1693. "Send HUP to change back.");
  1694. control_event_signal(sig);
  1695. break;
  1696. case SIGHUP:
  1697. if (do_hup() < 0) {
  1698. log_warn(LD_CONFIG,"Restart failed (config error?). Exiting.");
  1699. tor_cleanup();
  1700. exit(1);
  1701. }
  1702. control_event_signal(sig);
  1703. break;
  1704. #ifdef SIGCHLD
  1705. case SIGCHLD:
  1706. while (waitpid(-1,NULL,WNOHANG) > 0) ; /* keep reaping until no more
  1707. zombies */
  1708. break;
  1709. #endif
  1710. case SIGNEWNYM: {
  1711. time_t now = time(NULL);
  1712. if (time_of_last_signewnym + MAX_SIGNEWNYM_RATE > now) {
  1713. signewnym_is_pending = 1;
  1714. log(LOG_NOTICE, LD_CONTROL,
  1715. "Rate limiting NEWNYM request: delaying by %d second(s)",
  1716. (int)(MAX_SIGNEWNYM_RATE+time_of_last_signewnym-now));
  1717. } else {
  1718. signewnym_impl(now);
  1719. }
  1720. break;
  1721. }
  1722. case SIGCLEARDNSCACHE:
  1723. addressmap_clear_transient();
  1724. control_event_signal(sig);
  1725. break;
  1726. }
  1727. }
  1728. /** Returns Tor's uptime. */
  1729. long
  1730. get_uptime(void)
  1731. {
  1732. return stats_n_seconds_working;
  1733. }
  1734. extern uint64_t rephist_total_alloc;
  1735. extern uint32_t rephist_total_num;
  1736. /**
  1737. * Write current memory usage information to the log.
  1738. */
  1739. static void
  1740. dumpmemusage(int severity)
  1741. {
  1742. connection_dump_buffer_mem_stats(severity);
  1743. log(severity, LD_GENERAL, "In rephist: "U64_FORMAT" used by %d Tors.",
  1744. U64_PRINTF_ARG(rephist_total_alloc), rephist_total_num);
  1745. dump_routerlist_mem_usage(severity);
  1746. dump_cell_pool_usage(severity);
  1747. dump_dns_mem_usage(severity);
  1748. buf_dump_freelist_sizes(severity);
  1749. tor_log_mallinfo(severity);
  1750. }
  1751. /** Write all statistics to the log, with log level <b>severity</b>. Called
  1752. * in response to a SIGUSR1. */
  1753. static void
  1754. dumpstats(int severity)
  1755. {
  1756. time_t now = time(NULL);
  1757. time_t elapsed;
  1758. size_t rbuf_cap, wbuf_cap, rbuf_len, wbuf_len;
  1759. log(severity, LD_GENERAL, "Dumping stats:");
  1760. SMARTLIST_FOREACH(connection_array, connection_t *, conn,
  1761. {
  1762. int i = conn_sl_idx;
  1763. log(severity, LD_GENERAL,
  1764. "Conn %d (socket %d) type %d (%s), state %d (%s), created %d secs ago",
  1765. i, (int)conn->s, conn->type, conn_type_to_string(conn->type),
  1766. conn->state, conn_state_to_string(conn->type, conn->state),
  1767. (int)(now - conn->timestamp_created));
  1768. if (!connection_is_listener(conn)) {
  1769. log(severity,LD_GENERAL,
  1770. "Conn %d is to %s:%d.", i,
  1771. safe_str_client(conn->address),
  1772. conn->port);
  1773. log(severity,LD_GENERAL,
  1774. "Conn %d: %d bytes waiting on inbuf (len %d, last read %d secs ago)",
  1775. i,
  1776. (int)connection_get_inbuf_len(conn),
  1777. (int)buf_allocation(conn->inbuf),
  1778. (int)(now - conn->timestamp_lastread));
  1779. log(severity,LD_GENERAL,
  1780. "Conn %d: %d bytes waiting on outbuf "
  1781. "(len %d, last written %d secs ago)",i,
  1782. (int)connection_get_outbuf_len(conn),
  1783. (int)buf_allocation(conn->outbuf),
  1784. (int)(now - conn->timestamp_lastwritten));
  1785. if (conn->type == CONN_TYPE_OR) {
  1786. or_connection_t *or_conn = TO_OR_CONN(conn);
  1787. if (or_conn->tls) {
  1788. tor_tls_get_buffer_sizes(or_conn->tls, &rbuf_cap, &rbuf_len,
  1789. &wbuf_cap, &wbuf_len);
  1790. log(severity, LD_GENERAL,
  1791. "Conn %d: %d/%d bytes used on OpenSSL read buffer; "
  1792. "%d/%d bytes used on write buffer.",
  1793. i, (int)rbuf_len, (int)rbuf_cap, (int)wbuf_len, (int)wbuf_cap);
  1794. }
  1795. }
  1796. }
  1797. circuit_dump_by_conn(conn, severity); /* dump info about all the circuits
  1798. * using this conn */
  1799. });
  1800. log(severity, LD_NET,
  1801. "Cells processed: "U64_FORMAT" padding\n"
  1802. " "U64_FORMAT" create\n"
  1803. " "U64_FORMAT" created\n"
  1804. " "U64_FORMAT" relay\n"
  1805. " ("U64_FORMAT" relayed)\n"
  1806. " ("U64_FORMAT" delivered)\n"
  1807. " "U64_FORMAT" destroy",
  1808. U64_PRINTF_ARG(stats_n_padding_cells_processed),
  1809. U64_PRINTF_ARG(stats_n_create_cells_processed),
  1810. U64_PRINTF_ARG(stats_n_created_cells_processed),
  1811. U64_PRINTF_ARG(stats_n_relay_cells_processed),
  1812. U64_PRINTF_ARG(stats_n_relay_cells_relayed),
  1813. U64_PRINTF_ARG(stats_n_relay_cells_delivered),
  1814. U64_PRINTF_ARG(stats_n_destroy_cells_processed));
  1815. if (stats_n_data_cells_packaged)
  1816. log(severity,LD_NET,"Average packaged cell fullness: %2.3f%%",
  1817. 100*(U64_TO_DBL(stats_n_data_bytes_packaged) /
  1818. U64_TO_DBL(stats_n_data_cells_packaged*RELAY_PAYLOAD_SIZE)) );
  1819. if (stats_n_data_cells_received)
  1820. log(severity,LD_NET,"Average delivered cell fullness: %2.3f%%",
  1821. 100*(U64_TO_DBL(stats_n_data_bytes_received) /
  1822. U64_TO_DBL(stats_n_data_cells_received*RELAY_PAYLOAD_SIZE)) );
  1823. if (now - time_of_process_start >= 0)
  1824. elapsed = now - time_of_process_start;
  1825. else
  1826. elapsed = 0;
  1827. if (elapsed) {
  1828. log(severity, LD_NET,
  1829. "Average bandwidth: "U64_FORMAT"/%d = %d bytes/sec reading",
  1830. U64_PRINTF_ARG(stats_n_bytes_read),
  1831. (int)elapsed,
  1832. (int) (stats_n_bytes_read/elapsed));
  1833. log(severity, LD_NET,
  1834. "Average bandwidth: "U64_FORMAT"/%d = %d bytes/sec writing",
  1835. U64_PRINTF_ARG(stats_n_bytes_written),
  1836. (int)elapsed,
  1837. (int) (stats_n_bytes_written/elapsed));
  1838. }
  1839. log(severity, LD_NET, "--------------- Dumping memory information:");
  1840. dumpmemusage(severity);
  1841. rep_hist_dump_stats(now,severity);
  1842. rend_service_dump_stats(severity);
  1843. dump_pk_ops(severity);
  1844. dump_distinct_digest_count(severity);
  1845. }
  1846. /** Called by exit() as we shut down the process.
  1847. */
  1848. static void
  1849. exit_function(void)
  1850. {
  1851. /* NOTE: If we ever daemonize, this gets called immediately. That's
  1852. * okay for now, because we only use this on Windows. */
  1853. #ifdef MS_WINDOWS
  1854. WSACleanup();
  1855. #endif
  1856. }
  1857. /** Set up the signal handlers for either parent or child. */
  1858. void
  1859. handle_signals(int is_parent)
  1860. {
  1861. #ifndef MS_WINDOWS /* do signal stuff only on Unix */
  1862. int i;
  1863. static const int signals[] = {
  1864. SIGINT, /* do a controlled slow shutdown */
  1865. SIGTERM, /* to terminate now */
  1866. SIGPIPE, /* otherwise SIGPIPE kills us */
  1867. SIGUSR1, /* dump stats */
  1868. SIGUSR2, /* go to loglevel debug */
  1869. SIGHUP, /* to reload config, retry conns, etc */
  1870. #ifdef SIGXFSZ
  1871. SIGXFSZ, /* handle file-too-big resource exhaustion */
  1872. #endif
  1873. SIGCHLD, /* handle dns/cpu workers that exit */
  1874. -1 };
  1875. static struct event *signal_events[16]; /* bigger than it has to be. */
  1876. if (is_parent) {
  1877. for (i = 0; signals[i] >= 0; ++i) {
  1878. signal_events[i] = tor_evsignal_new(
  1879. tor_libevent_get_base(), signals[i], signal_callback,
  1880. (void*)(uintptr_t)signals[i]);
  1881. if (event_add(signal_events[i], NULL))
  1882. log_warn(LD_BUG, "Error from libevent when adding event for signal %d",
  1883. signals[i]);
  1884. }
  1885. } else {
  1886. struct sigaction action;
  1887. action.sa_flags = 0;
  1888. sigemptyset(&action.sa_mask);
  1889. action.sa_handler = SIG_IGN;
  1890. sigaction(SIGINT, &action, NULL);
  1891. sigaction(SIGTERM, &action, NULL);
  1892. sigaction(SIGPIPE, &action, NULL);
  1893. sigaction(SIGUSR1, &action, NULL);
  1894. sigaction(SIGUSR2, &action, NULL);
  1895. sigaction(SIGHUP, &action, NULL);
  1896. #ifdef SIGXFSZ
  1897. sigaction(SIGXFSZ, &action, NULL);
  1898. #endif
  1899. }
  1900. #else /* MS windows */
  1901. (void)is_parent;
  1902. #endif /* signal stuff */
  1903. }
  1904. /** Main entry point for the Tor command-line client.
  1905. */
  1906. /* static */ int
  1907. tor_init(int argc, char *argv[])
  1908. {
  1909. char buf[256];
  1910. int i, quiet = 0;
  1911. time_of_process_start = time(NULL);
  1912. if (!connection_array)
  1913. connection_array = smartlist_create();
  1914. if (!closeable_connection_lst)
  1915. closeable_connection_lst = smartlist_create();
  1916. if (!active_linked_connection_lst)
  1917. active_linked_connection_lst = smartlist_create();
  1918. /* Have the log set up with our application name. */
  1919. tor_snprintf(buf, sizeof(buf), "Tor %s", get_version());
  1920. log_set_application_name(buf);
  1921. /* Initialize the history structures. */
  1922. rep_hist_init();
  1923. /* Initialize the service cache. */
  1924. rend_cache_init();
  1925. addressmap_init(); /* Init the client dns cache. Do it always, since it's
  1926. * cheap. */
  1927. /* We search for the "quiet" option first, since it decides whether we
  1928. * will log anything at all to the command line. */
  1929. for (i=1;i<argc;++i) {
  1930. if (!strcmp(argv[i], "--hush"))
  1931. quiet = 1;
  1932. if (!strcmp(argv[i], "--quiet"))
  1933. quiet = 2;
  1934. }
  1935. /* give it somewhere to log to initially */
  1936. switch (quiet) {
  1937. case 2:
  1938. /* no initial logging */
  1939. break;
  1940. case 1:
  1941. add_temp_log(LOG_WARN);
  1942. break;
  1943. default:
  1944. add_temp_log(LOG_NOTICE);
  1945. }
  1946. quiet_level = quiet;
  1947. log(LOG_NOTICE, LD_GENERAL, "Tor v%s%s. This is experimental software. "
  1948. "Do not rely on it for strong anonymity. (Running on %s)", get_version(),
  1949. #ifdef USE_BUFFEREVENTS
  1950. " (with bufferevents)",
  1951. #else
  1952. "",
  1953. #endif
  1954. get_uname());
  1955. if (network_init()<0) {
  1956. log_err(LD_BUG,"Error initializing network; exiting.");
  1957. return -1;
  1958. }
  1959. atexit(exit_function);
  1960. if (options_init_from_torrc(argc,argv) < 0) {
  1961. log_err(LD_CONFIG,"Reading config failed--see warnings above.");
  1962. return -1;
  1963. }
  1964. #ifndef MS_WINDOWS
  1965. if (geteuid()==0)
  1966. log_warn(LD_GENERAL,"You are running Tor as root. You don't need to, "
  1967. "and you probably shouldn't.");
  1968. #endif
  1969. if (crypto_global_init(get_options()->HardwareAccel,
  1970. get_options()->AccelName,
  1971. get_options()->AccelDir)) {
  1972. log_err(LD_BUG, "Unable to initialize OpenSSL. Exiting.");
  1973. return -1;
  1974. }
  1975. return 0;
  1976. }
  1977. /** A lockfile structure, used to prevent two Tors from messing with the
  1978. * data directory at once. If this variable is non-NULL, we're holding
  1979. * the lockfile. */
  1980. static tor_lockfile_t *lockfile = NULL;
  1981. /** Try to grab the lock file described in <b>options</b>, if we do not
  1982. * already have it. If <b>err_if_locked</b> is true, warn if somebody else is
  1983. * holding the lock, and exit if we can't get it after waiting. Otherwise,
  1984. * return -1 if we can't get the lockfile. Return 0 on success.
  1985. */
  1986. int
  1987. try_locking(const or_options_t *options, int err_if_locked)
  1988. {
  1989. if (lockfile)
  1990. return 0;
  1991. else {
  1992. char *fname = options_get_datadir_fname2_suffix(options, "lock",NULL,NULL);
  1993. int already_locked = 0;
  1994. tor_lockfile_t *lf = tor_lockfile_lock(fname, 0, &already_locked);
  1995. tor_free(fname);
  1996. if (!lf) {
  1997. if (err_if_locked && already_locked) {
  1998. int r;
  1999. log_warn(LD_GENERAL, "It looks like another Tor process is running "
  2000. "with the same data directory. Waiting 5 seconds to see "
  2001. "if it goes away.");
  2002. #ifndef WIN32
  2003. sleep(5);
  2004. #else
  2005. Sleep(5000);
  2006. #endif
  2007. r = try_locking(options, 0);
  2008. if (r<0) {
  2009. log_err(LD_GENERAL, "No, it's still there. Exiting.");
  2010. exit(0);
  2011. }
  2012. return r;
  2013. }
  2014. return -1;
  2015. }
  2016. lockfile = lf;
  2017. return 0;
  2018. }
  2019. }
  2020. /** Return true iff we've successfully acquired the lock file. */
  2021. int
  2022. have_lockfile(void)
  2023. {
  2024. return lockfile != NULL;
  2025. }
  2026. /** If we have successfully acquired the lock file, release it. */
  2027. void
  2028. release_lockfile(void)
  2029. {
  2030. if (lockfile) {
  2031. tor_lockfile_unlock(lockfile);
  2032. lockfile = NULL;
  2033. }
  2034. }
  2035. /** Free all memory that we might have allocated somewhere.
  2036. * If <b>postfork</b>, we are a worker process and we want to free
  2037. * only the parts of memory that we won't touch. If !<b>postfork</b>,
  2038. * Tor is shutting down and we should free everything.
  2039. *
  2040. * Helps us find the real leaks with dmalloc and the like. Also valgrind
  2041. * should then report 0 reachable in its leak report (in an ideal world --
  2042. * in practice libevent, SSL, libc etc never quite free everything). */
  2043. void
  2044. tor_free_all(int postfork)
  2045. {
  2046. if (!postfork) {
  2047. evdns_shutdown(1);
  2048. }
  2049. geoip_free_all();
  2050. dirvote_free_all();
  2051. routerlist_free_all();
  2052. networkstatus_free_all();
  2053. addressmap_free_all();
  2054. dirserv_free_all();
  2055. rend_service_free_all();
  2056. rend_cache_free_all();
  2057. rend_service_authorization_free_all();
  2058. rep_hist_free_all();
  2059. dns_free_all();
  2060. clear_pending_onions();
  2061. circuit_free_all();
  2062. entry_guards_free_all();
  2063. connection_free_all();
  2064. buf_shrink_freelists(1);
  2065. memarea_clear_freelist();
  2066. nodelist_free_all();
  2067. microdesc_free_all();
  2068. if (!postfork) {
  2069. config_free_all();
  2070. router_free_all();
  2071. policies_free_all();
  2072. }
  2073. free_cell_pool();
  2074. if (!postfork) {
  2075. tor_tls_free_all();
  2076. }
  2077. /* stuff in main.c */
  2078. smartlist_free(connection_array);
  2079. smartlist_free(closeable_connection_lst);
  2080. smartlist_free(active_linked_connection_lst);
  2081. periodic_timer_free(second_timer);
  2082. if (!postfork) {
  2083. release_lockfile();
  2084. }
  2085. /* Stuff in util.c and address.c*/
  2086. if (!postfork) {
  2087. escaped(NULL);
  2088. esc_router_info(NULL);
  2089. logs_free_all(); /* free log strings. do this last so logs keep working. */
  2090. }
  2091. }
  2092. /** Do whatever cleanup is necessary before shutting Tor down. */
  2093. void
  2094. tor_cleanup(void)
  2095. {
  2096. const or_options_t *options = get_options();
  2097. if (options->command == CMD_RUN_TOR) {
  2098. time_t now = time(NULL);
  2099. /* Remove our pid file. We don't care if there was an error when we
  2100. * unlink, nothing we could do about it anyways. */
  2101. if (options->PidFile)
  2102. unlink(options->PidFile);
  2103. if (options->ControlPortWriteToFile)
  2104. unlink(options->ControlPortWriteToFile);
  2105. if (accounting_is_enabled(options))
  2106. accounting_record_bandwidth_usage(now, get_or_state());
  2107. or_state_mark_dirty(get_or_state(), 0); /* force an immediate save. */
  2108. or_state_save(now);
  2109. if (authdir_mode_tests_reachability(options))
  2110. rep_hist_record_mtbf_data(now, 0);
  2111. }
  2112. #ifdef USE_DMALLOC
  2113. dmalloc_log_stats();
  2114. #endif
  2115. tor_free_all(0); /* We could move tor_free_all back into the ifdef below
  2116. later, if it makes shutdown unacceptably slow. But for
  2117. now, leave it here: it's helped us catch bugs in the
  2118. past. */
  2119. crypto_global_cleanup();
  2120. #ifdef USE_DMALLOC
  2121. dmalloc_log_unfreed();
  2122. dmalloc_shutdown();
  2123. #endif
  2124. }
  2125. /** Read/create keys as needed, and echo our fingerprint to stdout. */
  2126. /* static */ int
  2127. do_list_fingerprint(void)
  2128. {
  2129. char buf[FINGERPRINT_LEN+1];
  2130. crypto_pk_env_t *k;
  2131. const char *nickname = get_options()->Nickname;
  2132. if (!server_mode(get_options())) {
  2133. log_err(LD_GENERAL,
  2134. "Clients don't have long-term identity keys. Exiting.\n");
  2135. return -1;
  2136. }
  2137. tor_assert(nickname);
  2138. if (init_keys() < 0) {
  2139. log_err(LD_BUG,"Error initializing keys; can't display fingerprint");
  2140. return -1;
  2141. }
  2142. if (!(k = get_server_identity_key())) {
  2143. log_err(LD_GENERAL,"Error: missing identity key.");
  2144. return -1;
  2145. }
  2146. if (crypto_pk_get_fingerprint(k, buf, 1)<0) {
  2147. log_err(LD_BUG, "Error computing fingerprint");
  2148. return -1;
  2149. }
  2150. printf("%s %s\n", nickname, buf);
  2151. return 0;
  2152. }
  2153. /** Entry point for password hashing: take the desired password from
  2154. * the command line, and print its salted hash to stdout. **/
  2155. /* static */ void
  2156. do_hash_password(void)
  2157. {
  2158. char output[256];
  2159. char key[S2K_SPECIFIER_LEN+DIGEST_LEN];
  2160. crypto_rand(key, S2K_SPECIFIER_LEN-1);
  2161. key[S2K_SPECIFIER_LEN-1] = (uint8_t)96; /* Hash 64 K of data. */
  2162. secret_to_key(key+S2K_SPECIFIER_LEN, DIGEST_LEN,
  2163. get_options()->command_arg, strlen(get_options()->command_arg),
  2164. key);
  2165. base16_encode(output, sizeof(output), key, sizeof(key));
  2166. printf("16:%s\n",output);
  2167. }
  2168. #if defined (WINCE)
  2169. int
  2170. find_flashcard_path(PWCHAR path, size_t size)
  2171. {
  2172. WIN32_FIND_DATA d = {0};
  2173. HANDLE h = NULL;
  2174. if (!path)
  2175. return -1;
  2176. h = FindFirstFlashCard(&d);
  2177. if (h == INVALID_HANDLE_VALUE)
  2178. return -1;
  2179. if (wcslen(d.cFileName) == 0) {
  2180. FindClose(h);
  2181. return -1;
  2182. }
  2183. wcsncpy(path,d.cFileName,size);
  2184. FindClose(h);
  2185. return 0;
  2186. }
  2187. #endif
  2188. /** Main entry point for the Tor process. Called from main(). */
  2189. /* This function is distinct from main() only so we can link main.c into
  2190. * the unittest binary without conflicting with the unittests' main. */
  2191. int
  2192. tor_main(int argc, char *argv[])
  2193. {
  2194. int result = 0;
  2195. #if defined (WINCE)
  2196. WCHAR path [MAX_PATH] = {0};
  2197. WCHAR fullpath [MAX_PATH] = {0};
  2198. PWCHAR p = NULL;
  2199. FILE* redir = NULL;
  2200. FILE* redirdbg = NULL;
  2201. // this is to facilitate debugging by opening
  2202. // a file on a folder shared by the wm emulator.
  2203. // if no flashcard (real or emulated) is present,
  2204. // log files will be written in the root folder
  2205. if (find_flashcard_path(path,MAX_PATH) == -1)
  2206. {
  2207. redir = _wfreopen( L"\\stdout.log", L"w", stdout );
  2208. redirdbg = _wfreopen( L"\\stderr.log", L"w", stderr );
  2209. } else {
  2210. swprintf(fullpath,L"\\%s\\tor",path);
  2211. CreateDirectory(fullpath,NULL);
  2212. swprintf(fullpath,L"\\%s\\tor\\stdout.log",path);
  2213. redir = _wfreopen( fullpath, L"w", stdout );
  2214. swprintf(fullpath,L"\\%s\\tor\\stderr.log",path);
  2215. redirdbg = _wfreopen( fullpath, L"w", stderr );
  2216. }
  2217. #endif
  2218. #ifdef MS_WINDOWS
  2219. /* Call SetProcessDEPPolicy to permanently enable DEP.
  2220. The function will not resolve on earlier versions of Windows,
  2221. and failure is not dangerous. */
  2222. HMODULE hMod = GetModuleHandleA("Kernel32.dll");
  2223. if (hMod) {
  2224. typedef BOOL (WINAPI *PSETDEP)(DWORD);
  2225. PSETDEP setdeppolicy = (PSETDEP)GetProcAddress(hMod,
  2226. "SetProcessDEPPolicy");
  2227. if (setdeppolicy) setdeppolicy(1); /* PROCESS_DEP_ENABLE */
  2228. }
  2229. #endif
  2230. update_approx_time(time(NULL));
  2231. tor_threads_init();
  2232. init_logging();
  2233. #ifdef USE_DMALLOC
  2234. {
  2235. /* Instruct OpenSSL to use our internal wrappers for malloc,
  2236. realloc and free. */
  2237. int r = CRYPTO_set_mem_ex_functions(_tor_malloc, _tor_realloc, _tor_free);
  2238. tor_assert(r);
  2239. }
  2240. #endif
  2241. #ifdef NT_SERVICE
  2242. {
  2243. int done = 0;
  2244. result = nt_service_parse_options(argc, argv, &done);
  2245. if (done) return result;
  2246. }
  2247. #endif
  2248. if (tor_init(argc, argv)<0)
  2249. return -1;
  2250. switch (get_options()->command) {
  2251. case CMD_RUN_TOR:
  2252. #ifdef NT_SERVICE
  2253. nt_service_set_state(SERVICE_RUNNING);
  2254. #endif
  2255. result = do_main_loop();
  2256. break;
  2257. case CMD_LIST_FINGERPRINT:
  2258. result = do_list_fingerprint();
  2259. break;
  2260. case CMD_HASH_PASSWORD:
  2261. do_hash_password();
  2262. result = 0;
  2263. break;
  2264. case CMD_VERIFY_CONFIG:
  2265. printf("Configuration was valid\n");
  2266. result = 0;
  2267. break;
  2268. case CMD_RUN_UNITTESTS: /* only set by test.c */
  2269. default:
  2270. log_warn(LD_BUG,"Illegal command number %d: internal error.",
  2271. get_options()->command);
  2272. result = -1;
  2273. }
  2274. tor_cleanup();
  2275. return result;
  2276. }