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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #include "wine/port.h"
31 #ifdef HAVE_SYS_ERRNO_H
32 #include <sys/errno.h>
36 #include <sys/types.h>
47 #define WIN32_NO_STATUS
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.) */
63 static unsigned int generic_file_map_access( unsigned int access
);
65 static void file_dump( struct object
*obj
, int verbose
);
66 static struct fd
*file_get_fd( struct object
*obj
);
67 static unsigned int file_map_access( struct object
*obj
, unsigned int access
);
68 static void file_destroy( struct object
*obj
);
70 static int file_get_poll_events( struct fd
*fd
);
71 static void file_flush( struct fd
*fd
, struct event
**event
);
72 static enum server_fd_type
file_get_fd_type( struct fd
*fd
);
74 static const struct object_ops file_ops
=
76 sizeof(struct file
), /* size */
78 add_queue
, /* add_queue */
79 remove_queue
, /* remove_queue */
80 default_fd_signaled
, /* signaled */
81 no_satisfied
, /* satisfied */
82 no_signal
, /* signal */
83 file_get_fd
, /* get_fd */
84 file_map_access
, /* map_access */
85 no_lookup_name
, /* lookup_name */
86 no_open_file
, /* open_file */
87 fd_close_handle
, /* close_handle */
88 file_destroy
/* destroy */
91 static const struct fd_ops file_fd_ops
=
93 file_get_poll_events
, /* get_poll_events */
94 default_poll_event
, /* poll_event */
95 file_flush
, /* flush */
96 file_get_fd_type
, /* get_fd_type */
97 default_fd_queue_async
, /* queue_async */
98 default_fd_reselect_async
, /* reselect_async */
99 default_fd_cancel_async
/* cancel_async */
102 static inline int is_overlapped( const struct file
*file
)
104 return !(get_fd_options( file
->fd
) & (FILE_SYNCHRONOUS_IO_ALERT
| FILE_SYNCHRONOUS_IO_NONALERT
));
107 /* create a file from a file descriptor */
108 /* if the function fails the fd is closed */
109 static struct file
*create_file_for_fd( int fd
, unsigned int access
, unsigned int sharing
)
113 if ((file
= alloc_object( &file_ops
)))
115 file
->access
= file_map_access( &file
->obj
, access
);
116 if (!(file
->fd
= create_anonymous_fd( &file_fd_ops
, fd
, &file
->obj
,
117 FILE_SYNCHRONOUS_IO_NONALERT
)))
119 release_object( file
);
126 static struct object
*create_file_obj( struct fd
*fd
, unsigned int access
)
128 struct file
*file
= alloc_object( &file_ops
);
130 if (!file
) return NULL
;
131 file
->access
= access
;
134 set_fd_user( fd
, &file_fd_ops
, &file
->obj
);
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
,
142 struct object
*obj
= NULL
;
148 if (!(name
= mem_alloc( len
+ 1 ))) return NULL
;
149 memcpy( name
, nameptr
, len
);
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
;
163 mode
= (attrs
& FILE_ATTRIBUTE_READONLY
) ? 0444 : 0666;
166 (!strcasecmp( name
+ len
- 4, ".exe" ) || !strcasecmp( name
+ len
- 4, ".com" )))
169 access
= generic_file_map_access( access
);
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
);
176 obj
= create_dir_obj( fd
);
177 else if (S_ISCHR(mode
) && is_serial_fd( fd
))
178 obj
= create_serial( fd
);
180 obj
= create_file_obj( fd
, access
);
182 release_object( fd
);
189 /* check if two file objects point to the same file */
190 int is_same_file( struct file
*file1
, struct file
*file2
)
192 return is_same_file_fd( file1
->fd
, file2
->fd
);
195 /* create a temp file for anonymous mappings */
196 struct file
*create_temp_file( int access
)
201 sprintf( tmpfn
, "anonmap.XXXXXX" ); /* create it in the server directory */
202 fd
= mkstemps( tmpfn
, 0 );
209 return create_file_for_fd( fd
, access
, 0 );
212 static void file_dump( struct object
*obj
, int verbose
)
214 struct file
*file
= (struct file
*)obj
;
215 assert( obj
->ops
== &file_ops
);
216 fprintf( stderr
, "File fd=%p\n", file
->fd
);
219 static int file_get_poll_events( struct fd
*fd
)
221 struct file
*file
= get_fd_user( fd
);
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
;
229 static void file_flush( struct fd
*fd
, struct event
**event
)
231 int unix_fd
= get_unix_fd( fd
);
232 if (unix_fd
!= -1 && fsync( unix_fd
) == -1) file_set_error();
235 static enum server_fd_type
file_get_fd_type( struct fd
*fd
)
240 static struct fd
*file_get_fd( struct object
*obj
)
242 struct file
*file
= (struct file
*)obj
;
243 assert( obj
->ops
== &file_ops
);
244 return (struct fd
*)grab_object( file
->fd
);
247 static unsigned int generic_file_map_access( unsigned int access
)
249 if (access
& GENERIC_READ
) access
|= FILE_GENERIC_READ
;
250 if (access
& GENERIC_WRITE
) access
|= FILE_GENERIC_WRITE
;
251 if (access
& GENERIC_EXECUTE
) access
|= FILE_GENERIC_EXECUTE
;
252 if (access
& GENERIC_ALL
) access
|= FILE_ALL_ACCESS
;
253 return access
& ~(GENERIC_READ
| GENERIC_WRITE
| GENERIC_EXECUTE
| GENERIC_ALL
);
256 static unsigned int file_map_access( struct object
*obj
, unsigned int access
)
258 return generic_file_map_access( access
);
261 static void file_destroy( struct object
*obj
)
263 struct file
*file
= (struct file
*)obj
;
264 assert( obj
->ops
== &file_ops
);
266 if (file
->fd
) release_object( file
->fd
);
269 /* set the last error depending on errno */
270 void file_set_error(void)
274 case EAGAIN
: set_error( STATUS_SHARING_VIOLATION
); break;
275 case EBADF
: set_error( STATUS_INVALID_HANDLE
); break;
276 case ENOSPC
: set_error( STATUS_DISK_FULL
); break;
279 case EPERM
: set_error( STATUS_ACCESS_DENIED
); break;
280 case EROFS
: set_error( STATUS_MEDIA_WRITE_PROTECTED
); break;
281 case EBUSY
: set_error( STATUS_FILE_LOCK_CONFLICT
); break;
282 case ENOENT
: set_error( STATUS_NO_SUCH_FILE
); break;
283 case EISDIR
: set_error( STATUS_FILE_IS_A_DIRECTORY
); break;
285 case EMFILE
: set_error( STATUS_TOO_MANY_OPENED_FILES
); break;
286 case EEXIST
: set_error( STATUS_OBJECT_NAME_COLLISION
); break;
287 case EINVAL
: set_error( STATUS_INVALID_PARAMETER
); break;
288 case ESPIPE
: set_error( STATUS_ILLEGAL_FUNCTION
); break;
289 case ENOTEMPTY
: set_error( STATUS_DIRECTORY_NOT_EMPTY
); break;
290 case EIO
: set_error( STATUS_ACCESS_VIOLATION
); break;
291 case ENOTDIR
: set_error( STATUS_NOT_A_DIRECTORY
); break;
292 case EFBIG
: set_error( STATUS_SECTION_TOO_BIG
); break;
293 case ENODEV
: set_error( STATUS_NO_SUCH_DEVICE
); break;
294 case ENXIO
: set_error( STATUS_NO_SUCH_DEVICE
); break;
296 case EOVERFLOW
: set_error( STATUS_INVALID_PARAMETER
); break;
298 default: perror("file_set_error"); set_error( STATUS_UNSUCCESSFUL
); break;
302 struct file
*get_file_obj( struct process
*process
, obj_handle_t handle
, unsigned int access
)
304 return (struct file
*)get_handle_obj( process
, handle
, access
, &file_ops
);
307 int get_file_unix_fd( struct file
*file
)
309 return get_unix_fd( file
->fd
);
312 struct file
*grab_file_unless_removable( struct file
*file
)
314 if (is_fd_removable( file
->fd
)) return NULL
;
315 return (struct file
*)grab_object( file
);
318 /* extend a file beyond the current end of file */
319 static int extend_file( struct file
*file
, file_pos_t new_size
)
321 static const char zero
;
322 int unix_fd
= get_file_unix_fd( file
);
323 off_t size
= new_size
;
325 if (unix_fd
== -1) return 0;
327 if (sizeof(new_size
) > sizeof(size
) && size
!= new_size
)
329 set_error( STATUS_INVALID_PARAMETER
);
332 /* extend the file one byte beyond the requested size and then truncate it */
333 /* this should work around ftruncate implementations that can't extend files */
334 if (pwrite( unix_fd
, &zero
, 1, size
) != -1)
336 ftruncate( unix_fd
, size
);
343 /* try to grow the file to the specified size */
344 int grow_file( struct file
*file
, file_pos_t size
)
347 int unix_fd
= get_file_unix_fd( file
);
349 if (unix_fd
== -1) return 0;
351 if (fstat( unix_fd
, &st
) == -1)
356 if (st
.st_size
>= size
) return 1; /* already large enough */
357 return extend_file( file
, size
);
361 DECL_HANDLER(create_file
)
366 if ((file
= create_file( get_req_data(), get_req_data_size(), req
->access
,
367 req
->sharing
, req
->create
, req
->options
, req
->attrs
)))
369 reply
->handle
= alloc_handle( current
->process
, file
, req
->access
, req
->attributes
);
370 release_object( file
);
374 /* allocate a file handle for a Unix fd */
375 DECL_HANDLER(alloc_file_handle
)
381 if ((fd
= thread_get_inflight_fd( current
, req
->fd
)) == -1)
383 set_error( STATUS_INVALID_HANDLE
);
386 if ((file
= create_file_for_fd( fd
, req
->access
, FILE_SHARE_READ
| FILE_SHARE_WRITE
)))
388 reply
->handle
= alloc_handle( current
->process
, file
, req
->access
, req
->attributes
);
389 release_object( file
);
393 /* lock a region of a file */
394 DECL_HANDLER(lock_file
)
397 file_pos_t offset
= ((file_pos_t
)req
->offset_high
<< 32) | req
->offset_low
;
398 file_pos_t count
= ((file_pos_t
)req
->count_high
<< 32) | req
->count_low
;
400 if ((file
= get_file_obj( current
->process
, req
->handle
, 0 )))
402 reply
->handle
= lock_fd( file
->fd
, offset
, count
, req
->shared
, req
->wait
);
403 reply
->overlapped
= is_overlapped( file
);
404 release_object( file
);
408 /* unlock a region of a file */
409 DECL_HANDLER(unlock_file
)
412 file_pos_t offset
= ((file_pos_t
)req
->offset_high
<< 32) | req
->offset_low
;
413 file_pos_t count
= ((file_pos_t
)req
->count_high
<< 32) | req
->count_low
;
415 if ((file
= get_file_obj( current
->process
, req
->handle
, 0 )))
417 unlock_fd( file
->fd
, offset
, count
);
418 release_object( file
);