X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fafb-ws.c;h=1db9ad5445dd0417bb520b1fa0c611e9d32a408a;hb=65353dce81a629e042800bb7b86fcd869a76727e;hp=49d836b2d6897843ae9f7374ef821b2b06a876ec;hpb=ce7b0d0a381016057cedb99f1e33293c9f65b562;p=src%2Fapp-framework-binder.git diff --git a/src/afb-ws.c b/src/afb-ws.c index 49d836b2..1db9ad54 100644 --- a/src/afb-ws.c +++ b/src/afb-ws.c @@ -1,5 +1,5 @@ /* - * Copyright 2016 IoT.bzh + * Copyright (C) 2015-2020 "IoT.bzh" * Author: José Bollo * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -16,371 +16,545 @@ */ #define _GNU_SOURCE +#include +#include +#include #include #include #include #include - -#include +#include +#include #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_disconnect(struct afb_ws *ws); static void aws_on_close(struct afb_ws *ws, uint16_t code, size_t size); -static void aws_on_content(struct afb_ws *ws, int last, size_t size); +static void aws_on_text(struct afb_ws *ws, int last, 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_error(struct afb_ws *ws, uint16_t code, const void *data, size_t size); static struct websock_itf aws_itf = { .writev = (void*)aws_writev, .readv = (void*)aws_readv, - .disconnect = (void*)aws_disconnect, .on_ping = NULL, .on_pong = NULL, .on_close = (void*)aws_on_close, - .on_text = (void*)aws_on_content, - .on_binary = (void*)aws_on_content, - .on_continue = (void*)aws_on_content, + .on_text = (void*)aws_on_text, + .on_binary = (void*)aws_on_binary, + .on_continue = (void*)aws_on_continue, .on_extension = NULL, + + .on_error = (void*)aws_on_error }; -struct afb_wsreq +/* + * a common scheme of buffer handling + */ +struct buf { - struct afb_ws *aws; - struct afb_wsreq *next; - struct json_object *id; - struct json_object *name; - struct json_object *token; - struct json_object *request; + char *buffer; + size_t size; }; -struct afb_ws +/* + * the state + */ +enum state { - int fd; - struct upoll *up; - struct websock *ws; - void (*cleanup)(void*); - void *cleanup_closure; - struct AFB_clientCtx *context; - struct afb_wsreq *requests; + waiting, + reading_text, + reading_binary }; -static struct afb_arg wsreq_get(struct afb_wsreq *wsreq, const char *name); -static void wsreq_iterate(struct afb_wsreq *wsreq, int (*iterator)(void *closure, struct afb_arg arg), void *closure); -static void wsreq_fail(struct afb_wsreq *wsreq, const char *status, const char *info); -static void wsreq_success(struct afb_wsreq *wsreq, struct json_object *obj, const char *info); -static int wsreq_session_create(struct afb_wsreq *wsreq); -static int wsreq_session_check(struct afb_wsreq *wsreq, int refresh); -static void wsreq_session_close(struct afb_wsreq *wsreq); - -static const struct afb_req_itf wsreq_itf = { - .get = (void*)wsreq_get, - .iterate = (void*)wsreq_iterate, - .fail = (void*)wsreq_fail, - .success = (void*)wsreq_success, - .session_create = (void*)wsreq_session_create, - .session_check = (void*)wsreq_session_check, - .session_close = (void*)wsreq_session_close +/* + * the afb_ws structure + */ +struct afb_ws +{ + 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, struct AFB_clientCtx *context, void (*cleanup)(void*), 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(context != NULL); + assert(fdev); + /* allocation */ result = malloc(sizeof * result); if (result == NULL) goto error; - result->fd = fd; - result->cleanup = cleanup; - result->cleanup_closure = closure; - result->context = ctxClientGet(context); - if (result->context == NULL) - goto error2; + /* 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 error3; - - result->up = upoll_open(result->fd, result); - if (result->up == NULL) - goto error4; + goto error2; - upoll_on_readable(result->up, (void*)aws_on_readable); - upoll_on_hangup(result->up, (void*)aws_disconnect); + /* finalize */ + fdev_set_events(fdev, EPOLLIN); + fdev_set_callback(fdev, fdevcb, result); return result; -error4: - websock_destroy(result->ws); -error3: - ctxClientPut(result->context); + error2: free(result); error: - close(fd); + fdev_unref(fdev); return NULL; } -static ssize_t aws_writev(struct afb_ws *ws, const struct iovec *iov, int iovcnt) +/* + * 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) { - ssize_t rc; - do { - rc = writev(ws->fd, iov, iovcnt); - } while(rc == -1 && errno == EINTR); - return rc; + aws_disconnect(ws, 0); + free(ws); } -static ssize_t aws_readv(struct afb_ws *ws, const struct iovec *iov, int iovcnt) +/* + * Hangup the websocket 'ws' + */ +void afb_ws_hangup(struct afb_ws *ws) { - ssize_t rc; - do { - rc = readv(ws->fd, iov, iovcnt); - } while(rc == -1 && errno == EINTR); - return rc; + aws_disconnect(ws, 1); } -static void aws_disconnect(struct afb_ws *ws) +/* + * Is the websocket 'ws' still connected ? + */ +int afb_ws_is_connected(struct afb_ws *ws) { - upoll_close(ws->up); - websock_destroy(ws->ws); - close(ws->fd); - MHD_resume_connection (ws->connection); - ctxClientPut(ws->context); - json_tokener_free(ws->tokener); - free(ws); + return ws->ws != NULL; } -static void aws_on_close(struct afb_ws *ws, uint16_t code, size_t size) +/* + * 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) { - /* do nothing */ + if (ws->ws == NULL) { + /* disconnected */ + errno = EPIPE; + return -1; + } + return websock_close(ws->ws, code, reason, reason == NULL ? 0 : strlen(reason)); } -static void aws_on_readable(struct afb_ws *ws) +/* + * 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) { - websock_dispatch(ws->ws); + if (ws->ws == NULL) { + /* disconnected */ + errno = EPIPE; + return -1; + } + return websock_error(ws->ws, code, reason, reason == NULL ? 0 : strlen(reason)); } -static int aws_handle_json(struct afb_ws *aws, struct json_object *obj) +/* + * 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) { - struct afb_req r; - int count, num; - struct json_object *type, *id, *name, *req, *token; - struct afb_wsreq *wsreq; - const char *api, *verb; - size_t lenapi, lenverb; - - /* protocol inspired by http://www.gir.fr/ocppjs/ocpp_srpc_spec.shtml */ - - /* the object must be an array of 4 or 5 elements */ - if (!json_object_is_type(obj, json_type_array)) - goto error; - count = json_object_array_length(obj); - if (count < 4 || count > 5) - goto error; - - /* get the 5 elements: type id name request token */ - type = json_object_array_get_idx(obj, 0); - id = json_object_array_get_idx(obj, 1); - name = json_object_array_get_idx(obj, 2); - req = json_object_array_get_idx(obj, 3); - token = json_object_array_get_idx(obj, 4); - - /* check the types: int string string object string */ - if (!json_object_is_type(type, json_type_int)) - goto error; - if (!json_object_is_type(id, json_type_string)) - goto error; - if (!json_object_is_type(name, json_type_string)) - goto error; - if (!json_object_is_type(req, json_type_object)) - goto error; - if (token != NULL && !json_object_is_type(token, json_type_string)) - goto error; - - /* the type is only 2 */ - num = json_object_get_int(type); - if (num != 2) - goto error; - - /* checks the api/verb structure of name */ - api = json_object_get_string(name); - for (lenapi = 0 ; api[lenapi] && api[lenapi] != '/' ; lenapi++); - if (!lenapi || !api[lenapi]) - goto error; - verb = &api[lenapi+1]; - for (lenverb = 0 ; verb[lenverb] && verb[lenverb] != '/' ; lenverb++); - if (!lenverb || verb[lenverb]) - goto error; - - /* allocates the request data */ - wsreq = malloc(sizeof *wsreq); - if (wsreq == NULL) - goto error; + if (ws->ws == NULL) { + /* disconnected */ + errno = EPIPE; + return -1; + } + return websock_text(ws->ws, 1, text, length); +} - /* fill and record the request */ - wsreq->aws = aws; - wsreq->id = json_object_get(id); - wsreq->name = json_object_get(name); - wsreq->token = json_object_get(token); - wsreq->request = json_object_get(req); - wsreq->next = aws->requests; - aws->requests = wsreq; - json_object_put(obj); - - r.data = wsreq; - r.itf = &wsreq_itf; - afb_apis_call(r, aws->context, api, lenapi, verb, lenverb); - return 1; +/* + * 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; + } -error: - json_object_put(obj); - return 0; + 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); } -static void aws_on_content(struct afb_ws *ws, int last, size_t size) +/* + * 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) { - ssize_t rrc; - char buffer[8000]; - struct json_object *obj; - - json_tokener_reset(ws->tokener); - while(size) { - rrc = websock_read(ws->ws, buffer, - size > sizeof buffer ? sizeof buffer : size); - if (rrc < 0) { - websock_close(ws->ws); - return; - } - size -= (size_t)rrc; - obj = json_tokener_parse_ex(ws->tokener, buffer, (int)rrc); - if (obj != NULL) { - if (!aws_handle_json(ws, obj)) { - websock_close(ws->ws); - return; - } - } else if (json_tokener_get_error(ws->tokener) != json_tokener_continue) { - websock_close(ws->ws); - return; - } + if (ws->ws == NULL) { + /* disconnected */ + errno = EPIPE; + return -1; } + return websock_text_v(ws->ws, 1, iovec, count); } -static struct afb_arg wsreq_get(struct afb_wsreq *wsreq, const char *name) +/* + * 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) { - struct afb_arg arg; - struct json_object *value; - - if (json_object_object_get_ex(wsreq->request, name, &value)) { - arg.name = name; - arg.value = json_object_get_string(value); - arg.size = strlen(arg.value); - } else { - arg.name = NULL; - arg.value = NULL; - arg.size = 0; + if (ws->ws == NULL) { + /* disconnected */ + errno = EPIPE; + return -1; } - arg.path = NULL; - return arg; + return websock_binary(ws->ws, 1, data, length); } -static void wsreq_iterate(struct afb_wsreq *wsreq, int (*iterator)(void *closure, struct afb_arg arg), void *closure) +/* + * 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) { - struct afb_arg arg; - struct json_object_iterator it = json_object_iter_begin(wsreq->request); - struct json_object_iterator end = json_object_iter_end(wsreq->request); - - arg.size = 0; - arg.path = NULL; - while(!json_object_iter_equal(&it, &end)) { - arg.name = json_object_iter_peek_name(&it); - arg.value = json_object_get_string(json_object_iter_peek_value(&it)); - if (!iterator(closure, arg)) - break; - json_object_iter_next(&it); + if (ws->ws == NULL) { + /* disconnected */ + errno = EPIPE; + return -1; } + return websock_binary_v(ws->ws, 1, iovec, count); } -static int wsreq_session_create(struct afb_wsreq *wsreq) +/* + * callback for writing data + */ +static ssize_t aws_writev(struct afb_ws *ws, const struct iovec *iov, int iovcnt) { - struct AFB_clientCtx *context = wsreq->aws->context; - if (context->created) + 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; - return wsreq_session_check(wsreq, 1); + + /* 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); + } } -static int wsreq_session_check(struct afb_wsreq *wsreq, int refresh) +/* + * callback for reading data + */ +static ssize_t aws_readv(struct afb_ws *ws, const struct iovec *iov, int iovcnt) { - const char *token; - struct AFB_clientCtx *context = wsreq->aws->context; + ssize_t rc; + do { + rc = readv(ws->fd, iov, iovcnt); + } while(rc == -1 && errno == EINTR); + if (rc == 0) { + errno = EPIPE; + rc = -1; + } + return rc; +} - if (wsreq->token == NULL) - return 0; +/* + * callback on incoming data + */ +static void aws_on_readable(struct afb_ws *ws) +{ + int rc; - token = json_object_get_string(wsreq->token); - if (token == NULL) - return 0; + assert(ws->ws != NULL); + rc = websock_dispatch(ws->ws, 0); + if (rc < 0 && errno == EPIPE) + afb_ws_hangup(ws); +} - if (!ctxTokenCheck (context, token)) - return 0; +/* + * 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 || ws->buffer.buffer == NULL) { + buffer = realloc(ws->buffer.buffer, ws->buffer.size + size + 1); + if (buffer == NULL) + return 0; + ws->buffer.buffer = buffer; + 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; +} - if (refresh) { - ctxTokenNew (context); +/* + * 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->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 { + b = aws_pick_buffer(ws); + ws->itf->on_close(ws->closure, code, b.buffer, b.size); } +} - return 1; +/* + * 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); } -static void wsreq_session_close(struct afb_wsreq *wsreq) +/* + * 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 AFB_clientCtx *context = wsreq->aws->context; - ctxClientClose(context); + 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->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); + } +} -static void wsreq_reply(struct afb_wsreq *wsreq, int retcode, const char *status, const char *info, json_object *resp) +/* + * 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) { - json_object *root, *request, *reply; - const char *message; - - /* builds the answering structure */ - root = json_object_new_object(); - json_object_object_add(root, "jtype", json_object_new_string("afb-reply")); - request = json_object_new_object(); - json_object_object_add(root, "request", request); - json_object_object_add(request, "status", json_object_new_string(status)); - if (info) - json_object_object_add(request, "info", json_object_new_string(info)); - if (resp) - json_object_object_add(root, "response", resp); - - /* make the reply */ - reply = json_object_new_array(); - json_object_array_add(reply, json_object_new_int(retcode)); - json_object_array_add(reply, wsreq->id); - json_object_array_add(reply, root); - json_object_array_add(reply, json_object_new_string(wsreq->aws->context->token)); - - /* emits the reply */ - message = json_object_to_json_string(reply); - websock_text(wsreq->aws->ws, message, strlen(message)); - json_object_put(reply); - - /* TODO eliminates the wsreq */ + 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); + } } -static void wsreq_fail(struct afb_wsreq *wsreq, const char *status, const char *info) +/* + * 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) { - wsreq_reply(wsreq, 4, status, info, NULL); + if (ws->state == waiting) + aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR); + else + aws_continue(ws, last, size); } -static void wsreq_success(struct afb_wsreq *wsreq, json_object *obj, const char *info) +/* + * 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) { - wsreq_reply(wsreq, 3, "success", info, obj); + if (ws->itf->on_error != NULL) + ws->itf->on_error(ws->closure, code, data, size); + else + afb_ws_hangup(ws); } +