2 * Server-side file management
4 * Copyright (C) 1998 Alexandre Julliard
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.
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.
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
22 #include "wine/port.h"
31 #ifdef HAVE_SYS_ERRNO_H
32 #include <sys/errno.h>
36 #include <sys/types.h>
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...) */
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 );
68 static int file_get_poll_events( struct fd *fd );
69 static void file_poll_event( struct fd *fd, int event );
70 static int file_flush( struct fd *fd, struct event **event );
71 static int file_get_info( struct fd *fd );
72 static void file_queue_async( struct fd *fd, void *apc, void *user, void* iosb, int type, int count );
73 static void file_cancel_async( struct fd *fd );
75 static const struct object_ops file_ops =
77 sizeof(struct file), /* size */
79 default_fd_add_queue, /* add_queue */
80 default_fd_remove_queue, /* remove_queue */
81 default_fd_signaled, /* signaled */
82 no_satisfied, /* satisfied */
83 file_get_fd, /* get_fd */
84 file_destroy /* destroy */
87 static const struct fd_ops file_fd_ops =
89 file_get_poll_events, /* get_poll_events */
90 file_poll_event, /* poll_event */
91 file_flush, /* flush */
92 file_get_info, /* get_file_info */
93 file_queue_async, /* queue_async */
94 file_cancel_async /* cancel_async */
97 static inline int is_overlapped( const struct file *file )
99 return !(file->options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT));
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 )
108 if ((file = alloc_object( &file_ops )))
110 file->access = access;
111 file->options = FILE_SYNCHRONOUS_IO_NONALERT;
112 if (!(file->fd = create_anonymous_fd( &file_fd_ops, fd, &file->obj )))
114 release_object( file );
122 static struct object *create_file( const char *nameptr, size_t len, unsigned int access,
123 unsigned int sharing, int create, unsigned int options,
131 if (!(name = mem_alloc( len + 1 ))) return NULL;
132 memcpy( name, nameptr, len );
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;
146 switch(access & (GENERIC_READ | GENERIC_WRITE))
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;
153 mode = (attrs & FILE_ATTRIBUTE_READONLY) ? 0444 : 0666;
156 (!strcasecmp( name + len - 4, ".exe" ) || !strcasecmp( name + len - 4, ".com" )))
159 if (!(file = alloc_object( &file_ops ))) goto error;
161 file->access = access;
162 file->options = options;
163 list_init( &file->read_q );
164 list_init( &file->write_q );
166 /* FIXME: should set error to STATUS_OBJECT_NAME_COLLISION if file existed before */
167 if (!(file->fd = alloc_fd( &file_fd_ops, &file->obj )) ||
168 !(file->fd = open_fd( file->fd, name, flags | O_NONBLOCK | O_LARGEFILE,
169 &mode, access, sharing, options )))
172 release_object( file );
177 /* check for serial port */
178 if (S_ISCHR(mode) && is_serial_fd( file->fd ))
180 struct object *obj = create_serial( file->fd, file->options );
181 release_object( file );
192 /* check if two file objects point to the same file */
193 int is_same_file( struct file *file1, struct file *file2 )
195 return is_same_file_fd( file1->fd, file2->fd );
198 /* create a temp file for anonymous mappings */
199 struct file *create_temp_file( int access )
204 sprintf( tmpfn, "anonmap.XXXXXX" ); /* create it in the server directory */
205 fd = mkstemps( tmpfn, 0 );
212 return create_file_for_fd( fd, access, 0 );
215 static void file_dump( struct object *obj, int verbose )
217 struct file *file = (struct file *)obj;
218 assert( obj->ops == &file_ops );
219 fprintf( stderr, "File fd=%p options=%08x\n", file->fd, file->options );
222 static int file_get_poll_events( struct fd *fd )
224 struct file *file = get_fd_user( fd );
226 assert( file->obj.ops == &file_ops );
227 if (file->access & GENERIC_READ) events |= POLLIN;
228 if (file->access & GENERIC_WRITE) events |= POLLOUT;
232 static void file_poll_event( struct fd *fd, int event )
234 struct file *file = get_fd_user( fd );
235 assert( file->obj.ops == &file_ops );
236 if (is_overlapped( file ))
238 if (!list_empty( &file->read_q ) && (POLLIN & event) )
240 async_terminate_head( &file->read_q, STATUS_ALERTED );
243 if (!list_empty( &file->write_q ) && (POLLOUT & event) )
245 async_terminate_head( &file->write_q, STATUS_ALERTED );
249 default_poll_event( fd, event );
253 static int file_flush( struct fd *fd, struct event **event )
255 int ret = (fsync( get_unix_fd(fd) ) != -1);
256 if (!ret) file_set_error();
260 static int file_get_info( struct fd *fd )
262 struct file *file = get_fd_user( fd );
264 if (is_overlapped( file )) return FD_FLAG_OVERLAPPED;
268 static void file_queue_async( struct fd *fd, void *apc, void *user, void *iosb,
269 int type, int count )
271 struct file *file = get_fd_user( fd );
275 assert( file->obj.ops == &file_ops );
277 if (!is_overlapped( file ))
279 set_error( STATUS_INVALID_HANDLE );
285 case ASYNC_TYPE_READ:
286 queue = &file->read_q;
288 case ASYNC_TYPE_WRITE:
289 queue = &file->write_q;
292 set_error( STATUS_INVALID_PARAMETER );
296 if (!create_async( fd, current, 0, queue, apc, user, iosb ))
299 /* Check if the new pending request can be served immediately */
300 events = check_fd_events( fd, file_get_poll_events( fd ) );
301 if (events) file_poll_event( fd, events );
303 set_fd_events( fd, file_get_poll_events( fd ));
306 static void file_cancel_async( struct fd *fd )
308 struct file *file = get_fd_user( fd );
309 assert( file->obj.ops == &file_ops );
311 async_terminate_queue( &file->read_q, STATUS_CANCELLED );
312 async_terminate_queue( &file->write_q, STATUS_CANCELLED );
315 static struct fd *file_get_fd( struct object *obj )
317 struct file *file = (struct file *)obj;
318 assert( obj->ops == &file_ops );
319 return (struct fd *)grab_object( file->fd );
322 static void file_destroy( struct object *obj )
324 struct file *file = (struct file *)obj;
325 assert( obj->ops == &file_ops );
327 if (is_overlapped( file ))
329 async_terminate_queue( &file->read_q, STATUS_CANCELLED );
330 async_terminate_queue( &file->write_q, STATUS_CANCELLED );
332 if (file->fd) release_object( file->fd );
335 /* set the last error depending on errno */
336 void file_set_error(void)
340 case EAGAIN: set_error( STATUS_SHARING_VIOLATION ); break;
341 case EBADF: set_error( STATUS_INVALID_HANDLE ); break;
342 case ENOSPC: set_error( STATUS_DISK_FULL ); break;
345 case EPERM: set_error( STATUS_ACCESS_DENIED ); break;
346 case EROFS: set_error( STATUS_MEDIA_WRITE_PROTECTED ); break;
347 case EBUSY: set_error( STATUS_FILE_LOCK_CONFLICT ); break;
348 case ENOENT: set_error( STATUS_NO_SUCH_FILE ); break;
349 case EISDIR: set_error( STATUS_FILE_IS_A_DIRECTORY ); break;
351 case EMFILE: set_error( STATUS_NO_MORE_FILES ); break;
352 case EEXIST: set_error( STATUS_OBJECT_NAME_COLLISION ); break;
353 case EINVAL: set_error( STATUS_INVALID_PARAMETER ); break;
354 case ESPIPE: set_win32_error( ERROR_SEEK ); break;
355 case ENOTEMPTY: set_error( STATUS_DIRECTORY_NOT_EMPTY ); break;
356 case EIO: set_error( STATUS_ACCESS_VIOLATION ); break;
357 case ENOTDIR: set_error( STATUS_NOT_A_DIRECTORY ); break;
358 case EFBIG: set_error( STATUS_SECTION_TOO_BIG ); break;
359 case ENODEV: set_error( STATUS_NO_SUCH_DEVICE ); break;
360 case ENXIO: set_error( STATUS_NO_SUCH_DEVICE ); break;
362 case EOVERFLOW: set_error( STATUS_INVALID_PARAMETER ); break;
364 default: perror("file_set_error"); set_error( STATUS_UNSUCCESSFUL ); break;
368 struct file *get_file_obj( struct process *process, obj_handle_t handle, unsigned int access )
370 return (struct file *)get_handle_obj( process, handle, access, &file_ops );
373 int get_file_unix_fd( struct file *file )
375 return get_unix_fd( file->fd );
378 /* extend a file beyond the current end of file */
379 static int extend_file( struct file *file, off_t size )
381 static const char zero;
382 int unix_fd = get_file_unix_fd( file );
384 /* extend the file one byte beyond the requested size and then truncate it */
385 /* this should work around ftruncate implementations that can't extend files */
386 if (pwrite( unix_fd, &zero, 1, size ) != -1)
388 ftruncate( unix_fd, size );
395 /* try to grow the file to the specified size */
396 int grow_file( struct file *file, int size_high, int size_low )
399 int unix_fd = get_file_unix_fd( file );
400 off_t size = size_low + (((off_t)size_high)<<32);
402 if (fstat( unix_fd, &st ) == -1)
407 if (st.st_size >= size) return 1; /* already large enough */
408 return extend_file( file, size );
412 DECL_HANDLER(create_file)
417 if ((file = create_file( get_req_data(), get_req_data_size(), req->access,
418 req->sharing, req->create, req->options, req->attrs )))
420 reply->handle = alloc_handle( current->process, file, req->access, req->inherit );
421 release_object( file );
425 /* allocate a file handle for a Unix fd */
426 DECL_HANDLER(alloc_file_handle)
432 if ((fd = thread_get_inflight_fd( current, req->fd )) == -1)
434 set_error( STATUS_INVALID_HANDLE );
437 if ((file = create_file_for_fd( fd, req->access, FILE_SHARE_READ | FILE_SHARE_WRITE )))
439 reply->handle = alloc_handle( current->process, file, req->access, req->inherit );
440 release_object( file );
444 /* lock a region of a file */
445 DECL_HANDLER(lock_file)
448 file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
449 file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
451 if ((file = get_file_obj( current->process, req->handle, 0 )))
453 reply->handle = lock_fd( file->fd, offset, count, req->shared, req->wait );
454 reply->overlapped = is_overlapped( file );
455 release_object( file );
459 /* unlock a region of a file */
460 DECL_HANDLER(unlock_file)
463 file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
464 file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
466 if ((file = get_file_obj( current->process, req->handle, 0 )))
468 unlock_fd( file->fd, offset, count );
469 release_object( file );