blob: 74858702523ba4694d2cc6f574e8d7b28fc8502f [file] [log] [blame]
Willy Tarreaud1d54542012-09-12 22:58:11 +02001/*
2 * Protocol registration functions.
3 *
4 * Copyright 2000-2012 Willy Tarreau <w@1wt.eu>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
Willy Tarreaua6e3be72016-08-10 18:24:48 +020013#include <sys/types.h>
Willy Tarreaub550d002015-02-20 16:53:25 +010014#include <sys/socket.h>
15
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020016#include <haproxy/api.h>
Willy Tarreau8d366972020-05-27 16:10:29 +020017#include <haproxy/errors.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020018#include <haproxy/list.h>
Willy Tarreau94320852020-09-01 18:48:35 +020019#include <haproxy/listener.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020020#include <haproxy/protocol.h>
Willy Tarreaue91bff22020-09-02 11:11:43 +020021#include <haproxy/proxy.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020022#include <haproxy/tools.h>
Willy Tarreaud1d54542012-09-12 22:58:11 +020023
Willy Tarreaud1d54542012-09-12 22:58:11 +020024
25/* List head of all registered protocols */
26static struct list protocols = LIST_HEAD_INIT(protocols);
William Lallemand2d3f8a42018-09-11 16:51:28 +020027struct protocol *__protocol_by_family[AF_CUST_MAX] = { };
Willy Tarreaud1d54542012-09-12 22:58:11 +020028
Willy Tarreaudaacf362019-07-24 16:45:02 +020029/* This is the global spinlock we may need to register/unregister listeners or
30 * protocols. Its main purpose is in fact to serialize the rare stop/deinit()
31 * phases.
32 */
33__decl_spinlock(proto_lock);
34
Willy Tarreaud1d54542012-09-12 22:58:11 +020035/* Registers the protocol <proto> */
36void protocol_register(struct protocol *proto)
37{
Willy Tarreaudaacf362019-07-24 16:45:02 +020038 HA_SPIN_LOCK(PROTO_LOCK, &proto_lock);
Willy Tarreaud1d54542012-09-12 22:58:11 +020039 LIST_ADDQ(&protocols, &proto->list);
William Lallemand2d3f8a42018-09-11 16:51:28 +020040 if (proto->sock_domain >= 0 && proto->sock_domain < AF_CUST_MAX)
Willy Tarreaub550d002015-02-20 16:53:25 +010041 __protocol_by_family[proto->sock_domain] = proto;
Willy Tarreaudaacf362019-07-24 16:45:02 +020042 HA_SPIN_UNLOCK(PROTO_LOCK, &proto_lock);
Willy Tarreaud1d54542012-09-12 22:58:11 +020043}
44
45/* Unregisters the protocol <proto>. Note that all listeners must have
46 * previously been unbound.
47 */
48void protocol_unregister(struct protocol *proto)
49{
Willy Tarreaudaacf362019-07-24 16:45:02 +020050 HA_SPIN_LOCK(PROTO_LOCK, &proto_lock);
Willy Tarreaud1d54542012-09-12 22:58:11 +020051 LIST_DEL(&proto->list);
52 LIST_INIT(&proto->list);
Willy Tarreaudaacf362019-07-24 16:45:02 +020053 HA_SPIN_UNLOCK(PROTO_LOCK, &proto_lock);
Willy Tarreaud1d54542012-09-12 22:58:11 +020054}
55
56/* binds all listeners of all registered protocols. Returns a composition
57 * of ERR_NONE, ERR_RETRYABLE, ERR_FATAL.
58 */
Willy Tarreaue91bff22020-09-02 11:11:43 +020059int protocol_bind_all(int verbose)
Willy Tarreaud1d54542012-09-12 22:58:11 +020060{
61 struct protocol *proto;
Willy Tarreau94320852020-09-01 18:48:35 +020062 struct listener *listener;
Willy Tarreaufc974882020-09-02 18:22:11 +020063 struct receiver *receiver;
Willy Tarreaue91bff22020-09-02 11:11:43 +020064 char msg[100];
Willy Tarreaufc974882020-09-02 18:22:11 +020065 char *errmsg;
66 void *handler;
Willy Tarreaue91bff22020-09-02 11:11:43 +020067 int err, lerr;
Willy Tarreaud1d54542012-09-12 22:58:11 +020068
69 err = 0;
Willy Tarreaudaacf362019-07-24 16:45:02 +020070 HA_SPIN_LOCK(PROTO_LOCK, &proto_lock);
Willy Tarreaud1d54542012-09-12 22:58:11 +020071 list_for_each_entry(proto, &protocols, list) {
Willy Tarreaufc974882020-09-02 18:22:11 +020072 list_for_each_entry(receiver, &proto->listeners, proto_list) {
73 listener = LIST_ELEM(receiver, struct listener *, rx);
74
75 /* FIXME: horrible hack, we don't have a way to register
76 * a handler when creating the receiver yet, so we still
77 * have to take care of special cases here.
78 */
79 handler = listener->rx.proto->accept;
80 if (!handler && listener->bind_conf->frontend->mode == PR_MODE_SYSLOG) {
81 extern void syslog_fd_handler(int);
82 handler = syslog_fd_handler;
83 }
84
Willy Tarreauf1f66092020-09-04 08:15:31 +020085 lerr = proto->fam->bind(receiver, handler, &errmsg);
Willy Tarreaufc974882020-09-02 18:22:11 +020086 err |= lerr;
Willy Tarreaue91bff22020-09-02 11:11:43 +020087
88 /* errors are reported if <verbose> is set or if they are fatal */
89 if (verbose || (lerr & (ERR_FATAL | ERR_ABORT))) {
90 struct proxy *px = listener->bind_conf->frontend;
91
92 if (lerr & ERR_ALERT)
93 ha_alert("Starting %s %s: %s\n",
Willy Tarreaufc974882020-09-02 18:22:11 +020094 proxy_type_str(px), px->id, errmsg);
Willy Tarreaue91bff22020-09-02 11:11:43 +020095 else if (lerr & ERR_WARN)
96 ha_warning("Starting %s %s: %s\n",
Willy Tarreaufc974882020-09-02 18:22:11 +020097 proxy_type_str(px), px->id, errmsg);
98 free(errmsg); errmsg = NULL;
Willy Tarreaue91bff22020-09-02 11:11:43 +020099 }
Willy Tarreaufc974882020-09-02 18:22:11 +0200100 if (lerr & ERR_ABORT)
101 break;
Willy Tarreaue91bff22020-09-02 11:11:43 +0200102
Willy Tarreaufc974882020-09-02 18:22:11 +0200103 if (lerr & ~ERR_WARN)
104 continue;
105
106 /* for now there's still always a listening function */
107 BUG_ON(!proto->listen);
108 lerr = proto->listen(listener, msg, sizeof(msg));
Willy Tarreaue91bff22020-09-02 11:11:43 +0200109 err |= lerr;
Willy Tarreaufc974882020-09-02 18:22:11 +0200110
111 if (verbose || (lerr & (ERR_FATAL | ERR_ABORT))) {
112 struct proxy *px = listener->bind_conf->frontend;
113
114 if (lerr & ERR_ALERT)
115 ha_alert("Starting %s %s: %s\n",
116 proxy_type_str(px), px->id, msg);
117 else if (lerr & ERR_WARN)
118 ha_warning("Starting %s %s: %s\n",
119 proxy_type_str(px), px->id, msg);
120 }
Willy Tarreaue91bff22020-09-02 11:11:43 +0200121 if (lerr & ERR_ABORT)
Willy Tarreaud1d54542012-09-12 22:58:11 +0200122 break;
123 }
Willy Tarreaue91bff22020-09-02 11:11:43 +0200124 if (err & ERR_ABORT)
125 break;
Willy Tarreaud1d54542012-09-12 22:58:11 +0200126 }
Willy Tarreaudaacf362019-07-24 16:45:02 +0200127 HA_SPIN_UNLOCK(PROTO_LOCK, &proto_lock);
Willy Tarreaud1d54542012-09-12 22:58:11 +0200128 return err;
129}
130
131/* unbinds all listeners of all registered protocols. They are also closed.
132 * This must be performed before calling exit() in order to get a chance to
133 * remove file-system based sockets and pipes.
134 * Returns a composition of ERR_NONE, ERR_RETRYABLE, ERR_FATAL, ERR_ABORT.
135 */
136int protocol_unbind_all(void)
137{
138 struct protocol *proto;
Willy Tarreauca212622020-09-02 10:31:31 +0200139 struct listener *listener;
Willy Tarreaud1d54542012-09-12 22:58:11 +0200140 int err;
141
142 err = 0;
Willy Tarreaudaacf362019-07-24 16:45:02 +0200143 HA_SPIN_LOCK(PROTO_LOCK, &proto_lock);
Willy Tarreaud1d54542012-09-12 22:58:11 +0200144 list_for_each_entry(proto, &protocols, list) {
Willy Tarreaub7436612020-08-28 19:51:44 +0200145 list_for_each_entry(listener, &proto->listeners, rx.proto_list)
Willy Tarreauca212622020-09-02 10:31:31 +0200146 unbind_listener(listener);
Willy Tarreaud1d54542012-09-12 22:58:11 +0200147 }
Willy Tarreaudaacf362019-07-24 16:45:02 +0200148 HA_SPIN_UNLOCK(PROTO_LOCK, &proto_lock);
Willy Tarreaud1d54542012-09-12 22:58:11 +0200149 return err;
150}
151
152/* enables all listeners of all registered protocols. This is intended to be
153 * used after a fork() to enable reading on all file descriptors. Returns a
154 * composition of ERR_NONE, ERR_RETRYABLE, ERR_FATAL.
155 */
156int protocol_enable_all(void)
157{
158 struct protocol *proto;
159 int err;
160
161 err = 0;
Willy Tarreaudaacf362019-07-24 16:45:02 +0200162 HA_SPIN_LOCK(PROTO_LOCK, &proto_lock);
Willy Tarreaud1d54542012-09-12 22:58:11 +0200163 list_for_each_entry(proto, &protocols, list) {
164 if (proto->enable_all) {
165 err |= proto->enable_all(proto);
166 }
167 }
Willy Tarreaudaacf362019-07-24 16:45:02 +0200168 HA_SPIN_UNLOCK(PROTO_LOCK, &proto_lock);
Willy Tarreaud1d54542012-09-12 22:58:11 +0200169 return err;
170}
171
172/* disables all listeners of all registered protocols. This may be used before
173 * a fork() to avoid duplicating poll lists. Returns a composition of ERR_NONE,
174 * ERR_RETRYABLE, ERR_FATAL.
175 */
176int protocol_disable_all(void)
177{
178 struct protocol *proto;
179 int err;
180
181 err = 0;
Willy Tarreaudaacf362019-07-24 16:45:02 +0200182 HA_SPIN_LOCK(PROTO_LOCK, &proto_lock);
Willy Tarreaud1d54542012-09-12 22:58:11 +0200183 list_for_each_entry(proto, &protocols, list) {
184 if (proto->disable_all) {
185 err |= proto->disable_all(proto);
186 }
187 }
Willy Tarreaudaacf362019-07-24 16:45:02 +0200188 HA_SPIN_UNLOCK(PROTO_LOCK, &proto_lock);
Willy Tarreaud1d54542012-09-12 22:58:11 +0200189 return err;
190}
191
Willy Tarreaud1d54542012-09-12 22:58:11 +0200192/*
193 * Local variables:
194 * c-indent-level: 8
195 * c-basic-offset: 8
196 * End:
197 */