git.oblomov.eu Git - wine/blob - server/fd.c

   1 /*
   2  * Server-side file descriptor management
   3  *
   4  * Copyright (C) 2000, 2003 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21
  22 #include "config.h"
  23 #include "wine/port.h"
  24
  25 #include <assert.h>
  26 #include <errno.h>
  27 #include <fcntl.h>
  28 #include <limits.h>
  29 #include <signal.h>
  30 #include <stdarg.h>
  31 #include <stdio.h>
  32 #include <string.h>
  33 #include <stdlib.h>
  34 #ifdef HAVE_POLL_H
  35 #include <poll.h>
  36 #endif
  37 #ifdef HAVE_SYS_POLL_H
  38 #include <sys/poll.h>
  39 #endif
  40 #ifdef HAVE_STDINT_H
  41 #include <stdint.h>
  42 #endif
  43 #include <sys/stat.h>
  44 #include <sys/time.h>
  45 #include <sys/types.h>
  46 #include <unistd.h>
  47
  48 #include "ntstatus.h"
  49 #define WIN32_NO_STATUS
  50 #include "object.h"
  51 #include "file.h"
  52 #include "handle.h"
  53 #include "process.h"
  54 #include "request.h"
  55
  56 #include "winternl.h"
  57
  58 #if defined(HAVE_SYS_EPOLL_H) && defined(HAVE_EPOLL_CREATE)
  59 # include <sys/epoll.h>
  60 # define USE_EPOLL
  61 #elif defined(linux) && defined(__i386__) && defined(HAVE_STDINT_H)
  62 # define USE_EPOLL
  63 # define EPOLLIN POLLIN
  64 # define EPOLLOUT POLLOUT
  65 # define EPOLLERR POLLERR
  66 # define EPOLLHUP POLLHUP
  67 # define EPOLL_CTL_ADD 1
  68 # define EPOLL_CTL_DEL 2
  69 # define EPOLL_CTL_MOD 3
  70
  71 typedef union epoll_data
  72 {
  73   void *ptr;
  74   int fd;
  75   uint32_t u32;
  76   uint64_t u64;
  77 } epoll_data_t;
  78
  79 struct epoll_event
  80 {
  81   uint32_t events;
  82   epoll_data_t data;
  83 };
  84
  85 #define SYSCALL_RET(ret) do { \
  86         if (ret < 0) { errno = -ret; ret = -1; } \
  87         return ret; \
  88     } while(0)
  89
  90 static inline int epoll_create( int size )
  91 {
  92     int ret;
  93     __asm__( "pushl %%ebx; movl %2,%%ebx; int $0x80; popl %%ebx"
  94              : "=a" (ret) : "0" (254 /*NR_epoll_create*/), "r" (size) );
  95     SYSCALL_RET(ret);
  96 }
  97
  98 static inline int epoll_ctl( int epfd, int op, int fd, const struct epoll_event *event )
  99 {
 100     int ret;
 101     __asm__( "pushl %%ebx; movl %2,%%ebx; int $0x80; popl %%ebx"
 102              : "=a" (ret)
 103              : "0" (255 /*NR_epoll_ctl*/), "r" (epfd), "c" (op), "d" (fd), "S" (event), "m" (*event) );
 104     SYSCALL_RET(ret);
 105 }
 106
 107 static inline int epoll_wait( int epfd, struct epoll_event *events, int maxevents, int timeout )
 108 {
 109     int ret;
 110     __asm__( "pushl %%ebx; movl %2,%%ebx; int $0x80; popl %%ebx"
 111              : "=a" (ret)
 112              : "0" (256 /*NR_epoll_wait*/), "r" (epfd), "c" (events), "d" (maxevents), "S" (timeout)
 113              : "memory" );
 114     SYSCALL_RET(ret);
 115 }
 116 #undef SYSCALL_RET
 117
 118 #endif /* linux && __i386__ && HAVE_STDINT_H */
 119
 120
 121 /* Because of the stupid Posix locking semantics, we need to keep
 122  * track of all file descriptors referencing a given file, and not
 123  * close a single one until all the locks are gone (sigh).
 124  */
 125
 126 /* file descriptor object */
 127
 128 /* closed_fd is used to keep track of the unix fd belonging to a closed fd object */
 129 struct closed_fd
 130 {
 131     struct list entry;       /* entry in inode closed list */
 132     int         unix_fd;     /* the unix file descriptor */
 133     char        unlink[1];   /* name to unlink on close (if any) */
 134 };
 135
 136 struct fd
 137 {
 138     struct object        obj;         /* object header */
 139     const struct fd_ops *fd_ops;      /* file descriptor operations */
 140     struct inode        *inode;       /* inode that this fd belongs to */
 141     struct list          inode_entry; /* entry in inode fd list */
 142     struct closed_fd    *closed;      /* structure to store the unix fd at destroy time */
 143     struct object       *user;        /* object using this file descriptor */
 144     struct list          locks;       /* list of locks on this fd */
 145     unsigned int         access;      /* file access (FILE_READ_DATA etc.) */
 146     unsigned int         sharing;     /* file sharing mode */
 147     int                  unix_fd;     /* unix file descriptor */
 148     int                  fs_locks :1; /* can we use filesystem locks for this fd? */
 149     int                  unmounted :1;/* has the device been unmounted? */
 150     int                  poll_index;  /* index of fd in poll array */
 151     struct list          read_q;      /* async readers of this fd */
 152     struct list          write_q;     /* async writers of this fd */
 153 };
 154
 155 static void fd_dump( struct object *obj, int verbose );
 156 static void fd_destroy( struct object *obj );
 157
 158 static const struct object_ops fd_ops =
 159 {
 160     sizeof(struct fd),        /* size */
 161     fd_dump,                  /* dump */
 162     no_add_queue,             /* add_queue */
 163     NULL,                     /* remove_queue */
 164     NULL,                     /* signaled */
 165     NULL,                     /* satisfied */
 166     no_signal,                /* signal */
 167     no_get_fd,                /* get_fd */
 168     no_map_access,            /* map_access */
 169     no_lookup_name,           /* lookup_name */
 170     no_close_handle,          /* close_handle */
 171     fd_destroy                /* destroy */
 172 };
 173
 174 /* device object */
 175
 176 #define DEVICE_HASH_SIZE 7
 177 #define INODE_HASH_SIZE 17
 178
 179 struct device
 180 {
 181     struct object       obj;        /* object header */
 182     struct list         entry;      /* entry in device hash list */
 183     dev_t               dev;        /* device number */
 184     int                 removable;  /* removable device? (or -1 if unknown) */
 185     struct list         inode_hash[INODE_HASH_SIZE];  /* inodes hash table */
 186 };
 187
 188 static void device_dump( struct object *obj, int verbose );
 189 static void device_destroy( struct object *obj );
 190
 191 static const struct object_ops device_ops =
 192 {
 193     sizeof(struct device),    /* size */
 194     device_dump,              /* dump */
 195     no_add_queue,             /* add_queue */
 196     NULL,                     /* remove_queue */
 197     NULL,                     /* signaled */
 198     NULL,                     /* satisfied */
 199     no_signal,                /* signal */
 200     no_get_fd,                /* get_fd */
 201     no_map_access,            /* map_access */
 202     no_lookup_name,           /* lookup_name */
 203     no_close_handle,          /* close_handle */
 204     device_destroy            /* destroy */
 205 };
 206
 207 /* inode object */
 208
 209 struct inode
 210 {
 211     struct object       obj;        /* object header */
 212     struct list         entry;      /* inode hash list entry */
 213     struct device      *device;     /* device containing this inode */
 214     ino_t               ino;        /* inode number */
 215     struct list         open;       /* list of open file descriptors */
 216     struct list         locks;      /* list of file locks */
 217     struct list         closed;     /* list of file descriptors to close at destroy time */
 218 };
 219
 220 static void inode_dump( struct object *obj, int verbose );
 221 static void inode_destroy( struct object *obj );
 222
 223 static const struct object_ops inode_ops =
 224 {
 225     sizeof(struct inode),     /* size */
 226     inode_dump,               /* dump */
 227     no_add_queue,             /* add_queue */
 228     NULL,                     /* remove_queue */
 229     NULL,                     /* signaled */
 230     NULL,                     /* satisfied */
 231     no_signal,                /* signal */
 232     no_get_fd,                /* get_fd */
 233     no_map_access,            /* map_access */
 234     no_lookup_name,           /* lookup_name */
 235     no_close_handle,          /* close_handle */
 236     inode_destroy             /* destroy */
 237 };
 238
 239 /* file lock object */
 240
 241 struct file_lock
 242 {
 243     struct object       obj;         /* object header */
 244     struct fd          *fd;          /* fd owning this lock */
 245     struct list         fd_entry;    /* entry in list of locks on a given fd */
 246     struct list         inode_entry; /* entry in inode list of locks */
 247     int                 shared;      /* shared lock? */
 248     file_pos_t          start;       /* locked region is interval [start;end) */
 249     file_pos_t          end;
 250     struct process     *process;     /* process owning this lock */
 251     struct list         proc_entry;  /* entry in list of locks owned by the process */
 252 };
 253
 254 static void file_lock_dump( struct object *obj, int verbose );
 255 static int file_lock_signaled( struct object *obj, struct thread *thread );
 256
 257 static const struct object_ops file_lock_ops =
 258 {
 259     sizeof(struct file_lock),   /* size */
 260     file_lock_dump,             /* dump */
 261     add_queue,                  /* add_queue */
 262     remove_queue,               /* remove_queue */
 263     file_lock_signaled,         /* signaled */
 264     no_satisfied,               /* satisfied */
 265     no_signal,                  /* signal */
 266     no_get_fd,                  /* get_fd */
 267     no_map_access,              /* map_access */
 268     no_lookup_name,             /* lookup_name */
 269     no_close_handle,            /* close_handle */
 270     no_destroy                  /* destroy */
 271 };
 272
 273
 274 #define OFF_T_MAX       (~((file_pos_t)1 << (8*sizeof(off_t)-1)))
 275 #define FILE_POS_T_MAX  (~(file_pos_t)0)
 276
 277 static file_pos_t max_unix_offset = OFF_T_MAX;
 278
 279 #define DUMP_LONG_LONG(val) do { \
 280     if (sizeof(val) > sizeof(unsigned long) && (val) > ~0UL) \
 281         fprintf( stderr, "%lx%08lx", (unsigned long)((unsigned long long)(val) >> 32), (unsigned long)(val) ); \
 282     else \
 283         fprintf( stderr, "%lx", (unsigned long)(val) ); \
 284   } while (0)
 285
 286
 287
 288 /****************************************************************/
 289 /* timeouts support */
 290
 291 struct timeout_user
 292 {
 293     struct list           entry;      /* entry in sorted timeout list */
 294     struct timeval        when;       /* timeout expiry (absolute time) */
 295     timeout_callback      callback;   /* callback function */
 296     void                 *private;    /* callback private data */
 297 };
 298
 299 static struct list timeout_list = LIST_INIT(timeout_list);   /* sorted timeouts list */
 300
 301 /* add a timeout user */
 302 struct timeout_user *add_timeout_user( const struct timeval *when, timeout_callback func,
 303                                        void *private )
 304 {
 305     struct timeout_user *user;
 306     struct list *ptr;
 307
 308     if (!(user = mem_alloc( sizeof(*user) ))) return NULL;
 309     user->when     = *when;
 310     user->callback = func;
 311     user->private  = private;
 312
 313     /* Now insert it in the linked list */
 314
 315     LIST_FOR_EACH( ptr, &timeout_list )
 316     {
 317         struct timeout_user *timeout = LIST_ENTRY( ptr, struct timeout_user, entry );
 318         if (!time_before( &timeout->when, when )) break;
 319     }
 320     list_add_before( ptr, &user->entry );
 321     return user;
 322 }
 323
 324 /* remove a timeout user */
 325 void remove_timeout_user( struct timeout_user *user )
 326 {
 327     list_remove( &user->entry );
 328     free( user );
 329 }
 330
 331 /* add a timeout in milliseconds to an absolute time */
 332 void add_timeout( struct timeval *when, int timeout )
 333 {
 334     if (timeout)
 335     {
 336         long sec = timeout / 1000;
 337         if ((when->tv_usec += (timeout - 1000*sec) * 1000) >= 1000000)
 338         {
 339             when->tv_usec -= 1000000;
 340             when->tv_sec++;
 341         }
 342         when->tv_sec += sec;
 343     }
 344 }
 345
 346
 347 /****************************************************************/
 348 /* poll support */
 349
 350 static struct fd **poll_users;              /* users array */
 351 static struct pollfd *pollfd;               /* poll fd array */
 352 static int nb_users;                        /* count of array entries actually in use */
 353 static int active_users;                    /* current number of active users */
 354 static int allocated_users;                 /* count of allocated entries in the array */
 355 static struct fd **freelist;                /* list of free entries in the array */
 356
 357 #ifdef USE_EPOLL
 358
 359 static int epoll_fd;
 360 static struct epoll_event *epoll_events;
 361
 362 /* set the events that epoll waits for on this fd; helper for set_fd_events */
 363 static inline void set_fd_epoll_events( struct fd *fd, int user, int events )
 364 {
 365     struct epoll_event ev;
 366     int ctl;
 367
 368     if (epoll_fd == -1) return;
 369
 370     if (events == -1)  /* stop waiting on this fd completely */
 371     {
 372         if (pollfd[user].fd == -1) return;  /* already removed */
 373         ctl = EPOLL_CTL_DEL;
 374     }
 375     else if (pollfd[user].fd == -1)
 376     {
 377         if (pollfd[user].events) return;  /* stopped waiting on it, don't restart */
 378         ctl = EPOLL_CTL_ADD;
 379     }
 380     else
 381     {
 382         if (pollfd[user].events == events) return;  /* nothing to do */
 383         ctl = EPOLL_CTL_MOD;
 384     }
 385
 386     ev.events = events;
 387     memset(&ev.data, 0, sizeof(ev.data));
 388     ev.data.u32 = user;
 389
 390     if (epoll_ctl( epoll_fd, ctl, fd->unix_fd, &ev ) == -1)
 391     {
 392         if (errno == ENOMEM)  /* not enough memory, give up on epoll */
 393         {
 394             close( epoll_fd );
 395             epoll_fd = -1;
 396         }
 397         else perror( "epoll_ctl" );  /* should not happen */
 398     }
 399 }
 400
 401 #else /* USE_EPOLL */
 402
 403 static inline void set_fd_epoll_events( struct fd *fd, int user, int events )
 404 {
 405 }
 406
 407 #endif /* USE_EPOLL */
 408
 409
 410 /* add a user in the poll array and return its index, or -1 on failure */
 411 static int add_poll_user( struct fd *fd )
 412 {
 413     int ret;
 414     if (freelist)
 415     {
 416         ret = freelist - poll_users;
 417         freelist = (struct fd **)poll_users[ret];
 418     }
 419     else
 420     {
 421         if (nb_users == allocated_users)
 422         {
 423             struct fd **newusers;
 424             struct pollfd *newpoll;
 425             int new_count = allocated_users ? (allocated_users + allocated_users / 2) : 16;
 426             if (!(newusers = realloc( poll_users, new_count * sizeof(*poll_users) ))) return -1;
 427             if (!(newpoll = realloc( pollfd, new_count * sizeof(*pollfd) )))
 428             {
 429                 if (allocated_users)
 430                     poll_users = newusers;
 431                 else
 432                     free( newusers );
 433                 return -1;
 434             }
 435             poll_users = newusers;
 436             pollfd = newpoll;
 437 #ifdef USE_EPOLL
 438             if (!allocated_users) epoll_fd = epoll_create( new_count );
 439             if (epoll_fd != -1)
 440             {
 441                 struct epoll_event *new_events;
 442                 if (!(new_events = realloc( epoll_events, new_count * sizeof(*epoll_events) )))
 443                     return -1;
 444                 epoll_events = new_events;
 445             }
 446 #endif
 447             allocated_users = new_count;
 448         }
 449         ret = nb_users++;
 450     }
 451     pollfd[ret].fd = -1;
 452     pollfd[ret].events = 0;
 453     pollfd[ret].revents = 0;
 454     poll_users[ret] = fd;
 455     active_users++;
 456     return ret;
 457 }
 458
 459 /* remove a user from the poll list */
 460 static void remove_poll_user( struct fd *fd, int user )
 461 {
 462     assert( user >= 0 );
 463     assert( poll_users[user] == fd );
 464
 465 #ifdef USE_EPOLL
 466     if (epoll_fd != -1 && pollfd[user].fd != -1)
 467     {
 468         struct epoll_event dummy;
 469         epoll_ctl( epoll_fd, EPOLL_CTL_DEL, fd->unix_fd, &dummy );
 470     }
 471 #endif
 472     pollfd[user].fd = -1;
 473     pollfd[user].events = 0;
 474     pollfd[user].revents = 0;
 475     poll_users[user] = (struct fd *)freelist;
 476     freelist = &poll_users[user];
 477     active_users--;
 478 }
 479
 480 /* process pending timeouts and return the time until the next timeout, in milliseconds */
 481 static int get_next_timeout(void)
 482 {
 483     if (!list_empty( &timeout_list ))
 484     {
 485         struct list expired_list, *ptr;
 486         struct timeval now;
 487
 488         gettimeofday( &now, NULL );
 489
 490         /* first remove all expired timers from the list */
 491
 492         list_init( &expired_list );
 493         while ((ptr = list_head( &timeout_list )) != NULL)
 494         {
 495             struct timeout_user *timeout = LIST_ENTRY( ptr, struct timeout_user, entry );
 496
 497             if (!time_before( &now, &timeout->when ))
 498             {
 499                 list_remove( &timeout->entry );
 500                 list_add_tail( &expired_list, &timeout->entry );
 501             }
 502             else break;
 503         }
 504
 505         /* now call the callback for all the removed timers */
 506
 507         while ((ptr = list_head( &expired_list )) != NULL)
 508         {
 509             struct timeout_user *timeout = LIST_ENTRY( ptr, struct timeout_user, entry );
 510             list_remove( &timeout->entry );
 511             timeout->callback( timeout->private );
 512             free( timeout );
 513         }
 514
 515         if ((ptr = list_head( &timeout_list )) != NULL)
 516         {
 517             struct timeout_user *timeout = LIST_ENTRY( ptr, struct timeout_user, entry );
 518             int diff = (timeout->when.tv_sec - now.tv_sec) * 1000
 519                      + (timeout->when.tv_usec - now.tv_usec) / 1000;
 520             if (diff < 0) diff = 0;
 521             return diff;
 522         }
 523     }
 524     return -1;  /* no pending timeouts */
 525 }
 526
 527 /* server main poll() loop */
 528 void main_loop(void)
 529 {
 530     int i, ret, timeout;
 531
 532 #ifdef USE_EPOLL
 533     assert( POLLIN == EPOLLIN );
 534     assert( POLLOUT == EPOLLOUT );
 535     assert( POLLERR == EPOLLERR );
 536     assert( POLLHUP == EPOLLHUP );
 537
 538     if (epoll_fd != -1)
 539     {
 540         while (active_users)
 541         {
 542             timeout = get_next_timeout();
 543
 544             if (!active_users) break;  /* last user removed by a timeout */
 545             if (epoll_fd == -1) break;  /* an error occurred with epoll */
 546
 547             ret = epoll_wait( epoll_fd, epoll_events, allocated_users, timeout );
 548
 549             /* put the events into the pollfd array first, like poll does */
 550             for (i = 0; i < ret; i++)
 551             {
 552                 int user = epoll_events[i].data.u32;
 553                 pollfd[user].revents = epoll_events[i].events;
 554             }
 555
 556             /* read events from the pollfd array, as set_fd_events may modify them */
 557             for (i = 0; i < ret; i++)
 558             {
 559                 int user = epoll_events[i].data.u32;
 560                 if (pollfd[user].revents) fd_poll_event( poll_users[user], pollfd[user].revents );
 561             }
 562         }
 563     }
 564     /* fall through to normal poll loop */
 565 #endif  /* USE_EPOLL */
 566
 567     while (active_users)
 568     {
 569         timeout = get_next_timeout();
 570
 571         if (!active_users) break;  /* last user removed by a timeout */
 572
 573         ret = poll( pollfd, nb_users, timeout );
 574         if (ret > 0)
 575         {
 576             for (i = 0; i < nb_users; i++)
 577             {
 578                 if (pollfd[i].revents)
 579                 {
 580                     fd_poll_event( poll_users[i], pollfd[i].revents );
 581                     if (!--ret) break;
 582                 }
 583             }
 584         }
 585     }
 586 }
 587
 588
 589 /****************************************************************/
 590 /* device functions */
 591
 592 static struct list device_hash[DEVICE_HASH_SIZE];
 593
 594 /* retrieve the device object for a given fd, creating it if needed */
 595 static struct device *get_device( dev_t dev, int create )
 596 {
 597     struct device *device;
 598     unsigned int i, hash = dev % DEVICE_HASH_SIZE;
 599
 600     if (device_hash[hash].next)
 601     {
 602         LIST_FOR_EACH_ENTRY( device, &device_hash[hash], struct device, entry )
 603             if (device->dev == dev) return (struct device *)grab_object( device );
 604     }
 605     else list_init( &device_hash[hash] );
 606
 607     /* not found, create it */
 608
 609     if (!create) return NULL;
 610     if ((device = alloc_object( &device_ops )))
 611     {
 612         device->dev = dev;
 613         device->removable = -1;
 614         for (i = 0; i < INODE_HASH_SIZE; i++) list_init( &device->inode_hash[i] );
 615         list_add_head( &device_hash[hash], &device->entry );
 616     }
 617     return device;
 618 }
 619
 620 static void device_dump( struct object *obj, int verbose )
 621 {
 622     struct device *device = (struct device *)obj;
 623     fprintf( stderr, "Device dev=" );
 624     DUMP_LONG_LONG( device->dev );
 625     fprintf( stderr, "\n" );
 626 }
 627
 628 static void device_destroy( struct object *obj )
 629 {
 630     struct device *device = (struct device *)obj;
 631     unsigned int i;
 632
 633     for (i = 0; i < INODE_HASH_SIZE; i++)
 634         assert( list_empty(&device->inode_hash[i]) );
 635
 636     list_remove( &device->entry );  /* remove it from the hash table */
 637 }
 638
 639
 640 /****************************************************************/
 641 /* inode functions */
 642
 643 /* close all pending file descriptors in the closed list */
 644 static void inode_close_pending( struct inode *inode, int keep_unlinks )
 645 {
 646     struct list *ptr = list_head( &inode->closed );
 647
 648     while (ptr)
 649     {
 650         struct closed_fd *fd = LIST_ENTRY( ptr, struct closed_fd, entry );
 651         struct list *next = list_next( &inode->closed, ptr );
 652
 653         if (fd->unix_fd != -1)
 654         {
 655             close( fd->unix_fd );
 656             fd->unix_fd = -1;
 657         }
 658         if (!keep_unlinks || !fd->unlink[0])  /* get rid of it unless there's an unlink pending on that file */
 659         {
 660             list_remove( ptr );
 661             free( fd );
 662         }
 663         ptr = next;
 664     }
 665 }
 666
 667 static void inode_dump( struct object *obj, int verbose )
 668 {
 669     struct inode *inode = (struct inode *)obj;
 670     fprintf( stderr, "Inode device=%p ino=", inode->device );
 671     DUMP_LONG_LONG( inode->ino );
 672     fprintf( stderr, "\n" );
 673 }
 674
 675 static void inode_destroy( struct object *obj )
 676 {
 677     struct inode *inode = (struct inode *)obj;
 678     struct list *ptr;
 679
 680     assert( list_empty(&inode->open) );
 681     assert( list_empty(&inode->locks) );
 682
 683     list_remove( &inode->entry );
 684
 685     while ((ptr = list_head( &inode->closed )))
 686     {
 687         struct closed_fd *fd = LIST_ENTRY( ptr, struct closed_fd, entry );
 688         list_remove( ptr );
 689         if (fd->unix_fd != -1) close( fd->unix_fd );
 690         if (fd->unlink[0])
 691         {
 692             /* make sure it is still the same file */
 693             struct stat st;
 694             if (!stat( fd->unlink, &st ) && st.st_dev == inode->device->dev && st.st_ino == inode->ino)
 695             {
 696                 if (S_ISDIR(st.st_mode)) rmdir( fd->unlink );
 697                 else unlink( fd->unlink );
 698             }
 699         }
 700         free( fd );
 701     }
 702     release_object( inode->device );
 703 }
 704
 705 /* retrieve the inode object for a given fd, creating it if needed */
 706 static struct inode *get_inode( dev_t dev, ino_t ino )
 707 {
 708     struct device *device;
 709     struct inode *inode;
 710     unsigned int hash = ino % INODE_HASH_SIZE;
 711
 712     if (!(device = get_device( dev, 1 ))) return NULL;
 713
 714     LIST_FOR_EACH_ENTRY( inode, &device->inode_hash[hash], struct inode, entry )
 715     {
 716         if (inode->ino == ino)
 717         {
 718             release_object( device );
 719             return (struct inode *)grab_object( inode );
 720         }
 721     }
 722
 723     /* not found, create it */
 724     if ((inode = alloc_object( &inode_ops )))
 725     {
 726         inode->device = device;
 727         inode->ino    = ino;
 728         list_init( &inode->open );
 729         list_init( &inode->locks );
 730         list_init( &inode->closed );
 731         list_add_head( &device->inode_hash[hash], &inode->entry );
 732     }
 733     else release_object( device );
 734
 735     return inode;
 736 }
 737
 738 /* add fd to the inode list of file descriptors to close */
 739 static void inode_add_closed_fd( struct inode *inode, struct closed_fd *fd )
 740 {
 741     if (!list_empty( &inode->locks ))
 742     {
 743         list_add_head( &inode->closed, &fd->entry );
 744     }
 745     else if (fd->unlink[0])  /* close the fd but keep the structure around for unlink */
 746     {
 747         if (fd->unix_fd != -1) close( fd->unix_fd );
 748         fd->unix_fd = -1;
 749         list_add_head( &inode->closed, &fd->entry );
 750     }
 751     else  /* no locks on this inode and no unlink, get rid of the fd */
 752     {
 753         if (fd->unix_fd != -1) close( fd->unix_fd );
 754         free( fd );
 755     }
 756 }
 757
 758
 759 /****************************************************************/
 760 /* file lock functions */
 761
 762 static void file_lock_dump( struct object *obj, int verbose )
 763 {
 764     struct file_lock *lock = (struct file_lock *)obj;
 765     fprintf( stderr, "Lock %s fd=%p proc=%p start=",
 766              lock->shared ? "shared" : "excl", lock->fd, lock->process );
 767     DUMP_LONG_LONG( lock->start );
 768     fprintf( stderr, " end=" );
 769     DUMP_LONG_LONG( lock->end );
 770     fprintf( stderr, "\n" );
 771 }
 772
 773 static int file_lock_signaled( struct object *obj, struct thread *thread )
 774 {
 775     struct file_lock *lock = (struct file_lock *)obj;
 776     /* lock is signaled if it has lost its owner */
 777     return !lock->process;
 778 }
 779
 780 /* set (or remove) a Unix lock if possible for the given range */
 781 static int set_unix_lock( struct fd *fd, file_pos_t start, file_pos_t end, int type )
 782 {
 783     struct flock fl;
 784
 785     if (!fd->fs_locks) return 1;  /* no fs locks possible for this fd */
 786     for (;;)
 787     {
 788         if (start == end) return 1;  /* can't set zero-byte lock */
 789         if (start > max_unix_offset) return 1;  /* ignore it */
 790         fl.l_type   = type;
 791         fl.l_whence = SEEK_SET;
 792         fl.l_start  = start;
 793         if (!end || end > max_unix_offset) fl.l_len = 0;
 794         else fl.l_len = end - start;
 795         if (fcntl( fd->unix_fd, F_SETLK, &fl ) != -1) return 1;
 796
 797         switch(errno)
 798         {
 799         case EACCES:
 800             /* check whether locks work at all on this file system */
 801             if (fcntl( fd->unix_fd, F_GETLK, &fl ) != -1)
 802             {
 803                 set_error( STATUS_FILE_LOCK_CONFLICT );
 804                 return 0;
 805             }
 806             /* fall through */
 807         case EIO:
 808         case ENOLCK:
 809             /* no locking on this fs, just ignore it */
 810             fd->fs_locks = 0;
 811             return 1;
 812         case EAGAIN:
 813             set_error( STATUS_FILE_LOCK_CONFLICT );
 814             return 0;
 815         case EBADF:
 816             /* this can happen if we try to set a write lock on a read-only file */
 817             /* we just ignore that error */
 818             if (fl.l_type == F_WRLCK) return 1;
 819             set_error( STATUS_ACCESS_DENIED );
 820             return 0;
 821 #ifdef EOVERFLOW
 822         case EOVERFLOW:
 823 #endif
 824         case EINVAL:
 825             /* this can happen if off_t is 64-bit but the kernel only supports 32-bit */
 826             /* in that case we shrink the limit and retry */
 827             if (max_unix_offset > INT_MAX)
 828             {
 829                 max_unix_offset = INT_MAX;
 830                 break;  /* retry */
 831             }
 832             /* fall through */
 833         default:
 834             file_set_error();
 835             return 0;
 836         }
 837     }
 838 }
 839
 840 /* check if interval [start;end) overlaps the lock */
 841 inline static int lock_overlaps( struct file_lock *lock, file_pos_t start, file_pos_t end )
 842 {
 843     if (lock->end && start >= lock->end) return 0;
 844     if (end && lock->start >= end) return 0;
 845     return 1;
 846 }
 847
 848 /* remove Unix locks for all bytes in the specified area that are no longer locked */
 849 static void remove_unix_locks( struct fd *fd, file_pos_t start, file_pos_t end )
 850 {
 851     struct hole
 852     {
 853         struct hole *next;
 854         struct hole *prev;
 855         file_pos_t   start;
 856         file_pos_t   end;
 857     } *first, *cur, *next, *buffer;
 858
 859     struct list *ptr;
 860     int count = 0;
 861
 862     if (!fd->inode) return;
 863     if (!fd->fs_locks) return;
 864     if (start == end || start > max_unix_offset) return;
 865     if (!end || end > max_unix_offset) end = max_unix_offset + 1;
 866
 867     /* count the number of locks overlapping the specified area */
 868
 869     LIST_FOR_EACH( ptr, &fd->inode->locks )
 870     {
 871         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
 872         if (lock->start == lock->end) continue;
 873         if (lock_overlaps( lock, start, end )) count++;
 874     }
 875
 876     if (!count)  /* no locks at all, we can unlock everything */
 877     {
 878         set_unix_lock( fd, start, end, F_UNLCK );
 879         return;
 880     }
 881
 882     /* allocate space for the list of holes */
 883     /* max. number of holes is number of locks + 1 */
 884
 885     if (!(buffer = malloc( sizeof(*buffer) * (count+1) ))) return;
 886     first = buffer;
 887     first->next  = NULL;
 888     first->prev  = NULL;
 889     first->start = start;
 890     first->end   = end;
 891     next = first + 1;
 892
 893     /* build a sorted list of unlocked holes in the specified area */
 894
 895     LIST_FOR_EACH( ptr, &fd->inode->locks )
 896     {
 897         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
 898         if (lock->start == lock->end) continue;
 899         if (!lock_overlaps( lock, start, end )) continue;
 900
 901         /* go through all the holes touched by this lock */
 902         for (cur = first; cur; cur = cur->next)
 903         {
 904             if (cur->end <= lock->start) continue; /* hole is before start of lock */
 905             if (lock->end && cur->start >= lock->end) break;  /* hole is after end of lock */
 906
 907             /* now we know that lock is overlapping hole */
 908
 909             if (cur->start >= lock->start)  /* lock starts before hole, shrink from start */
 910             {
 911                 cur->start = lock->end;
 912                 if (cur->start && cur->start < cur->end) break;  /* done with this lock */
 913                 /* now hole is empty, remove it */
 914                 if (cur->next) cur->next->prev = cur->prev;
 915                 if (cur->prev) cur->prev->next = cur->next;
 916                 else if (!(first = cur->next)) goto done;  /* no more holes at all */
 917             }
 918             else if (!lock->end || cur->end <= lock->end)  /* lock larger than hole, shrink from end */
 919             {
 920                 cur->end = lock->start;
 921                 assert( cur->start < cur->end );
 922             }
 923             else  /* lock is in the middle of hole, split hole in two */
 924             {
 925                 next->prev = cur;
 926                 next->next = cur->next;
 927                 cur->next = next;
 928                 next->start = lock->end;
 929                 next->end = cur->end;
 930                 cur->end = lock->start;
 931                 assert( next->start < next->end );
 932                 assert( cur->end < next->start );
 933                 next++;
 934                 break;  /* done with this lock */
 935             }
 936         }
 937     }
 938
 939     /* clear Unix locks for all the holes */
 940
 941     for (cur = first; cur; cur = cur->next)
 942         set_unix_lock( fd, cur->start, cur->end, F_UNLCK );
 943
 944  done:
 945     free( buffer );
 946 }
 947
 948 /* create a new lock on a fd */
 949 static struct file_lock *add_lock( struct fd *fd, int shared, file_pos_t start, file_pos_t end )
 950 {
 951     struct file_lock *lock;
 952
 953     if (!fd->inode)  /* not a regular file */
 954     {
 955         set_error( STATUS_INVALID_HANDLE );
 956         return NULL;
 957     }
 958
 959     if (!(lock = alloc_object( &file_lock_ops ))) return NULL;
 960     lock->shared  = shared;
 961     lock->start   = start;
 962     lock->end     = end;
 963     lock->fd      = fd;
 964     lock->process = current->process;
 965
 966     /* now try to set a Unix lock */
 967     if (!set_unix_lock( lock->fd, lock->start, lock->end, lock->shared ? F_RDLCK : F_WRLCK ))
 968     {
 969         release_object( lock );
 970         return NULL;
 971     }
 972     list_add_head( &fd->locks, &lock->fd_entry );
 973     list_add_head( &fd->inode->locks, &lock->inode_entry );
 974     list_add_head( &lock->process->locks, &lock->proc_entry );
 975     return lock;
 976 }
 977
 978 /* remove an existing lock */
 979 static void remove_lock( struct file_lock *lock, int remove_unix )
 980 {
 981     struct inode *inode = lock->fd->inode;
 982
 983     list_remove( &lock->fd_entry );
 984     list_remove( &lock->inode_entry );
 985     list_remove( &lock->proc_entry );
 986     if (remove_unix) remove_unix_locks( lock->fd, lock->start, lock->end );
 987     if (list_empty( &inode->locks )) inode_close_pending( inode, 1 );
 988     lock->process = NULL;
 989     wake_up( &lock->obj, 0 );
 990     release_object( lock );
 991 }
 992
 993 /* remove all locks owned by a given process */
 994 void remove_process_locks( struct process *process )
 995 {
 996     struct list *ptr;
 997
 998     while ((ptr = list_head( &process->locks )))
 999     {
1000         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, proc_entry );
1001         remove_lock( lock, 1 );  /* this removes it from the list */
1002     }
1003 }
1004
1005 /* remove all locks on a given fd */
1006 static void remove_fd_locks( struct fd *fd )
1007 {
1008     file_pos_t start = FILE_POS_T_MAX, end = 0;
1009     struct list *ptr;
1010
1011     while ((ptr = list_head( &fd->locks )))
1012     {
1013         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, fd_entry );
1014         if (lock->start < start) start = lock->start;
1015         if (!lock->end || lock->end > end) end = lock->end - 1;
1016         remove_lock( lock, 0 );
1017     }
1018     if (start < end) remove_unix_locks( fd, start, end + 1 );
1019 }
1020
1021 /* add a lock on an fd */
1022 /* returns handle to wait on */
1023 obj_handle_t lock_fd( struct fd *fd, file_pos_t start, file_pos_t count, int shared, int wait )
1024 {
1025     struct list *ptr;
1026     file_pos_t end = start + count;
1027
1028     /* don't allow wrapping locks */
1029     if (end && end < start)
1030     {
1031         set_error( STATUS_INVALID_PARAMETER );
1032         return 0;
1033     }
1034
1035     /* check if another lock on that file overlaps the area */
1036     LIST_FOR_EACH( ptr, &fd->inode->locks )
1037     {
1038         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
1039         if (!lock_overlaps( lock, start, end )) continue;
1040         if (lock->shared && shared) continue;
1041         /* found one */
1042         if (!wait)
1043         {
1044             set_error( STATUS_FILE_LOCK_CONFLICT );
1045             return 0;
1046         }
1047         set_error( STATUS_PENDING );
1048         return alloc_handle( current->process, lock, SYNCHRONIZE, 0 );
1049     }
1050
1051     /* not found, add it */
1052     if (add_lock( fd, shared, start, end )) return 0;
1053     if (get_error() == STATUS_FILE_LOCK_CONFLICT)
1054     {
1055         /* Unix lock conflict -> tell client to wait and retry */
1056         if (wait) set_error( STATUS_PENDING );
1057     }
1058     return 0;
1059 }
1060
1061 /* remove a lock on an fd */
1062 void unlock_fd( struct fd *fd, file_pos_t start, file_pos_t count )
1063 {
1064     struct list *ptr;
1065     file_pos_t end = start + count;
1066
1067     /* find an existing lock with the exact same parameters */
1068     LIST_FOR_EACH( ptr, &fd->locks )
1069     {
1070         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, fd_entry );
1071         if ((lock->start == start) && (lock->end == end))
1072         {
1073             remove_lock( lock, 1 );
1074             return;
1075         }
1076     }
1077     set_error( STATUS_FILE_LOCK_CONFLICT );
1078 }
1079
1080
1081 /****************************************************************/
1082 /* asynchronous operations support */
1083
1084 struct async
1085 {
1086     struct thread       *thread;
1087     void                *apc;
1088     void                *user;
1089     void                *sb;
1090     struct timeout_user *timeout;
1091     struct list          entry;
1092 };
1093
1094 /* notifies client thread of new status of its async request */
1095 /* destroys the server side of it */
1096 static void async_terminate( struct async *async, int status )
1097 {
1098     thread_queue_apc( async->thread, NULL, async->apc, APC_ASYNC_IO,
1099                       1, async->user, async->sb, (void *)status );
1100
1101     if (async->timeout) remove_timeout_user( async->timeout );
1102     async->timeout = NULL;
1103     list_remove( &async->entry );
1104     release_object( async->thread );
1105     free( async );
1106 }
1107
1108 /* cb for timeout on an async request */
1109 static void async_callback(void *private)
1110 {
1111     struct async *async = (struct async *)private;
1112
1113     /* fprintf(stderr, "async timeout out %p\n", async); */
1114     async->timeout = NULL;
1115     async_terminate( async, STATUS_TIMEOUT );
1116 }
1117
1118 /* create an async on a given queue of a fd */
1119 struct async *create_async( struct thread *thread, const struct timeval *timeout,
1120                             struct list *queue, void *io_apc, void *io_user, void* io_sb )
1121 {
1122     struct async *async = mem_alloc( sizeof(struct async) );
1123
1124     if (!async) return NULL;
1125
1126     async->thread = (struct thread *)grab_object(thread);
1127     async->apc = io_apc;
1128     async->user = io_user;
1129     async->sb = io_sb;
1130
1131     list_add_tail( queue, &async->entry );
1132
1133     if (timeout) async->timeout = add_timeout_user( timeout, async_callback, async );
1134     else async->timeout = NULL;
1135
1136     return async;
1137 }
1138
1139 /* terminate the async operation at the head of the queue */
1140 void async_terminate_head( struct list *queue, int status )
1141 {
1142     struct list *ptr = list_head( queue );
1143     if (ptr) async_terminate( LIST_ENTRY( ptr, struct async, entry ), status );
1144 }
1145
1146 /****************************************************************/
1147 /* file descriptor functions */
1148
1149 static void fd_dump( struct object *obj, int verbose )
1150 {
1151     struct fd *fd = (struct fd *)obj;
1152     fprintf( stderr, "Fd unix_fd=%d user=%p", fd->unix_fd, fd->user );
1153     if (fd->inode) fprintf( stderr, " inode=%p unlink='%s'", fd->inode, fd->closed->unlink );
1154     fprintf( stderr, "\n" );
1155 }
1156
1157 static void fd_destroy( struct object *obj )
1158 {
1159     struct fd *fd = (struct fd *)obj;
1160
1161     async_terminate_queue( &fd->read_q, STATUS_CANCELLED );
1162     async_terminate_queue( &fd->write_q, STATUS_CANCELLED );
1163
1164     remove_fd_locks( fd );
1165     list_remove( &fd->inode_entry );
1166     if (fd->poll_index != -1) remove_poll_user( fd, fd->poll_index );
1167     if (fd->inode)
1168     {
1169         inode_add_closed_fd( fd->inode, fd->closed );
1170         release_object( fd->inode );
1171     }
1172     else  /* no inode, close it right away */
1173     {
1174         if (fd->unix_fd != -1) close( fd->unix_fd );
1175     }
1176 }
1177
1178 /* set the events that select waits for on this fd */
1179 void set_fd_events( struct fd *fd, int events )
1180 {
1181     int user = fd->poll_index;
1182     assert( poll_users[user] == fd );
1183
1184     set_fd_epoll_events( fd, user, events );
1185
1186     if (events == -1)  /* stop waiting on this fd completely */
1187     {
1188         pollfd[user].fd = -1;
1189         pollfd[user].events = POLLERR;
1190         pollfd[user].revents = 0;
1191     }
1192     else if (pollfd[user].fd != -1 || !pollfd[user].events)
1193     {
1194         pollfd[user].fd = fd->unix_fd;
1195         pollfd[user].events = events;
1196     }
1197 }
1198
1199 /* prepare an fd for unmounting its corresponding device */
1200 static inline void unmount_fd( struct fd *fd )
1201 {
1202     assert( fd->inode );
1203
1204     async_terminate_queue( &fd->read_q, STATUS_VOLUME_DISMOUNTED );
1205     async_terminate_queue( &fd->write_q, STATUS_VOLUME_DISMOUNTED );
1206
1207     if (fd->poll_index != -1) set_fd_events( fd, -1 );
1208
1209     if (fd->unix_fd != -1) close( fd->unix_fd );
1210
1211     fd->unix_fd = -1;
1212     fd->unmounted = 1;
1213     fd->closed->unix_fd = -1;
1214     fd->closed->unlink[0] = 0;
1215
1216     /* stop using Unix locks on this fd (existing locks have been removed by close) */
1217     fd->fs_locks = 0;
1218 }
1219
1220 /* allocate an fd object, without setting the unix fd yet */
1221 static struct fd *alloc_fd_object(void)
1222 {
1223     struct fd *fd = alloc_object( &fd_ops );
1224
1225     if (!fd) return NULL;
1226
1227     fd->fd_ops     = NULL;
1228     fd->user       = NULL;
1229     fd->inode      = NULL;
1230     fd->closed     = NULL;
1231     fd->access     = 0;
1232     fd->sharing    = 0;
1233     fd->unix_fd    = -1;
1234     fd->fs_locks   = 1;
1235     fd->unmounted  = 0;
1236     fd->poll_index = -1;
1237     list_init( &fd->inode_entry );
1238     list_init( &fd->locks );
1239     list_init( &fd->read_q );
1240     list_init( &fd->write_q );
1241
1242     if ((fd->poll_index = add_poll_user( fd )) == -1)
1243     {
1244         release_object( fd );
1245         return NULL;
1246     }
1247     return fd;
1248 }
1249
1250 /* allocate a pseudo fd object, for objects that need to behave like files but don't have a unix fd */
1251 struct fd *alloc_pseudo_fd( const struct fd_ops *fd_user_ops, struct object *user )
1252 {
1253     struct fd *fd = alloc_object( &fd_ops );
1254
1255     if (!fd) return NULL;
1256
1257     fd->fd_ops     = fd_user_ops;
1258     fd->user       = user;
1259     fd->inode      = NULL;
1260     fd->closed     = NULL;
1261     fd->access     = 0;
1262     fd->sharing    = 0;
1263     fd->unix_fd    = -1;
1264     fd->fs_locks   = 0;
1265     fd->unmounted  = 0;
1266     fd->poll_index = -1;
1267     list_init( &fd->inode_entry );
1268     list_init( &fd->locks );
1269     list_init( &fd->read_q );
1270     list_init( &fd->write_q );
1271     return fd;
1272 }
1273
1274 /* check if the desired access is possible without violating */
1275 /* the sharing mode of other opens of the same file */
1276 static int check_sharing( struct fd *fd, unsigned int access, unsigned int sharing )
1277 {
1278     unsigned int existing_sharing = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE;
1279     unsigned int existing_access = 0;
1280     struct list *ptr;
1281
1282     /* if access mode is 0, sharing mode is ignored */
1283     if (!access) sharing = existing_sharing;
1284     fd->access = access;
1285     fd->sharing = sharing;
1286
1287     LIST_FOR_EACH( ptr, &fd->inode->open )
1288     {
1289         struct fd *fd_ptr = LIST_ENTRY( ptr, struct fd, inode_entry );
1290         if (fd_ptr != fd)
1291         {
1292             existing_sharing &= fd_ptr->sharing;
1293             existing_access  |= fd_ptr->access;
1294         }
1295     }
1296
1297     if ((access & FILE_UNIX_READ_ACCESS) && !(existing_sharing & FILE_SHARE_READ)) return 0;
1298     if ((access & FILE_UNIX_WRITE_ACCESS) && !(existing_sharing & FILE_SHARE_WRITE)) return 0;
1299     if ((access & DELETE) && !(existing_sharing & FILE_SHARE_DELETE)) return 0;
1300     if ((existing_access & FILE_UNIX_READ_ACCESS) && !(sharing & FILE_SHARE_READ)) return 0;
1301     if ((existing_access & FILE_UNIX_WRITE_ACCESS) && !(sharing & FILE_SHARE_WRITE)) return 0;
1302     if ((existing_access & DELETE) && !(sharing & FILE_SHARE_DELETE)) return 0;
1303     return 1;
1304 }
1305
1306 /* sets the user of an fd that previously had no user */
1307 void set_fd_user( struct fd *fd, const struct fd_ops *user_ops, struct object *user )
1308 {
1309     assert( fd->fd_ops == NULL );
1310     fd->fd_ops = user_ops;
1311     fd->user   = user;
1312 }
1313
1314 /* open() wrapper that returns a struct fd with no fd user set */
1315 struct fd *open_fd( const char *name, int flags, mode_t *mode, unsigned int access,
1316                     unsigned int sharing, unsigned int options )
1317 {
1318     struct stat st;
1319     struct closed_fd *closed_fd;
1320     struct fd *fd;
1321     const char *unlink_name = "";
1322     int rw_mode;
1323
1324     if ((options & FILE_DELETE_ON_CLOSE) && !(access & DELETE))
1325     {
1326         set_error( STATUS_INVALID_PARAMETER );
1327         return NULL;
1328     }
1329
1330     if (!(fd = alloc_fd_object())) return NULL;
1331
1332     if (options & FILE_DELETE_ON_CLOSE) unlink_name = name;
1333     if (!(closed_fd = mem_alloc( sizeof(*closed_fd) + strlen(unlink_name) )))
1334     {
1335         release_object( fd );
1336         return NULL;
1337     }
1338
1339     /* create the directory if needed */
1340     if ((options & FILE_DIRECTORY_FILE) && (flags & O_CREAT))
1341     {
1342         if (mkdir( name, 0777 ) == -1)
1343         {
1344             if (errno != EEXIST || (flags & O_EXCL))
1345             {
1346                 file_set_error();
1347                 goto error;
1348             }
1349         }
1350         flags &= ~(O_CREAT | O_EXCL | O_TRUNC);
1351     }
1352
1353     if ((access & FILE_UNIX_WRITE_ACCESS) && !(options & FILE_DIRECTORY_FILE))
1354     {
1355         if (access & FILE_UNIX_READ_ACCESS) rw_mode = O_RDWR;
1356         else rw_mode = O_WRONLY;
1357     }
1358     else rw_mode = O_RDONLY;
1359
1360     if ((fd->unix_fd = open( name, rw_mode | (flags & ~O_TRUNC), *mode )) == -1)
1361     {
1362         /* if we tried to open a directory for write access, retry read-only */
1363         if (errno != EISDIR ||
1364             !(access & FILE_UNIX_WRITE_ACCESS) ||
1365             (fd->unix_fd = open( name, O_RDONLY | (flags & ~O_TRUNC), *mode )) == -1)
1366         {
1367             file_set_error();
1368             goto error;
1369         }
1370     }
1371
1372     closed_fd->unix_fd = fd->unix_fd;
1373     closed_fd->unlink[0] = 0;
1374     fstat( fd->unix_fd, &st );
1375     *mode = st.st_mode;
1376
1377     /* only bother with an inode for normal files and directories */
1378     if (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode))
1379     {
1380         struct inode *inode = get_inode( st.st_dev, st.st_ino );
1381
1382         if (!inode)
1383         {
1384             /* we can close the fd because there are no others open on the same file,
1385              * otherwise we wouldn't have failed to allocate a new inode
1386              */
1387             goto error;
1388         }
1389         fd->inode = inode;
1390         fd->closed = closed_fd;
1391         list_add_head( &inode->open, &fd->inode_entry );
1392
1393         /* check directory options */
1394         if ((options & FILE_DIRECTORY_FILE) && !S_ISDIR(st.st_mode))
1395         {
1396             release_object( fd );
1397             set_error( STATUS_NOT_A_DIRECTORY );
1398             return NULL;
1399         }
1400         if ((options & FILE_NON_DIRECTORY_FILE) && S_ISDIR(st.st_mode))
1401         {
1402             release_object( fd );
1403             set_error( STATUS_FILE_IS_A_DIRECTORY );
1404             return NULL;
1405         }
1406         if (!check_sharing( fd, access, sharing ))
1407         {
1408             release_object( fd );
1409             set_error( STATUS_SHARING_VIOLATION );
1410             return NULL;
1411         }
1412         strcpy( closed_fd->unlink, unlink_name );
1413         if (flags & O_TRUNC) ftruncate( fd->unix_fd, 0 );
1414     }
1415     else  /* special file */
1416     {
1417         if (options & FILE_DIRECTORY_FILE)
1418         {
1419             set_error( STATUS_NOT_A_DIRECTORY );
1420             goto error;
1421         }
1422         if (unlink_name[0])  /* we can't unlink special files */
1423         {
1424             set_error( STATUS_INVALID_PARAMETER );
1425             goto error;
1426         }
1427         free( closed_fd );
1428     }
1429     return fd;
1430
1431 error:
1432     release_object( fd );
1433     free( closed_fd );
1434     return NULL;
1435 }
1436
1437 /* create an fd for an anonymous file */
1438 /* if the function fails the unix fd is closed */
1439 struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops, int unix_fd, struct object *user )
1440 {
1441     struct fd *fd = alloc_fd_object();
1442
1443     if (fd)
1444     {
1445         set_fd_user( fd, fd_user_ops, user );
1446         fd->unix_fd = unix_fd;
1447         return fd;
1448     }
1449     close( unix_fd );
1450     return NULL;
1451 }
1452
1453 /* retrieve the object that is using an fd */
1454 void *get_fd_user( struct fd *fd )
1455 {
1456     return fd->user;
1457 }
1458
1459 /* retrieve the unix fd for an object */
1460 int get_unix_fd( struct fd *fd )
1461 {
1462     if (fd->unix_fd == -1)
1463     {
1464         if (fd->unmounted) set_error( STATUS_VOLUME_DISMOUNTED );
1465         else set_error( STATUS_BAD_DEVICE_TYPE );
1466     }
1467     return fd->unix_fd;
1468 }
1469
1470 /* check if two file descriptors point to the same file */
1471 int is_same_file_fd( struct fd *fd1, struct fd *fd2 )
1472 {
1473     return fd1->inode == fd2->inode;
1474 }
1475
1476 /* callback for event happening in the main poll() loop */
1477 void fd_poll_event( struct fd *fd, int event )
1478 {
1479     return fd->fd_ops->poll_event( fd, event );
1480 }
1481
1482 /* check if events are pending and if yes return which one(s) */
1483 int check_fd_events( struct fd *fd, int events )
1484 {
1485     struct pollfd pfd;
1486
1487     if (fd->unix_fd == -1) return POLLERR;
1488
1489     pfd.fd     = fd->unix_fd;
1490     pfd.events = events;
1491     if (poll( &pfd, 1, 0 ) <= 0) return 0;
1492     return pfd.revents;
1493 }
1494
1495 /* default add_queue() routine for objects that poll() on an fd */
1496 int default_fd_add_queue( struct object *obj, struct wait_queue_entry *entry )
1497 {
1498     struct fd *fd = get_obj_fd( obj );
1499
1500     if (!fd) return 0;
1501     if (!fd->inode && list_empty( &obj->wait_queue ))  /* first on the queue */
1502         set_fd_events( fd, fd->fd_ops->get_poll_events( fd ) );
1503     add_queue( obj, entry );
1504     release_object( fd );
1505     return 1;
1506 }
1507
1508 /* default remove_queue() routine for objects that poll() on an fd */
1509 void default_fd_remove_queue( struct object *obj, struct wait_queue_entry *entry )
1510 {
1511     struct fd *fd = get_obj_fd( obj );
1512
1513     grab_object( obj );
1514     remove_queue( obj, entry );
1515     if (!fd->inode && list_empty( &obj->wait_queue ))  /* last on the queue is gone */
1516         set_fd_events( fd, 0 );
1517     release_object( obj );
1518     release_object( fd );
1519 }
1520
1521 /* default signaled() routine for objects that poll() on an fd */
1522 int default_fd_signaled( struct object *obj, struct thread *thread )
1523 {
1524     int events, ret;
1525     struct fd *fd = get_obj_fd( obj );
1526
1527     if (fd->inode) ret = 1; /* regular files are always signaled */
1528     else
1529     {
1530         events = fd->fd_ops->get_poll_events( fd );
1531         ret = check_fd_events( fd, events ) != 0;
1532
1533         if (ret)
1534         {
1535             /* stop waiting on select() if we are signaled */
1536             set_fd_events( fd, 0 );
1537         }
1538         else if (!list_empty( &obj->wait_queue ))
1539         {
1540             /* restart waiting on poll() if we are no longer signaled */
1541             set_fd_events( fd, events );
1542         }
1543     }
1544     release_object( fd );
1545     return ret;
1546 }
1547
1548 int default_fd_get_poll_events( struct fd *fd )
1549 {
1550     int events = 0;
1551
1552     if (!list_empty( &fd->read_q ))
1553         events |= POLLIN;
1554     if (!list_empty( &fd->write_q ))
1555         events |= POLLOUT;
1556
1557     return events;
1558 }
1559
1560 /* default handler for poll() events */
1561 void default_poll_event( struct fd *fd, int event )
1562 {
1563     if (!list_empty( &fd->read_q ) && (POLLIN & event) )
1564     {
1565         async_terminate_head( &fd->read_q, STATUS_ALERTED );
1566         return;
1567     }
1568     if (!list_empty( &fd->write_q ) && (POLLOUT & event) )
1569     {
1570         async_terminate_head( &fd->write_q, STATUS_ALERTED );
1571         return;
1572     }
1573
1574     /* if an error occurred, stop polling this fd to avoid busy-looping */
1575     if (event & (POLLERR | POLLHUP)) set_fd_events( fd, -1 );
1576     wake_up( fd->user, 0 );
1577 }
1578
1579 void fd_queue_async_timeout( struct fd *fd, void *apc, void *user, void *io_sb, int type, int count,
1580                              const struct timeval *timeout )
1581 {
1582     struct list *queue;
1583     int events;
1584
1585     if (!(fd->fd_ops->get_file_info( fd ) & (FD_FLAG_OVERLAPPED|FD_FLAG_TIMEOUT)))
1586     {
1587         set_error( STATUS_INVALID_HANDLE );
1588         return;
1589     }
1590
1591     switch (type)
1592     {
1593     case ASYNC_TYPE_READ:
1594         queue = &fd->read_q;
1595         break;
1596     case ASYNC_TYPE_WRITE:
1597         queue = &fd->write_q;
1598         break;
1599     default:
1600         set_error( STATUS_INVALID_PARAMETER );
1601         return;
1602     }
1603
1604     if (!create_async( current, timeout, queue, apc, user, io_sb ))
1605         return;
1606
1607     /* Check if the new pending request can be served immediately */
1608     events = check_fd_events( fd, fd->fd_ops->get_poll_events( fd ) );
1609     if (events) fd->fd_ops->poll_event( fd, events );
1610
1611     set_fd_events( fd, fd->fd_ops->get_poll_events( fd ) );
1612 }
1613
1614 void default_fd_queue_async( struct fd *fd, void *apc, void *user, void *io_sb, int type, int count )
1615 {
1616     fd_queue_async_timeout( fd, apc, user, io_sb, type, count, NULL );
1617 }
1618
1619 void default_fd_cancel_async( struct fd *fd )
1620 {
1621     async_terminate_queue( &fd->read_q, STATUS_CANCELLED );
1622     async_terminate_queue( &fd->write_q, STATUS_CANCELLED );
1623 }
1624
1625 /* default flush() routine */
1626 int no_flush( struct fd *fd, struct event **event )
1627 {
1628     set_error( STATUS_OBJECT_TYPE_MISMATCH );
1629     return 0;
1630 }
1631
1632 /* default get_file_info() routine */
1633 int no_get_file_info( struct fd *fd )
1634 {
1635     set_error( STATUS_OBJECT_TYPE_MISMATCH );
1636     return 0;
1637 }
1638
1639 /* default queue_async() routine */
1640 void no_queue_async( struct fd *fd, void* apc, void* user, void* io_sb,
1641                      int type, int count)
1642 {
1643     set_error( STATUS_OBJECT_TYPE_MISMATCH );
1644 }
1645
1646 /* default cancel_async() routine */
1647 void no_cancel_async( struct fd *fd )
1648 {
1649     set_error( STATUS_OBJECT_TYPE_MISMATCH );
1650 }
1651
1652 /* close all Unix file descriptors on a device to allow unmounting it */
1653 static void unmount_device( struct fd *device_fd )
1654 {
1655     unsigned int i;
1656     struct stat st;
1657     struct device *device;
1658     struct inode *inode;
1659     struct fd *fd;
1660     int unix_fd = get_unix_fd( device_fd );
1661
1662     if (unix_fd == -1) return;
1663
1664     if (fstat( unix_fd, &st ) == -1 || !S_ISBLK( st.st_mode ))
1665     {
1666         set_error( STATUS_INVALID_PARAMETER );
1667         return;
1668     }
1669
1670     if (!(device = get_device( st.st_rdev, 0 ))) return;
1671
1672     for (i = 0; i < INODE_HASH_SIZE; i++)
1673     {
1674         LIST_FOR_EACH_ENTRY( inode, &device->inode_hash[i], struct inode, entry )
1675         {
1676             LIST_FOR_EACH_ENTRY( fd, &inode->open, struct fd, inode_entry )
1677             {
1678                 unmount_fd( fd );
1679             }
1680             inode_close_pending( inode, 0 );
1681         }
1682     }
1683     /* remove it from the hash table */
1684     list_remove( &device->entry );
1685     list_init( &device->entry );
1686     release_object( device );
1687 }
1688
1689 /* same as get_handle_obj but retrieve the struct fd associated to the object */
1690 static struct fd *get_handle_fd_obj( struct process *process, obj_handle_t handle,
1691                                      unsigned int access )
1692 {
1693     struct fd *fd = NULL;
1694     struct object *obj;
1695
1696     if ((obj = get_handle_obj( process, handle, access, NULL )))
1697     {
1698         fd = get_obj_fd( obj );
1699         release_object( obj );
1700     }
1701     return fd;
1702 }
1703
1704 /* flush a file buffers */
1705 DECL_HANDLER(flush_file)
1706 {
1707     struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
1708     struct event * event = NULL;
1709
1710     if (fd)
1711     {
1712         fd->fd_ops->flush( fd, &event );
1713         if ( event )
1714         {
1715             reply->event = alloc_handle( current->process, event, SYNCHRONIZE, 0 );
1716         }
1717         release_object( fd );
1718     }
1719 }
1720
1721 /* open a file object */
1722 DECL_HANDLER(open_file_object)
1723 {
1724     struct unicode_str name;
1725     struct directory *root = NULL;
1726     struct object *obj;
1727
1728     get_req_unicode_str( &name );
1729     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
1730         return;
1731
1732     if ((obj = open_object_dir( root, &name, req->attributes, NULL )))
1733     {
1734         /* make sure this is a valid file object */
1735         struct fd *fd = get_obj_fd( obj );
1736         if (fd)
1737         {
1738             reply->handle = alloc_handle( current->process, obj, req->access, req->attributes );
1739             release_object( fd );
1740         }
1741         release_object( obj );
1742     }
1743
1744     if (root) release_object( root );
1745 }
1746
1747 /* get a Unix fd to access a file */
1748 DECL_HANDLER(get_handle_fd)
1749 {
1750     struct fd *fd;
1751
1752     reply->fd = -1;
1753
1754     if ((fd = get_handle_fd_obj( current->process, req->handle, req->access )))
1755     {
1756         int unix_fd = get_unix_fd( fd );
1757         if (unix_fd != -1)
1758         {
1759             int cached_fd = get_handle_unix_fd( current->process, req->handle, req->access );
1760             if (cached_fd != -1) reply->fd = cached_fd;
1761             else if (!get_error()) send_client_fd( current->process, unix_fd, req->handle );
1762         }
1763         if (fd->inode) reply->removable = fd->inode->device->removable;
1764         reply->flags = fd->fd_ops->get_file_info( fd );
1765         release_object( fd );
1766     }
1767 }
1768
1769 /* set the cached file descriptor of a handle */
1770 DECL_HANDLER(set_handle_fd)
1771 {
1772     struct fd *fd;
1773
1774     reply->cur_fd = -1;
1775     if ((fd = get_handle_fd_obj( current->process, req->handle, 0 )))
1776     {
1777         struct device *device = fd->inode ? fd->inode->device : NULL;
1778
1779         if (device && device->removable == -1) device->removable = req->removable;
1780
1781         /* only cache the fd on non-removable devices */
1782         if (!device || !device->removable)
1783             reply->cur_fd = set_handle_unix_fd( current->process, req->handle, req->fd );
1784         release_object( fd );
1785     }
1786 }
1787
1788 /* get ready to unmount a Unix device */
1789 DECL_HANDLER(unmount_device)
1790 {
1791     struct fd *fd;
1792
1793     if ((fd = get_handle_fd_obj( current->process, req->handle, 0 )))
1794     {
1795         unmount_device( fd );
1796         release_object( fd );
1797     }
1798 }
1799
1800 /* create / reschedule an async I/O */
1801 DECL_HANDLER(register_async)
1802 {
1803     struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
1804
1805     /*
1806      * The queue_async method must do the following:
1807      *
1808      * 1. Get the async_queue for the request of given type.
1809      * 2. Create a new asynchronous request for the selected queue
1810      * 3. Carry out any operations necessary to adjust the object's poll events
1811      *    Usually: set_elect_events (obj, obj->ops->get_poll_events()).
1812      * 4. When the async request is triggered, then send back (with a proper APC)
1813      *    the trigger (STATUS_ALERTED) to the thread that posted the request.
1814      *    async_destroy() is to be called: it will both notify the sender about
1815      *    the trigger and destroy the request by itself
1816      * See also the implementations in file.c, serial.c, and sock.c.
1817      */
1818
1819     if (fd)
1820     {
1821         fd->fd_ops->queue_async( fd, req->io_apc, req->io_user, req->io_sb,
1822                                  req->type, req->count );
1823         release_object( fd );
1824     }
1825 }
1826
1827 /* cancels all async I/O */
1828 DECL_HANDLER(cancel_async)
1829 {
1830     struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
1831     if (fd)
1832     {
1833         /* Note: we don't kill the queued APC_ASYNC_IO on this thread because
1834          * NtCancelIoFile() will force the pending APC to be run. Since,
1835          * Windows only guarantees that the current thread will have no async
1836          * operation on the current fd when NtCancelIoFile returns, this shall
1837          * do the work.
1838          */
1839         fd->fd_ops->cancel_async( fd );
1840         release_object( fd );
1841     }
1842 }