server: Map ESPIPE to STATUS_ILLEGAL_FUNCTION for consistency with ntdll.
[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     unsigned int        options;    /* file options (FILE_DELETE_ON_CLOSE, FILE_SYNCHRONOUS...) */
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 int file_flush( struct fd *fd, struct event **event );
73 static enum server_fd_type file_get_info( struct fd *fd, int *flags );
74
75 static const struct object_ops file_ops =
76 {
77     sizeof(struct file),          /* size */
78     file_dump,                    /* dump */
79     default_fd_add_queue,         /* add_queue */
80     default_fd_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     fd_close_handle,              /* close_handle */
88     file_destroy                  /* destroy */
89 };
90
91 static const struct fd_ops file_fd_ops =
92 {
93     file_get_poll_events,         /* get_poll_events */
94     default_poll_event,           /* poll_event */
95     file_flush,                   /* flush */
96     file_get_info,                /* get_file_info */
97     default_fd_queue_async,       /* queue_async */
98     default_fd_cancel_async       /* cancel_async */
99 };
100
101 static inline int is_overlapped( const struct file *file )
102 {
103     return !(file->options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT));
104 }
105
106 /* create a file from a file descriptor */
107 /* if the function fails the fd is closed */
108 static struct file *create_file_for_fd( int fd, unsigned int access, unsigned int sharing )
109 {
110     struct file *file;
111
112     if ((file = alloc_object( &file_ops )))
113     {
114         file->access     = file_map_access( &file->obj, access );
115         file->options    = FILE_SYNCHRONOUS_IO_NONALERT;
116         if (!(file->fd = create_anonymous_fd( &file_fd_ops, fd, &file->obj )))
117         {
118             release_object( file );
119             return NULL;
120         }
121     }
122     return file;
123 }
124
125 static struct object *create_file_obj( struct fd *fd, unsigned int access, unsigned int options )
126 {
127     struct file *file = alloc_object( &file_ops );
128
129     if (!file) return NULL;
130     file->access  = access;
131     file->options = options;
132     file->fd      = fd;
133     grab_object( fd );
134     set_fd_user( fd, &file_fd_ops, &file->obj );
135     return &file->obj;
136 }
137
138 static struct object *create_file( const char *nameptr, data_size_t len, unsigned int access,
139                                    unsigned int sharing, int create, unsigned int options,
140                                    unsigned int attrs )
141 {
142     struct object *obj = NULL;
143     struct fd *fd;
144     int flags;
145     char *name;
146     mode_t mode;
147
148     if (!(name = mem_alloc( len + 1 ))) return NULL;
149     memcpy( name, nameptr, len );
150     name[len] = 0;
151
152     switch(create)
153     {
154     case FILE_CREATE:       flags = O_CREAT | O_EXCL; break;
155     case FILE_OVERWRITE_IF: /* FIXME: the difference is whether we trash existing attr or not */
156     case FILE_SUPERSEDE:    flags = O_CREAT | O_TRUNC; break;
157     case FILE_OPEN:         flags = 0; break;
158     case FILE_OPEN_IF:      flags = O_CREAT; break;
159     case FILE_OVERWRITE:    flags = O_TRUNC; break;
160     default:                set_error( STATUS_INVALID_PARAMETER ); goto done;
161     }
162
163     mode = (attrs & FILE_ATTRIBUTE_READONLY) ? 0444 : 0666;
164
165     if (len >= 4 &&
166         (!strcasecmp( name + len - 4, ".exe" ) || !strcasecmp( name + len - 4, ".com" )))
167         mode |= 0111;
168
169     access = generic_file_map_access( access );
170
171     /* FIXME: should set error to STATUS_OBJECT_NAME_COLLISION if file existed before */
172     fd = open_fd( name, flags | O_NONBLOCK | O_LARGEFILE, &mode, access, sharing, options );
173     if (!fd) goto done;
174
175     if (S_ISDIR(mode))
176         obj = create_dir_obj( fd );
177     else if (S_ISCHR(mode) && is_serial_fd( fd ))
178         obj = create_serial( fd, options );
179     else
180         obj = create_file_obj( fd, access, options );
181
182     release_object( fd );
183
184 done:
185     free( name );
186     return obj;
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 & FILE_UNIX_READ_ACCESS) events |= POLLIN;
225     if (file->access & FILE_UNIX_WRITE_ACCESS) events |= POLLOUT;
226     return events;
227 }
228
229 static int file_flush( struct fd *fd, struct event **event )
230 {
231     int ret = 0, unix_fd = get_unix_fd( fd );
232
233     if (unix_fd != -1)
234     {
235         ret = (fsync( unix_fd ) != -1);
236         if (!ret) file_set_error();
237     }
238     return ret;
239 }
240
241 static enum server_fd_type file_get_info( struct fd *fd, int *flags )
242 {
243     struct file *file = get_fd_user( fd );
244
245     *flags = 0;
246     if (is_overlapped( file )) *flags |= FD_FLAG_OVERLAPPED;
247     return FD_TYPE_FILE;
248 }
249
250 static struct fd *file_get_fd( struct object *obj )
251 {
252     struct file *file = (struct file *)obj;
253     assert( obj->ops == &file_ops );
254     return (struct fd *)grab_object( file->fd );
255 }
256
257 static unsigned int generic_file_map_access( unsigned int access )
258 {
259     if (access & GENERIC_READ)    access |= FILE_GENERIC_READ;
260     if (access & GENERIC_WRITE)   access |= FILE_GENERIC_WRITE;
261     if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
262     if (access & GENERIC_ALL)     access |= FILE_ALL_ACCESS;
263     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
264 }
265
266 static unsigned int file_map_access( struct object *obj, unsigned int access )
267 {
268     return generic_file_map_access( access );
269 }
270
271 static void file_destroy( struct object *obj )
272 {
273     struct file *file = (struct file *)obj;
274     assert( obj->ops == &file_ops );
275
276     if (file->fd) release_object( file->fd );
277 }
278
279 /* set the last error depending on errno */
280 void file_set_error(void)
281 {
282     switch (errno)
283     {
284     case EAGAIN:    set_error( STATUS_SHARING_VIOLATION ); break;
285     case EBADF:     set_error( STATUS_INVALID_HANDLE ); break;
286     case ENOSPC:    set_error( STATUS_DISK_FULL ); break;
287     case EACCES:
288     case ESRCH:
289     case EPERM:     set_error( STATUS_ACCESS_DENIED ); break;
290     case EROFS:     set_error( STATUS_MEDIA_WRITE_PROTECTED ); break;
291     case EBUSY:     set_error( STATUS_FILE_LOCK_CONFLICT ); break;
292     case ENOENT:    set_error( STATUS_NO_SUCH_FILE ); break;
293     case EISDIR:    set_error( STATUS_FILE_IS_A_DIRECTORY ); break;
294     case ENFILE:
295     case EMFILE:    set_error( STATUS_TOO_MANY_OPENED_FILES ); break;
296     case EEXIST:    set_error( STATUS_OBJECT_NAME_COLLISION ); break;
297     case EINVAL:    set_error( STATUS_INVALID_PARAMETER ); break;
298     case ESPIPE:    set_error( STATUS_ILLEGAL_FUNCTION ); break;
299     case ENOTEMPTY: set_error( STATUS_DIRECTORY_NOT_EMPTY ); break;
300     case EIO:       set_error( STATUS_ACCESS_VIOLATION ); break;
301     case ENOTDIR:   set_error( STATUS_NOT_A_DIRECTORY ); break;
302     case EFBIG:     set_error( STATUS_SECTION_TOO_BIG ); break;
303     case ENODEV:    set_error( STATUS_NO_SUCH_DEVICE ); break;
304     case ENXIO:     set_error( STATUS_NO_SUCH_DEVICE ); break;
305 #ifdef EOVERFLOW
306     case EOVERFLOW: set_error( STATUS_INVALID_PARAMETER ); break;
307 #endif
308     default:        perror("file_set_error"); set_error( STATUS_UNSUCCESSFUL ); break;
309     }
310 }
311
312 struct file *get_file_obj( struct process *process, obj_handle_t handle, unsigned int access )
313 {
314     return (struct file *)get_handle_obj( process, handle, access, &file_ops );
315 }
316
317 int get_file_unix_fd( struct file *file )
318 {
319     return get_unix_fd( file->fd );
320 }
321
322 /* extend a file beyond the current end of file */
323 static int extend_file( struct file *file, file_pos_t new_size )
324 {
325     static const char zero;
326     int unix_fd = get_file_unix_fd( file );
327     off_t size = new_size;
328
329     if (unix_fd == -1) return 0;
330
331     if (sizeof(new_size) > sizeof(size) && size != new_size)
332     {
333         set_error( STATUS_INVALID_PARAMETER );
334         return 0;
335     }
336     /* extend the file one byte beyond the requested size and then truncate it */
337     /* this should work around ftruncate implementations that can't extend files */
338     if (pwrite( unix_fd, &zero, 1, size ) != -1)
339     {
340         ftruncate( unix_fd, size );
341         return 1;
342     }
343     file_set_error();
344     return 0;
345 }
346
347 /* try to grow the file to the specified size */
348 int grow_file( struct file *file, file_pos_t size )
349 {
350     struct stat st;
351     int unix_fd = get_file_unix_fd( file );
352
353     if (unix_fd == -1) return 0;
354
355     if (fstat( unix_fd, &st ) == -1)
356     {
357         file_set_error();
358         return 0;
359     }
360     if (st.st_size >= size) return 1;  /* already large enough */
361     return extend_file( file, size );
362 }
363
364 /* create a file */
365 DECL_HANDLER(create_file)
366 {
367     struct object *file;
368
369     reply->handle = 0;
370     if ((file = create_file( get_req_data(), get_req_data_size(), req->access,
371                              req->sharing, req->create, req->options, req->attrs )))
372     {
373         reply->handle = alloc_handle( current->process, file, req->access, req->attributes );
374         release_object( file );
375     }
376 }
377
378 /* allocate a file handle for a Unix fd */
379 DECL_HANDLER(alloc_file_handle)
380 {
381     struct file *file;
382     int fd;
383
384     reply->handle = 0;
385     if ((fd = thread_get_inflight_fd( current, req->fd )) == -1)
386     {
387         set_error( STATUS_INVALID_HANDLE );
388         return;
389     }
390     if ((file = create_file_for_fd( fd, req->access, FILE_SHARE_READ | FILE_SHARE_WRITE )))
391     {
392         reply->handle = alloc_handle( current->process, file, req->access, req->attributes );
393         release_object( file );
394     }
395 }
396
397 /* lock a region of a file */
398 DECL_HANDLER(lock_file)
399 {
400     struct file *file;
401     file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
402     file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
403
404     if ((file = get_file_obj( current->process, req->handle, 0 )))
405     {
406         reply->handle = lock_fd( file->fd, offset, count, req->shared, req->wait );
407         reply->overlapped = is_overlapped( file );
408         release_object( file );
409     }
410 }
411
412 /* unlock a region of a file */
413 DECL_HANDLER(unlock_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         unlock_fd( file->fd, offset, count );
422         release_object( file );
423     }
424 }