Tor  0.4.4.0-alpha-dev
shutdown.c
Go to the documentation of this file.
1 /* Copyright (c) 2001 Matej Pfajfar.
2  * Copyright (c) 2001-2004, Roger Dingledine.
3  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4  * Copyright (c) 2007-2020, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
6 
7 /**
8  * @file shutdown.c
9  * @brief Code to free global resources used by Tor.
10  *
11  * In the future, this should all be handled by the subsystem manager. */
12 
13 #include "core/or/or.h"
14 
15 #include "app/config/config.h"
16 #include "app/config/statefile.h"
17 #include "app/main/main.h"
18 #include "app/main/shutdown.h"
19 #include "app/main/subsysmgr.h"
22 #include "core/or/channeltls.h"
23 #include "core/or/circuitlist.h"
25 #include "core/or/circuitpadding.h"
27 #include "core/or/dos.h"
28 #include "core/or/scheduler.h"
30 #include "feature/client/bridges.h"
41 #include "feature/hs/hs_common.h"
48 #include "feature/rend/rendcache.h"
51 #include "feature/stats/rephist.h"
53 #include "lib/geoip/geoip.h"
54 
55 void evdns_shutdown(int);
56 
57 /** Do whatever cleanup is necessary before shutting Tor down. */
58 void
60 {
61  const or_options_t *options = get_options();
62  if (options->command == CMD_RUN_TOR) {
63  time_t now = time(NULL);
64  /* Remove our pid file. We don't care if there was an error when we
65  * unlink, nothing we could do about it anyways. */
66  tor_remove_file(options->PidFile);
67  /* Remove control port file */
69  /* Remove cookie authentication file */
70  {
71  char *cookie_fname = get_controller_cookie_file_name();
72  tor_remove_file(cookie_fname);
73  tor_free(cookie_fname);
74  }
75  /* Remove Extended ORPort cookie authentication file */
76  {
77  char *cookie_fname = get_ext_or_auth_cookie_file_name();
78  if (cookie_fname)
79  tor_remove_file(cookie_fname);
80  tor_free(cookie_fname);
81  }
82  if (accounting_is_enabled(options))
84  or_state_mark_dirty(get_or_state(), 0); /* force an immediate save. */
85  or_state_save(now);
86  if (authdir_mode(options)) {
88  }
91  }
92 
94 
95  tor_free_all(0); /* We could move tor_free_all back into the ifdef below
96  later, if it makes shutdown unacceptably slow. But for
97  now, leave it here: it's helped us catch bugs in the
98  past. */
99 }
100 
101 /** Free all memory that we might have allocated somewhere.
102  * If <b>postfork</b>, we are a worker process and we want to free
103  * only the parts of memory that we won't touch. If !<b>postfork</b>,
104  * Tor is shutting down and we should free everything.
105  *
106  * Helps us find the real leaks with sanitizers and the like. Also valgrind
107  * should then report 0 reachable in its leak report (in an ideal world --
108  * in practice libevent, SSL, libc etc never quite free everything). */
109 void
110 tor_free_all(int postfork)
111 {
112  if (!postfork) {
113  evdns_shutdown(1);
114  }
115  geoip_free_all();
120  dirserv_free_all();
127  pt_free_all();
139  hs_free_all();
140  dos_free_all();
144 
145  if (!postfork) {
146  config_free_all();
148  or_state_free_all();
149  }
150  if (!postfork) {
151 #ifndef _WIN32
152  tor_getpwnam(NULL);
153 #endif
154  }
155  /* stuff in main.c */
156 
158 
159  if (!postfork) {
161  }
162 
164 
165  /* Stuff in util.c and address.c*/
166  if (!postfork) {
167  esc_router_info(NULL);
168  }
169 }
void rep_hist_free_all(void)
Definition: rephist.c:2899
Header file for dirserv.c.
Header for statefile.c.
Header for feature/relay/relay_config.c.
void subsystems_shutdown(void)
Definition: subsysmgr.c:204
int authdir_mode_tests_reachability(const or_options_t *options)
Definition: authmode.c:68
Header file for channeltls.c.
Header file containing common data for the whole HS subsytem.
Header file for circuitbuild.c.
char * PidFile
Definition: or_options_st.h:75
Header file for control_auth.c.
Header for addressmap.c.
void tor_cleanup(void)
Definition: shutdown.c:59
void routerparse_free_all(void)
Definition: routerparse.c:1246
Header file for geoip_stats.c.
Header file for connection.c.
char * ControlPortWriteToFile
void circuitmux_ewma_free_all(void)
int authdir_mode(const or_options_t *options)
Definition: authmode.c:25
Header file for nodelist.c.
Header file for shutdown.c.
int accounting_is_enabled(const or_options_t *options)
Definition: hibernate.c:305
const struct passwd * tor_getpwnam(const char *username)
Definition: userdb.c:70
Header for mainloop_pubsub.c.
Header file for config.c.
const or_options_t * get_options(void)
Definition: config.c:925
void consdiffmgr_free_all(void)
Definition: consdiffmgr.c:1257
Header file for microdesc.c.
#define tor_free(p)
Definition: malloc.h:52
void relay_config_free_all(void)
Definition: relay_config.c:83
void bridges_free_all(void)
Definition: bridges.c:1024
Header file for geoip.c.
Header for ext_orport.c.
Header file for scheduler*.c.
char * get_controller_cookie_file_name(void)
Definition: control_auth.c:48
Header file for main.c.
void rend_service_authorization_free_all(void)
Definition: rendclient.c:1169
void accounting_free_all(void)
Definition: hibernate.c:1254
Header file for directory authority mode.
Header file for hibernate.c.
void rend_cache_free_all(void)
Definition: rendcache.c:244
void sr_save_and_cleanup(void)
void tor_mainloop_disconnect_pubsub(void)
void control_free_all(void)
Definition: control.c:606
Header file for circuitpadding.c.
void scheduler_free_all(void)
Definition: scheduler.c:484
Header file for rendcache.c.
Header file for circuitbuild.c.
Master header file for Tor-specific functionality.
void release_lockfile(void)
Definition: main.c:675
Header file for rephist.c.
void circpad_machines_free(void)
void addressmap_free_all(void)
Definition: addressmap.c:328
void config_free_all(void)
Definition: config.c:1045
void entry_guards_free_all(void)
Definition: entrynodes.c:3814
Header file for circuitmux_ewma.c.
void timers_shutdown(void)
Definition: timers.c:234
Header file for circuitlist.c.
Headers for transports.c.
const char * esc_router_info(const routerinfo_t *router)
Definition: routerlist.c:3188
void channel_free_all(void)
Definition: channel.c:2219
Header file for connection_edge.c.
void circpad_free_all(void)
void microdesc_free_all(void)
Definition: microdesc.c:927
void nodelist_free_all(void)
Definition: nodelist.c:854
Header file for control.c.
void circuit_free_all(void)
Definition: circuitlist.c:1296
void channel_tls_free_all(void)
Definition: channeltls.c:296
void routerlist_free_all(void)
Definition: routerlist.c:1426
void or_state_mark_dirty(or_state_t *state, time_t when)
Definition: statefile.c:733
int rep_hist_record_mtbf_data(time_t now, int missing_means_down)
Definition: rephist.c:626
int or_state_save(time_t now)
Definition: statefile.c:511
void geoip_stats_free_all(void)
Definition: geoip_stats.c:1402
void networkstatus_free_all(void)
char * get_ext_or_auth_cookie_file_name(void)
Definition: ext_orport.c:127
int accounting_record_bandwidth_usage(time_t now, or_state_t *state)
Definition: hibernate.c:705
void pt_free_all(void)
Definition: transports.c:1761
Header for subsysmgr.c.
tor_cmdline_mode_t command
Definition: or_options_st.h:43
or_state_t * get_or_state(void)
Definition: statefile.c:200
void connection_free_all(void)
Definition: connection.c:5611
Header for compat_libevent.c.
Header file for rendclient.c.
Header for consdiffmgr.c.
void tor_remove_file(const char *filename)
Definition: main.c:688
This file contains ABI/API of the shared random protocol defined in proposal #250....
Header file for networkstatus.c.
void tor_free_all(int postfork)
Definition: shutdown.c:110
Header file for routerlist.c.
Header file for routerparse.c.
void connection_edge_free_all(void)
void geoip_free_all(void)
Definition: geoip.c:510
void hs_free_all(void)
Definition: hs_common.c:1827