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>
55 struct object obj
; /* object header */
56 struct fd
*fd
; /* file descriptor for this file */
57 struct file
*next
; /* next file in hashing list */
58 char *name
; /* file name */
59 unsigned int access
; /* file access (GENERIC_READ/WRITE) */
60 unsigned int flags
; /* flags (FILE_FLAG_*) */
61 unsigned int sharing
; /* file sharing mode */
62 int removable
; /* is file on removable media? */
63 struct async_queue read_q
;
64 struct async_queue write_q
;
67 #define NAME_HASH_SIZE 37
69 static struct file
*file_hash
[NAME_HASH_SIZE
];
71 static void file_dump( struct object
*obj
, int verbose
);
72 static struct fd
*file_get_fd( struct object
*obj
);
73 static void file_destroy( struct object
*obj
);
75 static int file_get_poll_events( struct fd
*fd
);
76 static void file_poll_event( struct fd
*fd
, int event
);
77 static int file_flush( struct fd
*fd
, struct event
**event
);
78 static int file_get_info( struct fd
*fd
, struct get_file_info_reply
*reply
, int *flags
);
79 static void file_queue_async( struct fd
*fd
, void *ptr
, unsigned int status
, int type
, int count
);
81 static const struct object_ops file_ops
=
83 sizeof(struct file
), /* size */
85 default_fd_add_queue
, /* add_queue */
86 default_fd_remove_queue
, /* remove_queue */
87 default_fd_signaled
, /* signaled */
88 no_satisfied
, /* satisfied */
89 file_get_fd
, /* get_fd */
90 file_destroy
/* destroy */
93 static const struct fd_ops file_fd_ops
=
95 file_get_poll_events
, /* get_poll_events */
96 file_poll_event
, /* poll_event */
97 file_flush
, /* flush */
98 file_get_info
, /* get_file_info */
99 file_queue_async
/* queue_async */
102 static int get_name_hash( const char *name
)
105 while (*name
) hash
^= (unsigned char)*name
++;
106 return hash
% NAME_HASH_SIZE
;
109 /* check if the desired access is possible without violating */
110 /* the sharing mode of other opens of the same file */
111 static int check_sharing( const char *name
, int hash
, unsigned int access
,
112 unsigned int sharing
)
115 unsigned int existing_sharing
= FILE_SHARE_READ
| FILE_SHARE_WRITE
;
116 unsigned int existing_access
= 0;
118 for (file
= file_hash
[hash
]; file
; file
= file
->next
)
120 if (strcmp( file
->name
, name
)) continue;
121 existing_sharing
&= file
->sharing
;
122 existing_access
|= file
->access
;
124 if ((access
& GENERIC_READ
) && !(existing_sharing
& FILE_SHARE_READ
)) goto error
;
125 if ((access
& GENERIC_WRITE
) && !(existing_sharing
& FILE_SHARE_WRITE
)) goto error
;
126 if ((existing_access
& GENERIC_READ
) && !(sharing
& FILE_SHARE_READ
)) goto error
;
127 if ((existing_access
& GENERIC_WRITE
) && !(sharing
& FILE_SHARE_WRITE
)) goto error
;
130 set_error( STATUS_SHARING_VIOLATION
);
134 /* create a file from a file descriptor */
135 /* if the function fails the fd is closed */
136 static struct file
*create_file_for_fd( int fd
, unsigned int access
, unsigned int sharing
,
137 unsigned int attrs
, int removable
)
141 if ((file
= alloc_object( &file_ops
)))
145 file
->access
= access
;
147 file
->sharing
= sharing
;
148 file
->removable
= removable
;
149 if (file
->flags
& FILE_FLAG_OVERLAPPED
)
151 init_async_queue (&file
->read_q
);
152 init_async_queue (&file
->write_q
);
154 if (!(file
->fd
= create_anonymous_fd( &file_fd_ops
, fd
, &file
->obj
)))
156 release_object( file
);
164 static struct file
*create_file( const char *nameptr
, size_t len
, unsigned int access
,
165 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 if (!(file
= alloc_object( &file_ops
))) goto error
;
205 file
->access
= access
;
207 file
->sharing
= sharing
;
208 file
->removable
= removable
;
210 file
->next
= file_hash
[hash
];
211 file_hash
[hash
] = file
;
212 if (file
->flags
& FILE_FLAG_OVERLAPPED
)
214 init_async_queue (&file
->read_q
);
215 init_async_queue (&file
->write_q
);
218 /* FIXME: should set error to STATUS_OBJECT_NAME_COLLISION if file existed before */
219 if (!(file
->fd
= alloc_fd( &file_fd_ops
, &file
->obj
)) ||
220 !(file
->fd
= open_fd( file
->fd
, name
, flags
| O_NONBLOCK
| O_LARGEFILE
, &mode
)))
222 release_object( file
);
225 /* refuse to open a directory */
226 if (S_ISDIR(mode
) && !(file
->flags
& FILE_FLAG_BACKUP_SEMANTICS
))
228 set_error( STATUS_ACCESS_DENIED
);
229 release_object( file
);
239 /* check if two file objects point to the same file */
240 int is_same_file( struct file
*file1
, struct file
*file2
)
242 return !strcmp( file1
->name
, file2
->name
);
245 /* check if the file is on removable media */
246 int is_file_removable( struct file
*file
)
248 return file
->removable
;
251 /* create a temp file for anonymous mappings */
252 struct file
*create_temp_file( int access
)
257 sprintf( tmpfn
, "anonmap.XXXXXX" ); /* create it in the server directory */
258 fd
= mkstemps( tmpfn
, 0 );
265 return create_file_for_fd( fd
, access
, 0, 0, FALSE
);
268 static void file_dump( struct object
*obj
, int verbose
)
270 struct file
*file
= (struct file
*)obj
;
271 assert( obj
->ops
== &file_ops
);
272 fprintf( stderr
, "File fd=%p flags=%08x name='%s'\n", file
->fd
, file
->flags
, file
->name
);
275 static int file_get_poll_events( struct fd
*fd
)
277 struct file
*file
= get_fd_user( fd
);
279 assert( file
->obj
.ops
== &file_ops
);
280 if (file
->access
& GENERIC_READ
) events
|= POLLIN
;
281 if (file
->access
& GENERIC_WRITE
) events
|= POLLOUT
;
285 static void file_poll_event( struct fd
*fd
, int event
)
287 struct file
*file
= get_fd_user( fd
);
288 assert( file
->obj
.ops
== &file_ops
);
289 if ( file
->flags
& FILE_FLAG_OVERLAPPED
)
291 if( IS_READY(file
->read_q
) && (POLLIN
& event
) )
293 async_notify(file
->read_q
.head
, STATUS_ALERTED
);
296 if( IS_READY(file
->write_q
) && (POLLOUT
& event
) )
298 async_notify(file
->write_q
.head
, STATUS_ALERTED
);
302 default_poll_event( fd
, event
);
306 static int file_flush( struct fd
*fd
, struct event
**event
)
308 int ret
= (fsync( get_unix_fd(fd
) ) != -1);
309 if (!ret
) file_set_error();
313 static int file_get_info( struct fd
*fd
, struct get_file_info_reply
*reply
, int *flags
)
316 struct file
*file
= get_fd_user( fd
);
317 int unix_fd
= get_unix_fd( fd
);
321 if (fstat( unix_fd
, &st
) == -1)
324 return FD_TYPE_INVALID
;
326 if (S_ISCHR(st
.st_mode
) || S_ISFIFO(st
.st_mode
) ||
327 S_ISSOCK(st
.st_mode
) || isatty(unix_fd
)) reply
->type
= FILE_TYPE_CHAR
;
328 else reply
->type
= FILE_TYPE_DISK
;
329 if (S_ISDIR(st
.st_mode
)) reply
->attr
= FILE_ATTRIBUTE_DIRECTORY
;
330 else reply
->attr
= FILE_ATTRIBUTE_ARCHIVE
;
331 if (!(st
.st_mode
& S_IWUSR
)) reply
->attr
|= FILE_ATTRIBUTE_READONLY
;
332 reply
->access_time
= st
.st_atime
;
333 reply
->write_time
= st
.st_mtime
;
334 reply
->change_time
= st
.st_ctime
;
335 if (S_ISDIR(st
.st_mode
))
337 reply
->size_high
= 0;
339 reply
->alloc_high
= 0;
340 reply
->alloc_low
= 0;
345 reply
->size_high
= st
.st_size
>> 32;
346 reply
->size_low
= st
.st_size
& 0xffffffff;
347 alloc
= (file_pos_t
)st
.st_blksize
* st
.st_blocks
;
348 reply
->alloc_high
= alloc
>> 32;
349 reply
->alloc_low
= alloc
& 0xffffffff;
351 reply
->links
= st
.st_nlink
;
352 reply
->index_high
= st
.st_dev
;
353 reply
->index_low
= st
.st_ino
;
354 reply
->serial
= 0; /* FIXME */
357 if (file
->flags
& FILE_FLAG_OVERLAPPED
) *flags
|= FD_FLAG_OVERLAPPED
;
358 return FD_TYPE_DEFAULT
;
361 static void file_queue_async(struct fd
*fd
, void *ptr
, unsigned int status
, int type
, int count
)
363 struct file
*file
= get_fd_user( fd
);
365 struct async_queue
*q
;
367 assert( file
->obj
.ops
== &file_ops
);
369 if ( !(file
->flags
& FILE_FLAG_OVERLAPPED
) )
371 set_error ( STATUS_INVALID_HANDLE
);
377 case ASYNC_TYPE_READ
:
380 case ASYNC_TYPE_WRITE
:
384 set_error( STATUS_INVALID_PARAMETER
);
388 async
= find_async ( q
, current
, ptr
);
390 if ( status
== STATUS_PENDING
)
395 async
= create_async ( &file
->obj
, current
, ptr
);
399 async
->status
= STATUS_PENDING
;
401 async_insert( q
, async
);
403 /* Check if the new pending request can be served immediately */
404 events
= check_fd_events( fd
, file_get_poll_events( fd
) );
405 if (events
) file_poll_event ( fd
, events
);
407 else if ( async
) destroy_async ( async
);
408 else set_error ( STATUS_INVALID_PARAMETER
);
410 set_fd_events( fd
, file_get_poll_events( fd
));
413 static struct fd
*file_get_fd( struct object
*obj
)
415 struct file
*file
= (struct file
*)obj
;
416 assert( obj
->ops
== &file_ops
);
417 return (struct fd
*)grab_object( file
->fd
);
420 static void file_destroy( struct object
*obj
)
422 struct file
*file
= (struct file
*)obj
;
423 assert( obj
->ops
== &file_ops
);
427 /* remove it from the hashing list */
428 struct file
**pptr
= &file_hash
[get_name_hash( file
->name
)];
429 while (*pptr
&& *pptr
!= file
) pptr
= &(*pptr
)->next
;
431 *pptr
= (*pptr
)->next
;
432 if (file
->flags
& FILE_FLAG_DELETE_ON_CLOSE
) unlink( file
->name
);
435 if (file
->flags
& FILE_FLAG_OVERLAPPED
)
437 destroy_async_queue (&file
->read_q
);
438 destroy_async_queue (&file
->write_q
);
440 if (file
->fd
) release_object( file
->fd
);
443 /* set the last error depending on errno */
444 void file_set_error(void)
448 case EAGAIN
: set_error( STATUS_SHARING_VIOLATION
); break;
449 case EBADF
: set_error( STATUS_INVALID_HANDLE
); break;
450 case ENOSPC
: set_error( STATUS_DISK_FULL
); break;
453 case EPERM
: set_error( STATUS_ACCESS_DENIED
); break;
454 case EROFS
: set_error( STATUS_MEDIA_WRITE_PROTECTED
); break;
455 case EBUSY
: set_error( STATUS_FILE_LOCK_CONFLICT
); break;
456 case ENOENT
: set_error( STATUS_NO_SUCH_FILE
); break;
457 case EISDIR
: set_error( 0xc0010000 | ERROR_CANNOT_MAKE
/* FIXME */ ); break;
459 case EMFILE
: set_error( STATUS_NO_MORE_FILES
); break;
460 case EEXIST
: set_error( STATUS_OBJECT_NAME_COLLISION
); break;
461 case EINVAL
: set_error( STATUS_INVALID_PARAMETER
); break;
462 case ESPIPE
: set_error( 0xc0010000 | ERROR_SEEK
/* FIXME */ ); break;
463 case ENOTEMPTY
: set_error( STATUS_DIRECTORY_NOT_EMPTY
); break;
464 case EIO
: set_error( STATUS_ACCESS_VIOLATION
); break;
465 case EOVERFLOW
: set_error( STATUS_INVALID_PARAMETER
); break;
466 default: perror("file_set_error"); set_error( ERROR_UNKNOWN
/* FIXME */ ); break;
470 struct file
*get_file_obj( struct process
*process
, obj_handle_t handle
, unsigned int access
)
472 return (struct file
*)get_handle_obj( process
, handle
, access
, &file_ops
);
475 int get_file_unix_fd( struct file
*file
)
477 return get_unix_fd( file
->fd
);
480 static int set_file_pointer( obj_handle_t handle
, unsigned int *low
, int *high
, int whence
)
485 xto
= *low
+((off_t
)*high
<<32);
486 if (!(file
= get_file_obj( current
->process
, handle
, 0 )))
488 if ((result
= lseek( get_file_unix_fd(file
), xto
, whence
))==-1)
490 /* Check for seek before start of file */
492 /* also check EPERM due to SuSE7 2.2.16 lseek() EPERM kernel bug */
493 if (((errno
== EINVAL
) || (errno
== EPERM
))
494 && (whence
!= SEEK_SET
) && (*high
< 0))
495 set_error( 0xc0010000 | ERROR_NEGATIVE_SEEK
/* FIXME */ );
498 release_object( file
);
501 *low
= result
& 0xffffffff;
502 *high
= result
>> 32;
503 release_object( file
);
507 /* extend a file beyond the current end of file */
508 static int extend_file( struct file
*file
, off_t size
)
510 static const char zero
;
511 int unix_fd
= get_file_unix_fd( file
);
513 /* extend the file one byte beyond the requested size and then truncate it */
514 /* this should work around ftruncate implementations that can't extend files */
515 if ((lseek( unix_fd
, size
, SEEK_SET
) != -1) &&
516 (write( unix_fd
, &zero
, 1 ) != -1))
518 ftruncate( unix_fd
, size
);
525 /* truncate file at current position */
526 static int truncate_file( struct file
*file
)
529 int unix_fd
= get_file_unix_fd( file
);
530 off_t pos
= lseek( unix_fd
, 0, SEEK_CUR
);
531 off_t eof
= lseek( unix_fd
, 0, SEEK_END
);
533 if (eof
< pos
) ret
= extend_file( file
, pos
);
536 if (ftruncate( unix_fd
, pos
) != -1) ret
= 1;
537 else file_set_error();
539 lseek( unix_fd
, pos
, SEEK_SET
); /* restore file pos */
543 /* try to grow the file to the specified size */
544 int grow_file( struct file
*file
, int size_high
, int size_low
)
548 int unix_fd
= get_file_unix_fd( file
);
549 off_t old_pos
, size
= size_low
+ (((off_t
)size_high
)<<32);
551 if (fstat( unix_fd
, &st
) == -1)
556 if (st
.st_size
>= size
) return 1; /* already large enough */
557 old_pos
= lseek( unix_fd
, 0, SEEK_CUR
); /* save old pos */
558 ret
= extend_file( file
, size
);
559 lseek( unix_fd
, old_pos
, SEEK_SET
); /* restore file pos */
563 static int set_file_time( obj_handle_t handle
, time_t access_time
, time_t write_time
)
566 struct utimbuf utimbuf
;
568 if (!(file
= get_file_obj( current
->process
, handle
, GENERIC_WRITE
)))
572 set_error( STATUS_INVALID_HANDLE
);
573 release_object( file
);
576 if (!access_time
|| !write_time
)
579 if (stat( file
->name
, &st
) == -1) goto error
;
580 if (!access_time
) access_time
= st
.st_atime
;
581 if (!write_time
) write_time
= st
.st_mtime
;
583 utimbuf
.actime
= access_time
;
584 utimbuf
.modtime
= write_time
;
585 if (utime( file
->name
, &utimbuf
) == -1) goto error
;
586 release_object( file
);
590 release_object( file
);
595 DECL_HANDLER(create_file
)
600 if ((file
= create_file( get_req_data(), get_req_data_size(), req
->access
,
601 req
->sharing
, req
->create
, req
->attrs
, req
->removable
)))
603 reply
->handle
= alloc_handle( current
->process
, file
, req
->access
, req
->inherit
);
604 release_object( file
);
608 /* allocate a file handle for a Unix fd */
609 DECL_HANDLER(alloc_file_handle
)
615 if ((fd
= thread_get_inflight_fd( current
, req
->fd
)) == -1)
617 set_error( STATUS_INVALID_HANDLE
);
620 if ((file
= create_file_for_fd( fd
, req
->access
, FILE_SHARE_READ
| FILE_SHARE_WRITE
,
623 reply
->handle
= alloc_handle( current
->process
, file
, req
->access
, req
->inherit
);
624 release_object( file
);
628 /* set a file current position */
629 DECL_HANDLER(set_file_pointer
)
631 int high
= req
->high
;
633 set_file_pointer( req
->handle
, &low
, &high
, req
->whence
);
634 reply
->new_low
= low
;
635 reply
->new_high
= high
;
638 /* truncate (or extend) a file */
639 DECL_HANDLER(truncate_file
)
643 if ((file
= get_file_obj( current
->process
, req
->handle
, GENERIC_WRITE
)))
645 truncate_file( file
);
646 release_object( file
);
650 /* set a file access and modification times */
651 DECL_HANDLER(set_file_time
)
653 set_file_time( req
->handle
, req
->access_time
, req
->write_time
);
656 /* lock a region of a file */
657 DECL_HANDLER(lock_file
)
660 file_pos_t offset
= ((file_pos_t
)req
->offset_high
<< 32) | req
->offset_low
;
661 file_pos_t count
= ((file_pos_t
)req
->count_high
<< 32) | req
->count_low
;
663 if ((file
= get_file_obj( current
->process
, req
->handle
, 0 )))
665 reply
->handle
= lock_fd( file
->fd
, offset
, count
, req
->shared
, req
->wait
);
666 reply
->overlapped
= (file
->flags
& FILE_FLAG_OVERLAPPED
) != 0;
667 release_object( file
);
671 /* unlock a region of a file */
672 DECL_HANDLER(unlock_file
)
675 file_pos_t offset
= ((file_pos_t
)req
->offset_high
<< 32) | req
->offset_low
;
676 file_pos_t count
= ((file_pos_t
)req
->count_high
<< 32) | req
->count_low
;
678 if ((file
= get_file_obj( current
->process
, req
->handle
, 0 )))
680 unlock_fd( file
->fd
, offset
, count
);
681 release_object( file
);