April 2017 - tor-commits - lists.torproject.org

[tor/master] Merge remote-tracking branch 'dgoulet/bug21293_031_01'
by nickm＠torproject.org 25 Apr '17

25 Apr '17

commit ec7c512d272d366e8e7de61aaf8108bca0adf957 Merge: 6bf82a4 368b091 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Apr 25 10:43:53 2017 -0400 Merge remote-tracking branch 'dgoulet/bug21293_031_01' changes/bug21293 | 5 +++++ src/or/relay.c | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-)

1 0

[tor/master] relay: Change LD_BUG log to LD_PROTOCOL_WARN
by nickm＠torproject.org 25 Apr '17

25 Apr '17

commit 368b0913293dec9b392bce288753f5d90c130431 Author: David Goulet <dgoulet(a)torproject.org> Date: Tue Apr 25 09:24:56 2017 -0400 relay: Change LD_BUG log to LD_PROTOCOL_WARN That log statement can be triggered if somebody on the Internet behaves badly which is possible with buggy implementation for instance. Fixes #21293 Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- changes/bug21293 | 5 +++++ src/or/relay.c | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/changes/bug21293 b/changes/bug21293 new file mode 100644 index 0000000..23a7547 --- /dev/null +++ b/changes/bug21293 @@ -0,0 +1,5 @@ + o Minor bugfixes (cell, logging): + - Downgrade a log statement from bug to protocol warning because there is + at least one use case where it can be triggered by a buggy tor + implementation on the Internet for instance. Fixes bug 21293; bugfix on + tor-0.1.1.14-alpha. diff --git a/src/or/relay.c b/src/or/relay.c index 8524080..1842012 100644 --- a/src/or/relay.c +++ b/src/or/relay.c @@ -226,7 +226,8 @@ circuit_receive_relay_cell(cell_t *cell, circuit_t *circ, return 0; if (relay_crypt(circ, cell, cell_direction, &layer_hint, &recognized) < 0) { - log_warn(LD_BUG,"relay crypt failed. Dropping connection."); + log_fn(LOG_PROTOCOL_WARN, LD_PROTOCOL, + "relay crypt failed. Dropping connection."); return -END_CIRC_REASON_INTERNAL; }

1 0

[tor/master] trace: Add a basic event-tracing infrastructure.
by nickm＠torproject.org 25 Apr '17

25 Apr '17

