rephist.c 22.2 KB
Newer Older
Nick Mathewson's avatar
Nick Mathewson committed
1
/* Copyright 2004-2005 Roger Dingledine, Nick Mathewson. */
2
3
/* See LICENSE for licensing information */
/* $Id$ */
4
const char rephist_c_id[] = "$Id$";
5

Nick Mathewson's avatar
Nick Mathewson committed
6
7
/**
 * \file rephist.c
8
9
10
 * \brief Basic history and "reputation" functionality to remember
 *    which servers have worked in the past, how much bandwidth we've
 *    been using, which ports we tend to want, and so on.
Nick Mathewson's avatar
Nick Mathewson committed
11
 **/
12

13
14
#include "or.h"

15
static void bw_arrays_init(void);
16
static void predicted_ports_init(void);
17

18
19
uint64_t rephist_total_alloc=0;
uint32_t rephist_total_num=0;
20

Nick Mathewson's avatar
Nick Mathewson committed
21
/** History of an OR-\>OR link. */
22
typedef struct link_history_t {
Nick Mathewson's avatar
Nick Mathewson committed
23
  /** When did we start tracking this list? */
24
  time_t since;
25
26
  /** When did we most recently note a change to this link */
  time_t changed;
27
  /** How many times did extending from OR1 to OR2 succeed? */
28
  unsigned long n_extend_ok;
Nick Mathewson's avatar
Nick Mathewson committed
29
  /** How many times did extending from OR1 to OR2 fail? */
30
31
32
  unsigned long n_extend_fail;
} link_history_t;

Nick Mathewson's avatar
Nick Mathewson committed
33
/** History of an OR. */
34
typedef struct or_history_t {
Nick Mathewson's avatar
Nick Mathewson committed
35
  /** When did we start tracking this OR? */
36
  time_t since;
37
38
  /** When did we most recently note a change to this OR? */
  time_t changed;
Nick Mathewson's avatar
Nick Mathewson committed
39
  /** How many times did we successfully connect? */
40
  unsigned long n_conn_ok;
Nick Mathewson's avatar
Nick Mathewson committed
41
  /** How many times did we try to connect and fail?*/
42
  unsigned long n_conn_fail;
Nick Mathewson's avatar
Nick Mathewson committed
43
  /** How many seconds have we been connected to this OR before
44
   * 'up_since'? */
45
  unsigned long uptime;
Nick Mathewson's avatar
Nick Mathewson committed
46
  /** How many seconds have we been unable to connect to this OR before
47
   * 'down_since'? */
48
  unsigned long downtime;
Nick Mathewson's avatar
Nick Mathewson committed
49
  /** If nonzero, we have been connected since this time. */
50
  time_t up_since;
Nick Mathewson's avatar
Nick Mathewson committed
51
  /** If nonzero, we have been unable to connect since this time. */
52
  time_t down_since;
Nick Mathewson's avatar
Nick Mathewson committed
53
  /** Map from hex OR2 identity digest to a link_history_t for the link
54
   * from this OR to OR2. */
55
56
57
  strmap_t *link_history_map;
} or_history_t;

Nick Mathewson's avatar
Nick Mathewson committed
58
/** Map from hex OR identity digest to or_history_t. */
59
static strmap_t *history_map = NULL;
60

Nick Mathewson's avatar
Nick Mathewson committed
61
/** Return the or_history_t for the named OR, creating it if necessary.
62
 */
63
64
static or_history_t *
get_or_history(const char* id)
65
66
{
  or_history_t *hist;
67
68
69
  char hexid[HEX_DIGEST_LEN+1];
  base16_encode(hexid, HEX_DIGEST_LEN+1, id, DIGEST_LEN);

70
71
72
  if (!strcmp(hexid, "0000000000000000000000000000000000000000"))
    return NULL;

73
  hist = (or_history_t*) strmap_get(history_map, hexid);
74
75
  if (!hist) {
    hist = tor_malloc_zero(sizeof(or_history_t));
76
    rephist_total_alloc += sizeof(or_history_t);
77
    rephist_total_num++;
78
    hist->link_history_map = strmap_new();
79
    hist->since = hist->changed = time(NULL);
80
    strmap_set(history_map, hexid, hist);
81
82
83
84
  }
  return hist;
}

