Convert circuituse, command, config, connection, relay, router, test to new logging...
[tor.git] / src / or / rephist.c
blob18de290a2f3dde0fae1e5fb4cb0b91ba0c4147a6
1 /* Copyright 2004-2005 Roger Dingledine, Nick Mathewson. */
2 /* See LICENSE for licensing information */
3 /* $Id$ */
4 const char rephist_c_id[] = "$Id$";
6 /**
7 * \file rephist.c
8 * \brief Basic history and "reputation" functionality to remember
9 * which servers have worked in the past, how much bandwidth we've
10 * been using, which ports we tend to want, and so on.
11 **/
13 #define NEW_LOG_INTERFACE
14 #include "or.h"
16 static void bw_arrays_init(void);
17 static void predicted_ports_init(void);
19 uint64_t rephist_total_alloc=0;
20 uint32_t rephist_total_num=0;
22 /** History of an OR-\>OR link. */
23 typedef struct link_history_t {
24 /** When did we start tracking this list? */
25 time_t since;
26 /** When did we most recently note a change to this link */
27 time_t changed;
28 /** How many times did extending from OR1 to OR2 succeed? */
29 unsigned long n_extend_ok;
30 /** How many times did extending from OR1 to OR2 fail? */
31 unsigned long n_extend_fail;
32 } link_history_t;
34 /** History of an OR. */
35 typedef struct or_history_t {
36 /** When did we start tracking this OR? */
37 time_t since;
38 /** When did we most recently note a change to this OR? */
39 time_t changed;
40 /** How many times did we successfully connect? */
41 unsigned long n_conn_ok;
42 /** How many times did we try to connect and fail?*/
43 unsigned long n_conn_fail;
44 /** How many seconds have we been connected to this OR before
45 * 'up_since'? */
46 unsigned long uptime;
47 /** How many seconds have we been unable to connect to this OR before
48 * 'down_since'? */
49 unsigned long downtime;
50 /** If nonzero, we have been connected since this time. */
51 time_t up_since;
52 /** If nonzero, we have been unable to connect since this time. */
53 time_t down_since;
54 /** Map from hex OR2 identity digest to a link_history_t for the link
55 * from this OR to OR2. */
56 digestmap_t *link_history_map;
57 } or_history_t;
59 /** Map from hex OR identity digest to or_history_t. */
60 static digestmap_t *history_map = NULL;
62 /** Return the or_history_t for the named OR, creating it if necessary.
64 static or_history_t *
65 get_or_history(const char* id)
67 or_history_t *hist;
69 if (!memcmp(id, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0", DIGEST_LEN))
70 return NULL;
72 hist = digestmap_get(history_map, id);
73 if (!hist) {
74 hist = tor_malloc_zero(sizeof(or_history_t));
75 rephist_total_alloc += sizeof(or_history_t);
76 rephist_total_num++;
77 hist->link_history_map = digestmap_new();
78 hist->since = hist->changed = time(NULL);
79 digestmap_set(history_map, id, hist);
81 return hist;
84 /** Return the link_history_t for the link from the first named OR to
85 * the second, creating it if necessary. (ORs are identified by
86 * identity digest)
88 static link_history_t *
89 get_link_history(const char *from_id, const char *to_id)
91 or_history_t *orhist;
92 link_history_t *lhist;
93 orhist = get_or_history(from_id);
94 if (!orhist)
95 return NULL;
96 if (!memcmp(to_id, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0", DIGEST_LEN))
97 return NULL;
98 lhist = (link_history_t*) digestmap_get(orhist->link_history_map, to_id);
99 if (!lhist) {
100 lhist = tor_malloc_zero(sizeof(link_history_t));
101 rephist_total_alloc += sizeof(link_history_t);
102 lhist->since = lhist->changed = time(NULL);
103 digestmap_set(orhist->link_history_map, to_id, lhist);
105 return lhist;
108 /** Helper: free storage held by a single link history entry */
109 static void
110 _free_link_history(void *val)
112 rephist_total_alloc -= sizeof(link_history_t);
113 tor_free(val);
116 /** Helper: free storage held by a single OR history entry */
117 static void
118 free_or_history(void *_hist)
120 or_history_t *hist = _hist;
121 digestmap_free(hist->link_history_map, _free_link_history);
122 rephist_total_alloc -= sizeof(or_history_t);
123 rephist_total_num--;
124 tor_free(hist);
127 /** Update an or_history_t object <b>hist</b> so that its uptime/downtime
128 * count is up-to-date as of <b>when</b>.
130 static void
131 update_or_history(or_history_t *hist, time_t when)
133 tor_assert(hist);
134 if (hist->up_since) {
135 tor_assert(!hist->down_since);
136 hist->uptime += (when - hist->up_since);
137 hist->up_since = when;
138 } else if (hist->down_since) {
139 hist->downtime += (when - hist->down_since);
140 hist->down_since = when;
144 /** Initialize the static data structures for tracking history.
146 void
147 rep_hist_init(void)
149 history_map = digestmap_new();
150 bw_arrays_init();
151 predicted_ports_init();
154 /** Remember that an attempt to connect to the OR with identity digest
155 * <b>id</b> failed at <b>when</b>.
157 void
158 rep_hist_note_connect_failed(const char* id, time_t when)
160 or_history_t *hist;
161 hist = get_or_history(id);
162 if (!hist)
163 return;
164 ++hist->n_conn_fail;
165 if (hist->up_since) {
166 hist->uptime += (when - hist->up_since);
167 hist->up_since = 0;
169 if (!hist->down_since)
170 hist->down_since = when;
171 hist->changed = when;
174 /** Remember that an attempt to connect to the OR with identity digest
175 * <b>id</b> succeeded at <b>when</b>.
177 void
178 rep_hist_note_connect_succeeded(const char* id, time_t when)
180 or_history_t *hist;
181 hist = get_or_history(id);
182 if (!hist)
183 return;
184 ++hist->n_conn_ok;
185 if (hist->down_since) {
186 hist->downtime += (when - hist->down_since);
187 hist->down_since = 0;
189 if (!hist->up_since)
190 hist->up_since = when;
191 hist->changed = when;
194 /** Remember that we intentionally closed our connection to the OR
195 * with identity digest <b>id</b> at <b>when</b>.
197 void
198 rep_hist_note_disconnect(const char* id, time_t when)
200 or_history_t *hist;
201 hist = get_or_history(id);
202 if (!hist)
203 return;
204 ++hist->n_conn_ok;
205 if (hist->up_since) {
206 hist->uptime += (when - hist->up_since);
207 hist->up_since = 0;
209 hist->changed = when;
212 /** Remember that our connection to the OR with identity digest
213 * <b>id</b> had an error and stopped working at <b>when</b>.
215 void
216 rep_hist_note_connection_died(const char* id, time_t when)
218 or_history_t *hist;
219 if (!id) {
220 /* XXXX009 Well, everybody has an ID now. Hm. */
221 /* If conn has no nickname, it's either an OP, or it is an OR
222 * which didn't complete its handshake (or did and was unapproved).
223 * Ignore it.
225 return;
227 hist = get_or_history(id);
228 if (!hist)
229 return;
230 if (hist->up_since) {
231 hist->uptime += (when - hist->up_since);
232 hist->up_since = 0;
234 if (!hist->down_since)
235 hist->down_since = when;
236 hist->changed = when;
239 /** Remember that we successfully extended from the OR with identity
240 * digest <b>from_id</b> to the OR with identity digest
241 * <b>to_name</b>.
243 void
244 rep_hist_note_extend_succeeded(const char *from_id, const char *to_id)
246 link_history_t *hist;
247 /* log_fn(LOG_WARN, "EXTEND SUCCEEDED: %s->%s",from_name,to_name); */
248 hist = get_link_history(from_id, to_id);
249 if (!hist)
250 return;
251 ++hist->n_extend_ok;
252 hist->changed = time(NULL);
255 /** Remember that we tried to extend from the OR with identity digest
256 * <b>from_id</b> to the OR with identity digest <b>to_name</b>, but
257 * failed.
259 void
260 rep_hist_note_extend_failed(const char *from_id, const char *to_id)
262 link_history_t *hist;
263 /* log_fn(LOG_WARN, "EXTEND FAILED: %s->%s",from_name,to_name); */
264 hist = get_link_history(from_id, to_id);
265 if (!hist)
266 return;
267 ++hist->n_extend_fail;
268 hist->changed = time(NULL);
271 /** Log all the reliability data we have remembered, with the chosen
272 * severity.
274 void
275 rep_hist_dump_stats(time_t now, int severity)
277 digestmap_iter_t *lhist_it;
278 digestmap_iter_t *orhist_it;
279 const char *name1, *name2, *digest1, *digest2;
280 char hexdigest1[HEX_DIGEST_LEN+1];
281 or_history_t *or_history;
282 link_history_t *link_history;
283 void *or_history_p, *link_history_p;
284 double uptime;
285 char buffer[2048];
286 size_t len;
287 int ret;
288 unsigned long upt, downt;
289 routerinfo_t *r;
291 rep_history_clean(now - get_options()->RephistTrackTime);
293 log(severity, LD_GENERAL, "--------------- Dumping history information:");
295 for (orhist_it = digestmap_iter_init(history_map); !digestmap_iter_done(orhist_it);
296 orhist_it = digestmap_iter_next(history_map,orhist_it)) {
297 digestmap_iter_get(orhist_it, &digest1, &or_history_p);
298 or_history = (or_history_t*) or_history_p;
300 if ((r = router_get_by_digest(digest1)))
301 name1 = r->nickname;
302 else
303 name1 = "(unknown)";
304 base16_encode(hexdigest1, sizeof(hexdigest1), digest1, DIGEST_LEN);
305 update_or_history(or_history, now);
306 upt = or_history->uptime;
307 downt = or_history->downtime;
308 if (upt+downt) {
309 uptime = ((double)upt) / (upt+downt);
310 } else {
311 uptime=1.0;
313 log(severity, LD_GENERAL,
314 "OR %s [%s]: %ld/%ld good connections; uptime %ld/%ld sec (%.2f%%)",
315 name1, hexdigest1,
316 or_history->n_conn_ok, or_history->n_conn_fail+or_history->n_conn_ok,
317 upt, upt+downt, uptime*100.0);
319 if (!digestmap_isempty(or_history->link_history_map)) {
320 strlcpy(buffer, " Extend attempts: ", sizeof(buffer));
321 len = strlen(buffer);
322 for (lhist_it = digestmap_iter_init(or_history->link_history_map);
323 !digestmap_iter_done(lhist_it);
324 lhist_it = digestmap_iter_next(or_history->link_history_map, lhist_it)) {
325 digestmap_iter_get(lhist_it, &digest2, &link_history_p);
326 if ((r = router_get_by_digest(digest2)))
327 name2 = r->nickname;
328 else
329 name2 = "(unknown)";
331 link_history = (link_history_t*) link_history_p;
333 ret = tor_snprintf(buffer+len, 2048-len, "%s(%ld/%ld); ", name2,
334 link_history->n_extend_ok,
335 link_history->n_extend_ok+link_history->n_extend_fail);
336 if (ret<0)
337 break;
338 else
339 len += ret;
341 log(severity, LD_GENERAL, "%s", buffer);
346 /** Remove history info for routers/links that haven't changed since
347 * <b>before</b> */
348 void
349 rep_history_clean(time_t before)
351 or_history_t *or_history;
352 link_history_t *link_history;
353 void *or_history_p, *link_history_p;
354 digestmap_iter_t *orhist_it, *lhist_it;
355 const char *d1, *d2;
357 orhist_it = digestmap_iter_init(history_map);
358 while (!digestmap_iter_done(orhist_it)) {
359 digestmap_iter_get(orhist_it, &d1, &or_history_p);
360 or_history = or_history_p;
361 if (or_history->changed < before) {
362 free_or_history(or_history);
363 orhist_it = digestmap_iter_next_rmv(history_map, orhist_it);
364 continue;
366 for (lhist_it = digestmap_iter_init(or_history->link_history_map);
367 !digestmap_iter_done(lhist_it); ) {
368 digestmap_iter_get(lhist_it, &d2, &link_history_p);
369 link_history = link_history_p;
370 if (link_history->changed < before) {
371 rephist_total_alloc -= sizeof(link_history_t);
372 tor_free(link_history);
373 lhist_it = digestmap_iter_next_rmv(or_history->link_history_map,lhist_it);
374 continue;
376 lhist_it = digestmap_iter_next(or_history->link_history_map,lhist_it);
378 orhist_it = digestmap_iter_next(history_map, orhist_it);
382 #define NUM_SECS_ROLLING_MEASURE 10
383 #define NUM_SECS_BW_SUM_IS_VALID (24*60*60) /* one day */
384 #define NUM_SECS_BW_SUM_INTERVAL (15*60)
385 #define NUM_TOTALS (NUM_SECS_BW_SUM_IS_VALID/NUM_SECS_BW_SUM_INTERVAL)
388 * Structure to track bandwidth use, and remember the maxima for a given
389 * time period.
391 typedef struct bw_array_t {
392 /** Observation array: Total number of bytes transferred in each of the last
393 * NUM_SECS_ROLLING_MEASURE seconds. This is used as a circular array. */
394 int obs[NUM_SECS_ROLLING_MEASURE];
395 int cur_obs_idx; /**< Current position in obs. */
396 time_t cur_obs_time; /**< Time represented in obs[cur_obs_idx] */
397 int total_obs; /**< Total for all members of obs except obs[cur_obs_idx] */
398 int max_total; /**< Largest value that total_obs has taken on in the current
399 * period. */
400 uint64_t total_in_period; /**< Total bytes transferred in the current period. */
402 /** When does the next period begin? */
403 time_t next_period;
404 /** Where in 'maxima' should the maximum bandwidth usage for the current
405 * period be stored? */
406 int next_max_idx;
407 /** How many values in maxima/totals have been set ever? */
408 int num_maxes_set;
409 /** Circular array of the maximum
410 * bandwidth-per-NUM_SECS_ROLLING_MEASURE usage for the last
411 * NUM_TOTALS periods */
412 int maxima[NUM_TOTALS];
413 /** Circular array of the total bandwidth usage for the last NUM_TOTALS
414 * periods */
415 uint64_t totals[NUM_TOTALS];
416 } bw_array_t;
418 /** Shift the current period of b forward by one.
420 static void
421 commit_max(bw_array_t *b)
423 /* Store total from current period. */
424 b->totals[b->next_max_idx] = b->total_in_period;
425 /* Store maximum from current period. */
426 b->maxima[b->next_max_idx++] = b->max_total;
427 /* Advance next_period and next_max_idx */
428 b->next_period += NUM_SECS_BW_SUM_INTERVAL;
429 if (b->next_max_idx == NUM_TOTALS)
430 b->next_max_idx = 0;
431 if (b->num_maxes_set < NUM_TOTALS)
432 ++b->num_maxes_set;
433 /* Reset max_total. */
434 b->max_total = 0;
435 /* Reset total_in_period. */
436 b->total_in_period = 0;
439 /** Shift the current observation time of 'b' forward by one second.
441 static INLINE void
442 advance_obs(bw_array_t *b)
444 int nextidx;
445 int total;
447 /* Calculate the total bandwidth for the last NUM_SECS_ROLLING_MEASURE
448 * seconds; adjust max_total as needed.*/
449 total = b->total_obs + b->obs[b->cur_obs_idx];
450 if (total > b->max_total)
451 b->max_total = total;
453 nextidx = b->cur_obs_idx+1;
454 if (nextidx == NUM_SECS_ROLLING_MEASURE)
455 nextidx = 0;
457 b->total_obs = total - b->obs[nextidx];
458 b->obs[nextidx]=0;
459 b->cur_obs_idx = nextidx;
461 if (++b->cur_obs_time >= b->next_period)
462 commit_max(b);
465 /** Add 'n' bytes to the number of bytes in b for second 'when'.
467 static INLINE void
468 add_obs(bw_array_t *b, time_t when, int n)
470 /* Don't record data in the past. */
471 if (when<b->cur_obs_time)
472 return;
473 /* If we're currently adding observations for an earlier second than
474 * 'when', advance b->cur_obs_time and b->cur_obs_idx by an
475 * appropriate number of seconds, and do all the other housekeeping */
476 while (when>b->cur_obs_time)
477 advance_obs(b);
479 b->obs[b->cur_obs_idx] += n;
480 b->total_in_period += n;
483 /** Allocate, initialize, and return a new bw_array.
485 static bw_array_t *
486 bw_array_new(void)
488 bw_array_t *b;
489 time_t start;
490 b = tor_malloc_zero(sizeof(bw_array_t));
491 rephist_total_alloc += sizeof(bw_array_t);
492 start = time(NULL);
493 b->cur_obs_time = start;
494 b->next_period = start + NUM_SECS_BW_SUM_INTERVAL;
495 return b;
498 static bw_array_t *read_array = NULL;
499 static bw_array_t *write_array = NULL;
501 /** Set up read_array and write_array
503 static void
504 bw_arrays_init(void)
506 read_array = bw_array_new();
507 write_array = bw_array_new();
510 /** We read <b>num_bytes</b> more bytes in second <b>when</b>.
512 * Add num_bytes to the current running total for <b>when</b>.
514 * <b>when</b> can go back to time, but it's safe to ignore calls
515 * earlier than the latest <b>when</b> you've heard of.
517 void
518 rep_hist_note_bytes_written(int num_bytes, time_t when)
520 /* Maybe a circular array for recent seconds, and step to a new point
521 * every time a new second shows up. Or simpler is to just to have
522 * a normal array and push down each item every second; it's short.
524 /* When a new second has rolled over, compute the sum of the bytes we've
525 * seen over when-1 to when-1-NUM_SECS_ROLLING_MEASURE, and stick it
526 * somewhere. See rep_hist_bandwidth_assess() below.
528 add_obs(write_array, when, num_bytes);
531 /** We wrote <b>num_bytes</b> more bytes in second <b>when</b>.
532 * (like rep_hist_note_bytes_written() above)
534 void
535 rep_hist_note_bytes_read(int num_bytes, time_t when)
537 /* if we're smart, we can make this func and the one above share code */
538 add_obs(read_array, when, num_bytes);
541 /** Helper: Return the largest value in b->maxima. (This is equal to the
542 * most bandwidth used in any NUM_SECS_ROLLING_MEASURE period for the last
543 * NUM_SECS_BW_SUM_IS_VALID seconds.)
545 static int
546 find_largest_max(bw_array_t *b)
548 int i,max;
549 max=0;
550 for (i=0; i<NUM_TOTALS; ++i) {
551 if (b->maxima[i]>max)
552 max = b->maxima[i];
554 return max;
558 * Find the largest sums in the past NUM_SECS_BW_SUM_IS_VALID (roughly)
559 * seconds. Find one sum for reading and one for writing. They don't have
560 * to be at the same time).
562 * Return the smaller of these sums, divided by NUM_SECS_ROLLING_MEASURE.
565 rep_hist_bandwidth_assess(void)
567 int w,r;
568 r = find_largest_max(read_array);
569 w = find_largest_max(write_array);
570 if (r>w)
571 return (int)(w/(double)NUM_SECS_ROLLING_MEASURE);
572 else
573 return (int)(r/(double)NUM_SECS_ROLLING_MEASURE);
575 return 0;
579 * Allocate and return lines for representing this server's bandwidth
580 * history in its descriptor.
582 char *
583 rep_hist_get_bandwidth_lines(void)
585 char *buf, *cp;
586 char t[ISO_TIME_LEN+1];
587 int r, i, n;
588 bw_array_t *b;
589 size_t len;
591 /* opt (read|write)-history yyyy-mm-dd HH:MM:SS (n s) n,n,n,n,n... */
592 len = (60+20*NUM_TOTALS)*2;
593 buf = tor_malloc_zero(len);
594 cp = buf;
595 for (r=0;r<2;++r) {
596 b = r?read_array:write_array;
597 tor_assert(b);
598 format_iso_time(t, b->next_period-NUM_SECS_BW_SUM_INTERVAL);
599 tor_snprintf(cp, len-(cp-buf), "opt %s %s (%d s) ",
600 r ? "read-history" : "write-history", t,
601 NUM_SECS_BW_SUM_INTERVAL);
602 cp += strlen(cp);
604 if (b->num_maxes_set <= b->next_max_idx)
605 /* We haven't been through the circular array yet; time starts at i=0.*/
606 i = 0;
607 else
608 /* We've been around the array at least once. The next i to be
609 overwritten is the oldest. */
610 i = b->next_max_idx;
612 for (n=0; n<b->num_maxes_set; ++n,++i) {
613 while (i >= NUM_TOTALS) i -= NUM_TOTALS;
614 if (n==(b->num_maxes_set-1))
615 tor_snprintf(cp, len-(cp-buf), U64_FORMAT,
616 U64_PRINTF_ARG(b->totals[i]));
617 else
618 tor_snprintf(cp, len-(cp-buf), U64_FORMAT",",
619 U64_PRINTF_ARG(b->totals[i]));
620 cp += strlen(cp);
622 strlcat(cp, "\n", len-(cp-buf));
623 ++cp;
625 return buf;
628 /** A list of port numbers that have been used recently. */
629 static smartlist_t *predicted_ports_list=NULL;
630 /** The corresponding most recently used time for each port. */
631 static smartlist_t *predicted_ports_times=NULL;
633 /** DOCDOC */
634 static void
635 add_predicted_port(uint16_t port, time_t now)
637 /* XXXX we could just use uintptr_t here, I think. */
638 uint16_t *tmp_port = tor_malloc(sizeof(uint16_t));
639 time_t *tmp_time = tor_malloc(sizeof(time_t));
640 *tmp_port = port;
641 *tmp_time = now;
642 rephist_total_alloc += sizeof(uint16_t) + sizeof(time_t);
643 smartlist_add(predicted_ports_list, tmp_port);
644 smartlist_add(predicted_ports_times, tmp_time);
647 /** DOCDOC */
648 static void
649 predicted_ports_init(void)
651 predicted_ports_list = smartlist_create();
652 predicted_ports_times = smartlist_create();
653 add_predicted_port(80, time(NULL)); /* add one to kickstart us */
656 /** DOCDOC */
657 static void
658 predicted_ports_free(void)
660 rephist_total_alloc -= smartlist_len(predicted_ports_list)*sizeof(uint16_t);
661 SMARTLIST_FOREACH(predicted_ports_list, char *, cp, tor_free(cp));
662 smartlist_free(predicted_ports_list);
663 rephist_total_alloc -= smartlist_len(predicted_ports_times)*sizeof(time_t);
664 SMARTLIST_FOREACH(predicted_ports_times, char *, cp, tor_free(cp));
665 smartlist_free(predicted_ports_times);
668 /** Remember that <b>port</b> has been asked for as of time <b>now</b>.
669 * This is used for predicting what sorts of streams we'll make in the
670 * future and making circuits to anticipate that.
672 void
673 rep_hist_note_used_port(uint16_t port, time_t now)
675 int i;
676 uint16_t *tmp_port;
677 time_t *tmp_time;
679 tor_assert(predicted_ports_list);
680 tor_assert(predicted_ports_times);
682 if (!port) /* record nothing */
683 return;
685 for (i = 0; i < smartlist_len(predicted_ports_list); ++i) {
686 tmp_port = smartlist_get(predicted_ports_list, i);
687 tmp_time = smartlist_get(predicted_ports_times, i);
688 if (*tmp_port == port) {
689 *tmp_time = now;
690 return;
693 /* it's not there yet; we need to add it */
694 add_predicted_port(port, now);
697 #define PREDICTED_CIRCS_RELEVANCE_TIME (3600) /* 1 hour */
699 /** Return a pointer to the list of port numbers that
700 * are likely to be asked for in the near future.
702 * The caller promises not to mess with it.
704 smartlist_t *
705 rep_hist_get_predicted_ports(time_t now)
707 int i;
708 uint16_t *tmp_port;
709 time_t *tmp_time;
711 tor_assert(predicted_ports_list);
712 tor_assert(predicted_ports_times);
714 /* clean out obsolete entries */
715 for (i = 0; i < smartlist_len(predicted_ports_list); ++i) {
716 tmp_time = smartlist_get(predicted_ports_times, i);
717 if (*tmp_time + PREDICTED_CIRCS_RELEVANCE_TIME < now) {
718 tmp_port = smartlist_get(predicted_ports_list, i);
719 debug(LD_CIRC, "Expiring predicted port %d", *tmp_port);
720 smartlist_del(predicted_ports_list, i);
721 smartlist_del(predicted_ports_times, i);
722 rephist_total_alloc -= sizeof(uint16_t)+sizeof(time_t);
723 tor_free(tmp_port);
724 tor_free(tmp_time);
725 i--;
728 return predicted_ports_list;
731 /** The last time at which we needed an internal circ. */
732 static time_t predicted_hidserv_time = 0;
733 /** The last time we needed an internal circ with good uptime. */
734 static time_t predicted_hidserv_uptime_time = 0;
735 /** The last time we needed an internal circ with good capacity. */
736 static time_t predicted_hidserv_capacity_time = 0;
738 /** Remember that we used an internal circ at time <b>now</b>. */
739 void
740 rep_hist_note_used_hidserv(time_t now, int need_uptime, int need_capacity)
742 predicted_hidserv_time = now;
743 if (need_uptime)
744 predicted_hidserv_uptime_time = now;
745 if (need_capacity)
746 predicted_hidserv_capacity_time = now;
749 /** Return 1 if we've used an internal circ recently; else return 0. */
751 rep_hist_get_predicted_hidserv(time_t now, int *need_uptime, int *need_capacity)
753 if (!predicted_hidserv_time) { /* initialize it */
754 predicted_hidserv_time = now;
755 predicted_hidserv_uptime_time = now;
756 predicted_hidserv_capacity_time = now;
758 if (predicted_hidserv_time + PREDICTED_CIRCS_RELEVANCE_TIME < now)
759 return 0; /* too long ago */
760 if (predicted_hidserv_uptime_time + PREDICTED_CIRCS_RELEVANCE_TIME < now)
761 *need_uptime = 1;
762 if (predicted_hidserv_capacity_time + PREDICTED_CIRCS_RELEVANCE_TIME < now)
763 *need_capacity = 1;
764 return 1;
767 /* not used yet */
768 void
769 rep_hist_note_used_resolve(time_t now)
773 rep_hist_get_predicted_resolve(time_t now)
775 return 0;
778 /** Free all storage held by the OR/link history caches, by the
779 * bandwidth history arrays, or by the port history. */
780 void
781 rep_hist_free_all(void)
783 digestmap_free(history_map, free_or_history);
784 tor_free(read_array);
785 tor_free(write_array);
786 predicted_ports_free();