Include dependency graph for server.c:

Enumerations
enum	shutdown_reason { CONTINUE_MAIN_LOOP , SHUTDOWN_REQUESTED , SHUTDOWN_WITH_ERROR_CODE , SHUTDOWN_WITH_SIGNAL_CODE }

Functions
static int	add_connection (struct service service, struct command_context cmd_ctx)

int	add_service (const struct service_driver driver, const char port, int max_connections, void *priv)

	COMMAND_HANDLER (handle_bindto_command)

	COMMAND_HANDLER (handle_poll_period_command)

	COMMAND_HANDLER (handle_shutdown_command)

	COMMAND_HELPER (server_pipe_command, char **out)
	Defines an extended command handler function declaration to enable access to (and manipulation of) the server port number. More...

	COMMAND_HELPER (server_port_command, unsigned short *out)

int	connection_read (struct connection connection, void data, int len)

int	connection_write (struct connection connection, const void data, int len)

void	exit_on_signal (int sig)

static void	free_service (struct service *c)

bool	openocd_is_shutdown_pending (void)

static int	remove_connection (struct service service, struct connection connection)

static void	remove_connections (struct service *service)

int	remove_service (const char name, const char port)

static int	remove_services (void)

void	server_free (void)

int	server_host_os_close (void)

int	server_host_os_entry (void)

int	server_init (struct command_context *cmd_ctx)

void	server_keep_clients_alive (void)

int	server_loop (struct command_context *command_context)

int	server_preinit (void)

int	server_quit (void)

int	server_register_commands (struct command_context *cmd_ctx)

static void	sig_handler (int sig)

static void	sigkey_handler (int sig)

Variables
static char *	bindto_name

static int	last_signal

static int	polling_period = 100

static const struct command_registration	server_command_handlers []

static struct service *	services

static enum shutdown_reason	shutdown_openocd = CONTINUE_MAIN_LOOP

Enumeration Type Documentation

◆ shutdown_reason

enum shutdown_reason

Enumerator
CONTINUE_MAIN_LOOP
SHUTDOWN_REQUESTED
SHUTDOWN_WITH_ERROR_CODE
SHUTDOWN_WITH_SIGNAL_CODE

Definition at line 40 of file server.c.

Function Documentation

◆ add_connection()

static int add_connection	(	struct service *	service,
		struct command_context *	cmd_ctx
	)

static

Definition at line 57 of file server.c.

References alloc_printf(), close_socket(), connection::cmd_ctx, command_done(), CONNECTION_LIMIT_UNLIMITED, CONNECTION_PIPE, CONNECTION_STDINOUT, CONNECTION_TCP, service::connections, copy_command_context(), ERROR_FAIL, ERROR_OK, connection::fd, service::fd, connection::fd_out, flag, connection::input_pending, LOG_ERROR, LOG_INFO, service::max_connections, service::name, service::new_connection, connection::next, NULL, service::port, connection::priv, connection::service, connection::sin, service::sin, and service::type.

Referenced by server_loop().

◆ add_service()

int add_service	(	const struct service_driver *	driver,
		const char *	port,
		int	max_connections,
		void *	priv
	)

Definition at line 198 of file server.c.

References bindto_name, close_socket(), service::connection_closed, service_driver::connection_closed_handler, CONNECTION_PIPE, CONNECTION_STDINOUT, CONNECTION_TCP, service::connections, ERROR_FAIL, ERROR_OK, service::fd, free_service(), service::input, service_driver::input_handler, service::keep_client_alive, service_driver::keep_client_alive_handler, LOG_ERROR, LOG_INFO, LOG_WARNING, service::max_connections, service_driver::name, service::name, service::new_connection, service::new_connection_during_keep_alive, service_driver::new_connection_during_keep_alive_handler, service_driver::new_connection_handler, service::next, NULL, parse_long(), service::port, service::portnumber, priv, service::priv, services, service::sin, socket_nonblock(), and service::type.

Referenced by COMMAND_HANDLER(), gdb_target_start(), ipdbg_start(), jsp_init(), tcl_init(), and telnet_init().

◆ COMMAND_HANDLER() [1/3]

COMMAND_HANDLER ( handle_bindto_command )

Definition at line 788 of file server.c.

References bindto_name, CMD, CMD_ARGC, CMD_ARGV, command_print(), ERROR_COMMAND_SYNTAX_ERROR, and ERROR_OK.

◆ COMMAND_HANDLER() [2/3]

COMMAND_HANDLER ( handle_poll_period_command )

Definition at line 776 of file server.c.

References CMD_ARGC, CMD_ARGV, COMMAND_PARSE_NUMBER, ERROR_OK, LOG_INFO, LOG_WARNING, and polling_period.

◆ COMMAND_HANDLER() [3/3]

