file.c 13.9 KB
Newer Older
1 2 3 4
/*
 * Server-side file management
 *
 * Copyright (C) 1998 Alexandre Julliard
5 6 7 8 9 10 11 12 13 14 15 16 17 18
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * 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 25
#include <assert.h>
#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 35 36 37 38
#include <sys/stat.h>
#include <sys/time.h>
#include <sys/types.h>
#include <time.h>
#include <unistd.h>
Steven Edwards's avatar
Steven Edwards committed
39
#ifdef HAVE_UTIME_H
40
#include <utime.h>
Steven Edwards's avatar
Steven Edwards committed
41
#endif
42 43 44
#ifdef HAVE_POLL_H
#include <poll.h>
#endif
45 46

#include "winerror.h"
47
#include "windef.h"
48
#include "winbase.h"
49 50
#include "winreg.h"
#include "winternl.h"
51

52
#include "file.h"
53 54
#include "handle.h"
#include "thread.h"
55
#include "request.h"
56 57 58

struct file
{
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 64
    struct list         read_q;
    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 72

static int file_get_poll_events( struct fd *fd );
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 76
static void file_queue_async( struct fd *fd, void *apc, void *user, void* iosb, int type, int count );
static void file_cancel_async( struct fd *fd );
77 78 79

static const struct object_ops file_ops =
{
80 81
    sizeof(struct file),          /* size */
    file_dump,                    /* dump */
82 83 84
    default_fd_add_queue,         /* add_queue */
    default_fd_remove_queue,      /* remove_queue */
    default_fd_signaled,          /* signaled */
85
    no_satisfied,                 /* satisfied */
86
    file_get_fd,                  /* get_fd */
87 88 89 90 91
    file_destroy                  /* destroy */
};

static const struct fd_ops file_fd_ops =
{
92
    file_get_poll_events,         /* get_poll_events */
93
    file_poll_event,              /* poll_event */
94 95
    file_flush,                   /* flush */
    file_get_info,                /* get_file_info */
96 97
    file_queue_async,             /* queue_async */
    file_cancel_async             /* cancel_async */
98 99
};

100 101 102 103 104
static inline int is_overlapped( const struct file *file )
{
    return !(file->options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT));
}

105 106
/* create a file from a file descriptor */
/* 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 118 119
        {
            release_object( file );
            return NULL;
        }
120 121 122
    }
    return file;
}
123 124


125 126
static struct object *create_file( const char *nameptr, size_t len, unsigned int access,
                                   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 135 136
    if (!(name = mem_alloc( len + 1 ))) return NULL;
    memcpy( name, nameptr, len );
    name[len] = 0;
137

138
    switch(create)
139
    {
140 141 142 143 144 145
    case FILE_CREATE:       flags = O_CREAT | O_EXCL; break;
    case FILE_OVERWRITE_IF: /* FIXME: the difference is whether we trash existing attr or not */
    case FILE_SUPERSEDE:    flags = O_CREAT | O_TRUNC; break;
    case FILE_OPEN:         flags = 0; break;
    case FILE_OPEN_IF:      flags = O_CREAT; break;
    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 152 153 154
    case 0: break;
    case GENERIC_READ:  flags |= O_RDONLY; break;
    case GENERIC_WRITE: flags |= O_WRONLY; break;
    case GENERIC_READ|GENERIC_WRITE: flags |= O_RDWR; break;
155
    }
156 157 158 159 160
    mode = (attrs & FILE_ATTRIBUTE_READONLY) ? 0444 : 0666;

    if (len >= 4 &&
        (!strcasecmp( name + len - 4, ".exe" ) || !strcasecmp( name + len - 4, ".com" )))
        mode |= 0111;
161

162 163 164
    if (!(file = alloc_object( &file_ops ))) goto error;

    file->access     = access;
165
    file->options    = options;
166 167
    list_init( &file->read_q );
    list_init( &file->write_q );
168

169 170
    /* FIXME: should set error to STATUS_OBJECT_NAME_COLLISION if file existed before */
    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 176 177
        release_object( file );
        return NULL;
    }
178 179
    free( name );

180 181 182 183 184 185 186 187 188
    /* check for serial port */
    if (S_ISCHR(mode) && is_serial_fd( file->fd ))
    {
        struct object *obj = create_serial( file->fd, file->options );
        release_object( file );
        return obj;
    }

    return &file->obj;
189 190 191 192

 error:
    free( name );
    return NULL;
193 194
}

195 196 197
/* check if two file objects point to the same file */
int is_same_file( struct file *file1, struct file *file2 )
{
198
    return is_same_file_fd( file1->fd, file2->fd );
199 200
}

201 202
/* create a temp file for anonymous mappings */
struct file *create_temp_file( int access )
203
{
204
    char tmpfn[16];
205 206
    int fd;

207
    sprintf( tmpfn, "anonmap.XXXXXX" );  /* create it in the server directory */
208
    fd = mkstemps( tmpfn, 0 );
209 210 211
    if (fd == -1)
    {
        file_set_error();
212
        return NULL;
213
    }
214
    unlink( tmpfn );
215
    return create_file_for_fd( fd, access, 0 );
216 217
}

218 219 220 221
static void file_dump( struct object *obj, int verbose )
{
    struct file *file = (struct file *)obj;
    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 231
    if (file->access & GENERIC_READ) events |= POLLIN;
    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 238
    struct file *file = get_fd_user( fd );
    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 245
            return;
        }
246
        if (!list_empty( &file->write_q ) && (POLLOUT & event) )
