1e18a033bSKonstantin Ananyev
2e18a033bSKonstantin Ananyev/*
3e18a033bSKonstantin Ananyev * Copyright (C) Igor Sysoev
4e18a033bSKonstantin Ananyev * Copyright (C) Nginx, Inc.
5e18a033bSKonstantin Ananyev */
6e18a033bSKonstantin Ananyev
7e18a033bSKonstantin Ananyev
8e18a033bSKonstantin Ananyev#ifndef _NGX_BUF_H_INCLUDED_
9e18a033bSKonstantin Ananyev#define _NGX_BUF_H_INCLUDED_
10e18a033bSKonstantin Ananyev
11e18a033bSKonstantin Ananyev
12e18a033bSKonstantin Ananyev#include <ngx_config.h>
13e18a033bSKonstantin Ananyev#include <ngx_core.h>
14e18a033bSKonstantin Ananyev
15e18a033bSKonstantin Ananyev
16e18a033bSKonstantin Ananyevtypedef void *            ngx_buf_tag_t;
17e18a033bSKonstantin Ananyev
18e18a033bSKonstantin Ananyevtypedef struct ngx_buf_s  ngx_buf_t;
19e18a033bSKonstantin Ananyev
20e18a033bSKonstantin Ananyevstruct ngx_buf_s {
21e18a033bSKonstantin Ananyev    u_char          *pos;
22e18a033bSKonstantin Ananyev    u_char          *last;
23e18a033bSKonstantin Ananyev    off_t            file_pos;
24e18a033bSKonstantin Ananyev    off_t            file_last;
25e18a033bSKonstantin Ananyev
26e18a033bSKonstantin Ananyev    u_char          *start;         /* start of buffer */
27e18a033bSKonstantin Ananyev    u_char          *end;           /* end of buffer */
28e18a033bSKonstantin Ananyev    ngx_buf_tag_t    tag;
29e18a033bSKonstantin Ananyev    ngx_file_t      *file;
30e18a033bSKonstantin Ananyev    ngx_buf_t       *shadow;
31e18a033bSKonstantin Ananyev
32e18a033bSKonstantin Ananyev
33e18a033bSKonstantin Ananyev    /* the buf's content could be changed */
34e18a033bSKonstantin Ananyev    unsigned         temporary:1;
35e18a033bSKonstantin Ananyev
36e18a033bSKonstantin Ananyev    /*
37e18a033bSKonstantin Ananyev     * the buf's content is in a memory cache or in a read only memory
38e18a033bSKonstantin Ananyev     * and must not be changed
39e18a033bSKonstantin Ananyev     */
40e18a033bSKonstantin Ananyev    unsigned         memory:1;
41e18a033bSKonstantin Ananyev
42e18a033bSKonstantin Ananyev    /* the buf's content is mmap()ed and must not be changed */
43e18a033bSKonstantin Ananyev    unsigned         mmap:1;
44e18a033bSKonstantin Ananyev
45e18a033bSKonstantin Ananyev    unsigned         recycled:1;
46e18a033bSKonstantin Ananyev    unsigned         in_file:1;
47e18a033bSKonstantin Ananyev    unsigned         flush:1;
48e18a033bSKonstantin Ananyev    unsigned         sync:1;
49e18a033bSKonstantin Ananyev    unsigned         last_buf:1;
50e18a033bSKonstantin Ananyev    unsigned         last_in_chain:1;
51e18a033bSKonstantin Ananyev
52e18a033bSKonstantin Ananyev    unsigned         last_shadow:1;
53e18a033bSKonstantin Ananyev    unsigned         temp_file:1;
54e18a033bSKonstantin Ananyev
55e18a033bSKonstantin Ananyev    /* STUB */ int   num;
56e18a033bSKonstantin Ananyev};
57e18a033bSKonstantin Ananyev
58e18a033bSKonstantin Ananyev
59e18a033bSKonstantin Ananyevstruct ngx_chain_s {
60e18a033bSKonstantin Ananyev    ngx_buf_t    *buf;
61e18a033bSKonstantin Ananyev    ngx_chain_t  *next;
62e18a033bSKonstantin Ananyev};
63e18a033bSKonstantin Ananyev
64e18a033bSKonstantin Ananyev
65e18a033bSKonstantin Ananyevtypedef struct {
66e18a033bSKonstantin Ananyev    ngx_int_t    num;
67e18a033bSKonstantin Ananyev    size_t       size;
68e18a033bSKonstantin Ananyev} ngx_bufs_t;
69e18a033bSKonstantin Ananyev
70e18a033bSKonstantin Ananyev
71e18a033bSKonstantin Ananyevtypedef struct ngx_output_chain_ctx_s  ngx_output_chain_ctx_t;
72e18a033bSKonstantin Ananyev
73e18a033bSKonstantin Ananyevtypedef ngx_int_t (*ngx_output_chain_filter_pt)(void *ctx, ngx_chain_t *in);
74e18a033bSKonstantin Ananyev
75e18a033bSKonstantin Ananyevtypedef void (*ngx_output_chain_aio_pt)(ngx_output_chain_ctx_t *ctx,
76e18a033bSKonstantin Ananyev    ngx_file_t *file);
77e18a033bSKonstantin Ananyev
78e18a033bSKonstantin Ananyevstruct ngx_output_chain_ctx_s {
79e18a033bSKonstantin Ananyev    ngx_buf_t                   *buf;
80e18a033bSKonstantin Ananyev    ngx_chain_t                 *in;
81e18a033bSKonstantin Ananyev    ngx_chain_t                 *free;
82e18a033bSKonstantin Ananyev    ngx_chain_t                 *busy;
83e18a033bSKonstantin Ananyev
84e18a033bSKonstantin Ananyev    unsigned                     sendfile:1;
85e18a033bSKonstantin Ananyev    unsigned                     directio:1;
86e18a033bSKonstantin Ananyev    unsigned                     unaligned:1;
87e18a033bSKonstantin Ananyev    unsigned                     need_in_memory:1;
88e18a033bSKonstantin Ananyev    unsigned                     need_in_temp:1;
89e18a033bSKonstantin Ananyev    unsigned                     aio:1;
90e18a033bSKonstantin Ananyev
91e18a033bSKonstantin Ananyev#if (NGX_HAVE_FILE_AIO || NGX_COMPAT)
92e18a033bSKonstantin Ananyev    ngx_output_chain_aio_pt      aio_handler;
93e18a033bSKonstantin Ananyev#if (NGX_HAVE_AIO_SENDFILE || NGX_COMPAT)
94e18a033bSKonstantin Ananyev    ssize_t                    (*aio_preload)(ngx_buf_t *file);
95e18a033bSKonstantin Ananyev#endif
96e18a033bSKonstantin Ananyev#endif
97e18a033bSKonstantin Ananyev
98e18a033bSKonstantin Ananyev#if (NGX_THREADS || NGX_COMPAT)
99e18a033bSKonstantin Ananyev    ngx_int_t                  (*thread_handler)(ngx_thread_task_t *task,
100e18a033bSKonstantin Ananyev                                                 ngx_file_t *file);
101e18a033bSKonstantin Ananyev    ngx_thread_task_t           *thread_task;
102e18a033bSKonstantin Ananyev#endif
103e18a033bSKonstantin Ananyev
104e18a033bSKonstantin Ananyev    off_t                        alignment;
105e18a033bSKonstantin Ananyev
106e18a033bSKonstantin Ananyev    ngx_pool_t                  *pool;
107e18a033bSKonstantin Ananyev    ngx_int_t                    allocated;
108e18a033bSKonstantin Ananyev    ngx_bufs_t                   bufs;
109e18a033bSKonstantin Ananyev    ngx_buf_tag_t                tag;
110e18a033bSKonstantin Ananyev
111e18a033bSKonstantin Ananyev    ngx_output_chain_filter_pt   output_filter;
112e18a033bSKonstantin Ananyev    void                        *filter_ctx;
113e18a033bSKonstantin Ananyev};
114e18a033bSKonstantin Ananyev
115e18a033bSKonstantin Ananyev
116e18a033bSKonstantin Ananyevtypedef struct {
117e18a033bSKonstantin Ananyev    ngx_chain_t                 *out;
118e18a033bSKonstantin Ananyev    ngx_chain_t                **last;
119e18a033bSKonstantin Ananyev    ngx_connection_t            *connection;
120e18a033bSKonstantin Ananyev    ngx_pool_t                  *pool;
121e18a033bSKonstantin Ananyev    off_t                        limit;
122e18a033bSKonstantin Ananyev} ngx_chain_writer_ctx_t;
123e18a033bSKonstantin Ananyev
124e18a033bSKonstantin Ananyev
125e18a033bSKonstantin Ananyev#define NGX_CHAIN_ERROR     (ngx_chain_t *) NGX_ERROR
126e18a033bSKonstantin Ananyev
127e18a033bSKonstantin Ananyev
128e18a033bSKonstantin Ananyev#define ngx_buf_in_memory(b)        (b->temporary || b->memory || b->mmap)
129e18a033bSKonstantin Ananyev#define ngx_buf_in_memory_only(b)   (ngx_buf_in_memory(b) && !b->in_file)
130e18a033bSKonstantin Ananyev
131e18a033bSKonstantin Ananyev#define ngx_buf_special(b)                                                   \
132e18a033bSKonstantin Ananyev    ((b->flush || b->last_buf || b->sync)                                    \
133e18a033bSKonstantin Ananyev     && !ngx_buf_in_memory(b) && !b->in_file)
134e18a033bSKonstantin Ananyev
135e18a033bSKonstantin Ananyev#define ngx_buf_sync_only(b)                                                 \
136e18a033bSKonstantin Ananyev    (b->sync                                                                 \
137e18a033bSKonstantin Ananyev     && !ngx_buf_in_memory(b) && !b->in_file && !b->flush && !b->last_buf)
138e18a033bSKonstantin Ananyev
139e18a033bSKonstantin Ananyev#define ngx_buf_size(b)                                                      \
140e18a033bSKonstantin Ananyev    (ngx_buf_in_memory(b) ? (off_t) (b->last - b->pos):                      \
141e18a033bSKonstantin Ananyev                            (b->file_last - b->file_pos))
142e18a033bSKonstantin Ananyev
143e18a033bSKonstantin Ananyevngx_buf_t *ngx_create_temp_buf(ngx_pool_t *pool, size_t size);
144e18a033bSKonstantin Ananyevngx_chain_t *ngx_create_chain_of_bufs(ngx_pool_t *pool, ngx_bufs_t *bufs);
145e18a033bSKonstantin Ananyev
146e18a033bSKonstantin Ananyev
147e18a033bSKonstantin Ananyev#define ngx_alloc_buf(pool)  ngx_palloc(pool, sizeof(ngx_buf_t))
148e18a033bSKonstantin Ananyev#define ngx_calloc_buf(pool) ngx_pcalloc(pool, sizeof(ngx_buf_t))
149e18a033bSKonstantin Ananyev
150e18a033bSKonstantin Ananyevngx_chain_t *ngx_alloc_chain_link(ngx_pool_t *pool);
151e18a033bSKonstantin Ananyev#define ngx_free_chain(pool, cl)                                             \
152e18a033bSKonstantin Ananyev    cl->next = pool->chain;                                                  \
153e18a033bSKonstantin Ananyev    pool->chain = cl
154e18a033bSKonstantin Ananyev
155e18a033bSKonstantin Ananyev
156e18a033bSKonstantin Ananyev
157e18a033bSKonstantin Ananyevngx_int_t ngx_output_chain(ngx_output_chain_ctx_t *ctx, ngx_chain_t *in);
158e18a033bSKonstantin Ananyevngx_int_t ngx_chain_writer(void *ctx, ngx_chain_t *in);
159e18a033bSKonstantin Ananyev
160e18a033bSKonstantin Ananyevngx_int_t ngx_chain_add_copy(ngx_pool_t *pool, ngx_chain_t **chain,
161e18a033bSKonstantin Ananyev    ngx_chain_t *in);
162e18a033bSKonstantin Ananyevngx_chain_t *ngx_chain_get_free_buf(ngx_pool_t *p, ngx_chain_t **free);
163e18a033bSKonstantin Ananyevvoid ngx_chain_update_chains(ngx_pool_t *p, ngx_chain_t **free,
164e18a033bSKonstantin Ananyev    ngx_chain_t **busy, ngx_chain_t **out, ngx_buf_tag_t tag);
165e18a033bSKonstantin Ananyev
166e18a033bSKonstantin Ananyevoff_t ngx_chain_coalesce_file(ngx_chain_t **in, off_t limit);
167e18a033bSKonstantin Ananyev
168e18a033bSKonstantin Ananyevngx_chain_t *ngx_chain_update_sent(ngx_chain_t *in, off_t sent);
169e18a033bSKonstantin Ananyev
170e18a033bSKonstantin Ananyev#endif /* _NGX_BUF_H_INCLUDED_ */
171