webdiss/tests/websocket.c

/* https://datatracker.ietf.org/doc/html/rfc6455 */

#include <stdlib.h>
#define _GNU_SOURCE
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <pthread.h>
#include <arpa/inet.h>
#include <errno.h>
#include <ctype.h>
#include <getopt.h>

#include <sys/types.h>
#include <sys/socket.h>

#include <event.h>
#include <http_parser.h>

#define DEBUG_LOGS 0

struct host_info {
    char *host;
    short port;
};

enum worker_state {
    WS_INITIAL,
    WS_SENT_HANDSHAKE,
    WS_RECEIVED_HANDSHAKE,
    WS_SENT_FRAME,
    WS_COMPLETE
};

/* worker_thread, with counter of remaining messages */
struct worker_thread {
    struct host_info *hi;
    struct event_base *base;

    int msg_target;
    int msg_received;
    int msg_sent;
    int byte_count;
    int id;
    pthread_t thread;
    enum worker_state state;
    int timeout_seconds;

    struct evbuffer *rbuffer;
    int got_header;

    struct evbuffer *wbuffer;

    int verbose;
    int fd;
    struct event ev_r;
    struct event ev_w;

    http_parser parser;
    http_parser_settings settings;

    int (*debug)(const char *fmt, ...);
};

int debug_noop(const char *fmt, ...) {
    (void)fmt;
    return 0;
}

int debug_verbose(const char *fmt, ...) {
    int ret;
    va_list vargs;
    va_start(vargs, fmt);
    ret = vfprintf(stderr, fmt, vargs);
    va_end(vargs);
    return ret;
}

void
hex_dump(struct worker_thread *wt, char *p, size_t sz) {
    wt->debug("hex dump of %p (%ld bytes)\n", p, sz);
    for (char *cur = p; cur < p + sz; cur += 16) {
        char letters[16] = {0};
        int limit = (cur + 16) > p + sz ? (sz % 16) : 16;
        wt->debug("%08lx ", cur - p); /* address */
        for (int i = 0; i < limit; i++) {
            wt->debug("%02x ", (unsigned int)(cur[i] & 0xff));
            letters[i] = isprint(cur[i]) ? cur[i] : '.';
        }
        for (int i = limit; i < 16; i++) { /* pad on last line */
            wt->debug("   ");
        }
        wt->debug(" %.*s\n", limit, letters);
    }
}

void
evbuffer_debug_dump(struct worker_thread *wt, struct evbuffer *buffer) {
    size_t sz = evbuffer_get_length(buffer);
    char *data = malloc(sz);
    evbuffer_remove(buffer, data, sz);
    hex_dump(wt, data, sz);
    evbuffer_prepend(buffer, data, sz);
    free(data);
}

static void
wait_for_possible_read(struct worker_thread *wt);
static void
wait_for_possible_write(struct worker_thread *wt);

static void
ws_enqueue_frame(struct worker_thread *wt);

void
process_message(struct worker_thread *wt, size_t sz) {

    // printf("process_message\n");
    if(wt->msg_received && wt->msg_received % 1000 == 0) {
        printf("thread %d: %8d messages left (got %9d bytes so far).\n",
            wt->id,
            wt->msg_target - wt->msg_received, wt->byte_count);
    }
    wt->byte_count += sz;

    /* decrement read count, and stop receiving when we reach zero. */
    wt->msg_received++;
    if(wt->msg_received == wt->msg_target) {
        wt->debug("%s: thread %d has received all %d messages it expected\n",
            __func__, wt->id, wt->msg_received);
        event_base_loopexit(wt->base, NULL);
    }
}

/**
 * Called when we can write to the socket.
 */
void
websocket_can_write(int fd, short event, void *ptr) {
    int ret;
    struct worker_thread *wt = ptr;
    wt->debug("%s (wt=%p, fd=%d)\n", __func__, wt, fd);

    if(event != EV_WRITE) {
        return;
    }
    switch (wt->state)
    {
    case WS_INITIAL: { /* still sending initial HTTP request */
        ret = evbuffer_write(wt->wbuffer, fd);
        wt->debug("evbuffer_write returned %d\n", ret);
        wt->debug("evbuffer_get_length returned %d\n", evbuffer_get_length(wt->wbuffer));
        if (evbuffer_get_length(wt->wbuffer) != 0) { /* not all written */
            wait_for_possible_write(wt);
            return;
        }
        /* otherwise, we've sent the full request, time to read the response */
        wt->state = WS_SENT_HANDSHAKE;
        wt->debug("state=WS_SENT_HANDSHAKE\n");
        wait_for_possible_read(wt);
        return;
    }
    case WS_RECEIVED_HANDSHAKE: { /* ready to send a frame */
        wt->debug("About to send data for WS frame, %lu in buffer\n", evbuffer_get_length(wt->wbuffer));
        evbuffer_write(wt->wbuffer, fd);
        size_t write_remains = evbuffer_get_length(wt->wbuffer);
        wt->debug("Sent data for WS frame, still %lu left to write\n", write_remains);
        if (write_remains == 0) { /* ready to read response */
            wt->state = WS_SENT_FRAME;
            wt->msg_sent++;
            wait_for_possible_read(wt);
        } else { /* not finished writing */
            wait_for_possible_write(wt);
        }
        return;
    }
    default:
        break;
    }
}

