Macros | Functions
microdesc.h File Reference

Go to the source code of this file.


#define microdesc_free(md)


microdesc_cache_tget_microdesc_cache (void)
void microdesc_check_counts (void)
smartlist_tmicrodescs_add_to_cache (microdesc_cache_t *cache, const char *s, const char *eos, saved_location_t where, int no_save, time_t listed_at, smartlist_t *requested_digests256)
smartlist_tmicrodescs_add_list_to_cache (microdesc_cache_t *cache, smartlist_t *descriptors, saved_location_t where, int no_save)
void microdesc_cache_clean (microdesc_cache_t *cache, time_t cutoff, int force)
int microdesc_cache_rebuild (microdesc_cache_t *cache, int force)
int microdesc_cache_reload (microdesc_cache_t *cache)
void microdesc_cache_clear (microdesc_cache_t *cache)
microdesc_tmicrodesc_cache_lookup_by_digest256 (microdesc_cache_t *cache, const char *d)
smartlist_tmicrodesc_list_missing_digest256 (networkstatus_t *ns, microdesc_cache_t *cache, int downloadable_only, digest256map_t *skip)
void microdesc_free_ (microdesc_t *md, const char *fname, int line)
void microdesc_free_all (void)
void update_microdesc_downloads (time_t now)
void update_microdescs_from_networkstatus (time_t now)
 MOCK_DECL (int, usable_consensus_flavor,(void))
int we_fetch_microdescriptors (const or_options_t *options)
int we_fetch_router_descriptors (const or_options_t *options)
int we_use_microdescriptors_for_circuits (const or_options_t *options)
void microdesc_note_outdated_dirserver (const char *relay_digest)
int microdesc_relay_is_outdated_dirserver (const char *relay_digest)
void microdesc_reset_outdated_dirservers_list (void)

Detailed Description

Header file for microdesc.c.

Definition in file microdesc.h.

Macro Definition Documentation

◆ microdesc_free

#define microdesc_free (   md)
do { \
microdesc_free_((md), __FILE__, __LINE__); \
(md) = NULL; \
} while (0)

Definition at line 41 of file microdesc.h.

Function Documentation

◆ get_microdesc_cache()

microdesc_cache_t* get_microdesc_cache ( void  )

Return a pointer to the microdescriptor cache, loading it if necessary.

Definition at line 249 of file microdesc.c.

References get_microdesc_cache_noload().

Referenced by microdesc_cache_lookup_by_digest256(), and update_microdescs_from_networkstatus().

◆ microdesc_cache_clean()

