ap_mmn.h revision 439ccf2a084e1da566548931c585cbcc3a9e7f4c
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe/* Licensed to the Apache Software Foundation (ASF) under one or more
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * contributor license agreements. See the NOTICE file distributed with
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * this work for additional information regarding copyright ownership.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * The ASF licenses this file to You under the Apache License, Version 2.0
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * (the "License"); you may not use this file except in compliance with
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * the License. You may obtain a copy of the License at
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe *
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * http://www.apache.org/licenses/LICENSE-2.0
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe *
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * Unless required by applicable law or agreed to in writing, software
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * distributed under the License is distributed on an "AS IS" BASIS,
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * See the License for the specific language governing permissions and
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * limitations under the License.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe */
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe/**
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * @file ap_mpm.h
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * @brief Module Magic Number
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe *
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * @defgroup APACHE_CORE_MMN Module Magic Number
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * @ingroup APACHE_CORE
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * @{
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe */
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe#ifndef APACHE_AP_MMN_H
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe#define APACHE_AP_MMN_H
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe/*
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * MODULE_MAGIC_NUMBER_MAJOR
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * Major API changes that could cause compatibility problems for older modules
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * such as structure size changes. No binary compatibility is possible across
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * a change in the major version.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe *
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * MODULE_MAGIC_NUMBER_MINOR
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * Minor API changes that do not cause binary compatibility problems.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * Should be reset to 0 when upgrading MODULE_MAGIC_NUMBER_MAJOR.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe *
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * See the MODULE_MAGIC_AT_LEAST macro below for an example.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe */
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe/*
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20010224 (2.0.13-dev) MODULE_MAGIC_COOKIE reset to "AP20"
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20010523 (2.0.19-dev) bump for scoreboard structure reordering
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20010627 (2.0.19-dev) more API changes than I can count
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20010726 (2.0.22-dev) more big API changes
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20010808 (2.0.23-dev) dir d_is_absolute bit introduced, bucket changes, etc
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20010825 (2.0.25-dev) removed d_is_absolute, introduced map_to_storage hook
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20011002 (2.0.26-dev) removed 1.3-deprecated request_rec.content_language
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20011127 (2.0.29-dev) bump for postconfig hook change, and removal of
4c5e3ef22e7e27d880aac578167cdb93468ae6d4wrowe * socket from connection record
4c5e3ef22e7e27d880aac578167cdb93468ae6d4wrowe * 20011212 (2.0.30-dev) bump for new used_path_info member of request_rec
4c5e3ef22e7e27d880aac578167cdb93468ae6d4wrowe * 20011218 (2.0.30-dev) bump for new sbh member of conn_rec, different
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * declarations for scoreboard, new parameter to
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * create_connection hook
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020102 (2.0.30-dev) bump for changed type of limit_req_body in
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * core_dir_config
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020109 (2.0.31-dev) bump for changed shm and scoreboard declarations
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020111 (2.0.31-dev) bump for ETag fields added at end of cor_dir_config
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020114 (2.0.31-dev) mod_dav changed how it asks its provider to fulfill
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * a GET request
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020118 (2.0.31-dev) Input filtering split of blocking and mode
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020127 (2.0.31-dev) bump for pre_mpm hook change
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020128 (2.0.31-dev) bump for pre_config hook change
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020218 (2.0.33-dev) bump for AddOutputFilterByType directive
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020220 (2.0.33-dev) bump for scoreboard.h structure change
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020302 (2.0.33-dev) bump for protocol_filter additions.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020306 (2.0.34-dev) bump for filter type renames.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020318 (2.0.34-dev) mod_dav's API for REPORT generation changed
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020319 (2.0.34-dev) M_INVALID changed, plus new M_* methods for RFC 3253
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020327 (2.0.35-dev) Add parameter to quick_handler hook
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020329 (2.0.35-dev) bump for addition of freelists to bucket API
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020329.1 (2.0.36) minor bump for new arg to opt fn ap_cgi_build_command
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020506 (2.0.37-dev) Removed r->boundary in request_rec.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020529 (2.0.37-dev) Standardized the names of some apr_pool_*_set funcs
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020602 (2.0.37-dev) Bucket API change (metadata buckets)
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020612 (2.0.38-dev) Changed server_rec->[keep_alive_]timeout to apr time
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020625 (2.0.40-dev) Changed conn_rec->keepalive to an enumeration
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020628 (2.0.40-dev) Added filter_init to filter registration functions
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020903 (2.0.41-dev) APR's error constants changed
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020903.1 (2.1.0-dev) allow_encoded_slashes added to core_dir_config
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20020903.2 (2.0.46-dev) add ap_escape_logitem
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20030213.1 (2.1.0-dev) changed log_writer optional fn's to return previous
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * handler
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20030821 (2.1.0-dev) bumped mod_include's entire API
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20030821.1 (2.1.0-dev) added XHTML doctypes
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20030821.2 (2.1.0-dev) added ap_escape_errorlog_item
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20030821.3 (2.1.0-dev) added ap_get_server_revision / ap_version_t
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20040425 (2.1.0-dev) removed ap_add_named_module API
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * changed ap_add_module, ap_add_loaded_module,
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * ap_setup_prelinked_modules,
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * ap_process_resource_config
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20040425.1 (2.1.0-dev) Added ap_module_symbol_t and
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * ap_prelinked_module_symbols
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20050101.0 (2.1.2-dev) Axed misnamed http_method for http_scheme
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * (which it was!)
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20050127.0 (2.1.3-dev) renamed regex_t->ap_regex_t,
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * regmatch_t->ap_regmatch_t, REG_*->AP_REG_*,
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * removed reg* in place of ap_reg*; added ap_regex.h
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20050217.0 (2.1.3-dev) Axed find_child_by_pid, mpm_*_completion_context
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * (winnt mpm) symbols from the public sector, and
0c01ceec64ab3a97b86baaecf0e77506e7098132gsmith * decorated real_exit_code with ap_ in the win32/os.h.
0c01ceec64ab3a97b86baaecf0e77506e7098132gsmith * 20050305.0 (2.1.4-dev) added pid and generation fields to worker_score
0c01ceec64ab3a97b86baaecf0e77506e7098132gsmith * 20050305.1 (2.1.5-dev) added ap_vhost_iterate_given_conn.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20050305.2 (2.1.5-dev) added AP_INIT_TAKE_ARGV.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20050305.3 (2.1.5-dev) added Protocol Framework.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20050701.0 (2.1.7-dev) Bump MODULE_MAGIC_COOKIE to "AP21"!
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20050701.1 (2.1.7-dev) trace_enable member added to core server_config
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20050708.0 (2.1.7-dev) Bump MODULE_MAGIC_COOKIE to "AP22"!
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20050708.1 (2.1.7-dev) add proxy request_status hook (minor)
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20050919.0 (2.1.8-dev) mod_ssl ssl_ext_list optional function added
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20051005.0 (2.1.8-dev) NET_TIME filter eliminated
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20051005.0 (2.3.0-dev) Bump MODULE_MAGIC_COOKIE to "AP24"!
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20051115.0 (2.3.0-dev) Added use_canonical_phys_port to core_dir_config
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20060110.0 (2.3.0-dev) Conversion of Authz to be provider based
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * addition of <SatisfyAll><SatisfyOne>
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * removal of Satisfy, Allow, Deny, Order
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20060110.1 (2.3.0-dev) minex and minex_set members added to
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * cache_server_conf (minor)
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20060110.2 (2.3.0-dev) flush_packets and flush_wait members added to
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * proxy_server (minor)
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20060110.3 (2.3.0-dev) added inreslist member to proxy_conn_rec (minor)
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20060110.4 (2.3.0-dev) Added server_scheme member to server_rec (minor)
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20060905.0 (2.3.0-dev) Replaced ap_get_server_version() with
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * ap_get_server_banner() and ap_get_server_description()
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20060905.1 (2.3.0-dev) Enable retry=0 for the worker (minor)
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20060905.2 (2.3.0-dev) Added ap_all_available_mutexes_string,
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * ap_available_mutexes_string and
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * ap_parse_mutex()
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20060905.3 (2.3.0-dev) Added conn_rec::clogging_input_filters.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20060905.4 (2.3.0-dev) Added proxy_balancer::sticky_path.
a985f6595e5da3e4b35bd91eab0a6eac3cbc8ae4fuankg * 20060905.5 (2.3.0-dev) Added ap_mpm_safe_kill()
a985f6595e5da3e4b35bd91eab0a6eac3cbc8ae4fuankg * 20070823.0 (2.3.0-dev) Removed ap_all_available_mutexes_string,
a985f6595e5da3e4b35bd91eab0a6eac3cbc8ae4fuankg * ap_available_mutexes_string for macros
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20070823.1 (2.3.0-dev) add ap_send_interim_response()
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20071023.0 (2.3.0-dev) add ap_get_scoreboard(sbh) split from the less
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * conventional ap_get_scoreboard(proc, thread)
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20071023.1 (2.3.0-dev) Add flags field to struct proxy_alias
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20071023.2 (2.3.0-dev) Add ap_mod_status_reqtail
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20071023.3 (2.3.0-dev) Declare ap_time_process_request() as part of the
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * public scoreboard API.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * 20071108.1 (2.3.0-dev) Add the optional kept_body brigade to request_rec
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe */
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe#define MODULE_MAGIC_COOKIE 0x41503234UL /* "AP24" */
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe#ifndef MODULE_MAGIC_NUMBER_MAJOR
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe#define MODULE_MAGIC_NUMBER_MAJOR 20071108
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe#endif
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe#define MODULE_MAGIC_NUMBER_MINOR 1 /* 0...n */
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe/**
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * Determine if the server's current MODULE_MAGIC_NUMBER is at least a
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * specified value.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * <pre>
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * Useful for testing for features.
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * For example, suppose you wish to use the apr_table_overlap
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * function. You can do this:
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe *
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * #if AP_MODULE_MAGIC_AT_LEAST(19980812,2)
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * ... use apr_table_overlap()
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * #else
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * ... alternative code which doesn't use apr_table_overlap()
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * #endif
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * </pre>
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * @param major The major module magic number
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * @param minor The minor module magic number
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe * @fn AP_MODULE_MAGIC_AT_LEAST(int major, int minor)
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe */
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe#define AP_MODULE_MAGIC_AT_LEAST(major,minor) \
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe ((major) < MODULE_MAGIC_NUMBER_MAJOR \
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe || ((major) == MODULE_MAGIC_NUMBER_MAJOR \
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe && (minor) <= MODULE_MAGIC_NUMBER_MINOR))
b18a480dd67320740d67fc105317dc23425440e1gsmith
b18a480dd67320740d67fc105317dc23425440e1gsmith/** @deprecated present for backwards compatibility */
b18a480dd67320740d67fc105317dc23425440e1gsmith#define MODULE_MAGIC_NUMBER MODULE_MAGIC_NUMBER_MAJOR
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe#define MODULE_MAGIC_AT_LEAST old_broken_macro_we_hope_you_are_not_using
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe#endif /* !APACHE_AP_MMN_H */
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe/** @} */
ceaa05c302b4a0013174f4344c0907df84f7390dwrowe