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