COMMAND_HANDLER ( handle_shutdown_command )

Definition at line 758 of file server.c.

References CMD_ARGC, CMD_ARGV, CMD_CTX, command_run_line(), ERROR_COMMAND_CLOSE_CONNECTION, ERROR_FAIL, LOG_USER, shutdown_openocd, SHUTDOWN_REQUESTED, and SHUTDOWN_WITH_ERROR_CODE.

◆ COMMAND_HELPER() [1/2]

COMMAND_HELPER	(	server_pipe_command	,
		char **	out
	)

Defines an extended command handler function declaration to enable access to (and manipulation of) the server port number.

Call server_port like a normal COMMAND_HANDLER with an extra out parameter to receive the specified port number.

Definition at line 866 of file server.c.

References CMD, CMD_ARGC, CMD_ARGV, CMD_CTX, COMMAND_EXEC, command_print(), ERROR_COMMAND_ARGUMENT_INVALID, ERROR_COMMAND_SYNTAX_ERROR, ERROR_OK, and LOG_WARNING.

◆ COMMAND_HELPER() [2/2]

COMMAND_HELPER	(	server_port_command	,
		unsigned short *	out
	)

Definition at line 847 of file server.c.

References CMD, CMD_ARGC, CMD_ARGV, COMMAND_PARSE_NUMBER, command_print(), ERROR_COMMAND_SYNTAX_ERROR, and ERROR_OK.

◆ connection_read()

int connection_read	(	struct connection *	connection,
		void *	data,
		int	len
	)

Definition at line 744 of file server.c.

References CONNECTION_TCP, connection::fd, read_socket(), connection::service, and service::type.

Referenced by arm_tpiu_swo_service_input(), ipdbg_on_connection_input(), jsp_input(), rtt_input(), semihosting_redirect_read(), semihosting_service_input_handler(), tcl_input(), and telnet_input().

◆ connection_write()

int connection_write	(	struct connection *	connection,
		const void *	data,
		int	len
	)

Definition at line 732 of file server.c.

References CONNECTION_TCP, connection::fd_out, connection::service, service::type, and write_socket().

Referenced by arm_tpiu_swo_poll_trace(), gdb_write(), ipdbg_move_buffer_to_connection(), read_callback(), rtt_new_connection(), semihosting_redirect_write(), tcl_output(), and telnet_write().

◆ exit_on_signal()

void exit_on_signal ( int sig )

Definition at line 723 of file server.c.

Referenced by openocd_main().

◆ free_service()

static void free_service ( struct service * c )

static

Definition at line 191 of file server.c.

References service::name, and service::port.

Referenced by add_service(), and remove_service().

◆ openocd_is_shutdown_pending()

bool openocd_is_shutdown_pending ( void )

Definition at line 752 of file server.c.

References CONTINUE_MAIN_LOOP, and shutdown_openocd.

Referenced by COMMAND_HELPER(), esp32_apptrace_wait4halt(), esp32_cmd_apptrace_generic(), image_calculate_checksum(), target_fill_mem(), target_run_read_async_algorithm(), and target_wait_state().

◆ remove_connection()

static int remove_connection	(	struct service *	service,
		struct connection *	connection
	)

static

Definition at line 156 of file server.c.

References close_socket(), connection::cmd_ctx, command_done(), service::connection_closed, CONNECTION_LIMIT_UNLIMITED, CONNECTION_PIPE, CONNECTION_TCP, service::connections, ERROR_OK, connection::fd, service::fd, service::max_connections, connection::next, connection::service, and service::type.

Referenced by remove_connections(), and server_loop().

◆ remove_connections()

static void remove_connections ( struct service * service )

static

Definition at line 340 of file server.c.

References service::connections, connection::next, and remove_connection().

Referenced by remove_service(), and remove_services().

◆ remove_service()

int remove_service	(	const char *	name,
		const char *	port
	)

Definition at line 355 of file server.c.

References close_socket(), CONNECTION_STDINOUT, ERROR_OK, service::fd, free_service(), service::name, name, service::next, service::port, service::priv, remove_connections(), services, and service::type.

Referenced by arm_tpiu_swo_close_output(), COMMAND_HANDLER(), and ipdbg_stop_service().

◆ remove_services()

static int remove_services ( void )

static

Definition at line 384 of file server.c.

References CONNECTION_PIPE, ERROR_OK, service::fd, service::name, service::next, NULL, service::port, service::priv, remove_connections(), services, and service::type.

Referenced by server_init(), and server_quit().

◆ server_free()

void server_free ( void )

Definition at line 713 of file server.c.

References bindto_name, ipdbg_server_free(), jsp_service_free(), tcl_service_free(), and telnet_service_free().

Referenced by openocd_main().

◆ server_host_os_close()

int server_host_os_close ( void )

