HelenOS sources

root/uspace/lib/http/src/receive-buffer.c

DEFINITIONS

1. recv_buffer_init
2. dummy_receive
3. recv_buffer_init_const
4. recv_buffer_fini
5. recv_reset
6. recv_mark
7. recv_unmark
8. recv_mark_update
9. recv_cut
10. recv_cut_str
11. recv_char
12. recv_buffer
13. recv_discard
14. recv_discard_str
15. recv_while
16. recv_eol
17. recv_line

/*
 * Copyright (c) 2012 Jiri Svoboda
 * Copyright (c) 2013 Martin Sucha
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** @addtogroup http
 * @{
 */
/**
 * @file
 */

#include <stdlib.h>
#include <str.h>
#include <errno.h>
#include <macros.h>
#include <adt/list.h>

#include <http/receive-buffer.h>

errno_t recv_buffer_init(receive_buffer_t *rb, size_t buffer_size,
    receive_func_t receive, void *client_data)
{
        rb->receive = receive;
        rb->client_data = client_data;

        rb->in = 0;
        rb->out = 0;
        rb->size = buffer_size;

        list_initialize(&rb->marks);

        rb->buffer = malloc(buffer_size);
        if (rb->buffer == NULL)
                return ENOMEM;
        return EOK;
}

static errno_t dummy_receive(void *unused, void *buf, size_t buf_size,
    size_t *nrecv)
{
        *nrecv = 0;
        return EOK;
}

errno_t recv_buffer_init_const(receive_buffer_t *rb, void *buf, size_t size)
{
        errno_t rc = recv_buffer_init(rb, size, dummy_receive, NULL);
        if (rc != EOK)
                return rc;

        memcpy(rb->buffer, buf, size);
        rb->in = size;
        return EOK;
}

void recv_buffer_fini(receive_buffer_t *rb)
{
        free(rb->buffer);
}

void recv_reset(receive_buffer_t *rb)
{
        rb->in = 0;
        rb->out = 0;
}

void recv_mark(receive_buffer_t *rb, receive_buffer_mark_t *mark)
{
        link_initialize(&mark->link);
        list_append(&mark->link, &rb->marks);
        recv_mark_update(rb, mark);
}

void recv_unmark(receive_buffer_t *rb, receive_buffer_mark_t *mark)
{
        list_remove(&mark->link);
}

void recv_mark_update(receive_buffer_t *rb, receive_buffer_mark_t *mark)
{
        mark->offset = rb->out;
}

errno_t recv_cut(receive_buffer_t *rb, receive_buffer_mark_t *a, receive_buffer_mark_t *b, void **out_buf, size_t *out_size)
{
        if (a->offset > b->offset)
                return EINVAL;

        size_t size = b->offset - a->offset;
        void *buf = malloc(size);
        if (buf == NULL)
                return ENOMEM;

        memcpy(buf, rb->buffer + a->offset, size);
        *out_buf = buf;
        *out_size = size;
        return EOK;
}

errno_t recv_cut_str(receive_buffer_t *rb, receive_buffer_mark_t *a, receive_buffer_mark_t *b, char **out_buf)
{
        if (a->offset > b->offset)
                return EINVAL;

        size_t size = b->offset - a->offset;
        char *buf = malloc(size + 1);
        if (buf == NULL)
                return ENOMEM;

        memcpy(buf, rb->buffer + a->offset, size);
        buf[size] = 0;
        for (size_t i = 0; i < size; i++) {
                if (buf[i] == 0) {
                        free(buf);
                        return EIO;
                }
        }
        *out_buf = buf;
        return EOK;
}

/** Receive one character (with buffering) */
errno_t recv_char(receive_buffer_t *rb, char *c, bool consume)
{
        if (rb->out == rb->in) {
                size_t free = rb->size - rb->in;
                if (free == 0) {
                        size_t min_mark = rb->size;
                        list_foreach(rb->marks, link, receive_buffer_mark_t, mark) {
                                min_mark = min(min_mark, mark->offset);
                        }

                        if (min_mark == 0)
                                return ELIMIT;

                        size_t new_in = rb->in - min_mark;
                        memmove(rb->buffer, rb->buffer + min_mark, new_in);
                        rb->out = rb->in = new_in;
                        free = rb->size - rb->in;
                        list_foreach(rb->marks, link, receive_buffer_mark_t, mark) {
                                mark->offset -= min_mark;
                        }
                }

                size_t nrecv;
                errno_t rc = rb->receive(rb->client_data, rb->buffer + rb->in, free, &nrecv);
                if (rc != EOK)
                        return rc;

                rb->in = nrecv;
        }

        *c = rb->buffer[rb->out];
        if (consume)
                rb->out++;
        return EOK;
}

