v3bwfile.py 27.4 KB
Newer Older
juga's avatar
juga committed
1
2
3
4
# -*- coding: utf-8 -*-
"""Classes and functions that create the bandwidth measurements document
(v3bw) used by bandwidth authorities."""

juga's avatar
juga committed
5
import copy
juga's avatar
juga committed
6
import logging
juga's avatar
juga committed
7
import os
juga's avatar
juga committed
8
from statistics import median, mean
juga's avatar
juga committed
9

10
from sbws import __version__
11
12
13
14
from sbws.globals import (SPEC_VERSION, BW_LINE_SIZE, SBWS_SCALE_CONSTANT,
                          TORFLOW_SCALING, SBWS_SCALING, TORFLOW_BW_MARGIN,
                          TORFLOW_OBS_LAST, TORFLOW_OBS_MEAN,
                          fail_hard)
juga's avatar
juga committed
15
from sbws.lib.resultdump import ResultSuccess, _ResultType
16
from sbws.util.filelock import DirectoryLock
Matt Traudt's avatar
Matt Traudt committed
17
from sbws.util.timestamp import now_isodt_str, unixts_to_isodt_str
18
from sbws.util.state import State
juga's avatar
juga committed
19
20
21

log = logging.getLogger(__name__)

22
LINE_SEP = '\n'
23
24
25
26
27
28
KEYVALUE_SEP_V110 = '='
KEYVALUE_SEP_V200 = ' '
# List of the extra KeyValues accepted by the class
EXTRA_ARG_KEYVALUES = ['software', 'software_version', 'file_created',
                       'earliest_bandwidth', 'generator_started']
# List of all unordered KeyValues currently being used to generate the file
juga's avatar
juga committed
29
UNORDERED_KEYVALUES = EXTRA_ARG_KEYVALUES + ['latest_bandwidth']
30
31
# List of all the KeyValues currently being used to generate the file
ALL_KEYVALUES = ['version'] + UNORDERED_KEYVALUES
32
TERMINATOR = '===='
juga's avatar
juga committed
33
34
# Num header lines in v1.1.0 using all the KeyValues
NUM_LINES_HEADER_V110 = len(ALL_KEYVALUES) + 2
35
36
LINE_TERMINATOR = TERMINATOR + LINE_SEP

juga's avatar
juga committed
37
38
# KeyValue separator in Bandwidth Lines
BW_KEYVALUE_SEP_V110 = ' '
39
40
41
42
43
# not inclding in the files the extra bws for now
BW_KEYVALUES_BASIC = ['node_id', 'bw']
BW_KEYVALUES_FILE = BW_KEYVALUES_BASIC + \
                    ['master_key_ed25519', 'nick', 'rtt', 'time',
                     'success', 'error_stream', 'error_circ', 'error_misc']
44
45
BW_KEYVALUES_EXTRA_BWS = ['bw_bs_median', 'bw_bs_mean', 'desc_avg_bw_bs',
                          'desc_obs_bw_bs_last', 'desc_obs_bw_bs_mean']
46
BW_KEYVALUES_EXTRA = BW_KEYVALUES_FILE + BW_KEYVALUES_EXTRA_BWS
47
BW_KEYVALUES_INT = ['bw', 'rtt', 'success', 'error_stream',
48
49
                    'error_circ', 'error_misc'] + BW_KEYVALUES_EXTRA_BWS
BW_KEYVALUES = BW_KEYVALUES_BASIC + BW_KEYVALUES_EXTRA
juga's avatar
juga committed
50
51
52
53
54
55
56
57
58
59
60


def num_results_of_type(results, type_str):
    return len([r for r in results if r.type == type_str])


# Better way to use enums?
def result_type_to_key(type_str):
    return type_str.replace('-', '_')


