Blame buckets/chunk_buckets.c

Packit 3adb1e
/* ====================================================================
Packit 3adb1e
 *    Licensed to the Apache Software Foundation (ASF) under one
Packit 3adb1e
 *    or more contributor license agreements.  See the NOTICE file
Packit 3adb1e
 *    distributed with this work for additional information
Packit 3adb1e
 *    regarding copyright ownership.  The ASF licenses this file
Packit 3adb1e
 *    to you under the Apache License, Version 2.0 (the
Packit 3adb1e
 *    "License"); you may not use this file except in compliance
Packit 3adb1e
 *    with the License.  You may obtain a copy of the License at
Packit 3adb1e
 *
Packit 3adb1e
 *      http://www.apache.org/licenses/LICENSE-2.0
Packit 3adb1e
 *
Packit 3adb1e
 *    Unless required by applicable law or agreed to in writing,
Packit 3adb1e
 *    software distributed under the License is distributed on an
Packit 3adb1e
 *    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
Packit 3adb1e
 *    KIND, either express or implied.  See the License for the
Packit 3adb1e
 *    specific language governing permissions and limitations
Packit 3adb1e
 *    under the License.
Packit 3adb1e
 * ====================================================================
Packit 3adb1e
 */
Packit 3adb1e
Packit 3adb1e
#include <apr_pools.h>
Packit 3adb1e
#include <apr_strings.h>
Packit 3adb1e
Packit 3adb1e
#include "serf.h"
Packit 3adb1e
#include "serf_bucket_util.h"
Packit 3adb1e
Packit 3adb1e
Packit 3adb1e
typedef struct {
Packit 3adb1e
    enum {
Packit 3adb1e
        STATE_FETCH,
Packit 3adb1e
        STATE_CHUNK,
Packit 3adb1e
        STATE_EOF
Packit 3adb1e
    } state;
Packit 3adb1e
Packit 3adb1e
    apr_status_t last_status;
Packit 3adb1e
Packit 3adb1e
    serf_bucket_t *chunk;
Packit 3adb1e
    serf_bucket_t *stream;
Packit 3adb1e
Packit 3adb1e
    char chunk_hdr[20];
Packit 3adb1e
} chunk_context_t;
Packit 3adb1e
Packit 3adb1e
Packit 3adb1e
serf_bucket_t *serf_bucket_chunk_create(
Packit 3adb1e
    serf_bucket_t *stream, serf_bucket_alloc_t *allocator)
