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