mirror of
https://git.haproxy.org/git/haproxy.git/
synced 2025-08-09 16:47:18 +02:00
a7b04e383a
Add a new parameter "alt" that will store wether this configuration use an alternate protocol. This alt pointer will contain a value that can be transparently passed to protocol_lookup to obtain an appropriate protocol structure. This change is needed to allow for example the servers to know if it need to use an alternate protocol or not.
135 lines
4.8 KiB
C
135 lines
4.8 KiB
C
/*
|
|
* include/haproxy/protocol.h
|
|
* This file declares generic protocol management primitives.
|
|
*
|
|
* Copyright (C) 2000-2020 Willy Tarreau - w@1wt.eu
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation, version 2.1
|
|
* exclusively.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef _HAPROXY_PROTOCOL_H
|
|
#define _HAPROXY_PROTOCOL_H
|
|
|
|
#include <sys/socket.h>
|
|
#include <haproxy/protocol-t.h>
|
|
#include <haproxy/thread.h>
|
|
|
|
/* [AF][sock_dgram][ctrl_dgram] */
|
|
extern struct protocol *__protocol_by_family[AF_CUST_MAX][PROTO_NUM_TYPES][2];
|
|
extern const struct proto_fam *__proto_fam_by_family[AF_CUST_MAX];
|
|
__decl_thread(extern HA_SPINLOCK_T proto_lock);
|
|
|
|
/* Registers the protocol <proto> */
|
|
void protocol_register(struct protocol *proto);
|
|
|
|
/* Unregisters the protocol <proto>. Note that all listeners must have
|
|
* previously been unbound.
|
|
*/
|
|
void protocol_unregister(struct protocol *proto);
|
|
|
|
/* clears flag <flag> on all protocols. */
|
|
void protocol_clrf_all(uint flag);
|
|
|
|
/* sets flag <flag> on all protocols. */
|
|
void protocol_setf_all(uint flag);
|
|
|
|
/* Checks if protocol <proto> supports PROTO_F flag <flag>. Returns zero if not,
|
|
* non-zero if supported. It may return a cached value from a previous test,
|
|
* and may run live tests then update the proto's flags to cache a result. It's
|
|
* better to call it only if needed so that it doesn't result in modules being
|
|
* loaded in case of a live test.
|
|
*/
|
|
int protocol_supports_flag(struct protocol *proto, uint flag);
|
|
|
|
/* binds all listeners of all registered protocols. Returns a composition
|
|
* of ERR_NONE, ERR_RETRYABLE, ERR_FATAL, ERR_ABORT.
|
|
*/
|
|
int protocol_bind_all(int verbose);
|
|
|
|
/* unbinds all listeners of all registered protocols. They are also closed.
|
|
* This must be performed before calling exit() in order to get a chance to
|
|
* remove file-system based sockets and pipes.
|
|
* Returns a composition of ERR_NONE, ERR_RETRYABLE, ERR_FATAL.
|
|
*/
|
|
int protocol_unbind_all(void);
|
|
|
|
/* stops all listeners of all registered protocols. This will normally catch
|
|
* every single listener, all protocols included. This is to be used during
|
|
* soft_stop() only. It does not return any error.
|
|
*/
|
|
void protocol_stop_now(void);
|
|
|
|
/* pauses all listeners of all registered protocols. This is typically
|
|
* used on SIG_TTOU to release all listening sockets for the time needed to
|
|
* try to bind a new process. The listeners enter LI_PAUSED. It returns
|
|
* ERR_NONE, with ERR_FATAL on failure.
|
|
*/
|
|
int protocol_pause_all(void);
|
|
|
|
/* resumes all listeners of all registered protocols. This is typically used on
|
|
* SIG_TTIN to re-enable listening sockets after a new process failed to bind.
|
|
* The listeners switch to LI_READY/LI_FULL. It returns ERR_NONE, with ERR_FATAL
|
|
* on failure.
|
|
*/
|
|
int protocol_resume_all(void);
|
|
|
|
/* enables all listeners of all registered protocols. This is intended to be
|
|
* used after a fork() to enable reading on all file descriptors. Returns a
|
|
* composition of ERR_NONE, ERR_RETRYABLE, ERR_FATAL.
|
|
*/
|
|
int protocol_enable_all(void);
|
|
|
|
/* returns the protocol associated to family <family> with proto_type among the
|
|
* supported protocol types, and ctrl_type of either SOCK_STREAM or SOCK_DGRAM
|
|
* depending on the requested values, or NULL if not found.
|
|
*/
|
|
static inline struct protocol *protocol_lookup(int family, enum proto_type proto_type, int alt)
|
|
{
|
|
if (family >= 0 && family < AF_CUST_MAX)
|
|
return __protocol_by_family[family][proto_type][!!alt];
|
|
return NULL;
|
|
}
|
|
|
|
/* returns the proto_fam that matches ss_family. This supports custom address
|
|
* families so it is suitable for use with ss_family as found in various config
|
|
* element addresses.
|
|
*/
|
|
static inline const struct proto_fam *proto_fam_lookup(int ss_family)
|
|
{
|
|
if (ss_family >= 0 && ss_family < AF_CUST_MAX)
|
|
return __proto_fam_by_family[ss_family];
|
|
return NULL;
|
|
}
|
|
|
|
/* returns either the real family when known or AF_UNSPEC for non-existing
|
|
* families. Note that real families that contain a custom value will be
|
|
* returned as-is. This aims at simplifying address validation tests everywhere.
|
|
*/
|
|
static inline int real_family(int ss_family)
|
|
{
|
|
const struct proto_fam *fam = proto_fam_lookup(ss_family);
|
|
|
|
return fam ? fam->real_family : AF_UNSPEC;
|
|
}
|
|
|
|
#endif /* _HAPROXY_PROTOCOL_H */
|
|
|
|
/*
|
|
* Local variables:
|
|
* c-indent-level: 8
|
|
* c-basic-offset: 8
|
|
* End:
|
|
*/
|