granicus.if.org Git - apache/blob - modules/proxy/mod_proxy.h

   1 /* Copyright 1999-2004 The Apache Software Foundation
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef MOD_PROXY_H
  17 #define MOD_PROXY_H
  18
  19 /*
  20  * Main include file for the Apache proxy
  21  */
  22
  23 /*
  24
  25    Also note numerous FIXMEs and CHECKMEs which should be eliminated.
  26
  27    This code is once again experimental!
  28
  29    Things to do:
  30
  31    1. Make it completely work (for FTP too)
  32
  33    2. HTTP/1.1
  34
  35    Chuck Murcko <chuck@topsail.org> 02-06-01
  36
  37  */
  38
  39 #define CORE_PRIVATE
  40
  41 #include "apr_hooks.h"
  42 #include "apr.h"
  43 #include "apr_lib.h"
  44 #include "apr_strings.h"
  45 #include "apr_buckets.h"
  46 #include "apr_md5.h"
  47 #include "apr_network_io.h"
  48 #include "apr_pools.h"
  49 #include "apr_strings.h"
  50 #include "apr_uri.h"
  51 #include "apr_date.h"
  52 #include "apr_strmatch.h"
  53 #include "apr_fnmatch.h"
  54 #include "apr_reslist.h"
  55 #define APR_WANT_STRFUNC
  56 #include "apr_want.h"
  57
  58 #include "httpd.h"
  59 #include "http_config.h"
  60 #include "ap_config.h"
  61 #include "http_core.h"
  62 #include "http_protocol.h"
  63 #include "http_request.h"
  64 #include "http_vhost.h"
  65 #include "http_main.h"
  66 #include "http_log.h"
  67 #include "http_connection.h"
  68 #include "util_filter.h"
  69 #include "util_ebcdic.h"
  70
  71 #if APR_HAVE_NETINET_IN_H
  72 #include <netinet/in.h>
  73 #endif
  74 #if APR_HAVE_ARPA_INET_H
  75 #include <arpa/inet.h>
  76 #endif
  77
  78 /* for proxy_canonenc() */
  79 enum enctype {
  80     enc_path, enc_search, enc_user, enc_fpath, enc_parm
  81 };
  82
  83 #if APR_CHARSET_EBCDIC
  84 #define CRLF   "\r\n"
  85 #else /*APR_CHARSET_EBCDIC*/
  86 #define CRLF   "\015\012"
  87 #endif /*APR_CHARSET_EBCDIC*/
  88
  89 /* default Max-Forwards header setting */
  90 #define DEFAULT_MAX_FORWARDS    10
  91
  92 /* static information about a remote proxy */
  93 struct proxy_remote {
  94     const char *scheme;     /* the schemes handled by this proxy, or '*' */
  95     const char *protocol;   /* the scheme used to talk to this proxy */
  96     const char *hostname;   /* the hostname of this proxy */
  97     apr_port_t  port;       /* the port for this proxy */
  98     regex_t *regexp;        /* compiled regex (if any) for the remote */
  99     int use_regex;          /* simple boolean. True if we have a regex pattern */
 100 };
 101
 102 struct proxy_alias {
 103     const char  *real;
 104     const char  *fake;
 105 };
 106
 107 struct dirconn_entry {
 108     char *name;
 109     struct in_addr addr, mask;
 110     struct apr_sockaddr_t *hostaddr;
 111     int (*matcher) (struct dirconn_entry * This, request_rec *r);
 112 };
 113
 114 struct noproxy_entry {
 115     const char *name;
 116     struct apr_sockaddr_t *addr;
 117 };
 118
 119 typedef struct proxy_balancer  proxy_balancer;
 120 typedef struct proxy_worker    proxy_worker;
 121 typedef struct proxy_conn_pool proxy_conn_pool;
 122
 123 typedef struct {
 124     apr_array_header_t *proxies;
 125     apr_array_header_t *sec_proxy;
 126     apr_array_header_t *aliases;
 127     apr_array_header_t *raliases;
 128     apr_array_header_t *noproxies;
 129     apr_array_header_t *dirconn;
 130     apr_array_header_t *allowed_connect_ports;
 131     apr_array_header_t *workers;
 132     apr_array_header_t *balancers;
 133     proxy_worker       *forward;    /* forward proxy worker */
 134     proxy_worker       *reverse;    /* reverse "module-driven" proxy worker */
 135     const char *domain;     /* domain name to use in absence of a domain name in the request */
 136     int req;                /* true if proxy requests are enabled */
 137     char req_set;
 138     enum {
 139       via_off,
 140       via_on,
 141       via_block,
 142       via_full
 143     } viaopt;                   /* how to deal with proxy Via: headers */
 144     char viaopt_set;
 145     apr_size_t recv_buffer_size;
 146     char recv_buffer_size_set;
 147     apr_size_t io_buffer_size;
 148     char io_buffer_size_set;
 149     long maxfwd;
 150     char maxfwd_set;
 151     /**
 152      * the following setting masks the error page
 153      * returned from the 'proxied server' and just
 154      * forwards the status code upwards.
 155      * This allows the main server (us) to generate
 156      * the error page, (so it will look like a error
 157      * returned from the rest of the system
 158      */
 159     int error_override;
 160     int error_override_set;
 161     int preserve_host;
 162     int preserve_host_set;
 163     apr_interval_time_t timeout;
 164     char timeout_set;
 165     enum {
 166       bad_error,
 167       bad_ignore,
 168       bad_body
 169     } badopt;                   /* how to deal with bad headers */
 170     char badopt_set;
 171 /* putting new stuff on the end maximises binary back-compatibility.
 172  * the strmatch_patterns are really a const just to have a
 173  * case-independent strstr.
 174  */
 175     apr_array_header_t* cookie_paths;
 176     apr_array_header_t* cookie_domains;
 177     const apr_strmatch_pattern* cookie_path_str;
 178     const apr_strmatch_pattern* cookie_domain_str;
 179     enum {
 180         status_off,
 181         status_on,
 182         status_full
 183     } proxy_status;             /* Status display options */
 184     char proxy_status_set;
 185     apr_pool_t *pool;           /* Pool used for allocating this struct */
 186 } proxy_server_conf;
 187
 188
 189 typedef struct {
 190     const char *p;            /* The path */
 191     int         p_is_fnmatch; /* Is this path an fnmatch candidate? */
 192     regex_t    *r;            /* Is this a regex? */
 193 } proxy_dir_conf;
 194
 195 typedef struct {
 196     conn_rec     *connection;
 197     const char   *hostname;
 198     apr_port_t   port;
 199     int          is_ssl;
 200     apr_pool_t   *pool;     /* Subpool used for creating socket */
 201     apr_socket_t *sock;     /* Connection socket */
 202     apr_sockaddr_t *addr;   /* Preparsed remote address info */
 203     apr_uint32_t flags;     /* Conection flags */
 204     int          close;     /* Close 'this' connection */
 205     int          close_on_recycle; /* Close the connection when returning to pool */
 206     proxy_worker *worker;   /* Connection pool this connection belogns to */
 207     void         *data;     /* per scheme connection data */
 208 } proxy_conn_rec;
 209
 210 typedef struct {
 211         float cache_completion; /* completion percentage */
 212         int content_length; /* length of the content */
 213 } proxy_completion;
 214
 215 /* Connection pool */
 216 struct proxy_conn_pool {
 217     apr_pool_t     *pool;   /* The pool used in constructor and destructor calls */
 218     apr_sockaddr_t *addr;   /* Preparsed remote address info */
 219 #if APR_HAS_THREADS
 220     apr_reslist_t  *res;    /* Connection resource list */
 221 #endif
 222     proxy_conn_rec *conn;   /* Single connection for prefork mpm's */
 223 };
 224
 225 /* woker status flags */
 226 #define PROXY_WORKER_INITIALIZED    0x0001
 227 #define PROXY_WORKER_IGNORE_ERRORS  0x0002
 228 #define PROXY_WORKER_IN_SHUTDOWN    0x0010
 229 #define PROXY_WORKER_DISABLED       0x0020
 230 #define PROXY_WORKER_IN_ERROR       0x0040
 231
 232 #define PROXY_WORKER_IS_USABLE(f)   (!((f)->s->status & 0x00F0))
 233
 234 /* default worker retry timeout in seconds */
 235 #define PROXY_WORKER_DEFAULT_RETRY  60
 236 #define PROXY_WORKER_MAX_ROUTE_SIZ  63
 237
 238 /* Runtime worker status informations. Shared in scoreboard */
 239 typedef struct {
 240     int             status;
 241     apr_time_t      error_time; /* time of the last error */
 242     int             retries;    /* number of retries on this worker */
 243     int             lbstatus;   /* Current lbstatus */
 244     int             lbfactor;   /* dynamic lbfactor */
 245     apr_off_t       transfered; /* Number of bytes transfered to remote */
 246     apr_off_t       readed;     /* Number of bytes readed from remote */
 247     apr_size_t      elected;    /* Number of times the worker was elected */
 248     char            route[PROXY_WORKER_MAX_ROUTE_SIZ+1];
 249     char            redirect[PROXY_WORKER_MAX_ROUTE_SIZ+1];
 250 } proxy_worker_stat;
 251
 252 /* Worker configuration */
 253 struct proxy_worker {
 254     int             id;         /* scoreboard id */
 255     apr_interval_time_t retry;  /* retry interval */
 256     int             lbfactor;   /* initial load balancing factor */
 257     const char      *name;
 258     const char      *scheme;    /* scheme to use ajp|http|https */
 259     const char      *hostname;  /* remote backend address */
 260     const char      *route;     /* balancing route */
 261     const char      *redirect;  /* temporary balancing redirection route */
 262     apr_port_t      port;
 263     int             min;        /* Desired minimum number of available connections */
 264     int             smax;       /* Soft maximum on the total number of connections */
 265     int             hmax;       /* Hard maximum on the total number of connections */
 266     apr_interval_time_t ttl;    /* maximum amount of time in seconds a connection
 267                                  * may be available while exceeding the soft limit */
 268     apr_interval_time_t timeout; /* connection timeout */
 269     char                timeout_set;
 270     apr_interval_time_t acquire; /* acquire timeout when the maximum number of connections is exceeded */
 271     char                acquire_set;
 272     apr_size_t          recv_buffer_size;
 273     char                recv_buffer_size_set;
 274     apr_size_t          io_buffer_size;
 275     char                io_buffer_size_set;
 276     char                keepalive;
 277     char                keepalive_set;
 278     proxy_conn_pool     *cp;        /* Connection pool to use */
 279     proxy_worker_stat   *s;         /* Shared data */
 280     void                *opaque;    /* per scheme worker data */
 281     int                 is_address_reusable;
 282 #if APR_HAS_THREADS
 283     apr_thread_mutex_t  *mutex;  /* Thread lock for updating address cache */
 284 #endif
 285 };
 286
 287 struct proxy_balancer {
 288     apr_array_header_t *workers; /* array of proxy_workers */
 289     const char *name;            /* name of the load balancer */
 290     const char *sticky;          /* sticky session identifier */
 291     int         sticky_force;    /* Disable failover for sticky sessions */
 292     apr_interval_time_t timeout; /* Timeout for waiting on free connection */
 293     int                 max_attempts; /* Number of attempts before failing */
 294     char                max_attempts_set;
 295
 296     /* XXX: Perhaps we will need the proc mutex too.
 297      * Altrough we are only using arithmetic operations
 298      * it may lead to a incorrect calculations.
 299      * For now use only the thread mutex.
 300      */
 301 #if APR_HAS_THREADS
 302     apr_thread_mutex_t  *mutex;  /* Thread lock for updating lb params */
 303 #endif
 304 };
 305
 306 #if APR_HAS_THREADS
 307 #define PROXY_THREAD_LOCK(x)      apr_thread_mutex_lock((x)->mutex)
 308 #define PROXY_THREAD_UNLOCK(x)    apr_thread_mutex_unlock((x)->mutex)
 309 #else
 310 #define PROXY_THREAD_LOCK(x)      APR_SUCCESS
 311 #define PROXY_THREAD_UNLOCK(x)    APR_SUCCESS
 312 #endif
 313
 314 /* hooks */
 315
 316 /* Create a set of PROXY_DECLARE(type), PROXY_DECLARE_NONSTD(type) and
 317  * PROXY_DECLARE_DATA with appropriate export and import tags for the platform
 318  */
 319 #if !defined(WIN32)
 320 #define PROXY_DECLARE(type)            type
 321 #define PROXY_DECLARE_NONSTD(type)     type
 322 #define PROXY_DECLARE_DATA
 323 #elif defined(PROXY_DECLARE_STATIC)
 324 #define PROXY_DECLARE(type)            type __stdcall
 325 #define PROXY_DECLARE_NONSTD(type)     type
 326 #define PROXY_DECLARE_DATA
 327 #elif defined(PROXY_DECLARE_EXPORT)
 328 #define PROXY_DECLARE(type)            __declspec(dllexport) type __stdcall
 329 #define PROXY_DECLARE_NONSTD(type)     __declspec(dllexport) type
 330 #define PROXY_DECLARE_DATA             __declspec(dllexport)
 331 #else
 332 #define PROXY_DECLARE(type)            __declspec(dllimport) type __stdcall
 333 #define PROXY_DECLARE_NONSTD(type)     __declspec(dllimport) type
 334 #define PROXY_DECLARE_DATA             __declspec(dllimport)
 335 #endif
 336
 337 /**
 338  * Hook an optional proxy hook.  Unlike static hooks, this uses a macro
 339  * instead of a function.
 340  */
 341 #define PROXY_OPTIONAL_HOOK(name,fn,pre,succ,order) \
 342         APR_OPTIONAL_HOOK(proxy,name,fn,pre,succ,order)
 343
 344 APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, scheme_handler, (request_rec *r,
 345                           proxy_worker *worker, proxy_server_conf *conf, char *url,
 346                           const char *proxyhost, apr_port_t proxyport))
 347 APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, canon_handler, (request_rec *r,
 348                           char *url))
 349
 350 APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, create_req, (request_rec *r, request_rec *pr))
 351 APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, fixups, (request_rec *r))
 352
 353 /**
 354  * pre request hook.
 355  * It will return the most suitable worker at the moment
 356  * and coresponding balancer.
 357  * The url is rewritten from balancer://cluster/uri to scheme://host:port/uri
 358  * and then the scheme_handler is called.
 359  *
 360  */
 361 APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, pre_request, (proxy_worker **worker,
 362                           proxy_balancer **balancer,
 363                           request_rec *r,
 364                           proxy_server_conf *conf, char **url))
 365 /**
 366  * post request hook.
 367  * It is called after request for updating runtime balancer status.
 368  */
 369 APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, post_request, (proxy_worker *worker,
 370                           proxy_balancer *balancer, request_rec *r,
 371                           proxy_server_conf *conf))
 372
 373
 374 /* proxy_util.c */
 375
 376 PROXY_DECLARE(request_rec *)ap_proxy_make_fake_req(conn_rec *c, request_rec *r);
 377 PROXY_DECLARE(int) ap_proxy_hex2c(const char *x);
 378 PROXY_DECLARE(void) ap_proxy_c2hex(int ch, char *x);
 379 PROXY_DECLARE(char *)ap_proxy_canonenc(apr_pool_t *p, const char *x, int len, enum enctype t,
 380                                        int isenc);
 381 PROXY_DECLARE(char *)ap_proxy_canon_netloc(apr_pool_t *p, char **const urlp, char **userp,
 382                                            char **passwordp, char **hostp, apr_port_t *port);
 383 PROXY_DECLARE(const char *)ap_proxy_date_canon(apr_pool_t *p, const char *x);
 384 PROXY_DECLARE(int) ap_proxy_liststr(const char *list, const char *val);
 385 PROXY_DECLARE(char *)ap_proxy_removestr(apr_pool_t *pool, const char *list, const char *val);
 386 PROXY_DECLARE(int) ap_proxy_hex2sec(const char *x);
 387 PROXY_DECLARE(void) ap_proxy_sec2hex(int t, char *y);
 388 PROXY_DECLARE(int) ap_proxyerror(request_rec *r, int statuscode, const char *message);
 389 PROXY_DECLARE(int) ap_proxy_is_ipaddr(struct dirconn_entry *This, apr_pool_t *p);
 390 PROXY_DECLARE(int) ap_proxy_is_domainname(struct dirconn_entry *This, apr_pool_t *p);
 391 PROXY_DECLARE(int) ap_proxy_is_hostname(struct dirconn_entry *This, apr_pool_t *p);
 392 PROXY_DECLARE(int) ap_proxy_is_word(struct dirconn_entry *This, apr_pool_t *p);
 393 PROXY_DECLARE(int) ap_proxy_checkproxyblock(request_rec *r, proxy_server_conf *conf, apr_sockaddr_t *uri_addr);
 394 PROXY_DECLARE(int) ap_proxy_pre_http_request(conn_rec *c, request_rec *r);
 395 PROXY_DECLARE(apr_status_t) ap_proxy_string_read(conn_rec *c, apr_bucket_brigade *bb, char *buff, size_t bufflen, int *eos);
 396 PROXY_DECLARE(void) ap_proxy_table_unmerge(apr_pool_t *p, apr_table_t *t, char *key);
 397 /* DEPRECATED (will be replaced with ap_proxy_connect_backend */
 398 PROXY_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 *);
 399 PROXY_DECLARE(int) ap_proxy_ssl_enable(conn_rec *c);
 400 PROXY_DECLARE(int) ap_proxy_ssl_disable(conn_rec *c);
 401
 402 /* Connection pool API */
 403 /**
 404  * Get the worker from proxy configuration
 405  * @param p     memory pool used for finding worker
 406  * @param conf  current proxy server configuration
 407  * @param url   url to find the worker from
 408  * @return      proxy_worker or NULL if not found
 409  */
 410 PROXY_DECLARE(proxy_worker *) ap_proxy_get_worker(apr_pool_t *p,
 411                                                   proxy_server_conf *conf,
 412                                                   const char *url);
 413 /**
 414  * Add the worker to proxy configuration
 415  * @param worker the new worker
 416  * @param p      memory pool to allocate worker from
 417  * @param conf   current proxy server configuration
 418  * @param url    url containing worker name
 419  * @return       error message or NULL if successfull
 420  */
 421 PROXY_DECLARE(const char *) ap_proxy_add_worker(proxy_worker **worker,
 422                                                 apr_pool_t *p,
 423                                                 proxy_server_conf *conf,
 424                                                 const char *url);
 425
 426 /**
 427  * Create new worker
 428  * @param p      memory pool to allocate worker from
 429  * @return       new worker
 430  */
 431 PROXY_DECLARE(proxy_worker *) ap_proxy_create_worker(apr_pool_t *p);
 432
 433 /**
 434  * Initize the worker's shared data
 435  * @param conf   current proxy server configuration
 436  * @param worker worker to initialize
 437  * @param s      current server record
 438  * @param worker worker to initialize
 439  */
 440 PROXY_DECLARE(void) ap_proxy_initialize_worker_share(proxy_server_conf *conf,
 441                                                      proxy_worker *worker,
 442                                                      server_rec *s);
 443
 444
 445 /**
 446  * Initize the worker
 447  * @param worker worker to initialize
 448  * @param s      current server record
 449  * @return       APR_SUCCESS or error code
 450  */
 451 PROXY_DECLARE(apr_status_t) ap_proxy_initialize_worker(proxy_worker *worker,
 452                                                        server_rec *s);
 453 /**
 454  * Get the balancer from proxy configuration
 455  * @param p     memory pool used for finding balancer
 456  * @param conf  current proxy server configuration
 457  * @param url   url to find the worker from. Has to have balancer:// prefix
 458  * @return      proxy_balancer or NULL if not found
 459  */
 460 PROXY_DECLARE(proxy_balancer *) ap_proxy_get_balancer(apr_pool_t *p,
 461                                                       proxy_server_conf *conf,
 462                                                       const char *url);
 463 /**
 464  * Add the balancer to proxy configuration
 465  * @param balancer the new balancer
 466  * @param p      memory pool to allocate balancer from
 467  * @param conf   current proxy server configuration
 468  * @param url    url containing balancer name
 469  * @return       error message or NULL if successfull
 470  */
 471 PROXY_DECLARE(const char *) ap_proxy_add_balancer(proxy_balancer **balancer,
 472                                                   apr_pool_t *p,
 473                                                   proxy_server_conf *conf,
 474                                                   const char *url);
 475
 476 /**
 477  * Add the worker to the balancer
 478  * @param pool     memory pool for adding worker
 479  * @param balancer balancer to add to
 480  * @param balancer worker to add
 481  * @note Single worker can be added to multiple balancers.
 482  */
 483 PROXY_DECLARE(void) ap_proxy_add_worker_to_balancer(apr_pool_t *pool,
 484                                                     proxy_balancer *balancer,
 485                                                     proxy_worker *worker);
 486 /**
 487  * Get the most suitable worker and(or) balancer for the request
 488  * @param worker   worker used for processing request
 489  * @param balancer balancer used for processing request
 490  * @param r        current request
 491  * @param conf     current proxy server configuration
 492  * @param url      request url that balancer can rewrite.
 493  * @return         OK or  HTTP_XXX error
 494  * @note It calls balancer pre_request hook if the url starts with balancer://
 495  * The balancer then rewrites the url to particular worker, like http://host:port
 496  */
 497 PROXY_DECLARE(int) ap_proxy_pre_request(proxy_worker **worker,
 498                                         proxy_balancer **balancer,
 499                                         request_rec *r,
 500                                         proxy_server_conf *conf,
 501                                         char **url);
 502 /**
 503  * Post request worker and balancer cleanup
 504  * @param worker   worker used for processing request
 505  * @param balancer balancer used for processing request
 506  * @param r        current request
 507  * @param conf     current proxy server configuration
 508  * @return         OK or  HTTP_XXX error
 509  * @note When ever the pre_request is called, the post_request has to be
 510  * called too.
 511  */
 512 PROXY_DECLARE(int) ap_proxy_post_request(proxy_worker *worker,
 513                                          proxy_balancer *balancer,
 514                                          request_rec *r,
 515                                          proxy_server_conf *conf);
 516 /**
 517  * Deternime backend hostname and port
 518  * @param p       memory pool used for processing
 519  * @param r       current request
 520  * @param conf    current proxy server configuration
 521  * @param worker  worker used for processing request
 522  * @param conn    proxy connection struct
 523  * @param uri     processed uri
 524  * @param url     request url
 525  * @param proxyname are we connecting directly or via s proxy
 526  * @param proxyport proxy host port
 527  * @param server_portstr Via headers server port
 528  * @param server_portstr_size size of the server_portstr buffer
 529  * @return         OK or HTTP_XXX error
 530  */
 531 PROXY_DECLARE(int) ap_proxy_determine_connection(apr_pool_t *p, request_rec *r,
 532                                                  proxy_server_conf *conf,
 533                                                  proxy_worker *worker,
 534                                                  proxy_conn_rec *conn,
 535                                                  apr_uri_t *uri,
 536                                                  char **url,
 537                                                  const char *proxyname,
 538                                                  apr_port_t proxyport,
 539                                                  char *server_portstr,
 540                                                  int server_portstr_size);
 541 /**
 542  * Mark a worker for retry
 543  * @param proxy_function calling proxy scheme (http, ajp, ...)
 544  * @param conf    current proxy server configuration
 545  * @param worker  worker used for retrying
 546  * @param s       current server record
 547  * @return        OK if marked for retry, DECLINED otherwise
 548  * @note Worker will be marker for retry if the time of the last retry
 549  * has been ellapsed. In case there is no retry option set, defaults to
 550  * number_of_retries seconds.
 551  */
 552 PROXY_DECLARE(int) ap_proxy_retry_worker(const char *proxy_function,
 553                                          proxy_worker *worker,
 554                                          server_rec *s);
 555 /**
 556  * Acquire a connection from workers connection pool
 557  * @param proxy_function calling proxy scheme (http, ajp, ...)
 558  * @param conn    acquired connection
 559  * @param worker  worker used for obtaining connection
 560  * @param s       current server record
 561  * @return        OK or HTTP_XXX error
 562  * @note If the number of connections is exhaused the function will
 563  * block untill the timeout is reached.
 564  */
 565 PROXY_DECLARE(int) ap_proxy_acquire_connection(const char *proxy_function,
 566                                                proxy_conn_rec **conn,
 567                                                proxy_worker *worker,
 568                                                server_rec *s);
 569 /**
 570  * Release a connection back to worker connection pool
 571  * @param proxy_function calling proxy scheme (http, ajp, ...)
 572  * @param conn    acquired connection
 573  * @param s       current server record
 574  * @return        OK or HTTP_XXX error
 575  * @note The connection will be closed if conn->close_on_release is set
 576  */
 577 PROXY_DECLARE(int) ap_proxy_release_connection(const char *proxy_function,
 578                                                proxy_conn_rec *conn,
 579                                                server_rec *s);
 580 /**
 581  * Make a connection to the backend
 582  * @param proxy_function calling proxy scheme (http, ajp, ...)
 583  * @param conn    acquired connection
 584  * @param worker  connection worker
 585  * @param s       current server record
 586  * @return        OK or HTTP_XXX error
 587  * @note In case the socket already exists for conn, just check the link
 588  * status.
 589  */
 590 PROXY_DECLARE(int) ap_proxy_connect_backend(const char *proxy_function,
 591                                             proxy_conn_rec *conn,
 592                                             proxy_worker *worker,
 593                                             server_rec *s);
 594 /**
 595  * Make a connection record for backend connection
 596  * @param proxy_function calling proxy scheme (http, ajp, ...)
 597  * @param conn    acquired connection
 598  * @param c       client connection record
 599  * @param s       current server record
 600  * @return        OK or HTTP_XXX error
 601  */
 602 PROXY_DECLARE(int) ap_proxy_connection_create(const char *proxy_function,
 603                                               proxy_conn_rec *conn,
 604                                               conn_rec *c, server_rec *s);
 605
 606 /* Scoreboard */
 607 #if MODULE_MAGIC_NUMBER_MAJOR > 20020903
 608 #define PROXY_HAS_SCOREBOARD 1
 609 #else
 610 #define PROXY_HAS_SCOREBOARD 0
 611 #endif
 612
 613 /* The number of dynamic workers that can be added when reconfiguring.
 614  * If this limit is reached you must stop and restart the server.
 615  */
 616 #define PROXY_DYNAMIC_BALANCER_LIMIT    16
 617 /**
 618  * Calculate number of maximum number of workers in scoreboard.
 619  * @return  number of workers to allocate in the scoreboard
 620  */
 621 int ap_proxy_lb_workers(void);
 622
 623 /* For proxy_util */
 624 extern module PROXY_DECLARE_DATA proxy_module;
 625
 626 extern int PROXY_DECLARE_DATA proxy_lb_workers;
 627
 628 #endif /*MOD_PROXY_H*/