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