commit cb8ac1f33102dbe509edf50aa3cac2a106241466 Author: David Goulet <dgoulet(a)torproject.org> Date: Mon Jan 23 14:28:10 2017 -0500 trace: Add a basic event-tracing infrastructure. This commit adds the src/trace directory containing the basics for our tracing subsystem. It is not used in the code base. The "src/trace/debug.h" file contains an example on how we can map our tor trace events to log_debug(). The tracing subsystem can only be enabled by tracing framework at compile time. This commit introduces the "--enable-tracing-debug" option that will make all "tor_trace()" function be maped to "log_debug()". Closes #13802 Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- .gitignore | 3 ++ changes/ticket13802 | 5 +++ configure.ac | 10 ++++++ doc/HACKING/Tracing.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++ src/include.am | 1 + src/or/include.am | 1 + src/test/include.am | 5 +++ src/trace/debug.h | 25 ++++++++++++++ src/trace/events.h | 45 +++++++++++++++++++++++++ src/trace/include.am | 20 +++++++++++ 10 files changed, 205 insertions(+) diff --git a/.gitignore b/.gitignore index f8d6e13..68bad5f 100644 --- a/.gitignore +++ b/.gitignore @@ -125,6 +125,9 @@ uptime-*.json /src/Makefile /src/Makefile.in +# /src/trace +/src/trace/libor-trace.a + # /src/common/ /src/common/Makefile /src/common/Makefile.in diff --git a/changes/ticket13802 b/changes/ticket13802 new file mode 100644 index 0000000..581d5bd --- /dev/null +++ b/changes/ticket13802 @@ -0,0 +1,5 @@ + o Minor features (testing): + - Add general tracing instrumentation to Tor. For now, this subsystem is + not being used by any part of the code, it is for future use or external + testing that is not part of the upstream code base. Any tracing + framework needs to be enabled at compile time. Closes #13802. diff --git a/configure.ac b/configure.ac index c7960fa..ff91735 100644 --- a/configure.ac +++ b/configure.ac @@ -189,6 +189,16 @@ AC_ARG_ENABLE(seccomp, AC_ARG_ENABLE(libscrypt, AS_HELP_STRING(--disable-libscrypt, [do not attempt to use libscrypt])) +dnl Enable event tracing which are transformed to debug log statement. +AC_ARG_ENABLE(event-tracing-debug, + AS_HELP_STRING(--enable-event-tracing-debug, [build with event tracing to debug log])) +AM_CONDITIONAL([USE_EVENT_TRACING_DEBUG], [test "x$enable_event_tracing_debug" = "xyes"]) + +if test x$enable_event_tracing_debug = xyes; then + AC_DEFINE([USE_EVENT_TRACING_DEBUG], [1], [Tracing framework to log debug]) + AC_DEFINE([TOR_EVENT_TRACING_ENABLED], [1], [Compile the event tracing instrumentation]) +fi + dnl check for the correct "ar" when cross-compiling. dnl (AM_PROG_AR was new in automake 1.11.2, which we do not yet require, dnl so kludge up a replacement for the case where it isn't there yet.) diff --git a/doc/HACKING/Tracing.md b/doc/HACKING/Tracing.md new file mode 100644 index 0000000..f4a55b7 --- /dev/null +++ b/doc/HACKING/Tracing.md @@ -0,0 +1,90 @@ +# Tracing # + +This document describes how the tracing subsystem works in tor so developers +can add events to the code base but also hook them to a tracing framework. + +## Basics ### + +Tracing is seperated in two concepts, trace events and a tracer. The tracing +subsystem can be found in `src/trace`. The `events.h` header file is the +main file that maps the different tracers to trace events. + +### Events ### + +A trace event is basically a function from which we can pass any data that +we want to collect. In addition, we specify a context for the event such as +a subsystem and an event name. + +A trace event in tor has the following standard format: + + tor_trace(subsystem, event\_name, args...) + +The `subsystem` parameter is the name of the subsytem the trace event is in. +For example that could be "scheduler" or "vote" or "hs". The idea is to add +some context to the event so when we collect them we know where it's coming +from. The `event_name` is the name of the event which helps a lot with +adding some semantic to the event. Finally, `args` is any number of +arguments we want to collect. + +Here is an example of a possible tracepoint in main(): + + tor_trace(main, init_phase, argc) + +The above is a tracepoint in the `main` subsystem with `init_phase` as the +event name and the `int argc` is passed to the event as well. + +How `argc` is collected or used has nothing to do with the instrumentation +(adding trace events to the code). It is the work of the tracer so this is why +the trace events and collection framework (tracer) are decoupled. You _can_ +have trace events without a tracer. + +### Tracer ### + +In `src/trace/events.h`, we map the `tor_trace()` function to the right +tracer. A tracer support is only enabled at compile time. For instance, the +file `src/trace/debug.h` contains the mapping of the generic tracing function +`tor_trace()` to the `log_debug()` function. More specialized function can be +mapped depending on the tracepoint. + +## Build System ## + +This section describes how it is integrated into the build system of tor. + +By default, every tracing events are disabled in tor that is `tor_trace()` +is a NOP. + +To enable a tracer, there is a configure option on the form of: + + --enable-tracing-<tracer> + +We have an option that will send every trace events to a `log_debug()` (as +mentionned above) which will print you the subsystem and name of the event but +not the arguments for technical reasons. This is useful if you want to quickly +see if your trace event is being hit or well written. To do so, use this +configure option: + + --enable-tracing-debug + +## Instrument Tor ## + +This is pretty easy. Let's say you want to add a trace event in +`src/or/rendcache.c`, you only have to add this include statement: + + #include "trace/events.h" + +Once done, you can add as many as you want `tor_trace()` that you need. +Please use the right subsystem (here it would be `hs`) and a unique name that +tells what the event is for. For example: + + tor_trace(hs, store_desc_as_client, desc, desc_id); + +If you look in `src/trace/events.h`, you'll see that if tracing is enabled it +will be mapped to a function called: + + tor_trace_hs_store_desc_as_client(desc, desc_id) + +And the point of all this is for that function to be defined in a new file +that you might want to add named `src/trace/hs.{c|h}` which would defined how +to collect the data for the `tor_trace_hs_store_desc_as_client()` function +like for instance sending it to a `log_debug()` or do more complex operations +or use a userspace tracer like LTTng (https://lttng.org) diff --git a/src/include.am b/src/include.am index d12684e..f78853f 100644 --- a/src/include.am +++ b/src/include.am @@ -7,3 +7,4 @@ include src/tools/include.am include src/win32/include.am include src/config/include.am include src/test/fuzz/include.am +include src/trace/include.am diff --git a/src/or/include.am b/src/or/include.am index 483ea2f..4c24dd2 100644 --- a/src/or/include.am +++ b/src/or/include.am @@ -120,6 +120,7 @@ src_or_tor_LDFLAGS = @TOR_LDFLAGS_zlib@ @TOR_LDFLAGS_openssl@ @TOR_LDFLAGS_libev src_or_tor_LDADD = src/or/libtor.a src/common/libor.a src/common/libor-ctime.a \ src/common/libor-crypto.a $(LIBKECCAK_TINY) $(LIBDONNA) \ src/common/libor-event.a src/trunnel/libor-trunnel.a \ + src/trace/libor-trace.a \ @TOR_ZLIB_LIBS@ @TOR_LIB_MATH@ @TOR_LIBEVENT_LIBS@ @TOR_OPENSSL_LIBS@ \ @TOR_LIB_WS32@ @TOR_LIB_GDI@ @CURVE25519_LIBS@ @TOR_SYSTEMD_LIBS@ \ @TOR_LZMA_LIBS@ @TOR_ZSTD_LIBS@ diff --git a/src/test/include.am b/src/test/include.am index 653adad..230a6c8 100644 --- a/src/test/include.am +++ b/src/test/include.am @@ -193,6 +193,7 @@ src_test_test_LDADD = src/or/libtor-testing.a \ src/common/libor-ctime-testing.a \ src/common/libor-event-testing.a \ src/trunnel/libor-trunnel-testing.a \ + src/trace/libor-trace.a \ @TOR_ZLIB_LIBS@ @TOR_LIB_MATH@ @TOR_LIBEVENT_LIBS@ \ @TOR_OPENSSL_LIBS@ @TOR_LIB_WS32@ @TOR_LIB_GDI@ @CURVE25519_LIBS@ \ @TOR_SYSTEMD_LIBS@ @TOR_LZMA_LIBS@ @TOR_ZSTD_LIBS@ @@ -216,6 +217,7 @@ src_test_bench_LDADD = src/or/libtor.a src/common/libor.a \ src/common/libor-ctime.a \ src/common/libor-crypto.a $(LIBKECCAK_TINY) $(LIBDONNA) \ src/common/libor-event.a src/trunnel/libor-trunnel.a \ + src/trace/libor-trace.a \ @TOR_ZLIB_LIBS@ @TOR_LIB_MATH@ @TOR_LIBEVENT_LIBS@ \ @TOR_OPENSSL_LIBS@ @TOR_LIB_WS32@ @TOR_LIB_GDI@ @CURVE25519_LIBS@ \ @TOR_SYSTEMD_LIBS@ @TOR_LZMA_LIBS@ @TOR_ZSTD_LIBS@ @@ -227,6 +229,7 @@ src_test_test_workqueue_LDADD = src/or/libtor-testing.a \ src/common/libor-ctime-testing.a \ src/common/libor-crypto-testing.a $(LIBKECCAK_TINY) $(LIBDONNA) \ src/common/libor-event-testing.a \ + src/trace/libor-trace.a \ @TOR_ZLIB_LIBS@ @TOR_LIB_MATH@ @TOR_LIBEVENT_LIBS@ \ @TOR_OPENSSL_LIBS@ @TOR_LIB_WS32@ @TOR_LIB_GDI@ @CURVE25519_LIBS@ \ @TOR_LZMA_LIBS@ @TOR_ZSTD_LIBS@ @@ -264,6 +267,7 @@ src_test_test_ntor_cl_LDFLAGS = @TOR_LDFLAGS_zlib@ @TOR_LDFLAGS_openssl@ src_test_test_ntor_cl_LDADD = src/or/libtor.a src/common/libor.a \ src/common/libor-ctime.a \ src/common/libor-crypto.a $(LIBKECCAK_TINY) $(LIBDONNA) \ + src/trace/libor-trace.a \ @TOR_ZLIB_LIBS@ @TOR_LIB_MATH@ \ @TOR_OPENSSL_LIBS@ @TOR_LIB_WS32@ @TOR_LIB_GDI@ @CURVE25519_LIBS@ \ @TOR_LZMA_LIBS@ @@ -285,6 +289,7 @@ noinst_PROGRAMS += src/test/test-bt-cl src_test_test_bt_cl_SOURCES = src/test/test_bt_cl.c src_test_test_bt_cl_LDADD = src/common/libor-testing.a \ src/common/libor-ctime-testing.a \ + src/trace/libor-trace.a \ @TOR_LIB_MATH@ \ @TOR_LIB_WS32@ @TOR_LIB_GDI@ src_test_test_bt_cl_CFLAGS = $(AM_CFLAGS) $(TEST_CFLAGS) diff --git a/src/trace/debug.h b/src/trace/debug.h new file mode 100644 index 0000000..3a16525 --- /dev/null +++ b/src/trace/debug.h @@ -0,0 +1,25 @@ +/* Copyright (c) 2017, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ + +#ifndef TOR_TRACE_LOG_DEBUG_H +#define TOR_TRACE_LOG_DEBUG_H + +#include "torlog.h" + +/* Stringify pre-processor trick. */ +#define XSTR(d) STR(d) +#define STR(s) #s + +/* Send every event to a debug log level. This is useful to debug new trace + * events without implementing them for a specific event tracing framework. + * Note that the arguments are ignored since at this step we do not know the + * types and amount there is. */ + +/* Example on how to map a tracepoint to log_debug(). */ +#undef tor_trace +#define tor_trace(subsystem, name, args...) \ + log_debug(LD_GENERAL, "Trace event \"" XSTR(name) "\" from " \ + "\"" XSTR(subsystem) "\" hit. " \ + "(line "XSTR(__LINE__) ")") + +#endif /* TOR_TRACE_LOG_DEBUG_H */ diff --git a/src/trace/events.h b/src/trace/events.h new file mode 100644 index 0000000..1be1fd5 --- /dev/null +++ b/src/trace/events.h @@ -0,0 +1,45 @@ +/* Copyright (c) 2017, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ + +/** + * \file events.h + * \brief Header file for Tor event tracing. + **/ + +#ifndef TOR_TRACE_EVENTS_H +#define TOR_TRACE_EVENTS_H + +/* + * The following defines a generic event tracing function name that has to be + * used to trace events in the code base. + * + * That generic function is then defined by a event tracing framework. For + * instance, the "log debug" framework sends all trace events to log_debug() + * which is defined in src/trace/debug.h which can only be enabled at compile + * time (--enable-event-tracing-debug). + * + * By default, every trace events in the code base are replaced by a NOP. See + * doc/HACKING/Tracing.md for more information on how to use event tracing or + * add events. + */ + +#ifdef TOR_EVENT_TRACING_ENABLED +/* Map every trace event to a per subsystem macro. */ +#define tor_trace(subsystem, name, ...) \ + tor_trace_##subsystem(name, __VA_ARGS__) + +/* Enable event tracing for the debug framework where all trace events are + * mapped to a log_debug(). */ +#ifdef USE_EVENT_TRACING_DEBUG +#include "trace/debug.h" +#endif + +#else /* TOR_EVENT_TRACING_ENABLED */ + +/* Reaching this point, we NOP every event declaration because event tracing + * is not been enabled at compile time. */ +#define tor_trace(subsystem, name, args...) + +#endif /* TOR_EVENT_TRACING_ENABLED */ + +#endif /* TOR_TRACE_EVENTS_H */ diff --git a/src/trace/include.am b/src/trace/include.am new file mode 100644 index 0000000..f7de1fb --- /dev/null +++ b/src/trace/include.am @@ -0,0 +1,20 @@ +# Include the src/ so we can use the trace/events.h statement when including +# any file in that directory. +AM_CPPFLAGS += -I$(srcdir)/src + +noinst_LIBRARIES += \ + src/trace/libor-trace.a +LIBOR_TRACE_A_SOURCES = + +TRACEHEADERS = \ + src/trace/events.h + +if USE_EVENT_TRACING_DEBUG +TRACEHEADERS += \ + src/trace/debug.h +endif + +# Library source files. +src_trace_libor_trace_a_SOURCES = $(LIBOR_TRACE_A_SOURCES) + +noinst_HEADERS+= $(TRACEHEADERS)

