neovim/src/nvim/msgpack_rpc/server.c

#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include <stdint.h>

#include <uv.h>

#include "nvim/msgpack_rpc/channel.h"
#include "nvim/msgpack_rpc/server.h"
#include "nvim/os/os.h"
#include "nvim/ascii.h"
#include "nvim/eval.h"
#include "nvim/garray.h"
#include "nvim/vim.h"
#include "nvim/memory.h"
#include "nvim/log.h"
#include "nvim/tempfile.h"
#include "nvim/path.h"
#include "nvim/strings.h"

#define MAX_CONNECTIONS 32
#define ADDRESS_MAX_SIZE 256
#define NVIM_DEFAULT_TCP_PORT 7450
#define LISTEN_ADDRESS_ENV_VAR "NVIM_LISTEN_ADDRESS"

typedef enum {
  kServerTypeTcp,
  kServerTypePipe
} ServerType;

typedef struct {
  // Pipe/socket path, or TCP address string
  char addr[ADDRESS_MAX_SIZE];

  // Type of the union below
  ServerType type;

  // TCP server or unix socket (named pipe on Windows)
  union {
    struct {
      uv_tcp_t handle;
      struct sockaddr_in addr;
    } tcp;
    struct {
      uv_pipe_t handle;
    } pipe;
  } socket;
} Server;

static garray_T servers = GA_EMPTY_INIT_VALUE;

#ifdef INCLUDE_GENERATED_DECLARATIONS
# include "msgpack_rpc/server.c.generated.h"
#endif

/// Initializes the module
bool server_init(void)
{
  ga_init(&servers, sizeof(Server *), 1);

  bool must_free = false;
  const char *listen_address = os_getenv(LISTEN_ADDRESS_ENV_VAR);
  if (listen_address == NULL) {
    must_free = true;
    listen_address = (char *)vim_tempname();
  }

  bool ok = (server_start(listen_address) == 0);
  if (must_free) {
    xfree((char *) listen_address);
  }
  return ok;
}

/// Retrieve the file handle from a server.
static uv_handle_t *server_handle(Server *server)
{
  return server->type == kServerTypeTcp
    ? (uv_handle_t *)&server->socket.tcp.handle
    : (uv_handle_t *) &server->socket.pipe.handle;
}

/// Teardown a single server
static void server_close_cb(Server **server)
{
  uv_close(server_handle(*server), free_server);
}

/// Set v:servername to the first server in the server list, or unset it if no
/// servers are known.
static void set_vservername(garray_T *srvs)
{
  char *default_server = (srvs->ga_len > 0)
    ? ((Server **)srvs->ga_data)[0]->addr
    : NULL;
  set_vim_var_string(VV_SEND_SERVER, (char_u *)default_server, -1);
}

/// Teardown the server module
void server_teardown(void)
{
  GA_DEEP_CLEAR(&servers, Server *, server_close_cb);
}

/// Starts listening for API calls on the TCP address or pipe path `endpoint`.
/// The socket type is determined by parsing `endpoint`: If it's a valid IPv4
/// address in 'ip[:port]' format, then it will be TCP socket. The port is
/// optional and if omitted defaults to NVIM_DEFAULT_TCP_PORT. Otherwise it
/// will be a unix socket or named pipe.
///
/// @param endpoint Address of the server. Either a 'ip[:port]' string or an
///        arbitrary identifier (trimmed to 256 bytes) for the unix socket or
///        named pipe.
/// @returns 0 on success, 1 on a regular error, and negative errno
///          on failure to bind or connect.
int server_start(const char *endpoint)
  FUNC_ATTR_NONNULL_ALL
{
  char addr[ADDRESS_MAX_SIZE];

  // Trim to `ADDRESS_MAX_SIZE`
  if (xstrlcpy(addr, endpoint, sizeof(addr)) >= sizeof(addr)) {
    // TODO(aktau): since this is not what the user wanted, perhaps we
    // should return an error here
    WLOG("Address was too long, truncated to %s", addr);
  }

  // Check if the server already exists
  for (int i = 0; i < servers.ga_len; i++) {
    if (strcmp(addr, ((Server **)servers.ga_data)[i]->addr) == 0) {
      ELOG("Already listening on %s", addr);
      return 1;
    }
  }

  ServerType server_type = kServerTypeTcp;
  Server *server = xmalloc(sizeof(Server));
  char ip[16], *ip_end = strrchr(addr, ':');

  if (!ip_end) {
    ip_end = strchr(addr, NUL);
  }

  // (ip_end - addr) is always > 0, so convert to size_t
  size_t addr_len = (size_t)(ip_end - addr);

  if (addr_len > sizeof(ip) - 1) {
    // Maximum length of an IPv4 address buffer is 15 (eg: 255.255.255.255)
    addr_len = sizeof(ip) - 1;
  }

  // Extract the address part
  xstrlcpy(ip, addr, addr_len + 1);

  int port = NVIM_DEFAULT_TCP_PORT;

  if (*ip_end == ':') {
    // Extract the port
    long lport = strtol(ip_end + 1, NULL, 10); // NOLINT
    if (lport <= 0 || lport > 0xffff) {
      // Invalid port, treat as named pipe or unix socket
      server_type = kServerTypePipe;
    } else {
      port = (int) lport;
    }
  }

  if (server_type == kServerTypeTcp) {
    // Try to parse ip address
    if (uv_ip4_addr(ip, port, &server->socket.tcp.addr)) {
      // Invalid address, treat as named pipe or unix socket
      server_type = kServerTypePipe;
    }
  }

  int result;
  uv_stream_t *stream = NULL;

  xstrlcpy(server->addr, addr, sizeof(server->addr));

  if (server_type == kServerTypeTcp) {
    // Listen on tcp address/port
    uv_tcp_init(&loop.uv, &server->socket.tcp.handle);
    result = uv_tcp_bind(&server->socket.tcp.handle,
                         (const struct sockaddr *)&server->socket.tcp.addr,
                         0);
    stream = (uv_stream_t *)&server->socket.tcp.handle;
  } else {
    // Listen on named pipe or unix socket
    uv_pipe_init(&loop.uv, &server->socket.pipe.handle, 0);
    result = uv_pipe_bind(&server->socket.pipe.handle, server->addr);
    stream = (uv_stream_t *)&server->socket.pipe.handle;
  }

  stream->data = server;

  if (result == 0) {
    result = uv_listen((uv_stream_t *)&server->socket.tcp.handle,
                       MAX_CONNECTIONS,
                       connection_cb);
  }

  assert(result <= 0);  // libuv should have returned -errno or zero.
  if (result < 0) {
    if (result == -EACCES) {
      // Libuv converts ENOENT to EACCES for Windows compatibility, but if
      // the parent directory does not exist, ENOENT would be more accurate.
      *path_tail((char_u *) addr) = NUL;
      if (!os_file_exists((char_u *) addr)) {
        result = -ENOENT;
      }
    }
    uv_close((uv_handle_t *)stream, free_server);
    ELOG("Failed to start server: %s", uv_strerror(result));
    return result;
  }

  // Update $NVIM_LISTEN_ADDRESS, if not set.
  const char *listen_address = os_getenv(LISTEN_ADDRESS_ENV_VAR);
  if (listen_address == NULL) {
    os_setenv(LISTEN_ADDRESS_ENV_VAR, addr, 1);
  }

  server->type = server_type;

  // Add the server to the list.
  ga_grow(&servers, 1);
  ((Server **)servers.ga_data)[servers.ga_len++] = server;

  // Update v:servername, if not set.
  if (STRLEN(get_vim_var_str(VV_SEND_SERVER)) == 0) {
    set_vservername(&servers);
  }

  return 0;
}

