- Add a default asynchronous I/O implementation.
[wine] / server / file.c
1 /*
2  * Server-side file management
3  *
4  * Copyright (C) 1998 Alexandre Julliard
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library 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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; 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 #include "wine/port.h"
23
24 #include <assert.h>
25 #include <fcntl.h>
26 #include <stdarg.h>
27 #include <stdio.h>
28 #include <string.h>
29 #include <stdlib.h>
30 #include <errno.h>
31 #ifdef HAVE_SYS_ERRNO_H
32 #include <sys/errno.h>
33 #endif
34 #include <sys/stat.h>
35 #include <sys/time.h>
36 #include <sys/types.h>
37 #include <time.h>
38 #include <unistd.h>
39 #ifdef HAVE_UTIME_H
40 #include <utime.h>
41 #endif
42 #ifdef HAVE_POLL_H
43 #include <poll.h>
44 #endif
45
46 #include "winerror.h"
47 #include "windef.h"
48 #include "winbase.h"
49 #include "winreg.h"
50 #include "winternl.h"
51
52 #include "file.h"
53 #include "handle.h"
54 #include "thread.h"
55 #include "request.h"
56
57 struct file
58 {
59     struct object       obj;        /* object header */
60     struct fd          *fd;         /* file descriptor for this file */
61     unsigned int        access;     /* file access (GENERIC_READ/WRITE) */
62     unsigned int        options;    /* file options (FILE_DELETE_ON_CLOSE, FILE_SYNCHRONOUS...) */
63 };
64
65 static void file_dump( struct object *obj, int verbose );
66 static struct fd *file_get_fd( struct object *obj );
67 static void file_destroy( struct object *obj );
68
69 static int file_get_poll_events( struct fd *fd );
70 static int file_flush( struct fd *fd, struct event **event );
71 static int file_get_info( struct fd *fd );
72
73 static const struct object_ops file_ops =
74 {
75     sizeof(struct file),          /* size */
76     file_dump,                    /* dump */
77     default_fd_add_queue,         /* add_queue */
78     default_fd_remove_queue,      /* remove_queue */
79     default_fd_signaled,          /* signaled */
80     no_satisfied,                 /* satisfied */
81     no_signal,                    /* signal */
82     file_get_fd,                  /* get_fd */
83     file_destroy                  /* destroy */
84 };
85
86 static const struct fd_ops file_fd_ops =
87 {
88     file_get_poll_events,         /* get_poll_events */
89     default_poll_event,           /* poll_event */
90     file_flush,                   /* flush */
91     file_get_info,                /* get_file_info */
92     default_fd_queue_async,       /* queue_async */
93     default_fd_cancel_async       /* cancel_async */
94 };
95
96 static inline int is_overlapped( const struct file *file )
97 {
98     return !(file->options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT));
99 }
100
101 /* create a file from a file descriptor */
102 /* if the function fails the fd is closed */
103 static struct file *create_file_for_fd( int fd, unsigned int access, unsigned int sharing )
104 {
105     struct file *file;
106
107     if ((file = alloc_object( &file_ops )))
108     {
109         file->access     = access;
110         file->options    = FILE_SYNCHRONOUS_IO_NONALERT;
111         if (!(file->fd = create_anonymous_fd( &file_fd_ops, fd, &file->obj )))
112         {
113             release_object( file );
114             return NULL;
115         }
116     }
117     return file;
118 }
119
120
121 static struct object *create_file( const char *nameptr, size_t len, unsigned int access,
122                                    unsigned int sharing, int create, unsigned int options,
123                                    unsigned int attrs )
124 {
125     struct file *file;
126     int flags;
127     char *name;
128     mode_t mode;
129
130     if (!(name = mem_alloc( len + 1 ))) return NULL;
131     memcpy( name, nameptr, len );
132     name[len] = 0;
133
134     switch(create)
135     {
136     case FILE_CREATE:       flags = O_CREAT | O_EXCL; break;
137     case FILE_OVERWRITE_IF: /* FIXME: the difference is whether we trash existing attr or not */
138     case FILE_SUPERSEDE:    flags = O_CREAT | O_TRUNC; break;
139     case FILE_OPEN:         flags = 0; break;
140     case FILE_OPEN_IF:      flags = O_CREAT; break;
141     case FILE_OVERWRITE:    flags = O_TRUNC; break;
142     default:                set_error( STATUS_INVALID_PARAMETER ); goto error;
143     }
144
145     switch(access & (GENERIC_READ | GENERIC_WRITE))
146     {
147     case 0: break;
148     case GENERIC_READ:  flags |= O_RDONLY; break;
149     case GENERIC_WRITE: flags |= O_WRONLY; break;
150     case GENERIC_READ|GENERIC_WRITE: flags |= O_RDWR; break;
151     }
152     mode = (attrs & FILE_ATTRIBUTE_READONLY) ? 0444 : 0666;
153
154     if (len >= 4 &&
155         (!strcasecmp( name + len - 4, ".exe" ) || !strcasecmp( name + len - 4, ".com" )))
156         mode |= 0111;
157
158     if (!(file = alloc_object( &file_ops ))) goto error;
159
160     file->access     = access;
161     file->options    = options;
162
163     /* FIXME: should set error to STATUS_OBJECT_NAME_COLLISION if file existed before */
164     if (!(file->fd = alloc_fd( &file_fd_ops, &file->obj )) ||
165         !(file->fd = open_fd( file->fd, name, flags | O_NONBLOCK | O_LARGEFILE,
166                               &mode, access, sharing, options )))
167     {
168         free( name );
169         release_object( file );
170         return NULL;
171     }
172     free( name );
173
174     /* check for serial port */
175     if (S_ISCHR(mode) && is_serial_fd( file->fd ))
176     {
177         struct object *obj = create_serial( file->fd, file->options );
178         release_object( file );
179         return obj;
180     }
181
182     return &file->obj;
183
184  error:
185     free( name );
186     return NULL;
187 }
188
189 /* check if two file objects point to the same file */
190 int is_same_file( struct file *file1, struct file *file2 )
191 {
192     return is_same_file_fd( file1->fd, file2->fd );
193 }
194
195 /* create a temp file for anonymous mappings */
196 struct file *create_temp_file( int access )
197 {
198     char tmpfn[16];
199     int fd;
200
201     sprintf( tmpfn, "anonmap.XXXXXX" );  /* create it in the server directory */
202     fd = mkstemps( tmpfn, 0 );
203     if (fd == -1)
204     {
205         file_set_error();
206         return NULL;
207     }
208     unlink( tmpfn );
209     return create_file_for_fd( fd, access, 0 );
210 }
211
212 static void file_dump( struct object *obj, int verbose )
213 {
214     struct file *file = (struct file *)obj;
215     assert( obj->ops == &file_ops );
216     fprintf( stderr, "File fd=%p options=%08x\n", file->fd, file->options );
217 }
218
219 static int file_get_poll_events( struct fd *fd )
220 {
221     struct file *file = get_fd_user( fd );
222     int events = 0;
223     assert( file->obj.ops == &file_ops );
224     if (file->access & GENERIC_READ) events |= POLLIN;
225     if (file->access & GENERIC_WRITE) events |= POLLOUT;
226     return events;
227 }
228
229 static int file_flush( struct fd *fd, struct event **event )
230 {
231     int ret = (fsync( get_unix_fd(fd) ) != -1);
232     if (!ret) file_set_error();
233     return ret;
234 }
235
236 static int file_get_info( struct fd *fd )
237 {
238     struct file *file = get_fd_user( fd );
239
240     if (is_overlapped( file )) return FD_FLAG_OVERLAPPED;
241     else return 0;
242 }
243
244 static struct fd *file_get_fd( struct object *obj )
245 {
246     struct file *file = (struct file *)obj;
247     assert( obj->ops == &file_ops );
248     return (struct fd *)grab_object( file->fd );
249 }
250
251 static void file_destroy( struct object *obj )
252 {
253     struct file *file = (struct file *)obj;
254     assert( obj->ops == &file_ops );
255
256     if (file->fd) release_object( file->fd );
257 }
258
259 /* set the last error depending on errno */
260 void file_set_error(void)
261 {
262     switch (errno)
263     {
264     case EAGAIN:    set_error( STATUS_SHARING_VIOLATION ); break;
265     case EBADF:     set_error( STATUS_INVALID_HANDLE ); break;
266     case ENOSPC:    set_error( STATUS_DISK_FULL ); break;
267     case EACCES:
268     case ESRCH:
269     case EPERM:     set_error( STATUS_ACCESS_DENIED ); break;
270     case EROFS:     set_error( STATUS_MEDIA_WRITE_PROTECTED ); break;
271     case EBUSY:     set_error( STATUS_FILE_LOCK_CONFLICT ); break;
272     case ENOENT:    set_error( STATUS_NO_SUCH_FILE ); break;
273     case EISDIR:    set_error( STATUS_FILE_IS_A_DIRECTORY ); break;
274     case ENFILE:
275     case EMFILE:    set_error( STATUS_NO_MORE_FILES ); break;
276     case EEXIST:    set_error( STATUS_OBJECT_NAME_COLLISION ); break;
277     case EINVAL:    set_error( STATUS_INVALID_PARAMETER ); break;
278     case ESPIPE:    set_win32_error( ERROR_SEEK ); break;
279     case ENOTEMPTY: set_error( STATUS_DIRECTORY_NOT_EMPTY ); break;
280     case EIO:       set_error( STATUS_ACCESS_VIOLATION ); break;
281     case ENOTDIR:   set_error( STATUS_NOT_A_DIRECTORY ); break;
282     case EFBIG:     set_error( STATUS_SECTION_TOO_BIG ); break;
283     case ENODEV:    set_error( STATUS_NO_SUCH_DEVICE ); break;
284     case ENXIO:     set_error( STATUS_NO_SUCH_DEVICE ); break;
285 #ifdef EOVERFLOW
286     case EOVERFLOW: set_error( STATUS_INVALID_PARAMETER ); break;
287 #endif
288     default:        perror("file_set_error"); set_error( STATUS_UNSUCCESSFUL ); break;
289     }
290 }
291
292 struct file *get_file_obj( struct process *process, obj_handle_t handle, unsigned int access )
293 {
294     return (struct file *)get_handle_obj( process, handle, access, &file_ops );
295 }
296
297 int get_file_unix_fd( struct file *file )
298 {
299     return get_unix_fd( file->fd );
300 }
301
302 /* extend a file beyond the current end of file */
303 static int extend_file( struct file *file, file_pos_t new_size )
304 {
305     static const char zero;
306     int unix_fd = get_file_unix_fd( file );
307     off_t size = new_size;
308
309     if (sizeof(new_size) > sizeof(size) && size != new_size)
310     {
311         set_error( STATUS_INVALID_PARAMETER );
312         return 0;
313     }
314     /* extend the file one byte beyond the requested size and then truncate it */
315     /* this should work around ftruncate implementations that can't extend files */
316     if (pwrite( unix_fd, &zero, 1, size ) != -1)
317     {
318         ftruncate( unix_fd, size );
319         return 1;
320     }
321     file_set_error();
322     return 0;
323 }
324
325 /* try to grow the file to the specified size */
326 int grow_file( struct file *file, file_pos_t size )
327 {
328     struct stat st;
329     int unix_fd = get_file_unix_fd( file );
330
331     if (fstat( unix_fd, &st ) == -1)
332     {
333         file_set_error();
334         return 0;
335     }
336     if (st.st_size >= size) return 1;  /* already large enough */
337     return extend_file( file, size );
338 }
339
340 /* create a file */
341 DECL_HANDLER(create_file)
342 {
343     struct object *file;
344
345     reply->handle = 0;
346     if ((file = create_file( get_req_data(), get_req_data_size(), req->access,
347                              req->sharing, req->create, req->options, req->attrs )))
348     {
349         reply->handle = alloc_handle( current->process, file, req->access, req->inherit );
350         release_object( file );
351     }
352 }
353
354 /* allocate a file handle for a Unix fd */
355 DECL_HANDLER(alloc_file_handle)
356 {
357     struct file *file;
358     int fd;
359
360     reply->handle = 0;
361     if ((fd = thread_get_inflight_fd( current, req->fd )) == -1)
362     {
363         set_error( STATUS_INVALID_HANDLE );
364         return;
365     }
366     if ((file = create_file_for_fd( fd, req->access, FILE_SHARE_READ | FILE_SHARE_WRITE )))
367     {
368         reply->handle = alloc_handle( current->process, file, req->access, req->inherit );
369         release_object( file );
370     }
371 }
372
373 /* lock a region of a file */
374 DECL_HANDLER(lock_file)
375 {
376     struct file *file;
377     file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
378     file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
379
380     if ((file = get_file_obj( current->process, req->handle, 0 )))
381     {
382         reply->handle = lock_fd( file->fd, offset, count, req->shared, req->wait );
383         reply->overlapped = is_overlapped( file );
384         release_object( file );
385     }
386 }
387
388 /* unlock a region of a file */
389 DECL_HANDLER(unlock_file)
390 {
391     struct file *file;
392     file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
393     file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
394
395     if ((file = get_file_obj( current->process, req->handle, 0 )))
396     {
397         unlock_fd( file->fd, offset, count );
398         release_object( file );
399     }
400 }