void microdesc_cache_clean ( microdesc_cache_t cache,
time_t  cutoff,
int  force 

Remove all microdescriptors from cache that haven't been listed for a long time. Does not rebuild the cache on disk. If cutoff is positive, specifically remove microdescriptors that have been unlisted since cutoff. If force is true, remove microdescriptors even if we have no current live microdescriptor consensus.

Definition at line 570 of file microdesc.c.

Referenced by microdesc_cache_rebuild().

◆ microdesc_cache_clear()

void microdesc_cache_clear ( microdesc_cache_t cache)

Remove every microdescriptor in cache.

Definition at line 463 of file microdesc.c.

References microdesc_t::held_in_map.

Referenced by microdesc_cache_reload(), and microdesc_free_all().

◆ microdesc_cache_lookup_by_digest256()

microdesc_t* microdesc_cache_lookup_by_digest256 ( microdesc_cache_t cache,
const char *  d 

If there is a microdescriptor in cache whose sha256 digest is d, return it. Otherwise return NULL.

Definition at line 944 of file microdesc.c.

References microdesc_t::digest, DIGEST256_LEN, and get_microdesc_cache().

◆ microdesc_cache_rebuild()

int microdesc_cache_rebuild ( microdesc_cache_t cache,
int  force 

Regenerate the main cache file for cache, clear the journal file, and update every microdesc_t in the cache with pointers to its new location. If force is true, do this unconditionally. If force is false, do it only if we expect to save space on disk.

Definition at line 703 of file microdesc.c.

References microdesc_cache_clean(), and the_microdesc_cache.

◆ microdesc_cache_reload()

int microdesc_cache_reload ( microdesc_cache_t cache)

Reload the contents of cache from disk. If it is empty, load it for the first time. Return 0 on success, -1 on failure.

Definition at line 513 of file microdesc.c.

References microdesc_cache_clear().

◆ microdesc_check_counts()

void microdesc_check_counts ( void  )

Make sure that the reference count of every microdescriptor in cache is accurate.

Definition at line 842 of file microdesc.c.

References microdesc_t::held_by_nodes, SMARTLIST_FOREACH, the_microdesc_cache, and tor_assert().

◆ microdesc_free_()

void microdesc_free_ ( microdesc_t md,
const char *  fname,
int  lineno 

Deallocate a single microdescriptor. Note: the microdescriptor MUST have previously been removed from the cache if it had ever been inserted.

Definition at line 864 of file microdesc.c.

References get_microdesc_cache_noload(), and microdesc_t::held_in_map.

◆ microdesc_free_all()

void microdesc_free_all ( void  )

Free all storage held in the microdesc.c module.

Definition at line 926 of file microdesc.c.

References microdesc_cache_clear(), SMARTLIST_FOREACH, the_microdesc_cache, and tor_free.

◆ microdesc_list_missing_digest256()

smartlist_t* microdesc_list_missing_digest256 ( networkstatus_t ns,
microdesc_cache_t cache,
int  downloadable_only,
digest256map_t *  skip 

Return a smartlist of all the sha256 digest of the microdescriptors that are listed in ns but not present in cache. Returns pointers to internals of ns; you should not free the members of the resulting smartlist. Omit all microdescriptors whose digest appear in skip.

Definition at line 959 of file microdesc.c.

References networkstatus_t::flavor, and tor_assert().

◆ microdesc_relay_is_outdated_dirserver()

int microdesc_relay_is_outdated_dirserver ( const char *  relay_digest)

Return True if the relay with relay_digest (size DIGEST_LEN) is an outdated dirserver

Definition at line 161 of file microdesc.c.

References base16_encode(), DIGEST_LEN, HEX_DIGEST_LEN, and smartlist_contains_string().

Referenced by guard_obeys_md_dirserver_restriction().

◆ microdesc_reset_outdated_dirservers_list()

void microdesc_reset_outdated_dirservers_list ( void  )

Reset the list of outdated dirservers.

Definition at line 184 of file microdesc.c.

References smartlist_clear(), SMARTLIST_FOREACH, and tor_free.

◆ microdescs_add_list_to_cache()

smartlist_t* microdescs_add_list_to_cache ( microdesc_cache_t cache,
smartlist_t descriptors,
saved_location_t  where,
int  no_save 

As microdescs_add_to_cache, but takes a list of microdescriptors instead of a string to decode. Frees any members of descriptors that it does not add.

Definition at line 381 of file microdesc.c.

References SAVED_NOWHERE, and start_writing_to_file().

◆ microdescs_add_to_cache()

smartlist_t* microdescs_add_to_cache ( microdesc_cache_t cache,
const char *  s,
const char *  eos,
saved_location_t  where,
int  no_save,
time_t  listed_at,
smartlist_t requested_digests256 

Decode the microdescriptors from the string starting at s and ending at eos, and store them in cache. If no_save, mark them as non-writable to disk. If where is SAVED_IN_CACHE, leave their bodies as pointers to the mmap'd cache. If where is SAVED_NOWHERE, do not allow annotations. If listed_at is not -1, set the last_listed field of every microdesc to listed_at. If requested_digests is non-null, then it contains a list of digests we mean to allow, so we should reject any non-requested microdesc with a different digest, and alter the list to contain only the digests of those microdescs we didn't find. Return a newly allocated list of the added microdescriptors, or NULL

Definition at line 291 of file microdesc.c.

References microdesc_t::last_listed, microdescs_parse_from_string(), SAVED_NOWHERE, SMARTLIST_DEL_CURRENT, SMARTLIST_FOREACH, SMARTLIST_FOREACH_BEGIN, and tor_free.

◆ update_microdesc_downloads()

void update_microdesc_downloads ( time_t  now)

Launch download requests for microdescriptors as appropriate.

Specifically, we should launch download requests if we are configured to download mirodescriptors, and there are some microdescriptors listed in the current microdesc consensus that we don't have, and either we never asked for them, or we failed to download them but we're willing to retry.

Definition at line 991 of file microdesc.c.

References directory_too_idle_to_fetch_descriptors(), and should_delay_dir_fetches().

Referenced by update_all_descriptor_downloads().

◆ update_microdescs_from_networkstatus()

void update_microdescs_from_networkstatus ( time_t  now)

For every microdescriptor listed in the current microdescriptor consensus, update its last_listed field to be at least as recent as the publication time of the current microdescriptor consensus.

Definition at line 1031 of file microdesc.c.

References get_microdesc_cache().

◆ we_fetch_microdescriptors()

int we_fetch_microdescriptors ( const or_options_t options)

Return true iff we should try to download microdescriptors at all.

Definition at line 1062 of file microdesc.c.

References directory_caches_dir_info(), or_options_t::FetchUselessDescriptors, and we_use_microdescriptors_for_circuits().

◆ we_fetch_router_descriptors()

int we_fetch_router_descriptors ( const or_options_t options)

Return true iff we should try to download router descriptors at all.

Definition at line 1073 of file microdesc.c.

References directory_caches_dir_info(), or_options_t::FetchUselessDescriptors, and we_use_microdescriptors_for_circuits().

Referenced by update_router_descriptor_downloads().

◆ we_use_microdescriptors_for_circuits()

int we_use_microdescriptors_for_circuits ( const or_options_t options)

Return true iff we should prefer to use microdescriptors rather than routerdescs for building circuits.

Definition at line 1053 of file microdesc.c.

References or_options_t::UseMicrodescriptors.

Referenced by MOCK_IMPL(), node_has_preferred_descriptor(), we_fetch_microdescriptors(), and we_fetch_router_descriptors().