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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21
  22 #include "config.h"
  23
  24 #include <assert.h>
  25 #include <errno.h>
  26 #include <fcntl.h>
  27 #include <limits.h>
  28 #include <signal.h>
  29 #include <stdio.h>
  30 #include <string.h>
  31 #include <stdlib.h>
  32 #ifdef HAVE_SYS_POLL_H
  33 #include <sys/poll.h>
  34 #endif
  35 #include <sys/stat.h>
  36 #include <sys/time.h>
  37 #include <sys/types.h>
  38 #include <unistd.h>
  39
  40 #include "object.h"
  41 #include "file.h"
  42 #include "handle.h"
  43 #include "process.h"
  44 #include "request.h"
  45 #include "console.h"
  46
  47 /* Because of the stupid Posix locking semantics, we need to keep
  48  * track of all file descriptors referencing a given file, and not
  49  * close a single one until all the locks are gone (sigh).
  50  */
  51
  52 /* file descriptor object */
  53
  54 /* closed_fd is used to keep track of the unix fd belonging to a closed fd object */
  55 struct closed_fd
  56 {
  57     struct closed_fd *next;   /* next fd in close list */
  58     int               fd;     /* the unix file descriptor */
  59 };
  60
  61 struct fd
  62 {
  63     struct object        obj;         /* object header */
  64     const struct fd_ops *fd_ops;      /* file descriptor operations */
  65     struct inode        *inode;       /* inode that this fd belongs to */
  66     struct list          inode_entry; /* entry in inode fd list */
  67     struct closed_fd    *closed;      /* structure to store the unix fd at destroy time */
  68     struct object       *user;        /* object using this file descriptor */
  69     struct list          locks;       /* list of locks on this fd */
  70     int                  unix_fd;     /* unix file descriptor */
  71     int                  poll_index;  /* index of fd in poll array */
  72 };
  73
  74 static void fd_dump( struct object *obj, int verbose );
  75 static void fd_destroy( struct object *obj );
  76
  77 static const struct object_ops fd_ops =
  78 {
  79     sizeof(struct fd),        /* size */
  80     fd_dump,                  /* dump */
  81     no_add_queue,             /* add_queue */
  82     NULL,                     /* remove_queue */
  83     NULL,                     /* signaled */
  84     NULL,                     /* satisfied */
  85     no_get_fd,                /* get_fd */
  86     fd_destroy                /* destroy */
  87 };
  88
  89 /* inode object */
  90
  91 struct inode
  92 {
  93     struct object       obj;        /* object header */
  94     struct list         entry;      /* inode hash list entry */
  95     unsigned int        hash;       /* hashing code */
  96     dev_t               dev;        /* device number */
  97     ino_t               ino;        /* inode number */
  98     struct list         open;       /* list of open file descriptors */
  99     struct list         locks;      /* list of file locks */
 100     struct closed_fd   *closed;     /* list of file descriptors to close at destroy time */
 101 };
 102
 103 static void inode_dump( struct object *obj, int verbose );
 104 static void inode_destroy( struct object *obj );
 105
 106 static const struct object_ops inode_ops =
 107 {
 108     sizeof(struct inode),     /* size */
 109     inode_dump,               /* dump */
 110     no_add_queue,             /* add_queue */
 111     NULL,                     /* remove_queue */
 112     NULL,                     /* signaled */
 113     NULL,                     /* satisfied */
 114     no_get_fd,                /* get_fd */
 115     inode_destroy             /* destroy */
 116 };
 117
 118 /* file lock object */
 119
 120 struct file_lock
 121 {
 122     struct object       obj;         /* object header */
 123     struct fd          *fd;          /* fd owning this lock */
 124     struct list         fd_entry;    /* entry in list of locks on a given fd */
 125     struct list         inode_entry; /* entry in inode list of locks */
 126     int                 shared;      /* shared lock? */
 127     file_pos_t          start;       /* locked region is interval [start;end) */
 128     file_pos_t          end;
 129     struct process     *process;     /* process owning this lock */
 130     struct list         proc_entry;  /* entry in list of locks owned by the process */
 131 };
 132
 133 static void file_lock_dump( struct object *obj, int verbose );
 134 static int file_lock_signaled( struct object *obj, struct thread *thread );
 135
 136 static const struct object_ops file_lock_ops =
 137 {
 138     sizeof(struct file_lock),   /* size */
 139     file_lock_dump,             /* dump */
 140     add_queue,                  /* add_queue */
 141     remove_queue,               /* remove_queue */
 142     file_lock_signaled,         /* signaled */
 143     no_satisfied,               /* satisfied */
 144     no_get_fd,                  /* get_fd */
 145     no_destroy                  /* destroy */
 146 };
 147
 148
 149 #define OFF_T_MAX       (~((file_pos_t)1 << (8*sizeof(off_t)-1)))
 150 #define FILE_POS_T_MAX  (~(file_pos_t)0)
 151
 152 static file_pos_t max_unix_offset = OFF_T_MAX;
 153
 154 #define DUMP_LONG_LONG(val) do { \
 155     if (sizeof(val) > sizeof(unsigned long) && (val) > ~0UL) \
 156         fprintf( stderr, "%lx%08lx", (unsigned long)((val) >> 32), (unsigned long)(val) ); \
 157     else \
 158         fprintf( stderr, "%lx", (unsigned long)(val) ); \
 159   } while (0)
 160
 161
 162
 163 /****************************************************************/
 164 /* timeouts support */
 165
 166 struct timeout_user
 167 {
 168     struct timeout_user  *next;       /* next in sorted timeout list */
 169     struct timeout_user  *prev;       /* prev in sorted timeout list */
 170     struct timeval        when;       /* timeout expiry (absolute time) */
 171     timeout_callback      callback;   /* callback function */
 172     void                 *private;    /* callback private data */
 173 };
 174
 175 static struct timeout_user *timeout_head;   /* sorted timeouts list head */
 176 static struct timeout_user *timeout_tail;   /* sorted timeouts list tail */
 177
 178 /* add a timeout user */
 179 struct timeout_user *add_timeout_user( struct timeval *when, timeout_callback func, void *private )
 180 {
 181     struct timeout_user *user;
 182     struct timeout_user *pos;
 183
 184     if (!(user = mem_alloc( sizeof(*user) ))) return NULL;
 185     user->when     = *when;
 186     user->callback = func;
 187     user->private  = private;
 188
 189     /* Now insert it in the linked list */
 190
 191     for (pos = timeout_head; pos; pos = pos->next)
 192         if (!time_before( &pos->when, when )) break;
 193
 194     if (pos)  /* insert it before 'pos' */
 195     {
 196         if ((user->prev = pos->prev)) user->prev->next = user;
 197         else timeout_head = user;
 198         user->next = pos;
 199         pos->prev = user;
 200     }
 201     else  /* insert it at the tail */
 202     {
 203         user->next = NULL;
 204         if (timeout_tail) timeout_tail->next = user;
 205         else timeout_head = user;
 206         user->prev = timeout_tail;
 207         timeout_tail = user;
 208     }
 209     return user;
 210 }
 211
 212 /* remove a timeout user */
 213 void remove_timeout_user( struct timeout_user *user )
 214 {
 215     if (user->next) user->next->prev = user->prev;
 216     else timeout_tail = user->prev;
 217     if (user->prev) user->prev->next = user->next;
 218     else timeout_head = user->next;
 219     free( user );
 220 }
 221
 222 /* add a timeout in milliseconds to an absolute time */
 223 void add_timeout( struct timeval *when, int timeout )
 224 {
 225     if (timeout)
 226     {
 227         long sec = timeout / 1000;
 228         if ((when->tv_usec += (timeout - 1000*sec) * 1000) >= 1000000)
 229         {
 230             when->tv_usec -= 1000000;
 231             when->tv_sec++;
 232         }
 233         when->tv_sec += sec;
 234     }
 235 }
 236
 237 /* handle the next expired timeout */
 238 inline static void handle_timeout(void)
 239 {
 240     struct timeout_user *user = timeout_head;
 241     timeout_head = user->next;
 242     if (user->next) user->next->prev = user->prev;
 243     else timeout_tail = user->prev;
 244     user->callback( user->private );
 245     free( user );
 246 }
 247
 248
 249 /****************************************************************/
 250 /* poll support */
 251
 252 static struct fd **poll_users;              /* users array */
 253 static struct pollfd *pollfd;               /* poll fd array */
 254 static int nb_users;                        /* count of array entries actually in use */
 255 static int active_users;                    /* current number of active users */
 256 static int allocated_users;                 /* count of allocated entries in the array */
 257 static struct fd **freelist;                /* list of free entries in the array */
 258
 259 /* add a user in the poll array and return its index, or -1 on failure */
 260 static int add_poll_user( struct fd *fd )
 261 {
 262     int ret;
 263     if (freelist)
 264     {
 265         ret = freelist - poll_users;
 266         freelist = (struct fd **)poll_users[ret];
 267     }
 268     else
 269     {
 270         if (nb_users == allocated_users)
 271         {
 272             struct fd **newusers;
 273             struct pollfd *newpoll;
 274             int new_count = allocated_users ? (allocated_users + allocated_users / 2) : 16;
 275             if (!(newusers = realloc( poll_users, new_count * sizeof(*poll_users) ))) return -1;
 276             if (!(newpoll = realloc( pollfd, new_count * sizeof(*pollfd) )))
 277             {
 278                 if (allocated_users)
 279                     poll_users = newusers;
 280                 else
 281                     free( newusers );
 282                 return -1;
 283             }
 284             poll_users = newusers;
 285             pollfd = newpoll;
 286             allocated_users = new_count;
 287         }
 288         ret = nb_users++;
 289     }
 290     pollfd[ret].fd = -1;
 291     pollfd[ret].events = 0;
 292     pollfd[ret].revents = 0;
 293     poll_users[ret] = fd;
 294     active_users++;
 295     return ret;
 296 }
 297
 298 /* remove a user from the poll list */
 299 static void remove_poll_user( struct fd *fd, int user )
 300 {
 301     assert( user >= 0 );
 302     assert( poll_users[user] == fd );
 303     pollfd[user].fd = -1;
 304     pollfd[user].events = 0;
 305     pollfd[user].revents = 0;
 306     poll_users[user] = (struct fd *)freelist;
 307     freelist = &poll_users[user];
 308     active_users--;
 309 }
 310
 311
 312 /* SIGHUP handler */
 313 static void sighup_handler()
 314 {
 315 #ifdef DEBUG_OBJECTS
 316     dump_objects();
 317 #endif
 318 }
 319
 320 /* SIGTERM handler */
 321 static void sigterm_handler()
 322 {
 323     flush_registry();
 324     exit(1);
 325 }
 326
 327 /* SIGINT handler */
 328 static void sigint_handler()
 329 {
 330     kill_all_processes( NULL, 1 );
 331     flush_registry();
 332     exit(1);
 333 }
 334
 335 /* server main poll() loop */
 336 void main_loop(void)
 337 {
 338     int ret;
 339     sigset_t sigset;
 340     struct sigaction action;
 341
 342     /* block the signals we use */
 343     sigemptyset( &sigset );
 344     sigaddset( &sigset, SIGCHLD );
 345     sigaddset( &sigset, SIGHUP );
 346     sigaddset( &sigset, SIGINT );
 347     sigaddset( &sigset, SIGQUIT );
 348     sigaddset( &sigset, SIGTERM );
 349     sigprocmask( SIG_BLOCK, &sigset, NULL );
 350
 351     /* set the handlers */
 352     action.sa_mask = sigset;
 353     action.sa_flags = 0;
 354     action.sa_handler = sigchld_handler;
 355     sigaction( SIGCHLD, &action, NULL );
 356     action.sa_handler = sighup_handler;
 357     sigaction( SIGHUP, &action, NULL );
 358     action.sa_handler = sigint_handler;
 359     sigaction( SIGINT, &action, NULL );
 360     action.sa_handler = sigterm_handler;
 361     sigaction( SIGQUIT, &action, NULL );
 362     sigaction( SIGTERM, &action, NULL );
 363
 364     while (active_users)
 365     {
 366         long diff = -1;
 367         if (timeout_head)
 368         {
 369             struct timeval now;
 370             gettimeofday( &now, NULL );
 371             while (timeout_head)
 372             {
 373                 if (!time_before( &now, &timeout_head->when )) handle_timeout();
 374                 else
 375                 {
 376                     diff = (timeout_head->when.tv_sec - now.tv_sec) * 1000
 377                             + (timeout_head->when.tv_usec - now.tv_usec) / 1000;
 378                     break;
 379                 }
 380             }
 381             if (!active_users) break;  /* last user removed by a timeout */
 382         }
 383
 384         sigprocmask( SIG_UNBLOCK, &sigset, NULL );
 385
 386         /* Note: we assume that the signal handlers do not manipulate the pollfd array
 387          *       or the timeout list, otherwise there is a race here.
 388          */
 389         ret = poll( pollfd, nb_users, diff );
 390
 391         sigprocmask( SIG_BLOCK, &sigset, NULL );
 392
 393         if (ret > 0)
 394         {
 395             int i;
 396             for (i = 0; i < nb_users; i++)
 397             {
 398                 if (pollfd[i].revents)
 399                 {
 400                     fd_poll_event( poll_users[i], pollfd[i].revents );
 401                     if (!--ret) break;
 402                 }
 403             }
 404         }
 405     }
 406 }
 407
 408
 409 /****************************************************************/
 410 /* inode functions */
 411
 412 #define HASH_SIZE 37
 413
 414 static struct list inode_hash[HASH_SIZE];
 415
 416 /* close all pending file descriptors in the closed list */
 417 static void inode_close_pending( struct inode *inode )
 418 {
 419     while (inode->closed)
 420     {
 421         struct closed_fd *fd = inode->closed;
 422         inode->closed = fd->next;
 423         close( fd->fd );
 424         free( fd );
 425     }
 426 }
 427
 428
 429 static void inode_dump( struct object *obj, int verbose )
 430 {
 431     struct inode *inode = (struct inode *)obj;
 432     fprintf( stderr, "Inode dev=" );
 433     DUMP_LONG_LONG( inode->dev );
 434     fprintf( stderr, " ino=" );
 435     DUMP_LONG_LONG( inode->ino );
 436     fprintf( stderr, "\n" );
 437 }
 438
 439 static void inode_destroy( struct object *obj )
 440 {
 441     struct inode *inode = (struct inode *)obj;
 442
 443     assert( list_empty(&inode->open) );
 444     assert( list_empty(&inode->locks) );
 445
 446     list_remove( &inode->entry );
 447     inode_close_pending( inode );
 448 }
 449
 450 /* retrieve the inode object for a given fd, creating it if needed */
 451 static struct inode *get_inode( dev_t dev, ino_t ino )
 452 {
 453     struct list *ptr;
 454     struct inode *inode;
 455     unsigned int hash = (dev ^ ino) % HASH_SIZE;
 456
 457     if (inode_hash[hash].next)
 458     {
 459         LIST_FOR_EACH( ptr, &inode_hash[hash] )
 460         {
 461             inode = LIST_ENTRY( ptr, struct inode, entry );
 462             if (inode->dev == dev && inode->ino == ino)
 463                 return (struct inode *)grab_object( inode );
 464         }
 465     }
 466     else list_init( &inode_hash[hash] );
 467
 468     /* not found, create it */
 469     if ((inode = alloc_object( &inode_ops )))
 470     {
 471         inode->hash   = hash;
 472         inode->dev    = dev;
 473         inode->ino    = ino;
 474         inode->closed = NULL;
 475         list_init( &inode->open );
 476         list_init( &inode->locks );
 477         list_add_head( &inode_hash[hash], &inode->entry );
 478     }
 479     return inode;
 480 }
 481
 482 /* add fd to the indoe list of file descriptors to close */
 483 static void inode_add_closed_fd( struct inode *inode, struct closed_fd *fd )
 484 {
 485     if (!list_empty( &inode->locks ))
 486     {
 487         fd->next = inode->closed;
 488         inode->closed = fd;
 489     }
 490     else  /* no locks on this inode, we can close the fd right away */
 491     {
 492         close( fd->fd );
 493         free( fd );
 494     }
 495 }
 496
 497
 498 /****************************************************************/
 499 /* file lock functions */
 500
 501 static void file_lock_dump( struct object *obj, int verbose )
 502 {
 503     struct file_lock *lock = (struct file_lock *)obj;
 504     fprintf( stderr, "Lock %s fd=%p proc=%p start=",
 505              lock->shared ? "shared" : "excl", lock->fd, lock->process );
 506     DUMP_LONG_LONG( lock->start );
 507     fprintf( stderr, " end=" );
 508     DUMP_LONG_LONG( lock->end );
 509     fprintf( stderr, "\n" );
 510 }
 511
 512 static int file_lock_signaled( struct object *obj, struct thread *thread )
 513 {
 514     struct file_lock *lock = (struct file_lock *)obj;
 515     /* lock is signaled if it has lost its owner */
 516     return !lock->process;
 517 }
 518
 519 /* set (or remove) a Unix lock if possible for the given range */
 520 static int set_unix_lock( const struct fd *fd, file_pos_t start, file_pos_t end, int type )
 521 {
 522     struct flock fl;
 523
 524     for (;;)
 525     {
 526         if (start == end) return 1;  /* can't set zero-byte lock */
 527         if (start > max_unix_offset) return 1;  /* ignore it */
 528         fl.l_type   = type;
 529         fl.l_whence = SEEK_SET;
 530         fl.l_start  = start;
 531         if (!end || end > max_unix_offset) fl.l_len = 0;
 532         else fl.l_len = end - start;
 533         if (fcntl( fd->unix_fd, F_SETLK, &fl ) != -1) return 1;
 534
 535         switch(errno)
 536         {
 537         case EACCES:
 538         case EAGAIN:
 539             set_error( STATUS_FILE_LOCK_CONFLICT );
 540             return 0;
 541         case EBADF:
 542             /* this can happen if we try to set a write lock on a read-only file */
 543             /* we just ignore that error */
 544             if (fl.l_type == F_WRLCK) return 1;
 545             set_error( STATUS_ACCESS_DENIED );
 546             return 0;
 547         case EOVERFLOW:
 548             /* this can happen if off_t is 64-bit but the kernel only supports 32-bit */
 549             /* in that case we shrink the limit and retry */
 550             if (max_unix_offset > INT_MAX)
 551             {
 552                 max_unix_offset = INT_MAX;
 553                 break;  /* retry */
 554             }
 555             /* fall through */
 556         default:
 557             file_set_error();
 558             return 0;
 559         }
 560     }
 561 }
 562
 563 /* check if interval [start;end) overlaps the lock */
 564 inline static int lock_overlaps( struct file_lock *lock, file_pos_t start, file_pos_t end )
 565 {
 566     if (lock->end && start >= lock->end) return 0;
 567     if (end && lock->start >= end) return 0;
 568     return 1;
 569 }
 570
 571 /* remove Unix locks for all bytes in the specified area that are no longer locked */
 572 static void remove_unix_locks( const struct fd *fd, file_pos_t start, file_pos_t end )
 573 {
 574     struct hole
 575     {
 576         struct hole *next;
 577         struct hole *prev;
 578         file_pos_t   start;
 579         file_pos_t   end;
 580     } *first, *cur, *next, *buffer;
 581
 582     struct list *ptr;
 583     int count = 0;
 584
 585     if (!fd->inode) return;
 586     if (start == end || start > max_unix_offset) return;
 587     if (!end || end > max_unix_offset) end = max_unix_offset + 1;
 588
 589     /* count the number of locks overlapping the specified area */
 590
 591     LIST_FOR_EACH( ptr, &fd->inode->locks )
 592     {
 593         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
 594         if (lock->start == lock->end) continue;
 595         if (lock_overlaps( lock, start, end )) count++;
 596     }
 597
 598     if (!count)  /* no locks at all, we can unlock everything */
 599     {
 600         set_unix_lock( fd, start, end, F_UNLCK );
 601         return;
 602     }
 603
 604     /* allocate space for the list of holes */
 605     /* max. number of holes is number of locks + 1 */
 606
 607     if (!(buffer = malloc( sizeof(*buffer) * (count+1) ))) return;
 608     first = buffer;
 609     first->next  = NULL;
 610     first->prev  = NULL;
 611     first->start = start;
 612     first->end   = end;
 613     next = first + 1;
 614
 615     /* build a sorted list of unlocked holes in the specified area */
 616
 617     LIST_FOR_EACH( ptr, &fd->inode->locks )
 618     {
 619         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
 620         if (lock->start == lock->end) continue;
 621         if (!lock_overlaps( lock, start, end )) continue;
 622
 623         /* go through all the holes touched by this lock */
 624         for (cur = first; cur; cur = cur->next)
 625         {
 626             if (cur->end <= lock->start) continue; /* hole is before start of lock */
 627             if (lock->end && cur->start >= lock->end) break;  /* hole is after end of lock */
 628
 629             /* now we know that lock is overlapping hole */
 630
 631             if (cur->start >= lock->start)  /* lock starts before hole, shrink from start */
 632             {
 633                 cur->start = lock->end;
 634                 if (cur->start && cur->start < cur->end) break;  /* done with this lock */
 635                 /* now hole is empty, remove it */
 636                 if (cur->next) cur->next->prev = cur->prev;
 637                 if (cur->prev) cur->prev->next = cur->next;
 638                 else if (!(first = cur->next)) goto done;  /* no more holes at all */
 639             }
 640             else if (!lock->end || cur->end <= lock->end)  /* lock larger than hole, shrink from end */
 641             {
 642                 cur->end = lock->start;
 643                 assert( cur->start < cur->end );
 644             }
 645             else  /* lock is in the middle of hole, split hole in two */
 646             {
 647                 next->prev = cur;
 648                 next->next = cur->next;
 649                 cur->next = next;
 650                 next->start = lock->end;
 651                 next->end = cur->end;
 652                 cur->end = lock->start;
 653                 assert( next->start < next->end );
 654                 assert( cur->end < next->start );
 655                 next++;
 656                 break;  /* done with this lock */
 657             }
 658         }
 659     }
 660
 661     /* clear Unix locks for all the holes */
 662
 663     for (cur = first; cur; cur = cur->next)
 664         set_unix_lock( fd, cur->start, cur->end, F_UNLCK );
 665
 666  done:
 667     free( buffer );
 668 }
 669
 670 /* create a new lock on a fd */
 671 static struct file_lock *add_lock( struct fd *fd, int shared, file_pos_t start, file_pos_t end )
 672 {
 673     struct file_lock *lock;
 674
 675     if (!fd->inode)  /* not a regular file */
 676     {
 677         set_error( STATUS_INVALID_HANDLE );
 678         return NULL;
 679     }
 680
 681     if (!(lock = alloc_object( &file_lock_ops ))) return NULL;
 682     lock->shared  = shared;
 683     lock->start   = start;
 684     lock->end     = end;
 685     lock->fd      = fd;
 686     lock->process = current->process;
 687
 688     /* now try to set a Unix lock */
 689     if (!set_unix_lock( lock->fd, lock->start, lock->end, lock->shared ? F_RDLCK : F_WRLCK ))
 690     {
 691         release_object( lock );
 692         return NULL;
 693     }
 694     list_add_head( &fd->locks, &lock->fd_entry );
 695     list_add_head( &fd->inode->locks, &lock->inode_entry );
 696     list_add_head( &lock->process->locks, &lock->proc_entry );
 697     return lock;
 698 }
 699
 700 /* remove an existing lock */
 701 static void remove_lock( struct file_lock *lock, int remove_unix )
 702 {
 703     struct inode *inode = lock->fd->inode;
 704
 705     list_remove( &lock->fd_entry );
 706     list_remove( &lock->inode_entry );
 707     list_remove( &lock->proc_entry );
 708     if (remove_unix) remove_unix_locks( lock->fd, lock->start, lock->end );
 709     if (list_empty( &inode->locks )) inode_close_pending( inode );
 710     lock->process = NULL;
 711     wake_up( &lock->obj, 0 );
 712     release_object( lock );
 713 }
 714
 715 /* remove all locks owned by a given process */
 716 void remove_process_locks( struct process *process )
 717 {
 718     struct list *ptr;
 719
 720     while ((ptr = list_head( &process->locks )))
 721     {
 722         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, proc_entry );
 723         remove_lock( lock, 1 );  /* this removes it from the list */
 724     }
 725 }
 726
 727 /* remove all locks on a given fd */
 728 static void remove_fd_locks( struct fd *fd )
 729 {
 730     file_pos_t start = FILE_POS_T_MAX, end = 0;
 731     struct list *ptr;
 732
 733     while ((ptr = list_head( &fd->locks )))
 734     {
 735         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, fd_entry );
 736         if (lock->start < start) start = lock->start;
 737         if (!lock->end || lock->end > end) end = lock->end - 1;
 738         remove_lock( lock, 0 );
 739     }
 740     if (start < end) remove_unix_locks( fd, start, end + 1 );
 741 }
 742
 743 /* add a lock on an fd */
 744 /* returns handle to wait on */
 745 obj_handle_t lock_fd( struct fd *fd, file_pos_t start, file_pos_t count, int shared, int wait )
 746 {
 747     struct list *ptr;
 748     file_pos_t end = start + count;
 749
 750     /* don't allow wrapping locks */
 751     if (end && end < start)
 752     {
 753         set_error( STATUS_INVALID_PARAMETER );
 754         return 0;
 755     }
 756
 757     /* check if another lock on that file overlaps the area */
 758     LIST_FOR_EACH( ptr, &fd->inode->locks )
 759     {
 760         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
 761         if (!lock_overlaps( lock, start, end )) continue;
 762         if (lock->shared && shared) continue;
 763         /* found one */
 764         if (!wait)
 765         {
 766             set_error( STATUS_FILE_LOCK_CONFLICT );
 767             return 0;
 768         }
 769         set_error( STATUS_PENDING );
 770         return alloc_handle( current->process, lock, SYNCHRONIZE, 0 );
 771     }
 772
 773     /* not found, add it */
 774     if (add_lock( fd, shared, start, end )) return 0;
 775     if (get_error() == STATUS_FILE_LOCK_CONFLICT)
 776     {
 777         /* Unix lock conflict -> tell client to wait and retry */
 778         if (wait) set_error( STATUS_PENDING );
 779     }
 780     return 0;
 781 }
 782
 783 /* remove a lock on an fd */
 784 void unlock_fd( struct fd *fd, file_pos_t start, file_pos_t count )
 785 {
 786     struct list *ptr;
 787     file_pos_t end = start + count;
 788
 789     /* find an existing lock with the exact same parameters */
 790     LIST_FOR_EACH( ptr, &fd->locks )
 791     {
 792         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, fd_entry );
 793         if ((lock->start == start) && (lock->end == end))
 794         {
 795             remove_lock( lock, 1 );
 796             return;
 797         }
 798     }
 799     set_error( STATUS_FILE_LOCK_CONFLICT );
 800 }
 801
 802
 803 /****************************************************************/
 804 /* file descriptor functions */
 805
 806 static void fd_dump( struct object *obj, int verbose )
 807 {
 808     struct fd *fd = (struct fd *)obj;
 809     fprintf( stderr, "Fd unix_fd=%d user=%p\n", fd->unix_fd, fd->user );
 810 }
 811
 812 static void fd_destroy( struct object *obj )
 813 {
 814     struct fd *fd = (struct fd *)obj;
 815
 816     remove_fd_locks( fd );
 817     list_remove( &fd->inode_entry );
 818     if (fd->poll_index != -1) remove_poll_user( fd, fd->poll_index );
 819     if (fd->inode)
 820     {
 821         inode_add_closed_fd( fd->inode, fd->closed );
 822         release_object( fd->inode );
 823     }
 824     else  /* no inode, close it right away */
 825     {
 826         if (fd->unix_fd != -1) close( fd->unix_fd );
 827     }
 828 }
 829
 830 /* set the events that select waits for on this fd */
 831 void set_fd_events( struct fd *fd, int events )
 832 {
 833     int user = fd->poll_index;
 834     assert( poll_users[user] == fd );
 835     if (events == -1)  /* stop waiting on this fd completely */
 836     {
 837         pollfd[user].fd = -1;
 838         pollfd[user].events = POLLERR;
 839         pollfd[user].revents = 0;
 840     }
 841     else if (pollfd[user].fd != -1 || !pollfd[user].events)
 842     {
 843         pollfd[user].fd = fd->unix_fd;
 844         pollfd[user].events = events;
 845     }
 846 }
 847
 848 /* allocate an fd object, without setting the unix fd yet */
 849 struct fd *alloc_fd( const struct fd_ops *fd_user_ops, struct object *user )
 850 {
 851     struct fd *fd = alloc_object( &fd_ops );
 852
 853     if (!fd) return NULL;
 854
 855     fd->fd_ops     = fd_user_ops;
 856     fd->user       = user;
 857     fd->inode      = NULL;
 858     fd->closed     = NULL;
 859     fd->unix_fd    = -1;
 860     fd->poll_index = -1;
 861     list_init( &fd->inode_entry );
 862     list_init( &fd->locks );
 863
 864     if ((fd->poll_index = add_poll_user( fd )) == -1)
 865     {
 866         release_object( fd );
 867         return NULL;
 868     }
 869     return fd;
 870 }
 871
 872 /* open() wrapper using a struct fd */
 873 /* the fd must have been created with alloc_fd */
 874 /* on error the fd object is released */
 875 struct fd *open_fd( struct fd *fd, const char *name, int flags, mode_t *mode )
 876 {
 877     struct stat st;
 878     struct closed_fd *closed_fd;
 879
 880     assert( fd->unix_fd == -1 );
 881
 882     if (!(closed_fd = mem_alloc( sizeof(*closed_fd) )))
 883     {
 884         release_object( fd );
 885         return NULL;
 886     }
 887     if ((fd->unix_fd = open( name, flags, *mode )) == -1)
 888     {
 889         file_set_error();
 890         release_object( fd );
 891         free( closed_fd );
 892         return NULL;
 893     }
 894     closed_fd->fd = fd->unix_fd;
 895     fstat( fd->unix_fd, &st );
 896     *mode = st.st_mode;
 897
 898     if (S_ISREG(st.st_mode))  /* only bother with an inode for normal files */
 899     {
 900         struct inode *inode = get_inode( st.st_dev, st.st_ino );
 901
 902         if (!inode)
 903         {
 904             /* we can close the fd because there are no others open on the same file,
 905              * otherwise we wouldn't have failed to allocate a new inode
 906              */
 907             release_object( fd );
 908             free( closed_fd );
 909             return NULL;
 910         }
 911         fd->inode = inode;
 912         fd->closed = closed_fd;
 913         list_add_head( &inode->open, &fd->inode_entry );
 914     }
 915     else
 916     {
 917         free( closed_fd );
 918     }
 919     return fd;
 920 }
 921
 922 /* create an fd for an anonymous file */
 923 /* if the function fails the unix fd is closed */
 924 struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops, int unix_fd, struct object *user )
 925 {
 926     struct fd *fd = alloc_fd( fd_user_ops, user );
 927
 928     if (fd)
 929     {
 930         fd->unix_fd = unix_fd;
 931         return fd;
 932     }
 933     close( unix_fd );
 934     return NULL;
 935 }
 936
 937 /* retrieve the object that is using an fd */
 938 void *get_fd_user( struct fd *fd )
 939 {
 940     return fd->user;
 941 }
 942
 943 /* retrieve the unix fd for an object */
 944 int get_unix_fd( struct fd *fd )
 945 {
 946     return fd->unix_fd;
 947 }
 948
 949 /* callback for event happening in the main poll() loop */
 950 void fd_poll_event( struct fd *fd, int event )
 951 {
 952     return fd->fd_ops->poll_event( fd, event );
 953 }
 954
 955 /* check if events are pending and if yes return which one(s) */
 956 int check_fd_events( struct fd *fd, int events )
 957 {
 958     struct pollfd pfd;
 959
 960     pfd.fd     = fd->unix_fd;
 961     pfd.events = events;
 962     if (poll( &pfd, 1, 0 ) <= 0) return 0;
 963     return pfd.revents;
 964 }
 965
 966 /* default add_queue() routine for objects that poll() on an fd */
 967 int default_fd_add_queue( struct object *obj, struct wait_queue_entry *entry )
 968 {
 969     struct fd *fd = get_obj_fd( obj );
 970
 971     if (!fd) return 0;
 972     if (!obj->head)  /* first on the queue */
 973         set_fd_events( fd, fd->fd_ops->get_poll_events( fd ) );
 974     add_queue( obj, entry );
 975     release_object( fd );
 976     return 1;
 977 }
 978
 979 /* default remove_queue() routine for objects that poll() on an fd */
 980 void default_fd_remove_queue( struct object *obj, struct wait_queue_entry *entry )
 981 {
 982     struct fd *fd = get_obj_fd( obj );
 983
 984     grab_object( obj );
 985     remove_queue( obj, entry );
 986     if (!obj->head)  /* last on the queue is gone */
 987         set_fd_events( fd, 0 );
 988     release_object( obj );
 989     release_object( fd );
 990 }
 991
 992 /* default signaled() routine for objects that poll() on an fd */
 993 int default_fd_signaled( struct object *obj, struct thread *thread )
 994 {
 995     struct fd *fd = get_obj_fd( obj );
 996     int events = fd->fd_ops->get_poll_events( fd );
 997     int ret = check_fd_events( fd, events ) != 0;
 998
 999     if (ret)
1000         set_fd_events( fd, 0 ); /* stop waiting on select() if we are signaled */
1001     else if (obj->head)
1002         set_fd_events( fd, events ); /* restart waiting on poll() if we are no longer signaled */
1003
1004     release_object( fd );
1005     return ret;
1006 }
1007
1008 /* default handler for poll() events */
1009 void default_poll_event( struct fd *fd, int event )
1010 {
1011     /* an error occurred, stop polling this fd to avoid busy-looping */
1012     if (event & (POLLERR | POLLHUP)) set_fd_events( fd, -1 );
1013     wake_up( fd->user, 0 );
1014 }
1015
1016 /* default flush() routine */
1017 int no_flush( struct fd *fd )
1018 {
1019     set_error( STATUS_OBJECT_TYPE_MISMATCH );
1020     return 0;
1021 }
1022
1023 /* default get_file_info() routine */
1024 int no_get_file_info( struct fd *fd, struct get_file_info_reply *info, int *flags )
1025 {
1026     set_error( STATUS_OBJECT_TYPE_MISMATCH );
1027     *flags = 0;
1028     return FD_TYPE_INVALID;
1029 }
1030
1031 /* default queue_async() routine */
1032 void no_queue_async( struct fd *fd, void* ptr, unsigned int status, int type, int count )
1033 {
1034     set_error( STATUS_OBJECT_TYPE_MISMATCH );
1035 }
1036
1037 /* same as get_handle_obj but retrieve the struct fd associated to the object */
1038 static struct fd *get_handle_fd_obj( struct process *process, obj_handle_t handle,
1039                                      unsigned int access )
1040 {
1041     struct fd *fd = NULL;
1042     struct object *obj;
1043
1044     if ((obj = get_handle_obj( process, handle, access, NULL )))
1045     {
1046         if (!(fd = get_obj_fd( obj ))) set_error( STATUS_OBJECT_TYPE_MISMATCH );
1047         release_object( obj );
1048     }
1049     return fd;
1050 }
1051
1052 /* flush a file buffers */
1053 DECL_HANDLER(flush_file)
1054 {
1055     struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
1056
1057     if (fd)
1058     {
1059         fd->fd_ops->flush( fd );
1060         release_object( fd );
1061     }
1062 }
1063
1064 /* get a Unix fd to access a file */
1065 DECL_HANDLER(get_handle_fd)
1066 {
1067     struct fd *fd;
1068
1069     reply->fd = -1;
1070     reply->type = FD_TYPE_INVALID;
1071
1072     if ((fd = get_handle_fd_obj( current->process, req->handle, req->access )))
1073     {
1074         int unix_fd = get_handle_unix_fd( current->process, req->handle, req->access );
1075         if (unix_fd != -1) reply->fd = unix_fd;
1076         else if (!get_error())
1077         {
1078             unix_fd = fd->unix_fd;
1079             if (unix_fd != -1) send_client_fd( current->process, unix_fd, req->handle );
1080         }
1081         reply->type = fd->fd_ops->get_file_info( fd, NULL, &reply->flags );
1082         release_object( fd );
1083     }
1084     else  /* check for console handle (FIXME: should be done in the client) */
1085     {
1086         struct object *obj;
1087
1088         if ((obj = get_handle_obj( current->process, req->handle, req->access, NULL )))
1089         {
1090             if (is_console_object( obj )) reply->type = FD_TYPE_CONSOLE;
1091             release_object( obj );
1092         }
1093     }
1094 }
1095
1096 /* get a file information */
1097 DECL_HANDLER(get_file_info)
1098 {
1099     struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
1100
1101     if (fd)
1102     {
1103         int flags;
1104         fd->fd_ops->get_file_info( fd, reply, &flags );
1105         release_object( fd );
1106     }
1107 }
1108
1109 /* create / reschedule an async I/O */
1110 DECL_HANDLER(register_async)
1111 {
1112     struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
1113
1114 /*
1115  * The queue_async method must do the following:
1116  *
1117  * 1. Get the async_queue for the request of given type.
1118  * 2. Call find_async() to look for the specific client request in the queue (=> NULL if not found).
1119  * 3. If status is STATUS_PENDING:
1120  *      a) If no async request found in step 2 (new request): call create_async() to initialize one.
1121  *      b) Set request's status to STATUS_PENDING.
1122  *      c) If the "queue" field of the async request is NULL: call async_insert() to put it into the queue.
1123  *    Otherwise:
1124  *      If the async request was found in step 2, destroy it by calling destroy_async().
1125  * 4. Carry out any operations necessary to adjust the object's poll events
1126  *    Usually: set_elect_events (obj, obj->ops->get_poll_events()).
1127  *
1128  * See also the implementations in file.c, serial.c, and sock.c.
1129 */
1130
1131     if (fd)
1132     {
1133         fd->fd_ops->queue_async( fd, req->overlapped, req->status, req->type, req->count );
1134         release_object( fd );
1135     }
1136 }