tcp: minor optimization
[sip-router] / tcp_conn.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2001-2003 FhG Fokus
5  *
6  * This file is part of ser, a free SIP server.
7  *
8  * ser is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * For a license to use the ser software under conditions
14  * other than those described here, or to purchase support for this
15  * software, please contact iptel.org by e-mail at the following addresses:
16  *    info@iptel.org
17  *
18  * ser is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  *
27  *
28  * History:
29  * --------
30  *  2003-01-29  tcp buffer size ++-ed to allow for 0-terminator
31  *  2003-06-30  added tcp_connection flags & state (andrei) 
32  *  2003-10-27  tcp port aliases support added (andrei)
33  *  2006-10-13  added tcp_req_states for STUN (vlada)
34  *  2007-07-26  improved tcp connection hash function; increased aliases
35  *               hash size (andrei)
36  *  2007-11-26  switched to local_timer (andrei)
37  *  2007-11-30  buffered write support (andrei)
38  */
39
40
41
42 #ifndef _tcp_conn_h
43 #define _tcp_conn_h
44
45 #include "tcp_init.h"
46 #include "tcp_options.h"
47
48 #include "ip_addr.h"
49 #include "locking.h"
50 #include "atomic_ops.h"
51 #include "timer_ticks.h"
52 #include "timer.h"
53
54 /* maximum number of port aliases x search wildcard possibilities */
55 #define TCP_CON_MAX_ALIASES (4*3) 
56
57 #define TCP_CHILD_TIMEOUT 5 /* after 5 seconds, the child "returns" 
58                                                          the connection to the tcp master process */
59 #define TCP_MAIN_SELECT_TIMEOUT 5 /* how often "tcp main" checks for timeout*/
60 #define TCP_CHILD_SELECT_TIMEOUT 2 /* the same as above but for children */
61
62
63 /* tcp connection flags */
64 #define F_CONN_NON_BLOCKING 1
65 #define F_CONN_READ_W       2 /* watched for READ ev. in main */
66 #define F_CONN_WRITE_W      4 /* watched for WRITE (main) */
67 #define F_CONN_READER       8 /* handled by a tcp reader */
68 #define F_CONN_HASHED      16 /* in tcp_main hash */
69 #define F_CONN_FD_CLOSED   32 /* fd was already closed */
70 #define F_CONN_PENDING     64 /* pending connect  (fd not known yet in main) */
71 #define F_CONN_MAIN_TIMER 128 /* timer active in the tcp_main process */
72 #define F_CONN_EOF_SEEN   256 /* FIN or RST have been received */
73 #define F_CONN_FORCE_EOF  512 /* act as if an EOF was received */
74 #define F_CONN_OOB_DATA  1024 /* out of band data on the connection */
75 #define F_CONN_WR_ERROR  2048 /* write error on the fd */
76 #define F_CONN_WANTS_RD  4096  /* conn. should be watched for READ */
77 #define F_CONN_WANTS_WR  8192  /* conn. should be watched for WRITE */
78
79
80 enum tcp_req_errors {   TCP_REQ_INIT, TCP_REQ_OK, TCP_READ_ERROR,
81                                                 TCP_REQ_OVERRUN, TCP_REQ_BAD_LEN };
82 enum tcp_req_states {   H_SKIP_EMPTY, H_SKIP_EMPTY_CR_FOUND, H_SKIP_EMPTY_CRLF_FOUND, H_SKIP_EMPTY_CRLFCR_FOUND,
83                         H_SKIP, H_LF, H_LFCR,  H_BODY, H_STARTWS,
84                 H_CONT_LEN1, H_CONT_LEN2, H_CONT_LEN3, H_CONT_LEN4, H_CONT_LEN5,
85                 H_CONT_LEN6, H_CONT_LEN7, H_CONT_LEN8, H_CONT_LEN9, H_CONT_LEN10,
86                 H_CONT_LEN11, H_CONT_LEN12, H_CONT_LEN13, H_L_COLON, 
87                 H_CONT_LEN_BODY, H_CONT_LEN_BODY_PARSE,
88                 H_STUN_MSG, H_STUN_READ_BODY, H_STUN_FP, H_STUN_END, H_PING_CRLF
89         };
90
91 enum tcp_conn_states { S_CONN_ERROR=-2, S_CONN_BAD=-1,
92                                                 S_CONN_OK=0, /* established (write or read) */
93                                                 S_CONN_INIT, /* initial state (invalid) */
94                                                 S_CONN_EOF,
95                                                 S_CONN_ACCEPT, S_CONN_CONNECT
96                                         };
97
98
99 /* fd communication commands */
100 enum conn_cmds { CONN_DESTROY=-3, CONN_ERROR=-2, CONN_EOF=-1, CONN_RELEASE, 
101                                         CONN_GET_FD, CONN_NEW, CONN_QUEUED_WRITE,
102                                         CONN_NEW_PENDING_WRITE, CONN_NEW_COMPLETE };
103 /* CONN_RELEASE, EOF, ERROR, DESTROY can be used by "reader" processes
104  * CONN_GET_FD, NEW, ERROR only by writers */
105
106 struct tcp_req{
107         struct tcp_req* next;
108         /* sockaddr ? */
109         char* buf; /* bytes read so far (+0-terminator)*/
110         char* start; /* where the message starts, after all the empty lines are
111                                         skipped*/
112         char* pos; /* current position in buf */
113         char* parsed; /* last parsed position */
114         char* body; /* body position */
115         unsigned int b_size; /* buffer size-1 (extra space for 0-term)*/
116         int content_len;
117         unsigned short flags; /* F_TCP_REQ_HAS_CLEN | F_TCP_REQ_COMPLETE */
118         int bytes_to_go; /* how many bytes we have still to read from the body*/
119         enum tcp_req_errors error;
120         enum tcp_req_states state;
121 };
122
123 /* tcp_req flags */
124 #define F_TCP_REQ_HAS_CLEN 1
125 #define F_TCP_REQ_COMPLETE 2
126
127 #define TCP_REQ_HAS_CLEN(tr)  ((tr)->flags & F_TCP_REQ_HAS_CLEN)
128 #define TCP_REQ_COMPLETE(tr)  ((tr)->flags & F_TCP_REQ_COMPLETE)
129
130
131 struct tcp_connection;
132
133 /* tcp port alias structure */
134 struct tcp_conn_alias{
135         struct tcp_connection* parent;
136         struct tcp_conn_alias* next;
137         struct tcp_conn_alias* prev;
138         unsigned short port; /* alias port */
139         unsigned short hash; /* hash index in the address hash */
140 };
141
142
143 #ifdef TCP_ASYNC
144         struct tcp_wbuffer{
145                 struct tcp_wbuffer* next;
146                 unsigned int b_size;
147                 char buf[1];
148         };
149
150         struct tcp_wbuffer_queue{
151                 struct tcp_wbuffer* first;
152                 struct tcp_wbuffer* last;
153                 ticks_t wr_timeout; /* write timeout*/
154                 unsigned int queued; /* total size */
155                 unsigned int offset; /* offset in the first wbuffer were data
156                                                                 starts */
157                 unsigned int last_used; /* how much of the last buffer is used */
158         };
159 #endif
160
161
162 struct tcp_connection{
163         int s; /*socket, used by "tcp main" */
164         int fd; /* used only by "children", don't modify it! private data! */
165         gen_lock_t write_lock;
166         int id; /* id (unique!) used to retrieve a specific connection when
167                    reply-ing*/
168         int reader_pid; /* pid of the active reader process */
169         struct receive_info rcv; /* src & dst ip, ports, proto a.s.o*/
170         struct tcp_req req; /* request data */
171         atomic_t refcnt;
172         enum sip_protos type; /* PROTO_TCP or a protocol over it, e.g. TLS */
173         int flags; /* connection related flags */
174         enum tcp_conn_states state; /* connection state */
175         void* extra_data; /* extra data associated to the connection, 0 for tcp*/
176         struct timer_ln timer;
177         ticks_t timeout;/* connection timeout, after this it will be removed*/
178         unsigned id_hash; /* hash index in the id_hash */
179         struct tcp_connection* id_next; /* next, prev in id hash table */
180         struct tcp_connection* id_prev;
181         struct tcp_connection* c_next; /* child next prev (use locally) */
182         struct tcp_connection* c_prev;
183         struct tcp_conn_alias con_aliases[TCP_CON_MAX_ALIASES];
184         int aliases; /* aliases number, at least 1 */
185 #ifdef TCP_ASYNC
186         struct tcp_wbuffer_queue wbuf_q;
187 #endif
188 };
189
190
191
192
193
194 #define tcpconn_ref(c) atomic_inc(&((c)->refcnt))
195 #define tcpconn_put(c) atomic_dec_and_test(&((c)->refcnt))
196
197
198 #define init_tcp_req( r, rd_buf, rd_buf_size) \
199         do{ \
200                 memset( (r), 0, sizeof(struct tcp_req)); \
201                 (r)->buf=(rd_buf) ;\
202                 (r)->b_size=(rd_buf_size)-1; /* space for 0 term. */ \
203                 (r)->parsed=(r)->pos=(r)->start=(r)->buf; \
204                 (r)->error=TCP_REQ_OK;\
205                 (r)->state=H_SKIP_EMPTY; \
206         }while(0)
207
208
209 /* add a tcpconn to a list*/
210 /* list head, new element, next member, prev member */
211 #define tcpconn_listadd(head, c, next, prev) \
212         do{ \
213                 /* add it at the begining of the list*/ \
214                 (c)->next=(head); \
215                 (c)->prev=0; \
216                 if ((head)) (head)->prev=(c); \
217                 (head)=(c); \
218         } while(0)
219
220
221 /* remove a tcpconn from a list*/
222 #define tcpconn_listrm(head, c, next, prev) \
223         do{ \
224                 if ((head)==(c)) (head)=(c)->next; \
225                 if ((c)->next) (c)->next->prev=(c)->prev; \
226                 if ((c)->prev) (c)->prev->next=(c)->next; \
227         }while(0)
228
229
230 #define TCPCONN_LOCK lock_get(tcpconn_lock);
231 #define TCPCONN_UNLOCK lock_release(tcpconn_lock);
232
233 #define TCP_ALIAS_HASH_SIZE 4096
234 #define TCP_ID_HASH_SIZE 1024
235
236 /* hash (dst_ip, dst_port, local_ip, local_port) */
237 static inline unsigned tcp_addr_hash(   struct ip_addr* ip, 
238                                                                                 unsigned short port,
239                                                                                 struct ip_addr* l_ip,
240                                                                                 unsigned short l_port)
241 {
242         unsigned h;
243
244         if(ip->len==4)
245                 h=(ip->u.addr32[0]^port)^(l_ip->u.addr32[0]^l_port);
246         else if (ip->len==16) 
247                 h= (ip->u.addr32[0]^ip->u.addr32[1]^ip->u.addr32[2]^
248                                 ip->u.addr32[3]^port) ^
249                         (l_ip->u.addr32[0]^l_ip->u.addr32[1]^l_ip->u.addr32[2]^
250                                 l_ip->u.addr32[3]^l_port);
251         else{
252                 LOG(L_CRIT, "tcp_addr_hash: BUG: bad len %d for an ip address\n",
253                                 ip->len);
254                 return 0;
255         }
256         /* make sure the first bits are influenced by all 32
257          * (the first log2(TCP_ALIAS_HASH_SIZE) bits should be a mix of all
258          *  32)*/
259         h ^= h>>17;
260         h ^= h>>7;
261         return h & (TCP_ALIAS_HASH_SIZE-1);
262 }
263
264 #define tcp_id_hash(id) (id&(TCP_ID_HASH_SIZE-1))
265
266 struct tcp_connection* tcpconn_get(int id, struct ip_addr* ip, int port,
267                                                                         union sockaddr_union* local_addr,
268                                                                         ticks_t timeout);
269
270 #endif
271
272