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