blob: 0b238a5c7651fda60b6022f387527e7b1adb8dd9 [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);
Willy Tarreaubaaee002006-06-26 02:48:02 +020053
Baptiste Assmanna68ca962015-04-14 01:15:08 +020054/* functions related to server name resolution */
Olivier Houcharda8c6db82017-07-06 18:46:47 +020055int snr_update_srv_status(struct server *s, int has_no_ip);
Olivier Houchard8da5f982017-08-04 18:35:36 +020056const char *update_server_fqdn(struct server *server, const char *fqdn, const char *updater);
Baptiste Assmann201c07f2017-05-22 15:17:15 +020057int snr_resolution_cb(struct dns_requester *requester, struct dns_nameserver *nameserver);
58int snr_resolution_error_cb(struct dns_requester *requester, int error_code);
Baptiste Assmannfb7091e2017-05-03 15:43:12 +020059struct server *snr_check_ip_callback(struct server *srv, void *ip, unsigned char *ip_family);
Baptiste Assmann747359e2017-08-14 10:37:46 +020060void srv_free_from_resolution(struct server *srv);
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{
Krzysztof Piotr Oledzki052d4fd2009-10-04 14:52:57 +020065 s->counters.cum_sess++;
Willy Tarreau7f062c42009-03-05 18:43:00 +010066 update_freq_ctr(&s->sess_per_sec, 1);
Willy Tarreauac68c5d2009-10-04 23:12:44 +020067 if (s->sess_per_sec.curr_ctr > s->counters.sps_max)
68 s->counters.sps_max = s->sess_per_sec.curr_ctr;
Willy Tarreau7f062c42009-03-05 18:43:00 +010069}
70
Bhaskar Maddalaa20cb852014-02-03 16:26:46 -050071/* set the time of last session on the designated server */
72static void inline srv_set_sess_last(struct server *s)
73{
74 s->counters.last_sess = now.tv_sec;
75}
76
Willy Tarreaubaaee002006-06-26 02:48:02 +020077/*
Willy Tarreau21faa912012-10-10 08:27:36 +020078 * Registers the server keyword list <kwl> as a list of valid keywords for next
79 * parsing sessions.
80 */
81void srv_register_keywords(struct srv_kw_list *kwl);
82
83/* Return a pointer to the server keyword <kw>, or NULL if not found. */
84struct srv_kw *srv_find_kw(const char *kw);
85
86/* Dumps all registered "server" keywords to the <out> string pointer. */
87void srv_dump_kws(char **out);
88
Willy Tarreau004e0452013-11-21 11:22:01 +010089/* Recomputes the server's eweight based on its state, uweight, the current time,
90 * and the proxy's algorihtm. To be used after updating sv->uweight. The warmup
91 * state is automatically disabled if the time is elapsed.
92 */
93void server_recalc_eweight(struct server *sv);
94
Willy Tarreaud32c3992013-11-21 15:30:45 +010095/* returns the current server throttle rate between 0 and 100% */
96static inline unsigned int server_throttle_rate(struct server *sv)
97{
98 struct proxy *px = sv->proxy;
99
100 /* when uweight is 0, we're in soft-stop so that cannot be a slowstart,
101 * thus the throttle is 100%.
102 */
103 if (!sv->uweight)
104 return 100;
105
Emeric Brun52a91d32017-08-31 14:41:55 +0200106 return (100U * px->lbprm.wmult * sv->cur_eweight + px->lbprm.wdiv - 1) / (px->lbprm.wdiv * sv->uweight);
Willy Tarreaud32c3992013-11-21 15:30:45 +0100107}
108
Willy Tarreau21faa912012-10-10 08:27:36 +0200109/*
Simon Horman7d09b9a2013-02-12 10:45:51 +0900110 * Parses weight_str and configures sv accordingly.
111 * Returns NULL on success, error message string otherwise.
112 */
113const char *server_parse_weight_change_request(struct server *sv,
114 const char *weight_str);
115
116/*
Thierry Fournier09a91782016-02-24 08:25:39 +0100117 * Parses addr_str and configures sv accordingly. updater precise
118 * the source of the change in the associated message log.
Baptiste Assmann3d8f8312015-04-13 22:54:33 +0200119 * Returns NULL on success, error message string otherwise.
120 */
121const char *server_parse_addr_change_request(struct server *sv,
Thierry Fournier09a91782016-02-24 08:25:39 +0100122 const char *addr_str, const char *updater);
Baptiste Assmann3d8f8312015-04-13 22:54:33 +0200123
124/*
Nenad Merdanovic174dd372016-04-24 23:10:06 +0200125 * Parses maxconn_str and configures sv accordingly.
126 * Returns NULL on success, error message string otherwise.
127 */
128const char *server_parse_maxconn_change_request(struct server *sv,
129 const char *maxconn_str);
130
131/*
Willy Tarreau02615f92014-05-13 22:08:20 +0200132 * Return true if the server has a zero user-weight, meaning it's in draining
133 * mode (ie: not taking new non-persistent connections).
Simon Horman8c3d0be2013-11-25 10:46:40 +0900134 */
Willy Tarreau02615f92014-05-13 22:08:20 +0200135static inline int server_is_draining(const struct server *s)
Simon Horman8c3d0be2013-11-25 10:46:40 +0900136{
Emeric Brun52a91d32017-08-31 14:41:55 +0200137 return !s->uweight || (s->cur_admin & SRV_ADMF_DRAIN);
Simon Horman8c3d0be2013-11-25 10:46:40 +0900138}
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200139
140/* Shutdown all connections of a server. The caller must pass a termination
Willy Tarreaue7dff022015-04-03 01:14:29 +0200141 * code in <why>, which must be one of SF_ERR_* indicating the reason for the
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200142 * shutdown.
143 */
Thierry Fournier9f725552016-02-22 16:08:58 +0100144void srv_shutdown_streams(struct server *srv, int why);
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200145
146/* Shutdown all connections of all backup servers of a proxy. The caller must
Willy Tarreaue7dff022015-04-03 01:14:29 +0200147 * pass a termination code in <why>, which must be one of SF_ERR_* indicating
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200148 * the reason for the shutdown.
149 */
Thierry Fournier9f725552016-02-22 16:08:58 +0100150void srv_shutdown_backup_streams(struct proxy *px, int why);
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200151
Willy Tarreaubda92272014-05-20 21:55:30 +0200152/* Appends some information to a message string related to a server going UP or
153 * DOWN. If both <forced> and <reason> are null and the server tracks another
154 * one, a "via" information will be provided to know where the status came from.
155 * If <reason> is non-null, the entire string will be appended after a comma and
156 * a space (eg: to report some information from the check that changed the state).
157 * If <xferred> is non-negative, some information about requeued sessions are
158 * provided.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200159 */
Willy Tarreaubda92272014-05-20 21:55:30 +0200160void srv_append_status(struct chunk *msg, struct server *s, const char *reason, int xferred, int forced);
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200161
Willy Tarreaue7d1ef12014-05-20 22:25:12 +0200162/* Marks server <s> down, regardless of its checks' statuses, notifies by all
163 * available means, recounts the remaining servers on the proxy and transfers
164 * queued sessions whenever possible to other servers. It automatically
165 * recomputes the number of servers, but not the map. Maintenance servers are
166 * ignored. It reports <reason> if non-null as the reason for going down. Note
167 * that it makes use of the trash to build the log strings, so <reason> must
168 * not be placed there.
169 */
170void srv_set_stopped(struct server *s, const char *reason);
171
Willy Tarreaudbd5e782014-05-20 22:46:35 +0200172/* Marks server <s> up regardless of its checks' statuses and provided it isn't
173 * in maintenance. Notifies by all available means, recounts the remaining
174 * servers on the proxy and tries to grab requests from the proxy. It
175 * automatically recomputes the number of servers, but not the map. Maintenance
176 * servers are ignored. It reports <reason> if non-null as the reason for going
177 * up. Note that it makes use of the trash to build the log strings, so <reason>
178 * must not be placed there.
179 */
180void srv_set_running(struct server *s, const char *reason);
181
Willy Tarreau8eb77842014-05-21 13:54:57 +0200182/* Marks server <s> stopping regardless of its checks' statuses and provided it
183 * isn't in maintenance. Notifies by all available means, recounts the remaining
184 * servers on the proxy and tries to grab requests from the proxy. It
185 * automatically recomputes the number of servers, but not the map. Maintenance
186 * servers are ignored. It reports <reason> if non-null as the reason for going
187 * up. Note that it makes use of the trash to build the log strings, so <reason>
188 * must not be placed there.
189 */
190void srv_set_stopping(struct server *s, const char *reason);
191
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200192/* Enables admin flag <mode> (among SRV_ADMF_*) on server <s>. This is used to
193 * enforce either maint mode or drain mode. It is not allowed to set more than
194 * one flag at once. The equivalent "inherited" flag is propagated to all
195 * tracking servers. Maintenance mode disables health checks (but not agent
196 * checks). When either the flag is already set or no flag is passed, nothing
Willy Tarreau8b428482016-11-07 15:53:43 +0100197 * is done. If <cause> is non-null, it will be displayed at the end of the log
198 * lines to justify the state change.
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200199 */
Willy Tarreau8b428482016-11-07 15:53:43 +0100200void srv_set_admin_flag(struct server *s, enum srv_admin mode, const char *cause);
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200201
202/* Disables admin flag <mode> (among SRV_ADMF_*) on server <s>. This is used to
203 * stop enforcing either maint mode or drain mode. It is not allowed to set more
204 * than one flag at once. The equivalent "inherited" flag is propagated to all
205 * tracking servers. Leaving maintenance mode re-enables health checks. When
206 * either the flag is already cleared or no flag is passed, nothing is done.
207 */
208void srv_clr_admin_flag(struct server *s, enum srv_admin mode);
209
Olivier Houchard4e694042017-03-14 20:01:29 +0100210/* Calculates the dynamic persitent cookie for a server, if a secret key has
211 * been provided.
212 */
213void srv_set_dyncookie(struct server *s);
214
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200215/* Puts server <s> into maintenance mode, and propagate that status down to all
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200216 * tracking servers.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200217 */
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200218static inline void srv_adm_set_maint(struct server *s)
219{
Willy Tarreau8b428482016-11-07 15:53:43 +0100220 srv_set_admin_flag(s, SRV_ADMF_FMAINT, NULL);
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200221 srv_clr_admin_flag(s, SRV_ADMF_FDRAIN);
222}
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200223
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200224/* Puts server <s> into drain mode, and propagate that status down to all
225 * tracking servers.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200226 */
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200227static inline void srv_adm_set_drain(struct server *s)
228{
Willy Tarreau8b428482016-11-07 15:53:43 +0100229 srv_set_admin_flag(s, SRV_ADMF_FDRAIN, NULL);
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200230 srv_clr_admin_flag(s, SRV_ADMF_FMAINT);
231}
232
233/* Puts server <s> into ready mode, and propagate that status down to all
234 * tracking servers.
235 */
236static inline void srv_adm_set_ready(struct server *s)
237{
238 srv_clr_admin_flag(s, SRV_ADMF_FDRAIN);
239 srv_clr_admin_flag(s, SRV_ADMF_FMAINT);
240}
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200241
Baptiste Assmann25938272016-09-21 20:26:16 +0200242/* appends an initaddr method to the existing list. Returns 0 on failure. */
243static inline int srv_append_initaddr(unsigned int *list, enum srv_initaddr addr)
244{
245 int shift = 0;
246
247 while (shift + 3 < 32 && (*list >> shift))
248 shift += 3;
249
250 if (shift + 3 > 32)
251 return 0;
252
253 *list |= addr << shift;
254 return 1;
255}
256
Willy Tarreau25e51522016-11-04 15:10:17 +0100257/* returns the next initaddr method and removes it from <list> by shifting
258 * it right (implying that it MUST NOT be the server's. Returns SRV_IADDR_END
259 * at the end.
260 */
261static inline enum srv_initaddr srv_get_next_initaddr(unsigned int *list)
262{
263 enum srv_initaddr ret;
264
265 ret = *list & 7;
266 *list >>= 3;
267 return ret;
268}
269
Godbache468d552014-07-28 17:31:57 +0800270#endif /* _PROTO_SERVER_H */
271
Simon Horman8c3d0be2013-11-25 10:46:40 +0900272/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200273 * Local variables:
274 * c-indent-level: 8
275 * c-basic-offset: 8
276 * End:
277 */