OpenOCD
Enumerations | Functions | Variables
server.c File Reference
Include dependency graph for server.c:

Go to the source code of this file.

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_exit_command)
 
 COMMAND_HANDLER (handle_poll_period_command)
 
 COMMAND_HANDLER (handle_services_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)
 
int 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)
 
uint8_t server_get_exit_status_code (void)
 
int server_get_last_signal_number (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)
 
void server_loop (struct command_context *command_context)
 
int server_preinit (void)
 
void server_quit (void)
 
int server_register_commands (struct command_context *cmd_ctx)
 
bool server_terminated_by_signal (void)
 
static void sig_handler (int sig)
 
static void sigkey_handler (int sig)
 

Variables

static char * bindto_name
 
static volatile sig_atomic_t last_signal
 
static uint8_t openocd_exit_status_code
 
static int polling_period = 100
 
static const struct command_registration server_command_handlers []
 
static struct service * services
 
static volatile sig_atomic_t 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 39 of file server.c.

Function Documentation

◆ add_connection()

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

Definition at line 62 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 211 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, 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, service::service_dtor, service_driver::service_dtor_handler, 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/5]

COMMAND_HANDLER ( handle_bindto_command  )

Definition at line 862 of file server.c.

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

◆ COMMAND_HANDLER() [2/5]

COMMAND_HANDLER ( handle_exit_command  )

Definition at line 833 of file server.c.

References CMD_ARGC, CMD_CTX, command_run_line(), ERROR_COMMAND_CLOSE_CONNECTION, ERROR_COMMAND_SYNTAX_ERROR, LOG_WARNING, tcl_is_from_tcl_session(), and telnet_is_from_telnet_session().

◆ COMMAND_HANDLER() [3/5]

COMMAND_HANDLER ( handle_poll_period_command  )

Definition at line 850 of file server.c.

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

◆ COMMAND_HANDLER() [4/5]

COMMAND_HANDLER ( handle_services_command  )

Definition at line 878 of file server.c.

References CALL_COMMAND_HANDLER, CMD, CMD_ARGC, CMD_CTX, command_print(), CONNECTION_TCP, ERROR_COMMAND_SYNTAX_ERROR, ERROR_FAIL, ERROR_OK, service::next, services, and tcl_escape_alloc().

◆ COMMAND_HANDLER() [5/5]

COMMAND_HANDLER ( handle_shutdown_command  )

Definition at line 798 of file server.c.

References CMD_ARGC, CMD_ARGV, CMD_CTX, COMMAND_PARSE_NUMBER, command_run_line(), ERROR_COMMAND_CLOSE_CONNECTION, ERROR_COMMAND_SYNTAX_ERROR, LOG_USER, openocd_exit_status_code, shutdown_openocd, SHUTDOWN_REQUESTED, SHUTDOWN_WITH_ERROR_CODE, and SHUTDOWN_WITH_SIGNAL_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 999 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 980 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 784 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 772 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()

int exit_on_signal ( int  sig)

Definition at line 759 of file server.c.

Referenced by openocd_main().

◆ free_service()

static void free_service ( struct service *  c)
static

Definition at line 197 of file server.c.

References close_socket(), CONNECTION_PIPE, CONNECTION_TCP, service::fd, service::name, service::port, service::priv, service::service_dtor, and service::type.

Referenced by remove_service(), and remove_services().

◆ openocd_is_shutdown_pending()

bool openocd_is_shutdown_pending ( void  )

Definition at line 792 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 161 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 367 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 382 of file server.c.

References close_socket(), CONNECTION_STDINOUT, ERROR_OK, service::fd, free_service(), service::name, name, service::next, service::port, 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 410 of file server.c.

References ERROR_OK, free_service(), service::next, NULL, remove_connections(), and services.

Referenced by server_init(), and server_quit().

◆ server_free()

void server_free ( void  )

Definition at line 749 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_get_exit_status_code()

uint8_t server_get_exit_status_code ( void  )

Definition at line 637 of file server.c.

References openocd_exit_status_code, and server_terminated_by_signal().

Referenced by openocd_main().

◆ server_get_last_signal_number()

int server_get_last_signal_number ( void  )

Definition at line 628 of file server.c.

References last_signal, and server_terminated_by_signal().

Referenced by openocd_main().

◆ server_host_os_close()

int server_host_os_close ( void  )

Definition at line 694 of file server.c.

References ERROR_OK.

Referenced by openocd_main().

◆ server_host_os_entry()

int server_host_os_entry ( void  )

Definition at line 674 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 722 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 429 of file server.c.

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

Referenced by keep_alive().

◆ server_loop()

void server_loop ( struct command_context *  command_context)

Definition at line 437 of file server.c.

References add_connection(), close_socket(), command_run_line(), CONNECTION_PIPE, CONNECTION_STDINOUT, CONNECTION_TCP, service::connections, CONTINUE_MAIN_LOOP, ERROR_OK, connection::fd, service::fd, service::input, connection::input_pending, LOG_ERROR, LOG_INFO, service::max_connections, MSG, service::name, connection::next, service::next, NULL, OCD_FD_ISSET, OCD_FD_SET, openocd_exit_status_code, polling_period, process_jim_events(), remove_connection(), services, shutdown_openocd, SHUTDOWN_REQUESTED, SHUTDOWN_WITH_ERROR_CODE, SHUTDOWN_WITH_SIGNAL_CODE, service::sin, socket_select(), target_call_timer_callbacks(), target_got_message(), target_timer_next_event(), timeval_ms(), timeval::tv_sec, timeval::tv_usec, and service::type.

Referenced by openocd_thread().

◆ server_preinit()

int server_preinit ( void  )

Definition at line 702 of file server.c.

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

Referenced by openocd_thread().

◆ server_quit()

void server_quit ( void  )

Definition at line 739 of file server.c.

References remove_services(), and target_quit().

Referenced by openocd_thread().

◆ server_register_commands()

int server_register_commands ( struct command_context *  cmd_ctx)

Definition at line 963 of file server.c.

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

◆ server_terminated_by_signal()

bool server_terminated_by_signal ( void  )

Definition at line 623 of file server.c.

References shutdown_openocd, and SHUTDOWN_WITH_SIGNAL_CODE.

Referenced by openocd_main(), server_get_exit_status_code(), and server_get_last_signal_number().

◆ sig_handler()

static void sig_handler ( int  sig)
static

Definition at line 643 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 662 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 60 of file server.c.

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

◆ last_signal

volatile sig_atomic_t last_signal
static

Definition at line 51 of file server.c.

Referenced by server_get_last_signal_number(), and sig_handler().

◆ openocd_exit_status_code

uint8_t openocd_exit_status_code
static

Definition at line 54 of file server.c.

Referenced by COMMAND_HANDLER(), server_get_exit_status_code(), and server_loop().

◆ polling_period

int polling_period = 100
static

Definition at line 57 of file server.c.

Referenced by COMMAND_HANDLER(), and server_loop().

◆ server_command_handlers

const struct command_registration server_command_handlers[]
static

Definition at line 878 of file server.c.

Referenced by server_register_commands().

◆ services

struct service* services
static

Definition at line 46 of file server.c.

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

◆ shutdown_openocd

volatile sig_atomic_t shutdown_openocd = CONTINUE_MAIN_LOOP
static

Definition at line 48 of file server.c.

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