static void
websocket_can_read(int fd, short event, void *ptr) {
    int ret;

    struct worker_thread *wt = ptr;
    wt->debug("%s (wt=%p)\n", __func__, wt);

    if(event != EV_READ) {
        return;
    }

    /* read message */
    ret = evbuffer_read(wt->rbuffer, fd, 65536);
    wt->debug("evbuffer_read() returned %d; wt->state=%d. wt->rbuffer:\n", ret, wt->state);
    evbuffer_debug_dump(wt, wt->rbuffer);
    if (ret == 0) {
        wt->debug("We didn't read anything from the socket...\n");
        return;
    }

    while(1) {
        switch (wt->state) {
        case WS_SENT_HANDSHAKE: { /* waiting for handshake response */
            size_t avail_sz = evbuffer_get_length(wt->rbuffer);
            char *tmp = calloc(avail_sz, 1);
            wt->debug("avail_sz from rbuffer = %lu\n", avail_sz);
            evbuffer_remove(wt->rbuffer, tmp, avail_sz); /* copy into `tmp` */
            wt->debug("Giving %lu bytes to http-parser\n", avail_sz);
            int nparsed = http_parser_execute(&wt->parser, &wt->settings, tmp, avail_sz);
            wt->debug("http-parser returned %d\n", nparsed);
            if (nparsed != (int)avail_sz) { // put back what we didn't read
                wt->debug("re-attach (prepend) %lu byte%c\n", avail_sz - nparsed,
                          avail_sz - nparsed > 1 ? 's' : ' ');
                evbuffer_prepend(wt->rbuffer, tmp + nparsed, avail_sz - nparsed);
            }
            free(tmp);
            if (wt->state == WS_SENT_HANDSHAKE &&  /* haven't encountered end of response yet */
                wt->parser.upgrade && nparsed != (int)avail_sz) {
                wt->debug("UPGRADE *and* we have some data left\n");
                continue;
            } else if (wt->state == WS_RECEIVED_HANDSHAKE) { /* we have the full response */
                evbuffer_drain(wt->rbuffer, evbuffer_get_length(wt->rbuffer));
            }
            return;
        }

        case WS_SENT_FRAME: { /* waiting for frame response */
            wt->debug("We're in WS_SENT_FRAME, just read a frame response. wt->rbuffer:\n");
            evbuffer_debug_dump(wt, wt->rbuffer);
            uint8_t flag_opcodes, payload_len;
            if (evbuffer_get_length(wt->rbuffer) < 2) { /* not enough data */
                wait_for_possible_read(wt);
                return;
            }
            evbuffer_remove(wt->rbuffer, &flag_opcodes, 1); /* remove flags & opcode */
            evbuffer_remove(wt->rbuffer, &payload_len, 1);  /* remove length */
            evbuffer_drain(wt->rbuffer, (size_t)payload_len); /* remove payload itself */
            process_message(wt, payload_len);

            if (evbuffer_get_length(wt->rbuffer) == 0) { /* consumed everything */
                if (wt->msg_received < wt->msg_target) { /* let's write again */
                    wt->debug("our turn to write again\n");
                    wt->state = WS_RECEIVED_HANDSHAKE;
                    ws_enqueue_frame(wt);
                } /* otherwise, we're done */
                return;
            } else {
                wt->debug("there's still data to consume\n");
                continue;
            }
            return;
        }

        default:
            return;
        }
    }
}


static void
wait_for_possible_read(struct worker_thread *wt) {
    wt->debug("%s (wt=%p)\n", __func__, wt);
    event_set(&wt->ev_r, wt->fd, EV_READ, websocket_can_read, wt);
    event_base_set(wt->base, &wt->ev_r);
    event_add(&wt->ev_r, NULL);
}

static void
wait_for_possible_write(struct worker_thread *wt) {
    wt->debug("%s (wt=%p)\n", __func__, wt);
    event_set(&wt->ev_r, wt->fd, EV_WRITE, websocket_can_write, wt);
    event_base_set(wt->base, &wt->ev_r);
    event_add(&wt->ev_r, NULL);
}

