view src/http/ngx_http_output_filter.c @ 60:50186b49f2ad

nginx-0.0.1-2003-02-11-10:14:40 import
author Igor Sysoev <igor@sysoev.ru>
date Tue, 11 Feb 2003 07:14:40 +0000
parents e8cdc2989cee
children 4f3e2abcc2c4
line wrap: on
line source


#include <ngx_config.h>

#include <ngx_core.h>
#include <ngx_files.h>
#include <ngx_string.h>
#include <ngx_hunk.h>
#include <ngx_conf_file.h>

#include <ngx_http.h>
#include <ngx_http_config.h>
#include <ngx_http_output_filter.h>


static int ngx_http_output_filter_copy_hunk(ngx_hunk_t *dst, ngx_hunk_t *src);
static void *ngx_http_output_filter_create_conf(ngx_pool_t *pool);
static char *ngx_http_output_filter_merge_conf(ngx_pool_t *pool,
                                               void *parent, void *child);


static ngx_command_t  ngx_http_output_filter_commands[] = {

    {ngx_string("output_buffer"),
     NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
     ngx_conf_set_size_slot,
     NGX_HTTP_LOC_CONF_OFFSET,
     offsetof(ngx_http_output_filter_conf_t, hunk_size)},

    {ngx_string(""), 0, NULL, 0, 0}
};


static ngx_http_module_t  ngx_http_output_filter_module_ctx = {
    NGX_HTTP_MODULE,

    NULL,                                  /* create server config */
    NULL,                                  /* init server config */
    ngx_http_output_filter_create_conf,    /* create location config */
    ngx_http_output_filter_merge_conf,     /* merge location config */

    NULL,                                  /* translate handler */

    NULL,                                  /* output header filter */
    NULL,                                  /* next output header filter */
    (int (*)(ngx_http_request_t *, ngx_chain_t *))
        ngx_http_output_filter,            /* output body filter */
    NULL                                   /* next output body filter */
};


ngx_module_t  ngx_http_output_filter_module = {
    0,                                     /* module index */
    &ngx_http_output_filter_module_ctx,    /* module context */
    ngx_http_output_filter_commands,       /* module directives */
    NGX_HTTP_MODULE_TYPE,                  /* module type */
    NULL                                   /* init module */
};


#if 1

#define next_filter  ngx_http_output_filter_module_ctx.next_output_body_filter

#define need_to_copy(r, hunk)                                             \
            (((r->filter & NGX_HTTP_FILTER_NEED_IN_MEMORY)                \
               && (hunk->type & NGX_HUNK_FILE))                           \
            || ((r->filter & NGX_HTTP_FILTER_NEED_TEMP)                   \
               && (hunk->type & (NGX_HUNK_MEMORY|NGX_HUNK_MMAP))))

