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