file.c 12.7 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
 *
 * 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
18
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, 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 47
#include "ntstatus.h"
#define WIN32_NO_STATUS
48
#include "windef.h"
49
#include "winternl.h"
50

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

struct file
{
58
    struct object       obj;        /* object header */
59
    struct fd          *fd;         /* file descriptor for this file */
60
    unsigned int        access;     /* file access (FILE_READ_DATA etc.) */
61
    unsigned int        options;    /* file options (FILE_DELETE_ON_CLOSE, FILE_SYNCHRONOUS...) */
62 63
};

64 65
static unsigned int generic_file_map_access( unsigned int access );

66
static void file_dump( struct object *obj, int verbose );
67
static struct fd *file_get_fd( struct object *obj );
68
static unsigned int file_map_access( struct object *obj, unsigned int access );
69
static void file_destroy( struct object *obj );
70 71

static int file_get_poll_events( struct fd *fd );
72
static int file_flush( struct fd *fd, struct event **event );
73
static int file_get_info( struct fd *fd );
74 75 76

static const struct object_ops file_ops =
{
77 78
    sizeof(struct file),          /* size */
    file_dump,                    /* dump */
79 80 81
    default_fd_add_queue,         /* add_queue */
    default_fd_remove_queue,      /* remove_queue */
    default_fd_signaled,          /* signaled */
82
    no_satisfied,                 /* satisfied */
83
    no_signal,                    /* signal */
84
    file_get_fd,                  /* get_fd */
85
    file_map_access,              /* map_access */
86
    no_lookup_name,               /* lookup_name */
87
    no_close_handle,              /* close_handle */
88 89 90 91 92
    file_destroy                  /* destroy */
};

static const struct fd_ops file_fd_ops =
{
93
    file_get_poll_events,         /* get_poll_events */
94
    default_poll_event,           /* poll_event */
95 96
    file_flush,                   /* flush */
    file_get_info,                /* get_file_info */
97 98
    default_fd_queue_async,       /* queue_async */
    default_fd_cancel_async       /* cancel_async */
99 100
};

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

106 107
/* create a file from a file descriptor */
/* if the function fails the fd is closed */
108
static struct file *create_file_for_fd( int fd, unsigned int access, unsigned int sharing )
109 110
{
    struct file *file;
111

112
    if ((file = alloc_object( &file_ops )))
113
    {
114
        file->access     = file_map_access( &file->obj, access );
115
        file->options    = FILE_SYNCHRONOUS_IO_NONALERT;
116
        if (!(file->fd = create_anonymous_fd( &file_fd_ops, fd, &file->obj )))
117 118 119 120
        {
            release_object( file );
            return NULL;
        }
121 122 123
    }
    return file;
}
124

125 126 127 128 129 130 131 132 133 134 135 136
static struct object *create_file_obj( struct fd *fd, unsigned int access, unsigned int options )
{
    struct file *file = alloc_object( &file_ops );

    if (!file) return NULL;
    file->access  = access;
    file->options = options;
    file->fd      = fd;
    grab_object( fd );
    set_fd_user( fd, &file_fd_ops, &file->obj );
    return &file->obj;
}
137

138
static struct object *create_file( const char *nameptr, data_size_t len, unsigned int access,
139
                                   unsigned int sharing, int create, unsigned int options,
140
                                   unsigned int attrs )
141
{
142 143
    struct object *obj = NULL;
    struct fd *fd;
144
    int flags;
145
    char *name;
146
    mode_t mode;
147

148 149 150
    if (!(name = mem_alloc( len + 1 ))) return NULL;
    memcpy( name, nameptr, len );
    name[len] = 0;
151

152
    switch(create)
153
    {
154 155 156 157 158 159
    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;
160
    default:                set_error( STATUS_INVALID_PARAMETER ); goto done;
161
    }
162

163 164 165 166 167
    mode = (attrs & FILE_ATTRIBUTE_READONLY) ? 0444 : 0666;

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

169
    access = generic_file_map_access( access );
170

171
    /* FIXME: should set error to STATUS_OBJECT_NAME_COLLISION if file existed before */
172 173
    fd = open_fd( name, flags | O_NONBLOCK | O_LARGEFILE, &mode, access, sharing, options );
    if (!fd) goto done;
174

175 176 177
    if (S_ISDIR(mode))
        obj = create_dir_obj( fd );
    else if (S_ISCHR(mode) && is_serial_fd( fd ))
178 179 180
        obj = create_serial( fd, options );
    else
        obj = create_file_obj( fd, access, options );
181

182
    release_object( fd );
183

184
done:
185
    free( name );
186
    return obj;
187 188
}

