1 /* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
2 * Copyright (c) 2007-2009, The Tor Project, Inc. */
3 /* See LICENSE for licensing information */
7 * \brief Basic history and "reputation" functionality to remember
8 * which servers have worked in the past, how much bandwidth we've
9 * been using, which ports we tend to want, and so on.
15 static void bw_arrays_init(void);
16 static void predicted_ports_init(void);
17 static void hs_usage_init(void);
19 /** Total number of bytes currently allocated in fields used by rephist.c. */
20 uint64_t rephist_total_alloc
=0;
21 /** Number of or_history_t objects currently allocated. */
22 uint32_t rephist_total_num
=0;
24 /** If the total weighted run count of all runs for a router ever falls
25 * below this amount, the router can be treated as having 0 MTBF. */
26 #define STABILITY_EPSILON 0.0001
27 /** Value by which to discount all old intervals for MTBF purposes. This
28 * is compounded every STABILITY_INTERVAL. */
29 #define STABILITY_ALPHA 0.95
30 /** Interval at which to discount all old intervals for MTBF purposes. */
31 #define STABILITY_INTERVAL (12*60*60)
32 /* (This combination of ALPHA, INTERVAL, and EPSILON makes it so that an
33 * interval that just ended counts twice as much as one that ended a week ago,
34 * 20X as much as one that ended a month ago, and routers that have had no
35 * uptime data for about half a year will get forgotten.) */
37 /** History of an OR-\>OR link. */
38 typedef struct link_history_t
{
39 /** When did we start tracking this list? */
41 /** When did we most recently note a change to this link */
43 /** How many times did extending from OR1 to OR2 succeed? */
44 unsigned long n_extend_ok
;
45 /** How many times did extending from OR1 to OR2 fail? */
46 unsigned long n_extend_fail
;
49 /** History of an OR. */
50 typedef struct or_history_t
{
51 /** When did we start tracking this OR? */
53 /** When did we most recently note a change to this OR? */
55 /** How many times did we successfully connect? */
56 unsigned long n_conn_ok
;
57 /** How many times did we try to connect and fail?*/
58 unsigned long n_conn_fail
;
59 /** How many seconds have we been connected to this OR before
62 /** How many seconds have we been unable to connect to this OR before
64 unsigned long downtime
;
65 /** If nonzero, we have been connected since this time. */
67 /** If nonzero, we have been unable to connect since this time. */
70 /* === For MTBF tracking: */
71 /** Weighted sum total of all times that this router has been online.
73 unsigned long weighted_run_length
;
74 /** If the router is now online (according to stability-checking rules),
75 * when did it come online? */
77 /** Sum of weights for runs in weighted_run_length. */
78 double total_run_weights
;
79 /* === For fractional uptime tracking: */
80 time_t start_of_downtime
;
81 unsigned long weighted_uptime
;
82 unsigned long total_weighted_time
;
84 /** Map from hex OR2 identity digest to a link_history_t for the link
85 * from this OR to OR2. */
86 digestmap_t
*link_history_map
;
89 /** When did we last multiply all routers' weighted_run_length and
90 * total_run_weights by STABILITY_ALPHA? */
91 static time_t stability_last_downrated
= 0;
94 static time_t started_tracking_stability
= 0;
96 /** Map from hex OR identity digest to or_history_t. */
97 static digestmap_t
*history_map
= NULL
;
99 /** Return the or_history_t for the OR with identity digest <b>id</b>,
100 * creating it if necessary. */
101 static or_history_t
*
102 get_or_history(const char* id
)
106 if (tor_mem_is_zero(id
, DIGEST_LEN
))
109 hist
= digestmap_get(history_map
, id
);
111 hist
= tor_malloc_zero(sizeof(or_history_t
));
112 rephist_total_alloc
+= sizeof(or_history_t
);
114 hist
->link_history_map
= digestmap_new();
115 hist
->since
= hist
->changed
= time(NULL
);
116 digestmap_set(history_map
, id
, hist
);
121 /** Return the link_history_t for the link from the first named OR to
122 * the second, creating it if necessary. (ORs are identified by
125 static link_history_t
*
126 get_link_history(const char *from_id
, const char *to_id
)
128 or_history_t
*orhist
;
129 link_history_t
*lhist
;
130 orhist
= get_or_history(from_id
);
133 if (tor_mem_is_zero(to_id
, DIGEST_LEN
))
135 lhist
= (link_history_t
*) digestmap_get(orhist
->link_history_map
, to_id
);
137 lhist
= tor_malloc_zero(sizeof(link_history_t
));
138 rephist_total_alloc
+= sizeof(link_history_t
);
139 lhist
->since
= lhist
->changed
= time(NULL
);
140 digestmap_set(orhist
->link_history_map
, to_id
, lhist
);
145 /** Helper: free storage held by a single link history entry. */
147 _free_link_history(void *val
)
149 rephist_total_alloc
-= sizeof(link_history_t
);
153 /** Helper: free storage held by a single OR history entry. */
155 free_or_history(void *_hist
)
157 or_history_t
*hist
= _hist
;
158 digestmap_free(hist
->link_history_map
, _free_link_history
);
159 rephist_total_alloc
-= sizeof(or_history_t
);
164 /** Update an or_history_t object <b>hist</b> so that its uptime/downtime
165 * count is up-to-date as of <b>when</b>.
168 update_or_history(or_history_t
*hist
, time_t when
)
171 if (hist
->up_since
) {
172 tor_assert(!hist
->down_since
);
173 hist
->uptime
+= (when
- hist
->up_since
);
174 hist
->up_since
= when
;
175 } else if (hist
->down_since
) {
176 hist
->downtime
+= (when
- hist
->down_since
);
177 hist
->down_since
= when
;
181 /** Initialize the static data structures for tracking history. */
185 history_map
= digestmap_new();
187 predicted_ports_init();
191 /** Helper: note that we are no longer connected to the router with history
192 * <b>hist</b>. If <b>failed</b>, the connection failed; otherwise, it was
193 * closed correctly. */
195 mark_or_down(or_history_t
*hist
, time_t when
, int failed
)
197 if (hist
->up_since
) {
198 hist
->uptime
+= (when
- hist
->up_since
);
201 if (failed
&& !hist
->down_since
) {
202 hist
->down_since
= when
;
206 /** Helper: note that we are connected to the router with history
209 mark_or_up(or_history_t
*hist
, time_t when
)
211 if (hist
->down_since
) {
212 hist
->downtime
+= (when
- hist
->down_since
);
213 hist
->down_since
= 0;
215 if (!hist
->up_since
) {
216 hist
->up_since
= when
;
220 /** Remember that an attempt to connect to the OR with identity digest
221 * <b>id</b> failed at <b>when</b>.
224 rep_hist_note_connect_failed(const char* id
, time_t when
)
227 hist
= get_or_history(id
);
231 mark_or_down(hist
, when
, 1);
232 hist
->changed
= when
;
235 /** Remember that an attempt to connect to the OR with identity digest
236 * <b>id</b> succeeded at <b>when</b>.
239 rep_hist_note_connect_succeeded(const char* id
, time_t when
)
242 hist
= get_or_history(id
);
246 mark_or_up(hist
, when
);
247 hist
->changed
= when
;
250 /** Remember that we intentionally closed our connection to the OR
251 * with identity digest <b>id</b> at <b>when</b>.
254 rep_hist_note_disconnect(const char* id
, time_t when
)
257 hist
= get_or_history(id
);
260 mark_or_down(hist
, when
, 0);
261 hist
->changed
= when
;
264 /** Remember that our connection to the OR with identity digest
265 * <b>id</b> had an error and stopped working at <b>when</b>.
268 rep_hist_note_connection_died(const char* id
, time_t when
)
272 /* If conn has no identity, it didn't complete its handshake, or something
273 * went wrong. Ignore it.
277 hist
= get_or_history(id
);
280 mark_or_down(hist
, when
, 1);
281 hist
->changed
= when
;
284 /** We have just decided that this router with identity digest <b>id</b> is
285 * reachable, meaning we will give it a "Running" flag for the next while. */
287 rep_hist_note_router_reachable(const char *id
, time_t when
)
289 or_history_t
*hist
= get_or_history(id
);
291 char tbuf
[ISO_TIME_LEN
+1];
295 if (!started_tracking_stability
)
296 started_tracking_stability
= time(NULL
);
297 if (!hist
->start_of_run
) {
298 hist
->start_of_run
= when
;
301 if (hist
->start_of_downtime
) {
304 format_local_iso_time(tbuf
, hist
->start_of_downtime
);
305 log_info(LD_HIST
, "Router %s is now Running; it had been down since %s.",
306 hex_str(id
, DIGEST_LEN
), tbuf
);
308 log_info(LD_HIST
, " (Paradoxically, it was already Running too.)");
310 down_length
= when
- hist
->start_of_downtime
;
311 hist
->total_weighted_time
+= down_length
;
312 hist
->start_of_downtime
= 0;
314 format_local_iso_time(tbuf
, hist
->start_of_run
);
316 log_debug(LD_HIST
, "Router %s is still Running; it has been Running "
317 "since %s", hex_str(id
, DIGEST_LEN
), tbuf
);
319 log_info(LD_HIST
,"Router %s is now Running; it was previously untracked",
320 hex_str(id
, DIGEST_LEN
));
324 /** We have just decided that this router is unreachable, meaning
325 * we are taking away its "Running" flag. */
327 rep_hist_note_router_unreachable(const char *id
, time_t when
)
329 or_history_t
*hist
= get_or_history(id
);
330 char tbuf
[ISO_TIME_LEN
+1];
332 if (!started_tracking_stability
)
333 started_tracking_stability
= time(NULL
);
336 if (hist
->start_of_run
) {
337 /*XXXX We could treat failed connections differently from failed
338 * connect attempts. */
339 long run_length
= when
- hist
->start_of_run
;
340 format_local_iso_time(tbuf
, hist
->start_of_run
);
342 hist
->weighted_run_length
+= run_length
;
343 hist
->total_run_weights
+= 1.0;
344 hist
->start_of_run
= 0;
345 hist
->weighted_uptime
+= run_length
;
346 hist
->total_weighted_time
+= run_length
;
349 log_info(LD_HIST
, "Router %s is now non-Running: it had previously been "
350 "Running since %s. Its total weighted uptime is %lu/%lu.",
351 hex_str(id
, DIGEST_LEN
), tbuf
, hist
->weighted_uptime
,
352 hist
->total_weighted_time
);
354 if (!hist
->start_of_downtime
) {
355 hist
->start_of_downtime
= when
;
358 log_info(LD_HIST
, "Router %s is now non-Running; it was previously "
359 "untracked.", hex_str(id
, DIGEST_LEN
));
362 format_local_iso_time(tbuf
, hist
->start_of_downtime
);
364 log_info(LD_HIST
, "Router %s is still non-Running; it has been "
365 "non-Running since %s.", hex_str(id
, DIGEST_LEN
), tbuf
);
370 /** Helper: Discount all old MTBF data, if it is time to do so. Return
371 * the time at which we should next discount MTBF data. */
373 rep_hist_downrate_old_runs(time_t now
)
375 digestmap_iter_t
*orhist_it
;
382 history_map
= digestmap_new();
383 if (!stability_last_downrated
)
384 stability_last_downrated
= now
;
385 if (stability_last_downrated
+ STABILITY_INTERVAL
> now
)
386 return stability_last_downrated
+ STABILITY_INTERVAL
;
388 /* Okay, we should downrate the data. By how much? */
389 while (stability_last_downrated
+ STABILITY_INTERVAL
< now
) {
390 stability_last_downrated
+= STABILITY_INTERVAL
;
391 alpha
*= STABILITY_ALPHA
;
394 log_info(LD_HIST
, "Discounting all old stability info by a factor of %lf",
397 /* Multiply every w_r_l, t_r_w pair by alpha. */
398 for (orhist_it
= digestmap_iter_init(history_map
);
399 !digestmap_iter_done(orhist_it
);
400 orhist_it
= digestmap_iter_next(history_map
,orhist_it
)) {
401 digestmap_iter_get(orhist_it
, &digest1
, &hist_p
);
404 hist
->weighted_run_length
=
405 (unsigned long)(hist
->weighted_run_length
* alpha
);
406 hist
->total_run_weights
*= alpha
;
408 hist
->weighted_uptime
= (unsigned long)(hist
->weighted_uptime
* alpha
);
409 hist
->total_weighted_time
= (unsigned long)
410 (hist
->total_weighted_time
* alpha
);
413 return stability_last_downrated
+ STABILITY_INTERVAL
;
416 /** Helper: Return the weighted MTBF of the router with history <b>hist</b>. */
418 get_stability(or_history_t
*hist
, time_t when
)
420 unsigned long total
= hist
->weighted_run_length
;
421 double total_weights
= hist
->total_run_weights
;
423 if (hist
->start_of_run
) {
424 /* We're currently in a run. Let total and total_weights hold the values
425 * they would hold if the current run were to end now. */
426 total
+= (when
-hist
->start_of_run
);
427 total_weights
+= 1.0;
429 if (total_weights
< STABILITY_EPSILON
) {
430 /* Round down to zero, and avoid divide-by-zero. */
434 return total
/ total_weights
;
437 /** Return the total amount of time we've been observing, with each run of
438 * time downrated by the appropriate factor. */
440 get_total_weighted_time(or_history_t
*hist
, time_t when
)
442 long total
= hist
->total_weighted_time
;
443 if (hist
->start_of_run
) {
444 total
+= (when
- hist
->start_of_run
);
445 } else if (hist
->start_of_downtime
) {
446 total
+= (when
- hist
->start_of_downtime
);
451 /** Helper: Return the weighted percent-of-time-online of the router with
452 * history <b>hist</b>. */
454 get_weighted_fractional_uptime(or_history_t
*hist
, time_t when
)
456 unsigned long total
= hist
->total_weighted_time
;
457 unsigned long up
= hist
->weighted_uptime
;
459 if (hist
->start_of_run
) {
460 long run_length
= (when
- hist
->start_of_run
);
463 } else if (hist
->start_of_downtime
) {
464 total
+= (when
- hist
->start_of_downtime
);
468 /* Avoid calling anybody's uptime infinity (which should be impossible if
469 * the code is working), or NaN (which can happen for any router we haven't
470 * observed up or down yet). */
474 return ((double) up
) / total
;
477 /** Return an estimated MTBF for the router whose identity digest is
478 * <b>id</b>. Return 0 if the router is unknown. */
480 rep_hist_get_stability(const char *id
, time_t when
)
482 or_history_t
*hist
= get_or_history(id
);
486 return get_stability(hist
, when
);
489 /** Return an estimated percent-of-time-online for the router whose identity
490 * digest is <b>id</b>. Return 0 if the router is unknown. */
492 rep_hist_get_weighted_fractional_uptime(const char *id
, time_t when
)
494 or_history_t
*hist
= get_or_history(id
);
498 return get_weighted_fractional_uptime(hist
, when
);
501 /** Return a number representing how long we've known about the router whose
502 * digest is <b>id</b>. Return 0 if the router is unknown.
504 * Be careful: this measure increases monotonically as we know the router for
505 * longer and longer, but it doesn't increase linearly.
508 rep_hist_get_weighted_time_known(const char *id
, time_t when
)
510 or_history_t
*hist
= get_or_history(id
);
514 return get_total_weighted_time(hist
, when
);
517 /** Return true if we've been measuring MTBFs for long enough to
518 * pronounce on Stability. */
520 rep_hist_have_measured_enough_stability(void)
522 /* XXXX021 This doesn't do so well when we change our opinion
523 * as to whether we're tracking router stability. */
524 return started_tracking_stability
< time(NULL
) - 4*60*60;
527 /** Remember that we successfully extended from the OR with identity
528 * digest <b>from_id</b> to the OR with identity digest
532 rep_hist_note_extend_succeeded(const char *from_id
, const char *to_id
)
534 link_history_t
*hist
;
535 /* log_fn(LOG_WARN, "EXTEND SUCCEEDED: %s->%s",from_name,to_name); */
536 hist
= get_link_history(from_id
, to_id
);
540 hist
->changed
= time(NULL
);
543 /** Remember that we tried to extend from the OR with identity digest
544 * <b>from_id</b> to the OR with identity digest <b>to_name</b>, but
548 rep_hist_note_extend_failed(const char *from_id
, const char *to_id
)
550 link_history_t
*hist
;
551 /* log_fn(LOG_WARN, "EXTEND FAILED: %s->%s",from_name,to_name); */
552 hist
= get_link_history(from_id
, to_id
);
555 ++hist
->n_extend_fail
;
556 hist
->changed
= time(NULL
);
559 /** Log all the reliability data we have remembered, with the chosen
563 rep_hist_dump_stats(time_t now
, int severity
)
565 digestmap_iter_t
*lhist_it
;
566 digestmap_iter_t
*orhist_it
;
567 const char *name1
, *name2
, *digest1
, *digest2
;
568 char hexdigest1
[HEX_DIGEST_LEN
+1];
569 or_history_t
*or_history
;
570 link_history_t
*link_history
;
571 void *or_history_p
, *link_history_p
;
576 unsigned long upt
, downt
;
579 rep_history_clean(now
- get_options()->RephistTrackTime
);
581 log(severity
, LD_HIST
, "--------------- Dumping history information:");
583 for (orhist_it
= digestmap_iter_init(history_map
);
584 !digestmap_iter_done(orhist_it
);
585 orhist_it
= digestmap_iter_next(history_map
,orhist_it
)) {
588 digestmap_iter_get(orhist_it
, &digest1
, &or_history_p
);
589 or_history
= (or_history_t
*) or_history_p
;
591 if ((r
= router_get_by_digest(digest1
)))
595 base16_encode(hexdigest1
, sizeof(hexdigest1
), digest1
, DIGEST_LEN
);
596 update_or_history(or_history
, now
);
597 upt
= or_history
->uptime
;
598 downt
= or_history
->downtime
;
599 s
= get_stability(or_history
, now
);
602 uptime
= ((double)upt
) / (upt
+downt
);
606 log(severity
, LD_HIST
,
607 "OR %s [%s]: %ld/%ld good connections; uptime %ld/%ld sec (%.2f%%); "
608 "wmtbf %lu:%02lu:%02lu",
610 or_history
->n_conn_ok
, or_history
->n_conn_fail
+or_history
->n_conn_ok
,
611 upt
, upt
+downt
, uptime
*100.0,
612 stability
/3600, (stability
/60)%60, stability
%60);
614 if (!digestmap_isempty(or_history
->link_history_map
)) {
615 strlcpy(buffer
, " Extend attempts: ", sizeof(buffer
));
616 len
= strlen(buffer
);
617 for (lhist_it
= digestmap_iter_init(or_history
->link_history_map
);
618 !digestmap_iter_done(lhist_it
);
619 lhist_it
= digestmap_iter_next(or_history
->link_history_map
,
621 digestmap_iter_get(lhist_it
, &digest2
, &link_history_p
);
622 if ((r
= router_get_by_digest(digest2
)))
627 link_history
= (link_history_t
*) link_history_p
;
629 ret
= tor_snprintf(buffer
+len
, 2048-len
, "%s(%ld/%ld); ", name2
,
630 link_history
->n_extend_ok
,
631 link_history
->n_extend_ok
+link_history
->n_extend_fail
);
637 log(severity
, LD_HIST
, "%s", buffer
);
642 /** Remove history info for routers/links that haven't changed since
646 rep_history_clean(time_t before
)
648 int authority
= authdir_mode(get_options());
649 or_history_t
*or_history
;
650 link_history_t
*link_history
;
651 void *or_history_p
, *link_history_p
;
652 digestmap_iter_t
*orhist_it
, *lhist_it
;
655 orhist_it
= digestmap_iter_init(history_map
);
656 while (!digestmap_iter_done(orhist_it
)) {
658 digestmap_iter_get(orhist_it
, &d1
, &or_history_p
);
659 or_history
= or_history_p
;
661 remove
= authority
? (or_history
->total_run_weights
< STABILITY_EPSILON
&&
662 !or_history
->start_of_run
)
663 : (or_history
->changed
< before
);
665 orhist_it
= digestmap_iter_next_rmv(history_map
, orhist_it
);
666 free_or_history(or_history
);
669 for (lhist_it
= digestmap_iter_init(or_history
->link_history_map
);
670 !digestmap_iter_done(lhist_it
); ) {
671 digestmap_iter_get(lhist_it
, &d2
, &link_history_p
);
672 link_history
= link_history_p
;
673 if (link_history
->changed
< before
) {
674 lhist_it
= digestmap_iter_next_rmv(or_history
->link_history_map
,
676 rephist_total_alloc
-= sizeof(link_history_t
);
677 tor_free(link_history
);
680 lhist_it
= digestmap_iter_next(or_history
->link_history_map
,lhist_it
);
682 orhist_it
= digestmap_iter_next(history_map
, orhist_it
);
686 /** Write MTBF data to disk. Return 0 on success, negative on failure.
688 * If <b>missing_means_down</b>, then if we're about to write an entry
689 * that is still considered up but isn't in our routerlist, consider it
692 rep_hist_record_mtbf_data(time_t now
, int missing_means_down
)
694 char time_buf
[ISO_TIME_LEN
+1];
696 digestmap_iter_t
*orhist_it
;
700 open_file_t
*open_file
= NULL
;
704 char *filename
= get_datadir_fname("router-stability");
705 f
= start_writing_to_stdio_file(filename
, OPEN_FLAGS_REPLACE
|O_TEXT
, 0600,
713 * FormatLine *KeywordLine Data
715 * FormatLine = "format 1" NL
716 * KeywordLine = Keyword SP Arguments NL
717 * Data = "data" NL *RouterMTBFLine "." NL
718 * RouterMTBFLine = Fingerprint SP WeightedRunLen SP
719 * TotalRunWeights [SP S=StartRunTime] NL
721 #define PUT(s) STMT_BEGIN if (fputs((s),f)<0) goto err; STMT_END
722 #define PRINTF(args) STMT_BEGIN if (fprintf args <0) goto err; STMT_END
726 format_iso_time(time_buf
, time(NULL
));
727 PRINTF((f
, "stored-at %s\n", time_buf
));
729 if (started_tracking_stability
) {
730 format_iso_time(time_buf
, started_tracking_stability
);
731 PRINTF((f
, "tracked-since %s\n", time_buf
));
733 if (stability_last_downrated
) {
734 format_iso_time(time_buf
, stability_last_downrated
);
735 PRINTF((f
, "last-downrated %s\n", time_buf
));
740 /* XXX Nick: now bridge auths record this for all routers too.
741 * Should we make them record it only for bridge routers? -RD
742 * Not for 0.2.0. -NM */
743 for (orhist_it
= digestmap_iter_init(history_map
);
744 !digestmap_iter_done(orhist_it
);
745 orhist_it
= digestmap_iter_next(history_map
,orhist_it
)) {
746 char dbuf
[HEX_DIGEST_LEN
+1];
747 const char *t
= NULL
;
748 digestmap_iter_get(orhist_it
, &digest
, &or_history_p
);
749 hist
= (or_history_t
*) or_history_p
;
751 base16_encode(dbuf
, sizeof(dbuf
), digest
, DIGEST_LEN
);
753 if (missing_means_down
&& hist
->start_of_run
&&
754 !router_get_by_digest(digest
)) {
755 /* We think this relay is running, but it's not listed in our
756 * routerlist. Somehow it fell out without telling us it went
757 * down. Complain and also correct it. */
759 "Relay '%s' is listed as up in rephist, but it's not in "
760 "our routerlist. Correcting.", dbuf
);
761 rep_hist_note_router_unreachable(digest
, now
);
764 PRINTF((f
, "R %s\n", dbuf
));
765 if (hist
->start_of_run
> 0) {
766 format_iso_time(time_buf
, hist
->start_of_run
);
769 PRINTF((f
, "+MTBF %lu %.5lf%s%s\n",
770 hist
->weighted_run_length
, hist
->total_run_weights
,
771 t
? " S=" : "", t
? t
: ""));
773 if (hist
->start_of_downtime
> 0) {
774 format_iso_time(time_buf
, hist
->start_of_downtime
);
777 PRINTF((f
, "+WFU %lu %lu%s%s\n",
778 hist
->weighted_uptime
, hist
->total_weighted_time
,
779 t
? " S=" : "", t
? t
: ""));
787 return finish_writing_to_file(open_file
);
789 abort_writing_to_file(open_file
);
793 /** Format the current tracked status of the router in <b>hist</b> at time
794 * <b>now</b> for analysis; return it in a newly allocated string. */
796 rep_hist_format_router_status(or_history_t
*hist
, time_t now
)
799 char sor_buf
[ISO_TIME_LEN
+1];
800 char sod_buf
[ISO_TIME_LEN
+1];
803 int up
= 0, down
= 0;
805 if (hist
->start_of_run
) {
806 format_iso_time(sor_buf
, hist
->start_of_run
);
809 if (hist
->start_of_downtime
) {
810 format_iso_time(sod_buf
, hist
->start_of_downtime
);
814 wfu
= get_weighted_fractional_uptime(hist
, now
);
815 mtbf
= get_stability(hist
, now
);
816 tor_snprintf(buf
, sizeof(buf
),
820 " weighted-time %lu\n"
821 " weighted-uptime %lu\n"
823 " weighted-run-length %lu\n"
824 " total-run-weights %lf\n",
825 up
?"uptime-started ":"", up
?sor_buf
:"", up
?" UTC\n":"",
826 down
?"downtime-started ":"", down
?sod_buf
:"", down
?" UTC\n":"",
828 hist
->total_weighted_time
,
829 hist
->weighted_uptime
,
831 hist
->weighted_run_length
,
832 hist
->total_run_weights
835 return tor_strdup(buf
);
838 /** The last stability analysis document that we created, or NULL if we never
839 * have created one. */
840 static char *last_stability_doc
= NULL
;
841 /** The last time we created a stability analysis document, or 0 if we never
842 * have created one. */
843 static time_t built_last_stability_doc_at
= 0;
844 /** Shortest allowable time between building two stability documents. */
845 #define MAX_STABILITY_DOC_BUILD_RATE (3*60)
847 /** Return a pointer to a NUL-terminated document describing our view of the
848 * stability of the routers we've been tracking. Return NULL on failure. */
850 rep_hist_get_router_stability_doc(time_t now
)
854 if (built_last_stability_doc_at
+ MAX_STABILITY_DOC_BUILD_RATE
> now
)
855 return last_stability_doc
;
860 tor_free(last_stability_doc
);
861 chunks
= smartlist_create();
863 if (rep_hist_have_measured_enough_stability()) {
864 smartlist_add(chunks
, tor_strdup("we-have-enough-measurements\n"));
866 smartlist_add(chunks
, tor_strdup("we-do-not-have-enough-measurements\n"));
869 DIGESTMAP_FOREACH(history_map
, id
, or_history_t
*, hist
) {
871 char dbuf
[BASE64_DIGEST_LEN
+1];
872 char header_buf
[512];
874 digest_to_base64(dbuf
, id
);
875 ri
= router_get_by_digest(id
);
877 char *ip
= tor_dup_ip(ri
->addr
);
878 char tbuf
[ISO_TIME_LEN
+1];
879 format_iso_time(tbuf
, ri
->cache_info
.published_on
);
880 tor_snprintf(header_buf
, sizeof(header_buf
),
883 "relevant-flags %s%s%s\n"
884 "declared-uptime %ld\n",
885 dbuf
, ri
->nickname
, ip
,
887 ri
->is_running
? "Running " : "",
888 ri
->is_valid
? "Valid " : "",
889 ri
->is_hibernating
? "Hibernating " : "",
893 tor_snprintf(header_buf
, sizeof(header_buf
),
894 "router %s {no descriptor}\n", dbuf
);
896 smartlist_add(chunks
, tor_strdup(header_buf
));
897 info
= rep_hist_format_router_status(hist
, now
);
899 smartlist_add(chunks
, info
);
901 } DIGESTMAP_FOREACH_END
;
903 result
= smartlist_join_strings(chunks
, "", 0, NULL
);
904 SMARTLIST_FOREACH(chunks
, char *, cp
, tor_free(cp
));
905 smartlist_free(chunks
);
907 last_stability_doc
= result
;
908 built_last_stability_doc_at
= time(NULL
);
912 /** Helper: return the first j >= i such that !strcmpstart(sl[j], prefix) and
913 * such that no line sl[k] with i <= k < j starts with "R ". Return -1 if no
914 * such line exists. */
916 find_next_with(smartlist_t
*sl
, int i
, const char *prefix
)
918 for ( ; i
< smartlist_len(sl
); ++i
) {
919 const char *line
= smartlist_get(sl
, i
);
920 if (!strcmpstart(line
, prefix
))
922 if (!strcmpstart(line
, "R "))
928 /** How many bad times has parse_possibly_bad_iso_time parsed? */
929 static int n_bogus_times
= 0;
930 /** Parse the ISO-formatted time in <b>s</b> into *<b>time_out</b>, but
931 * rounds any pre-1970 date to Jan 1, 1970. */
933 parse_possibly_bad_iso_time(const char *s
, time_t *time_out
)
937 strlcpy(b
, s
, sizeof(b
));
939 year
= (int)tor_parse_long(b
, 10, 0, INT_MAX
, NULL
, NULL
);
945 return parse_iso_time(s
, time_out
);
948 /** We've read a time <b>t</b> from a file stored at <b>stored_at</b>, which
949 * says we started measuring at <b>started_measuring</b>. Return a new number
950 * that's about as much before <b>now</b> as <b>t</b> was before
954 correct_time(time_t t
, time_t now
, time_t stored_at
, time_t started_measuring
)
956 if (t
< started_measuring
- 24*60*60*365)
958 else if (t
< started_measuring
)
959 return started_measuring
;
960 else if (t
> stored_at
)
963 long run_length
= stored_at
- t
;
964 t
= now
- run_length
;
965 if (t
< started_measuring
)
966 t
= started_measuring
;
971 /** Load MTBF data from disk. Returns 0 on success or recoverable error, -1
974 rep_hist_load_mtbf_data(time_t now
)
976 /* XXXX won't handle being called while history is already populated. */
978 const char *line
= NULL
;
980 time_t last_downrated
= 0, stored_at
= 0, tracked_since
= 0;
981 time_t latest_possible_start
= now
;
985 char *filename
= get_datadir_fname("router-stability");
986 char *d
= read_file_to_str(filename
, RFTS_IGNORE_MISSING
, NULL
);
990 lines
= smartlist_create();
991 smartlist_split_string(lines
, d
, "\n", SPLIT_SKIP_SPACE
, 0);
996 const char *firstline
;
997 if (smartlist_len(lines
)>4) {
998 firstline
= smartlist_get(lines
, 0);
999 if (!strcmpstart(firstline
, "format "))
1000 format
= tor_parse_long(firstline
+strlen("format "),
1001 10, -1, LONG_MAX
, NULL
, NULL
);
1004 if (format
!= 1 && format
!= 2) {
1006 "Unrecognized format in mtbf history file. Skipping.");
1009 for (i
= 1; i
< smartlist_len(lines
); ++i
) {
1010 line
= smartlist_get(lines
, i
);
1011 if (!strcmp(line
, "data"))
1013 if (!strcmpstart(line
, "last-downrated ")) {
1014 if (parse_iso_time(line
+strlen("last-downrated "), &last_downrated
)<0)
1015 log_warn(LD_HIST
,"Couldn't parse downrate time in mtbf "
1018 if (!strcmpstart(line
, "stored-at ")) {
1019 if (parse_iso_time(line
+strlen("stored-at "), &stored_at
)<0)
1020 log_warn(LD_HIST
,"Couldn't parse stored time in mtbf "
1023 if (!strcmpstart(line
, "tracked-since ")) {
1024 if (parse_iso_time(line
+strlen("tracked-since "), &tracked_since
)<0)
1025 log_warn(LD_HIST
,"Couldn't parse started-tracking time in mtbf "
1029 if (last_downrated
> now
)
1030 last_downrated
= now
;
1031 if (tracked_since
> now
)
1032 tracked_since
= now
;
1035 log_warn(LD_HIST
, "No stored time recorded.");
1039 if (line
&& !strcmp(line
, "data"))
1044 for (; i
< smartlist_len(lines
); ++i
) {
1045 char digest
[DIGEST_LEN
];
1046 char hexbuf
[HEX_DIGEST_LEN
+1];
1047 char mtbf_timebuf
[ISO_TIME_LEN
+1];
1048 char wfu_timebuf
[ISO_TIME_LEN
+1];
1049 time_t start_of_run
= 0;
1050 time_t start_of_downtime
= 0;
1051 int have_mtbf
= 0, have_wfu
= 0;
1054 long wt_uptime
= 0, total_wt_time
= 0;
1057 line
= smartlist_get(lines
, i
);
1058 if (!strcmp(line
, "."))
1061 mtbf_timebuf
[0] = '\0';
1062 wfu_timebuf
[0] = '\0';
1065 n
= sscanf(line
, "%40s %ld %lf S=%10s %8s",
1066 hexbuf
, &wrl
, &trw
, mtbf_timebuf
, mtbf_timebuf
+11);
1067 if (n
!= 3 && n
!= 5) {
1068 log_warn(LD_HIST
, "Couldn't scan line %s", escaped(line
));
1074 int mtbf_idx
, wfu_idx
;
1075 if (strcmpstart(line
, "R ") || strlen(line
) < 2+HEX_DIGEST_LEN
)
1077 strlcpy(hexbuf
, line
+2, sizeof(hexbuf
));
1078 mtbf_idx
= find_next_with(lines
, i
+1, "+MTBF ");
1079 wfu_idx
= find_next_with(lines
, i
+1, "+WFU ");
1080 if (mtbf_idx
>= 0) {
1081 const char *mtbfline
= smartlist_get(lines
, mtbf_idx
);
1082 n
= sscanf(mtbfline
, "+MTBF %lu %lf S=%10s %8s",
1083 &wrl
, &trw
, mtbf_timebuf
, mtbf_timebuf
+11);
1084 if (n
== 2 || n
== 4) {
1087 log_warn(LD_HIST
, "Couldn't scan +MTBF line %s",
1092 const char *wfuline
= smartlist_get(lines
, wfu_idx
);
1093 n
= sscanf(wfuline
, "+WFU %lu %lu S=%10s %8s",
1094 &wt_uptime
, &total_wt_time
,
1095 wfu_timebuf
, wfu_timebuf
+11);
1096 if (n
== 2 || n
== 4) {
1099 log_warn(LD_HIST
, "Couldn't scan +WFU line %s", escaped(wfuline
));
1107 if (base16_decode(digest
, DIGEST_LEN
, hexbuf
, HEX_DIGEST_LEN
) < 0) {
1108 log_warn(LD_HIST
, "Couldn't hex string %s", escaped(hexbuf
));
1111 hist
= get_or_history(digest
);
1116 if (mtbf_timebuf
[0]) {
1117 mtbf_timebuf
[10] = ' ';
1118 if (parse_possibly_bad_iso_time(mtbf_timebuf
, &start_of_run
)<0)
1119 log_warn(LD_HIST
, "Couldn't parse time %s",
1120 escaped(mtbf_timebuf
));
1122 hist
->start_of_run
= correct_time(start_of_run
, now
, stored_at
,
1124 if (hist
->start_of_run
< latest_possible_start
+ wrl
)
1125 latest_possible_start
= hist
->start_of_run
- wrl
;
1127 hist
->weighted_run_length
= wrl
;
1128 hist
->total_run_weights
= trw
;
1131 if (wfu_timebuf
[0]) {
1132 wfu_timebuf
[10] = ' ';
1133 if (parse_possibly_bad_iso_time(wfu_timebuf
, &start_of_downtime
)<0)
1134 log_warn(LD_HIST
, "Couldn't parse time %s", escaped(wfu_timebuf
));
1137 hist
->start_of_downtime
= correct_time(start_of_downtime
, now
, stored_at
,
1139 hist
->weighted_uptime
= wt_uptime
;
1140 hist
->total_weighted_time
= total_wt_time
;
1142 if (strcmp(line
, "."))
1143 log_warn(LD_HIST
, "Truncated MTBF file.");
1145 if (tracked_since
< 86400*365) /* Recover from insanely early value. */
1146 tracked_since
= latest_possible_start
;
1148 stability_last_downrated
= last_downrated
;
1149 started_tracking_stability
= tracked_since
;
1155 SMARTLIST_FOREACH(lines
, char *, cp
, tor_free(cp
));
1156 smartlist_free(lines
);
1160 /** For how many seconds do we keep track of individual per-second bandwidth
1162 #define NUM_SECS_ROLLING_MEASURE 10
1163 /** How large are the intervals for which we track and report bandwidth use? */
1164 #define NUM_SECS_BW_SUM_INTERVAL (15*60)
1165 /** How far in the past do we remember and publish bandwidth use? */
1166 #define NUM_SECS_BW_SUM_IS_VALID (24*60*60)
1167 /** How many bandwidth usage intervals do we remember? (derived) */
1168 #define NUM_TOTALS (NUM_SECS_BW_SUM_IS_VALID/NUM_SECS_BW_SUM_INTERVAL)
1170 /** Structure to track bandwidth use, and remember the maxima for a given
1173 typedef struct bw_array_t
{
1174 /** Observation array: Total number of bytes transferred in each of the last
1175 * NUM_SECS_ROLLING_MEASURE seconds. This is used as a circular array. */
1176 uint64_t obs
[NUM_SECS_ROLLING_MEASURE
];
1177 int cur_obs_idx
; /**< Current position in obs. */
1178 time_t cur_obs_time
; /**< Time represented in obs[cur_obs_idx] */
1179 uint64_t total_obs
; /**< Total for all members of obs except
1180 * obs[cur_obs_idx] */
1181 uint64_t max_total
; /**< Largest value that total_obs has taken on in the
1182 * current period. */
1183 uint64_t total_in_period
; /**< Total bytes transferred in the current
1186 /** When does the next period begin? */
1188 /** Where in 'maxima' should the maximum bandwidth usage for the current
1189 * period be stored? */
1191 /** How many values in maxima/totals have been set ever? */
1193 /** Circular array of the maximum
1194 * bandwidth-per-NUM_SECS_ROLLING_MEASURE usage for the last
1195 * NUM_TOTALS periods */
1196 uint64_t maxima
[NUM_TOTALS
];
1197 /** Circular array of the total bandwidth usage for the last NUM_TOTALS
1199 uint64_t totals
[NUM_TOTALS
];
1202 /** Shift the current period of b forward by one. */
1204 commit_max(bw_array_t
*b
)
1206 /* Store total from current period. */
1207 b
->totals
[b
->next_max_idx
] = b
->total_in_period
;
1208 /* Store maximum from current period. */
1209 b
->maxima
[b
->next_max_idx
++] = b
->max_total
;
1210 /* Advance next_period and next_max_idx */
1211 b
->next_period
+= NUM_SECS_BW_SUM_INTERVAL
;
1212 if (b
->next_max_idx
== NUM_TOTALS
)
1213 b
->next_max_idx
= 0;
1214 if (b
->num_maxes_set
< NUM_TOTALS
)
1216 /* Reset max_total. */
1218 /* Reset total_in_period. */
1219 b
->total_in_period
= 0;
1222 /** Shift the current observation time of 'b' forward by one second. */
1224 advance_obs(bw_array_t
*b
)
1229 /* Calculate the total bandwidth for the last NUM_SECS_ROLLING_MEASURE
1230 * seconds; adjust max_total as needed.*/
1231 total
= b
->total_obs
+ b
->obs
[b
->cur_obs_idx
];
1232 if (total
> b
->max_total
)
1233 b
->max_total
= total
;
1235 nextidx
= b
->cur_obs_idx
+1;
1236 if (nextidx
== NUM_SECS_ROLLING_MEASURE
)
1239 b
->total_obs
= total
- b
->obs
[nextidx
];
1241 b
->cur_obs_idx
= nextidx
;
1243 if (++b
->cur_obs_time
>= b
->next_period
)
1247 /** Add <b>n</b> bytes to the number of bytes in <b>b</b> for second
1250 add_obs(bw_array_t
*b
, time_t when
, uint64_t n
)
1252 /* Don't record data in the past. */
1253 if (when
<b
->cur_obs_time
)
1255 /* If we're currently adding observations for an earlier second than
1256 * 'when', advance b->cur_obs_time and b->cur_obs_idx by an
1257 * appropriate number of seconds, and do all the other housekeeping */
1258 while (when
>b
->cur_obs_time
)
1261 b
->obs
[b
->cur_obs_idx
] += n
;
1262 b
->total_in_period
+= n
;
1265 /** Allocate, initialize, and return a new bw_array. */
1271 b
= tor_malloc_zero(sizeof(bw_array_t
));
1272 rephist_total_alloc
+= sizeof(bw_array_t
);
1274 b
->cur_obs_time
= start
;
1275 b
->next_period
= start
+ NUM_SECS_BW_SUM_INTERVAL
;
1279 /** Recent history of bandwidth observations for read operations. */
1280 static bw_array_t
*read_array
= NULL
;
1281 /** Recent history of bandwidth observations for write operations. */
1282 static bw_array_t
*write_array
= NULL
;
1284 /** Set up read_array and write_array. */
1286 bw_arrays_init(void)
1288 read_array
= bw_array_new();
1289 write_array
= bw_array_new();
1292 /** We read <b>num_bytes</b> more bytes in second <b>when</b>.
1294 * Add num_bytes to the current running total for <b>when</b>.
1296 * <b>when</b> can go back to time, but it's safe to ignore calls
1297 * earlier than the latest <b>when</b> you've heard of.
1300 rep_hist_note_bytes_written(size_t num_bytes
, time_t when
)
1302 /* Maybe a circular array for recent seconds, and step to a new point
1303 * every time a new second shows up. Or simpler is to just to have
1304 * a normal array and push down each item every second; it's short.
1306 /* When a new second has rolled over, compute the sum of the bytes we've
1307 * seen over when-1 to when-1-NUM_SECS_ROLLING_MEASURE, and stick it
1308 * somewhere. See rep_hist_bandwidth_assess() below.
1310 add_obs(write_array
, when
, num_bytes
);
1313 /** We wrote <b>num_bytes</b> more bytes in second <b>when</b>.
1314 * (like rep_hist_note_bytes_written() above)
1317 rep_hist_note_bytes_read(size_t num_bytes
, time_t when
)
1319 /* if we're smart, we can make this func and the one above share code */
1320 add_obs(read_array
, when
, num_bytes
);
1323 #ifdef ENABLE_EXIT_STATS
1324 /* Some constants */
1325 /** How long are the intervals for measuring exit stats? */
1326 #define EXIT_STATS_INTERVAL_SEC (24 * 60 * 60)
1327 /** To what multiple should byte numbers be rounded up? */
1328 #define EXIT_STATS_ROUND_UP_BYTES 1024
1329 /** To what multiple should stream counts be rounded up? */
1330 #define EXIT_STATS_ROUND_UP_STREAMS 4
1331 /** Number of TCP ports */
1332 #define EXIT_STATS_NUM_PORTS 65536
1334 /* The following data structures are arrays and no fancy smartlists or maps,
1335 * so that all write operations can be done in constant time. This comes at
1336 * the price of some memory (1.25 MB) and linear complexity when writing
1338 /** Number of bytes read in current period by exit port */
1339 static uint64_t exit_bytes_read
[EXIT_STATS_NUM_PORTS
];
1340 /** Number of bytes written in current period by exit port */
1341 static uint64_t exit_bytes_written
[EXIT_STATS_NUM_PORTS
];
1342 /** Number of streams opened in current period by exit port */
1343 static uint32_t exit_streams
[EXIT_STATS_NUM_PORTS
];
1345 /** When does the current exit stats period end? */
1346 static time_t end_of_current_exit_stats_period
= 0;
1348 /** Write exit stats for the current period to disk and reset counters. */
1350 write_exit_stats(time_t when
)
1352 char t
[ISO_TIME_LEN
+1];
1356 char *filename
= get_datadir_fname("exit-stats");
1357 open_file_t
*open_file
= NULL
;
1360 log_debug(LD_HIST
, "Considering writing exit port statistics to disk..");
1361 while (when
> end_of_current_exit_stats_period
) {
1362 format_iso_time(t
, end_of_current_exit_stats_period
);
1363 log_info(LD_HIST
, "Writing exit port statistics to disk for period "
1364 "ending at %s.", t
);
1367 out
= start_writing_to_stdio_file(filename
, OPEN_FLAGS_APPEND
,
1370 log_warn(LD_HIST
, "Couldn't open '%s'.", filename
);
1375 /* written yyyy-mm-dd HH:MM:SS (n s) */
1376 if (fprintf(out
, "written %s (%d s)\n", t
, EXIT_STATS_INTERVAL_SEC
) < 0)
1379 /* kibibytes-(read|written) port=kibibytes,.. */
1380 for (r
= 0; r
< 2; r
++) {
1381 b
= r
? exit_bytes_read
: exit_bytes_written
;
1383 if (fprintf(out
, "%s ",
1384 r
== 0 ? "kibibytes-read" : "kibibytes-written")<0)
1388 for (i
= 1; i
< EXIT_STATS_NUM_PORTS
; i
++) {
1390 uint64_t num
= b
[i
];
1391 num
+= EXIT_STATS_ROUND_UP_BYTES
- 1;
1392 num
/= EXIT_STATS_ROUND_UP_BYTES
;
1393 num
*= EXIT_STATS_ROUND_UP_BYTES
;
1395 if (fprintf(out
, "%s%d="U64_FORMAT
,
1396 comma
++ ? "," : "", i
,
1397 U64_PRINTF_ARG(num
)) < 0)
1401 if (fprintf(out
, "\n")<0)
1403 /* Reset counters */
1404 memset(b
, 0, EXIT_STATS_NUM_PORTS
*sizeof(uint64_t));
1406 /* streams-opened port=num,.. */
1407 if (fprintf(out
, "streams-opened ")<0)
1410 for (i
= 1; i
< EXIT_STATS_NUM_PORTS
; i
++) {
1411 if (exit_streams
[i
] > 0) {
1412 uint32_t num
= exit_streams
[i
];
1413 num
+= EXIT_STATS_ROUND_UP_STREAMS
- 1;
1414 num
/= EXIT_STATS_ROUND_UP_STREAMS
;
1415 num
*= EXIT_STATS_ROUND_UP_STREAMS
;
1416 if (fprintf(out
, "%s%d=%d",
1417 comma
++ ? "," : "", i
, num
)<0)
1421 if (fprintf(out
, "\n")<0)
1423 /* Reset counters */
1424 memset(exit_streams
, 0, sizeof(exit_streams
));
1425 end_of_current_exit_stats_period
+= EXIT_STATS_INTERVAL_SEC
;
1429 finish_writing_to_file(open_file
);
1433 abort_writing_to_file(open_file
);
1437 /** Prepare to add an exit stats observation at second <b>when</b> by
1438 * checking whether this observation lies in the current observation
1439 * period; if not, shift the current period forward by one until the
1440 * reported event fits it and write all results in between to disk. */
1442 add_exit_obs(time_t when
)
1444 if (when
> end_of_current_exit_stats_period
) {
1445 if (end_of_current_exit_stats_period
)
1446 write_exit_stats(when
);
1448 end_of_current_exit_stats_period
= when
+ EXIT_STATS_INTERVAL_SEC
;
1452 /** Note that we wrote <b>num_bytes</b> to an exit connection to
1453 * <b>port</b> in second <b>when</b>. */
1455 rep_hist_note_exit_bytes_written(uint16_t port
, size_t num_bytes
,
1458 if (!get_options()->ExitPortStatistics
)
1461 exit_bytes_written
[port
] += num_bytes
;
1462 log_debug(LD_HIST
, "Written %lu bytes to exit connection to port %d.",
1463 (unsigned long)num_bytes
, port
);
1466 /** Note that we read <b>num_bytes</b> from an exit connection to
1467 * <b>port</b> in second <b>when</b>. */
1469 rep_hist_note_exit_bytes_read(uint16_t port
, size_t num_bytes
,
1472 if (!get_options()->ExitPortStatistics
)
1475 exit_bytes_read
[port
] += num_bytes
;
1476 log_debug(LD_HIST
, "Read %lu bytes from exit connection to port %d.",
1477 (unsigned long)num_bytes
, port
);
1480 /** Note that we opened an exit stream to <b>port</b> in second
1483 rep_hist_note_exit_stream_opened(uint16_t port
, time_t when
)
1485 if (!get_options()->ExitPortStatistics
)
1488 exit_streams
[port
]++;
1489 log_debug(LD_HIST
, "Opened exit stream to port %d", port
);
1493 /** Helper: Return the largest value in b->maxima. (This is equal to the
1494 * most bandwidth used in any NUM_SECS_ROLLING_MEASURE period for the last
1495 * NUM_SECS_BW_SUM_IS_VALID seconds.)
1498 find_largest_max(bw_array_t
*b
)
1503 for (i
=0; i
<NUM_TOTALS
; ++i
) {
1504 if (b
->maxima
[i
]>max
)
1510 /** Find the largest sums in the past NUM_SECS_BW_SUM_IS_VALID (roughly)
1511 * seconds. Find one sum for reading and one for writing. They don't have
1512 * to be at the same time.
1514 * Return the smaller of these sums, divided by NUM_SECS_ROLLING_MEASURE.
1517 rep_hist_bandwidth_assess(void)
1520 r
= find_largest_max(read_array
);
1521 w
= find_largest_max(write_array
);
1523 return (int)(U64_TO_DBL(w
)/NUM_SECS_ROLLING_MEASURE
);
1525 return (int)(U64_TO_DBL(r
)/NUM_SECS_ROLLING_MEASURE
);
1528 /** Print the bandwidth history of b (either read_array or write_array)
1529 * into the buffer pointed to by buf. The format is simply comma
1530 * separated numbers, from oldest to newest.
1532 * It returns the number of bytes written.
1535 rep_hist_fill_bandwidth_history(char *buf
, size_t len
, bw_array_t
*b
)
1539 or_options_t
*options
= get_options();
1542 if (b
->num_maxes_set
<= b
->next_max_idx
) {
1543 /* We haven't been through the circular array yet; time starts at i=0.*/
1546 /* We've been around the array at least once. The next i to be
1547 overwritten is the oldest. */
1548 i
= b
->next_max_idx
;
1551 if (options
->RelayBandwidthRate
) {
1552 /* We don't want to report that we used more bandwidth than the max we're
1553 * willing to relay; otherwise everybody will know how much traffic
1554 * we used ourself. */
1555 cutoff
= options
->RelayBandwidthRate
* NUM_SECS_BW_SUM_INTERVAL
;
1557 cutoff
= UINT64_MAX
;
1560 for (n
=0; n
<b
->num_maxes_set
; ++n
,++i
) {
1562 if (i
>= NUM_TOTALS
)
1564 tor_assert(i
< NUM_TOTALS
);
1565 /* Round the bandwidth used down to the nearest 1k. */
1566 total
= b
->totals
[i
] & ~0x3ff;
1570 if (n
==(b
->num_maxes_set
-1))
1571 tor_snprintf(cp
, len
-(cp
-buf
), U64_FORMAT
, U64_PRINTF_ARG(total
));
1573 tor_snprintf(cp
, len
-(cp
-buf
), U64_FORMAT
",", U64_PRINTF_ARG(total
));
1579 /** Allocate and return lines for representing this server's bandwidth
1580 * history in its descriptor.
1583 rep_hist_get_bandwidth_lines(int for_extrainfo
)
1586 char t
[ISO_TIME_LEN
+1];
1591 /* opt (read|write)-history yyyy-mm-dd HH:MM:SS (n s) n,n,n,n,n... */
1592 len
= (60+20*NUM_TOTALS
)*2;
1593 buf
= tor_malloc_zero(len
);
1596 b
= r
?read_array
:write_array
;
1598 format_iso_time(t
, b
->next_period
-NUM_SECS_BW_SUM_INTERVAL
);
1599 tor_snprintf(cp
, len
-(cp
-buf
), "%s%s %s (%d s) ",
1600 for_extrainfo
? "" : "opt ",
1601 r
? "read-history" : "write-history", t
,
1602 NUM_SECS_BW_SUM_INTERVAL
);
1604 cp
+= rep_hist_fill_bandwidth_history(cp
, len
-(cp
-buf
), b
);
1605 strlcat(cp
, "\n", len
-(cp
-buf
));
1611 /** Update <b>state</b> with the newest bandwidth history. */
1613 rep_hist_update_state(or_state_t
*state
)
1617 smartlist_t
**s_values
;
1622 len
= 20*NUM_TOTALS
+1;
1623 buf
= tor_malloc_zero(len
);
1626 b
= r
?read_array
:write_array
;
1627 s_begins
= r
?&state
->BWHistoryReadEnds
:&state
->BWHistoryWriteEnds
;
1628 s_interval
= r
?&state
->BWHistoryReadInterval
:&state
->BWHistoryWriteInterval
;
1629 s_values
= r
?&state
->BWHistoryReadValues
:&state
->BWHistoryWriteValues
;
1632 SMARTLIST_FOREACH(*s_values
, char *, val
, tor_free(val
));
1633 smartlist_free(*s_values
);
1635 if (! server_mode(get_options())) {
1636 /* Clients don't need to store bandwidth history persistently;
1637 * force these values to the defaults. */
1638 /* FFFF we should pull the default out of config.c's state table,
1639 * so we don't have two defaults. */
1640 if (*s_begins
!= 0 || *s_interval
!= 900) {
1641 time_t now
= time(NULL
);
1642 time_t save_at
= get_options()->AvoidDiskWrites
? now
+3600 : now
+600;
1643 or_state_mark_dirty(state
, save_at
);
1647 *s_values
= smartlist_create();
1650 *s_begins
= b
->next_period
;
1651 *s_interval
= NUM_SECS_BW_SUM_INTERVAL
;
1653 cp
+= rep_hist_fill_bandwidth_history(cp
, len
, b
);
1654 tor_snprintf(cp
, len
-(cp
-buf
), cp
== buf
? U64_FORMAT
: ","U64_FORMAT
,
1655 U64_PRINTF_ARG(b
->total_in_period
));
1656 *s_values
= smartlist_create();
1657 if (server_mode(get_options()))
1658 smartlist_split_string(*s_values
, buf
, ",", SPLIT_SKIP_SPACE
, 0);
1661 if (server_mode(get_options())) {
1662 or_state_mark_dirty(get_or_state(), time(NULL
)+(2*3600));
1666 /** Set bandwidth history from our saved state. */
1668 rep_hist_load_state(or_state_t
*state
, char **err
)
1670 time_t s_begins
, start
;
1671 time_t now
= time(NULL
);
1676 smartlist_t
*s_values
;
1679 /* Assert they already have been malloced */
1680 tor_assert(read_array
&& write_array
);
1683 b
= r
?read_array
:write_array
;
1684 s_begins
= r
?state
->BWHistoryReadEnds
:state
->BWHistoryWriteEnds
;
1685 s_interval
= r
?state
->BWHistoryReadInterval
:state
->BWHistoryWriteInterval
;
1686 s_values
= r
?state
->BWHistoryReadValues
:state
->BWHistoryWriteValues
;
1687 if (s_values
&& s_begins
>= now
- NUM_SECS_BW_SUM_INTERVAL
*NUM_TOTALS
) {
1688 start
= s_begins
- s_interval
*(smartlist_len(s_values
));
1691 b
->cur_obs_time
= start
;
1692 b
->next_period
= start
+ NUM_SECS_BW_SUM_INTERVAL
;
1693 SMARTLIST_FOREACH(s_values
, char *, cp
, {
1694 v
= tor_parse_uint64(cp
, 10, 0, UINT64_MAX
, &ok
, NULL
);
1697 log_notice(LD_HIST
, "Could not parse '%s' into a number.'", cp
);
1700 add_obs(b
, start
, v
);
1701 start
+= NUM_SECS_BW_SUM_INTERVAL
;
1706 /* Clean up maxima and observed */
1707 /* Do we really want to zero this for the purpose of max capacity? */
1708 for (i
=0; i
<NUM_SECS_ROLLING_MEASURE
; ++i
) {
1712 for (i
=0; i
<NUM_TOTALS
; ++i
) {
1719 *err
= tor_strdup("Parsing of bandwidth history values failed");
1720 /* and create fresh arrays */
1721 tor_free(read_array
);
1722 tor_free(write_array
);
1723 read_array
= bw_array_new();
1724 write_array
= bw_array_new();
1730 /*********************************************************************/
1732 /** A list of port numbers that have been used recently. */
1733 static smartlist_t
*predicted_ports_list
=NULL
;
1734 /** The corresponding most recently used time for each port. */
1735 static smartlist_t
*predicted_ports_times
=NULL
;
1737 /** We just got an application request for a connection with
1738 * port <b>port</b>. Remember it for the future, so we can keep
1739 * some circuits open that will exit to this port.
1742 add_predicted_port(time_t now
, uint16_t port
)
1744 /* XXXX we could just use uintptr_t here, I think. */
1745 uint16_t *tmp_port
= tor_malloc(sizeof(uint16_t));
1746 time_t *tmp_time
= tor_malloc(sizeof(time_t));
1749 rephist_total_alloc
+= sizeof(uint16_t) + sizeof(time_t);
1750 smartlist_add(predicted_ports_list
, tmp_port
);
1751 smartlist_add(predicted_ports_times
, tmp_time
);
1754 /** Initialize whatever memory and structs are needed for predicting
1755 * which ports will be used. Also seed it with port 80, so we'll build
1756 * circuits on start-up.
1759 predicted_ports_init(void)
1761 predicted_ports_list
= smartlist_create();
1762 predicted_ports_times
= smartlist_create();
1763 add_predicted_port(time(NULL
), 80); /* add one to kickstart us */
1766 /** Free whatever memory is needed for predicting which ports will
1770 predicted_ports_free(void)
1772 rephist_total_alloc
-= smartlist_len(predicted_ports_list
)*sizeof(uint16_t);
1773 SMARTLIST_FOREACH(predicted_ports_list
, char *, cp
, tor_free(cp
));
1774 smartlist_free(predicted_ports_list
);
1775 rephist_total_alloc
-= smartlist_len(predicted_ports_times
)*sizeof(time_t);
1776 SMARTLIST_FOREACH(predicted_ports_times
, char *, cp
, tor_free(cp
));
1777 smartlist_free(predicted_ports_times
);
1780 /** Remember that <b>port</b> has been asked for as of time <b>now</b>.
1781 * This is used for predicting what sorts of streams we'll make in the
1782 * future and making exit circuits to anticipate that.
1785 rep_hist_note_used_port(time_t now
, uint16_t port
)
1791 tor_assert(predicted_ports_list
);
1792 tor_assert(predicted_ports_times
);
1794 if (!port
) /* record nothing */
1797 for (i
= 0; i
< smartlist_len(predicted_ports_list
); ++i
) {
1798 tmp_port
= smartlist_get(predicted_ports_list
, i
);
1799 tmp_time
= smartlist_get(predicted_ports_times
, i
);
1800 if (*tmp_port
== port
) {
1805 /* it's not there yet; we need to add it */
1806 add_predicted_port(now
, port
);
1809 /** For this long after we've seen a request for a given port, assume that
1810 * we'll want to make connections to the same port in the future. */
1811 #define PREDICTED_CIRCS_RELEVANCE_TIME (60*60)
1813 /** Return a pointer to the list of port numbers that
1814 * are likely to be asked for in the near future.
1816 * The caller promises not to mess with it.
1819 rep_hist_get_predicted_ports(time_t now
)
1825 tor_assert(predicted_ports_list
);
1826 tor_assert(predicted_ports_times
);
1828 /* clean out obsolete entries */
1829 for (i
= 0; i
< smartlist_len(predicted_ports_list
); ++i
) {
1830 tmp_time
= smartlist_get(predicted_ports_times
, i
);
1831 if (*tmp_time
+ PREDICTED_CIRCS_RELEVANCE_TIME
< now
) {
1832 tmp_port
= smartlist_get(predicted_ports_list
, i
);
1833 log_debug(LD_CIRC
, "Expiring predicted port %d", *tmp_port
);
1834 smartlist_del(predicted_ports_list
, i
);
1835 smartlist_del(predicted_ports_times
, i
);
1836 rephist_total_alloc
-= sizeof(uint16_t)+sizeof(time_t);
1842 return predicted_ports_list
;
1845 /** The user asked us to do a resolve. Rather than keeping track of
1846 * timings and such of resolves, we fake it for now by treating
1847 * it the same way as a connection to port 80. This way we will continue
1848 * to have circuits lying around if the user only uses Tor for resolves.
1851 rep_hist_note_used_resolve(time_t now
)
1853 rep_hist_note_used_port(now
, 80);
1856 /** The last time at which we needed an internal circ. */
1857 static time_t predicted_internal_time
= 0;
1858 /** The last time we needed an internal circ with good uptime. */
1859 static time_t predicted_internal_uptime_time
= 0;
1860 /** The last time we needed an internal circ with good capacity. */
1861 static time_t predicted_internal_capacity_time
= 0;
1863 /** Remember that we used an internal circ at time <b>now</b>. */
1865 rep_hist_note_used_internal(time_t now
, int need_uptime
, int need_capacity
)
1867 predicted_internal_time
= now
;
1869 predicted_internal_uptime_time
= now
;
1871 predicted_internal_capacity_time
= now
;
1874 /** Return 1 if we've used an internal circ recently; else return 0. */
1876 rep_hist_get_predicted_internal(time_t now
, int *need_uptime
,
1879 if (!predicted_internal_time
) { /* initialize it */
1880 predicted_internal_time
= now
;
1881 predicted_internal_uptime_time
= now
;
1882 predicted_internal_capacity_time
= now
;
1884 if (predicted_internal_time
+ PREDICTED_CIRCS_RELEVANCE_TIME
< now
)
1885 return 0; /* too long ago */
1886 if (predicted_internal_uptime_time
+ PREDICTED_CIRCS_RELEVANCE_TIME
>= now
)
1888 if (predicted_internal_capacity_time
+ PREDICTED_CIRCS_RELEVANCE_TIME
>= now
)
1893 /** Any ports used lately? These are pre-seeded if we just started
1894 * up or if we're running a hidden service. */
1896 any_predicted_circuits(time_t now
)
1898 return smartlist_len(predicted_ports_list
) ||
1899 predicted_internal_time
+ PREDICTED_CIRCS_RELEVANCE_TIME
>= now
;
1902 /** Return 1 if we have no need for circuits currently, else return 0. */
1904 rep_hist_circbuilding_dormant(time_t now
)
1906 if (any_predicted_circuits(now
))
1909 /* see if we'll still need to build testing circuits */
1910 if (server_mode(get_options()) &&
1911 (!check_whether_orport_reachable() || !circuit_enough_testing_circs()))
1913 if (!check_whether_dirport_reachable())
1919 /** Structure to track how many times we've done each public key operation. */
1921 /** How many directory objects have we signed? */
1922 unsigned long n_signed_dir_objs
;
1923 /** How many routerdescs have we signed? */
1924 unsigned long n_signed_routerdescs
;
1925 /** How many directory objects have we verified? */
1926 unsigned long n_verified_dir_objs
;
1927 /** How many routerdescs have we verified */
1928 unsigned long n_verified_routerdescs
;
1929 /** How many onionskins have we encrypted to build circuits? */
1930 unsigned long n_onionskins_encrypted
;
1931 /** How many onionskins have we decrypted to do circuit build requests? */
1932 unsigned long n_onionskins_decrypted
;
1933 /** How many times have we done the TLS handshake as a client? */
1934 unsigned long n_tls_client_handshakes
;
1935 /** How many times have we done the TLS handshake as a server? */
1936 unsigned long n_tls_server_handshakes
;
1937 /** How many PK operations have we done as a hidden service client? */
1938 unsigned long n_rend_client_ops
;
1939 /** How many PK operations have we done as a hidden service midpoint? */
1940 unsigned long n_rend_mid_ops
;
1941 /** How many PK operations have we done as a hidden service provider? */
1942 unsigned long n_rend_server_ops
;
1943 } pk_op_counts
= {0,0,0,0,0,0,0,0,0,0,0};
1945 /** Increment the count of the number of times we've done <b>operation</b>. */
1947 note_crypto_pk_op(pk_op_t operation
)
1952 pk_op_counts
.n_signed_dir_objs
++;
1955 pk_op_counts
.n_signed_routerdescs
++;
1958 pk_op_counts
.n_verified_dir_objs
++;
1961 pk_op_counts
.n_verified_routerdescs
++;
1964 pk_op_counts
.n_onionskins_encrypted
++;
1967 pk_op_counts
.n_onionskins_decrypted
++;
1969 case TLS_HANDSHAKE_C
:
1970 pk_op_counts
.n_tls_client_handshakes
++;
1972 case TLS_HANDSHAKE_S
:
1973 pk_op_counts
.n_tls_server_handshakes
++;
1976 pk_op_counts
.n_rend_client_ops
++;
1979 pk_op_counts
.n_rend_mid_ops
++;
1982 pk_op_counts
.n_rend_server_ops
++;
1985 log_warn(LD_BUG
, "Unknown pk operation %d", operation
);
1989 /** Log the number of times we've done each public/private-key operation. */
1991 dump_pk_ops(int severity
)
1993 log(severity
, LD_HIST
,
1994 "PK operations: %lu directory objects signed, "
1995 "%lu directory objects verified, "
1996 "%lu routerdescs signed, "
1997 "%lu routerdescs verified, "
1998 "%lu onionskins encrypted, "
1999 "%lu onionskins decrypted, "
2000 "%lu client-side TLS handshakes, "
2001 "%lu server-side TLS handshakes, "
2002 "%lu rendezvous client operations, "
2003 "%lu rendezvous middle operations, "
2004 "%lu rendezvous server operations.",
2005 pk_op_counts
.n_signed_dir_objs
,
2006 pk_op_counts
.n_verified_dir_objs
,
2007 pk_op_counts
.n_signed_routerdescs
,
2008 pk_op_counts
.n_verified_routerdescs
,
2009 pk_op_counts
.n_onionskins_encrypted
,
2010 pk_op_counts
.n_onionskins_decrypted
,
2011 pk_op_counts
.n_tls_client_handshakes
,
2012 pk_op_counts
.n_tls_server_handshakes
,
2013 pk_op_counts
.n_rend_client_ops
,
2014 pk_op_counts
.n_rend_mid_ops
,
2015 pk_op_counts
.n_rend_server_ops
);
2018 /** Free all storage held by the OR/link history caches, by the
2019 * bandwidth history arrays, or by the port history. */
2021 rep_hist_free_all(void)
2023 digestmap_free(history_map
, free_or_history
);
2024 tor_free(read_array
);
2025 tor_free(write_array
);
2026 tor_free(last_stability_doc
);
2027 built_last_stability_doc_at
= 0;
2028 predicted_ports_free();
2031 /****************** hidden service usage statistics ******************/
2033 /** How large are the intervals for which we track and report hidden service
2035 #define NUM_SECS_HS_USAGE_SUM_INTERVAL (15*60)
2036 /** How far in the past do we remember and publish hidden service use? */
2037 #define NUM_SECS_HS_USAGE_SUM_IS_VALID (24*60*60)
2038 /** How many hidden service usage intervals do we remember? (derived) */
2039 #define NUM_TOTALS_HS_USAGE (NUM_SECS_HS_USAGE_SUM_IS_VALID/ \
2040 NUM_SECS_HS_USAGE_SUM_INTERVAL)
2042 /** List element containing a service id and the count. */
2043 typedef struct hs_usage_list_elem_t
{
2044 /** Service id of this elem. */
2045 char service_id
[REND_SERVICE_ID_LEN_BASE32
+1];
2046 /** Number of occurrences for the given service id. */
2048 /* Pointer to next list elem */
2049 struct hs_usage_list_elem_t
*next
;
2050 } hs_usage_list_elem_t
;
2052 /** Ordered list that stores service ids and the number of observations. It is
2053 * ordered by the number of occurrences in descending order. Its purpose is to
2054 * calculate the frequency distribution when the period is over. */
2055 typedef struct hs_usage_list_t
{
2056 /* Pointer to the first element in the list. */
2057 hs_usage_list_elem_t
*start
;
2058 /* Number of total occurrences for all list elements. */
2059 uint32_t total_count
;
2060 /* Number of service ids, i.e. number of list elements. */
2061 uint32_t total_service_ids
;
2064 /** Tracks service-related observations in the current period and their
2066 typedef struct hs_usage_service_related_observation_t
{
2067 /** Ordered list that stores service ids and the number of observations in
2068 * the current period. It is ordered by the number of occurrences in
2069 * descending order. Its purpose is to calculate the frequency distribution
2070 * when the period is over. */
2071 hs_usage_list_t
*list
;
2072 /** Circular arrays that store the history of observations. totals stores all
2073 * observations, twenty (ten, five) the number of observations related to a
2074 * service id being accounted for the top 20 (10, 5) percent of all
2076 uint32_t totals
[NUM_TOTALS_HS_USAGE
];
2077 uint32_t five
[NUM_TOTALS_HS_USAGE
];
2078 uint32_t ten
[NUM_TOTALS_HS_USAGE
];
2079 uint32_t twenty
[NUM_TOTALS_HS_USAGE
];
2080 } hs_usage_service_related_observation_t
;
2082 /** Tracks the history of general period-related observations, i.e. those that
2083 * cannot be related to a specific service id. */
2084 typedef struct hs_usage_general_period_related_observations_t
{
2085 /** Circular array that stores the history of observations. */
2086 uint32_t totals
[NUM_TOTALS_HS_USAGE
];
2087 } hs_usage_general_period_related_observations_t
;
2089 /** Keeps information about the current observation period and its relation to
2090 * the histories of observations. */
2091 typedef struct hs_usage_current_observation_period_t
{
2092 /** Where do we write the next history entry? */
2094 /** How many values in history have been set ever? (upper bound!) */
2096 /** When did this period begin? */
2097 time_t start_of_current_period
;
2098 /** When does the next period begin? */
2099 time_t start_of_next_period
;
2100 } hs_usage_current_observation_period_t
;
2102 /** Usage statistics for the current observation period. */
2103 static hs_usage_current_observation_period_t
*current_period
= NULL
;
2105 /** Total number of descriptor publish requests in the current observation
2107 static hs_usage_service_related_observation_t
*publish_total
= NULL
;
2109 /** Number of descriptor publish requests for services that have not been
2110 * seen before in the current observation period. */
2111 static hs_usage_service_related_observation_t
*publish_novel
= NULL
;
2113 /** Total number of descriptor fetch requests in the current observation
2115 static hs_usage_service_related_observation_t
*fetch_total
= NULL
;
2117 /** Number of successful descriptor fetch requests in the current
2118 * observation period. */
2119 static hs_usage_service_related_observation_t
*fetch_successful
= NULL
;
2121 /** Number of descriptors stored in the current observation period. */
2122 static hs_usage_general_period_related_observations_t
*descs
= NULL
;
2124 /** Creates an empty ordered list element. */
2125 static hs_usage_list_elem_t
*
2126 hs_usage_list_elem_new(void)
2128 hs_usage_list_elem_t
*e
;
2129 e
= tor_malloc_zero(sizeof(hs_usage_list_elem_t
));
2130 rephist_total_alloc
+= sizeof(hs_usage_list_elem_t
);
2136 /** Creates an empty ordered list. */
2137 static hs_usage_list_t
*
2138 hs_usage_list_new(void)
2141 l
= tor_malloc_zero(sizeof(hs_usage_list_t
));
2142 rephist_total_alloc
+= sizeof(hs_usage_list_t
);
2145 l
->total_service_ids
= 0;
2149 /** Creates an empty structure for storing service-related observations. */
2150 static hs_usage_service_related_observation_t
*
2151 hs_usage_service_related_observation_new(void)
2153 hs_usage_service_related_observation_t
*h
;
2154 h
= tor_malloc_zero(sizeof(hs_usage_service_related_observation_t
));
2155 rephist_total_alloc
+= sizeof(hs_usage_service_related_observation_t
);
2156 h
->list
= hs_usage_list_new();
2160 /** Creates an empty structure for storing general period-related
2162 static hs_usage_general_period_related_observations_t
*
2163 hs_usage_general_period_related_observations_new(void)
2165 hs_usage_general_period_related_observations_t
*p
;
2166 p
= tor_malloc_zero(sizeof(hs_usage_general_period_related_observations_t
));
2167 rephist_total_alloc
+= sizeof(hs_usage_general_period_related_observations_t
);
2171 /** Creates an empty structure for storing period-specific information. */
2172 static hs_usage_current_observation_period_t
*
2173 hs_usage_current_observation_period_new(void)
2175 hs_usage_current_observation_period_t
*c
;
2177 c
= tor_malloc_zero(sizeof(hs_usage_current_observation_period_t
));
2178 rephist_total_alloc
+= sizeof(hs_usage_current_observation_period_t
);
2180 c
->start_of_current_period
= now
;
2181 c
->start_of_next_period
= now
+ NUM_SECS_HS_USAGE_SUM_INTERVAL
;
2185 /** Initializes the structures for collecting hidden service usage data. */
2189 current_period
= hs_usage_current_observation_period_new();
2190 publish_total
= hs_usage_service_related_observation_new();
2191 publish_novel
= hs_usage_service_related_observation_new();
2192 fetch_total
= hs_usage_service_related_observation_new();
2193 fetch_successful
= hs_usage_service_related_observation_new();
2194 descs
= hs_usage_general_period_related_observations_new();
2197 /** Clears the given ordered list by resetting its attributes and releasing
2198 * the memory allocated by its elements. */
2200 hs_usage_list_clear(hs_usage_list_t
*lst
)
2202 /* walk through elements and free memory */
2203 hs_usage_list_elem_t
*current
= lst
->start
;
2204 hs_usage_list_elem_t
*tmp
;
2205 while (current
!= NULL
) {
2206 tmp
= current
->next
;
2207 rephist_total_alloc
-= sizeof(hs_usage_list_elem_t
);
2211 /* reset attributes */
2213 lst
->total_count
= 0;
2214 lst
->total_service_ids
= 0;
2218 /** Frees the memory used by the given list. */
2220 hs_usage_list_free(hs_usage_list_t
*lst
)
2224 hs_usage_list_clear(lst
);
2225 rephist_total_alloc
-= sizeof(hs_usage_list_t
);
2229 /** Frees the memory used by the given service-related observations. */
2231 hs_usage_service_related_observation_free(
2232 hs_usage_service_related_observation_t
*s
)
2236 hs_usage_list_free(s
->list
);
2237 rephist_total_alloc
-= sizeof(hs_usage_service_related_observation_t
);
2241 /** Frees the memory used by the given period-specific observations. */
2243 hs_usage_general_period_related_observations_free(
2244 hs_usage_general_period_related_observations_t
*s
)
2246 rephist_total_alloc
-=sizeof(hs_usage_general_period_related_observations_t
);
2250 /** Frees the memory used by period-specific information. */
2252 hs_usage_current_observation_period_free(
2253 hs_usage_current_observation_period_t
*s
)
2255 rephist_total_alloc
-= sizeof(hs_usage_current_observation_period_t
);
2259 /** Frees all memory that was used for collecting hidden service usage data. */
2261 hs_usage_free_all(void)
2263 hs_usage_general_period_related_observations_free(descs
);
2265 hs_usage_service_related_observation_free(fetch_successful
);
2266 hs_usage_service_related_observation_free(fetch_total
);
2267 hs_usage_service_related_observation_free(publish_novel
);
2268 hs_usage_service_related_observation_free(publish_total
);
2269 fetch_successful
= fetch_total
= publish_novel
= publish_total
= NULL
;
2270 hs_usage_current_observation_period_free(current_period
);
2271 current_period
= NULL
;
2274 /** Inserts a new occurrence for the given service id to the given ordered
2277 hs_usage_insert_value(hs_usage_list_t
*lst
, const char *service_id
)
2279 /* search if there is already an elem with same service_id in list */
2280 hs_usage_list_elem_t
*current
= lst
->start
;
2281 hs_usage_list_elem_t
*previous
= NULL
;
2282 while (current
!= NULL
&& strcasecmp(current
->service_id
,service_id
)) {
2284 current
= current
->next
;
2286 /* found an element with same service_id? */
2287 if (current
== NULL
) {
2288 /* not found! append to end (which could also be the end of a zero-length
2289 * list), don't need to sort (1 is smallest value). */
2291 hs_usage_list_elem_t
*e
= hs_usage_list_elem_new();
2292 /* update list attributes (one new elem, one new occurrence) */
2294 lst
->total_service_ids
++;
2295 /* copy service id to elem */
2296 strlcpy(e
->service_id
,service_id
,sizeof(e
->service_id
));
2297 /* let either l->start or previously last elem point to new elem */
2298 if (lst
->start
== NULL
) {
2299 /* this is the first elem */
2302 /* there were elems in the list before */
2306 /* found! add occurrence to elem and consider resorting */
2307 /* update list attributes (no new elem, but one new occurrence) */
2309 /* add occurrence to elem */
2311 /* is it another than the first list elem? and has previous elem fewer
2312 * count than current? then we need to resort */
2313 if (previous
!= NULL
&& previous
->count
< current
->count
) {
2314 /* yes! we need to resort */
2315 /* remove current elem first */
2316 previous
->next
= current
->next
;
2317 /* can we prepend elem to all other elements? */
2318 if (lst
->start
->count
<= current
->count
) {
2319 /* yes! prepend elem */
2320 current
->next
= lst
->start
;
2321 lst
->start
= current
;
2323 /* no! walk through list a second time and insert at correct place */
2324 hs_usage_list_elem_t
*insert_current
= lst
->start
->next
;
2325 hs_usage_list_elem_t
*insert_previous
= lst
->start
;
2326 while (insert_current
!= NULL
&&
2327 insert_current
->count
> current
->count
) {
2328 insert_previous
= insert_current
;
2329 insert_current
= insert_current
->next
;
2332 current
->next
= insert_current
;
2333 insert_previous
->next
= current
;
2339 /** Writes the current service-related observations to the history array and
2340 * clears the observations of the current period. */
2342 hs_usage_write_service_related_observations_to_history(
2343 hs_usage_current_observation_period_t
*p
,
2344 hs_usage_service_related_observation_t
*h
)
2346 /* walk through the first 20 % of list elements and calculate frequency
2348 /* maximum indices for the three frequencies */
2349 int five_percent_idx
= h
->list
->total_service_ids
/20;
2350 int ten_percent_idx
= h
->list
->total_service_ids
/10;
2351 int twenty_percent_idx
= h
->list
->total_service_ids
/5;
2353 uint32_t five_percent
= 0;
2354 uint32_t ten_percent
= 0;
2355 uint32_t twenty_percent
= 0;
2356 /* walk through list */
2357 hs_usage_list_elem_t
*current
= h
->list
->start
;
2359 while (current
!= NULL
&& i
<= twenty_percent_idx
) {
2360 twenty_percent
+= current
->count
;
2361 if (i
<= ten_percent_idx
)
2362 ten_percent
+= current
->count
;
2363 if (i
<= five_percent_idx
)
2364 five_percent
+= current
->count
;
2365 current
= current
->next
;
2368 /* copy frequencies */
2369 h
->twenty
[p
->next_idx
] = twenty_percent
;
2370 h
->ten
[p
->next_idx
] = ten_percent
;
2371 h
->five
[p
->next_idx
] = five_percent
;
2372 /* copy total number of observations */
2373 h
->totals
[p
->next_idx
] = h
->list
->total_count
;
2374 /* free memory of old list */
2375 hs_usage_list_clear(h
->list
);
2378 /** Advances to next observation period. */
2380 hs_usage_advance_current_observation_period(void)
2382 /* aggregate observations to history, including frequency distribution
2384 hs_usage_write_service_related_observations_to_history(
2385 current_period
, publish_total
);
2386 hs_usage_write_service_related_observations_to_history(
2387 current_period
, publish_novel
);
2388 hs_usage_write_service_related_observations_to_history(
2389 current_period
, fetch_total
);
2390 hs_usage_write_service_related_observations_to_history(
2391 current_period
, fetch_successful
);
2392 /* write current number of descriptors to descs history */
2393 descs
->totals
[current_period
->next_idx
] = rend_cache_size();
2394 /* advance to next period */
2395 current_period
->next_idx
++;
2396 if (current_period
->next_idx
== NUM_TOTALS_HS_USAGE
)
2397 current_period
->next_idx
= 0;
2398 if (current_period
->num_set
< NUM_TOTALS_HS_USAGE
)
2399 ++current_period
->num_set
;
2400 current_period
->start_of_current_period
=current_period
->start_of_next_period
;
2401 current_period
->start_of_next_period
+= NUM_SECS_HS_USAGE_SUM_INTERVAL
;
2404 /** Checks if the current period is up to date, and if not, advances it. */
2406 hs_usage_check_if_current_period_is_up_to_date(time_t now
)
2408 while (now
> current_period
->start_of_next_period
) {
2409 hs_usage_advance_current_observation_period();
2413 /** Adds a service-related observation, maybe after advancing to next
2414 * observation period. */
2416 hs_usage_add_service_related_observation(
2417 hs_usage_service_related_observation_t
*h
,
2419 const char *service_id
)
2421 if (now
< current_period
->start_of_current_period
) {
2422 /* don't record old data */
2425 /* check if we are up-to-date */
2426 hs_usage_check_if_current_period_is_up_to_date(now
);
2427 /* add observation */
2428 hs_usage_insert_value(h
->list
, service_id
);
2431 /** Adds the observation of storing a rendezvous service descriptor to our
2432 * cache in our role as HS authoritative directory. */
2434 hs_usage_note_publish_total(const char *service_id
, time_t now
)
2436 hs_usage_add_service_related_observation(publish_total
, now
, service_id
);
2439 /** Adds the observation of storing a novel rendezvous service descriptor to
2440 * our cache in our role as HS authoritative directory. */
2442 hs_usage_note_publish_novel(const char *service_id
, time_t now
)
2444 hs_usage_add_service_related_observation(publish_novel
, now
, service_id
);
2447 /** Adds the observation of being requested for a rendezvous service descriptor
2448 * in our role as HS authoritative directory. */
2450 hs_usage_note_fetch_total(const char *service_id
, time_t now
)
2452 hs_usage_add_service_related_observation(fetch_total
, now
, service_id
);
2455 /** Adds the observation of being requested for a rendezvous service descriptor
2456 * in our role as HS authoritative directory and being able to answer that
2457 * request successfully. */
2459 hs_usage_note_fetch_successful(const char *service_id
, time_t now
)
2461 hs_usage_add_service_related_observation(fetch_successful
, now
, service_id
);
2464 /** Writes the given circular array to a string. */
2466 hs_usage_format_history(char *buf
, size_t len
, uint32_t *data
)
2468 char *cp
= buf
; /* pointer where we are in the buffer */
2470 if (current_period
->num_set
<= current_period
->next_idx
) {
2471 i
= 0; /* not been through circular array */
2473 i
= current_period
->next_idx
;
2475 for (n
= 0; n
< current_period
->num_set
; ++n
,++i
) {
2476 if (i
>= NUM_TOTALS_HS_USAGE
)
2477 i
-= NUM_TOTALS_HS_USAGE
;
2478 tor_assert(i
< NUM_TOTALS_HS_USAGE
);
2479 if (n
== (current_period
->num_set
-1))
2480 tor_snprintf(cp
, len
-(cp
-buf
), "%d", data
[i
]);
2482 tor_snprintf(cp
, len
-(cp
-buf
), "%d,", data
[i
]);
2488 /** Writes the complete usage history as hidden service authoritative directory
2491 hs_usage_format_statistics(void)
2493 char *buf
, *cp
, *s
= NULL
;
2494 char t
[ISO_TIME_LEN
+1];
2496 uint32_t *data
= NULL
;
2498 len
= (70+20*NUM_TOTALS_HS_USAGE
)*11;
2499 buf
= tor_malloc_zero(len
);
2501 for (r
= 0; r
< 11; ++r
) {
2504 s
= (char*) "publish-total-history";
2505 data
= publish_total
->totals
;
2508 s
= (char*) "publish-novel-history";
2509 data
= publish_novel
->totals
;
2512 s
= (char*) "publish-top-5-percent-history";
2513 data
= publish_total
->five
;
2516 s
= (char*) "publish-top-10-percent-history";
2517 data
= publish_total
->ten
;
2520 s
= (char*) "publish-top-20-percent-history";
2521 data
= publish_total
->twenty
;
2524 s
= (char*) "fetch-total-history";
2525 data
= fetch_total
->totals
;
2528 s
= (char*) "fetch-successful-history";
2529 data
= fetch_successful
->totals
;
2532 s
= (char*) "fetch-top-5-percent-history";
2533 data
= fetch_total
->five
;
2536 s
= (char*) "fetch-top-10-percent-history";
2537 data
= fetch_total
->ten
;
2540 s
= (char*) "fetch-top-20-percent-history";
2541 data
= fetch_total
->twenty
;
2544 s
= (char*) "desc-total-history";
2545 data
= descs
->totals
;
2548 format_iso_time(t
, current_period
->start_of_current_period
);
2549 tor_snprintf(cp
, len
-(cp
-buf
), "%s %s (%d s) ", s
, t
,
2550 NUM_SECS_HS_USAGE_SUM_INTERVAL
);
2552 cp
+= hs_usage_format_history(cp
, len
-(cp
-buf
), data
);
2553 strlcat(cp
, "\n", len
-(cp
-buf
));
2559 /** Write current statistics about hidden service usage to file. */
2561 hs_usage_write_statistics_to_file(time_t now
)
2566 or_options_t
*options
= get_options();
2567 /* check if we are up-to-date */
2568 hs_usage_check_if_current_period_is_up_to_date(now
);
2569 buf
= hs_usage_format_statistics();
2570 len
= strlen(options
->DataDirectory
) + 16;
2571 fname
= tor_malloc(len
);
2572 tor_snprintf(fname
, len
, "%s"PATH_SEPARATOR
"hsusage",
2573 options
->DataDirectory
);
2574 write_str_to_file(fname
,buf
,0);
2579 /*** cell statistics ***/
2581 #ifdef ENABLE_BUFFER_STATS
2582 /** Start of the current buffer stats interval. */
2583 time_t start_of_buffer_stats_interval
;
2585 typedef struct circ_buffer_stats_t
{
2586 uint32_t processed_cells
;
2587 double mean_num_cells_in_queue
;
2588 double mean_time_cells_in_queue
;
2589 uint32_t local_circ_id
;
2590 } circ_buffer_stats_t
;
2593 smartlist_t
*circuits_for_buffer_stats
= NULL
;
2595 /** Remember cell statistics for circuit <b>circ</b> at time
2596 * <b>end_of_interval</b> and reset cell counters in case the circuit
2597 * remains open in the next measurement interval. */
2599 add_circ_to_buffer_stats(circuit_t
*circ
, time_t end_of_interval
)
2601 circ_buffer_stats_t
*stat
;
2602 time_t start_of_interval
;
2603 int interval_length
;
2604 or_circuit_t
*orcirc
;
2605 if (CIRCUIT_IS_ORIGIN(circ
))
2607 orcirc
= TO_OR_CIRCUIT(circ
);
2608 if (!orcirc
->processed_cells
)
2610 if (!circuits_for_buffer_stats
)
2611 circuits_for_buffer_stats
= smartlist_create();
2612 start_of_interval
= circ
->timestamp_created
>
2613 start_of_buffer_stats_interval
?
2614 circ
->timestamp_created
:
2615 start_of_buffer_stats_interval
;
2616 interval_length
= (int) (end_of_interval
- start_of_interval
);
2617 stat
= tor_malloc_zero(sizeof(circ_buffer_stats_t
));
2618 stat
->processed_cells
= orcirc
->processed_cells
;
2619 /* 1000.0 for s -> ms; 2.0 because of app-ward and exit-ward queues */
2620 stat
->mean_num_cells_in_queue
= interval_length
== 0 ? 0.0 :
2621 (double) orcirc
->total_cell_waiting_time
/
2622 (double) interval_length
/ 1000.0 / 2.0;
2623 stat
->mean_time_cells_in_queue
=
2624 (double) orcirc
->total_cell_waiting_time
/
2625 (double) orcirc
->processed_cells
;
2626 smartlist_add(circuits_for_buffer_stats
, stat
);
2627 orcirc
->total_cell_waiting_time
= 0;
2628 orcirc
->processed_cells
= 0;
2631 /** Sorting helper: return -1, 1, or 0 based on comparison of two
2632 * circ_buffer_stats_t */
2634 _buffer_stats_compare_entries(const void **_a
, const void **_b
)
2636 const circ_buffer_stats_t
*a
= *_a
, *b
= *_b
;
2637 if (a
->processed_cells
< b
->processed_cells
)
2639 else if (a
->processed_cells
> b
->processed_cells
)
2645 /** Append buffer statistics to local file. */
2647 dump_buffer_stats(void)
2649 time_t now
= time(NULL
);
2651 char written
[ISO_TIME_LEN
+1];
2652 open_file_t
*open_file
= NULL
;
2655 int processed_cells
[SHARES
], circs_in_share
[SHARES
],
2656 number_of_circuits
, i
;
2657 double queued_cells
[SHARES
], time_in_queue
[SHARES
];
2658 smartlist_t
*str_build
= smartlist_create();
2662 /* add current circuits to stats */
2663 for (circ
= _circuit_get_global_list(); circ
; circ
= circ
->next
)
2664 add_circ_to_buffer_stats(circ
, now
);
2665 /* calculate deciles */
2666 memset(processed_cells
, 0, SHARES
* sizeof(int));
2667 memset(circs_in_share
, 0, SHARES
* sizeof(int));
2668 memset(queued_cells
, 0, SHARES
* sizeof(double));
2669 memset(time_in_queue
, 0, SHARES
* sizeof(double));
2670 smartlist_sort(circuits_for_buffer_stats
,
2671 _buffer_stats_compare_entries
);
2672 number_of_circuits
= smartlist_len(circuits_for_buffer_stats
);
2674 SMARTLIST_FOREACH_BEGIN(circuits_for_buffer_stats
,
2675 circ_buffer_stats_t
*, stat
)
2677 int share
= i
++ * SHARES
/ number_of_circuits
;
2678 processed_cells
[share
] += stat
->processed_cells
;
2679 queued_cells
[share
] += stat
->mean_num_cells_in_queue
;
2680 time_in_queue
[share
] += stat
->mean_time_cells_in_queue
;
2681 circs_in_share
[share
]++;
2683 SMARTLIST_FOREACH_END(stat
);
2684 /* clear buffer stats history */
2685 SMARTLIST_FOREACH(circuits_for_buffer_stats
, circ_buffer_stats_t
*,
2686 stat
, tor_free(stat
));
2687 smartlist_clear(circuits_for_buffer_stats
);
2689 filename
= get_datadir_fname("buffer-stats");
2690 out
= start_writing_to_stdio_file(filename
, OPEN_FLAGS_APPEND
,
2694 format_iso_time(written
, now
);
2695 if (fprintf(out
, "written %s (%d s)\n", written
,
2696 DUMP_BUFFER_STATS_INTERVAL
) < 0)
2698 for (i
= 0; i
< SHARES
; i
++) {
2699 tor_snprintf(buf
, sizeof(buf
), "%d", !circs_in_share
[i
] ? 0 :
2700 processed_cells
[i
] / circs_in_share
[i
]);
2701 smartlist_add(str_build
, tor_strdup(buf
));
2703 str
= smartlist_join_strings(str_build
, ",", 0, NULL
);
2704 if (fprintf(out
, "processed-cells %s\n", str
) < 0)
2707 SMARTLIST_FOREACH(str_build
, char *, c
, tor_free(c
));
2708 smartlist_clear(str_build
);
2709 for (i
= 0; i
< SHARES
; i
++) {
2710 tor_snprintf(buf
, sizeof(buf
), "%.2f", circs_in_share
[i
] == 0 ? 0.0 :
2711 queued_cells
[i
] / (double) circs_in_share
[i
]);
2712 smartlist_add(str_build
, tor_strdup(buf
));
2714 str
= smartlist_join_strings(str_build
, ",", 0, NULL
);
2715 if (fprintf(out
, "queued-cells %s\n", str
) < 0)
2718 SMARTLIST_FOREACH(str_build
, char *, c
, tor_free(c
));
2719 smartlist_clear(str_build
);
2720 for (i
= 0; i
< SHARES
; i
++) {
2721 tor_snprintf(buf
, sizeof(buf
), "%.0f", circs_in_share
[i
] == 0 ? 0.0 :
2722 time_in_queue
[i
] / (double) circs_in_share
[i
]);
2723 smartlist_add(str_build
, tor_strdup(buf
));
2725 str
= smartlist_join_strings(str_build
, ",", 0, NULL
);
2726 if (fprintf(out
, "time-in-queue %s\n", str
) < 0)
2729 SMARTLIST_FOREACH(str_build
, char *, c
, tor_free(c
));
2730 smartlist_free(str_build
);
2732 if (fprintf(out
, "number-of-circuits-per-share %d\n",
2733 (number_of_circuits
+ SHARES
- 1) / SHARES
) < 0)
2735 finish_writing_to_file(open_file
);
2739 abort_writing_to_file(open_file
);
2742 SMARTLIST_FOREACH(str_build
, char *, c
, tor_free(c
));
2743 smartlist_free(str_build
);