61
class V3BWHeader(object):
juga's avatar
juga committed
62
63
64
65
    """
    Create a bandwidth measurements (V3bw) header
    following bandwidth measurements document spec version 1.1.0.

66
    :param str timestamp: timestamp in Unix Epoch seconds of the most recent
67
        generator result.
juga's avatar
juga committed
68
69
70
    :param str version: the spec version
    :param str software: the name of the software that generates this
    :param str software_version: the version of the software
71
    :param dict kwargs: extra headers. Currently supported:
juga's avatar
juga committed
72

73
74
75
76
        - earliest_bandwidth: str, ISO 8601 timestamp in UTC time zone
          when the first bandwidth was obtained
        - generator_started: str, ISO 8601 timestamp in UTC time zone
          when the generator started
juga's avatar
juga committed
77
    """
78
    def __init__(self, timestamp, **kwargs):
juga's avatar
juga committed
79
80
81
82
        assert isinstance(timestamp, str)
        for v in kwargs.values():
            assert isinstance(v, str)
        self.timestamp = timestamp
83
84
85
86
        # KeyValues with default value when not given by kwargs
        self.version = kwargs.get('version', SPEC_VERSION)
        self.software = kwargs.get('software', 'sbws')
        self.software_version = kwargs.get('software_version', __version__)
87
        self.file_created = kwargs.get('file_created', now_isodt_str())
juga's avatar
juga committed
88
        # latest_bandwidth should not be in kwargs, since it MUST be the
89
        # same as timestamp
juga's avatar
juga committed
90
        self.latest_bandwidth = unixts_to_isodt_str(timestamp)
91
92
        [setattr(self, k, v) for k, v in kwargs.items()
         if k in EXTRA_ARG_KEYVALUES]
juga's avatar
juga committed
93

94
95
96
97
98
    def __str__(self):
        if self.version == '1.1.0':
            return self.strv110
        return self.strv200

juga's avatar
juga committed
99
    @classmethod
juga's avatar
juga committed
100
    def from_results(cls, results, state_fpath=''):
juga's avatar
juga committed
101
102
103
        kwargs = dict()
        latest_bandwidth = cls.latest_bandwidth_from_results(results)
        earliest_bandwidth = cls.earliest_bandwidth_from_results(results)
juga's avatar
juga committed
104
        generator_started = cls.generator_started_from_file(state_fpath)
juga's avatar
juga committed
105
106
107
108
109
110
111
112
        timestamp = str(latest_bandwidth)
        kwargs['latest_bandwidth'] = unixts_to_isodt_str(latest_bandwidth)
        kwargs['earliest_bandwidth'] = unixts_to_isodt_str(earliest_bandwidth)
        if generator_started is not None:
            kwargs['generator_started'] = generator_started
        h = cls(timestamp, **kwargs)
        return h

113
114
115
116
    @classmethod
    def from_lines_v110(cls, lines):
        """
        :param list lines: list of lines to parse
117
        :returns: tuple of V3BWHeader object and non-header lines
118
119
120
121
        """
        assert isinstance(lines, list)
        try:
            index_terminator = lines.index(TERMINATOR)
Matt Traudt's avatar
Matt Traudt committed
122
        except ValueError:
123
124
125
            # is not a bw file or is v100
            log.warn('Terminator is not in lines')
            return None
126
        ts = lines[0]
127
        kwargs = dict([l.split(KEYVALUE_SEP_V110)
128
                       for l in lines[:index_terminator]
129
                       if l.split(KEYVALUE_SEP_V110)[0] in ALL_KEYVALUES])
130
        h = cls(ts, **kwargs)
juga's avatar
juga committed
131
        # last line is new line
132
        return h, lines[index_terminator + 1:-1]
133
134
135
136

    @classmethod
    def from_text_v110(self, text):
        """
137
        :param str text: text to parse
138
        :returns: tuple of V3BWHeader object and non-header lines
139
140
141
        """
        assert isinstance(text, str)
        return self.from_lines_v110(text.split(LINE_SEP))
juga's avatar
juga committed
142
143

    @staticmethod
juga's avatar
juga committed
144
    def generator_started_from_file(state_fpath):
145
146
147
148
        '''
        ISO formatted timestamp for the time when the scanner process most
        recently started.
        '''
juga's avatar
juga committed
149
        state = State(state_fpath)
