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
  46 /* Because of the stupid Posix locking semantics, we need to keep
  47  * track of all file descriptors referencing a given file, and not
  48  * close a single one until all the locks are gone (sigh).
  49  */
  50
  51 /* file descriptor object */
  52
  53 /* closed_fd is used to keep track of the unix fd belonging to a closed fd object */
  54 struct closed_fd
  55 {
  56     struct closed_fd *next;   /* next fd in close list */
  57     int               fd;     /* the unix file descriptor */
  58 };
  59
  60 struct fd
  61 {
  62     struct object        obj;         /* object header */
  63     const struct fd_ops *fd_ops;      /* file descriptor operations */
  64     struct inode        *inode;       /* inode that this fd belongs to */
  65     struct list          inode_entry; /* entry in inode fd list */
  66     struct closed_fd    *closed;      /* structure to store the unix fd at destroy time */
  67     struct object       *user;        /* object using this file descriptor */
  68     struct list          locks;       /* list of locks on this fd */
  69     int                  unix_fd;     /* unix file descriptor */
  70     int                  fs_locks;    /* can we use filesystem locks for this fd? */
  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 /* server main poll() loop */
 313 void main_loop(void)
 314 {
 315     int ret;
 316
 317     while (active_users)
 318     {
 319         long diff = -1;
 320         if (timeout_head)
 321         {
 322             struct timeval now;
 323             gettimeofday( &now, NULL );
 324             while (timeout_head)
 325             {
 326                 if (!time_before( &now, &timeout_head->when )) handle_timeout();
 327                 else
 328                 {
 329                     diff = (timeout_head->when.tv_sec - now.tv_sec) * 1000
 330                             + (timeout_head->when.tv_usec - now.tv_usec) / 1000;
 331                     break;
 332                 }
 333             }
 334             if (!active_users) break;  /* last user removed by a timeout */
 335         }
 336         ret = poll( pollfd, nb_users, diff );
 337         if (ret > 0)
 338         {
 339             int i;
 340             for (i = 0; i < nb_users; i++)
 341             {
 342                 if (pollfd[i].revents)
 343                 {
 344                     fd_poll_event( poll_users[i], pollfd[i].revents );
 345                     if (!--ret) break;
 346                 }
 347             }
 348         }
 349     }
 350 }
 351
 352
 353 /****************************************************************/
 354 /* inode functions */
 355
 356 #define HASH_SIZE 37
 357
 358 static struct list inode_hash[HASH_SIZE];
 359
 360 /* close all pending file descriptors in the closed list */
 361 static void inode_close_pending( struct inode *inode )
 362 {
 363     while (inode->closed)
 364     {
 365         struct closed_fd *fd = inode->closed;
 366         inode->closed = fd->next;
 367         close( fd->fd );
 368         free( fd );
 369     }
 370 }
 371
 372
 373 static void inode_dump( struct object *obj, int verbose )
 374 {
 375     struct inode *inode = (struct inode *)obj;
 376     fprintf( stderr, "Inode dev=" );
 377     DUMP_LONG_LONG( inode->dev );
 378     fprintf( stderr, " ino=" );
 379     DUMP_LONG_LONG( inode->ino );
 380     fprintf( stderr, "\n" );
 381 }
 382
 383 static void inode_destroy( struct object *obj )
 384 {
 385     struct inode *inode = (struct inode *)obj;
 386
 387     assert( list_empty(&inode->open) );
 388     assert( list_empty(&inode->locks) );
 389
 390     list_remove( &inode->entry );
 391     inode_close_pending( inode );
 392 }
 393
 394 /* retrieve the inode object for a given fd, creating it if needed */
 395 static struct inode *get_inode( dev_t dev, ino_t ino )
 396 {
 397     struct list *ptr;
 398     struct inode *inode;
 399     unsigned int hash = (dev ^ ino) % HASH_SIZE;
 400
 401     if (inode_hash[hash].next)
 402     {
 403         LIST_FOR_EACH( ptr, &inode_hash[hash] )
 404         {
 405             inode = LIST_ENTRY( ptr, struct inode, entry );
 406             if (inode->dev == dev && inode->ino == ino)
 407                 return (struct inode *)grab_object( inode );
 408         }
 409     }
 410     else list_init( &inode_hash[hash] );
 411
 412     /* not found, create it */
 413     if ((inode = alloc_object( &inode_ops )))
 414     {
 415         inode->hash   = hash;
 416         inode->dev    = dev;
 417         inode->ino    = ino;
 418         inode->closed = NULL;
 419         list_init( &inode->open );
 420         list_init( &inode->locks );
 421         list_add_head( &inode_hash[hash], &inode->entry );
 422     }
 423     return inode;
 424 }
 425
 426 /* add fd to the indoe list of file descriptors to close */
 427 static void inode_add_closed_fd( struct inode *inode, struct closed_fd *fd )
 428 {
 429     if (!list_empty( &inode->locks ))
 430     {
 431         fd->next = inode->closed;
 432         inode->closed = fd;
 433     }
 434     else  /* no locks on this inode, we can close the fd right away */
 435     {
 436         close( fd->fd );
 437         free( fd );
 438     }
 439 }
 440
 441
 442 /****************************************************************/
 443 /* file lock functions */
 444
 445 static void file_lock_dump( struct object *obj, int verbose )
 446 {
 447     struct file_lock *lock = (struct file_lock *)obj;
 448     fprintf( stderr, "Lock %s fd=%p proc=%p start=",
 449              lock->shared ? "shared" : "excl", lock->fd, lock->process );
 450     DUMP_LONG_LONG( lock->start );
 451     fprintf( stderr, " end=" );
 452     DUMP_LONG_LONG( lock->end );
 453     fprintf( stderr, "\n" );
 454 }
 455
 456 static int file_lock_signaled( struct object *obj, struct thread *thread )
 457 {
 458     struct file_lock *lock = (struct file_lock *)obj;
 459     /* lock is signaled if it has lost its owner */
 460     return !lock->process;
 461 }
 462
 463 /* set (or remove) a Unix lock if possible for the given range */
 464 static int set_unix_lock( struct fd *fd, file_pos_t start, file_pos_t end, int type )
 465 {
 466     struct flock fl;
 467
 468     if (!fd->fs_locks) return 1;  /* no fs locks possible for this fd */
 469     for (;;)
 470     {
 471         if (start == end) return 1;  /* can't set zero-byte lock */
 472         if (start > max_unix_offset) return 1;  /* ignore it */
 473         fl.l_type   = type;
 474         fl.l_whence = SEEK_SET;
 475         fl.l_start  = start;
 476         if (!end || end > max_unix_offset) fl.l_len = 0;
 477         else fl.l_len = end - start;
 478         if (fcntl( fd->unix_fd, F_SETLK, &fl ) != -1) return 1;
 479
 480         switch(errno)
 481         {
 482         case EACCES:
 483             /* check whether locks work at all on this file system */
 484             if (fcntl( fd->unix_fd, F_GETLK, &fl ) != -1)
 485             {
 486                 set_error( STATUS_FILE_LOCK_CONFLICT );
 487                 return 0;
 488             }
 489             /* fall through */
 490         case EIO:
 491         case ENOLCK:
 492             /* no locking on this fs, just ignore it */
 493             fd->fs_locks = 0;
 494             return 1;
 495         case EAGAIN:
 496             set_error( STATUS_FILE_LOCK_CONFLICT );
 497             return 0;
 498         case EBADF:
 499             /* this can happen if we try to set a write lock on a read-only file */
 500             /* we just ignore that error */
 501             if (fl.l_type == F_WRLCK) return 1;
 502             set_error( STATUS_ACCESS_DENIED );
 503             return 0;
 504         case EOVERFLOW:
 505         case EINVAL:
 506             /* this can happen if off_t is 64-bit but the kernel only supports 32-bit */
 507             /* in that case we shrink the limit and retry */
 508             if (max_unix_offset > INT_MAX)
 509             {
 510                 max_unix_offset = INT_MAX;
 511                 break;  /* retry */
 512             }
 513             /* fall through */
 514         default:
 515             file_set_error();
 516             return 0;
 517         }
 518     }
 519 }
 520
 521 /* check if interval [start;end) overlaps the lock */
 522 inline static int lock_overlaps( struct file_lock *lock, file_pos_t start, file_pos_t end )
 523 {
 524     if (lock->end && start >= lock->end) return 0;
 525     if (end && lock->start >= end) return 0;
 526     return 1;
 527 }
 528
 529 /* remove Unix locks for all bytes in the specified area that are no longer locked */
 530 static void remove_unix_locks( struct fd *fd, file_pos_t start, file_pos_t end )
 531 {
 532     struct hole
 533     {
 534         struct hole *next;
 535         struct hole *prev;
 536         file_pos_t   start;
 537         file_pos_t   end;
 538     } *first, *cur, *next, *buffer;
 539
 540     struct list *ptr;
 541     int count = 0;
 542
 543     if (!fd->inode) return;
 544     if (!fd->fs_locks) return;
 545     if (start == end || start > max_unix_offset) return;
 546     if (!end || end > max_unix_offset) end = max_unix_offset + 1;
 547
 548     /* count the number of locks overlapping the specified area */
 549
 550     LIST_FOR_EACH( ptr, &fd->inode->locks )
 551     {
 552         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
 553         if (lock->start == lock->end) continue;
 554         if (lock_overlaps( lock, start, end )) count++;
 555     }
 556
 557     if (!count)  /* no locks at all, we can unlock everything */
 558     {
 559         set_unix_lock( fd, start, end, F_UNLCK );
 560         return;
 561     }
 562
 563     /* allocate space for the list of holes */
 564     /* max. number of holes is number of locks + 1 */
 565
 566     if (!(buffer = malloc( sizeof(*buffer) * (count+1) ))) return;
 567     first = buffer;
 568     first->next  = NULL;
 569     first->prev  = NULL;
 570     first->start = start;
 571     first->end   = end;
 572     next = first + 1;
 573
 574     /* build a sorted list of unlocked holes in the specified area */
 575
 576     LIST_FOR_EACH( ptr, &fd->inode->locks )
 577     {
 578         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
 579         if (lock->start == lock->end) continue;
 580         if (!lock_overlaps( lock, start, end )) continue;
 581
 582         /* go through all the holes touched by this lock */
 583         for (cur = first; cur; cur = cur->next)
 584         {
 585             if (cur->end <= lock->start) continue; /* hole is before start of lock */
 586             if (lock->end && cur->start >= lock->end) break;  /* hole is after end of lock */
 587
 588             /* now we know that lock is overlapping hole */
 589
 590             if (cur->start >= lock->start)  /* lock starts before hole, shrink from start */
 591             {
 592                 cur->start = lock->end;
 593                 if (cur->start && cur->start < cur->end) break;  /* done with this lock */
 594                 /* now hole is empty, remove it */
 595                 if (cur->next) cur->next->prev = cur->prev;
 596                 if (cur->prev) cur->prev->next = cur->next;
 597                 else if (!(first = cur->next)) goto done;  /* no more holes at all */
 598             }
 599             else if (!lock->end || cur->end <= lock->end)  /* lock larger than hole, shrink from end */
 600             {
 601                 cur->end = lock->start;
 602                 assert( cur->start < cur->end );
 603             }
 604             else  /* lock is in the middle of hole, split hole in two */
 605             {
 606                 next->prev = cur;
 607                 next->next = cur->next;
 608                 cur->next = next;
 609                 next->start = lock->end;
 610                 next->end = cur->end;
 611                 cur->end = lock->start;
 612                 assert( next->start < next->end );
 613                 assert( cur->end < next->start );
 614                 next++;
 615                 break;  /* done with this lock */
 616             }
 617         }
 618     }
 619
 620     /* clear Unix locks for all the holes */
 621
 622     for (cur = first; cur; cur = cur->next)
 623         set_unix_lock( fd, cur->start, cur->end, F_UNLCK );
 624
 625  done:
 626     free( buffer );
 627 }
 628
 629 /* create a new lock on a fd */
 630 static struct file_lock *add_lock( struct fd *fd, int shared, file_pos_t start, file_pos_t end )
 631 {
 632     struct file_lock *lock;
 633
 634     if (!fd->inode)  /* not a regular file */
 635     {
 636         set_error( STATUS_INVALID_HANDLE );
 637         return NULL;
 638     }
 639
 640     if (!(lock = alloc_object( &file_lock_ops ))) return NULL;
 641     lock->shared  = shared;
 642     lock->start   = start;
 643     lock->end     = end;
 644     lock->fd      = fd;
 645     lock->process = current->process;
 646
 647     /* now try to set a Unix lock */
 648     if (!set_unix_lock( lock->fd, lock->start, lock->end, lock->shared ? F_RDLCK : F_WRLCK ))
 649     {
 650         release_object( lock );
 651         return NULL;
 652     }
 653     list_add_head( &fd->locks, &lock->fd_entry );
 654     list_add_head( &fd->inode->locks, &lock->inode_entry );
 655     list_add_head( &lock->process->locks, &lock->proc_entry );
 656     return lock;
 657 }
 658
 659 /* remove an existing lock */
 660 static void remove_lock( struct file_lock *lock, int remove_unix )
 661 {
 662     struct inode *inode = lock->fd->inode;
 663
 664     list_remove( &lock->fd_entry );
 665     list_remove( &lock->inode_entry );
 666     list_remove( &lock->proc_entry );
 667     if (remove_unix) remove_unix_locks( lock->fd, lock->start, lock->end );
 668     if (list_empty( &inode->locks )) inode_close_pending( inode );
 669     lock->process = NULL;
 670     wake_up( &lock->obj, 0 );
 671     release_object( lock );
 672 }
 673
 674 /* remove all locks owned by a given process */
 675 void remove_process_locks( struct process *process )
 676 {
 677     struct list *ptr;
 678
 679     while ((ptr = list_head( &process->locks )))
 680     {
 681         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, proc_entry );
 682         remove_lock( lock, 1 );  /* this removes it from the list */
 683     }
 684 }
 685
 686 /* remove all locks on a given fd */
 687 static void remove_fd_locks( struct fd *fd )
 688 {
 689     file_pos_t start = FILE_POS_T_MAX, end = 0;
 690     struct list *ptr;
 691
 692     while ((ptr = list_head( &fd->locks )))
 693     {
 694         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, fd_entry );
 695         if (lock->start < start) start = lock->start;
 696         if (!lock->end || lock->end > end) end = lock->end - 1;
 697         remove_lock( lock, 0 );
 698     }
 699     if (start < end) remove_unix_locks( fd, start, end + 1 );
 700 }
 701
 702 /* add a lock on an fd */
 703 /* returns handle to wait on */
 704 obj_handle_t lock_fd( struct fd *fd, file_pos_t start, file_pos_t count, int shared, int wait )
 705 {
 706     struct list *ptr;
 707     file_pos_t end = start + count;
 708
 709     /* don't allow wrapping locks */
 710     if (end && end < start)
 711     {
 712         set_error( STATUS_INVALID_PARAMETER );
 713         return 0;
 714     }
 715
 716     /* check if another lock on that file overlaps the area */
 717     LIST_FOR_EACH( ptr, &fd->inode->locks )
 718     {
 719         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
 720         if (!lock_overlaps( lock, start, end )) continue;
 721         if (lock->shared && shared) continue;
 722         /* found one */
 723         if (!wait)
 724         {
 725             set_error( STATUS_FILE_LOCK_CONFLICT );
 726             return 0;
 727         }
 728         set_error( STATUS_PENDING );
 729         return alloc_handle( current->process, lock, SYNCHRONIZE, 0 );
 730     }
 731
 732     /* not found, add it */
 733     if (add_lock( fd, shared, start, end )) return 0;
 734     if (get_error() == STATUS_FILE_LOCK_CONFLICT)
 735     {
 736         /* Unix lock conflict -> tell client to wait and retry */
 737         if (wait) set_error( STATUS_PENDING );
 738     }
 739     return 0;
 740 }
 741
 742 /* remove a lock on an fd */
 743 void unlock_fd( struct fd *fd, file_pos_t start, file_pos_t count )
 744 {
 745     struct list *ptr;
 746     file_pos_t end = start + count;
 747
 748     /* find an existing lock with the exact same parameters */
 749     LIST_FOR_EACH( ptr, &fd->locks )
 750     {
 751         struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, fd_entry );
 752         if ((lock->start == start) && (lock->end == end))
 753         {
 754             remove_lock( lock, 1 );
 755             return;
 756         }
 757     }
 758     set_error( STATUS_FILE_LOCK_CONFLICT );
 759 }
 760
 761
 762 /****************************************************************/
 763 /* file descriptor functions */
 764
 765 static void fd_dump( struct object *obj, int verbose )
 766 {
 767     struct fd *fd = (struct fd *)obj;
 768     fprintf( stderr, "Fd unix_fd=%d user=%p\n", fd->unix_fd, fd->user );
 769 }
 770
 771 static void fd_destroy( struct object *obj )
 772 {
 773     struct fd *fd = (struct fd *)obj;
 774
 775     remove_fd_locks( fd );
 776     list_remove( &fd->inode_entry );
 777     if (fd->poll_index != -1) remove_poll_user( fd, fd->poll_index );
 778     if (fd->inode)
 779     {
 780         inode_add_closed_fd( fd->inode, fd->closed );
 781         release_object( fd->inode );
 782     }
 783     else  /* no inode, close it right away */
 784     {
 785         if (fd->unix_fd != -1) close( fd->unix_fd );
 786     }
 787 }
 788
 789 /* set the events that select waits for on this fd */
 790 void set_fd_events( struct fd *fd, int events )
 791 {
 792     int user = fd->poll_index;
 793     assert( poll_users[user] == fd );
 794     if (events == -1)  /* stop waiting on this fd completely */
 795     {
 796         pollfd[user].fd = -1;
 797         pollfd[user].events = POLLERR;
 798         pollfd[user].revents = 0;
 799     }
 800     else if (pollfd[user].fd != -1 || !pollfd[user].events)
 801     {
 802         pollfd[user].fd = fd->unix_fd;
 803         pollfd[user].events = events;
 804     }
 805 }
 806
 807 /* allocate an fd object, without setting the unix fd yet */
 808 struct fd *alloc_fd( const struct fd_ops *fd_user_ops, struct object *user )
 809 {
 810     struct fd *fd = alloc_object( &fd_ops );
 811
 812     if (!fd) return NULL;
 813
 814     fd->fd_ops     = fd_user_ops;
 815     fd->user       = user;
 816     fd->inode      = NULL;
 817     fd->closed     = NULL;
 818     fd->unix_fd    = -1;
 819     fd->fs_locks   = 1;
 820     fd->poll_index = -1;
 821     list_init( &fd->inode_entry );
 822     list_init( &fd->locks );
 823
 824     if ((fd->poll_index = add_poll_user( fd )) == -1)
 825     {
 826         release_object( fd );
 827         return NULL;
 828     }
 829     return fd;
 830 }
 831
 832 /* open() wrapper using a struct fd */
 833 /* the fd must have been created with alloc_fd */
 834 /* on error the fd object is released */
 835 struct fd *open_fd( struct fd *fd, const char *name, int flags, mode_t *mode )
 836 {
 837     struct stat st;
 838     struct closed_fd *closed_fd;
 839
 840     assert( fd->unix_fd == -1 );
 841
 842     if (!(closed_fd = mem_alloc( sizeof(*closed_fd) )))
 843     {
 844         release_object( fd );
 845         return NULL;
 846     }
 847     if ((fd->unix_fd = open( name, flags, *mode )) == -1)
 848     {
 849         file_set_error();
 850         release_object( fd );
 851         free( closed_fd );
 852         return NULL;
 853     }
 854     closed_fd->fd = fd->unix_fd;
 855     fstat( fd->unix_fd, &st );
 856     *mode = st.st_mode;
 857
 858     if (S_ISREG(st.st_mode))  /* only bother with an inode for normal files */
 859     {
 860         struct inode *inode = get_inode( st.st_dev, st.st_ino );
 861
 862         if (!inode)
 863         {
 864             /* we can close the fd because there are no others open on the same file,
 865              * otherwise we wouldn't have failed to allocate a new inode
 866              */
 867             release_object( fd );
 868             free( closed_fd );
 869             return NULL;
 870         }
 871         fd->inode = inode;
 872         fd->closed = closed_fd;
 873         list_add_head( &inode->open, &fd->inode_entry );
 874     }
 875     else
 876     {
 877         free( closed_fd );
 878     }
 879     return fd;
 880 }
 881
 882 /* create an fd for an anonymous file */
 883 /* if the function fails the unix fd is closed */
 884 struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops, int unix_fd, struct object *user )
 885 {
 886     struct fd *fd = alloc_fd( fd_user_ops, user );
 887
 888     if (fd)
 889     {
 890         fd->unix_fd = unix_fd;
 891         return fd;
 892     }
 893     close( unix_fd );
 894     return NULL;
 895 }
 896
 897 /* retrieve the object that is using an fd */
 898 void *get_fd_user( struct fd *fd )
 899 {
 900     return fd->user;
 901 }
 902
 903 /* retrieve the unix fd for an object */
 904 int get_unix_fd( struct fd *fd )
 905 {
 906     return fd->unix_fd;
 907 }
 908
 909 /* callback for event happening in the main poll() loop */
 910 void fd_poll_event( struct fd *fd, int event )
 911 {
 912     return fd->fd_ops->poll_event( fd, event );
 913 }
 914
 915 /* check if events are pending and if yes return which one(s) */
 916 int check_fd_events( struct fd *fd, int events )
 917 {
 918     struct pollfd pfd;
 919
 920     pfd.fd     = fd->unix_fd;
 921     pfd.events = events;
 922     if (poll( &pfd, 1, 0 ) <= 0) return 0;
 923     return pfd.revents;
 924 }
 925
 926 /* default add_queue() routine for objects that poll() on an fd */
 927 int default_fd_add_queue( struct object *obj, struct wait_queue_entry *entry )
 928 {
 929     struct fd *fd = get_obj_fd( obj );
 930
 931     if (!fd) return 0;
 932     if (!obj->head)  /* first on the queue */
 933         set_fd_events( fd, fd->fd_ops->get_poll_events( fd ) );
 934     add_queue( obj, entry );
 935     release_object( fd );
 936     return 1;
 937 }
 938
 939 /* default remove_queue() routine for objects that poll() on an fd */
 940 void default_fd_remove_queue( struct object *obj, struct wait_queue_entry *entry )
 941 {
 942     struct fd *fd = get_obj_fd( obj );
 943
 944     grab_object( obj );
 945     remove_queue( obj, entry );
 946     if (!obj->head)  /* last on the queue is gone */
 947         set_fd_events( fd, 0 );
 948     release_object( obj );
 949     release_object( fd );
 950 }
 951
 952 /* default signaled() routine for objects that poll() on an fd */
 953 int default_fd_signaled( struct object *obj, struct thread *thread )
 954 {
 955     struct fd *fd = get_obj_fd( obj );
 956     int events = fd->fd_ops->get_poll_events( fd );
 957     int ret = check_fd_events( fd, events ) != 0;
 958
 959     if (ret)
 960         set_fd_events( fd, 0 ); /* stop waiting on select() if we are signaled */
 961     else if (obj->head)
 962         set_fd_events( fd, events ); /* restart waiting on poll() if we are no longer signaled */
 963
 964     release_object( fd );
 965     return ret;
 966 }
 967
 968 /* default handler for poll() events */
 969 void default_poll_event( struct fd *fd, int event )
 970 {
 971     /* an error occurred, stop polling this fd to avoid busy-looping */
 972     if (event & (POLLERR | POLLHUP)) set_fd_events( fd, -1 );
 973     wake_up( fd->user, 0 );
 974 }
 975
 976 /* default flush() routine */
 977 int no_flush( struct fd *fd, struct event **event )
 978 {
 979     set_error( STATUS_OBJECT_TYPE_MISMATCH );
 980     return 0;
 981 }
 982
 983 /* default get_file_info() routine */
 984 int no_get_file_info( struct fd *fd, struct get_file_info_reply *info, int *flags )
 985 {
 986     set_error( STATUS_OBJECT_TYPE_MISMATCH );
 987     *flags = 0;
 988     return FD_TYPE_INVALID;
 989 }
 990
 991 /* default queue_async() routine */
 992 void no_queue_async( struct fd *fd, void* ptr, unsigned int status, int type, int count )
 993 {
 994     set_error( STATUS_OBJECT_TYPE_MISMATCH );
 995 }
 996
 997 /* same as get_handle_obj but retrieve the struct fd associated to the object */
 998 static struct fd *get_handle_fd_obj( struct process *process, obj_handle_t handle,
 999                                      unsigned int access )
