/*
* $Id$
*
* Copyright (C) 2001-2003 FhG Fokus
*
* This file is part of ser, a free SIP server.
*
* ser is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version
*
* For a license to use the ser software under conditions
* other than those described here, or to purchase support for this
* software, please contact iptel.org by e-mail at the following addresses:
* info@iptel.org
*
* ser 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*
* History:
* --------
* 2003-01-29 tcp buffer size ++-ed to allow for 0-terminator
* 2003-06-30 added tcp_connection flags & state (andrei)
* 2003-10-27 tcp port aliases support added (andrei)
* 2006-10-13 added tcp_req_states for STUN (vlada)
* 2007-07-26 improved tcp connection hash function; increased aliases
* hash size (andrei)
* 2007-11-26 switched to local_timer (andrei)
* 2007-11-30 buffered write support (andrei)
*/
#ifndef _tcp_conn_h
#define _tcp_conn_h
#include "tcp_options.h"
#include "ip_addr.h"
#include "locking.h"
#include "atomic_ops.h"
#include "timer_ticks.h"
#include "timer.h"
/* maximum number of port aliases x search wildcard possibilities */
#define TCP_CON_MAX_ALIASES (4*3)
#define TCP_BUF_SIZE 4096
#define DEFAULT_TCP_CONNECTION_LIFETIME 120 /* in seconds */
#define DEFAULT_TCP_SEND_TIMEOUT 10 /* if a send can't write for more then 10s,
timeout */
#define DEFAULT_TCP_CONNECT_TIMEOUT 10 /* if a connect doesn't complete in this
time, timeout */
#define DEFAULT_TCP_MAX_CONNECTIONS 2048 /* maximum connections */
#define TCP_CHILD_TIMEOUT 5 /* after 5 seconds, the child "returns"
the connection to the tcp master process */
#define TCP_MAIN_SELECT_TIMEOUT 5 /* how often "tcp main" checks for timeout*/
#define TCP_CHILD_SELECT_TIMEOUT 2 /* the same as above but for children */
/* tcp connection flags */
#define F_CONN_NON_BLOCKING 1
#define F_CONN_READ_W 2 /* watched for READ ev. in main */
#define F_CONN_WRITE_W 4 /* watched for WRITE (main) */
#define F_CONN_READER 8 /* handled by a tcp reader */
#define F_CONN_HASHED 16 /* in tcp_main hash */
#define F_CONN_FD_CLOSED 32 /* fd was already closed */
#define F_CONN_PENDING 64 /* pending connect (fd not known yet in main) */
#define F_CONN_MAIN_TIMER 128 /* timer active in the tcp_main process */
#define F_CONN_EOF_SEEN 256 /* FIN or RST have been received */
#define F_CONN_FORCE_EOF 512 /* act as if an EOF was received */
#define F_CONN_OOB_DATA 1024 /* out of band data on the connection */
#define F_CONN_WR_ERROR 2048 /* write error on the fd */
enum tcp_req_errors { TCP_REQ_INIT, TCP_REQ_OK, TCP_READ_ERROR,
TCP_REQ_OVERRUN, TCP_REQ_BAD_LEN };
enum tcp_req_states { H_SKIP_EMPTY, H_SKIP_EMPTY_CR_FOUND, H_SKIP_EMPTY_CRLF_FOUND, H_SKIP_EMPTY_CRLFCR_FOUND,
H_SKIP, H_LF, H_LFCR, H_BODY, H_STARTWS,
H_CONT_LEN1, H_CONT_LEN2, H_CONT_LEN3, H_CONT_LEN4, H_CONT_LEN5,
H_CONT_LEN6, H_CONT_LEN7, H_CONT_LEN8, H_CONT_LEN9, H_CONT_LEN10,
H_CONT_LEN11, H_CONT_LEN12, H_CONT_LEN13, H_L_COLON,
H_CONT_LEN_BODY, H_CONT_LEN_BODY_PARSE,
H_STUN_MSG, H_STUN_READ_BODY, H_STUN_FP, H_STUN_END, H_PING_CRLF
};
enum tcp_conn_states { S_CONN_ERROR=-2, S_CONN_BAD=-1, S_CONN_OK=0,
S_CONN_INIT, S_CONN_EOF,
S_CONN_ACCEPT, S_CONN_CONNECT, S_CONN_PENDING };
/* fd communication commands */
enum conn_cmds { CONN_DESTROY=-3, CONN_ERROR=-2, CONN_EOF=-1, CONN_RELEASE,
CONN_GET_FD, CONN_NEW, CONN_QUEUED_WRITE,
CONN_NEW_PENDING_WRITE, CONN_NEW_COMPLETE };
/* CONN_RELEASE, EOF, ERROR, DESTROY can be used by "reader" processes
* CONN_GET_FD, NEW, ERROR only by writers */
struct tcp_req{
struct tcp_req* next;
/* sockaddr ? */
char buf[TCP_BUF_SIZE+1]; /* bytes read so far (+0-terminator)*/
char* start; /* where the message starts, after all the empty lines are
skipped*/
char* pos; /* current position in buf */
char* parsed; /* last parsed position */
char* body; /* body position */
int content_len;
int has_content_len; /* 1 if content_length was parsed ok*/
int complete; /* 1 if one req has been fully read, 0 otherwise*/
int bytes_to_go; /* how many bytes we have still to read from the body*/
enum tcp_req_errors error;
enum tcp_req_states state;
};
struct tcp_connection;
/* tcp port alias structure */
struct tcp_conn_alias{
struct tcp_connection* parent;
struct tcp_conn_alias* next;
struct tcp_conn_alias* prev;
unsigned short port; /* alias port */
unsigned short hash; /* hash index in the address hash */
};
#ifdef TCP_BUF_WRITE
struct tcp_wbuffer{
struct tcp_wbuffer* next;
unsigned int b_size;
char buf[1];
};
struct tcp_wbuffer_queue{
struct tcp_wbuffer* first;
struct tcp_wbuffer* last;
ticks_t wr_timeout; /* write timeout*/
unsigned int queued; /* total size */
unsigned int offset; /* offset in the first wbuffer were data
starts */
unsigned int last_used; /* how much of the last buffer is used */
};
#endif
struct tcp_connection{
int s; /*socket, used by "tcp main" */
int fd; /* used only by "children", don't modify it! private data! */
gen_lock_t write_lock;
int id; /* id (unique!) used to retrieve a specific connection when
reply-ing*/
int reader_pid; /* pid of the active reader process */
struct receive_info rcv; /* src & dst ip, ports, proto a.s.o*/
struct tcp_req req; /* request data */
atomic_t refcnt;
enum sip_protos type; /* PROTO_TCP or a protocol over it, e.g. TLS */
int flags; /* connection related flags */
enum tcp_conn_states state; /* connection state */
void* extra_data; /* extra data associated to the connection, 0 for tcp*/
struct timer_ln timer;
ticks_t timeout;/* connection timeout, after this it will be removed*/
unsigned id_hash; /* hash index in the id_hash */
struct tcp_connection* id_next; /* next, prev in id hash table */
struct tcp_connection* id_prev;
struct tcp_connection* c_next; /* child next prev (use locally) */
struct tcp_connection* c_prev;
struct tcp_conn_alias con_aliases[TCP_CON_MAX_ALIASES];
int aliases; /* aliases number, at least 1 */
#ifdef TCP_BUF_WRITE
struct tcp_wbuffer_queue wbuf_q;
#endif
};
#define tcpconn_ref(c) atomic_inc(&((c)->refcnt))
#define tcpconn_put(c) atomic_dec_and_test(&((c)->refcnt))
#define init_tcp_req( r) \
do{ \
memset( (r), 0, sizeof(struct tcp_req)); \
(r)->parsed=(r)->pos=(r)->start=(r)->buf; \
(r)->error=TCP_REQ_OK;\
(r)->state=H_SKIP_EMPTY; \
}while(0)
/* add a tcpconn to a list*/
/* list head, new element, next member, prev member */
#define tcpconn_listadd(head, c, next, prev) \
do{ \
/* add it at the begining of the list*/ \
(c)->next=(head); \
(c)->prev=0; \
if ((head)) (head)->prev=(c); \
(head)=(c); \
} while(0)
/* remove a tcpconn from a list*/
#define tcpconn_listrm(head, c, next, prev) \
do{ \
if ((head)==(c)) (head)=(c)->next; \
if ((c)->next) (c)->next->prev=(c)->prev; \
if ((c)->prev) (c)->prev->next=(c)->next; \
}while(0)
#define TCPCONN_LOCK lock_get(tcpconn_lock);
#define TCPCONN_UNLOCK lock_release(tcpconn_lock);
#define TCP_ALIAS_HASH_SIZE 4096
#define TCP_ID_HASH_SIZE 1024
/* hash (dst_ip, dst_port, local_ip, local_port) */
static inline unsigned tcp_addr_hash( struct ip_addr* ip,
unsigned short port,
struct ip_addr* l_ip,
unsigned short l_port)
{
unsigned h;
if(ip->len==4)
h=(ip->u.addr32[0]^port)^(l_ip->u.addr32[0]^l_port);
else if (ip->len==16)
h= (ip->u.addr32[0]^ip->u.addr32[1]^ip->u.addr32[2]^
ip->u.addr32[3]^port) ^
(l_ip->u.addr32[0]^l_ip->u.addr32[1]^l_ip->u.addr32[2]^
l_ip->u.addr32[3]^l_port);
else{
LOG(L_CRIT, "tcp_addr_hash: BUG: bad len %d for an ip address\n",
ip->len);
return 0;
}
/* make sure the first bits are influenced by all 32
* (the first log2(TCP_ALIAS_HASH_SIZE) bits should be a mix of all
* 32)*/
h ^= h>>17;
h ^= h>>7;
return h & (TCP_ALIAS_HASH_SIZE-1);
}
#define tcp_id_hash(id) (id&(TCP_ID_HASH_SIZE-1))
struct tcp_connection* tcpconn_get(int id, struct ip_addr* ip, int port,
union sockaddr_union* local_addr,
ticks_t timeout);
#endif