int ngx_http_output_filter(ngx_http_request_t *r, ngx_hunk_t *hunk)
{
    int                             rc;
    size_t                          size;
    ngx_chain_t                    *ce, *pe;
    ngx_http_output_filter_ctx_t   *ctx;
    ngx_http_output_filter_conf_t  *conf;

    ctx = (ngx_http_output_filter_ctx_t *)
                    ngx_http_get_module_ctx(r->main ? r->main : r,
                                            ngx_http_output_filter_module);

    if (ctx == NULL) {
        ngx_http_create_ctx(r, ctx, ngx_http_output_filter_module,
                            sizeof(ngx_http_output_filter_ctx_t));
    }

    /* the incoming chain ctx->in is empty */
    if (ctx->in == NULL) {

        if (hunk == NULL) {
            return next_filter(r, NULL);
        }

        /* we do not need to copy the incoming hunk to our hunk */
        if (!need_to_copy(r, hunk)) {
            ctx->out.hunk = hunk;
            ctx->out.next = NULL;

            return next_filter(r, &ctx->out);
        }

        /* we need to copy the incoming hunk to our hunk */

        /* allocate ctx->hunk if it's needed */
        if (ctx->hunk == NULL) {

            conf = (ngx_http_output_filter_conf_t *)
                   ngx_http_get_module_loc_conf(r->main ? r->main : r,
                                                ngx_http_output_filter_module);

            if (hunk->type & NGX_HUNK_LAST) {
                size = hunk->last.mem - hunk->pos.mem;
                if (size > conf->hunk_size) {
                    size = conf->hunk_size;
                }

            } else {
                size = conf->hunk_size;
            }

            ngx_test_null(ctx->hunk,
                          ngx_create_temp_hunk(r->pool, size, 50, 50),
                          NGX_ERROR);

            ctx->hunk->type |= NGX_HUNK_RECYCLED;
        }

        /* copy the incoming hunk or its part to our hunk
           and pass it to the next filter */

        do {
            rc = ngx_http_output_filter_copy_hunk(ctx->hunk, hunk);

            if (rc == NGX_ERROR) {
                return rc;
            }

#if (NGX_FILE_AIO_READ)

            if (rc == NGX_AGAIN) {
                /* add the incoming hunk to the incoming chain */
                ngx_add_hunk_to_chain(ctx->in, hunk, r->pool, NGX_ERROR);
                return rc;
            }

#endif
            ctx->out.hunk = ctx->hunk;
            ctx->out.next = NULL;

            rc = next_filter(r, &ctx->out);

            if (rc == NGX_ERROR) {
                return rc;
            }

            if (rc == NGX_AGAIN) {
                /* add the incoming hunk to the incoming chain */
                ngx_add_hunk_to_chain(ctx->in, hunk, r->pool, NGX_ERROR);
                return rc;
            }

            /* NGX_OK */

            /* set our hunk free */
            ctx->hunk->pos.mem = ctx->hunk->last.mem = ctx->hunk->start;

        /* repeat until we will have copied the whole incoming hunk */
        } while (hunk->pos.mem < hunk->last.mem);

        return NGX_OK;
    }

    /* the incoming chain ctx->in is not empty */

    /* add the incoming hunk to the incoming chain */
    if (hunk) {
        for (ce = ctx->in; ce->next; ce = ce->next) {
            /* void */ ;
        }

        ngx_add_hunk_to_chain(ce->next, hunk, r->pool, NGX_ERROR);
    }

    /* our hunk is still busy */
    if (ctx->hunk->pos.mem < ctx->hunk->last.mem) {
        rc = next_filter(r, NULL);

        if (rc == NGX_ERROR || rc == NGX_AGAIN) {
            return rc;
        }

        /* NGX_OK */
        ctx->hunk->pos.mem = ctx->hunk->last.mem = ctx->hunk->start;
    }

#if (NGX_SUPPRESS_WARN)
    pe = NULL;
#endif

    /* process the incoming chain ctx->in */
    do {
        /* find the hunks that do not need to be copied ... */
        for (ce = ctx->in; ce; ce = ce->next) {
            if (need_to_copy(r, ce->hunk)) {
                break;
            }
            pe = ce;
        }

        /* ... and pass them to the next filter */
        if (ctx->in != ce) {

            ctx->out.hunk = ctx->in->hunk;
            ctx->out.next = ctx->in->next;
            ctx->in = ce;
            pe->next = NULL;

            rc = next_filter(r, &ctx->out);

            if (rc == NGX_ERROR || rc == NGX_AGAIN) {
                return rc;
            }

            /* NGX_OK */
            if (ctx->in == NULL) {
                return rc;
            }
        }


        /* copy the first hunk or its part from the incoming chain ctx->in
           to our hunk and pass it to the next filter */
        do {
            rc = ngx_http_output_filter_copy_hunk(ctx->hunk, ctx->in->hunk);

            if (rc == NGX_ERROR) {
                return rc;
            }

#if (NGX_FILE_AIO_READ)

            if (rc == NGX_AGAIN) {
                return rc;
            }

#endif
            ctx->out.hunk = ctx->hunk;
            ctx->out.next = NULL;

            rc = next_filter(r, &ctx->out);

            if (rc == NGX_ERROR || rc == NGX_AGAIN) {
                return rc;
            }

            /* NGX_OK */

            /* set our hunk free */
            ctx->hunk->pos.mem = ctx->hunk->last.mem = ctx->hunk->start;

        /* repeat until we will have copied the whole first hunk from
           the incoming chain ctx->in */
        } while (ctx->in->hunk->pos.mem < ctx->in->hunk->last.mem);

    /* delete the completed hunk from the incoming chain */
    ctx->in = ctx->in->next;

    /* repeat until we will have processed the whole incoming chain ctx->in */
    } while (ctx->in);

    return NGX_OK;
}


#else