Nick Mathewson's avatar
Nick Mathewson committed
85
/** Return the link_history_t for the link from the first named OR to
Nick Mathewson's avatar
Nick Mathewson committed
86
87
 * the second, creating it if necessary. (ORs are identified by
 * identity digest)
88
 */
89
90
static link_history_t *
get_link_history(const char *from_id, const char *to_id)
91
92
93
{
  or_history_t *orhist;
  link_history_t *lhist;
94
95
  char to_hexid[HEX_DIGEST_LEN+1];
  orhist = get_or_history(from_id);
96
97
  if (!orhist)
    return NULL;
98
  base16_encode(to_hexid, HEX_DIGEST_LEN+1, to_id, DIGEST_LEN);
Nick Mathewson's avatar
Nick Mathewson committed
99
  if (!strcmp(to_hexid, "0000000000000000000000000000000000000000"))
100
    return NULL;
101
  lhist = (link_history_t*) strmap_get(orhist->link_history_map, to_hexid);
102
103
  if (!lhist) {
    lhist = tor_malloc_zero(sizeof(link_history_t));
104
    rephist_total_alloc += sizeof(link_history_t);
105
    lhist->since = lhist->changed = time(NULL);
106
    strmap_set(orhist->link_history_map, to_hexid, lhist);
107
108
109
110
  }
  return lhist;
}

111
/** Helper: free storage held by a single link history entry */
112
113
114
static void
_free_link_history(void *val)
{
115
  rephist_total_alloc -= sizeof(link_history_t);
116
117
118
  tor_free(val);
}

119
/** Helper: free storage held by a single OR history entry */
120
static void
121
free_or_history(void *_hist)
122
{
123
  or_history_t *hist = _hist;
124
  strmap_free(hist->link_history_map, _free_link_history);
125
  rephist_total_alloc -= sizeof(or_history_t);
126
  rephist_total_num--;
127
128
129
  tor_free(hist);
}

Nick Mathewson's avatar
Nick Mathewson committed
130
131
/** Update an or_history_t object <b>hist</b> so that its uptime/downtime
 * count is up-to-date as of <b>when</b>.
132
 */
