In Netbios(),
[wine] / 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 #include "async.h"
54
55 struct file
56 {
57     struct object       obj;        /* object header */
58     struct fd          *fd;         /* file descriptor for this file */
59     unsigned int        access;     /* file access (GENERIC_READ/WRITE) */
60     unsigned int        options;    /* file options (FILE_DELETE_ON_CLOSE, FILE_SYNCHRONOUS...) */
61     struct async_queue  read_q;
62     struct async_queue  write_q;
63 };
64
65 static void file_dump( struct object *obj, int verbose );
66 static struct fd *file_get_fd( struct object *obj );
67 static void file_destroy( struct object *obj );
68
69 static int file_get_poll_events( struct fd *fd );
70 static void file_poll_event( struct fd *fd, int event );
71 static int file_flush( struct fd *fd, struct event **event );
72 static int file_get_info( struct fd *fd );
73 static void file_queue_async( struct fd *fd, void *ptr, unsigned int status, int type, int count );
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 };
95
96 static inline int is_overlapped( const struct file *file )
97 {
98     return !(file->options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT));
99 }
100
101 /* create a file from a file descriptor */
102 /* if the function fails the fd is closed */
103 static struct file *create_file_for_fd( int fd, unsigned int access, unsigned int sharing )
104 {
105     struct file *file;
106
107     if ((file = alloc_object( &file_ops )))
108     {
109         file->access     = access;
110         file->options    = FILE_SYNCHRONOUS_IO_NONALERT;
111         if (!(file->fd = create_anonymous_fd( &file_fd_ops, fd, &file->obj )))
112         {
113             release_object( file );
114             return NULL;
115         }
116     }
117     return file;
118 }
119
120
121 static struct object *create_file( const char *nameptr, size_t len, unsigned int access,
122                                    unsigned int sharing, int create, unsigned int options,
123                                    unsigned int attrs )
124 {
125     struct file *file;
126     int flags;
127     char *name;
128     mode_t mode;
129
130     if (!(name = mem_alloc( len + 1 ))) return NULL;
131     memcpy( name, nameptr, len );
132     name[len] = 0;
133
134     switch(create)
135     {
136     case FILE_CREATE:       flags = O_CREAT | O_EXCL; break;
137     case FILE_OVERWRITE_IF: /* FIXME: the difference is whether we trash existing attr or not */
138     case FILE_SUPERSEDE:    flags = O_CREAT | O_TRUNC; break;
139     case FILE_OPEN:         flags = 0; break;
140     case FILE_OPEN_IF:      flags = O_CREAT; break;
141     case FILE_OVERWRITE:    flags = O_TRUNC; break;
142     default:                set_error( STATUS_INVALID_PARAMETER ); goto error;
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     if (is_overlapped( file ))
162     {
163         init_async_queue (&file->read_q);
164         init_async_queue (&file->write_q);
165     }
166
167     /* FIXME: should set error to STATUS_OBJECT_NAME_COLLISION if file existed before */
168     if (!(file->fd = alloc_fd( &file_fd_ops, &file->obj )) ||
169         !(file->fd = open_fd( file->fd, name, flags | O_NONBLOCK | O_LARGEFILE,
170                               &mode, access, sharing, options )))
171     {
172         free( name );
173         release_object( file );
174         return NULL;
175     }
176     free( name );
177
178     /* check for serial port */
179     if (S_ISCHR(mode) && is_serial_fd( file->fd ))
180     {
181         struct object *obj = create_serial( file->fd, file->options );
182         release_object( file );
183         return obj;
184     }
185
186     return &file->obj;
187
188  error:
189     free( name );
190     return NULL;
191 }
192
193 /* check if two file objects point to the same file */
194 int is_same_file( struct file *file1, struct file *file2 )
195 {
196     return is_same_file_fd( file1->fd, file2->fd );
197 }
198
199 /* create a temp file for anonymous mappings */
200 struct file *create_temp_file( int access )
201 {
202     char tmpfn[16];
203     int fd;
204
205     sprintf( tmpfn, "anonmap.XXXXXX" );  /* create it in the server directory */
206     fd = mkstemps( tmpfn, 0 );
207     if (fd == -1)
208     {
209         file_set_error();
210         return NULL;
211     }
212     unlink( tmpfn );
213     return create_file_for_fd( fd, access, 0 );
214 }
215
216 static void file_dump( struct object *obj, int verbose )
217 {
218     struct file *file = (struct file *)obj;
219     assert( obj->ops == &file_ops );
220     fprintf( stderr, "File fd=%p options=%08x\n", file->fd, file->options );
221 }
222
223 static int file_get_poll_events( struct fd *fd )
224 {
225     struct file *file = get_fd_user( fd );
226     int events = 0;
227     assert( file->obj.ops == &file_ops );
228     if (file->access & GENERIC_READ) events |= POLLIN;
229     if (file->access & GENERIC_WRITE) events |= POLLOUT;
230     return events;
231 }
232
233 static void file_poll_event( struct fd *fd, int event )
234 {
235     struct file *file = get_fd_user( fd );
236     assert( file->obj.ops == &file_ops );
237     if (is_overlapped( file ))
238     {
239         if( IS_READY(file->read_q) && (POLLIN & event) )
240         {
241             async_notify(file->read_q.head, STATUS_ALERTED);
242             return;
243         }
244         if( IS_READY(file->write_q) && (POLLOUT & event) )
245         {
246             async_notify(file->write_q.head, STATUS_ALERTED);
247             return;
248         }
249     }
250     default_poll_event( fd, event );
251 }
252
253
254 static int file_flush( struct fd *fd, struct event **event )
255 {
256     int ret = (fsync( get_unix_fd(fd) ) != -1);
257     if (!ret) file_set_error();
258     return ret;
259 }
260
261 static int file_get_info( struct fd *fd )
262 {
263     struct file *file = get_fd_user( fd );
264
265     if (is_overlapped( file )) return FD_FLAG_OVERLAPPED;
266     else return 0;
267 }
268
269 static void file_queue_async(struct fd *fd, void *ptr, unsigned int status, int type, int count)
270 {
271     struct file *file = get_fd_user( fd );
272     struct async *async;
273     struct async_queue *q;
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         q = &file->read_q;
287         break;
288     case ASYNC_TYPE_WRITE:
289         q = &file->write_q;
290         break;
291     default:
292         set_error( STATUS_INVALID_PARAMETER );
293         return;
294     }
295
296     async = find_async ( q, current, ptr );
297
298     if ( status == STATUS_PENDING )
299     {
300         int events;
301
302         if ( !async )
303             async = create_async ( &file->obj, current, ptr );
304         if ( !async )
305             return;
306
307         async->status = STATUS_PENDING;
308         if ( !async->q )
309             async_insert( q, async );
310
311         /* Check if the new pending request can be served immediately */
312         events = check_fd_events( fd, file_get_poll_events( fd ) );
313         if (events) file_poll_event ( fd, events );
314     }
315     else if ( async ) destroy_async ( async );
316     else set_error ( STATUS_INVALID_PARAMETER );
317
318     set_fd_events( fd, file_get_poll_events( fd ));
319 }
320
321 static struct fd *file_get_fd( struct object *obj )
322 {
323     struct file *file = (struct file *)obj;
324     assert( obj->ops == &file_ops );
325     return (struct fd *)grab_object( file->fd );
326 }
327
328 static void file_destroy( struct object *obj )
329 {
330     struct file *file = (struct file *)obj;
331     assert( obj->ops == &file_ops );
332
333     if (is_overlapped( file ))
334     {
335         destroy_async_queue (&file->read_q);
336         destroy_async_queue (&file->write_q);
337     }
338     if (file->fd) release_object( file->fd );
339 }
340
341 /* set the last error depending on errno */
342 void file_set_error(void)
343 {
344     switch (errno)
345     {
346     case EAGAIN:    set_error( STATUS_SHARING_VIOLATION ); break;
347     case EBADF:     set_error( STATUS_INVALID_HANDLE ); break;
348     case ENOSPC:    set_error( STATUS_DISK_FULL ); break;
349     case EACCES:
350     case ESRCH:
351     case EPERM:     set_error( STATUS_ACCESS_DENIED ); break;
352     case EROFS:     set_error( STATUS_MEDIA_WRITE_PROTECTED ); break;
353     case EBUSY:     set_error( STATUS_FILE_LOCK_CONFLICT ); break;
354     case ENOENT:    set_error( STATUS_NO_SUCH_FILE ); break;
355     case EISDIR:    set_error( STATUS_FILE_IS_A_DIRECTORY ); break;
356     case ENFILE:
357     case EMFILE:    set_error( STATUS_NO_MORE_FILES ); break;
358     case EEXIST:    set_error( STATUS_OBJECT_NAME_COLLISION ); break;
359     case EINVAL:    set_error( STATUS_INVALID_PARAMETER ); break;
360     case ESPIPE:    set_win32_error( ERROR_SEEK ); break;
361     case ENOTEMPTY: set_error( STATUS_DIRECTORY_NOT_EMPTY ); break;
362     case EIO:       set_error( STATUS_ACCESS_VIOLATION ); break;
363     case ENOTDIR:   set_error( STATUS_NOT_A_DIRECTORY ); break;
364     case EFBIG:     set_error( STATUS_SECTION_TOO_BIG ); break;
365     case ENODEV:    set_error( STATUS_NO_SUCH_DEVICE ); break;
366     case ENXIO:     set_error( STATUS_NO_SUCH_DEVICE ); break;
367 #ifdef EOVERFLOW
368     case EOVERFLOW: set_error( STATUS_INVALID_PARAMETER ); break;
369 #endif
370     default:        perror("file_set_error"); set_error( STATUS_UNSUCCESSFUL ); break;
371     }
372 }
373
374 struct file *get_file_obj( struct process *process, obj_handle_t handle, unsigned int access )
375 {
376     return (struct file *)get_handle_obj( process, handle, access, &file_ops );
377 }
378
379 int get_file_unix_fd( struct file *file )
380 {
381     return get_unix_fd( file->fd );
382 }
383
384 /* extend a file beyond the current end of file */
385 static int extend_file( struct file *file, off_t size )
386 {
387     static const char zero;
388     int unix_fd = get_file_unix_fd( file );
389
390     /* extend the file one byte beyond the requested size and then truncate it */
391     /* this should work around ftruncate implementations that can't extend files */
392     if (pwrite( unix_fd, &zero, 1, size ) != -1)
393     {
394         ftruncate( unix_fd, size );
395         return 1;
396     }
397     file_set_error();
398     return 0;
399 }
400
401 /* try to grow the file to the specified size */
402 int grow_file( struct file *file, int size_high, int size_low )
403 {
404     struct stat st;
405     int unix_fd = get_file_unix_fd( file );
406     off_t size = size_low + (((off_t)size_high)<<32);
407
408     if (fstat( unix_fd, &st ) == -1)
409     {
410         file_set_error();
411         return 0;
412     }
413     if (st.st_size >= size) return 1;  /* already large enough */
414     return extend_file( file, size );
415 }
416
417 /* create a file */
418 DECL_HANDLER(create_file)
419 {
420     struct object *file;
421
422     reply->handle = 0;
423     if ((file = create_file( get_req_data(), get_req_data_size(), req->access,
424                              req->sharing, req->create, req->options, req->attrs )))
425     {
426         reply->handle = alloc_handle( current->process, file, req->access, req->inherit );
427         release_object( file );
428     }
429 }
430
431 /* allocate a file handle for a Unix fd */
432 DECL_HANDLER(alloc_file_handle)
433 {
434     struct file *file;
435     int fd;
436
437     reply->handle = 0;
438     if ((fd = thread_get_inflight_fd( current, req->fd )) == -1)
439     {
440         set_error( STATUS_INVALID_HANDLE );
441         return;
442     }
443     if ((file = create_file_for_fd( fd, req->access, FILE_SHARE_READ | FILE_SHARE_WRITE )))
444     {
445         reply->handle = alloc_handle( current->process, file, req->access, req->inherit );
446         release_object( file );
447     }
448 }
449
450 /* lock a region of a file */
451 DECL_HANDLER(lock_file)
452 {
453     struct file *file;
454     file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
455     file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
456
457     if ((file = get_file_obj( current->process, req->handle, 0 )))
458     {
459         reply->handle = lock_fd( file->fd, offset, count, req->shared, req->wait );
460         reply->overlapped = is_overlapped( file );
461         release_object( file );
462     }
463 }
464
465 /* unlock a region of a file */
466 DECL_HANDLER(unlock_file)
467 {
468     struct file *file;
469     file_pos_t offset = ((file_pos_t)req->offset_high << 32) | req->offset_low;
470     file_pos_t count = ((file_pos_t)req->count_high << 32) | req->count_low;
471
472     if ((file = get_file_obj( current->process, req->handle, 0 )))
473     {
474         unlock_fd( file->fd, offset, count );
475         release_object( file );
476     }
477 }