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"
30 #ifdef HAVE_SYS_ERRNO_H
31 #include <sys/errno.h>
35 #include <sys/types.h>
53 struct object obj; /* object header */
54 struct fd *fd; /* file descriptor for this file */
55 struct file *next; /* next file in hashing list */
56 char *name; /* file name */
57 unsigned int access; /* file access (GENERIC_READ/WRITE) */
58 unsigned int flags; /* flags (FILE_FLAG_*) */
59 unsigned int sharing; /* file sharing mode */
60 int drive_type; /* type of drive the file is on */
61 struct async_queue read_q;
62 struct async_queue write_q;
65 #define NAME_HASH_SIZE 37
67 static struct file *file_hash[NAME_HASH_SIZE];
69 static void file_dump( struct object *obj, int verbose );
70 static struct fd *file_get_fd( struct object *obj );
71 static void file_destroy( struct object *obj );
73 static int file_get_poll_events( struct fd *fd );
74 static void file_poll_event( struct fd *fd, int event );
75 static int file_flush( struct fd *fd );
76 static int file_get_info( struct fd *fd, struct get_file_info_reply *reply, int *flags );
77 static void file_queue_async( struct fd *fd, void *ptr, unsigned int status, int type, int count );
79 static const struct object_ops file_ops =
81 sizeof(struct file), /* size */
83 default_fd_add_queue, /* add_queue */
84 default_fd_remove_queue, /* remove_queue */
85 default_fd_signaled, /* signaled */
86 no_satisfied, /* satisfied */
87 file_get_fd, /* get_fd */
88 file_destroy /* destroy */
91 static const struct fd_ops file_fd_ops =
93 file_get_poll_events, /* get_poll_events */
94 file_poll_event, /* poll_event */
95 file_flush, /* flush */
96 file_get_info, /* get_file_info */
97 file_queue_async /* queue_async */
100 static int get_name_hash( const char *name )
103 while (*name) hash ^= (unsigned char)*name++;
104 return hash % NAME_HASH_SIZE;
107 /* check if the desired access is possible without violating */
108 /* the sharing mode of other opens of the same file */
109 static int check_sharing( const char *name, int hash, unsigned int access,
110 unsigned int sharing )
113 unsigned int existing_sharing = FILE_SHARE_READ | FILE_SHARE_WRITE;
114 unsigned int existing_access = 0;
116 for (file = file_hash[hash]; file; file = file->next)
118 if (strcmp( file->name, name )) continue;
119 existing_sharing &= file->sharing;
120 existing_access |= file->access;
122 if ((access & GENERIC_READ) && !(existing_sharing & FILE_SHARE_READ)) goto error;
123 if ((access & GENERIC_WRITE) && !(existing_sharing & FILE_SHARE_WRITE)) goto error;
124 if ((existing_access & GENERIC_READ) && !(sharing & FILE_SHARE_READ)) goto error;
125 if ((existing_access & GENERIC_WRITE) && !(sharing & FILE_SHARE_WRITE)) goto error;
128 set_error( STATUS_SHARING_VIOLATION );
132 /* create a file from a file descriptor */
133 /* if the function fails the fd is closed */
134 static struct file *create_file_for_fd( int fd, unsigned int access, unsigned int sharing,
135 unsigned int attrs, int drive_type )
139 if ((file = alloc_object( &file_ops )))
143 file->access = access;
145 file->sharing = sharing;
146 file->drive_type = drive_type;
147 if (file->flags & FILE_FLAG_OVERLAPPED)
149 init_async_queue (&file->read_q);
150 init_async_queue (&file->write_q);
152 if (!(file->fd = alloc_fd( &file_fd_ops, fd, &file->obj )))
154 release_object( file );
162 static struct file *create_file( const char *nameptr, size_t len, unsigned int access,
163 unsigned int sharing, int create, unsigned int attrs,
173 if (!(name = mem_alloc( len + 1 ))) return NULL;
174 memcpy( name, nameptr, len );
177 /* check sharing mode */
178 hash = get_name_hash( name );
179 if (!check_sharing( name, hash, access, sharing )) goto error;
183 case CREATE_NEW: flags = O_CREAT | O_EXCL; break;
184 case CREATE_ALWAYS: flags = O_CREAT | O_TRUNC; break;
185 case OPEN_ALWAYS: flags = O_CREAT; break;
186 case TRUNCATE_EXISTING: flags = O_TRUNC; break;
187 case OPEN_EXISTING: flags = 0; break;
188 default: set_error( STATUS_INVALID_PARAMETER ); goto error;
190 switch(access & (GENERIC_READ | GENERIC_WRITE))
193 case GENERIC_READ: flags |= O_RDONLY; break;
194 case GENERIC_WRITE: flags |= O_WRONLY; break;
195 case GENERIC_READ|GENERIC_WRITE: flags |= O_RDWR; break;
197 mode = (attrs & FILE_ATTRIBUTE_READONLY) ? 0444 : 0666;
200 (!strcasecmp( name + len - 4, ".exe" ) || !strcasecmp( name + len - 4, ".com" )))
203 /* FIXME: should set error to STATUS_OBJECT_NAME_COLLISION if file existed before */
204 if ((fd = open( name, flags | O_NONBLOCK | O_LARGEFILE, mode )) == -1 )
206 /* refuse to open a directory */
207 if (fstat( fd, &st ) == -1) goto file_error;
208 if (S_ISDIR(st.st_mode))
210 set_error( STATUS_ACCESS_DENIED );
214 if (!(file = create_file_for_fd( fd, access, sharing, attrs, drive_type )))
220 file->next = file_hash[hash];
221 file_hash[hash] = file;
227 if (fd != -1) close( fd );
232 /* check if two file objects point to the same file */
233 int is_same_file( struct file *file1, struct file *file2 )
235 return !strcmp( file1->name, file2->name );
238 /* get the type of drive the file is on */
239 int get_file_drive_type( struct file *file )
241 return file->drive_type;
244 /* Create an anonymous Unix file */
245 int create_anonymous_file(void)
250 sprintf(tmpfn,"/tmp/anonmap.XXXXXX");
261 /* Create a temp file for anonymous mappings */
262 struct file *create_temp_file( int access )
266 if ((fd = create_anonymous_file()) == -1) return NULL;
267 return create_file_for_fd( fd, access, 0, 0, DRIVE_FIXED );
270 static void file_dump( struct object *obj, int verbose )
272 struct file *file = (struct file *)obj;
273 assert( obj->ops == &file_ops );
274 fprintf( stderr, "File fd=%p flags=%08x name='%s'\n", file->fd, file->flags, file->name );
277 static int file_get_poll_events( struct fd *fd )
279 struct file *file = get_fd_user( fd );
281 assert( file->obj.ops == &file_ops );
282 if (file->access & GENERIC_READ) events |= POLLIN;
283 if (file->access & GENERIC_WRITE) events |= POLLOUT;
287 static void file_poll_event( struct fd *fd, int event )
289 struct file *file = get_fd_user( fd );
290 assert( file->obj.ops == &file_ops );
291 if ( file->flags & FILE_FLAG_OVERLAPPED )
293 if( IS_READY(file->read_q) && (POLLIN & event) )
295 async_notify(file->read_q.head, STATUS_ALERTED);
298 if( IS_READY(file->write_q) && (POLLOUT & event) )
300 async_notify(file->write_q.head, STATUS_ALERTED);
304 default_poll_event( fd, event );
308 static int file_flush( struct fd *fd )
310 int ret = (fsync( get_unix_fd(fd) ) != -1);
311 if (!ret) file_set_error();
315 static int file_get_info( struct fd *fd, struct get_file_info_reply *reply, int *flags )
318 struct file *file = get_fd_user( fd );
319 int unix_fd = get_unix_fd( fd );
323 if (fstat( unix_fd, &st ) == -1)
326 return FD_TYPE_INVALID;
328 if (S_ISCHR(st.st_mode) || S_ISFIFO(st.st_mode) ||
329 S_ISSOCK(st.st_mode) || isatty(unix_fd)) reply->type = FILE_TYPE_CHAR;
330 else reply->type = FILE_TYPE_DISK;
331 if (S_ISDIR(st.st_mode)) reply->attr = FILE_ATTRIBUTE_DIRECTORY;
332 else reply->attr = FILE_ATTRIBUTE_ARCHIVE;
333 if (!(st.st_mode & S_IWUSR)) reply->attr |= FILE_ATTRIBUTE_READONLY;
334 reply->access_time = st.st_atime;
335 reply->write_time = st.st_mtime;
336 if (S_ISDIR(st.st_mode))
338 reply->size_high = 0;
343 reply->size_high = st.st_size >> 32;
344 reply->size_low = st.st_size & 0xffffffff;
346 reply->links = st.st_nlink;
347 reply->index_high = st.st_dev;
348 reply->index_low = st.st_ino;
349 reply->serial = 0; /* FIXME */
352 if (file->flags & FILE_FLAG_OVERLAPPED) *flags |= FD_FLAG_OVERLAPPED;
353 return FD_TYPE_DEFAULT;
356 static void file_queue_async(struct fd *fd, void *ptr, unsigned int status, int type, int count)
358 struct file *file = get_fd_user( fd );
360 struct async_queue *q;
362 assert( file->obj.ops == &file_ops );
364 if ( !(file->flags & FILE_FLAG_OVERLAPPED) )
366 set_error ( STATUS_INVALID_HANDLE );
372 case ASYNC_TYPE_READ:
375 case ASYNC_TYPE_WRITE:
379 set_error( STATUS_INVALID_PARAMETER );
383 async = find_async ( q, current, ptr );
385 if ( status == STATUS_PENDING )
390 async = create_async ( &file->obj, current, ptr );
394 async->status = STATUS_PENDING;
396 async_insert( q, async );
398 /* Check if the new pending request can be served immediately */
399 events = check_fd_events( fd, file_get_poll_events( fd ) );
400 if (events) file_poll_event ( fd, events );
402 else if ( async ) destroy_async ( async );
403 else set_error ( STATUS_INVALID_PARAMETER );
405 set_fd_events( fd, file_get_poll_events( fd ));
408 static struct fd *file_get_fd( struct object *obj )
410 struct file *file = (struct file *)obj;
411 assert( obj->ops == &file_ops );
412 return (struct fd *)grab_object( file->fd );
415 static void file_destroy( struct object *obj )
417 struct file *file = (struct file *)obj;
418 assert( obj->ops == &file_ops );
422 /* remove it from the hashing list */
423 struct file **pptr = &file_hash[get_name_hash( file->name )];
424 while (*pptr && *pptr != file) pptr = &(*pptr)->next;
426 *pptr = (*pptr)->next;
427 if (file->flags & FILE_FLAG_DELETE_ON_CLOSE) unlink( file->name );
430 if (file->flags & FILE_FLAG_OVERLAPPED)
432 destroy_async_queue (&file->read_q);
433 destroy_async_queue (&file->write_q);
435 if (file->fd) release_object( file->fd );
438 /* set the last error depending on errno */
439 void file_set_error(void)
443 case EAGAIN: set_error( STATUS_SHARING_VIOLATION ); break;
444 case EBADF: set_error( STATUS_INVALID_HANDLE ); break;
445 case ENOSPC: set_error( STATUS_DISK_FULL ); break;
448 case EPERM: set_error( STATUS_ACCESS_DENIED ); break;
449 case EROFS: set_error( STATUS_MEDIA_WRITE_PROTECTED ); break;
450 case EBUSY: set_error( STATUS_FILE_LOCK_CONFLICT ); break;
451 case ENOENT: set_error( STATUS_NO_SUCH_FILE ); break;
452 case EISDIR: set_error( 0xc0010000 | ERROR_CANNOT_MAKE /* FIXME */ ); break;
454 case EMFILE: set_error( STATUS_NO_MORE_FILES ); break;
455 case EEXIST: set_error( STATUS_OBJECT_NAME_COLLISION ); break;
456 case EINVAL: set_error( STATUS_INVALID_PARAMETER ); break;
457 case ESPIPE: set_error( 0xc0010000 | ERROR_SEEK /* FIXME */ ); break;
458 case ENOTEMPTY: set_error( STATUS_DIRECTORY_NOT_EMPTY ); break;
459 case EIO: set_error( STATUS_ACCESS_VIOLATION ); break;
460 default: perror("file_set_error"); set_error( ERROR_UNKNOWN /* FIXME */ ); break;
464 struct file *get_file_obj( struct process *process, obj_handle_t handle, unsigned int access )
466 return (struct file *)get_handle_obj( process, handle, access, &file_ops );
469 int get_file_unix_fd( struct file *file )
471 return get_unix_fd( file->fd );
474 static int set_file_pointer( obj_handle_t handle, unsigned int *low, int *high, int whence )
479 xto = *low+((off_t)*high<<32);
480 if (!(file = get_file_obj( current->process, handle, 0 )))
482 if ((result = lseek( get_file_unix_fd(file), xto, whence))==-1)
484 /* Check for seek before start of file */
486 /* also check EPERM due to SuSE7 2.2.16 lseek() EPERM kernel bug */
487 if (((errno == EINVAL) || (errno == EPERM))
488 && (whence != SEEK_SET) && (*high < 0))
489 set_error( 0xc0010000 | ERROR_NEGATIVE_SEEK /* FIXME */ );
492 release_object( file );
495 *low = result & 0xffffffff;
496 *high = result >> 32;
497 release_object( file );
501 /* extend a file beyond the current end of file */
502 static int extend_file( struct file *file, off_t size )
504 static const char zero;
505 int unix_fd = get_file_unix_fd( file );
507 /* extend the file one byte beyond the requested size and then truncate it */
508 /* this should work around ftruncate implementations that can't extend files */
509 if ((lseek( unix_fd, size, SEEK_SET ) != -1) &&
510 (write( unix_fd, &zero, 1 ) != -1))
512 ftruncate( unix_fd, size );
519 /* truncate file at current position */
520 static int truncate_file( struct file *file )
523 int unix_fd = get_file_unix_fd( file );
524 off_t pos = lseek( unix_fd, 0, SEEK_CUR );
525 off_t eof = lseek( unix_fd, 0, SEEK_END );
527 if (eof < pos) ret = extend_file( file, pos );
530 if (ftruncate( unix_fd, pos ) != -1) ret = 1;
531 else file_set_error();
533 lseek( unix_fd, pos, SEEK_SET ); /* restore file pos */
537 /* try to grow the file to the specified size */
538 int grow_file( struct file *file, int size_high, int size_low )
542 int unix_fd = get_file_unix_fd( file );
543 off_t old_pos, size = size_low + (((off_t)size_high)<<32);
545 if (fstat( unix_fd, &st ) == -1)
550 if (st.st_size >= size) return 1; /* already large enough */
551 old_pos = lseek( unix_fd, 0, SEEK_CUR ); /* save old pos */
552 ret = extend_file( file, size );
553 lseek( unix_fd, old_pos, SEEK_SET ); /* restore file pos */
557 static int set_file_time( obj_handle_t handle, time_t access_time, time_t write_time )
560 struct utimbuf utimbuf;
562 if (!(file = get_file_obj( current->process, handle, GENERIC_WRITE )))
566 set_error( STATUS_INVALID_HANDLE );
567 release_object( file );
570 if (!access_time || !write_time)
573 if (stat( file->name, &st ) == -1) goto error;
574 if (!access_time) access_time = st.st_atime;
575 if (!write_time) write_time = st.st_mtime;
577 utimbuf.actime = access_time;
578 utimbuf.modtime = write_time;
579 if (utime( file->name, &utimbuf ) == -1) goto error;
580 release_object( file );
584 release_object( file );
588 static int file_lock( struct file *file, int offset_high, int offset_low,
589 int count_high, int count_low )
591 /* FIXME: implement this */
595 static int file_unlock( struct file *file, int offset_high, int offset_low,
596 int count_high, int count_low )
598 /* FIXME: implement this */
603 DECL_HANDLER(create_file)
608 if ((file = create_file( get_req_data(), get_req_data_size(), req->access,
609 req->sharing, req->create, req->attrs, req->drive_type )))
611 reply->handle = alloc_handle( current->process, file, req->access, req->inherit );
612 release_object( file );
616 /* allocate a file handle for a Unix fd */
617 DECL_HANDLER(alloc_file_handle)
623 if ((fd = thread_get_inflight_fd( current, req->fd )) == -1)
625 set_error( STATUS_INVALID_HANDLE );
628 if ((file = create_file_for_fd( fd, req->access, FILE_SHARE_READ | FILE_SHARE_WRITE,
631 reply->handle = alloc_handle( current->process, file, req->access, req->inherit );
632 release_object( file );
636 /* set a file current position */
637 DECL_HANDLER(set_file_pointer)
639 int high = req->high;
641 set_file_pointer( req->handle, &low, &high, req->whence );
642 reply->new_low = low;
643 reply->new_high = high;
646 /* truncate (or extend) a file */
647 DECL_HANDLER(truncate_file)
651 if ((file = get_file_obj( current->process, req->handle, GENERIC_WRITE )))
653 truncate_file( file );
654 release_object( file );
658 /* set a file access and modification times */
659 DECL_HANDLER(set_file_time)
661 set_file_time( req->handle, req->access_time, req->write_time );
664 /* lock a region of a file */
665 DECL_HANDLER(lock_file)
669 if ((file = get_file_obj( current->process, req->handle, 0 )))
671 file_lock( file, req->offset_high, req->offset_low,
672 req->count_high, req->count_low );
673 release_object( file );
677 /* unlock a region of a file */
678 DECL_HANDLER(unlock_file)
682 if ((file = get_file_obj( current->process, req->handle, 0 )))
684 file_unlock( file, req->offset_high, req->offset_low,
685 req->count_high, req->count_low );
686 release_object( file );