1 /*
2 * include/proto/proxy.h
3 * This file defines function prototypes for proxy management.
4 *
5 * Copyright (C) 2000-2011 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 */
21
22 #ifndef _PROTO_PROXY_H
23 #define _PROTO_PROXY_H
24
25 #include <common/config.h>
26 #include <common/ticks.h>
27 #include <common/time.h>
28 #include <types/applet.h>
29 #include <types/global.h>
30 #include <types/proxy.h>
31 #include <types/listener.h>
32 #include <proto/freq_ctr.h>
33
34 extern struct proxy *proxies_list;
35 extern struct eb_root used_proxy_id; /* list of proxy IDs in use */
36 extern unsigned int error_snapshot_id; /* global ID assigned to each error then incremented */
37 extern struct eb_root proxy_by_name; /* tree of proxies sorted by name */
38
39 int start_proxies(int verbose);
40 struct task *manage_proxy(struct task *t);
41 void soft_stop(void);
42 int pause_proxy(struct proxy *p);
43 int resume_proxy(struct proxy *p);
44 void stop_proxy(struct proxy *p);
45 void zombify_proxy(struct proxy *p);
46 void pause_proxies(void);
47 void resume_proxies(void);
48 int stream_set_backend(struct stream *s, struct proxy *be);
49
50 const char *proxy_cap_str(int cap);
51 const char *proxy_mode_str(int mode);
52 void proxy_store_name(struct proxy *px);
53 struct proxy *proxy_find_by_id(int id, int cap, int table);
54 struct proxy *proxy_find_by_name(const char *name, int cap, int table);
55 struct proxy *proxy_find_best_match(int cap, const char *name, int id, int *diff);
56 struct server *findserver(const struct proxy *px, const char *name);
57 int proxy_cfg_ensure_no_http(struct proxy *curproxy);
58 void init_new_proxy(struct proxy *p);
59 int get_backend_server(const char *bk_name, const char *sv_name,
60 struct proxy **bk, struct server **sv);
61 struct proxy *cli_find_frontend(struct appctx *appctx, const char *arg);
62 struct proxy *cli_find_frontend(struct appctx *appctx, const char *arg);
63
64 /*
65 * This function returns a string containing the type of the proxy in a format
66 * suitable for error messages, from its capabilities.
67 */
proxy_type_str(struct proxy * proxy)68 static inline const char *proxy_type_str(struct proxy *proxy)
69 {
70 return proxy_cap_str(proxy->cap);
71 }
72
73 /* Find the frontend having name <name>. The name may also start with a '#' to
74 * reference a numeric id. NULL is returned if not found.
75 */
proxy_fe_by_name(const char * name)76 static inline struct proxy *proxy_fe_by_name(const char *name)
77 {
78 return proxy_find_by_name(name, PR_CAP_FE, 0);
79 }
80
81 /* Find the backend having name <name>. The name may also start with a '#' to
82 * reference a numeric id. NULL is returned if not found.
83 */
proxy_be_by_name(const char * name)84 static inline struct proxy *proxy_be_by_name(const char *name)
85 {
86 return proxy_find_by_name(name, PR_CAP_BE, 0);
87 }
88
89 /* Find the table having name <name>. The name may also start with a '#' to
90 * reference a numeric id. NULL is returned if not found.
91 */
proxy_tbl_by_name(const char * name)92 static inline struct proxy *proxy_tbl_by_name(const char *name)
93 {
94 return proxy_find_by_name(name, 0, 1);
95 }
96
97 /* this function initializes all timeouts for proxy p */
proxy_reset_timeouts(struct proxy * proxy)98 static inline void proxy_reset_timeouts(struct proxy *proxy)
99 {
100 proxy->timeout.client = TICK_ETERNITY;
101 proxy->timeout.tarpit = TICK_ETERNITY;
102 proxy->timeout.queue = TICK_ETERNITY;
103 proxy->timeout.connect = TICK_ETERNITY;
104 proxy->timeout.server = TICK_ETERNITY;
105 proxy->timeout.httpreq = TICK_ETERNITY;
106 proxy->timeout.check = TICK_ETERNITY;
107 proxy->timeout.tunnel = TICK_ETERNITY;
108 }
109
110 /* increase the number of cumulated connections received on the designated frontend */
proxy_inc_fe_conn_ctr(struct listener * l,struct proxy * fe)111 static void inline proxy_inc_fe_conn_ctr(struct listener *l, struct proxy *fe)
112 {
113 HA_ATOMIC_ADD(&fe->fe_counters.cum_conn, 1);
114 if (l && l->counters)
115 HA_ATOMIC_ADD(&l->counters->cum_conn, 1);
116 HA_ATOMIC_UPDATE_MAX(&fe->fe_counters.cps_max,
117 update_freq_ctr(&fe->fe_conn_per_sec, 1));
118 }
119
120 /* increase the number of cumulated connections accepted by the designated frontend */
proxy_inc_fe_sess_ctr(struct listener * l,struct proxy * fe)121 static void inline proxy_inc_fe_sess_ctr(struct listener *l, struct proxy *fe)
122 {
123
124 HA_ATOMIC_ADD(&fe->fe_counters.cum_sess, 1);
125 if (l && l->counters)
126 HA_ATOMIC_ADD(&l->counters->cum_sess, 1);
127 HA_ATOMIC_UPDATE_MAX(&fe->fe_counters.sps_max,
128 update_freq_ctr(&fe->fe_sess_per_sec, 1));
129 }
130
131 /* increase the number of cumulated connections on the designated backend */
proxy_inc_be_ctr(struct proxy * be)132 static void inline proxy_inc_be_ctr(struct proxy *be)
133 {
134 HA_ATOMIC_ADD(&be->be_counters.cum_conn, 1);
135 HA_ATOMIC_UPDATE_MAX(&be->be_counters.sps_max,
136 update_freq_ctr(&be->be_sess_per_sec, 1));
137 }
138
139 /* increase the number of cumulated requests on the designated frontend */
proxy_inc_fe_req_ctr(struct proxy * fe)140 static void inline proxy_inc_fe_req_ctr(struct proxy *fe)
141 {
142 HA_ATOMIC_ADD(&fe->fe_counters.p.http.cum_req, 1);
143 HA_ATOMIC_UPDATE_MAX(&fe->fe_counters.p.http.rps_max,
144 update_freq_ctr(&fe->fe_req_per_sec, 1));
145 }
146
147 #endif /* _PROTO_PROXY_H */
148
149 /*
150 * Local variables:
151 * c-indent-level: 8
152 * c-basic-offset: 8
153 * End:
154 */
155