00001 /* ==================================================================== 00002 * The Apache Software License, Version 1.1 00003 * 00004 * Copyright (c) 2000-2003 The Apache Software Foundation. All rights 00005 * reserved. 00006 * 00007 * Redistribution and use in source and binary forms, with or without 00008 * modification, are permitted provided that the following conditions 00009 * are met: 00010 * 00011 * 1. Redistributions of source code must retain the above copyright 00012 * notice, this list of conditions and the following disclaimer. 00013 * 00014 * 2. Redistributions in binary form must reproduce the above copyright 00015 * notice, this list of conditions and the following disclaimer in 00016 * the documentation and/or other materials provided with the 00017 * distribution. 00018 * 00019 * 3. The end-user documentation included with the redistribution, 00020 * if any, must include the following acknowledgment: 00021 * "This product includes software developed by the 00022 * Apache Software Foundation (http://www.apache.org/)." 00023 * Alternately, this acknowledgment may appear in the software itself, 00024 * if and wherever such third-party acknowledgments normally appear. 00025 * 00026 * 4. The names "Apache" and "Apache Software Foundation" must 00027 * not be used to endorse or promote products derived from this 00028 * software without prior written permission. For written 00029 * permission, please contact apache@apache.org. 00030 * 00031 * 5. Products derived from this software may not be called "Apache", 00032 * nor may "Apache" appear in their name, without prior written 00033 * permission of the Apache Software Foundation. 00034 * 00035 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 00036 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 00037 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00038 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 00039 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00040 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 00041 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 00042 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 00043 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 00044 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 00045 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 00046 * SUCH DAMAGE. 00047 * ==================================================================== 00048 * 00049 * This software consists of voluntary contributions made by many 00050 * individuals on behalf of the Apache Software Foundation. For more 00051 * information on the Apache Software Foundation, please see 00052 * <http://www.apache.org/>. 00053 */ 00054 00055 #ifndef APR_MMAP_H 00056 #define APR_MMAP_H 00057 00063 #include "apr.h" 00064 #include "apr_pools.h" 00065 #include "apr_errno.h" 00066 #include "apr_ring.h" 00067 #include "apr_file_io.h" /* for apr_file_t */ 00068 00069 #ifdef BEOS 00070 #include <kernel/OS.h> 00071 #endif 00072 00073 #ifdef __cplusplus 00074 extern "C" { 00075 #endif /* __cplusplus */ 00076 00084 #define APR_MMAP_READ 1 00085 00086 #define APR_MMAP_WRITE 2 00087 00089 typedef struct apr_mmap_t apr_mmap_t; 00090 00100 struct apr_mmap_t { 00102 apr_pool_t *cntxt; 00103 #ifdef BEOS 00104 00105 area_id area; 00106 #endif 00107 #ifdef WIN32 00108 00109 HANDLE mhandle; 00111 void *mv; 00113 apr_off_t pstart; 00114 apr_size_t psize; 00115 apr_off_t poffset; 00116 #endif 00117 00118 void *mm; 00120 apr_size_t size; 00123 int unused; 00126 APR_RING_ENTRY(apr_mmap_t) link; 00127 }; 00128 00129 #if APR_HAS_MMAP || defined(DOXYGEN) 00130 00136 #ifdef MMAP_THRESHOLD 00137 # define APR_MMAP_THRESHOLD MMAP_THRESHOLD 00138 #else 00139 # ifdef SUNOS4 00140 # define APR_MMAP_THRESHOLD (8*1024) 00141 # else 00142 # define APR_MMAP_THRESHOLD 1 00143 # endif /* SUNOS4 */ 00144 #endif /* MMAP_THRESHOLD */ 00145 00149 #ifdef MMAP_LIMIT 00150 # define APR_MMAP_LIMIT MMAP_LIMIT 00151 #else 00152 # define APR_MMAP_LIMIT (4*1024*1024) 00153 #endif /* MMAP_LIMIT */ 00154 00156 #define APR_MMAP_CANDIDATE(filelength) \ 00157 ((filelength >= APR_MMAP_THRESHOLD) && (filelength < APR_MMAP_LIMIT)) 00158 00159 /* Function definitions */ 00160 00174 APR_DECLARE(apr_status_t) apr_mmap_create(apr_mmap_t **newmmap, 00175 apr_file_t *file, apr_off_t offset, 00176 apr_size_t size, apr_int32_t flag, 00177 apr_pool_t *cntxt); 00178 00187 APR_DECLARE(apr_status_t) apr_mmap_dup(apr_mmap_t **new_mmap, 00188 apr_mmap_t *old_mmap, 00189 apr_pool_t *p, 00190 int transfer_ownership); 00191 00192 #if defined(DOXYGEN) 00201 APR_DECLARE(apr_status_t) apr_mmap_setaside(apr_mmap_t **new_mmap, 00202 apr_mmap_t *old_mmap, 00203 apr_pool_t *p); 00204 #else 00205 #define apr_mmap_setaside(new_mmap, old_mmap, p) apr_mmap_dup(new_mmap, old_mmap, p, 1) 00206 #endif /* DOXYGEN */ 00207 00212 APR_DECLARE(apr_status_t) apr_mmap_delete(apr_mmap_t *mm); 00213 00220 APR_DECLARE(apr_status_t) apr_mmap_offset(void **addr, apr_mmap_t *mm, 00221 apr_off_t offset); 00222 00223 #endif /* APR_HAS_MMAP */ 00224 00227 #ifdef __cplusplus 00228 } 00229 #endif 00230 00231 #endif /* ! APR_MMAP_H */