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