| blob | 8c003d28bbc32802b3e0baf7ca5dd09b19192d82 |
1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
17 /**
18 * @file ap_mpm.h
19 * @brief Module Magic Number
20 *
21 * @defgroup APACHE_CORE_MMN Module Magic Number
22 * @ingroup APACHE_CORE
23 * @{
24 */
26 #ifndef APACHE_AP_MMN_H
27 #define APACHE_AP_MMN_H
29 /*
30 * MODULE_MAGIC_NUMBER_MAJOR
31 * Major API changes that could cause compatibility problems for older modules
32 * such as structure size changes. No binary compatibility is possible across
33 * a change in the major version.
34 *
35 * MODULE_MAGIC_NUMBER_MINOR
36 * Minor API changes that do not cause binary compatibility problems.
37 * Should be reset to 0 when upgrading MODULE_MAGIC_NUMBER_MAJOR.
38 *
39 * See the MODULE_MAGIC_AT_LEAST macro below for an example.
40 */
42 /*
43 * 20010224 (2.0.13-dev) MODULE_MAGIC_COOKIE reset to "AP20"
44 * 20010523 (2.0.19-dev) bump for scoreboard structure reordering
45 * 20010627 (2.0.19-dev) more API changes than I can count
46 * 20010726 (2.0.22-dev) more big API changes
47 * 20010808 (2.0.23-dev) dir d_is_absolute bit introduced, bucket changes, etc
48 * 20010825 (2.0.25-dev) removed d_is_absolute, introduced map_to_storage hook
49 * 20011002 (2.0.26-dev) removed 1.3-deprecated request_rec.content_language
50 * 20011127 (2.0.29-dev) bump for postconfig hook change, and removal of
51 * socket from connection record
52 * 20011212 (2.0.30-dev) bump for new used_path_info member of request_rec
53 * 20011218 (2.0.30-dev) bump for new sbh member of conn_rec, different
54 * declarations for scoreboard, new parameter to
55 * create_connection hook
56 * 20020102 (2.0.30-dev) bump for changed type of limit_req_body in
57 * core_dir_config
58 * 20020109 (2.0.31-dev) bump for changed shm and scoreboard declarations
59 * 20020111 (2.0.31-dev) bump for ETag fields added at end of cor_dir_config
60 * 20020114 (2.0.31-dev) mod_dav changed how it asks its provider to fulfill
61 * a GET request
62 * 20020118 (2.0.31-dev) Input filtering split of blocking and mode
63 * 20020127 (2.0.31-dev) bump for pre_mpm hook change
64 * 20020128 (2.0.31-dev) bump for pre_config hook change
65 * 20020218 (2.0.33-dev) bump for AddOutputFilterByType directive
66 * 20020220 (2.0.33-dev) bump for scoreboard.h structure change
67 * 20020302 (2.0.33-dev) bump for protocol_filter additions.
68 * 20020306 (2.0.34-dev) bump for filter type renames.
69 * 20020318 (2.0.34-dev) mod_dav's API for REPORT generation changed
70 * 20020319 (2.0.34-dev) M_INVALID changed, plus new M_* methods for RFC 3253
71 * 20020327 (2.0.35-dev) Add parameter to quick_handler hook
72 * 20020329 (2.0.35-dev) bump for addition of freelists to bucket API
73 * 20020329.1 (2.0.36) minor bump for new arg to opt fn ap_cgi_build_command
74 * 20020506 (2.0.37-dev) Removed r->boundary in request_rec.
75 * 20020529 (2.0.37-dev) Standardized the names of some apr_pool_*_set funcs
76 * 20020602 (2.0.37-dev) Bucket API change (metadata buckets)
77 * 20020612 (2.0.38-dev) Changed server_rec->[keep_alive_]timeout to apr time
78 * 20020625 (2.0.40-dev) Changed conn_rec->keepalive to an enumeration
79 * 20020628 (2.0.40-dev) Added filter_init to filter registration functions
80 * 20020903 (2.0.41-dev) APR's error constants changed
81 * 20020903.1 (2.1.0-dev) allow_encoded_slashes added to core_dir_config
82 * 20020903.2 (2.0.46-dev) add ap_escape_logitem
83 * 20030213.1 (2.1.0-dev) changed log_writer optional fn's to return previous
84 * handler
85 * 20030821 (2.1.0-dev) bumped mod_include's entire API
86 * 20030821.1 (2.1.0-dev) added XHTML doctypes
87 * 20030821.2 (2.1.0-dev) added ap_escape_errorlog_item
88 * 20030821.3 (2.1.0-dev) added ap_get_server_revision / ap_version_t
89 * 20040425 (2.1.0-dev) removed ap_add_named_module API
90 * changed ap_add_module, ap_add_loaded_module,
91 * ap_setup_prelinked_modules,
92 * ap_process_resource_config
93 * 20040425.1 (2.1.0-dev) Added ap_module_symbol_t and
94 * ap_prelinked_module_symbols
95 * 20050101.0 (2.1.2-dev) Axed misnamed http_method for http_scheme
96 * (which it was!)
97 * 20050127.0 (2.1.3-dev) renamed regex_t->ap_regex_t,
98 * regmatch_t->ap_regmatch_t, REG_*->AP_REG_*,
99 * removed reg* in place of ap_reg*; added ap_regex.h
100 * 20050217.0 (2.1.3-dev) Axed find_child_by_pid, mpm_*_completion_context
101 * (winnt mpm) symbols from the public sector, and
102 * decorated real_exit_code with ap_ in the win32/os.h.
103 * 20050305.0 (2.1.4-dev) added pid and generation fields to worker_score
104 * 20050305.1 (2.1.5-dev) added ap_vhost_iterate_given_conn.
105 * 20050305.2 (2.1.5-dev) added AP_INIT_TAKE_ARGV.
106 * 20050305.3 (2.1.5-dev) added Protocol Framework.
107 * 20050701.0 (2.1.7-dev) Bump MODULE_MAGIC_COOKIE to "AP21"!
108 * 20050701.1 (2.1.7-dev) trace_enable member added to core server_config
109 * 20050708.0 (2.1.7-dev) Bump MODULE_MAGIC_COOKIE to "AP22"!
110 * 20050708.1 (2.1.7-dev) add proxy request_status hook (minor)
111 * 20050919.0 (2.1.8-dev) mod_ssl ssl_ext_list optional function added
112 * 20051005.0 (2.1.8-dev) NET_TIME filter eliminated
113 * 20051005.0 (2.3.0-dev) Bump MODULE_MAGIC_COOKIE to "AP24"!
114 * 20051115.0 (2.3.0-dev) Added use_canonical_phys_port to core_dir_config
115 * 20060110.0 (2.3.0-dev) Conversion of Authz to be provider based
116 * addition of <SatisfyAll><SatisfyOne>
117 * removal of Satisfy, Allow, Deny, Order
118 * 20060110.1 (2.3.0-dev) minex and minex_set members added to
119 * cache_server_conf (minor)
120 * 20060110.2 (2.3.0-dev) flush_packets and flush_wait members added to
121 * proxy_server (minor)
122 * 20060110.3 (2.3.0-dev) added inreslist member to proxy_conn_rec (minor)
123 * 20060110.4 (2.3.0-dev) Added server_scheme member to server_rec (minor)
124 * 20060905.0 (2.3.0-dev) Replaced ap_get_server_version() with
125 * ap_get_server_banner() and ap_get_server_description()
126 * 20060905.1 (2.3.0-dev) Enable retry=0 for the worker (minor)
127 * 20060905.2 (2.3.0-dev) Added ap_all_available_mutexes_string,
128 * ap_available_mutexes_string and
129 * ap_parse_mutex()
130 * 20060905.3 (2.3.0-dev) Added conn_rec::clogging_input_filters.
131 * 20060905.4 (2.3.0-dev) Added proxy_balancer::sticky_path.
132 * 20060905.5 (2.3.0-dev) Added ap_mpm_safe_kill()
133 * 20070823.0 (2.3.0-dev) Removed ap_all_available_mutexes_string,
134 * ap_available_mutexes_string for macros
135 * 20070823.1 (2.3.0-dev) add ap_send_interim_response()
136 * 20071023.0 (2.3.0-dev) add ap_get_scoreboard(sbh) split from the less
137 * conventional ap_get_scoreboard(proc, thread)
138 * 20071023.1 (2.3.0-dev) Add flags field to struct proxy_alias
139 * 20071023.2 (2.3.0-dev) Add ap_mod_status_reqtail
140 * 20071023.3 (2.3.0-dev) Declare ap_time_process_request() as part of the
141 * public scoreboard API.
142 * 20071108.1 (2.3.0-dev) Add the optional kept_body brigade to request_rec
143 * 20071108.2 (2.3.0-dev) Add st and keep fields to struct util_ldap_connection_t
144 * 20071108.3 (2.3.0-dev) Add API guarantee for adding connection filters
145 * with non-NULL request_rec pointer (ap_add_*_filter*)
146 * 20071108.4 (2.3.0-dev) Add ap_proxy_ssl_connection_cleanup
147 * 20071108.5 (2.3.0-dev) Add *scpool to proxy_conn_rec structure
148 * 20071108.6 (2.3.0-dev) Add *r and need_flush to proxy_conn_rec structure
149 * 20071108.7 (2.3.0-dev) Add *ftp_directory_charset to proxy_dir_conf
150 * 20071108.8 (2.3.0-dev) Add optional function ap_logio_add_bytes_in() to mog_logio
151 * 20071108.9 (2.3.0-dev) Add chroot support to unixd_config
152 * 20071108.10(2.3.0-dev) Introduce new ap_expr API
153 * 20071108.11(2.3.0-dev) Revise/Expand new ap_expr API
154 * 20071108.12(2.3.0-dev) Remove ap_expr_clone from the API (same day it was added)
155 * 20080403.0 (2.3.0-dev) Add condition field to core dir config
156 * 20080403.1 (2.3.0-dev) Add authn/z hook and provider registration wrappers.
157 * 20080403.2 (2.3.0-dev) Add ap_escape_path_segment_buffer() and ap_unescape_all().
158 * 20080407.0 (2.3.0-dev) Remove ap_graceful_stop_signalled.
159 * 20080407.1 Deprecate ap_cache_cacheable_hdrs_out and add two
160 * generalized ap_cache_cacheable_headers_(in|out).
161 * 20080528.0 (2.3.0-dev) Switch order of ftp_directory_charset and
162 * interpolate_env in proxy_dir_conf.
163 * Rationale: see r661069.
164 * 20080528.1 (2.3.0-dev) add has_realm_hash() to authn_provider struct
165 * 20080722.0 (2.3.0-dev) remove has_realm_hash() from authn_provider struct
166 * 20080722.1 (2.3.0-dev) Add conn_timeout and conn_timeout_set to
167 * proxy_worker struct.
168 * 20080722.2 (2.3.0-dev) Add scolonsep to proxy_balancer
169 * 20080829.0 (2.3.0-dev) Add cookie attributes when removing cookies
170 * 20080830.0 (2.3.0-dev) Cookies can be set on headers_out and err_headers_out
171 * 20080920.0 (2.3.0-dev) Add ap_mpm_register_timed_callback.
172 * 20080920.1 (2.3.0-dev) Export mod_rewrite.h in the public API.
173 * 20080920.2 (2.3.0-dev) Added ap_timeout_parameter_parse to util.c / httpd.h
174 * 20081101.0 (2.3.0-dev) Remove unused AUTHZ_GROUP_NOTE define.
175 * 20081102.0 (2.3.0-dev) Remove authz_provider_list, authz_request_state,
176 * and AUTHZ_ACCESS_PASSED_NOTE.
177 * 20081104.0 (2.3.0-dev) Remove r and need_flush fields from proxy_conn_rec
178 * as they are no longer used and add
179 * ap_proxy_buckets_lifetime_transform to mod_proxy.h
180 * 20081129.0 (2.3.0-dev) Move AP_FILTER_ERROR and AP_NOBODY_READ|WROTE
181 * from util_filter.h to httpd.h and change their
182 * numeric values so they do not overlap with other
183 * potential status codes
184 * 20081201.0 (2.3.0-dev) Rename several APIs to include ap_ prefix.
185 * 20081201.1 (2.3.0-dev) Added ap_args_to_table and ap_body_to_table.
186 * 20081212.0 (2.3.0-dev) Remove sb_type from process_score in scoreboard.h.
187 * 20081231.0 (2.3.0-dev) Switch ap_escape_html API: add ap_escape_html2,
188 * and make ap_escape_html a macro for it.
189 * 20090130.0 (2.3.2-dev) Add ap_ prefix to unixd_setup_child().
190 * 20090131.0 (2.3.2-dev) Remove ap_default_type(), disable DefaultType
191 * 20090208.0 (2.3.2-dev) Add conn_rec::current_thread.
192 */
196 #ifndef MODULE_MAGIC_NUMBER_MAJOR
197 #define MODULE_MAGIC_NUMBER_MAJOR 20090208
198 #endif
201 /**
202 * Determine if the server's current MODULE_MAGIC_NUMBER is at least a
203 * specified value.
204 * <pre>
205 * Useful for testing for features.
206 * For example, suppose you wish to use the apr_table_overlap
207 * function. You can do this:
208 *
209 * #if AP_MODULE_MAGIC_AT_LEAST(19980812,2)
210 * ... use apr_table_overlap()
211 * #else
212 * ... alternative code which doesn't use apr_table_overlap()
213 * #endif
214 * </pre>
215 * @param major The major module magic number
216 * @param minor The minor module magic number
217 * @fn AP_MODULE_MAGIC_AT_LEAST(int major, int minor)
218 */
219 #define AP_MODULE_MAGIC_AT_LEAST(major,minor) \
220 ((major) < MODULE_MAGIC_NUMBER_MAJOR \
221 || ((major) == MODULE_MAGIC_NUMBER_MAJOR \
222 && (minor) <= MODULE_MAGIC_NUMBER_MINOR))
224 /** @deprecated present for backwards compatibility */
225 #define MODULE_MAGIC_NUMBER MODULE_MAGIC_NUMBER_MAJOR
226 #define MODULE_MAGIC_AT_LEAST old_broken_macro_we_hope_you_are_not_using
229 /** @} */