1 0

[tor/master] More clarification on 13802
by nickm＠torproject.org 25 Apr '17

25 Apr '17

commit 6bf82a4910db3f20c2cb81d7569224f4322681f2 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Apr 25 10:40:27 2017 -0400 More clarification on 13802 --- changes/ticket13802 | 10 ++++++---- doc/HACKING/Tracing.md | 11 ++++++----- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/changes/ticket13802 b/changes/ticket13802 index 581d5bd..35cd2b5 100644 --- a/changes/ticket13802 +++ b/changes/ticket13802 @@ -1,5 +1,7 @@ o Minor features (testing): - - Add general tracing instrumentation to Tor. For now, this subsystem is - not being used by any part of the code, it is for future use or external - testing that is not part of the upstream code base. Any tracing - framework needs to be enabled at compile time. Closes #13802. + - Add a general event-tracing instrumentation support to Tor. This + subsystem will enable developers and researchers to add fine-grained + instrumentation to their Tor instances, for use when examining Tor + network performance issues. There are no trace events yet, and + event-tracing is off by default unless enabled at compile time. + Implements ticket 13802. diff --git a/doc/HACKING/Tracing.md b/doc/HACKING/Tracing.md index f4a55b7..a5fb516 100644 --- a/doc/HACKING/Tracing.md +++ b/doc/HACKING/Tracing.md @@ -1,13 +1,14 @@ # Tracing # -This document describes how the tracing subsystem works in tor so developers -can add events to the code base but also hook them to a tracing framework. +This document describes how the event tracing subsystem works in tor so +developers can add events to the code base but also hook them to an event +tracing framework. ## Basics ### -Tracing is seperated in two concepts, trace events and a tracer. The tracing -subsystem can be found in `src/trace`. The `events.h` header file is the -main file that maps the different tracers to trace events. +Event tracing is seperated in two concepts, trace events and a tracer. The +tracing subsystem can be found in `src/trace`. The `events.h` header file is +the main file that maps the different tracers to trace events. ### Events ###

