ap_mmn.h revision 8fae12696bce44be9ce4c56888690cad8ac7b8f9
/* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file ap_mmn.h
* @brief Module Magic Number
*
* @defgroup APACHE_CORE_MMN Module Magic Number
* @ingroup APACHE_CORE
* @{
*/
#ifndef APACHE_AP_MMN_H
#define APACHE_AP_MMN_H
/*
* MODULE_MAGIC_NUMBER_MAJOR
* Major API changes that could cause compatibility problems for older modules
* such as structure size changes. No binary compatibility is possible across
* a change in the major version.
*
* MODULE_MAGIC_NUMBER_MINOR
* Minor API changes that do not cause binary compatibility problems.
* Should be reset to 0 when upgrading MODULE_MAGIC_NUMBER_MAJOR.
*
* See the AP_MODULE_MAGIC_AT_LEAST macro below for an example.
*/
/*
* 20010224 (2.0.13-dev) MODULE_MAGIC_COOKIE reset to "AP20"
* 20010523 (2.0.19-dev) bump for scoreboard structure reordering
* 20010627 (2.0.19-dev) more API changes than I can count
* 20010726 (2.0.22-dev) more big API changes
* 20010808 (2.0.23-dev) dir d_is_absolute bit introduced, bucket changes, etc
* 20010825 (2.0.25-dev) removed d_is_absolute, introduced map_to_storage hook
* 20011002 (2.0.26-dev) removed 1.3-deprecated request_rec.content_language
* 20011127 (2.0.29-dev) bump for postconfig hook change, and removal of
* socket from connection record
* 20011212 (2.0.30-dev) bump for new used_path_info member of request_rec
* 20011218 (2.0.30-dev) bump for new sbh member of conn_rec, different
* declarations for scoreboard, new parameter to
* create_connection hook
* 20020102 (2.0.30-dev) bump for changed type of limit_req_body in
* core_dir_config
* 20020109 (2.0.31-dev) bump for changed shm and scoreboard declarations
* 20020111 (2.0.31-dev) bump for ETag fields added at end of cor_dir_config
* 20020114 (2.0.31-dev) mod_dav changed how it asks its provider to fulfill
* a GET request
* 20020118 (2.0.31-dev) Input filtering split of blocking and mode
* 20020127 (2.0.31-dev) bump for pre_mpm hook change
* 20020128 (2.0.31-dev) bump for pre_config hook change
* 20020218 (2.0.33-dev) bump for AddOutputFilterByType directive
* 20020220 (2.0.33-dev) bump for scoreboard.h structure change
* 20020302 (2.0.33-dev) bump for protocol_filter additions.
* 20020306 (2.0.34-dev) bump for filter type renames.
* 20020318 (2.0.34-dev) mod_dav's API for REPORT generation changed
* 20020319 (2.0.34-dev) M_INVALID changed, plus new M_* methods for RFC 3253
* 20020327 (2.0.35-dev) Add parameter to quick_handler hook
* 20020329 (2.0.35-dev) bump for addition of freelists to bucket API
* 20020329.1 (2.0.36) minor bump for new arg to opt fn ap_cgi_build_command
* 20020506 (2.0.37-dev) Removed r->boundary in request_rec.
* 20020529 (2.0.37-dev) Standardized the names of some apr_pool_*_set funcs
* 20020602 (2.0.37-dev) Bucket API change (metadata buckets)
* 20020612 (2.0.38-dev) Changed server_rec->[keep_alive_]timeout to apr time
* 20020625 (2.0.40-dev) Changed conn_rec->keepalive to an enumeration
* 20020628 (2.0.40-dev) Added filter_init to filter registration functions
* 20020903 (2.0.41-dev) APR's error constants changed
* 20020903.1 (2.1.0-dev) allow_encoded_slashes added to core_dir_config
* 20020903.2 (2.0.46-dev) add ap_escape_logitem
* 20030213.1 (2.1.0-dev) changed log_writer optional fn's to return previous
* handler
* 20030821 (2.1.0-dev) bumped mod_include's entire API
* 20030821.1 (2.1.0-dev) added XHTML doctypes
* 20030821.2 (2.1.0-dev) added ap_escape_errorlog_item
* 20030821.3 (2.1.0-dev) added ap_get_server_revision / ap_version_t
* 20040425 (2.1.0-dev) removed ap_add_named_module API
* changed ap_add_module, ap_add_loaded_module,
* ap_setup_prelinked_modules,
* ap_process_resource_config
* 20040425.1 (2.1.0-dev) Added ap_module_symbol_t and
* ap_prelinked_module_symbols
* 20050101.0 (2.1.2-dev) Axed misnamed http_method for http_scheme
* (which it was!)
* 20050127.0 (2.1.3-dev) renamed regex_t->ap_regex_t,
* regmatch_t->ap_regmatch_t, REG_*->AP_REG_*,
* removed reg* in place of ap_reg*; added ap_regex.h
* 20050217.0 (2.1.3-dev) Axed find_child_by_pid, mpm_*_completion_context
* (winnt mpm) symbols from the public sector, and
* 20050305.0 (2.1.4-dev) added pid and generation fields to worker_score
* 20050305.1 (2.1.5-dev) added ap_vhost_iterate_given_conn.
* 20050305.2 (2.1.5-dev) added AP_INIT_TAKE_ARGV.
* 20050305.3 (2.1.5-dev) added Protocol Framework.
* 20050701.0 (2.1.7-dev) Bump MODULE_MAGIC_COOKIE to "AP21"!
* 20050701.1 (2.1.7-dev) trace_enable member added to core server_config
* 20050708.0 (2.1.7-dev) Bump MODULE_MAGIC_COOKIE to "AP22"!
* 20050708.1 (2.1.7-dev) add proxy request_status hook (minor)
* 20050919.0 (2.1.8-dev) mod_ssl ssl_ext_list optional function added
* 20051005.0 (2.1.8-dev) NET_TIME filter eliminated
* 20051005.0 (2.3.0-dev) Bump MODULE_MAGIC_COOKIE to "AP24"!
* 20051115.0 (2.3.0-dev) Added use_canonical_phys_port to core_dir_config
* 20060110.0 (2.3.0-dev) Conversion of Authz to be provider based
* addition of <SatisfyAll><SatisfyOne>
* removal of Satisfy, Allow, Deny, Order
* 20060110.1 (2.3.0-dev) minex and minex_set members added to
* cache_server_conf (minor)
* 20060110.2 (2.3.0-dev) flush_packets and flush_wait members added to
* proxy_server (minor)
* 20060110.3 (2.3.0-dev) added inreslist member to proxy_conn_rec (minor)
* 20060110.4 (2.3.0-dev) Added server_scheme member to server_rec (minor)
* 20060905.0 (2.3.0-dev) Replaced ap_get_server_version() with
* ap_get_server_banner() and ap_get_server_description()
* 20060905.1 (2.3.0-dev) Enable retry=0 for the worker (minor)
* 20060905.2 (2.3.0-dev) Added ap_all_available_mutexes_string,
* ap_available_mutexes_string and
* ap_parse_mutex()
* 20060905.3 (2.3.0-dev) Added conn_rec::clogging_input_filters.
* 20060905.4 (2.3.0-dev) Added proxy_balancer::sticky_path.
* 20060905.5 (2.3.0-dev) Added ap_mpm_safe_kill()
* 20070823.0 (2.3.0-dev) Removed ap_all_available_mutexes_string,
* ap_available_mutexes_string for macros
* 20070823.1 (2.3.0-dev) add ap_send_interim_response()
* 20071023.0 (2.3.0-dev) add ap_get_scoreboard(sbh) split from the less
* conventional ap_get_scoreboard(proc, thread)
* 20071023.1 (2.3.0-dev) Add flags field to struct proxy_alias
* 20071023.2 (2.3.0-dev) Add ap_mod_status_reqtail
* 20071023.3 (2.3.0-dev) Declare ap_time_process_request() as part of the
* public scoreboard API.
* 20071108.1 (2.3.0-dev) Add the optional kept_body brigade to request_rec
* 20071108.2 (2.3.0-dev) Add st and keep fields to struct util_ldap_connection_t
* 20071108.3 (2.3.0-dev) Add API guarantee for adding connection filters
* with non-NULL request_rec pointer (ap_add_*_filter*)
* 20071108.4 (2.3.0-dev) Add ap_proxy_ssl_connection_cleanup
* 20071108.5 (2.3.0-dev) Add *scpool to proxy_conn_rec structure
* 20071108.6 (2.3.0-dev) Add *r and need_flush to proxy_conn_rec structure
* 20071108.7 (2.3.0-dev) Add *ftp_directory_charset to proxy_dir_conf
* 20071108.8 (2.3.0-dev) Add optional function ap_logio_add_bytes_in() to mog_logio
* 20071108.9 (2.3.0-dev) Add chroot support to unixd_config
* 20071108.10(2.3.0-dev) Introduce new ap_expr API
* 20071108.12(2.3.0-dev) Remove ap_expr_clone from the API (same day it was added)
* 20080403.0 (2.3.0-dev) Add condition field to core dir config
* 20080403.1 (2.3.0-dev) Add authn/z hook and provider registration wrappers.
* 20080403.2 (2.3.0-dev) Add ap_escape_path_segment_buffer() and ap_unescape_all().
* 20080407.0 (2.3.0-dev) Remove ap_graceful_stop_signalled.
* 20080407.1 Deprecate ap_cache_cacheable_hdrs_out and add two
* generalized ap_cache_cacheable_headers_(in|out).
* 20080528.0 (2.3.0-dev) Switch order of ftp_directory_charset and
* interpolate_env in proxy_dir_conf.
* Rationale: see r661069.
* 20080528.1 (2.3.0-dev) add has_realm_hash() to authn_provider struct
* 20080722.0 (2.3.0-dev) remove has_realm_hash() from authn_provider struct
* 20080722.1 (2.3.0-dev) Add conn_timeout and conn_timeout_set to
* proxy_worker struct.
* 20080722.2 (2.3.0-dev) Add scolonsep to proxy_balancer
* 20080829.0 (2.3.0-dev) Add cookie attributes when removing cookies
* 20080830.0 (2.3.0-dev) Cookies can be set on headers_out and err_headers_out
* 20080920.0 (2.3.0-dev) Add ap_mpm_register_timed_callback.
* 20080920.1 (2.3.0-dev) Export mod_rewrite.h in the public API.
* 20081101.0 (2.3.0-dev) Remove unused AUTHZ_GROUP_NOTE define.
* 20081102.0 (2.3.0-dev) Remove authz_provider_list, authz_request_state,
* and AUTHZ_ACCESS_PASSED_NOTE.
* 20081104.0 (2.3.0-dev) Remove r and need_flush fields from proxy_conn_rec
* as they are no longer used and add
* ap_proxy_buckets_lifetime_transform to mod_proxy.h
* 20081129.0 (2.3.0-dev) Move AP_FILTER_ERROR and AP_NOBODY_READ|WROTE
* from util_filter.h to httpd.h and change their
* numeric values so they do not overlap with other
* potential status codes
* 20081201.0 (2.3.0-dev) Rename several APIs to include ap_ prefix.
* 20081201.1 (2.3.0-dev) Added ap_args_to_table and ap_body_to_table.
* 20081212.0 (2.3.0-dev) Remove sb_type from process_score in scoreboard.h.
* 20081231.0 (2.3.0-dev) Switch ap_escape_html API: add ap_escape_html2,
* and make ap_escape_html a macro for it.
* 20090130.0 (2.3.2-dev) Add ap_ prefix to unixd_setup_child().
* 20090131.0 (2.3.2-dev) Remove ap_default_type(), disable DefaultType
* 20090208.0 (2.3.2-dev) Add conn_rec::current_thread.
* 20090208.1 (2.3.3-dev) Add ap_retained_data_create()/ap_retained_data_get()
* 20090401.0 (2.3.3-dev) Remove ap_threads_per_child, ap_max_daemons_limit,
* ap_my_generation, etc. ap_mpm_query() can't be called
* until after the register-hooks phase.
* 20090401.1 (2.3.3-dev) Protected log.c internals, http_log.h changes
* 20090401.2 (2.3.3-dev) Added tmp_flush_bb to core_output_filter_ctx_t
* 20090401.3 (2.3.3-dev) Added DAV options provider to mod_dav.h
* 20090925.0 (2.3.3-dev) Added server_rec::context and added *server_rec
* param to ap_wait_or_timeout()
* 20090925.1 (2.3.3-dev) Add optional function ap_logio_get_last_bytes() to
* mod_logio
* 20091011.0 (2.3.3-dev) Move preserve_host{,_set} from proxy_server_conf to
* proxy_dir_conf
* 20091011.1 (2.3.3-dev) add debug_level to util_ldap_state_t
* 20091031.0 (2.3.3-dev) remove public LDAP referral-related macros
* 20091119.0 (2.3.4-dev) dav_error interface uses apr_status_t parm, not errno
* 20091119.1 (2.3.4-dev) ap_mutex_register(), ap_{proc,global}_mutex_create()
* 20091229.0 (2.3.5-dev) Move allowed_connect_ports from proxy_server_conf
* to mod_proxy_connect
* 20091230.0 (2.3.5-dev) Move ftp_directory_charset from proxy_dir_conf
* to proxy_ftp_dir_conf(mod_proxy_ftp)
* 20091230.1 (2.3.5-dev) add util_ldap_state_t.opTimeout
* 20091230.2 (2.3.5-dev) add ap_get_server_name_for_url()
* 20091230.3 (2.3.6-dev) add ap_parse_log_level()
* 20091230.4 (2.3.6-dev) export ap_process_request_after_handler() for mod_serf
* 20100208.0 (2.3.6-dev) ap_socache_provider_t API changes to store and iterate
* 20100208.1 (2.3.6-dev) Added forward member to proxy_conn_rec
* 20100208.2 (2.3.6-dev) Added ap_log_command_line().
* 20100223.0 (2.3.6-dev) LDAP client_certs per-server moved to per-dir
* 20100223.1 (2.3.6-dev) Added ap_process_fnmatch_configs().
* 20100504.0 (2.3.6-dev) Added name arg to ap_{proc,global}_mutex_create().
* 20100604.0 (2.3.6-dev) Remove unused core_dir_config::loglevel
* 20100606.0 (2.3.6-dev) Make ap_log_*error macro wrappers around
* ap_log_*error_ to save argument preparation and
* function call overhead.
* Introduce per-module loglevels
* 20100606.1 (2.3.6-dev) Added extended timestamp formatting via
* ap_recent_ctime_ex().
* 20100609.0 (2.3.6-dev) Dropped ap_body_to_table due to missing constraints.
* 20100609.1 (2.3.7-dev) Introduce ap_log_cserror()
* 20100609.2 (2.3.7-dev) Add deferred write pool to core_output_filter_ctx
* 20100625.0 (2.3.7-dev) Add 'userctx' to socache iterator callback prototype
* 20100630.0 (2.3.7-dev) make module_levels vector of char instead of int
* 20100701.0 (2.3.7-dev) re-order struct members to improve alignment
* 20100701.1 (2.3.7-dev) add note_auth_failure hook
* 20100701.2 (2.3.7-dev) add ap_proxy_*_wid() functions
* 20100714.0 (2.3.7-dev) add access_checker_ex hook, add AUTHZ_DENIED_NO_USER
* to authz_status, call authz providers twice to allow
* authz without authenticated user
* 20100719.0 (2.3.7-dev) Add symbol name parameter to ap_add_module and
* ap_add_loaded_module. Add ap_find_module_short_name
* 20100723.0 (2.3.7-dev) Remove ct_output_filters from core rec
* 20100723.1 (2.3.7-dev) Added ap_proxy_hashfunc() and hash elements to
* proxy worker structs
* 20100723.2 (2.3.7-dev) Add ap_request_has_body()
* 20100723.3 (2.3.8-dev) Add ap_check_mpm()
* 20100905.0 (2.3.9-dev) Add log_id to conn and req recs. Add error log
* format handlers. Support AP_CTIME_OPTION_COMPACT in
* ap_recent_ctime_ex().
* 20100905.1 (2.3.9-dev) Add ap_cache_check_allowed()
* 20100912.0 (2.3.9-dev) Add an additional "out" brigade parameter to the
* mod_cache store_body() provider function.
* 20100916.0 (2.3.9-dev) Add commit_entity() to the mod_cache provider
* interface.
* 20100918.0 (2.3.9-dev) Move the request_rec within mod_include to be
* exposed within include_ctx_t.
* 20100919.0 (2.3.9-dev) Authz providers: Add parsed_require_line parameter
* to check_authorization() function. Add
* parse_require_line() function.
* 20100921.0 (2.3.9-dev) Add an apr_bucket_brigade to the create_entity
* provider interface for mod_cache.h.
* 20100922.0 (2.3.9-dev) Move cache_* functions from mod_cache.h to a
* private header file.
* 20100923.0 (2.3.9-dev) Remove MOD_CACHE_REQUEST_REC, remove deprecated
* ap_cache_cacheable_hdrs_out, trim cache_object_t,
* make ap_cache_accept_headers, ap_cache_accept_headers
* ap_cache_try_lock, ap_cache_check_freshness,
* cache_server_conf, cache_enable, cache_disable,
* cache_request_rec and cache_provider_list private.
* 20100923.1 (2.3.9-dev) Add cache_status hook.
* 20100923.2 (2.3.9-dev) Add generate_log_id hook.
* Make root parameter of ap_expr_eval() const.
* 20100923.3 (2.3.9-dev) Add "last" member to ap_directive_t
* 20101012.0 (2.3.9-dev) Add header to cache_status hook.
* 20101016.0 (2.3.9-dev) Remove ap_cache_check_allowed().
* 20101017.0 (2.3.9-dev) Make ap_cache_control() public, add cache_control_t
* to mod_disk_cache format.
* 20101106.0 (2.3.9-dev) Replace the ap_expr parser derived from
* mod_include's parser with one derived from
* mod_ssl's parser. Clean up ap_expr's public
* interface.
*/
#ifndef MODULE_MAGIC_NUMBER_MAJOR
#define MODULE_MAGIC_NUMBER_MAJOR 20101106
#endif
#define MODULE_MAGIC_NUMBER_MINOR 0 /* 0...n */
/**
* Determine if the server's current MODULE_MAGIC_NUMBER is at least a
* specified value.
*
* Useful for testing for features.
* For example, suppose you wish to use the apr_table_overlap
* function. You can do this:
*
* \code
* #if AP_MODULE_MAGIC_AT_LEAST(19980812,2)
* ... use apr_table_overlap()
* #else
* ... alternative code which doesn't use apr_table_overlap()
* #endif
* \endcode
*
* @param major The major module magic number
* @param minor The minor module magic number
* @def AP_MODULE_MAGIC_AT_LEAST(int major, int minor)
*/
((major) < MODULE_MAGIC_NUMBER_MAJOR \
|| ((major) == MODULE_MAGIC_NUMBER_MAJOR \
&& (minor) <= MODULE_MAGIC_NUMBER_MINOR))
/** @deprecated present for backwards compatibility */
#endif /* !APACHE_AP_MMN_H */
/** @} */