October 2011 - tor-commits - lists.torproject.org

[tor/master] Add new stats type: descriptor fetch stats
by nickm＠torproject.org 21 Oct '11

21 Oct '11

commit 03c06b629fc604030393567ec05c16f813d43529 Author: Sebastian Hahn <sebastian(a)torproject.org> Date: Fri Oct 7 02:39:48 2011 +0200 Add new stats type: descriptor fetch stats This is used for the bridge authority currently, to get a better intuition on how many descriptors are actually fetched from it and how many fetches happen in total. Implements ticket 4200. --- changes/ticket4200 | 5 ++ src/or/config.c | 10 ++++- src/or/dirserv.c | 1 + src/or/main.c | 5 ++ src/or/rephist.c | 116 ++++++++++++++++++++++++++++++++++++++++++++++++++++ src/or/rephist.h | 5 ++ 6 files changed, 141 insertions(+), 1 deletions(-) diff --git a/changes/ticket4200 b/changes/ticket4200 new file mode 100644 index 0000000..9df9930 --- /dev/null +++ b/changes/ticket4200 @@ -0,0 +1,5 @@ + o Minor features: + - The bridge authority now writes statistics on how many bridge + descriptors it gave out in total, and how unique descriptors + it gave out. Implements ticket 4200. + diff --git a/src/or/config.c b/src/or/config.c index 59bbe1d..627e1ac 100644 --- a/src/or/config.c +++ b/src/or/config.c @@ -1532,7 +1532,8 @@ options_act(const or_options_t *old_options) if (options->CellStatistics || options->DirReqStatistics || options->EntryStatistics || options->ExitPortStatistics || - options->ConnDirectionStatistics) { + options->ConnDirectionStatistics || + options->BridgeAuthoritativeDir) { time_t now = time(NULL); int print_notice = 0; if ((!old_options || !old_options->CellStatistics) && @@ -1577,6 +1578,10 @@ options_act(const or_options_t *old_options) options->ConnDirectionStatistics) { rep_hist_conn_stats_init(now); } + if (!old_options || !old_options->BridgeAuthoritativeDir) { + rep_hist_desc_stats_init(now); + print_notice = 1; + } if (print_notice) log_notice(LD_CONFIG, "Configured to measure statistics. Look for " "the *-stats files that will first be written to the " @@ -1598,6 +1603,9 @@ options_act(const or_options_t *old_options) if (old_options && old_options->ConnDirectionStatistics && !options->ConnDirectionStatistics) rep_hist_conn_stats_term(); + if (old_options && old_options->BridgeAuthoritativeDir && + !options->BridgeAuthoritativeDir) + rep_hist_desc_stats_term(); /* Check if we need to parse and add the EntryNodes config option. */ if (options->EntryNodes && diff --git a/src/or/dirserv.c b/src/or/dirserv.c index f64dcff..4b9587b 100644 --- a/src/or/dirserv.c +++ b/src/or/dirserv.c @@ -3509,6 +3509,7 @@ connection_dirserv_add_servers_to_outbuf(dir_connection_t *conn) * unknown bridge descriptor has shown up between then and now. */ continue; } + rep_hist_note_desc_served(sd->identity_digest); body = signed_descriptor_get_body(sd); if (conn->zlib_state) { /* XXXX022 This 'last' business should actually happen on the last diff --git a/src/or/main.c b/src/or/main.c index aa167e1..d01552f 100644 --- a/src/or/main.c +++ b/src/or/main.c @@ -1268,6 +1268,11 @@ run_scheduled_events(time_t now) if (next_write && next_write < next_time_to_write_stats_files) next_time_to_write_stats_files = next_write; } + if (options->BridgeAuthoritativeDir) { + time_t next_write = rep_hist_desc_stats_write(time_to_write_stats_files); + if (next_write && next_write < next_time_to_write_stats_files) + next_time_to_write_stats_files = next_write; + } time_to_write_stats_files = next_time_to_write_stats_files; } diff --git a/src/or/rephist.c b/src/or/rephist.c index de4a1ef..8038bf4 100644 --- a/src/or/rephist.c +++ b/src/or/rephist.c @@ -2596,6 +2596,120 @@ rep_hist_buffer_stats_write(time_t now) return start_of_buffer_stats_interval + WRITE_STATS_INTERVAL; } +/*** Descriptor serving statistics ***/ + +/** Digestmap to track which descriptors were downloaded this stats + * collection interval. It maps descriptor digest to pointers to 1, + * effectively turning this into a list. */ +static digestmap_t *served_descs = NULL; + +/** Number of how many descriptors were downloaded in total during this + * interval. */ +static unsigned long total_descriptor_downloads; + +/** Start time of served descs stats or 0 if we're not collecting those. */ +static time_t start_of_served_descs_stats_interval; + +/** Initialize descriptor stats. */ +void +rep_hist_desc_stats_init(time_t now) +{ + if (served_descs) { + log_warn(LD_BUG, "Called rep_hist_desc_stats_init() when desc stats were " + "already initialized. This is probably harmless."); + return; // Already initialized + } + served_descs = digestmap_new(); + total_descriptor_downloads = 0; + start_of_served_descs_stats_interval = now; +} + +/** Reset served descs stats to empty, starting a new interval now. */ +static void +rep_hist_reset_desc_stats(time_t now) +{ + rep_hist_desc_stats_term(); + rep_hist_desc_stats_init(now); +} + +/** Stop collecting served descs stats, so that rep_hist_desc_stats_init() is + * safe to be called again. */ +void +rep_hist_desc_stats_term(void) +{ + digestmap_free(served_descs, NULL); + served_descs = NULL; + start_of_served_descs_stats_interval = 0; + total_descriptor_downloads = 0; +} + +/** Helper for rep_hist_desc_stats_write(). Return a newly allocated string + * containing the served desc statistics until now, or NULL if we're not + * collecting served desc stats. Caller must ensure that now is not before + * start_of_served_descs_stats_interval. */ +static char * +rep_hist_format_desc_stats(time_t now) +{ + char t[ISO_TIME_LEN+1]; + char *result; + + if (!start_of_served_descs_stats_interval) + return NULL; + + format_iso_time(t, now); + + tor_asprintf(&result, + "served-descs-stats-end %s (%d s) total=%lu unique=%u\n", + t, + (unsigned) (now - start_of_served_descs_stats_interval), + total_descriptor_downloads, + digestmap_size(served_descs)); + + return result; +} + +/** If WRITE_STATS_INTERVAL seconds have passed since the beginning of + * the current served desc stats interval, write the stats to + * $DATADIR/stats/served-desc-stats (possibly appending to an existing file) + * and reset the state for the next interval. Return when we would next want + * to write served desc stats or 0 if we won't want to write. */ +time_t +rep_hist_desc_stats_write(time_t now) +{ + char *statsdir = NULL, *filename = NULL, *str = NULL; + + if (!start_of_served_descs_stats_interval) + return 0; /* We're not collecting stats. */ + if (start_of_served_descs_stats_interval + WRITE_STATS_INTERVAL > now) + return start_of_served_descs_stats_interval + WRITE_STATS_INTERVAL; + + str = rep_hist_format_desc_stats(now); + + statsdir = get_datadir_fname("stats"); + if (check_private_dir(statsdir, CPD_CREATE, get_options()->User) < 0) { + log_warn(LD_HIST, "Unable to create stats/ directory!"); + goto done; + } + filename = get_datadir_fname2("stats", "served-desc-stats"); + if (append_bytes_to_file(filename, str, strlen(str), 0) < 0) + log_warn(LD_HIST, "Unable to write served descs statistics to disk!"); + + rep_hist_reset_desc_stats(now); + + done: + tor_free(statsdir); + tor_free(filename); + tor_free(str); + return start_of_served_descs_stats_interval + WRITE_STATS_INTERVAL; +} + +void +rep_hist_note_desc_served(const char * desc) +{ + digestmap_set(served_descs, desc, (void *)1); + total_descriptor_downloads++; +} + /*** Connection statistics ***/ /** Start of the current connection stats interval or 0 if we're not @@ -2839,5 +2953,7 @@ rep_hist_free_all(void) smartlist_free(circuits_for_buffer_stats); circuits_for_buffer_stats = NULL; } + rep_hist_desc_stats_term(); + total_descriptor_downloads = 0; } diff --git a/src/or/rephist.h b/src/or/rephist.h index e590659..0a3e46a 100644 --- a/src/or/rephist.h +++ b/src/or/rephist.h @@ -82,6 +82,11 @@ void rep_hist_add_buffer_stats(double mean_num_cells_in_queue, char *rep_hist_format_buffer_stats(time_t now); void rep_hist_reset_buffer_stats(time_t now); +void rep_hist_desc_stats_init(time_t now); +void rep_hist_note_desc_served(const char * desc); +void rep_hist_desc_stats_term(void); +time_t rep_hist_desc_stats_write(time_t now); + void rep_hist_conn_stats_init(time_t now); void rep_hist_note_or_conn_bytes(uint64_t conn_id, size_t num_read, size_t num_written, time_t when);

1 0

[tor/master] Check for jumping clock in *format_*stats functions
by nickm＠torproject.org 21 Oct '11

21 Oct '11

commit 42b96a041de39399a60a622329c5d5ecf593ab99 Author: Sebastian Hahn <sebastian(a)torproject.org> Date: Fri Oct 21 17:01:38 2011 +0200 Check for jumping clock in *format_*stats functions None of these were real bugs (yet), because the callers made sure everything was fine. Make it more explicit. Suggested by Nick --- src/or/geoip.c | 10 ++++++++-- src/or/rephist.c | 15 ++++++++++++--- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/src/or/geoip.c b/src/or/geoip.c index 67dea96..73194ae 100644 --- a/src/or/geoip.c +++ b/src/or/geoip.c @@ -976,7 +976,8 @@ geoip_dirreq_stats_term(void) } /** Return a newly allocated string containing the dirreq statistics - * until now, or NULL if we're not collecting dirreq stats. */ + * until now, or NULL if we're not collecting dirreq stats. Caller + * must ensure start_of_dirreq_stats_interval is in the past. */ char * geoip_format_dirreq_stats(time_t now) { @@ -992,6 +993,8 @@ geoip_format_dirreq_stats(time_t now) if (!start_of_dirreq_stats_interval) return NULL; /* Not initialized. */ + tor_assert(now >= start_of_dirreq_stats_interval); + format_iso_time(t, now); v2_ips_string = geoip_get_client_history(GEOIP_CLIENT_NETWORKSTATUS_V2); v3_ips_string = geoip_get_client_history(GEOIP_CLIENT_NETWORKSTATUS); @@ -1351,7 +1354,8 @@ geoip_entry_stats_term(void) } /** Return a newly allocated string containing the entry statistics - * until now, or NULL if we're not collecting entry stats. */ + * until now, or NULL if we're not collecting entry stats. Caller + * must ensure start_of_entry_stats_interval lies in the past. */ char * geoip_format_entry_stats(time_t now) { @@ -1362,6 +1366,8 @@ geoip_format_entry_stats(time_t now) if (!start_of_entry_stats_interval) return NULL; /* Not initialized. */ + tor_assert(now >= start_of_entry_stats_interval); + data = geoip_get_client_history(GEOIP_CLIENT_CONNECT); format_iso_time(t, now); tor_asprintf(&result, "entry-stats-end %s (%u s)\nentry-ips %s\n", diff --git a/src/or/rephist.c b/src/or/rephist.c index 8038bf4..1aa0aeb 100644 --- a/src/or/rephist.c +++ b/src/or/rephist.c @@ -2114,7 +2114,8 @@ _compare_int(const void *x, const void *y) } /** Return a newly allocated string containing the exit port statistics - * until now, or NULL if we're not collecting exit stats. */ + * until now, or NULL if we're not collecting exit stats. Caller + * must ensure start_of_exit_stats_interval is in the past. */ char * rep_hist_format_exit_stats(time_t now) { @@ -2133,6 +2134,8 @@ rep_hist_format_exit_stats(time_t now) if (!start_of_exit_stats_interval) return NULL; /* Not initialized. */ + tor_assert(now >= start_of_exit_stats_interval); + /* Go through all ports to find the n ports that saw most written and * read bytes. * @@ -2456,7 +2459,8 @@ rep_hist_reset_buffer_stats(time_t now) } /** Return a newly allocated string containing the buffer statistics until - * now, or NULL if we're not collecting buffer stats. */ + * now, or NULL if we're not collecting buffer stats. Caller must + * ensure start_of_buffer_stats_interval is in the past. */ char * rep_hist_format_buffer_stats(time_t now) { @@ -2475,6 +2479,8 @@ rep_hist_format_buffer_stats(time_t now) if (!start_of_buffer_stats_interval) return NULL; /* Not initialized. */ + tor_assert(now >= start_of_buffer_stats_interval); + /* Calculate deciles if we saw at least one circuit. */ memset(processed_cells, 0, SHARES * sizeof(int)); memset(circs_in_share, 0, SHARES * sizeof(int)); @@ -2874,7 +2880,8 @@ rep_hist_note_or_conn_bytes(uint64_t conn_id, size_t num_read, } /** Return a newly allocated string containing the connection statistics - * until now, or NULL if we're not collecting conn stats. */ + * until now, or NULL if we're not collecting conn stats. Caller must + * ensure start_of_conn_stats_interval is in the past. */ char * rep_hist_format_conn_stats(time_t now) { @@ -2883,6 +2890,8 @@ rep_hist_format_conn_stats(time_t now) if (!start_of_conn_stats_interval) return NULL; /* Not initialized. */ + tor_assert(now >= start_of_conn_stats_interval); + format_iso_time(written, now); tor_asprintf(&result, "conn-bi-direct %s (%d s) %d,%d,%d,%d\n", written,

1 0

[tor/master] Fix missing word in changes/ticket4200
by nickm＠torproject.org 21 Oct '11

21 Oct '11

commit 4fbc6152eda885fbbc155b0950d2dffa0a32549c Author: Nick Mathewson <nickm(a)torproject.org> Date: Fri Oct 21 11:25:16 2011 -0400 Fix missing word in changes/ticket4200 --- changes/ticket4200 | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/changes/ticket4200 b/changes/ticket4200 index 9df9930..71bc04f 100644 --- a/changes/ticket4200 +++ b/changes/ticket4200 @@ -1,5 +1,5 @@ o Minor features: - The bridge authority now writes statistics on how many bridge - descriptors it gave out in total, and how unique descriptors + descriptors it gave out in total, and how many unique descriptors it gave out. Implements ticket 4200.

1 0

[tor/master] Merge branch 'ticket4200'
by nickm＠torproject.org 21 Oct '11

21 Oct '11

commit cc3f0ba1e8b49f0dc2a40c80d741808380e0ab45 Merge: 29825f0 4fbc615 Author: Nick Mathewson <nickm(a)torproject.org> Date: Fri Oct 21 11:25:29 2011 -0400 Merge branch 'ticket4200' changes/remove_TRACK_SERVED_TIME | 4 + changes/ticket4200 | 5 ++ src/or/config.c | 10 +++- src/or/dirserv.c | 7 +-- src/or/geoip.c | 10 ++- src/or/main.c | 5 ++ src/or/or.h | 5 -- src/or/rephist.c | 131 +++++++++++++++++++++++++++++++++++++- src/or/rephist.h | 5 ++ 9 files changed, 165 insertions(+), 17 deletions(-)

1 0

r25178: {website} link to polipo windows binary for those who want it (website/trunk/docs/en)
by Roger Dingledine 21 Oct '11

21 Oct '11

Author: arma Date: 2011-10-21 03:55:40 +0000 (Fri, 21 Oct 2011) New Revision: 25178 Modified: website/trunk/docs/en/faq.wml Log: link to polipo windows binary for those who want it Modified: website/trunk/docs/en/faq.wml =================================================================== --- website/trunk/docs/en/faq.wml 2011-10-20 14:18:49 UTC (rev 25177) +++ website/trunk/docs/en/faq.wml 2011-10-21 03:55:40 UTC (rev 25178) @@ -822,7 +822,10 @@ -If that fails, feel free to install privoxy or polipo. You can use <a +If that fails, feel free to install <a +href="http://www.privoxy.org/">privoxy</a> or <a +href="https://archive.torproject.org/tor-package-archive/polipo/">polipo</a>. +You can use <a href="https://gitweb.torproject.org/torbrowser.git/blob_plain/HEAD:/build-scripts…">our old polipo config file</a> if you like. However, please realize that this approach is unsupported.

1 0

[tor/master] Check whether a client port is a Unix socket before using its IP addr
by nickm＠torproject.org 20 Oct '11

20 Oct '11

commit 9df99bbb9171c15b00c5148f54397351eccac95b Author: Robert Ransom <rransom.8774(a)gmail.com> Date: Thu Oct 20 03:17:23 2011 -0700 Check whether a client port is a Unix socket before using its IP addr Bugfix on commit c1ac0695d5bc64b555c345e4be87b18bab3ae56b, not yet in any release. Fixes bug 4091; bug reported by SwissTorHelp. --- src/or/config.c | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-) diff --git a/src/or/config.c b/src/or/config.c index 388c45f..59bbe1d 100644 --- a/src/or/config.c +++ b/src/or/config.c @@ -5128,7 +5128,9 @@ static void warn_nonlocal_client_ports(const smartlist_t *ports, const char *portname) { SMARTLIST_FOREACH_BEGIN(ports, const port_cfg_t *, port) { - if (!tor_addr_is_internal(&port->addr, 1)) { + if (port->is_unix_addr) { + /* Unix sockets aren't accessible over a network. */ + } else if (!tor_addr_is_internal(&port->addr, 1)) { log_warn(LD_CONFIG, "You specified a public address for %sPort. " "Other people on the Internet might find your computer and " "use it as an open proxy. Please don't allow this unless you "

1 0

[tor/master] Merge remote-tracking branch 'rransom-tor/bug4091'
by nickm＠torproject.org 20 Oct '11

20 Oct '11

commit 29825f0bfd301185744d6961c1b62b9597d165d6 Merge: 169c818 9df99bb Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Oct 20 14:26:54 2011 -0400 Merge remote-tracking branch 'rransom-tor/bug4091' src/or/config.c | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-)

1 0

[translation/gettor] Update translations for gettor
by translation＠torproject.org 20 Oct '11

20 Oct '11

commit 36d246006a03e9c4c906ebdde51f4a233c696732 Author: Translation commit bot <translation(a)torproject.org> Date: Thu Oct 20 18:15:24 2011 +0000 Update translations for gettor --- ar/gettor.po | 27 +++++++++++++++++++++++++-- 1 files changed, 25 insertions(+), 2 deletions(-) diff --git a/ar/gettor.po b/ar/gettor.po index 5a654db..7b921b2 100644 --- a/ar/gettor.po +++ b/ar/gettor.po @@ -12,8 +12,8 @@ msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2011-09-10 01:52-0400\n" -"PO-Revision-Date: 2011-10-11 06:30+0000\n" -"Last-Translator: modafar <modafar22(a)hotmail.com>\n" +"PO-Revision-Date: 2011-10-20 18:07+0000\n" +"Last-Translator: redeemer <fadi.redeemer.mansour(a)gmail.com>\n" "Language-Team: LANGUAGE <LL(a)li.org>\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -275,6 +275,11 @@ msgid "" "\n" " gpg --verify tor-browser-1.3.24_en-US.exe.asc tor-browser-1.3.24_en-US.exe" msgstr "" +"التأكد من التوقيع\n" +"========\n" +"إن كان حاسبك يحوي غنو بي جي (GnuPG)، قم باستخدام الأمر gpg بالشكل التالي بعد فك ضغط ملف zip:\n" +"\n" +" gpg --verify tor-browser-1.3.24_en-US.exe.asc tor-browser-1.3.24-en-US.exe" #: lib/gettor/i18n.py:143 msgid "" @@ -282,6 +287,10 @@ msgid "" "\n" " gpg: Good signature from 'Erinn Clark <...>'" msgstr "" +"يجب أن تكون النتيجة شيء من هذا القبيل:\n" +"\n" +" gpg: Good signature from 'Erinn Clark <...>'\n" +" gpg: توقيع جيد من 'إرين كلارك <...>'" #: lib/gettor/i18n.py:147 msgid "" @@ -290,12 +299,17 @@ msgid "" "\n" " http://www.gnupg.org/related_software/frontends.html" msgstr "" +"إن لم تكن معتاداً على استخدام أدوات سطر الأوامر، حاول البحث عن واجهة رسومية لغنو بي جي على هذا الموقع:\n" +"\n" +" http://www.gnupg.org/related_software/frontends.html" #: lib/gettor/i18n.py:152 msgid "" "BLOCKED ACCESS / CENSORSHIP\n" "===========================" msgstr "" +"الوصول المحجوب/الرقابة\n" +"=============" #: lib/gettor/i18n.py:155 msgid "" @@ -319,6 +333,9 @@ msgid "" "\n" " bridges(a)torproject.org" msgstr "" +"يمكنك الحصول على جسر بإرسال بريد يحوي \"get bridges\" في متن البريد وعنونه للبريد التالي:\n" +"\n" +" bridges(a)torproject.org" #: lib/gettor/i18n.py:167 msgid "" @@ -354,12 +371,16 @@ msgid "" "It was successfully understood. Your request is currently being processed.\n" "Your package (%s) should arrive within the next ten minutes." msgstr "" +"تم الفهم بنجاح. تتم حالياً معالجة طلبك. ستصلك رزمتك (%s) خلال الدقائق العشر " +"التالية." #: lib/gettor/i18n.py:182 msgid "" "If it doesn't arrive, the package might be too big for your mail provider.\n" "Try resending the mail from a GMAIL.COM, YAHOO.CN or YAHOO.COM account." msgstr "" +"إن لم تصل، لا بد أن الرزمة أكبر مما يسمح به مزود بريدك. حاول أن تعيد إرسال " +"الرسالة من حساب بريد من GMAIL.COM، YAHOO.CN أو YAHOO.COM." #: lib/gettor/i18n.py:185 msgid "" @@ -385,6 +406,8 @@ msgid "" "UNPACKING THE FILES\n" "===================" msgstr "" +"فك ضغط الملفات\n" +"=========" #: lib/gettor/i18n.py:196 msgid ""

1 0

[torspec/master] Oops; commutative, not transitive.
by nickm＠torproject.org 20 Oct '11

20 Oct '11

commit 9cd2dd3f9a5cc07e4caab92a8e81b10c15fc7717 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Oct 20 13:58:37 2011 -0400 Oops; commutative, not transitive. --- proposals/188-bridge-guards.txt | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/proposals/188-bridge-guards.txt b/proposals/188-bridge-guards.txt index 249d794..3c53cfb 100644 --- a/proposals/188-bridge-guards.txt +++ b/proposals/188-bridge-guards.txt @@ -134,7 +134,7 @@ Status: Open before passing it to Guillaume. Note that this design does not require that our stream cipher - operations be transitive, even though they are. + operations be commutative, even though they are. Note also that this design requires no change in behavior from any node other than Bob the bridge.

1 0

[stem/master] Moving tor launcher into stem function
by atagar＠torproject.org 20 Oct '11

20 Oct '11

commit 3a913b6b92796f2195c28e55ead532a0fef906e6 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Oct 20 09:58:37 2011 -0700 Moving tor launcher into stem function In writing the stem integ tests I needed a function for starting tor then blocking for its bootstraping to complete. Yesterday Jake mentioned that he could use a launch_tor() function in TorCtl so I'm generalizing this code and moving it into the stem lib. --- stem/__init__.py | 2 +- stem/process.py | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ test/runner.py | 48 ++++++++++------------------------------- 3 files changed, 74 insertions(+), 37 deletions(-) diff --git a/stem/__init__.py b/stem/__init__.py index 01c350c..5ac77ed 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -2,5 +2,5 @@ Library for working with the tor process. """ -__all__ = ["types"] +__all__ = ["process", "types"] diff --git a/stem/process.py b/stem/process.py new file mode 100644 index 0000000..f049610 --- /dev/null +++ b/stem/process.py @@ -0,0 +1,61 @@ +""" +Helper functions for working with tor as a process. These are mostly os +dependent, only working on linux, osx, and bsd. +""" + +import os +import signal +import subprocess + +# number of seconds before we time out our attempt to start a tor instance +TOR_INIT_TIMEOUT = 90 + +def launch_tor(torrc_path, init_msg_handler = None): + """ + Initializes a tor process. This blocks until initialization completes or we + error out. + + Arguments: + torrc_path (str) - location of the torrc for us to use + init_msg_handler (functor) - optional functor that will be provided with + tor's initialization stdout as we get it + + Returns: + subprocess.Popen instance for the tor subprocess + + Raises: + OSError if we either fail to create the tor process or reached a timeout + without success + """ + + # double check that we have a torrc to work with + if not os.path.exists(torrc_path): + raise OSError("torrc doesn't exist (%s)" % torrc_path) + + # starts a tor subprocess, raising an OSError if it fails + tor_process = subprocess.Popen(["tor", "-f", torrc_path], stdout = subprocess.PIPE, stderr = subprocess.PIPE) + + # time ourselves out if we reach TOR_INIT_TIMEOUT + def timeout_handler(signum, frame): + # terminates the uninitialized tor process and raise on timeout + tor_process.kill() + raise OSError("reached a %i second timeout without success" % TOR_INIT_TIMEOUT) + + signal.signal(signal.SIGALRM, timeout_handler) + signal.alarm(TOR_INIT_TIMEOUT) + + while True: + init_line = tor_process.stdout.readline().strip() + + # this will provide empty results if the process is terminated + if not init_line: + tor_process.kill() # ... but best make sure + raise OSError("process terminated") + + # provide the caller with the initialization message if they want it + if init_msg_handler: init_msg_handler(init_line) + + # return the process if we're done with bootstrapping + if init_line.endswith("Bootstrapped 100%: Done."): + return tor_process + diff --git a/test/runner.py b/test/runner.py index 6f76d01..c795ea8 100644 --- a/test/runner.py +++ b/test/runner.py @@ -6,9 +6,9 @@ import os import sys import time import shutil -import signal import tempfile -import subprocess + +import stem.process from stem.util import term @@ -87,44 +87,20 @@ class Runner: without success """ + def print_init_line(init_line): + """ + Prints output from tor's stdout while it starts up. + """ + + print term.format(" %s" % init_line, term.Color.BLUE) + print term.format("Starting tor...", term.Color.BLUE, term.Attr.BOLD) start_time = time.time() try: - # terminate our previous instance before continuing if we had one - if self._tor_process: self._tor_process.kill() - - # double check that we have a torrc to work with - torrc_dst = self.get_torrc_path() - if not os.path.exists(torrc_dst): - raise OSError("torrc doesn't exist (%s)" % torrc_dst) - - # starts a tor subprocess, raising an OSError if it fails - self._tor_process = subprocess.Popen(["tor", "-f", torrc_dst], stdout = subprocess.PIPE, stderr = subprocess.PIPE) - - # time ourselves out if we reach TOR_INIT_TIMEOUT - def timeout_handler(signum, frame): - # terminates the uninitialized tor process and raise on timeout - self._tor_process.kill() - raise OSError("reached a %i second timeout without success" % TOR_INIT_TIMEOUT) - - signal.signal(signal.SIGALRM, timeout_handler) - signal.alarm(TOR_INIT_TIMEOUT) - - while True: - init_line = self._tor_process.stdout.readline().strip() - - # this will provide empty results if the process is terminated - if not init_line: - self._tor_process.kill() # ... but best make sure - raise OSError("process terminated") - - print term.format(" %s" % init_line, term.Color.BLUE) - - # return the process if we're done with bootstrapping - if init_line.endswith("Bootstrapped 100%: Done."): - print term.format(" done (%i seconds)" % (time.time() - start_time), term.Color.BLUE, term.Attr.BOLD) - return + self._tor_process = stem.process.launch_tor(self.get_torrc_path(), print_init_line) + print term.format(" done (%i seconds)" % (time.time() - start_time), term.Color.BLUE, term.Attr.BOLD) + return except OSError, exc: print term.format(" failed to start tor: %s" % exc, term.Color.RED, term.Attr.BOLD) raise exc

1 0