| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2000-2001 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. 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. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * nor may "Apache" appear in their name, without prior written |
| * permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS 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. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| #include "apr.h" |
| #include "apr_general.h" |
| #include "apr_file_io.h" |
| #include "apr_buckets.h" |
| #include <stdlib.h> |
| |
| #if APR_HAS_MMAP |
| #include "apr_mmap.h" |
| |
| /* mmap support for static files based on ideas from John Heidemann's |
| * patch against 1.0.5. See |
| * <http://www.isi.edu/~johnh/SOFTWARE/APACHE/index.html>. |
| */ |
| |
| #endif /* APR_HAS_MMAP */ |
| |
| static void file_destroy(void *data) |
| { |
| if (apr_bucket_shared_destroy(data)) { |
| /* no need to close the file here; it will get |
| * done automatically when the pool gets cleaned up */ |
| free(data); |
| } |
| } |
| |
| #if APR_HAS_MMAP |
| static int file_make_mmap(apr_bucket *e, apr_size_t filelength, |
| apr_off_t fileoffset, apr_pool_t *p) |
| { |
| apr_bucket_file *a = e->data; |
| apr_mmap_t *mm; |
| |
| if (filelength > APR_MMAP_LIMIT) { |
| if (apr_mmap_create(&mm, a->fd, fileoffset, APR_MMAP_LIMIT, |
| APR_MMAP_READ, p) != APR_SUCCESS) { |
| return 0; |
| } |
| else { |
| apr_bucket_split(e, APR_MMAP_LIMIT); |
| filelength = APR_MMAP_LIMIT; |
| } |
| } |
| else if ((filelength < APR_MMAP_THRESHOLD) || |
| (apr_mmap_create(&mm, a->fd, fileoffset, filelength, |
| APR_MMAP_READ, p) != APR_SUCCESS)) |
| { |
| return 0; |
| } |
| apr_bucket_mmap_make(e, mm, 0, filelength); |
| file_destroy(a); |
| return 1; |
| } |
| #endif |
| |
| static apr_status_t file_read(apr_bucket *e, const char **str, |
| apr_size_t *len, apr_read_type_e block) |
| { |
| apr_bucket_file *a = e->data; |
| apr_file_t *f = a->fd; |
| apr_bucket *b = NULL; |
| char *buf; |
| apr_status_t rv; |
| apr_size_t filelength = e->length; /* bytes remaining in file past offset */ |
| apr_off_t fileoffset = e->start; |
| #if APR_HAS_THREADS && !APR_HAS_XTHREAD_FILES |
| apr_int32_t flags; |
| #endif |
| |
| #if APR_HAS_MMAP |
| if (file_make_mmap(e, filelength, fileoffset, a->readpool)) { |
| return apr_bucket_read(e, str, len, block); |
| } |
| #endif |
| |
| #if APR_HAS_THREADS && !APR_HAS_XTHREAD_FILES |
| if ((flags = apr_file_flags_get(f)) & APR_XTHREAD) { |
| /* this file descriptor is shared across multiple threads and |
| * this OS doesn't support that natively, so as a workaround |
| * we must reopen the file into a->readpool */ |
| const char *fname; |
| apr_file_name_get(&fname, f); |
| |
| rv = apr_file_open(&f, fname, (flags & ~APR_XTHREAD), 0, a->readpool); |
| if (rv != APR_SUCCESS) |
| return rv; |
| |
| a->fd = f; |
| } |
| #endif |
| |
| *len = (filelength > APR_BUCKET_BUFF_SIZE) |
| ? APR_BUCKET_BUFF_SIZE |
| : filelength; |
| *str = NULL; /* in case we die prematurely */ |
| buf = malloc(*len); |
| |
| /* Handle offset ... */ |
| rv = apr_file_seek(f, APR_SET, &fileoffset); |
| if (rv != APR_SUCCESS) { |
| free(buf); |
| return rv; |
| } |
| rv = apr_file_read(f, buf, len); |
| if (rv != APR_SUCCESS && rv != APR_EOF) { |
| free(buf); |
| return rv; |
| } |
| filelength -= *len; |
| /* |
| * Change the current bucket to refer to what we read, |
| * even if we read nothing because we hit EOF. |
| */ |
| apr_bucket_heap_make(e, buf, *len, 0); |
| |
| /* If we have more to read from the file, then create another bucket */ |
| if (filelength > 0) { |
| /* for efficiency, we can just build a new apr_bucket struct |
| * to wrap around the existing file bucket */ |
| b = malloc(sizeof(*b)); |
| b->start = fileoffset + (*len); |
| b->length = filelength; |
| b->data = a; |
| b->type = &apr_bucket_type_file; |
| b->free = free; |
| APR_BUCKET_INSERT_AFTER(e, b); |
| } |
| else { |
| file_destroy(a); |
| } |
| |
| *str = buf; |
| return APR_SUCCESS; |
| } |
| |
| APU_DECLARE(apr_bucket *) apr_bucket_file_make(apr_bucket *b, apr_file_t *fd, |
| apr_off_t offset, |
| apr_size_t len, apr_pool_t *p) |
| { |
| apr_bucket_file *f; |
| |
| f = malloc(sizeof(*f)); |
| if (f == NULL) { |
| return NULL; |
| } |
| f->fd = fd; |
| f->readpool = p; |
| |
| b = apr_bucket_shared_make(b, f, offset, len); |
| b->type = &apr_bucket_type_file; |
| |
| return b; |
| } |
| |
| APU_DECLARE(apr_bucket *) apr_bucket_file_create(apr_file_t *fd, |
| apr_off_t offset, |
| apr_size_t len, apr_pool_t *p) |
| { |
| apr_bucket *b = (apr_bucket *)malloc(sizeof(*b)); |
| |
| APR_BUCKET_INIT(b); |
| b->free = free; |
| return apr_bucket_file_make(b, fd, offset, len, p); |
| } |
| |
| static apr_status_t file_setaside(apr_bucket *data, apr_pool_t *reqpool) |
| { |
| apr_bucket_file *a = data->data; |
| apr_file_t *fd = NULL; |
| apr_file_t *f = a->fd; |
| apr_pool_t *curpool = apr_file_pool_get(f); |
| #if APR_HAS_MMAP |
| apr_size_t filelength = data->length; /* bytes remaining in file past offset */ |
| apr_off_t fileoffset = data->start; |
| #endif |
| |
| if (apr_pool_is_ancestor(curpool, reqpool)) { |
| return APR_SUCCESS; |
| } |
| |
| if (!apr_pool_is_ancestor(a->readpool, reqpool)) { |
| a->readpool = reqpool; |
| } |
| |
| #if APR_HAS_MMAP |
| if (file_make_mmap(data, filelength, fileoffset, reqpool)) { |
| return APR_SUCCESS; |
| } |
| #endif |
| apr_file_dup(&fd, f, reqpool); |
| a->fd = fd; |
| return APR_SUCCESS; |
| } |
| |
| APU_DECLARE_DATA const apr_bucket_type_t apr_bucket_type_file = { |
| "FILE", 5, |
| file_destroy, |
| file_read, |
| file_setaside, |
| apr_bucket_shared_split, |
| apr_bucket_shared_copy |
| }; |
