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