133
134
static void
update_or_history(or_history_t *hist, time_t when)
135
{
Roger Dingledine's avatar
Roger Dingledine committed
136
  tor_assert(hist);
137
  if (hist->up_since) {
Roger Dingledine's avatar
Roger Dingledine committed
138
    tor_assert(!hist->down_since);
139
140
141
142
143
144
145
146
    hist->uptime += (when - hist->up_since);
    hist->up_since = when;
  } else if (hist->down_since) {
    hist->downtime += (when - hist->down_since);
    hist->down_since = when;
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
147
/** Initialize the static data structures for tracking history.
148
 */
149
150
void
rep_hist_init(void)
151
152
{
  history_map = strmap_new();
153
  bw_arrays_init();
154
  predicted_ports_init();
155
156
}

Nick Mathewson's avatar
Nick Mathewson committed
157
158
/** Remember that an attempt to connect to the OR with identity digest
 * <b>id</b> failed at <b>when</b>.
159
 */
160
161
void
rep_hist_note_connect_failed(const char* id, time_t when)
162
163
{
  or_history_t *hist;
164
  hist = get_or_history(id);
165
166
  if (!hist)
    return;
167
168
169
170
171
172
173
  ++hist->n_conn_fail;
  if (hist->up_since) {
    hist->uptime += (when - hist->up_since);
    hist->up_since = 0;
  }
  if (!hist->down_since)
    hist->down_since = when;
174
  hist->changed = when;
175
176
}

Nick Mathewson's avatar
Nick Mathewson committed
177
178
/** Remember that an attempt to connect to the OR with identity digest
 * <b>id</b> succeeded at <b>when</b>.
179
 */
180
181
void
rep_hist_note_connect_succeeded(const char* id, time_t when)
182
183
{
  or_history_t *hist;
184
  hist = get_or_history(id);
185
186
  if (!hist)
    return;
187
188
189
190
191
192
193
  ++hist->n_conn_ok;
  if (hist->down_since) {
    hist->downtime += (when - hist->down_since);
    hist->down_since = 0;
  }
  if (!hist->up_since)
    hist->up_since = when;
194
  hist->changed = when;
195
}
196

Nick Mathewson's avatar
Nick Mathewson committed
197
/** Remember that we intentionally closed our connection to the OR
Nick Mathewson's avatar
Nick Mathewson committed
198
 * with identity digest <b>id</b> at <b>when</b>.
199
 */
200
201
void
rep_hist_note_disconnect(const char* id, time_t when)
202
203
{
  or_history_t *hist;
204
  hist = get_or_history(id);
205
206
  if (!hist)
    return;
207
208
209
210
211
  ++hist->n_conn_ok;
  if (hist->up_since) {
    hist->uptime += (when - hist->up_since);
    hist->up_since = 0;
  }
212
  hist->changed = when;
213
214
}

Nick Mathewson's avatar
Nick Mathewson committed
215
216
/** Remember that our connection to the OR with identity digest
 * <b>id</b> had an error and stopped working at <b>when</b>.
217
 */
218
219
void
rep_hist_note_connection_died(const char* id, time_t when)
220
221
{
  or_history_t *hist;
222
  if (!id) {
223
    /* XXXX009 Well, everybody has an ID now. Hm. */
Nick Mathewson's avatar
Nick Mathewson committed
224
    /* If conn has no nickname, it's either an OP, or it is an OR
225
     * which didn't complete its handshake (or did and was unapproved).
Nick Mathewson's avatar
Nick Mathewson committed
226
     * Ignore it.
227
228
229
     */
    return;
  }
230
  hist = get_or_history(id);
231
232
  if (!hist)
    return;
233
234
235
236
237
238
  if (hist->up_since) {
    hist->uptime += (when - hist->up_since);
    hist->up_since = 0;
  }
  if (!hist->down_since)
    hist->down_since = when;
239
  hist->changed = when;
240
241
}

Nick Mathewson's avatar
Nick Mathewson committed
242
243
244
/** Remember that we successfully extended from the OR with identity
 * digest <b>from_id</b> to the OR with identity digest
 *  <b>to_name</b>.
245
 */
246
247
void
rep_hist_note_extend_succeeded(const char *from_id, const char *to_id)
248
249
{
  link_history_t *hist;
250
  /* log_fn(LOG_WARN, "EXTEND SUCCEEDED: %s->%s",from_name,to_name); */
251
  hist = get_link_history(from_id, to_id);
252
253
  if (!hist)
    return;
254
  ++hist->n_extend_ok;
255
  hist->changed = time(NULL);
256
}
257

Nick Mathewson's avatar
Nick Mathewson committed
258
259
260
/** Remember that we tried to extend from the OR with identity digest
 * <b>from_id</b> to the OR with identity digest <b>to_name</b>, but
 * failed.
261
 */
262
263
void
rep_hist_note_extend_failed(const char *from_id, const char *to_id)
264
265
{
  link_history_t *hist;
266
  /* log_fn(LOG_WARN, "EXTEND FAILED: %s->%s",from_name,to_name); */
267
  hist = get_link_history(from_id, to_id);
268
269
  if (!hist)
    return;
270
  ++hist->n_extend_fail;
271
  hist->changed = time(NULL);
272
273
}

274
/** Log all the reliability data we have remembered, with the chosen
275
276
 * severity.
 */
277
278
void
rep_hist_dump_stats(time_t now, int severity)
279
280
281
{
  strmap_iter_t *lhist_it;
  strmap_iter_t *orhist_it;
282
  const char *name1, *name2, *hexdigest1, *hexdigest2;
283
284
  or_history_t *or_history;
  link_history_t *link_history;
285
  void *or_history_p, *link_history_p;
286
287
  double uptime;
  char buffer[2048];
288
  size_t len;
Nick Mathewson's avatar
Nick Mathewson committed
289
  int ret;
290
  unsigned long upt, downt;
291
  routerinfo_t *r;
292

293
294
  rep_history_clean(now-24*60*60);

295
  log(severity, "--------------- Dumping history information:");
296
297
298

  for (orhist_it = strmap_iter_init(history_map); !strmap_iter_done(orhist_it);
       orhist_it = strmap_iter_next(history_map,orhist_it)) {
299
    strmap_iter_get(orhist_it, &hexdigest1, &or_history_p);
300
    or_history = (or_history_t*) or_history_p;
301

302
303
304
305
306
    if ((r = router_get_by_hexdigest(hexdigest1)))
      name1 = r->nickname;
    else
      name1 = "(unknown)";

307
    update_or_history(or_history, now);
308
309
310
311
312
313
314
315
    upt = or_history->uptime;
    downt = or_history->downtime;
    if (upt+downt) {
      uptime = ((double)upt) / (upt+downt);
    } else {
      uptime=1.0;
    }
    log(severity,
316
317
        "OR %s [%s]: %ld/%ld good connections; uptime %ld/%ld sec (%.2f%%)",
        name1, hexdigest1,
Roger Dingledine's avatar
tabs    
Roger Dingledine committed
318
        or_history->n_conn_ok, or_history->n_conn_fail+or_history->n_conn_ok,
319
        upt, upt+downt, uptime*100.0);
320

321
    if (!strmap_isempty(or_history->link_history_map)) {
322
      strlcpy(buffer, "    Extend attempts: ", sizeof(buffer));
323
324
325
326
327
328
329
330
331
      len = strlen(buffer);
      for (lhist_it = strmap_iter_init(or_history->link_history_map);
           !strmap_iter_done(lhist_it);
           lhist_it = strmap_iter_next(or_history->link_history_map, lhist_it)) {
        strmap_iter_get(lhist_it, &hexdigest2, &link_history_p);
        if ((r = router_get_by_hexdigest(hexdigest2)))
          name2 = r->nickname;
        else
          name2 = "(unknown)";
332

333
        link_history = (link_history_t*) link_history_p;
334

Nick Mathewson's avatar
Nick Mathewson committed
335
        ret = tor_snprintf(buffer+len, 2048-len, "%s(%ld/%ld); ", name2,
336
337
                        link_history->n_extend_ok,
                        link_history->n_extend_ok+link_history->n_extend_fail);
Nick Mathewson's avatar
Nick Mathewson committed
338
        if (ret<0)
339
          break;
Nick Mathewson's avatar
Nick Mathewson committed
340
        else
Nick Mathewson's avatar
Nick Mathewson committed
341
          len += ret;
342
      }
343
      log(severity, "%s", buffer);
344
345
346
347
    }
  }
}

348
349
/** Remove history info for routers/links that haven't changed since
 * <b>before</b> */
350
351
void
rep_history_clean(time_t before)
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
{
  or_history_t *or_history;
  link_history_t *link_history;
  void *or_history_p, *link_history_p;
  strmap_iter_t *orhist_it, *lhist_it;
  const char *hd1, *hd2;

  orhist_it = strmap_iter_init(history_map);
  while (!strmap_iter_done(orhist_it)) {
    strmap_iter_get(orhist_it, &hd1, &or_history_p);
    or_history = or_history_p;
    if (or_history->changed < before) {
      free_or_history(or_history);
      orhist_it = strmap_iter_next_rmv(history_map, orhist_it);
      continue;
    }
    for (lhist_it = strmap_iter_init(or_history->link_history_map);
         !strmap_iter_done(lhist_it); ) {
      strmap_iter_get(lhist_it, &hd2, &link_history_p);
      link_history = link_history_p;
      if (link_history->changed < before) {
373
        rephist_total_alloc -= sizeof(link_history_t);
374
375
376
377
378
379
380
381
382
383
        tor_free(link_history);
        lhist_it = strmap_iter_next_rmv(or_history->link_history_map,lhist_it);
        continue;
      }
      lhist_it = strmap_iter_next(or_history->link_history_map,lhist_it);
    }
    orhist_it = strmap_iter_next(history_map, orhist_it);
  }
}

384
#define NUM_SECS_ROLLING_MEASURE 10
385
#define NUM_SECS_BW_SUM_IS_VALID (24*60*60) /* one day */
386
387
388
389
#define NUM_SECS_BW_SUM_INTERVAL (15*60)
#define NUM_TOTALS (NUM_SECS_BW_SUM_IS_VALID/NUM_SECS_BW_SUM_INTERVAL)

/**
390
 * Structure to track bandwidth use, and remember the maxima for a given
391
392
393
394
395
396
397
398
399
400
401
 * time period.
 */
typedef struct bw_array_t {
  /** Observation array: Total number of bytes transferred in each of the last
   * NUM_SECS_ROLLING_MEASURE seconds. This is used as a circular array. */
  int obs[NUM_SECS_ROLLING_MEASURE];
  int cur_obs_idx; /**< Current position in obs. */
  time_t cur_obs_time; /**< Time represented in obs[cur_obs_idx] */
  int total_obs; /**< Total for all members of obs except obs[cur_obs_idx] */
  int max_total; /**< Largest value that total_obs has taken on in the current
                  * period. */
402
  int total_in_period; /**< Total bytes transferred in the current period. */
403
404
405
406
407
408

  /** When does the next period begin? */
  time_t next_period;
  /** Where in 'maxima' should the maximum bandwidth usage for the current
   * period be stored? */
  int next_max_idx;
409
410
411
412
413
  /** How many values in maxima/totals have been set ever? */
  int num_maxes_set;
  /** Circular array of the maximum
   * bandwidth-per-NUM_SECS_ROLLING_MEASURE usage for the last
   * NUM_TOTALS periods */
414
  int maxima[NUM_TOTALS];
415
416
417
  /** Circular array of the total bandwidth usage for the last NUM_TOTALS
   * periods */
  int totals[NUM_TOTALS];
418
419
} bw_array_t;

420
/** Shift the current period of b forward by one.
421
 */
422
423
424
static void
commit_max(bw_array_t *b)
{
425
426
  /* Store total from current period. */
  b->totals[b->next_max_idx] = b->total_in_period;
427
428
429
430
431
432
  /* Store maximum from current period. */
  b->maxima[b->next_max_idx++] = b->max_total;
  /* Advance next_period and next_max_idx */
  b->next_period += NUM_SECS_BW_SUM_INTERVAL;
  if (b->next_max_idx == NUM_TOTALS)
    b->next_max_idx = 0;
433
434
  if (b->num_maxes_set < NUM_TOTALS)
    ++b->num_maxes_set;
435
436
  /* Reset max_total. */
  b->max_total = 0;
437
438
  /* Reset total_in_period. */
  b->total_in_period = 0;
439
440
}

441
/** Shift the current observation time of 'b' forward by one second.
442
 */
443
444
445
static INLINE void
advance_obs(bw_array_t *b)
{
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
  int nextidx;
  int total;

  /* Calculate the total bandwidth for the last NUM_SECS_ROLLING_MEASURE
   * seconds; adjust max_total as needed.*/
  total = b->total_obs + b->obs[b->cur_obs_idx];
  if (total > b->max_total)
    b->max_total = total;

  nextidx = b->cur_obs_idx+1;
  if (nextidx == NUM_SECS_ROLLING_MEASURE)
    nextidx = 0;

  b->total_obs = total - b->obs[nextidx];
  b->obs[nextidx]=0;
  b->cur_obs_idx = nextidx;

  if (++b->cur_obs_time >= b->next_period)
    commit_max(b);
}

/** Add 'n' bytes to the number of bytes in b for second 'when'.
 */
469
470
471
static INLINE void
add_obs(bw_array_t *b, time_t when, int n)
{
Nick Mathewson's avatar
Nick Mathewson committed
472
473
474
475
476
477
478
  /* Don't record data in the past. */
  if (when<b->cur_obs_time)
    return;
  /* If we're currently adding observations for an earlier second than
   * 'when', advance b->cur_obs_time and b->cur_obs_idx by an
   * appropriate number of seconds, and do all the other housekeeping */
  while (when>b->cur_obs_time)
479
    advance_obs(b);
Nick Mathewson's avatar
Nick Mathewson committed
480

481
  b->obs[b->cur_obs_idx] += n;
482
  b->total_in_period += n;
483
484
485
486
}

/** Allocate, initialize, and return a new bw_array.
 */
487
488
static bw_array_t *bw_array_new(void)
{
489
490
491
  bw_array_t *b;
  time_t start;
  b = tor_malloc_zero(sizeof(bw_array_t));
492
  rephist_total_alloc += sizeof(bw_array_t);
493
494
495
496
497
498
499
500
501
502
503
  start = time(NULL);
  b->cur_obs_time = start;
  b->next_period = start + NUM_SECS_BW_SUM_INTERVAL;
  return b;
}

static bw_array_t *read_array = NULL;
static bw_array_t *write_array = NULL;

/** Set up read_array and write_array
 */
504
505
static void
bw_arrays_init(void)
506
507
508
509
{
  read_array = bw_array_new();
  write_array = bw_array_new();
}
510
511
512
513
514
515

/** We read <b>num_bytes</b> more bytes in second <b>when</b>.
 *
 * Add num_bytes to the current running total for <b>when</b>.
 *
 * <b>when</b> can go back to time, but it's safe to ignore calls
516
 * earlier than the latest <b>when</b> you've heard of.
517
 */
518
519
520
void
rep_hist_note_bytes_written(int num_bytes, time_t when)
{
521
522
523
524
525
526
527
528
/* Maybe a circular array for recent seconds, and step to a new point
 * every time a new second shows up. Or simpler is to just to have
 * a normal array and push down each item every second; it's short.
 */
/* When a new second has rolled over, compute the sum of the bytes we've
 * seen over when-1 to when-1-NUM_SECS_ROLLING_MEASURE, and stick it
 * somewhere. See rep_hist_bandwidth_assess() below.
 */
529
  add_obs(write_array, when, num_bytes);
530
531
532
533
534
}

/** We wrote <b>num_bytes</b> more bytes in second <b>when</b>.
 * (like rep_hist_note_bytes_written() above)
 */
535
536
537
void
rep_hist_note_bytes_read(int num_bytes, time_t when)
{
538
/* if we're smart, we can make this func and the one above share code */
539
540
541
542
543
544
545
  add_obs(read_array, when, num_bytes);
}

/** Helper: Return the largest value in b->maxima.  (This is equal to the
 * most bandwidth used in any NUM_SECS_ROLLING_MEASURE period for the last
 * NUM_SECS_BW_SUM_IS_VALID seconds.)
 */
546
547
static int
find_largest_max(bw_array_t *b)
548
549
550
551
552
553
554
555
{
  int i,max;
  max=0;
  for (i=0; i<NUM_TOTALS; ++i) {
    if (b->maxima[i]>max)
      max = b->maxima[i];
  }
  return max;
556
557
558
559
560
561
562
563
564
}

/**
 * Find the largest sums in the past NUM_SECS_BW_SUM_IS_VALID (roughly)
 * seconds. Find one sum for reading and one for writing. They don't have
 * to be at the same time).
 *
 * Return the smaller of these sums, divided by NUM_SECS_ROLLING_MEASURE.
 */
565
566
567
int
rep_hist_bandwidth_assess(void)
{
568
569
570
571
  int w,r;
  r = find_largest_max(read_array);
  w = find_largest_max(write_array);
  if (r>w)
572
    return (int)(w/(double)NUM_SECS_ROLLING_MEASURE);
573
  else
574
    return (int)(r/(double)NUM_SECS_ROLLING_MEASURE);
575
576
577
578

  return 0;
}

579
/**
580
581
 * Allocate and return lines for representing this server's bandwidth
 * history in its descriptor.
582
 */
583
584
char *
rep_hist_get_bandwidth_lines(void)
585
586
587
588
589
590
591
{
  char *buf, *cp;
  char t[ISO_TIME_LEN+1];
  int r, i, n;
  bw_array_t *b;
  size_t len;

592
  /* opt (read|write)-history yyyy-mm-dd HH:MM:SS (n s) n,n,n,n,n... */
593
594
595
596
597
  len = (60+12*NUM_TOTALS)*2;
  buf = tor_malloc_zero(len);
  cp = buf;
  for (r=0;r<2;++r) {
    b = r?read_array:write_array;
598
    tor_assert(b);
599
    format_iso_time(t, b->next_period-NUM_SECS_BW_SUM_INTERVAL);
600
    tor_snprintf(cp, len-(cp-buf), "opt %s %s (%d s) ", r?"read-history ":"write-history", t,
601
602
            NUM_SECS_BW_SUM_INTERVAL);
    cp += strlen(cp);
603

604
605
    if (b->num_maxes_set <= b->next_max_idx)
      /* We haven't been through the circular array yet; time starts at i=0.*/
606
607
      i = 0;
    else
608
      /* We've been around the array at least once.  The next i to be
609
         overwritten is the oldest. */
610
611
612
613
      i = b->next_max_idx;

    for (n=0; n<b->num_maxes_set; ++n,++i) {
      while (i >= NUM_TOTALS) i -= NUM_TOTALS;
614
      if (n==(b->num_maxes_set-1))
615
        tor_snprintf(cp, len-(cp-buf), "%d", b->totals[i]);
616
      else
617
        tor_snprintf(cp, len-(cp-buf), "%d,", b->totals[i]);
618
619
      cp += strlen(cp);
    }
620
    strlcat(cp, "\n", len-(cp-buf));
621
622
623
624
625
    ++cp;
  }
  return buf;
}

626
627
628
629
630
/** A list of port numbers that have been used recently. */
static smartlist_t *predicted_ports_list=NULL;
/** The corresponding most recently used time for each port. */
static smartlist_t *predicted_ports_times=NULL;

631
632
633
634
/** DOCDOC */
static void
add_predicted_port(uint16_t port, time_t now)
{
635
  /* XXXX we could just use uintptr_t here, I think. */
636
637
638
639
  uint16_t *tmp_port = tor_malloc(sizeof(uint16_t));
  time_t *tmp_time = tor_malloc(sizeof(time_t));
  *tmp_port = port;
  *tmp_time = now;
640
  rephist_total_alloc += sizeof(uint16_t) + sizeof(time_t);
641
642
643
644
  smartlist_add(predicted_ports_list, tmp_port);
  smartlist_add(predicted_ports_times, tmp_time);
}

645
646
647
648
/** DOCDOC */
static void
predicted_ports_init(void)
{
649
650
651
652
653
  predicted_ports_list = smartlist_create();
  predicted_ports_times = smartlist_create();
  add_predicted_port(80, time(NULL)); /* add one to kickstart us */
}

654
655
656
657
/** DOCDOC */
static void
predicted_ports_free(void)
{
658
  rephist_total_alloc -= smartlist_len(predicted_ports_list)*sizeof(uint16_t);
659
660
  SMARTLIST_FOREACH(predicted_ports_list, char *, cp, tor_free(cp));
  smartlist_free(predicted_ports_list);
661
  rephist_total_alloc -= smartlist_len(predicted_ports_times)*sizeof(time_t);
662
663
664
665
  SMARTLIST_FOREACH(predicted_ports_times, char *, cp, tor_free(cp));
  smartlist_free(predicted_ports_times);
}

666
667
668
669
/** Remember that <b>port</b> has been asked for as of time <b>now</b>.
 * This is used for predicting what sorts of streams we'll make in the
 * future and making circuits to anticipate that.
 */
670
671
672
void
rep_hist_note_used_port(uint16_t port, time_t now)
{
673
674
675
676
677
678
679
  int i;
  uint16_t *tmp_port;
  time_t *tmp_time;

  tor_assert(predicted_ports_list);
  tor_assert(predicted_ports_times);

Nick Mathewson's avatar
Nick Mathewson committed
680
  if (!port) /* record nothing */
681
682
683
684
685
686
687
688
689
690
691
692
693
694
    return;

  for (i = 0; i < smartlist_len(predicted_ports_list); ++i) {
    tmp_port = smartlist_get(predicted_ports_list, i);
    tmp_time = smartlist_get(predicted_ports_times, i);
    if (*tmp_port == port) {
      *tmp_time = now;
      return;
    }
  }
  /* it's not there yet; we need to add it */
  add_predicted_port(port, now);
}

695
#define PREDICTED_CIRCS_RELEVANCE_TIME (3600) /* 1 hour */
696

Roger Dingledine's avatar
Roger Dingledine committed
697
/** Return a pointer to the list of port numbers that
698
 * are likely to be asked for in the near future.
Roger Dingledine's avatar
Roger Dingledine committed
699
700
 *
 * The caller promises not to mess with it.
701
 */
702
703
704
smartlist_t *
rep_hist_get_predicted_ports(time_t now)
{
705
706
707
708
709
710
711
712
713
714
  int i;
  uint16_t *tmp_port;
  time_t *tmp_time;

  tor_assert(predicted_ports_list);
  tor_assert(predicted_ports_times);

  /* clean out obsolete entries */
  for (i = 0; i < smartlist_len(predicted_ports_list); ++i) {
    tmp_time = smartlist_get(predicted_ports_times, i);
715
    if (*tmp_time + PREDICTED_CIRCS_RELEVANCE_TIME < now) {
716
      tmp_port = smartlist_get(predicted_ports_list, i);
Roger Dingledine's avatar
Roger Dingledine committed
717
      log_fn(LOG_DEBUG, "Expiring predicted port %d", *tmp_port);
718
719
      smartlist_del(predicted_ports_list, i);
      smartlist_del(predicted_ports_times, i);
720
      rephist_total_alloc -= sizeof(uint16_t)+sizeof(time_t);
721
722
723
724
725
      tor_free(tmp_port);
      tor_free(tmp_time);
      i--;
    }
  }
Roger Dingledine's avatar
Roger Dingledine committed
726
  return predicted_ports_list;
727
728
}

729
730
731
732
733
734
735
736
/** The last time at which we needed an internal circ. */
static time_t predicted_hidserv_time = 0;
/** The last time we needed an internal circ with good uptime. */
static time_t predicted_hidserv_uptime_time = 0;
/** The last time we needed an internal circ with good capacity. */
static time_t predicted_hidserv_capacity_time = 0;

/** Remember that we used an internal circ at time <b>now</b>. */
737
738
739
void
rep_hist_note_used_hidserv(time_t now, int need_uptime, int need_capacity)
{
740
741
742
743
744
745
746
747
  predicted_hidserv_time = now;
  if (need_uptime)
    predicted_hidserv_uptime_time = now;
  if (need_capacity)
    predicted_hidserv_capacity_time = now;
}

/** Return 1 if we've used an internal circ recently; else return 0. */
748
749
750
int
rep_hist_get_predicted_hidserv(time_t now, int *need_uptime, int *need_capacity)
{
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
  if (!predicted_hidserv_time) /* initialize it */
    predicted_hidserv_time = now;
  if (predicted_hidserv_time + PREDICTED_CIRCS_RELEVANCE_TIME < now)
    return 0; /* too long ago */
  if (predicted_hidserv_uptime_time + PREDICTED_CIRCS_RELEVANCE_TIME < now)
    *need_uptime = 1;
  if (predicted_hidserv_capacity_time + PREDICTED_CIRCS_RELEVANCE_TIME < now)
    *need_capacity = 1;
  return 1;
}

/* not used yet */
void rep_hist_note_used_resolve(time_t now) { }
int rep_hist_get_predicted_resolve(time_t now) { return 0; }

766
767
768
769
/** Free all storage held by the OR/link history caches, by the
 * bandwidth history arrays, or by the port history. */
void
rep_hist_free_all(void)
770
771
772
773
{
  strmap_free(history_map, free_or_history);
  tor_free(read_array);
  tor_free(write_array);
774
  predicted_ports_free();
775
}
776