ap_mmn.h revision 0fdf8c342123fde84405b885fb1720ebc652e10d
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny/* ====================================================================
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * The Apache Software License, Version 1.1
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * Copyright (c) 2000-2002 The Apache Software Foundation. All rights
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * reserved.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * Redistribution and use in source and binary forms, with or without
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * modification, are permitted provided that the following conditions
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * are met:
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 1. Redistributions of source code must retain the above copyright
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * notice, this list of conditions and the following disclaimer.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 2. Redistributions in binary form must reproduce the above copyright
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * notice, this list of conditions and the following disclaimer in
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * the documentation and/or other materials provided with the
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * distribution.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 3. The end-user documentation included with the redistribution,
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * if any, must include the following acknowledgment:
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * "This product includes software developed by the
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * Apache Software Foundation (http://www.apache.org/)."
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * Alternately, this acknowledgment may appear in the software itself,
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * if and wherever such third-party acknowledgments normally appear.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * 4. The names "Apache" and "Apache Software Foundation" must
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * not be used to endorse or promote products derived from this
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * software without prior written permission. For written
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * permission, please contact apache@apache.org.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 5. Products derived from this software may not be called "Apache",
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * nor may "Apache" appear in their name, without prior written
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * permission of the Apache Software Foundation.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * SUCH DAMAGE.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * ====================================================================
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny *
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * This software consists of voluntary contributions made by many
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * individuals on behalf of the Apache Software Foundation. For more
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * information on the Apache Software Foundation, please see
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * <http://www.apache.org/>.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek#ifndef APACHE_AP_MMN_H
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny#define APACHE_AP_MMN_H
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny/**
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * @package Module Magic Number
bdbf4f169e4d5d00b0616df19f7a55debb407f78Pavel Březina */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny/*
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * MODULE_MAGIC_NUMBER_MAJOR
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * Major API changes that could cause compatibility problems for older modules
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * such as structure size changes. No binary compatibility is possible across
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * a change in the major version.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek *
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * MODULE_MAGIC_NUMBER_MINOR
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * Minor API changes that do not cause binary compatibility problems.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * Should be reset to 0 when upgrading MODULE_MAGIC_NUMBER_MAJOR.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek *
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * See the MODULE_MAGIC_AT_LEAST macro below for an example.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek/*
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20010224 (2.0.13-dev) MODULE_MAGIC_COOKIE reset to "AP20"
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * 20010523 (2.0.19-dev) bump for scoreboard structure reordering
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * 20010627 (2.0.19-dev) more API changes than I can count
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * 20010726 (2.0.22-dev) more big API changes
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * 20010808 (2.0.23-dev) dir d_is_absolute bit introduced, bucket changes, etc
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20010825 (2.0.25-dev) removed d_is_absolute, introduced map_to_storage hook
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20011002 (2.0.26-dev) removed 1.3-depreciated request_rec.content_language
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20011127 (2.0.29-dev) bump for postconfig hook change, and removal of socket
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * from connection record
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20011212 (2.0.30-dev) bump for new used_path_info member of request_rec
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20011218 (2.0.30-dev) bump for new sbh member of conn_rec, different
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * declarations for scoreboard, new parameter to
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * create_connection hook
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020102 (2.0.30-dev) bump for changed type of limit_req_body in
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * core_dir_config
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020109 (2.0.31-dev) bump for changed shm and scoreboard declarations
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020111 (2.0.31-dev) bump for ETag fields added at end of cor_dir_config
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020114 (2.0.31-dev) mod_dav changed how it asks its provider to fulfill
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * a GET request
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020118 (2.0.31-dev) Input filtering split of blocking and mode
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020127 (2.0.31-dev) bump for pre_mpm hook change
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020128 (2.0.31-dev) bump for pre_config hook change
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020218 (2.0.33-dev) bump for AddOutputFilterByType directive
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020220 (2.0.33-dev) bump for scoreboard.h structure change
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020302 (2.0.33-dev) bump for protocol_filter additions.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020306 (2.0.34-dev) bump for filter type renames.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020318 (2.0.34-dev) mod_dav's API for REPORT generation changed
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020319 (2.0.34-dev) M_INVALID changed, plus new M_* methods for RFC 3253
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020327 (2.0.35-dev) Add parameter to quick_handler hook
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020329 (2.0.35-dev) bump for addition of freelists to bucket API
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020329.1 (2.0.36) minor bump for new arg to opt fn ap_cgi_build_command
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020506 (2.0.37-dev) Removed r->boundary in request_rec.
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020529 (2.0.37-dev) Standardized the names of some apr_pool_*_set funcs
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020602 (2.0.37-dev) Bucket API change (metadata buckets)
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020612 (2.0.38-dev) Changed server_rec->[keep_alive_]timeout to apr time
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020625 (2.0.40-dev) Changed conn_rec->keepalive to an enumeration
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny * 20020628 (2.0.40-dev) Added filter_init to filter registration functions
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny#define MODULE_MAGIC_COOKIE 0x41503230UL /* "AP20" */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny#ifndef MODULE_MAGIC_NUMBER_MAJOR
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny#define MODULE_MAGIC_NUMBER_MAJOR 20020628
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny#endif
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny#define MODULE_MAGIC_NUMBER_MINOR 0 /* 0...n */
c0f9698cd951b7223f251ff2511c4b22a6e4ba60Jan Zeleny
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek/**
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * Determine if the server's current MODULE_MAGIC_NUMBER is at least a
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * specified value.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * <pre>
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * Useful for testing for features.
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * For example, suppose you wish to use the apr_table_overlap
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * function. You can do this:
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek *
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * #if AP_MODULE_MAGIC_AT_LEAST(19980812,2)
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * ... use apr_table_overlap()
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * #else
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * ... alternative code which doesn't use apr_table_overlap()
99bac83188601c2b07e0b141aac7dc7d882b464aSumit Bose * #endif
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * </pre>
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * @param major The major module magic number
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * @param minor The minor module magic number
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek * @deffunc AP_MODULE_MAGIC_AT_LEAST(int major, int minor)
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek#define AP_MODULE_MAGIC_AT_LEAST(major,minor) \
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek ((major) < MODULE_MAGIC_NUMBER_MAJOR \
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek || ((major) == MODULE_MAGIC_NUMBER_MAJOR \
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek && (minor) <= MODULE_MAGIC_NUMBER_MINOR))
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek/** @deprecated present for backwards compatibility */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek#define MODULE_MAGIC_NUMBER MODULE_MAGIC_NUMBER_MAJOR
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek#define MODULE_MAGIC_AT_LEAST old_broken_macro_we_hope_you_are_not_using
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek#endif /* !APACHE_AP_MMN_H */
8ba8222afca3026fd67af08e224b1d9e848aceaaJakub Hrozek