150
151
152
153
        if 'scanner_started' in state:
            return state['scanner_started']
        else:
            return None
juga's avatar
juga committed
154
155

    @staticmethod
juga's avatar
juga committed
156
    def latest_bandwidth_from_results(results):
juga's avatar
juga committed
157
        return round(max([r.time for fp in results for r in results[fp]]))
juga's avatar
juga committed
158
159
160

    @staticmethod
    def earliest_bandwidth_from_results(results):
juga's avatar
juga committed
161
        return round(min([r.time for fp in results for r in results[fp]]))
juga's avatar
juga committed
162

juga's avatar
juga committed
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
    @property
    def keyvalue_unordered_tuple_ls(self):
        """Return list of KeyValue tuples that do not have specific order."""
        # sort the list to generate determinist headers
        keyvalue_tuple_ls = sorted([(k, v) for k, v in self.__dict__.items()
                                    if k in UNORDERED_KEYVALUES])
        return keyvalue_tuple_ls

    @property
    def keyvalue_tuple_ls(self):
        """Return list of all KeyValue tuples"""
        return [('version', self.version)] + self.keyvalue_unordered_tuple_ls

    @property
    def keyvalue_v110str_ls(self):
        """Return KeyValue list of strings following spec v1.1.0."""
        keyvalues = [self.timestamp] + [KEYVALUE_SEP_V110.join([k, v])
                                        for k, v in self.keyvalue_tuple_ls]
        return keyvalues

    @property
    def strv110(self):
        """Return header string following spec v1.1.0."""
        header_str = LINE_SEP.join(self.keyvalue_v110str_ls) + LINE_SEP + \
            LINE_TERMINATOR
        return header_str

    @property
    def keyvalue_v200_ls(self):
        """Return KeyValue list of strings following spec v2.0.0."""
        keyvalue = [self.timestamp] + [KEYVALUE_SEP_V200.join([k, v])
                                       for k, v in self.keyvalue_tuple_ls]
        return keyvalue

    @property
    def strv200(self):
        """Return header string following spec v2.0.0."""
        header_str = LINE_SEP.join(self.keyvalue_v200_ls) + LINE_SEP + \
            LINE_TERMINATOR
        return header_str

    @property
    def num_lines(self):
        return len(self.__str__().split(LINE_SEP))
juga's avatar
juga committed
207
208


juga's avatar
juga committed
209
class V3BWLine(object):
juga's avatar
juga committed
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
    """
    Create a Bandwidth List line following the spec version 1.1.0.

    :param str node_id:
    :param int bw:
    :param dict kwargs: extra headers. Currently supported:

        - nickname, str
        - master_key_ed25519, str
        - rtt, int
        - time, str
        - sucess, int
        - error_stream, int
        - error_circ, int
        - error_misc, int
    """
juga's avatar
juga committed
226
227
228
    def __init__(self, node_id, bw, **kwargs):
        assert isinstance(node_id, str)
        assert isinstance(bw, int)
229
        assert node_id.startswith('$')
juga's avatar
juga committed
230
231
232
        self.node_id = node_id
        self.bw = bw
        [setattr(self, k, v) for k, v in kwargs.items()
233
         if k in BW_KEYVALUES_EXTRA]
juga's avatar
juga committed
234

juga's avatar
juga committed
235
    def __str__(self):
juga's avatar
juga committed
236
237
        return self.bw_strv110

juga's avatar
juga committed
238
239
    @classmethod
    def from_results(cls, results):
240
241
242
243
244
245
246
247
248
        """Convert sbws results to relays' Bandwidth Lines

        ``bs`` stands for Bytes/seconds
        ``bw_bs_mean`` means the bw is obtained from the mean of the all the
        downloads' bandwidth.
        Downloads' bandwidth are calculated as the amount of data received
        divided by the the time it took to received.
        bw = data (Bytes) / time (seconds)
        """
