nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-30 23:53:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

dirvote: Reorganize the dirvote.h file

Browse Source 
Remove useless include.

Clearly identify functions that are used by other part of Tor, functions that
are only used by the dirauth subsystem and functions that are exposed for unit
tests.

This will help us in the dirauth modularization effort.

Signed-off-by: David Goulet <dgoulet@torproject.org>
This commit is contained in:
David Goulet 2018-04-05 11:38:37 -04:00
parent 5e1e906a5c
commit 35d86b088d
1 changed files with 32 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
src/or/dirvote.h
View File

@ -12,8 +12,6 @@
#ifndef TOR_DIRVOTE_H #ifndef TOR_DIRVOTE_H
#define TOR_DIRVOTE_H #define TOR_DIRVOTE_H
#include "testsupport.h"
/* /*
* Ideally, assuming synced clocks, we should only need 1 second for each of: * Ideally, assuming synced clocks, we should only need 1 second for each of:
* - Vote * - Vote
@ -86,41 +84,53 @@
* get confused with the above macros.) */ * get confused with the above macros.) */
#define DEFAULT_MAX_UNMEASURED_BW_KB 20 #define DEFAULT_MAX_UNMEASURED_BW_KB 20
/* Directory Get Vote (DGV) flags for dirvote_get_vote(). */
#define DGV_BY_ID 1
#define DGV_INCLUDE_PENDING 2
#define DGV_INCLUDE_PREVIOUS 4
/*
* Public API. Used outside of the dirauth subsystem.
*/
void dirvote_free_all(void); void dirvote_free_all(void);
/* vote manipulation */ /* Vote manipulation */
void ns_detached_signatures_free_(ns_detached_signatures_t *s); void ns_detached_signatures_free_(ns_detached_signatures_t *s);
#define ns_detached_signatures_free(s) \ #define ns_detached_signatures_free(s) \
FREE_AND_NULL(ns_detached_signatures_t, ns_detached_signatures_free_, (s)) FREE_AND_NULL(ns_detached_signatures_t, ns_detached_signatures_free_, (s))
/* cert manipulation */
authority_cert_t *authority_cert_dup(authority_cert_t *cert);
void dirvote_get_preferred_voting_intervals(vote_timing_t *timing_out);
time_t dirvote_get_start_of_next_interval(time_t now,
int interval,
int offset);
void dirvote_recalculate_timing(const or_options_t *options, time_t now); void dirvote_recalculate_timing(const or_options_t *options, time_t now);
void dirvote_act(const or_options_t *options, time_t now); void dirvote_act(const or_options_t *options, time_t now);
time_t dirvote_get_next_valid_after_time(void); /* Invoked on timers and by outside triggers. */
/* invoked on timers and by outside triggers. */
struct pending_vote_t * dirvote_add_vote(const char *vote_body, struct pending_vote_t * dirvote_add_vote(const char *vote_body,
const char **msg_out, const char **msg_out,
int *status_out); int *status_out);
int dirvote_add_signatures(const char *detached_signatures_body, int dirvote_add_signatures(const char *detached_signatures_body,
const char *source, const char *source,
const char **msg_out); const char **msg_out);
/* Item access */ /* Item access */
MOCK_DECL(const char*, dirvote_get_pending_consensus, MOCK_DECL(const char*, dirvote_get_pending_consensus,
(consensus_flavor_t flav)); (consensus_flavor_t flav));
MOCK_DECL(const char*, dirvote_get_pending_detached_signatures, (void)); MOCK_DECL(const char*, dirvote_get_pending_detached_signatures, (void));
#define DGV_BY_ID 1
#define DGV_INCLUDE_PENDING 2
#define DGV_INCLUDE_PREVIOUS 4
const cached_dir_t *dirvote_get_vote(const char *fp, int flags); const cached_dir_t *dirvote_get_vote(const char *fp, int flags);
document_signature_t *voter_get_sig_by_algorithm(
const networkstatus_voter_info_t *voter,
digest_algorithm_t alg);
/*
* API used _only_ by the dirauth subsystem.
*/
/* Cert manipulation */
authority_cert_t *authority_cert_dup(authority_cert_t *cert);
void dirvote_get_preferred_voting_intervals(vote_timing_t *timing_out);
time_t dirvote_get_start_of_next_interval(time_t now,
int interval,
int offset);
time_t dirvote_get_next_valid_after_time(void);
void set_routerstatus_from_routerinfo(routerstatus_t *rs, void set_routerstatus_from_routerinfo(routerstatus_t *rs,
node_t *node, node_t *node,
routerinfo_t *ri, time_t now, routerinfo_t *ri, time_t now,
@ -134,11 +144,11 @@ vote_microdesc_hash_t *dirvote_format_all_microdesc_vote_lines(
time_t now, time_t now,
smartlist_t *microdescriptors_out); smartlist_t *microdescriptors_out);
document_signature_t *voter_get_sig_by_algorithm( /*
const networkstatus_voter_info_t *voter, * Exposed functions for unit tests.
digest_algorithm_t alg); */
#ifdef DIRVOTE_PRIVATE #ifdef DIRVOTE_PRIVATE
STATIC int32_t dirvote_get_intermediate_param_value( STATIC int32_t dirvote_get_intermediate_param_value(
const smartlist_t *param_list, const smartlist_t *param_list,
const char *keyword, const char *keyword,