January 2015 - tor-commits - lists.torproject.org

[tor/master] Documentation for new workqueue and condition and locking stuff
by nickm＠torproject.org 21 Jan '15

21 Jan '15

commit b2db3fb4627c8bd06489334f69b6d36d60fb418d Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Sep 25 11:05:27 2013 -0400 Documentation for new workqueue and condition and locking stuff --- src/common/compat_pthreads.c | 11 ++- src/common/compat_threads.c | 39 ++++++++- src/common/compat_threads.h | 12 ++- src/common/workqueue.c | 178 +++++++++++++++++++++++++++++++++--------- src/common/workqueue.h | 14 +++- 5 files changed, 205 insertions(+), 49 deletions(-) diff --git a/src/common/compat_pthreads.c b/src/common/compat_pthreads.c index 59b54a6..a2e4065 100644 --- a/src/common/compat_pthreads.c +++ b/src/common/compat_pthreads.c @@ -164,6 +164,7 @@ tor_get_thread_id(void) /* Conditions. */ +/** Initialize an already-allocated condition variable. */ int tor_cond_init(tor_cond_t *cond) { @@ -173,7 +174,9 @@ tor_cond_init(tor_cond_t *cond) } return 0; } -/** Release all resources held by cond. */ + +/** Release all resources held by cond, but do not free cond + * itself. */ void tor_cond_uninit(tor_cond_t *cond) { @@ -183,7 +186,11 @@ tor_cond_uninit(tor_cond_t *cond) } } /** Wait until one of the tor_cond_signal functions is called on cond. - * All waiters on the condition must wait holding the same mutex. + * (If tv is set, and that amount of time passes with no signal to + * cond, return anyway. All waiters on the condition must wait holding + * the same mutex. All signallers should hold that mutex. The mutex + * needs to have been allocated with tor_mutex_init_for_cond(). + * * Returns 0 on success, -1 on failure, 1 on timeout. */ int tor_cond_wait(tor_cond_t *cond, tor_mutex_t *mutex, const struct timeval *tv) diff --git a/src/common/compat_threads.c b/src/common/compat_threads.c index 98bdbbc..024c627 100644 --- a/src/common/compat_threads.c +++ b/src/common/compat_threads.c @@ -40,6 +40,7 @@ tor_mutex_free(tor_mutex_t *m) tor_free(m); } +/** Allocate and return a new condition variable. */ tor_cond_t * tor_cond_new(void) { @@ -48,6 +49,8 @@ tor_cond_new(void) tor_free(cond); return cond; } + +/** Free all storage held in c. */ void tor_cond_free(tor_cond_t *c) { @@ -140,13 +143,16 @@ sock_drain(tor_socket_t fd) return 0; } -/** Allocate a new set of alert sockets. DOCDOC */ +/** Allocate a new set of alert sockets, and set the appropriate function + * pointers, in socks_out. */ int alert_sockets_create(alert_sockets_t *socks_out) { tor_socket_t socks[2]; #ifdef HAVE_EVENTFD + /* First, we try the Linux eventfd() syscall. This gives a 64-bit counter + * associated with a single file descriptor. */ #if defined(EFD_CLOEXEC) && defined(EFD_NONBLOCK) socks[0] = eventfd(0, EFD_CLOEXEC|EFD_NONBLOCK); #else @@ -171,6 +177,8 @@ alert_sockets_create(alert_sockets_t *socks_out) #endif #ifdef HAVE_PIPE2 + /* Now we're going to try pipes. First type the pipe2() syscall, if we + * have it, so we can save some calls... */ if (pipe2(socks, O_NONBLOCK|O_CLOEXEC) == 0) { socks_out->read_fd = socks[0]; socks_out->write_fd = socks[1]; @@ -181,6 +189,8 @@ alert_sockets_create(alert_sockets_t *socks_out) #endif #ifdef HAVE_PIPE + /* Now try the regular pipe() syscall. Pipes have a bit lower overhead than + * socketpairs, fwict. */ if (pipe(socks) == 0) { if (fcntl(socks[0], F_SETFD, FD_CLOEXEC) < 0 || fcntl(socks[1], F_SETFD, FD_CLOEXEC) < 0 || @@ -198,12 +208,35 @@ alert_sockets_create(alert_sockets_t *socks_out) } #endif + /* If nothing else worked, fall back on socketpair(). */ if (tor_socketpair(AF_UNIX, SOCK_STREAM, 0, socks) == 0) { - set_socket_nonblocking(socks[0]); - set_socket_nonblocking(socks[1]); + if (set_socket_nonblocking(socks[0]) < 0 || + set_socket_nonblocking(socks[1])) { + tor_close_socket(socks[0]); + tor_close_socket(socks[1]); + return -1; + } + socks_out->read_fd = socks[0]; + socks_out->write_fd = socks[1]; socks_out->alert_fn = sock_alert; socks_out->drain_fn = sock_drain; return 0; } return -1; } + +/** Close the sockets in socks. */ +void +alert_sockets_close(alert_sockets_t *socks) +{ + if (socks->alert_fn == sock_alert) { + /* they are sockets. */ + tor_close_socket(socks->read_fd); + tor_close_socket(socks->write_fd); + } else { + close(socks->read_fd); + if (socks->write_fd != socks->read_fd) + close(socks->write_fd); + } + socks->read_fd = socks->write_fd = -1; +} diff --git a/src/common/compat_threads.h b/src/common/compat_threads.h index b053136..9070f13 100644 --- a/src/common/compat_threads.h +++ b/src/common/compat_threads.h @@ -82,15 +82,23 @@ int tor_cond_wait(tor_cond_t *cond, tor_mutex_t *mutex, void tor_cond_signal_one(tor_cond_t *cond); void tor_cond_signal_all(tor_cond_t *cond); -/** DOCDOC */ +/** Helper type used to manage waking up the main thread while it's in + * the libevent main loop. Used by the work queue code. */ typedef struct alert_sockets_s { - /*XXX needs a better name */ + /* XXXX This structure needs a better name. */ + /** Socket that the main thread should listen for EV_READ events on. + * Note that this socket may be a regular fd on a non-Windows platform. + */ tor_socket_t read_fd; + /** Socket to use when alerting the main thread. */ tor_socket_t write_fd; + /** Function to alert the main thread */ int (*alert_fn)(tor_socket_t write_fd); + /** Function to make the main thread no longer alerted. */ int (*drain_fn)(tor_socket_t read_fd); } alert_sockets_t; int alert_sockets_create(alert_sockets_t *socks_out); +void alert_sockets_close(alert_sockets_t *socks); #endif diff --git a/src/common/workqueue.c b/src/common/workqueue.c index c4b64de..e07787b 100644 --- a/src/common/workqueue.c +++ b/src/common/workqueue.c @@ -9,67 +9,84 @@ #include "tor_queue.h" #include "torlog.h" -/* - design: - - each thread has its own queue, try to keep at least elements min..max cycles - worth of work on each queue. - -keep array of threads; round-robin between them. - - When out of work, work-steal. - - alert threads with condition variables. +struct threadpool_s { + /** An array of pointers to workerthread_t: one for each running worker + * thread. */ + struct workerthread_s **threads; + /** Index of the next thread that we'll give work to.*/ + int next_for_work; - alert main thread with fd, since it's libevent. + /** Number of elements in threads. */ + int n_threads; + /** Mutex to protect all the above fields. */ + tor_mutex_t lock; + /** A reply queue to use when constructing new threads. */ + replyqueue_t *reply_queue; - */ + /** Functions used to allocate and free thread state. */ + void *(*new_thread_state_fn)(void*); + void (*free_thread_state_fn)(void*); + void *new_thread_state_arg; +}; struct workqueue_entry_s { + /** The next workqueue_entry_t that's pending on the same thread or + * reply queue. */ TOR_TAILQ_ENTRY(workqueue_entry_s) next_work; + /** The thread to which this workqueue_entry_t was assigned. This field + * is set when the workqueue_entry_t is created, and won't be cleared until + * after it's handled in the main thread. */ struct workerthread_s *on_thread; + /** True iff this entry is waiting for a worker to start processing it. */ uint8_t pending; + /** Function to run in the worker thread. */ int (*fn)(void *state, void *arg); + /** Function to run while processing the reply queue. */ void (*reply_fn)(void *arg); + /** Argument for the above functions. */ void *arg; }; struct replyqueue_s { + /** Mutex to protect the answers field */ tor_mutex_t lock; + /** Doubly-linked list of answers that the reply queue needs to handle. */ TOR_TAILQ_HEAD(, workqueue_entry_s) answers; - alert_sockets_t alert; // lock not held on this. + /** Mechanism to wake up the main thread when it is receiving answers. */ + alert_sockets_t alert; }; +/** A worker thread represents a single thread in a thread pool. To avoid + * contention, each gets its own queue. This breaks the guarantee that that + * queued work will get executed strictly in order. */ typedef struct workerthread_s { + /** Lock to protect all fields of this thread and its queue. */ tor_mutex_t lock; + /** Condition variable that we wait on when we have no work, and which + * gets signaled when our queue becomes nonempty. */ tor_cond_t condition; + /** Queue of pending work that we have to do. */ TOR_TAILQ_HEAD(, workqueue_entry_s) work; + /** True iff this thread is currently in its loop. */ unsigned is_running; + /** True iff this thread has crashed or is shut down for some reason. */ unsigned is_shut_down; + /** True if we're waiting for more elements to get added to the queue. */ unsigned waiting; + /** User-supplied state field that we pass to the worker functions of each + * work item. */ void *state; + /** Reply queue to which we pass our results. */ replyqueue_t *reply_queue; } workerthread_t; -struct threadpool_s { - workerthread_t **threads; - int next_for_work; - - tor_mutex_t lock; - int n_threads; - - replyqueue_t *reply_queue; - - void *(*new_thread_state_fn)(void*); - void (*free_thread_state_fn)(void*); - void *new_thread_state_arg; - -}; - static void queue_reply(replyqueue_t *queue, workqueue_entry_t *work); +/** Allocate and return a new workqueue_entry_t, set up to run the function + * fn in the worker thread, and reply_fn in the main + * thread. See threadpool_queue_work() for full documentation. */ static workqueue_entry_t * workqueue_entry_new(int (*fn)(void*, void*), void (*reply_fn)(void*), @@ -82,6 +99,10 @@ workqueue_entry_new(int (*fn)(void*, void*), return ent; } +/** + * Release all storage held in ent. Call only when ent is not on + * any queue. + */ static void workqueue_entry_free(workqueue_entry_t *ent) { @@ -90,6 +111,20 @@ workqueue_entry_free(workqueue_entry_t *ent) tor_free(ent); } +/** + * Cancel a workqueue_entry_t that has been returned from + * threadpool_queue_work. + * + * You must not call this function on any work whose reply function has been + * executed in the main thread; that will cause undefined behavior (probably, + * a crash). + * + * If the work is cancelled, this function return 1. It is the caller's + * responsibility to free any storage in the work function's arguments. + * + * This function will have no effect if the worker thread has already executed + * or begun to execute the work item. In that case, it will return 0. + */ int workqueue_entry_cancel(workqueue_entry_t *ent) { @@ -107,6 +142,9 @@ workqueue_entry_cancel(workqueue_entry_t *ent) return cancelled; } +/** + * Main function for the worker thread. + */ static void worker_thread_main(void *thread_) { @@ -115,23 +153,26 @@ worker_thread_main(void *thread_) int result; tor_mutex_acquire(&thread->lock); - thread->is_running = 1; while (1) { - /* lock held. */ + /* lock must be held at this point. */ while (!TOR_TAILQ_EMPTY(&thread->work)) { - /* lock held. */ + /* lock must be held at this point. */ work = TOR_TAILQ_FIRST(&thread->work); TOR_TAILQ_REMOVE(&thread->work, work, next_work); work->pending = 0; tor_mutex_release(&thread->lock); + /* We run the work function without holding the thread lock. This + * is the main thread's first opportunity to give us more work. */ result = work->fn(thread->state, work->arg); + /* Queue the reply for the main thread. */ queue_reply(thread->reply_queue, work); tor_mutex_acquire(&thread->lock); + /* We may need to exit the thread. */ if (result >= WQ_RPL_ERROR) { thread->is_running = 0; thread->is_shut_down = 1; @@ -139,19 +180,23 @@ worker_thread_main(void *thread_) return; } } - /* Lock held; no work in this thread's queue. */ + /* At this point the lock is held, and there is no work in this thread's + * queue. */ /* TODO: Try work-stealing. */ - /* TODO: support an idle-function */ + /* Okay. Now, wait till somebody has work for us. */ thread->waiting = 1; - if (tor_cond_wait(&thread->condition, &thread->lock, NULL) < 0) - /* ERR */ + if (tor_cond_wait(&thread->condition, &thread->lock, NULL) < 0) { + /* XXXX ERROR */ + } thread->waiting = 0; } } +/** Put a reply on the reply queue. The reply must not currently be on + * any thread's work queue. */ static void queue_reply(replyqueue_t *queue, workqueue_entry_t *work) { @@ -168,6 +213,8 @@ queue_reply(replyqueue_t *queue, workqueue_entry_t *work) } } +/** Allocate and start a new worker thread to use state object state, + * and send responses to replyqueue. */ static workerthread_t * workerthread_new(void *state, replyqueue_t *replyqueue) { @@ -186,6 +233,10 @@ workerthread_new(void *state, replyqueue_t *replyqueue) return thr; } +/** + * Add an item of work to a single worker thread. See threadpool_queue_work(*) + * for arguments. + */ static workqueue_entry_t * workerthread_queue_work(workerthread_t *worker, int (*fn)(void *, void *), @@ -206,6 +257,23 @@ workerthread_queue_work(workerthread_t *worker, return ent; } +/** + * Queue an item of work for a thread in a thread pool. The function + * fn will be run in a worker thread, and will receive as arguments the + * thread's state object, and the provided object arg. It must return + * one of WQ_RPL_REPLY, WQ_RPL_ERROR, or WQ_RPL_SHUTDOWN. + * + * Regardless of its return value, the function reply_fn will later be + * run in the main thread when it invokes replyqueue_process(), and will + * receive as its argument the same arg object. It's the reply + * function's responsibility to free the work object. + * + * On success, return a workqueue_entry_t object that can be passed to + * workqueue_entry_cancel(). On failure, return NULL. + * + * Note that because each thread has its own work queue, work items may not + * be executed strictly in order. + */ workqueue_entry_t * threadpool_queue_work(threadpool_t *pool, int (*fn)(void *, void *), @@ -215,6 +283,7 @@ threadpool_queue_work(threadpool_t *pool, workerthread_t *worker; tor_mutex_acquire(&pool->lock); + /* Pick the next thread in random-access order. */ worker = pool->threads[pool->next_for_work++]; if (!worker) { tor_mutex_release(&pool->lock); @@ -227,9 +296,19 @@ threadpool_queue_work(threadpool_t *pool, return workerthread_queue_work(worker, fn, reply_fn, arg); } +/** + * Queue a copy of a work item for every thread in a pool. This can be used, + * for example, to tell the threads to update some parameter in their states. + * + * Arguments are as for threadpool_queue_work, except that the + * arg value is passed to dup_fn once per each thread to + * make a copy of it. + * + * Return 0 on success, -1 on failure. + */ int threadpool_queue_for_all(threadpool_t *pool, - void *(*dup_fn)(void *), + void *(*dup_fn)(const void *), int (*fn)(void *, void *), void (*reply_fn)(void *), void *arg) @@ -251,6 +330,7 @@ threadpool_queue_for_all(threadpool_t *pool, } } +/** Launch threads until we have n. */ static int threadpool_start_threads(threadpool_t *pool, int n) { @@ -274,6 +354,13 @@ threadpool_start_threads(threadpool_t *pool, int n) return 0; } +/** + * Construct a new thread pool with n worker threads, configured to + * send their output to replyqueue. The threads' states will be + * constructed with the new_thread_state_fn call, receiving arg + * as its argument. When the threads close, they will call + * free_thread_state_fn on their states. + */ threadpool_t * threadpool_new(int n_threads, replyqueue_t *replyqueue, @@ -298,12 +385,17 @@ threadpool_new(int n_threads, return pool; } +/** Return the reply queue associated with a given thread pool. */ replyqueue_t * threadpool_get_replyqueue(threadpool_t *tp) { return tp->reply_queue; } +/** Allocate a new reply queue. Reply queues are used to pass results from + * worker threads to the main thread. Since the main thread is running an + * IO-centric event loop, it needs to get woken up with means other than a + * condition variable. */ replyqueue_t * replyqueue_new(void) { @@ -321,12 +413,22 @@ replyqueue_new(void) return rq; } +/** + * Return the "read socket" for a given reply queue. The main thread should + * listen for read events on this socket, and call replyqueue_process() every + * time it triggers. + */ tor_socket_t replyqueue_get_socket(replyqueue_t *rq) { return rq->alert.read_fd; } +/** + * Process all pending replies on a reply queue. The main thread should call + * this function every time the socket returned by replyqueue_get_socket() is + * readable. + */ void replyqueue_process(replyqueue_t *queue) { @@ -336,7 +438,7 @@ replyqueue_process(replyqueue_t *queue) tor_mutex_acquire(&queue->lock); while (!TOR_TAILQ_EMPTY(&queue->answers)) { - /* lock held. */ + /* lock must be held at this point.*/ workqueue_entry_t *work = TOR_TAILQ_FIRST(&queue->answers); TOR_TAILQ_REMOVE(&queue->answers, work, next_work); tor_mutex_release(&queue->lock); diff --git a/src/common/workqueue.h b/src/common/workqueue.h index 684fb19..dca947e 100644 --- a/src/common/workqueue.h +++ b/src/common/workqueue.h @@ -6,15 +6,21 @@ #include "compat.h" +/** A replyqueue is used to tell the main thread about the outcome of + * work that we queued for the the workers. */ typedef struct replyqueue_s replyqueue_t; +/** A thread-pool manages starting threads and passing work to them. */ typedef struct threadpool_s threadpool_t; +/** A workqueue entry represents a request that has been passed to a thread + * pool. */ typedef struct workqueue_entry_s workqueue_entry_t; -#define WQ_CMD_RUN 0 -#define WQ_CMD_CANCEL 1 - +/** Possible return value from a work function: indicates success. */ #define WQ_RPL_REPLY 0 +/** Possible return value from a work function: indicates fatal error */ #define WQ_RPL_ERROR 1 +/** Possible return value from a work function: indicates thread is shutting + * down. */ #define WQ_RPL_SHUTDOWN 2 workqueue_entry_t *threadpool_queue_work(threadpool_t *pool, @@ -22,7 +28,7 @@ workqueue_entry_t *threadpool_queue_work(threadpool_t *pool, void (*reply_fn)(void *), void *arg); int threadpool_queue_for_all(threadpool_t *pool, - void *(*dup_fn)(void *), + void *(*dup_fn)(const void *), int (*fn)(void *, void *), void (*reply_fn)(void *), void *arg);

1 0

[tor/master] Move thread tests into their own module
by nickm＠torproject.org 21 Jan '15

21 Jan '15

commit 74b782645ad89b8bd5a18fd3f2cb3be45c38a04f Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Sep 25 14:50:01 2013 -0400 Move thread tests into their own module --- src/test/include.am | 1 + src/test/test.c | 2 + src/test/test_threads.c | 154 +++++++++++++++++++++++++++++++++++++++++++++++ src/test/test_util.c | 137 ----------------------------------------- 4 files changed, 157 insertions(+), 137 deletions(-) diff --git a/src/test/include.am b/src/test/include.am index 2badc47..2e13454 100644 --- a/src/test/include.am +++ b/src/test/include.am @@ -46,6 +46,7 @@ src_test_test_SOURCES = \ src/test/test_routerkeys.c \ src/test/test_scheduler.c \ src/test/test_socks.c \ + src/test/test_threads.c \ src/test/test_util.c \ src/test/test_config.c \ src/test/test_hs.c \ diff --git a/src/test/test.c b/src/test/test.c index de6efaf..edc28cd 100644 --- a/src/test/test.c +++ b/src/test/test.c @@ -1297,6 +1297,7 @@ extern struct testcase_t cell_queue_tests[]; extern struct testcase_t options_tests[]; extern struct testcase_t socks_tests[]; extern struct testcase_t entrynodes_tests[]; +extern struct testcase_t thread_tests[]; extern struct testcase_t extorport_tests[]; extern struct testcase_t controller_event_tests[]; extern struct testcase_t logging_tests[]; @@ -1323,6 +1324,7 @@ static struct testgroup_t testgroups[] = { { "container/", container_tests }, { "util/", util_tests }, { "util/logging/", logging_tests }, + { "util/thread/", thread_tests }, { "cellfmt/", cell_format_tests }, { "cellqueue/", cell_queue_tests }, { "dir/", dir_tests }, diff --git a/src/test/test_threads.c b/src/test/test_threads.c new file mode 100644 index 0000000..2b4c933 --- /dev/null +++ b/src/test/test_threads.c @@ -0,0 +1,154 @@ +/* Copyright (c) 2001-2004, Roger Dingledine. + * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson. + * Copyright (c) 2007-2013, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ + +#include "orconfig.h" +#include "or.h" +#include "compat_threads.h" +#include "test.h" + +/** mutex for thread test to stop the threads hitting data at the same time. */ +static tor_mutex_t *thread_test_mutex_ = NULL; +/** mutexes for the thread test to make sure that the threads have to + * interleave somewhat. */ +static tor_mutex_t *thread_test_start1_ = NULL, + *thread_test_start2_ = NULL; +/** Shared strmap for the thread test. */ +static strmap_t *thread_test_strmap_ = NULL; +/** The name of thread1 for the thread test */ +static char *thread1_name_ = NULL; +/** The name of thread2 for the thread test */ +static char *thread2_name_ = NULL; + +static void thread_test_func_(void* _s) ATTR_NORETURN; + +/** How many iterations have the threads in the unit test run? */ +static int t1_count = 0, t2_count = 0; + +/** Helper function for threading unit tests: This function runs in a + * subthread. It grabs its own mutex (start1 or start2) to make sure that it + * should start, then it repeatedly alters _test_thread_strmap protected by + * thread_test_mutex_. */ +static void +thread_test_func_(void* _s) +{ + char *s = _s; + int i, *count; + tor_mutex_t *m; + char buf[64]; + char **cp; + if (!strcmp(s, "thread 1")) { + m = thread_test_start1_; + cp = &thread1_name_; + count = &t1_count; + } else { + m = thread_test_start2_; + cp = &thread2_name_; + count = &t2_count; + } + + tor_snprintf(buf, sizeof(buf), "%lu", tor_get_thread_id()); + *cp = tor_strdup(buf); + + tor_mutex_acquire(m); + + for (i=0; i<10000; ++i) { + tor_mutex_acquire(thread_test_mutex_); + strmap_set(thread_test_strmap_, "last to run", *cp); + ++*count; + tor_mutex_release(thread_test_mutex_); + } + tor_mutex_acquire(thread_test_mutex_); + strmap_set(thread_test_strmap_, s, *cp); + tor_mutex_release(thread_test_mutex_); + + tor_mutex_release(m); + + spawn_exit(); +} + +/** Run unit tests for threading logic. */ +static void +test_threads_basic(void *arg) +{ + char *s1 = NULL, *s2 = NULL; + int done = 0, timedout = 0; + time_t started; +#ifndef _WIN32 + struct timeval tv; + tv.tv_sec=0; + tv.tv_usec=100*1000; +#endif + (void)arg; + thread_test_mutex_ = tor_mutex_new(); + thread_test_start1_ = tor_mutex_new(); + thread_test_start2_ = tor_mutex_new(); + thread_test_strmap_ = strmap_new(); + s1 = tor_strdup("thread 1"); + s2 = tor_strdup("thread 2"); + tor_mutex_acquire(thread_test_start1_); + tor_mutex_acquire(thread_test_start2_); + spawn_func(thread_test_func_, s1); + spawn_func(thread_test_func_, s2); + tor_mutex_release(thread_test_start2_); + tor_mutex_release(thread_test_start1_); + started = time(NULL); + while (!done) { + tor_mutex_acquire(thread_test_mutex_); + strmap_assert_ok(thread_test_strmap_); + if (strmap_get(thread_test_strmap_, "thread 1") && + strmap_get(thread_test_strmap_, "thread 2")) { + done = 1; + } else if (time(NULL) > started + 150) { + timedout = done = 1; + } + tor_mutex_release(thread_test_mutex_); +#ifndef _WIN32 + /* Prevent the main thread from starving the worker threads. */ + select(0, NULL, NULL, NULL, &tv); +#endif + } + tor_mutex_acquire(thread_test_start1_); + tor_mutex_release(thread_test_start1_); + tor_mutex_acquire(thread_test_start2_); + tor_mutex_release(thread_test_start2_); + + tor_mutex_free(thread_test_mutex_); + + if (timedout) { + printf("\nTimed out: %d %d", t1_count, t2_count); + tt_assert(strmap_get(thread_test_strmap_, "thread 1")); + tt_assert(strmap_get(thread_test_strmap_, "thread 2")); + tt_assert(!timedout); + } + + /* different thread IDs. */ + tt_assert(strcmp(strmap_get(thread_test_strmap_, "thread 1"), + strmap_get(thread_test_strmap_, "thread 2"))); + tt_assert(!strcmp(strmap_get(thread_test_strmap_, "thread 1"), + strmap_get(thread_test_strmap_, "last to run")) || + !strcmp(strmap_get(thread_test_strmap_, "thread 2"), + strmap_get(thread_test_strmap_, "last to run"))); + + done: + tor_free(s1); + tor_free(s2); + tor_free(thread1_name_); + tor_free(thread2_name_); + if (thread_test_strmap_) + strmap_free(thread_test_strmap_, NULL); + if (thread_test_start1_) + tor_mutex_free(thread_test_start1_); + if (thread_test_start2_) + tor_mutex_free(thread_test_start2_); +} + +#define THREAD_TEST(name) \ + { #name, test_threads_##name, TT_FORK, NULL, NULL } + +struct testcase_t thread_tests[] = { + THREAD_TEST(basic), + END_OF_TESTCASES +}; + diff --git a/src/test/test_util.c b/src/test/test_util.c index 15470e8..b4ee934 100644 --- a/src/test/test_util.c +++ b/src/test/test_util.c @@ -1607,142 +1607,6 @@ test_util_pow2(void *arg) ; } -/** mutex for thread test to stop the threads hitting data at the same time. */ -static tor_mutex_t *thread_test_mutex_ = NULL; -/** mutexes for the thread test to make sure that the threads have to - * interleave somewhat. */ -static tor_mutex_t *thread_test_start1_ = NULL, - *thread_test_start2_ = NULL; -/** Shared strmap for the thread test. */ -static strmap_t *thread_test_strmap_ = NULL; -/** The name of thread1 for the thread test */ -static char *thread1_name_ = NULL; -/** The name of thread2 for the thread test */ -static char *thread2_name_ = NULL; - -static void thread_test_func_(void* _s) ATTR_NORETURN; - -/** How many iterations have the threads in the unit test run? */ -static int t1_count = 0, t2_count = 0; - -/** Helper function for threading unit tests: This function runs in a - * subthread. It grabs its own mutex (start1 or start2) to make sure that it - * should start, then it repeatedly alters _test_thread_strmap protected by - * thread_test_mutex_. */ -static void -thread_test_func_(void* _s) -{ - char *s = _s; - int i, *count; - tor_mutex_t *m; - char buf[64]; - char **cp; - if (!strcmp(s, "thread 1")) { - m = thread_test_start1_; - cp = &thread1_name_; - count = &t1_count; - } else { - m = thread_test_start2_; - cp = &thread2_name_; - count = &t2_count; - } - - tor_snprintf(buf, sizeof(buf), "%lu", tor_get_thread_id()); - *cp = tor_strdup(buf); - - tor_mutex_acquire(m); - - for (i=0; i<10000; ++i) { - tor_mutex_acquire(thread_test_mutex_); - strmap_set(thread_test_strmap_, "last to run", *cp); - ++*count; - tor_mutex_release(thread_test_mutex_); - } - tor_mutex_acquire(thread_test_mutex_); - strmap_set(thread_test_strmap_, s, *cp); - tor_mutex_release(thread_test_mutex_); - - tor_mutex_release(m); - - spawn_exit(); -} - -/** Run unit tests for threading logic. */ -static void -test_util_threads(void *arg) -{ - char *s1 = NULL, *s2 = NULL; - int done = 0, timedout = 0; - time_t started; -#ifndef _WIN32 - struct timeval tv; - tv.tv_sec=0; - tv.tv_usec=100*1000; -#endif - (void)arg; - thread_test_mutex_ = tor_mutex_new(); - thread_test_start1_ = tor_mutex_new(); - thread_test_start2_ = tor_mutex_new(); - thread_test_strmap_ = strmap_new(); - s1 = tor_strdup("thread 1"); - s2 = tor_strdup("thread 2"); - tor_mutex_acquire(thread_test_start1_); - tor_mutex_acquire(thread_test_start2_); - spawn_func(thread_test_func_, s1); - spawn_func(thread_test_func_, s2); - tor_mutex_release(thread_test_start2_); - tor_mutex_release(thread_test_start1_); - started = time(NULL); - while (!done) { - tor_mutex_acquire(thread_test_mutex_); - strmap_assert_ok(thread_test_strmap_); - if (strmap_get(thread_test_strmap_, "thread 1") && - strmap_get(thread_test_strmap_, "thread 2")) { - done = 1; - } else if (time(NULL) > started + 150) { - timedout = done = 1; - } - tor_mutex_release(thread_test_mutex_); -#ifndef _WIN32 - /* Prevent the main thread from starving the worker threads. */ - select(0, NULL, NULL, NULL, &tv); -#endif - } - tor_mutex_acquire(thread_test_start1_); - tor_mutex_release(thread_test_start1_); - tor_mutex_acquire(thread_test_start2_); - tor_mutex_release(thread_test_start2_); - - tor_mutex_free(thread_test_mutex_); - - if (timedout) { - printf("\nTimed out: %d %d", t1_count, t2_count); - tt_assert(strmap_get(thread_test_strmap_, "thread 1")); - tt_assert(strmap_get(thread_test_strmap_, "thread 2")); - tt_assert(!timedout); - } - - /* different thread IDs. */ - tt_assert(strcmp(strmap_get(thread_test_strmap_, "thread 1"), - strmap_get(thread_test_strmap_, "thread 2"))); - tt_assert(!strcmp(strmap_get(thread_test_strmap_, "thread 1"), - strmap_get(thread_test_strmap_, "last to run")) || - !strcmp(strmap_get(thread_test_strmap_, "thread 2"), - strmap_get(thread_test_strmap_, "last to run"))); - - done: - tor_free(s1); - tor_free(s2); - tor_free(thread1_name_); - tor_free(thread2_name_); - if (thread_test_strmap_) - strmap_free(thread_test_strmap_, NULL); - if (thread_test_start1_) - tor_mutex_free(thread_test_start1_); - if (thread_test_start2_) - tor_mutex_free(thread_test_start2_); -} - /** Run unit tests for compression functions */ static void test_util_gzip(void *arg) @@ -4927,7 +4791,6 @@ struct testcase_t util_tests[] = { UTIL_LEGACY(memarea), UTIL_LEGACY(control_formats), UTIL_LEGACY(mmap), - UTIL_LEGACY(threads), UTIL_LEGACY(sscanf), UTIL_LEGACY(format_time_interval), UTIL_LEGACY(path_is_relative),

1 0

[tor/master] Rename bench_workqueue -> test_workqueue and make it a unit test.
by nickm＠torproject.org 21 Jan '15

21 Jan '15

commit 93ad89e9d219d6cea764652a05c236210c7de3fa Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Sep 25 11:36:02 2013 -0400 Rename bench_workqueue -> test_workqueue and make it a unit test. --- .gitignore | 2 + src/test/bench_workqueue.c | 288 ------------------------------------- src/test/include.am | 19 +-- src/test/test_workqueue.c | 342 ++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 355 insertions(+), 296 deletions(-) diff --git a/.gitignore b/.gitignore index 9ddd0c5..e63576c 100644 --- a/.gitignore +++ b/.gitignore @@ -163,10 +163,12 @@ cscope.* /src/test/test-bt-cl /src/test/test-child /src/test/test-ntor-cl +/src/test/test_workqueue /src/test/test.exe /src/test/test-bt-cl.exe /src/test/test-child.exe /src/test/test-ntor-cl.exe +/src/test/test_workqueue.exe # /src/tools/ /src/tools/tor-checkkey diff --git a/src/test/bench_workqueue.c b/src/test/bench_workqueue.c deleted file mode 100644 index f190c61..0000000 --- a/src/test/bench_workqueue.c +++ /dev/null @@ -1,288 +0,0 @@ -/* Copyright (c) 2001-2004, Roger Dingledine. - * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson. - * Copyright (c) 2007-2013, The Tor Project, Inc. */ -/* See LICENSE for licensing information */ - -#include "or.h" -#include "compat_threads.h" -#include "onion.h" -#include "workqueue.h" -#include "crypto.h" -#include "crypto_curve25519.h" -#include "compat_libevent.h" - -#include <stdio.h> -#ifdef HAVE_EVENT2_EVENT_H -#include <event2/event.h> -#else -#include <event.h> -#endif - -#ifdef TRACK_RESPONSES -tor_mutex_t bitmap_mutex; -int handled_len; -bitarray_t *handled; -#endif - -#define N_ITEMS 10000 -#define N_INFLIGHT 1000 -#define RELAUNCH_AT 250 - -typedef struct state_s { - int magic; - int n_handled; - crypto_pk_t *rsa; - curve25519_secret_key_t ecdh; -} state_t; - -typedef struct rsa_work_s { - int serial; - uint8_t msg[128]; - uint8_t msglen; -} rsa_work_t; - -typedef struct ecdh_work_s { - int serial; - union { - curve25519_public_key_t pk; - uint8_t msg[32]; - } u; -} ecdh_work_t; - -static void -mark_handled(int serial) -{ -#ifdef TRACK_RESPONSES - tor_mutex_acquire(&bitmap_mutex); - tor_assert(serial < handled_len); - tor_assert(! bitarray_is_set(handled, serial)); - bitarray_set(handled, serial); - tor_mutex_release(&bitmap_mutex); -#else - (void)serial; -#endif -} - -static int -workqueue_do_rsa(void *state, void *work) -{ - rsa_work_t *rw = work; - state_t *st = state; - crypto_pk_t *rsa = st->rsa; - uint8_t sig[256]; - int len; - - tor_assert(st->magic == 13371337); - - len = crypto_pk_private_sign(rsa, (char*)sig, 256, - (char*)rw->msg, rw->msglen); - if (len < 0) { - rw->msglen = 0; - return WQ_RPL_ERROR; - } - - memset(rw->msg, 0, sizeof(rw->msg)); - rw->msglen = len; - memcpy(rw->msg, sig, len); - ++st->n_handled; - - mark_handled(rw->serial); - - return WQ_RPL_REPLY; -} - -#if 0 -static int -workqueue_do_shutdown(void *state, void *work) -{ - (void)state; - (void)work; - (void)cmd; - crypto_pk_free(((state_t*)state)->rsa); - tor_free(state); - return WQ_RPL_SHUTDOWN; -} -#endif - -static int -workqueue_do_ecdh(void *state, void *work) -{ - ecdh_work_t *ew = work; - uint8_t output[CURVE25519_OUTPUT_LEN]; - state_t *st = state; - - tor_assert(st->magic == 13371337); - - curve25519_handshake(output, &st->ecdh, &ew->u.pk); - memcpy(ew->u.msg, output, CURVE25519_OUTPUT_LEN); - ++st->n_handled; - mark_handled(ew->serial); - return WQ_RPL_REPLY; -} - -static void * -new_state(void *arg) -{ - state_t *st; - (void)arg; - - st = tor_malloc(sizeof(*st)); - /* Every thread gets its own keys. not a problem for benchmarking */ - st->rsa = crypto_pk_new(); - if (crypto_pk_generate_key_with_bits(st->rsa, 1024) < 0) { - puts("keygen failed"); - crypto_pk_free(st->rsa); - tor_free(st); - return NULL; - } - curve25519_secret_key_generate(&st->ecdh, 0); - st->magic = 13371337; - return st; -} - -static void -free_state(void *arg) -{ - state_t *st = arg; - crypto_pk_free(st->rsa); - tor_free(st); -} - -static tor_weak_rng_t weak_rng; -static int n_sent = 0; -static int rsa_sent = 0; -static int ecdh_sent = 0; -static int n_received = 0; - -#ifdef TRACK_RESPONSES -bitarray_t *received; -#endif - -static void -handle_reply(void *arg) -{ -#ifdef TRACK_RESPONSES - rsa_work_t *rw = arg; /* Naughty cast, but only looking at serial. */ - tor_assert(! bitarray_is_set(received, rw->serial)); - bitarray_set(received,rw->serial); -#endif - - tor_free(arg); - ++n_received; -} - -static int -add_work(threadpool_t *tp) -{ - int add_rsa = tor_weak_random_range(&weak_rng, 5) == 0; - if (add_rsa) { - rsa_work_t *w = tor_malloc_zero(sizeof(*w)); - w->serial = n_sent++; - crypto_rand((char*)w->msg, 20); - w->msglen = 20; - ++rsa_sent; - return threadpool_queue_work(tp, workqueue_do_rsa, handle_reply, w) != NULL; - } else { - ecdh_work_t *w = tor_malloc_zero(sizeof(*w)); - w->serial = n_sent++; - /* Not strictly right, but this is just for benchmarks. */ - crypto_rand((char*)w->u.pk.public_key, 32); - ++ecdh_sent; - return threadpool_queue_work(tp, workqueue_do_ecdh, handle_reply, w) != NULL; - } -} - -static void -replysock_readable_cb(tor_socket_t sock, short what, void *arg) -{ - threadpool_t *tp = arg; - replyqueue_t *rq = threadpool_get_replyqueue(tp); - - int old_r = n_received; - (void) sock; - (void) what; - - replyqueue_process(rq); - if (old_r == n_received) - return; - - printf("%d / %d\n", n_received, n_sent); -#ifdef TRACK_RESPONSES - tor_mutex_acquire(&bitmap_mutex); - for (i = 0; i < N_ITEMS; ++i) { - if (bitarray_is_set(received, i)) - putc('o', stdout); - else if (bitarray_is_set(handled, i)) - putc('!', stdout); - else - putc('.', stdout); - } - puts(""); - tor_mutex_release(&bitmap_mutex); -#endif - - if (n_sent - n_received < RELAUNCH_AT) { - while (n_sent < n_received + N_INFLIGHT && n_sent < N_ITEMS) { - if (! add_work(tp)) { - puts("Couldn't add work."); - tor_event_base_loopexit(tor_libevent_get_base(), NULL); - } - } - } - - if (n_received == n_sent && n_sent >= N_ITEMS) { - tor_event_base_loopexit(tor_libevent_get_base(), NULL); - } -} - -int -main(int argc, char **argv) -{ - replyqueue_t *rq; - threadpool_t *tp; - int i; - tor_libevent_cfg evcfg; - struct event *ev; - - (void)argc; - (void)argv; - - init_logging(1); - crypto_global_init(1, NULL, NULL); - crypto_seed_rng(1); - - rq = replyqueue_new(); - tor_assert(rq); - tp = threadpool_new(16, - rq, new_state, free_state, NULL); - tor_assert(tp); - - crypto_seed_weak_rng(&weak_rng); - - memset(&evcfg, 0, sizeof(evcfg)); - tor_libevent_initialize(&evcfg); - - ev = tor_event_new(tor_libevent_get_base(), - replyqueue_get_socket(rq), EV_READ|EV_PERSIST, - replysock_readable_cb, tp); - - event_add(ev, NULL); - -#ifdef TRACK_RESPONSES - handled = bitarray_init_zero(N_ITEMS); - received = bitarray_init_zero(N_ITEMS); - tor_mutex_init(&bitmap_mutex); - handled_len = N_ITEMS; -#endif - - for (i = 0; i < N_INFLIGHT; ++i) { - if (! add_work(tp)) { - puts("Couldn't add work."); - return 1; - } - } - - event_base_loop(tor_libevent_get_base(), 0); - - return 0; -} diff --git a/src/test/include.am b/src/test/include.am index 6ad1b55..2badc47 100644 --- a/src/test/include.am +++ b/src/test/include.am @@ -1,8 +1,8 @@ TESTS += src/test/test -noinst_PROGRAMS+= src/test/bench src/test/bench_workqueue +noinst_PROGRAMS+= src/test/bench if UNITTESTS_ENABLED -noinst_PROGRAMS+= src/test/test src/test/test-child +noinst_PROGRAMS+= src/test/test src/test/test-child src/test/test_workqueue endif src_test_AM_CPPFLAGS = -DSHARE_DATADIR="\"$(datadir)\"" \ @@ -62,8 +62,10 @@ src_test_test_CPPFLAGS= $(src_test_AM_CPPFLAGS) src_test_bench_SOURCES = \ src/test/bench.c -src_test_bench_workqueue_SOURCES = \ - src/test/bench_workqueue.c +src_test_test_workqueue_SOURCES = \ + src/test/test_workqueue.c +src_test_test_workqueue_CPPFLAGS= $(src_test_AM_CPPFLAGS) +src_test_test_workqueue_CFLAGS = $(AM_CFLAGS) $(TEST_CFLAGS) src_test_test_LDFLAGS = @TOR_LDFLAGS_zlib@ @TOR_LDFLAGS_openssl@ \ @TOR_LDFLAGS_libevent@ @@ -83,11 +85,12 @@ src_test_bench_LDADD = src/or/libtor.a src/common/libor.a \ @TOR_OPENSSL_LIBS@ @TOR_LIB_WS32@ @TOR_LIB_GDI@ @CURVE25519_LIBS@ \ @TOR_SYSTEMD_LIBS@ -src_test_bench_workqueue_LDFLAGS = @TOR_LDFLAGS_zlib@ @TOR_LDFLAGS_openssl@ \ +src_test_test_workqueue_LDFLAGS = @TOR_LDFLAGS_zlib@ @TOR_LDFLAGS_openssl@ \ @TOR_LDFLAGS_libevent@ -src_test_bench_workqueue_LDADD = src/or/libtor.a src/common/libor.a \ - src/common/libor-crypto.a $(LIBDONNA) \ - src/common/libor-event.a \ +src_test_test_workqueue_LDADD = src/or/libtor-testing.a \ + src/common/libor-testing.a \ + src/common/libor-crypto-testing.a $(LIBDONNA) \ + src/common/libor-event-testing.a \ @TOR_ZLIB_LIBS@ @TOR_LIB_MATH@ @TOR_LIBEVENT_LIBS@ \ @TOR_OPENSSL_LIBS@ @TOR_LIB_WS32@ @TOR_LIB_GDI@ @CURVE25519_LIBS@ diff --git a/src/test/test_workqueue.c b/src/test/test_workqueue.c new file mode 100644 index 0000000..4077fb2 --- /dev/null +++ b/src/test/test_workqueue.c @@ -0,0 +1,342 @@ +/* Copyright (c) 2001-2004, Roger Dingledine. + * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson. + * Copyright (c) 2007-2013, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ + +#include "or.h" +#include "compat_threads.h" +#include "onion.h" +#include "workqueue.h" +#include "crypto.h" +#include "crypto_curve25519.h" +#include "compat_libevent.h" + +#include <stdio.h> +#ifdef HAVE_EVENT2_EVENT_H +#include <event2/event.h> +#else +#include <event.h> +#endif + +static int opt_verbose = 0; +static int opt_n_threads = 8; +static int opt_n_items = 10000; +static int opt_n_inflight = 1000; +static int opt_n_lowwater = 250; +static int opt_ratio_rsa = 5; + +#ifdef TRACK_RESPONSES +tor_mutex_t bitmap_mutex; +int handled_len; +bitarray_t *handled; +#endif + +typedef struct state_s { + int magic; + int n_handled; + crypto_pk_t *rsa; + curve25519_secret_key_t ecdh; +} state_t; + +typedef struct rsa_work_s { + int serial; + uint8_t msg[128]; + uint8_t msglen; +} rsa_work_t; + +typedef struct ecdh_work_s { + int serial; + union { + curve25519_public_key_t pk; + uint8_t msg[32]; + } u; +} ecdh_work_t; + +static void +mark_handled(int serial) +{ +#ifdef TRACK_RESPONSES + tor_mutex_acquire(&bitmap_mutex); + tor_assert(serial < handled_len); + tor_assert(! bitarray_is_set(handled, serial)); + bitarray_set(handled, serial); + tor_mutex_release(&bitmap_mutex); +#else + (void)serial; +#endif +} + +static int +workqueue_do_rsa(void *state, void *work) +{ + rsa_work_t *rw = work; + state_t *st = state; + crypto_pk_t *rsa = st->rsa; + uint8_t sig[256]; + int len; + + tor_assert(st->magic == 13371337); + + len = crypto_pk_private_sign(rsa, (char*)sig, 256, + (char*)rw->msg, rw->msglen); + if (len < 0) { + rw->msglen = 0; + return WQ_RPL_ERROR; + } + + memset(rw->msg, 0, sizeof(rw->msg)); + rw->msglen = len; + memcpy(rw->msg, sig, len); + ++st->n_handled; + + mark_handled(rw->serial); + + return WQ_RPL_REPLY; +} + +#if 0 +static int +workqueue_do_shutdown(void *state, void *work) +{ + (void)state; + (void)work; + (void)cmd; + crypto_pk_free(((state_t*)state)->rsa); + tor_free(state); + return WQ_RPL_SHUTDOWN; +} +#endif + +static int +workqueue_do_ecdh(void *state, void *work) +{ + ecdh_work_t *ew = work; + uint8_t output[CURVE25519_OUTPUT_LEN]; + state_t *st = state; + + tor_assert(st->magic == 13371337); + + curve25519_handshake(output, &st->ecdh, &ew->u.pk); + memcpy(ew->u.msg, output, CURVE25519_OUTPUT_LEN); + ++st->n_handled; + mark_handled(ew->serial); + return WQ_RPL_REPLY; +} + +static void * +new_state(void *arg) +{ + state_t *st; + (void)arg; + + st = tor_malloc(sizeof(*st)); + /* Every thread gets its own keys. not a problem for benchmarking */ + st->rsa = crypto_pk_new(); + if (crypto_pk_generate_key_with_bits(st->rsa, 1024) < 0) { + puts("keygen failed"); + crypto_pk_free(st->rsa); + tor_free(st); + return NULL; + } + curve25519_secret_key_generate(&st->ecdh, 0); + st->magic = 13371337; + return st; +} + +static void +free_state(void *arg) +{ + state_t *st = arg; + crypto_pk_free(st->rsa); + tor_free(st); +} + +static tor_weak_rng_t weak_rng; +static int n_sent = 0; +static int rsa_sent = 0; +static int ecdh_sent = 0; +static int n_received = 0; + +#ifdef TRACK_RESPONSES +bitarray_t *received; +#endif + +static void +handle_reply(void *arg) +{ +#ifdef TRACK_RESPONSES + rsa_work_t *rw = arg; /* Naughty cast, but only looking at serial. */ + tor_assert(! bitarray_is_set(received, rw->serial)); + bitarray_set(received,rw->serial); +#endif + + tor_free(arg); + ++n_received; +} + +static int +add_work(threadpool_t *tp) +{ + int add_rsa = + opt_ratio_rsa == 0 || + tor_weak_random_range(&weak_rng, opt_ratio_rsa) == 0; + if (add_rsa) { + rsa_work_t *w = tor_malloc_zero(sizeof(*w)); + w->serial = n_sent++; + crypto_rand((char*)w->msg, 20); + w->msglen = 20; + ++rsa_sent; + return threadpool_queue_work(tp, workqueue_do_rsa, handle_reply, w) != NULL; + } else { + ecdh_work_t *w = tor_malloc_zero(sizeof(*w)); + w->serial = n_sent++; + /* Not strictly right, but this is just for benchmarks. */ + crypto_rand((char*)w->u.pk.public_key, 32); + ++ecdh_sent; + return threadpool_queue_work(tp, workqueue_do_ecdh, handle_reply, w) != NULL; + } +} + +static void +replysock_readable_cb(tor_socket_t sock, short what, void *arg) +{ + threadpool_t *tp = arg; + replyqueue_t *rq = threadpool_get_replyqueue(tp); + + int old_r = n_received; + (void) sock; + (void) what; + + replyqueue_process(rq); + if (old_r == n_received) + return; + + if (opt_verbose) + printf("%d / %d\n", n_received, n_sent); +#ifdef TRACK_RESPONSES + tor_mutex_acquire(&bitmap_mutex); + for (i = 0; i < opt_n_items; ++i) { + if (bitarray_is_set(received, i)) + putc('o', stdout); + else if (bitarray_is_set(handled, i)) + putc('!', stdout); + else + putc('.', stdout); + } + puts(""); + tor_mutex_release(&bitmap_mutex); +#endif + + if (n_sent - n_received < opt_n_lowwater) { + while (n_sent < n_received + opt_n_inflight && n_sent < opt_n_items) { + if (! add_work(tp)) { + puts("Couldn't add work."); + tor_event_base_loopexit(tor_libevent_get_base(), NULL); + } + } + } + + if (n_received == n_sent && n_sent >= opt_n_items) { + tor_event_base_loopexit(tor_libevent_get_base(), NULL); + } +} + +static void +help(void) +{ + puts( + "Options:\n" + " -N <items> Run this many items of work\n" + " -T <threads> Use this many threads\n" + " -I <inflight> Have no more than this many requests queued at once\n" + " -L <lowwater> Add items whenever fewer than this many are pending.\n" + " -R <ratio> Make one out of this many items be a slow (RSA) one"); +} + +int +main(int argc, char **argv) +{ + replyqueue_t *rq; + threadpool_t *tp; + int i; + tor_libevent_cfg evcfg; + struct event *ev; + + for (i = 1; i < argc; ++i) { + if (!strcmp(argv[i], "-v")) { + opt_verbose = 1; + } else if (!strcmp(argv[i], "-T") && i+1<argc) { + opt_n_threads = atoi(argv[++i]); + } else if (!strcmp(argv[i], "-N") && i+1<argc) { + opt_n_items = atoi(argv[++i]); + } else if (!strcmp(argv[i], "-I") && i+1<argc) { + opt_n_inflight = atoi(argv[++i]); + } else if (!strcmp(argv[i], "-L") && i+1<argc) { + opt_n_lowwater = atoi(argv[++i]); + } else if (!strcmp(argv[i], "-R") && i+1<argc) { + opt_ratio_rsa = atoi(argv[++i]); + } else if (!strcmp(argv[i], "-h")) { + help(); + return 0; + } else { + help(); + return 1; + } + } + if (opt_n_threads < 1 || + opt_n_items < 1 || opt_n_inflight < 1 || opt_n_lowwater < 0 || + opt_ratio_rsa < 0) { + help(); + return 1; + } + + init_logging(1); + crypto_global_init(1, NULL, NULL); + crypto_seed_rng(1); + + rq = replyqueue_new(); + tor_assert(rq); + tp = threadpool_new(opt_n_threads, + rq, new_state, free_state, NULL); + tor_assert(tp); + + crypto_seed_weak_rng(&weak_rng); + + memset(&evcfg, 0, sizeof(evcfg)); + tor_libevent_initialize(&evcfg); + + ev = tor_event_new(tor_libevent_get_base(), + replyqueue_get_socket(rq), EV_READ|EV_PERSIST, + replysock_readable_cb, tp); + + event_add(ev, NULL); + +#ifdef TRACK_RESPONSES + handled = bitarray_init_zero(opt_n_items); + received = bitarray_init_zero(opt_n_items); + tor_mutex_init(&bitmap_mutex); + handled_len = opt_n_items; +#endif + + for (i = 0; i < opt_n_inflight; ++i) { + if (! add_work(tp)) { + puts("Couldn't add work."); + return 1; + } + } + + { + struct timeval limit = { 30, 0 }; + tor_event_base_loopexit(tor_libevent_get_base(), &limit); + } + + event_base_loop(tor_libevent_get_base(), 0); + + if (n_sent != opt_n_items || n_received != n_sent) { + puts("FAIL"); + return 1; + } else { + puts("OK"); + return 0; + } +}

1 0

[tor/master] Test a little more of compat_threads.c
by nickm＠torproject.org 21 Jan '15

21 Jan '15

commit c51f7c23e3af71466f9bd2ae57ae7a2b998ee3e2 Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Sep 25 14:31:59 2013 -0400 Test a little more of compat_threads.c --- src/common/compat_threads.c | 20 +++++++++++--------- src/common/compat_threads.h | 9 ++++++++- src/common/workqueue.c | 4 ++-- src/common/workqueue.h | 2 +- src/test/test_workqueue.c | 19 ++++++++++++++++--- 5 files changed, 38 insertions(+), 16 deletions(-) diff --git a/src/common/compat_threads.c b/src/common/compat_threads.c index f2a516a..648eaa2 100644 --- a/src/common/compat_threads.c +++ b/src/common/compat_threads.c @@ -155,19 +155,18 @@ sock_drain(tor_socket_t fd) /** Allocate a new set of alert sockets, and set the appropriate function * pointers, in socks_out. */ int -alert_sockets_create(alert_sockets_t *socks_out) +alert_sockets_create(alert_sockets_t *socks_out, uint32_t flags) { - tor_socket_t socks[2]; + tor_socket_t socks[2] = { TOR_INVALID_SOCKET, TOR_INVALID_SOCKET }; #ifdef HAVE_EVENTFD /* First, we try the Linux eventfd() syscall. This gives a 64-bit counter * associated with a single file descriptor. */ #if defined(EFD_CLOEXEC) && defined(EFD_NONBLOCK) - socks[0] = eventfd(0, EFD_CLOEXEC|EFD_NONBLOCK); -#else - socks[0] = -1; + if (!(flags & ASOCKS_NOEVENTFD2)) + socks[0] = eventfd(0, EFD_CLOEXEC|EFD_NONBLOCK); #endif - if (socks[0] < 0) { + if (socks[0] < 0 && !(flags & ASOCKS_NOEVENTFD)) { socks[0] = eventfd(0,0); if (socks[0] >= 0) { if (fcntl(socks[0], F_SETFD, FD_CLOEXEC) < 0 || @@ -188,7 +187,8 @@ alert_sockets_create(alert_sockets_t *socks_out) #ifdef HAVE_PIPE2 /* Now we're going to try pipes. First type the pipe2() syscall, if we * have it, so we can save some calls... */ - if (pipe2(socks, O_NONBLOCK|O_CLOEXEC) == 0) { + if (!(flags & ASOCKS_NOPIPE2) && + pipe2(socks, O_NONBLOCK|O_CLOEXEC) == 0) { socks_out->read_fd = socks[0]; socks_out->write_fd = socks[1]; socks_out->alert_fn = pipe_alert; @@ -200,7 +200,8 @@ alert_sockets_create(alert_sockets_t *socks_out) #ifdef HAVE_PIPE /* Now try the regular pipe() syscall. Pipes have a bit lower overhead than * socketpairs, fwict. */ - if (pipe(socks) == 0) { + if (!(flags & ASOCKS_NOPIPE) && + pipe(socks) == 0) { if (fcntl(socks[0], F_SETFD, FD_CLOEXEC) < 0 || fcntl(socks[1], F_SETFD, FD_CLOEXEC) < 0 || set_socket_nonblocking(socks[0]) < 0 || @@ -218,7 +219,8 @@ alert_sockets_create(alert_sockets_t *socks_out) #endif /* If nothing else worked, fall back on socketpair(). */ - if (tor_socketpair(AF_UNIX, SOCK_STREAM, 0, socks) == 0) { + if (!(flags & ASOCKS_NOSOCKETPAIR) && + tor_socketpair(AF_UNIX, SOCK_STREAM, 0, socks) == 0) { if (set_socket_nonblocking(socks[0]) < 0 || set_socket_nonblocking(socks[1])) { tor_close_socket(socks[0]); diff --git a/src/common/compat_threads.h b/src/common/compat_threads.h index 245df76..1b59391 100644 --- a/src/common/compat_threads.h +++ b/src/common/compat_threads.h @@ -102,7 +102,14 @@ typedef struct alert_sockets_s { int (*drain_fn)(tor_socket_t read_fd); } alert_sockets_t; -int alert_sockets_create(alert_sockets_t *socks_out); +/* Flags to disable one or more alert_sockets backends. */ +#define ASOCKS_NOEVENTFD2 (1u<<0) +#define ASOCKS_NOEVENTFD (1u<<1) +#define ASOCKS_NOPIPE2 (1u<<2) +#define ASOCKS_NOPIPE (1u<<3) +#define ASOCKS_NOSOCKETPAIR (1u<<4) + +int alert_sockets_create(alert_sockets_t *socks_out, uint32_t flags); void alert_sockets_close(alert_sockets_t *socks); #endif diff --git a/src/common/workqueue.c b/src/common/workqueue.c index e07787b..9293e1f 100644 --- a/src/common/workqueue.c +++ b/src/common/workqueue.c @@ -397,12 +397,12 @@ threadpool_get_replyqueue(threadpool_t *tp) * IO-centric event loop, it needs to get woken up with means other than a * condition variable. */ replyqueue_t * -replyqueue_new(void) +replyqueue_new(uint32_t alertsocks_flags) { replyqueue_t *rq; rq = tor_malloc_zero(sizeof(replyqueue_t)); - if (alert_sockets_create(&rq->alert) < 0) { + if (alert_sockets_create(&rq->alert, alertsocks_flags) < 0) { tor_free(rq); return NULL; } diff --git a/src/common/workqueue.h b/src/common/workqueue.h index dca947e..5a6cd80 100644 --- a/src/common/workqueue.h +++ b/src/common/workqueue.h @@ -40,7 +40,7 @@ threadpool_t *threadpool_new(int n_threads, void *arg); replyqueue_t *threadpool_get_replyqueue(threadpool_t *tp); -replyqueue_t *replyqueue_new(void); +replyqueue_t *replyqueue_new(uint32_t alertsocks_flags); tor_socket_t replyqueue_get_socket(replyqueue_t *rq); void replyqueue_process(replyqueue_t *queue); diff --git a/src/test/test_workqueue.c b/src/test/test_workqueue.c index 4077fb2..7ef54ef 100644 --- a/src/test/test_workqueue.c +++ b/src/test/test_workqueue.c @@ -249,8 +249,10 @@ help(void) " -N <items> Run this many items of work\n" " -T <threads> Use this many threads\n" " -I <inflight> Have no more than this many requests queued at once\n" - " -L <lowwater> Add items whenever fewer than this many are pending.\n" - " -R <ratio> Make one out of this many items be a slow (RSA) one"); + " -L <lowwater> Add items whenever fewer than this many are pending\n" + " -R <ratio> Make one out of this many items be a slow (RSA) one\n" + " --no-{eventfd2,eventfd,pipe2,pipe,socketpair}\n" + " Disable one of the alert_socket backends."); } int @@ -261,6 +263,7 @@ main(int argc, char **argv) int i; tor_libevent_cfg evcfg; struct event *ev; + uint32_t as_flags = 0; for (i = 1; i < argc; ++i) { if (!strcmp(argv[i], "-v")) { @@ -275,6 +278,16 @@ main(int argc, char **argv) opt_n_lowwater = atoi(argv[++i]); } else if (!strcmp(argv[i], "-R") && i+1<argc) { opt_ratio_rsa = atoi(argv[++i]); + } else if (!strcmp(argv[i], "--no-eventfd2")) { + as_flags |= ASOCKS_NOEVENTFD2; + } else if (!strcmp(argv[i], "--no-eventfd")) { + as_flags |= ASOCKS_NOEVENTFD; + } else if (!strcmp(argv[i], "--no-pipe2")) { + as_flags |= ASOCKS_NOPIPE2; + } else if (!strcmp(argv[i], "--no-pipe")) { + as_flags |= ASOCKS_NOPIPE; + } else if (!strcmp(argv[i], "--no-socketpair")) { + as_flags |= ASOCKS_NOSOCKETPAIR; } else if (!strcmp(argv[i], "-h")) { help(); return 0; @@ -294,7 +307,7 @@ main(int argc, char **argv) crypto_global_init(1, NULL, NULL); crypto_seed_rng(1); - rq = replyqueue_new(); + rq = replyqueue_new(as_flags); tor_assert(rq); tp = threadpool_new(opt_n_threads, rq, new_state, free_state, NULL);

1 0

[tor/master] Add a way to tell all threads to do something.
by nickm＠torproject.org 21 Jan '15

21 Jan '15

commit 4abbf13f99dac9e15856dc4e458a8c9525acab4d Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Sep 24 20:55:09 2013 -0400 Add a way to tell all threads to do something. --- src/common/workqueue.c | 57 +++++++++++++++++++++++++++++++++++++----------- src/common/workqueue.h | 6 ++++- 2 files changed, 49 insertions(+), 14 deletions(-) diff --git a/src/common/workqueue.c b/src/common/workqueue.c index ed70d5e..c4b64de 100644 --- a/src/common/workqueue.c +++ b/src/common/workqueue.c @@ -186,13 +186,32 @@ workerthread_new(void *state, replyqueue_t *replyqueue) return thr; } +static workqueue_entry_t * +workerthread_queue_work(workerthread_t *worker, + int (*fn)(void *, void *), + void (*reply_fn)(void *), + void *arg) +{ + workqueue_entry_t *ent = workqueue_entry_new(fn, reply_fn, arg); + + tor_mutex_acquire(&worker->lock); + ent->on_thread = worker; + ent->pending = 1; + TOR_TAILQ_INSERT_TAIL(&worker->work, ent, next_work); + + if (worker->waiting) /* XXXX inside or outside of lock?? */ + tor_cond_signal_one(&worker->condition); + + tor_mutex_release(&worker->lock); + return ent; +} + workqueue_entry_t * threadpool_queue_work(threadpool_t *pool, int (*fn)(void *, void *), void (*reply_fn)(void *), void *arg) { - workqueue_entry_t *ent; workerthread_t *worker; tor_mutex_acquire(&pool->lock); @@ -205,22 +224,34 @@ threadpool_queue_work(threadpool_t *pool, pool->next_for_work = 0; tor_mutex_release(&pool->lock); - ent = workqueue_entry_new(fn, reply_fn, arg); - - tor_mutex_acquire(&worker->lock); - ent->on_thread = worker; - ent->pending = 1; - TOR_TAILQ_INSERT_TAIL(&worker->work, ent, next_work); - - if (worker->waiting) /* XXXX inside or outside of lock?? */ - tor_cond_signal_one(&worker->condition); + return workerthread_queue_work(worker, fn, reply_fn, arg); +} - tor_mutex_release(&worker->lock); +int +threadpool_queue_for_all(threadpool_t *pool, + void *(*dup_fn)(void *), + int (*fn)(void *, void *), + void (*reply_fn)(void *), + void *arg) +{ + int i = 0; + workerthread_t *worker; + void *arg_copy; + while (1) { + tor_mutex_acquire(&pool->lock); + if (i >= pool->n_threads) { + tor_mutex_release(&pool->lock); + return 0; + } + worker = pool->threads[i++]; + tor_mutex_release(&pool->lock); - return ent; + arg_copy = dup_fn ? dup_fn(arg) : arg; + /* CHECK*/ workerthread_queue_work(worker, fn, reply_fn, arg_copy); + } } -int +static int threadpool_start_threads(threadpool_t *pool, int n) { tor_mutex_acquire(&pool->lock); diff --git a/src/common/workqueue.h b/src/common/workqueue.h index 47753cf..684fb19 100644 --- a/src/common/workqueue.h +++ b/src/common/workqueue.h @@ -21,8 +21,12 @@ workqueue_entry_t *threadpool_queue_work(threadpool_t *pool, int (*fn)(void *, void *), void (*reply_fn)(void *), void *arg); +int threadpool_queue_for_all(threadpool_t *pool, + void *(*dup_fn)(void *), + int (*fn)(void *, void *), + void (*reply_fn)(void *), + void *arg); int workqueue_entry_cancel(workqueue_entry_t *pending_work); -int threadpool_start_threads(threadpool_t *pool, int n); threadpool_t *threadpool_new(int n_threads, replyqueue_t *replyqueue, void *(*new_thread_state_fn)(void*),

1 0

[tor/master] Use correct (absolute) time for pthread_cond_timedwait
by nickm＠torproject.org 21 Jan '15

21 Jan '15

commit d69717f61bd9ab4e0a6097f0201bd02fc96f88eb Author: Nick Mathewson <nickm(a)torproject.org> Date: Fri Sep 27 12:09:57 2013 -0400 Use correct (absolute) time for pthread_cond_timedwait --- src/common/compat_pthreads.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/common/compat_pthreads.c b/src/common/compat_pthreads.c index 8d3c609..5983427 100644 --- a/src/common/compat_pthreads.c +++ b/src/common/compat_pthreads.c @@ -199,9 +199,12 @@ tor_cond_wait(tor_cond_t *cond, tor_mutex_t *mutex, const struct timeval *tv) return pthread_cond_wait(&cond->cond, &mutex->mutex) ? -1 : 0; } else { struct timespec ts; + struct timeval tvnow, tvsum; int r; - ts.tv_sec = tv->tv_sec; - ts.tv_nsec = tv->tv_usec * 1000; + gettimeofday(&tvnow, NULL); + timeradd(tv, &tvnow, &tvsum); + ts.tv_sec = tvsum.tv_sec; + ts.tv_nsec = tvsum.tv_usec * 1000; r = pthread_cond_timedwait(&cond->cond, &mutex->mutex, &ts); if (r == 0) return 0;

1 0

[tor/master] Isolate the "socketpair or a pipe" logic for alerting main thread
by nickm＠torproject.org 21 Jan '15

21 Jan '15

commit 51bc0e7f3d612b099382500b434d31f179eaa8a8 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Sep 24 20:43:48 2013 -0400 Isolate the "socketpair or a pipe" logic for alerting main thread This way we can use the linux eventfd extension where available. Using EVFILT_USER on the BSDs will be a teeny bit trickier, and will require libevent hacking. --- configure.ac | 4 ++ src/common/compat_threads.c | 150 +++++++++++++++++++++++++++++++++++++++++++ src/common/compat_threads.h | 11 ++++ src/common/workqueue.c | 68 ++++---------------- 4 files changed, 177 insertions(+), 56 deletions(-) diff --git a/configure.ac b/configure.ac index 65b3ff2..69a266a 100644 --- a/configure.ac +++ b/configure.ac @@ -407,6 +407,7 @@ AC_CHECK_FUNCS( backtrace \ backtrace_symbols_fd \ clock_gettime \ + eventfd \ flock \ ftime \ getaddrinfo \ @@ -421,6 +422,8 @@ AC_CHECK_FUNCS( localtime_r \ lround \ memmem \ + pipe \ + pipe2 \ prctl \ rint \ sigaction \ @@ -962,6 +965,7 @@ AC_CHECK_HEADERS( netinet/in6.h \ pwd.h \ stdint.h \ + sys/eventfd.h \ sys/file.h \ sys/ioctl.h \ sys/limits.h \ diff --git a/src/common/compat_threads.c b/src/common/compat_threads.c index e0cbf5c..98bdbbc 100644 --- a/src/common/compat_threads.c +++ b/src/common/compat_threads.c @@ -3,8 +3,24 @@ * Copyright (c) 2007-2015, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +#include "orconfig.h" +#define _GNU_SOURCE +#include <stdlib.h> #include "compat.h" +#include "compat_threads.h" + #include "util.h" +#include "torlog.h" + +#ifdef HAVE_SYS_EVENTFD_H +#include <sys/eventfd.h> +#endif +#ifdef HAVE_UNISTD_H +#include <unistd.h> +#endif +#ifdef HAVE_FCNTL_H +#include <fcntl.h> +#endif /** Return a newly allocated, ready-for-use mutex. */ tor_mutex_t * @@ -57,3 +73,137 @@ in_main_thread(void) { return main_thread_id == tor_get_thread_id(); } + +#ifdef HAVE_EVENTFD +static int +eventfd_alert(int fd) +{ + uint64_t u = 1; + int r = write(fd, (void*)&u, sizeof(u)); + if (r < 0 && errno != EAGAIN) + return -1; + return 0; +} + +static int +eventfd_drain(int fd) +{ + uint64_t u = 0; + int r = read(fd, (void*)&u, sizeof(u)); + if (r < 0 && errno != EAGAIN) + return -1; + return 0; +} +#endif + +#ifdef HAVE_PIPE +static int +pipe_alert(int fd) +{ + ssize_t r = write(fd, "x", 1); + if (r < 0 && errno != EAGAIN) + return -1; + return 0; +} + +static int +pipe_drain(int fd) +{ + char buf[32]; + ssize_t r; + while ((r = read(fd, buf, sizeof(buf))) >= 0) + ; + if (r == 0 || errno != EAGAIN) + return -1; + return 0; +} +#endif + +static int +sock_alert(tor_socket_t fd) +{ + ssize_t r = send(fd, "x", 1, 0); + if (r < 0 && !ERRNO_IS_EAGAIN(tor_socket_errno(fd))) + return -1; + return 0; +} + +static int +sock_drain(tor_socket_t fd) +{ + char buf[32]; + ssize_t r; + while ((r = recv(fd, buf, sizeof(buf), 0)) >= 0) + ; + if (r == 0 || !ERRNO_IS_EAGAIN(tor_socket_errno(fd))) + return -1; + return 0; +} + +/** Allocate a new set of alert sockets. DOCDOC */ +int +alert_sockets_create(alert_sockets_t *socks_out) +{ + tor_socket_t socks[2]; + +#ifdef HAVE_EVENTFD +#if defined(EFD_CLOEXEC) && defined(EFD_NONBLOCK) + socks[0] = eventfd(0, EFD_CLOEXEC|EFD_NONBLOCK); +#else + socks[0] = -1; +#endif + if (socks[0] < 0) { + socks[0] = eventfd(0,0); + if (socks[0] >= 0) { + if (fcntl(socks[0], F_SETFD, FD_CLOEXEC) < 0 || + set_socket_nonblocking(socks[0]) < 0) { + close(socks[0]); + return -1; + } + } + } + if (socks[0] >= 0) { + socks_out->read_fd = socks_out->write_fd = socks[0]; + socks_out->alert_fn = eventfd_alert; + socks_out->drain_fn = eventfd_drain; + return 0; + } +#endif + +#ifdef HAVE_PIPE2 + if (pipe2(socks, O_NONBLOCK|O_CLOEXEC) == 0) { + socks_out->read_fd = socks[0]; + socks_out->write_fd = socks[1]; + socks_out->alert_fn = pipe_alert; + socks_out->drain_fn = pipe_drain; + return 0; + } +#endif + +#ifdef HAVE_PIPE + if (pipe(socks) == 0) { + if (fcntl(socks[0], F_SETFD, FD_CLOEXEC) < 0 || + fcntl(socks[1], F_SETFD, FD_CLOEXEC) < 0 || + set_socket_nonblocking(socks[0]) < 0 || + set_socket_nonblocking(socks[1]) < 0) { + close(socks[0]); + close(socks[1]); + return -1; + } + socks_out->read_fd = socks[0]; + socks_out->write_fd = socks[1]; + socks_out->alert_fn = pipe_alert; + socks_out->drain_fn = pipe_drain; + return 0; + } +#endif + + if (tor_socketpair(AF_UNIX, SOCK_STREAM, 0, socks) == 0) { + set_socket_nonblocking(socks[0]); + set_socket_nonblocking(socks[1]); + socks_out->alert_fn = sock_alert; + socks_out->drain_fn = sock_drain; + return 0; + } + return -1; +} diff --git a/src/common/compat_threads.h b/src/common/compat_threads.h index 581d8dd..b053136 100644 --- a/src/common/compat_threads.h +++ b/src/common/compat_threads.h @@ -82,4 +82,15 @@ int tor_cond_wait(tor_cond_t *cond, tor_mutex_t *mutex, void tor_cond_signal_one(tor_cond_t *cond); void tor_cond_signal_all(tor_cond_t *cond); +/** DOCDOC */ +typedef struct alert_sockets_s { + /*XXX needs a better name */ + tor_socket_t read_fd; + tor_socket_t write_fd; + int (*alert_fn)(tor_socket_t write_fd); + int (*drain_fn)(tor_socket_t read_fd); +} alert_sockets_t; + +int alert_sockets_create(alert_sockets_t *socks_out); + #endif diff --git a/src/common/workqueue.c b/src/common/workqueue.c index 80e061d..ed70d5e 100644 --- a/src/common/workqueue.c +++ b/src/common/workqueue.c @@ -9,11 +9,6 @@ #include "tor_queue.h" #include "torlog.h" -#ifdef HAVE_UNISTD_H -// XXXX move wherever we move the write/send stuff -#include <unistd.h> -#endif - /* design: @@ -44,9 +39,7 @@ struct replyqueue_s { tor_mutex_t lock; TOR_TAILQ_HEAD(, workqueue_entry_s) answers; - void (*alert_fn)(struct replyqueue_s *); // lock not held on this, next 2. - tor_socket_t write_sock; - tor_socket_t read_sock; + alert_sockets_t alert; // lock not held on this. }; typedef struct workerthread_s { @@ -169,22 +162,12 @@ queue_reply(replyqueue_t *queue, workqueue_entry_t *work) tor_mutex_release(&queue->lock); if (was_empty) { - queue->alert_fn(queue); + if (queue->alert.alert_fn(queue->alert.write_fd) < 0) { + /* XXXX complain! */ + } } } - -static void -alert_by_fd(replyqueue_t *queue) -{ - /* XXX extract this into new function */ -#ifndef _WIN32 - (void) send(queue->write_sock, "x", 1, 0); -#else - (void) write(queue->write_sock, "x", 1); -#endif -} - static workerthread_t * workerthread_new(void *state, replyqueue_t *replyqueue) { @@ -293,59 +276,32 @@ threadpool_get_replyqueue(threadpool_t *tp) replyqueue_t * replyqueue_new(void) { - tor_socket_t pair[2]; replyqueue_t *rq; - int r; - - /* XXX extract this into new function */ -#ifdef _WIN32 - r = tor_socketpair(AF_UNIX, SOCK_STREAM, 0, pair); -#else - r = pipe(pair); -#endif - if (r < 0) - return NULL; - - set_socket_nonblocking(pair[0]); /* the read-size should be nonblocking. */ -#if defined(FD_CLOEXEC) - fcntl(pair[0], F_SETFD, FD_CLOEXEC); - fcntl(pair[1], F_SETFD, FD_CLOEXEC); -#endif rq = tor_malloc_zero(sizeof(replyqueue_t)); + if (alert_sockets_create(&rq->alert) < 0) { + tor_free(rq); + return NULL; + } tor_mutex_init(&rq->lock); TOR_TAILQ_INIT(&rq->answers); - rq->read_sock = pair[0]; - rq->write_sock = pair[1]; - rq->alert_fn = alert_by_fd; - return rq; } tor_socket_t replyqueue_get_socket(replyqueue_t *rq) { - return rq->read_sock; + return rq->alert.read_fd; } void replyqueue_process(replyqueue_t *queue) { - ssize_t r; - - /* XXX extract this into new function */ - do { - char buf[64]; -#ifdef _WIN32 - r = recv(queue->read_sock, buf, sizeof(buf), 0); -#else - r = read(queue->read_sock, buf, sizeof(buf)); -#endif - } while (r > 0); - - /* XXXX freak out on r == 0, or r == "error, not retryable". */ + if (queue->alert.drain_fn(queue->alert.read_fd) < 0) { + /* XXXX complain! */ + } tor_mutex_acquire(&queue->lock); while (!TOR_TAILQ_EMPTY(&queue->answers)) {

1 0

[tor/master] Fix windows compilation of condition code
by nickm＠torproject.org 21 Jan '15

21 Jan '15

commit 9fdc0d059456146722dc81f2b58672b533a2bb71 Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Sep 25 23:31:40 2013 -0400 Fix windows compilation of condition code --- src/common/compat.c | 1 - src/common/compat_winthreads.c | 11 +++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/src/common/compat.c b/src/common/compat.c index a22a61a..5575316 100644 --- a/src/common/compat.c +++ b/src/common/compat.c @@ -27,7 +27,6 @@ #include "compat.h" #ifdef _WIN32 -#include <process.h> #include <windows.h> #include <sys/locking.h> #endif diff --git a/src/common/compat_winthreads.c b/src/common/compat_winthreads.c index 0ab26b7..e19b1ca 100644 --- a/src/common/compat_winthreads.c +++ b/src/common/compat_winthreads.c @@ -9,6 +9,10 @@ #include "util.h" #include "container.h" #include "torlog.h" +#include <process.h> + +/* This value is more or less total cargo-cult */ +#define SPIN_COUNT 2000 /** Minimalist interface to run a void function in the background. On * Unix calls fork, on win32 calls beginthread. Returns -1 on failure. @@ -108,7 +112,6 @@ tor_cond_signal_impl(tor_cond_t *cond, int broadcast) cond->generation++; SetEvent(cond->event); LeaveCriticalSection(&cond->lock); - return 0; } void tor_cond_signal_one(tor_cond_t *cond) @@ -122,15 +125,15 @@ tor_cond_signal_all(tor_cond_t *cond) } int -tor_cond_wait(tor_cond_t *cond, tor_mutex_t *lock, const struct timeval *tv) +tor_cond_wait(tor_cond_t *cond, tor_mutex_t *lock_, const struct timeval *tv) { - CRITICAL_SECTION *lock = &lock->mutex; + CRITICAL_SECTION *lock = &lock_->mutex; int generation_at_start; int waiting = 1; int result = -1; DWORD ms = INFINITE, ms_orig = INFINITE, startTime, endTime; if (tv) - ms_orig = ms = evutil_tv_to_msec_(tv); + ms_orig = ms = tv->tv_sec*1000 + (tv->tv_usec+999)/1000; EnterCriticalSection(&cond->lock); ++cond->n_waiting;

1 0

[tor/master] Fix linux compilation (pipe2 needs _GNU_SOURCE)
by nickm＠torproject.org 21 Jan '15

21 Jan '15

commit d850ec8574761c0279df53f3b7a9811d1dab430f Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Sep 25 23:25:02 2013 -0400 Fix linux compilation (pipe2 needs _GNU_SOURCE) --- src/common/compat_threads.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/common/compat_threads.c b/src/common/compat_threads.c index 648eaa2..ba48eb4 100644 --- a/src/common/compat_threads.c +++ b/src/common/compat_threads.c @@ -3,6 +3,8 @@ * Copyright (c) 2007-2015, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +#define _GNU_SOURCE + #include "orconfig.h" #define _GNU_SOURCE #include <stdlib.h> @@ -15,12 +17,12 @@ #ifdef HAVE_SYS_EVENTFD_H #include <sys/eventfd.h> #endif -#ifdef HAVE_UNISTD_H -#include <unistd.h> -#endif #ifdef HAVE_FCNTL_H #include <fcntl.h> #endif +#ifdef HAVE_UNISTD_H +#include <unistd.h> +#endif /** Return a newly allocated, ready-for-use mutex. */ tor_mutex_t *

1 0

[tor/master] Make pending work cancellable.
by nickm＠torproject.org 21 Jan '15

21 Jan '15

commit c7eebe237ddf0555a99b2ef10fd95def2a4bbbd4 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Sep 24 16:57:40 2013 -0400 Make pending work cancellable. --- src/common/workqueue.c | 72 +++++++++++++++++++++++++++----------------- src/common/workqueue.h | 18 +++++------ src/test/bench_workqueue.c | 24 +++++---------- 3 files changed, 61 insertions(+), 53 deletions(-) diff --git a/src/common/workqueue.c b/src/common/workqueue.c index ea8dcb0..80e061d 100644 --- a/src/common/workqueue.c +++ b/src/common/workqueue.c @@ -31,16 +31,18 @@ keep array of threads; round-robin between them. */ -typedef struct workqueue_entry_s { - TOR_SIMPLEQ_ENTRY(workqueue_entry_s) next_work; - int (*fn)(int status, void *state, void *arg); +struct workqueue_entry_s { + TOR_TAILQ_ENTRY(workqueue_entry_s) next_work; + struct workerthread_s *on_thread; + uint8_t pending; + int (*fn)(void *state, void *arg); void (*reply_fn)(void *arg); void *arg; -} workqueue_entry_t; +}; struct replyqueue_s { tor_mutex_t lock; - TOR_SIMPLEQ_HEAD(, workqueue_entry_s) answers; + TOR_TAILQ_HEAD(, workqueue_entry_s) answers; void (*alert_fn)(struct replyqueue_s *); // lock not held on this, next 2. tor_socket_t write_sock; @@ -50,7 +52,7 @@ struct replyqueue_s { typedef struct workerthread_s { tor_mutex_t lock; tor_cond_t condition; - TOR_SIMPLEQ_HEAD(, workqueue_entry_s) work; + TOR_TAILQ_HEAD(, workqueue_entry_s) work; unsigned is_running; unsigned is_shut_down; unsigned waiting; @@ -76,7 +78,7 @@ struct threadpool_s { static void queue_reply(replyqueue_t *queue, workqueue_entry_t *work); static workqueue_entry_t * -workqueue_entry_new(int (*fn)(int, void*, void*), +workqueue_entry_new(int (*fn)(void*, void*), void (*reply_fn)(void*), void *arg) { @@ -95,6 +97,23 @@ workqueue_entry_free(workqueue_entry_t *ent) tor_free(ent); } +int +workqueue_entry_cancel(workqueue_entry_t *ent) +{ + int cancelled = 0; + tor_mutex_acquire(&ent->on_thread->lock); + if (ent->pending) { + TOR_TAILQ_REMOVE(&ent->on_thread->work, ent, next_work); + cancelled = 1; + } + tor_mutex_release(&ent->on_thread->lock); + + if (cancelled) { + tor_free(ent); + } + return cancelled; +} + static void worker_thread_main(void *thread_) { @@ -107,20 +126,17 @@ worker_thread_main(void *thread_) thread->is_running = 1; while (1) { /* lock held. */ - while (!TOR_SIMPLEQ_EMPTY(&thread->work)) { + while (!TOR_TAILQ_EMPTY(&thread->work)) { /* lock held. */ - work = TOR_SIMPLEQ_FIRST(&thread->work); - TOR_SIMPLEQ_REMOVE_HEAD(&thread->work, next_work); + work = TOR_TAILQ_FIRST(&thread->work); + TOR_TAILQ_REMOVE(&thread->work, work, next_work); + work->pending = 0; tor_mutex_release(&thread->lock); - result = work->fn(WQ_CMD_RUN, thread->state, work->arg); + result = work->fn(thread->state, work->arg); - if (result == WQ_RPL_QUEUE) { - queue_reply(thread->reply_queue, work); - } else { - workqueue_entry_free(work); - } + queue_reply(thread->reply_queue, work); tor_mutex_acquire(&thread->lock); if (result >= WQ_RPL_ERROR) { @@ -148,8 +164,8 @@ queue_reply(replyqueue_t *queue, workqueue_entry_t *work) { int was_empty; tor_mutex_acquire(&queue->lock); - was_empty = TOR_SIMPLEQ_EMPTY(&queue->answers); - TOR_SIMPLEQ_INSERT_TAIL(&queue->answers, work, next_work); + was_empty = TOR_TAILQ_EMPTY(&queue->answers); + TOR_TAILQ_INSERT_TAIL(&queue->answers, work, next_work); tor_mutex_release(&queue->lock); if (was_empty) { @@ -175,7 +191,7 @@ workerthread_new(void *state, replyqueue_t *replyqueue) workerthread_t *thr = tor_malloc_zero(sizeof(workerthread_t)); tor_mutex_init_for_cond(&thr->lock); tor_cond_init(&thr->condition); - TOR_SIMPLEQ_INIT(&thr->work); + TOR_TAILQ_INIT(&thr->work); thr->state = state; thr->reply_queue = replyqueue; @@ -187,9 +203,9 @@ workerthread_new(void *state, replyqueue_t *replyqueue) return thr; } -void * +workqueue_entry_t * threadpool_queue_work(threadpool_t *pool, - int (*fn)(int, void *, void *), + int (*fn)(void *, void *), void (*reply_fn)(void *), void *arg) { @@ -206,11 +222,12 @@ threadpool_queue_work(threadpool_t *pool, pool->next_for_work = 0; tor_mutex_release(&pool->lock); - ent = workqueue_entry_new(fn, reply_fn, arg); tor_mutex_acquire(&worker->lock); - TOR_SIMPLEQ_INSERT_TAIL(&worker->work, ent, next_work); + ent->on_thread = worker; + ent->pending = 1; + TOR_TAILQ_INSERT_TAIL(&worker->work, ent, next_work); if (worker->waiting) /* XXXX inside or outside of lock?? */ tor_cond_signal_one(&worker->condition); @@ -298,7 +315,7 @@ replyqueue_new(void) rq = tor_malloc_zero(sizeof(replyqueue_t)); tor_mutex_init(&rq->lock); - TOR_SIMPLEQ_INIT(&rq->answers); + TOR_TAILQ_INIT(&rq->answers); rq->read_sock = pair[0]; rq->write_sock = pair[1]; @@ -331,10 +348,10 @@ replyqueue_process(replyqueue_t *queue) /* XXXX freak out on r == 0, or r == "error, not retryable". */ tor_mutex_acquire(&queue->lock); - while (!TOR_SIMPLEQ_EMPTY(&queue->answers)) { + while (!TOR_TAILQ_EMPTY(&queue->answers)) { /* lock held. */ - workqueue_entry_t *work = TOR_SIMPLEQ_FIRST(&queue->answers); - TOR_SIMPLEQ_REMOVE_HEAD(&queue->answers, next_work); + workqueue_entry_t *work = TOR_TAILQ_FIRST(&queue->answers); + TOR_TAILQ_REMOVE(&queue->answers, work, next_work); tor_mutex_release(&queue->lock); work->reply_fn(work->arg); @@ -345,3 +362,4 @@ replyqueue_process(replyqueue_t *queue) tor_mutex_release(&queue->lock); } + diff --git a/src/common/workqueue.h b/src/common/workqueue.h index e502734..47753cf 100644 --- a/src/common/workqueue.h +++ b/src/common/workqueue.h @@ -8,20 +8,20 @@ typedef struct replyqueue_s replyqueue_t; typedef struct threadpool_s threadpool_t; - +typedef struct workqueue_entry_s workqueue_entry_t; #define WQ_CMD_RUN 0 #define WQ_CMD_CANCEL 1 -#define WQ_RPL_QUEUE 0 -#define WQ_RPL_NOQUEUE 1 -#define WQ_RPL_ERROR 2 -#define WQ_RPL_SHUTDOWN 3 +#define WQ_RPL_REPLY 0 +#define WQ_RPL_ERROR 1 +#define WQ_RPL_SHUTDOWN 2 -void *threadpool_queue_work(threadpool_t *pool, - int (*fn)(int, void *, void *), - void (*reply_fn)(void *), - void *arg); +workqueue_entry_t *threadpool_queue_work(threadpool_t *pool, + int (*fn)(void *, void *), + void (*reply_fn)(void *), + void *arg); +int workqueue_entry_cancel(workqueue_entry_t *pending_work); int threadpool_start_threads(threadpool_t *pool, int n); threadpool_t *threadpool_new(int n_threads, replyqueue_t *replyqueue, diff --git a/src/test/bench_workqueue.c b/src/test/bench_workqueue.c index 1bdfbef..f190c61 100644 --- a/src/test/bench_workqueue.c +++ b/src/test/bench_workqueue.c @@ -64,7 +64,7 @@ mark_handled(int serial) } static int -workqueue_do_rsa(int cmd, void *state, void *work) +workqueue_do_rsa(void *state, void *work) { rsa_work_t *rw = work; state_t *st = state; @@ -74,16 +74,11 @@ workqueue_do_rsa(int cmd, void *state, void *work) tor_assert(st->magic == 13371337); - if (cmd == WQ_CMD_CANCEL) { - tor_free(work); - return WQ_RPL_NOQUEUE; - } - len = crypto_pk_private_sign(rsa, (char*)sig, 256, (char*)rw->msg, rw->msglen); if (len < 0) { - tor_free(work); - return WQ_RPL_NOQUEUE; + rw->msglen = 0; + return WQ_RPL_ERROR; } memset(rw->msg, 0, sizeof(rw->msg)); @@ -93,12 +88,12 @@ workqueue_do_rsa(int cmd, void *state, void *work) mark_handled(rw->serial); - return WQ_RPL_QUEUE; + return WQ_RPL_REPLY; } #if 0 static int -workqueue_do_shutdown(int cmd, void *state, void *work) +workqueue_do_shutdown(void *state, void *work) { (void)state; (void)work; @@ -110,7 +105,7 @@ workqueue_do_shutdown(int cmd, void *state, void *work) #endif static int -workqueue_do_ecdh(int cmd, void *state, void *work) +workqueue_do_ecdh(void *state, void *work) { ecdh_work_t *ew = work; uint8_t output[CURVE25519_OUTPUT_LEN]; @@ -118,16 +113,11 @@ workqueue_do_ecdh(int cmd, void *state, void *work) tor_assert(st->magic == 13371337); - if (cmd == WQ_CMD_CANCEL) { - tor_free(work); - return WQ_RPL_NOQUEUE; - } - curve25519_handshake(output, &st->ecdh, &ew->u.pk); memcpy(ew->u.msg, output, CURVE25519_OUTPUT_LEN); ++st->n_handled; mark_handled(ew->serial); - return WQ_RPL_QUEUE; + return WQ_RPL_REPLY; } static void *

1 0