Make seek information part of the xfer metadata, rather than an entirely
[people/mcb30/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 /**
64  * Free open file
65  *
66  * @v refcnt            Reference counter
67  */
68 static void posix_file_free ( struct refcnt *refcnt ) {
69         struct posix_file *file =
70                 container_of ( refcnt, struct posix_file, refcnt );
71         struct io_buffer *iobuf;
72         struct io_buffer *tmp;
73
74         list_for_each_entry_safe ( iobuf, tmp, &file->data, list ) {
75                 list_del ( &iobuf->list );
76                 free_iob ( iobuf );
77         }
78         free ( file );
79 }
80
81 /**
82  * Terminate file data transfer
83  *
84  * @v file              POSIX file
85  * @v rc                Reason for termination
86  */
87 static void posix_file_finished ( struct posix_file *file, int rc ) {
88         xfer_nullify ( &file->xfer );
89         xfer_close ( &file->xfer, rc );
90         file->rc = rc;
91 }
92
93 /**
94  * Handle close() event
95  *
96  * @v xfer              POSIX file data transfer interface
97  * @v rc                Reason for close
98  */
99 static void posix_file_xfer_close ( struct xfer_interface *xfer, int rc ) {
100         struct posix_file *file =
101                 container_of ( xfer, struct posix_file, xfer );
102
103         posix_file_finished ( file, rc );
104 }
105
106 /**
107  * Handle deliver_iob() event
108  *
109  * @v xfer              POSIX file data transfer interface
110  * @v iobuf             I/O buffer
111  * @v meta              Data transfer metadata
112  * @ret rc              Return status code
113  */
114 static int
115 posix_file_xfer_deliver_iob ( struct xfer_interface *xfer,
116                               struct io_buffer *iobuf,
117                               struct xfer_metadata *meta __unused ) {
118         struct posix_file *file =
119                 container_of ( xfer, struct posix_file, xfer );
120
121         /* Keep track of file position solely for the filesize */
122         if ( meta->whence != SEEK_CUR )
123                 file->pos = 0;
124         file->pos += meta->offset;
125         if ( file->filesize < file->pos )
126                 file->filesize = file->pos;
127
128         list_add_tail ( &iobuf->list, &file->data );
129         return 0;
130 }
131
132 /** POSIX file data transfer interface operations */
133 static struct xfer_interface_operations posix_file_xfer_operations = {
134         .close          = posix_file_xfer_close,
135         .vredirect      = xfer_vopen,
136         .window         = unlimited_xfer_window,
137         .alloc_iob      = default_xfer_alloc_iob,
138         .deliver_iob    = posix_file_xfer_deliver_iob,
139         .deliver_raw    = xfer_deliver_as_iob,
140 };
141
142 /**
143  * Identify file by file descriptor
144  *
145  * @v fd                File descriptor
146  * @ret file            Corresponding file, or NULL
147  */
148 static struct posix_file * posix_fd_to_file ( int fd ) {
149         struct posix_file *file;
150
151         list_for_each_entry ( file, &posix_files, list ) {
152                 if ( file->fd == fd )
153                         return file;
154         }
155         return NULL;
156 }
157
158 /**
159  * Find an available file descriptor
160  *
161  * @ret fd              File descriptor, or negative error number
162  */
163 static int posix_find_free_fd ( void ) {
164         int fd;
165
166         for ( fd = POSIX_FD_MIN ; fd <= POSIX_FD_MAX ; fd++ ) {
167                 if ( ! posix_fd_to_file ( fd ) )
168                         return fd;
169         }
170         DBG ( "POSIX could not find free file descriptor\n" );
171         return -ENFILE;
172 }
173
174 /**
175  * Open file
176  *
177  * @v uri_string        URI string
178  * @ret fd              File descriptor, or negative error number
179  */
180 int open ( const char *uri_string ) {
181         struct posix_file *file;
182         int fd;
183         int rc;
184
185         /* Find a free file descriptor to use */
186         fd = posix_find_free_fd();
187         if ( fd < 0 )
188                 return fd;
189
190         /* Allocate and initialise structure */
191         file = zalloc ( sizeof ( *file ) );
192         if ( ! file )
193                 return -ENOMEM;
194         file->refcnt.free = posix_file_free;
195         file->fd = fd;
196         file->rc = -EINPROGRESS;
197         xfer_init ( &file->xfer, &posix_file_xfer_operations,
198                     &file->refcnt );
199         INIT_LIST_HEAD ( &file->data );
200
201         /* Open URI on data transfer interface */
202         if ( ( rc = xfer_open_uri_string ( &file->xfer, uri_string ) ) != 0 )
203                 goto err;
204
205         /* Wait for open to succeed or fail */
206         while ( list_empty ( &file->data ) ) {
207                 step();
208                 if ( file->rc == 0 )
209                         break;
210                 if ( file->rc != -EINPROGRESS ) {
211                         rc = file->rc;
212                         goto err;
213                 }
214         }
215
216         /* Add to list of open files.  List takes reference ownership. */
217         list_add ( &file->list, &posix_files );
218         DBG ( "POSIX opened %s as file %d\n", uri_string, fd );
219         return fd;
220
221  err:
222         posix_file_finished ( file, rc );
223         ref_put ( &file->refcnt );
224         return rc;
225 }
226
227 /**
228  * Check file descriptors for readiness
229  *
230  * @v readfds           File descriptors to check
231  * @v wait              Wait until data is ready
232  * @ret nready          Number of ready file descriptors
233  */
234 int select ( fd_set *readfds, int wait ) {
235         struct posix_file *file;
236         int fd;
237
238         do {
239                 for ( fd = POSIX_FD_MIN ; fd <= POSIX_FD_MAX ; fd++ ) {
240                         if ( ! FD_ISSET ( fd, readfds ) )
241                                 continue;
242                         file = posix_fd_to_file ( fd );
243                         if ( ! file )
244                                 return -EBADF;
245                         if ( ( list_empty ( &file->data ) ) &&
246                              ( file->rc == -EINPROGRESS ) )
247                                 continue;
248                         /* Data is available or status has changed */
249                         FD_ZERO ( readfds );
250                         FD_SET ( fd, readfds );
251                         return 1;
252                 }
253                 step();
254         } while ( wait );
255
256         return 0;
257 }
258
259 /**
260  * Read data from file
261  *
262  * @v buffer            Data buffer
263  * @v offset            Starting offset within data buffer
264  * @v len               Maximum length to read
265  * @ret len             Actual length read, or negative error number
266  *
267  * This call is non-blocking; if no data is available to read then
268  * -EWOULDBLOCK will be returned.
269  */
270 ssize_t read_user ( int fd, userptr_t buffer, off_t offset, size_t max_len ) {
271         struct posix_file *file;
272         struct io_buffer *iobuf;
273         size_t len;
274
275         /* Identify file */
276         file = posix_fd_to_file ( fd );
277         if ( ! file )
278                 return -EBADF;
279
280         /* Try to fetch more data if none available */
281         if ( list_empty ( &file->data ) )
282                 step();
283
284         /* Dequeue at most one received I/O buffer into user buffer */
285         list_for_each_entry ( iobuf, &file->data, list ) {
286                 len = iob_len ( iobuf );
287                 if ( len > max_len )
288                         len = max_len;
289                 copy_to_user ( buffer, offset, iobuf->data, len );
290                 iob_pull ( iobuf, len );
291                 if ( ! iob_len ( iobuf ) ) {
292                         list_del ( &iobuf->list );
293                         free_iob ( iobuf );
294                 }
295                 file->pos += len;
296                 return len;
297         }
298
299         /* If file has completed, return (after returning all data) */
300         if ( file->rc != -EINPROGRESS )
301                 return file->rc;
302
303         /* No data ready and file still in progress; return -WOULDBLOCK */
304         return -EWOULDBLOCK;
305 }
306
307 /**
308  * Determine file size
309  *
310  * @v fd                File descriptor
311  * @ret size            File size, or negative error number
312  */
313 ssize_t fsize ( int fd ) {
314         struct posix_file *file;
315
316         /* Identify file */
317         file = posix_fd_to_file ( fd );
318         if ( ! file )
319                 return -EBADF;
320
321         return file->filesize;
322 }
323
324 /**
325  * Close file
326  *
327  * @v fd                File descriptor
328  * @ret rc              Return status code
329  */
330 int close ( int fd ) {
331         struct posix_file *file;
332
333         /* Identify file */
334         file = posix_fd_to_file ( fd );
335         if ( ! file )
336                 return -EBADF;
337
338         /* Terminate data transfer */
339         posix_file_finished ( file, 0 );
340
341         /* Remove from list of open files and drop reference */
342         list_del ( &file->list );
343         ref_put ( &file->refcnt );
344         return 0;
345 }