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