core: fix another bunch of 'no real prototype' warnings, add doxygen docs
[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_READ_W       2 /* watched for READ ev. in main */
65 #define F_CONN_WRITE_W      4 /* watched for WRITE (main) */
66 #define F_CONN_READER       8 /* handled by a tcp reader */
67 #define F_CONN_HASHED      16 /* in tcp_main hash */
68 #define F_CONN_FD_CLOSED   32 /* fd was already closed */
69 #define F_CONN_PENDING     64 /* pending connect  (fd not known yet in main) */
70 #define F_CONN_MAIN_TIMER 128 /* timer active in the tcp_main process */
71 #define F_CONN_EOF_SEEN   256 /* FIN or RST have been received */
72 #define F_CONN_FORCE_EOF  512 /* act as if an EOF was received */
73 #define F_CONN_OOB_DATA  1024 /* out of band data on the connection */
74 #define F_CONN_WR_ERROR  2048 /* write error on the fd */
75 #define F_CONN_WANTS_RD  4096  /* conn. should be watched for READ */
76 #define F_CONN_WANTS_WR  8192  /* conn. should be watched for WRITE */
77 #define F_CONN_PASSIVE  16384 /* conn. created via accept() and not connect()*/
78
79 #ifndef NO_READ_HTTP11
80 #define READ_HTTP11
81 #endif
82
83 enum tcp_req_errors {   TCP_REQ_INIT, TCP_REQ_OK, TCP_READ_ERROR,
84                                                 TCP_REQ_OVERRUN, TCP_REQ_BAD_LEN };
85 enum tcp_req_states {   H_SKIP_EMPTY, H_SKIP_EMPTY_CR_FOUND, H_SKIP_EMPTY_CRLF_FOUND, H_SKIP_EMPTY_CRLFCR_FOUND,
86                         H_SKIP, H_LF, H_LFCR,  H_BODY, H_STARTWS,
87                 H_CONT_LEN1, H_CONT_LEN2, H_CONT_LEN3, H_CONT_LEN4, H_CONT_LEN5,
88                 H_CONT_LEN6, H_CONT_LEN7, H_CONT_LEN8, H_CONT_LEN9, H_CONT_LEN10,
89                 H_CONT_LEN11, H_CONT_LEN12, H_CONT_LEN13, H_L_COLON, 
90                 H_CONT_LEN_BODY, H_CONT_LEN_BODY_PARSE,
91                 H_STUN_MSG, H_STUN_READ_BODY, H_STUN_FP, H_STUN_END, H_PING_CRLF
92 #ifdef READ_HTTP11
93                 , H_HTTP11_CHUNK_START, H_HTTP11_CHUNK_SIZE,
94                 H_HTTP11_CHUNK_BODY, H_HTTP11_CHUNK_END, H_HTTP11_CHUNK_FINISH
95 #endif
96         };
97
98 enum tcp_conn_states { S_CONN_ERROR=-2, S_CONN_BAD=-1,
99                                                 S_CONN_OK=0, /* established (write or read) */
100                                                 S_CONN_INIT, /* initial state (invalid) */
101                                                 S_CONN_EOF,
102                                                 S_CONN_ACCEPT, S_CONN_CONNECT
103                                         };
104
105
106 /* fd communication commands */
107 enum conn_cmds {
108         CONN_DESTROY=-3 /* destroy connection & auto-dec. refcnt */,
109         CONN_ERROR=-2   /* error on connection & auto-dec. refcnt */,
110         CONN_EOF=-1     /* eof received or conn. closed & auto-dec refcnt */,
111         CONN_NOP=0      /* do-nothing (invalid for tcp_main) */,
112         CONN_RELEASE    /* release a connection from tcp_read back into tcp_main
113                                            & auto-dec refcnt */,
114         CONN_GET_FD     /* request a fd from tcp_main */,
115         CONN_NEW        /* update/set a fd int a new tcp connection; refcnts are
116                                           not touched */,
117         CONN_QUEUED_WRITE /* new write queue: start watching the fd for write &
118                                                  auto-dec refcnt */,
119         CONN_NEW_PENDING_WRITE /* like CONN_NEW+CONN_QUEUED_WRITE: set fd and
120                                                           start watching it for write (write queue
121                                                           non-empty); refcnts are not touced */,
122         CONN_NEW_COMPLETE  /* like CONN_NEW_PENDING_WRITE, but there is no
123                                                   pending write (the write queue might be empty) */
124 };
125 /* CONN_RELEASE, EOF, ERROR, DESTROY can be used by "reader" processes
126  * CONN_GET_FD, CONN_NEW*, CONN_QUEUED_WRITE only by writers */
127
128 struct tcp_req{
129         struct tcp_req* next;
130         /* sockaddr ? */
131         char* buf; /* bytes read so far (+0-terminator)*/
132         char* start; /* where the message starts, after all the empty lines are
133                                         skipped*/
134         char* pos; /* current position in buf */
135         char* parsed; /* last parsed position */
136         char* body; /* body position */
137         unsigned int b_size; /* buffer size-1 (extra space for 0-term)*/
138         int content_len;
139 #ifdef READ_HTTP11
140         int chunk_size;
141 #endif
142         unsigned short flags; /* F_TCP_REQ_HAS_CLEN | F_TCP_REQ_COMPLETE */
143         int bytes_to_go; /* how many bytes we have still to read from the body*/
144         enum tcp_req_errors error;
145         enum tcp_req_states state;
146 };
147
148 /* tcp_req flags */
149 #define F_TCP_REQ_HAS_CLEN 1
150 #define F_TCP_REQ_COMPLETE 2
151 #ifdef READ_HTTP11
152 #define F_TCP_REQ_BCHUNKED 4
153 #endif
154
155 #define TCP_REQ_HAS_CLEN(tr)  ((tr)->flags & F_TCP_REQ_HAS_CLEN)
156 #define TCP_REQ_COMPLETE(tr)  ((tr)->flags & F_TCP_REQ_COMPLETE)
157 #ifdef READ_HTTP11
158 #define TCP_REQ_BCHUNKED(tr)  ((tr)->flags & F_TCP_REQ_BCHUNKED)
159 #endif
160
161
162 struct tcp_connection;
163
164 /* tcp port alias structure */
165 struct tcp_conn_alias{
166         struct tcp_connection* parent;
167         struct tcp_conn_alias* next;
168         struct tcp_conn_alias* prev;
169         unsigned short port; /* alias port */
170         unsigned short hash; /* hash index in the address hash */
171 };
172
173
174 #ifdef TCP_ASYNC
175         struct tcp_wbuffer{
176                 struct tcp_wbuffer* next;
177                 unsigned int b_size;
178                 char buf[1];
179         };
180
181         struct tcp_wbuffer_queue{
182                 struct tcp_wbuffer* first;
183                 struct tcp_wbuffer* last;
184                 ticks_t wr_timeout; /* write timeout*/
185                 unsigned int queued; /* total size */
186                 unsigned int offset; /* offset in the first wbuffer were data
187                                                                 starts */
188                 unsigned int last_used; /* how much of the last buffer is used */
189         };
190 #endif
191
192
193 struct tcp_connection{
194         int s; /*socket, used by "tcp main" */
195         int fd; /* used only by "children", don't modify it! private data! */
196         gen_lock_t write_lock;
197         int id; /* id (unique!) used to retrieve a specific connection when
198                    reply-ing*/
199         int reader_pid; /* pid of the active reader process */
200         struct receive_info rcv; /* src & dst ip, ports, proto a.s.o*/
201         struct tcp_req req; /* request data */
202         atomic_t refcnt;
203         enum sip_protos type; /* PROTO_TCP or a protocol over it, e.g. TLS */
204         unsigned short flags; /* connection related flags */
205         snd_flags_t send_flags; /* special send flags */
206         enum tcp_conn_states state; /* connection state */
207         void* extra_data; /* extra data associated to the connection, 0 for tcp*/
208         struct timer_ln timer;
209         ticks_t timeout;/* connection timeout, after this it will be removed*/
210         unsigned id_hash; /* hash index in the id_hash */
211         struct tcp_connection* id_next; /* next, prev in id hash table */
212         struct tcp_connection* id_prev;
213         struct tcp_connection* c_next; /* child next prev (use locally) */
214         struct tcp_connection* c_prev;
215         struct tcp_conn_alias con_aliases[TCP_CON_MAX_ALIASES];
216         int aliases; /* aliases number, at least 1 */
217 #ifdef TCP_ASYNC
218         struct tcp_wbuffer_queue wbuf_q;
219 #endif
220 };
221
222
223 /* helper macros */
224
225 #define tcpconn_set_send_flags(c, snd_flags) \
226         SND_FLAGS_OR(&(c)->send_flags, &(c)->send_flags, &(snd_flags))
227
228 #define tcpconn_close_after_send(c)     ((c)->send_flags.f & SND_F_CON_CLOSE)
229
230 #define TCP_RCV_INFO(c) (&(c)->rcv)
231
232 #define TCP_RCV_LADDR(r) (&((r).dst_ip))
233 #define TCP_RCV_LPORT(r) ((r).dst_port)
234 #define TCP_RCV_PADDR(r)  (&((r).src_ip))
235 #define TCP_RCV_PPORT(r)  ((r).src_port)
236 #define TCP_RCV_PSU(r)   (&(r).src_su)
237 #define TCP_RCV_SOCK_INFO(r)  ((r).bind_address)
238 #define TCP_RCV_PROTO(r)      ((r).proto)
239 #ifdef USE_COMP
240 #define TCP_RCV_COMP(r)       ((r).comp)
241 #else
242 #define TCP_RCV_COMP(r)  0
243 #endif /* USE_COMP */
244
245 #define TCP_LADDR(c) TCP_RCV_LADDR(c->rcv)
246 #define TCP_LPORT(c) TCP_RCV_LPORT(c->rcv)
247 #define TCP_PADDR(c) TCP_RCV_PADDR(c->rcv)
248 #define TCP_PPORT(c) TCP_RCV_PPORT(c->rcv)
249 #define TCP_PSU(c)   TCP_RCV_PSU(c->rcv)
250 #define TCP_SOCK_INFO(c) TCP_RCV_SOCK_INFO(c->rcv)
251 #define TCP_PROTO(c) TCP_RCV_PROTO(c->rcv)
252 #define TCP_COMP(c) TCP_RCV_COMP(c->rcv)
253
254
255
256 #define tcpconn_ref(c) atomic_inc(&((c)->refcnt))
257 #define tcpconn_put(c) atomic_dec_and_test(&((c)->refcnt))
258
259
260 #define init_tcp_req( r, rd_buf, rd_buf_size) \
261         do{ \
262                 memset( (r), 0, sizeof(struct tcp_req)); \
263                 (r)->buf=(rd_buf) ;\
264                 (r)->b_size=(rd_buf_size)-1; /* space for 0 term. */ \
265                 (r)->parsed=(r)->pos=(r)->start=(r)->buf; \
266                 (r)->error=TCP_REQ_OK;\
267                 (r)->state=H_SKIP_EMPTY; \
268         }while(0)
269
270
271 /* add a tcpconn to a list*/
272 /* list head, new element, next member, prev member */
273 #define tcpconn_listadd(head, c, next, prev) \
274         do{ \
275                 /* add it at the begining of the list*/ \
276                 (c)->next=(head); \
277                 (c)->prev=0; \
278                 if ((head)) (head)->prev=(c); \
279                 (head)=(c); \
280         } while(0)
281
282
283 /* remove a tcpconn from a list*/
284 #define tcpconn_listrm(head, c, next, prev) \
285         do{ \
286                 if ((head)==(c)) (head)=(c)->next; \
287                 if ((c)->next) (c)->next->prev=(c)->prev; \
288                 if ((c)->prev) (c)->prev->next=(c)->next; \
289         }while(0)
290
291
292 #define TCPCONN_LOCK lock_get(tcpconn_lock);
293 #define TCPCONN_UNLOCK lock_release(tcpconn_lock);
294
295 #define TCP_ALIAS_HASH_SIZE 4096
296 #define TCP_ID_HASH_SIZE 1024
297
298 /* hash (dst_ip, dst_port, local_ip, local_port) */
299 static inline unsigned tcp_addr_hash(   struct ip_addr* ip, 
300                                                                                 unsigned short port,
301                                                                                 struct ip_addr* l_ip,
302                                                                                 unsigned short l_port)
303 {
304         unsigned h;
305
306         if(ip->len==4)
307                 h=(ip->u.addr32[0]^port)^(l_ip->u.addr32[0]^l_port);
308         else if (ip->len==16) 
309                 h= (ip->u.addr32[0]^ip->u.addr32[1]^ip->u.addr32[2]^
310                                 ip->u.addr32[3]^port) ^
311                         (l_ip->u.addr32[0]^l_ip->u.addr32[1]^l_ip->u.addr32[2]^
312                                 l_ip->u.addr32[3]^l_port);
313         else{
314                 LOG(L_CRIT, "tcp_addr_hash: BUG: bad len %d for an ip address\n",
315                                 ip->len);
316                 return 0;
317         }
318         /* make sure the first bits are influenced by all 32
319          * (the first log2(TCP_ALIAS_HASH_SIZE) bits should be a mix of all
320          *  32)*/
321         h ^= h>>17;
322         h ^= h>>7;
323         return h & (TCP_ALIAS_HASH_SIZE-1);
324 }
325
326 #define tcp_id_hash(id) (id&(TCP_ID_HASH_SIZE-1))
327
328 struct tcp_connection* tcpconn_get(int id, struct ip_addr* ip, int port,
329                                                                         union sockaddr_union* local_addr,
330                                                                         ticks_t timeout);
331
332 #endif
333
334