247
        {
248
            async_terminate_head( &file->write_q, STATUS_ALERTED );
249 250 251
            return;
        }
    }
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 260
    if (!ret) file_set_error();
    return ret;
261 262
}

263
static int file_get_info( struct fd *fd )
264
{
265
    struct file *file = get_fd_user( fd );
266

267 268
    if (is_overlapped( file )) return FD_FLAG_OVERLAPPED;
    else return 0;
269 270
}

271 272
static void file_queue_async( struct fd *fd, void *apc, void *user, void *iosb,
                              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 291
        break;
    case ASYNC_TYPE_WRITE:
292
        queue = &file->write_q;
293 294 295
        break;
    default:
        set_error( STATUS_INVALID_PARAMETER );
296
        return;
297 298
    }

299
    if (!create_async( current, 0, queue, apc, user, iosb ))
300
        return;
301

302 303 304
    /* Check if the new pending request can be served immediately */
    events = check_fd_events( fd, file_get_poll_events( fd ) );
    if (events) file_poll_event( fd, events );
305

306 307
    set_fd_events( fd, file_get_poll_events( fd ));
}
308

309 310 311 312
static void file_cancel_async( struct fd *fd )
{
    struct file *file = get_fd_user( fd );
    assert( file->obj.ops == &file_ops );
313

314 315
    async_terminate_queue( &file->read_q, STATUS_CANCELLED );
    async_terminate_queue( &file->write_q, STATUS_CANCELLED );
316 317 318 319 320 321 322
}

static struct fd *file_get_fd( struct object *obj )
{
    struct file *file = (struct file *)obj;
    assert( obj->ops == &file_ops );
    return (struct fd *)grab_object( file->fd );
323 324
}

325
static void file_destroy( struct object *obj )
326
{
327 328
    struct file *file = (struct file *)obj;
    assert( obj->ops == &file_ops );
329

330
    if (is_overlapped( file ))
331
    {
332 333
        async_terminate_queue( &file->read_q, STATUS_CANCELLED );
        async_terminate_queue( &file->write_q, STATUS_CANCELLED );
334
    }
335
    if (file->fd) release_object( file->fd );
336 337 338 339 340 341 342
}

/* set the last error depending on errno */
void file_set_error(void)
{
    switch (errno)
    {
343 344 345
    case EAGAIN:    set_error( STATUS_SHARING_VIOLATION ); break;
    case EBADF:     set_error( STATUS_INVALID_HANDLE ); break;
    case ENOSPC:    set_error( STATUS_DISK_FULL ); break;
346
    case EACCES:
347
    case ESRCH:
348 349 350 351
    case EPERM:     set_error( STATUS_ACCESS_DENIED ); break;
    case EROFS:     set_error( STATUS_MEDIA_WRITE_PROTECTED ); break;
    case EBUSY:     set_error( STATUS_FILE_LOCK_CONFLICT ); break;
    case ENOENT:    set_error( STATUS_NO_SUCH_FILE ); break;
352
    case EISDIR:    set_error( STATUS_FILE_IS_A_DIRECTORY ); break;
353
    case ENFILE:
354 355 356
    case EMFILE:    set_error( STATUS_NO_MORE_FILES ); break;
    case EEXIST:    set_error( STATUS_OBJECT_NAME_COLLISION ); break;
    case EINVAL:    set_error( STATUS_INVALID_PARAMETER ); break;
357
    case ESPIPE:    set_win32_error( ERROR_SEEK ); break;
358 359
    case ENOTEMPTY: set_error( STATUS_DIRECTORY_NOT_EMPTY ); break;
    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 363
    case ENODEV:    set_error( STATUS_NO_SUCH_DEVICE ); break;
    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 377
int get_file_unix_fd( struct file *file )
{
378
    return get_unix_fd( file->fd );
379 380
}

381 382
/* extend a file beyond the current end of file */
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 388
    /* extend the file one byte beyond the requested size and then truncate it */
    /* 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 395 396 397
    file_set_error();
    return 0;
}

398 399 400
/* try to grow the file to the specified size */
int grow_file( struct file *file, int size_high, int size_low )
{
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 408 409
    {
        file_set_error();
        return 0;
    }
410
    if (st.st_size >= size) return 1;  /* already large enough */
411
    return extend_file( file, size );
412 413
}

414 415 416
/* create a file */
DECL_HANDLER(create_file)
{
417
    struct object *file;
418

419 420
    reply->handle = 0;
    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 429 430 431
}

/* allocate a file handle for a Unix fd */
DECL_HANDLER(alloc_file_handle)
{
    struct file *file;
432
    int fd;
433

434
    reply->handle = 0;
435
    if ((fd = thread_get_inflight_fd( current, req->fd )) == -1)
436
    {
437 438 439
        set_error( STATUS_INVALID_HANDLE );
        return;
    }
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 448 449 450
    }
}

/* lock a region of a file */
DECL_HANDLER(lock_file)
{
    struct file *file;
451 452
    file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
    file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
453 454 455

    if ((file = get_file_obj( current->process, req->handle, 0 )))
    {
456
        reply->handle = lock_fd( file->fd, offset, count, req->shared, req->wait );
457
        reply->overlapped = is_overlapped( file );
458 459 460 461 462 463 464 465
        release_object( file );
    }
}

/* unlock a region of a file */
DECL_HANDLER(unlock_file)
{
    struct file *file;
466 467
    file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
    file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
468 469 470

    if ((file = get_file_obj( current->process, req->handle, 0 )))
    {
471
        unlock_fd( file->fd, offset, count );
472 473 474
        release_object( file );
    }
}