Add some comments to or_circuit_t.workqueue_entry

These were suggested by dgoulet, thanks!

diff --git a/src/or/cpuworker.c b/src/or/cpuworker.c
index 7fe2351979b3508e2a11929d1917088be3bc641b..c5e78ed71672645d529ea9079c79e2242fc8261e 100644 (file)
--- a/src/or/cpuworker.c
+++ b/src/or/cpuworker.c
@@ -556,6 +556,7 @@ cpuworker_cancel_circ_handshake(or_circuit_t *circ)
     tor_free(job);
     tor_assert(total_pending_tasks > 0);
     --total_pending_tasks;
+    /* if (!job), this is done in cpuworker_onion_handshake_replyfn. */
     circ->workqueue_entry = NULL;
   }
 }

diff --git a/src/or/or.h b/src/or/or.h
index 520b7dba8999b4c127dedc48a2037f2f7a32e9c8..5d70798d8e23a514ea90975f0b053e7bf68ea280 100644 (file)
--- a/src/or/or.h
+++ b/src/or/or.h
@@ -3126,7 +3126,8 @@ typedef struct or_circuit_t {
    * chance to give an onionskin to a cpuworker. Used only in onion.c */
   struct onion_queue_t *onionqueue_entry;
   /** Pointer to a workqueue entry, if this circuit has given an onionskin to
-   * a cpuworker and is waiting for a response. Used only in cpuworker.c */
+   * a cpuworker and is waiting for a response. Used to decide whether it is
+   * safe to free a circuit or if it is still in use by a cpuworker. */
   struct workqueue_entry_s *workqueue_entry;
 
   /** The circuit_id used in the previous (backward) hop of this circuit. */