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