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 */
183 struct completion
*completion
; /* completion object attached to this fd */
184 unsigned long comp_key
; /* completion key to set in completion events */
187 static void fd_dump( struct object
*obj
, int verbose
);
188 static void fd_destroy( struct object
*obj
);
190 static const struct object_ops fd_ops
=
192 sizeof(struct fd
), /* size */
194 no_get_type
, /* get_type */
195 no_add_queue
, /* add_queue */
196 NULL
, /* remove_queue */
198 NULL
, /* satisfied */
199 no_signal
, /* signal */
200 no_get_fd
, /* get_fd */
201 no_map_access
, /* map_access */
202 default_get_sd
, /* get_sd */
203 default_set_sd
, /* set_sd */
204 no_lookup_name
, /* lookup_name */
205 no_open_file
, /* open_file */
206 no_close_handle
, /* close_handle */
207 fd_destroy
/* destroy */
212 #define DEVICE_HASH_SIZE 7
213 #define INODE_HASH_SIZE 17
217 struct object obj
; /* object header */
218 struct list entry
; /* entry in device hash list */
219 dev_t dev
; /* device number */
220 int removable
; /* removable device? (or -1 if unknown) */
221 struct list inode_hash
[INODE_HASH_SIZE
]; /* inodes hash table */
224 static void device_dump( struct object
*obj
, int verbose
);
225 static void device_destroy( struct object
*obj
);
227 static const struct object_ops device_ops
=
229 sizeof(struct device
), /* size */
230 device_dump
, /* dump */
231 no_get_type
, /* get_type */
232 no_add_queue
, /* add_queue */
233 NULL
, /* remove_queue */
235 NULL
, /* satisfied */
236 no_signal
, /* signal */
237 no_get_fd
, /* get_fd */
238 no_map_access
, /* map_access */
239 default_get_sd
, /* get_sd */
240 default_set_sd
, /* set_sd */
241 no_lookup_name
, /* lookup_name */
242 no_open_file
, /* open_file */
243 no_close_handle
, /* close_handle */
244 device_destroy
/* destroy */
251 struct object obj
; /* object header */
252 struct list entry
; /* inode hash list entry */
253 struct device
*device
; /* device containing this inode */
254 ino_t ino
; /* inode number */
255 struct list open
; /* list of open file descriptors */
256 struct list locks
; /* list of file locks */
257 struct list closed
; /* list of file descriptors to close at destroy time */
260 static void inode_dump( struct object
*obj
, int verbose
);
261 static void inode_destroy( struct object
*obj
);
263 static const struct object_ops inode_ops
=
265 sizeof(struct inode
), /* size */
266 inode_dump
, /* dump */
267 no_get_type
, /* get_type */
268 no_add_queue
, /* add_queue */
269 NULL
, /* remove_queue */
271 NULL
, /* satisfied */
272 no_signal
, /* signal */
273 no_get_fd
, /* get_fd */
274 no_map_access
, /* map_access */
275 default_get_sd
, /* get_sd */
276 default_set_sd
, /* set_sd */
277 no_lookup_name
, /* lookup_name */
278 no_open_file
, /* open_file */
279 no_close_handle
, /* close_handle */
280 inode_destroy
/* destroy */
283 /* file lock object */
287 struct object obj
; /* object header */
288 struct fd
*fd
; /* fd owning this lock */
289 struct list fd_entry
; /* entry in list of locks on a given fd */
290 struct list inode_entry
; /* entry in inode list of locks */
291 int shared
; /* shared lock? */
292 file_pos_t start
; /* locked region is interval [start;end) */
294 struct process
*process
; /* process owning this lock */
295 struct list proc_entry
; /* entry in list of locks owned by the process */
298 static void file_lock_dump( struct object
*obj
, int verbose
);
299 static int file_lock_signaled( struct object
*obj
, struct thread
*thread
);
301 static const struct object_ops file_lock_ops
=
303 sizeof(struct file_lock
), /* size */
304 file_lock_dump
, /* dump */
305 no_get_type
, /* get_type */
306 add_queue
, /* add_queue */
307 remove_queue
, /* remove_queue */
308 file_lock_signaled
, /* signaled */
309 no_satisfied
, /* satisfied */
310 no_signal
, /* signal */
311 no_get_fd
, /* get_fd */
312 no_map_access
, /* map_access */
313 default_get_sd
, /* get_sd */
314 default_set_sd
, /* set_sd */
315 no_lookup_name
, /* lookup_name */
316 no_open_file
, /* open_file */
317 no_close_handle
, /* close_handle */
318 no_destroy
/* destroy */
322 #define OFF_T_MAX (~((file_pos_t)1 << (8*sizeof(off_t)-1)))
323 #define FILE_POS_T_MAX (~(file_pos_t)0)
325 static file_pos_t max_unix_offset
= OFF_T_MAX
;
327 #define DUMP_LONG_LONG(val) do { \
328 if (sizeof(val) > sizeof(unsigned long) && (val) > ~0UL) \
329 fprintf( stderr, "%lx%08lx", (unsigned long)((unsigned long long)(val) >> 32), (unsigned long)(val) ); \
331 fprintf( stderr, "%lx", (unsigned long)(val) ); \
336 /****************************************************************/
337 /* timeouts support */
341 struct list entry
; /* entry in sorted timeout list */
342 timeout_t when
; /* timeout expiry (absolute time) */
343 timeout_callback callback
; /* callback function */
344 void *private; /* callback private data */
347 static struct list timeout_list
= LIST_INIT(timeout_list
); /* sorted timeouts list */
348 timeout_t current_time
;
350 static inline void set_current_time(void)
352 static const timeout_t ticks_1601_to_1970
= (timeout_t
)86400 * (369 * 365 + 89) * TICKS_PER_SEC
;
354 gettimeofday( &now
, NULL
);
355 current_time
= (timeout_t
)now
.tv_sec
* TICKS_PER_SEC
+ now
.tv_usec
* 10 + ticks_1601_to_1970
;
358 /* add a timeout user */
359 struct timeout_user
*add_timeout_user( timeout_t when
, timeout_callback func
, void *private )
361 struct timeout_user
*user
;
364 if (!(user
= mem_alloc( sizeof(*user
) ))) return NULL
;
365 user
->when
= (when
> 0) ? when
: current_time
- when
;
366 user
->callback
= func
;
367 user
->private = private;
369 /* Now insert it in the linked list */
371 LIST_FOR_EACH( ptr
, &timeout_list
)
373 struct timeout_user
*timeout
= LIST_ENTRY( ptr
, struct timeout_user
, entry
);
374 if (timeout
->when
>= user
->when
) break;
376 list_add_before( ptr
, &user
->entry
);
380 /* remove a timeout user */
381 void remove_timeout_user( struct timeout_user
*user
)
383 list_remove( &user
->entry
);
387 /* return a text description of a timeout for debugging purposes */
388 const char *get_timeout_str( timeout_t timeout
)
390 static char buffer
[64];
393 if (!timeout
) return "0";
394 if (timeout
== TIMEOUT_INFINITE
) return "infinite";
396 if (timeout
< 0) /* relative */
398 secs
= -timeout
/ TICKS_PER_SEC
;
399 nsecs
= -timeout
% TICKS_PER_SEC
;
400 sprintf( buffer
, "+%ld.%07ld", secs
, nsecs
);
404 secs
= (timeout
- current_time
) / TICKS_PER_SEC
;
405 nsecs
= (timeout
- current_time
) % TICKS_PER_SEC
;
408 nsecs
+= TICKS_PER_SEC
;
412 sprintf( buffer
, "%x%08x (+%ld.%07ld)",
413 (unsigned int)(timeout
>> 32), (unsigned int)timeout
, secs
, nsecs
);
415 sprintf( buffer
, "%x%08x (-%ld.%07ld)",
416 (unsigned int)(timeout
>> 32), (unsigned int)timeout
,
417 -(secs
+ 1), TICKS_PER_SEC
- nsecs
);
423 /****************************************************************/
426 static struct fd
**poll_users
; /* users array */
427 static struct pollfd
*pollfd
; /* poll fd array */
428 static int nb_users
; /* count of array entries actually in use */
429 static int active_users
; /* current number of active users */
430 static int allocated_users
; /* count of allocated entries in the array */
431 static struct fd
**freelist
; /* list of free entries in the array */
433 static int get_next_timeout(void);
435 static inline void fd_poll_event( struct fd
*fd
, int event
)
437 fd
->fd_ops
->poll_event( fd
, event
);
442 static int epoll_fd
= -1;
444 static inline void init_epoll(void)
446 epoll_fd
= epoll_create( 128 );
449 /* set the events that epoll waits for on this fd; helper for set_fd_events */
450 static inline void set_fd_epoll_events( struct fd
*fd
, int user
, int events
)
452 struct epoll_event ev
;
455 if (epoll_fd
== -1) return;
457 if (events
== -1) /* stop waiting on this fd completely */
459 if (pollfd
[user
].fd
== -1) return; /* already removed */
462 else if (pollfd
[user
].fd
== -1)
464 if (pollfd
[user
].events
) return; /* stopped waiting on it, don't restart */
469 if (pollfd
[user
].events
== events
) return; /* nothing to do */
474 memset(&ev
.data
, 0, sizeof(ev
.data
));
477 if (epoll_ctl( epoll_fd
, ctl
, fd
->unix_fd
, &ev
) == -1)
479 if (errno
== ENOMEM
) /* not enough memory, give up on epoll */
484 else perror( "epoll_ctl" ); /* should not happen */
488 static inline void remove_epoll_user( struct fd
*fd
, int user
)
490 if (epoll_fd
== -1) return;
492 if (pollfd
[user
].fd
!= -1)
494 struct epoll_event dummy
;
495 epoll_ctl( epoll_fd
, EPOLL_CTL_DEL
, fd
->unix_fd
, &dummy
);
499 static inline void main_loop_epoll(void)
502 struct epoll_event events
[128];
504 assert( POLLIN
== EPOLLIN
);
505 assert( POLLOUT
== EPOLLOUT
);
506 assert( POLLERR
== EPOLLERR
);
507 assert( POLLHUP
== EPOLLHUP
);
509 if (epoll_fd
== -1) return;
513 timeout
= get_next_timeout();
515 if (!active_users
) break; /* last user removed by a timeout */
516 if (epoll_fd
== -1) break; /* an error occurred with epoll */
518 ret
= epoll_wait( epoll_fd
, events
, sizeof(events
)/sizeof(events
[0]), timeout
);
521 /* put the events into the pollfd array first, like poll does */
522 for (i
= 0; i
< ret
; i
++)
524 int user
= events
[i
].data
.u32
;
525 pollfd
[user
].revents
= events
[i
].events
;
528 /* read events from the pollfd array, as set_fd_events may modify them */
529 for (i
= 0; i
< ret
; i
++)
531 int user
= events
[i
].data
.u32
;
532 if (pollfd
[user
].revents
) fd_poll_event( poll_users
[user
], pollfd
[user
].revents
);
537 #elif defined(HAVE_KQUEUE)
539 static int kqueue_fd
= -1;
541 static inline void init_epoll(void)
543 #ifdef __APPLE__ /* kqueue support is broken in Mac OS < 10.5 */
546 size_t len
= sizeof(release
);
549 mib
[1] = KERN_OSRELEASE
;
550 if (sysctl( mib
, 2, release
, &len
, NULL
, 0 ) == -1) return;
551 if (atoi(release
) < 9) return;
553 kqueue_fd
= kqueue();
556 static inline void set_fd_epoll_events( struct fd
*fd
, int user
, int events
)
560 if (kqueue_fd
== -1) return;
562 EV_SET( &ev
[0], fd
->unix_fd
, EVFILT_READ
, 0, NOTE_LOWAT
, 1, (void *)user
);
563 EV_SET( &ev
[1], fd
->unix_fd
, EVFILT_WRITE
, 0, NOTE_LOWAT
, 1, (void *)user
);
565 if (events
== -1) /* stop waiting on this fd completely */
567 if (pollfd
[user
].fd
== -1) return; /* already removed */
568 ev
[0].flags
|= EV_DELETE
;
569 ev
[1].flags
|= EV_DELETE
;
571 else if (pollfd
[user
].fd
== -1)
573 if (pollfd
[user
].events
) return; /* stopped waiting on it, don't restart */
574 ev
[0].flags
|= EV_ADD
| ((events
& POLLIN
) ? EV_ENABLE
: EV_DISABLE
);
575 ev
[1].flags
|= EV_ADD
| ((events
& POLLOUT
) ? EV_ENABLE
: EV_DISABLE
);
579 if (pollfd
[user
].events
== events
) return; /* nothing to do */
580 ev
[0].flags
|= (events
& POLLIN
) ? EV_ENABLE
: EV_DISABLE
;
581 ev
[1].flags
|= (events
& POLLOUT
) ? EV_ENABLE
: EV_DISABLE
;
584 if (kevent( kqueue_fd
, ev
, 2, NULL
, 0, NULL
) == -1)
586 if (errno
== ENOMEM
) /* not enough memory, give up on kqueue */
591 else perror( "kevent" ); /* should not happen */
595 static inline void remove_epoll_user( struct fd
*fd
, int user
)
597 if (kqueue_fd
== -1) return;
599 if (pollfd
[user
].fd
!= -1)
603 EV_SET( &ev
[0], fd
->unix_fd
, EVFILT_READ
, EV_DELETE
, 0, 0, 0 );
604 EV_SET( &ev
[1], fd
->unix_fd
, EVFILT_WRITE
, EV_DELETE
, 0, 0, 0 );
605 kevent( kqueue_fd
, ev
, 2, NULL
, 0, NULL
);
609 static inline void main_loop_epoll(void)
612 struct kevent events
[128];
614 if (kqueue_fd
== -1) return;
618 timeout
= get_next_timeout();
620 if (!active_users
) break; /* last user removed by a timeout */
621 if (kqueue_fd
== -1) break; /* an error occurred with kqueue */
627 ts
.tv_sec
= timeout
/ 1000;
628 ts
.tv_nsec
= (timeout
% 1000) * 1000000;
629 ret
= kevent( kqueue_fd
, NULL
, 0, events
, sizeof(events
)/sizeof(events
[0]), &ts
);
631 else ret
= kevent( kqueue_fd
, NULL
, 0, events
, sizeof(events
)/sizeof(events
[0]), NULL
);
635 /* put the events into the pollfd array first, like poll does */
636 for (i
= 0; i
< ret
; i
++)
638 long user
= (long)events
[i
].udata
;
639 pollfd
[user
].revents
= 0;
641 for (i
= 0; i
< ret
; i
++)
643 long user
= (long)events
[i
].udata
;
644 if (events
[i
].filter
== EVFILT_READ
) pollfd
[user
].revents
|= POLLIN
;
645 else if (events
[i
].filter
== EVFILT_WRITE
) pollfd
[user
].revents
|= POLLOUT
;
646 if (events
[i
].flags
& EV_EOF
) pollfd
[user
].revents
|= POLLHUP
;
647 if (events
[i
].flags
& EV_ERROR
) pollfd
[user
].revents
|= POLLERR
;
650 /* read events from the pollfd array, as set_fd_events may modify them */
651 for (i
= 0; i
< ret
; i
++)
653 long user
= (long)events
[i
].udata
;
654 if (pollfd
[user
].revents
) fd_poll_event( poll_users
[user
], pollfd
[user
].revents
);
655 pollfd
[user
].revents
= 0;
660 #else /* HAVE_KQUEUE */
662 static inline void init_epoll(void) { }
663 static inline void set_fd_epoll_events( struct fd
*fd
, int user
, int events
) { }
664 static inline void remove_epoll_user( struct fd
*fd
, int user
) { }
665 static inline void main_loop_epoll(void) { }
667 #endif /* USE_EPOLL */
670 /* add a user in the poll array and return its index, or -1 on failure */
671 static int add_poll_user( struct fd
*fd
)
676 ret
= freelist
- poll_users
;
677 freelist
= (struct fd
**)poll_users
[ret
];
681 if (nb_users
== allocated_users
)
683 struct fd
**newusers
;
684 struct pollfd
*newpoll
;
685 int new_count
= allocated_users
? (allocated_users
+ allocated_users
/ 2) : 16;
686 if (!(newusers
= realloc( poll_users
, new_count
* sizeof(*poll_users
) ))) return -1;
687 if (!(newpoll
= realloc( pollfd
, new_count
* sizeof(*pollfd
) )))
690 poll_users
= newusers
;
695 poll_users
= newusers
;
697 if (!allocated_users
) init_epoll();
698 allocated_users
= new_count
;
703 pollfd
[ret
].events
= 0;
704 pollfd
[ret
].revents
= 0;
705 poll_users
[ret
] = fd
;
710 /* remove a user from the poll list */
711 static void remove_poll_user( struct fd
*fd
, int user
)
714 assert( poll_users
[user
] == fd
);
716 remove_epoll_user( fd
, user
);
717 pollfd
[user
].fd
= -1;
718 pollfd
[user
].events
= 0;
719 pollfd
[user
].revents
= 0;
720 poll_users
[user
] = (struct fd
*)freelist
;
721 freelist
= &poll_users
[user
];
725 /* process pending timeouts and return the time until the next timeout, in milliseconds */
726 static int get_next_timeout(void)
728 if (!list_empty( &timeout_list
))
730 struct list expired_list
, *ptr
;
732 /* first remove all expired timers from the list */
734 list_init( &expired_list
);
735 while ((ptr
= list_head( &timeout_list
)) != NULL
)
737 struct timeout_user
*timeout
= LIST_ENTRY( ptr
, struct timeout_user
, entry
);
739 if (timeout
->when
<= current_time
)
741 list_remove( &timeout
->entry
);
742 list_add_tail( &expired_list
, &timeout
->entry
);
747 /* now call the callback for all the removed timers */
749 while ((ptr
= list_head( &expired_list
)) != NULL
)
751 struct timeout_user
*timeout
= LIST_ENTRY( ptr
, struct timeout_user
, entry
);
752 list_remove( &timeout
->entry
);
753 timeout
->callback( timeout
->private );
757 if ((ptr
= list_head( &timeout_list
)) != NULL
)
759 struct timeout_user
*timeout
= LIST_ENTRY( ptr
, struct timeout_user
, entry
);
760 int diff
= (timeout
->when
- current_time
+ 9999) / 10000;
761 if (diff
< 0) diff
= 0;
765 return -1; /* no pending timeouts */
768 /* server main poll() loop */
774 server_start_time
= current_time
;
777 /* fall through to normal poll loop */
781 timeout
= get_next_timeout();
783 if (!active_users
) break; /* last user removed by a timeout */
785 ret
= poll( pollfd
, nb_users
, timeout
);
790 for (i
= 0; i
< nb_users
; i
++)
792 if (pollfd
[i
].revents
)
794 fd_poll_event( poll_users
[i
], pollfd
[i
].revents
);
803 /****************************************************************/
804 /* device functions */
806 static struct list device_hash
[DEVICE_HASH_SIZE
];
808 static int is_device_removable( dev_t dev
, int unix_fd
)
810 #if defined(linux) && defined(HAVE_FSTATFS)
813 /* check for floppy disk */
814 if (major(dev
) == FLOPPY_MAJOR
) return 1;
816 if (fstatfs( unix_fd
, &stfs
) == -1) return 0;
817 return (stfs
.f_type
== 0x9660 || /* iso9660 */
818 stfs
.f_type
== 0x9fa1 || /* supermount */
819 stfs
.f_type
== 0x15013346); /* udf */
820 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__APPLE__)
823 if (fstatfs( unix_fd
, &stfs
) == -1) return 0;
824 return (!strcmp("cd9660", stfs
.f_fstypename
) || !strcmp("udf", stfs
.f_fstypename
));
825 #elif defined(__NetBSD__)
828 if (fstatvfs( unix_fd
, &stfs
) == -1) return 0;
829 return (!strcmp("cd9660", stfs
.f_fstypename
) || !strcmp("udf", stfs
.f_fstypename
));
831 # include <sys/dkio.h>
832 # include <sys/vtoc.h>
833 struct dk_cinfo dkinf
;
834 if (ioctl( unix_fd
, DKIOCINFO
, &dkinf
) == -1) return 0;
835 return (dkinf
.dki_ctype
== DKC_CDROM
||
836 dkinf
.dki_ctype
== DKC_NCRFLOPPY
||
837 dkinf
.dki_ctype
== DKC_SMSFLOPPY
||
838 dkinf
.dki_ctype
== DKC_INTEL82072
||
839 dkinf
.dki_ctype
== DKC_INTEL82077
);
845 /* retrieve the device object for a given fd, creating it if needed */
846 static struct device
*get_device( dev_t dev
, int unix_fd
)
848 struct device
*device
;
849 unsigned int i
, hash
= dev
% DEVICE_HASH_SIZE
;
851 if (device_hash
[hash
].next
)
853 LIST_FOR_EACH_ENTRY( device
, &device_hash
[hash
], struct device
, entry
)
854 if (device
->dev
== dev
) return (struct device
*)grab_object( device
);
856 else list_init( &device_hash
[hash
] );
858 /* not found, create it */
860 if (unix_fd
== -1) return NULL
;
861 if ((device
= alloc_object( &device_ops
)))
864 device
->removable
= is_device_removable( dev
, unix_fd
);
865 for (i
= 0; i
< INODE_HASH_SIZE
; i
++) list_init( &device
->inode_hash
[i
] );
866 list_add_head( &device_hash
[hash
], &device
->entry
);
871 static void device_dump( struct object
*obj
, int verbose
)
873 struct device
*device
= (struct device
*)obj
;
874 fprintf( stderr
, "Device dev=" );
875 DUMP_LONG_LONG( device
->dev
);
876 fprintf( stderr
, "\n" );
879 static void device_destroy( struct object
*obj
)
881 struct device
*device
= (struct device
*)obj
;
884 for (i
= 0; i
< INODE_HASH_SIZE
; i
++)
885 assert( list_empty(&device
->inode_hash
[i
]) );
887 list_remove( &device
->entry
); /* remove it from the hash table */
891 /****************************************************************/
892 /* inode functions */
894 /* close all pending file descriptors in the closed list */
895 static void inode_close_pending( struct inode
*inode
, int keep_unlinks
)
897 struct list
*ptr
= list_head( &inode
->closed
);
901 struct closed_fd
*fd
= LIST_ENTRY( ptr
, struct closed_fd
, entry
);
902 struct list
*next
= list_next( &inode
->closed
, ptr
);
904 if (fd
->unix_fd
!= -1)
906 close( fd
->unix_fd
);
909 if (!keep_unlinks
|| !fd
->unlink
[0]) /* get rid of it unless there's an unlink pending on that file */
918 static void inode_dump( struct object
*obj
, int verbose
)
920 struct inode
*inode
= (struct inode
*)obj
;
921 fprintf( stderr
, "Inode device=%p ino=", inode
->device
);
922 DUMP_LONG_LONG( inode
->ino
);
923 fprintf( stderr
, "\n" );
926 static void inode_destroy( struct object
*obj
)
928 struct inode
*inode
= (struct inode
*)obj
;
931 assert( list_empty(&inode
->open
) );
932 assert( list_empty(&inode
->locks
) );
934 list_remove( &inode
->entry
);
936 while ((ptr
= list_head( &inode
->closed
)))
938 struct closed_fd
*fd
= LIST_ENTRY( ptr
, struct closed_fd
, entry
);
940 if (fd
->unix_fd
!= -1) close( fd
->unix_fd
);
943 /* make sure it is still the same file */
945 if (!stat( fd
->unlink
, &st
) && st
.st_dev
== inode
->device
->dev
&& st
.st_ino
== inode
->ino
)
947 if (S_ISDIR(st
.st_mode
)) rmdir( fd
->unlink
);
948 else unlink( fd
->unlink
);
953 release_object( inode
->device
);
956 /* retrieve the inode object for a given fd, creating it if needed */
957 static struct inode
*get_inode( dev_t dev
, ino_t ino
, int unix_fd
)
959 struct device
*device
;
961 unsigned int hash
= ino
% INODE_HASH_SIZE
;
963 if (!(device
= get_device( dev
, unix_fd
))) return NULL
;
965 LIST_FOR_EACH_ENTRY( inode
, &device
->inode_hash
[hash
], struct inode
, entry
)
967 if (inode
->ino
== ino
)
969 release_object( device
);
970 return (struct inode
*)grab_object( inode
);
974 /* not found, create it */
975 if ((inode
= alloc_object( &inode_ops
)))
977 inode
->device
= device
;
979 list_init( &inode
->open
);
980 list_init( &inode
->locks
);
981 list_init( &inode
->closed
);
982 list_add_head( &device
->inode_hash
[hash
], &inode
->entry
);
984 else release_object( device
);
989 /* add fd to the inode list of file descriptors to close */
990 static void inode_add_closed_fd( struct inode
*inode
, struct closed_fd
*fd
)
992 if (!list_empty( &inode
->locks
))
994 list_add_head( &inode
->closed
, &fd
->entry
);
996 else if (fd
->unlink
[0]) /* close the fd but keep the structure around for unlink */
998 if (fd
->unix_fd
!= -1) close( fd
->unix_fd
);
1000 list_add_head( &inode
->closed
, &fd
->entry
);
1002 else /* no locks on this inode and no unlink, get rid of the fd */
1004 if (fd
->unix_fd
!= -1) close( fd
->unix_fd
);
1010 /****************************************************************/
1011 /* file lock functions */
1013 static void file_lock_dump( struct object
*obj
, int verbose
)
1015 struct file_lock
*lock
= (struct file_lock
*)obj
;
1016 fprintf( stderr
, "Lock %s fd=%p proc=%p start=",
1017 lock
->shared
? "shared" : "excl", lock
->fd
, lock
->process
);
1018 DUMP_LONG_LONG( lock
->start
);
1019 fprintf( stderr
, " end=" );
1020 DUMP_LONG_LONG( lock
->end
);
1021 fprintf( stderr
, "\n" );
1024 static int file_lock_signaled( struct object
*obj
, struct thread
*thread
)
1026 struct file_lock
*lock
= (struct file_lock
*)obj
;
1027 /* lock is signaled if it has lost its owner */
1028 return !lock
->process
;
1031 /* set (or remove) a Unix lock if possible for the given range */
1032 static int set_unix_lock( struct fd
*fd
, file_pos_t start
, file_pos_t end
, int type
)
1036 if (!fd
->fs_locks
) return 1; /* no fs locks possible for this fd */
1039 if (start
== end
) return 1; /* can't set zero-byte lock */
1040 if (start
> max_unix_offset
) return 1; /* ignore it */
1042 fl
.l_whence
= SEEK_SET
;
1044 if (!end
|| end
> max_unix_offset
) fl
.l_len
= 0;
1045 else fl
.l_len
= end
- start
;
1046 if (fcntl( fd
->unix_fd
, F_SETLK
, &fl
) != -1) return 1;
1051 /* check whether locks work at all on this file system */
1052 if (fcntl( fd
->unix_fd
, F_GETLK
, &fl
) != -1)
1054 set_error( STATUS_FILE_LOCK_CONFLICT
);
1060 /* no locking on this fs, just ignore it */
1064 set_error( STATUS_FILE_LOCK_CONFLICT
);
1067 /* this can happen if we try to set a write lock on a read-only file */
1068 /* we just ignore that error */
1069 if (fl
.l_type
== F_WRLCK
) return 1;
1070 set_error( STATUS_ACCESS_DENIED
);
1076 /* this can happen if off_t is 64-bit but the kernel only supports 32-bit */
1077 /* in that case we shrink the limit and retry */
1078 if (max_unix_offset
> INT_MAX
)
1080 max_unix_offset
= INT_MAX
;
1091 /* check if interval [start;end) overlaps the lock */
1092 static inline int lock_overlaps( struct file_lock
*lock
, file_pos_t start
, file_pos_t end
)
1094 if (lock
->end
&& start
>= lock
->end
) return 0;
1095 if (end
&& lock
->start
>= end
) return 0;
1099 /* remove Unix locks for all bytes in the specified area that are no longer locked */
1100 static void remove_unix_locks( struct fd
*fd
, file_pos_t start
, file_pos_t end
)
1108 } *first
, *cur
, *next
, *buffer
;
1113 if (!fd
->inode
) return;
1114 if (!fd
->fs_locks
) return;
1115 if (start
== end
|| start
> max_unix_offset
) return;
1116 if (!end
|| end
> max_unix_offset
) end
= max_unix_offset
+ 1;
1118 /* count the number of locks overlapping the specified area */
1120 LIST_FOR_EACH( ptr
, &fd
->inode
->locks
)
1122 struct file_lock
*lock
= LIST_ENTRY( ptr
, struct file_lock
, inode_entry
);
1123 if (lock
->start
== lock
->end
) continue;
1124 if (lock_overlaps( lock
, start
, end
)) count
++;
1127 if (!count
) /* no locks at all, we can unlock everything */
1129 set_unix_lock( fd
, start
, end
, F_UNLCK
);
1133 /* allocate space for the list of holes */
1134 /* max. number of holes is number of locks + 1 */
1136 if (!(buffer
= malloc( sizeof(*buffer
) * (count
+1) ))) return;
1140 first
->start
= start
;
1144 /* build a sorted list of unlocked holes in the specified area */
1146 LIST_FOR_EACH( ptr
, &fd
->inode
->locks
)
1148 struct file_lock
*lock
= LIST_ENTRY( ptr
, struct file_lock
, inode_entry
);
1149 if (lock
->start
== lock
->end
) continue;
1150 if (!lock_overlaps( lock
, start
, end
)) continue;
1152 /* go through all the holes touched by this lock */
1153 for (cur
= first
; cur
; cur
= cur
->next
)
1155 if (cur
->end
<= lock
->start
) continue; /* hole is before start of lock */
1156 if (lock
->end
&& cur
->start
>= lock
->end
) break; /* hole is after end of lock */
1158 /* now we know that lock is overlapping hole */
1160 if (cur
->start
>= lock
->start
) /* lock starts before hole, shrink from start */
1162 cur
->start
= lock
->end
;
1163 if (cur
->start
&& cur
->start
< cur
->end
) break; /* done with this lock */
1164 /* now hole is empty, remove it */
1165 if (cur
->next
) cur
->next
->prev
= cur
->prev
;
1166 if (cur
->prev
) cur
->prev
->next
= cur
->next
;
1167 else if (!(first
= cur
->next
)) goto done
; /* no more holes at all */
1169 else if (!lock
->end
|| cur
->end
<= lock
->end
) /* lock larger than hole, shrink from end */
1171 cur
->end
= lock
->start
;
1172 assert( cur
->start
< cur
->end
);
1174 else /* lock is in the middle of hole, split hole in two */
1177 next
->next
= cur
->next
;
1179 next
->start
= lock
->end
;
1180 next
->end
= cur
->end
;
1181 cur
->end
= lock
->start
;
1182 assert( next
->start
< next
->end
);
1183 assert( cur
->end
< next
->start
);
1185 break; /* done with this lock */
1190 /* clear Unix locks for all the holes */
1192 for (cur
= first
; cur
; cur
= cur
->next
)
1193 set_unix_lock( fd
, cur
->start
, cur
->end
, F_UNLCK
);
1199 /* create a new lock on a fd */
1200 static struct file_lock
*add_lock( struct fd
*fd
, int shared
, file_pos_t start
, file_pos_t end
)
1202 struct file_lock
*lock
;
1204 if (!(lock
= alloc_object( &file_lock_ops
))) return NULL
;
1205 lock
->shared
= shared
;
1206 lock
->start
= start
;
1209 lock
->process
= current
->process
;
1211 /* now try to set a Unix lock */
1212 if (!set_unix_lock( lock
->fd
, lock
->start
, lock
->end
, lock
->shared
? F_RDLCK
: F_WRLCK
))
1214 release_object( lock
);
1217 list_add_head( &fd
->locks
, &lock
->fd_entry
);
1218 list_add_head( &fd
->inode
->locks
, &lock
->inode_entry
);
1219 list_add_head( &lock
->process
->locks
, &lock
->proc_entry
);
1223 /* remove an existing lock */
1224 static void remove_lock( struct file_lock
*lock
, int remove_unix
)
1226 struct inode
*inode
= lock
->fd
->inode
;
1228 list_remove( &lock
->fd_entry
);
1229 list_remove( &lock
->inode_entry
);
1230 list_remove( &lock
->proc_entry
);
1231 if (remove_unix
) remove_unix_locks( lock
->fd
, lock
->start
, lock
->end
);
1232 if (list_empty( &inode
->locks
)) inode_close_pending( inode
, 1 );
1233 lock
->process
= NULL
;
1234 wake_up( &lock
->obj
, 0 );
1235 release_object( lock
);
1238 /* remove all locks owned by a given process */
1239 void remove_process_locks( struct process
*process
)
1243 while ((ptr
= list_head( &process
->locks
)))
1245 struct file_lock
*lock
= LIST_ENTRY( ptr
, struct file_lock
, proc_entry
);
1246 remove_lock( lock
, 1 ); /* this removes it from the list */
1250 /* remove all locks on a given fd */
1251 static void remove_fd_locks( struct fd
*fd
)
1253 file_pos_t start
= FILE_POS_T_MAX
, end
= 0;
1256 while ((ptr
= list_head( &fd
->locks
)))
1258 struct file_lock
*lock
= LIST_ENTRY( ptr
, struct file_lock
, fd_entry
);
1259 if (lock
->start
< start
) start
= lock
->start
;
1260 if (!lock
->end
|| lock
->end
> end
) end
= lock
->end
- 1;
1261 remove_lock( lock
, 0 );
1263 if (start
< end
) remove_unix_locks( fd
, start
, end
+ 1 );
1266 /* add a lock on an fd */
1267 /* returns handle to wait on */
1268 obj_handle_t
lock_fd( struct fd
*fd
, file_pos_t start
, file_pos_t count
, int shared
, int wait
)
1271 file_pos_t end
= start
+ count
;
1273 if (!fd
->inode
) /* not a regular file */
1275 set_error( STATUS_INVALID_DEVICE_REQUEST
);
1279 /* don't allow wrapping locks */
1280 if (end
&& end
< start
)
1282 set_error( STATUS_INVALID_PARAMETER
);
1286 /* check if another lock on that file overlaps the area */
1287 LIST_FOR_EACH( ptr
, &fd
->inode
->locks
)
1289 struct file_lock
*lock
= LIST_ENTRY( ptr
, struct file_lock
, inode_entry
);
1290 if (!lock_overlaps( lock
, start
, end
)) continue;
1291 if (lock
->shared
&& shared
) continue;
1295 set_error( STATUS_FILE_LOCK_CONFLICT
);
1298 set_error( STATUS_PENDING
);
1299 return alloc_handle( current
->process
, lock
, SYNCHRONIZE
, 0 );
1302 /* not found, add it */
1303 if (add_lock( fd
, shared
, start
, end
)) return 0;
1304 if (get_error() == STATUS_FILE_LOCK_CONFLICT
)
1306 /* Unix lock conflict -> tell client to wait and retry */
1307 if (wait
) set_error( STATUS_PENDING
);
1312 /* remove a lock on an fd */
1313 void unlock_fd( struct fd
*fd
, file_pos_t start
, file_pos_t count
)
1316 file_pos_t end
= start
+ count
;
1318 /* find an existing lock with the exact same parameters */
1319 LIST_FOR_EACH( ptr
, &fd
->locks
)
1321 struct file_lock
*lock
= LIST_ENTRY( ptr
, struct file_lock
, fd_entry
);
1322 if ((lock
->start
== start
) && (lock
->end
== end
))
1324 remove_lock( lock
, 1 );
1328 set_error( STATUS_FILE_LOCK_CONFLICT
);
1332 /****************************************************************/
1333 /* file descriptor functions */
1335 static void fd_dump( struct object
*obj
, int verbose
)
1337 struct fd
*fd
= (struct fd
*)obj
;
1338 fprintf( stderr
, "Fd unix_fd=%d user=%p options=%08x", fd
->unix_fd
, fd
->user
, fd
->options
);
1339 if (fd
->inode
) fprintf( stderr
, " inode=%p unlink='%s'", fd
->inode
, fd
->closed
->unlink
);
1340 fprintf( stderr
, "\n" );
1343 static void fd_destroy( struct object
*obj
)
1345 struct fd
*fd
= (struct fd
*)obj
;
1347 free_async_queue( fd
->read_q
);
1348 free_async_queue( fd
->write_q
);
1349 free_async_queue( fd
->wait_q
);
1351 if (fd
->completion
) release_object( fd
->completion
);
1352 remove_fd_locks( fd
);
1353 list_remove( &fd
->inode_entry
);
1354 if (fd
->poll_index
!= -1) remove_poll_user( fd
, fd
->poll_index
);
1357 inode_add_closed_fd( fd
->inode
, fd
->closed
);
1358 release_object( fd
->inode
);
1360 else /* no inode, close it right away */
1362 if (fd
->unix_fd
!= -1) close( fd
->unix_fd
);
1366 /* set the events that select waits for on this fd */
1367 void set_fd_events( struct fd
*fd
, int events
)
1369 int user
= fd
->poll_index
;
1370 assert( poll_users
[user
] == fd
);
1372 set_fd_epoll_events( fd
, user
, events
);
1374 if (events
== -1) /* stop waiting on this fd completely */
1376 pollfd
[user
].fd
= -1;
1377 pollfd
[user
].events
= POLLERR
;
1378 pollfd
[user
].revents
= 0;
1380 else if (pollfd
[user
].fd
!= -1 || !pollfd
[user
].events
)
1382 pollfd
[user
].fd
= fd
->unix_fd
;
1383 pollfd
[user
].events
= events
;
1387 /* prepare an fd for unmounting its corresponding device */
1388 static inline void unmount_fd( struct fd
*fd
)
1390 assert( fd
->inode
);
1392 async_wake_up( fd
->read_q
, STATUS_VOLUME_DISMOUNTED
);
1393 async_wake_up( fd
->write_q
, STATUS_VOLUME_DISMOUNTED
);
1395 if (fd
->poll_index
!= -1) set_fd_events( fd
, -1 );
1397 if (fd
->unix_fd
!= -1) close( fd
->unix_fd
);
1400 fd
->no_fd_status
= STATUS_VOLUME_DISMOUNTED
;
1401 fd
->closed
->unix_fd
= -1;
1402 fd
->closed
->unlink
[0] = 0;
1404 /* stop using Unix locks on this fd (existing locks have been removed by close) */
1408 /* allocate an fd object, without setting the unix fd yet */
1409 static struct fd
*alloc_fd_object(void)
1411 struct fd
*fd
= alloc_object( &fd_ops
);
1413 if (!fd
) return NULL
;
1425 fd
->poll_index
= -1;
1429 fd
->completion
= NULL
;
1430 list_init( &fd
->inode_entry
);
1431 list_init( &fd
->locks
);
1433 if ((fd
->poll_index
= add_poll_user( fd
)) == -1)
1435 release_object( fd
);
1441 /* allocate a pseudo fd object, for objects that need to behave like files but don't have a unix fd */
1442 struct fd
*alloc_pseudo_fd( const struct fd_ops
*fd_user_ops
, struct object
*user
, unsigned int options
)
1444 struct fd
*fd
= alloc_object( &fd_ops
);
1446 if (!fd
) return NULL
;
1448 fd
->fd_ops
= fd_user_ops
;
1453 fd
->options
= options
;
1458 fd
->poll_index
= -1;
1462 fd
->completion
= NULL
;
1463 fd
->no_fd_status
= STATUS_BAD_DEVICE_TYPE
;
1464 list_init( &fd
->inode_entry
);
1465 list_init( &fd
->locks
);
1469 /* set the status to return when the fd has no associated unix fd */
1470 void set_no_fd_status( struct fd
*fd
, unsigned int status
)
1472 fd
->no_fd_status
= status
;
1475 /* check if the desired access is possible without violating */
1476 /* the sharing mode of other opens of the same file */
1477 static int check_sharing( struct fd
*fd
, unsigned int access
, unsigned int sharing
)
1479 unsigned int existing_sharing
= FILE_SHARE_READ
| FILE_SHARE_WRITE
| FILE_SHARE_DELETE
;
1480 unsigned int existing_access
= 0;
1483 /* if access mode is 0, sharing mode is ignored */
1484 if (!access
) sharing
= existing_sharing
;
1485 fd
->access
= access
;
1486 fd
->sharing
= sharing
;
1488 LIST_FOR_EACH( ptr
, &fd
->inode
->open
)
1490 struct fd
*fd_ptr
= LIST_ENTRY( ptr
, struct fd
, inode_entry
);
1493 existing_sharing
&= fd_ptr
->sharing
;
1494 existing_access
|= fd_ptr
->access
;
1498 if ((access
& FILE_UNIX_READ_ACCESS
) && !(existing_sharing
& FILE_SHARE_READ
)) return 0;
1499 if ((access
& FILE_UNIX_WRITE_ACCESS
) && !(existing_sharing
& FILE_SHARE_WRITE
)) return 0;
1500 if ((access
& DELETE
) && !(existing_sharing
& FILE_SHARE_DELETE
)) return 0;
1501 if ((existing_access
& FILE_UNIX_READ_ACCESS
) && !(sharing
& FILE_SHARE_READ
)) return 0;
1502 if ((existing_access
& FILE_UNIX_WRITE_ACCESS
) && !(sharing
& FILE_SHARE_WRITE
)) return 0;
1503 if ((existing_access
& DELETE
) && !(sharing
& FILE_SHARE_DELETE
)) return 0;
1507 /* sets the user of an fd that previously had no user */
1508 void set_fd_user( struct fd
*fd
, const struct fd_ops
*user_ops
, struct object
*user
)
1510 assert( fd
->fd_ops
== NULL
);
1511 fd
->fd_ops
= user_ops
;
1515 /* open() wrapper that returns a struct fd with no fd user set */
1516 struct fd
*open_fd( const char *name
, int flags
, mode_t
*mode
, unsigned int access
,
1517 unsigned int sharing
, unsigned int options
)
1520 struct closed_fd
*closed_fd
;
1522 const char *unlink_name
= "";
1525 if ((options
& FILE_DELETE_ON_CLOSE
) && !(access
& DELETE
))
1527 set_error( STATUS_INVALID_PARAMETER
);
1531 if (!(fd
= alloc_fd_object())) return NULL
;
1533 fd
->options
= options
;
1534 if (options
& FILE_DELETE_ON_CLOSE
) unlink_name
= name
;
1535 if (!(closed_fd
= mem_alloc( sizeof(*closed_fd
) + strlen(unlink_name
) )))
1537 release_object( fd
);
1541 /* create the directory if needed */
1542 if ((options
& FILE_DIRECTORY_FILE
) && (flags
& O_CREAT
))
1544 if (mkdir( name
, 0777 ) == -1)
1546 if (errno
!= EEXIST
|| (flags
& O_EXCL
))
1552 flags
&= ~(O_CREAT
| O_EXCL
| O_TRUNC
);
1555 if ((access
& FILE_UNIX_WRITE_ACCESS
) && !(options
& FILE_DIRECTORY_FILE
))
1557 if (access
& FILE_UNIX_READ_ACCESS
) rw_mode
= O_RDWR
;
1558 else rw_mode
= O_WRONLY
;
1560 else rw_mode
= O_RDONLY
;
1562 if ((fd
->unix_fd
= open( name
, rw_mode
| (flags
& ~O_TRUNC
), *mode
)) == -1)
1564 /* if we tried to open a directory for write access, retry read-only */
1565 if (errno
!= EISDIR
||
1566 !(access
& FILE_UNIX_WRITE_ACCESS
) ||
1567 (fd
->unix_fd
= open( name
, O_RDONLY
| (flags
& ~O_TRUNC
), *mode
)) == -1)
1574 closed_fd
->unix_fd
= fd
->unix_fd
;
1575 closed_fd
->unlink
[0] = 0;
1576 fstat( fd
->unix_fd
, &st
);
1579 /* only bother with an inode for normal files and directories */
1580 if (S_ISREG(st
.st_mode
) || S_ISDIR(st
.st_mode
))
1582 struct inode
*inode
= get_inode( st
.st_dev
, st
.st_ino
, fd
->unix_fd
);
1586 /* we can close the fd because there are no others open on the same file,
1587 * otherwise we wouldn't have failed to allocate a new inode
1592 fd
->closed
= closed_fd
;
1593 list_add_head( &inode
->open
, &fd
->inode_entry
);
1595 /* check directory options */
1596 if ((options
& FILE_DIRECTORY_FILE
) && !S_ISDIR(st
.st_mode
))
1598 release_object( fd
);
1599 set_error( STATUS_NOT_A_DIRECTORY
);
1602 if ((options
& FILE_NON_DIRECTORY_FILE
) && S_ISDIR(st
.st_mode
))
1604 release_object( fd
);
1605 set_error( STATUS_FILE_IS_A_DIRECTORY
);
1608 if (!check_sharing( fd
, access
, sharing
))
1610 release_object( fd
);
1611 set_error( STATUS_SHARING_VIOLATION
);
1614 strcpy( closed_fd
->unlink
, unlink_name
);
1615 if (flags
& O_TRUNC
) ftruncate( fd
->unix_fd
, 0 );
1617 else /* special file */
1619 if (options
& FILE_DIRECTORY_FILE
)
1621 set_error( STATUS_NOT_A_DIRECTORY
);
1624 if (unlink_name
[0]) /* we can't unlink special files */
1626 set_error( STATUS_INVALID_PARAMETER
);
1634 release_object( fd
);
1639 /* create an fd for an anonymous file */
1640 /* if the function fails the unix fd is closed */
1641 struct fd
*create_anonymous_fd( const struct fd_ops
*fd_user_ops
, int unix_fd
, struct object
*user
,
1642 unsigned int options
)
1644 struct fd
*fd
= alloc_fd_object();
1648 set_fd_user( fd
, fd_user_ops
, user
);
1649 fd
->unix_fd
= unix_fd
;
1650 fd
->options
= options
;
1657 /* retrieve the object that is using an fd */
1658 void *get_fd_user( struct fd
*fd
)
1663 /* retrieve the opening options for the fd */
1664 unsigned int get_fd_options( struct fd
*fd
)
1669 /* retrieve the unix fd for an object */
1670 int get_unix_fd( struct fd
*fd
)
1672 if (fd
->unix_fd
== -1) set_error( fd
->no_fd_status
);
1676 /* check if two file descriptors point to the same file */
1677 int is_same_file_fd( struct fd
*fd1
, struct fd
*fd2
)
1679 return fd1
->inode
== fd2
->inode
;
1682 /* check if fd is on a removable device */
1683 int is_fd_removable( struct fd
*fd
)
1685 return (fd
->inode
&& fd
->inode
->device
->removable
);
1688 /* set or clear the fd signaled state */
1689 void set_fd_signaled( struct fd
*fd
, int signaled
)
1691 fd
->signaled
= signaled
;
1692 if (signaled
) wake_up( fd
->user
, 0 );
1695 /* handler for close_handle that refuses to close fd-associated handles in other processes */
1696 int fd_close_handle( struct object
*obj
, struct process
*process
, obj_handle_t handle
)
1698 return (!current
|| current
->process
== process
);
1701 /* check if events are pending and if yes return which one(s) */
1702 int check_fd_events( struct fd
*fd
, int events
)
1706 if (fd
->unix_fd
== -1) return POLLERR
;
1707 if (fd
->inode
) return events
; /* regular files are always signaled */
1709 pfd
.fd
= fd
->unix_fd
;
1710 pfd
.events
= events
;
1711 if (poll( &pfd
, 1, 0 ) <= 0) return 0;
1715 /* default signaled() routine for objects that poll() on an fd */
1716 int default_fd_signaled( struct object
*obj
, struct thread
*thread
)
1718 struct fd
*fd
= get_obj_fd( obj
);
1719 int ret
= fd
->signaled
;
1720 release_object( fd
);
1724 /* default map_access() routine for objects that behave like an fd */
1725 unsigned int default_fd_map_access( struct object
*obj
, unsigned int access
)
1727 if (access
& GENERIC_READ
) access
|= FILE_GENERIC_READ
;
1728 if (access
& GENERIC_WRITE
) access
|= FILE_GENERIC_WRITE
;
1729 if (access
& GENERIC_EXECUTE
) access
|= FILE_GENERIC_EXECUTE
;
1730 if (access
& GENERIC_ALL
) access
|= FILE_ALL_ACCESS
;
1731 return access
& ~(GENERIC_READ
| GENERIC_WRITE
| GENERIC_EXECUTE
| GENERIC_ALL
);
1734 int default_fd_get_poll_events( struct fd
*fd
)
1738 if (async_waiting( fd
->read_q
)) events
|= POLLIN
;
1739 if (async_waiting( fd
->write_q
)) events
|= POLLOUT
;
1743 /* default handler for poll() events */
1744 void default_poll_event( struct fd
*fd
, int event
)
1746 if (event
& (POLLIN
| POLLERR
| POLLHUP
)) async_wake_up( fd
->read_q
, STATUS_ALERTED
);
1747 if (event
& (POLLOUT
| POLLERR
| POLLHUP
)) async_wake_up( fd
->write_q
, STATUS_ALERTED
);
1749 /* if an error occurred, stop polling this fd to avoid busy-looping */
1750 if (event
& (POLLERR
| POLLHUP
)) set_fd_events( fd
, -1 );
1751 else if (!fd
->inode
) set_fd_events( fd
, fd
->fd_ops
->get_poll_events( fd
) );
1754 struct async
*fd_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
, int count
)
1756 struct async_queue
*queue
;
1757 struct async
*async
;
1761 case ASYNC_TYPE_READ
:
1762 if (!fd
->read_q
&& !(fd
->read_q
= create_async_queue( fd
))) return NULL
;
1765 case ASYNC_TYPE_WRITE
:
1766 if (!fd
->write_q
&& !(fd
->write_q
= create_async_queue( fd
))) return NULL
;
1767 queue
= fd
->write_q
;
1769 case ASYNC_TYPE_WAIT
:
1770 if (!fd
->wait_q
&& !(fd
->wait_q
= create_async_queue( fd
))) return NULL
;
1778 if ((async
= create_async( current
, queue
, data
)) && type
!= ASYNC_TYPE_WAIT
)
1781 set_fd_events( fd
, fd
->fd_ops
->get_poll_events( fd
) );
1782 else /* regular files are always ready for read and write */
1783 async_wake_up( queue
, STATUS_ALERTED
);
1788 void fd_async_wake_up( struct fd
*fd
, int type
, unsigned int status
)
1792 case ASYNC_TYPE_READ
:
1793 async_wake_up( fd
->read_q
, status
);
1795 case ASYNC_TYPE_WRITE
:
1796 async_wake_up( fd
->write_q
, status
);
1798 case ASYNC_TYPE_WAIT
:
1799 async_wake_up( fd
->wait_q
, status
);
1806 void fd_reselect_async( struct fd
*fd
, struct async_queue
*queue
)
1808 fd
->fd_ops
->reselect_async( fd
, queue
);
1811 void default_fd_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
, int count
)
1813 struct async
*async
;
1815 if ((async
= fd_queue_async( fd
, data
, type
, count
)))
1817 release_object( async
);
1818 set_error( STATUS_PENDING
);
1822 /* default reselect_async() fd routine */
1823 void default_fd_reselect_async( struct fd
*fd
, struct async_queue
*queue
)
1825 if (queue
!= fd
->wait_q
)
1827 int poll_events
= fd
->fd_ops
->get_poll_events( fd
);
1828 int events
= check_fd_events( fd
, poll_events
);
1829 if (events
) fd
->fd_ops
->poll_event( fd
, events
);
1830 else set_fd_events( fd
, poll_events
);
1834 /* default cancel_async() fd routine */
1835 void default_fd_cancel_async( struct fd
*fd
)
1837 async_wake_up( fd
->read_q
, STATUS_CANCELLED
);
1838 async_wake_up( fd
->write_q
, STATUS_CANCELLED
);
1839 async_wake_up( fd
->wait_q
, STATUS_CANCELLED
);
1842 /* default flush() routine */
1843 void no_flush( struct fd
*fd
, struct event
**event
)
1845 set_error( STATUS_OBJECT_TYPE_MISMATCH
);
1848 static inline int is_valid_mounted_device( struct stat
*st
)
1850 #if defined(linux) || defined(__sun__)
1851 return S_ISBLK( st
->st_mode
);
1853 /* disks are char devices on *BSD */
1854 return S_ISCHR( st
->st_mode
);
1858 /* close all Unix file descriptors on a device to allow unmounting it */
1859 static void unmount_device( struct fd
*device_fd
)
1863 struct device
*device
;
1864 struct inode
*inode
;
1866 int unix_fd
= get_unix_fd( device_fd
);
1868 if (unix_fd
== -1) return;
1870 if (fstat( unix_fd
, &st
) == -1 || !is_valid_mounted_device( &st
))
1872 set_error( STATUS_INVALID_PARAMETER
);
1876 if (!(device
= get_device( st
.st_rdev
, -1 ))) return;
1878 for (i
= 0; i
< INODE_HASH_SIZE
; i
++)
1880 LIST_FOR_EACH_ENTRY( inode
, &device
->inode_hash
[i
], struct inode
, entry
)
1882 LIST_FOR_EACH_ENTRY( fd
, &inode
->open
, struct fd
, inode_entry
)
1886 inode_close_pending( inode
, 0 );
1889 /* remove it from the hash table */
1890 list_remove( &device
->entry
);
1891 list_init( &device
->entry
);
1892 release_object( device
);
1895 /* default ioctl() routine */
1896 obj_handle_t
default_fd_ioctl( struct fd
*fd
, ioctl_code_t code
, const async_data_t
*async
,
1897 const void *data
, data_size_t size
)
1901 case FSCTL_DISMOUNT_VOLUME
:
1902 unmount_device( fd
);
1905 set_error( STATUS_NOT_SUPPORTED
);
1910 /* same as get_handle_obj but retrieve the struct fd associated to the object */
1911 static struct fd
*get_handle_fd_obj( struct process
*process
, obj_handle_t handle
,
1912 unsigned int access
)
1914 struct fd
*fd
= NULL
;
1917 if ((obj
= get_handle_obj( process
, handle
, access
, NULL
)))
1919 fd
= get_obj_fd( obj
);
1920 release_object( obj
);
1925 void fd_assign_completion( struct fd
*fd
, struct completion
**p_port
, unsigned long *p_key
)
1927 *p_key
= fd
->comp_key
;
1928 *p_port
= fd
->completion
? (struct completion
*)grab_object( fd
->completion
) : NULL
;
1931 /* flush a file buffers */
1932 DECL_HANDLER(flush_file
)
1934 struct fd
*fd
= get_handle_fd_obj( current
->process
, req
->handle
, 0 );
1935 struct event
* event
= NULL
;
1939 fd
->fd_ops
->flush( fd
, &event
);
1942 reply
->event
= alloc_handle( current
->process
, event
, SYNCHRONIZE
, 0 );
1944 release_object( fd
);
1948 /* open a file object */
1949 DECL_HANDLER(open_file_object
)
1951 struct unicode_str name
;
1952 struct directory
*root
= NULL
;
1953 struct object
*obj
, *result
;
1955 get_req_unicode_str( &name
);
1956 if (req
->rootdir
&& !(root
= get_directory_obj( current
->process
, req
->rootdir
, 0 )))
1959 if ((obj
= open_object_dir( root
, &name
, req
->attributes
, NULL
)))
1961 if ((result
= obj
->ops
->open_file( obj
, req
->access
, req
->sharing
, req
->options
)))
1963 reply
->handle
= alloc_handle( current
->process
, result
, req
->access
, req
->attributes
);
1964 release_object( result
);
1966 release_object( obj
);
1969 if (root
) release_object( root
);
1972 /* get a Unix fd to access a file */
1973 DECL_HANDLER(get_handle_fd
)
1977 if ((fd
= get_handle_fd_obj( current
->process
, req
->handle
, 0 )))
1979 int unix_fd
= get_unix_fd( fd
);
1982 send_client_fd( current
->process
, unix_fd
, req
->handle
);
1983 reply
->type
= fd
->fd_ops
->get_fd_type( fd
);
1984 reply
->removable
= is_fd_removable(fd
);
1985 reply
->options
= fd
->options
;
1986 reply
->access
= get_handle_access( current
->process
, req
->handle
);
1988 release_object( fd
);
1992 /* perform an ioctl on a file */
1995 unsigned int access
= (req
->code
>> 14) & (FILE_READ_DATA
|FILE_WRITE_DATA
);
1996 struct fd
*fd
= get_handle_fd_obj( current
->process
, req
->handle
, access
);
2000 reply
->wait
= fd
->fd_ops
->ioctl( fd
, req
->code
, &req
->async
,
2001 get_req_data(), get_req_data_size() );
2002 reply
->options
= fd
->options
;
2003 release_object( fd
);
2007 /* create / reschedule an async I/O */
2008 DECL_HANDLER(register_async
)
2010 unsigned int access
;
2015 case ASYNC_TYPE_READ
:
2016 access
= FILE_READ_DATA
;
2018 case ASYNC_TYPE_WRITE
:
2019 access
= FILE_WRITE_DATA
;
2022 set_error( STATUS_INVALID_PARAMETER
);
2026 if ((fd
= get_handle_fd_obj( current
->process
, req
->handle
, access
)))
2028 if (get_unix_fd( fd
) != -1) fd
->fd_ops
->queue_async( fd
, &req
->async
, req
->type
, req
->count
);
2029 release_object( fd
);
2033 /* cancels all async I/O */
2034 DECL_HANDLER(cancel_async
)
2036 struct fd
*fd
= get_handle_fd_obj( current
->process
, req
->handle
, 0 );
2040 if (get_unix_fd( fd
) != -1) fd
->fd_ops
->cancel_async( fd
);
2041 release_object( fd
);
2045 /* attach completion object to a fd */
2046 DECL_HANDLER(set_completion_info
)
2048 struct fd
*fd
= get_handle_fd_obj( current
->process
, req
->handle
, 0 );
2052 if (!(fd
->options
& (FILE_SYNCHRONOUS_IO_ALERT
| FILE_SYNCHRONOUS_IO_NONALERT
)) && !fd
->completion
)
2054 fd
->completion
= get_completion_obj( current
->process
, req
->chandle
, IO_COMPLETION_MODIFY_STATE
);
2055 fd
->comp_key
= req
->ckey
;
2057 else set_error( STATUS_INVALID_PARAMETER
);
2058 release_object( fd
);
2062 /* push new completion msg into a completion queue attached to the fd */
2063 DECL_HANDLER(add_fd_completion
)
2065 struct fd
*fd
= get_handle_fd_obj( current
->process
, req
->handle
, 0 );
2069 add_completion( fd
->completion
, fd
->comp_key
, req
->cvalue
, req
->status
, req
->information
);
2070 release_object( fd
);