juga's avatar
juga committed
249
250
251
252
253
254
255
256
        success_results = [r for r in results if isinstance(r, ResultSuccess)]
        node_id = '$' + results[0].fingerprint
        kwargs = dict()
        kwargs['nick'] = results[0].nickname
        if getattr(results[0], 'master_key_ed25519'):
            kwargs['master_key_ed25519'] = results[0].master_key_ed25519
        kwargs['time'] = cls.last_time_from_results(results)
        kwargs.update(cls.result_types_from_results(results))
257
258
259
260
261
262
263
264
265
266
        # useful args for scaling
        if success_results:
            # the most recent should be the last
            kwargs['desc_avg_bw_bs'] = \
                success_results[-1].relay_average_bandwidth
            kwargs['rtt'] = cls.rtt_from_results(success_results)
            bw = cls.bw_bs_median_from_results(success_results)
            kwargs['bw_bs_mean'] = cls.bw_bs_mean_from_results(success_results)
            kwargs['bw_bs_median'] = cls.bw_bs_median_from_results(
                success_results)
267
268
269
270
            kwargs['desc_obs_bw_bs_last'] = \
                cls.desc_obs_bw_bs_last_from_results(success_results)
            kwargs['desc_obs_bw_bs_mean'] = \
                cls.desc_obs_bw_bs_mean_from_results(success_results)
271
272
273
            bwl = cls(node_id, bw, **kwargs)
            return bwl
        return None
juga's avatar
juga committed
274
275
276
277
278
279

    @classmethod
    def from_data(cls, data, fingerprint):
        assert fingerprint in data
        return cls.from_results(data[fingerprint])

juga's avatar
juga committed
280
281
282
283
284
285
    @classmethod
    def from_bw_line_v110(cls, line):
        assert isinstance(line, str)
        kwargs = dict([kv.split(KEYVALUE_SEP_V110)
                       for kv in line.split(BW_KEYVALUE_SEP_V110)
                       if kv.split(KEYVALUE_SEP_V110)[0] in BW_KEYVALUES])
juga's avatar
juga committed
286
287
288
        for k, v in kwargs.items():
            if k in BW_KEYVALUES_INT:
                kwargs[k] = int(v)
289
290
291
292
293
        node_id = kwargs['node_id']
        bw = kwargs['bw']
        del kwargs['node_id']
        del kwargs['bw']
        bw_line = cls(node_id, bw, **kwargs)
juga's avatar
juga committed
294
295
        return bw_line

296
297
298
299
300
301
302
303
304
305
    @staticmethod
    def bw_bs_median_from_results(results):
        return max(round(median([dl['amount'] / dl['duration']
                                 for r in results for dl in r.downloads])), 1)

    @staticmethod
    def bw_bs_mean_from_results(results):
        return max(round(mean([dl['amount'] / dl['duration']
                               for r in results for dl in r.downloads])), 1)

juga's avatar
juga committed
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
    @staticmethod
    def last_time_from_results(results):
        return unixts_to_isodt_str(round(max([r.time for r in results])))

    @staticmethod
    def rtt_from_results(results):
        # convert from miliseconds to seconds
        rtts = [(round(rtt * 1000)) for r in results for rtt in r.rtts]
        rtt = round(median(rtts))
        return rtt

    @staticmethod
    def result_types_from_results(results):
        rt_dict = dict([(result_type_to_key(rt.value),
                         num_results_of_type(results, rt.value))
                        for rt in _ResultType])
        return rt_dict

324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
    @staticmethod
    def desc_obs_bw_bs_mean_from_results(results):
        desc_obs_bws = []
        for r in results:
            if r.relay_observed_bandwidth is not None:
                desc_obs_bws.append(r.relay_observed_bandwidth)
        if desc_obs_bws:
            return max(round(mean(desc_obs_bws)), 1)
        return None

    @staticmethod
    def desc_obs_bw_bs_last_from_results(results):
        # the last is at the end of the list
        for r in reversed(results):
            if r.relay_observed_bandwidth is not None:
                return r.relay_observed_bandwidth
        return None

juga's avatar
juga committed
342
343
344
345
346
347
348
    @property
    def bw_keyvalue_tuple_ls(self):
        """Return list of KeyValue Bandwidth Line tuples."""
        # sort the list to generate determinist headers
        keyvalue_tuple_ls = sorted([(k, v) for k, v in self.__dict__.items()
                                    if k in BW_KEYVALUES])
        return keyvalue_tuple_ls
