b98766f8da81e60fb1fc219b023120d48867af27
[gpxe.git] / src / core / posix_io.c
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <stdlib.h>
20 #include <string.h>
21 #include <errno.h>
22 #include <gpxe/list.h>
23 #include <gpxe/xfer.h>
24 #include <gpxe/open.h>
25 #include <gpxe/process.h>
26 #include <gpxe/posix_io.h>
27
28 /** @file
29  *
30  * POSIX-like I/O
31  *
32  * These functions provide traditional blocking I/O semantics.  They
33  * are designed to be used by the PXE TFTP API.  Because they block,
34  * they may not be used by most other portions of the gPXE codebase.
35  */
36
37 /** An open file */
38 struct posix_file {
39         /** Reference count for this object */
40         struct refcnt refcnt;
41         /** List of open files */
42         struct list_head list;
43         /** File descriptor */
44         int fd;
45         /** Overall status
46          *
47          * Set to -EINPROGRESS while data transfer is in progress.
48          */
49         int rc;
50         /** Data transfer interface */
51         struct xfer_interface xfer;
52         /** Current seek position */
53         size_t pos;
54         /** File size */
55         size_t filesize;
56         /** Received data queue */
57         struct list_head data;
58 };
59
60 /** List of open files */
61 static LIST_HEAD ( posix_files );
62
63 /** Minimum file descriptor that will ever be allocated */
64 #define POSIX_FD_MIN ( 1 )
65
66 /** Maximum file descriptor that will ever be allocated */
67 #define POSIX_FD_MAX ( 255 )
68
69 /**
70  * Free open file
71  *
72  * @v refcnt            Reference counter
73  */
74 static void posix_file_free ( struct refcnt *refcnt ) {
75         struct posix_file *file =
76                 container_of ( refcnt, struct posix_file, refcnt );
77         struct io_buffer *iobuf;
78         struct io_buffer *tmp;
79
80         list_for_each_entry_safe ( iobuf, tmp, &file->data, list ) {
81                 free_iob ( iobuf );
82         }
83         free ( file );
84 }
85
86 /**
87  * Terminate file data transfer
88  *
89  * @v file              POSIX file
90  * @v rc                Reason for termination
91  */
92 static void posix_file_finished ( struct posix_file *file, int rc ) {
93         xfer_nullify ( &file->xfer );
94         xfer_close ( &file->xfer, rc );
95         file->rc = rc;
96 }
97
98 /**
99  * Handle close() event
100  *
101  * @v xfer              POSIX file data transfer interface
102  * @v rc                Reason for close
103  */
104 static void posix_file_xfer_close ( struct xfer_interface *xfer, int rc ) {
105         struct posix_file *file =
106                 container_of ( xfer, struct posix_file, xfer );
107
108         posix_file_finished ( file, rc );
109 }
110
111 /**
112  * Handle seek() event
113  *
114  * @v xfer              POSIX file data transfer interface
115  * @v pos               New position
116  * @ret rc              Return status code
117  */
118 static int posix_file_xfer_seek ( struct xfer_interface *xfer, off_t offset,
119                                   int whence ) {
120         struct posix_file *file =
121                 container_of ( xfer, struct posix_file, xfer );
122
123         switch ( whence ) {
124         case SEEK_SET:
125                 file->pos = offset;
126                 break;
127         case SEEK_CUR:
128                 file->pos += offset;
129                 break;
130         }
131
132         if ( file->filesize < file->pos )
133                 file->filesize = file->pos;
134
135         return 0;
136 }
137
138 /**
139  * Handle deliver_iob() event
140  *
141  * @v xfer              POSIX file data transfer interface
142  * @v iobuf             I/O buffer
143  * @ret rc              Return status code
144  */
145 static int posix_file_xfer_deliver_iob ( struct xfer_interface *xfer,
146                                          struct io_buffer *iobuf ) {
147         struct posix_file *file =
148                 container_of ( xfer, struct posix_file, xfer );
149
150         list_add_tail ( &iobuf->list, &file->data );
151         return 0;
152 }
153
154 /** POSIX file data transfer interface operations */
155 static struct xfer_interface_operations posix_file_xfer_operations = {
156         .close          = posix_file_xfer_close,
157         .vredirect      = xfer_vopen,
158         .request        = ignore_xfer_request,
159         .seek           = posix_file_xfer_seek,
160         .alloc_iob      = default_xfer_alloc_iob,
161         .deliver_iob    = posix_file_xfer_deliver_iob,
162         .deliver_raw    = xfer_deliver_as_iob,
163 };
164
165 /**
166  * Identify file by file descriptor
167  *
168  * @v fd                File descriptor
169  * @ret file            Corresponding file, or NULL
170  */
171 static struct posix_file * posix_fd_to_file ( int fd ) {
172         struct posix_file *file;
173
174         list_for_each_entry ( file, &posix_files, list ) {
175                 if ( file->fd == fd )
176                         return file;
177         }
178         return NULL;
179 }
180
181 /**
182  * Find an available file descriptor
183  *
184  * @ret fd              File descriptor, or negative error number
185  */
186 static int posix_find_free_fd ( void ) {
187         int fd;
188
189         for ( fd = POSIX_FD_MIN ; fd <= POSIX_FD_MAX ; fd++ ) {
190                 if ( ! posix_fd_to_file ( fd ) )
191                         return fd;
192         }
193         return -ENFILE;
194 }
195
196 /**
197  * Open file
198  *
199  * @v uri_string        URI string
200  * @ret fd              File descriptor, or negative error number
201  */
202 int open ( const char *uri_string ) {
203         struct posix_file *file;
204         int fd;
205         int rc;
206
207         /* Find a free file descriptor to use */
208         fd = posix_find_free_fd();
209         if ( fd < 0 )
210                 return fd;
211
212         /* Allocate and initialise structure */
213         file = malloc ( sizeof ( *file ) );
214         if ( ! file )
215                 return -ENOMEM;
216         memset ( file, 0, sizeof ( *file ) );
217         file->refcnt.free = posix_file_free;
218         file->fd = fd;
219         file->rc = -EINPROGRESS;
220         xfer_init ( &file->xfer, &posix_file_xfer_operations,
221                     &file->refcnt );
222         INIT_LIST_HEAD ( &file->data );
223
224         /* Open URI on data transfer interface */
225         if ( ( rc = xfer_open_uri ( &file->xfer, uri_string ) ) != 0 )
226                 goto err;
227
228         /* Request data */
229         if ( ( rc = xfer_request_all ( &file->xfer ) ) != 0 )
230                 goto err;
231
232         /* Wait for open to succeed or fail */
233         while ( list_empty ( &file->data ) ) {
234                 step();
235                 if ( file->rc != -EINPROGRESS ) {
236                         rc = file->rc;
237                         goto err;
238                 }
239         }
240
241         /* Add to list of open files.  List takes reference ownership. */
242         list_add ( &file->list, &posix_files );
243         return fd;
244
245  err:
246         posix_file_finished ( file, rc );
247         ref_put ( &file->refcnt );
248         return rc;
249 }
250
251 /**
252  * Read data from file
253  *
254  * @v buffer            Data buffer
255  * @v offset            Starting offset within data buffer
256  * @v len               Maximum length to read
257  * @ret len             Actual length read, or negative error number
258  */
259 ssize_t read_user ( int fd, userptr_t buffer, off_t offset, size_t max_len ) {
260         struct posix_file *file;
261         struct io_buffer *iobuf;
262         size_t frag_len;
263         ssize_t len = 0;
264
265         /* Identify file */
266         file = posix_fd_to_file ( fd );
267         if ( ! file )
268                 return -EBADF;
269
270         while ( 1 ) {
271                 /* Try to fetch more data if none available */
272                 if ( list_empty ( &file->data ) )
273                         step();
274                 /* Dequeue at most one received I/O buffer into user buffer */
275                 list_for_each_entry ( iobuf, &file->data, list ) {
276                         frag_len = iob_len ( iobuf );
277                         if ( frag_len > max_len )
278                                 frag_len = max_len;
279                         copy_to_user ( buffer, offset, iobuf->data,
280                                        frag_len );
281                         iob_pull ( iobuf, frag_len );
282                         if ( ! iob_len ( iobuf ) )
283                                 free_iob ( iobuf );
284                         file->pos += frag_len;
285                         len += frag_len;
286                         offset += frag_len;
287                         max_len -= frag_len;
288                         break;
289                 }
290                 /* If buffer is full, return */
291                 if ( ! max_len )
292                         return len;
293                 /* If file has completed, return */
294                 if ( file->rc != -EINPROGRESS )
295                         return ( file->rc ? file->rc : len );
296         }
297 }
298
299 /**
300  * Determine file size
301  *
302  * @v fd                File descriptor
303  * @ret size            File size, or negative error number
304  */
305 ssize_t fsize ( int fd ) {
306         struct posix_file *file;
307
308         /* Identify file */
309         file = posix_fd_to_file ( fd );
310         if ( ! file )
311                 return -EBADF;
312
313         return file->filesize;
314 }
315
316 /**
317  * Close file
318  *
319  * @v fd                File descriptor
320  * @ret rc              Return status code
321  */
322 int close ( int fd ) {
323         struct posix_file *file;
324
325         /* Identify file */
326         file = posix_fd_to_file ( fd );
327         if ( ! file )
328                 return -EBADF;
329
330         /* Terminate data transfer */
331         posix_file_finished ( file, 0 );
332
333         /* Remove from list of open files and drop reference */
334         list_del ( &file->list );
335         ref_put ( &file->refcnt );
336         return 0;
337 }