blob: 0844e8aeb895ead91e890a6ddc5ccdab7fd025e3 [file] [log] [blame]
Willy TARREAU3dc06442006-06-15 21:48:13 +02001/*
Willy Tarreauac68c5d2009-10-04 23:12:44 +02002 * include/proto/server.h
3 * This file defines everything related to servers.
4 *
5 * Copyright (C) 2000-2009 Willy Tarreau - w@1wt.eu
6 *
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_SERVER_H
23#define _PROTO_SERVER_H
24
25#include <unistd.h>
26
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020027#include <common/config.h>
Bhaskar Maddalaa20cb852014-02-03 16:26:46 -050028#include <common/time.h>
Willy Tarreaudf4399f2016-11-24 17:32:01 +010029#include <types/applet.h>
Baptiste Assmanna68ca962015-04-14 01:15:08 +020030#include <types/dns.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020031#include <types/proxy.h>
32#include <types/queue.h>
33#include <types/server.h>
Willy TARREAU3dc06442006-06-15 21:48:13 +020034
Willy Tarreaubaaee002006-06-26 02:48:02 +020035#include <proto/queue.h>
Bhaskar Maddalaa20cb852014-02-03 16:26:46 -050036#include <proto/log.h>
Willy Tarreau7f062c42009-03-05 18:43:00 +010037#include <proto/freq_ctr.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020038
Olivier Houchard9ea5d362019-02-14 18:29:09 +010039
40__decl_hathreads(extern HA_SPINLOCK_T idle_conn_srv_lock);
41extern struct eb_root idle_conn_srv;
42extern struct task *idle_conn_task;
43extern struct task *idle_conn_cleanup[MAX_THREADS];
Olivier Houchard859dc802019-08-08 15:47:21 +020044extern struct mt_list toremove_connections[MAX_THREADS];
Olivier Houchard9ea5d362019-02-14 18:29:09 +010045
Simon Hormana3608442013-11-01 16:46:15 +090046int srv_downtime(const struct server *s);
Bhaskar Maddalaa20cb852014-02-03 16:26:46 -050047int srv_lastsession(const struct server *s);
Simon Horman4a741432013-02-23 15:35:38 +090048int srv_getinter(const struct check *check);
Frédéric Lécaille355b2032019-01-11 14:06:12 +010049int parse_server(const char *file, int linenum, char **args, struct proxy *curproxy, struct proxy *defproxy, int parse_addr);
Thierry Fournierd35b7a62016-02-24 08:23:22 +010050int update_server_addr(struct server *s, void *ip, int ip_sin_family, const char *updater);
Baptiste Assmannd458adc2016-08-02 08:18:55 +020051const char *update_server_addr_port(struct server *s, const char *addr, const char *port, char *updater);
Baptiste Assmann19a106d2015-07-08 22:03:56 +020052struct server *server_find_by_id(struct proxy *bk, int id);
53struct server *server_find_by_name(struct proxy *bk, const char *name);
54struct server *server_find_best_match(struct proxy *bk, char *name, int id, int *diff);
Baptiste Assmanne11cfcd2015-08-19 16:44:03 +020055void apply_server_state(void);
Willy Tarreau757478e2016-11-03 19:22:19 +010056void srv_compute_all_admin_states(struct proxy *px);
Baptiste Assmann83cbaa52016-11-02 15:34:05 +010057int srv_set_addr_via_libc(struct server *srv, int *err_code);
58int srv_init_addr(void);
Willy Tarreau21b069d2016-11-23 17:15:08 +010059struct server *cli_find_server(struct appctx *appctx, char *arg);
William Lallemand313bfd12018-10-26 14:47:32 +020060struct server *new_server(struct proxy *proxy);
Willy Tarreaubaaee002006-06-26 02:48:02 +020061
Baptiste Assmanna68ca962015-04-14 01:15:08 +020062/* functions related to server name resolution */
Olivier Houcharda8c6db82017-07-06 18:46:47 +020063int snr_update_srv_status(struct server *s, int has_no_ip);
Olivier Houchardd16bfe62017-10-31 15:21:19 +010064const char *update_server_fqdn(struct server *server, const char *fqdn, const char *updater, int dns_locked);
Baptiste Assmann201c07f2017-05-22 15:17:15 +020065int snr_resolution_cb(struct dns_requester *requester, struct dns_nameserver *nameserver);
66int snr_resolution_error_cb(struct dns_requester *requester, int error_code);
Baptiste Assmannfb7091e2017-05-03 15:43:12 +020067struct server *snr_check_ip_callback(struct server *srv, void *ip, unsigned char *ip_family);
Willy Tarreau980855b2019-02-07 14:59:29 +010068struct task *srv_cleanup_idle_connections(struct task *task, void *ctx, unsigned short state);
Olivier Houchard9ea5d362019-02-14 18:29:09 +010069struct task *srv_cleanup_toremove_connections(struct task *task, void *context, unsigned short state);
Baptiste Assmanna68ca962015-04-14 01:15:08 +020070
Willy Tarreau7f062c42009-03-05 18:43:00 +010071/* increase the number of cumulated connections on the designated server */
Willy Tarreau0e492e22019-04-15 21:25:03 +020072static inline void srv_inc_sess_ctr(struct server *s)
Willy Tarreau7f062c42009-03-05 18:43:00 +010073{
Olivier Houchardaa4d71a2019-03-08 18:48:31 +010074 _HA_ATOMIC_ADD(&s->counters.cum_sess, 1);
Christopher Faulet29f77e82017-06-08 14:04:45 +020075 HA_ATOMIC_UPDATE_MAX(&s->counters.sps_max,
76 update_freq_ctr(&s->sess_per_sec, 1));
Willy Tarreau7f062c42009-03-05 18:43:00 +010077}
78
Bhaskar Maddalaa20cb852014-02-03 16:26:46 -050079/* set the time of last session on the designated server */
Willy Tarreau0e492e22019-04-15 21:25:03 +020080static inline void srv_set_sess_last(struct server *s)
Bhaskar Maddalaa20cb852014-02-03 16:26:46 -050081{
82 s->counters.last_sess = now.tv_sec;
83}
84
Willy Tarreaubaaee002006-06-26 02:48:02 +020085/*
Willy Tarreau21faa912012-10-10 08:27:36 +020086 * Registers the server keyword list <kwl> as a list of valid keywords for next
87 * parsing sessions.
88 */
89void srv_register_keywords(struct srv_kw_list *kwl);
90
91/* Return a pointer to the server keyword <kw>, or NULL if not found. */
92struct srv_kw *srv_find_kw(const char *kw);
93
94/* Dumps all registered "server" keywords to the <out> string pointer. */
95void srv_dump_kws(char **out);
96
Willy Tarreau004e0452013-11-21 11:22:01 +010097/* Recomputes the server's eweight based on its state, uweight, the current time,
98 * and the proxy's algorihtm. To be used after updating sv->uweight. The warmup
99 * state is automatically disabled if the time is elapsed.
100 */
Willy Tarreau3ff577e2018-08-02 11:48:52 +0200101void server_recalc_eweight(struct server *sv, int must_update);
Willy Tarreau004e0452013-11-21 11:22:01 +0100102
Willy Tarreaud32c3992013-11-21 15:30:45 +0100103/* returns the current server throttle rate between 0 and 100% */
104static inline unsigned int server_throttle_rate(struct server *sv)
105{
106 struct proxy *px = sv->proxy;
107
108 /* when uweight is 0, we're in soft-stop so that cannot be a slowstart,
109 * thus the throttle is 100%.
110 */
111 if (!sv->uweight)
112 return 100;
113
Emeric Brun52a91d32017-08-31 14:41:55 +0200114 return (100U * px->lbprm.wmult * sv->cur_eweight + px->lbprm.wdiv - 1) / (px->lbprm.wdiv * sv->uweight);
Willy Tarreaud32c3992013-11-21 15:30:45 +0100115}
116
Willy Tarreau21faa912012-10-10 08:27:36 +0200117/*
Simon Horman7d09b9a2013-02-12 10:45:51 +0900118 * Parses weight_str and configures sv accordingly.
119 * Returns NULL on success, error message string otherwise.
120 */
121const char *server_parse_weight_change_request(struct server *sv,
122 const char *weight_str);
123
124/*
Thierry Fournier09a91782016-02-24 08:25:39 +0100125 * Parses addr_str and configures sv accordingly. updater precise
126 * the source of the change in the associated message log.
Baptiste Assmann3d8f8312015-04-13 22:54:33 +0200127 * Returns NULL on success, error message string otherwise.
128 */
129const char *server_parse_addr_change_request(struct server *sv,
Thierry Fournier09a91782016-02-24 08:25:39 +0100130 const char *addr_str, const char *updater);
Baptiste Assmann3d8f8312015-04-13 22:54:33 +0200131
132/*
Nenad Merdanovic174dd372016-04-24 23:10:06 +0200133 * Parses maxconn_str and configures sv accordingly.
134 * Returns NULL on success, error message string otherwise.
135 */
136const char *server_parse_maxconn_change_request(struct server *sv,
137 const char *maxconn_str);
138
139/*
Willy Tarreau02615f92014-05-13 22:08:20 +0200140 * Return true if the server has a zero user-weight, meaning it's in draining
141 * mode (ie: not taking new non-persistent connections).
Simon Horman8c3d0be2013-11-25 10:46:40 +0900142 */
Willy Tarreau02615f92014-05-13 22:08:20 +0200143static inline int server_is_draining(const struct server *s)
Simon Horman8c3d0be2013-11-25 10:46:40 +0900144{
Emeric Brun52a91d32017-08-31 14:41:55 +0200145 return !s->uweight || (s->cur_admin & SRV_ADMF_DRAIN);
Simon Horman8c3d0be2013-11-25 10:46:40 +0900146}
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200147
148/* Shutdown all connections of a server. The caller must pass a termination
Willy Tarreaue7dff022015-04-03 01:14:29 +0200149 * code in <why>, which must be one of SF_ERR_* indicating the reason for the
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200150 * shutdown.
151 */
Thierry Fournier9f725552016-02-22 16:08:58 +0100152void srv_shutdown_streams(struct server *srv, int why);
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200153
154/* Shutdown all connections of all backup servers of a proxy. The caller must
Willy Tarreaue7dff022015-04-03 01:14:29 +0200155 * pass a termination code in <why>, which must be one of SF_ERR_* indicating
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200156 * the reason for the shutdown.
157 */
Thierry Fournier9f725552016-02-22 16:08:58 +0100158void srv_shutdown_backup_streams(struct proxy *px, int why);
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200159
Willy Tarreau83061a82018-07-13 11:56:34 +0200160void srv_append_status(struct buffer *msg, struct server *s, struct check *,
161 int xferred, int forced);
Willy Tarreaudbd5e782014-05-20 22:46:35 +0200162
Emeric Brun5a133512017-10-19 14:42:30 +0200163void srv_set_stopped(struct server *s, const char *reason, struct check *check);
164void srv_set_running(struct server *s, const char *reason, struct check *check);
165void srv_set_stopping(struct server *s, const char *reason, struct check *check);
Willy Tarreau8eb77842014-05-21 13:54:57 +0200166
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200167/* Enables admin flag <mode> (among SRV_ADMF_*) on server <s>. This is used to
168 * enforce either maint mode or drain mode. It is not allowed to set more than
169 * one flag at once. The equivalent "inherited" flag is propagated to all
170 * tracking servers. Maintenance mode disables health checks (but not agent
171 * checks). When either the flag is already set or no flag is passed, nothing
Willy Tarreau8b428482016-11-07 15:53:43 +0100172 * is done. If <cause> is non-null, it will be displayed at the end of the log
173 * lines to justify the state change.
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200174 */
Willy Tarreau8b428482016-11-07 15:53:43 +0100175void srv_set_admin_flag(struct server *s, enum srv_admin mode, const char *cause);
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200176
177/* Disables admin flag <mode> (among SRV_ADMF_*) on server <s>. This is used to
178 * stop enforcing either maint mode or drain mode. It is not allowed to set more
179 * than one flag at once. The equivalent "inherited" flag is propagated to all
180 * tracking servers. Leaving maintenance mode re-enables health checks. When
181 * either the flag is already cleared or no flag is passed, nothing is done.
182 */
183void srv_clr_admin_flag(struct server *s, enum srv_admin mode);
184
Olivier Houchard4e694042017-03-14 20:01:29 +0100185/* Calculates the dynamic persitent cookie for a server, if a secret key has
186 * been provided.
187 */
188void srv_set_dyncookie(struct server *s);
189
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200190/* Puts server <s> into maintenance mode, and propagate that status down to all
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200191 * tracking servers.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200192 */
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200193static inline void srv_adm_set_maint(struct server *s)
194{
Willy Tarreau8b428482016-11-07 15:53:43 +0100195 srv_set_admin_flag(s, SRV_ADMF_FMAINT, NULL);
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200196 srv_clr_admin_flag(s, SRV_ADMF_FDRAIN);
197}
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200198
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200199/* Puts server <s> into drain mode, and propagate that status down to all
200 * tracking servers.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200201 */
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200202static inline void srv_adm_set_drain(struct server *s)
203{
Willy Tarreau8b428482016-11-07 15:53:43 +0100204 srv_set_admin_flag(s, SRV_ADMF_FDRAIN, NULL);
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200205 srv_clr_admin_flag(s, SRV_ADMF_FMAINT);
206}
207
208/* Puts server <s> into ready mode, and propagate that status down to all
209 * tracking servers.
210 */
211static inline void srv_adm_set_ready(struct server *s)
212{
213 srv_clr_admin_flag(s, SRV_ADMF_FDRAIN);
214 srv_clr_admin_flag(s, SRV_ADMF_FMAINT);
215}
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200216
Baptiste Assmann25938272016-09-21 20:26:16 +0200217/* appends an initaddr method to the existing list. Returns 0 on failure. */
218static inline int srv_append_initaddr(unsigned int *list, enum srv_initaddr addr)
219{
220 int shift = 0;
221
222 while (shift + 3 < 32 && (*list >> shift))
223 shift += 3;
224
225 if (shift + 3 > 32)
226 return 0;
227
228 *list |= addr << shift;
229 return 1;
230}
231
Willy Tarreau25e51522016-11-04 15:10:17 +0100232/* returns the next initaddr method and removes it from <list> by shifting
233 * it right (implying that it MUST NOT be the server's. Returns SRV_IADDR_END
234 * at the end.
235 */
236static inline enum srv_initaddr srv_get_next_initaddr(unsigned int *list)
237{
238 enum srv_initaddr ret;
239
240 ret = *list & 7;
241 *list >>= 3;
242 return ret;
243}
244
Willy Tarreau00f18a32019-01-26 12:19:01 +0100245/* This adds an idle connection to the server's list if the connection is
246 * reusable, not held by any owner anymore, but still has available streams.
247 */
Olivier Houcharda4d4fdf2018-12-14 19:27:06 +0100248static inline int srv_add_to_idle_list(struct server *srv, struct connection *conn)
249{
Willy Tarreau00f18a32019-01-26 12:19:01 +0100250 if (srv && srv->pool_purge_delay > 0 &&
251 (srv->max_idle_conns == -1 || srv->max_idle_conns > srv->curr_idle_conns) &&
Willy Tarreau4cae3bf2019-09-08 07:38:23 +0200252 (srv->cur_sess + srv->curr_idle_conns <= srv->counters.cur_sess_max) &&
Olivier Houcharda4d4fdf2018-12-14 19:27:06 +0100253 !(conn->flags & CO_FL_PRIVATE) &&
254 ((srv->proxy->options & PR_O_REUSE_MASK) != PR_O_REUSE_NEVR) &&
Olivier Houchard88698d92019-04-16 19:07:22 +0200255 !conn->mux->used_streams(conn) && conn->mux->avail_streams(conn) &&
256 ha_used_fds < global.tune.pool_low_count) {
Olivier Houcharde7371032019-02-15 18:49:15 +0100257 int retadd;
258
Olivier Houchardaa4d71a2019-03-08 18:48:31 +0100259 retadd = _HA_ATOMIC_ADD(&srv->curr_idle_conns, 1);
Christopher Faulet34ce7d02019-07-10 14:06:33 +0200260 if (retadd > srv->max_idle_conns) {
Olivier Houchardaa4d71a2019-03-08 18:48:31 +0100261 _HA_ATOMIC_SUB(&srv->curr_idle_conns, 1);
Olivier Houcharde7371032019-02-15 18:49:15 +0100262 return 0;
263 }
Olivier Houchard9570ecf2019-09-20 18:08:29 +0200264 LIST_DEL_INIT(&conn->list);
Olivier Houchard859dc802019-08-08 15:47:21 +0200265 MT_LIST_ADDQ(&srv->idle_orphan_conns[tid], (struct mt_list *)&conn->list);
Olivier Houchardf1314812019-02-18 16:41:17 +0100266 srv->curr_idle_thr[tid]++;
Olivier Houcharda4d4fdf2018-12-14 19:27:06 +0100267
268 conn->idle_time = now_ms;
Olivier Houchard9ea5d362019-02-14 18:29:09 +0100269 __ha_barrier_full();
270 if ((volatile void *)srv->idle_node.node.leaf_p == NULL) {
271 HA_SPIN_LOCK(OTHER_LOCK, &idle_conn_srv_lock);
272 if ((volatile void *)srv->idle_node.node.leaf_p == NULL) {
273 srv->idle_node.key = tick_add(srv->pool_purge_delay,
274 now_ms);
275 eb32_insert(&idle_conn_srv, &srv->idle_node);
276 if (!task_in_wq(idle_conn_task) && !
277 task_in_rq(idle_conn_task)) {
278 task_schedule(idle_conn_task,
279 srv->idle_node.key);
280 }
281
282 }
283 HA_SPIN_UNLOCK(OTHER_LOCK, &idle_conn_srv_lock);
284 }
Olivier Houcharda4d4fdf2018-12-14 19:27:06 +0100285 return 1;
286 }
287 return 0;
288}
289
Godbache468d552014-07-28 17:31:57 +0800290#endif /* _PROTO_SERVER_H */
291
Simon Horman8c3d0be2013-11-25 10:46:40 +0900292/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200293 * Local variables:
294 * c-indent-level: 8
295 * c-basic-offset: 8
296 * End:
297 */