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