pv(k): use $TV(Sn) for string timeval
[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   *  2008-04-30  added MSG_WAITALL emulation for cygwin (andrei)
37   */
38
39 /*!
40  * \file
41  * \brief SIP-router core :: 
42  * \ingroup core
43  * Module: \ref core
44  */
45
46 #ifdef USE_TCP
47
48 #include "pass_fd.h"
49
50 #include <sys/types.h>
51 #include <sys/socket.h>
52 #include <sys/uio.h>
53 #include <stdlib.h> /* for NULL definition on openbsd */
54 #include <errno.h>
55 #include <string.h>
56 #ifdef NO_MSG_WAITALL
57 #include <poll.h>
58 #endif /* NO_MSG_WAITALL */
59
60 #include "dprint.h"
61
62
63
64 /* receive all the data or returns error (handles EINTR etc.)
65  * params: socket
66  *         data     - buffer for the results
67  *         data_len - 
68  *         flags    - recv flags for the first recv (see recv(2)), only
69  *                    0, MSG_WAITALL and MSG_DONTWAIT make sense
70  * if flags is set to MSG_DONWAIT (or to 0 and the socket fd is non-blocking),
71  * and if no data is queued on the fd, recv_all will not wait (it will 
72  * return error and set errno to EAGAIN/EWOULDBLOCK). However if even 1 byte
73  *  is queued, the call will block until the whole data_len was read or an
74  *  error or eof occured ("semi-nonblocking" behaviour,  some tcp code
75  *   counts on it).
76  * if flags is set to MSG_WAITALL it will block even if no byte is available.
77  *  
78  * returns: bytes read or error (<0)
79  * can return < data_len if EOF */
80 int recv_all(int socket, void* data, int data_len, int flags)
81 {
82         int b_read;
83         int n;
84 #ifdef NO_MSG_WAITALL
85         struct pollfd pfd;
86 #endif /* NO_MSG_WAITALL */
87         
88         b_read=0;
89 again:
90 #ifdef NO_MSG_WAITALL
91         if (flags & MSG_WAITALL){
92                 n=-1;
93                 goto poll_recv; /* simulate MSG_WAITALL */
94         }
95 #endif /* NO_MSG_WAITALL */
96         n=recv(socket, (char*)data, data_len, flags);
97         if (n<0){
98                 /* error */
99                 if (errno==EINTR) goto again; /* signal, try again */
100                 /* on EAGAIN just return (let the caller know) */
101                 if ((errno==EAGAIN)||(errno==EWOULDBLOCK)) return n;
102                         LOG(L_CRIT, "ERROR: recv_all: 1st recv on %d failed: %s\n",
103                                         socket, strerror(errno));
104                         return n;
105         }
106         b_read+=n;
107         while( (b_read!=data_len) && (n)){
108 #ifdef NO_MSG_WAITALL
109                 /* cygwin & win do not support MSG_WAITALL => workaround using poll */
110 poll_recv:
111                 n=recv(socket, (char*)data+b_read, data_len-b_read, 0);
112 #else /* NO_MSG_WAITALL */
113                 n=recv(socket, (char*)data+b_read, data_len-b_read, MSG_WAITALL);
114 #endif /* NO_MSG_WAITALL */
115                 if (n<0){
116                         /* error */
117                         if (errno==EINTR) continue; /* signal, try again */
118 #ifdef NO_MSG_WAITALL
119                         if (errno==EAGAIN || errno==EWOULDBLOCK){
120                                 /* emulate MSG_WAITALL using poll */
121                                 pfd.fd=socket;
122                                 pfd.events=POLLIN;
123 poll_retry:
124                                 n=poll(&pfd, 1, -1);
125                                 if (n<0){ 
126                                         if (errno==EINTR) goto poll_retry;
127                                         LOG(L_CRIT, "ERROR: recv_all: poll on %d failed: %s\n",
128                                                                 socket, strerror(errno));
129                                         return n;
130                                 } else continue; /* try recv again */
131                         }
132 #endif /* NO_MSG_WAITALL */
133                         LOG(L_CRIT, "ERROR: recv_all: 2nd recv on %d failed: %s\n",
134                                         socket, strerror(errno));
135                         return n;
136                 }
137                 b_read+=n;
138         }
139         return b_read;
140 }
141
142
143
144 /* sends all data (takes care of signals) (assumes blocking fd)
145  * returns number of bytes sent or < 0 for an error */
146 int send_all(int socket, void* data, int data_len)
147 {
148         int n;
149         
150 again:
151         n=send(socket, data, data_len, 0);
152         if (n<0){
153                         /* error */
154                 if (errno==EINTR) goto again; /* signal, try again */
155                 if ((errno!=EAGAIN) &&(errno!=EWOULDBLOCK))
156                         LOG(L_CRIT, "ERROR: send_all: send on %d failed: %s\n",
157                                         socket, strerror(errno));
158         }
159         return n;
160 }
161
162
163 /* at least 1 byte must be sent! */
164 int send_fd(int unix_socket, void* data, int data_len, int fd)
165 {
166         struct msghdr msg;
167         struct iovec iov[1];
168         int ret;
169 #ifdef HAVE_MSGHDR_MSG_CONTROL
170         struct cmsghdr* cmsg;
171         /* make sure msg_control will point to properly aligned data */
172         union {
173                 struct cmsghdr cm;
174                 char control[CMSG_SPACE(sizeof(fd))];
175         }control_un;
176         
177         msg.msg_control=control_un.control;
178         /* openbsd doesn't like "more space", msg_controllen must not
179          * include the end padding */
180         msg.msg_controllen=CMSG_LEN(sizeof(fd));
181         
182         cmsg=CMSG_FIRSTHDR(&msg);
183         cmsg->cmsg_level = SOL_SOCKET;
184         cmsg->cmsg_type = SCM_RIGHTS;
185         cmsg->cmsg_len = CMSG_LEN(sizeof(fd));
186         *(int*)CMSG_DATA(cmsg)=fd;
187         msg.msg_flags=0;
188 #else
189         msg.msg_accrights=(caddr_t) &fd;
190         msg.msg_accrightslen=sizeof(fd);
191 #endif
192         
193         msg.msg_name=0;
194         msg.msg_namelen=0;
195         
196         iov[0].iov_base=data;
197         iov[0].iov_len=data_len;
198         msg.msg_iov=iov;
199         msg.msg_iovlen=1;
200         
201 again:
202         ret=sendmsg(unix_socket, &msg, 0);
203         if (ret<0){
204                 if (errno==EINTR) goto again;
205                 if ((errno!=EAGAIN) && (errno!=EWOULDBLOCK))
206                         LOG(L_CRIT, "ERROR: send_fd: sendmsg failed on %d: %s\n",
207                                         unix_socket, strerror(errno));
208         }
209         
210         return ret;
211 }
212
213
214
215 /* receives a fd and data_len data
216  * params: unix_socket 
217  *         data
218  *         data_len
219  *         fd         - will be set to the passed fd value or -1 if no fd
220  *                      was passed
221  *         flags      - 0, MSG_DONTWAIT, MSG_WAITALL; same as recv_all flags
222  * returns: bytes read on success, -1 on error (and sets errno) */
223 int receive_fd(int unix_socket, void* data, int data_len, int* fd, int flags)
224 {
225         struct msghdr msg;
226         struct iovec iov[1];
227         int new_fd;
228         int ret;
229         int n;
230 #ifdef NO_MSG_WAITALL
231         struct pollfd pfd;
232         int f;
233 #endif /*NO_MSG_WAITALL */
234 #ifdef HAVE_MSGHDR_MSG_CONTROL
235         struct cmsghdr* cmsg;
236         union{
237                 struct cmsghdr cm;
238                 char control[CMSG_SPACE(sizeof(new_fd))];
239         }control_un;
240         
241         msg.msg_control=control_un.control;
242         msg.msg_controllen=sizeof(control_un.control);
243 #else
244         msg.msg_accrights=(caddr_t) &new_fd;
245         msg.msg_accrightslen=sizeof(int);
246 #endif
247         
248         msg.msg_name=0;
249         msg.msg_namelen=0;
250         
251         iov[0].iov_base=data;
252         iov[0].iov_len=data_len;
253         msg.msg_iov=iov;
254         msg.msg_iovlen=1;
255         
256 #ifdef NO_MSG_WAITALL
257         f=flags & ~MSG_WAITALL;
258 #endif /* NO_MSG_WAITALL */
259
260 again:
261 #ifdef NO_MSG_WAITALL
262                 ret=recvmsg(unix_socket, &msg, f);
263 #else /* NO_MSG_WAITALL */
264                 ret=recvmsg(unix_socket, &msg, flags);
265 #endif /* NO_MSG_WAITALL */
266         if (ret<0){
267                 if (errno==EINTR) goto again;
268                 if ((errno==EAGAIN)||(errno==EWOULDBLOCK)){
269 #ifdef NO_MSG_WAITALL
270                         if (flags & MSG_WAITALL){
271                                 /* emulate MSG_WAITALL using poll */
272                                 pfd.fd=unix_socket;
273                                 pfd.events=POLLIN;
274 poll_again:
275                                 ret=poll(&pfd, 1, -1);
276                                 if (ret>=0) goto again;
277                                 else if (errno==EINTR) goto poll_again;
278                                 LOG(L_CRIT, "ERROR: receive_fd: poll on %d failed: %s\n",
279                                                         unix_socket, strerror(errno));
280                         }
281 #endif /* NO_MSG_WAITALL */
282                         goto error;
283                 }
284                 LOG(L_CRIT, "ERROR: receive_fd: recvmsg on %d failed: %s\n",
285                                 unix_socket, strerror(errno));
286                 goto error;
287         }
288         if (ret==0){
289                 /* EOF */
290                 LOG(L_CRIT, "ERROR: receive_fd: EOF on %d\n", unix_socket);
291                 goto error;
292         }
293         if (ret<data_len){
294                 LOG(L_WARN, "WARNING: receive_fd: too few bytes read (%d from %d)"
295                                     "trying to fix...\n", ret, data_len);
296                 /* blocking recv_all */
297                 n=recv_all(unix_socket, (char*)data+ret, data_len-ret, MSG_WAITALL);
298                 if (n>=0) ret+=n;
299                 else{
300                         ret=n;
301                         goto error;
302                 }
303         }
304         
305 #ifdef HAVE_MSGHDR_MSG_CONTROL
306         cmsg=CMSG_FIRSTHDR(&msg);
307         if ((cmsg!=0) && (cmsg->cmsg_len==CMSG_LEN(sizeof(new_fd)))){
308                 if (cmsg->cmsg_type!= SCM_RIGHTS){
309                         LOG(L_ERR, "ERROR: receive_fd: msg control type != SCM_RIGHTS\n");
310                         ret=-1;
311                         goto error;
312                 }
313                 if (cmsg->cmsg_level!= SOL_SOCKET){
314                         LOG(L_ERR, "ERROR: receive_fd: msg level != SOL_SOCKET\n");
315                         ret=-1;
316                         goto error;
317                 }
318                 *fd=*((int*) CMSG_DATA(cmsg));
319         }else{
320                 /*
321                 LOG(L_ERR, "ERROR: receive_fd: no descriptor passed, cmsg=%p,"
322                                 "len=%d\n", cmsg, (unsigned)cmsg->cmsg_len); */
323                 *fd=-1;
324                 /* it's not really an error */
325         }
326 #else
327         if (msg.msg_accrightslen==sizeof(int)){
328                 *fd=new_fd;
329         }else{
330                 /*LOG(L_ERR, "ERROR: receive_fd: no descriptor passed,"
331                                 " accrightslen=%d\n", msg.msg_accrightslen); */
332                 *fd=-1;
333         }
334 #endif
335         
336 error:
337         return ret;
338 }
339 #endif