static int
ws_on_headers_complete(http_parser *p) {
    struct worker_thread *wt = p->data;

    wt->debug("%s (wt=%p)\n", __func__, wt);
    // TODO
    return 0;
}

static void
ws_enqueue_frame_for_command(struct worker_thread *wt, char *cmd, size_t sz) {
    unsigned char mask[4];
    for (int i = 0; i < 4; i++) {
        mask[i] = rand() & 0xff;
    }
    uint8_t len = (uint8_t)(sz); /* (1 << 7) | length. */
    len |= (1 << 7); /* set masking bit ON */

    for (size_t i = 0; i < sz; i++) {
        cmd[i] = (cmd[i] ^ mask[i%4]) & 0xff;
    }
    /* 0x81 = 10000001b: FIN bit (only one message in the frame), text frame */
    evbuffer_add(wt->wbuffer, "\x81", 1);
    evbuffer_add(wt->wbuffer, &len, 1);
    evbuffer_add(wt->wbuffer, mask, 4);
    evbuffer_add(wt->wbuffer, cmd, sz);
}

static void
ws_enqueue_frame(struct worker_thread *wt) {
    char ping_command[] = "[\"PING\"]";
    ws_enqueue_frame_for_command(wt, ping_command, sizeof(ping_command) - 1);

    wait_for_possible_write(wt);
}

static int
ws_on_message_complete(http_parser *p) {
    struct worker_thread *wt = p->data;

    wt->debug("%s (wt=%p)\n", __func__, wt);
    // we've received the full HTTP response now, so we're ready to send frames
    wt->state = WS_RECEIVED_HANDSHAKE;
    ws_enqueue_frame(wt); /* add frame to buffer and register interest in writing */
    return 0;
}

static void
ws_on_timeout(evutil_socket_t fd, short event, void *arg) {
    struct worker_thread *wt = arg;
    (void) fd;
    (void) event;

    fprintf(stderr, "Time has run out! (thread %d)\n", wt->id);
    event_base_loopbreak(wt->base); /* break out of event loop */
}

void*
worker_main(void *ptr) {

    char ws_template[] = "GET /.json HTTP/1.1\r\n"
                "Host: %s:%d\r\n"
                "Connection: Upgrade\r\n"
                "Upgrade: WebSocket\r\n"
                "Origin: http://%s:%d\r\n"
                "Sec-WebSocket-Key: webdis-websocket-test-key\r\n"
                "\r\n"
                ;

    struct worker_thread *wt = ptr;

    int ret;
    int fd;
    struct sockaddr_in addr;
    struct timeval timeout_tv;
    struct event *timeout_ev;

    /* connect socket */
    fd = socket(AF_INET, SOCK_STREAM, 0);
    addr.sin_family = AF_INET;
    addr.sin_port = htons(wt->hi->port);
    memset(&(addr.sin_addr), 0, sizeof(addr.sin_addr));
    addr.sin_addr.s_addr = inet_addr(wt->hi->host);

    ret = connect(fd, (struct sockaddr*)&addr, sizeof(struct sockaddr));
    if(ret != 0) {
        fprintf(stderr, "connect: ret=%d: %s\n", ret, strerror(errno));
        return NULL;
    }

    /* initialize worker thread */
    wt->fd = fd;
    wt->base = event_base_new();
    wt->rbuffer = evbuffer_new();
    wt->wbuffer = evbuffer_new(); /* write buffer */
    wt->byte_count = 0;
    wt->got_header = 0;

    /* add timeout, if set */
    if (wt->timeout_seconds > 0) {
        timeout_tv.tv_sec = wt->timeout_seconds;
        timeout_tv.tv_usec = 0;
        timeout_ev = event_new(wt->base, -1, EV_TIMEOUT, ws_on_timeout, wt);
        event_add(timeout_ev, &timeout_tv);
    }

    /* initialize HTTP parser, to parse the server response */
    memset(&wt->settings, 0, sizeof(http_parser_settings));
    wt->settings.on_headers_complete = ws_on_headers_complete;
    wt->settings.on_message_complete = ws_on_message_complete;
    http_parser_init(&wt->parser, HTTP_RESPONSE);
    wt->parser.data = wt;

    /* add GET request to buffer */
    evbuffer_add_printf(wt->wbuffer, ws_template, wt->hi->host, wt->hi->port,
                        wt->hi->host, wt->hi->port);
    wait_for_possible_write(wt); /* request callback */

    /* go! */
    event_base_dispatch(wt->base);
    wt->debug("event_base_dispatch returned\n");
    event_base_free(wt->base);
    return NULL;
}

