blob: 71c8b1390b565e79e7721e56d4d30427be2e4cfb [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 Tarreaubaaee002006-06-26 02:48:02 +020029#include <types/proxy.h>
30#include <types/queue.h>
31#include <types/server.h>
Willy TARREAU3dc06442006-06-15 21:48:13 +020032
Willy Tarreaubaaee002006-06-26 02:48:02 +020033#include <proto/queue.h>
Bhaskar Maddalaa20cb852014-02-03 16:26:46 -050034#include <proto/log.h>
Willy Tarreau7f062c42009-03-05 18:43:00 +010035#include <proto/freq_ctr.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020036
Simon Hormana3608442013-11-01 16:46:15 +090037int srv_downtime(const struct server *s);
Bhaskar Maddalaa20cb852014-02-03 16:26:46 -050038int srv_lastsession(const struct server *s);
Simon Horman4a741432013-02-23 15:35:38 +090039int srv_getinter(const struct check *check);
Willy Tarreau272adea2014-03-31 10:39:59 +020040int parse_server(const char *file, int linenum, char **args, struct proxy *curproxy, struct proxy *defproxy);
Willy Tarreaubaaee002006-06-26 02:48:02 +020041
Willy Tarreau7f062c42009-03-05 18:43:00 +010042/* increase the number of cumulated connections on the designated server */
43static void inline srv_inc_sess_ctr(struct server *s)
44{
Krzysztof Piotr Oledzki052d4fd2009-10-04 14:52:57 +020045 s->counters.cum_sess++;
Willy Tarreau7f062c42009-03-05 18:43:00 +010046 update_freq_ctr(&s->sess_per_sec, 1);
Willy Tarreauac68c5d2009-10-04 23:12:44 +020047 if (s->sess_per_sec.curr_ctr > s->counters.sps_max)
48 s->counters.sps_max = s->sess_per_sec.curr_ctr;
Willy Tarreau7f062c42009-03-05 18:43:00 +010049}
50
Bhaskar Maddalaa20cb852014-02-03 16:26:46 -050051/* set the time of last session on the designated server */
52static void inline srv_set_sess_last(struct server *s)
53{
54 s->counters.last_sess = now.tv_sec;
55}
56
Willy Tarreaubaaee002006-06-26 02:48:02 +020057/*
Willy Tarreau21faa912012-10-10 08:27:36 +020058 * Registers the server keyword list <kwl> as a list of valid keywords for next
59 * parsing sessions.
60 */
61void srv_register_keywords(struct srv_kw_list *kwl);
62
63/* Return a pointer to the server keyword <kw>, or NULL if not found. */
64struct srv_kw *srv_find_kw(const char *kw);
65
66/* Dumps all registered "server" keywords to the <out> string pointer. */
67void srv_dump_kws(char **out);
68
Willy Tarreau004e0452013-11-21 11:22:01 +010069/* Recomputes the server's eweight based on its state, uweight, the current time,
70 * and the proxy's algorihtm. To be used after updating sv->uweight. The warmup
71 * state is automatically disabled if the time is elapsed.
72 */
73void server_recalc_eweight(struct server *sv);
74
Willy Tarreaud32c3992013-11-21 15:30:45 +010075/* returns the current server throttle rate between 0 and 100% */
76static inline unsigned int server_throttle_rate(struct server *sv)
77{
78 struct proxy *px = sv->proxy;
79
80 /* when uweight is 0, we're in soft-stop so that cannot be a slowstart,
81 * thus the throttle is 100%.
82 */
83 if (!sv->uweight)
84 return 100;
85
Willy Tarreaue38feed2013-12-16 18:04:57 +010086 return (100U * px->lbprm.wmult * sv->eweight + px->lbprm.wdiv - 1) / (px->lbprm.wdiv * sv->uweight);
Willy Tarreaud32c3992013-11-21 15:30:45 +010087}
88
Willy Tarreau21faa912012-10-10 08:27:36 +020089/*
Simon Horman7d09b9a2013-02-12 10:45:51 +090090 * Parses weight_str and configures sv accordingly.
91 * Returns NULL on success, error message string otherwise.
92 */
93const char *server_parse_weight_change_request(struct server *sv,
94 const char *weight_str);
95
96/*
Willy Tarreau02615f92014-05-13 22:08:20 +020097 * Return true if the server has a zero user-weight, meaning it's in draining
98 * mode (ie: not taking new non-persistent connections).
Simon Horman8c3d0be2013-11-25 10:46:40 +090099 */
Willy Tarreau02615f92014-05-13 22:08:20 +0200100static inline int server_is_draining(const struct server *s)
Simon Horman8c3d0be2013-11-25 10:46:40 +0900101{
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200102 return !s->uweight || (s->admin & SRV_ADMF_DRAIN);
Simon Horman8c3d0be2013-11-25 10:46:40 +0900103}
Willy Tarreau4aac7db2014-05-16 11:48:10 +0200104
105/* Shutdown all connections of a server. The caller must pass a termination
106 * code in <why>, which must be one of SN_ERR_* indicating the reason for the
107 * shutdown.
108 */
109void srv_shutdown_sessions(struct server *srv, int why);
110
111/* Shutdown all connections of all backup servers of a proxy. The caller must
112 * pass a termination code in <why>, which must be one of SN_ERR_* indicating
113 * the reason for the shutdown.
114 */
115void srv_shutdown_backup_sessions(struct proxy *px, int why);
116
Willy Tarreaubda92272014-05-20 21:55:30 +0200117/* Appends some information to a message string related to a server going UP or
118 * DOWN. If both <forced> and <reason> are null and the server tracks another
119 * one, a "via" information will be provided to know where the status came from.
120 * If <reason> is non-null, the entire string will be appended after a comma and
121 * a space (eg: to report some information from the check that changed the state).
122 * If <xferred> is non-negative, some information about requeued sessions are
123 * provided.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200124 */
Willy Tarreaubda92272014-05-20 21:55:30 +0200125void srv_append_status(struct chunk *msg, struct server *s, const char *reason, int xferred, int forced);
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200126
Willy Tarreaue7d1ef12014-05-20 22:25:12 +0200127/* Marks server <s> down, regardless of its checks' statuses, notifies by all
128 * available means, recounts the remaining servers on the proxy and transfers
129 * queued sessions whenever possible to other servers. It automatically
130 * recomputes the number of servers, but not the map. Maintenance servers are
131 * ignored. It reports <reason> if non-null as the reason for going down. Note
132 * that it makes use of the trash to build the log strings, so <reason> must
133 * not be placed there.
134 */
135void srv_set_stopped(struct server *s, const char *reason);
136
Willy Tarreaudbd5e782014-05-20 22:46:35 +0200137/* Marks server <s> up regardless of its checks' statuses and provided it isn't
138 * in maintenance. Notifies by all available means, recounts the remaining
139 * servers on the proxy and tries to grab requests from the proxy. It
140 * automatically recomputes the number of servers, but not the map. Maintenance
141 * servers are ignored. It reports <reason> if non-null as the reason for going
142 * up. Note that it makes use of the trash to build the log strings, so <reason>
143 * must not be placed there.
144 */
145void srv_set_running(struct server *s, const char *reason);
146
Willy Tarreau8eb77842014-05-21 13:54:57 +0200147/* Marks server <s> stopping regardless of its checks' statuses and provided it
148 * isn't in maintenance. Notifies by all available means, recounts the remaining
149 * servers on the proxy and tries to grab requests from the proxy. It
150 * automatically recomputes the number of servers, but not the map. Maintenance
151 * servers are ignored. It reports <reason> if non-null as the reason for going
152 * up. Note that it makes use of the trash to build the log strings, so <reason>
153 * must not be placed there.
154 */
155void srv_set_stopping(struct server *s, const char *reason);
156
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200157/* Enables admin flag <mode> (among SRV_ADMF_*) on server <s>. This is used to
158 * enforce either maint mode or drain mode. It is not allowed to set more than
159 * one flag at once. The equivalent "inherited" flag is propagated to all
160 * tracking servers. Maintenance mode disables health checks (but not agent
161 * checks). When either the flag is already set or no flag is passed, nothing
162 * is done.
163 */
164void srv_set_admin_flag(struct server *s, enum srv_admin mode);
165
166/* Disables admin flag <mode> (among SRV_ADMF_*) on server <s>. This is used to
167 * stop enforcing either maint mode or drain mode. It is not allowed to set more
168 * than one flag at once. The equivalent "inherited" flag is propagated to all
169 * tracking servers. Leaving maintenance mode re-enables health checks. When
170 * either the flag is already cleared or no flag is passed, nothing is done.
171 */
172void srv_clr_admin_flag(struct server *s, enum srv_admin mode);
173
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200174/* Puts server <s> into maintenance mode, and propagate that status down to all
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200175 * tracking servers.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200176 */
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200177static inline void srv_adm_set_maint(struct server *s)
178{
179 srv_set_admin_flag(s, SRV_ADMF_FMAINT);
180 srv_clr_admin_flag(s, SRV_ADMF_FDRAIN);
181}
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200182
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200183/* Puts server <s> into drain mode, and propagate that status down to all
184 * tracking servers.
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200185 */
Willy Tarreaubfc7b7a2014-05-22 16:14:34 +0200186static inline void srv_adm_set_drain(struct server *s)
187{
188 srv_set_admin_flag(s, SRV_ADMF_FDRAIN);
189 srv_clr_admin_flag(s, SRV_ADMF_FMAINT);
190}
191
192/* Puts server <s> into ready mode, and propagate that status down to all
193 * tracking servers.
194 */
195static inline void srv_adm_set_ready(struct server *s)
196{
197 srv_clr_admin_flag(s, SRV_ADMF_FDRAIN);
198 srv_clr_admin_flag(s, SRV_ADMF_FMAINT);
199}
Willy Tarreaua0066dd2014-05-16 11:25:16 +0200200
Godbachad65af72014-07-28 17:31:57 +0800201#endif /* _PROTO_SERVER_H */
202
Simon Horman8c3d0be2013-11-25 10:46:40 +0900203/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200204 * Local variables:
205 * c-indent-level: 8
206 * c-basic-offset: 8
207 * End:
208 */