int ngx_http_output_filter(ngx_http_request_t *r, ngx_hunk_t *hunk)
{
    int                             rc, once;
    u_int                           flags;
    size_t                          size;
    ngx_chain_t                    *ce;
    ngx_http_output_filter_ctx_t   *ctx;
    ngx_http_output_filter_conf_t  *conf;

    ctx = (ngx_http_output_filter_ctx_t *)
                    ngx_http_get_module_ctx(r->main ? r->main : r,
                                            ngx_http_output_filter_module);

    if (ctx == NULL) {
        ngx_http_create_ctx(r, ctx, ngx_http_output_filter_module,
                            sizeof(ngx_http_output_filter_ctx_t));
    }

    if (hunk && (hunk->type & NGX_HUNK_LAST)) {
        ctx->last = 1;
    }

#if (NGX_SUPPRESS_WARN)
    rc = NGX_ALERT;
#endif

    for (once = 1; once || ctx->in; once = 0) {

         /* input chain is not empty */
        if (ctx->in) {

            /* add hunk to input chain */
            if (once && hunk) {
                for (ce = ctx->in; ce->next; ce = ce->next) {
                    /* void */ ;
                }

                ngx_add_hunk_to_chain(ce->next, hunk, r->pool, NGX_ERROR);
            }

            /* our hunk is still busy */
            if (ctx->hunk->pos.mem < ctx->hunk->last.mem) {
                rc = ngx_http_output_filter_module_ctx.
                                              next_output_body_filter(r, NULL);

            /* our hunk is free */
            } else {
                ctx->out.hunk = ctx->hunk;

                /* XXX: should we check hunk type before copy it ? */
                rc = ngx_http_output_filter_copy_hunk(ctx->hunk, ctx->in->hunk);
#if (NGX_FILE_AIO_READ)
                if (rc == NGX_AGAIN) {
                    return rc;
                }
#endif
                if (rc == NGX_ERROR) {
                    return rc;
                }

                /* NGX_OK */

                /* whole hunk is copied so we send to next filter chain part
                   up to next hunk that need to be copied */
                if (ctx->in->hunk->pos.mem == ctx->in->hunk->last.mem) {
                    ctx->out.next = ctx->in->next;

                    for (ce = ctx->in->next; ce; ce = ce->next) {
                        if (ce->hunk->type & NGX_HUNK_FILE) {
                            break;
                        }

                        if ((ce->hunk->type & (NGX_HUNK_MEMORY|NGX_HUNK_MMAP))
                            && (r->filter & NGX_HTTP_FILTER_NEED_TEMP))
                        {
                            break;
                        }
                    }

                    ctx->out.next = ce;

                } else {
                    ctx->out.next = NULL;
                }

                rc = ngx_http_output_filter_module_ctx.
                                         next_output_body_filter(r, &ctx->out);
            }

            /* delete completed hunks from input chain */
            for (ce = ctx->in; ce; ce = ce->next) {
                 if (ce->hunk->pos.file == ce->hunk->last.file) {
                     ctx->in = ce->next;
                 }
            }

            if (rc == NGX_OK && ctx->hunk) {
                ctx->hunk->pos.mem = ctx->hunk->last.mem = ctx->hunk->start;
            } else {
                return rc;
            }

        /* input chain is empty */
        } else {

            if (hunk == NULL) {
                rc = ngx_http_output_filter_module_ctx.
                                              next_output_body_filter(r, NULL);

            } else {

                /* we need to copy hunk to our hunk */
                if (((r->filter & NGX_HTTP_FILTER_NEED_IN_MEMORY)
                        && (hunk->type & NGX_HUNK_FILE))
                    || ((r->filter & NGX_HTTP_FILTER_NEED_TEMP)
                        && (hunk->type & (NGX_HUNK_MEMORY|NGX_HUNK_MMAP)))
                   ) {

                    /* out hunk is still busy */
                    if (ctx->hunk && ctx->hunk->pos.mem < ctx->hunk->last.mem) {
                        ngx_add_hunk_to_chain(ctx->in, hunk, r->pool,
                                              NGX_ERROR);

                        rc = ngx_http_output_filter_module_ctx.
                                              next_output_body_filter(r, NULL);

                    } else {
                        if (ctx->hunk == NULL) {

                            conf = (ngx_http_output_filter_conf_t *)
                                            ngx_http_get_module_loc_conf(
                                                r->main ? r->main : r,
                                                ngx_http_output_filter_module);

                            if (hunk->type & NGX_HUNK_LAST) {
                                size = hunk->last.mem - hunk->pos.mem;
                                if (size > conf->hunk_size) {
                                    size = conf->hunk_size;
                                }

                            } else {
                                size = conf->hunk_size;
                            }

                            ngx_test_null(ctx->hunk,
                                          ngx_create_temp_hunk(r->pool, size,
                                                               50, 50),
                                          NGX_ERROR);
                            ctx->hunk->type |= NGX_HUNK_RECYCLED;

                            rc = ngx_http_output_filter_copy_hunk(ctx->hunk,
                                                                  hunk);
#if (NGX_FILE_AIO_READ)
                            if (rc == NGX_AGAIN) {
                                /* add hunk to input chain */
                                ngx_add_hunk_to_chain(ctx->in, hunk, r->pool,
                                                      NGX_ERROR);

                                return rc;
                            }
#endif
                            if (rc == NGX_ERROR) {
                                return rc;
                            }

                            if (hunk->pos.mem < hunk->last.mem) {
                                ngx_add_hunk_to_chain(ctx->in, hunk, r->pool,
                                                      NGX_ERROR);
                            }

                            ctx->out.hunk = ctx->hunk;
                            ctx->out.next = NULL;

                            rc = ngx_http_output_filter_module_ctx.
                                         next_output_body_filter(r, &ctx->out);
                        }
                    }

                } else {
                    ctx->out.hunk = hunk;
                    ctx->out.next = NULL;

                    rc = ngx_http_output_filter_module_ctx.
                                         next_output_body_filter(r, &ctx->out);
                }
            }
        }

        /* set free our hunk if operation has completed */
        if (rc == NGX_OK && ctx->hunk) {
            ctx->hunk->pos.mem = ctx->hunk->last.mem = ctx->hunk->start;
        }
    }

#if (NGX_SUPPRESS_WARN)
    if (rc == NGX_ALERT) {
        ngx_log_error(NGX_LOG_ALERT, r->connection->log, 0,
                      "ngx_http_output_filter: rc == NGX_ALERT");
        return NGX_ERROR;
    }
#endif

    if (rc == NGX_OK && ctx->last) {
        return NGX_OK;
    }

    if (rc == NGX_OK) {
        if (ctx->hunk) { /* XXX: double upper code ? */
            ctx->hunk->pos.mem = ctx->hunk->last.mem = ctx->hunk->start;
        }
#if (NGX_LEVEL_EVENT)
        ngx_del_event(r->connection->write, NGX_WRITE_EVENT);
#endif
    }

    return rc;
}