1 0

[tor/master] Rename shadowing variable in compress_zlib.c.
by nickm＠torproject.org 25 Apr '17

25 Apr '17

commit 91dd4a00f7d4891e24187a849933547128aeeb9f Author: Alexander Færøy <ahf(a)torproject.org> Date: Tue Apr 25 14:46:02 2017 +0200 Rename shadowing variable in compress_zlib.c. This patch renames the `compress` parameter of the `tor_zlib_compress_new()` function to `_compress` to avoid shadowing the `compress()` function in zlib.h. --- src/common/compress_zlib.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/common/compress_zlib.c b/src/common/compress_zlib.c index 50bdf9e..faa179f 100644 --- a/src/common/compress_zlib.c +++ b/src/common/compress_zlib.c @@ -406,14 +406,14 @@ tor_zlib_state_size_precalc(int inflate_, int windowbits, int memlevel) * <b>method</b>. If <b>compress</b>, it's for compression; otherwise it's for * decompression. */ tor_zlib_compress_state_t * -tor_zlib_compress_new(int compress, +tor_zlib_compress_new(int compress_, compress_method_t method, compression_level_t compression_level) { tor_zlib_compress_state_t *out; int bits, memlevel; - if (! compress) { + if (! compress_) { /* use this setting for decompression, since we might have the * max number of window bits */ compression_level = HIGH_COMPRESSION; @@ -423,10 +423,10 @@ tor_zlib_compress_new(int compress, out->stream.zalloc = Z_NULL; out->stream.zfree = Z_NULL; out->stream.opaque = NULL; - out->compress = compress; + out->compress = compress_; bits = method_bits(method, compression_level); memlevel = memory_level(compression_level); - if (compress) { + if (compress_) { if (deflateInit2(&out->stream, Z_BEST_COMPRESSION, Z_DEFLATED, bits, memlevel, Z_DEFAULT_STRATEGY) != Z_OK) @@ -435,7 +435,7 @@ tor_zlib_compress_new(int compress, if (inflateInit2(&out->stream, bits) != Z_OK) goto err; // LCOV_EXCL_LINE } - out->allocation = tor_zlib_state_size_precalc(!compress, bits, memlevel); + out->allocation = tor_zlib_state_size_precalc(!compress_, bits, memlevel); total_zlib_allocation += out->allocation;

1 0

[tor/master] changes file for 21662/21663/21664
by nickm＠torproject.org 25 Apr '17

25 Apr '17

commit 754b86ba01db81b109c657a33a19978d5703a72b Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Apr 25 08:22:21 2017 -0400 changes file for 21662/21663/21664 --- changes/21662_21663_21664 | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/changes/21662_21663_21664 b/changes/21662_21663_21664 new file mode 100644 index 0000000..6712b0f --- /dev/null +++ b/changes/21662_21663_21664 @@ -0,0 +1,12 @@ + o Major features: + - Tor's compression module now includes support for the zstd and lzma2 + compression algorithms, if the libzstd and liblzma libraries are + available when Tor is compiled. Once these features are exposed in the + directory module, they will enable Tor to provide better compression + ratios on directory documents. Part of an implementation for proposal + 278; closes ticket 21662. + + o Code simplification and refactoring: + - Tor's compression module now supports multiple backends. Part of + an implementation of proposal 278; closes ticket 21663. +

1 0

[tor/master] Use tt_int_op() over tt_assert() and do explicit NULL checks in test_util_gzip().
by nickm＠torproject.org 25 Apr '17

25 Apr '17

commit a8821d83660c5ed6244e3ad414b348890da93050 Author: Alexander Færøy <ahf(a)torproject.org> Date: Mon Apr 17 14:02:16 2017 +0200 Use tt_int_op() over tt_assert() and do explicit NULL checks in test_util_gzip(). This patch changes some of the tt_assert() usage in test_util_gzip() to use tt_int_op() to get better error messages upon failure. Additionally we move to use explicit NULL checks. See https://bugs.torproject.org/21663 --- src/test/test_util.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/test/test_util.c b/src/test/test_util.c index 203f9dd..4ad4ffa 100644 --- a/src/test/test_util.c +++ b/src/test/test_util.c @@ -2257,13 +2257,13 @@ test_util_gzip(void *arg) tt_assert(!tor_gzip_compress(&buf2, &len1, buf1, strlen(buf1)+1, GZIP_METHOD)); - tt_assert(buf2); - tt_assert(len1 < strlen(buf1)); - tt_assert(detect_compression_method(buf2, len1) == GZIP_METHOD); + tt_assert(buf2 != NULL); + tt_int_op(len1, OP_LT, strlen(buf1)); + tt_int_op(detect_compression_method(buf2, len1), OP_EQ, GZIP_METHOD); tt_assert(!tor_gzip_uncompress(&buf3, &len2, buf2, len1, GZIP_METHOD, 1, LOG_INFO)); - tt_assert(buf3); + tt_assert(buf3 != NULL); tt_int_op(strlen(buf1) + 1,OP_EQ, len2); tt_str_op(buf1,OP_EQ, buf3); @@ -2273,11 +2273,11 @@ test_util_gzip(void *arg) tt_assert(!tor_gzip_compress(&buf2, &len1, buf1, strlen(buf1)+1, ZLIB_METHOD)); tt_assert(buf2); - tt_assert(detect_compression_method(buf2, len1) == ZLIB_METHOD); + tt_int_op(detect_compression_method(buf2, len1), OP_EQ, ZLIB_METHOD); tt_assert(!tor_gzip_uncompress(&buf3, &len2, buf2, len1, ZLIB_METHOD, 1, LOG_INFO)); - tt_assert(buf3); + tt_assert(buf3 != NULL); tt_int_op(strlen(buf1) + 1,OP_EQ, len2); tt_str_op(buf1,OP_EQ, buf3); @@ -2302,7 +2302,7 @@ test_util_gzip(void *arg) tor_strdup("String with low redundancy that won't be compressed much."); tt_assert(!tor_gzip_compress(&buf2, &len1, buf1, strlen(buf1)+1, ZLIB_METHOD)); - tt_assert(len1>16); + tt_int_op(len1, OP_GT, 16); /* when we allow an incomplete string, we should succeed.*/ tt_assert(!tor_gzip_uncompress(&buf3, &len2, buf2, len1-16, ZLIB_METHOD, 0, LOG_INFO)); @@ -2314,7 +2314,7 @@ test_util_gzip(void *arg) tor_free(buf3); tt_assert(tor_gzip_uncompress(&buf3, &len2, buf2, len1-16, ZLIB_METHOD, 1, LOG_INFO)); - tt_assert(!buf3); + tt_assert(buf3 == NULL); /* Now, try streaming compression. */ tor_free(buf1);

1 0

[tor/master] Remove unused function `is_gzip_supported()`.
by nickm＠torproject.org 25 Apr '17

25 Apr '17

commit 7460b9755aa0b9b4a54c5c80e47dfdf8c8fc513a Author: Alexander Færøy <ahf(a)torproject.org> Date: Mon Apr 17 14:11:35 2017 +0200 Remove unused function `is_gzip_supported()`. This patch removes the unused `is_gzip_supported()` and changes the documentation string around the `compress_method_t` enumeration to explicitly state that both `ZLIB_METHOD` and `GZIP_METHOD` are both always supported. Zlib version 1.2.0 was released on the 9'th of March, 2003 according to their ChangeLog. See https://bugs.torproject.org/21663 --- src/common/torgzip.h | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/src/common/torgzip.h b/src/common/torgzip.h index 430b152..42b45ab 100644 --- a/src/common/torgzip.h +++ b/src/common/torgzip.h @@ -11,10 +11,9 @@ #ifndef TOR_TORGZIP_H #define TOR_TORGZIP_H -/** Enumeration of what kind of compression to use. Only ZLIB_METHOD is - * guaranteed to be supported by the compress/uncompress functions here; - * GZIP_METHOD may be supported if we built against zlib version 1.2 or later - * and is_gzip_supported() returns true. */ +/** Enumeration of what kind of compression to use. Only ZLIB_METHOD and + * GZIP_METHOD is guaranteed to be supported by the compress/uncompress + * functions here. */ typedef enum { NO_METHOD=0, GZIP_METHOD=1, ZLIB_METHOD=2, UNKNOWN_METHOD=3 } compress_method_t; @@ -39,8 +38,6 @@ tor_gzip_uncompress(char **out, size_t *out_len, int complete_only, int protocol_warn_level); -int is_gzip_supported(void); - const char * tor_zlib_get_version_str(void);

1 0

[tor/master] Rename `zlib_state` to `compress_state` in `dir_connection_t`.
by nickm＠torproject.org 25 Apr '17

25 Apr '17

commit 4b9349192d4bd2e9c598b13d74bc826c8f16d40e Author: Alexander Færøy <ahf(a)torproject.org> Date: Tue Apr 18 01:10:25 2017 +0200 Rename `zlib_state` to `compress_state` in `dir_connection_t`. This patch renames the `zlib_state` field in `dir_connection_t` to `compress_state`. See https://bugs.torproject.org/21663 --- src/or/circuitlist.c | 8 ++++---- src/or/connection.c | 4 ++-- src/or/directory.c | 13 +++++++------ src/or/dirserv.c | 10 +++++----- src/or/or.h | 2 +- 5 files changed, 19 insertions(+), 18 deletions(-) diff --git a/src/or/circuitlist.c b/src/or/circuitlist.c index 4f11586..365e5b2 100644 --- a/src/or/circuitlist.c +++ b/src/or/circuitlist.c @@ -1990,10 +1990,10 @@ single_conn_free_bytes(connection_t *conn) } if (conn->type == CONN_TYPE_DIR) { dir_connection_t *dir_conn = TO_DIR_CONN(conn); - if (dir_conn->zlib_state) { - result += tor_compress_state_size(dir_conn->zlib_state); - tor_compress_free(dir_conn->zlib_state); - dir_conn->zlib_state = NULL; + if (dir_conn->compress_state) { + result += tor_compress_state_size(dir_conn->compress_state); + tor_compress_free(dir_conn->compress_state); + dir_conn->compress_state = NULL; } } return result; diff --git a/src/or/connection.c b/src/or/connection.c index ad97c3b..70b08e2 100644 --- a/src/or/connection.c +++ b/src/or/connection.c @@ -628,7 +628,7 @@ connection_free_(connection_t *conn) dir_connection_t *dir_conn = TO_DIR_CONN(conn); tor_free(dir_conn->requested_resource); - tor_compress_free(dir_conn->zlib_state); + tor_compress_free(dir_conn->compress_state); if (dir_conn->spool) { SMARTLIST_FOREACH(dir_conn->spool, spooled_resource_t *, spooled, spooled_resource_free(spooled)); @@ -4061,7 +4061,7 @@ connection_write_to_buf_impl_,(const char *string, size_t len, dir_connection_t *dir_conn = TO_DIR_CONN(conn); int done = zlib < 0; CONN_LOG_PROTECT(conn, r = write_to_buf_zlib(conn->outbuf, - dir_conn->zlib_state, + dir_conn->compress_state, string, len, done)); } else { CONN_LOG_PROTECT(conn, r = write_to_buf(string, len, conn->outbuf)); diff --git a/src/or/directory.c b/src/or/directory.c index 5ae61e4..098683e 100644 --- a/src/or/directory.c +++ b/src/or/directory.c @@ -3178,7 +3178,8 @@ handle_get_current_consensus(dir_connection_t *conn, write_http_response_header(conn, -1, compressed, smartlist_len(conn->spool) == 1 ? lifetime : 0); if (! compressed) - conn->zlib_state = tor_compress_new(0, ZLIB_METHOD, HIGH_COMPRESSION); + conn->compress_state = tor_compress_new(0, ZLIB_METHOD, + HIGH_COMPRESSION); /* Prime the connection with some data. */ const int initial_flush_result = connection_dirserv_flushed_some(conn); @@ -3276,7 +3277,7 @@ handle_get_status_vote(dir_connection_t *conn, const get_handler_args_t *args) if (smartlist_len(items)) { if (compressed) { - conn->zlib_state = tor_compress_new(1, ZLIB_METHOD, + conn->compress_state = tor_compress_new(1, ZLIB_METHOD, choose_compression_level(estimated_len)); SMARTLIST_FOREACH(items, const char *, c, connection_write_to_buf_zlib(c, strlen(c), conn, 0)); @@ -3335,7 +3336,7 @@ handle_get_microdesc(dir_connection_t *conn, const get_handler_args_t *args) write_http_response_header(conn, -1, compressed, MICRODESC_CACHE_LIFETIME); if (compressed) - conn->zlib_state = tor_compress_new(1, ZLIB_METHOD, + conn->compress_state = tor_compress_new(1, ZLIB_METHOD, choose_compression_level(size_guess)); const int initial_flush_result = connection_dirserv_flushed_some(conn); @@ -3428,7 +3429,7 @@ handle_get_descriptor(dir_connection_t *conn, const get_handler_args_t *args) } write_http_response_header(conn, -1, compressed, cache_lifetime); if (compressed) - conn->zlib_state = tor_compress_new(1, ZLIB_METHOD, + conn->compress_state = tor_compress_new(1, ZLIB_METHOD, choose_compression_level(size_guess)); clear_spool = 0; /* Prime the connection with some data. */ @@ -3519,8 +3520,8 @@ handle_get_keys(dir_connection_t *conn, const get_handler_args_t *args) write_http_response_header(conn, compressed?-1:len, compressed, 60*60); if (compressed) { - conn->zlib_state = tor_compress_new(1, ZLIB_METHOD, - choose_compression_level(len)); + conn->compress_state = tor_compress_new(1, ZLIB_METHOD, + choose_compression_level(len)); SMARTLIST_FOREACH(certs, authority_cert_t *, c, connection_write_to_buf_zlib(c->cache_info.signed_descriptor_body, c->cache_info.signed_descriptor_len, diff --git a/src/or/dirserv.c b/src/or/dirserv.c index 186478c..2746d09 100644 --- a/src/or/dirserv.c +++ b/src/or/dirserv.c @@ -3497,7 +3497,7 @@ spooled_resource_flush_some(spooled_resource_t *spooled, /* Absent objects count as "done". */ return SRFS_DONE; } - if (conn->zlib_state) { + if (conn->compress_state) { connection_write_to_buf_zlib((const char*)body, bodylen, conn, 0); } else { connection_write_to_buf((const char*)body, bodylen, TO_CONN(conn)); @@ -3523,7 +3523,7 @@ spooled_resource_flush_some(spooled_resource_t *spooled, if (BUG(remaining < 0)) return SRFS_ERR; ssize_t bytes = (ssize_t) MIN(DIRSERV_CACHED_DIR_CHUNK_SIZE, remaining); - if (conn->zlib_state) { + if (conn->compress_state) { connection_write_to_buf_zlib(cached->dir_z + spooled->cached_dir_offset, bytes, conn, 0); } else { @@ -3788,12 +3788,12 @@ connection_dirserv_flushed_some(dir_connection_t *conn) /* If we get here, we're done. */ smartlist_free(conn->spool); conn->spool = NULL; - if (conn->zlib_state) { + if (conn->compress_state) { /* Flush the zlib state: there could be more bytes pending in there, and * we don't want to omit bytes. */ connection_write_to_buf_zlib("", 0, conn, 1); - tor_compress_free(conn->zlib_state); - conn->zlib_state = NULL; + tor_compress_free(conn->compress_state); + conn->compress_state = NULL; } return 0; } diff --git a/src/or/or.h b/src/or/or.h index 6aec588..20c4ebc 100644 --- a/src/or/or.h +++ b/src/or/or.h @@ -1774,7 +1774,7 @@ typedef struct dir_connection_t { * it from back to front. */ smartlist_t *spool; /** The compression object doing on-the-fly compression for spooled data. */ - tor_compress_state_t *zlib_state; + tor_compress_state_t *compress_state; /** What rendezvous service are we querying for? */ rend_data_t *rend_data;

1 0

[tor/master] Rename `zlib_state` to `compress_state` in the test_buffers.
by nickm＠torproject.org 25 Apr '17

25 Apr '17

commit 40ed68290e69d32d95bc0d0c259d8c76ae3e80ef Author: Alexander Færøy <ahf(a)torproject.org> Date: Tue Apr 18 01:12:01 2017 +0200 Rename `zlib_state` to `compress_state` in the test_buffers. See https://bugs.torproject.org/21663 --- src/test/test_buffers.c | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/src/test/test_buffers.c b/src/test/test_buffers.c index a6f0309..be757ae 100644 --- a/src/test/test_buffers.c +++ b/src/test/test_buffers.c @@ -584,22 +584,23 @@ test_buffers_zlib_impl(int finalize_with_nil) char *contents = NULL; char *expanded = NULL; buf_t *buf = NULL; - tor_compress_state_t *zlib_state = NULL; + tor_compress_state_t *compress_state = NULL; size_t out_len, in_len; int done; buf = buf_new_with_capacity(128); /* will round up */ - zlib_state = tor_compress_new(1, ZLIB_METHOD, HIGH_COMPRESSION); + compress_state = tor_compress_new(1, ZLIB_METHOD, HIGH_COMPRESSION); msg = tor_malloc(512); crypto_rand(msg, 512); - tt_int_op(write_to_buf_zlib(buf, zlib_state, msg, 128, 0), OP_EQ, 0); - tt_int_op(write_to_buf_zlib(buf, zlib_state, msg+128, 128, 0), OP_EQ, 0); - tt_int_op(write_to_buf_zlib(buf, zlib_state, msg+256, 256, 0), OP_EQ, 0); + tt_int_op(write_to_buf_zlib(buf, compress_state, msg, 128, 0), OP_EQ, 0); + tt_int_op(write_to_buf_zlib(buf, compress_state, msg+128, 128, 0), OP_EQ, 0); + tt_int_op(write_to_buf_zlib(buf, compress_state, msg+256, 256, 0), OP_EQ, 0); done = !finalize_with_nil; - tt_int_op(write_to_buf_zlib(buf, zlib_state, "all done", 9, done), OP_EQ, 0); + tt_int_op(write_to_buf_zlib(buf, compress_state, + "all done", 9, done), OP_EQ, 0); if (finalize_with_nil) { - tt_int_op(write_to_buf_zlib(buf, zlib_state, "", 0, 1), OP_EQ, 0); + tt_int_op(write_to_buf_zlib(buf, compress_state, "", 0, 1), OP_EQ, 0); } in_len = buf_datalen(buf); @@ -621,7 +622,7 @@ test_buffers_zlib_impl(int finalize_with_nil) done: buf_free(buf); - tor_compress_free(zlib_state); + tor_compress_free(compress_state); tor_free(contents); tor_free(expanded); tor_free(msg); @@ -647,7 +648,7 @@ test_buffers_zlib_fin_at_chunk_end(void *arg) char *contents = NULL; char *expanded = NULL; buf_t *buf = NULL; - tor_compress_state_t *zlib_state = NULL; + tor_compress_state_t *compress_state = NULL; size_t out_len, in_len; size_t sz, headerjunk; (void) arg; @@ -666,8 +667,8 @@ test_buffers_zlib_fin_at_chunk_end(void *arg) tt_uint_op(buf->head->datalen, OP_EQ, headerjunk); tt_uint_op(buf_datalen(buf), OP_EQ, headerjunk); /* Write an empty string, with finalization on. */ - zlib_state = tor_compress_new(1, ZLIB_METHOD, HIGH_COMPRESSION); - tt_int_op(write_to_buf_zlib(buf, zlib_state, "", 0, 1), OP_EQ, 0); + compress_state = tor_compress_new(1, ZLIB_METHOD, HIGH_COMPRESSION); + tt_int_op(write_to_buf_zlib(buf, compress_state, "", 0, 1), OP_EQ, 0); in_len = buf_datalen(buf); contents = tor_malloc(in_len); @@ -687,7 +688,7 @@ test_buffers_zlib_fin_at_chunk_end(void *arg) done: buf_free(buf); - tor_compress_free(zlib_state); + tor_compress_free(compress_state); tor_free(contents); tor_free(expanded); tor_free(msg);

1 0