@cfg_get.<group_name>.<var_name> is documented
[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_options.h"
46
47 #include "ip_addr.h"
48 #include "locking.h"
49 #include "atomic_ops.h"
50 #include "timer_ticks.h"
51 #include "timer.h"
52
53 /* maximum number of port aliases x search wildcard possibilities */
54 #define TCP_CON_MAX_ALIASES (4*3) 
55
56 #define TCP_BUF_SIZE    4096 
57 #define DEFAULT_TCP_CONNECTION_LIFETIME 120 /* in  seconds */
58 #define DEFAULT_TCP_SEND_TIMEOUT 10 /* if a send can't write for more then 10s,
59                                                                            timeout */
60 #define DEFAULT_TCP_CONNECT_TIMEOUT 10 /* if a connect doesn't complete in this
61                                                                                   time, timeout */
62 #define DEFAULT_TCP_MAX_CONNECTIONS 2048 /* maximum connections */
63 #define TCP_CHILD_TIMEOUT 5 /* after 5 seconds, the child "returns" 
64                                                          the connection to the tcp master process */
65 #define TCP_MAIN_SELECT_TIMEOUT 5 /* how often "tcp main" checks for timeout*/
66 #define TCP_CHILD_SELECT_TIMEOUT 2 /* the same as above but for children */
67
68
69 /* tcp connection flags */
70 #define F_CONN_NON_BLOCKING 1
71 #define F_CONN_REMOVED      2 /* no longer  in "main" listen fd list */
72 #define F_CONN_READER       4 /* handled by a tcp reader */
73 #define F_CONN_WRITE_W      8 /* watched for write (main) */
74 #define F_CONN_HASHED      16 /* in tcp_main hash */
75 #define F_CONN_FD_CLOSED   32 /* fd was already closed */
76 #define F_CONN_PENDING     64 /* pending connect  (fd not known yet in main) */
77 #define F_CONN_MAIN_TIMER 128 /* timer active in the tcp_main process */
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, H_LF, H_LFCR,  H_BODY, H_STARTWS,
83                 H_CONT_LEN1, H_CONT_LEN2, H_CONT_LEN3, H_CONT_LEN4, H_CONT_LEN5,
84                 H_CONT_LEN6, H_CONT_LEN7, H_CONT_LEN8, H_CONT_LEN9, H_CONT_LEN10,
85                 H_CONT_LEN11, H_CONT_LEN12, H_CONT_LEN13, H_L_COLON, 
86                 H_CONT_LEN_BODY, H_CONT_LEN_BODY_PARSE,
87                 H_STUN_MSG, H_STUN_READ_BODY, H_STUN_FP, H_STUN_END 
88         };
89
90 enum tcp_conn_states { S_CONN_ERROR=-2, S_CONN_BAD=-1, S_CONN_OK=0, 
91                                                 S_CONN_INIT, S_CONN_EOF, 
92                                                 S_CONN_ACCEPT, S_CONN_CONNECT, S_CONN_PENDING };
93
94
95 /* fd communication commands */
96 enum conn_cmds { CONN_DESTROY=-3, CONN_ERROR=-2, CONN_EOF=-1, CONN_RELEASE, 
97                                         CONN_GET_FD, CONN_NEW, CONN_QUEUED_WRITE,
98                                         CONN_NEW_PENDING_WRITE, CONN_NEW_COMPLETE };
99 /* CONN_RELEASE, EOF, ERROR, DESTROY can be used by "reader" processes
100  * CONN_GET_FD, NEW, ERROR only by writers */
101
102 struct tcp_req{
103         struct tcp_req* next;
104         /* sockaddr ? */
105         char buf[TCP_BUF_SIZE+1]; /* bytes read so far (+0-terminator)*/
106         char* start; /* where the message starts, after all the empty lines are
107                                         skipped*/
108         char* pos; /* current position in buf */
109         char* parsed; /* last parsed position */
110         char* body; /* body position */
111         int content_len;
112         int has_content_len; /* 1 if content_length was parsed ok*/
113         int complete; /* 1 if one req has been fully read, 0 otherwise*/
114         int bytes_to_go; /* how many bytes we have still to read from the body*/
115         enum tcp_req_errors error;
116         enum tcp_req_states state;
117 };
118
119
120
121 struct tcp_connection;
122
123 /* tcp port alias structure */
124 struct tcp_conn_alias{
125         struct tcp_connection* parent;
126         struct tcp_conn_alias* next;
127         struct tcp_conn_alias* prev;
128         unsigned short port; /* alias port */
129         unsigned short hash; /* hash index in the address hash */
130 };
131
132
133 #ifdef TCP_BUF_WRITE
134         struct tcp_wbuffer{
135                 struct tcp_wbuffer* next;
136                 unsigned int b_size;
137                 char buf[1];
138         };
139
140         struct tcp_wbuffer_queue{
141                 struct tcp_wbuffer* first;
142                 struct tcp_wbuffer* last;
143                 ticks_t wr_timeout; /* write timeout*/
144                 unsigned int queued; /* total size */
145                 unsigned int offset; /* offset in the first wbuffer were data
146                                                                 starts */
147                 unsigned int last_used; /* how much of the last buffer is used */
148         };
149 #endif
150
151
152 struct tcp_connection{
153         int s; /*socket, used by "tcp main" */
154         int fd; /* used only by "children", don't modify it! private data! */
155         gen_lock_t write_lock;
156         int id; /* id (unique!) used to retrieve a specific connection when
157                    reply-ing*/
158         int reader_pid; /* pid of the active reader process */
159         struct receive_info rcv; /* src & dst ip, ports, proto a.s.o*/
160         struct tcp_req req; /* request data */
161         atomic_t refcnt;
162         enum sip_protos type; /* PROTO_TCP or a protocol over it, e.g. TLS */
163         int flags; /* connection related flags */
164         enum tcp_conn_states state; /* connection state */
165         void* extra_data; /* extra data associated to the connection, 0 for tcp*/
166         struct timer_ln timer;
167         ticks_t timeout;/* connection timeout, after this it will be removed*/
168         unsigned id_hash; /* hash index in the id_hash */
169         struct tcp_connection* id_next; /* next, prev in id hash table */
170         struct tcp_connection* id_prev;
171         struct tcp_connection* c_next; /* child next prev (use locally) */
172         struct tcp_connection* c_prev;
173         struct tcp_conn_alias con_aliases[TCP_CON_MAX_ALIASES];
174         int aliases; /* aliases number, at least 1 */
175 #ifdef TCP_BUF_WRITE
176         struct tcp_wbuffer_queue wbuf_q;
177 #endif
178 };
179
180
181
182
183
184 #define tcpconn_ref(c) atomic_inc(&((c)->refcnt))
185 #define tcpconn_put(c) atomic_dec_and_test(&((c)->refcnt))
186
187
188 #define init_tcp_req( r) \
189         do{ \
190                 memset( (r), 0, sizeof(struct tcp_req)); \
191                 (r)->parsed=(r)->pos=(r)->start=(r)->buf; \
192                 (r)->error=TCP_REQ_OK;\
193                 (r)->state=H_SKIP_EMPTY; \
194         }while(0)
195
196
197 /* add a tcpconn to a list*/
198 /* list head, new element, next member, prev member */
199 #define tcpconn_listadd(head, c, next, prev) \
200         do{ \
201                 /* add it at the begining of the list*/ \
202                 (c)->next=(head); \
203                 (c)->prev=0; \
204                 if ((head)) (head)->prev=(c); \
205                 (head)=(c); \
206         } while(0)
207
208
209 /* remove a tcpconn from a list*/
210 #define tcpconn_listrm(head, c, next, prev) \
211         do{ \
212                 if ((head)==(c)) (head)=(c)->next; \
213                 if ((c)->next) (c)->next->prev=(c)->prev; \
214                 if ((c)->prev) (c)->prev->next=(c)->next; \
215         }while(0)
216
217
218 #define TCPCONN_LOCK lock_get(tcpconn_lock);
219 #define TCPCONN_UNLOCK lock_release(tcpconn_lock);
220
221 #define TCP_ALIAS_HASH_SIZE 4096
222 #define TCP_ID_HASH_SIZE 1024
223
224 /* hash (dst_ip, dst_port, local_ip, local_port) */
225 static inline unsigned tcp_addr_hash(   struct ip_addr* ip, 
226                                                                                 unsigned short port,
227                                                                                 struct ip_addr* l_ip,
228                                                                                 unsigned short l_port)
229 {
230         unsigned h;
231
232         if(ip->len==4)
233                 h=(ip->u.addr32[0]^port)^(l_ip->u.addr32[0]^l_port);
234         else if (ip->len==16) 
235                 h= (ip->u.addr32[0]^ip->u.addr32[1]^ip->u.addr32[2]^
236                                 ip->u.addr32[3]^port) ^
237                         (l_ip->u.addr32[0]^l_ip->u.addr32[1]^l_ip->u.addr32[2]^
238                                 l_ip->u.addr32[3]^l_port);
239         else{
240                 LOG(L_CRIT, "tcp_addr_hash: BUG: bad len %d for an ip address\n",
241                                 ip->len);
242                 return 0;
243         }
244         /* make sure the first bits are influenced by all 32
245          * (the first log2(TCP_ALIAS_HASH_SIZE) bits should be a mix of all
246          *  32)*/
247         h ^= h>>17;
248         h ^= h>>7;
249         return h & (TCP_ALIAS_HASH_SIZE-1);
250 }
251
252 #define tcp_id_hash(id) (id&(TCP_ID_HASH_SIZE-1))
253
254 struct tcp_connection* tcpconn_get(int id, struct ip_addr* ip, int port,
255                                                                         union sockaddr_union* local_addr,
256                                                                         ticks_t timeout);
257
258 #endif
259
260