blob: 2b649665e9ac09a8235ad744f8019b6945eda783 [file] [log] [blame]
Willy TARREAU3dc06442006-06-15 21:48:13 +02001/*
Willy Tarreauac68c5d2009-10-04 23:12:44 +02002 * include/proto/proxy.h
3 * This file defines function prototypes for proxy management.
4 *
Willy Tarreau918ff602011-07-25 16:33:49 +02005 * Copyright (C) 2000-2011 Willy Tarreau - w@1wt.eu
Willy Tarreauac68c5d2009-10-04 23:12:44 +02006 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
Willy TARREAU3dc06442006-06-15 21:48:13 +020021
Willy Tarreaubaaee002006-06-26 02:48:02 +020022#ifndef _PROTO_PROXY_H
23#define _PROTO_PROXY_H
24
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020025#include <common/config.h>
Willy Tarreau0c303ee2008-07-07 00:09:58 +020026#include <common/ticks.h>
Willy Tarreaud825eef2007-05-12 22:35:00 +020027#include <common/time.h>
Willy Tarreau81c25d02011-09-07 15:17:21 +020028#include <types/global.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020029#include <types/proxy.h>
Willy Tarreaud1d54542012-09-12 22:58:11 +020030#include <types/listener.h>
Willy Tarreau7f062c42009-03-05 18:43:00 +010031#include <proto/freq_ctr.h>
Willy TARREAU3dc06442006-06-15 21:48:13 +020032
Willy Tarreauf79d9502014-03-15 07:22:35 +010033extern struct proxy *proxy;
34extern struct eb_root used_proxy_id; /* list of proxy IDs in use */
35extern unsigned int error_snapshot_id; /* global ID assigned to each error then incremented */
36extern struct eb_root proxy_by_name; /* tree of proxies sorted by name */
37
Willy Tarreaubaaee002006-06-26 02:48:02 +020038int start_proxies(int verbose);
Willy Tarreau918ff602011-07-25 16:33:49 +020039struct task *manage_proxy(struct task *t);
Willy Tarreaubaaee002006-06-26 02:48:02 +020040void soft_stop(void);
Willy Tarreauce8fe252011-09-07 19:14:57 +020041int pause_proxy(struct proxy *p);
Willy Tarreau532a4502011-09-07 22:37:44 +020042int resume_proxy(struct proxy *p);
Willy Tarreauda250db2008-10-12 12:07:48 +020043void stop_proxy(struct proxy *p);
Willy Tarreaubaaee002006-06-26 02:48:02 +020044void pause_proxies(void);
Willy Tarreaube58c382011-07-24 18:28:10 +020045void resume_proxies(void);
Willy Tarreau87b09662015-04-03 00:22:06 +020046int stream_set_backend(struct stream *s, struct proxy *be);
Willy Tarreaubaaee002006-06-26 02:48:02 +020047
Willy Tarreau816eb542007-11-04 07:04:43 +010048const char *proxy_cap_str(int cap);
Krzysztof Piotr Oledzki6eb730d2007-11-03 23:41:58 +010049const char *proxy_mode_str(int mode);
Willy Tarreauf79d9502014-03-15 07:22:35 +010050void proxy_store_name(struct proxy *px);
Willy Tarreau3c56a7d2015-05-26 15:25:32 +020051struct proxy *proxy_find_by_id(int id, int cap, int table);
Willy Tarreau9e0bb102015-05-26 11:24:42 +020052struct proxy *proxy_find_by_name(const char *name, int cap, int table);
Willy Tarreaueb3e3482015-05-27 16:46:26 +020053struct proxy *proxy_find_best_match(int cap, const char *name, int id, int *diff);
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +010054struct server *findserver(const struct proxy *px, const char *name);
Willy Tarreau915e1eb2009-06-22 15:48:36 +020055int proxy_cfg_ensure_no_http(struct proxy *curproxy);
Willy Tarreau237250c2011-07-29 01:49:03 +020056void init_new_proxy(struct proxy *p);
Willy Tarreauf3950172009-10-10 18:35:51 +020057int get_backend_server(const char *bk_name, const char *sv_name,
58 struct proxy **bk, struct server **sv);
Willy Tarreaubaaee002006-06-26 02:48:02 +020059
Willy Tarreau816eb542007-11-04 07:04:43 +010060/*
61 * This function returns a string containing the type of the proxy in a format
62 * suitable for error messages, from its capabilities.
63 */
64static inline const char *proxy_type_str(struct proxy *proxy)
65{
66 return proxy_cap_str(proxy->cap);
67}
68
Willy Tarreau9e0bb102015-05-26 11:24:42 +020069/* Find the frontend having name <name>. The name may also start with a '#' to
70 * reference a numeric id. NULL is returned if not found.
71 */
72static inline struct proxy *proxy_fe_by_name(const char *name)
73{
74 return proxy_find_by_name(name, PR_CAP_FE, 0);
75}
76
77/* Find the backend having name <name>. The name may also start with a '#' to
78 * reference a numeric id. NULL is returned if not found.
79 */
80static inline struct proxy *proxy_be_by_name(const char *name)
81{
82 return proxy_find_by_name(name, PR_CAP_BE, 0);
83}
84
85/* Find the table having name <name>. The name may also start with a '#' to
86 * reference a numeric id. NULL is returned if not found.
87 */
88static inline struct proxy *proxy_tbl_by_name(const char *name)
89{
90 return proxy_find_by_name(name, 0, 1);
91}
92
Willy Tarreau3a70f942008-02-15 11:15:34 +010093/* this function initializes all timeouts for proxy p */
94static inline void proxy_reset_timeouts(struct proxy *proxy)
95{
Willy Tarreau0c303ee2008-07-07 00:09:58 +020096 proxy->timeout.client = TICK_ETERNITY;
97 proxy->timeout.tarpit = TICK_ETERNITY;
98 proxy->timeout.queue = TICK_ETERNITY;
99 proxy->timeout.connect = TICK_ETERNITY;
100 proxy->timeout.server = TICK_ETERNITY;
Willy Tarreau0c303ee2008-07-07 00:09:58 +0200101 proxy->timeout.httpreq = TICK_ETERNITY;
102 proxy->timeout.check = TICK_ETERNITY;
Willy Tarreauce887fd2012-05-12 12:50:00 +0200103 proxy->timeout.tunnel = TICK_ETERNITY;
Willy Tarreau3a70f942008-02-15 11:15:34 +0100104}
105
Willy Tarreaub36b4242010-06-04 20:59:39 +0200106/* increase the number of cumulated connections received on the designated frontend */
107static void inline proxy_inc_fe_conn_ctr(struct listener *l, struct proxy *fe)
Willy Tarreau7f062c42009-03-05 18:43:00 +0100108{
Willy Tarreau7d0aaf32011-03-10 23:25:56 +0100109 fe->fe_counters.cum_conn++;
Krzysztof Piotr Oledzkiaeebf9b2009-10-04 15:43:17 +0200110 if (l->counters)
111 l->counters->cum_conn++;
112
Willy Tarreaub36b4242010-06-04 20:59:39 +0200113 update_freq_ctr(&fe->fe_conn_per_sec, 1);
Willy Tarreau7d0aaf32011-03-10 23:25:56 +0100114 if (fe->fe_conn_per_sec.curr_ctr > fe->fe_counters.cps_max)
115 fe->fe_counters.cps_max = fe->fe_conn_per_sec.curr_ctr;
Willy Tarreaub36b4242010-06-04 20:59:39 +0200116}
117
118/* increase the number of cumulated connections accepted by the designated frontend */
119static void inline proxy_inc_fe_sess_ctr(struct listener *l, struct proxy *fe)
120{
Willy Tarreau7d0aaf32011-03-10 23:25:56 +0100121 fe->fe_counters.cum_sess++;
Willy Tarreaub36b4242010-06-04 20:59:39 +0200122 if (l->counters)
123 l->counters->cum_sess++;
Willy Tarreau7f062c42009-03-05 18:43:00 +0100124 update_freq_ctr(&fe->fe_sess_per_sec, 1);
Willy Tarreau7d0aaf32011-03-10 23:25:56 +0100125 if (fe->fe_sess_per_sec.curr_ctr > fe->fe_counters.sps_max)
126 fe->fe_counters.sps_max = fe->fe_sess_per_sec.curr_ctr;
Willy Tarreau7f062c42009-03-05 18:43:00 +0100127}
128
129/* increase the number of cumulated connections on the designated backend */
130static void inline proxy_inc_be_ctr(struct proxy *be)
131{
Willy Tarreau7d0aaf32011-03-10 23:25:56 +0100132 be->be_counters.cum_conn++;
Willy Tarreau7f062c42009-03-05 18:43:00 +0100133 update_freq_ctr(&be->be_sess_per_sec, 1);
Willy Tarreau7d0aaf32011-03-10 23:25:56 +0100134 if (be->be_sess_per_sec.curr_ctr > be->be_counters.sps_max)
135 be->be_counters.sps_max = be->be_sess_per_sec.curr_ctr;
Willy Tarreau7f062c42009-03-05 18:43:00 +0100136}
137
Willy Tarreaud9b587f2010-02-26 10:05:55 +0100138/* increase the number of cumulated requests on the designated frontend */
139static void inline proxy_inc_fe_req_ctr(struct proxy *fe)
140{
Willy Tarreau7d0aaf32011-03-10 23:25:56 +0100141 fe->fe_counters.p.http.cum_req++;
Willy Tarreaud9b587f2010-02-26 10:05:55 +0100142 update_freq_ctr(&fe->fe_req_per_sec, 1);
Willy Tarreau7d0aaf32011-03-10 23:25:56 +0100143 if (fe->fe_req_per_sec.curr_ctr > fe->fe_counters.p.http.rps_max)
144 fe->fe_counters.p.http.rps_max = fe->fe_req_per_sec.curr_ctr;
Willy Tarreaud9b587f2010-02-26 10:05:55 +0100145}
146
Willy Tarreaubaaee002006-06-26 02:48:02 +0200147#endif /* _PROTO_PROXY_H */
Willy TARREAU3dc06442006-06-15 21:48:13 +0200148
Willy Tarreaubaaee002006-06-26 02:48:02 +0200149/*
150 * Local variables:
151 * c-indent-level: 8
152 * c-basic-offset: 8
153 * End:
154 */