juga's avatar
juga committed
349

juga's avatar
juga committed
350
351
352
353
354
355
356
357
    @property
    def bw_keyvalue_v110str_ls(self):
        """Return list of KeyValue Bandwidth Line strings following
        spec v1.1.0.
        """
        bw_keyvalue_str = [KEYVALUE_SEP_V110 .join([k, str(v)])
                           for k, v in self.bw_keyvalue_tuple_ls]
        return bw_keyvalue_str
juga's avatar
juga committed
358

juga's avatar
juga committed
359
360
361
362
363
364
365
366
367
368
369
    @property
    def bw_strv110(self):
        """Return Bandwidth Line string following spec v1.1.0."""
        bw_line_str = BW_KEYVALUE_SEP_V110.join(
                        self.bw_keyvalue_v110str_ls) + LINE_SEP
        if len(bw_line_str) > BW_LINE_SIZE:
            # if this is the case, probably there are too many KeyValues,
            # or the limit needs to be changed in Tor
            log.warn("The bandwidth line %s is longer than %s",
                     len(bw_line_str), BW_LINE_SIZE)
        return bw_line_str
juga's avatar
juga committed
370

juga's avatar
juga committed
371

372
class V3BWFile(object):
juga's avatar
juga committed
373
374
375
376
377
378
    """
    Create a Bandwidth List file following spec version 1.1.0

    :param V3BWHeader v3bwheader: header
    :param list v3bwlines: V3BWLines
    """
juga's avatar
juga committed
379
380
381
382
383
    def __init__(self, v3bwheader, v3bwlines):
        self.header = v3bwheader
        self.bw_lines = v3bwlines

    def __str__(self):
384
        return str(self.header) + ''.join([str(bw_line) or ''
juga's avatar
juga committed
385
386
                                           for bw_line in self.bw_lines])

juga's avatar
juga committed
387
    @classmethod
juga's avatar
juga committed
388
    def from_results(cls, results, state_fpath='',
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
                     scale_constant=SBWS_SCALE_CONSTANT,
                     scaling_method=None, torflow_obs=TORFLOW_OBS_LAST,
                     reverse=False):
        """Create V3BWFile class from sbws Results.

        :param dict results: see below
        :param str state_fpath: path to the state file
        :param int scaling_method:
            Scaling method to obtain the bandwidth
            Posiable values: {NONE, SBWS_SCALING, TORFLOW_SCALING} = {0, 1, 2}
        :param int scale_constant: sbws scaling constant
        :param int torflow_obs: method to choose descriptor observed bandwidth
        :param bool reverse: whether to sort the bw lines descending or not

        Results are in the form::

            {'relay_fp1': [Result1, Result2, ...],
             'relay_fp2': [Result1, Result2, ...]}

        """
        # TODO: change scaling_method to TORFLOW_SCALING before getting this
        # in production
        log.info('Processing results to generate a bandwidth list file.')
        header = V3BWHeader.from_results(results, state_fpath)
        bw_lines_raw = []
        for fp in results.keys():
            l = V3BWLine.from_results(results[fp])
            if l is not None:
                bw_lines_raw.append(l)
        if not bw_lines_raw:
            return cls(header, [])
        if scaling_method == SBWS_SCALING:
            bw_lines = cls.bw_sbws_scale(bw_lines_raw, scale_constant)
juga's avatar
juga committed
422
            cls.warn_if_not_accurate_enough(bw_lines, scale_constant)
423
424
425
426
            # log.debug(bw_lines[-1])
        elif scaling_method == TORFLOW_SCALING:
            bw_lines = cls.bw_torflow_scale(bw_lines_raw, torflow_obs)
            # log.debug(bw_lines[-1])
juga's avatar
juga committed
427
        else:
428
429
            bw_lines = cls.bw_kb(bw_lines_raw)
            # log.debug(bw_lines[-1])
