2 * Copyright (C) 2016, 2017 "IoT.bzh"
3 * Author: José Bollo <jose.bollo@iot.bzh>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
29 #include <systemd/sd-event.h>
34 #include "afb-common.h"
37 * declaration of the websock interface for afb-ws
39 static ssize_t aws_writev(struct afb_ws *ws, const struct iovec *iov, int iovcnt);
40 static ssize_t aws_readv(struct afb_ws *ws, const struct iovec *iov, int iovcnt);
41 static void aws_on_close(struct afb_ws *ws, uint16_t code, size_t size);
42 static void aws_on_text(struct afb_ws *ws, int last, size_t size);
43 static void aws_on_binary(struct afb_ws *ws, int last, size_t size);
44 static void aws_on_continue(struct afb_ws *ws, int last, size_t size);
45 static void aws_on_readable(struct afb_ws *ws);
46 static void aws_on_error(struct afb_ws *ws, uint16_t code, const void *data, size_t size);
48 static struct websock_itf aws_itf = {
49 .writev = (void*)aws_writev,
50 .readv = (void*)aws_readv,
54 .on_close = (void*)aws_on_close,
55 .on_text = (void*)aws_on_text,
56 .on_binary = (void*)aws_on_binary,
57 .on_continue = (void*)aws_on_continue,
60 .on_error = (void*)aws_on_error
64 * a common scheme of buffer handling
83 * the afb_ws structure
87 int fd; /* the socket file descriptor */
88 enum state state; /* current state */
89 const struct afb_ws_itf *itf; /* the callback interface */
90 void *closure; /* closure when calling the callbacks */
91 struct websock *ws; /* the websock handler */
92 sd_event_source *evsrc; /* the event source for the socket */
93 struct buf buffer; /* the last read fragment */
97 * Returns the current buffer of 'ws' that is reset.
99 static inline struct buf aws_pick_buffer(struct afb_ws *ws)
101 struct buf result = ws->buffer;
102 ws->buffer.buffer = NULL;
108 * Disconnect the websocket 'ws' and calls on_hangup if
109 * 'call_on_hangup' is not null.
111 static void aws_disconnect(struct afb_ws *ws, int call_on_hangup)
113 struct websock *wsi = ws->ws;
116 sd_event_source_unref(ws->evsrc);
118 websock_destroy(wsi);
119 free(aws_pick_buffer(ws).buffer);
121 if (call_on_hangup && ws->itf->on_hangup)
122 ws->itf->on_hangup(ws->closure);
126 static int io_event_callback(sd_event_source *src, int fd, uint32_t revents, void *ws)
128 if ((revents & EPOLLIN) != 0)
130 if ((revents & EPOLLHUP) != 0)
136 * Creates the afb_ws structure for the file descritor
137 * 'fd' and the callbacks described by the interface 'itf'
139 * When the creation is a success, the systemd event loop 'eloop' is
140 * used for handling event for 'fd'.
142 * Returns the handle for the afb_ws created or NULL on error.
144 struct afb_ws *afb_ws_create(struct sd_event *eloop, int fd, const struct afb_ws_itf *itf, void *closure)
147 struct afb_ws *result;
152 result = malloc(sizeof * result);
158 result->state = waiting;
160 result->closure = closure;
161 result->buffer.buffer = NULL;
162 result->buffer.size = 0;
164 /* creates the websocket */
165 result->ws = websock_create_v13(&aws_itf, result);
166 if (result->ws == NULL)
169 /* creates the evsrc */
170 rc = sd_event_add_io(eloop, &result->evsrc, result->fd, EPOLLIN, io_event_callback, result);
178 websock_destroy(result->ws);
186 * Destroys the websocket 'ws'
187 * It first hangup (but without calling on_hangup for safety reasons)
190 void afb_ws_destroy(struct afb_ws *ws)
192 aws_disconnect(ws, 0);
197 * Hangup the websocket 'ws'
199 void afb_ws_hangup(struct afb_ws *ws)
201 aws_disconnect(ws, 1);
205 * Is the websocket 'ws' still connected ?
207 int afb_ws_is_connected(struct afb_ws *ws)
209 return ws->ws != NULL;
213 * Sends a 'close' command to the endpoint of 'ws' with the 'code' and the
214 * 'reason' (that can be NULL and that else should not be greater than 123
216 * Returns 0 on success or -1 in case of error.
218 int afb_ws_close(struct afb_ws *ws, uint16_t code, const char *reason)
220 if (ws->ws == NULL) {
225 return websock_close(ws->ws, code, reason, reason == NULL ? 0 : strlen(reason));
229 * Sends a 'close' command to the endpoint of 'ws' with the 'code' and the
230 * 'reason' (that can be NULL and that else should not be greater than 123
232 * Raise an error after 'close' command is sent.
233 * Returns 0 on success or -1 in case of error.
235 int afb_ws_error(struct afb_ws *ws, uint16_t code, const char *reason)
237 if (ws->ws == NULL) {
242 return websock_error(ws->ws, code, reason, reason == NULL ? 0 : strlen(reason));
246 * Sends a 'text' of 'length' to the endpoint of 'ws'.
247 * Returns 0 on success or -1 in case of error.
249 int afb_ws_text(struct afb_ws *ws, const char *text, size_t length)
251 if (ws->ws == NULL) {
256 return websock_text(ws->ws, 1, text, length);
260 * Sends a variable list of texts to the endpoint of 'ws'.
261 * Returns 0 on success or -1 in case of error.
263 int afb_ws_texts(struct afb_ws *ws, ...)
266 struct iovec ios[32];
270 if (ws->ws == NULL) {
278 s = va_arg(args, const char *);
284 ios[count].iov_base = (void*)s;
285 ios[count].iov_len = strlen(s);
287 s = va_arg(args, const char *);
290 return websock_text_v(ws->ws, 1, ios, count);
294 * Sends a text data described in the 'count' 'iovec' to the endpoint of 'ws'.
295 * Returns 0 on success or -1 in case of error.
297 int afb_ws_text_v(struct afb_ws *ws, const struct iovec *iovec, int count)
299 if (ws->ws == NULL) {
304 return websock_text_v(ws->ws, 1, iovec, count);
308 * Sends a binary 'data' of 'length' to the endpoint of 'ws'.
309 * Returns 0 on success or -1 in case of error.
311 int afb_ws_binary(struct afb_ws *ws, const void *data, size_t length)
313 if (ws->ws == NULL) {
318 return websock_binary(ws->ws, 1, data, length);
322 * Sends a binary data described in the 'count' 'iovec' to the endpoint of 'ws'.
323 * Returns 0 on success or -1 in case of error.
325 int afb_ws_binary_v(struct afb_ws *ws, const struct iovec *iovec, int count)
327 if (ws->ws == NULL) {
332 return websock_binary_v(ws->ws, 1, iovec, count);
336 * callback for writing data
338 static ssize_t aws_writev(struct afb_ws *ws, const struct iovec *iov, int iovcnt)
342 rc = writev(ws->fd, iov, iovcnt);
346 else if (errno == EAGAIN) {
349 pfd.events = POLLOUT;
359 * callback for reading data
361 static ssize_t aws_readv(struct afb_ws *ws, const struct iovec *iov, int iovcnt)
365 rc = readv(ws->fd, iov, iovcnt);
366 } while(rc == -1 && errno == EINTR);
375 * callback on incoming data
377 static void aws_on_readable(struct afb_ws *ws)
381 assert(ws->ws != NULL);
382 rc = websock_dispatch(ws->ws, 0);
383 if (rc < 0 && errno == EPIPE)
388 * Reads from the websocket handled by 'ws' data of length 'size'
389 * and append it to the current buffer of 'ws'.
390 * Returns 0 in case of error or 1 in case of success.
392 static int aws_read(struct afb_ws *ws, size_t size)
398 if (size != 0 || ws->buffer.buffer == NULL) {
399 buffer = realloc(ws->buffer.buffer, ws->buffer.size + size + 1);
402 ws->buffer.buffer = buffer;
404 sz = websock_read(ws->ws, &buffer[ws->buffer.size], size);
410 poll(&pfd, 1, 10); /* TODO: make fully asynchronous websockets */
412 ws->buffer.size += (size_t)sz;
421 * Callback when 'close' command received from 'ws' with 'code' and 'size'.
423 static void aws_on_close(struct afb_ws *ws, uint16_t code, size_t size)
428 free(aws_pick_buffer(ws).buffer);
429 if (ws->itf->on_close == NULL) {
430 websock_drop(ws->ws);
432 } else if (!aws_read(ws, size))
433 ws->itf->on_close(ws->closure, code, NULL, 0);
435 b = aws_pick_buffer(ws);
436 ws->itf->on_close(ws->closure, code, b.buffer, b.size);
441 * Drops any incoming data and send an error of 'code'
443 static void aws_drop_error(struct afb_ws *ws, uint16_t code)
446 free(aws_pick_buffer(ws).buffer);
447 websock_drop(ws->ws);
448 websock_error(ws->ws, code, NULL, 0);
452 * Reads either text or binary data of 'size' from 'ws' eventually 'last'.
454 static void aws_continue(struct afb_ws *ws, int last, size_t size)
459 if (!aws_read(ws, size))
460 aws_drop_error(ws, WEBSOCKET_CODE_ABNORMAL);
462 istxt = ws->state == reading_text;
464 b = aws_pick_buffer(ws);
465 b.buffer[b.size] = 0;
466 (istxt ? ws->itf->on_text : ws->itf->on_binary)(ws->closure, b.buffer, b.size);
471 * Callback when 'text' message received from 'ws' with 'size' and possibly 'last'.
473 static void aws_on_text(struct afb_ws *ws, int last, size_t size)
475 if (ws->state != waiting)
476 aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR);
477 else if (ws->itf->on_text == NULL)
478 aws_drop_error(ws, WEBSOCKET_CODE_CANT_ACCEPT);
480 ws->state = reading_text;
481 aws_continue(ws, last, size);
486 * Callback when 'binary' message received from 'ws' with 'size' and possibly 'last'.
488 static void aws_on_binary(struct afb_ws *ws, int last, size_t size)
490 if (ws->state != waiting)
491 aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR);
492 else if (ws->itf->on_binary == NULL)
493 aws_drop_error(ws, WEBSOCKET_CODE_CANT_ACCEPT);
495 ws->state = reading_binary;
496 aws_continue(ws, last, size);
501 * Callback when 'continue' command received from 'ws' with 'code' and 'size'.
503 static void aws_on_continue(struct afb_ws *ws, int last, size_t size)
505 if (ws->state == waiting)
506 aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR);
508 aws_continue(ws, last, size);
512 * Callback when 'close' command is sent to 'ws' with 'code' and 'size'.
514 static void aws_on_error(struct afb_ws *ws, uint16_t code, const void *data, size_t size)
516 if (ws->itf->on_error != NULL)
517 ws->itf->on_error(ws->closure, code, data, size);