From a1efd65746cb0c464fac987e076ec3632e632445 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Fri, 1 Nov 2019 20:37:22 +0100 Subject: server: implement a --server mode In this mode, foot listens on a UNIX socket and creates terminal windows when clients connect. A connecting client sends argc/argv to the server, and the server instantiates a new terminal window. When the terminal window is closed, the exit code is sent back to the client. --- server.c | 310 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 310 insertions(+) create mode 100644 server.c (limited to 'server.c') diff --git a/server.c b/server.c new file mode 100644 index 00000000..ae6d678e --- /dev/null +++ b/server.c @@ -0,0 +1,310 @@ +#include "server.h" + +#include + +#include +#include +#include +#include + +#include + +#define LOG_MODULE "server" +#define LOG_ENABLE_DBG 1 +#include "log.h" +#include "terminal.h" +#include "tllist.h" + +struct client; +struct server { + const struct config *conf; + struct fdm *fdm; + struct wayland *wayl; + + int fd; + char *sock_path; + + tll(struct client *) clients; +}; + +struct client { + struct server *server; + int fd; + + struct terminal *term; + int argc; + char **argv; +}; + +static void +client_destroy(struct client *client) +{ + if (client == NULL) + return; + + if (client->term != NULL) { + LOG_WARN("client FD=%d: terminal still alive", client->fd); + term_destroy(client->term); + } + + if (client->argv != NULL) { + for (int i = 0; i < client->argc; i++) + free(client->argv[i]); + free(client->argv); + } + + if (client->fd != -1) { + LOG_DBG("client FD=%d: disconnected", client->fd); + fdm_del(client->server->fdm, client->fd); + } + + tll_foreach(client->server->clients, it) { + if (it->item == client) { + tll_remove(client->server->clients, it); + break; + } + } + + free(client); +} + +static void +client_send_exit_code(struct client *client, int exit_code) +{ + if (client->fd == -1) + return; + + if (write(client->fd, &exit_code, sizeof(exit_code)) != sizeof(exit_code)) + LOG_ERRNO("failed to write slave exit code to client"); +} + +static void +term_shutdown_handler(void *data, int exit_code) +{ + struct client *client = data; + + client_send_exit_code(client, exit_code); + + client->term = NULL; + client_destroy(client); +} + +static bool +fdm_client(struct fdm *fdm, int fd, int events, void *data) +{ + struct client *client = data; + struct server *server = client->server; + + if (events & EPOLLHUP) + goto shutdown; + + assert(events & EPOLLIN); + + if (recv(fd, &client->argc, sizeof(client->argc), 0) != sizeof(client->argc)) + goto shutdown; + + client->argv = calloc(client->argc + 1, sizeof(client->argv[0])); + for (int i = 0; i < client->argc; i++) { + uint16_t len; + if (recv(fd, &len, sizeof(len), 0) != sizeof(len)) + goto shutdown; + + client->argv[i] = malloc(len + 1); + client->argv[i][len] = '\0'; + if (recv(fd, client->argv[i], len, 0) != len) + goto shutdown; + } + + assert(client->term == NULL); + client->term = term_init( + server->conf, server->fdm, server->wayl, client->argc, client->argv, + &term_shutdown_handler, client); + + if (client->term == NULL) { + LOG_ERR("failed to instantiate new terminal"); + goto shutdown; + } + + return true; + +shutdown: + LOG_DBG("client FD=%d: disconnected", client->fd); + + fdm_del(fdm, fd); + client->fd = -1; + + if (client->term != NULL && !client->term->is_shutting_down) + term_shutdown(client->term); + else + client_destroy(client); + + return true; +} + +static bool +fdm_server(struct fdm *fdm, int fd, int events, void *data) +{ + if (events & EPOLLHUP) + return false; + + struct server *server = data; + + struct sockaddr_un addr; + socklen_t addr_size = sizeof(addr); + int client_fd = accept4( + server->fd, (struct sockaddr *)&addr, &addr_size, SOCK_CLOEXEC); + + if (client_fd == -1) { + LOG_ERRNO("failed to accept client connection"); + return false; + } + + struct client *client = malloc(sizeof(*client)); + *client = (struct client) { + .server = server, + .fd = client_fd, + }; + + if (!fdm_add(server->fdm, client_fd, EPOLLIN, &fdm_client, client)) { + LOG_ERR("client FD=%d: failed to add client to FDM", client_fd); + close(client_fd); + free(client); + return false; + } + + LOG_DBG("client FD=%d: connected", client_fd); + tll_push_back(server->clients, client); + return true; +} + +static char * +get_socket_path(void) +{ + const char *xdg_runtime = getenv("XDG_RUNTIME_DIR"); + if (xdg_runtime == NULL) + return strdup("/tmp/foot.sock"); + + char *path = malloc(strlen(xdg_runtime) + 1 + strlen("foot.sock") + 1); + sprintf(path, "%s/foot.sock", xdg_runtime); + return path; +} + +enum connect_status {CONNECT_ERR, CONNECT_FAIL, CONNECT_SUCCESS}; + +static enum connect_status +try_connect(const char *sock_path) +{ + enum connect_status ret = CONNECT_ERR; + + int fd = socket(AF_UNIX, SOCK_STREAM, 0); + if (fd == -1) { + LOG_ERRNO("failed to create UNIX socket"); + goto err; + } + + struct sockaddr_un addr = {.sun_family = AF_UNIX}; + strncpy(addr.sun_path, sock_path, sizeof(addr.sun_path) - 1); + + ret = connect(fd, (const struct sockaddr *)&addr, sizeof(addr)) < 0 + ? CONNECT_FAIL : CONNECT_SUCCESS; + +err: + if (fd != -1) + close(fd); + return ret; +} + +struct server * +server_init(const struct config *conf, struct fdm *fdm, struct wayland *wayl) +{ + int fd = socket(AF_UNIX, SOCK_STREAM, 0); + if (fd == -1) { + LOG_ERRNO("failed to create UNIX socket"); + return NULL; + } + + struct server *server = NULL; + char *sock_path = NULL; + + if ((sock_path = get_socket_path()) == NULL) + goto err; + + switch (try_connect(sock_path)) { + case CONNECT_FAIL: + break; + + case CONNECT_SUCCESS: + LOG_ERR("foot --server already running"); + /* FALLTHROUGH */ + + case CONNECT_ERR: + goto err; + } + + unlink(sock_path); + + if (fcntl(fd, F_SETFL, fcntl(fd, F_GETFL) | FD_CLOEXEC) < 0) { + LOG_ERRNO("failed to set FD_CLOEXEC on socket"); + goto err; + } + + struct sockaddr_un addr = {.sun_family = AF_UNIX}; + strncpy(addr.sun_path, sock_path, sizeof(addr.sun_path) - 1); + + if (bind(fd, (const struct sockaddr *)&addr, sizeof(addr)) < 0) { + LOG_ERRNO("%s: failed to bind", addr.sun_path); + goto err; + } + + if (listen(fd, 0) < 0) { + LOG_ERRNO("%s: failed to listen", addr.sun_path); + goto err; + } + + server = malloc(sizeof(*server)); + *server = (struct server) { + .conf = conf, + .fdm = fdm, + .wayl = wayl, + + .fd = fd, + .sock_path = sock_path, + + .clients = tll_init(), + }; + + if (!fdm_add(fdm, fd, EPOLLIN, &fdm_server, server)) { + LOG_ERR("failed to add server FD to the FDM"); + goto err; + } + + return server; + +err: + free(server); + free(sock_path); + if (fd != -1) + close(fd); + return NULL; +} + +void +server_destroy(struct server *server) +{ + if (server == NULL) + return; + + LOG_DBG("server destroy, %zu clients still alive", + tll_length(server->clients)); + + tll_foreach(server->clients, it) { + client_send_exit_code(it->item, 1); + client_destroy(it->item); + } + + tll_free(server->clients); + + fdm_del(server->fdm, server->fd); + free(server->sock_path); + free(server); +} -- cgit v1.3 From 0bd2ddd8ad60a77e27cdb459da8e319647fd6f59 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Fri, 1 Nov 2019 21:03:08 +0100 Subject: term_init(): initialize slave TERM from term_init() argument --- main.c | 2 +- server.c | 4 ++-- terminal.c | 4 ++-- terminal.h | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) (limited to 'server.c') diff --git a/main.c b/main.c index c1abe5bc..26a8f300 100644 --- a/main.c +++ b/main.c @@ -174,7 +174,7 @@ main(int argc, char *const *argv) if ((wayl = wayl_init(fdm)) == NULL) goto out; - if (!as_server && (term = term_init(&conf, fdm, wayl, argc, argv, + if (!as_server && (term = term_init(&conf, fdm, wayl, conf.term, argc, argv, &term_shutdown_cb, &shutdown_ctx)) == NULL) goto out; diff --git a/server.c b/server.c index ae6d678e..f48ed262 100644 --- a/server.c +++ b/server.c @@ -117,8 +117,8 @@ fdm_client(struct fdm *fdm, int fd, int events, void *data) assert(client->term == NULL); client->term = term_init( - server->conf, server->fdm, server->wayl, client->argc, client->argv, - &term_shutdown_handler, client); + server->conf, server->fdm, server->wayl, server->conf->term, + client->argc, client->argv, &term_shutdown_handler, client); if (client->term == NULL) { LOG_ERR("failed to instantiate new terminal"); diff --git a/terminal.c b/terminal.c index d6aaf4ff..f71d90a6 100644 --- a/terminal.c +++ b/terminal.c @@ -289,7 +289,7 @@ initialize_fonts(struct terminal *term, const struct config *conf) struct terminal * term_init(const struct config *conf, struct fdm *fdm, struct wayland *wayl, - int argc, char *const *argv, + const char *term_env, int argc, char *const *argv, void (*shutdown_cb)(void *data, int exit_code), void *shutdown_data) { int ptmx = -1; @@ -428,7 +428,7 @@ term_init(const struct config *conf, struct fdm *fdm, struct wayland *wayl, LOG_INFO("cell width=%d, height=%d", term->cell_width, term->cell_height); /* Start the slave/client */ - if ((term->slave = slave_spawn(term->ptmx, argc, argv, conf->term, conf->shell)) == -1) + if ((term->slave = slave_spawn(term->ptmx, argc, argv, term_env, conf->shell)) == -1) goto err; /* Initiailze the Wayland window backend */ diff --git a/terminal.h b/terminal.h index 3ec2802c..11571519 100644 --- a/terminal.h +++ b/terminal.h @@ -296,7 +296,7 @@ struct terminal { struct config; struct terminal *term_init( const struct config *conf, struct fdm *fdm, struct wayland *wayl, - int argc, char *const *argv, + const char *term_env, int argc, char *const *argv, void (*shutdown_cb)(void *data, int exit_code), void *shutdown_data); bool term_shutdown(struct terminal *term); -- cgit v1.3 From 438d6eaff0b4280492c8a0a161a33daec5de3707 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Fri, 1 Nov 2019 21:10:47 +0100 Subject: client/server: add -t,--term to footclient --- client.c | 20 ++++++++++++++++++-- completions/zsh/_footclient | 7 +++++++ server.c | 16 +++++++++++++++- 3 files changed, 40 insertions(+), 3 deletions(-) (limited to 'server.c') diff --git a/client.c b/client.c index 25dcbd27..bac72838 100644 --- a/client.c +++ b/client.c @@ -30,7 +30,8 @@ print_usage(const char *prog_name) printf("Usage: %s [OPTIONS]...\n", prog_name); printf("\n"); printf("Options:\n"); - printf(" -v,--version show the version number and quit\n"); + printf(" -t,--term=TERM value to set the environment variable TERM to (foot)\n" + " -v,--version show the version number and quit\n"); } int @@ -41,17 +42,24 @@ main(int argc, char *const *argv) const char *const prog_name = argv[0]; static const struct option longopts[] = { + {"term", required_argument, 0, 't'}, {"version", no_argument, 0, 'v'}, {"help", no_argument, 0, 'h'}, {NULL, no_argument, 0, 0}, }; + const char *term = ""; + while (true) { - int c = getopt_long(argc, argv, ":hv", longopts, NULL); + int c = getopt_long(argc, argv, ":t:hv", longopts, NULL); if (c == -1) break; switch (c) { + case 't': + term = optarg; + break; + case 'v': printf("footclient version %s\n", FOOT_VERSION); return EXIT_SUCCESS; @@ -98,6 +106,14 @@ main(int argc, char *const *argv) } } + uint16_t term_len = strlen(term); + if (send(fd, &term_len, sizeof(term_len), 0) != sizeof(term_len) || + send(fd, term, term_len, 0) != term_len) + { + LOG_ERRNO("failed to send TERM to server"); + goto err; + } + if (send(fd, &argc, sizeof(argc), 0) != sizeof(argc)) { LOG_ERRNO("failed to send argc/argv to server"); goto err; diff --git a/completions/zsh/_footclient b/completions/zsh/_footclient index 6ab98fd0..47a050cb 100644 --- a/completions/zsh/_footclient +++ b/completions/zsh/_footclient @@ -2,5 +2,12 @@ _arguments \ -s \ + '(-t,--term)'{-t,--term}'[value to set the environment variable TERM to (foot)]:term:->terms' \ '(-v --version)'{-v,--version}'[show the version number and quit]' \ '(-h --help)'{-h,--help}'[show help message and quit]' + +case ${state} in + terms) + _values 'terminal definitions' $(find /usr/share/terminfo -type f -printf "%f\n") + ;; +esac diff --git a/server.c b/server.c index f48ed262..6307b1bf 100644 --- a/server.c +++ b/server.c @@ -94,12 +94,22 @@ fdm_client(struct fdm *fdm, int fd, int events, void *data) { struct client *client = data; struct server *server = client->server; + char *term_env = NULL; if (events & EPOLLHUP) goto shutdown; assert(events & EPOLLIN); + uint16_t term_env_len; + if (recv(fd, &term_env_len, sizeof(term_env_len), 0) != sizeof(term_env_len)) + goto shutdown; + + term_env = malloc(term_env_len + 1); + term_env[term_env_len] = '\0'; + if (recv(fd, term_env, term_env_len, 0) != term_env_len) + goto shutdown; + if (recv(fd, &client->argc, sizeof(client->argc), 0) != sizeof(client->argc)) goto shutdown; @@ -117,7 +127,8 @@ fdm_client(struct fdm *fdm, int fd, int events, void *data) assert(client->term == NULL); client->term = term_init( - server->conf, server->fdm, server->wayl, server->conf->term, + server->conf, server->fdm, server->wayl, + term_env_len > 0 ? term_env : server->conf->term, client->argc, client->argv, &term_shutdown_handler, client); if (client->term == NULL) { @@ -125,11 +136,14 @@ fdm_client(struct fdm *fdm, int fd, int events, void *data) goto shutdown; } + free(term_env); return true; shutdown: LOG_DBG("client FD=%d: disconnected", client->fd); + free(term_env); + fdm_del(fdm, fd); client->fd = -1; -- cgit v1.3