189 190 191
/* check if two file objects point to the same file */
int is_same_file( struct file *file1, struct file *file2 )
{
192
    return is_same_file_fd( file1->fd, file2->fd );
193 194
}

195 196
/* create a temp file for anonymous mappings */
struct file *create_temp_file( int access )
197
{
198
    char tmpfn[16];
199 200
    int fd;

201
    sprintf( tmpfn, "anonmap.XXXXXX" );  /* create it in the server directory */
202
    fd = mkstemps( tmpfn, 0 );
203 204 205
    if (fd == -1)
    {
        file_set_error();
206
        return NULL;
207
    }
208
    unlink( tmpfn );
209
    return create_file_for_fd( fd, access, 0 );
210 211
}

212 213 214 215
static void file_dump( struct object *obj, int verbose )
{
    struct file *file = (struct file *)obj;
    assert( obj->ops == &file_ops );
216
    fprintf( stderr, "File fd=%p options=%08x\n", file->fd, file->options );
217 218
}

219
static int file_get_poll_events( struct fd *fd )
220
{
221
    struct file *file = get_fd_user( fd );
222
    int events = 0;
223
    assert( file->obj.ops == &file_ops );
224 225
    if (file->access & FILE_UNIX_READ_ACCESS) events |= POLLIN;
    if (file->access & FILE_UNIX_WRITE_ACCESS) events |= POLLOUT;
226
    return events;
227 228
}

229
static int file_flush( struct fd *fd, struct event **event )
230
{
231 232 233 234 235 236 237
    int ret = 0, unix_fd = get_unix_fd( fd );

    if (unix_fd != -1)
    {
        ret = (fsync( unix_fd ) != -1);
        if (!ret) file_set_error();
    }
238
    return ret;
239 240
}

241
static int file_get_info( struct fd *fd )
242
{
243
    struct file *file = get_fd_user( fd );
244

245 246
    if (is_overlapped( file )) return FD_FLAG_OVERLAPPED;
    else return 0;
247 248
}

249 250 251 252 253
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 );
254 255
}

256
static unsigned int generic_file_map_access( unsigned int access )
257 258 259 260 261 262 263 264
{
    if (access & GENERIC_READ)    access |= FILE_GENERIC_READ;
    if (access & GENERIC_WRITE)   access |= FILE_GENERIC_WRITE;
    if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
    if (access & GENERIC_ALL)     access |= FILE_ALL_ACCESS;
    return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
}

265 266 267 268 269
static unsigned int file_map_access( struct object *obj, unsigned int access )
{
    return generic_file_map_access( access );
}

270
static void file_destroy( struct object *obj )
271
{
272 273
    struct file *file = (struct file *)obj;
    assert( obj->ops == &file_ops );
274

275
    if (file->fd) release_object( file->fd );
276 277 278 279 280 281 282
}

/* set the last error depending on errno */
void file_set_error(void)
{
    switch (errno)
    {
283 284 285
    case EAGAIN:    set_error( STATUS_SHARING_VIOLATION ); break;
    case EBADF:     set_error( STATUS_INVALID_HANDLE ); break;
    case ENOSPC:    set_error( STATUS_DISK_FULL ); break;
286
    case EACCES:
287
    case ESRCH:
288 289 290 291
    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;
292
    case EISDIR:    set_error( STATUS_FILE_IS_A_DIRECTORY ); break;
293
    case ENFILE:
294
    case EMFILE:    set_error( STATUS_TOO_MANY_OPENED_FILES ); break;
295 296
    case EEXIST:    set_error( STATUS_OBJECT_NAME_COLLISION ); break;
    case EINVAL:    set_error( STATUS_INVALID_PARAMETER ); break;
297
    case ESPIPE:    set_win32_error( ERROR_SEEK ); break;
298 299
    case ENOTEMPTY: set_error( STATUS_DIRECTORY_NOT_EMPTY ); break;
    case EIO:       set_error( STATUS_ACCESS_VIOLATION ); break;
300
    case ENOTDIR:   set_error( STATUS_NOT_A_DIRECTORY ); break;
301
    case EFBIG:     set_error( STATUS_SECTION_TOO_BIG ); break;
302 303
    case ENODEV:    set_error( STATUS_NO_SUCH_DEVICE ); break;
    case ENXIO:     set_error( STATUS_NO_SUCH_DEVICE ); break;
304
#ifdef EOVERFLOW
305
    case EOVERFLOW: set_error( STATUS_INVALID_PARAMETER ); break;
306
#endif
307
    default:        perror("file_set_error"); set_error( STATUS_UNSUCCESSFUL ); break;
308
    }
309 310
}

