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