[tor-commits] [tor/master] sched: add comment about how we determine if a socket should write

[nickm at torproject.org]

commit ae9e6b547df8efe3eab40237cb4646e158d4d8b0
Author: Matt Traudt <sirmatt at ksu.edu>
Date:   Fri Sep 15 10:28:52 2017 -0400

    sched: add comment about how we determine if a socket should write
---
 src/or/scheduler_kist.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/or/scheduler_kist.c b/src/or/scheduler_kist.c
index 3a897f5bf..913cb4dce 100644
--- a/src/or/scheduler_kist.c
+++ b/src/or/scheduler_kist.c
@@ -375,6 +375,10 @@ socket_can_write(socket_table_t *table, const channel_t *chan)
     return 1; // Just return true, saying that kist wouldn't limit the socket
   }
 
+  /* We previously caclulated a write limit for this socket. In the below
+   * calculation, first determine how much room is left in bytes. Then divide
+   * that by the amount of space a cell takes. If there's room for at least 1
+   * cell, then KIST will allow the socket to write. */
   int64_t kist_limit_space =
     (int64_t) (ent->limit - ent->written) /
     (CELL_MAX_NETWORK_SIZE + TLS_PER_CELL_OVERHEAD);