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