2 * Server-side file descriptor management
4 * Copyright (C) 2000, 2003 Alexandre Julliard
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.
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.
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
23 #include "wine/port.h"
37 #ifdef HAVE_SYS_POLL_H
40 #ifdef HAVE_LINUX_MAJOR_H
41 #include <linux/major.h>
43 #ifdef HAVE_SYS_STATVFS_H
44 #include <sys/statvfs.h>
48 * Solaris defines its system list in sys/list.h.
49 * This need to be workaround it here.
52 #define list_next SYSLIST_NEXT
53 #define list_prev SYSLIST_PREV
54 #define list_head SYSLIST_HEAD
55 #define list_tail SYSLIST_TAIL
56 #define list_move_tail SYSLIST_MOVE_TAIL
57 #define list_remove SYSLIST_REMOVE
67 #ifdef HAVE_SYS_PARAM_H
68 #include <sys/param.h>
70 #ifdef HAVE_SYS_MOUNT_H
71 #include <sys/mount.h>
73 #ifdef HAVE_SYS_STATFS_H
74 #include <sys/statfs.h>
76 #ifdef HAVE_SYS_SYSCTL_H
77 #include <sys/sysctl.h>
79 #ifdef HAVE_SYS_EVENT_H
80 #include <sys/event.h>
89 #include <sys/types.h>
93 #define WIN32_NO_STATUS
100 #include "winternl.h"
101 #include "winioctl.h"
103 #if defined(HAVE_SYS_EPOLL_H) && defined(HAVE_EPOLL_CREATE)
104 # include <sys/epoll.h>
106 #elif defined(linux) && defined(__i386__) && defined(HAVE_STDINT_H)
108 # define EPOLLIN POLLIN
109 # define EPOLLOUT POLLOUT
110 # define EPOLLERR POLLERR
111 # define EPOLLHUP POLLHUP
112 # define EPOLL_CTL_ADD 1
113 # define EPOLL_CTL_DEL 2
114 # define EPOLL_CTL_MOD 3
116 typedef union epoll_data
130 #define SYSCALL_RET(ret) do { \
131 if (ret < 0) { errno = -ret; ret = -1; } \
135 static inline int epoll_create( int size )
138 __asm__( "pushl %%ebx; movl %2,%%ebx; int $0x80; popl %%ebx"
139 : "=a" (ret) : "0" (254 /*NR_epoll_create*/), "r" (size) );
143 static inline int epoll_ctl( int epfd, int op, int fd, const struct epoll_event *event )
146 __asm__( "pushl %%ebx; movl %2,%%ebx; int $0x80; popl %%ebx"
148 : "0" (255 /*NR_epoll_ctl*/), "r" (epfd), "c" (op), "d" (fd), "S" (event), "m" (*event) );
152 static inline int epoll_wait( int epfd, struct epoll_event *events, int maxevents, int timeout )
155 __asm__( "pushl %%ebx; movl %2,%%ebx; int $0x80; popl %%ebx"
157 : "0" (256 /*NR_epoll_wait*/), "r" (epfd), "c" (events), "d" (maxevents), "S" (timeout)
163 #endif /* linux && __i386__ && HAVE_STDINT_H */
165 #if defined(HAVE_PORT_H) && defined(HAVE_PORT_CREATE)
167 # define USE_EVENT_PORTS
168 #endif /* HAVE_PORT_H && HAVE_PORT_CREATE */
170 /* Because of the stupid Posix locking semantics, we need to keep
171 * track of all file descriptors referencing a given file, and not
172 * close a single one until all the locks are gone (sigh).
175 /* file descriptor object */
177 /* closed_fd is used to keep track of the unix fd belonging to a closed fd object */
180 struct list entry; /* entry in inode closed list */
181 int unix_fd; /* the unix file descriptor */
182 char unlink[1]; /* name to unlink on close (if any) */
187 struct object obj; /* object header */
188 const struct fd_ops *fd_ops; /* file descriptor operations */
189 struct inode *inode; /* inode that this fd belongs to */
190 struct list inode_entry; /* entry in inode fd list */
191 struct closed_fd *closed; /* structure to store the unix fd at destroy time */
192 struct object *user; /* object using this file descriptor */
193 struct list locks; /* list of locks on this fd */
194 unsigned int access; /* file access (FILE_READ_DATA etc.) */
195 unsigned int options; /* file options (FILE_DELETE_ON_CLOSE, FILE_SYNCHRONOUS...) */
196 unsigned int sharing; /* file sharing mode */
197 char *unix_name; /* unix file name */
198 int unix_fd; /* unix file descriptor */
199 unsigned int no_fd_status;/* status to return when unix_fd is -1 */
200 unsigned int signaled :1; /* is the fd signaled? */
201 unsigned int fs_locks :1; /* can we use filesystem locks for this fd? */
202 int poll_index; /* index of fd in poll array */
203 struct async_queue *read_q; /* async readers of this fd */
204 struct async_queue *write_q; /* async writers of this fd */
205 struct async_queue *wait_q; /* other async waiters of this fd */
206 struct completion *completion; /* completion object attached to this fd */
207 apc_param_t comp_key; /* completion key to set in completion events */
210 static void fd_dump( struct object *obj, int verbose );
211 static void fd_destroy( struct object *obj );
213 static const struct object_ops fd_ops =
215 sizeof(struct fd), /* size */
217 no_get_type, /* get_type */
218 no_add_queue, /* add_queue */
219 NULL, /* remove_queue */
221 NULL, /* satisfied */
222 no_signal, /* signal */
223 no_get_fd, /* get_fd */
224 no_map_access, /* map_access */
225 default_get_sd, /* get_sd */
226 default_set_sd, /* set_sd */
227 no_lookup_name, /* lookup_name */
228 no_open_file, /* open_file */
229 no_close_handle, /* close_handle */
230 fd_destroy /* destroy */
235 #define DEVICE_HASH_SIZE 7
236 #define INODE_HASH_SIZE 17
240 struct object obj; /* object header */
241 struct list entry; /* entry in device hash list */
242 dev_t dev; /* device number */
243 int removable; /* removable device? (or -1 if unknown) */
244 struct list inode_hash[INODE_HASH_SIZE]; /* inodes hash table */
247 static void device_dump( struct object *obj, int verbose );
248 static void device_destroy( struct object *obj );
250 static const struct object_ops device_ops =
252 sizeof(struct device), /* size */
253 device_dump, /* dump */
254 no_get_type, /* get_type */
255 no_add_queue, /* add_queue */
256 NULL, /* remove_queue */
258 NULL, /* satisfied */
259 no_signal, /* signal */
260 no_get_fd, /* get_fd */
261 no_map_access, /* map_access */
262 default_get_sd, /* get_sd */
263 default_set_sd, /* set_sd */
264 no_lookup_name, /* lookup_name */
265 no_open_file, /* open_file */
266 no_close_handle, /* close_handle */
267 device_destroy /* destroy */
274 struct object obj; /* object header */
275 struct list entry; /* inode hash list entry */
276 struct device *device; /* device containing this inode */
277 ino_t ino; /* inode number */
278 struct list open; /* list of open file descriptors */
279 struct list locks; /* list of file locks */
280 struct list closed; /* list of file descriptors to close at destroy time */
283 static void inode_dump( struct object *obj, int verbose );
284 static void inode_destroy( struct object *obj );
286 static const struct object_ops inode_ops =
288 sizeof(struct inode), /* size */
289 inode_dump, /* dump */
290 no_get_type, /* get_type */
291 no_add_queue, /* add_queue */
292 NULL, /* remove_queue */
294 NULL, /* satisfied */
295 no_signal, /* signal */
296 no_get_fd, /* get_fd */
297 no_map_access, /* map_access */
298 default_get_sd, /* get_sd */
299 default_set_sd, /* set_sd */
300 no_lookup_name, /* lookup_name */
301 no_open_file, /* open_file */
302 no_close_handle, /* close_handle */
303 inode_destroy /* destroy */
306 /* file lock object */
310 struct object obj; /* object header */
311 struct fd *fd; /* fd owning this lock */
312 struct list fd_entry; /* entry in list of locks on a given fd */
313 struct list inode_entry; /* entry in inode list of locks */
314 int shared; /* shared lock? */
315 file_pos_t start; /* locked region is interval [start;end) */
317 struct process *process; /* process owning this lock */
318 struct list proc_entry; /* entry in list of locks owned by the process */
321 static void file_lock_dump( struct object *obj, int verbose );
322 static int file_lock_signaled( struct object *obj, struct thread *thread );
324 static const struct object_ops file_lock_ops =
326 sizeof(struct file_lock), /* size */
327 file_lock_dump, /* dump */
328 no_get_type, /* get_type */
329 add_queue, /* add_queue */
330 remove_queue, /* remove_queue */
331 file_lock_signaled, /* signaled */
332 no_satisfied, /* satisfied */
333 no_signal, /* signal */
334 no_get_fd, /* get_fd */
335 no_map_access, /* map_access */
336 default_get_sd, /* get_sd */
337 default_set_sd, /* set_sd */
338 no_lookup_name, /* lookup_name */
339 no_open_file, /* open_file */
340 no_close_handle, /* close_handle */
341 no_destroy /* destroy */
345 #define OFF_T_MAX (~((file_pos_t)1 << (8*sizeof(off_t)-1)))
346 #define FILE_POS_T_MAX (~(file_pos_t)0)
348 static file_pos_t max_unix_offset = OFF_T_MAX;
350 #define DUMP_LONG_LONG(val) do { \
351 if (sizeof(val) > sizeof(unsigned long) && (val) > ~0UL) \
352 fprintf( stderr, "%lx%08lx", (unsigned long)((unsigned long long)(val) >> 32), (unsigned long)(val) ); \
354 fprintf( stderr, "%lx", (unsigned long)(val) ); \
359 /****************************************************************/
360 /* timeouts support */
364 struct list entry; /* entry in sorted timeout list */
365 timeout_t when; /* timeout expiry (absolute time) */
366 timeout_callback callback; /* callback function */
367 void *private; /* callback private data */
370 static struct list timeout_list = LIST_INIT(timeout_list); /* sorted timeouts list */
371 timeout_t current_time;
373 static inline void set_current_time(void)
375 static const timeout_t ticks_1601_to_1970 = (timeout_t)86400 * (369 * 365 + 89) * TICKS_PER_SEC;
377 gettimeofday( &now, NULL );
378 current_time = (timeout_t)now.tv_sec * TICKS_PER_SEC + now.tv_usec * 10 + ticks_1601_to_1970;
381 /* add a timeout user */
382 struct timeout_user *add_timeout_user( timeout_t when, timeout_callback func, void *private )
384 struct timeout_user *user;
387 if (!(user = mem_alloc( sizeof(*user) ))) return NULL;
388 user->when = (when > 0) ? when : current_time - when;
389 user->callback = func;
390 user->private = private;
392 /* Now insert it in the linked list */
394 LIST_FOR_EACH( ptr, &timeout_list )
396 struct timeout_user *timeout = LIST_ENTRY( ptr, struct timeout_user, entry );
397 if (timeout->when >= user->when) break;
399 list_add_before( ptr, &user->entry );
403 /* remove a timeout user */
404 void remove_timeout_user( struct timeout_user *user )
406 list_remove( &user->entry );
410 /* return a text description of a timeout for debugging purposes */
411 const char *get_timeout_str( timeout_t timeout )
413 static char buffer[64];
416 if (!timeout) return "0";
417 if (timeout == TIMEOUT_INFINITE) return "infinite";
419 if (timeout < 0) /* relative */
421 secs = -timeout / TICKS_PER_SEC;
422 nsecs = -timeout % TICKS_PER_SEC;
423 sprintf( buffer, "+%ld.%07ld", secs, nsecs );
427 secs = (timeout - current_time) / TICKS_PER_SEC;
428 nsecs = (timeout - current_time) % TICKS_PER_SEC;
431 nsecs += TICKS_PER_SEC;
435 sprintf( buffer, "%x%08x (+%ld.%07ld)",
436 (unsigned int)(timeout >> 32), (unsigned int)timeout, secs, nsecs );
438 sprintf( buffer, "%x%08x (-%ld.%07ld)",
439 (unsigned int)(timeout >> 32), (unsigned int)timeout,
440 -(secs + 1), TICKS_PER_SEC - nsecs );
446 /****************************************************************/
449 static struct fd **poll_users; /* users array */
450 static struct pollfd *pollfd; /* poll fd array */
451 static int nb_users; /* count of array entries actually in use */
452 static int active_users; /* current number of active users */
453 static int allocated_users; /* count of allocated entries in the array */
454 static struct fd **freelist; /* list of free entries in the array */
456 static int get_next_timeout(void);
458 static inline void fd_poll_event( struct fd *fd, int event )
460 fd->fd_ops->poll_event( fd, event );
465 static int epoll_fd = -1;
467 static inline void init_epoll(void)
469 epoll_fd = epoll_create( 128 );
472 /* set the events that epoll waits for on this fd; helper for set_fd_events */
473 static inline void set_fd_epoll_events( struct fd *fd, int user, int events )
475 struct epoll_event ev;
478 if (epoll_fd == -1) return;
480 if (events == -1) /* stop waiting on this fd completely */
482 if (pollfd[user].fd == -1) return; /* already removed */
485 else if (pollfd[user].fd == -1)
487 if (pollfd[user].events) return; /* stopped waiting on it, don't restart */
492 if (pollfd[user].events == events) return; /* nothing to do */
497 memset(&ev.data, 0, sizeof(ev.data));
500 if (epoll_ctl( epoll_fd, ctl, fd->unix_fd, &ev ) == -1)
502 if (errno == ENOMEM) /* not enough memory, give up on epoll */
507 else perror( "epoll_ctl" ); /* should not happen */
511 static inline void remove_epoll_user( struct fd *fd, int user )
513 if (epoll_fd == -1) return;
515 if (pollfd[user].fd != -1)
517 struct epoll_event dummy;
518 epoll_ctl( epoll_fd, EPOLL_CTL_DEL, fd->unix_fd, &dummy );
522 static inline void main_loop_epoll(void)
525 struct epoll_event events[128];
527 assert( POLLIN == EPOLLIN );
528 assert( POLLOUT == EPOLLOUT );
529 assert( POLLERR == EPOLLERR );
530 assert( POLLHUP == EPOLLHUP );
532 if (epoll_fd == -1) return;
536 timeout = get_next_timeout();
538 if (!active_users) break; /* last user removed by a timeout */
539 if (epoll_fd == -1) break; /* an error occurred with epoll */
541 ret = epoll_wait( epoll_fd, events, sizeof(events)/sizeof(events[0]), timeout );
544 /* put the events into the pollfd array first, like poll does */
545 for (i = 0; i < ret; i++)
547 int user = events[i].data.u32;
548 pollfd[user].revents = events[i].events;
551 /* read events from the pollfd array, as set_fd_events may modify them */
552 for (i = 0; i < ret; i++)
554 int user = events[i].data.u32;
555 if (pollfd[user].revents) fd_poll_event( poll_users[user], pollfd[user].revents );
560 #elif defined(HAVE_KQUEUE)
562 static int kqueue_fd = -1;
564 static inline void init_epoll(void)
566 #ifdef __APPLE__ /* kqueue support is broken in Mac OS < 10.5 */
569 size_t len = sizeof(release);
572 mib[1] = KERN_OSRELEASE;
573 if (sysctl( mib, 2, release, &len, NULL, 0 ) == -1) return;
574 if (atoi(release) < 9) return;
576 kqueue_fd = kqueue();
579 static inline void set_fd_epoll_events( struct fd *fd, int user, int events )
583 if (kqueue_fd == -1) return;
585 EV_SET( &ev[0], fd->unix_fd, EVFILT_READ, 0, NOTE_LOWAT, 1, (void *)user );
586 EV_SET( &ev[1], fd->unix_fd, EVFILT_WRITE, 0, NOTE_LOWAT, 1, (void *)user );
588 if (events == -1) /* stop waiting on this fd completely */
590 if (pollfd[user].fd == -1) return; /* already removed */
591 ev[0].flags |= EV_DELETE;
592 ev[1].flags |= EV_DELETE;
594 else if (pollfd[user].fd == -1)
596 if (pollfd[user].events) return; /* stopped waiting on it, don't restart */
597 ev[0].flags |= EV_ADD | ((events & POLLIN) ? EV_ENABLE : EV_DISABLE);
598 ev[1].flags |= EV_ADD | ((events & POLLOUT) ? EV_ENABLE : EV_DISABLE);
602 if (pollfd[user].events == events) return; /* nothing to do */
603 ev[0].flags |= (events & POLLIN) ? EV_ENABLE : EV_DISABLE;
604 ev[1].flags |= (events & POLLOUT) ? EV_ENABLE : EV_DISABLE;
607 if (kevent( kqueue_fd, ev, 2, NULL, 0, NULL ) == -1)
609 if (errno == ENOMEM) /* not enough memory, give up on kqueue */
614 else perror( "kevent" ); /* should not happen */
618 static inline void remove_epoll_user( struct fd *fd, int user )
620 if (kqueue_fd == -1) return;
622 if (pollfd[user].fd != -1)
626 EV_SET( &ev[0], fd->unix_fd, EVFILT_READ, EV_DELETE, 0, 0, 0 );
627 EV_SET( &ev[1], fd->unix_fd, EVFILT_WRITE, EV_DELETE, 0, 0, 0 );
628 kevent( kqueue_fd, ev, 2, NULL, 0, NULL );
632 static inline void main_loop_epoll(void)
635 struct kevent events[128];
637 if (kqueue_fd == -1) return;
641 timeout = get_next_timeout();
643 if (!active_users) break; /* last user removed by a timeout */
644 if (kqueue_fd == -1) break; /* an error occurred with kqueue */
650 ts.tv_sec = timeout / 1000;
651 ts.tv_nsec = (timeout % 1000) * 1000000;
652 ret = kevent( kqueue_fd, NULL, 0, events, sizeof(events)/sizeof(events[0]), &ts );
654 else ret = kevent( kqueue_fd, NULL, 0, events, sizeof(events)/sizeof(events[0]), NULL );
658 /* put the events into the pollfd array first, like poll does */
659 for (i = 0; i < ret; i++)
661 long user = (long)events[i].udata;
662 pollfd[user].revents = 0;
664 for (i = 0; i < ret; i++)
666 long user = (long)events[i].udata;
667 if (events[i].filter == EVFILT_READ) pollfd[user].revents |= POLLIN;
668 else if (events[i].filter == EVFILT_WRITE) pollfd[user].revents |= POLLOUT;
669 if (events[i].flags & EV_EOF) pollfd[user].revents |= POLLHUP;
670 if (events[i].flags & EV_ERROR) pollfd[user].revents |= POLLERR;
673 /* read events from the pollfd array, as set_fd_events may modify them */
674 for (i = 0; i < ret; i++)
676 long user = (long)events[i].udata;
677 if (pollfd[user].revents) fd_poll_event( poll_users[user], pollfd[user].revents );
678 pollfd[user].revents = 0;
683 #elif defined(USE_EVENT_PORTS)
685 static int port_fd = -1;
687 static inline void init_epoll(void)
689 port_fd = port_create();
692 static inline void set_fd_epoll_events( struct fd *fd, int user, int events )
696 if (port_fd == -1) return;
698 if (events == -1) /* stop waiting on this fd completely */
700 if (pollfd[user].fd == -1) return; /* already removed */
701 port_dissociate( port_fd, PORT_SOURCE_FD, fd->unix_fd );
703 else if (pollfd[user].fd == -1)
705 if (pollfd[user].events) return; /* stopped waiting on it, don't restart */
706 ret = port_associate( port_fd, PORT_SOURCE_FD, fd->unix_fd, events, (void *)user );
710 if (pollfd[user].events == events) return; /* nothing to do */
711 ret = port_associate( port_fd, PORT_SOURCE_FD, fd->unix_fd, events, (void *)user );
716 if (errno == ENOMEM) /* not enough memory, give up on port_associate */
721 else perror( "port_associate" ); /* should not happen */
725 static inline void remove_epoll_user( struct fd *fd, int user )
727 if (port_fd == -1) return;
729 if (pollfd[user].fd != -1)
731 port_dissociate( port_fd, PORT_SOURCE_FD, fd->unix_fd );
735 static inline void main_loop_epoll(void)
737 int i, nget, ret, timeout;
738 port_event_t events[128];
740 if (port_fd == -1) return;
744 timeout = get_next_timeout();
747 if (!active_users) break; /* last user removed by a timeout */
748 if (port_fd == -1) break; /* an error occurred with event completion */
754 ts.tv_sec = timeout / 1000;
755 ts.tv_nsec = (timeout % 1000) * 1000000;
756 ret = port_getn( port_fd, events, sizeof(events)/sizeof(events[0]), &nget, &ts );
758 else ret = port_getn( port_fd, events, sizeof(events)/sizeof(events[0]), &nget, NULL );
760 if (ret == -1) break; /* an error occurred with event completion */
764 /* put the events into the pollfd array first, like poll does */
765 for (i = 0; i < nget; i++)
767 long user = (long)events[i].portev_user;
768 pollfd[user].revents = events[i].portev_events;
771 /* read events from the pollfd array, as set_fd_events may modify them */
772 for (i = 0; i < nget; i++)
774 long user = (long)events[i].portev_user;
775 if (pollfd[user].revents) fd_poll_event( poll_users[user], pollfd[user].revents );
776 /* if we are still interested, reassociate the fd */
777 if (pollfd[user].fd != -1) {
778 port_associate( port_fd, PORT_SOURCE_FD, pollfd[user].fd, pollfd[user].events, (void *)user );
784 #else /* HAVE_KQUEUE */
786 static inline void init_epoll(void) { }
787 static inline void set_fd_epoll_events( struct fd *fd, int user, int events ) { }
788 static inline void remove_epoll_user( struct fd *fd, int user ) { }
789 static inline void main_loop_epoll(void) { }
791 #endif /* USE_EPOLL */
794 /* add a user in the poll array and return its index, or -1 on failure */
795 static int add_poll_user( struct fd *fd )
800 ret = freelist - poll_users;
801 freelist = (struct fd **)poll_users[ret];
805 if (nb_users == allocated_users)
807 struct fd **newusers;
808 struct pollfd *newpoll;
809 int new_count = allocated_users ? (allocated_users + allocated_users / 2) : 16;
810 if (!(newusers = realloc( poll_users, new_count * sizeof(*poll_users) ))) return -1;
811 if (!(newpoll = realloc( pollfd, new_count * sizeof(*pollfd) )))
814 poll_users = newusers;
819 poll_users = newusers;
821 if (!allocated_users) init_epoll();
822 allocated_users = new_count;
827 pollfd[ret].events = 0;
828 pollfd[ret].revents = 0;
829 poll_users[ret] = fd;
834 /* remove a user from the poll list */
835 static void remove_poll_user( struct fd *fd, int user )
838 assert( poll_users[user] == fd );
840 remove_epoll_user( fd, user );
841 pollfd[user].fd = -1;
842 pollfd[user].events = 0;
843 pollfd[user].revents = 0;
844 poll_users[user] = (struct fd *)freelist;
845 freelist = &poll_users[user];
849 /* process pending timeouts and return the time until the next timeout, in milliseconds */
850 static int get_next_timeout(void)
852 if (!list_empty( &timeout_list ))
854 struct list expired_list, *ptr;
856 /* first remove all expired timers from the list */
858 list_init( &expired_list );
859 while ((ptr = list_head( &timeout_list )) != NULL)
861 struct timeout_user *timeout = LIST_ENTRY( ptr, struct timeout_user, entry );
863 if (timeout->when <= current_time)
865 list_remove( &timeout->entry );
866 list_add_tail( &expired_list, &timeout->entry );
871 /* now call the callback for all the removed timers */
873 while ((ptr = list_head( &expired_list )) != NULL)
875 struct timeout_user *timeout = LIST_ENTRY( ptr, struct timeout_user, entry );
876 list_remove( &timeout->entry );
877 timeout->callback( timeout->private );
881 if ((ptr = list_head( &timeout_list )) != NULL)
883 struct timeout_user *timeout = LIST_ENTRY( ptr, struct timeout_user, entry );
884 int diff = (timeout->when - current_time + 9999) / 10000;
885 if (diff < 0) diff = 0;
889 return -1; /* no pending timeouts */
892 /* server main poll() loop */
898 server_start_time = current_time;
901 /* fall through to normal poll loop */
905 timeout = get_next_timeout();
907 if (!active_users) break; /* last user removed by a timeout */
909 ret = poll( pollfd, nb_users, timeout );
914 for (i = 0; i < nb_users; i++)
916 if (pollfd[i].revents)
918 fd_poll_event( poll_users[i], pollfd[i].revents );
927 /****************************************************************/
928 /* device functions */
930 static struct list device_hash[DEVICE_HASH_SIZE];
932 static int is_device_removable( dev_t dev, int unix_fd )
934 #if defined(linux) && defined(HAVE_FSTATFS)
937 /* check for floppy disk */
938 if (major(dev) == FLOPPY_MAJOR) return 1;
940 if (fstatfs( unix_fd, &stfs ) == -1) return 0;
941 return (stfs.f_type == 0x9660 || /* iso9660 */
942 stfs.f_type == 0x9fa1 || /* supermount */
943 stfs.f_type == 0x15013346); /* udf */
944 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__APPLE__)
947 if (fstatfs( unix_fd, &stfs ) == -1) return 0;
948 return (!strcmp("cd9660", stfs.f_fstypename) || !strcmp("udf", stfs.f_fstypename));
949 #elif defined(__NetBSD__)
952 if (fstatvfs( unix_fd, &stfs ) == -1) return 0;
953 return (!strcmp("cd9660", stfs.f_fstypename) || !strcmp("udf", stfs.f_fstypename));
955 # include <sys/dkio.h>
956 # include <sys/vtoc.h>
957 struct dk_cinfo dkinf;
958 if (ioctl( unix_fd, DKIOCINFO, &dkinf ) == -1) return 0;
959 return (dkinf.dki_ctype == DKC_CDROM ||
960 dkinf.dki_ctype == DKC_NCRFLOPPY ||
961 dkinf.dki_ctype == DKC_SMSFLOPPY ||
962 dkinf.dki_ctype == DKC_INTEL82072 ||
963 dkinf.dki_ctype == DKC_INTEL82077);
969 /* retrieve the device object for a given fd, creating it if needed */
970 static struct device *get_device( dev_t dev, int unix_fd )
972 struct device *device;
973 unsigned int i, hash = dev % DEVICE_HASH_SIZE;
975 if (device_hash[hash].next)
977 LIST_FOR_EACH_ENTRY( device, &device_hash[hash], struct device, entry )
978 if (device->dev == dev) return (struct device *)grab_object( device );
980 else list_init( &device_hash[hash] );
982 /* not found, create it */
984 if (unix_fd == -1) return NULL;
985 if ((device = alloc_object( &device_ops )))
988 device->removable = is_device_removable( dev, unix_fd );
989 for (i = 0; i < INODE_HASH_SIZE; i++) list_init( &device->inode_hash[i] );
990 list_add_head( &device_hash[hash], &device->entry );
995 static void device_dump( struct object *obj, int verbose )
997 struct device *device = (struct device *)obj;
998 fprintf( stderr, "Device dev=" );
999 DUMP_LONG_LONG( device->dev );
1000 fprintf( stderr, "\n" );
1003 static void device_destroy( struct object *obj )
1005 struct device *device = (struct device *)obj;
1008 for (i = 0; i < INODE_HASH_SIZE; i++)
1009 assert( list_empty(&device->inode_hash[i]) );
1011 list_remove( &device->entry ); /* remove it from the hash table */
1015 /****************************************************************/
1016 /* inode functions */
1018 /* close all pending file descriptors in the closed list */
1019 static void inode_close_pending( struct inode *inode, int keep_unlinks )
1021 struct list *ptr = list_head( &inode->closed );
1025 struct closed_fd *fd = LIST_ENTRY( ptr, struct closed_fd, entry );
1026 struct list *next = list_next( &inode->closed, ptr );
1028 if (fd->unix_fd != -1)
1030 close( fd->unix_fd );
1033 if (!keep_unlinks || !fd->unlink[0]) /* get rid of it unless there's an unlink pending on that file */
1042 static void inode_dump( struct object *obj, int verbose )
1044 struct inode *inode = (struct inode *)obj;
1045 fprintf( stderr, "Inode device=%p ino=", inode->device );
1046 DUMP_LONG_LONG( inode->ino );
1047 fprintf( stderr, "\n" );
1050 static void inode_destroy( struct object *obj )
1052 struct inode *inode = (struct inode *)obj;
1055 assert( list_empty(&inode->open) );
1056 assert( list_empty(&inode->locks) );
1058 list_remove( &inode->entry );
1060 while ((ptr = list_head( &inode->closed )))
1062 struct closed_fd *fd = LIST_ENTRY( ptr, struct closed_fd, entry );
1064 if (fd->unix_fd != -1) close( fd->unix_fd );
1067 /* make sure it is still the same file */
1069 if (!stat( fd->unlink, &st ) && st.st_dev == inode->device->dev && st.st_ino == inode->ino)
1071 if (S_ISDIR(st.st_mode)) rmdir( fd->unlink );
1072 else unlink( fd->unlink );
1077 release_object( inode->device );
1080 /* retrieve the inode object for a given fd, creating it if needed */
1081 static struct inode *get_inode( dev_t dev, ino_t ino, int unix_fd )
1083 struct device *device;
1084 struct inode *inode;
1085 unsigned int hash = ino % INODE_HASH_SIZE;
1087 if (!(device = get_device( dev, unix_fd ))) return NULL;
1089 LIST_FOR_EACH_ENTRY( inode, &device->inode_hash[hash], struct inode, entry )
1091 if (inode->ino == ino)
1093 release_object( device );
1094 return (struct inode *)grab_object( inode );
1098 /* not found, create it */
1099 if ((inode = alloc_object( &inode_ops )))
1101 inode->device = device;
1103 list_init( &inode->open );
1104 list_init( &inode->locks );
1105 list_init( &inode->closed );
1106 list_add_head( &device->inode_hash[hash], &inode->entry );
1108 else release_object( device );
1113 /* add fd to the inode list of file descriptors to close */
1114 static void inode_add_closed_fd( struct inode *inode, struct closed_fd *fd )
1116 if (!list_empty( &inode->locks ))
1118 list_add_head( &inode->closed, &fd->entry );
1120 else if (fd->unlink[0]) /* close the fd but keep the structure around for unlink */
1122 if (fd->unix_fd != -1) close( fd->unix_fd );
1124 list_add_head( &inode->closed, &fd->entry );
1126 else /* no locks on this inode and no unlink, get rid of the fd */
1128 if (fd->unix_fd != -1) close( fd->unix_fd );
1134 /****************************************************************/
1135 /* file lock functions */
1137 static void file_lock_dump( struct object *obj, int verbose )
1139 struct file_lock *lock = (struct file_lock *)obj;
1140 fprintf( stderr, "Lock %s fd=%p proc=%p start=",
1141 lock->shared ? "shared" : "excl", lock->fd, lock->process );
1142 DUMP_LONG_LONG( lock->start );
1143 fprintf( stderr, " end=" );
1144 DUMP_LONG_LONG( lock->end );
1145 fprintf( stderr, "\n" );
1148 static int file_lock_signaled( struct object *obj, struct thread *thread )
1150 struct file_lock *lock = (struct file_lock *)obj;
1151 /* lock is signaled if it has lost its owner */
1152 return !lock->process;
1155 /* set (or remove) a Unix lock if possible for the given range */
1156 static int set_unix_lock( struct fd *fd, file_pos_t start, file_pos_t end, int type )
1160 if (!fd->fs_locks) return 1; /* no fs locks possible for this fd */
1163 if (start == end) return 1; /* can't set zero-byte lock */
1164 if (start > max_unix_offset) return 1; /* ignore it */
1166 fl.l_whence = SEEK_SET;
1168 if (!end || end > max_unix_offset) fl.l_len = 0;
1169 else fl.l_len = end - start;
1170 if (fcntl( fd->unix_fd, F_SETLK, &fl ) != -1) return 1;
1175 /* check whether locks work at all on this file system */
1176 if (fcntl( fd->unix_fd, F_GETLK, &fl ) != -1)
1178 set_error( STATUS_FILE_LOCK_CONFLICT );
1184 /* no locking on this fs, just ignore it */
1188 set_error( STATUS_FILE_LOCK_CONFLICT );
1191 /* this can happen if we try to set a write lock on a read-only file */
1192 /* we just ignore that error */
1193 if (fl.l_type == F_WRLCK) return 1;
1194 set_error( STATUS_ACCESS_DENIED );
1200 /* this can happen if off_t is 64-bit but the kernel only supports 32-bit */
1201 /* in that case we shrink the limit and retry */
1202 if (max_unix_offset > INT_MAX)
1204 max_unix_offset = INT_MAX;
1215 /* check if interval [start;end) overlaps the lock */
1216 static inline int lock_overlaps( struct file_lock *lock, file_pos_t start, file_pos_t end )
1218 if (lock->end && start >= lock->end) return 0;
1219 if (end && lock->start >= end) return 0;
1223 /* remove Unix locks for all bytes in the specified area that are no longer locked */
1224 static void remove_unix_locks( struct fd *fd, file_pos_t start, file_pos_t end )
1232 } *first, *cur, *next, *buffer;
1237 if (!fd->inode) return;
1238 if (!fd->fs_locks) return;
1239 if (start == end || start > max_unix_offset) return;
1240 if (!end || end > max_unix_offset) end = max_unix_offset + 1;
1242 /* count the number of locks overlapping the specified area */
1244 LIST_FOR_EACH( ptr, &fd->inode->locks )
1246 struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
1247 if (lock->start == lock->end) continue;
1248 if (lock_overlaps( lock, start, end )) count++;
1251 if (!count) /* no locks at all, we can unlock everything */
1253 set_unix_lock( fd, start, end, F_UNLCK );
1257 /* allocate space for the list of holes */
1258 /* max. number of holes is number of locks + 1 */
1260 if (!(buffer = malloc( sizeof(*buffer) * (count+1) ))) return;
1264 first->start = start;
1268 /* build a sorted list of unlocked holes in the specified area */
1270 LIST_FOR_EACH( ptr, &fd->inode->locks )
1272 struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
1273 if (lock->start == lock->end) continue;
1274 if (!lock_overlaps( lock, start, end )) continue;
1276 /* go through all the holes touched by this lock */
1277 for (cur = first; cur; cur = cur->next)
1279 if (cur->end <= lock->start) continue; /* hole is before start of lock */
1280 if (lock->end && cur->start >= lock->end) break; /* hole is after end of lock */
1282 /* now we know that lock is overlapping hole */
1284 if (cur->start >= lock->start) /* lock starts before hole, shrink from start */
1286 cur->start = lock->end;
1287 if (cur->start && cur->start < cur->end) break; /* done with this lock */
1288 /* now hole is empty, remove it */
1289 if (cur->next) cur->next->prev = cur->prev;
1290 if (cur->prev) cur->prev->next = cur->next;
1291 else if (!(first = cur->next)) goto done; /* no more holes at all */
1293 else if (!lock->end || cur->end <= lock->end) /* lock larger than hole, shrink from end */
1295 cur->end = lock->start;
1296 assert( cur->start < cur->end );
1298 else /* lock is in the middle of hole, split hole in two */
1301 next->next = cur->next;
1303 next->start = lock->end;
1304 next->end = cur->end;
1305 cur->end = lock->start;
1306 assert( next->start < next->end );
1307 assert( cur->end < next->start );
1309 break; /* done with this lock */
1314 /* clear Unix locks for all the holes */
1316 for (cur = first; cur; cur = cur->next)
1317 set_unix_lock( fd, cur->start, cur->end, F_UNLCK );
1323 /* create a new lock on a fd */
1324 static struct file_lock *add_lock( struct fd *fd, int shared, file_pos_t start, file_pos_t end )
1326 struct file_lock *lock;
1328 if (!(lock = alloc_object( &file_lock_ops ))) return NULL;
1329 lock->shared = shared;
1330 lock->start = start;
1333 lock->process = current->process;
1335 /* now try to set a Unix lock */
1336 if (!set_unix_lock( lock->fd, lock->start, lock->end, lock->shared ? F_RDLCK : F_WRLCK ))
1338 release_object( lock );
1341 list_add_head( &fd->locks, &lock->fd_entry );
1342 list_add_head( &fd->inode->locks, &lock->inode_entry );
1343 list_add_head( &lock->process->locks, &lock->proc_entry );
1347 /* remove an existing lock */
1348 static void remove_lock( struct file_lock *lock, int remove_unix )
1350 struct inode *inode = lock->fd->inode;
1352 list_remove( &lock->fd_entry );
1353 list_remove( &lock->inode_entry );
1354 list_remove( &lock->proc_entry );
1355 if (remove_unix) remove_unix_locks( lock->fd, lock->start, lock->end );
1356 if (list_empty( &inode->locks )) inode_close_pending( inode, 1 );
1357 lock->process = NULL;
1358 wake_up( &lock->obj, 0 );
1359 release_object( lock );
1362 /* remove all locks owned by a given process */
1363 void remove_process_locks( struct process *process )
1367 while ((ptr = list_head( &process->locks )))
1369 struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, proc_entry );
1370 remove_lock( lock, 1 ); /* this removes it from the list */
1374 /* remove all locks on a given fd */
1375 static void remove_fd_locks( struct fd *fd )
1377 file_pos_t start = FILE_POS_T_MAX, end = 0;
1380 while ((ptr = list_head( &fd->locks )))
1382 struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, fd_entry );
1383 if (lock->start < start) start = lock->start;
1384 if (!lock->end || lock->end > end) end = lock->end - 1;
1385 remove_lock( lock, 0 );
1387 if (start < end) remove_unix_locks( fd, start, end + 1 );
1390 /* add a lock on an fd */
1391 /* returns handle to wait on */
1392 obj_handle_t lock_fd( struct fd *fd, file_pos_t start, file_pos_t count, int shared, int wait )
1395 file_pos_t end = start + count;
1397 if (!fd->inode) /* not a regular file */
1399 set_error( STATUS_INVALID_DEVICE_REQUEST );
1403 /* don't allow wrapping locks */
1404 if (end && end < start)
1406 set_error( STATUS_INVALID_PARAMETER );
1410 /* check if another lock on that file overlaps the area */
1411 LIST_FOR_EACH( ptr, &fd->inode->locks )
1413 struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
1414 if (!lock_overlaps( lock, start, end )) continue;
1415 if (lock->shared && shared) continue;
1419 set_error( STATUS_FILE_LOCK_CONFLICT );
1422 set_error( STATUS_PENDING );
1423 return alloc_handle( current->process, lock, SYNCHRONIZE, 0 );
1426 /* not found, add it */
1427 if (add_lock( fd, shared, start, end )) return 0;
1428 if (get_error() == STATUS_FILE_LOCK_CONFLICT)
1430 /* Unix lock conflict -> tell client to wait and retry */
1431 if (wait) set_error( STATUS_PENDING );
1436 /* remove a lock on an fd */
1437 void unlock_fd( struct fd *fd, file_pos_t start, file_pos_t count )
1440 file_pos_t end = start + count;
1442 /* find an existing lock with the exact same parameters */
1443 LIST_FOR_EACH( ptr, &fd->locks )
1445 struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, fd_entry );
1446 if ((lock->start == start) && (lock->end == end))
1448 remove_lock( lock, 1 );
1452 set_error( STATUS_FILE_LOCK_CONFLICT );
1456 /****************************************************************/
1457 /* file descriptor functions */
1459 static void fd_dump( struct object *obj, int verbose )
1461 struct fd *fd = (struct fd *)obj;
1462 fprintf( stderr, "Fd unix_fd=%d user=%p options=%08x", fd->unix_fd, fd->user, fd->options );
1463 if (fd->inode) fprintf( stderr, " inode=%p unlink='%s'", fd->inode, fd->closed->unlink );
1464 fprintf( stderr, "\n" );
1467 static void fd_destroy( struct object *obj )
1469 struct fd *fd = (struct fd *)obj;
1471 free_async_queue( fd->read_q );
1472 free_async_queue( fd->write_q );
1473 free_async_queue( fd->wait_q );
1475 if (fd->completion) release_object( fd->completion );
1476 remove_fd_locks( fd );
1477 free( fd->unix_name );
1478 list_remove( &fd->inode_entry );
1479 if (fd->poll_index != -1) remove_poll_user( fd, fd->poll_index );
1482 inode_add_closed_fd( fd->inode, fd->closed );
1483 release_object( fd->inode );
1485 else /* no inode, close it right away */
1487 if (fd->unix_fd != -1) close( fd->unix_fd );
1491 /* set the events that select waits for on this fd */
1492 void set_fd_events( struct fd *fd, int events )
1494 int user = fd->poll_index;
1495 assert( poll_users[user] == fd );
1497 set_fd_epoll_events( fd, user, events );
1499 if (events == -1) /* stop waiting on this fd completely */
1501 pollfd[user].fd = -1;
1502 pollfd[user].events = POLLERR;
1503 pollfd[user].revents = 0;
1505 else if (pollfd[user].fd != -1 || !pollfd[user].events)
1507 pollfd[user].fd = fd->unix_fd;
1508 pollfd[user].events = events;
1512 /* prepare an fd for unmounting its corresponding device */
1513 static inline void unmount_fd( struct fd *fd )
1515 assert( fd->inode );
1517 async_wake_up( fd->read_q, STATUS_VOLUME_DISMOUNTED );
1518 async_wake_up( fd->write_q, STATUS_VOLUME_DISMOUNTED );
1520 if (fd->poll_index != -1) set_fd_events( fd, -1 );
1522 if (fd->unix_fd != -1) close( fd->unix_fd );
1525 fd->no_fd_status = STATUS_VOLUME_DISMOUNTED;
1526 fd->closed->unix_fd = -1;
1527 fd->closed->unlink[0] = 0;
1529 /* stop using Unix locks on this fd (existing locks have been removed by close) */
1533 /* allocate an fd object, without setting the unix fd yet */
1534 static struct fd *alloc_fd_object(void)
1536 struct fd *fd = alloc_object( &fd_ops );
1538 if (!fd) return NULL;
1548 fd->unix_name = NULL;
1551 fd->poll_index = -1;
1555 fd->completion = NULL;
1556 list_init( &fd->inode_entry );
1557 list_init( &fd->locks );
1559 if ((fd->poll_index = add_poll_user( fd )) == -1)
1561 release_object( fd );
1567 /* allocate a pseudo fd object, for objects that need to behave like files but don't have a unix fd */
1568 struct fd *alloc_pseudo_fd( const struct fd_ops *fd_user_ops, struct object *user, unsigned int options )
1570 struct fd *fd = alloc_object( &fd_ops );
1572 if (!fd) return NULL;
1574 fd->fd_ops = fd_user_ops;
1579 fd->options = options;
1581 fd->unix_name = NULL;
1585 fd->poll_index = -1;
1589 fd->completion = NULL;
1590 fd->no_fd_status = STATUS_BAD_DEVICE_TYPE;
1591 list_init( &fd->inode_entry );
1592 list_init( &fd->locks );
1596 /* duplicate an fd object for a different user */
1597 struct fd *dup_fd_object( struct fd *orig, unsigned int access, unsigned int sharing, unsigned int options )
1599 struct fd *fd = alloc_object( &fd_ops );
1601 if (!fd) return NULL;
1607 fd->access = access;
1608 fd->options = options;
1609 fd->sharing = sharing;
1613 fd->poll_index = -1;
1617 fd->completion = NULL;
1618 list_init( &fd->inode_entry );
1619 list_init( &fd->locks );
1621 if (!(fd->unix_name = mem_alloc( strlen(orig->unix_name) + 1 ))) goto failed;
1622 strcpy( fd->unix_name, orig->unix_name );
1623 if ((fd->poll_index = add_poll_user( fd )) == -1) goto failed;
1627 struct closed_fd *closed = mem_alloc( sizeof(*closed) );
1628 if (!closed) goto failed;
1629 if ((fd->unix_fd = dup( orig->unix_fd )) == -1)
1635 closed->unix_fd = fd->unix_fd;
1636 closed->unlink[0] = 0;
1637 fd->closed = closed;
1638 fd->inode = (struct inode *)grab_object( orig->inode );
1639 list_add_head( &fd->inode->open, &fd->inode_entry );
1641 else if ((fd->unix_fd = dup( orig->unix_fd )) == -1)
1649 release_object( fd );
1653 /* set the status to return when the fd has no associated unix fd */
1654 void set_no_fd_status( struct fd *fd, unsigned int status )
1656 fd->no_fd_status = status;
1659 /* check if the desired access is possible without violating */
1660 /* the sharing mode of other opens of the same file */
1661 static unsigned int check_sharing( struct fd *fd, unsigned int access, unsigned int sharing,
1662 unsigned int open_flags, unsigned int options )
1664 unsigned int existing_sharing = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE;
1665 unsigned int existing_access = 0;
1668 fd->access = access;
1669 fd->sharing = sharing;
1671 LIST_FOR_EACH( ptr, &fd->inode->open )
1673 struct fd *fd_ptr = LIST_ENTRY( ptr, struct fd, inode_entry );
1676 /* if access mode is 0, sharing mode is ignored */
1677 if (fd_ptr->access) existing_sharing &= fd_ptr->sharing;
1678 existing_access |= fd_ptr->access;
1682 if (((access & FILE_UNIX_READ_ACCESS) && !(existing_sharing & FILE_SHARE_READ)) ||
1683 ((access & FILE_UNIX_WRITE_ACCESS) && !(existing_sharing & FILE_SHARE_WRITE)) ||
1684 ((access & DELETE) && !(existing_sharing & FILE_SHARE_DELETE)))
1685 return STATUS_SHARING_VIOLATION;
1686 if (((existing_access & FILE_MAPPING_WRITE) && !(sharing & FILE_SHARE_WRITE)) ||
1687 ((existing_access & FILE_MAPPING_IMAGE) && (access & FILE_SHARE_WRITE)))
1688 return STATUS_SHARING_VIOLATION;
1689 if ((existing_access & FILE_MAPPING_IMAGE) && (options & FILE_DELETE_ON_CLOSE))
1690 return STATUS_CANNOT_DELETE;
1691 if ((existing_access & FILE_MAPPING_ACCESS) && (open_flags & O_TRUNC))
1692 return STATUS_USER_MAPPED_FILE;
1693 if (!access) return 0; /* if access mode is 0, sharing mode is ignored (except for mappings) */
1694 if (((existing_access & FILE_UNIX_READ_ACCESS) && !(sharing & FILE_SHARE_READ)) ||
1695 ((existing_access & FILE_UNIX_WRITE_ACCESS) && !(sharing & FILE_SHARE_WRITE)) ||
1696 ((existing_access & DELETE) && !(sharing & FILE_SHARE_DELETE)))
1697 return STATUS_SHARING_VIOLATION;
1701 /* sets the user of an fd that previously had no user */
1702 void set_fd_user( struct fd *fd, const struct fd_ops *user_ops, struct object *user )
1704 assert( fd->fd_ops == NULL );
1705 fd->fd_ops = user_ops;
1709 static char *dup_fd_name( struct fd *root, const char *name )
1713 if (!root) return strdup( name );
1714 if (!root->unix_name) return NULL;
1717 if (name[0] == '.' && (!name[1] || name[1] == '/')) name++;
1719 if ((ret = malloc( strlen(root->unix_name) + strlen(name) + 2 )))
1721 strcpy( ret, root->unix_name );
1722 if (name[0] && name[0] != '/') strcat( ret, "/" );
1723 strcat( ret, name );
1728 /* open() wrapper that returns a struct fd with no fd user set */
1729 struct fd *open_fd( struct fd *root, const char *name, int flags, mode_t *mode, unsigned int access,
1730 unsigned int sharing, unsigned int options )
1733 struct closed_fd *closed_fd;
1735 const char *unlink_name = "";
1739 if (((options & FILE_DELETE_ON_CLOSE) && !(access & DELETE)) ||
1740 ((options & FILE_DIRECTORY_FILE) && (flags & O_TRUNC)))
1742 set_error( STATUS_INVALID_PARAMETER );
1746 if (!(fd = alloc_fd_object())) return NULL;
1748 fd->options = options;
1749 if (options & FILE_DELETE_ON_CLOSE) unlink_name = name;
1750 if (!(closed_fd = mem_alloc( sizeof(*closed_fd) + strlen(unlink_name) )))
1752 release_object( fd );
1758 if ((root_fd = get_unix_fd( root )) == -1) goto error;
1759 if (fchdir( root_fd ) == -1)
1767 /* create the directory if needed */
1768 if ((options & FILE_DIRECTORY_FILE) && (flags & O_CREAT))
1770 if (mkdir( name, 0777 ) == -1)
1772 if (errno != EEXIST || (flags & O_EXCL))
1778 flags &= ~(O_CREAT | O_EXCL | O_TRUNC);
1781 if ((access & FILE_UNIX_WRITE_ACCESS) && !(options & FILE_DIRECTORY_FILE))
1783 if (access & FILE_UNIX_READ_ACCESS) rw_mode = O_RDWR;
1784 else rw_mode = O_WRONLY;
1786 else rw_mode = O_RDONLY;
1788 fd->unix_name = dup_fd_name( root, name );
1790 if ((fd->unix_fd = open( name, rw_mode | (flags & ~O_TRUNC), *mode )) == -1)
1792 /* if we tried to open a directory for write access, retry read-only */
1793 if (errno == EISDIR)
1795 if ((access & FILE_UNIX_WRITE_ACCESS) || (flags & O_CREAT))
1796 fd->unix_fd = open( name, O_RDONLY | (flags & ~(O_TRUNC | O_CREAT | O_EXCL)), *mode );
1799 if (fd->unix_fd == -1)
1806 closed_fd->unix_fd = fd->unix_fd;
1807 closed_fd->unlink[0] = 0;
1808 fstat( fd->unix_fd, &st );
1811 /* only bother with an inode for normal files and directories */
1812 if (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode))
1815 struct inode *inode = get_inode( st.st_dev, st.st_ino, fd->unix_fd );
1819 /* we can close the fd because there are no others open on the same file,
1820 * otherwise we wouldn't have failed to allocate a new inode
1825 fd->closed = closed_fd;
1826 list_add_head( &inode->open, &fd->inode_entry );
1828 /* check directory options */
1829 if ((options & FILE_DIRECTORY_FILE) && !S_ISDIR(st.st_mode))
1831 release_object( fd );
1832 set_error( STATUS_NOT_A_DIRECTORY );
1835 if ((options & FILE_NON_DIRECTORY_FILE) && S_ISDIR(st.st_mode))
1837 release_object( fd );
1838 set_error( STATUS_FILE_IS_A_DIRECTORY );
1841 if ((err = check_sharing( fd, access, sharing, flags, options )))
1843 release_object( fd );
1847 strcpy( closed_fd->unlink, unlink_name );
1848 if (flags & O_TRUNC)
1850 if (S_ISDIR(st.st_mode))
1852 release_object( fd );
1853 set_error( STATUS_OBJECT_NAME_COLLISION );
1856 ftruncate( fd->unix_fd, 0 );
1859 else /* special file */
1861 if (options & FILE_DIRECTORY_FILE)
1863 set_error( STATUS_NOT_A_DIRECTORY );
1866 if (unlink_name[0]) /* we can't unlink special files */
1868 set_error( STATUS_INVALID_PARAMETER );
1876 release_object( fd );
1878 if (root_fd != -1) fchdir( server_dir_fd ); /* go back to the server dir */
1882 /* create an fd for an anonymous file */
1883 /* if the function fails the unix fd is closed */
1884 struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops, int unix_fd, struct object *user,
1885 unsigned int options )
1887 struct fd *fd = alloc_fd_object();
1891 set_fd_user( fd, fd_user_ops, user );
1892 fd->unix_fd = unix_fd;
1893 fd->options = options;
1900 /* retrieve the object that is using an fd */
1901 void *get_fd_user( struct fd *fd )
1906 /* retrieve the opening options for the fd */
1907 unsigned int get_fd_options( struct fd *fd )
1912 /* retrieve the unix fd for an object */
1913 int get_unix_fd( struct fd *fd )
1915 if (fd->unix_fd == -1) set_error( fd->no_fd_status );
1919 /* check if two file descriptors point to the same file */
1920 int is_same_file_fd( struct fd *fd1, struct fd *fd2 )
1922 return fd1->inode == fd2->inode;
1925 /* check if fd is on a removable device */
1926 int is_fd_removable( struct fd *fd )
1928 return (fd->inode && fd->inode->device->removable);
1931 /* set or clear the fd signaled state */
1932 void set_fd_signaled( struct fd *fd, int signaled )
1934 fd->signaled = signaled;
1935 if (signaled) wake_up( fd->user, 0 );
1938 /* set or clear the fd signaled state */
1939 int is_fd_signaled( struct fd *fd )
1941 return fd->signaled;
1944 /* handler for close_handle that refuses to close fd-associated handles in other processes */
1945 int fd_close_handle( struct object *obj, struct process *process, obj_handle_t handle )
1947 return (!current || current->process == process);
1950 /* check if events are pending and if yes return which one(s) */
1951 int check_fd_events( struct fd *fd, int events )
1955 if (fd->unix_fd == -1) return POLLERR;
1956 if (fd->inode) return events; /* regular files are always signaled */
1958 pfd.fd = fd->unix_fd;
1959 pfd.events = events;
1960 if (poll( &pfd, 1, 0 ) <= 0) return 0;
1964 /* default signaled() routine for objects that poll() on an fd */
1965 int default_fd_signaled( struct object *obj, struct thread *thread )
1967 struct fd *fd = get_obj_fd( obj );
1968 int ret = fd->signaled;
1969 release_object( fd );
1973 /* default map_access() routine for objects that behave like an fd */
1974 unsigned int default_fd_map_access( struct object *obj, unsigned int access )
1976 if (access & GENERIC_READ) access |= FILE_GENERIC_READ;
1977 if (access & GENERIC_WRITE) access |= FILE_GENERIC_WRITE;
1978 if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
1979 if (access & GENERIC_ALL) access |= FILE_ALL_ACCESS;
1980 return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
1983 int default_fd_get_poll_events( struct fd *fd )
1987 if (async_waiting( fd->read_q )) events |= POLLIN;
1988 if (async_waiting( fd->write_q )) events |= POLLOUT;
1992 /* default handler for poll() events */
1993 void default_poll_event( struct fd *fd, int event )
1995 if (event & (POLLIN | POLLERR | POLLHUP)) async_wake_up( fd->read_q, STATUS_ALERTED );
1996 if (event & (POLLOUT | POLLERR | POLLHUP)) async_wake_up( fd->write_q, STATUS_ALERTED );
1998 /* if an error occurred, stop polling this fd to avoid busy-looping */
1999 if (event & (POLLERR | POLLHUP)) set_fd_events( fd, -1 );
2000 else if (!fd->inode) set_fd_events( fd, fd->fd_ops->get_poll_events( fd ) );
2003 struct async *fd_queue_async( struct fd *fd, const async_data_t *data, int type )
2005 struct async_queue *queue;
2006 struct async *async;
2010 case ASYNC_TYPE_READ:
2011 if (!fd->read_q && !(fd->read_q = create_async_queue( fd ))) return NULL;
2014 case ASYNC_TYPE_WRITE:
2015 if (!fd->write_q && !(fd->write_q = create_async_queue( fd ))) return NULL;
2016 queue = fd->write_q;
2018 case ASYNC_TYPE_WAIT:
2019 if (!fd->wait_q && !(fd->wait_q = create_async_queue( fd ))) return NULL;
2027 if ((async = create_async( current, queue, data )) && type != ASYNC_TYPE_WAIT)
2030 set_fd_events( fd, fd->fd_ops->get_poll_events( fd ) );
2031 else /* regular files are always ready for read and write */
2032 async_wake_up( queue, STATUS_ALERTED );
2037 void fd_async_wake_up( struct fd *fd, int type, unsigned int status )
2041 case ASYNC_TYPE_READ:
2042 async_wake_up( fd->read_q, status );
2044 case ASYNC_TYPE_WRITE:
2045 async_wake_up( fd->write_q, status );
2047 case ASYNC_TYPE_WAIT:
2048 async_wake_up( fd->wait_q, status );
2055 void fd_reselect_async( struct fd *fd, struct async_queue *queue )
2057 fd->fd_ops->reselect_async( fd, queue );
2060 void no_fd_queue_async( struct fd *fd, const async_data_t *data, int type, int count )
2062 set_error( STATUS_OBJECT_TYPE_MISMATCH );
2065 void default_fd_queue_async( struct fd *fd, const async_data_t *data, int type, int count )
2067 struct async *async;
2069 if ((async = fd_queue_async( fd, data, type )))
2071 release_object( async );
2072 set_error( STATUS_PENDING );
2076 /* default reselect_async() fd routine */
2077 void default_fd_reselect_async( struct fd *fd, struct async_queue *queue )
2079 if (queue != fd->wait_q)
2081 int poll_events = fd->fd_ops->get_poll_events( fd );
2082 int events = check_fd_events( fd, poll_events );
2083 if (events) fd->fd_ops->poll_event( fd, events );
2084 else set_fd_events( fd, poll_events );
2088 /* default cancel_async() fd routine */
2089 void default_fd_cancel_async( struct fd *fd, struct process *process, struct thread *thread, client_ptr_t iosb )
2093 n += async_wake_up_by( fd->read_q, process, thread, iosb, STATUS_CANCELLED );
2094 n += async_wake_up_by( fd->write_q, process, thread, iosb, STATUS_CANCELLED );
2095 n += async_wake_up_by( fd->wait_q, process, thread, iosb, STATUS_CANCELLED );
2097 set_error( STATUS_NOT_FOUND );
2100 /* default flush() routine */
2101 void no_flush( struct fd *fd, struct event **event )
2103 set_error( STATUS_OBJECT_TYPE_MISMATCH );
2106 static inline int is_valid_mounted_device( struct stat *st )
2108 #if defined(linux) || defined(__sun__)
2109 return S_ISBLK( st->st_mode );
2111 /* disks are char devices on *BSD */
2112 return S_ISCHR( st->st_mode );
2116 /* close all Unix file descriptors on a device to allow unmounting it */
2117 static void unmount_device( struct fd *device_fd )
2121 struct device *device;
2122 struct inode *inode;
2124 int unix_fd = get_unix_fd( device_fd );
2126 if (unix_fd == -1) return;
2128 if (fstat( unix_fd, &st ) == -1 || !is_valid_mounted_device( &st ))
2130 set_error( STATUS_INVALID_PARAMETER );
2134 if (!(device = get_device( st.st_rdev, -1 ))) return;
2136 for (i = 0; i < INODE_HASH_SIZE; i++)
2138 LIST_FOR_EACH_ENTRY( inode, &device->inode_hash[i], struct inode, entry )
2140 LIST_FOR_EACH_ENTRY( fd, &inode->open, struct fd, inode_entry )
2144 inode_close_pending( inode, 0 );
2147 /* remove it from the hash table */
2148 list_remove( &device->entry );
2149 list_init( &device->entry );
2150 release_object( device );
2153 obj_handle_t no_fd_ioctl( struct fd *fd, ioctl_code_t code, const async_data_t *async,
2154 int blocking, const void *data, data_size_t size )
2156 set_error( STATUS_OBJECT_TYPE_MISMATCH );
2160 /* default ioctl() routine */
2161 obj_handle_t default_fd_ioctl( struct fd *fd, ioctl_code_t code, const async_data_t *async,
2162 int blocking, const void *data, data_size_t size )
2166 case FSCTL_DISMOUNT_VOLUME:
2167 unmount_device( fd );
2170 set_error( STATUS_NOT_SUPPORTED );
2175 /* same as get_handle_obj but retrieve the struct fd associated to the object */
2176 static struct fd *get_handle_fd_obj( struct process *process, obj_handle_t handle,
2177 unsigned int access )
2179 struct fd *fd = NULL;
2182 if ((obj = get_handle_obj( process, handle, access, NULL )))
2184 fd = get_obj_fd( obj );
2185 release_object( obj );
2190 struct completion *fd_get_completion( struct fd *fd, apc_param_t *p_key )
2192 *p_key = fd->comp_key;
2193 return fd->completion ? (struct completion *)grab_object( fd->completion ) : NULL;
2196 void fd_copy_completion( struct fd *src, struct fd *dst )
2198 assert( !dst->completion );
2199 dst->completion = fd_get_completion( src, &dst->comp_key );
2202 /* flush a file buffers */
2203 DECL_HANDLER(flush_file)
2205 struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
2206 struct event * event = NULL;
2210 fd->fd_ops->flush( fd, &event );
2213 reply->event = alloc_handle( current->process, event, SYNCHRONIZE, 0 );
2215 release_object( fd );
2219 /* open a file object */
2220 DECL_HANDLER(open_file_object)
2222 struct unicode_str name;
2223 struct directory *root = NULL;
2224 struct object *obj, *result;
2226 get_req_unicode_str( &name );
2227 if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
2230 if ((obj = open_object_dir( root, &name, req->attributes, NULL )))
2232 if ((result = obj->ops->open_file( obj, req->access, req->sharing, req->options )))
2234 reply->handle = alloc_handle( current->process, result, req->access, req->attributes );
2235 release_object( result );
2237 release_object( obj );
2240 if (root) release_object( root );
2243 /* get the Unix name from a file handle */
2244 DECL_HANDLER(get_handle_unix_name)
2248 if ((fd = get_handle_fd_obj( current->process, req->handle, 0 )))
2252 data_size_t name_len = strlen( fd->unix_name );
2253 reply->name_len = name_len;
2254 if (name_len <= get_reply_max_size()) set_reply_data( fd->unix_name, name_len );
2255 else set_error( STATUS_BUFFER_OVERFLOW );
2257 release_object( fd );
2261 /* get a Unix fd to access a file */
2262 DECL_HANDLER(get_handle_fd)
2266 if ((fd = get_handle_fd_obj( current->process, req->handle, 0 )))
2268 int unix_fd = get_unix_fd( fd );
2271 reply->type = fd->fd_ops->get_fd_type( fd );
2272 reply->removable = is_fd_removable(fd);
2273 reply->options = fd->options;
2274 reply->access = get_handle_access( current->process, req->handle );
2275 send_client_fd( current->process, unix_fd, req->handle );
2277 release_object( fd );
2281 /* perform an ioctl on a file */
2284 unsigned int access = (req->code >> 14) & (FILE_READ_DATA|FILE_WRITE_DATA);
2285 struct fd *fd = get_handle_fd_obj( current->process, req->async.handle, access );
2289 reply->wait = fd->fd_ops->ioctl( fd, req->code, &req->async, req->blocking,
2290 get_req_data(), get_req_data_size() );
2291 reply->options = fd->options;
2292 release_object( fd );
2296 /* create / reschedule an async I/O */
2297 DECL_HANDLER(register_async)
2299 unsigned int access;
2304 case ASYNC_TYPE_READ:
2305 access = FILE_READ_DATA;
2307 case ASYNC_TYPE_WRITE:
2308 access = FILE_WRITE_DATA;
2311 set_error( STATUS_INVALID_PARAMETER );
2315 if ((fd = get_handle_fd_obj( current->process, req->async.handle, access )))
2317 if (get_unix_fd( fd ) != -1) fd->fd_ops->queue_async( fd, &req->async, req->type, req->count );
2318 release_object( fd );
2322 /* cancels all async I/O */
2323 DECL_HANDLER(cancel_async)
2325 struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
2326 struct thread *thread = req->only_thread ? current : NULL;
2330 if (get_unix_fd( fd ) != -1) fd->fd_ops->cancel_async( fd, current->process, thread, req->iosb );
2331 release_object( fd );
2335 /* attach completion object to a fd */
2336 DECL_HANDLER(set_completion_info)
2338 struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
2342 if (!(fd->options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT)) && !fd->completion)
2344 fd->completion = get_completion_obj( current->process, req->chandle, IO_COMPLETION_MODIFY_STATE );
2345 fd->comp_key = req->ckey;
2347 else set_error( STATUS_INVALID_PARAMETER );
2348 release_object( fd );
2352 /* push new completion msg into a completion queue attached to the fd */
2353 DECL_HANDLER(add_fd_completion)
2355 struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
2359 add_completion( fd->completion, fd->comp_key, req->cvalue, req->status, req->information );
2360 release_object( fd );