blob: 7f108b507370b400dfaa28e13aa3d61021d6e461 [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 Tarreau960f2cb2016-11-24 12:02:29 +010028#include <types/applet.h>
Willy Tarreau81c25d02011-09-07 15:17:21 +020029#include <types/global.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020030#include <types/proxy.h>
Willy Tarreaud1d54542012-09-12 22:58:11 +020031#include <types/listener.h>
Willy Tarreau7f062c42009-03-05 18:43:00 +010032#include <proto/freq_ctr.h>
Willy TARREAU3dc06442006-06-15 21:48:13 +020033
Olivier Houchardfbc74e82017-11-24 16:54:05 +010034extern struct proxy *proxies_list;
Willy Tarreauf79d9502014-03-15 07:22:35 +010035extern struct eb_root used_proxy_id; /* list of proxy IDs in use */
36extern unsigned int error_snapshot_id; /* global ID assigned to each error then incremented */
37extern struct eb_root proxy_by_name; /* tree of proxies sorted by name */
38
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +010039extern const struct cfg_opt cfg_opts[];
40extern const struct cfg_opt cfg_opts2[];
41
Willy Tarreaubaaee002006-06-26 02:48:02 +020042int start_proxies(int verbose);
Olivier Houchard9f6af332018-05-25 14:04:04 +020043struct task *manage_proxy(struct task *t, void *context, unsigned short state);
Willy Tarreaubaaee002006-06-26 02:48:02 +020044void soft_stop(void);
Willy Tarreauce8fe252011-09-07 19:14:57 +020045int pause_proxy(struct proxy *p);
Willy Tarreau532a4502011-09-07 22:37:44 +020046int resume_proxy(struct proxy *p);
Willy Tarreauda250db2008-10-12 12:07:48 +020047void stop_proxy(struct proxy *p);
Olivier Houchard1fc05162017-04-06 01:05:05 +020048void zombify_proxy(struct proxy *p);
Willy Tarreaubaaee002006-06-26 02:48:02 +020049void pause_proxies(void);
Willy Tarreaube58c382011-07-24 18:28:10 +020050void resume_proxies(void);
Willy Tarreau87b09662015-04-03 00:22:06 +020051int stream_set_backend(struct stream *s, struct proxy *be);
Willy Tarreaubaaee002006-06-26 02:48:02 +020052
Willy Tarreau816eb542007-11-04 07:04:43 +010053const char *proxy_cap_str(int cap);
Krzysztof Piotr Oledzki6eb730d2007-11-03 23:41:58 +010054const char *proxy_mode_str(int mode);
Willy Tarreauf79d9502014-03-15 07:22:35 +010055void proxy_store_name(struct proxy *px);
Willy Tarreau3c56a7d2015-05-26 15:25:32 +020056struct proxy *proxy_find_by_id(int id, int cap, int table);
Willy Tarreau9e0bb102015-05-26 11:24:42 +020057struct proxy *proxy_find_by_name(const char *name, int cap, int table);
Willy Tarreaueb3e3482015-05-27 16:46:26 +020058struct proxy *proxy_find_best_match(int cap, const char *name, int id, int *diff);
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +010059struct server *findserver(const struct proxy *px, const char *name);
Willy Tarreau915e1eb2009-06-22 15:48:36 +020060int proxy_cfg_ensure_no_http(struct proxy *curproxy);
Willy Tarreau237250c2011-07-29 01:49:03 +020061void init_new_proxy(struct proxy *p);
Willy Tarreauf3950172009-10-10 18:35:51 +020062int get_backend_server(const char *bk_name, const char *sv_name,
63 struct proxy **bk, struct server **sv);
Willy Tarreau75fb65a2018-09-07 17:43:26 +020064void proxy_capture_error(struct proxy *proxy, int is_back,
65 struct proxy *other_end, enum obj_type *target,
66 const struct session *sess,
67 const struct buffer *buf, long buf_ofs,
68 unsigned int buf_out, unsigned int err_pos,
69 const union error_snapshot_ctx *ctx,
70 void (*show)(struct buffer *, const struct error_snapshot *));
Willy Tarreauc8d5b952019-02-27 17:25:52 +010071void proxy_adjust_all_maxconn();
Willy Tarreau960f2cb2016-11-24 12:02:29 +010072struct proxy *cli_find_frontend(struct appctx *appctx, const char *arg);
Olivier Houchard614f8d72017-03-14 20:08:46 +010073struct proxy *cli_find_frontend(struct appctx *appctx, const char *arg);
Willy Tarreaubaaee002006-06-26 02:48:02 +020074
Willy Tarreau816eb542007-11-04 07:04:43 +010075/*
76 * This function returns a string containing the type of the proxy in a format
77 * suitable for error messages, from its capabilities.
78 */
79static inline const char *proxy_type_str(struct proxy *proxy)
80{
81 return proxy_cap_str(proxy->cap);
82}
83
Willy Tarreau9e0bb102015-05-26 11:24:42 +020084/* Find the frontend having name <name>. The name may also start with a '#' to
85 * reference a numeric id. NULL is returned if not found.
86 */
87static inline struct proxy *proxy_fe_by_name(const char *name)
88{
89 return proxy_find_by_name(name, PR_CAP_FE, 0);
90}
91
92/* Find the backend having name <name>. The name may also start with a '#' to
93 * reference a numeric id. NULL is returned if not found.
94 */
95static inline struct proxy *proxy_be_by_name(const char *name)
96{
97 return proxy_find_by_name(name, PR_CAP_BE, 0);
98}
99
Willy Tarreau3a70f942008-02-15 11:15:34 +0100100/* this function initializes all timeouts for proxy p */
101static inline void proxy_reset_timeouts(struct proxy *proxy)
102{
Willy Tarreau0c303ee2008-07-07 00:09:58 +0200103 proxy->timeout.client = TICK_ETERNITY;
104 proxy->timeout.tarpit = TICK_ETERNITY;
105 proxy->timeout.queue = TICK_ETERNITY;
106 proxy->timeout.connect = TICK_ETERNITY;
107 proxy->timeout.server = TICK_ETERNITY;
Willy Tarreau0c303ee2008-07-07 00:09:58 +0200108 proxy->timeout.httpreq = TICK_ETERNITY;
109 proxy->timeout.check = TICK_ETERNITY;
Willy Tarreauce887fd2012-05-12 12:50:00 +0200110 proxy->timeout.tunnel = TICK_ETERNITY;
Willy Tarreau3a70f942008-02-15 11:15:34 +0100111}
112
Willy Tarreaub36b4242010-06-04 20:59:39 +0200113/* increase the number of cumulated connections received on the designated frontend */
Willy Tarreau0e492e22019-04-15 21:25:03 +0200114static inline void proxy_inc_fe_conn_ctr(struct listener *l, struct proxy *fe)
Willy Tarreau7f062c42009-03-05 18:43:00 +0100115{
Olivier Houchard11ecfd12019-03-08 18:48:16 +0100116 _HA_ATOMIC_ADD(&fe->fe_counters.cum_conn, 1);
Krzysztof Piotr Oledzkiaeebf9b2009-10-04 15:43:17 +0200117 if (l->counters)
Olivier Houchard11ecfd12019-03-08 18:48:16 +0100118 _HA_ATOMIC_ADD(&l->counters->cum_conn, 1);
Christopher Fauletff8abcd2017-06-02 15:33:24 +0200119 HA_ATOMIC_UPDATE_MAX(&fe->fe_counters.cps_max,
120 update_freq_ctr(&fe->fe_conn_per_sec, 1));
Willy Tarreaub36b4242010-06-04 20:59:39 +0200121}
122
123/* increase the number of cumulated connections accepted by the designated frontend */
Willy Tarreau0e492e22019-04-15 21:25:03 +0200124static inline void proxy_inc_fe_sess_ctr(struct listener *l, struct proxy *fe)
Willy Tarreaub36b4242010-06-04 20:59:39 +0200125{
Christopher Fauletff8abcd2017-06-02 15:33:24 +0200126
Olivier Houchard11ecfd12019-03-08 18:48:16 +0100127 _HA_ATOMIC_ADD(&fe->fe_counters.cum_sess, 1);
Willy Tarreaub36b4242010-06-04 20:59:39 +0200128 if (l->counters)
Olivier Houchard11ecfd12019-03-08 18:48:16 +0100129 _HA_ATOMIC_ADD(&l->counters->cum_sess, 1);
Christopher Fauletff8abcd2017-06-02 15:33:24 +0200130 HA_ATOMIC_UPDATE_MAX(&fe->fe_counters.sps_max,
131 update_freq_ctr(&fe->fe_sess_per_sec, 1));
Willy Tarreau7f062c42009-03-05 18:43:00 +0100132}
133
134/* increase the number of cumulated connections on the designated backend */
Willy Tarreau0e492e22019-04-15 21:25:03 +0200135static inline void proxy_inc_be_ctr(struct proxy *be)
Willy Tarreau7f062c42009-03-05 18:43:00 +0100136{
Olivier Houchard11ecfd12019-03-08 18:48:16 +0100137 _HA_ATOMIC_ADD(&be->be_counters.cum_conn, 1);
Christopher Fauletff8abcd2017-06-02 15:33:24 +0200138 HA_ATOMIC_UPDATE_MAX(&be->be_counters.sps_max,
139 update_freq_ctr(&be->be_sess_per_sec, 1));
Willy Tarreau7f062c42009-03-05 18:43:00 +0100140}
141
Willy Tarreaud9b587f2010-02-26 10:05:55 +0100142/* increase the number of cumulated requests on the designated frontend */
Willy Tarreau0e492e22019-04-15 21:25:03 +0200143static inline void proxy_inc_fe_req_ctr(struct proxy *fe)
Willy Tarreaud9b587f2010-02-26 10:05:55 +0100144{
Olivier Houchard11ecfd12019-03-08 18:48:16 +0100145 _HA_ATOMIC_ADD(&fe->fe_counters.p.http.cum_req, 1);
Christopher Fauletff8abcd2017-06-02 15:33:24 +0200146 HA_ATOMIC_UPDATE_MAX(&fe->fe_counters.p.http.rps_max,
147 update_freq_ctr(&fe->fe_req_per_sec, 1));
Willy Tarreaud9b587f2010-02-26 10:05:55 +0100148}
149
Olivier Houcharda254a372019-04-05 15:30:12 +0200150/* Returns non-zero if the proxy is configured to retry a request if we got that status, 0 overwise */
151static inline int l7_status_match(struct proxy *p, int status)
152{
153 /* Just return 0 if no retry was configured for any status */
154 if (!(p->retry_type & PR_RE_STATUS_MASK))
155 return 0;
156
157 switch (status) {
158 case 404:
159 return (p->retry_type & PR_RE_404);
160 case 408:
161 return (p->retry_type & PR_RE_408);
162 case 425:
163 return (p->retry_type & PR_RE_425);
164 case 500:
165 return (p->retry_type & PR_RE_500);
166 case 501:
167 return (p->retry_type & PR_RE_501);
168 case 502:
169 return (p->retry_type & PR_RE_502);
170 case 503:
171 return (p->retry_type & PR_RE_503);
172 case 504:
173 return (p->retry_type & PR_RE_504);
174 default:
175 break;
176 }
177 return 0;
178}
Frédéric Lécaillebe367932019-08-07 09:28:39 +0200179
180/* Return 1 if <p> proxy is in <list> list of proxies which are also stick-tables,
181 * 0 if not.
182 */
183static inline int in_proxies_list(struct proxy *list, struct proxy *proxy)
184{
185 struct proxy *p;
186
187 for (p = list; p; p = p->next_stkt_ref)
188 if (proxy == p)
189 return 1;
190
191 return 0;
192}
193
Willy Tarreaubaaee002006-06-26 02:48:02 +0200194#endif /* _PROTO_PROXY_H */
Willy TARREAU3dc06442006-06-15 21:48:13 +0200195
Willy Tarreaubaaee002006-06-26 02:48:02 +0200196/*
197 * Local variables:
198 * c-indent-level: 8
199 * c-basic-offset: 8
200 * End:
201 */