ap_mmn.h revision 8b7594c66e764f5cd3506b6f2459497ab65a8b03
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames/* Copyright 1999-2005 The Apache Software Foundation or its licensors, as
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * applicable.
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding *
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding * Licensed under the Apache License, Version 2.0 (the "License");
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding * you may not use this file except in compliance with the License.
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding * You may obtain a copy of the License at
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding *
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding * http://www.apache.org/licenses/LICENSE-2.0
240b85022b73af58a6d971cd3d05d54037d8f682nd *
240b85022b73af58a6d971cd3d05d54037d8f682nd * Unless required by applicable law or agreed to in writing, software
240b85022b73af58a6d971cd3d05d54037d8f682nd * distributed under the License is distributed on an "AS IS" BASIS,
240b85022b73af58a6d971cd3d05d54037d8f682nd * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
240b85022b73af58a6d971cd3d05d54037d8f682nd * See the License for the specific language governing permissions and
240b85022b73af58a6d971cd3d05d54037d8f682nd * limitations under the License.
240b85022b73af58a6d971cd3d05d54037d8f682nd */
240b85022b73af58a6d971cd3d05d54037d8f682nd
240b85022b73af58a6d971cd3d05d54037d8f682nd#ifndef APACHE_AP_MMN_H
240b85022b73af58a6d971cd3d05d54037d8f682nd#define APACHE_AP_MMN_H
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames/**
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * @package Module Magic Number
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames */
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames/*
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * MODULE_MAGIC_NUMBER_MAJOR
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * Major API changes that could cause compatibility problems for older modules
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * such as structure size changes. No binary compatibility is possible across
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * a change in the major version.
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames *
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * MODULE_MAGIC_NUMBER_MINOR
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * Minor API changes that do not cause binary compatibility problems.
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * Should be reset to 0 when upgrading MODULE_MAGIC_NUMBER_MAJOR.
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames *
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * See the MODULE_MAGIC_AT_LEAST macro below for an example.
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames */
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames/*
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20010224 (2.0.13-dev) MODULE_MAGIC_COOKIE reset to "AP20"
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20010523 (2.0.19-dev) bump for scoreboard structure reordering
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20010627 (2.0.19-dev) more API changes than I can count
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20010726 (2.0.22-dev) more big API changes
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20010808 (2.0.23-dev) dir d_is_absolute bit introduced, bucket changes, etc
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20010825 (2.0.25-dev) removed d_is_absolute, introduced map_to_storage hook
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20011002 (2.0.26-dev) removed 1.3-depreciated request_rec.content_language
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20011127 (2.0.29-dev) bump for postconfig hook change, and removal of socket
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * from connection record
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20011212 (2.0.30-dev) bump for new used_path_info member of request_rec
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20011218 (2.0.30-dev) bump for new sbh member of conn_rec, different
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * declarations for scoreboard, new parameter to
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * create_connection hook
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020102 (2.0.30-dev) bump for changed type of limit_req_body in
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * core_dir_config
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020109 (2.0.31-dev) bump for changed shm and scoreboard declarations
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020111 (2.0.31-dev) bump for ETag fields added at end of cor_dir_config
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020114 (2.0.31-dev) mod_dav changed how it asks its provider to fulfill
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * a GET request
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020118 (2.0.31-dev) Input filtering split of blocking and mode
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020127 (2.0.31-dev) bump for pre_mpm hook change
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020128 (2.0.31-dev) bump for pre_config hook change
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020218 (2.0.33-dev) bump for AddOutputFilterByType directive
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020220 (2.0.33-dev) bump for scoreboard.h structure change
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020302 (2.0.33-dev) bump for protocol_filter additions.
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020306 (2.0.34-dev) bump for filter type renames.
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020318 (2.0.34-dev) mod_dav's API for REPORT generation changed
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020319 (2.0.34-dev) M_INVALID changed, plus new M_* methods for RFC 3253
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020327 (2.0.35-dev) Add parameter to quick_handler hook
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020329 (2.0.35-dev) bump for addition of freelists to bucket API
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020329.1 (2.0.36) minor bump for new arg to opt fn ap_cgi_build_command
cd2e0fb5f8e86eecb278e9d623f4c272d96f5e3ctrawick * 20020506 (2.0.37-dev) Removed r->boundary in request_rec.
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020529 (2.0.37-dev) Standardized the names of some apr_pool_*_set funcs
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020602 (2.0.37-dev) Bucket API change (metadata buckets)
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020612 (2.0.38-dev) Changed server_rec->[keep_alive_]timeout to apr time
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020625 (2.0.40-dev) Changed conn_rec->keepalive to an enumeration
86826d685f83170ca07d56550db9f0c2922a916btrawick * 20020628 (2.0.40-dev) Added filter_init to filter registration functions
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020903 (2.0.41-dev) APR's error constants changed
cd2e0fb5f8e86eecb278e9d623f4c272d96f5e3ctrawick * 20020903.1 (2.1.0-dev) allow_encoded_slashes added to core_dir_config
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20020903.2 (2.0.46-dev) add ap_escape_logitem
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20030213.1 (2.1.0-dev) changed log_writer optional fn's to return previous
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * handler
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20030821 (2.1.0-dev) bumped mod_include's entire API
cd2e0fb5f8e86eecb278e9d623f4c272d96f5e3ctrawick * 20030821.1 (2.1.0-dev) added XHTML doctypes
cd2e0fb5f8e86eecb278e9d623f4c272d96f5e3ctrawick * 20030821.2 (2.1.0-dev) added ap_escape_errorlog_item
cd2e0fb5f8e86eecb278e9d623f4c272d96f5e3ctrawick * 20030821.3 (2.1.0-dev) added ap_get_server_revision / ap_version_t
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20040425 (2.1.0-dev) removed ap_add_named_module API
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * changed ap_add_module, ap_add_loaded_module,
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * ap_setup_prelinked_modules, ap_process_resource_config
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20040425.1 (2.1.0-dev) Added ap_module_symbol_t and ap_prelinked_module_symbols
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20050101.0 (2.1.2-dev) Axed misnamed http_method for http_scheme (which it was!)
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20050127.0 (2.1.3-dev) renamed regex_t->ap_regex_t, regmatch_t->ap_regmatch_t,
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * REG_*->AP_REG_*, removed reg* in place of ap_reg*;
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * added ap_regex.h
43162230430f8144afe9c32cd0e60b927f4e0a60gregames * 20050217.0 (2.1.3-dev) Axed find_child_by_pid, mpm_*_completion_context (winnt mpm)
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * symbols from the public sector, and decorated real_exit_code
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * with ap_ in the win32 os.h.
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * 20050305.0 (2.1.4-dev) added pid and generation fields to worker_score
88dd056b9863502bba82c2889a0c4cde9fc0ba93trawick * 20050305.1 (2.1.5-dev) added ap_vhost_iterate_given_conn.
1c86147fa9b58111f7df3b0e24a5bf97833d5d84trawick * 20050305.2 (2.1.5-dev) added AP_INIT_TAKE_ARGV.
89211a5d592cdf0170d2b541946661b1a2a279c5trawick */
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames#define MODULE_MAGIC_COOKIE 0x41503230UL /* "AP20" */
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames#ifndef MODULE_MAGIC_NUMBER_MAJOR
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames#define MODULE_MAGIC_NUMBER_MAJOR 20050305
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames#endif
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames#define MODULE_MAGIC_NUMBER_MINOR 2 /* 0...n */
43162230430f8144afe9c32cd0e60b927f4e0a60gregames
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames/**
d468ce085370fb85e0cb4e3b48bd1a47c2eca33ctrawick * Determine if the server's current MODULE_MAGIC_NUMBER is at least a
d468ce085370fb85e0cb4e3b48bd1a47c2eca33ctrawick * specified value.
d468ce085370fb85e0cb4e3b48bd1a47c2eca33ctrawick * <pre>
d468ce085370fb85e0cb4e3b48bd1a47c2eca33ctrawick * Useful for testing for features.
8b30d716ef6380801f225010838faa3c00141a06trawick * For example, suppose you wish to use the apr_table_overlap
8b30d716ef6380801f225010838faa3c00141a06trawick * function. You can do this:
8b30d716ef6380801f225010838faa3c00141a06trawick *
d468ce085370fb85e0cb4e3b48bd1a47c2eca33ctrawick * #if AP_MODULE_MAGIC_AT_LEAST(19980812,2)
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * ... use apr_table_overlap()
8b30d716ef6380801f225010838faa3c00141a06trawick * #else
d468ce085370fb85e0cb4e3b48bd1a47c2eca33ctrawick * ... alternative code which doesn't use apr_table_overlap()
d468ce085370fb85e0cb4e3b48bd1a47c2eca33ctrawick * #endif
d468ce085370fb85e0cb4e3b48bd1a47c2eca33ctrawick * </pre>
d468ce085370fb85e0cb4e3b48bd1a47c2eca33ctrawick * @param major The major module magic number
c0d403aebd449af101969d1ff60a8cbcf9ecf35cgregames * @param minor The minor module magic number
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames * @deffunc AP_MODULE_MAGIC_AT_LEAST(int major, int minor)
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames */
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames#define AP_MODULE_MAGIC_AT_LEAST(major,minor) \
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames ((major) < MODULE_MAGIC_NUMBER_MAJOR \
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames || ((major) == MODULE_MAGIC_NUMBER_MAJOR \
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames && (minor) <= MODULE_MAGIC_NUMBER_MINOR))
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames/** @deprecated present for backwards compatibility */
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames#define MODULE_MAGIC_NUMBER MODULE_MAGIC_NUMBER_MAJOR
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames#define MODULE_MAGIC_AT_LEAST old_broken_macro_we_hope_you_are_not_using
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames#endif /* !APACHE_AP_MMN_H */
3d0434b7f8ce3bfce252ebbe3cabe626ba750d83gregames