- tcp major changes part 1: support for >1024 connection, better io poll model
[sip-router] / pass_fd.c
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   *  2002-11-29  created by andrei
31   *  2003-02-20  added solaris support (! HAVE_MSGHDR_MSG_CONTROL) (andrei)
32   *  2003-11-03  added send_all, recv_all  and updated send/get_fd
33   *               to handle signals  (andrei)
34   *  2005-06-13  added flags to recv_all & receive_fd, to allow full blocking
35   *              or semi-nonblocking mode (andrei)
36   */
37
38 #ifdef USE_TCP
39
40 #include <sys/types.h>
41 #include <sys/socket.h>
42 #include <sys/uio.h>
43 #include <stdlib.h> /* for NULL definition on openbsd */
44 #include <errno.h>
45 #include <string.h>
46
47 #include "dprint.h"
48
49
50
51 /* receive all the data or returns error (handles EINTR etc.)
52  * params: socket
53  *         data     - buffer for the results
54  *         data_len - 
55  *         flags    - recv flags for the first recv (see recv(2)), only
56  *                    0, MSG_WAITALL and MSG_DONTWAIT make sense
57  * if flags is set to MSG_DONWAIT (or to 0 and the socket fd is non-blocking),
58  * and if no data is queued on the fd, recv_all will not wait (it will 
59  * return error and set errno to EAGAIN/EWOULDBLOCK). However if even 1 byte
60  *  is queued, the call will block until the whole data_len was read or an
61  *  error or eof occured ("semi-nonblocking" behaviour,  some tcp code
62  *   counts on it).
63  * if flags is set to MSG_WAITALL it will block even if no byte is available.
64  *  
65  * returns: bytes read or error (<0)
66  * can return < data_len if EOF */
67 int recv_all(int socket, void* data, int data_len, int flags)
68 {
69         int b_read;
70         int n;
71         
72         b_read=0;
73 again:
74         n=recv(socket, (char*)data, data_len, flags);
75         if (n<0){
76                 /* error */
77                 if (errno==EINTR) goto again; /* signal, try again */
78                 /* on EAGAIN just return (let the caller know) */
79                 if ((errno==EAGAIN)||(errno==EWOULDBLOCK)) return n;
80                         LOG(L_CRIT, "ERROR: recv_all: 1st recv on %d failed: %s\n",
81                                         socket, strerror(errno));
82                         return n;
83         }
84         b_read+=n;
85         while( (b_read!=data_len) && (n)){
86                 n=recv(socket, (char*)data+b_read, data_len-b_read, MSG_WAITALL);
87                 if (n<0){
88                         /* error */
89                         if (errno==EINTR) continue; /* signal, try again */
90                         LOG(L_CRIT, "ERROR: recv_all: 2nd recv on %d failed: %s\n",
91                                         socket, strerror(errno));
92                         return n;
93                 }
94                 b_read+=n;
95         }
96         return b_read;
97 }
98
99
100
101 /* sends all data (takes care of signals) (assumes blocking fd)
102  * returns number of bytes sent or < 0 for an error */
103 int send_all(int socket, void* data, int data_len)
104 {
105         int n;
106         
107 again:
108         n=send(socket, data, data_len, 0);
109         if (n<0){
110                         /* error */
111                 if (errno==EINTR) goto again; /* signal, try again */
112                 LOG(L_CRIT, "ERROR: send_all: send on %d failed: %s\n",
113                                         socket, strerror(errno));
114         }
115         return n;
116 }
117
118
119 /* at least 1 byte must be sent! */
120 int send_fd(int unix_socket, void* data, int data_len, int fd)
121 {
122         struct msghdr msg;
123         struct iovec iov[1];
124         int ret;
125 #ifdef HAVE_MSGHDR_MSG_CONTROL
126         struct cmsghdr* cmsg;
127         union {
128                 struct cmsghdr cm;
129                 char control[CMSG_SPACE(sizeof(fd))];
130         }control_un;
131         
132         msg.msg_control=control_un.control;
133         msg.msg_controllen=sizeof(control_un.control);
134         
135         cmsg=CMSG_FIRSTHDR(&msg);
136         cmsg->cmsg_level = SOL_SOCKET;
137         cmsg->cmsg_type = SCM_RIGHTS;
138         cmsg->cmsg_len = CMSG_LEN(sizeof(fd));
139         *(int*)CMSG_DATA(cmsg)=fd;
140         msg.msg_flags=0;
141 #else
142         msg.msg_accrights=(caddr_t) &fd;
143         msg.msg_accrightslen=sizeof(fd);
144 #endif
145         
146         msg.msg_name=0;
147         msg.msg_namelen=0;
148         
149         iov[0].iov_base=data;
150         iov[0].iov_len=data_len;
151         msg.msg_iov=iov;
152         msg.msg_iovlen=1;
153         
154 again:
155         ret=sendmsg(unix_socket, &msg, 0);
156         if (ret<0){
157                 if (errno==EINTR) goto again;
158                 LOG(L_CRIT, "ERROR: send_fd: sendmsg failed on %d: %s\n",
159                                 unix_socket, strerror(errno));
160         }
161         
162         return ret;
163 }
164
165
166
167 /* receives a fd and data_len data
168  * params: unix_socket 
169  *         data
170  *         data_len
171  *         fd         - will be set to the passed fd value or -1 if no fd
172  *                      was passed
173  *         flags      - 0, MSG_DONTWAIT, MSG_WAITALL; same as recv_all flags
174  * returns: bytes read on success, -1 on error (and sets errno) */
175 int receive_fd(int unix_socket, void* data, int data_len, int* fd, int flags)
176 {
177         struct msghdr msg;
178         struct iovec iov[1];
179         int new_fd;
180         int ret;
181         int n;
182 #ifdef HAVE_MSGHDR_MSG_CONTROL
183         struct cmsghdr* cmsg;
184         union{
185                 struct cmsghdr cm;
186                 char control[CMSG_SPACE(sizeof(new_fd))];
187         }control_un;
188         
189         msg.msg_control=control_un.control;
190         msg.msg_controllen=sizeof(control_un.control);
191 #else
192         msg.msg_accrights=(caddr_t) &new_fd;
193         msg.msg_accrightslen=sizeof(int);
194 #endif
195         
196         msg.msg_name=0;
197         msg.msg_namelen=0;
198         
199         iov[0].iov_base=data;
200         iov[0].iov_len=data_len;
201         msg.msg_iov=iov;
202         msg.msg_iovlen=1;
203         
204 again:
205         ret=recvmsg(unix_socket, &msg, flags);
206         if (ret<0){
207                 if (errno==EINTR) goto again;
208                 if ((errno==EAGAIN)||(errno==EWOULDBLOCK)) goto error;
209                 LOG(L_CRIT, "ERROR: receive_fd: recvmsg on %d failed: %s\n",
210                                 unix_socket, strerror(errno));
211                 goto error;
212         }
213         if (ret==0){
214                 /* EOF */
215                 LOG(L_CRIT, "ERROR: receive_fd: EOF on %d\n", unix_socket);
216                 goto error;
217         }
218         if (ret<data_len){
219                 LOG(L_WARN, "WARNING: receive_fd: too few bytes read (%d from %d)"
220                                     "trying to fix...\n", ret, data_len);
221                 /* blocking recv_all */
222                 n=recv_all(unix_socket, (char*)data+ret, data_len-ret, MSG_WAITALL);
223                 if (n>=0) ret+=n;
224                 else{
225                         ret=n;
226                         goto error;
227                 }
228         }
229         
230 #ifdef HAVE_MSGHDR_MSG_CONTROL
231         cmsg=CMSG_FIRSTHDR(&msg);
232         if ((cmsg!=0) && (cmsg->cmsg_len==CMSG_LEN(sizeof(new_fd)))){
233                 if (cmsg->cmsg_type!= SCM_RIGHTS){
234                         LOG(L_ERR, "ERROR: receive_fd: msg control type != SCM_RIGHTS\n");
235                         ret=-1;
236                         goto error;
237                 }
238                 if (cmsg->cmsg_level!= SOL_SOCKET){
239                         LOG(L_ERR, "ERROR: receive_fd: msg level != SOL_SOCKET\n");
240                         ret=-1;
241                         goto error;
242                 }
243                 *fd=*((int*) CMSG_DATA(cmsg));
244         }else{
245                 /*
246                 LOG(L_ERR, "ERROR: receive_fd: no descriptor passed, cmsg=%p,"
247                                 "len=%d\n", cmsg, (unsigned)cmsg->cmsg_len); */
248                 *fd=-1;
249                 /* it's not really an error */
250         }
251 #else
252         if (msg.msg_accrightslen==sizeof(int)){
253                 *fd=new_fd;
254         }else{
255                 /*LOG(L_ERR, "ERROR: receive_fd: no descriptor passed,"
256                                 " accrightslen=%d\n", msg.msg_accrightslen); */
257                 *fd=-1;
258         }
259 #endif
260         
261 error:
262         return ret;
263 }
264 #endif