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