123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157 |
- /* Copyright (c) 2001 Matej Pfajfar.
- * Copyright (c) 2001-2004, Roger Dingledine.
- * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
- * Copyright (c) 2007-2013, The Tor Project, Inc. */
- /* See LICENSE for licensing information */
- /**
- * \file control.h
- * \brief Header file for control.c.
- **/
- #ifndef TOR_CONTROL_H
- #define TOR_CONTROL_H
- void control_update_global_event_mask(void);
- void control_adjust_event_log_severity(void);
- void control_ports_write_to_file(void);
- /** Log information about the connection <b>conn</b>, protecting it as with
- * CONN_LOG_PROTECT. Example:
- *
- * LOG_FN_CONN(conn, (LOG_DEBUG, "Socket %d wants to write", conn->s));
- **/
- #define LOG_FN_CONN(conn, args) \
- CONN_LOG_PROTECT(conn, log_fn args)
- int connection_control_finished_flushing(control_connection_t *conn);
- int connection_control_reached_eof(control_connection_t *conn);
- void connection_control_closed(control_connection_t *conn);
- int connection_control_process_inbuf(control_connection_t *conn);
- #define EVENT_AUTHDIR_NEWDESCS 0x000D
- #define EVENT_NS 0x000F
- int control_event_is_interesting(int event);
- int control_event_circuit_status(origin_circuit_t *circ,
- circuit_status_event_t e, int reason);
- int control_event_circuit_purpose_changed(origin_circuit_t *circ,
- int old_purpose);
- int control_event_circuit_cannibalized(origin_circuit_t *circ,
- int old_purpose,
- const struct timeval *old_tv_created);
- int control_event_stream_status(entry_connection_t *conn,
- stream_status_event_t e,
- int reason);
- int control_event_or_conn_status(or_connection_t *conn,
- or_conn_status_event_t e, int reason);
- int control_event_bandwidth_used(uint32_t n_read, uint32_t n_written);
- int control_event_stream_bandwidth(edge_connection_t *edge_conn);
- int control_event_stream_bandwidth_used(void);
- void control_event_logmsg(int severity, uint32_t domain, const char *msg);
- int control_event_descriptors_changed(smartlist_t *routers);
- int control_event_address_mapped(const char *from, const char *to,
- time_t expires, const char *error,
- const int cached);
- int control_event_or_authdir_new_descriptor(const char *action,
- const char *desc,
- size_t desclen,
- const char *msg);
- int control_event_my_descriptor_changed(void);
- int control_event_networkstatus_changed(smartlist_t *statuses);
- int control_event_newconsensus(const networkstatus_t *consensus);
- int control_event_networkstatus_changed_single(const routerstatus_t *rs);
- int control_event_general_status(int severity, const char *format, ...)
- CHECK_PRINTF(2,3);
- int control_event_client_status(int severity, const char *format, ...)
- CHECK_PRINTF(2,3);
- int control_event_server_status(int severity, const char *format, ...)
- CHECK_PRINTF(2,3);
- int control_event_guard(const char *nickname, const char *digest,
- const char *status);
- int control_event_conf_changed(const smartlist_t *elements);
- int control_event_buildtimeout_set(buildtimeout_set_event_t type,
- const char *args);
- int control_event_signal(uintptr_t signal);
- int init_control_cookie_authentication(int enabled);
- smartlist_t *decode_hashed_passwords(config_line_t *passwords);
- void disable_control_logging(void);
- void enable_control_logging(void);
- void monitor_owning_controller_process(const char *process_spec);
- void control_event_bootstrap(bootstrap_status_t status, int progress);
- MOCK_DECL(void, control_event_bootstrap_problem,(const char *warn,
- int reason));
- void control_event_clients_seen(const char *controller_str);
- void control_event_transport_launched(const char *mode,
- const char *transport_name,
- tor_addr_t *addr, uint16_t port);
- void control_free_all(void);
- #ifdef CONTROL_PRIVATE
- /* Recognized asynchronous event types. It's okay to expand this list
- * because it is used both as a list of v0 event types, and as indices
- * into the bitfield to determine which controllers want which events.
- */
- #define EVENT_MIN_ 0x0001
- #define EVENT_CIRCUIT_STATUS 0x0001
- #define EVENT_STREAM_STATUS 0x0002
- #define EVENT_OR_CONN_STATUS 0x0003
- #define EVENT_BANDWIDTH_USED 0x0004
- #define EVENT_CIRCUIT_STATUS_MINOR 0x0005
- #define EVENT_NEW_DESC 0x0006
- #define EVENT_DEBUG_MSG 0x0007
- #define EVENT_INFO_MSG 0x0008
- #define EVENT_NOTICE_MSG 0x0009
- #define EVENT_WARN_MSG 0x000A
- #define EVENT_ERR_MSG 0x000B
- #define EVENT_ADDRMAP 0x000C
- /* Exposed above */
- // #define EVENT_AUTHDIR_NEWDESCS 0x000D
- #define EVENT_DESCCHANGED 0x000E
- /* Exposed above */
- // #define EVENT_NS 0x000F
- #define EVENT_STATUS_CLIENT 0x0010
- #define EVENT_STATUS_SERVER 0x0011
- #define EVENT_STATUS_GENERAL 0x0012
- #define EVENT_GUARD 0x0013
- #define EVENT_STREAM_BANDWIDTH_USED 0x0014
- #define EVENT_CLIENTS_SEEN 0x0015
- #define EVENT_NEWCONSENSUS 0x0016
- #define EVENT_BUILDTIMEOUT_SET 0x0017
- #define EVENT_SIGNAL 0x0018
- #define EVENT_CONF_CHANGED 0x0019
- #define EVENT_TRANSPORT_LAUNCHED 0x0020
- #define EVENT_MAX_ 0x0020
- /* If EVENT_MAX_ ever hits 0x0040, we need to make the mask into a
- * different structure. */
- /* Used only by control.c and test.c */
- STATIC size_t write_escaped_data(const char *data, size_t len, char **out);
- STATIC size_t read_escaped_data(const char *data, size_t len, char **out);
- /** Flag for event_format_t. Indicates that we should use the one standard
- format. (Other formats previous existed, and are now deprecated)
- */
- #define ALL_FORMATS 1
- /** Bit field of flags to select how to format a controller event. Recognized
- * flag is ALL_FORMATS. */
- typedef int event_format_t;
- #ifdef TOR_UNIT_TESTS
- MOCK_DECL(STATIC void,
- send_control_event_string,(uint16_t event, event_format_t which,
- const char *msg));
- void control_testing_set_global_event_mask(uint64_t mask);
- #endif
- #endif
- #endif
|