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