1000 {
1001     struct fd *fd = NULL;
1002     struct object *obj;
1003
1004     if ((obj = get_handle_obj( process, handle, access, NULL )))
1005     {
1006         fd = get_obj_fd( obj );
1007         release_object( obj );
1008     }
1009     return fd;
1010 }
1011
1012 /* flush a file buffers */
1013 DECL_HANDLER(flush_file)
1014 {
1015     struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
1016     struct event * event = NULL;
1017
1018     if (fd)
1019     {
1020         fd->fd_ops->flush( fd, &event );
1021         if( event )
1022         {
1023             reply->event = alloc_handle( current->process, event, SYNCHRONIZE, 0 );
1024         }
1025         release_object( fd );
1026     }
1027 }
1028
1029 /* get a Unix fd to access a file */
1030 DECL_HANDLER(get_handle_fd)
1031 {
1032     struct fd *fd;
1033
1034     reply->fd = -1;
1035     reply->type = FD_TYPE_INVALID;
1036
1037     if ((fd = get_handle_fd_obj( current->process, req->handle, req->access )))
1038     {
1039         int unix_fd = get_handle_unix_fd( current->process, req->handle, req->access );
1040         if (unix_fd != -1) reply->fd = unix_fd;
1041         else if (!get_error())
1042         {
1043             assert( fd->unix_fd != -1 );
1044             send_client_fd( current->process, fd->unix_fd, req->handle );
1045         }
1046         reply->type = fd->fd_ops->get_file_info( fd, NULL, &reply->flags );
1047         release_object( fd );
1048     }
1049 }
1050
1051 /* get a file information */
1052 DECL_HANDLER(get_file_info)
1053 {
1054     struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
1055
1056     if (fd)
1057     {
1058         int flags;
1059         fd->fd_ops->get_file_info( fd, reply, &flags );
1060         release_object( fd );
1061     }
1062 }
1063
1064 /* create / reschedule an async I/O */
1065 DECL_HANDLER(register_async)
1066 {
1067     struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
1068
1069 /*
1070  * The queue_async method must do the following:
1071  *
1072  * 1. Get the async_queue for the request of given type.
1073  * 2. Call find_async() to look for the specific client request in the queue (=> NULL if not found).
1074  * 3. If status is STATUS_PENDING:
1075  *      a) If no async request found in step 2 (new request): call create_async() to initialize one.
1076  *      b) Set request's status to STATUS_PENDING.
1077  *      c) If the "queue" field of the async request is NULL: call async_insert() to put it into the queue.
1078  *    Otherwise:
1079  *      If the async request was found in step 2, destroy it by calling destroy_async().
1080  * 4. Carry out any operations necessary to adjust the object's poll events
1081  *    Usually: set_elect_events (obj, obj->ops->get_poll_events()).
1082  *
1083  * See also the implementations in file.c, serial.c, and sock.c.
1084 */
1085
1086     if (fd)
1087     {
1088         fd->fd_ops->queue_async( fd, req->overlapped, req->status, req->type, req->count );
1089         release_object( fd );
1090     }
1091 }