2006-06-26 02:48:02 +02:00
/*
include / proto / stream_sock . h
This file contains client - side definitions .
[MAJOR] rework of the server FSM
srv_state has been removed from HTTP state machines, and states
have been split in either TCP states or analyzers. For instance,
the TARPIT state has just become a simple analyzer.
New flags have been added to the struct buffer to compensate this.
The high-level stream processors sometimes need to force a disconnection
without touching a file-descriptor (eg: report an error). But if
they touched BF_SHUTW or BF_SHUTR, the file descriptor would not
be closed. Thus, the two SHUT?_NOW flags have been added so that
an application can request a forced close which the stream interface
will be forced to obey.
During this change, a new BF_HIJACK flag was added. It will
be used for data generation, eg during a stats dump. It
prevents the producer on a buffer from sending data into it.
BF_SHUTR_NOW /* the producer must shut down for reads ASAP */
BF_SHUTW_NOW /* the consumer must shut down for writes ASAP */
BF_HIJACK /* the producer is temporarily replaced */
BF_SHUTW_NOW has precedence over BF_HIJACK. BF_HIJACK has
precedence over BF_MAY_FORWARD (so that it does not need it).
New functions buffer_shutr_now(), buffer_shutw_now(), buffer_abort()
are provided to manipulate BF_SHUT* flags.
A new type "stream_interface" has been added to describe both
sides of a buffer. A stream interface has states and error
reporting. The session now has two stream interfaces (one per
side). Each buffer has stream_interface pointers to both
consumer and producer sides.
The server-side file descriptor has moved to its stream interface,
so that even the buffer has access to it.
process_srv() has been split into three parts :
- tcp_get_connection() obtains a connection to the server
- tcp_connection_failed() tests if a previously attempted
connection has succeeded or not.
- process_srv_data() only manages the data phase, and in
this sense should be roughly equivalent to process_cli.
Little code has been removed, and a lot of old code has been
left in comments for now.
2008-10-19 07:30:41 +02:00
Copyright ( C ) 2000 - 2008 Willy Tarreau - w @ 1 wt . eu
2008-12-14 14:42:35 +01:00
2006-06-26 02:48:02 +02:00
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 _PROTO_STREAM_SOCK_H
# define _PROTO_STREAM_SOCK_H
# include <stdlib.h>
# include <sys/socket.h>
# include <sys/types.h>
2006-06-29 17:53:05 +02:00
# include <common/config.h>
[MAJOR] rework of the server FSM
srv_state has been removed from HTTP state machines, and states
have been split in either TCP states or analyzers. For instance,
the TARPIT state has just become a simple analyzer.
New flags have been added to the struct buffer to compensate this.
The high-level stream processors sometimes need to force a disconnection
without touching a file-descriptor (eg: report an error). But if
they touched BF_SHUTW or BF_SHUTR, the file descriptor would not
be closed. Thus, the two SHUT?_NOW flags have been added so that
an application can request a forced close which the stream interface
will be forced to obey.
During this change, a new BF_HIJACK flag was added. It will
be used for data generation, eg during a stats dump. It
prevents the producer on a buffer from sending data into it.
BF_SHUTR_NOW /* the producer must shut down for reads ASAP */
BF_SHUTW_NOW /* the consumer must shut down for writes ASAP */
BF_HIJACK /* the producer is temporarily replaced */
BF_SHUTW_NOW has precedence over BF_HIJACK. BF_HIJACK has
precedence over BF_MAY_FORWARD (so that it does not need it).
New functions buffer_shutr_now(), buffer_shutw_now(), buffer_abort()
are provided to manipulate BF_SHUT* flags.
A new type "stream_interface" has been added to describe both
sides of a buffer. A stream interface has states and error
reporting. The session now has two stream interfaces (one per
side). Each buffer has stream_interface pointers to both
consumer and producer sides.
The server-side file descriptor has moved to its stream interface,
so that even the buffer has access to it.
process_srv() has been split into three parts :
- tcp_get_connection() obtains a connection to the server
- tcp_connection_failed() tests if a previously attempted
connection has succeeded or not.
- process_srv_data() only manages the data phase, and in
this sense should be roughly equivalent to process_cli.
Little code has been removed, and a lot of old code has been
left in comments for now.
2008-10-19 07:30:41 +02:00
# include <types/stream_interface.h>
2006-06-26 02:48:02 +02:00
2006-07-29 19:01:31 +02:00
/* main event functions used to move data between sockets and buffers */
2006-07-29 18:36:34 +02:00
int stream_sock_read ( int fd ) ;
2006-07-29 19:01:31 +02:00
int stream_sock_write ( int fd ) ;
2008-11-30 21:37:12 +01:00
void stream_sock_data_finish ( struct stream_interface * si ) ;
2008-11-23 19:31:35 +01:00
void stream_sock_shutr ( struct stream_interface * si ) ;
void stream_sock_shutw ( struct stream_interface * si ) ;
2008-12-14 14:42:35 +01:00
void stream_sock_chk_rcv ( struct stream_interface * si ) ;
void stream_sock_chk_snd ( struct stream_interface * si ) ;
2006-06-26 02:48:02 +02:00
/* This either returns the sockname or the original destination address. Code
* inspired from Patrick Schaaf ' s example of nf_getsockname ( ) implementation .
*/
static inline int get_original_dst ( int fd , struct sockaddr_in * sa , socklen_t * salen ) {
# if defined(TPROXY) && defined(SO_ORIGINAL_DST)
return getsockopt ( fd , SOL_IP , SO_ORIGINAL_DST , ( void * ) sa , salen ) ;
# else
# if defined(TPROXY) && defined(USE_GETSOCKNAME)
return getsockname ( fd , ( struct sockaddr * ) sa , salen ) ;
# else
return - 1 ;
# endif
# endif
}
# endif /* _PROTO_STREAM_SOCK_H */
/*
* Local variables :
* c - indent - level : 8
* c - basic - offset : 8
* End :
*/