mirror of
https://github.com/haproxy/haproxy.git
synced 2026-02-03 20:39:41 -05:00
7a798e5d6b
There's quite some inconsistency in the internal API. listener_accept() which is the main accept() function returns void but is declared as int in the include file. It's assigned to proto->accept() for all stream protocols where an int is expected but the result is never checked (nor is it documented by the way). This proto->accept() is in turn assigned to fd->iocb() which is supposed to return an int composed of FD_WAIT_* flags, but which is never checked either. So let's fix all this mess : - nobody checks accept()'s return - nobody checks iocb()'s return - nobody sets a return value => let's mark all these functions void and keep the current ones intact. Additionally we now include listener.h from listener.c to ensure we won't silently hide this incoherency in the future. Note that this patch could/should be backported to 1.6 and even 1.5 to simplify debugging sessions.
77 lines
3.2 KiB
C
77 lines
3.2 KiB
C
/*
|
|
* include/types/protocol.h
|
|
* This file defines the structures used by generic network protocols.
|
|
*
|
|
* Copyright (C) 2000-2012 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 _TYPES_PROTOCOL_H
|
|
#define _TYPES_PROTOCOL_H
|
|
|
|
#include <sys/types.h>
|
|
#include <sys/socket.h>
|
|
|
|
#include <common/config.h>
|
|
#include <common/mini-clist.h>
|
|
#include <eb32tree.h>
|
|
|
|
/* some pointer types referenced below */
|
|
struct listener;
|
|
struct connection;
|
|
|
|
/* max length of a protcol name, including trailing zero */
|
|
#define PROTO_NAME_LEN 16
|
|
|
|
/* This structure contains all information needed to easily handle a protocol.
|
|
* Its primary goal is to ease listeners maintenance. Specifically, the
|
|
* bind_all() primitive must be used before any fork(), and the enable_all()
|
|
* primitive must be called after the fork() to enable all fds. Last, the
|
|
* unbind_all() primitive closes all listeners.
|
|
*/
|
|
struct protocol {
|
|
char name[PROTO_NAME_LEN]; /* protocol name, zero-terminated */
|
|
int sock_domain; /* socket domain, as passed to socket() */
|
|
int sock_type; /* socket type, as passed to socket() */
|
|
int sock_prot; /* socket protocol, as passed to socket() */
|
|
sa_family_t sock_family; /* socket family, for sockaddr */
|
|
socklen_t sock_addrlen; /* socket address length, used by bind() */
|
|
int l3_addrlen; /* layer3 address length, used by hashes */
|
|
void (*accept)(int fd); /* generic accept function */
|
|
int (*bind)(struct listener *l, char *errmsg, int errlen); /* bind a listener */
|
|
int (*bind_all)(struct protocol *proto, char *errmsg, int errlen); /* bind all unbound listeners */
|
|
int (*unbind_all)(struct protocol *proto); /* unbind all bound listeners */
|
|
int (*enable_all)(struct protocol *proto); /* enable all bound listeners */
|
|
int (*disable_all)(struct protocol *proto); /* disable all bound listeners */
|
|
int (*connect)(struct connection *, int data, int delack); /* connect function if any */
|
|
int (*get_src)(int fd, struct sockaddr *, socklen_t, int dir); /* syscall used to retrieve src addr */
|
|
int (*get_dst)(int fd, struct sockaddr *, socklen_t, int dir); /* syscall used to retrieve dst addr */
|
|
int (*drain)(int fd); /* indicates whether we can safely close the fd */
|
|
int (*pause)(struct listener *l); /* temporarily pause this listener for a soft restart */
|
|
|
|
struct list listeners; /* list of listeners using this protocol */
|
|
int nb_listeners; /* number of listeners */
|
|
struct list list; /* list of registered protocols */
|
|
};
|
|
|
|
#endif /* _TYPES_PROTOCOL_H */
|
|
|
|
/*
|
|
* Local variables:
|
|
* c-indent-level: 8
|
|
* c-basic-offset: 8
|
|
* End:
|
|
*/
|