blob: 43e4e425145252a1511c9fb058fa69125c321e05 [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 */
55int snr_update_srv_status(struct server *s);
Baptiste Assmann201c07f2017-05-22 15:17:15 +020056int snr_resolution_cb(struct dns_requester *requester, struct dns_nameserver *nameserver);
57int snr_resolution_error_cb(struct dns_requester *requester, int error_code);
Baptiste Assmannfb7091e2017-05-03 15:43:12 +020058struct server *snr_check_ip_callback(struct server *srv, void *ip, unsigned char *ip_family);
Baptiste Assmanna68ca962015-04-14 01:15:08 +020059
Willy Tarreau7f062c42009-03-05 18:43:00 +010060/* increase the number of cumulated connections on the designated server */
61static void inline srv_inc_sess_ctr(struct server *s)
62{
Krzysztof Piotr Oledzki052d4fd2009-10-04 14:52:57 +020063 s->counters.cum_sess++;
Willy Tarreau7f062c42009-03-05 18:43:00 +010064 update_freq_ctr(&s->sess_per_sec, 1);
Willy Tarreauac68c5d2009-10-04 23:12:44 +020065 if (s->sess_per_sec.curr_ctr > s->counters.sps_max)
66 s->counters.sps_max = s->sess_per_sec.curr_ctr;
Willy Tarreau7f062c42009-03-05 18:43:00 +010067}
68
Bhaskar Maddalaa20cb852014-02-03 16:26:46 -050069/* set the time of last session on the designated server */
70static void inline srv_set_sess_last(struct server *s)
71{
72 s->counters.last_sess = now.tv_sec;
73}
74
Willy Tarreaubaaee002006-06-26 02:48:02 +020075/*
Willy Tarreau21faa912012-10-10 08:27:36 +020076 * Registers the server keyword list <kwl> as a list of valid keywords for next
77 * parsing sessions.
78 */
79void srv_register_keywords(struct srv_kw_list *kwl);
80
81/* Return a pointer to the server keyword <kw>, or NULL if not found. */
82struct srv_kw *srv_find_kw(const char *kw);
83
84/* Dumps all registered "server" keywords to the <out> string pointer. */
85void srv_dump_kws(char **out);
86
Willy Tarreau004e0452013-11-21 11:22:01 +010087/* Recomputes the server's eweight based on its state, uweight, the current time,
88 * and the proxy's algorihtm. To be used after updating sv->uweight. The warmup
89 * state is automatically disabled if the time is elapsed.
90 */
91void server_recalc_eweight(struct server *sv);
92
Willy Tarreaud32c3992013-11-21 15:30:45 +010093/* returns the current server throttle rate between 0 and 100% */
94static inline unsigned int server_throttle_rate(struct server *sv)
95{
96 struct proxy *px = sv->proxy;
97
98 /* when uweight is 0, we're in soft-stop so that cannot be a slowstart,
99 * thus the throttle is 100%.
100 */
101 if (!sv->uweight)
102 return 100;
103
Willy Tarreaue38feed2013-12-16 18:04:57 +0100104 return (100U * px->lbprm.wmult * sv->eweight + px->lbprm.wdiv - 1) / (px->lbprm.wdiv * sv->uweight);
Willy Tarreaud32c3992013-11-21 15:30:45 +0100105}
106
Willy Tarreau21faa912012-10-10 08:27:36 +0200107/*
Simon Horman7d09b9a2013-02-12 10:45:51 +0900108 * Parses weight_str and configures sv accordingly.
109 * Returns NULL on success, error message string otherwise.
110 */
111const char *server_parse_weight_change_request(struct server *sv,
112 const char *weight_str);
113
114/*
Thierry Fournier09a91782016-02-24 08:25:39 +0100115 * Parses addr_str and configures sv accordingly. updater precise
116 * the source of the change in the associated message log.
Baptiste Assmann3d8f8312015-04-13 22:54:33 +0200117 * Returns NULL on success, error message string otherwise.
118 */
119const char *server_parse_addr_change_request(struct server *sv,
Thierry Fournier09a91782016-02-24 08:25:39 +0100120 const char *addr_str, const char *updater);
Baptiste Assmann3d8f8312015-04-13 22:54:33 +0200121
122/*
Nenad Merdanovic174dd372016-04-24 23:10:06 +0200123 * Parses maxconn_str and configures sv accordingly.
124 * Returns NULL on success, error message string otherwise.
125 */
126const char *server_parse_maxconn_change_request(struct server *sv,
127 const char *maxconn_str);
128
129/*
Willy Tarreau02615f92014-05-13 22:08:20 +0200130 * Return true if the server has a zero user-weight, meaning it's in draining
131 * mode (ie: not taking new non-persistent connections).
Simon Horman8c3d0be2013-11-25 10:46:40 +0900132 */
Willy Tarreau02615f92014-05-13 22:08:20 +0200133static inline int server_is_draining(const struct server *s)
Simon Horman8c3d0be2013-11-25 10:46:40 +0900134{
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200135 return !s->uweight || (s->admin & SRV_ADMF_DRAIN);
Simon Horman8c3d0be2013-11-25 10:46:40 +0900136}
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200137
138/* Shutdown all connections of a server. The caller must pass a termination
Willy Tarreaue7dff022015-04-03 01:14:29 +0200139 * code in <why>, which must be one of SF_ERR_* indicating the reason for the
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200140 * shutdown.
141 */
Thierry Fournier9f725552016-02-22 16:08:58 +0100142void srv_shutdown_streams(struct server *srv, int why);
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200143
144/* Shutdown all connections of all backup servers of a proxy. The caller must
Willy Tarreaue7dff022015-04-03 01:14:29 +0200145 * pass a termination code in <why>, which must be one of SF_ERR_* indicating
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200146 * the reason for the shutdown.
147 */
Thierry Fournier9f725552016-02-22 16:08:58 +0100148void srv_shutdown_backup_streams(struct proxy *px, int why);
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200149
Willy Tarreaubda92272014-05-20 21:55:30 +0200150/* Appends some information to a message string related to a server going UP or
151 * DOWN. If both <forced> and <reason> are null and the server tracks another
152 * one, a "via" information will be provided to know where the status came from.
153 * If <reason> is non-null, the entire string will be appended after a comma and
154 * a space (eg: to report some information from the check that changed the state).
155 * If <xferred> is non-negative, some information about requeued sessions are
156 * provided.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200157 */
Willy Tarreaubda92272014-05-20 21:55:30 +0200158void srv_append_status(struct chunk *msg, struct server *s, const char *reason, int xferred, int forced);
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200159
Willy Tarreaue7d1ef12014-05-20 22:25:12 +0200160/* Marks server <s> down, regardless of its checks' statuses, notifies by all
161 * available means, recounts the remaining servers on the proxy and transfers
162 * queued sessions whenever possible to other servers. It automatically
163 * recomputes the number of servers, but not the map. Maintenance servers are
164 * ignored. It reports <reason> if non-null as the reason for going down. Note
165 * that it makes use of the trash to build the log strings, so <reason> must
166 * not be placed there.
167 */
168void srv_set_stopped(struct server *s, const char *reason);
169
Willy Tarreaudbd5e782014-05-20 22:46:35 +0200170/* Marks server <s> up regardless of its checks' statuses and provided it isn't
171 * in maintenance. Notifies by all available means, recounts the remaining
172 * servers on the proxy and tries to grab requests from the proxy. It
173 * automatically recomputes the number of servers, but not the map. Maintenance
174 * servers are ignored. It reports <reason> if non-null as the reason for going
175 * up. Note that it makes use of the trash to build the log strings, so <reason>
176 * must not be placed there.
177 */
178void srv_set_running(struct server *s, const char *reason);
179
Willy Tarreau8eb77842014-05-21 13:54:57 +0200180/* Marks server <s> stopping regardless of its checks' statuses and provided it
181 * isn't in maintenance. Notifies by all available means, recounts the remaining
182 * servers on the proxy and tries to grab requests from the proxy. It
183 * automatically recomputes the number of servers, but not the map. Maintenance
184 * servers are ignored. It reports <reason> if non-null as the reason for going
185 * up. Note that it makes use of the trash to build the log strings, so <reason>
186 * must not be placed there.
187 */
188void srv_set_stopping(struct server *s, const char *reason);
189
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200190/* Enables admin flag <mode> (among SRV_ADMF_*) on server <s>. This is used to
191 * enforce either maint mode or drain mode. It is not allowed to set more than
192 * one flag at once. The equivalent "inherited" flag is propagated to all
193 * tracking servers. Maintenance mode disables health checks (but not agent
194 * checks). When either the flag is already set or no flag is passed, nothing
Willy Tarreau8b428482016-11-07 15:53:43 +0100195 * is done. If <cause> is non-null, it will be displayed at the end of the log
196 * lines to justify the state change.
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200197 */
Willy Tarreau8b428482016-11-07 15:53:43 +0100198void srv_set_admin_flag(struct server *s, enum srv_admin mode, const char *cause);
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200199
200/* Disables admin flag <mode> (among SRV_ADMF_*) on server <s>. This is used to
201 * stop enforcing either maint mode or drain mode. It is not allowed to set more
202 * than one flag at once. The equivalent "inherited" flag is propagated to all
203 * tracking servers. Leaving maintenance mode re-enables health checks. When
204 * either the flag is already cleared or no flag is passed, nothing is done.
205 */
206void srv_clr_admin_flag(struct server *s, enum srv_admin mode);
207
Olivier Houchard4e694042017-03-14 20:01:29 +0100208/* Calculates the dynamic persitent cookie for a server, if a secret key has
209 * been provided.
210 */
211void srv_set_dyncookie(struct server *s);
212
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200213/* Puts server <s> into maintenance mode, and propagate that status down to all
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200214 * tracking servers.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200215 */
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200216static inline void srv_adm_set_maint(struct server *s)
217{
Willy Tarreau8b428482016-11-07 15:53:43 +0100218 srv_set_admin_flag(s, SRV_ADMF_FMAINT, NULL);
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200219 srv_clr_admin_flag(s, SRV_ADMF_FDRAIN);
220}
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200221
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200222/* Puts server <s> into drain mode, and propagate that status down to all
223 * tracking servers.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200224 */
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200225static inline void srv_adm_set_drain(struct server *s)
226{
Willy Tarreau8b428482016-11-07 15:53:43 +0100227 srv_set_admin_flag(s, SRV_ADMF_FDRAIN, NULL);
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200228 srv_clr_admin_flag(s, SRV_ADMF_FMAINT);
229}
230
231/* Puts server <s> into ready mode, and propagate that status down to all
232 * tracking servers.
233 */
234static inline void srv_adm_set_ready(struct server *s)
235{
236 srv_clr_admin_flag(s, SRV_ADMF_FDRAIN);
237 srv_clr_admin_flag(s, SRV_ADMF_FMAINT);
238}
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200239
Baptiste Assmann25938272016-09-21 20:26:16 +0200240/* appends an initaddr method to the existing list. Returns 0 on failure. */
241static inline int srv_append_initaddr(unsigned int *list, enum srv_initaddr addr)
242{
243 int shift = 0;
244
245 while (shift + 3 < 32 && (*list >> shift))
246 shift += 3;
247
248 if (shift + 3 > 32)
249 return 0;
250
251 *list |= addr << shift;
252 return 1;
253}
254
Willy Tarreau25e51522016-11-04 15:10:17 +0100255/* returns the next initaddr method and removes it from <list> by shifting
256 * it right (implying that it MUST NOT be the server's. Returns SRV_IADDR_END
257 * at the end.
258 */
259static inline enum srv_initaddr srv_get_next_initaddr(unsigned int *list)
260{
261 enum srv_initaddr ret;
262
263 ret = *list & 7;
264 *list >>= 3;
265 return ret;
266}
267
Godbache468d552014-07-28 17:31:57 +0800268#endif /* _PROTO_SERVER_H */
269
Simon Horman8c3d0be2013-11-25 10:46:40 +0900270/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200271 * Local variables:
272 * c-indent-level: 8
273 * c-basic-offset: 8
274 * End:
275 */