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