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