/*
- * Copyright 2016 IoT.bzh
+ * Copyright (C) 2015-2020 "IoT.bzh"
* Author: José Bollo <jose.bollo@iot.bzh>
*
* Licensed under the Apache License, Version 2.0 (the "License");
#include <errno.h>
#include <sys/uio.h>
#include <string.h>
+#include <stdarg.h>
+#include <poll.h>
#include "websock.h"
#include "afb-ws.h"
+#include "fdev.h"
-#include "utils-upoll.h"
-
+/*
+ * declaration of the websock interface for afb-ws
+ */
static ssize_t aws_writev(struct afb_ws *ws, const struct iovec *iov, int iovcnt);
static ssize_t aws_readv(struct afb_ws *ws, const struct iovec *iov, int iovcnt);
static void aws_on_close(struct afb_ws *ws, uint16_t code, size_t size);
static void aws_on_binary(struct afb_ws *ws, int last, size_t size);
static void aws_on_continue(struct afb_ws *ws, int last, size_t size);
static void aws_on_readable(struct afb_ws *ws);
-static void aws_on_hangup(struct afb_ws *ws);
+static void aws_on_error(struct afb_ws *ws, uint16_t code, const void *data, size_t size);
static struct websock_itf aws_itf = {
.writev = (void*)aws_writev,
.on_text = (void*)aws_on_text,
.on_binary = (void*)aws_on_binary,
.on_continue = (void*)aws_on_continue,
- .on_extension = NULL
+ .on_extension = NULL,
+
+ .on_error = (void*)aws_on_error
};
+/*
+ * a common scheme of buffer handling
+ */
struct buf
{
char *buffer;
size_t size;
};
+/*
+ * the state
+ */
+enum state
+{
+ waiting,
+ reading_text,
+ reading_binary
+};
+
+/*
+ * the afb_ws structure
+ */
struct afb_ws
{
- int fd;
- enum { none, text, binary } type;
- const struct afb_ws_itf *itf;
- void *closure;
- struct websock *ws;
- struct upoll *up;
- struct buf buffer;
+ int fd; /* the socket file descriptor */
+ enum state state; /* current state */
+ const struct afb_ws_itf *itf; /* the callback interface */
+ void *closure; /* closure when calling the callbacks */
+ struct websock *ws; /* the websock handler */
+ struct fdev *fdev; /* the fdev for the socket */
+ struct buf buffer; /* the last read fragment */
};
-struct afb_ws *afb_ws_create(int fd, const struct afb_ws_itf *itf, void *closure)
+/*
+ * Returns the current buffer of 'ws' that is reset.
+ */
+static inline struct buf aws_pick_buffer(struct afb_ws *ws)
+{
+ struct buf result = ws->buffer;
+ if (result.buffer)
+ result.buffer[result.size] = 0;
+ ws->buffer.buffer = NULL;
+ ws->buffer.size = 0;
+ return result;
+}
+
+/*
+ * Clear the current buffer
+ */
+static inline void aws_clear_buffer(struct afb_ws *ws)
+{
+ ws->buffer.size = 0;
+}
+
+/*
+ * Disconnect the websocket 'ws' and calls on_hangup if
+ * 'call_on_hangup' is not null.
+ */
+static void aws_disconnect(struct afb_ws *ws, int call_on_hangup)
+{
+ struct websock *wsi = ws->ws;
+ if (wsi != NULL) {
+ ws->ws = NULL;
+ fdev_set_callback(ws->fdev, NULL, 0);
+ fdev_unref(ws->fdev);
+ websock_destroy(wsi);
+ free(ws->buffer.buffer);
+ ws->state = waiting;
+ if (call_on_hangup && ws->itf->on_hangup)
+ ws->itf->on_hangup(ws->closure);
+ }
+}
+
+static void fdevcb(void *ws, uint32_t revents, struct fdev *fdev)
+{
+ if ((revents & EPOLLHUP) != 0)
+ afb_ws_hangup(ws);
+ else if ((revents & EPOLLIN) != 0)
+ aws_on_readable(ws);
+}
+
+/*
+ * Creates the afb_ws structure for the file descritor
+ * 'fd' and the callbacks described by the interface 'itf'
+ * and its 'closure'.
+ * When the creation is a success, the systemd event loop 'eloop' is
+ * used for handling event for 'fd'.
+ *
+ * Returns the handle for the afb_ws created or NULL on error.
+ */
+struct afb_ws *afb_ws_create(struct fdev *fdev, const struct afb_ws_itf *itf, void *closure)
{
struct afb_ws *result;
- assert(fd >= 0);
+ assert(fdev);
+ /* allocation */
result = malloc(sizeof * result);
if (result == NULL)
goto error;
- result->fd = fd;
- result->type = none;
+ /* init */
+ result->fdev = fdev;
+ result->fd = fdev_fd(fdev);
+ result->state = waiting;
result->itf = itf;
result->closure = closure;
+ result->buffer.buffer = NULL;
+ result->buffer.size = 0;
+ /* creates the websocket */
result->ws = websock_create_v13(&aws_itf, result);
if (result->ws == NULL)
goto error2;
- result->up = upoll_open(result->fd, result);
- if (result->up == NULL)
- goto error3;
-
- result->buffer.buffer = NULL;
- result->buffer.size = 0;
-
- upoll_on_readable(result->up, (void*)aws_on_readable);
- upoll_on_hangup(result->up, (void*)aws_on_hangup);
-
+ /* finalize */
+ fdev_set_events(fdev, EPOLLIN);
+ fdev_set_callback(fdev, fdevcb, result);
return result;
-error3:
- websock_destroy(result->ws);
error2:
free(result);
error:
- close(fd);
+ fdev_unref(fdev);
return NULL;
}
-void afb_ws_disconnect(struct afb_ws *ws)
+/*
+ * Destroys the websocket 'ws'
+ * It first hangup (but without calling on_hangup for safety reasons)
+ * if needed.
+ */
+void afb_ws_destroy(struct afb_ws *ws)
{
- struct upoll *up = ws->up;
- struct websock *wsi = ws->ws;
- ws->up = NULL;
- ws->ws = NULL;
- upoll_close(up);
- websock_destroy(wsi);
+ aws_disconnect(ws, 0);
+ free(ws);
+}
+
+/*
+ * Hangup the websocket 'ws'
+ */
+void afb_ws_hangup(struct afb_ws *ws)
+{
+ aws_disconnect(ws, 1);
+}
+
+/*
+ * Is the websocket 'ws' still connected ?
+ */
+int afb_ws_is_connected(struct afb_ws *ws)
+{
+ return ws->ws != NULL;
+}
+
+/*
+ * Sends a 'close' command to the endpoint of 'ws' with the 'code' and the
+ * 'reason' (that can be NULL and that else should not be greater than 123
+ * characters).
+ * Returns 0 on success or -1 in case of error.
+ */
+int afb_ws_close(struct afb_ws *ws, uint16_t code, const char *reason)
+{
+ if (ws->ws == NULL) {
+ /* disconnected */
+ errno = EPIPE;
+ return -1;
+ }
+ return websock_close(ws->ws, code, reason, reason == NULL ? 0 : strlen(reason));
+}
+
+/*
+ * Sends a 'close' command to the endpoint of 'ws' with the 'code' and the
+ * 'reason' (that can be NULL and that else should not be greater than 123
+ * characters).
+ * Raise an error after 'close' command is sent.
+ * Returns 0 on success or -1 in case of error.
+ */
+int afb_ws_error(struct afb_ws *ws, uint16_t code, const char *reason)
+{
+ if (ws->ws == NULL) {
+ /* disconnected */
+ errno = EPIPE;
+ return -1;
+ }
+ return websock_error(ws->ws, code, reason, reason == NULL ? 0 : strlen(reason));
+}
+
+/*
+ * Sends a 'text' of 'length' to the endpoint of 'ws'.
+ * Returns 0 on success or -1 in case of error.
+ */
+int afb_ws_text(struct afb_ws *ws, const char *text, size_t length)
+{
+ if (ws->ws == NULL) {
+ /* disconnected */
+ errno = EPIPE;
+ return -1;
+ }
+ return websock_text(ws->ws, 1, text, length);
+}
+
+/*
+ * Sends a variable list of texts to the endpoint of 'ws'.
+ * Returns 0 on success or -1 in case of error.
+ */
+int afb_ws_texts(struct afb_ws *ws, ...)
+{
+ va_list args;
+ struct iovec ios[32];
+ int count;
+ const char *s;
+
+ if (ws->ws == NULL) {
+ /* disconnected */
+ errno = EPIPE;
+ return -1;
+ }
+
+ count = 0;
+ va_start(args, ws);
+ s = va_arg(args, const char *);
+ while (s != NULL) {
+ if (count == 32) {
+ errno = EINVAL;
+ return -1;
+ }
+ ios[count].iov_base = (void*)s;
+ ios[count].iov_len = strlen(s);
+ count++;
+ s = va_arg(args, const char *);
+ }
+ va_end(args);
+ return websock_text_v(ws->ws, 1, ios, count);
}
-void afb_ws_close(struct afb_ws *ws, uint16_t code)
+/*
+ * Sends a text data described in the 'count' 'iovec' to the endpoint of 'ws'.
+ * Returns 0 on success or -1 in case of error.
+ */
+int afb_ws_text_v(struct afb_ws *ws, const struct iovec *iovec, int count)
{
- websock_close_code(ws->ws, code, NULL, 0);
+ if (ws->ws == NULL) {
+ /* disconnected */
+ errno = EPIPE;
+ return -1;
+ }
+ return websock_text_v(ws->ws, 1, iovec, count);
}
-void afb_ws_text(struct afb_ws *ws, const char *text, size_t length)
+/*
+ * Sends a binary 'data' of 'length' to the endpoint of 'ws'.
+ * Returns 0 on success or -1 in case of error.
+ */
+int afb_ws_binary(struct afb_ws *ws, const void *data, size_t length)
{
- websock_text(ws->ws, 1, text, length);
+ if (ws->ws == NULL) {
+ /* disconnected */
+ errno = EPIPE;
+ return -1;
+ }
+ return websock_binary(ws->ws, 1, data, length);
}
-void afb_ws_binary(struct afb_ws *ws, const void *data, size_t length)
+/*
+ * Sends a binary data described in the 'count' 'iovec' to the endpoint of 'ws'.
+ * Returns 0 on success or -1 in case of error.
+ */
+int afb_ws_binary_v(struct afb_ws *ws, const struct iovec *iovec, int count)
{
- websock_binary(ws->ws, 1, data, length);
+ if (ws->ws == NULL) {
+ /* disconnected */
+ errno = EPIPE;
+ return -1;
+ }
+ return websock_binary_v(ws->ws, 1, iovec, count);
}
+/*
+ * callback for writing data
+ */
static ssize_t aws_writev(struct afb_ws *ws, const struct iovec *iov, int iovcnt)
{
- ssize_t rc;
- do {
- rc = writev(ws->fd, iov, iovcnt);
- } while(rc == -1 && errno == EINTR);
- return rc;
+ int i;
+ ssize_t rc, sz, dsz;
+ struct iovec *iov2;
+ struct pollfd pfd;
+
+ /* compute the size */
+ dsz = 0;
+ i = 0;
+ while (i < iovcnt) {
+ dsz += iov[i++].iov_len;
+ if (dsz < 0) {
+ errno = EINVAL;
+ return -1;
+ }
+ }
+ if (dsz == 0)
+ return 0;
+
+ /* write the data */
+ iov2 = (struct iovec*)iov;
+ sz = dsz;
+ for (;;) {
+ rc = writev(ws->fd, iov2, iovcnt);
+ if (rc < 0) {
+ if (errno == EINTR)
+ continue;
+ if (errno != EAGAIN)
+ return -1;
+ } else {
+ dsz -= rc;
+ if (dsz == 0)
+ return sz;
+
+ i = 0;
+ while (rc >= (ssize_t)iov2[i].iov_len)
+ rc -= (ssize_t)iov2[i++].iov_len;
+
+ iovcnt -= i;
+ if (iov2 != iov)
+ iov2 += i;
+ else {
+ iov += i;
+ iov2 = alloca(iovcnt * sizeof *iov2);
+ for (i = 0 ; i < iovcnt ; i++)
+ iov2[i] = iov[i];
+ }
+ iov2->iov_base += rc;
+ iov2->iov_len -= rc;
+ }
+ pfd.fd = ws->fd;
+ pfd.events = POLLOUT;
+ poll(&pfd, 1, 10);
+ }
}
+/*
+ * callback for reading data
+ */
static ssize_t aws_readv(struct afb_ws *ws, const struct iovec *iov, int iovcnt)
{
ssize_t rc;
do {
rc = readv(ws->fd, iov, iovcnt);
} while(rc == -1 && errno == EINTR);
+ if (rc == 0) {
+ errno = EPIPE;
+ rc = -1;
+ }
return rc;
}
+/*
+ * callback on incoming data
+ */
static void aws_on_readable(struct afb_ws *ws)
{
- websock_dispatch(ws->ws);
-}
+ int rc;
-static void aws_on_hangup(struct afb_ws *ws)
-{
- afb_ws_disconnect(ws);
-}
-
-static inline struct buf aws_pick_buffer(struct afb_ws *ws)
-{
- struct buf result = ws->buffer;
- ws->buffer.buffer = NULL;
- ws->buffer.size = 0;
- return result;
+ assert(ws->ws != NULL);
+ rc = websock_dispatch(ws->ws, 0);
+ if (rc < 0 && errno == EPIPE)
+ afb_ws_hangup(ws);
}
+/*
+ * Reads from the websocket handled by 'ws' data of length 'size'
+ * and append it to the current buffer of 'ws'.
+ * Returns 0 in case of error or 1 in case of success.
+ */
static int aws_read(struct afb_ws *ws, size_t size)
{
+ struct pollfd pfd;
ssize_t sz;
char *buffer;
- if (size != 0) {
+ if (size != 0 || ws->buffer.buffer == NULL) {
buffer = realloc(ws->buffer.buffer, ws->buffer.size + size + 1);
if (buffer == NULL)
return 0;
ws->buffer.buffer = buffer;
- sz = websock_read(ws->ws, &buffer[ws->buffer.size], size);
- if ((size_t)sz != size)
- return 0;
- ws->buffer.size += size;
+ while (size != 0) {
+ sz = websock_read(ws->ws, &buffer[ws->buffer.size], size);
+ if (sz < 0) {
+ if (errno != EAGAIN)
+ return 0;
+ pfd.fd = ws->fd;
+ pfd.events = POLLIN;
+ poll(&pfd, 1, 10); /* TODO: make fully asynchronous websockets */
+ } else {
+ ws->buffer.size += (size_t)sz;
+ size -= (size_t)sz;
+ }
+ }
}
return 1;
}
+/*
+ * Callback when 'close' command received from 'ws' with 'code' and 'size'.
+ */
static void aws_on_close(struct afb_ws *ws, uint16_t code, size_t size)
{
struct buf b;
- ws->type = none;
- if (ws->itf->on_close == NULL)
+ ws->state = waiting;
+ aws_clear_buffer(ws);
+ if (ws->itf->on_close == NULL) {
websock_drop(ws->ws);
+ afb_ws_hangup(ws);
+ } else if (!aws_read(ws, size))
+ ws->itf->on_close(ws->closure, code, NULL, 0);
else {
- aws_read(ws, size);
b = aws_pick_buffer(ws);
ws->itf->on_close(ws->closure, code, b.buffer, b.size);
}
}
+/*
+ * Drops any incoming data and send an error of 'code'
+ */
+static void aws_drop_error(struct afb_ws *ws, uint16_t code)
+{
+ ws->state = waiting;
+ aws_clear_buffer(ws);
+ websock_drop(ws->ws);
+ websock_error(ws->ws, code, NULL, 0);
+}
+
+/*
+ * Reads either text or binary data of 'size' from 'ws' eventually 'last'.
+ */
+static void aws_continue(struct afb_ws *ws, int last, size_t size)
+{
+ struct buf b;
+ int istxt;
+
+ if (!aws_read(ws, size))
+ aws_drop_error(ws, WEBSOCKET_CODE_ABNORMAL);
+ else if (last) {
+ istxt = ws->state == reading_text;
+ ws->state = waiting;
+ b = aws_pick_buffer(ws);
+ (istxt ? ws->itf->on_text : ws->itf->on_binary)(ws->closure, b.buffer, b.size);
+ }
+}
+
+/*
+ * Callback when 'text' message received from 'ws' with 'size' and possibly 'last'.
+ */
static void aws_on_text(struct afb_ws *ws, int last, size_t size)
{
- if (ws->type != none) {
- websock_drop(ws->ws);
- websock_close_code(ws->ws, WEBSOCKET_CODE_PROTOCOL_ERROR, NULL, 0);
- } else if (ws->itf->on_text == NULL) {
- websock_drop(ws->ws);
- websock_close_code(ws->ws, WEBSOCKET_CODE_CANT_ACCEPT, NULL, 0);
- } else {
- ws->type = text;
- aws_on_continue(ws, last, size);
+ if (ws->state != waiting)
+ aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR);
+ else if (ws->itf->on_text == NULL)
+ aws_drop_error(ws, WEBSOCKET_CODE_CANT_ACCEPT);
+ else {
+ ws->state = reading_text;
+ aws_continue(ws, last, size);
}
}
+/*
+ * Callback when 'binary' message received from 'ws' with 'size' and possibly 'last'.
+ */
static void aws_on_binary(struct afb_ws *ws, int last, size_t size)
{
- if (ws->type != none) {
- websock_drop(ws->ws);
- websock_close_code(ws->ws, WEBSOCKET_CODE_PROTOCOL_ERROR, NULL, 0);
- } else if (ws->itf->on_binary == NULL) {
- websock_drop(ws->ws);
- websock_close_code(ws->ws, WEBSOCKET_CODE_CANT_ACCEPT, NULL, 0);
- } else {
- ws->type = text;
- aws_on_continue(ws, last, size);
+ if (ws->state != waiting)
+ aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR);
+ else if (ws->itf->on_binary == NULL)
+ aws_drop_error(ws, WEBSOCKET_CODE_CANT_ACCEPT);
+ else {
+ ws->state = reading_binary;
+ aws_continue(ws, last, size);
}
}
+/*
+ * Callback when 'continue' command received from 'ws' with 'code' and 'size'.
+ */
static void aws_on_continue(struct afb_ws *ws, int last, size_t size)
{
- struct buf b;
- int istxt;
+ if (ws->state == waiting)
+ aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR);
+ else
+ aws_continue(ws, last, size);
+}
- if (ws->type == none) {
- websock_drop(ws->ws);
- websock_close_code(ws->ws, WEBSOCKET_CODE_PROTOCOL_ERROR, NULL, 0);
- } else {
- if (!aws_read(ws, size)) {
- aws_on_close(ws, WEBSOCKET_CODE_ABNORMAL, 0);
- } else if (last) {
- istxt = ws->type == text;
- ws->type = none;
- b = aws_pick_buffer(ws);
- b.buffer[b.size] = 0;
- (istxt ? ws->itf->on_text : ws->itf->on_binary)(ws->closure, b.buffer, b.size);
- }
- }
+/*
+ * Callback when 'close' command is sent to 'ws' with 'code' and 'size'.
+ */
+static void aws_on_error(struct afb_ws *ws, uint16_t code, const void *data, size_t size)
+{
+ if (ws->itf->on_error != NULL)
+ ws->itf->on_error(ws->closure, code, data, size);
+ else
+ afb_ws_hangup(ws);
}
+
Code Review / src / app-framework-binder.git / blobdiff