blob: b3a9b877f935377abc0a05c69d8425a0463f3fef [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
Simon Hormana3608442013-11-01 16:46:15 +090039int srv_downtime(const struct server *s);
Bhaskar Maddalaa20cb852014-02-03 16:26:46 -050040int srv_lastsession(const struct server *s);
Simon Horman4a741432013-02-23 15:35:38 +090041int srv_getinter(const struct check *check);
Willy Tarreau272adea2014-03-31 10:39:59 +020042int parse_server(const char *file, int linenum, char **args, struct proxy *curproxy, struct proxy *defproxy);
Thierry Fournierd35b7a62016-02-24 08:23:22 +010043int update_server_addr(struct server *s, void *ip, int ip_sin_family, const char *updater);
Baptiste Assmannd458adc2016-08-02 08:18:55 +020044const char *update_server_addr_port(struct server *s, const char *addr, const char *port, char *updater);
Baptiste Assmann19a106d2015-07-08 22:03:56 +020045struct server *server_find_by_id(struct proxy *bk, int id);
46struct server *server_find_by_name(struct proxy *bk, const char *name);
47struct server *server_find_best_match(struct proxy *bk, char *name, int id, int *diff);
Baptiste Assmanne11cfcd2015-08-19 16:44:03 +020048void apply_server_state(void);
Willy Tarreau757478e2016-11-03 19:22:19 +010049void srv_compute_all_admin_states(struct proxy *px);
Baptiste Assmann83cbaa52016-11-02 15:34:05 +010050int srv_set_addr_via_libc(struct server *srv, int *err_code);
51int srv_init_addr(void);
Willy Tarreau21b069d2016-11-23 17:15:08 +010052struct server *cli_find_server(struct appctx *appctx, char *arg);
William Lallemand313bfd12018-10-26 14:47:32 +020053struct server *new_server(struct proxy *proxy);
Willy Tarreaubaaee002006-06-26 02:48:02 +020054
Baptiste Assmanna68ca962015-04-14 01:15:08 +020055/* functions related to server name resolution */
Olivier Houcharda8c6db82017-07-06 18:46:47 +020056int snr_update_srv_status(struct server *s, int has_no_ip);
Olivier Houchardd16bfe62017-10-31 15:21:19 +010057const char *update_server_fqdn(struct server *server, const char *fqdn, const char *updater, int dns_locked);
Baptiste Assmann201c07f2017-05-22 15:17:15 +020058int snr_resolution_cb(struct dns_requester *requester, struct dns_nameserver *nameserver);
59int snr_resolution_error_cb(struct dns_requester *requester, int error_code);
Baptiste Assmannfb7091e2017-05-03 15:43:12 +020060struct server *snr_check_ip_callback(struct server *srv, void *ip, unsigned char *ip_family);
Baptiste Assmanna68ca962015-04-14 01:15:08 +020061
Willy Tarreau7f062c42009-03-05 18:43:00 +010062/* increase the number of cumulated connections on the designated server */
63static void inline srv_inc_sess_ctr(struct server *s)
64{
Christopher Faulet29f77e82017-06-08 14:04:45 +020065 HA_ATOMIC_ADD(&s->counters.cum_sess, 1);
66 HA_ATOMIC_UPDATE_MAX(&s->counters.sps_max,
67 update_freq_ctr(&s->sess_per_sec, 1));
Willy Tarreau7f062c42009-03-05 18:43:00 +010068}
69
Bhaskar Maddalaa20cb852014-02-03 16:26:46 -050070/* set the time of last session on the designated server */
71static void inline srv_set_sess_last(struct server *s)
72{
73 s->counters.last_sess = now.tv_sec;
74}
75
Willy Tarreaubaaee002006-06-26 02:48:02 +020076/*
Willy Tarreau21faa912012-10-10 08:27:36 +020077 * Registers the server keyword list <kwl> as a list of valid keywords for next
78 * parsing sessions.
79 */
80void srv_register_keywords(struct srv_kw_list *kwl);
81
82/* Return a pointer to the server keyword <kw>, or NULL if not found. */
83struct srv_kw *srv_find_kw(const char *kw);
84
85/* Dumps all registered "server" keywords to the <out> string pointer. */
86void srv_dump_kws(char **out);
87
Willy Tarreau004e0452013-11-21 11:22:01 +010088/* Recomputes the server's eweight based on its state, uweight, the current time,
89 * and the proxy's algorihtm. To be used after updating sv->uweight. The warmup
90 * state is automatically disabled if the time is elapsed.
91 */
Willy Tarreau3ff577e2018-08-02 11:48:52 +020092void server_recalc_eweight(struct server *sv, int must_update);
Willy Tarreau004e0452013-11-21 11:22:01 +010093
Willy Tarreaud32c3992013-11-21 15:30:45 +010094/* returns the current server throttle rate between 0 and 100% */
95static inline unsigned int server_throttle_rate(struct server *sv)
96{
97 struct proxy *px = sv->proxy;
98
99 /* when uweight is 0, we're in soft-stop so that cannot be a slowstart,
100 * thus the throttle is 100%.
101 */
102 if (!sv->uweight)
103 return 100;
104
Emeric Brun52a91d32017-08-31 14:41:55 +0200105 return (100U * px->lbprm.wmult * sv->cur_eweight + px->lbprm.wdiv - 1) / (px->lbprm.wdiv * sv->uweight);
Willy Tarreaud32c3992013-11-21 15:30:45 +0100106}
107
Willy Tarreau21faa912012-10-10 08:27:36 +0200108/*
Simon Horman7d09b9a2013-02-12 10:45:51 +0900109 * Parses weight_str and configures sv accordingly.
110 * Returns NULL on success, error message string otherwise.
111 */
112const char *server_parse_weight_change_request(struct server *sv,
113 const char *weight_str);
114
115/*
Thierry Fournier09a91782016-02-24 08:25:39 +0100116 * Parses addr_str and configures sv accordingly. updater precise
117 * the source of the change in the associated message log.
Baptiste Assmann3d8f8312015-04-13 22:54:33 +0200118 * Returns NULL on success, error message string otherwise.
119 */
120const char *server_parse_addr_change_request(struct server *sv,
Thierry Fournier09a91782016-02-24 08:25:39 +0100121 const char *addr_str, const char *updater);
Baptiste Assmann3d8f8312015-04-13 22:54:33 +0200122
123/*
Nenad Merdanovic174dd372016-04-24 23:10:06 +0200124 * Parses maxconn_str and configures sv accordingly.
125 * Returns NULL on success, error message string otherwise.
126 */
127const char *server_parse_maxconn_change_request(struct server *sv,
128 const char *maxconn_str);
129
130/*
Willy Tarreau02615f92014-05-13 22:08:20 +0200131 * Return true if the server has a zero user-weight, meaning it's in draining
132 * mode (ie: not taking new non-persistent connections).
Simon Horman8c3d0be2013-11-25 10:46:40 +0900133 */
Willy Tarreau02615f92014-05-13 22:08:20 +0200134static inline int server_is_draining(const struct server *s)
Simon Horman8c3d0be2013-11-25 10:46:40 +0900135{
Emeric Brun52a91d32017-08-31 14:41:55 +0200136 return !s->uweight || (s->cur_admin & SRV_ADMF_DRAIN);
Simon Horman8c3d0be2013-11-25 10:46:40 +0900137}
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200138
139/* Shutdown all connections of a server. The caller must pass a termination
Willy Tarreaue7dff022015-04-03 01:14:29 +0200140 * code in <why>, which must be one of SF_ERR_* indicating the reason for the
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200141 * shutdown.
142 */
Thierry Fournier9f725552016-02-22 16:08:58 +0100143void srv_shutdown_streams(struct server *srv, int why);
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200144
145/* Shutdown all connections of all backup servers of a proxy. The caller must
Willy Tarreaue7dff022015-04-03 01:14:29 +0200146 * pass a termination code in <why>, which must be one of SF_ERR_* indicating
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200147 * the reason for the shutdown.
148 */
Thierry Fournier9f725552016-02-22 16:08:58 +0100149void srv_shutdown_backup_streams(struct proxy *px, int why);
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200150
Willy Tarreau83061a82018-07-13 11:56:34 +0200151void srv_append_status(struct buffer *msg, struct server *s, struct check *,
152 int xferred, int forced);
Willy Tarreaudbd5e782014-05-20 22:46:35 +0200153
Emeric Brun5a133512017-10-19 14:42:30 +0200154void srv_set_stopped(struct server *s, const char *reason, struct check *check);
155void srv_set_running(struct server *s, const char *reason, struct check *check);
156void srv_set_stopping(struct server *s, const char *reason, struct check *check);
Willy Tarreau8eb77842014-05-21 13:54:57 +0200157
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200158/* Enables admin flag <mode> (among SRV_ADMF_*) on server <s>. This is used to
159 * enforce either maint mode or drain mode. It is not allowed to set more than
160 * one flag at once. The equivalent "inherited" flag is propagated to all
161 * tracking servers. Maintenance mode disables health checks (but not agent
162 * checks). When either the flag is already set or no flag is passed, nothing
Willy Tarreau8b428482016-11-07 15:53:43 +0100163 * is done. If <cause> is non-null, it will be displayed at the end of the log
164 * lines to justify the state change.
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200165 */
Willy Tarreau8b428482016-11-07 15:53:43 +0100166void srv_set_admin_flag(struct server *s, enum srv_admin mode, const char *cause);
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200167
168/* Disables admin flag <mode> (among SRV_ADMF_*) on server <s>. This is used to
169 * stop enforcing either maint mode or drain mode. It is not allowed to set more
170 * than one flag at once. The equivalent "inherited" flag is propagated to all
171 * tracking servers. Leaving maintenance mode re-enables health checks. When
172 * either the flag is already cleared or no flag is passed, nothing is done.
173 */
174void srv_clr_admin_flag(struct server *s, enum srv_admin mode);
175
Olivier Houchard4e694042017-03-14 20:01:29 +0100176/* Calculates the dynamic persitent cookie for a server, if a secret key has
177 * been provided.
178 */
179void srv_set_dyncookie(struct server *s);
180
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200181/* Puts server <s> into maintenance mode, and propagate that status down to all
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200182 * tracking servers.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200183 */
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200184static inline void srv_adm_set_maint(struct server *s)
185{
Willy Tarreau8b428482016-11-07 15:53:43 +0100186 srv_set_admin_flag(s, SRV_ADMF_FMAINT, NULL);
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200187 srv_clr_admin_flag(s, SRV_ADMF_FDRAIN);
188}
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200189
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200190/* Puts server <s> into drain mode, and propagate that status down to all
191 * tracking servers.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200192 */
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200193static inline void srv_adm_set_drain(struct server *s)
194{
Willy Tarreau8b428482016-11-07 15:53:43 +0100195 srv_set_admin_flag(s, SRV_ADMF_FDRAIN, NULL);
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200196 srv_clr_admin_flag(s, SRV_ADMF_FMAINT);
197}
198
199/* Puts server <s> into ready mode, and propagate that status down to all
200 * tracking servers.
201 */
202static inline void srv_adm_set_ready(struct server *s)
203{
204 srv_clr_admin_flag(s, SRV_ADMF_FDRAIN);
205 srv_clr_admin_flag(s, SRV_ADMF_FMAINT);
206}
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200207
Baptiste Assmann25938272016-09-21 20:26:16 +0200208/* appends an initaddr method to the existing list. Returns 0 on failure. */
209static inline int srv_append_initaddr(unsigned int *list, enum srv_initaddr addr)
210{
211 int shift = 0;
212
213 while (shift + 3 < 32 && (*list >> shift))
214 shift += 3;
215
216 if (shift + 3 > 32)
217 return 0;
218
219 *list |= addr << shift;
220 return 1;
221}
222
Willy Tarreau25e51522016-11-04 15:10:17 +0100223/* returns the next initaddr method and removes it from <list> by shifting
224 * it right (implying that it MUST NOT be the server's. Returns SRV_IADDR_END
225 * at the end.
226 */
227static inline enum srv_initaddr srv_get_next_initaddr(unsigned int *list)
228{
229 enum srv_initaddr ret;
230
231 ret = *list & 7;
232 *list >>= 3;
233 return ret;
234}
235
Olivier Houcharda4d4fdf2018-12-14 19:27:06 +0100236static inline int srv_add_to_idle_list(struct server *srv, struct connection *conn)
237{
238 if (srv && srv->pool_purge_delay > 0 && (srv->max_idle_conns == -1 ||
239 srv->max_idle_conns > srv->curr_idle_conns) &&
240 !(conn->flags & CO_FL_PRIVATE) &&
241 ((srv->proxy->options & PR_O_REUSE_MASK) != PR_O_REUSE_NEVR) &&
242 conn->mux->avail_streams(conn) == conn->mux->max_streams(conn)) {
243 LIST_DEL(&conn->list);
244 LIST_ADDQ(&srv->idle_orphan_conns[tid], &conn->list);
245 srv->curr_idle_conns++;
246
247 conn->idle_time = now_ms;
248 if (!(task_in_wq(srv->idle_task[tid])) &&
249 !(task_in_rq(srv->idle_task[tid])))
250 task_schedule(srv->idle_task[tid],
251 tick_add(now_ms, srv->pool_purge_delay));
252 return 1;
253 }
254 return 0;
255}
256
Godbache468d552014-07-28 17:31:57 +0800257#endif /* _PROTO_SERVER_H */
258
Simon Horman8c3d0be2013-11-25 10:46:40 +0900259/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200260 * Local variables:
261 * c-indent-level: 8
262 * c-basic-offset: 8
263 * End:
264 */