Added some comments and prepared for W32 support
[gpgme.git] / gpgme / posix-io.c
1 /* posix-io.c - Posix I/O functions
2  *      Copyright (C) 2000 Werner Koch (dd9jn)
3  *
4  * This file is part of GPGME.
5  *
6  * GPGME is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GPGME is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #ifndef HAVE_DOSISH_SYSTEM
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <assert.h>
28 #include <errno.h>
29 #include <sys/time.h>
30 #include <sys/types.h>
31 #include <unistd.h>
32 #include <sys/wait.h>
33 #include <signal.h>
34 #include <fcntl.h>
35
36 #include "io.h"
37
38 #define DEBUG_SELECT_ENABLED 0
39
40 #if DEBUG_SELECT_ENABLED
41 # define DEBUG_SELECT(a) fprintf a
42 #else
43 # define DEBUG_SELECT(a) do { } while(0)
44 #endif
45
46
47 int
48 _gpgme_io_read ( int fd, void *buffer, size_t count )
49 {
50     int nread;
51
52     do {
53         nread = read (fd, buffer, count);
54     } while (nread == -1 && errno == EINTR );
55     return nread;
56 }
57
58
59 int
60 _gpgme_io_write ( int fd, const void *buffer, size_t count )
61 {
62     int nwritten;
63
64     do {
65         nwritten = write (fd, buffer, count);
66     } while (nwritten == -1 && errno == EINTR );
67     return nwritten;
68 }
69
70 int
71 _gpgme_io_pipe ( int filedes[2] )
72 {
73     return pipe ( filedes );
74 }
75
76
77 int
78 _gpgme_io_set_nonblocking ( int fd )
79 {
80     int flags;
81
82     flags = fcntl (fd, F_GETFL, 0);
83     if (flags == -1)
84         return -1;
85     flags |= O_NONBLOCK;
86     return fcntl (fd, F_SETFL, flags);
87 }
88
89
90 pid_t
91 _gpgme_io_spawn ( const char *path, char **argv,
92                   struct spawn_fd_item_s *fd_child_list,
93                   struct spawn_fd_item_s *fd_parent_list )
94 {
95     pid_t pid;
96     int i;
97     
98     pid = fork ();
99     if (pid == -1) 
100         return -1;
101
102     if ( !pid ) { /* child */
103         int duped_stdin = 0;
104         int duped_stderr = 0;
105
106         /* first close all fds which will not be duped */
107         for (i=0; fd_child_list[i].fd != -1; i++ ) {
108             if (fd_child_list[i].dup_to == -1 )
109                 close (fd_child_list[i].fd);
110         }
111         /* and now dup and close the rest */
112         for (i=0; fd_child_list[i].fd != -1; i++ ) {
113             if (fd_child_list[i].dup_to != -1 ) {
114                 if ( dup2 (fd_child_list[i].fd,
115                            fd_child_list[i].dup_to ) == -1 ) {
116                     fprintf (stderr, "dup2 failed in child: %s\n",
117                              strerror (errno));
118                     _exit (8);
119                 }
120                 if ( fd_child_list[i].dup_to == 0 )
121                     duped_stdin=1;
122                 if ( fd_child_list[i].dup_to == 2 )
123                     duped_stderr=1;
124                 close (fd_child_list[i].fd);
125             }
126         }
127
128         if( !duped_stdin || !duped_stderr ) {
129             int fd = open ( "/dev/null", O_RDONLY );
130             if ( fd == -1 ) {
131                 fprintf (stderr,"can't open `/dev/null': %s\n",
132                          strerror (errno) );
133                 _exit (8);
134             }
135             /* Make sure that the process has a connected stdin */
136             if ( !duped_stdin ) {
137                 if ( dup2 ( fd, 0 ) == -1 ) {
138                     fprintf (stderr,"dup2(/dev/null, 0) failed: %s\n",
139                              strerror (errno) );
140                     _exit (8);
141                 }
142             }
143             /* We normally don't want all the normal output */
144             if ( !duped_stderr ) {
145                 if (!getenv ("GPGME_DEBUG") ) {
146                     if ( dup2 ( fd, 2 ) == -1 ) {
147                         fprintf (stderr,"dup2(dev/null, 2) failed: %s\n",
148                                  strerror (errno) );
149                         _exit (8);
150                     }
151                 }
152             }
153             close (fd);
154         }
155
156         execv ( path, argv );
157         /* Hmm: in that case we could write a special status code to the
158          * status-pipe */
159         fprintf (stderr,"exec of `%s' failed\n", path );
160         _exit (8);
161     } /* end child */
162     
163     /* .dup_to is not used in the parent list */
164     for (i=0; fd_parent_list[i].fd != -1; i++ ) {
165         close (fd_parent_list[i].fd);
166     }
167
168     return pid;
169 }
170
171
172 int
173 _gpgme_io_waitpid ( pid_t pid, int hang, int *r_status, int *r_signal )
174 {
175     int status;
176
177     *r_status = 0;
178     *r_signal = 0;
179     if ( waitpid ( pid, &status, hang? 0 : WNOHANG ) == pid ) {
180         if ( WIFSIGNALED (status) ) {
181             *r_status = 4; /* Need some value here */
182             *r_signal = WTERMSIG (status);
183         }
184         else if ( WIFEXITED (status) ) {
185             *r_status = WEXITSTATUS (status);
186         }
187         else {
188             *r_status = 4; /* oops */
189         }
190         return 1;
191     }
192     return 0;
193 }
194
195
196 /*
197  * Select on the list of fds.
198  * Returns: -1 = error
199  *           0 = timeout or nothing to select
200  *          >0 = number of signaled fds
201  */
202 int
203 _gpgme_io_select ( struct io_select_fd_s *fds, size_t nfds )
204 {
205     static fd_set readfds;
206     static fd_set writefds;
207     int any, i, max_fd, n, count;
208     struct timeval timeout = { 1, 0 }; /* Use a one second timeout */
209     
210     FD_ZERO ( &readfds );
211     FD_ZERO ( &writefds );
212     max_fd = 0;
213
214     DEBUG_SELECT ((stderr, "gpgme:select on [ "));
215     any = 0;
216     for ( i=0; i < nfds; i++ ) {
217         if ( fds[i].fd == -1 ) 
218             continue;
219         if ( fds[i].for_read ) {
220             assert ( !FD_ISSET ( fds[i].fd, &readfds ) );
221             FD_SET ( fds[i].fd, &readfds );
222             if ( fds[i].fd > max_fd )
223                 max_fd = fds[i].fd;
224             DEBUG_SELECT ((stderr, "r%d ", fds[i].fd ));
225             any = 1;
226         }
227         else if ( fds[i].for_write ) {
228             assert ( !FD_ISSET ( fds[i].fd, &writefds ) );
229             FD_SET ( fds[i].fd, &writefds );
230             if ( fds[i].fd > max_fd )
231                 max_fd = fds[i].fd;
232             DEBUG_SELECT ((stderr, "w%d ", fds[i].fd ));
233             any = 1;
234         }
235         fds[i].signaled = 0;
236     }
237     DEBUG_SELECT ((stderr, "]\n" ));
238     if ( !any )
239         return 0;
240
241     do {
242         count = select ( max_fd+1, &readfds, &writefds, NULL, &timeout );
243     } while ( count < 0 && errno == EINTR);
244     if ( count < 0 ) {
245         fprintf (stderr, "_gpgme_io_select failed: %s\n", strerror (errno) );
246         return -1; /* error */
247     }
248
249 #if DEBUG_SELECT_ENABLED
250     fprintf (stderr, "gpgme:select OK [ " );
251     for (i=0; i <= max_fd; i++ ) {
252         if (FD_ISSET (i, &readfds) )
253             fprintf (stderr, "r%d ", i );
254         if (FD_ISSET (i, &writefds) )
255             fprintf (stderr, "w%d ", i );
256     }
257     fprintf (stderr, "]\n" );
258 #endif
259     
260     /* n is used to optimize it a little bit */
261     for ( n=count, i=0; i < nfds && n ; i++ ) {
262         if ( fds[i].fd == -1 ) 
263             ;
264         else if ( fds[i].for_read ) {
265             if ( FD_ISSET ( fds[i].fd, &readfds ) ) {
266                 fds[i].signaled = 1;
267                 n--;
268             }
269         }
270         else if ( fds[i].for_write ) {
271             if ( FD_ISSET ( fds[i].fd, &writefds ) ) {
272                 fds[i].signaled = 1;
273                 n--;
274             }
275         }
276     }
277     return count;
278 }
279
280
281 #endif /*!HAVE_DOSISH_SYSTEM*/
282
283
284