errno_t recv_buffer(receive_buffer_t *rb, char *buf, size_t buf_size,
    size_t *nrecv)
{
        /* Flush any buffered data */
        if (rb->out != rb->in) {
                size_t size = min(rb->in - rb->out, buf_size);
                memcpy(buf, rb->buffer + rb->out, size);
                rb->out += size;
                *nrecv = size;
                return EOK;
        }

        return rb->receive(rb->client_data, buf, buf_size, nrecv);
}

/** Receive a character and if it is c, discard it from input buffer
 * @param ndisc Place to store number of characters discarded
 * @return EOK or an error code
 */
errno_t recv_discard(receive_buffer_t *rb, char discard, size_t *ndisc)
{
        char c = 0;
        errno_t rc = recv_char(rb, &c, false);
        if (rc != EOK)
                return rc;
        if (c != discard) {
                *ndisc = 0;
                return EOK;
        }
        rc = recv_char(rb, &c, true);
        if (rc != EOK)
                return rc;
        *ndisc = 1;
        return EOK;
}

/** Receive a prefix of constant string discard and return number of bytes read
 * @param ndisc Place to store number of characters discarded
 * @return EOK or an error code
 */
errno_t recv_discard_str(receive_buffer_t *rb, const char *discard, size_t *ndisc)
{
        size_t discarded = 0;
        while (*discard) {
                size_t nd;
                errno_t rc = recv_discard(rb, *discard, &nd);
                if (rc != EOK)
                        return rc;
                if (nd == 0)
                        break;
                discarded += nd;
                discard++;
        }

        *ndisc = discarded;
        return EOK;
}

errno_t recv_while(receive_buffer_t *rb, char_class_func_t class)
{
        while (true) {
                char c = 0;
                errno_t rc = recv_char(rb, &c, false);
                if (rc != EOK)
                        return rc;

                if (!class(c))
                        break;

                rc = recv_char(rb, &c, true);
                if (rc != EOK)
                        return rc;
        }

        return EOK;
}

/** Receive an end of line, either CR, LF, CRLF or LFCR
 *
 * @param nrecv Place to store number of bytes received (zero if
 *              no newline is present in the stream)
 * @return EOK on success or an error code
 */
errno_t recv_eol(receive_buffer_t *rb, size_t *nrecv)
{
        char c = 0;
        errno_t rc = recv_char(rb, &c, false);
        if (rc != EOK)
                return rc;

        if (c != '\r' && c != '\n') {
                *nrecv = 0;
                return EOK;
        }

        rc = recv_char(rb, &c, true);
        if (rc != EOK)
                return rc;

        size_t nr;
        rc = recv_discard(rb, (c == '\r' ? '\n' : '\r'), &nr);
        if (rc != EOK)
                return rc;

        *nrecv = 1 + nr;
        return EOK;
}

/* Receive a single line */
errno_t recv_line(receive_buffer_t *rb, char *line, size_t size, size_t *nrecv)
{
        size_t written = 0;
        size_t nr;

        while (written < size) {
                char c = 0;
                errno_t rc = recv_char(rb, &c, true);
                if (rc != EOK)
                        return rc;
                if (c == '\n') {
                        rc = recv_discard(rb, '\r', &nr);
                        if (rc != EOK)
                                return rc;

                        line[written++] = 0;
                        *nrecv = written;
                        return EOK;
                } else if (c == '\r') {
                        rc = recv_discard(rb, '\n', &nr);
                        if (rc != EOK)
                                return rc;
                        line[written++] = 0;
                        *nrecv = written;
                        return EOK;
                }
                line[written++] = c;
        }

        return ELIMIT;
}

/** @}
 */