Packit 3adb1e
{
Packit 3adb1e
    chunk_context_t *ctx;
Packit 3adb1e
Packit 3adb1e
    ctx = serf_bucket_mem_alloc(allocator, sizeof(*ctx));
Packit 3adb1e
    ctx->state = STATE_FETCH;
Packit 3adb1e
    ctx->chunk = serf_bucket_aggregate_create(allocator);
Packit 3adb1e
    ctx->stream = stream;
Packit 3adb1e
Packit 3adb1e
    return serf_bucket_create(&serf_bucket_type_chunk, allocator, ctx);
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
#define CRLF "\r\n"
Packit 3adb1e
Packit 3adb1e
static apr_status_t create_chunk(serf_bucket_t *bucket)
Packit 3adb1e
{
Packit 3adb1e
    chunk_context_t *ctx = bucket->data;
Packit 3adb1e
    serf_bucket_t *simple_bkt;
Packit 3adb1e
    apr_size_t chunk_len;
Packit 3adb1e
    apr_size_t stream_len;
Packit 3adb1e
    struct iovec vecs[66]; /* 64 + chunk trailer + EOF trailer = 66 */
Packit 3adb1e
    int vecs_read;
Packit 3adb1e
    int i;
Packit 3adb1e
Packit 3adb1e
    if (ctx->state != STATE_FETCH) {
Packit 3adb1e
        return APR_SUCCESS;
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    ctx->last_status =
Packit 3adb1e
        serf_bucket_read_iovec(ctx->stream, SERF_READ_ALL_AVAIL,
Packit 3adb1e
                               64, vecs, &vecs_read);
Packit 3adb1e
Packit 3adb1e
    if (SERF_BUCKET_READ_ERROR(ctx->last_status)) {
Packit 3adb1e
        /* Uh-oh. */
Packit 3adb1e
        return ctx->last_status;
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    /* Count the length of the data we read. */
Packit 3adb1e
    stream_len = 0;
Packit 3adb1e
    for (i = 0; i < vecs_read; i++) {
Packit 3adb1e
        stream_len += vecs[i].iov_len;
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    /* assert: stream_len in hex < sizeof(ctx->chunk_hdr) */
Packit 3adb1e
Packit 3adb1e
    /* Inserting a 0 byte chunk indicates a terminator, which already happens
Packit 3adb1e
     * during the EOF handler below.  Adding another one here will cause the
Packit 3adb1e
     * EOF chunk to be interpreted by the server as a new request.  So,
Packit 3adb1e
     * we'll only do this if we have something to write.
Packit 3adb1e
     */
Packit 3adb1e
    if (stream_len) {
Packit 3adb1e
        /* Build the chunk header. */
Packit 3adb1e
        chunk_len = apr_snprintf(ctx->chunk_hdr, sizeof(ctx->chunk_hdr),
Packit 3adb1e
                                 "%" APR_UINT64_T_HEX_FMT CRLF,
Packit 3adb1e
                                 (apr_uint64_t)stream_len);
Packit 3adb1e
Packit 3adb1e
        /* Create a copy of the chunk header so we can have multiple chunks
Packit 3adb1e
         * in the pipeline at the same time.
Packit 3adb1e
         */
Packit 3adb1e
        simple_bkt = serf_bucket_simple_copy_create(ctx->chunk_hdr, chunk_len,
Packit 3adb1e
                                                    bucket->allocator);
Packit 3adb1e
        serf_bucket_aggregate_append(ctx->chunk, simple_bkt);
Packit 3adb1e
Packit 3adb1e
        /* Insert the chunk footer. */
Packit 3adb1e
        vecs[vecs_read].iov_base = CRLF;
Packit 3adb1e
        vecs[vecs_read++].iov_len = sizeof(CRLF) - 1;
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    /* We've reached the end of the line for the stream. */
Packit 3adb1e
    if (APR_STATUS_IS_EOF(ctx->last_status)) {
Packit 3adb1e
        /* Insert the chunk footer. */
Packit 3adb1e
        vecs[vecs_read].iov_base = "0" CRLF CRLF;
Packit 3adb1e
        vecs[vecs_read++].iov_len = sizeof("0" CRLF CRLF) - 1;
Packit 3adb1e
Packit 3adb1e
        ctx->state = STATE_EOF;
Packit 3adb1e
    }
Packit 3adb1e
    else {
Packit 3adb1e
        /* Okay, we can return data.  */
Packit 3adb1e
        ctx->state = STATE_CHUNK;
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    serf_bucket_aggregate_append_iovec(ctx->chunk, vecs, vecs_read);
Packit 3adb1e
Packit 3adb1e
    return APR_SUCCESS;
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
static apr_status_t serf_chunk_read(serf_bucket_t *bucket,
Packit 3adb1e
                                    apr_size_t requested,
Packit 3adb1e
                                    const char **data, apr_size_t *len)
Packit 3adb1e
{
Packit 3adb1e
    chunk_context_t *ctx = bucket->data;
Packit 3adb1e
    apr_status_t status;
Packit 3adb1e
Packit 3adb1e
    /* Before proceeding, we need to fetch some data from the stream. */
Packit 3adb1e
    if (ctx->state == STATE_FETCH) {
Packit 3adb1e
        status = create_chunk(bucket);
Packit 3adb1e
        if (status) {
Packit 3adb1e
            return status;
Packit 3adb1e
        }
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    status = serf_bucket_read(ctx->chunk, requested, data, len);
Packit 3adb1e
Packit 3adb1e
    /* Mask EOF from aggregate bucket. */
Packit 3adb1e
    if (APR_STATUS_IS_EOF(status) && ctx->state == STATE_CHUNK) {
Packit 3adb1e
        status = ctx->last_status;
Packit 3adb1e
        ctx->state = STATE_FETCH;
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    return status;
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
static apr_status_t serf_chunk_readline(serf_bucket_t *bucket,
Packit 3adb1e
                                         int acceptable, int *found,
Packit 3adb1e
                                         const char **data, apr_size_t *len)
Packit 3adb1e
{
Packit 3adb1e
    chunk_context_t *ctx = bucket->data;
Packit 3adb1e
    apr_status_t status;
Packit 3adb1e
Packit 3adb1e
    status = serf_bucket_readline(ctx->chunk, acceptable, found, data, len);
Packit 3adb1e
Packit 3adb1e
    /* Mask EOF from aggregate bucket. */
Packit 3adb1e
    if (APR_STATUS_IS_EOF(status) && ctx->state == STATE_CHUNK) {
Packit 3adb1e
        status = APR_EAGAIN;
Packit 3adb1e
        ctx->state = STATE_FETCH;
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    return status;
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
static apr_status_t serf_chunk_read_iovec(serf_bucket_t *bucket,
Packit 3adb1e
                                          apr_size_t requested,
Packit 3adb1e
                                          int vecs_size,
Packit 3adb1e
                                          struct iovec *vecs,
Packit 3adb1e
                                          int *vecs_used)
Packit 3adb1e
{
Packit 3adb1e
    chunk_context_t *ctx = bucket->data;
Packit 3adb1e
    apr_status_t status;
Packit 3adb1e
Packit 3adb1e
    /* Before proceeding, we need to fetch some data from the stream. */
Packit 3adb1e
    if (ctx->state == STATE_FETCH) {
Packit 3adb1e
        status = create_chunk(bucket);
Packit 3adb1e
        if (status) {
Packit 3adb1e
            return status;
Packit 3adb1e
        }
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    status = serf_bucket_read_iovec(ctx->chunk, requested, vecs_size, vecs,
Packit 3adb1e
                                    vecs_used);
Packit 3adb1e
Packit 3adb1e
    /* Mask EOF from aggregate bucket. */
Packit 3adb1e
    if (APR_STATUS_IS_EOF(status) && ctx->state == STATE_CHUNK) {
Packit 3adb1e
        status = ctx->last_status;
Packit 3adb1e
        ctx->state = STATE_FETCH;
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    return status;
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
static apr_status_t serf_chunk_peek(serf_bucket_t *bucket,
Packit 3adb1e
                                     const char **data,
Packit 3adb1e
                                     apr_size_t *len)
Packit 3adb1e
{
Packit 3adb1e
    chunk_context_t *ctx = bucket->data;
Packit 3adb1e
    apr_status_t status;
Packit 3adb1e
Packit 3adb1e
    status = serf_bucket_peek(ctx->chunk, data, len);
Packit 3adb1e
Packit 3adb1e
    /* Mask EOF from aggregate bucket. */
Packit 3adb1e
    if (APR_STATUS_IS_EOF(status) && ctx->state == STATE_CHUNK) {
Packit 3adb1e
        status = APR_EAGAIN;
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    return status;
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
static void serf_chunk_destroy(serf_bucket_t *bucket)
Packit 3adb1e
{
Packit 3adb1e
    chunk_context_t *ctx = bucket->data;
Packit 3adb1e
Packit 3adb1e
    serf_bucket_destroy(ctx->stream);
Packit 3adb1e
    serf_bucket_destroy(ctx->chunk);
Packit 3adb1e
Packit 3adb1e
    serf_default_destroy_and_data(bucket);
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
const serf_bucket_type_t serf_bucket_type_chunk = {
Packit 3adb1e
    "CHUNK",
Packit 3adb1e
    serf_chunk_read,
Packit 3adb1e
    serf_chunk_readline,
Packit 3adb1e
    serf_chunk_read_iovec,
Packit 3adb1e
    serf_default_read_for_sendfile,
Packit 3adb1e
    serf_default_read_bucket,
Packit 3adb1e
    serf_chunk_peek,
Packit 3adb1e
    serf_chunk_destroy,
Packit 3adb1e
};