juga's avatar
juga committed
430
431
432
        f = cls(header, bw_lines)
        return f

juga's avatar
juga committed
433
434
435
436
437
438
439
    @staticmethod
    def bw_kb(bw_lines, reverse=False):
        bw_lines_scaled = copy.deepcopy(bw_lines)
        for l in bw_lines_scaled:
            l.bw = max(round(l.bw / 1000), 1)
        return sorted(bw_lines_scaled, key=lambda x: x.bw, reverse=reverse)

juga's avatar
juga committed
440
    @staticmethod
441
    def bw_sbws_scale(bw_lines, scale_constant=SBWS_SCALE_CONSTANT,
juga's avatar
juga committed
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
                      reverse=False):
        """Return a new V3BwLine list scaled using sbws method.

        :param list bw_lines:
            bw lines to scale, not self.bw_lines,
            since this method will be before self.bw_lines have been
            initialized.
        :param int scale_constant:
            the constant to multiply by the ratio and
            the bandwidth to obtain the new bandwidth
        :returns list: V3BwLine list
        """
        # If a relay has MaxAdvertisedBandwidth set, they may be capable of
        # some large amount of bandwidth but prefer if they didn't receive it.
        # We also could have managed to measure them faster than their
        # {,Relay}BandwidthRate somehow.
        #
        # See https://github.com/pastly/simple-bw-scanner/issues/155 and
        # https://trac.torproject.org/projects/tor/ticket/8494
        #
        # Note how this isn't some measured-by-us average of bandwidth. It's
        # the first value on the 'bandwidth' line in the relay's server
        # descriptor.
        log.debug('Scaling bandwidth using sbws method.')
        m = median([l.bw for l in bw_lines])
        bw_lines_scaled = copy.deepcopy(bw_lines)
        for l in bw_lines_scaled:
            # min is to limit the bw to descriptor average-bandwidth
            # max to avoid bandwidth with 0 value
            l.bw = max(round(min(l.desc_avg_bw_bs,
472
                                 l.bw * scale_constant / m)
juga's avatar
juga committed
473
474
475
476
477
                             / 1000), 1)
        return sorted(bw_lines_scaled, key=lambda x: x.bw, reverse=reverse)

    @staticmethod
    def warn_if_not_accurate_enough(bw_lines,
478
                                    scale_constant=SBWS_SCALE_CONSTANT):
juga's avatar
juga committed
479
480
481
482
483
484
485
486
        margin = 0.001
        accuracy_ratio = median([l.bw for l in bw_lines]) / scale_constant
        log.info('The generated lines are within {:.5}% of what they should '
                 'be'.format((1 - accuracy_ratio) * 100))
        if accuracy_ratio < 1 - margin or accuracy_ratio > 1 + margin:
            log.warning('There was %f%% error and only +/- %f%% is '
                        'allowed', (1 - accuracy_ratio) * 100, margin * 100)

487
    @staticmethod
juga's avatar
juga committed
488
    def bw_torflow_scale(bw_lines, desc_obs_bws=TORFLOW_OBS_LAST,
489
                         cap=TORFLOW_BW_MARGIN, reverse=False):
