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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
  43 #include "winerror.h"
  44 #include "windef.h"
  45 #include "winbase.h"
  46 #include "winreg.h"
  47 #include "winternl.h"
  48
  49 #include "file.h"
  50 #include "handle.h"
  51 #include "thread.h"
  52 #include "request.h"
  53
  54 struct file
  55 {
  56     struct object       obj;        /* object header */
  57     struct fd          *fd;         /* file descriptor for this file */
  58     unsigned int        access;     /* file access (GENERIC_READ/WRITE) */
  59     unsigned int        options;    /* file options (FILE_DELETE_ON_CLOSE, FILE_SYNCHRONOUS...) */
  60     struct async       *read_q;
  61     struct async       *write_q;
  62 };
  63
  64 static void file_dump( struct object *obj, int verbose );
  65 static struct fd *file_get_fd( struct object *obj );
  66 static void file_destroy( struct object *obj );
  67
  68 static int file_get_poll_events( struct fd *fd );
  69 static void file_poll_event( struct fd *fd, int event );
  70 static int file_flush( struct fd *fd, struct event **event );
  71 static int file_get_info( struct fd *fd );
  72 static void file_queue_async( struct fd *fd, void *apc, void *user, void* iosb, int type, int count );
  73 static void file_cancel_async( struct fd *fd );
  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     file_get_fd,                  /* get_fd */
  84     file_destroy                  /* destroy */
  85 };
  86
  87 static const struct fd_ops file_fd_ops =
  88 {
  89     file_get_poll_events,         /* get_poll_events */
  90     file_poll_event,              /* poll_event */
  91     file_flush,                   /* flush */
  92     file_get_info,                /* get_file_info */
  93     file_queue_async,             /* queue_async */
  94     file_cancel_async             /* cancel_async */
  95 };
  96
  97 static inline int is_overlapped( const struct file *file )
  98 {
  99     return !(file->options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT));
 100 }
 101
 102 /* create a file from a file descriptor */
 103 /* if the function fails the fd is closed */
 104 static struct file *create_file_for_fd( int fd, unsigned int access, unsigned int sharing )
 105 {
 106     struct file *file;
 107
 108     if ((file = alloc_object( &file_ops )))
 109     {
 110         file->access     = access;
 111         file->options    = FILE_SYNCHRONOUS_IO_NONALERT;
 112         if (!(file->fd = create_anonymous_fd( &file_fd_ops, fd, &file->obj )))
 113         {
 114             release_object( file );
 115             return NULL;
 116         }
 117     }
 118     return file;
 119 }
 120
 121
 122 static struct object *create_file( const char *nameptr, size_t len, unsigned int access,
 123                                    unsigned int sharing, int create, unsigned int options,
 124                                    unsigned int attrs )
 125 {
 126     struct file *file;
 127     int flags;
 128     char *name;
 129     mode_t mode;
 130
 131     if (!(name = mem_alloc( len + 1 ))) return NULL;
 132     memcpy( name, nameptr, len );
 133     name[len] = 0;
 134
 135     switch(create)
 136     {
 137     case FILE_CREATE:       flags = O_CREAT | O_EXCL; break;
 138     case FILE_OVERWRITE_IF: /* FIXME: the difference is whether we trash existing attr or not */
 139     case FILE_SUPERSEDE:    flags = O_CREAT | O_TRUNC; break;
 140     case FILE_OPEN:         flags = 0; break;
 141     case FILE_OPEN_IF:      flags = O_CREAT; break;
 142     case FILE_OVERWRITE:    flags = O_TRUNC; break;
 143     default:                set_error( STATUS_INVALID_PARAMETER ); goto error;
 144     }
 145
 146     switch(access & (GENERIC_READ | GENERIC_WRITE))
 147     {
 148     case 0: break;
 149     case GENERIC_READ:  flags |= O_RDONLY; break;
 150     case GENERIC_WRITE: flags |= O_WRONLY; break;
 151     case GENERIC_READ|GENERIC_WRITE: flags |= O_RDWR; break;
 152     }
 153     mode = (attrs & FILE_ATTRIBUTE_READONLY) ? 0444 : 0666;
 154
 155     if (len >= 4 &&
 156         (!strcasecmp( name + len - 4, ".exe" ) || !strcasecmp( name + len - 4, ".com" )))
 157         mode |= 0111;
 158
 159     if (!(file = alloc_object( &file_ops ))) goto error;
 160
 161     file->access     = access;
 162     file->options    = options;
 163     if (is_overlapped( file ))
 164     {
 165         file->read_q = file->write_q = NULL;
 166     }
 167
 168     /* FIXME: should set error to STATUS_OBJECT_NAME_COLLISION if file existed before */
 169     if (!(file->fd = alloc_fd( &file_fd_ops, &file->obj )) ||
 170         !(file->fd = open_fd( file->fd, name, flags | O_NONBLOCK | O_LARGEFILE,
 171                               &mode, access, sharing, options )))
 172     {
 173         free( name );
 174         release_object( file );
 175         return NULL;
 176     }
 177     free( name );
 178
 179     /* check for serial port */
 180     if (S_ISCHR(mode) && is_serial_fd( file->fd ))
 181     {
 182         struct object *obj = create_serial( file->fd, file->options );
 183         release_object( file );
 184         return obj;
 185     }
 186
 187     return &file->obj;
 188
 189  error:
 190     free( name );
 191     return NULL;
 192 }
 193
 194 /* check if two file objects point to the same file */
 195 int is_same_file( struct file *file1, struct file *file2 )
 196 {
 197     return is_same_file_fd( file1->fd, file2->fd );
 198 }
 199
 200 /* create a temp file for anonymous mappings */
 201 struct file *create_temp_file( int access )
 202 {
 203     char tmpfn[16];
 204     int fd;
 205
 206     sprintf( tmpfn, "anonmap.XXXXXX" );  /* create it in the server directory */
 207     fd = mkstemps( tmpfn, 0 );
 208     if (fd == -1)
 209     {
 210         file_set_error();
 211         return NULL;
 212     }
 213     unlink( tmpfn );
 214     return create_file_for_fd( fd, access, 0 );
 215 }
 216
 217 static void file_dump( struct object *obj, int verbose )
 218 {
 219     struct file *file = (struct file *)obj;
 220     assert( obj->ops == &file_ops );
 221     fprintf( stderr, "File fd=%p options=%08x\n", file->fd, file->options );
 222 }
 223
 224 static int file_get_poll_events( struct fd *fd )
 225 {
 226     struct file *file = get_fd_user( fd );
 227     int events = 0;
 228     assert( file->obj.ops == &file_ops );
 229     if (file->access & GENERIC_READ) events |= POLLIN;
 230     if (file->access & GENERIC_WRITE) events |= POLLOUT;
 231     return events;
 232 }
 233
 234 static void file_poll_event( struct fd *fd, int event )
 235 {
 236     struct file *file = get_fd_user( fd );
 237     assert( file->obj.ops == &file_ops );
 238     if (is_overlapped( file ))
 239     {
 240         if ( file->read_q && (POLLIN & event) )
 241         {
 242             async_terminate( file->read_q, STATUS_ALERTED );
 243             return;
 244         }
 245         if ( file->write_q && (POLLOUT & event) )
 246         {
 247             async_terminate( file->write_q, STATUS_ALERTED );
 248             return;
 249         }
 250     }
 251     default_poll_event( fd, event );
 252 }
 253
 254
 255 static int file_flush( struct fd *fd, struct event **event )
 256 {
 257     int ret = (fsync( get_unix_fd(fd) ) != -1);
 258     if (!ret) file_set_error();
 259     return ret;
 260 }
 261
 262 static int file_get_info( struct fd *fd )
 263 {
 264     struct file *file = get_fd_user( fd );
 265
 266     if (is_overlapped( file )) return FD_FLAG_OVERLAPPED;
 267     else return 0;
 268 }
 269
 270 static void file_queue_async( struct fd *fd, void *apc, void *user, void *iosb,
 271                               int type, int count )
 272 {
 273     struct file *file = get_fd_user( fd );
 274     struct async **head;
 275     int events;
 276
 277     assert( file->obj.ops == &file_ops );
 278
 279     if (!is_overlapped( file ))
 280     {
 281         set_error( STATUS_INVALID_HANDLE );
 282         return;
 283     }
 284
 285     switch (type)
 286     {
 287     case ASYNC_TYPE_READ:
 288         head = &file->read_q;
 289         break;
 290     case ASYNC_TYPE_WRITE:
 291         head = &file->write_q;
 292         break;
 293     default:
 294         set_error( STATUS_INVALID_PARAMETER );
 295         return;
 296     }
 297
 298     if (!create_async( fd, current, 0, head, apc, user, iosb ))
 299         return;
 300
 301     /* Check if the new pending request can be served immediately */
 302     events = check_fd_events( fd, file_get_poll_events( fd ) );
 303     if (events) file_poll_event( fd, events );
 304
 305     set_fd_events( fd, file_get_poll_events( fd ));
 306 }
 307
 308 static void file_cancel_async( struct fd *fd )
 309 {
 310     struct file *file = get_fd_user( fd );
 311     assert( file->obj.ops == &file_ops );
 312
 313     async_terminate_queue( &file->read_q, STATUS_CANCELLED );
 314     async_terminate_queue( &file->write_q, STATUS_CANCELLED );
 315 }
 316
 317 static struct fd *file_get_fd( struct object *obj )
 318 {
 319     struct file *file = (struct file *)obj;
 320     assert( obj->ops == &file_ops );
 321     return (struct fd *)grab_object( file->fd );
 322 }
 323
 324 static void file_destroy( struct object *obj )
 325 {
 326     struct file *file = (struct file *)obj;
 327     assert( obj->ops == &file_ops );
 328
 329     if (is_overlapped( file ))
 330     {
 331         async_terminate_queue( &file->read_q, STATUS_CANCELLED );
 332         async_terminate_queue( &file->write_q, STATUS_CANCELLED );
 333     }
 334     if (file->fd) release_object( file->fd );
 335 }
 336
 337 /* set the last error depending on errno */
 338 void file_set_error(void)
 339 {
 340     switch (errno)
 341     {
 342     case EAGAIN:    set_error( STATUS_SHARING_VIOLATION ); break;
 343     case EBADF:     set_error( STATUS_INVALID_HANDLE ); break;
 344     case ENOSPC:    set_error( STATUS_DISK_FULL ); break;
 345     case EACCES:
 346     case ESRCH:
 347     case EPERM:     set_error( STATUS_ACCESS_DENIED ); break;
 348     case EROFS:     set_error( STATUS_MEDIA_WRITE_PROTECTED ); break;
 349     case EBUSY:     set_error( STATUS_FILE_LOCK_CONFLICT ); break;
 350     case ENOENT:    set_error( STATUS_NO_SUCH_FILE ); break;
 351     case EISDIR:    set_error( STATUS_FILE_IS_A_DIRECTORY ); break;
 352     case ENFILE:
 353     case EMFILE:    set_error( STATUS_NO_MORE_FILES ); break;
 354     case EEXIST:    set_error( STATUS_OBJECT_NAME_COLLISION ); break;
 355     case EINVAL:    set_error( STATUS_INVALID_PARAMETER ); break;
 356     case ESPIPE:    set_win32_error( ERROR_SEEK ); break;
 357     case ENOTEMPTY: set_error( STATUS_DIRECTORY_NOT_EMPTY ); break;
 358     case EIO:       set_error( STATUS_ACCESS_VIOLATION ); break;
 359     case ENOTDIR:   set_error( STATUS_NOT_A_DIRECTORY ); break;
 360     case EFBIG:     set_error( STATUS_SECTION_TOO_BIG ); break;
 361     case ENODEV:    set_error( STATUS_NO_SUCH_DEVICE ); break;
 362     case ENXIO:     set_error( STATUS_NO_SUCH_DEVICE ); break;
 363 #ifdef EOVERFLOW
 364     case EOVERFLOW: set_error( STATUS_INVALID_PARAMETER ); break;
 365 #endif
 366     default:        perror("file_set_error"); set_error( STATUS_UNSUCCESSFUL ); break;
 367     }
 368 }
 369
 370 struct file *get_file_obj( struct process *process, obj_handle_t handle, unsigned int access )
 371 {
 372     return (struct file *)get_handle_obj( process, handle, access, &file_ops );
 373 }
 374
 375 int get_file_unix_fd( struct file *file )
 376 {
 377     return get_unix_fd( file->fd );
 378 }
 379
 380 /* extend a file beyond the current end of file */
 381 static int extend_file( struct file *file, off_t size )
 382 {
 383     static const char zero;
 384     int unix_fd = get_file_unix_fd( file );
 385
 386     /* extend the file one byte beyond the requested size and then truncate it */
 387     /* this should work around ftruncate implementations that can't extend files */
 388     if (pwrite( unix_fd, &zero, 1, size ) != -1)
 389     {
 390         ftruncate( unix_fd, size );
 391         return 1;
 392     }
 393     file_set_error();
 394     return 0;
 395 }
 396
 397 /* try to grow the file to the specified size */
 398 int grow_file( struct file *file, int size_high, int size_low )
 399 {
 400     struct stat st;
 401     int unix_fd = get_file_unix_fd( file );
 402     off_t size = size_low + (((off_t)size_high)<<32);
 403
 404     if (fstat( unix_fd, &st ) == -1)
 405     {
 406         file_set_error();
 407         return 0;
 408     }
 409     if (st.st_size >= size) return 1;  /* already large enough */
 410     return extend_file( file, size );
 411 }
 412
 413 /* create a file */
 414 DECL_HANDLER(create_file)
 415 {
 416     struct object *file;
 417
 418     reply->handle = 0;
 419     if ((file = create_file( get_req_data(), get_req_data_size(), req->access,
 420                              req->sharing, req->create, req->options, req->attrs )))
 421     {
 422         reply->handle = alloc_handle( current->process, file, req->access, req->inherit );
 423         release_object( file );
 424     }
 425 }
 426
 427 /* allocate a file handle for a Unix fd */
 428 DECL_HANDLER(alloc_file_handle)
 429 {
 430     struct file *file;
 431     int fd;
 432
 433     reply->handle = 0;
 434     if ((fd = thread_get_inflight_fd( current, req->fd )) == -1)
 435     {
 436         set_error( STATUS_INVALID_HANDLE );
 437         return;
 438     }
 439     if ((file = create_file_for_fd( fd, req->access, FILE_SHARE_READ | FILE_SHARE_WRITE )))
 440     {
 441         reply->handle = alloc_handle( current->process, file, req->access, req->inherit );
 442         release_object( file );
 443     }
 444 }
 445
 446 /* lock a region of a file */
 447 DECL_HANDLER(lock_file)
 448 {
 449     struct file *file;
 450     file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
 451     file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
 452
 453     if ((file = get_file_obj( current->process, req->handle, 0 )))
 454     {
 455         reply->handle = lock_fd( file->fd, offset, count, req->shared, req->wait );
 456         reply->overlapped = is_overlapped( file );
 457         release_object( file );
 458     }
 459 }
 460
 461 /* unlock a region of a file */
 462 DECL_HANDLER(unlock_file)
 463 {
 464     struct file *file;
 465     file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
 466     file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
 467
 468     if ((file = get_file_obj( current->process, req->handle, 0 )))
 469     {
 470         unlock_fd( file->fd, offset, count );
 471         release_object( file );
 472     }
 473 }