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>
49 #ifdef HAVE_SYS_PARAM_H
50 #include <sys/param.h>
52 #ifdef HAVE_SYS_MOUNT_H
53 #include <sys/mount.h>
55 #ifdef HAVE_SYS_STATFS_H
56 #include <sys/statfs.h>
58 #ifdef HAVE_SYS_SYSCTL_H
59 #include <sys/sysctl.h>
61 #ifdef HAVE_SYS_EVENT_H
62 #include <sys/event.h>
71 #include <sys/types.h>
75 #define WIN32_NO_STATUS
85 #if defined(HAVE_SYS_EPOLL_H) && defined(HAVE_EPOLL_CREATE)
86 # include <sys/epoll.h>
88 #elif defined(linux) && defined(__i386__) && defined(HAVE_STDINT_H)
90 # define EPOLLIN POLLIN
91 # define EPOLLOUT POLLOUT
92 # define EPOLLERR POLLERR
93 # define EPOLLHUP POLLHUP
94 # define EPOLL_CTL_ADD 1
95 # define EPOLL_CTL_DEL 2
96 # define EPOLL_CTL_MOD 3
98 typedef union epoll_data
112 #define SYSCALL_RET(ret) do { \
113 if (ret < 0) { errno = -ret; ret = -1; } \
117 static inline int epoll_create( int size
)
120 __asm__( "pushl %%ebx; movl %2,%%ebx; int $0x80; popl %%ebx"
121 : "=a" (ret
) : "0" (254 /*NR_epoll_create*/), "r" (size
) );
125 static inline int epoll_ctl( int epfd
, int op
, int fd
, const struct epoll_event
*event
)
128 __asm__( "pushl %%ebx; movl %2,%%ebx; int $0x80; popl %%ebx"
130 : "0" (255 /*NR_epoll_ctl*/), "r" (epfd
), "c" (op
), "d" (fd
), "S" (event
), "m" (*event
) );
134 static inline int epoll_wait( int epfd
, struct epoll_event
*events
, int maxevents
, int timeout
)
137 __asm__( "pushl %%ebx; movl %2,%%ebx; int $0x80; popl %%ebx"
139 : "0" (256 /*NR_epoll_wait*/), "r" (epfd
), "c" (events
), "d" (maxevents
), "S" (timeout
)
145 #endif /* linux && __i386__ && HAVE_STDINT_H */
148 /* Because of the stupid Posix locking semantics, we need to keep
149 * track of all file descriptors referencing a given file, and not
150 * close a single one until all the locks are gone (sigh).
153 /* file descriptor object */
155 /* closed_fd is used to keep track of the unix fd belonging to a closed fd object */
158 struct list entry
; /* entry in inode closed list */
159 int unix_fd
; /* the unix file descriptor */
160 char unlink
[1]; /* name to unlink on close (if any) */
165 struct object obj
; /* object header */
166 const struct fd_ops
*fd_ops
; /* file descriptor operations */
167 struct inode
*inode
; /* inode that this fd belongs to */
168 struct list inode_entry
; /* entry in inode fd list */
169 struct closed_fd
*closed
; /* structure to store the unix fd at destroy time */
170 struct object
*user
; /* object using this file descriptor */
171 struct list locks
; /* list of locks on this fd */
172 unsigned int access
; /* file access (FILE_READ_DATA etc.) */
173 unsigned int options
; /* file options (FILE_DELETE_ON_CLOSE, FILE_SYNCHRONOUS...) */
174 unsigned int sharing
; /* file sharing mode */
175 int unix_fd
; /* unix file descriptor */
176 unsigned int no_fd_status
;/* status to return when unix_fd is -1 */
177 int signaled
:1; /* is the fd signaled? */
178 int fs_locks
:1; /* can we use filesystem locks for this fd? */
179 int poll_index
; /* index of fd in poll array */
180 struct async_queue
*read_q
; /* async readers of this fd */
181 struct async_queue
*write_q
; /* async writers of this fd */
182 struct async_queue
*wait_q
; /* other async waiters of this fd */
185 static void fd_dump( struct object
*obj
, int verbose
);
186 static void fd_destroy( struct object
*obj
);
188 static const struct object_ops fd_ops
=
190 sizeof(struct fd
), /* size */
192 no_add_queue
, /* add_queue */
193 NULL
, /* remove_queue */
195 NULL
, /* satisfied */
196 no_signal
, /* signal */
197 no_get_fd
, /* get_fd */
198 no_map_access
, /* map_access */
199 no_lookup_name
, /* lookup_name */
200 no_open_file
, /* open_file */
201 no_close_handle
, /* close_handle */
202 fd_destroy
/* destroy */
207 #define DEVICE_HASH_SIZE 7
208 #define INODE_HASH_SIZE 17
212 struct object obj
; /* object header */
213 struct list entry
; /* entry in device hash list */
214 dev_t dev
; /* device number */
215 int removable
; /* removable device? (or -1 if unknown) */
216 struct list inode_hash
[INODE_HASH_SIZE
]; /* inodes hash table */
219 static void device_dump( struct object
*obj
, int verbose
);
220 static void device_destroy( struct object
*obj
);
222 static const struct object_ops device_ops
=
224 sizeof(struct device
), /* size */
225 device_dump
, /* dump */
226 no_add_queue
, /* add_queue */
227 NULL
, /* remove_queue */
229 NULL
, /* satisfied */
230 no_signal
, /* signal */
231 no_get_fd
, /* get_fd */
232 no_map_access
, /* map_access */
233 no_lookup_name
, /* lookup_name */
234 no_open_file
, /* open_file */
235 no_close_handle
, /* close_handle */
236 device_destroy
/* destroy */
243 struct object obj
; /* object header */
244 struct list entry
; /* inode hash list entry */
245 struct device
*device
; /* device containing this inode */
246 ino_t ino
; /* inode number */
247 struct list open
; /* list of open file descriptors */
248 struct list locks
; /* list of file locks */
249 struct list closed
; /* list of file descriptors to close at destroy time */
252 static void inode_dump( struct object
*obj
, int verbose
);
253 static void inode_destroy( struct object
*obj
);
255 static const struct object_ops inode_ops
=
257 sizeof(struct inode
), /* size */
258 inode_dump
, /* dump */
259 no_add_queue
, /* add_queue */
260 NULL
, /* remove_queue */
262 NULL
, /* satisfied */
263 no_signal
, /* signal */
264 no_get_fd
, /* get_fd */
265 no_map_access
, /* map_access */
266 no_lookup_name
, /* lookup_name */
267 no_open_file
, /* open_file */
268 no_close_handle
, /* close_handle */
269 inode_destroy
/* destroy */
272 /* file lock object */
276 struct object obj
; /* object header */
277 struct fd
*fd
; /* fd owning this lock */
278 struct list fd_entry
; /* entry in list of locks on a given fd */
279 struct list inode_entry
; /* entry in inode list of locks */
280 int shared
; /* shared lock? */
281 file_pos_t start
; /* locked region is interval [start;end) */
283 struct process
*process
; /* process owning this lock */
284 struct list proc_entry
; /* entry in list of locks owned by the process */
287 static void file_lock_dump( struct object
*obj
, int verbose
);
288 static int file_lock_signaled( struct object
*obj
, struct thread
*thread
);
290 static const struct object_ops file_lock_ops
=
292 sizeof(struct file_lock
), /* size */
293 file_lock_dump
, /* dump */
294 add_queue
, /* add_queue */
295 remove_queue
, /* remove_queue */
296 file_lock_signaled
, /* signaled */
297 no_satisfied
, /* satisfied */
298 no_signal
, /* signal */
299 no_get_fd
, /* get_fd */
300 no_map_access
, /* map_access */
301 no_lookup_name
, /* lookup_name */
302 no_open_file
, /* open_file */
303 no_close_handle
, /* close_handle */
304 no_destroy
/* destroy */
308 #define OFF_T_MAX (~((file_pos_t)1 << (8*sizeof(off_t)-1)))
309 #define FILE_POS_T_MAX (~(file_pos_t)0)
311 static file_pos_t max_unix_offset
= OFF_T_MAX
;
313 #define DUMP_LONG_LONG(val) do { \
314 if (sizeof(val) > sizeof(unsigned long) && (val) > ~0UL) \
315 fprintf( stderr, "%lx%08lx", (unsigned long)((unsigned long long)(val) >> 32), (unsigned long)(val) ); \
317 fprintf( stderr, "%lx", (unsigned long)(val) ); \
322 /****************************************************************/
323 /* timeouts support */
327 struct list entry
; /* entry in sorted timeout list */
328 timeout_t when
; /* timeout expiry (absolute time) */
329 timeout_callback callback
; /* callback function */
330 void *private; /* callback private data */
333 static struct list timeout_list
= LIST_INIT(timeout_list
); /* sorted timeouts list */
334 timeout_t current_time
;
336 static inline void set_current_time(void)
338 static const timeout_t ticks_1601_to_1970
= (timeout_t
)86400 * (369 * 365 + 89) * TICKS_PER_SEC
;
340 gettimeofday( &now
, NULL
);
341 current_time
= (timeout_t
)now
.tv_sec
* TICKS_PER_SEC
+ now
.tv_usec
* 10 + ticks_1601_to_1970
;
344 /* add a timeout user */
345 struct timeout_user
*add_timeout_user( timeout_t when
, timeout_callback func
, void *private )
347 struct timeout_user
*user
;
350 if (!(user
= mem_alloc( sizeof(*user
) ))) return NULL
;
351 user
->when
= (when
> 0) ? when
: current_time
- when
;
352 user
->callback
= func
;
353 user
->private = private;
355 /* Now insert it in the linked list */
357 LIST_FOR_EACH( ptr
, &timeout_list
)
359 struct timeout_user
*timeout
= LIST_ENTRY( ptr
, struct timeout_user
, entry
);
360 if (timeout
->when
>= user
->when
) break;
362 list_add_before( ptr
, &user
->entry
);
366 /* remove a timeout user */
367 void remove_timeout_user( struct timeout_user
*user
)
369 list_remove( &user
->entry
);
373 /* return a text description of a timeout for debugging purposes */
374 const char *get_timeout_str( timeout_t timeout
)
376 static char buffer
[64];
379 if (!timeout
) return "0";
380 if (timeout
== TIMEOUT_INFINITE
) return "infinite";
382 if (timeout
< 0) /* relative */
384 secs
= -timeout
/ TICKS_PER_SEC
;
385 nsecs
= -timeout
% TICKS_PER_SEC
;
386 sprintf( buffer
, "+%ld.%07ld", secs
, nsecs
);
390 secs
= (timeout
- current_time
) / TICKS_PER_SEC
;
391 nsecs
= (timeout
- current_time
) % TICKS_PER_SEC
;
394 nsecs
+= TICKS_PER_SEC
;
398 sprintf( buffer
, "%x%08x (+%ld.%07ld)",
399 (unsigned int)(timeout
>> 32), (unsigned int)timeout
, secs
, nsecs
);
401 sprintf( buffer
, "%x%08x (-%ld.%07ld)",
402 (unsigned int)(timeout
>> 32), (unsigned int)timeout
,
403 -(secs
+ 1), TICKS_PER_SEC
- nsecs
);
409 /****************************************************************/
412 static struct fd
**poll_users
; /* users array */
413 static struct pollfd
*pollfd
; /* poll fd array */
414 static int nb_users
; /* count of array entries actually in use */
415 static int active_users
; /* current number of active users */
416 static int allocated_users
; /* count of allocated entries in the array */
417 static struct fd
**freelist
; /* list of free entries in the array */
419 static int get_next_timeout(void);
423 static int epoll_fd
= -1;
425 static inline void init_epoll(void)
427 epoll_fd
= epoll_create( 128 );
430 /* set the events that epoll waits for on this fd; helper for set_fd_events */
431 static inline void set_fd_epoll_events( struct fd
*fd
, int user
, int events
)
433 struct epoll_event ev
;
436 if (epoll_fd
== -1) return;
438 if (events
== -1) /* stop waiting on this fd completely */
440 if (pollfd
[user
].fd
== -1) return; /* already removed */
443 else if (pollfd
[user
].fd
== -1)
445 if (pollfd
[user
].events
) return; /* stopped waiting on it, don't restart */
450 if (pollfd
[user
].events
== events
) return; /* nothing to do */
455 memset(&ev
.data
, 0, sizeof(ev
.data
));
458 if (epoll_ctl( epoll_fd
, ctl
, fd
->unix_fd
, &ev
) == -1)
460 if (errno
== ENOMEM
) /* not enough memory, give up on epoll */
465 else perror( "epoll_ctl" ); /* should not happen */
469 static inline void remove_epoll_user( struct fd
*fd
, int user
)
471 if (epoll_fd
== -1) return;
473 if (pollfd
[user
].fd
!= -1)
475 struct epoll_event dummy
;
476 epoll_ctl( epoll_fd
, EPOLL_CTL_DEL
, fd
->unix_fd
, &dummy
);
480 static inline void main_loop_epoll(void)
483 struct epoll_event events
[128];
485 assert( POLLIN
== EPOLLIN
);
486 assert( POLLOUT
== EPOLLOUT
);
487 assert( POLLERR
== EPOLLERR
);
488 assert( POLLHUP
== EPOLLHUP
);
490 if (epoll_fd
== -1) return;
494 timeout
= get_next_timeout();
496 if (!active_users
) break; /* last user removed by a timeout */
497 if (epoll_fd
== -1) break; /* an error occurred with epoll */
499 ret
= epoll_wait( epoll_fd
, events
, sizeof(events
)/sizeof(events
[0]), timeout
);
502 /* put the events into the pollfd array first, like poll does */
503 for (i
= 0; i
< ret
; i
++)
505 int user
= events
[i
].data
.u32
;
506 pollfd
[user
].revents
= events
[i
].events
;
509 /* read events from the pollfd array, as set_fd_events may modify them */
510 for (i
= 0; i
< ret
; i
++)
512 int user
= events
[i
].data
.u32
;
513 if (pollfd
[user
].revents
) fd_poll_event( poll_users
[user
], pollfd
[user
].revents
);
518 #elif defined(HAVE_KQUEUE)
520 static int kqueue_fd
= -1;
522 static inline void init_epoll(void)
524 #ifdef __APPLE__ /* kqueue support is broken in Mac OS < 10.5 */
527 size_t len
= sizeof(release
);
530 mib
[1] = KERN_OSRELEASE
;
531 if (sysctl( mib
, 2, release
, &len
, NULL
, 0 ) == -1) return;
532 if (atoi(release
) < 9) return;
534 kqueue_fd
= kqueue();
537 static inline void set_fd_epoll_events( struct fd
*fd
, int user
, int events
)
541 if (kqueue_fd
== -1) return;
543 EV_SET( &ev
[0], fd
->unix_fd
, EVFILT_READ
, 0, NOTE_LOWAT
, 1, (void *)user
);
544 EV_SET( &ev
[1], fd
->unix_fd
, EVFILT_WRITE
, 0, NOTE_LOWAT
, 1, (void *)user
);
546 if (events
== -1) /* stop waiting on this fd completely */
548 if (pollfd
[user
].fd
== -1) return; /* already removed */
549 ev
[0].flags
|= EV_DELETE
;
550 ev
[1].flags
|= EV_DELETE
;
552 else if (pollfd
[user
].fd
== -1)
554 if (pollfd
[user
].events
) return; /* stopped waiting on it, don't restart */
555 ev
[0].flags
|= EV_ADD
| ((events
& POLLIN
) ? EV_ENABLE
: EV_DISABLE
);
556 ev
[1].flags
|= EV_ADD
| ((events
& POLLOUT
) ? EV_ENABLE
: EV_DISABLE
);
560 if (pollfd
[user
].events
== events
) return; /* nothing to do */
561 ev
[0].flags
|= (events
& POLLIN
) ? EV_ENABLE
: EV_DISABLE
;
562 ev
[1].flags
|= (events
& POLLOUT
) ? EV_ENABLE
: EV_DISABLE
;
565 if (kevent( kqueue_fd
, ev
, 2, NULL
, 0, NULL
) == -1)
567 if (errno
== ENOMEM
) /* not enough memory, give up on kqueue */
572 else perror( "kevent" ); /* should not happen */
576 static inline void remove_epoll_user( struct fd
*fd
, int user
)
578 if (kqueue_fd
== -1) return;
580 if (pollfd
[user
].fd
!= -1)
584 EV_SET( &ev
[0], fd
->unix_fd
, EVFILT_READ
, EV_DELETE
, 0, 0, 0 );
585 EV_SET( &ev
[1], fd
->unix_fd
, EVFILT_WRITE
, EV_DELETE
, 0, 0, 0 );
586 kevent( kqueue_fd
, ev
, 2, NULL
, 0, NULL
);
590 static inline void main_loop_epoll(void)
593 struct kevent events
[128];
595 if (kqueue_fd
== -1) return;
599 timeout
= get_next_timeout();
601 if (!active_users
) break; /* last user removed by a timeout */
602 if (kqueue_fd
== -1) break; /* an error occurred with kqueue */
608 ts
.tv_sec
= timeout
/ 1000;
609 ts
.tv_nsec
= (timeout
% 1000) * 1000000;
610 ret
= kevent( kqueue_fd
, NULL
, 0, events
, sizeof(events
)/sizeof(events
[0]), &ts
);
612 else ret
= kevent( kqueue_fd
, NULL
, 0, events
, sizeof(events
)/sizeof(events
[0]), NULL
);
616 /* put the events into the pollfd array first, like poll does */
617 for (i
= 0; i
< ret
; i
++)
619 long user
= (long)events
[i
].udata
;
620 pollfd
[user
].revents
= 0;
622 for (i
= 0; i
< ret
; i
++)
624 long user
= (long)events
[i
].udata
;
625 if (events
[i
].filter
== EVFILT_READ
) pollfd
[user
].revents
|= POLLIN
;
626 else if (events
[i
].filter
== EVFILT_WRITE
) pollfd
[user
].revents
|= POLLOUT
;
627 if (events
[i
].flags
& EV_EOF
) pollfd
[user
].revents
|= POLLHUP
;
628 if (events
[i
].flags
& EV_ERROR
) pollfd
[user
].revents
|= POLLERR
;
631 /* read events from the pollfd array, as set_fd_events may modify them */
632 for (i
= 0; i
< ret
; i
++)
634 long user
= (long)events
[i
].udata
;
635 if (pollfd
[user
].revents
) fd_poll_event( poll_users
[user
], pollfd
[user
].revents
);
636 pollfd
[user
].revents
= 0;
641 #else /* HAVE_KQUEUE */
643 static inline void init_epoll(void) { }
644 static inline void set_fd_epoll_events( struct fd
*fd
, int user
, int events
) { }
645 static inline void remove_epoll_user( struct fd
*fd
, int user
) { }
646 static inline void main_loop_epoll(void) { }
648 #endif /* USE_EPOLL */
651 /* add a user in the poll array and return its index, or -1 on failure */
652 static int add_poll_user( struct fd
*fd
)
657 ret
= freelist
- poll_users
;
658 freelist
= (struct fd
**)poll_users
[ret
];
662 if (nb_users
== allocated_users
)
664 struct fd
**newusers
;
665 struct pollfd
*newpoll
;
666 int new_count
= allocated_users
? (allocated_users
+ allocated_users
/ 2) : 16;
667 if (!(newusers
= realloc( poll_users
, new_count
* sizeof(*poll_users
) ))) return -1;
668 if (!(newpoll
= realloc( pollfd
, new_count
* sizeof(*pollfd
) )))
671 poll_users
= newusers
;
676 poll_users
= newusers
;
678 if (!allocated_users
) init_epoll();
679 allocated_users
= new_count
;
684 pollfd
[ret
].events
= 0;
685 pollfd
[ret
].revents
= 0;
686 poll_users
[ret
] = fd
;
691 /* remove a user from the poll list */
692 static void remove_poll_user( struct fd
*fd
, int user
)
695 assert( poll_users
[user
] == fd
);
697 remove_epoll_user( fd
, user
);
698 pollfd
[user
].fd
= -1;
699 pollfd
[user
].events
= 0;
700 pollfd
[user
].revents
= 0;
701 poll_users
[user
] = (struct fd
*)freelist
;
702 freelist
= &poll_users
[user
];
706 /* process pending timeouts and return the time until the next timeout, in milliseconds */
707 static int get_next_timeout(void)
709 if (!list_empty( &timeout_list
))
711 struct list expired_list
, *ptr
;
713 /* first remove all expired timers from the list */
715 list_init( &expired_list
);
716 while ((ptr
= list_head( &timeout_list
)) != NULL
)
718 struct timeout_user
*timeout
= LIST_ENTRY( ptr
, struct timeout_user
, entry
);
720 if (timeout
->when
<= current_time
)
722 list_remove( &timeout
->entry
);
723 list_add_tail( &expired_list
, &timeout
->entry
);
728 /* now call the callback for all the removed timers */
730 while ((ptr
= list_head( &expired_list
)) != NULL
)
732 struct timeout_user
*timeout
= LIST_ENTRY( ptr
, struct timeout_user
, entry
);
733 list_remove( &timeout
->entry
);
734 timeout
->callback( timeout
->private );
738 if ((ptr
= list_head( &timeout_list
)) != NULL
)
740 struct timeout_user
*timeout
= LIST_ENTRY( ptr
, struct timeout_user
, entry
);
741 int diff
= (timeout
->when
- current_time
+ 9999) / 10000;
742 if (diff
< 0) diff
= 0;
746 return -1; /* no pending timeouts */
749 /* server main poll() loop */
755 server_start_time
= current_time
;
758 /* fall through to normal poll loop */
762 timeout
= get_next_timeout();
764 if (!active_users
) break; /* last user removed by a timeout */
766 ret
= poll( pollfd
, nb_users
, timeout
);
771 for (i
= 0; i
< nb_users
; i
++)
773 if (pollfd
[i
].revents
)
775 fd_poll_event( poll_users
[i
], pollfd
[i
].revents
);
784 /****************************************************************/
785 /* device functions */
787 static struct list device_hash
[DEVICE_HASH_SIZE
];
789 static int is_device_removable( dev_t dev
, int unix_fd
)
791 #if defined(linux) && defined(HAVE_FSTATFS)
794 /* check for floppy disk */
795 if (major(dev
) == FLOPPY_MAJOR
) return 1;
797 if (fstatfs( unix_fd
, &stfs
) == -1) return 0;
798 return (stfs
.f_type
== 0x9660 || /* iso9660 */
799 stfs
.f_type
== 0x9fa1 || /* supermount */
800 stfs
.f_type
== 0x15013346); /* udf */
801 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__APPLE__)
804 if (fstatfs( unix_fd
, &stfs
) == -1) return 0;
805 return (!strcmp("cd9660", stfs
.f_fstypename
) || !strcmp("udf", stfs
.f_fstypename
));
806 #elif defined(__NetBSD__)
809 if (fstatvfs( unix_fd
, &stfs
) == -1) return 0;
810 return (!strcmp("cd9660", stfs
.f_fstypename
) || !strcmp("udf", stfs
.f_fstypename
));
812 # include <sys/dkio.h>
813 # include <sys/vtoc.h>
814 struct dk_cinfo dkinf
;
815 if (ioctl( unix_fd
, DKIOCINFO
, &dkinf
) == -1) return 0;
816 return (dkinf
.dki_ctype
== DKC_CDROM
||
817 dkinf
.dki_ctype
== DKC_NCRFLOPPY
||
818 dkinf
.dki_ctype
== DKC_SMSFLOPPY
||
819 dkinf
.dki_ctype
== DKC_INTEL82072
||
820 dkinf
.dki_ctype
== DKC_INTEL82077
);
826 /* retrieve the device object for a given fd, creating it if needed */
827 static struct device
*get_device( dev_t dev
, int unix_fd
)
829 struct device
*device
;
830 unsigned int i
, hash
= dev
% DEVICE_HASH_SIZE
;
832 if (device_hash
[hash
].next
)
834 LIST_FOR_EACH_ENTRY( device
, &device_hash
[hash
], struct device
, entry
)
835 if (device
->dev
== dev
) return (struct device
*)grab_object( device
);
837 else list_init( &device_hash
[hash
] );
839 /* not found, create it */
841 if (unix_fd
== -1) return NULL
;
842 if ((device
= alloc_object( &device_ops
)))
845 device
->removable
= is_device_removable( dev
, unix_fd
);
846 for (i
= 0; i
< INODE_HASH_SIZE
; i
++) list_init( &device
->inode_hash
[i
] );
847 list_add_head( &device_hash
[hash
], &device
->entry
);
852 static void device_dump( struct object
*obj
, int verbose
)
854 struct device
*device
= (struct device
*)obj
;
855 fprintf( stderr
, "Device dev=" );
856 DUMP_LONG_LONG( device
->dev
);
857 fprintf( stderr
, "\n" );
860 static void device_destroy( struct object
*obj
)
862 struct device
*device
= (struct device
*)obj
;
865 for (i
= 0; i
< INODE_HASH_SIZE
; i
++)
866 assert( list_empty(&device
->inode_hash
[i
]) );
868 list_remove( &device
->entry
); /* remove it from the hash table */
872 /****************************************************************/
873 /* inode functions */
875 /* close all pending file descriptors in the closed list */
876 static void inode_close_pending( struct inode
*inode
, int keep_unlinks
)
878 struct list
*ptr
= list_head( &inode
->closed
);
882 struct closed_fd
*fd
= LIST_ENTRY( ptr
, struct closed_fd
, entry
);
883 struct list
*next
= list_next( &inode
->closed
, ptr
);
885 if (fd
->unix_fd
!= -1)
887 close( fd
->unix_fd
);
890 if (!keep_unlinks
|| !fd
->unlink
[0]) /* get rid of it unless there's an unlink pending on that file */
899 static void inode_dump( struct object
*obj
, int verbose
)
901 struct inode
*inode
= (struct inode
*)obj
;
902 fprintf( stderr
, "Inode device=%p ino=", inode
->device
);
903 DUMP_LONG_LONG( inode
->ino
);
904 fprintf( stderr
, "\n" );
907 static void inode_destroy( struct object
*obj
)
909 struct inode
*inode
= (struct inode
*)obj
;
912 assert( list_empty(&inode
->open
) );
913 assert( list_empty(&inode
->locks
) );
915 list_remove( &inode
->entry
);
917 while ((ptr
= list_head( &inode
->closed
)))
919 struct closed_fd
*fd
= LIST_ENTRY( ptr
, struct closed_fd
, entry
);
921 if (fd
->unix_fd
!= -1) close( fd
->unix_fd
);
924 /* make sure it is still the same file */
926 if (!stat( fd
->unlink
, &st
) && st
.st_dev
== inode
->device
->dev
&& st
.st_ino
== inode
->ino
)
928 if (S_ISDIR(st
.st_mode
)) rmdir( fd
->unlink
);
929 else unlink( fd
->unlink
);
934 release_object( inode
->device
);
937 /* retrieve the inode object for a given fd, creating it if needed */
938 static struct inode
*get_inode( dev_t dev
, ino_t ino
, int unix_fd
)
940 struct device
*device
;
942 unsigned int hash
= ino
% INODE_HASH_SIZE
;
944 if (!(device
= get_device( dev
, unix_fd
))) return NULL
;
946 LIST_FOR_EACH_ENTRY( inode
, &device
->inode_hash
[hash
], struct inode
, entry
)
948 if (inode
->ino
== ino
)
950 release_object( device
);
951 return (struct inode
*)grab_object( inode
);
955 /* not found, create it */
956 if ((inode
= alloc_object( &inode_ops
)))
958 inode
->device
= device
;
960 list_init( &inode
->open
);
961 list_init( &inode
->locks
);
962 list_init( &inode
->closed
);
963 list_add_head( &device
->inode_hash
[hash
], &inode
->entry
);
965 else release_object( device
);
970 /* add fd to the inode list of file descriptors to close */
971 static void inode_add_closed_fd( struct inode
*inode
, struct closed_fd
*fd
)
973 if (!list_empty( &inode
->locks
))
975 list_add_head( &inode
->closed
, &fd
->entry
);
977 else if (fd
->unlink
[0]) /* close the fd but keep the structure around for unlink */
979 if (fd
->unix_fd
!= -1) close( fd
->unix_fd
);
981 list_add_head( &inode
->closed
, &fd
->entry
);
983 else /* no locks on this inode and no unlink, get rid of the fd */
985 if (fd
->unix_fd
!= -1) close( fd
->unix_fd
);
991 /****************************************************************/
992 /* file lock functions */
994 static void file_lock_dump( struct object
*obj
, int verbose
)
996 struct file_lock
*lock
= (struct file_lock
*)obj
;
997 fprintf( stderr
, "Lock %s fd=%p proc=%p start=",
998 lock
->shared
? "shared" : "excl", lock
->fd
, lock
->process
);
999 DUMP_LONG_LONG( lock
->start
);
1000 fprintf( stderr
, " end=" );
1001 DUMP_LONG_LONG( lock
->end
);
1002 fprintf( stderr
, "\n" );
1005 static int file_lock_signaled( struct object
*obj
, struct thread
*thread
)
1007 struct file_lock
*lock
= (struct file_lock
*)obj
;
1008 /* lock is signaled if it has lost its owner */
1009 return !lock
->process
;
1012 /* set (or remove) a Unix lock if possible for the given range */
1013 static int set_unix_lock( struct fd
*fd
, file_pos_t start
, file_pos_t end
, int type
)
1017 if (!fd
->fs_locks
) return 1; /* no fs locks possible for this fd */
1020 if (start
== end
) return 1; /* can't set zero-byte lock */
1021 if (start
> max_unix_offset
) return 1; /* ignore it */
1023 fl
.l_whence
= SEEK_SET
;
1025 if (!end
|| end
> max_unix_offset
) fl
.l_len
= 0;
1026 else fl
.l_len
= end
- start
;
1027 if (fcntl( fd
->unix_fd
, F_SETLK
, &fl
) != -1) return 1;
1032 /* check whether locks work at all on this file system */
1033 if (fcntl( fd
->unix_fd
, F_GETLK
, &fl
) != -1)
1035 set_error( STATUS_FILE_LOCK_CONFLICT
);
1041 /* no locking on this fs, just ignore it */
1045 set_error( STATUS_FILE_LOCK_CONFLICT
);
1048 /* this can happen if we try to set a write lock on a read-only file */
1049 /* we just ignore that error */
1050 if (fl
.l_type
== F_WRLCK
) return 1;
1051 set_error( STATUS_ACCESS_DENIED
);
1057 /* this can happen if off_t is 64-bit but the kernel only supports 32-bit */
1058 /* in that case we shrink the limit and retry */
1059 if (max_unix_offset
> INT_MAX
)
1061 max_unix_offset
= INT_MAX
;
1072 /* check if interval [start;end) overlaps the lock */
1073 static inline int lock_overlaps( struct file_lock
*lock
, file_pos_t start
, file_pos_t end
)
1075 if (lock
->end
&& start
>= lock
->end
) return 0;
1076 if (end
&& lock
->start
>= end
) return 0;
1080 /* remove Unix locks for all bytes in the specified area that are no longer locked */
1081 static void remove_unix_locks( struct fd
*fd
, file_pos_t start
, file_pos_t end
)
1089 } *first
, *cur
, *next
, *buffer
;
1094 if (!fd
->inode
) return;
1095 if (!fd
->fs_locks
) return;
1096 if (start
== end
|| start
> max_unix_offset
) return;
1097 if (!end
|| end
> max_unix_offset
) end
= max_unix_offset
+ 1;
1099 /* count the number of locks overlapping the specified area */
1101 LIST_FOR_EACH( ptr
, &fd
->inode
->locks
)
1103 struct file_lock
*lock
= LIST_ENTRY( ptr
, struct file_lock
, inode_entry
);
1104 if (lock
->start
== lock
->end
) continue;
1105 if (lock_overlaps( lock
, start
, end
)) count
++;
1108 if (!count
) /* no locks at all, we can unlock everything */
1110 set_unix_lock( fd
, start
, end
, F_UNLCK
);
1114 /* allocate space for the list of holes */
1115 /* max. number of holes is number of locks + 1 */
1117 if (!(buffer
= malloc( sizeof(*buffer
) * (count
+1) ))) return;
1121 first
->start
= start
;
1125 /* build a sorted list of unlocked holes in the specified area */
1127 LIST_FOR_EACH( ptr
, &fd
->inode
->locks
)
1129 struct file_lock
*lock
= LIST_ENTRY( ptr
, struct file_lock
, inode_entry
);
1130 if (lock
->start
== lock
->end
) continue;
1131 if (!lock_overlaps( lock
, start
, end
)) continue;
1133 /* go through all the holes touched by this lock */
1134 for (cur
= first
; cur
; cur
= cur
->next
)
1136 if (cur
->end
<= lock
->start
) continue; /* hole is before start of lock */
1137 if (lock
->end
&& cur
->start
>= lock
->end
) break; /* hole is after end of lock */
1139 /* now we know that lock is overlapping hole */
1141 if (cur
->start
>= lock
->start
) /* lock starts before hole, shrink from start */
1143 cur
->start
= lock
->end
;
1144 if (cur
->start
&& cur
->start
< cur
->end
) break; /* done with this lock */
1145 /* now hole is empty, remove it */
1146 if (cur
->next
) cur
->next
->prev
= cur
->prev
;
1147 if (cur
->prev
) cur
->prev
->next
= cur
->next
;
1148 else if (!(first
= cur
->next
)) goto done
; /* no more holes at all */
1150 else if (!lock
->end
|| cur
->end
<= lock
->end
) /* lock larger than hole, shrink from end */
1152 cur
->end
= lock
->start
;
1153 assert( cur
->start
< cur
->end
);
1155 else /* lock is in the middle of hole, split hole in two */
1158 next
->next
= cur
->next
;
1160 next
->start
= lock
->end
;
1161 next
->end
= cur
->end
;
1162 cur
->end
= lock
->start
;
1163 assert( next
->start
< next
->end
);
1164 assert( cur
->end
< next
->start
);
1166 break; /* done with this lock */
1171 /* clear Unix locks for all the holes */
1173 for (cur
= first
; cur
; cur
= cur
->next
)
1174 set_unix_lock( fd
, cur
->start
, cur
->end
, F_UNLCK
);
1180 /* create a new lock on a fd */
1181 static struct file_lock
*add_lock( struct fd
*fd
, int shared
, file_pos_t start
, file_pos_t end
)
1183 struct file_lock
*lock
;
1185 if (!(lock
= alloc_object( &file_lock_ops
))) return NULL
;
1186 lock
->shared
= shared
;
1187 lock
->start
= start
;
1190 lock
->process
= current
->process
;
1192 /* now try to set a Unix lock */
1193 if (!set_unix_lock( lock
->fd
, lock
->start
, lock
->end
, lock
->shared
? F_RDLCK
: F_WRLCK
))
1195 release_object( lock
);
1198 list_add_head( &fd
->locks
, &lock
->fd_entry
);
1199 list_add_head( &fd
->inode
->locks
, &lock
->inode_entry
);
1200 list_add_head( &lock
->process
->locks
, &lock
->proc_entry
);
1204 /* remove an existing lock */
1205 static void remove_lock( struct file_lock
*lock
, int remove_unix
)
1207 struct inode
*inode
= lock
->fd
->inode
;
1209 list_remove( &lock
->fd_entry
);
1210 list_remove( &lock
->inode_entry
);
1211 list_remove( &lock
->proc_entry
);
1212 if (remove_unix
) remove_unix_locks( lock
->fd
, lock
->start
, lock
->end
);
1213 if (list_empty( &inode
->locks
)) inode_close_pending( inode
, 1 );
1214 lock
->process
= NULL
;
1215 wake_up( &lock
->obj
, 0 );
1216 release_object( lock
);
1219 /* remove all locks owned by a given process */
1220 void remove_process_locks( struct process
*process
)
1224 while ((ptr
= list_head( &process
->locks
)))
1226 struct file_lock
*lock
= LIST_ENTRY( ptr
, struct file_lock
, proc_entry
);
1227 remove_lock( lock
, 1 ); /* this removes it from the list */
1231 /* remove all locks on a given fd */
1232 static void remove_fd_locks( struct fd
*fd
)
1234 file_pos_t start
= FILE_POS_T_MAX
, end
= 0;
1237 while ((ptr
= list_head( &fd
->locks
)))
1239 struct file_lock
*lock
= LIST_ENTRY( ptr
, struct file_lock
, fd_entry
);
1240 if (lock
->start
< start
) start
= lock
->start
;
1241 if (!lock
->end
|| lock
->end
> end
) end
= lock
->end
- 1;
1242 remove_lock( lock
, 0 );
1244 if (start
< end
) remove_unix_locks( fd
, start
, end
+ 1 );
1247 /* add a lock on an fd */
1248 /* returns handle to wait on */
1249 obj_handle_t
lock_fd( struct fd
*fd
, file_pos_t start
, file_pos_t count
, int shared
, int wait
)
1252 file_pos_t end
= start
+ count
;
1254 if (!fd
->inode
) /* not a regular file */
1256 set_error( STATUS_INVALID_DEVICE_REQUEST
);
1260 /* don't allow wrapping locks */
1261 if (end
&& end
< start
)
1263 set_error( STATUS_INVALID_PARAMETER
);
1267 /* check if another lock on that file overlaps the area */
1268 LIST_FOR_EACH( ptr
, &fd
->inode
->locks
)
1270 struct file_lock
*lock
= LIST_ENTRY( ptr
, struct file_lock
, inode_entry
);
1271 if (!lock_overlaps( lock
, start
, end
)) continue;
1272 if (lock
->shared
&& shared
) continue;
1276 set_error( STATUS_FILE_LOCK_CONFLICT
);
1279 set_error( STATUS_PENDING
);
1280 return alloc_handle( current
->process
, lock
, SYNCHRONIZE
, 0 );
1283 /* not found, add it */
1284 if (add_lock( fd
, shared
, start
, end
)) return 0;
1285 if (get_error() == STATUS_FILE_LOCK_CONFLICT
)
1287 /* Unix lock conflict -> tell client to wait and retry */
1288 if (wait
) set_error( STATUS_PENDING
);
1293 /* remove a lock on an fd */
1294 void unlock_fd( struct fd
*fd
, file_pos_t start
, file_pos_t count
)
1297 file_pos_t end
= start
+ count
;
1299 /* find an existing lock with the exact same parameters */
1300 LIST_FOR_EACH( ptr
, &fd
->locks
)
1302 struct file_lock
*lock
= LIST_ENTRY( ptr
, struct file_lock
, fd_entry
);
1303 if ((lock
->start
== start
) && (lock
->end
== end
))
1305 remove_lock( lock
, 1 );
1309 set_error( STATUS_FILE_LOCK_CONFLICT
);
1313 /****************************************************************/
1314 /* file descriptor functions */
1316 static void fd_dump( struct object
*obj
, int verbose
)
1318 struct fd
*fd
= (struct fd
*)obj
;
1319 fprintf( stderr
, "Fd unix_fd=%d user=%p options=%08x", fd
->unix_fd
, fd
->user
, fd
->options
);
1320 if (fd
->inode
) fprintf( stderr
, " inode=%p unlink='%s'", fd
->inode
, fd
->closed
->unlink
);
1321 fprintf( stderr
, "\n" );
1324 static void fd_destroy( struct object
*obj
)
1326 struct fd
*fd
= (struct fd
*)obj
;
1328 free_async_queue( fd
->read_q
);
1329 free_async_queue( fd
->write_q
);
1330 free_async_queue( fd
->wait_q
);
1332 remove_fd_locks( fd
);
1333 list_remove( &fd
->inode_entry
);
1334 if (fd
->poll_index
!= -1) remove_poll_user( fd
, fd
->poll_index
);
1337 inode_add_closed_fd( fd
->inode
, fd
->closed
);
1338 release_object( fd
->inode
);
1340 else /* no inode, close it right away */
1342 if (fd
->unix_fd
!= -1) close( fd
->unix_fd
);
1346 /* set the events that select waits for on this fd */
1347 void set_fd_events( struct fd
*fd
, int events
)
1349 int user
= fd
->poll_index
;
1350 assert( poll_users
[user
] == fd
);
1352 set_fd_epoll_events( fd
, user
, events
);
1354 if (events
== -1) /* stop waiting on this fd completely */
1356 pollfd
[user
].fd
= -1;
1357 pollfd
[user
].events
= POLLERR
;
1358 pollfd
[user
].revents
= 0;
1360 else if (pollfd
[user
].fd
!= -1 || !pollfd
[user
].events
)
1362 pollfd
[user
].fd
= fd
->unix_fd
;
1363 pollfd
[user
].events
= events
;
1367 /* prepare an fd for unmounting its corresponding device */
1368 static inline void unmount_fd( struct fd
*fd
)
1370 assert( fd
->inode
);
1372 async_wake_up( fd
->read_q
, STATUS_VOLUME_DISMOUNTED
);
1373 async_wake_up( fd
->write_q
, STATUS_VOLUME_DISMOUNTED
);
1375 if (fd
->poll_index
!= -1) set_fd_events( fd
, -1 );
1377 if (fd
->unix_fd
!= -1) close( fd
->unix_fd
);
1380 fd
->no_fd_status
= STATUS_VOLUME_DISMOUNTED
;
1381 fd
->closed
->unix_fd
= -1;
1382 fd
->closed
->unlink
[0] = 0;
1384 /* stop using Unix locks on this fd (existing locks have been removed by close) */
1388 /* allocate an fd object, without setting the unix fd yet */
1389 static struct fd
*alloc_fd_object(void)
1391 struct fd
*fd
= alloc_object( &fd_ops
);
1393 if (!fd
) return NULL
;
1405 fd
->poll_index
= -1;
1409 list_init( &fd
->inode_entry
);
1410 list_init( &fd
->locks
);
1412 if ((fd
->poll_index
= add_poll_user( fd
)) == -1)
1414 release_object( fd
);
1420 /* allocate a pseudo fd object, for objects that need to behave like files but don't have a unix fd */
1421 struct fd
*alloc_pseudo_fd( const struct fd_ops
*fd_user_ops
, struct object
*user
, unsigned int options
)
1423 struct fd
*fd
= alloc_object( &fd_ops
);
1425 if (!fd
) return NULL
;
1427 fd
->fd_ops
= fd_user_ops
;
1432 fd
->options
= options
;
1437 fd
->poll_index
= -1;
1441 fd
->no_fd_status
= STATUS_BAD_DEVICE_TYPE
;
1442 list_init( &fd
->inode_entry
);
1443 list_init( &fd
->locks
);
1447 /* set the status to return when the fd has no associated unix fd */
1448 void set_no_fd_status( struct fd
*fd
, unsigned int status
)
1450 fd
->no_fd_status
= status
;
1453 /* check if the desired access is possible without violating */
1454 /* the sharing mode of other opens of the same file */
1455 static int check_sharing( struct fd
*fd
, unsigned int access
, unsigned int sharing
)
1457 unsigned int existing_sharing
= FILE_SHARE_READ
| FILE_SHARE_WRITE
| FILE_SHARE_DELETE
;
1458 unsigned int existing_access
= 0;
1461 /* if access mode is 0, sharing mode is ignored */
1462 if (!access
) sharing
= existing_sharing
;
1463 fd
->access
= access
;
1464 fd
->sharing
= sharing
;
1466 LIST_FOR_EACH( ptr
, &fd
->inode
->open
)
1468 struct fd
*fd_ptr
= LIST_ENTRY( ptr
, struct fd
, inode_entry
);
1471 existing_sharing
&= fd_ptr
->sharing
;
1472 existing_access
|= fd_ptr
->access
;
1476 if ((access
& FILE_UNIX_READ_ACCESS
) && !(existing_sharing
& FILE_SHARE_READ
)) return 0;
1477 if ((access
& FILE_UNIX_WRITE_ACCESS
) && !(existing_sharing
& FILE_SHARE_WRITE
)) return 0;
1478 if ((access
& DELETE
) && !(existing_sharing
& FILE_SHARE_DELETE
)) return 0;
1479 if ((existing_access
& FILE_UNIX_READ_ACCESS
) && !(sharing
& FILE_SHARE_READ
)) return 0;
1480 if ((existing_access
& FILE_UNIX_WRITE_ACCESS
) && !(sharing
& FILE_SHARE_WRITE
)) return 0;
1481 if ((existing_access
& DELETE
) && !(sharing
& FILE_SHARE_DELETE
)) return 0;
1485 /* sets the user of an fd that previously had no user */
1486 void set_fd_user( struct fd
*fd
, const struct fd_ops
*user_ops
, struct object
*user
)
1488 assert( fd
->fd_ops
== NULL
);
1489 fd
->fd_ops
= user_ops
;
1493 /* open() wrapper that returns a struct fd with no fd user set */
1494 struct fd
*open_fd( const char *name
, int flags
, mode_t
*mode
, unsigned int access
,
1495 unsigned int sharing
, unsigned int options
)
1498 struct closed_fd
*closed_fd
;
1500 const char *unlink_name
= "";
1503 if ((options
& FILE_DELETE_ON_CLOSE
) && !(access
& DELETE
))
1505 set_error( STATUS_INVALID_PARAMETER
);
1509 if (!(fd
= alloc_fd_object())) return NULL
;
1511 fd
->options
= options
;
1512 if (options
& FILE_DELETE_ON_CLOSE
) unlink_name
= name
;
1513 if (!(closed_fd
= mem_alloc( sizeof(*closed_fd
) + strlen(unlink_name
) )))
1515 release_object( fd
);
1519 /* create the directory if needed */
1520 if ((options
& FILE_DIRECTORY_FILE
) && (flags
& O_CREAT
))
1522 if (mkdir( name
, 0777 ) == -1)
1524 if (errno
!= EEXIST
|| (flags
& O_EXCL
))
1530 flags
&= ~(O_CREAT
| O_EXCL
| O_TRUNC
);
1533 if ((access
& FILE_UNIX_WRITE_ACCESS
) && !(options
& FILE_DIRECTORY_FILE
))
1535 if (access
& FILE_UNIX_READ_ACCESS
) rw_mode
= O_RDWR
;
1536 else rw_mode
= O_WRONLY
;
1538 else rw_mode
= O_RDONLY
;
1540 if ((fd
->unix_fd
= open( name
, rw_mode
| (flags
& ~O_TRUNC
), *mode
)) == -1)
1542 /* if we tried to open a directory for write access, retry read-only */
1543 if (errno
!= EISDIR
||
1544 !(access
& FILE_UNIX_WRITE_ACCESS
) ||
1545 (fd
->unix_fd
= open( name
, O_RDONLY
| (flags
& ~O_TRUNC
), *mode
)) == -1)
1552 closed_fd
->unix_fd
= fd
->unix_fd
;
1553 closed_fd
->unlink
[0] = 0;
1554 fstat( fd
->unix_fd
, &st
);
1557 /* only bother with an inode for normal files and directories */
1558 if (S_ISREG(st
.st_mode
) || S_ISDIR(st
.st_mode
))
1560 struct inode
*inode
= get_inode( st
.st_dev
, st
.st_ino
, fd
->unix_fd
);
1564 /* we can close the fd because there are no others open on the same file,
1565 * otherwise we wouldn't have failed to allocate a new inode
1570 fd
->closed
= closed_fd
;
1571 list_add_head( &inode
->open
, &fd
->inode_entry
);
1573 /* check directory options */
1574 if ((options
& FILE_DIRECTORY_FILE
) && !S_ISDIR(st
.st_mode
))
1576 release_object( fd
);
1577 set_error( STATUS_NOT_A_DIRECTORY
);
1580 if ((options
& FILE_NON_DIRECTORY_FILE
) && S_ISDIR(st
.st_mode
))
1582 release_object( fd
);
1583 set_error( STATUS_FILE_IS_A_DIRECTORY
);
1586 if (!check_sharing( fd
, access
, sharing
))
1588 release_object( fd
);
1589 set_error( STATUS_SHARING_VIOLATION
);
1592 strcpy( closed_fd
->unlink
, unlink_name
);
1593 if (flags
& O_TRUNC
) ftruncate( fd
->unix_fd
, 0 );
1595 else /* special file */
1597 if (options
& FILE_DIRECTORY_FILE
)
1599 set_error( STATUS_NOT_A_DIRECTORY
);
1602 if (unlink_name
[0]) /* we can't unlink special files */
1604 set_error( STATUS_INVALID_PARAMETER
);
1612 release_object( fd
);
1617 /* create an fd for an anonymous file */
1618 /* if the function fails the unix fd is closed */
1619 struct fd
*create_anonymous_fd( const struct fd_ops
*fd_user_ops
, int unix_fd
, struct object
*user
,
1620 unsigned int options
)
1622 struct fd
*fd
= alloc_fd_object();
1626 set_fd_user( fd
, fd_user_ops
, user
);
1627 fd
->unix_fd
= unix_fd
;
1628 fd
->options
= options
;
1635 /* retrieve the object that is using an fd */
1636 void *get_fd_user( struct fd
*fd
)
1641 /* retrieve the opening options for the fd */
1642 unsigned int get_fd_options( struct fd
*fd
)
1647 /* retrieve the unix fd for an object */
1648 int get_unix_fd( struct fd
*fd
)
1650 if (fd
->unix_fd
== -1) set_error( fd
->no_fd_status
);
1654 /* check if two file descriptors point to the same file */
1655 int is_same_file_fd( struct fd
*fd1
, struct fd
*fd2
)
1657 return fd1
->inode
== fd2
->inode
;
1660 /* check if fd is on a removable device */
1661 int is_fd_removable( struct fd
*fd
)
1663 return (fd
->inode
&& fd
->inode
->device
->removable
);
1666 /* set or clear the fd signaled state */
1667 void set_fd_signaled( struct fd
*fd
, int signaled
)
1669 fd
->signaled
= signaled
;
1670 if (signaled
) wake_up( fd
->user
, 0 );
1673 /* handler for close_handle that refuses to close fd-associated handles in other processes */
1674 int fd_close_handle( struct object
*obj
, struct process
*process
, obj_handle_t handle
)
1676 return (!current
|| current
->process
== process
);
1679 /* callback for event happening in the main poll() loop */
1680 void fd_poll_event( struct fd
*fd
, int event
)
1682 return fd
->fd_ops
->poll_event( fd
, event
);
1685 /* check if events are pending and if yes return which one(s) */
1686 int check_fd_events( struct fd
*fd
, int events
)
1690 if (fd
->unix_fd
== -1) return POLLERR
;
1691 if (fd
->inode
) return events
; /* regular files are always signaled */
1693 pfd
.fd
= fd
->unix_fd
;
1694 pfd
.events
= events
;
1695 if (poll( &pfd
, 1, 0 ) <= 0) return 0;
1699 /* default signaled() routine for objects that poll() on an fd */
1700 int default_fd_signaled( struct object
*obj
, struct thread
*thread
)
1702 struct fd
*fd
= get_obj_fd( obj
);
1703 int ret
= fd
->signaled
;
1704 release_object( fd
);
1708 int default_fd_get_poll_events( struct fd
*fd
)
1712 if (async_waiting( fd
->read_q
)) events
|= POLLIN
;
1713 if (async_waiting( fd
->write_q
)) events
|= POLLOUT
;
1717 /* default handler for poll() events */
1718 void default_poll_event( struct fd
*fd
, int event
)
1720 if (event
& (POLLIN
| POLLERR
| POLLHUP
)) async_wake_up( fd
->read_q
, STATUS_ALERTED
);
1721 if (event
& (POLLOUT
| POLLERR
| POLLHUP
)) async_wake_up( fd
->write_q
, STATUS_ALERTED
);
1723 /* if an error occurred, stop polling this fd to avoid busy-looping */
1724 if (event
& (POLLERR
| POLLHUP
)) set_fd_events( fd
, -1 );
1725 else if (!fd
->inode
) set_fd_events( fd
, fd
->fd_ops
->get_poll_events( fd
) );
1728 struct async
*fd_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
, int count
)
1730 struct async_queue
*queue
;
1731 struct async
*async
;
1735 case ASYNC_TYPE_READ
:
1736 if (!fd
->read_q
&& !(fd
->read_q
= create_async_queue( fd
))) return NULL
;
1739 case ASYNC_TYPE_WRITE
:
1740 if (!fd
->write_q
&& !(fd
->write_q
= create_async_queue( fd
))) return NULL
;
1741 queue
= fd
->write_q
;
1743 case ASYNC_TYPE_WAIT
:
1744 if (!fd
->wait_q
&& !(fd
->wait_q
= create_async_queue( fd
))) return NULL
;
1752 if ((async
= create_async( current
, queue
, data
)) && type
!= ASYNC_TYPE_WAIT
)
1755 set_fd_events( fd
, fd
->fd_ops
->get_poll_events( fd
) );
1756 else /* regular files are always ready for read and write */
1757 async_wake_up( queue
, STATUS_ALERTED
);
1762 void fd_async_wake_up( struct fd
*fd
, int type
, unsigned int status
)
1766 case ASYNC_TYPE_READ
:
1767 async_wake_up( fd
->read_q
, status
);
1769 case ASYNC_TYPE_WRITE
:
1770 async_wake_up( fd
->write_q
, status
);
1772 case ASYNC_TYPE_WAIT
:
1773 async_wake_up( fd
->wait_q
, status
);
1780 void fd_reselect_async( struct fd
*fd
, struct async_queue
*queue
)
1782 fd
->fd_ops
->reselect_async( fd
, queue
);
1785 void default_fd_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
, int count
)
1787 struct async
*async
;
1789 if ((async
= fd_queue_async( fd
, data
, type
, count
)))
1791 release_object( async
);
1792 set_error( STATUS_PENDING
);
1796 /* default reselect_async() fd routine */
1797 void default_fd_reselect_async( struct fd
*fd
, struct async_queue
*queue
)
1799 if (queue
!= fd
->wait_q
)
1801 int poll_events
= fd
->fd_ops
->get_poll_events( fd
);
1802 int events
= check_fd_events( fd
, poll_events
);
1803 if (events
) fd
->fd_ops
->poll_event( fd
, events
);
1804 else set_fd_events( fd
, poll_events
);
1808 /* default cancel_async() fd routine */
1809 void default_fd_cancel_async( struct fd
*fd
)
1811 async_wake_up( fd
->read_q
, STATUS_CANCELLED
);
1812 async_wake_up( fd
->write_q
, STATUS_CANCELLED
);
1813 async_wake_up( fd
->wait_q
, STATUS_CANCELLED
);
1816 /* default flush() routine */
1817 void no_flush( struct fd
*fd
, struct event
**event
)
1819 set_error( STATUS_OBJECT_TYPE_MISMATCH
);
1822 static inline int is_valid_mounted_device( struct stat
*st
)
1824 #if defined(linux) || defined(__sun__)
1825 return S_ISBLK( st
->st_mode
);
1827 /* disks are char devices on *BSD */
1828 return S_ISCHR( st
->st_mode
);
1832 /* close all Unix file descriptors on a device to allow unmounting it */
1833 static void unmount_device( struct fd
*device_fd
)
1837 struct device
*device
;
1838 struct inode
*inode
;
1840 int unix_fd
= get_unix_fd( device_fd
);
1842 if (unix_fd
== -1) return;
1844 if (fstat( unix_fd
, &st
) == -1 || !is_valid_mounted_device( &st
))
1846 set_error( STATUS_INVALID_PARAMETER
);
1850 if (!(device
= get_device( st
.st_rdev
, -1 ))) return;
1852 for (i
= 0; i
< INODE_HASH_SIZE
; i
++)
1854 LIST_FOR_EACH_ENTRY( inode
, &device
->inode_hash
[i
], struct inode
, entry
)
1856 LIST_FOR_EACH_ENTRY( fd
, &inode
->open
, struct fd
, inode_entry
)
1860 inode_close_pending( inode
, 0 );
1863 /* remove it from the hash table */
1864 list_remove( &device
->entry
);
1865 list_init( &device
->entry
);
1866 release_object( device
);
1869 /* default ioctl() routine */
1870 obj_handle_t
default_fd_ioctl( struct fd
*fd
, ioctl_code_t code
, const async_data_t
*async
,
1871 const void *data
, data_size_t size
)
1875 case FSCTL_DISMOUNT_VOLUME
:
1876 unmount_device( fd
);
1879 set_error( STATUS_NOT_SUPPORTED
);
1884 /* same as get_handle_obj but retrieve the struct fd associated to the object */
1885 static struct fd
*get_handle_fd_obj( struct process
*process
, obj_handle_t handle
,
1886 unsigned int access
)
1888 struct fd
*fd
= NULL
;
1891 if ((obj
= get_handle_obj( process
, handle
, access
, NULL
)))
1893 fd
= get_obj_fd( obj
);
1894 release_object( obj
);
1899 /* flush a file buffers */
1900 DECL_HANDLER(flush_file
)
1902 struct fd
*fd
= get_handle_fd_obj( current
->process
, req
->handle
, 0 );
1903 struct event
* event
= NULL
;
1907 fd
->fd_ops
->flush( fd
, &event
);
1910 reply
->event
= alloc_handle( current
->process
, event
, SYNCHRONIZE
, 0 );
1912 release_object( fd
);
1916 /* open a file object */
1917 DECL_HANDLER(open_file_object
)
1919 struct unicode_str name
;
1920 struct directory
*root
= NULL
;
1921 struct object
*obj
, *result
;
1923 get_req_unicode_str( &name
);
1924 if (req
->rootdir
&& !(root
= get_directory_obj( current
->process
, req
->rootdir
, 0 )))
1927 if ((obj
= open_object_dir( root
, &name
, req
->attributes
, NULL
)))
1929 if ((result
= obj
->ops
->open_file( obj
, req
->access
, req
->sharing
, req
->options
)))
1931 reply
->handle
= alloc_handle( current
->process
, result
, req
->access
, req
->attributes
);
1932 release_object( result
);
1934 release_object( obj
);
1937 if (root
) release_object( root
);
1940 /* get a Unix fd to access a file */
1941 DECL_HANDLER(get_handle_fd
)
1945 if ((fd
= get_handle_fd_obj( current
->process
, req
->handle
, 0 )))
1947 int unix_fd
= get_unix_fd( fd
);
1950 send_client_fd( current
->process
, unix_fd
, req
->handle
);
1951 reply
->type
= fd
->fd_ops
->get_fd_type( fd
);
1952 reply
->removable
= is_fd_removable(fd
);
1953 reply
->options
= fd
->options
;
1954 reply
->access
= get_handle_access( current
->process
, req
->handle
);
1956 release_object( fd
);
1960 /* perform an ioctl on a file */
1963 unsigned int access
= (req
->code
>> 14) & (FILE_READ_DATA
|FILE_WRITE_DATA
);
1964 struct fd
*fd
= get_handle_fd_obj( current
->process
, req
->handle
, access
);
1968 reply
->wait
= fd
->fd_ops
->ioctl( fd
, req
->code
, &req
->async
,
1969 get_req_data(), get_req_data_size() );
1970 reply
->options
= fd
->options
;
1971 release_object( fd
);
1975 /* create / reschedule an async I/O */
1976 DECL_HANDLER(register_async
)
1978 unsigned int access
;
1983 case ASYNC_TYPE_READ
:
1984 access
= FILE_READ_DATA
;
1986 case ASYNC_TYPE_WRITE
:
1987 access
= FILE_WRITE_DATA
;
1990 set_error( STATUS_INVALID_PARAMETER
);
1994 if ((fd
= get_handle_fd_obj( current
->process
, req
->handle
, access
)))
1996 if (get_unix_fd( fd
) != -1) fd
->fd_ops
->queue_async( fd
, &req
->async
, req
->type
, req
->count
);
1997 release_object( fd
);
2001 /* cancels all async I/O */
2002 DECL_HANDLER(cancel_async
)
2004 struct fd
*fd
= get_handle_fd_obj( current
->process
, req
->handle
, 0 );
2008 if (get_unix_fd( fd
) != -1) fd
->fd_ops
->cancel_async( fd
);
2009 release_object( fd
);