Definition at line 653 of file server.c.

References ERROR_OK.

Referenced by openocd_main().

◆ server_host_os_entry()

int server_host_os_entry ( void )

Definition at line 633 of file server.c.

References ERROR_FAIL, ERROR_OK, LOG_ERROR, and WORD.

Referenced by openocd_main().

◆ server_init()

int server_init ( struct command_context * cmd_ctx )

Definition at line 681 of file server.c.

References ERROR_OK, remove_services(), tcl_init(), and telnet_init().

Referenced by openocd_thread().

◆ server_keep_clients_alive()

void server_keep_clients_alive ( void )

Definition at line 414 of file server.c.

References connection::next, service::next, and services.

Referenced by keep_alive().

◆ server_loop()

int server_loop ( struct command_context * command_context )

◆ server_preinit()

int server_preinit ( void )

Definition at line 661 of file server.c.

References ERROR_OK, sig_handler(), and sigkey_handler().

Referenced by openocd_thread().

◆ server_quit()

int server_quit ( void )

Definition at line 698 of file server.c.

References ERROR_OK, last_signal, remove_services(), and target_quit().

Referenced by openocd_thread().

◆ server_register_commands()

int server_register_commands ( struct command_context * cmd_ctx )

Definition at line 830 of file server.c.

References ERROR_OK, jsp_register_commands(), NULL, register_commands(), server_command_handlers, tcl_register_commands(), and telnet_register_commands().

Referenced by setup_command_handler().

◆ sig_handler()

static void sig_handler ( int sig )

static

Definition at line 602 of file server.c.

References CONTINUE_MAIN_LOOP, last_signal, LOG_DEBUG, shutdown_openocd, and SHUTDOWN_WITH_SIGNAL_CODE.

Referenced by server_preinit(), and sigkey_handler().

◆ sigkey_handler()

static void sigkey_handler ( int sig )

static

Definition at line 621 of file server.c.

References LOG_DEBUG, and sig_handler().

Referenced by server_preinit().

Variable Documentation

◆ bindto_name

char* bindto_name

static

Definition at line 55 of file server.c.

Referenced by add_service(), COMMAND_HANDLER(), and server_free().

◆ last_signal

int last_signal

static

Definition at line 49 of file server.c.

Referenced by openocd_thread(), server_quit(), and sig_handler().

◆ polling_period

int polling_period = 100

static

Definition at line 52 of file server.c.

Referenced by COMMAND_HANDLER(), and server_loop().

◆ server_command_handlers

const struct command_registration server_command_handlers[]

static

Initial value:

= {
    {
        .name = "shutdown",
        .handler = &handle_shutdown_command,
        .mode = COMMAND_ANY,
        .usage = "",
        .help = "shut the server down",
    },
    {
        .name = "poll_period",
        .handler = &handle_poll_period_command,
        .mode = COMMAND_ANY,
        .usage = "",
        .help = "set the servers polling period",
    },
    {
        .name = "bindto",
        .handler = &handle_bindto_command,
        .mode = COMMAND_CONFIG,
        .usage = "[name]",
        .help = "Specify address by name on which to listen for "
            "incoming TCP/IP connections",
    },
    COMMAND_REGISTRATION_DONE
}

Definition at line 788 of file server.c.

Referenced by server_register_commands().

◆ services

struct service* services

static

Definition at line 38 of file server.c.

Referenced by add_service(), remove_service(), remove_services(), server_keep_clients_alive(), and server_loop().

◆ shutdown_openocd

enum shutdown_reason shutdown_openocd = CONTINUE_MAIN_LOOP

static

Definition at line 38 of file server.c.

Referenced by COMMAND_HANDLER(), openocd_is_shutdown_pending(), server_loop(), and sig_handler().

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ shutdown_reason

Function Documentation

◆ add_connection()

◆ add_service()

◆ COMMAND_HANDLER() [1/3]

◆ COMMAND_HANDLER() [2/3]

◆ COMMAND_HANDLER() [3/3]

◆ COMMAND_HELPER() [1/2]

◆ COMMAND_HELPER() [2/2]

◆ connection_read()

◆ connection_write()

◆ exit_on_signal()

◆ free_service()

◆ openocd_is_shutdown_pending()

◆ remove_connection()

◆ remove_connections()

◆ remove_service()

◆ remove_services()

◆ server_free()

◆ server_host_os_close()

◆ server_host_os_entry()

◆ server_init()

◆ server_keep_clients_alive()

◆ server_loop()

◆ server_preinit()

◆ server_quit()

◆ server_register_commands()

◆ sig_handler()

◆ sigkey_handler()

Variable Documentation

◆ bindto_name

◆ last_signal

◆ polling_period

◆ server_command_handlers

◆ services

◆ shutdown_openocd