void
usage(const char* argv0, char *host_default, short port_default,
        int thread_count_default, int messages_default) {

    printf("Usage: %s [options]\n"
        "Options are:\n"
        "\t[--host|-h] HOST\t(default = \"%s\")\n"
        "\t[--port|-p] PORT\t(default = %d)\n"
        "\t[--clients|-c] THREADS\t(default = %d)\n"
        "\t[--messages|-n] COUNT\t(number of messages per thread, default = %d)\n"
        "\t[--max-time|-t] SECONDS\t(max time to give to the run, default = unlimited)\n"
        "\t[--verbose|-v]\t\t(extremely verbose output)\n",
        argv0, host_default, (int)port_default,
        thread_count_default, messages_default);
}

int
main(int argc, char *argv[]) {

    struct timespec t0, t1;

    int messages_default = 2500;
    int thread_count_default = 4;
    short port_default = 7379;
    char *host_default = "127.0.0.1";

    int msg_target = messages_default;
    int thread_count = thread_count_default;
    int i, opt;
    char *colon;
    long total = 0, total_bytes = 0;
    int verbose = 0;
    int timeout_seconds = -1;

    struct host_info hi = {host_default, port_default};

    struct worker_thread *workers;

    /* getopt */
    struct option long_options[] = {
        {"help", no_argument, NULL, '?'},
        {"host", required_argument, NULL, 'h'},
        {"port", required_argument, NULL, 'p'},
        {"clients", required_argument, NULL, 'c'},
        {"messages", required_argument, NULL, 'n'},
        {"max-time", required_argument, NULL, 't'},
        {"verbose", no_argument, NULL, 'v'},
        {0, 0, 0, 0}
    };
    while ((opt = getopt_long(argc, argv, "h:p:c:n:t:vs", long_options, NULL)) != -1) {
        switch (opt) {
            case 'h':
                colon = strchr(optarg, ':');
                if(!colon) {
                    size_t sz = strlen(optarg);
                    hi.host = calloc(1 + sz, 1);
                    strncpy(hi.host, optarg, sz);
                } else {
                    hi.host = calloc(1+colon-optarg, 1);
                    strncpy(hi.host, optarg, colon-optarg);
                    hi.port = (short)atol(colon+1);
                }
                break;

            case 'p':
                hi.port = (short)atol(optarg);
                break;

            case 'c':
                thread_count = atoi(optarg);
                break;

            case 'n':
                msg_target = atoi(optarg);
                break;

            case 't':
                timeout_seconds = atoi(optarg);
                break;

            case 'v':
                verbose = 1;
                break;

            default: /* '?' */
                usage(argv[0], host_default, port_default,
                        thread_count_default,
                        messages_default);
                exit(EXIT_SUCCESS);
        }
    }

    /* run threads */
    workers = calloc(sizeof(struct worker_thread), thread_count);

    clock_gettime(CLOCK_MONOTONIC, &t0);
    for (i = 0; i < thread_count; ++i) {
        workers[i].id = i;
        workers[i].msg_target = msg_target;
        workers[i].hi = &hi;
        workers[i].verbose = verbose;
        workers[i].state = WS_INITIAL;
        workers[i].debug = verbose ? debug_verbose : debug_noop;
        workers[i].timeout_seconds = timeout_seconds;
        if (thread_count == 1) {
            printf("Single-threaded mode\n");
            worker_main(&workers[0]);
        } else { /* create threads */
            pthread_create(&workers[i].thread, NULL,
                           worker_main, &workers[i]);
        }
    }

    /* wait for threads to finish */
    for (i = 0; i < thread_count; ++i) {
        if (thread_count > 1) {
            pthread_join(workers[i].thread, NULL);
        }
        total += workers[i].msg_received;
        total_bytes += workers[i].byte_count;
    }

    /* timing */
    clock_gettime(CLOCK_MONOTONIC, &t1);
    float mili0 = t0.tv_sec * 1000 + t0.tv_nsec / 1000000;
    float mili1 = t1.tv_sec * 1000 + t1.tv_nsec / 1000000;

    if(total != 0) {
        double kb_per_sec = ((double)total_bytes / (double)(mili1-mili0)) / 1.024;
        printf("Read %ld messages (%ld bytes) in %0.2f sec: %0.2f msg/sec (%0.2f KB/sec)\n",
            total,
            total_bytes,
            (mili1-mili0)/1000.0,
            1000*((double)total)/(mili1-mili0),
            kb_per_sec);
        return (total == thread_count * msg_target ? EXIT_SUCCESS : EXIT_FAILURE);
    } else {
        printf("No message was read.\n");
        return EXIT_FAILURE;
    }
}