commit 5a9cd80a98fa7f8379231862e0d1714a0779a960 Author: Mike Perry <mikeperry-git@torproject.org> Date: Wed May 16 05:58:42 2018 +0000 fixup! Attempt to clarify new CIRC_BW fields Also mention that the READ and WRITE fields do not include circuit headers, and the delivered and overhead fields do not include relay cell headers. --- control-spec.txt | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/control-spec.txt b/control-spec.txt index e448918..30160f4 100644 --- a/control-spec.txt +++ b/control-spec.txt @@ -2945,21 +2945,24 @@ BytesRead and BytesWritten are the number of bytes read and written on this circuit since the last CIRC_BW event. These bytes have not necessarily been validated by Tor, and can include invalid cells, - dropped cells, and ignored cells (such as padding cells). + dropped cells, and ignored cells (such as padding cells). These + values include the relay headers, but not circuit headers. Circuit data that has been validated and processed by Tor is further broken down into two categories: delivered payloads and overhead. - DeliveredBytesRead and DeliveredBytesWritten are the total payloads - transmitted since the last CIRC_BW event, whereas OverheadBytesRead and + DeliveredBytesRead and DeliveredBytesWritten are the total relay cell + payloads transmitted since the last CIRC_BW event, not counting relay + cell headers or circuit headers. OverheadBytesRead and OverheadBytesWritten are the extra unused bytes at the end of each cell in order for it to be the fixed CELL_LEN bytes long. The sum of DeliveredBytesRead and OverheadBytesRead MUST be less than - or equal to BytesRead, and the same is true for their written - counterparts. This sum represents the total bytes on the circuit that - have been validated by Tor. Subtracting this sum from the BytesRead - (or BytesWritten) value gives the byte count that Tor has decided - to reject due to protocol errors, or has otherwise decided to ignore. + BytesRead, and the same is true for their written counterparts. This + sum represents the total relay cell bytes on the circuit that + have been validated by Tor, not counting relay headers and cell headers. + Subtracting this sum (plus relay cell headers) from the BytesRead + (or BytesWritten) value gives the byte count that Tor has decided to + reject due to protocol errors, or has otherwise decided to ignore. The Time field is provided only in versions 0.3.2.1-alpha and later. It records when Tor created the bandwidth event.