server.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-or-later */
 
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
 *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
 *   Copyright (C) 2008 by Spencer Oliver                                  *
 *   spen@spen-soft.co.uk                                                  *
 ***************************************************************************/
 
#ifndef OPENOCD_SERVER_SERVER_H
#define OPENOCD_SERVER_SERVER_H
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
#include <helper/log.h>
#include <helper/replacements.h>
 
#ifdef HAVE_NETINET_IN_H
#include <netinet/in.h>
#endif
 
enum connection_type {
    CONNECTION_TCP,
    CONNECTION_PIPE,
    CONNECTION_STDINOUT
};
 
#define CONNECTION_LIMIT_UNLIMITED      (-1)
 
struct connection {
    int fd;
    int fd_out; /* When using pipes we're writing to a different fd */
    struct sockaddr_in sin;
    struct command_context *cmd_ctx;
    struct service *service;
    bool input_pending;
    void *priv;
    struct connection *next;
};
 
struct service_driver {
    const char *name;
    int (*new_connection_during_keep_alive_handler)(struct connection *connection);
    int (*new_connection_handler)(struct connection *connection);
    int (*input_handler)(struct connection *connection);
    void (*service_dtor_handler)(struct service *service);
    COMMAND_HELPER((*service_info_handler), const struct service *service);
    int (*connection_closed_handler)(struct connection *connection);
    void (*keep_client_alive_handler)(struct connection *connection);
};
 
struct service {
    char *name;
    enum connection_type type;
    char *port;
    unsigned short portnumber;
    int fd;
    struct sockaddr_in sin;
    int max_connections;
    struct connection *connections;
    int (*new_connection_during_keep_alive)(struct connection *connection);
    int (*new_connection)(struct connection *connection);
    int (*input)(struct connection *connection);
    void (*service_dtor)(struct service *service);
    COMMAND_HELPER((*service_info), const struct service *service);
    int (*connection_closed)(struct connection *connection);
    void (*keep_client_alive)(struct connection *connection);
    void *priv;
    struct service *next;
};
 
int add_service(const struct service_driver *driver, const char *port,
        int max_connections, void *priv);
int remove_service(const char *name, const char *port);
 
int server_host_os_entry(void);
int server_host_os_close(void);
 
int server_preinit(void);
int server_init(struct command_context *cmd_ctx);
void server_quit(void);
void server_free(void);
int exit_on_signal(int sig);
 
void server_keep_clients_alive(void);
 
void server_loop(struct command_context *command_context);
bool server_terminated_by_signal(void);
int server_get_last_signal_number(void);
uint8_t server_get_exit_status_code(void);
 
int server_register_commands(struct command_context *context);
 
int connection_write(struct connection *connection, const void *data, int len);
int connection_read(struct connection *connection, void *data, int len);
 
bool openocd_is_shutdown_pending(void);
 
COMMAND_HELPER(server_pipe_command, char **out);
 
COMMAND_HELPER(server_port_command, unsigned short *out);
 
#define ERROR_SERVER_REMOTE_CLOSED      (-400)
#define ERROR_CONNECTION_REJECTED       (-401)
#define ERROR_SERVER_INTERRUPTED        (-402)
 
#endif /* OPENOCD_SERVER_SERVER_H */