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 list         read_q;
  61     struct list         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     list_init( &file->read_q );
 164     list_init( &file->write_q );
 165
 166     /* FIXME: should set error to STATUS_OBJECT_NAME_COLLISION if file existed before */
 167     if (!(file->fd = alloc_fd( &file_fd_ops, &file->obj )) ||
 168         !(file->fd = open_fd( file->fd, name, flags | O_NONBLOCK | O_LARGEFILE,
 169                               &mode, access, sharing, options )))
 170     {
 171         free( name );
 172         release_object( file );
 173         return NULL;
 174     }
 175     free( name );
 176
 177     /* check for serial port */
 178     if (S_ISCHR(mode) && is_serial_fd( file->fd ))
 179     {
 180         struct object *obj = create_serial( file->fd, file->options );
 181         release_object( file );
 182         return obj;
 183     }
 184
 185     return &file->obj;
 186
 187  error:
 188     free( name );
 189     return NULL;
 190 }
 191
 192 /* check if two file objects point to the same file */
 193 int is_same_file( struct file *file1, struct file *file2 )
 194 {
 195     return is_same_file_fd( file1->fd, file2->fd );
 196 }
 197
 198 /* create a temp file for anonymous mappings */
 199 struct file *create_temp_file( int access )
 200 {
 201     char tmpfn[16];
 202     int fd;
 203
 204     sprintf( tmpfn, "anonmap.XXXXXX" );  /* create it in the server directory */
 205     fd = mkstemps( tmpfn, 0 );
 206     if (fd == -1)
 207     {
 208         file_set_error();
 209         return NULL;
 210     }
 211     unlink( tmpfn );
 212     return create_file_for_fd( fd, access, 0 );
 213 }
 214
 215 static void file_dump( struct object *obj, int verbose )
 216 {
 217     struct file *file = (struct file *)obj;
 218     assert( obj->ops == &file_ops );
 219     fprintf( stderr, "File fd=%p options=%08x\n", file->fd, file->options );
 220 }
 221
 222 static int file_get_poll_events( struct fd *fd )
 223 {
 224     struct file *file = get_fd_user( fd );
 225     int events = 0;
 226     assert( file->obj.ops == &file_ops );
 227     if (file->access & GENERIC_READ) events |= POLLIN;
 228     if (file->access & GENERIC_WRITE) events |= POLLOUT;
 229     return events;
 230 }
 231
 232 static void file_poll_event( struct fd *fd, int event )
 233 {
 234     struct file *file = get_fd_user( fd );
 235     assert( file->obj.ops == &file_ops );
 236     if (is_overlapped( file ))
 237     {
 238         if (!list_empty( &file->read_q ) && (POLLIN & event) )
 239         {
 240             async_terminate_head( &file->read_q, STATUS_ALERTED );
 241             return;
 242         }
 243         if (!list_empty( &file->write_q ) && (POLLOUT & event) )
 244         {
 245             async_terminate_head( &file->write_q, STATUS_ALERTED );
 246             return;
 247         }
 248     }
 249     default_poll_event( fd, event );
 250 }
 251
 252
 253 static int file_flush( struct fd *fd, struct event **event )
 254 {
 255     int ret = (fsync( get_unix_fd(fd) ) != -1);
 256     if (!ret) file_set_error();
 257     return ret;
 258 }
 259
 260 static int file_get_info( struct fd *fd )
 261 {
 262     struct file *file = get_fd_user( fd );
 263
 264     if (is_overlapped( file )) return FD_FLAG_OVERLAPPED;
 265     else return 0;
 266 }
 267
 268 static void file_queue_async( struct fd *fd, void *apc, void *user, void *iosb,
 269                               int type, int count )
 270 {
 271     struct file *file = get_fd_user( fd );
 272     struct list *queue;
 273     int events;
 274
 275     assert( file->obj.ops == &file_ops );
 276
 277     if (!is_overlapped( file ))
 278     {
 279         set_error( STATUS_INVALID_HANDLE );
 280         return;
 281     }
 282
 283     switch (type)
 284     {
 285     case ASYNC_TYPE_READ:
 286         queue = &file->read_q;
 287         break;
 288     case ASYNC_TYPE_WRITE:
 289         queue = &file->write_q;
 290         break;
 291     default:
 292         set_error( STATUS_INVALID_PARAMETER );
 293         return;
 294     }
 295
 296     if (!create_async( fd, current, 0, queue, apc, user, iosb ))
 297         return;
 298
 299     /* Check if the new pending request can be served immediately */
 300     events = check_fd_events( fd, file_get_poll_events( fd ) );
 301     if (events) file_poll_event( fd, events );
 302
 303     set_fd_events( fd, file_get_poll_events( fd ));
 304 }
 305
 306 static void file_cancel_async( struct fd *fd )
 307 {
 308     struct file *file = get_fd_user( fd );
 309     assert( file->obj.ops == &file_ops );
 310
 311     async_terminate_queue( &file->read_q, STATUS_CANCELLED );
 312     async_terminate_queue( &file->write_q, STATUS_CANCELLED );
 313 }
 314
 315 static struct fd *file_get_fd( struct object *obj )
 316 {
 317     struct file *file = (struct file *)obj;
 318     assert( obj->ops == &file_ops );
 319     return (struct fd *)grab_object( file->fd );
 320 }
 321
 322 static void file_destroy( struct object *obj )
 323 {
 324     struct file *file = (struct file *)obj;
 325     assert( obj->ops == &file_ops );
 326
 327     if (is_overlapped( file ))
 328     {
 329         async_terminate_queue( &file->read_q, STATUS_CANCELLED );
 330         async_terminate_queue( &file->write_q, STATUS_CANCELLED );
 331     }
 332     if (file->fd) release_object( file->fd );
 333 }
 334
 335 /* set the last error depending on errno */
 336 void file_set_error(void)
 337 {
 338     switch (errno)
 339     {
 340     case EAGAIN:    set_error( STATUS_SHARING_VIOLATION ); break;
 341     case EBADF:     set_error( STATUS_INVALID_HANDLE ); break;
 342     case ENOSPC:    set_error( STATUS_DISK_FULL ); break;
 343     case EACCES:
 344     case ESRCH:
 345     case EPERM:     set_error( STATUS_ACCESS_DENIED ); break;
 346     case EROFS:     set_error( STATUS_MEDIA_WRITE_PROTECTED ); break;
 347     case EBUSY:     set_error( STATUS_FILE_LOCK_CONFLICT ); break;
 348     case ENOENT:    set_error( STATUS_NO_SUCH_FILE ); break;
 349     case EISDIR:    set_error( STATUS_FILE_IS_A_DIRECTORY ); break;
 350     case ENFILE:
 351     case EMFILE:    set_error( STATUS_NO_MORE_FILES ); break;
 352     case EEXIST:    set_error( STATUS_OBJECT_NAME_COLLISION ); break;
 353     case EINVAL:    set_error( STATUS_INVALID_PARAMETER ); break;
 354     case ESPIPE:    set_win32_error( ERROR_SEEK ); break;
 355     case ENOTEMPTY: set_error( STATUS_DIRECTORY_NOT_EMPTY ); break;
 356     case EIO:       set_error( STATUS_ACCESS_VIOLATION ); break;
 357     case ENOTDIR:   set_error( STATUS_NOT_A_DIRECTORY ); break;
 358     case EFBIG:     set_error( STATUS_SECTION_TOO_BIG ); break;
 359     case ENODEV:    set_error( STATUS_NO_SUCH_DEVICE ); break;
 360     case ENXIO:     set_error( STATUS_NO_SUCH_DEVICE ); break;
 361 #ifdef EOVERFLOW
 362     case EOVERFLOW: set_error( STATUS_INVALID_PARAMETER ); break;
 363 #endif
 364     default:        perror("file_set_error"); set_error( STATUS_UNSUCCESSFUL ); break;
 365     }
 366 }
 367
 368 struct file *get_file_obj( struct process *process, obj_handle_t handle, unsigned int access )
 369 {
 370     return (struct file *)get_handle_obj( process, handle, access, &file_ops );
 371 }
 372
 373 int get_file_unix_fd( struct file *file )
 374 {
 375     return get_unix_fd( file->fd );
 376 }
 377
 378 /* extend a file beyond the current end of file */
 379 static int extend_file( struct file *file, off_t size )
 380 {
 381     static const char zero;
 382     int unix_fd = get_file_unix_fd( file );
 383
 384     /* extend the file one byte beyond the requested size and then truncate it */
 385     /* this should work around ftruncate implementations that can't extend files */
 386     if (pwrite( unix_fd, &zero, 1, size ) != -1)
 387     {
 388         ftruncate( unix_fd, size );
 389         return 1;
 390     }
 391     file_set_error();
 392     return 0;
 393 }
 394
 395 /* try to grow the file to the specified size */
 396 int grow_file( struct file *file, int size_high, int size_low )
 397 {
 398     struct stat st;
 399     int unix_fd = get_file_unix_fd( file );
 400     off_t size = size_low + (((off_t)size_high)<<32);
 401
 402     if (fstat( unix_fd, &st ) == -1)
 403     {
 404         file_set_error();
 405         return 0;
 406     }
 407     if (st.st_size >= size) return 1;  /* already large enough */
 408     return extend_file( file, size );
 409 }
 410
 411 /* create a file */
 412 DECL_HANDLER(create_file)
 413 {
 414     struct object *file;
 415
 416     reply->handle = 0;
 417     if ((file = create_file( get_req_data(), get_req_data_size(), req->access,
 418                              req->sharing, req->create, req->options, req->attrs )))
 419     {
 420         reply->handle = alloc_handle( current->process, file, req->access, req->inherit );
 421         release_object( file );
 422     }
 423 }
 424
 425 /* allocate a file handle for a Unix fd */
 426 DECL_HANDLER(alloc_file_handle)
 427 {
 428     struct file *file;
 429     int fd;
 430
 431     reply->handle = 0;
 432     if ((fd = thread_get_inflight_fd( current, req->fd )) == -1)
 433     {
 434         set_error( STATUS_INVALID_HANDLE );
 435         return;
 436     }
 437     if ((file = create_file_for_fd( fd, req->access, FILE_SHARE_READ | FILE_SHARE_WRITE )))
 438     {
 439         reply->handle = alloc_handle( current->process, file, req->access, req->inherit );
 440         release_object( file );
 441     }
 442 }
 443
 444 /* lock a region of a file */
 445 DECL_HANDLER(lock_file)
 446 {
 447     struct file *file;
 448     file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
 449     file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
 450
 451     if ((file = get_file_obj( current->process, req->handle, 0 )))
 452     {
 453         reply->handle = lock_fd( file->fd, offset, count, req->shared, req->wait );
 454         reply->overlapped = is_overlapped( file );
 455         release_object( file );
 456     }
 457 }
 458
 459 /* unlock a region of a file */
 460 DECL_HANDLER(unlock_file)
 461 {
 462     struct file *file;
 463     file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
 464     file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
 465
 466     if ((file = get_file_obj( current->process, req->handle, 0 )))
 467     {
 468         unlock_fd( file->fd, offset, count );
 469         release_object( file );
 470     }
 471 }