#endif


static int ngx_http_output_filter_copy_hunk(ngx_hunk_t *dst, ngx_hunk_t *src)
{
    ssize_t  n, size;

    size = src->last.mem - src->pos.mem;
    if (size > (dst->end - dst->pos.mem)) {
        size = dst->end - dst->pos.mem;
    }

    if (src->type & NGX_HUNK_FILE) {
        n = ngx_read_file(src->file, dst->pos.mem, size, src->pos.file);

        if (n == NGX_ERROR) {
            return n;

#if (NGX_FILE_AIO_READ)
        } else if (n == NGX_AGAIN) {
            return n;
#endif

        } else {
            ngx_assert((n == size), /* void */ ; , src->file->log,
                       ngx_read_file_n " reads only %d of %d" _
                       n _ size);
        }

        src->pos.mem += n;
        dst->last.mem += n;

    } else {
        ngx_memcpy(src->pos.mem, dst->pos.mem, size);

        src->pos.mem += size;
        dst->last.mem += size;
    }

    if (src->type & NGX_HUNK_LAST && src->pos.mem == src->last.mem) {
        dst->type |= NGX_HUNK_LAST;
    }

    return NGX_OK;
}


static void *ngx_http_output_filter_create_conf(ngx_pool_t *pool)
{
    ngx_http_output_filter_conf_t *conf;

    ngx_test_null(conf,
                  ngx_pcalloc(pool, sizeof(ngx_http_output_filter_conf_t)),
                  NULL);

    conf->hunk_size = NGX_CONF_UNSET;

    return conf;
}


static char *ngx_http_output_filter_merge_conf(ngx_pool_t *pool,
                                               void *parent, void *child)
{
    ngx_http_output_filter_conf_t *prev =
                                      (ngx_http_output_filter_conf_t *) parent;
    ngx_http_output_filter_conf_t *conf =
                                       (ngx_http_output_filter_conf_t *) child;

    ngx_conf_size_merge(conf->hunk_size, prev->hunk_size, 32768);

    return NULL;
}