311
struct file *get_file_obj( struct process *process, obj_handle_t handle, unsigned int access )
312
{
313
    return (struct file *)get_handle_obj( process, handle, access, &file_ops );
314
}
315

316 317
int get_file_unix_fd( struct file *file )
{
318
    return get_unix_fd( file->fd );
319 320
}

321
/* extend a file beyond the current end of file */
322
static int extend_file( struct file *file, file_pos_t new_size )
323
{
324
    static const char zero;
325
    int unix_fd = get_file_unix_fd( file );
326
    off_t size = new_size;
327

328 329
    if (unix_fd == -1) return 0;

330 331 332 333 334
    if (sizeof(new_size) > sizeof(size) && size != new_size)
    {
        set_error( STATUS_INVALID_PARAMETER );
        return 0;
    }
335 336
    /* extend the file one byte beyond the requested size and then truncate it */
    /* this should work around ftruncate implementations that can't extend files */
337
    if (pwrite( unix_fd, &zero, 1, size ) != -1)
338
    {
339
        ftruncate( unix_fd, size );
340
        return 1;
341
    }
342 343 344 345
    file_set_error();
    return 0;
}

346
/* try to grow the file to the specified size */
347
int grow_file( struct file *file, file_pos_t size )
348
{
349
    struct stat st;
350
    int unix_fd = get_file_unix_fd( file );
351

352 353
    if (unix_fd == -1) return 0;

354
    if (fstat( unix_fd, &st ) == -1)
355 356 357 358
    {
        file_set_error();
        return 0;
    }
359
    if (st.st_size >= size) return 1;  /* already large enough */
360
    return extend_file( file, size );
361 362
}

363 364 365
/* create a file */
DECL_HANDLER(create_file)
{
366
    struct object *file;
367

368 369
    reply->handle = 0;
    if ((file = create_file( get_req_data(), get_req_data_size(), req->access,
370
                             req->sharing, req->create, req->options, req->attrs )))
371
    {
372
        reply->handle = alloc_handle( current->process, file, req->access, req->attributes );
373
        release_object( file );
374
    }
375 376 377 378 379 380
}

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

383
    reply->handle = 0;
384
    if ((fd = thread_get_inflight_fd( current, req->fd )) == -1)
385
    {
386 387 388
        set_error( STATUS_INVALID_HANDLE );
        return;
    }
389
    if ((file = create_file_for_fd( fd, req->access, FILE_SHARE_READ | FILE_SHARE_WRITE )))
390
    {
391
        reply->handle = alloc_handle( current->process, file, req->access, req->attributes );
392
        release_object( file );
393 394 395 396 397 398 399
    }
}

/* lock a region of a file */
DECL_HANDLER(lock_file)
{
    struct file *file;
400 401
    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;
402 403 404

    if ((file = get_file_obj( current->process, req->handle, 0 )))
    {
405
        reply->handle = lock_fd( file->fd, offset, count, req->shared, req->wait );
406
        reply->overlapped = is_overlapped( file );
407 408 409 410 411 412 413 414
        release_object( file );
    }
}

/* unlock a region of a file */
DECL_HANDLER(unlock_file)
{
    struct file *file;
415 416
    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;
417 418 419

    if ((file = get_file_obj( current->process, req->handle, 0 )))
    {
420
        unlock_fd( file->fd, offset, count );
421 422 423
        release_object( file );
    }
}