mod_proxy.h revision d2cc8f1a060fa04373718826af986c49de3bff4b
842ae4bd224140319ae7feec1872b93dfd491143fielding/* Licensed to the Apache Software Foundation (ASF) under one or more
842ae4bd224140319ae7feec1872b93dfd491143fielding * contributor license agreements. See the NOTICE file distributed with
842ae4bd224140319ae7feec1872b93dfd491143fielding * this work for additional information regarding copyright ownership.
842ae4bd224140319ae7feec1872b93dfd491143fielding * The ASF licenses this file to You under the Apache License, Version 2.0
842ae4bd224140319ae7feec1872b93dfd491143fielding * (the "License"); you may not use this file except in compliance with
842ae4bd224140319ae7feec1872b93dfd491143fielding * the License. You may obtain a copy of the License at
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * Unless required by applicable law or agreed to in writing, software
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * distributed under the License is distributed on an "AS IS" BASIS,
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * See the License for the specific language governing permissions and
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * limitations under the License.
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @brief Proxy Extension Module for Apache
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @defgroup MOD_PROXY mod_proxy
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @ingroup APACHE_MODS
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp/* for proxy_canonenc() */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#else /*APR_CHARSET_EBCDIC*/
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#endif /*APR_CHARSET_EBCDIC*/
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/* default Max-Forwards header setting */
3d96ee83babeec32482c9082c9426340cee8c44dwrowe/* Set this to -1, which complies with RFC2616 by not setting
2d2eda71267231c2526be701fe655db125852c1ffielding * max-forwards if the client didn't send it to us.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/* static information about a remote proxy */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *scheme; /* the schemes handled by this proxy, or '*' */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *protocol; /* the scheme used to talk to this proxy */
2d2eda71267231c2526be701fe655db125852c1ffielding ap_regex_t *regexp; /* compiled regex (if any) for the remote */
3d96ee83babeec32482c9082c9426340cee8c44dwrowe int use_regex; /* simple boolean. True if we have a regex pattern */
2d2eda71267231c2526be701fe655db125852c1ffielding const char *real;
2d2eda71267231c2526be701fe655db125852c1ffielding const char *fake;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb unsigned int flags;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int (*matcher) (struct dirconn_entry * This, request_rec *r);
3d96ee83babeec32482c9082c9426340cee8c44dwrowe const char *name;
61fd0cab072a05b855cbef9c585702401ac5ae29rbbtypedef struct proxy_balancer_method proxy_balancer_method;
3d96ee83babeec32482c9082c9426340cee8c44dwrowetypedef struct {
c9a95767fbf0f5fb0976a06b97a256033925e433rbb apr_array_header_t *workers; /* non-balancer workers, eg ProxyPass http://example.com */
c9a95767fbf0f5fb0976a06b97a256033925e433rbb apr_array_header_t *balancers; /* list of balancers @ config time */
c9a95767fbf0f5fb0976a06b97a256033925e433rbb proxy_worker *reverse; /* reverse "module-driven" proxy worker */
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh const char *domain; /* domain name to use in absence of a domain name in the request */
c9a95767fbf0f5fb0976a06b97a256033925e433rbb const char *id;
c9a95767fbf0f5fb0976a06b97a256033925e433rbb apr_pool_t *pool; /* Pool used for allocating this struct */
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh ap_slotmem_instance_t *slot; /* balancers shm data - runtime */
78ae1cbba5a848a24ca551629bbf0a90d2b931f0stastypedef struct {
78ae1cbba5a848a24ca551629bbf0a90d2b931f0stas const char *p; /* The path */
2d2eda71267231c2526be701fe655db125852c1ffielding * ProxyPassReverse and friends are documented as working inside
2d2eda71267231c2526be701fe655db125852c1ffielding * <Location>. But in fact they never have done in the case of
2d2eda71267231c2526be701fe655db125852c1ffielding * more than one <Location>, because the server_conf can't see it.
2d2eda71267231c2526be701fe655db125852c1ffielding * We need to move them to the per-dir config.
2d2eda71267231c2526be701fe655db125852c1ffielding * Discussed in February 2005:
2d2eda71267231c2526be701fe655db125852c1ffielding * http://marc.theaimsgroup.com/?l=apache-httpd-dev&m=110726027118798&w=2
61fd0cab072a05b855cbef9c585702401ac5ae29rbb signed char p_is_fnmatch; /* Is the path an fnmatch candidate? */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * the following setting masks the error page
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * returned from the 'proxied server' and just
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * forwards the status code upwards.
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * This allows the main server (us) to generate
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm * the error page, (so it will look like a error
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein * returned from the rest of the system
3d96ee83babeec32482c9082c9426340cee8c44dwrowe/* if we interpolate env vars per-request, we'll need a per-request
2d2eda71267231c2526be701fe655db125852c1ffielding * copy of the reverse proxy config
2d2eda71267231c2526be701fe655db125852c1ffieldingtypedef struct {
62db15de4c1f335a64d45821796ae197cff94ef8rbbtypedef struct {
62db15de4c1f335a64d45821796ae197cff94ef8rbb request_rec *r; /* Request record of the backend request
62db15de4c1f335a64d45821796ae197cff94ef8rbb * that is used over the backend connection. */
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb proxy_worker *worker; /* Connection pool this connection belongs to */
62db15de4c1f335a64d45821796ae197cff94ef8rbb apr_pool_t *pool; /* Subpool for hostname and addr data */
62db15de4c1f335a64d45821796ae197cff94ef8rbb const char *hostname;
62db15de4c1f335a64d45821796ae197cff94ef8rbb apr_sockaddr_t *addr; /* Preparsed remote address info */
62db15de4c1f335a64d45821796ae197cff94ef8rbb apr_pool_t *scpool; /* Subpool used for socket and connection data */
62db15de4c1f335a64d45821796ae197cff94ef8rbb unsigned int need_flush:1; /* Flag to decide whether we need to flush the
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb * filter chain or not */
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb unsigned int inreslist:1; /* connection in apr_reslist? */
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coartypedef struct {
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar/* Connection pool */
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar apr_pool_t *pool; /* The pool used in constructor and destructor calls */
3d96ee83babeec32482c9082c9426340cee8c44dwrowe apr_sockaddr_t *addr; /* Preparsed remote address info */
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh proxy_conn_rec *conn; /* Single connection for prefork mpm */
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh/* Keep below in sync with proxy_util.c! */
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh/* worker status bits */
41287245b1632a4722b55f6dfe5fcf81f361f043wrowe/* worker status flags */
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#define PROXY_WORKER_NOT_USABLE_BITMAP ( PROXY_WORKER_IN_SHUTDOWN | \
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coarPROXY_WORKER_DISABLED | PROXY_WORKER_STOPPED | PROXY_WORKER_IN_ERROR )
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar/* NOTE: these check the shared status */
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#define PROXY_WORKER_IS_INITIALIZED(f) ( (f)->s->status & PROXY_WORKER_INITIALIZED )
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#define PROXY_WORKER_IS_STANDBY(f) ( (f)->s->status & PROXY_WORKER_HOT_STANDBY )
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#define PROXY_WORKER_IS_USABLE(f) ( ( !( (f)->s->status & PROXY_WORKER_NOT_USABLE_BITMAP) ) && \
3d96ee83babeec32482c9082c9426340cee8c44dwrowe/* default worker retry timeout in seconds */
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar/* Some max char string sizes, for shm fields */
db08da9ddcd65c31f9ea44b823898b72a1b24fbestoddard#define PROXY_STRNCPY(dst, src) apr_cpystrn((dst), (src), sizeof(dst))
2864362ca8266097928e84f101010bdf814ffa08stoddard(w)->s->recv_buffer_size_set = (c)->recv_buffer_size_set; \
2d2eda71267231c2526be701fe655db125852c1ffielding(w)->s->io_buffer_size_set = (c)->io_buffer_size_set; \
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/* Runtime worker status informations. Shared in scoreboard */
61fd0cab072a05b855cbef9c585702401ac5ae29rbbtypedef struct {
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char scheme[PROXY_WORKER_MAX_SCHEME_SIZE]; /* scheme to use ajp|http|https */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char hostname[PROXY_WORKER_MAX_HOSTNAME_SIZE]; /* remote backend address */
3d96ee83babeec32482c9082c9426340cee8c44dwrowe char route[PROXY_WORKER_MAX_ROUTE_SIZE]; /* balancing route */
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein char redirect[PROXY_WORKER_MAX_ROUTE_SIZE]; /* temporary balancing redirection route */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char flusher[PROXY_WORKER_MAX_SCHEME_SIZE]; /* flush provider used by mod_proxy_fdpass */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int min; /* Desired minimum number of available connections */
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding int smax; /* Soft maximum on the total number of connections */
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein int hmax; /* Hard maximum on the total number of connections */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int flush_wait; /* poll wait time in microseconds if flush_auto */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_interval_time_t ttl; /* maximum amount of time in seconds a connection
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * may be available while exceeding the soft limit */
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding apr_interval_time_t acquire; /* acquire timeout when the maximum number of connections is exceeded */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_size_t elected; /* Number of times the worker was elected */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_off_t transferred;/* Number of bytes transferred to remote */
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding apr_off_t read; /* Number of bytes read from remote */
3d96ee83babeec32482c9082c9426340cee8c44dwrowe#define ALIGNED_PROXY_WORKER_SHARED_SIZE (APR_ALIGN_DEFAULT(sizeof(proxy_worker_shared)))
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/* Worker configuration */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb unsigned int local_status; /* status of per-process worker */
3d96ee83babeec32482c9082c9426340cee8c44dwrowe proxy_balancer *balancer; /* which balancer am I in? */
2d2eda71267231c2526be701fe655db125852c1ffielding apr_thread_mutex_t *tmutex; /* Thread lock for updating address cache */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Time to wait (in microseconds) to find out if more data is currently
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * available at the backend.
2d2eda71267231c2526be701fe655db125852c1ffieldingtypedef struct {
2d2eda71267231c2526be701fe655db125852c1ffielding char sticky_path[PROXY_BALANCER_MAX_STICKY_SIZE]; /* URL sticky session identifier */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char sticky[PROXY_BALANCER_MAX_STICKY_SIZE]; /* sticky session identifier */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char lbpname[PROXY_MAX_PROVIDER_NAME_SIZE]; /* lbmethod provider name */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_interval_time_t timeout; /* Timeout for waiting on free connection */
346029f34d03eb20d84fc35664426d3874b00f9ewrowe apr_time_t wupdated; /* timestamp of last change to workers list */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int max_attempts; /* Number of attempts before failing */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb unsigned int sticky_force:1; /* Disable failover for sticky sessions */
346029f34d03eb20d84fc35664426d3874b00f9ewrowe unsigned int scolonsep:1; /* true if ';' seps sticky session paths */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#define ALIGNED_PROXY_BALANCER_SHARED_SIZE (APR_ALIGN_DEFAULT(sizeof(proxy_balancer_shared)))
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_array_header_t *workers; /* initially configured workers */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_array_header_t *errstatuses; /* statuses to force members into error */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb ap_slotmem_instance_t *slot; /* worker shm data - runtime */
3d96ee83babeec32482c9082c9426340cee8c44dwrowe int growth; /* number of post-config workers can added */
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein int max_workers; /* maximum number of allowed workers */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_time_t wupdated; /* timestamp of last change to workers list */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_global_mutex_t *gmutex; /* global lock for updating list of workers */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_thread_mutex_t *tmutex; /* Thread lock for updating shm */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_status_t (*reset)(proxy_balancer *balancer, server_rec *s);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_status_t (*age)(proxy_balancer *balancer, server_rec *s);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_status_t (*updatelbstatus)(proxy_balancer *balancer, proxy_worker *elected, server_rec *s);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#define PROXY_THREAD_LOCK(x) ( (x) && (x)->tmutex ? apr_thread_mutex_lock((x)->tmutex) : APR_SUCCESS)
3d96ee83babeec32482c9082c9426340cee8c44dwrowe#define PROXY_THREAD_UNLOCK(x) ( (x) && (x)->tmutex ? apr_thread_mutex_unlock((x)->tmutex) : APR_SUCCESS)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#define PROXY_GLOBAL_LOCK(x) ( (x) && (x)->gmutex ? apr_global_mutex_lock((x)->gmutex) : APR_SUCCESS)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#define PROXY_GLOBAL_UNLOCK(x) ( (x) && (x)->gmutex ? apr_global_mutex_unlock((x)->gmutex) : APR_SUCCESS)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/* hooks */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/* Create a set of PROXY_DECLARE(type), PROXY_DECLARE_NONSTD(type) and
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * PROXY_DECLARE_DATA with appropriate export and import tags for the platform
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#if !defined(WIN32)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#define PROXY_DECLARE(type) __declspec(dllexport) type __stdcall
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#define PROXY_DECLARE_NONSTD(type) __declspec(dllexport) type
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#define PROXY_DECLARE(type) __declspec(dllimport) type __stdcall
3d96ee83babeec32482c9082c9426340cee8c44dwrowe#define PROXY_DECLARE_NONSTD(type) __declspec(dllimport) type
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Hook an optional proxy hook. Unlike static hooks, this uses a macro
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * instead of a function.
61fd0cab072a05b855cbef9c585702401ac5ae29rbbAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, scheme_handler, (request_rec *r,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb proxy_worker *worker, proxy_server_conf *conf, char *url,
3d96ee83babeec32482c9082c9426340cee8c44dwroweAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, canon_handler, (request_rec *r,
61fd0cab072a05b855cbef9c585702401ac5ae29rbbAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, create_req, (request_rec *r, request_rec *pr))
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianhAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, fixups, (request_rec *r))
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * pre request hook.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * It will return the most suitable worker at the moment
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * and coresponding balancer.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * The url is rewritten from balancer://cluster/uri to scheme://host:port/uri
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * and then the scheme_handler is called.
fd8b91502bc200ed4cca3810560a2a570522b3debrianpAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, pre_request, (proxy_worker **worker,
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * post request hook.
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * It is called after request for updating runtime balancer status.
fd8b91502bc200ed4cca3810560a2a570522b3debrianpAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, post_request, (proxy_worker *worker,
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames * request status hook
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames * It is called after all proxy processing has been done. This gives other
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames * modules a chance to create default content on failure, for example
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregamesAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, request_status,
fd8b91502bc200ed4cca3810560a2a570522b3debrianpPROXY_DECLARE(request_rec *)ap_proxy_make_fake_req(conn_rec *c, request_rec *r);
45613d36b9466a48def0498cffa07f48980720f8jerenkrantzPROXY_DECLARE(char *)ap_proxy_canonenc(apr_pool_t *p, const char *x, int len, enum enctype t,
fd8b91502bc200ed4cca3810560a2a570522b3debrianpPROXY_DECLARE(char *)ap_proxy_canon_netloc(apr_pool_t *p, char **const urlp, char **userp,
45613d36b9466a48def0498cffa07f48980720f8jerenkrantzPROXY_DECLARE(const char *)ap_proxy_date_canon(apr_pool_t *p, const char *x);
45613d36b9466a48def0498cffa07f48980720f8jerenkrantzPROXY_DECLARE(int) ap_proxy_liststr(const char *list, const char *val);
45613d36b9466a48def0498cffa07f48980720f8jerenkrantzPROXY_DECLARE(char *)ap_proxy_removestr(apr_pool_t *pool, const char *list, const char *val);
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregamesPROXY_DECLARE(void) ap_proxy_sec2hex(int t, char *y);
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregamesPROXY_DECLARE(int) ap_proxyerror(request_rec *r, int statuscode, const char *message);
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregamesPROXY_DECLARE(int) ap_proxy_is_ipaddr(struct dirconn_entry *This, apr_pool_t *p);
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianpPROXY_DECLARE(int) ap_proxy_is_domainname(struct dirconn_entry *This, apr_pool_t *p);
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianpPROXY_DECLARE(int) ap_proxy_is_hostname(struct dirconn_entry *This, apr_pool_t *p);
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregamesPROXY_DECLARE(int) ap_proxy_is_word(struct dirconn_entry *This, apr_pool_t *p);
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianpPROXY_DECLARE(int) ap_proxy_checkproxyblock(request_rec *r, proxy_server_conf *conf, apr_sockaddr_t *uri_addr);
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianpPROXY_DECLARE(int) ap_proxy_pre_http_request(conn_rec *c, request_rec *r);
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregamesPROXY_DECLARE(apr_status_t) ap_proxy_string_read(conn_rec *c, apr_bucket_brigade *bb, char *buff, size_t bufflen, int *eos);
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianhPROXY_DECLARE(void) ap_proxy_table_unmerge(apr_pool_t *p, apr_table_t *t, char *key);
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh/* DEPRECATED (will be replaced with ap_proxy_connect_backend */
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregamesPROXY_DECLARE(int) ap_proxy_connect_to_backend(apr_socket_t **, const char *, apr_sockaddr_t *, const char *, proxy_server_conf *, request_rec *);
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregamesPROXY_DECLARE(apr_status_t) ap_proxy_ssl_connection_cleanup(proxy_conn_rec *conn,
61fd0cab072a05b855cbef9c585702401ac5ae29rbbPROXY_DECLARE(const char *) ap_proxy_ssl_val(apr_pool_t *p, server_rec *s, conn_rec *c, request_rec *r, const char *var);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/* Header mapping functions, and a typedef of their signature */
61fd0cab072a05b855cbef9c585702401ac5ae29rbbPROXY_DECLARE(const char *) ap_proxy_location_reverse_map(request_rec *r, proxy_dir_conf *conf, const char *url);
2d2eda71267231c2526be701fe655db125852c1ffieldingPROXY_DECLARE(const char *) ap_proxy_cookie_reverse_map(request_rec *r, proxy_dir_conf *conf, const char *str);
2d2eda71267231c2526be701fe655db125852c1ffielding#if !defined(WIN32)
344f3bc38dfccf6261d5bb8d689794cde113b3d6coartypedef const char *(*ap_proxy_header_reverse_map_fn)(request_rec *,
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar proxy_dir_conf *, const char *);
5a9667916c79d8c699b069068e5570aa1c331c80gsteintypedef const char *(__stdcall *ap_proxy_header_reverse_map_fn)(request_rec *,
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar proxy_dir_conf *, const char *);
5a9667916c79d8c699b069068e5570aa1c331c80gstein (__stdcall *ap_proxy_header_reverse_map_fn)(request_rec *,
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar proxy_dir_conf *, const char *);
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding (__stdcall *ap_proxy_header_reverse_map_fn)(request_rec *,
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding proxy_dir_conf *, const char *);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/* Connection pool API */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Get the worker from proxy configuration
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param p memory pool used for finding worker
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param balancer the balancer that the worker belongs to
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param conf current proxy server configuration
42ce672c516baf6e4eaed18ccc1647de2d456d8edougm * @param url url to find the worker from
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein * @return proxy_worker or NULL if not found
61fd0cab072a05b855cbef9c585702401ac5ae29rbbPROXY_DECLARE(proxy_worker *) ap_proxy_get_worker(apr_pool_t *p,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *url);
42ce672c516baf6e4eaed18ccc1647de2d456d8edougm * Define and Allocate space for the worker to proxy configuration
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein * @param p memory pool to allocate worker from
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param worker the new worker
7b6ba9c468f26bdb3492d5e8cb79628a3b04e8c8wrowe * @param balancer the balancer that the worker belongs to
7b6ba9c468f26bdb3492d5e8cb79628a3b04e8c8wrowe * @param conf current proxy server configuration
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param url url containing worker name
7b6ba9c468f26bdb3492d5e8cb79628a3b04e8c8wrowe * @param do_malloc true if shared struct should be malloced
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return error message or NULL if successful (*worker is new worker)
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgsteinPROXY_DECLARE(char *) ap_proxy_define_worker(apr_pool_t *p,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *url,
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * Share a defined proxy worker via shm
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param worker worker to be shared
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein * @param shm location of shared info
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param i index into shm
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @return APR_SUCCESS or error code
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianhPROXY_DECLARE(apr_status_t) ap_proxy_share_worker(proxy_worker *worker,
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * Initialize the worker by setting up worker connection pool and mutex
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param worker worker to initialize
0de8f88b22d24dd57ed10b96fb594e69b6aa0072jwoolley * @param s current server record
0de8f88b22d24dd57ed10b96fb594e69b6aa0072jwoolley * @param p memory pool used for mutex and connection pool
8b7047e519340545e6807c9749576a40a76b6d3frbb * @return APR_SUCCESS or error code
8b7047e519340545e6807c9749576a40a76b6d3frbbPROXY_DECLARE(apr_status_t) ap_proxy_initialize_worker(proxy_worker *worker,
9484ae61c7cc5fa8d8d9a836efdbdb1e88d3036dwrowe * Verifies valid balancer name (eg: balancer://foo)
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param name name to test
2e75499d05677dd589f7ce6b5139ae15ba049419jerenkrantz * @param i number of chars to test; 0 for all.
2e75499d05677dd589f7ce6b5139ae15ba049419jerenkrantzPROXY_DECLARE(int) ap_proxy_valid_balancer_name(char *name, int i);
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * Get the balancer from proxy configuration
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param p memory pool used for temporary storage while finding balancer
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param conf current proxy server configuration
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param url url to find the worker from; must have balancer:// prefix
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @return proxy_balancer or NULL if not found
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbbPROXY_DECLARE(proxy_balancer *) ap_proxy_get_balancer(apr_pool_t *p,
561e5f16a2f9fb397aac4c283aaa87a752520a4ddougm const char *url);
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * Define and Allocate space for the balancer to proxy configuration
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param p memory pool to allocate balancer from
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param balancer the new balancer
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param conf current proxy server configuration
2fc50921b88defeb7127985dfe4b4130175e069ejwoolley * @param url url containing balancer name
2fc50921b88defeb7127985dfe4b4130175e069ejwoolley * @param do_malloc true if shared struct should be malloced
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @return error message or NULL if successfull
2fc50921b88defeb7127985dfe4b4130175e069ejwoolleyPROXY_DECLARE(char *) ap_proxy_define_balancer(apr_pool_t *p,
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb const char *url,
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * Share a defined proxy balancer via shm
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * @param balancer balancer to be shared
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * @param shm location of shared info
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param i index into shm
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @return APR_SUCCESS or error code
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianhPROXY_DECLARE(apr_status_t) ap_proxy_share_balancer(proxy_balancer *balancer,
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * Initialize the balancer as needed
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param balancer balancer to initialize
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param s current server record
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param p memory pool used for mutex and connection pool
3311183b8638d2ba2ff8496cad5e01c27d329a05nd * @return APR_SUCCESS or error code
f5abdb59b6579717b5de18de9de340f4b67d6f26niqPROXY_DECLARE(apr_status_t) ap_proxy_initialize_balancer(proxy_balancer *balancer,
3347ef7496eff25aaca86b2852a14bab667d0e34niq * Get the most suitable worker and/or balancer for the request
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * @param worker worker used for processing request
2d2eda71267231c2526be701fe655db125852c1ffielding * @param balancer balancer used for processing request
2d2eda71267231c2526be701fe655db125852c1ffielding * @param r current request
2d2eda71267231c2526be701fe655db125852c1ffielding * @param conf current proxy server configuration
2d2eda71267231c2526be701fe655db125852c1ffielding * @param url request url that balancer can rewrite.
2d2eda71267231c2526be701fe655db125852c1ffielding * @return OK or HTTP_XXX error
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @note It calls balancer pre_request hook if the url starts with balancer://
* The balancer then rewrites the url to particular worker, like http://host:port
request_rec *r,
char **url);
request_rec *r,
char **url,
const char *proxyname,
char *server_portstr,
int server_portstr_size);
server_rec *s);
server_rec *s);
server_rec *s);
server_rec *s);
server_rec *s,
int ap_proxy_lb_workers(void);