juga's avatar
juga committed
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
        """
        Obtain final bandwidth measurements applying Torflow's scaling
        method.

        From Torflow's README.spec.txt (section 2.2)::

            In this way, the resulting network status consensus bandwidth values  # NOQA
            are effectively re-weighted proportional to how much faster the node  # NOQA
            was as compared to the rest of the network.

        The variables and steps used in Torflow:

        **strm_bw**::

            The strm_bw field is the average (mean) of all the streams for the relay  # NOQA
            identified by the fingerprint field.
            strm_bw = sum(bw stream x)/|n stream|

        **filt_bw**::

            The filt_bw field is computed similarly, but only the streams equal to  # NOQA
            or greater than the strm_bw are counted in order to filter very slow  # NOQA
            streams due to slow node pairings.

        **filt_sbw and strm_sbw**::

            for rs in RouterStats.query.filter(stats_clause).\
                  options(eagerload_all('router.streams.circuit.routers')).all():  # NOQA
              tot_sbw = 0
              sbw_cnt = 0
              for s in rs.router.streams:
                if isinstance(s, ClosedStream):
                  skip = False
                  #for br in badrouters:
                  #  if br != rs:
                  #    if br.router in s.circuit.routers:
                  #      skip = True
                  if not skip:
                    # Throw out outliers < mean
                    # (too much variance for stddev to filter much)
                    if rs.strm_closed == 1 or s.bandwidth() >= rs.sbw:
                      tot_sbw += s.bandwidth()
                      sbw_cnt += 1

            if sbw_cnt: rs.filt_sbw = tot_sbw/sbw_cnt
            else: rs.filt_sbw = None

        **filt_avg, and strm_avg**::

            Once we have determined the most recent measurements for each node, we  # NOQA
            compute an average of the filt_bw fields over all nodes we have measured.  # NOQA

        ::

            filt_avg = sum(map(lambda n: n.filt_bw, nodes.itervalues()))/float(len(nodes))  # NOQA
            strm_avg = sum(map(lambda n: n.strm_bw, nodes.itervalues()))/float(len(nodes))  # NOQA

        **true_filt_avg and true_strm_avg**::

            for cl in ["Guard+Exit", "Guard", "Exit", "Middle"]:
                true_filt_avg[cl] = filt_avg
                true_strm_avg[cl] = strm_avg

        In the non-pid case, all types of nodes get the same avg

        **n.fbw_ratio and n.fsw_ratio**::

            for n in nodes.itervalues():
                n.fbw_ratio = n.filt_bw/true_filt_avg[n.node_class()]
                n.sbw_ratio = n.strm_bw/true_strm_avg[n.node_class()]

        **n.ratio**::

            These averages are used to produce ratios for each node by dividing the  # NOQA
            measured value for that node by the network average.

        ::

            # Choose the larger between sbw and fbw
              if n.sbw_ratio > n.fbw_ratio:
                n.ratio = n.sbw_ratio
              else:
                n.ratio = n.fbw_ratio

        **desc_bw**:

        It is the ``observed bandwidth`` in the descriptor, NOT the ``average
        bandwidth``::

            return Router(ns.idhex, ns.nickname, bw_observed, dead, exitpolicy,
            ns.flags, ip, version, os, uptime, published, contact, rate_limited,  # NOQA
            ns.orhash, ns.bandwidth, extra_info_digest, ns.unmeasured)
            self.desc_bw = max(bw,1) # Avoid div by 0

        **new_bw**::

            These ratios are then multiplied by the most recent observed descriptor  # NOQA
            bandwidth we have available for each node, to produce a new value for  # NOQA
            the network status consensus process.

        ::

            n.new_bw = n.desc_bw*n.ratio

        The descriptor observed bandwidth is multiplied by the ratio.
        With empirical results this ratio is ~[0.9, 8.9]

        **Limit the bandwidth to a maximum**::

            NODE_CAP = 0.05

        ::

            if n.new_bw > tot_net_bw*NODE_CAP:
              plog("INFO", "Clipping extremely fast "+n.node_class()+" node "+n.idhex+"="+n.nick+  # NOQA
                   " at "+str(100*NODE_CAP)+"% of network capacity ("+
                   str(n.new_bw)+"->"+str(int(tot_net_bw*NODE_CAP))+") "+
                   " pid_error="+str(n.pid_error)+
                   " pid_error_sum="+str(n.pid_error_sum))
              n.new_bw = int(tot_net_bw*NODE_CAP)

        However, tot_net_bw does not seems to be updated when not using pid.
        This clipping would make faster relays to all have the same value.

        All of that can be expressed as:

        .. math::

                bwnew_i &=
                    max\\left(
                        \\frac{bw_i}{\\mu},
                        min \\left(
                            bw_i,
                            bw_i \\times \\mu
                            \\right)
                                \\times
                                \\frac{bw}{\\sum_{i=1}^{n}
                                min \\left(bw_i,
                                    bw_i \\times \\mu
                            \\right)}
                        \\right)
                    \\times bwdescobs_i \\

                &=
                    max\\left(
                        \\frac{bw_i}{\\frac{\\sum_{i=1}^{n}bw_i}{n}},
                        min \\left(
                            bw_i,
                            bw_i \\times \\frac{\\sum_{i=1}^{n}bw_i}{n}
                            \\right)
                                \\times
                                \\frac{bw}{\\sum_{i=1}^{n}
                                min \\left(bw_i,
                                    bw_i \\times \\frac{\\sum_{i=1}^{n}bw_i}{n}
                            \\right)}
                        \\right)
                    \\times bwdescobs_i

        """
        log.info("Calculating relays' bandwidth using Torflow method.")
        bw_lines_tf = copy.deepcopy(bw_lines)
        # mean (Torflow's strm_avg)
        mu = mean([l.bw_bs_mean for l in bw_lines])
        # filtered mean (Torflow's filt_avg)
        muf = mean([min(l.bw_bs_mean, mu) for l in bw_lines])
        # bw sum (Torflow's tot_net_bw or tot_sbw)
        sum_bw = sum([l.bw_bs_mean for l in bw_lines])
        # Torflow's clipping, not being applied
        # hlimit = sum_bw * TORFLOW_BW_MARGIN
        log.debug('sum %s', sum_bw)
        log.debug('mu %s', mu)
        log.debug('muf %s', muf)
        # log.debug('hlimit %s', hlimit)
        for l in bw_lines_tf:
            if desc_obs_bws == TORFLOW_OBS_LAST:
                desc_obs_bw = l.desc_obs_bw_bs_last
            elif desc_obs_bws == TORFLOW_OBS_MEAN:
                desc_obs_bw = l.desc_obs_bw_bs_mean
            # just applying the formula above:
            l.bw = max(round(
                max(
                    # ratio
                    l.bw_bs_mean / mu,
                    # ratio filtered
                    min(l.bw_bs_mean, mu) / muf
                    ) * desc_obs_bw
                / 1000), 1)
        return sorted(bw_lines_tf, key=lambda x: x.bw, reverse=reverse)
