src/afb-ws.c

   1 /*
   2  * Copyright (C) 2016, 2017 "IoT.bzh"
   3  * Author: José Bollo <jose.bollo@iot.bzh>
   4  *
   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
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  */
  17
  18 #define _GNU_SOURCE
  19 #include <stdlib.h>
  20 #include <unistd.h>
  21 #include <stdint.h>
  22 #include <assert.h>
  23 #include <errno.h>
  24 #include <sys/uio.h>
  25 #include <string.h>
  26 #include <stdarg.h>
  27 #include <poll.h>
  28
  29 #include <systemd/sd-event.h>
  30
  31 #include "websock.h"
  32 #include "afb-ws.h"
  33
  34 #include "afb-common.h"
  35
  36 /*
  37  * declaration of the websock interface for afb-ws
  38  */
  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);
  47
  48 static struct websock_itf aws_itf = {
  49         .writev = (void*)aws_writev,
  50         .readv = (void*)aws_readv,
  51
  52         .on_ping = NULL,
  53         .on_pong = NULL,
  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,
  58         .on_extension = NULL,
  59
  60         .on_error = (void*)aws_on_error
  61 };
  62
  63 /*
  64  * a common scheme of buffer handling
  65  */
  66 struct buf
  67 {
  68         char *buffer;
  69         size_t size;
  70 };
  71
  72 /*
  73  * the state
  74  */
  75 enum state
  76 {
  77         waiting,
  78         reading_text,
  79         reading_binary
  80 };
  81
  82 /*
  83  * the afb_ws structure
  84  */
  85 struct afb_ws
  86 {
  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 */
  94 };
  95
  96 /*
  97  * Returns the current buffer of 'ws' that is reset.
  98  */
  99 static inline struct buf aws_pick_buffer(struct afb_ws *ws)
 100 {
 101         struct buf result = ws->buffer;
 102         if (result.buffer)
 103                 result.buffer[result.size] = 0;
 104         ws->buffer.buffer = NULL;
 105         ws->buffer.size = 0;
 106         return result;
 107 }
 108
 109 /*
 110  * Clear the current buffer
 111  */
 112 static inline void aws_clear_buffer(struct afb_ws *ws)
 113 {
 114         ws->buffer.size = 0;
 115 }
 116
 117 /*
 118  * Disconnect the websocket 'ws' and calls on_hangup if
 119  * 'call_on_hangup' is not null.
 120  */
 121 static void aws_disconnect(struct afb_ws *ws, int call_on_hangup)
 122 {
 123         struct websock *wsi = ws->ws;
 124         if (wsi != NULL) {
 125                 ws->ws = NULL;
 126                 sd_event_source_unref(ws->evsrc);
 127                 ws->evsrc = NULL;
 128                 websock_destroy(wsi);
 129                 free(ws->buffer.buffer);
 130                 ws->state = waiting;
 131                 if (call_on_hangup && ws->itf->on_hangup)
 132                         ws->itf->on_hangup(ws->closure);
 133         }
 134 }
 135
 136 static int io_event_callback(sd_event_source *src, int fd, uint32_t revents, void *ws)
 137 {
 138         if ((revents & EPOLLIN) != 0)
 139                 aws_on_readable(ws);
 140         if ((revents & EPOLLHUP) != 0)
 141                 afb_ws_hangup(ws);
 142         return 0;
 143 }
 144
 145 /*
 146  * Creates the afb_ws structure for the file descritor
 147  * 'fd' and the callbacks described by the interface 'itf'
 148  * and its 'closure'.
 149  * When the creation is a success, the systemd event loop 'eloop' is
 150  * used for handling event for 'fd'.
 151  *
 152  * Returns the handle for the afb_ws created or NULL on error.
 153  */
 154 struct afb_ws *afb_ws_create(struct sd_event *eloop, int fd, const struct afb_ws_itf *itf, void *closure)
 155 {
 156         int rc;
 157         struct afb_ws *result;
 158
 159         assert(fd >= 0);
 160
 161         /* allocation */
 162         result = malloc(sizeof * result);
 163         if (result == NULL)
 164                 goto error;
 165
 166         /* init */
 167         result->fd = fd;
 168         result->state = waiting;
 169         result->itf = itf;
 170         result->closure = closure;
 171         result->buffer.buffer = NULL;
 172         result->buffer.size = 0;
 173
 174         /* creates the websocket */
 175         result->ws = websock_create_v13(&aws_itf, result);
 176         if (result->ws == NULL)
 177                 goto error2;
 178
 179         /* creates the evsrc */
 180         rc = sd_event_add_io(eloop, &result->evsrc, result->fd, EPOLLIN, io_event_callback, result);
 181         if (rc < 0) {
 182                 errno = -rc;
 183                 goto error3;
 184         }
 185         return result;
 186
 187 error3:
 188         websock_destroy(result->ws);
 189 error2:
 190         free(result);
 191 error:
 192         return NULL;
 193 }
 194
 195 /*
 196  * Destroys the websocket 'ws'
 197  * It first hangup (but without calling on_hangup for safety reasons)
 198  * if needed.
 199  */
 200 void afb_ws_destroy(struct afb_ws *ws)
 201 {
 202         aws_disconnect(ws, 0);
 203         free(ws);
 204 }
 205
 206 /*
 207  * Hangup the websocket 'ws'
 208  */
 209 void afb_ws_hangup(struct afb_ws *ws)
 210 {
 211         aws_disconnect(ws, 1);
 212 }
 213
 214 /*
 215  * Is the websocket 'ws' still connected ?
 216  */
 217 int afb_ws_is_connected(struct afb_ws *ws)
 218 {
 219         return ws->ws != NULL;
 220 }
 221
 222 /*
 223  * Sends a 'close' command to the endpoint of 'ws' with the 'code' and the
 224  * 'reason' (that can be NULL and that else should not be greater than 123
 225  * characters).
 226  * Returns 0 on success or -1 in case of error.
 227  */
 228 int afb_ws_close(struct afb_ws *ws, uint16_t code, const char *reason)
 229 {
 230         if (ws->ws == NULL) {
 231                 /* disconnected */
 232                 errno = EPIPE;
 233                 return -1;
 234         }
 235         return websock_close(ws->ws, code, reason, reason == NULL ? 0 : strlen(reason));
 236 }
 237
 238 /*
 239  * Sends a 'close' command to the endpoint of 'ws' with the 'code' and the
 240  * 'reason' (that can be NULL and that else should not be greater than 123
 241  * characters).
 242  * Raise an error after 'close' command is sent.
 243  * Returns 0 on success or -1 in case of error.
 244  */
 245 int afb_ws_error(struct afb_ws *ws, uint16_t code, const char *reason)
 246 {
 247         if (ws->ws == NULL) {
 248                 /* disconnected */
 249                 errno = EPIPE;
 250                 return -1;
 251         }
 252         return websock_error(ws->ws, code, reason, reason == NULL ? 0 : strlen(reason));
 253 }
 254
 255 /*
 256  * Sends a 'text' of 'length' to the endpoint of 'ws'.
 257  * Returns 0 on success or -1 in case of error.
 258  */
 259 int afb_ws_text(struct afb_ws *ws, const char *text, size_t length)
 260 {
 261         if (ws->ws == NULL) {
 262                 /* disconnected */
 263                 errno = EPIPE;
 264                 return -1;
 265         }
 266         return websock_text(ws->ws, 1, text, length);
 267 }
 268
 269 /*
 270  * Sends a variable list of texts to the endpoint of 'ws'.
 271  * Returns 0 on success or -1 in case of error.
 272  */
 273 int afb_ws_texts(struct afb_ws *ws, ...)
 274 {
 275         va_list args;
 276         struct iovec ios[32];
 277         int count;
 278         const char *s;
 279
 280         if (ws->ws == NULL) {
 281                 /* disconnected */
 282                 errno = EPIPE;
 283                 return -1;
 284         }
 285
 286         count = 0;
 287         va_start(args, ws);
 288         s = va_arg(args, const char *);
 289         while (s != NULL) {
 290                 if (count == 32) {
 291                         errno = EINVAL;
 292                         return -1;
 293                 }
 294                 ios[count].iov_base = (void*)s;
 295                 ios[count].iov_len = strlen(s);
 296                 count++;
 297                 s = va_arg(args, const char *);
 298         }
 299         va_end(args);
 300         return websock_text_v(ws->ws, 1, ios, count);
 301 }
 302
 303 /*
 304  * Sends a text data described in the 'count' 'iovec' to the endpoint of 'ws'.
 305  * Returns 0 on success or -1 in case of error.
 306  */
 307 int afb_ws_text_v(struct afb_ws *ws, const struct iovec *iovec, int count)
 308 {
 309         if (ws->ws == NULL) {
 310                 /* disconnected */
 311                 errno = EPIPE;
 312                 return -1;
 313         }
 314         return websock_text_v(ws->ws, 1, iovec, count);
 315 }
 316
 317 /*
 318  * Sends a binary 'data' of 'length' to the endpoint of 'ws'.
 319  * Returns 0 on success or -1 in case of error.
 320  */
 321 int afb_ws_binary(struct afb_ws *ws, const void *data, size_t length)
 322 {
 323         if (ws->ws == NULL) {
 324                 /* disconnected */
 325                 errno = EPIPE;
 326                 return -1;
 327         }
 328         return websock_binary(ws->ws, 1, data, length);
 329 }
 330
 331 /*
 332  * Sends a binary data described in the 'count' 'iovec' to the endpoint of 'ws'.
 333  * Returns 0 on success or -1 in case of error.
 334  */
 335 int afb_ws_binary_v(struct afb_ws *ws, const struct iovec *iovec, int count)
 336 {
 337         if (ws->ws == NULL) {
 338                 /* disconnected */
 339                 errno = EPIPE;
 340                 return -1;
 341         }
 342         return websock_binary_v(ws->ws, 1, iovec, count);
 343 }
 344
 345 /*
 346  * callback for writing data
 347  */
 348 static ssize_t aws_writev(struct afb_ws *ws, const struct iovec *iov, int iovcnt)
 349 {
 350         ssize_t rc;
 351         for (;;) {
 352                 rc = writev(ws->fd, iov, iovcnt);
 353                 if (rc == -1) {
 354                         if (errno == EINTR)
 355                                 continue;
 356                         else if (errno == EAGAIN) {
 357                                 struct pollfd pfd;
 358                                 pfd.fd = ws->fd;
 359                                 pfd.events = POLLOUT;
 360                                 poll(&pfd, 1, 10);
 361                                 continue;
 362                         }
 363                 }
 364                 return rc;
 365         }
 366 }
 367
 368 /*
 369  * callback for reading data
 370  */
 371 static ssize_t aws_readv(struct afb_ws *ws, const struct iovec *iov, int iovcnt)
 372 {
 373         ssize_t rc;
 374         do {
 375                 rc = readv(ws->fd, iov, iovcnt);
 376         } while(rc == -1 && errno == EINTR);
 377         if (rc == 0) {
 378                 errno = EPIPE;
 379                 rc = -1;
 380         }
 381         return rc;
 382 }
 383
 384 /*
 385  * callback on incoming data
 386  */
 387 static void aws_on_readable(struct afb_ws *ws)
 388 {
 389         int rc;
 390
 391         assert(ws->ws != NULL);
 392         rc = websock_dispatch(ws->ws, 0);
 393         if (rc < 0 && errno == EPIPE)
 394                 afb_ws_hangup(ws);
 395 }
 396
 397 /*
 398  * Reads from the websocket handled by 'ws' data of length 'size'
 399  * and append it to the current buffer of 'ws'.
 400  * Returns 0 in case of error or 1 in case of success.
 401  */
 402 static int aws_read(struct afb_ws *ws, size_t size)
 403 {
 404         struct pollfd pfd;
 405         ssize_t sz;
 406         char *buffer;
 407
 408         if (size != 0 || ws->buffer.buffer == NULL) {
 409                 buffer = realloc(ws->buffer.buffer, ws->buffer.size + size + 1);
 410                 if (buffer == NULL)
 411                         return 0;
 412                 ws->buffer.buffer = buffer;
 413                 while (size != 0) {
 414                         sz = websock_read(ws->ws, &buffer[ws->buffer.size], size);
 415                         if (sz < 0) {
 416                                 if (errno != EAGAIN)
 417                                         return 0;
 418                                 pfd.fd = ws->fd;
 419                                 pfd.events = POLLIN;
 420                                 poll(&pfd, 1, 10); /* TODO: make fully asynchronous websockets */
 421                         } else {
 422                                 ws->buffer.size += (size_t)sz;
 423                                 size -= (size_t)sz;
 424                         }
 425                 }
 426         }
 427         return 1;
 428 }
 429
 430 /*
 431  * Callback when 'close' command received from 'ws' with 'code' and 'size'.
 432  */
 433 static void aws_on_close(struct afb_ws *ws, uint16_t code, size_t size)
 434 {
 435         struct buf b;
 436
 437         ws->state = waiting;
 438         aws_clear_buffer(ws);
 439         if (ws->itf->on_close == NULL) {
 440                 websock_drop(ws->ws);
 441                 afb_ws_hangup(ws);
 442         } else if (!aws_read(ws, size))
 443                 ws->itf->on_close(ws->closure, code, NULL, 0);
 444         else {
 445                 b = aws_pick_buffer(ws);
 446                 ws->itf->on_close(ws->closure, code, b.buffer, b.size);
 447         }
 448 }
 449
 450 /*
 451  * Drops any incoming data and send an error of 'code'
 452  */
 453 static void aws_drop_error(struct afb_ws *ws, uint16_t code)
 454 {
 455         ws->state = waiting;
 456         aws_clear_buffer(ws);
 457         websock_drop(ws->ws);
 458         websock_error(ws->ws, code, NULL, 0);
 459 }
 460
 461 /*
 462  * Reads either text or binary data of 'size' from 'ws' eventually 'last'.
 463  */
 464 static void aws_continue(struct afb_ws *ws, int last, size_t size)
 465 {
 466         struct buf b;
 467         int istxt;
 468
 469         if (!aws_read(ws, size))
 470                 aws_drop_error(ws, WEBSOCKET_CODE_ABNORMAL);
 471         else if (last) {
 472                 istxt = ws->state == reading_text;
 473                 ws->state = waiting;
 474                 b = aws_pick_buffer(ws);
 475                 (istxt ? ws->itf->on_text : ws->itf->on_binary)(ws->closure, b.buffer, b.size);
 476         }
 477 }
 478
 479 /*
 480  * Callback when 'text' message received from 'ws' with 'size' and possibly 'last'.
 481  */
 482 static void aws_on_text(struct afb_ws *ws, int last, size_t size)
 483 {
 484         if (ws->state != waiting)
 485                 aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR);
 486         else if (ws->itf->on_text == NULL)
 487                 aws_drop_error(ws, WEBSOCKET_CODE_CANT_ACCEPT);
 488         else {
 489                 ws->state = reading_text;
 490                 aws_continue(ws, last, size);
 491         }
 492 }
 493
 494 /*
 495  * Callback when 'binary' message received from 'ws' with 'size' and possibly 'last'.
 496  */
 497 static void aws_on_binary(struct afb_ws *ws, int last, size_t size)
 498 {
 499         if (ws->state != waiting)
 500                 aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR);
 501         else if (ws->itf->on_binary == NULL)
 502                 aws_drop_error(ws, WEBSOCKET_CODE_CANT_ACCEPT);
 503         else {
 504                 ws->state = reading_binary;
 505                 aws_continue(ws, last, size);
 506         }
 507 }
 508
 509 /*
 510  * Callback when 'continue' command received from 'ws' with 'code' and 'size'.
 511  */
 512 static void aws_on_continue(struct afb_ws *ws, int last, size_t size)
 513 {
 514         if (ws->state == waiting)
 515                 aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR);
 516         else
 517                 aws_continue(ws, last, size);
 518 }
 519
 520 /*
 521  * Callback when 'close' command is sent to 'ws' with 'code' and 'size'.
 522  */
 523 static void aws_on_error(struct afb_ws *ws, uint16_t code, const void *data, size_t size)
 524 {
 525         if (ws->itf->on_error != NULL)
 526                 ws->itf->on_error(ws->closure, code, data, size);
 527         else
 528                 afb_ws_hangup(ws);
 529 }
 530
 531