/// Stops listening on the address specified by `endpoint`.
///
/// @param endpoint Address of the server.
void server_stop(char *endpoint)
{
  Server *server;
  char addr[ADDRESS_MAX_SIZE];

  // Trim to `ADDRESS_MAX_SIZE`
  xstrlcpy(addr, endpoint, sizeof(addr));

  int i = 0;  // Index of the server whose address equals addr.
  for (; i < servers.ga_len; i++) {
    server = ((Server **)servers.ga_data)[i];
    if (strcmp(addr, server->addr) == 0) {
      break;
    }
  }

  if (i >= servers.ga_len) {
    ELOG("Not listening on %s", addr);
    return;
  }

  // Unset $NVIM_LISTEN_ADDRESS if it is the stopped address.
  const char *listen_address = os_getenv(LISTEN_ADDRESS_ENV_VAR);
  if (listen_address && STRCMP(addr, listen_address) == 0) {
    os_unsetenv(LISTEN_ADDRESS_ENV_VAR);
  }

  uv_close(server_handle(server), free_server);

  // Remove this server from the list by swapping it with the last item.
  if (i != servers.ga_len - 1) {
    ((Server **)servers.ga_data)[i] =
      ((Server **)servers.ga_data)[servers.ga_len - 1];
  }
  servers.ga_len--;

  // If v:servername is the stopped address, re-initialize it.
  if (STRCMP(addr, get_vim_var_str(VV_SEND_SERVER)) == 0) {
    set_vservername(&servers);
  }
}

/// Returns an allocated array of server addresses.
/// @param[out] size The size of the returned array.
char **server_address_list(size_t *size)
  FUNC_ATTR_NONNULL_ALL
{
  if ((*size = (size_t) servers.ga_len) == 0) {
    return NULL;
  }

  char **addrs = xcalloc((size_t) servers.ga_len, sizeof(const char *));
  for (int i = 0; i < servers.ga_len; i++) {
    addrs[i] = xstrdup(((Server **)servers.ga_data)[i]->addr);
  }
  return addrs;
}

static void connection_cb(uv_stream_t *server, int status)
{
  int result;
  uv_stream_t *client;
  Server *srv = server->data;

  if (status < 0) {
    abort();
  }

  if (srv->type == kServerTypeTcp) {
    client = xmalloc(sizeof(uv_tcp_t));
    uv_tcp_init(&loop.uv, (uv_tcp_t *)client);
  } else {
    client = xmalloc(sizeof(uv_pipe_t));
    uv_pipe_init(&loop.uv, (uv_pipe_t *)client, 0);
  }

  result = uv_accept(server, client);

  if (result) {
    ELOG("Failed to accept connection: %s", uv_strerror(result));
    uv_close((uv_handle_t *)client, free_client);
    return;
  }

  channel_from_stream(client);
}

static void free_client(uv_handle_t *handle)
{
  xfree(handle);
}

static void free_server(uv_handle_t *handle)
{
  xfree(handle->data);
}