678

juga's avatar
juga committed
679
    @property
juga's avatar
juga committed
680
681
    def sum_bw(self):
        return sum([l.bw for l in self.bw_lines])
juga's avatar
juga committed
682
683

    @property
juga's avatar
juga committed
684
    def num(self):
juga's avatar
juga committed
685
686
687
        return len(self.bw_lines)

    @property
juga's avatar
juga committed
688
689
690
691
692
693
    def mean_bw(self):
        return mean([l.bw for l in self.bw_lines])

    @property
    def median_bw(self):
        return median([l.bw for l in self.bw_lines])
juga's avatar
juga committed
694

juga's avatar
juga committed
695
696
697
698
699
    def write(self, output):
        if output == '/dev/stdout':
            log.info("Writing to stdout is not supported.")
            return
        log.info('Writing v3bw file to %s', output)
700
701
        # To avoid inconsistent reads, the bandwidth data is written to an
        # archive path, then atomically symlinked to 'latest.v3bw'
juga's avatar
juga committed
702
703
        out_dir = os.path.dirname(output)
        out_link = os.path.join(out_dir, 'latest.v3bw')
704
        out_link_tmp = out_link + '.tmp'
juga's avatar
juga committed
705
706
707
708
709
710
        with DirectoryLock(out_dir):
            with open(output, 'wt') as fd:
                fd.write(str(self.header))
                for line in self.bw_lines:
                    fd.write(str(line))
            output_basename = os.path.basename(output)
711
712
713
714
715
716
717
718
719
720
            # To atomically symlink a file, we need to create a temporary link,
            # then rename it to the final link name. (POSIX guarantees that
            # rename is atomic.)
            log.debug('Creating symlink {} -> {}.'
                      .format(out_link_tmp, output_basename))
            os.symlink(output_basename, out_link_tmp)
            log.debug('Renaming symlink {} -> {} to {} -> {}.'
                      .format(out_link_tmp, output_basename,
                              out_link, output_basename))
            os.rename(out_link_tmp, out_link)