mod_proxy.h revision 908eb2ea826140b279ed8b7fcbbd83555adaf7b3
842ae4bd224140319ae7feec1872b93dfd491143fielding/* Copyright 1999-2004 The Apache Software Foundation
842ae4bd224140319ae7feec1872b93dfd491143fielding *
842ae4bd224140319ae7feec1872b93dfd491143fielding * Licensed under the Apache License, Version 2.0 (the "License");
842ae4bd224140319ae7feec1872b93dfd491143fielding * you may not use this file except in compliance with the License.
842ae4bd224140319ae7feec1872b93dfd491143fielding * You may obtain a copy of the License at
842ae4bd224140319ae7feec1872b93dfd491143fielding *
2d2eda71267231c2526be701fe655db125852c1ffielding * http://www.apache.org/licenses/LICENSE-2.0
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd *
2d2eda71267231c2526be701fe655db125852c1ffielding * 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.
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd */
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding#ifndef MOD_PROXY_H
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh#define MOD_PROXY_H
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh/*
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * Main include file for the Apache proxy
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh */
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh/*
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh Also note numerous FIXMEs and CHECKMEs which should be eliminated.
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding This code is once again experimental!
2d2eda71267231c2526be701fe655db125852c1ffielding
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb Things to do:
ab5581cc78e9d865b0a6ab1404c53347b3276968rbb
92f3af936ce61f25358a3ee4f28df2f6d62040dfdreid 1. Make it completely work (for FTP too)
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb
c9a95767fbf0f5fb0976a06b97a256033925e433rbb 2. HTTP/1.1
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding
2d2eda71267231c2526be701fe655db125852c1ffielding Chuck Murcko <chuck@topsail.org> 02-06-01
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding */
2d2eda71267231c2526be701fe655db125852c1ffielding
52de7a47876ce1748910cf3a0ee97f78842fab54rederpj#define CORE_PRIVATE
52de7a47876ce1748910cf3a0ee97f78842fab54rederpj
52de7a47876ce1748910cf3a0ee97f78842fab54rederpj#include "apr_hooks.h"
52de7a47876ce1748910cf3a0ee97f78842fab54rederpj#include "apr.h"
52de7a47876ce1748910cf3a0ee97f78842fab54rederpj#include "apr_lib.h"
52de7a47876ce1748910cf3a0ee97f78842fab54rederpj#include "apr_strings.h"
52de7a47876ce1748910cf3a0ee97f78842fab54rederpj#include "apr_buckets.h"
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh#include "apr_md5.h"
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb#include "apr_network_io.h"
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb#include "apr_pools.h"
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb#include "apr_strings.h"
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb#include "apr_uri.h"
2d2eda71267231c2526be701fe655db125852c1ffielding#include "apr_date.h"
2d2eda71267231c2526be701fe655db125852c1ffielding#include "apr_strmatch.h"
2d2eda71267231c2526be701fe655db125852c1ffielding#include "apr_fnmatch.h"
2d2eda71267231c2526be701fe655db125852c1ffielding#include "apr_reslist.h"
2d2eda71267231c2526be701fe655db125852c1ffielding#define APR_WANT_STRFUNC
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#include "apr_want.h"
61fd0cab072a05b855cbef9c585702401ac5ae29rbb
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#include "httpd.h"
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#include "http_config.h"
742318b93e89c311f66b55f426c4d9cf2c14628bjim#include "ap_config.h"
2d2eda71267231c2526be701fe655db125852c1ffielding#include "http_core.h"
2d2eda71267231c2526be701fe655db125852c1ffielding#include "http_protocol.h"
8af88bd6958b80c224e964892b8237720b13ab1ajerenkrantz#include "http_request.h"
8af88bd6958b80c224e964892b8237720b13ab1ajerenkrantz#include "http_vhost.h"
8af88bd6958b80c224e964892b8237720b13ab1ajerenkrantz#include "http_main.h"
8af88bd6958b80c224e964892b8237720b13ab1ajerenkrantz#include "http_log.h"
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp#include "http_connection.h"
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp#include "util_filter.h"
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp#include "util_ebcdic.h"
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp#if APR_HAVE_NETINET_IN_H
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp#include <netinet/in.h>
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp#endif
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp#if APR_HAVE_ARPA_INET_H
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp#include <arpa/inet.h>
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp#endif
8af88bd6958b80c224e964892b8237720b13ab1ajerenkrantz
bfb62a96023822c56c9120e4ee627d4091cc59c2rbb/* for proxy_canonenc() */
bfb62a96023822c56c9120e4ee627d4091cc59c2rbbenum enctype {
61fd0cab072a05b855cbef9c585702401ac5ae29rbb enc_path, enc_search, enc_user, enc_fpath, enc_parm
61fd0cab072a05b855cbef9c585702401ac5ae29rbb};
61fd0cab072a05b855cbef9c585702401ac5ae29rbb
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#if APR_CHARSET_EBCDIC
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#define CRLF "\r\n"
3d96ee83babeec32482c9082c9426340cee8c44dwrowe#else /*APR_CHARSET_EBCDIC*/
2d2eda71267231c2526be701fe655db125852c1ffielding#define CRLF "\015\012"
61fd0cab072a05b855cbef9c585702401ac5ae29rbb#endif /*APR_CHARSET_EBCDIC*/
61fd0cab072a05b855cbef9c585702401ac5ae29rbb
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/* default Max-Forwards header setting */
742318b93e89c311f66b55f426c4d9cf2c14628bjim#define DEFAULT_MAX_FORWARDS 10
742318b93e89c311f66b55f426c4d9cf2c14628bjim
742318b93e89c311f66b55f426c4d9cf2c14628bjim/* static information about a remote proxy */
742318b93e89c311f66b55f426c4d9cf2c14628bjimstruct proxy_remote {
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *scheme; /* the schemes handled by this proxy, or '*' */
2d2eda71267231c2526be701fe655db125852c1ffielding const char *protocol; /* the scheme used to talk to this proxy */
3d96ee83babeec32482c9082c9426340cee8c44dwrowe const char *hostname; /* the hostname of this proxy */
2d2eda71267231c2526be701fe655db125852c1ffielding apr_port_t port; /* the port for this proxy */
2d2eda71267231c2526be701fe655db125852c1ffielding regex_t *regexp; /* compiled regex (if any) for the remote */
2d2eda71267231c2526be701fe655db125852c1ffielding int use_regex; /* simple boolean. True if we have a regex pattern */
2d2eda71267231c2526be701fe655db125852c1ffielding};
000b67449410515eac43e76ef6667915bfd4d2abgstein
2d2eda71267231c2526be701fe655db125852c1ffieldingstruct proxy_alias {
2d2eda71267231c2526be701fe655db125852c1ffielding const char *real;
2d2eda71267231c2526be701fe655db125852c1ffielding const char *fake;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb};
61fd0cab072a05b855cbef9c585702401ac5ae29rbb
61fd0cab072a05b855cbef9c585702401ac5ae29rbbstruct dirconn_entry {
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char *name;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb struct in_addr addr, mask;
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein struct apr_sockaddr_t *hostaddr;
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein int (*matcher) (struct dirconn_entry * This, request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb};
61fd0cab072a05b855cbef9c585702401ac5ae29rbb
61fd0cab072a05b855cbef9c585702401ac5ae29rbbstruct noproxy_entry {
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *name;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb struct apr_sockaddr_t *addr;
3d96ee83babeec32482c9082c9426340cee8c44dwrowe};
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein
61fd0cab072a05b855cbef9c585702401ac5ae29rbbtypedef struct proxy_balancer proxy_balancer;
742318b93e89c311f66b55f426c4d9cf2c14628bjimtypedef struct proxy_worker proxy_worker;
61fd0cab072a05b855cbef9c585702401ac5ae29rbbtypedef struct proxy_conn_pool proxy_conn_pool;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb
61fd0cab072a05b855cbef9c585702401ac5ae29rbbtypedef struct {
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_array_header_t *proxies;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_array_header_t *sec_proxy;
3d96ee83babeec32482c9082c9426340cee8c44dwrowe apr_array_header_t *aliases;
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein apr_array_header_t *raliases;
c9a95767fbf0f5fb0976a06b97a256033925e433rbb apr_array_header_t *noproxies;
c9a95767fbf0f5fb0976a06b97a256033925e433rbb apr_array_header_t *dirconn;
c9a95767fbf0f5fb0976a06b97a256033925e433rbb apr_array_header_t *allowed_connect_ports;
cf8d02ea0c91653917b044529f3133c5a1bb9200fielding apr_array_header_t *workers;
c9a95767fbf0f5fb0976a06b97a256033925e433rbb apr_array_header_t *balancers;
c9a95767fbf0f5fb0976a06b97a256033925e433rbb proxy_worker *forward; /* forward proxy worker */
c9a95767fbf0f5fb0976a06b97a256033925e433rbb const char *domain; /* domain name to use in absence of a domain name in the request */
c9a95767fbf0f5fb0976a06b97a256033925e433rbb int req; /* true if proxy requests are enabled */
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh char req_set;
c9a95767fbf0f5fb0976a06b97a256033925e433rbb enum {
742318b93e89c311f66b55f426c4d9cf2c14628bjim via_off,
d82d78a97558238d16c52ec5278fe921bb7d7ec3brianp via_on,
d82d78a97558238d16c52ec5278fe921bb7d7ec3brianp via_block,
d82d78a97558238d16c52ec5278fe921bb7d7ec3brianp via_full
d82d78a97558238d16c52ec5278fe921bb7d7ec3brianp } viaopt; /* how to deal with proxy Via: headers */
d82d78a97558238d16c52ec5278fe921bb7d7ec3brianp char viaopt_set;
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh apr_size_t recv_buffer_size;
d82d78a97558238d16c52ec5278fe921bb7d7ec3brianp char recv_buffer_size_set;
d82d78a97558238d16c52ec5278fe921bb7d7ec3brianp apr_size_t io_buffer_size;
c9a95767fbf0f5fb0976a06b97a256033925e433rbb char io_buffer_size_set;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb long maxfwd;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char maxfwd_set;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /**
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * the following setting masks the error page
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * returned from the 'proxied server' and just
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * forwards the status code upwards.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * This allows the main server (us) to generate
742318b93e89c311f66b55f426c4d9cf2c14628bjim * the error page, (so it will look like a error
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * returned from the rest of the system
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int error_override;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int error_override_set;
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh int preserve_host;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int preserve_host_set;
3d96ee83babeec32482c9082c9426340cee8c44dwrowe apr_interval_time_t timeout;
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein char timeout_set;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb enum {
61fd0cab072a05b855cbef9c585702401ac5ae29rbb bad_error,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb bad_ignore,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb bad_body
3d96ee83babeec32482c9082c9426340cee8c44dwrowe } badopt; /* how to deal with bad headers */
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein char badopt_set;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin/* putting new stuff on the end maximises binary back-compatibility.
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * the strmatch_patterns are really a const just to have a
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * case-independent strstr.
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin apr_array_header_t* cookie_paths;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin apr_array_header_t* cookie_domains;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin const apr_strmatch_pattern* cookie_path_str;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin const apr_strmatch_pattern* cookie_domain_str;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin enum {
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin status_off,
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin status_on,
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin status_full
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin } proxy_status; /* Status display options */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin char proxy_status_set;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin apr_pool_t *pool; /* Pool used for allocating this struct */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin} proxy_server_conf;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrintypedef struct {
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin const char *p; /* The path */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin int p_is_fnmatch; /* Is this path an fnmatch candidate? */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin regex_t *r; /* Is this a regex? */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin} proxy_dir_conf;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrintypedef struct {
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin conn_rec *connection;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin const char *hostname;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin apr_port_t port;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin int is_ssl;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin apr_pool_t *pool; /* Subpool used for creating socket */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin apr_socket_t *sock; /* Connection socket */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin apr_sockaddr_t *addr; /* Preparsed remote address info */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin apr_uint32_t flags; /* Conection flags */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin int close; /* Close 'this' connection */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin int close_on_recycle; /* Close the connection when returning to pool */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin proxy_worker *worker; /* Connection pool this connection belogns to */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin void *data; /* per scheme connection data */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin} proxy_conn_rec;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrintypedef struct {
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin float cache_completion; /* completion percentage */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin int content_length; /* length of the content */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin} proxy_completion;
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin/* Connection pool */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrinstruct proxy_conn_pool {
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin apr_pool_t *pool; /* The pool used in constructor and destructor calls */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin apr_sockaddr_t *addr; /* Preparsed remote address info */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin#if APR_HAS_THREADS
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin apr_reslist_t *res; /* Connection resource list */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin#endif
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin proxy_conn_rec *conn; /* Single connection for prefork mpm's */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin};
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin/* woker status flags */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin#define PROXY_WORKER_INITIALIZED 0x0001
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin#define PROXY_WORKER_IGNORE_ERRORS 0x0002
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin#define PROXY_WORKER_IN_SHUTDOWN 0x0010
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin#define PROXY_WORKER_DISABLED 0x0020
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin#define PROXY_WORKER_IN_ERROR 0x0040
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin#define PROXY_WORKER_IS_USABLE(f) (!((f)->s->status & 0x00F0))
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin/* default worker retry timeout in seconds */
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin#define PROXY_WORKER_DEFAULT_RETRY 60
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin#define PROXY_WORKER_MAX_ROUTE_SIZ 63
61fd0cab072a05b855cbef9c585702401ac5ae29rbb
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/* Runtime worker status informations. Shared in scoreboard */
742318b93e89c311f66b55f426c4d9cf2c14628bjimtypedef struct {
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int status;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_time_t error_time; /* time of the last error */
78ae1cbba5a848a24ca551629bbf0a90d2b931f0stas int retries; /* number of retries on this worker */
78ae1cbba5a848a24ca551629bbf0a90d2b931f0stas int lbstatus; /* Current lbstatus */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int lbfactor; /* dynamic lbfactor */
3d96ee83babeec32482c9082c9426340cee8c44dwrowe apr_off_t transfered; /* Number of bytes transfered to remote */
2d2eda71267231c2526be701fe655db125852c1ffielding apr_off_t readed; /* Number of bytes readed from remote */
2d2eda71267231c2526be701fe655db125852c1ffielding apr_size_t elected; /* Number of times the worker was elected */
2d2eda71267231c2526be701fe655db125852c1ffielding char route[PROXY_WORKER_MAX_ROUTE_SIZ+1];
2d2eda71267231c2526be701fe655db125852c1ffielding char redirect[PROXY_WORKER_MAX_ROUTE_SIZ+1];
2d2eda71267231c2526be701fe655db125852c1ffielding} proxy_worker_stat;
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding/* Worker configuration */
2d2eda71267231c2526be701fe655db125852c1ffieldingstruct proxy_worker {
2d2eda71267231c2526be701fe655db125852c1ffielding int id; /* scoreboard id */
2d2eda71267231c2526be701fe655db125852c1ffielding apr_interval_time_t retry; /* retry interval */
2d2eda71267231c2526be701fe655db125852c1ffielding int lbfactor; /* initial load balancing factor */
2d2eda71267231c2526be701fe655db125852c1ffielding const char *name;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *scheme; /* scheme to use ajp|http|https */
742318b93e89c311f66b55f426c4d9cf2c14628bjim const char *hostname; /* remote backend address */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *route; /* balancing route */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *redirect; /* temporary balancing redirection route */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_port_t port;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int min; /* Desired minimum number of available connections */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int smax; /* Soft maximum on the total number of connections */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int hmax; /* Hard maximum on the total number of connections */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_interval_time_t ttl; /* maximum amount of time in seconds a connection
742318b93e89c311f66b55f426c4d9cf2c14628bjim * may be available while exceeding the soft limit */
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm apr_interval_time_t timeout; /* connection timeout */
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein char timeout_set;
23ff73a56371e21f16744cb94d06399b877829f1rbb apr_interval_time_t acquire; /* acquire timeout when the maximum number of connections is exceeded */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char acquire_set;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_size_t recv_buffer_size;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char recv_buffer_size_set;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_size_t io_buffer_size;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char io_buffer_size_set;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char keepalive;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char keepalive_set;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb proxy_conn_pool *cp; /* Connection pool to use */
b02dfdb611f84136664b3c05e4d4d704aeabbf63wrowe proxy_worker_stat *s; /* Shared data */
b02dfdb611f84136664b3c05e4d4d704aeabbf63wrowe void *opaque; /* per scheme worker data */
b02dfdb611f84136664b3c05e4d4d704aeabbf63wrowe};
b02dfdb611f84136664b3c05e4d4d704aeabbf63wrowe
23ff73a56371e21f16744cb94d06399b877829f1rbbstruct proxy_balancer {
2d2eda71267231c2526be701fe655db125852c1ffielding apr_array_header_t *workers; /* array of proxy_workers */
62db15de4c1f335a64d45821796ae197cff94ef8rbb const char *name; /* name of the load balancer */
62db15de4c1f335a64d45821796ae197cff94ef8rbb const char *sticky; /* sticky session identifier */
62db15de4c1f335a64d45821796ae197cff94ef8rbb int sticky_force; /* Disable failover for sticky sessions */
62db15de4c1f335a64d45821796ae197cff94ef8rbb apr_interval_time_t timeout; /* Timeout for waiting on free connection */
62db15de4c1f335a64d45821796ae197cff94ef8rbb int max_attempts; /* Number of attempts before failing */
62db15de4c1f335a64d45821796ae197cff94ef8rbb char max_attempts_set;
62db15de4c1f335a64d45821796ae197cff94ef8rbb
fb532d88e92dde225e7e7796dcdec276944bd3e4sf /* XXX: Perhaps we will need the proc mutex too.
62db15de4c1f335a64d45821796ae197cff94ef8rbb * Altrough we are only using arithmetic operations
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb * it may lead to a incorrect calculations.
62db15de4c1f335a64d45821796ae197cff94ef8rbb * For now use only the thread mutex.
62db15de4c1f335a64d45821796ae197cff94ef8rbb */
62db15de4c1f335a64d45821796ae197cff94ef8rbb#if APR_HAS_THREADS
62db15de4c1f335a64d45821796ae197cff94ef8rbb apr_thread_mutex_t *mutex; /* Thread lock for updating lb params */
62db15de4c1f335a64d45821796ae197cff94ef8rbb#endif
62db15de4c1f335a64d45821796ae197cff94ef8rbb};
62db15de4c1f335a64d45821796ae197cff94ef8rbb
62db15de4c1f335a64d45821796ae197cff94ef8rbb/* hooks */
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
62db15de4c1f335a64d45821796ae197cff94ef8rbb/* Create a set of PROXY_DECLARE(type), PROXY_DECLARE_NONSTD(type) and
62db15de4c1f335a64d45821796ae197cff94ef8rbb * PROXY_DECLARE_DATA with appropriate export and import tags for the platform
62db15de4c1f335a64d45821796ae197cff94ef8rbb */
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb#if !defined(WIN32)
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb#define PROXY_DECLARE(type) type
62db15de4c1f335a64d45821796ae197cff94ef8rbb#define PROXY_DECLARE_NONSTD(type) type
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#define PROXY_DECLARE_DATA
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#elif defined(PROXY_DECLARE_STATIC)
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#define PROXY_DECLARE(type) type __stdcall
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#define PROXY_DECLARE_NONSTD(type) type
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#define PROXY_DECLARE_DATA
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#elif defined(PROXY_DECLARE_EXPORT)
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#define PROXY_DECLARE(type) __declspec(dllexport) type __stdcall
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#define PROXY_DECLARE_NONSTD(type) __declspec(dllexport) type
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar#define PROXY_DECLARE_DATA __declspec(dllexport)
3d96ee83babeec32482c9082c9426340cee8c44dwrowe#else
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh#define PROXY_DECLARE(type) __declspec(dllimport) type __stdcall
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh#define PROXY_DECLARE_NONSTD(type) __declspec(dllimport) type
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh#define PROXY_DECLARE_DATA __declspec(dllimport)
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh#endif
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh/**
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * Hook an optional proxy hook. Unlike static hooks, this uses a macro
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * instead of a function.
3d96ee83babeec32482c9082c9426340cee8c44dwrowe */
11e076839c8d5a82d55e710194d0daac51390dbdsf#define PROXY_OPTIONAL_HOOK(name,fn,pre,succ,order) \
599c5abcc7fec60611956f56b732eca033c287d2pquerna APR_OPTIONAL_HOOK(proxy,name,fn,pre,succ,order)
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coarAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, scheme_handler, (request_rec *r,
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar proxy_worker *worker, proxy_server_conf *conf, char *url,
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar const char *proxyhost, apr_port_t proxyport))
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coarAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, canon_handler, (request_rec *r,
41287245b1632a4722b55f6dfe5fcf81f361f043wrowe char *url))
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coarAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, create_req, (request_rec *r, request_rec *pr))
3d96ee83babeec32482c9082c9426340cee8c44dwroweAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, fixups, (request_rec *r))
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar/**
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * pre request hook.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * It will return the most suitable worker at the moment
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * and coresponding balancer.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * The url is rewritten from balancer://cluster/uri to scheme://host:port/uri
41287245b1632a4722b55f6dfe5fcf81f361f043wrowe * and then the scheme_handler is called.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar *
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar */
3d96ee83babeec32482c9082c9426340cee8c44dwroweAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, pre_request, (proxy_worker **worker,
742318b93e89c311f66b55f426c4d9cf2c14628bjim proxy_balancer **balancer,
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar request_rec *r,
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar proxy_server_conf *conf, char **url))
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar/**
41287245b1632a4722b55f6dfe5fcf81f361f043wrowe * post request hook.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * It is called after request for updating runtime balancer status.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar */
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coarAPR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, post_request, (proxy_worker *worker,
3d96ee83babeec32482c9082c9426340cee8c44dwrowe proxy_balancer *balancer, request_rec *r,
11e076839c8d5a82d55e710194d0daac51390dbdsf proxy_server_conf *conf))
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar/* proxy_util.c */
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar
41287245b1632a4722b55f6dfe5fcf81f361f043wrowePROXY_DECLARE(request_rec *)ap_proxy_make_fake_req(conn_rec *c, request_rec *r);
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coarPROXY_DECLARE(int) ap_proxy_hex2c(const char *x);
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coarPROXY_DECLARE(void) ap_proxy_c2hex(int ch, char *x);
3d96ee83babeec32482c9082c9426340cee8c44dwrowePROXY_DECLARE(char *)ap_proxy_canonenc(apr_pool_t *p, const char *x, int len, enum enctype t,
742318b93e89c311f66b55f426c4d9cf2c14628bjim int isenc);
2864362ca8266097928e84f101010bdf814ffa08stoddardPROXY_DECLARE(char *)ap_proxy_canon_netloc(apr_pool_t *p, char **const urlp, char **userp,
742318b93e89c311f66b55f426c4d9cf2c14628bjim char **passwordp, char **hostp, apr_port_t *port);
db08da9ddcd65c31f9ea44b823898b72a1b24fbestoddardPROXY_DECLARE(const char *)ap_proxy_date_canon(apr_pool_t *p, const char *x);
bf648cbfa4a723c9c02fe8444103cd41ed8642d0wrowePROXY_DECLARE(int) ap_proxy_liststr(const char *list, const char *val);
742318b93e89c311f66b55f426c4d9cf2c14628bjimPROXY_DECLARE(char *)ap_proxy_removestr(apr_pool_t *pool, const char *list, const char *val);
bf648cbfa4a723c9c02fe8444103cd41ed8642d0wrowePROXY_DECLARE(int) ap_proxy_hex2sec(const char *x);
2864362ca8266097928e84f101010bdf814ffa08stoddardPROXY_DECLARE(void) ap_proxy_sec2hex(int t, char *y);
db08da9ddcd65c31f9ea44b823898b72a1b24fbestoddardPROXY_DECLARE(int) ap_proxyerror(request_rec *r, int statuscode, const char *message);
2864362ca8266097928e84f101010bdf814ffa08stoddardPROXY_DECLARE(int) ap_proxy_is_ipaddr(struct dirconn_entry *This, apr_pool_t *p);
af7cd2711a9737c0a2aa1b8475455a7dd8ce6113covenerPROXY_DECLARE(int) ap_proxy_is_domainname(struct dirconn_entry *This, apr_pool_t *p);
beb207f53c871585c4858040f0a8c0e2005c3c6dcovenerPROXY_DECLARE(int) ap_proxy_is_hostname(struct dirconn_entry *This, apr_pool_t *p);
af7cd2711a9737c0a2aa1b8475455a7dd8ce6113covenerPROXY_DECLARE(int) ap_proxy_is_word(struct dirconn_entry *This, apr_pool_t *p);
af7cd2711a9737c0a2aa1b8475455a7dd8ce6113covenerPROXY_DECLARE(int) ap_proxy_checkproxyblock(request_rec *r, proxy_server_conf *conf, apr_sockaddr_t *uri_addr);
af7cd2711a9737c0a2aa1b8475455a7dd8ce6113covenerPROXY_DECLARE(int) ap_proxy_pre_http_request(conn_rec *c, request_rec *r);
af7cd2711a9737c0a2aa1b8475455a7dd8ce6113covenerPROXY_DECLARE(apr_status_t) ap_proxy_string_read(conn_rec *c, apr_bucket_brigade *bb, char *buff, size_t bufflen, int *eos);
af7cd2711a9737c0a2aa1b8475455a7dd8ce6113covenerPROXY_DECLARE(void) ap_proxy_table_unmerge(apr_pool_t *p, apr_table_t *t, char *key);
2d2eda71267231c2526be701fe655db125852c1ffielding/* DEPRECATED (will be replaced with ap_proxy_connect_backend */
2d2eda71267231c2526be701fe655db125852c1ffieldingPROXY_DECLARE(int) ap_proxy_connect_to_backend(apr_socket_t **, const char *, apr_sockaddr_t *, const char *, proxy_server_conf *, server_rec *, apr_pool_t *);
2d2eda71267231c2526be701fe655db125852c1ffieldingPROXY_DECLARE(int) ap_proxy_ssl_enable(conn_rec *c);
2d2eda71267231c2526be701fe655db125852c1ffieldingPROXY_DECLARE(int) ap_proxy_ssl_disable(conn_rec *c);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/* Connection pool API */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/**
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Get the worker from proxy configuration
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param p memory pool used for finding worker
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param conf current proxy server configuration
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * @param url url to find the worker from
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein * @return proxy_worker or NULL if not found
61fd0cab072a05b855cbef9c585702401ac5ae29rbb */
b5c963a560a55d08763229330dc661b16b726da0sfPROXY_DECLARE(proxy_worker *) ap_proxy_get_worker(apr_pool_t *p,
b5c963a560a55d08763229330dc661b16b726da0sf proxy_server_conf *conf,
b5c963a560a55d08763229330dc661b16b726da0sf const char *url);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/**
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Add the worker to proxy configuration
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param worker the new worker
b5c963a560a55d08763229330dc661b16b726da0sf * @param p memory pool to allocate worker from
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein * @param conf current proxy server configuration
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param url url containing worker name
b5c963a560a55d08763229330dc661b16b726da0sf * @return error message or NULL if successfull
b5c963a560a55d08763229330dc661b16b726da0sf */
61fd0cab072a05b855cbef9c585702401ac5ae29rbbPROXY_DECLARE(const char *) ap_proxy_add_worker(proxy_worker **worker,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_pool_t *p,
b5c963a560a55d08763229330dc661b16b726da0sf proxy_server_conf *conf,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *url);
2968569cc3b1440bdb874d2d597ea4a49f0c0acfsf
b5c963a560a55d08763229330dc661b16b726da0sf/**
9d8e6c75a763a4d60cd435bfd733ea5fb6b33bb6trawick * Create new worker
b5c963a560a55d08763229330dc661b16b726da0sf * @param p memory pool to allocate worker from
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein * @return new worker
61fd0cab072a05b855cbef9c585702401ac5ae29rbb */
61fd0cab072a05b855cbef9c585702401ac5ae29rbbPROXY_DECLARE(proxy_worker *) ap_proxy_create_worker(apr_pool_t *p);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/**
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Initize the worker's shared data
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param conf current proxy server configuration
64945a581b504264270920efbad4f6af0d5a1978sf * @param worker worker to initialize
a054609255eb3b10ed30e5471b18ea0e7d5f735esf * @param s current server record
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein * @param worker worker to initialize
61fd0cab072a05b855cbef9c585702401ac5ae29rbb */
61fd0cab072a05b855cbef9c585702401ac5ae29rbbPROXY_DECLARE(void) ap_proxy_initialize_worker_share(proxy_server_conf *conf,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb proxy_worker *worker,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb server_rec *s);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb
61fd0cab072a05b855cbef9c585702401ac5ae29rbb
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/**
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding * Initize the worker
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein * @param worker worker to initialize
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param s current server record
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return APR_SUCCESS or error code
61fd0cab072a05b855cbef9c585702401ac5ae29rbb */
61fd0cab072a05b855cbef9c585702401ac5ae29rbbPROXY_DECLARE(apr_status_t) ap_proxy_initialize_worker(proxy_worker *worker,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb server_rec *s);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/**
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Get the balancer from proxy configuration
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding * @param p memory pool used for finding balancer
11e076839c8d5a82d55e710194d0daac51390dbdsf * @param conf current proxy server configuration
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param url url to find the worker from. Has to have balancer:// prefix
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return proxy_balancer or NULL if not found
61fd0cab072a05b855cbef9c585702401ac5ae29rbb */
61fd0cab072a05b855cbef9c585702401ac5ae29rbbPROXY_DECLARE(proxy_balancer *) ap_proxy_get_balancer(apr_pool_t *p,
9ed67b66c06749d639e0390a2357f79ced5f0299humbedooh proxy_server_conf *conf,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *url);
3d96ee83babeec32482c9082c9426340cee8c44dwrowe/**
2d2eda71267231c2526be701fe655db125852c1ffielding * Add the balancer to proxy configuration
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param balancer the new balancer
2d2eda71267231c2526be701fe655db125852c1ffielding * @param p memory pool to allocate balancer from
2d2eda71267231c2526be701fe655db125852c1ffielding * @param conf current proxy server configuration
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param url url containing balancer name
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return error message or NULL if successfull
2d2eda71267231c2526be701fe655db125852c1ffielding */
3d96ee83babeec32482c9082c9426340cee8c44dwrowePROXY_DECLARE(const char *) ap_proxy_add_balancer(proxy_balancer **balancer,
2d2eda71267231c2526be701fe655db125852c1ffielding apr_pool_t *p,
742318b93e89c311f66b55f426c4d9cf2c14628bjim proxy_server_conf *conf,
d839a9822ee53ce00da24c15f2d9fe054233d342gstein const char *url);
d839a9822ee53ce00da24c15f2d9fe054233d342gstein
742318b93e89c311f66b55f426c4d9cf2c14628bjim/**
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Add the worker to the balancer
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param pool memory pool for adding worker
d839a9822ee53ce00da24c15f2d9fe054233d342gstein * @param balancer balancer to add to
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * @param balancer worker to add
d839a9822ee53ce00da24c15f2d9fe054233d342gstein * @note Single worker can be added to multiple balancers.
2d2eda71267231c2526be701fe655db125852c1ffielding */
2d2eda71267231c2526be701fe655db125852c1ffieldingPROXY_DECLARE(void) ap_proxy_add_worker_to_balancer(apr_pool_t *pool,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb proxy_balancer *balancer,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb proxy_worker *worker);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/**
742318b93e89c311f66b55f426c4d9cf2c14628bjim * Get the most suitable worker and(or) balancer for the request
346029f34d03eb20d84fc35664426d3874b00f9ewrowe * @param worker worker used for processing request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param balancer balancer used for processing request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param conf current proxy server configuration
346029f34d03eb20d84fc35664426d3874b00f9ewrowe * @param url request url that balancer can rewrite.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return OK or HTTP_XXX error
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @note It calls balancer pre_request hook if the url starts with balancer://
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * The balancer then rewrites the url to particular worker, like http://host:port
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein */
61fd0cab072a05b855cbef9c585702401ac5ae29rbbPROXY_DECLARE(int) ap_proxy_pre_request(proxy_worker **worker,
742318b93e89c311f66b55f426c4d9cf2c14628bjim proxy_balancer **balancer,
face099b681c052cb1f52176a5499661c44b2982trawick request_rec *r,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb proxy_server_conf *conf,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char **url);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/**
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Post request worker and balancer cleanup
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param worker worker used for processing request
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * @param balancer balancer used for processing request
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein * @param r current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param conf current proxy server configuration
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return OK or HTTP_XXX error
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @note When ever the pre_request is called, the post_request has to be
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * called too.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb */
61fd0cab072a05b855cbef9c585702401ac5ae29rbbPROXY_DECLARE(int) ap_proxy_post_request(proxy_worker *worker,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb proxy_balancer *balancer,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb request_rec *r,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb proxy_server_conf *conf);
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding/**
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein * Deternime backend hostname and port
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @param p memory pool used for processing
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @param r current request
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @param conf current proxy server configuration
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @param worker worker used for processing request
1ee3a77e66dfd7ffa0ade4705467da860bb7d272chrisd * @param conn proxy connection struct
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @param uri processed uri
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @param url request url
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @param proxyname are we connecting directly or via s proxy
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @param proxyport proxy host port
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @param server_portstr Via headers server port
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @param server_portstr_size size of the server_portstr buffer
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @return OK or HTTP_XXX error
a511a29faf2ff7ead3b67680154a624effb31aafminfrin */
a511a29faf2ff7ead3b67680154a624effb31aafminfrinPROXY_DECLARE(int) ap_proxy_determine_connection(apr_pool_t *p, request_rec *r,
a511a29faf2ff7ead3b67680154a624effb31aafminfrin proxy_server_conf *conf,
a511a29faf2ff7ead3b67680154a624effb31aafminfrin proxy_worker *worker,
a511a29faf2ff7ead3b67680154a624effb31aafminfrin proxy_conn_rec *conn,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_uri_t *uri,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char **url,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *proxyname,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb apr_port_t proxyport,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb char *server_portstr,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb int server_portstr_size);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/**
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Mark a worker for retry
742318b93e89c311f66b55f426c4d9cf2c14628bjim * @param proxy_function calling proxy scheme (http, ajp, ...)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param conf current proxy server configuration
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * @param worker worker used for retrying
2d2eda71267231c2526be701fe655db125852c1ffielding * @param s current server record
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return OK if marked for retry, DECLINED otherwise
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @note Worker will be marker for retry if the time of the last retry
a44d29a3794110c558c940bd903a1930d717a7d7sf * has been ellapsed. In case there is no retry option set, defaults to
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * number_of_retries seconds.
742318b93e89c311f66b55f426c4d9cf2c14628bjim */
3d96ee83babeec32482c9082c9426340cee8c44dwrowePROXY_DECLARE(int) ap_proxy_retry_worker(const char *proxy_function,
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein proxy_worker *worker,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb server_rec *s);
a44d29a3794110c558c940bd903a1930d717a7d7sf/**
742318b93e89c311f66b55f426c4d9cf2c14628bjim * Acquire a connection from workers connection pool
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * @param proxy_function calling proxy scheme (http, ajp, ...)
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein * @param conn acquired connection
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param worker worker used for obtaining connection
a44d29a3794110c558c940bd903a1930d717a7d7sf * @param s current server record
742318b93e89c311f66b55f426c4d9cf2c14628bjim * @return OK or HTTP_XXX error
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * @note If the number of connections is exhaused the function will
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein * block untill the timeout is reached.
a44d29a3794110c558c940bd903a1930d717a7d7sf */
a44d29a3794110c558c940bd903a1930d717a7d7sfPROXY_DECLARE(int) ap_proxy_acquire_connection(const char *proxy_function,
a44d29a3794110c558c940bd903a1930d717a7d7sf proxy_conn_rec **conn,
a44d29a3794110c558c940bd903a1930d717a7d7sf proxy_worker *worker,
a44d29a3794110c558c940bd903a1930d717a7d7sf server_rec *s);
a44d29a3794110c558c940bd903a1930d717a7d7sf/**
a44d29a3794110c558c940bd903a1930d717a7d7sf * Release a connection back to worker connection pool
a44d29a3794110c558c940bd903a1930d717a7d7sf * @param proxy_function calling proxy scheme (http, ajp, ...)
a44d29a3794110c558c940bd903a1930d717a7d7sf * @param conn acquired connection
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param s current server record
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return OK or HTTP_XXX error
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @note The connection will be closed if conn->close_on_release is set
61fd0cab072a05b855cbef9c585702401ac5ae29rbb */
61fd0cab072a05b855cbef9c585702401ac5ae29rbbPROXY_DECLARE(int) ap_proxy_release_connection(const char *proxy_function,
742318b93e89c311f66b55f426c4d9cf2c14628bjim proxy_conn_rec *conn,
742318b93e89c311f66b55f426c4d9cf2c14628bjim server_rec *s);
742318b93e89c311f66b55f426c4d9cf2c14628bjim/**
742318b93e89c311f66b55f426c4d9cf2c14628bjim * Make a connection to the backend
742318b93e89c311f66b55f426c4d9cf2c14628bjim * @param proxy_function calling proxy scheme (http, ajp, ...)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param conn acquired connection
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param worker connection worker
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * @param s current server record
2d2eda71267231c2526be701fe655db125852c1ffielding * @return OK or HTTP_XXX error
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @note In case the socket already exists for conn, just check the link
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * status.
742318b93e89c311f66b55f426c4d9cf2c14628bjim */
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianhPROXY_DECLARE(int) ap_proxy_connect_backend(const char *proxy_function,
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh proxy_conn_rec *conn,
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh proxy_worker *worker,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb server_rec *s);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/**
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Make a connection record for backend connection
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * @param proxy_function calling proxy scheme (http, ajp, ...)
2d2eda71267231c2526be701fe655db125852c1ffielding * @param conn acquired connection
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * @param c client connection record
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * @param s current server record
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * @return OK or HTTP_XXX error
fd8b91502bc200ed4cca3810560a2a570522b3debrianp */
fd8b91502bc200ed4cca3810560a2a570522b3debrianpPROXY_DECLARE(int) ap_proxy_connection_create(const char *proxy_function,
fd8b91502bc200ed4cca3810560a2a570522b3debrianp proxy_conn_rec *conn,
fd8b91502bc200ed4cca3810560a2a570522b3debrianp conn_rec *c, server_rec *s);
fd8b91502bc200ed4cca3810560a2a570522b3debrianp
fd8b91502bc200ed4cca3810560a2a570522b3debrianp/* Scoreboard */
fd8b91502bc200ed4cca3810560a2a570522b3debrianp#if MODULE_MAGIC_NUMBER_MAJOR > 20020903
aa4af3da5c68fe5dbd9d2c3fd7b2fe7103daa2b7dougm#define PROXY_HAS_SCOREBOARD 1
e351a4349a3dcc2e8d9c27bcdf72414bdde0942frbb#else
fd8b91502bc200ed4cca3810560a2a570522b3debrianp#define PROXY_HAS_SCOREBOARD 0
fd8b91502bc200ed4cca3810560a2a570522b3debrianp#endif
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames
742318b93e89c311f66b55f426c4d9cf2c14628bjim/* The number of dynamic workers that can be added when reconfiguring.
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames * If this limit is reached you must stop and restart the server.
742318b93e89c311f66b55f426c4d9cf2c14628bjim */
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames#define PROXY_DYNAMIC_BALANCER_LIMIT 16
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames/**
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames * Calculate number of maximum number of workers in scoreboard.
742318b93e89c311f66b55f426c4d9cf2c14628bjim * @return number of workers to allocate in the scoreboard
fd8b91502bc200ed4cca3810560a2a570522b3debrianp */
fd8b91502bc200ed4cca3810560a2a570522b3debrianpint ap_proxy_lb_workers(void);
fd8b91502bc200ed4cca3810560a2a570522b3debrianp
fd8b91502bc200ed4cca3810560a2a570522b3debrianp/* For proxy_util */
45613d36b9466a48def0498cffa07f48980720f8jerenkrantzextern module PROXY_DECLARE_DATA proxy_module;
fd8b91502bc200ed4cca3810560a2a570522b3debrianp
fd8b91502bc200ed4cca3810560a2a570522b3debrianpextern int PROXY_DECLARE_DATA proxy_lb_workers;
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp
45613d36b9466a48def0498cffa07f48980720f8jerenkrantz#endif /*MOD_PROXY_H*/
45613d36b9466a48def0498cffa07f48980720f8jerenkrantz