ntdll: Fix the Mac build with SDKs older than 10.14.
[wine.git] / server / fd.c
blob5d80e218b9761ff6caa8edd87e7900255f4a1b4d
1 /*
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
22 #include "config.h"
23 #include "wine/port.h"
25 #include <assert.h>
26 #include <errno.h>
27 #include <fcntl.h>
28 #include <limits.h>
29 #include <signal.h>
30 #include <stdarg.h>
31 #include <stdio.h>
32 #include <string.h>
33 #include <stdlib.h>
34 #ifdef HAVE_POLL_H
35 #include <poll.h>
36 #endif
37 #ifdef HAVE_SYS_POLL_H
38 #include <sys/poll.h>
39 #endif
40 #ifdef HAVE_LINUX_MAJOR_H
41 #include <linux/major.h>
42 #endif
43 #ifdef HAVE_SYS_STATVFS_H
44 #include <sys/statvfs.h>
45 #endif
46 #ifdef HAVE_SYS_VFS_H
47 /* Work around a conflict with Solaris' system list defined in sys/list.h. */
48 #define list SYSLIST
49 #define list_next SYSLIST_NEXT
50 #define list_prev SYSLIST_PREV
51 #define list_head SYSLIST_HEAD
52 #define list_tail SYSLIST_TAIL
53 #define list_move_tail SYSLIST_MOVE_TAIL
54 #define list_remove SYSLIST_REMOVE
55 #include <sys/vfs.h>
56 #undef list
57 #undef list_next
58 #undef list_prev
59 #undef list_head
60 #undef list_tail
61 #undef list_move_tail
62 #undef list_remove
63 #endif
64 #ifdef HAVE_SYS_PARAM_H
65 #include <sys/param.h>
66 #endif
67 #ifdef HAVE_SYS_MOUNT_H
68 #include <sys/mount.h>
69 #endif
70 #ifdef HAVE_SYS_STATFS_H
71 #include <sys/statfs.h>
72 #endif
73 #ifdef HAVE_SYS_SYSCTL_H
74 #include <sys/sysctl.h>
75 #endif
76 #ifdef HAVE_SYS_EVENT_H
77 #include <sys/event.h>
78 #undef LIST_INIT
79 #undef LIST_ENTRY
80 #endif
81 #ifdef HAVE_STDINT_H
82 #include <stdint.h>
83 #endif
84 #include <sys/stat.h>
85 #include <sys/time.h>
86 #ifdef MAJOR_IN_MKDEV
87 #include <sys/mkdev.h>
88 #elif defined(MAJOR_IN_SYSMACROS)
89 #include <sys/sysmacros.h>
90 #endif
91 #include <sys/types.h>
92 #include <unistd.h>
93 #ifdef HAVE_SYS_SYSCALL_H
94 #include <sys/syscall.h>
95 #endif
97 #include "ntstatus.h"
98 #define WIN32_NO_STATUS
99 #include "object.h"
100 #include "file.h"
101 #include "handle.h"
102 #include "process.h"
103 #include "request.h"
105 #include "winternl.h"
106 #include "winioctl.h"
108 #if defined(HAVE_SYS_EPOLL_H) && defined(HAVE_EPOLL_CREATE)
109 # include <sys/epoll.h>
110 # define USE_EPOLL
111 #elif defined(linux) && defined(__i386__) && defined(HAVE_STDINT_H)
112 # define USE_EPOLL
113 # define EPOLLIN POLLIN
114 # define EPOLLOUT POLLOUT
115 # define EPOLLERR POLLERR
116 # define EPOLLHUP POLLHUP
117 # define EPOLL_CTL_ADD 1
118 # define EPOLL_CTL_DEL 2
119 # define EPOLL_CTL_MOD 3
121 typedef union epoll_data
123 void *ptr;
124 int fd;
125 uint32_t u32;
126 uint64_t u64;
127 } epoll_data_t;
129 struct epoll_event
131 uint32_t events;
132 epoll_data_t data;
135 static inline int epoll_create( int size )
137 return syscall( 254 /*NR_epoll_create*/, size );
140 static inline int epoll_ctl( int epfd, int op, int fd, const struct epoll_event *event )
142 return syscall( 255 /*NR_epoll_ctl*/, epfd, op, fd, event );
145 static inline int epoll_wait( int epfd, struct epoll_event *events, int maxevents, int timeout )
147 return syscall( 256 /*NR_epoll_wait*/, epfd, events, maxevents, timeout );
150 #endif /* linux && __i386__ && HAVE_STDINT_H */
152 #if defined(HAVE_PORT_H) && defined(HAVE_PORT_CREATE)
153 # include <port.h>
154 # define USE_EVENT_PORTS
155 #endif /* HAVE_PORT_H && HAVE_PORT_CREATE */
157 /* Because of the stupid Posix locking semantics, we need to keep
158 * track of all file descriptors referencing a given file, and not
159 * close a single one until all the locks are gone (sigh).
162 /* file descriptor object */
164 /* closed_fd is used to keep track of the unix fd belonging to a closed fd object */
165 struct closed_fd
167 struct list entry; /* entry in inode closed list */
168 int unix_fd; /* the unix file descriptor */
169 int unlink; /* whether to unlink on close: -1 - implicit FILE_DELETE_ON_CLOSE, 1 - explicit disposition */
170 char *unix_name; /* name to unlink on close, points to parent fd unix_name */
173 struct fd
175 struct object obj; /* object header */
176 const struct fd_ops *fd_ops; /* file descriptor operations */
177 struct inode *inode; /* inode that this fd belongs to */
178 struct list inode_entry; /* entry in inode fd list */
179 struct closed_fd *closed; /* structure to store the unix fd at destroy time */
180 struct object *user; /* object using this file descriptor */
181 struct list locks; /* list of locks on this fd */
182 unsigned int access; /* file access (FILE_READ_DATA etc.) */
183 unsigned int options; /* file options (FILE_DELETE_ON_CLOSE, FILE_SYNCHRONOUS...) */
184 unsigned int sharing; /* file sharing mode */
185 char *unix_name; /* unix file name */
186 int unix_fd; /* unix file descriptor */
187 unsigned int no_fd_status;/* status to return when unix_fd is -1 */
188 unsigned int cacheable :1;/* can the fd be cached on the client side? */
189 unsigned int signaled :1; /* is the fd signaled? */
190 unsigned int fs_locks :1; /* can we use filesystem locks for this fd? */
191 int poll_index; /* index of fd in poll array */
192 struct async_queue read_q; /* async readers of this fd */
193 struct async_queue write_q; /* async writers of this fd */
194 struct async_queue wait_q; /* other async waiters of this fd */
195 struct completion *completion; /* completion object attached to this fd */
196 apc_param_t comp_key; /* completion key to set in completion events */
197 unsigned int comp_flags; /* completion flags */
200 static void fd_dump( struct object *obj, int verbose );
201 static void fd_destroy( struct object *obj );
203 static const struct object_ops fd_ops =
205 sizeof(struct fd), /* size */
206 fd_dump, /* dump */
207 no_get_type, /* get_type */
208 no_add_queue, /* add_queue */
209 NULL, /* remove_queue */
210 NULL, /* signaled */
211 NULL, /* satisfied */
212 no_signal, /* signal */
213 no_get_fd, /* get_fd */
214 no_map_access, /* map_access */
215 default_get_sd, /* get_sd */
216 default_set_sd, /* set_sd */
217 no_lookup_name, /* lookup_name */
218 no_link_name, /* link_name */
219 NULL, /* unlink_name */
220 no_open_file, /* open_file */
221 no_kernel_obj_list, /* get_kernel_obj_list */
222 no_close_handle, /* close_handle */
223 fd_destroy /* destroy */
226 /* device object */
228 #define DEVICE_HASH_SIZE 7
229 #define INODE_HASH_SIZE 17
231 struct device
233 struct object obj; /* object header */
234 struct list entry; /* entry in device hash list */
235 dev_t dev; /* device number */
236 int removable; /* removable device? (or -1 if unknown) */
237 struct list inode_hash[INODE_HASH_SIZE]; /* inodes hash table */
240 static void device_dump( struct object *obj, int verbose );
241 static void device_destroy( struct object *obj );
243 static const struct object_ops device_ops =
245 sizeof(struct device), /* size */
246 device_dump, /* dump */
247 no_get_type, /* get_type */
248 no_add_queue, /* add_queue */
249 NULL, /* remove_queue */
250 NULL, /* signaled */
251 NULL, /* satisfied */
252 no_signal, /* signal */
253 no_get_fd, /* get_fd */
254 no_map_access, /* map_access */
255 default_get_sd, /* get_sd */
256 default_set_sd, /* set_sd */
257 no_lookup_name, /* lookup_name */
258 no_link_name, /* link_name */
259 NULL, /* unlink_name */
260 no_open_file, /* open_file */
261 no_kernel_obj_list, /* get_kernel_obj_list */
262 no_close_handle, /* close_handle */
263 device_destroy /* destroy */
266 /* inode object */
268 struct inode
270 struct object obj; /* object header */
271 struct list entry; /* inode hash list entry */
272 struct device *device; /* device containing this inode */
273 ino_t ino; /* inode number */
274 struct list open; /* list of open file descriptors */
275 struct list locks; /* list of file locks */
276 struct list closed; /* list of file descriptors to close at destroy time */
279 static void inode_dump( struct object *obj, int verbose );
280 static void inode_destroy( struct object *obj );
282 static const struct object_ops inode_ops =
284 sizeof(struct inode), /* size */
285 inode_dump, /* dump */
286 no_get_type, /* get_type */
287 no_add_queue, /* add_queue */
288 NULL, /* remove_queue */
289 NULL, /* signaled */
290 NULL, /* satisfied */
291 no_signal, /* signal */
292 no_get_fd, /* get_fd */
293 no_map_access, /* map_access */
294 default_get_sd, /* get_sd */
295 default_set_sd, /* set_sd */
296 no_lookup_name, /* lookup_name */
297 no_link_name, /* link_name */
298 NULL, /* unlink_name */
299 no_open_file, /* open_file */
300 no_kernel_obj_list, /* get_kernel_obj_list */
301 no_close_handle, /* close_handle */
302 inode_destroy /* destroy */
305 /* file lock object */
307 struct file_lock
309 struct object obj; /* object header */
310 struct fd *fd; /* fd owning this lock */
311 struct list fd_entry; /* entry in list of locks on a given fd */
312 struct list inode_entry; /* entry in inode list of locks */
313 int shared; /* shared lock? */
314 file_pos_t start; /* locked region is interval [start;end) */
315 file_pos_t end;
316 struct process *process; /* process owning this lock */
317 struct list proc_entry; /* entry in list of locks owned by the process */
320 static void file_lock_dump( struct object *obj, int verbose );
321 static int file_lock_signaled( struct object *obj, struct wait_queue_entry *entry );
323 static const struct object_ops file_lock_ops =
325 sizeof(struct file_lock), /* size */
326 file_lock_dump, /* dump */
327 no_get_type, /* get_type */
328 add_queue, /* add_queue */
329 remove_queue, /* remove_queue */
330 file_lock_signaled, /* signaled */
331 no_satisfied, /* satisfied */
332 no_signal, /* signal */
333 no_get_fd, /* get_fd */
334 no_map_access, /* map_access */
335 default_get_sd, /* get_sd */
336 default_set_sd, /* set_sd */
337 no_lookup_name, /* lookup_name */
338 no_link_name, /* link_name */
339 NULL, /* unlink_name */
340 no_open_file, /* open_file */
341 no_kernel_obj_list, /* get_kernel_obj_list */
342 no_close_handle, /* close_handle */
343 no_destroy /* destroy */
347 #define OFF_T_MAX (~((file_pos_t)1 << (8*sizeof(off_t)-1)))
348 #define FILE_POS_T_MAX (~(file_pos_t)0)
350 static file_pos_t max_unix_offset = OFF_T_MAX;
352 #define DUMP_LONG_LONG(val) do { \
353 if (sizeof(val) > sizeof(unsigned long) && (val) > ~0UL) \
354 fprintf( stderr, "%lx%08lx", (unsigned long)((unsigned long long)(val) >> 32), (unsigned long)(val) ); \
355 else \
356 fprintf( stderr, "%lx", (unsigned long)(val) ); \
357 } while (0)
361 /****************************************************************/
362 /* timeouts support */
364 struct timeout_user
366 struct list entry; /* entry in sorted timeout list */
367 timeout_t when; /* timeout expiry (absolute time) */
368 timeout_callback callback; /* callback function */
369 void *private; /* callback private data */
372 static struct list timeout_list = LIST_INIT(timeout_list); /* sorted timeouts list */
373 timeout_t current_time;
375 static inline void set_current_time(void)
377 static const timeout_t ticks_1601_to_1970 = (timeout_t)86400 * (369 * 365 + 89) * TICKS_PER_SEC;
378 struct timeval now;
379 gettimeofday( &now, NULL );
380 current_time = (timeout_t)now.tv_sec * TICKS_PER_SEC + now.tv_usec * 10 + ticks_1601_to_1970;
383 /* add a timeout user */
384 struct timeout_user *add_timeout_user( timeout_t when, timeout_callback func, void *private )
386 struct timeout_user *user;
387 struct list *ptr;
389 if (!(user = mem_alloc( sizeof(*user) ))) return NULL;
390 user->when = (when > 0) ? when : current_time - when;
391 user->callback = func;
392 user->private = private;
394 /* Now insert it in the linked list */
396 LIST_FOR_EACH( ptr, &timeout_list )
398 struct timeout_user *timeout = LIST_ENTRY( ptr, struct timeout_user, entry );
399 if (timeout->when >= user->when) break;
401 list_add_before( ptr, &user->entry );
402 return user;
405 /* remove a timeout user */
406 void remove_timeout_user( struct timeout_user *user )
408 list_remove( &user->entry );
409 free( user );
412 /* return a text description of a timeout for debugging purposes */
413 const char *get_timeout_str( timeout_t timeout )
415 static char buffer[64];
416 long secs, nsecs;
418 if (!timeout) return "0";
419 if (timeout == TIMEOUT_INFINITE) return "infinite";
421 if (timeout < 0) /* relative */
423 secs = -timeout / TICKS_PER_SEC;
424 nsecs = -timeout % TICKS_PER_SEC;
425 sprintf( buffer, "+%ld.%07ld", secs, nsecs );
427 else /* absolute */
429 secs = (timeout - current_time) / TICKS_PER_SEC;
430 nsecs = (timeout - current_time) % TICKS_PER_SEC;
431 if (nsecs < 0)
433 nsecs += TICKS_PER_SEC;
434 secs--;
436 if (secs >= 0)
437 sprintf( buffer, "%x%08x (+%ld.%07ld)",
438 (unsigned int)(timeout >> 32), (unsigned int)timeout, secs, nsecs );
439 else
440 sprintf( buffer, "%x%08x (-%ld.%07ld)",
441 (unsigned int)(timeout >> 32), (unsigned int)timeout,
442 -(secs + 1), TICKS_PER_SEC - nsecs );
444 return buffer;
448 /****************************************************************/
449 /* poll support */
451 static struct fd **poll_users; /* users array */
452 static struct pollfd *pollfd; /* poll fd array */
453 static int nb_users; /* count of array entries actually in use */
454 static int active_users; /* current number of active users */
455 static int allocated_users; /* count of allocated entries in the array */
456 static struct fd **freelist; /* list of free entries in the array */
458 static int get_next_timeout(void);
460 static inline void fd_poll_event( struct fd *fd, int event )
462 fd->fd_ops->poll_event( fd, event );
465 #ifdef USE_EPOLL
467 static int epoll_fd = -1;
469 static inline void init_epoll(void)
471 epoll_fd = epoll_create( 128 );
474 /* set the events that epoll waits for on this fd; helper for set_fd_events */
475 static inline void set_fd_epoll_events( struct fd *fd, int user, int events )
477 struct epoll_event ev;
478 int ctl;
480 if (epoll_fd == -1) return;
482 if (events == -1) /* stop waiting on this fd completely */
484 if (pollfd[user].fd == -1) return; /* already removed */
485 ctl = EPOLL_CTL_DEL;
487 else if (pollfd[user].fd == -1)
489 if (pollfd[user].events) return; /* stopped waiting on it, don't restart */
490 ctl = EPOLL_CTL_ADD;
492 else
494 if (pollfd[user].events == events) return; /* nothing to do */
495 ctl = EPOLL_CTL_MOD;
498 ev.events = events;
499 memset(&ev.data, 0, sizeof(ev.data));
500 ev.data.u32 = user;
502 if (epoll_ctl( epoll_fd, ctl, fd->unix_fd, &ev ) == -1)
504 if (errno == ENOMEM) /* not enough memory, give up on epoll */
506 close( epoll_fd );
507 epoll_fd = -1;
509 else perror( "epoll_ctl" ); /* should not happen */
513 static inline void remove_epoll_user( struct fd *fd, int user )
515 if (epoll_fd == -1) return;
517 if (pollfd[user].fd != -1)
519 struct epoll_event dummy;
520 epoll_ctl( epoll_fd, EPOLL_CTL_DEL, fd->unix_fd, &dummy );
524 static inline void main_loop_epoll(void)
526 int i, ret, timeout;
527 struct epoll_event events[128];
529 assert( POLLIN == EPOLLIN );
530 assert( POLLOUT == EPOLLOUT );
531 assert( POLLERR == EPOLLERR );
532 assert( POLLHUP == EPOLLHUP );
534 if (epoll_fd == -1) return;
536 while (active_users)
538 timeout = get_next_timeout();
540 if (!active_users) break; /* last user removed by a timeout */
541 if (epoll_fd == -1) break; /* an error occurred with epoll */
543 ret = epoll_wait( epoll_fd, events, ARRAY_SIZE( events ), timeout );
544 set_current_time();
546 /* put the events into the pollfd array first, like poll does */
547 for (i = 0; i < ret; i++)
549 int user = events[i].data.u32;
550 pollfd[user].revents = events[i].events;
553 /* read events from the pollfd array, as set_fd_events may modify them */
554 for (i = 0; i < ret; i++)
556 int user = events[i].data.u32;
557 if (pollfd[user].revents) fd_poll_event( poll_users[user], pollfd[user].revents );
562 #elif defined(HAVE_KQUEUE)
564 static int kqueue_fd = -1;
566 static inline void init_epoll(void)
568 #ifdef __APPLE__ /* kqueue support is broken in Mac OS < 10.5 */
569 int mib[2];
570 char release[32];
571 size_t len = sizeof(release);
573 mib[0] = CTL_KERN;
574 mib[1] = KERN_OSRELEASE;
575 if (sysctl( mib, 2, release, &len, NULL, 0 ) == -1) return;
576 if (atoi(release) < 9) return;
577 #endif
578 kqueue_fd = kqueue();
581 static inline void set_fd_epoll_events( struct fd *fd, int user, int events )
583 struct kevent ev[2];
585 if (kqueue_fd == -1) return;
587 EV_SET( &ev[0], fd->unix_fd, EVFILT_READ, 0, NOTE_LOWAT, 1, (void *)(long)user );
588 EV_SET( &ev[1], fd->unix_fd, EVFILT_WRITE, 0, NOTE_LOWAT, 1, (void *)(long)user );
590 if (events == -1) /* stop waiting on this fd completely */
592 if (pollfd[user].fd == -1) return; /* already removed */
593 ev[0].flags |= EV_DELETE;
594 ev[1].flags |= EV_DELETE;
596 else if (pollfd[user].fd == -1)
598 if (pollfd[user].events) return; /* stopped waiting on it, don't restart */
599 ev[0].flags |= EV_ADD | ((events & POLLIN) ? EV_ENABLE : EV_DISABLE);
600 ev[1].flags |= EV_ADD | ((events & POLLOUT) ? EV_ENABLE : EV_DISABLE);
602 else
604 if (pollfd[user].events == events) return; /* nothing to do */
605 ev[0].flags |= (events & POLLIN) ? EV_ENABLE : EV_DISABLE;
606 ev[1].flags |= (events & POLLOUT) ? EV_ENABLE : EV_DISABLE;
609 if (kevent( kqueue_fd, ev, 2, NULL, 0, NULL ) == -1)
611 if (errno == ENOMEM) /* not enough memory, give up on kqueue */
613 close( kqueue_fd );
614 kqueue_fd = -1;
616 else perror( "kevent" ); /* should not happen */
620 static inline void remove_epoll_user( struct fd *fd, int user )
622 if (kqueue_fd == -1) return;
624 if (pollfd[user].fd != -1)
626 struct kevent ev[2];
628 EV_SET( &ev[0], fd->unix_fd, EVFILT_READ, EV_DELETE, 0, 0, 0 );
629 EV_SET( &ev[1], fd->unix_fd, EVFILT_WRITE, EV_DELETE, 0, 0, 0 );
630 kevent( kqueue_fd, ev, 2, NULL, 0, NULL );
634 static inline void main_loop_epoll(void)
636 int i, ret, timeout;
637 struct kevent events[128];
639 if (kqueue_fd == -1) return;
641 while (active_users)
643 timeout = get_next_timeout();
645 if (!active_users) break; /* last user removed by a timeout */
646 if (kqueue_fd == -1) break; /* an error occurred with kqueue */
648 if (timeout != -1)
650 struct timespec ts;
652 ts.tv_sec = timeout / 1000;
653 ts.tv_nsec = (timeout % 1000) * 1000000;
654 ret = kevent( kqueue_fd, NULL, 0, events, ARRAY_SIZE( events ), &ts );
656 else ret = kevent( kqueue_fd, NULL, 0, events, ARRAY_SIZE( events ), NULL );
658 set_current_time();
660 /* put the events into the pollfd array first, like poll does */
661 for (i = 0; i < ret; i++)
663 long user = (long)events[i].udata;
664 pollfd[user].revents = 0;
666 for (i = 0; i < ret; i++)
668 long user = (long)events[i].udata;
669 if (events[i].filter == EVFILT_READ) pollfd[user].revents |= POLLIN;
670 else if (events[i].filter == EVFILT_WRITE) pollfd[user].revents |= POLLOUT;
671 if (events[i].flags & EV_EOF) pollfd[user].revents |= POLLHUP;
672 if (events[i].flags & EV_ERROR) pollfd[user].revents |= POLLERR;
675 /* read events from the pollfd array, as set_fd_events may modify them */
676 for (i = 0; i < ret; i++)
678 long user = (long)events[i].udata;
679 if (pollfd[user].revents) fd_poll_event( poll_users[user], pollfd[user].revents );
680 pollfd[user].revents = 0;
685 #elif defined(USE_EVENT_PORTS)
687 static int port_fd = -1;
689 static inline void init_epoll(void)
691 port_fd = port_create();
694 static inline void set_fd_epoll_events( struct fd *fd, int user, int events )
696 int ret;
698 if (port_fd == -1) return;
700 if (events == -1) /* stop waiting on this fd completely */
702 if (pollfd[user].fd == -1) return; /* already removed */
703 port_dissociate( port_fd, PORT_SOURCE_FD, fd->unix_fd );
705 else if (pollfd[user].fd == -1)
707 if (pollfd[user].events) return; /* stopped waiting on it, don't restart */
708 ret = port_associate( port_fd, PORT_SOURCE_FD, fd->unix_fd, events, (void *)user );
710 else
712 if (pollfd[user].events == events) return; /* nothing to do */
713 ret = port_associate( port_fd, PORT_SOURCE_FD, fd->unix_fd, events, (void *)user );
716 if (ret == -1)
718 if (errno == ENOMEM) /* not enough memory, give up on port_associate */
720 close( port_fd );
721 port_fd = -1;
723 else perror( "port_associate" ); /* should not happen */
727 static inline void remove_epoll_user( struct fd *fd, int user )
729 if (port_fd == -1) return;
731 if (pollfd[user].fd != -1)
733 port_dissociate( port_fd, PORT_SOURCE_FD, fd->unix_fd );
737 static inline void main_loop_epoll(void)
739 int i, nget, ret, timeout;
740 port_event_t events[128];
742 if (port_fd == -1) return;
744 while (active_users)
746 timeout = get_next_timeout();
747 nget = 1;
749 if (!active_users) break; /* last user removed by a timeout */
750 if (port_fd == -1) break; /* an error occurred with event completion */
752 if (timeout != -1)
754 struct timespec ts;
756 ts.tv_sec = timeout / 1000;
757 ts.tv_nsec = (timeout % 1000) * 1000000;
758 ret = port_getn( port_fd, events, ARRAY_SIZE( events ), &nget, &ts );
760 else ret = port_getn( port_fd, events, ARRAY_SIZE( events ), &nget, NULL );
762 if (ret == -1) break; /* an error occurred with event completion */
764 set_current_time();
766 /* put the events into the pollfd array first, like poll does */
767 for (i = 0; i < nget; i++)
769 long user = (long)events[i].portev_user;
770 pollfd[user].revents = events[i].portev_events;
773 /* read events from the pollfd array, as set_fd_events may modify them */
774 for (i = 0; i < nget; i++)
776 long user = (long)events[i].portev_user;
777 if (pollfd[user].revents) fd_poll_event( poll_users[user], pollfd[user].revents );
778 /* if we are still interested, reassociate the fd */
779 if (pollfd[user].fd != -1) {
780 port_associate( port_fd, PORT_SOURCE_FD, pollfd[user].fd, pollfd[user].events, (void *)user );
786 #else /* HAVE_KQUEUE */
788 static inline void init_epoll(void) { }
789 static inline void set_fd_epoll_events( struct fd *fd, int user, int events ) { }
790 static inline void remove_epoll_user( struct fd *fd, int user ) { }
791 static inline void main_loop_epoll(void) { }
793 #endif /* USE_EPOLL */
796 /* add a user in the poll array and return its index, or -1 on failure */
797 static int add_poll_user( struct fd *fd )
799 int ret;
800 if (freelist)
802 ret = freelist - poll_users;
803 freelist = (struct fd **)poll_users[ret];
805 else
807 if (nb_users == allocated_users)
809 struct fd **newusers;
810 struct pollfd *newpoll;
811 int new_count = allocated_users ? (allocated_users + allocated_users / 2) : 16;
812 if (!(newusers = realloc( poll_users, new_count * sizeof(*poll_users) ))) return -1;
813 if (!(newpoll = realloc( pollfd, new_count * sizeof(*pollfd) )))
815 if (allocated_users)
816 poll_users = newusers;
817 else
818 free( newusers );
819 return -1;
821 poll_users = newusers;
822 pollfd = newpoll;
823 if (!allocated_users) init_epoll();
824 allocated_users = new_count;
826 ret = nb_users++;
828 pollfd[ret].fd = -1;
829 pollfd[ret].events = 0;
830 pollfd[ret].revents = 0;
831 poll_users[ret] = fd;
832 active_users++;
833 return ret;
836 /* remove a user from the poll list */
837 static void remove_poll_user( struct fd *fd, int user )
839 assert( user >= 0 );
840 assert( poll_users[user] == fd );
842 remove_epoll_user( fd, user );
843 pollfd[user].fd = -1;
844 pollfd[user].events = 0;
845 pollfd[user].revents = 0;
846 poll_users[user] = (struct fd *)freelist;
847 freelist = &poll_users[user];
848 active_users--;
851 /* process pending timeouts and return the time until the next timeout, in milliseconds */
852 static int get_next_timeout(void)
854 if (!list_empty( &timeout_list ))
856 struct list expired_list, *ptr;
858 /* first remove all expired timers from the list */
860 list_init( &expired_list );
861 while ((ptr = list_head( &timeout_list )) != NULL)
863 struct timeout_user *timeout = LIST_ENTRY( ptr, struct timeout_user, entry );
865 if (timeout->when <= current_time)
867 list_remove( &timeout->entry );
868 list_add_tail( &expired_list, &timeout->entry );
870 else break;
873 /* now call the callback for all the removed timers */
875 while ((ptr = list_head( &expired_list )) != NULL)
877 struct timeout_user *timeout = LIST_ENTRY( ptr, struct timeout_user, entry );
878 list_remove( &timeout->entry );
879 timeout->callback( timeout->private );
880 free( timeout );
883 if ((ptr = list_head( &timeout_list )) != NULL)
885 struct timeout_user *timeout = LIST_ENTRY( ptr, struct timeout_user, entry );
886 int diff = (timeout->when - current_time + 9999) / 10000;
887 if (diff < 0) diff = 0;
888 return diff;
891 return -1; /* no pending timeouts */
894 /* server main poll() loop */
895 void main_loop(void)
897 int i, ret, timeout;
899 set_current_time();
900 server_start_time = current_time;
902 main_loop_epoll();
903 /* fall through to normal poll loop */
905 while (active_users)
907 timeout = get_next_timeout();
909 if (!active_users) break; /* last user removed by a timeout */
911 ret = poll( pollfd, nb_users, timeout );
912 set_current_time();
914 if (ret > 0)
916 for (i = 0; i < nb_users; i++)
918 if (pollfd[i].revents)
920 fd_poll_event( poll_users[i], pollfd[i].revents );
921 if (!--ret) break;
929 /****************************************************************/
930 /* device functions */
932 static struct list device_hash[DEVICE_HASH_SIZE];
934 static int is_device_removable( dev_t dev, int unix_fd )
936 #if defined(linux) && defined(HAVE_FSTATFS)
937 struct statfs stfs;
939 /* check for floppy disk */
940 if (major(dev) == FLOPPY_MAJOR) return 1;
942 if (fstatfs( unix_fd, &stfs ) == -1) return 0;
943 return (stfs.f_type == 0x9660 || /* iso9660 */
944 stfs.f_type == 0x9fa1 || /* supermount */
945 stfs.f_type == 0x15013346); /* udf */
946 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__) || defined(__APPLE__)
947 struct statfs stfs;
949 if (fstatfs( unix_fd, &stfs ) == -1) return 0;
950 return (!strcmp("cd9660", stfs.f_fstypename) || !strcmp("udf", stfs.f_fstypename));
951 #elif defined(__NetBSD__)
952 struct statvfs stfs;
954 if (fstatvfs( unix_fd, &stfs ) == -1) return 0;
955 return (!strcmp("cd9660", stfs.f_fstypename) || !strcmp("udf", stfs.f_fstypename));
956 #elif defined(sun)
957 # include <sys/dkio.h>
958 # include <sys/vtoc.h>
959 struct dk_cinfo dkinf;
960 if (ioctl( unix_fd, DKIOCINFO, &dkinf ) == -1) return 0;
961 return (dkinf.dki_ctype == DKC_CDROM ||
962 dkinf.dki_ctype == DKC_NCRFLOPPY ||
963 dkinf.dki_ctype == DKC_SMSFLOPPY ||
964 dkinf.dki_ctype == DKC_INTEL82072 ||
965 dkinf.dki_ctype == DKC_INTEL82077);
966 #else
967 return 0;
968 #endif
971 /* retrieve the device object for a given fd, creating it if needed */
972 static struct device *get_device( dev_t dev, int unix_fd )
974 struct device *device;
975 unsigned int i, hash = dev % DEVICE_HASH_SIZE;
977 if (device_hash[hash].next)
979 LIST_FOR_EACH_ENTRY( device, &device_hash[hash], struct device, entry )
980 if (device->dev == dev) return (struct device *)grab_object( device );
982 else list_init( &device_hash[hash] );
984 /* not found, create it */
986 if (unix_fd == -1) return NULL;
987 if ((device = alloc_object( &device_ops )))
989 device->dev = dev;
990 device->removable = is_device_removable( dev, unix_fd );
991 for (i = 0; i < INODE_HASH_SIZE; i++) list_init( &device->inode_hash[i] );
992 list_add_head( &device_hash[hash], &device->entry );
994 return device;
997 static void device_dump( struct object *obj, int verbose )
999 struct device *device = (struct device *)obj;
1000 fprintf( stderr, "Device dev=" );
1001 DUMP_LONG_LONG( device->dev );
1002 fprintf( stderr, "\n" );
1005 static void device_destroy( struct object *obj )
1007 struct device *device = (struct device *)obj;
1008 unsigned int i;
1010 for (i = 0; i < INODE_HASH_SIZE; i++)
1011 assert( list_empty(&device->inode_hash[i]) );
1013 list_remove( &device->entry ); /* remove it from the hash table */
1017 /****************************************************************/
1018 /* inode functions */
1020 /* close all pending file descriptors in the closed list */
1021 static void inode_close_pending( struct inode *inode, int keep_unlinks )
1023 struct list *ptr = list_head( &inode->closed );
1025 while (ptr)
1027 struct closed_fd *fd = LIST_ENTRY( ptr, struct closed_fd, entry );
1028 struct list *next = list_next( &inode->closed, ptr );
1030 if (fd->unix_fd != -1)
1032 close( fd->unix_fd );
1033 fd->unix_fd = -1;
1035 if (!keep_unlinks || !fd->unlink) /* get rid of it unless there's an unlink pending on that file */
1037 list_remove( ptr );
1038 free( fd->unix_name );
1039 free( fd );
1041 ptr = next;
1045 static void inode_dump( struct object *obj, int verbose )
1047 struct inode *inode = (struct inode *)obj;
1048 fprintf( stderr, "Inode device=%p ino=", inode->device );
1049 DUMP_LONG_LONG( inode->ino );
1050 fprintf( stderr, "\n" );
1053 static void inode_destroy( struct object *obj )
1055 struct inode *inode = (struct inode *)obj;
1056 struct list *ptr;
1058 assert( list_empty(&inode->open) );
1059 assert( list_empty(&inode->locks) );
1061 list_remove( &inode->entry );
1063 while ((ptr = list_head( &inode->closed )))
1065 struct closed_fd *fd = LIST_ENTRY( ptr, struct closed_fd, entry );
1066 list_remove( ptr );
1067 if (fd->unix_fd != -1) close( fd->unix_fd );
1068 if (fd->unlink)
1070 /* make sure it is still the same file */
1071 struct stat st;
1072 if (!stat( fd->unix_name, &st ) && st.st_dev == inode->device->dev && st.st_ino == inode->ino)
1074 if (S_ISDIR(st.st_mode)) rmdir( fd->unix_name );
1075 else unlink( fd->unix_name );
1078 free( fd->unix_name );
1079 free( fd );
1081 release_object( inode->device );
1084 /* retrieve the inode object for a given fd, creating it if needed */
1085 static struct inode *get_inode( dev_t dev, ino_t ino, int unix_fd )
1087 struct device *device;
1088 struct inode *inode;
1089 unsigned int hash = ino % INODE_HASH_SIZE;
1091 if (!(device = get_device( dev, unix_fd ))) return NULL;
1093 LIST_FOR_EACH_ENTRY( inode, &device->inode_hash[hash], struct inode, entry )
1095 if (inode->ino == ino)
1097 release_object( device );
1098 return (struct inode *)grab_object( inode );
1102 /* not found, create it */
1103 if ((inode = alloc_object( &inode_ops )))
1105 inode->device = device;
1106 inode->ino = ino;
1107 list_init( &inode->open );
1108 list_init( &inode->locks );
1109 list_init( &inode->closed );
1110 list_add_head( &device->inode_hash[hash], &inode->entry );
1112 else release_object( device );
1114 return inode;
1117 /* add fd to the inode list of file descriptors to close */
1118 static void inode_add_closed_fd( struct inode *inode, struct closed_fd *fd )
1120 if (!list_empty( &inode->locks ))
1122 list_add_head( &inode->closed, &fd->entry );
1124 else if (fd->unlink) /* close the fd but keep the structure around for unlink */
1126 if (fd->unix_fd != -1) close( fd->unix_fd );
1127 fd->unix_fd = -1;
1128 list_add_head( &inode->closed, &fd->entry );
1130 else /* no locks on this inode and no unlink, get rid of the fd */
1132 if (fd->unix_fd != -1) close( fd->unix_fd );
1133 free( fd->unix_name );
1134 free( fd );
1139 /****************************************************************/
1140 /* file lock functions */
1142 static void file_lock_dump( struct object *obj, int verbose )
1144 struct file_lock *lock = (struct file_lock *)obj;
1145 fprintf( stderr, "Lock %s fd=%p proc=%p start=",
1146 lock->shared ? "shared" : "excl", lock->fd, lock->process );
1147 DUMP_LONG_LONG( lock->start );
1148 fprintf( stderr, " end=" );
1149 DUMP_LONG_LONG( lock->end );
1150 fprintf( stderr, "\n" );
1153 static int file_lock_signaled( struct object *obj, struct wait_queue_entry *entry )
1155 struct file_lock *lock = (struct file_lock *)obj;
1156 /* lock is signaled if it has lost its owner */
1157 return !lock->process;
1160 /* set (or remove) a Unix lock if possible for the given range */
1161 static int set_unix_lock( struct fd *fd, file_pos_t start, file_pos_t end, int type )
1163 struct flock fl;
1165 if (!fd->fs_locks) return 1; /* no fs locks possible for this fd */
1166 for (;;)
1168 if (start == end) return 1; /* can't set zero-byte lock */
1169 if (start > max_unix_offset) return 1; /* ignore it */
1170 fl.l_type = type;
1171 fl.l_whence = SEEK_SET;
1172 fl.l_start = start;
1173 if (!end || end > max_unix_offset) fl.l_len = 0;
1174 else fl.l_len = end - start;
1175 if (fcntl( fd->unix_fd, F_SETLK, &fl ) != -1) return 1;
1177 switch(errno)
1179 case EACCES:
1180 /* check whether locks work at all on this file system */
1181 if (fcntl( fd->unix_fd, F_GETLK, &fl ) != -1)
1183 set_error( STATUS_FILE_LOCK_CONFLICT );
1184 return 0;
1186 /* fall through */
1187 case EIO:
1188 case ENOLCK:
1189 case ENOTSUP:
1190 /* no locking on this fs, just ignore it */
1191 fd->fs_locks = 0;
1192 return 1;
1193 case EAGAIN:
1194 set_error( STATUS_FILE_LOCK_CONFLICT );
1195 return 0;
1196 case EBADF:
1197 /* this can happen if we try to set a write lock on a read-only file */
1198 /* try to at least grab a read lock */
1199 if (fl.l_type == F_WRLCK)
1201 type = F_RDLCK;
1202 break; /* retry */
1204 set_error( STATUS_ACCESS_DENIED );
1205 return 0;
1206 #ifdef EOVERFLOW
1207 case EOVERFLOW:
1208 #endif
1209 case EINVAL:
1210 /* this can happen if off_t is 64-bit but the kernel only supports 32-bit */
1211 /* in that case we shrink the limit and retry */
1212 if (max_unix_offset > INT_MAX)
1214 max_unix_offset = INT_MAX;
1215 break; /* retry */
1217 /* fall through */
1218 default:
1219 file_set_error();
1220 return 0;
1225 /* check if interval [start;end) overlaps the lock */
1226 static inline int lock_overlaps( struct file_lock *lock, file_pos_t start, file_pos_t end )
1228 if (lock->end && start >= lock->end) return 0;
1229 if (end && lock->start >= end) return 0;
1230 return 1;
1233 /* remove Unix locks for all bytes in the specified area that are no longer locked */
1234 static void remove_unix_locks( struct fd *fd, file_pos_t start, file_pos_t end )
1236 struct hole
1238 struct hole *next;
1239 struct hole *prev;
1240 file_pos_t start;
1241 file_pos_t end;
1242 } *first, *cur, *next, *buffer;
1244 struct list *ptr;
1245 int count = 0;
1247 if (!fd->inode) return;
1248 if (!fd->fs_locks) return;
1249 if (start == end || start > max_unix_offset) return;
1250 if (!end || end > max_unix_offset) end = max_unix_offset + 1;
1252 /* count the number of locks overlapping the specified area */
1254 LIST_FOR_EACH( ptr, &fd->inode->locks )
1256 struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
1257 if (lock->start == lock->end) continue;
1258 if (lock_overlaps( lock, start, end )) count++;
1261 if (!count) /* no locks at all, we can unlock everything */
1263 set_unix_lock( fd, start, end, F_UNLCK );
1264 return;
1267 /* allocate space for the list of holes */
1268 /* max. number of holes is number of locks + 1 */
1270 if (!(buffer = malloc( sizeof(*buffer) * (count+1) ))) return;
1271 first = buffer;
1272 first->next = NULL;
1273 first->prev = NULL;
1274 first->start = start;
1275 first->end = end;
1276 next = first + 1;
1278 /* build a sorted list of unlocked holes in the specified area */
1280 LIST_FOR_EACH( ptr, &fd->inode->locks )
1282 struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
1283 if (lock->start == lock->end) continue;
1284 if (!lock_overlaps( lock, start, end )) continue;
1286 /* go through all the holes touched by this lock */
1287 for (cur = first; cur; cur = cur->next)
1289 if (cur->end <= lock->start) continue; /* hole is before start of lock */
1290 if (lock->end && cur->start >= lock->end) break; /* hole is after end of lock */
1292 /* now we know that lock is overlapping hole */
1294 if (cur->start >= lock->start) /* lock starts before hole, shrink from start */
1296 cur->start = lock->end;
1297 if (cur->start && cur->start < cur->end) break; /* done with this lock */
1298 /* now hole is empty, remove it */
1299 if (cur->next) cur->next->prev = cur->prev;
1300 if (cur->prev) cur->prev->next = cur->next;
1301 else if (!(first = cur->next)) goto done; /* no more holes at all */
1303 else if (!lock->end || cur->end <= lock->end) /* lock larger than hole, shrink from end */
1305 cur->end = lock->start;
1306 assert( cur->start < cur->end );
1308 else /* lock is in the middle of hole, split hole in two */
1310 next->prev = cur;
1311 next->next = cur->next;
1312 cur->next = next;
1313 next->start = lock->end;
1314 next->end = cur->end;
1315 cur->end = lock->start;
1316 assert( next->start < next->end );
1317 assert( cur->end < next->start );
1318 next++;
1319 break; /* done with this lock */
1324 /* clear Unix locks for all the holes */
1326 for (cur = first; cur; cur = cur->next)
1327 set_unix_lock( fd, cur->start, cur->end, F_UNLCK );
1329 done:
1330 free( buffer );
1333 /* create a new lock on a fd */
1334 static struct file_lock *add_lock( struct fd *fd, int shared, file_pos_t start, file_pos_t end )
1336 struct file_lock *lock;
1338 if (!(lock = alloc_object( &file_lock_ops ))) return NULL;
1339 lock->shared = shared;
1340 lock->start = start;
1341 lock->end = end;
1342 lock->fd = fd;
1343 lock->process = current->process;
1345 /* now try to set a Unix lock */
1346 if (!set_unix_lock( lock->fd, lock->start, lock->end, lock->shared ? F_RDLCK : F_WRLCK ))
1348 release_object( lock );
1349 return NULL;
1351 list_add_tail( &fd->locks, &lock->fd_entry );
1352 list_add_tail( &fd->inode->locks, &lock->inode_entry );
1353 list_add_tail( &lock->process->locks, &lock->proc_entry );
1354 return lock;
1357 /* remove an existing lock */
1358 static void remove_lock( struct file_lock *lock, int remove_unix )
1360 struct inode *inode = lock->fd->inode;
1362 list_remove( &lock->fd_entry );
1363 list_remove( &lock->inode_entry );
1364 list_remove( &lock->proc_entry );
1365 if (remove_unix) remove_unix_locks( lock->fd, lock->start, lock->end );
1366 if (list_empty( &inode->locks )) inode_close_pending( inode, 1 );
1367 lock->process = NULL;
1368 wake_up( &lock->obj, 0 );
1369 release_object( lock );
1372 /* remove all locks owned by a given process */
1373 void remove_process_locks( struct process *process )
1375 struct list *ptr;
1377 while ((ptr = list_head( &process->locks )))
1379 struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, proc_entry );
1380 remove_lock( lock, 1 ); /* this removes it from the list */
1384 /* remove all locks on a given fd */
1385 static void remove_fd_locks( struct fd *fd )
1387 file_pos_t start = FILE_POS_T_MAX, end = 0;
1388 struct list *ptr;
1390 while ((ptr = list_head( &fd->locks )))
1392 struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, fd_entry );
1393 if (lock->start < start) start = lock->start;
1394 if (!lock->end || lock->end > end) end = lock->end - 1;
1395 remove_lock( lock, 0 );
1397 if (start < end) remove_unix_locks( fd, start, end + 1 );
1400 /* add a lock on an fd */
1401 /* returns handle to wait on */
1402 obj_handle_t lock_fd( struct fd *fd, file_pos_t start, file_pos_t count, int shared, int wait )
1404 struct list *ptr;
1405 file_pos_t end = start + count;
1407 if (!fd->inode) /* not a regular file */
1409 set_error( STATUS_INVALID_DEVICE_REQUEST );
1410 return 0;
1413 /* don't allow wrapping locks */
1414 if (end && end < start)
1416 set_error( STATUS_INVALID_PARAMETER );
1417 return 0;
1420 /* check if another lock on that file overlaps the area */
1421 LIST_FOR_EACH( ptr, &fd->inode->locks )
1423 struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, inode_entry );
1424 if (!lock_overlaps( lock, start, end )) continue;
1425 if (shared && (lock->shared || lock->fd == fd)) continue;
1426 /* found one */
1427 if (!wait)
1429 set_error( STATUS_FILE_LOCK_CONFLICT );
1430 return 0;
1432 set_error( STATUS_PENDING );
1433 return alloc_handle( current->process, lock, SYNCHRONIZE, 0 );
1436 /* not found, add it */
1437 if (add_lock( fd, shared, start, end )) return 0;
1438 if (get_error() == STATUS_FILE_LOCK_CONFLICT)
1440 /* Unix lock conflict -> tell client to wait and retry */
1441 if (wait) set_error( STATUS_PENDING );
1443 return 0;
1446 /* remove a lock on an fd */
1447 void unlock_fd( struct fd *fd, file_pos_t start, file_pos_t count )
1449 struct list *ptr;
1450 file_pos_t end = start + count;
1452 /* find an existing lock with the exact same parameters */
1453 LIST_FOR_EACH( ptr, &fd->locks )
1455 struct file_lock *lock = LIST_ENTRY( ptr, struct file_lock, fd_entry );
1456 if ((lock->start == start) && (lock->end == end))
1458 remove_lock( lock, 1 );
1459 return;
1462 set_error( STATUS_FILE_LOCK_CONFLICT );
1466 /****************************************************************/
1467 /* file descriptor functions */
1469 static void fd_dump( struct object *obj, int verbose )
1471 struct fd *fd = (struct fd *)obj;
1472 fprintf( stderr, "Fd unix_fd=%d user=%p options=%08x", fd->unix_fd, fd->user, fd->options );
1473 if (fd->inode) fprintf( stderr, " inode=%p unlink=%d", fd->inode, fd->closed->unlink );
1474 fprintf( stderr, "\n" );
1477 static void fd_destroy( struct object *obj )
1479 struct fd *fd = (struct fd *)obj;
1481 free_async_queue( &fd->read_q );
1482 free_async_queue( &fd->write_q );
1483 free_async_queue( &fd->wait_q );
1485 if (fd->completion) release_object( fd->completion );
1486 remove_fd_locks( fd );
1487 list_remove( &fd->inode_entry );
1488 if (fd->poll_index != -1) remove_poll_user( fd, fd->poll_index );
1489 if (fd->inode)
1491 inode_add_closed_fd( fd->inode, fd->closed );
1492 release_object( fd->inode );
1494 else /* no inode, close it right away */
1496 if (fd->unix_fd != -1) close( fd->unix_fd );
1497 free( fd->unix_name );
1501 /* check if the desired access is possible without violating */
1502 /* the sharing mode of other opens of the same file */
1503 static unsigned int check_sharing( struct fd *fd, unsigned int access, unsigned int sharing,
1504 unsigned int open_flags, unsigned int options )
1506 /* only a few access bits are meaningful wrt sharing */
1507 const unsigned int read_access = FILE_READ_DATA | FILE_EXECUTE;
1508 const unsigned int write_access = FILE_WRITE_DATA | FILE_APPEND_DATA;
1509 const unsigned int all_access = read_access | write_access | DELETE;
1511 unsigned int existing_sharing = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE;
1512 unsigned int existing_access = 0;
1513 struct list *ptr;
1515 fd->access = access;
1516 fd->sharing = sharing;
1518 LIST_FOR_EACH( ptr, &fd->inode->open )
1520 struct fd *fd_ptr = LIST_ENTRY( ptr, struct fd, inode_entry );
1521 if (fd_ptr != fd)
1523 /* if access mode is 0, sharing mode is ignored */
1524 if (fd_ptr->access & all_access) existing_sharing &= fd_ptr->sharing;
1525 existing_access |= fd_ptr->access;
1529 if (((access & read_access) && !(existing_sharing & FILE_SHARE_READ)) ||
1530 ((access & write_access) && !(existing_sharing & FILE_SHARE_WRITE)) ||
1531 ((access & DELETE) && !(existing_sharing & FILE_SHARE_DELETE)))
1532 return STATUS_SHARING_VIOLATION;
1533 if (((existing_access & FILE_MAPPING_WRITE) && !(sharing & FILE_SHARE_WRITE)) ||
1534 ((existing_access & FILE_MAPPING_IMAGE) && (access & FILE_WRITE_DATA)))
1535 return STATUS_SHARING_VIOLATION;
1536 if ((existing_access & FILE_MAPPING_IMAGE) && (options & FILE_DELETE_ON_CLOSE))
1537 return STATUS_CANNOT_DELETE;
1538 if ((existing_access & FILE_MAPPING_ACCESS) && (open_flags & O_TRUNC))
1539 return STATUS_USER_MAPPED_FILE;
1540 if (!(access & all_access))
1541 return 0; /* if access mode is 0, sharing mode is ignored (except for mappings) */
1542 if (((existing_access & read_access) && !(sharing & FILE_SHARE_READ)) ||
1543 ((existing_access & write_access) && !(sharing & FILE_SHARE_WRITE)) ||
1544 ((existing_access & DELETE) && !(sharing & FILE_SHARE_DELETE)))
1545 return STATUS_SHARING_VIOLATION;
1546 return 0;
1549 /* set the events that select waits for on this fd */
1550 void set_fd_events( struct fd *fd, int events )
1552 int user = fd->poll_index;
1553 assert( poll_users[user] == fd );
1555 set_fd_epoll_events( fd, user, events );
1557 if (events == -1) /* stop waiting on this fd completely */
1559 pollfd[user].fd = -1;
1560 pollfd[user].events = POLLERR;
1561 pollfd[user].revents = 0;
1563 else if (pollfd[user].fd != -1 || !pollfd[user].events)
1565 pollfd[user].fd = fd->unix_fd;
1566 pollfd[user].events = events;
1570 /* prepare an fd for unmounting its corresponding device */
1571 static inline void unmount_fd( struct fd *fd )
1573 assert( fd->inode );
1575 async_wake_up( &fd->read_q, STATUS_VOLUME_DISMOUNTED );
1576 async_wake_up( &fd->write_q, STATUS_VOLUME_DISMOUNTED );
1578 if (fd->poll_index != -1) set_fd_events( fd, -1 );
1580 if (fd->unix_fd != -1) close( fd->unix_fd );
1582 fd->unix_fd = -1;
1583 fd->no_fd_status = STATUS_VOLUME_DISMOUNTED;
1584 fd->closed->unix_fd = -1;
1585 fd->closed->unlink = 0;
1587 /* stop using Unix locks on this fd (existing locks have been removed by close) */
1588 fd->fs_locks = 0;
1591 /* allocate an fd object, without setting the unix fd yet */
1592 static struct fd *alloc_fd_object(void)
1594 struct fd *fd = alloc_object( &fd_ops );
1596 if (!fd) return NULL;
1598 fd->fd_ops = NULL;
1599 fd->user = NULL;
1600 fd->inode = NULL;
1601 fd->closed = NULL;
1602 fd->access = 0;
1603 fd->options = 0;
1604 fd->sharing = 0;
1605 fd->unix_fd = -1;
1606 fd->unix_name = NULL;
1607 fd->cacheable = 0;
1608 fd->signaled = 1;
1609 fd->fs_locks = 1;
1610 fd->poll_index = -1;
1611 fd->completion = NULL;
1612 fd->comp_flags = 0;
1613 init_async_queue( &fd->read_q );
1614 init_async_queue( &fd->write_q );
1615 init_async_queue( &fd->wait_q );
1616 list_init( &fd->inode_entry );
1617 list_init( &fd->locks );
1619 if ((fd->poll_index = add_poll_user( fd )) == -1)
1621 release_object( fd );
1622 return NULL;
1624 return fd;
1627 /* allocate a pseudo fd object, for objects that need to behave like files but don't have a unix fd */
1628 struct fd *alloc_pseudo_fd( const struct fd_ops *fd_user_ops, struct object *user, unsigned int options )
1630 struct fd *fd = alloc_object( &fd_ops );
1632 if (!fd) return NULL;
1634 fd->fd_ops = fd_user_ops;
1635 fd->user = user;
1636 fd->inode = NULL;
1637 fd->closed = NULL;
1638 fd->access = 0;
1639 fd->options = options;
1640 fd->sharing = 0;
1641 fd->unix_name = NULL;
1642 fd->unix_fd = -1;
1643 fd->cacheable = 0;
1644 fd->signaled = 0;
1645 fd->fs_locks = 0;
1646 fd->poll_index = -1;
1647 fd->completion = NULL;
1648 fd->comp_flags = 0;
1649 fd->no_fd_status = STATUS_BAD_DEVICE_TYPE;
1650 init_async_queue( &fd->read_q );
1651 init_async_queue( &fd->write_q );
1652 init_async_queue( &fd->wait_q );
1653 list_init( &fd->inode_entry );
1654 list_init( &fd->locks );
1655 return fd;
1658 /* duplicate an fd object for a different user */
1659 struct fd *dup_fd_object( struct fd *orig, unsigned int access, unsigned int sharing, unsigned int options )
1661 unsigned int err;
1662 struct fd *fd = alloc_fd_object();
1664 if (!fd) return NULL;
1666 fd->options = options;
1667 fd->cacheable = orig->cacheable;
1669 if (orig->unix_name)
1671 if (!(fd->unix_name = mem_alloc( strlen(orig->unix_name) + 1 ))) goto failed;
1672 strcpy( fd->unix_name, orig->unix_name );
1675 if (orig->inode)
1677 struct closed_fd *closed = mem_alloc( sizeof(*closed) );
1678 if (!closed) goto failed;
1679 if ((fd->unix_fd = dup( orig->unix_fd )) == -1)
1681 file_set_error();
1682 free( closed );
1683 goto failed;
1685 closed->unix_fd = fd->unix_fd;
1686 closed->unlink = 0;
1687 closed->unix_name = fd->unix_name;
1688 fd->closed = closed;
1689 fd->inode = (struct inode *)grab_object( orig->inode );
1690 list_add_head( &fd->inode->open, &fd->inode_entry );
1691 if ((err = check_sharing( fd, access, sharing, 0, options )))
1693 set_error( err );
1694 goto failed;
1697 else if ((fd->unix_fd = dup( orig->unix_fd )) == -1)
1699 file_set_error();
1700 goto failed;
1702 return fd;
1704 failed:
1705 release_object( fd );
1706 return NULL;
1709 /* find an existing fd object that can be reused for a mapping */
1710 struct fd *get_fd_object_for_mapping( struct fd *fd, unsigned int access, unsigned int sharing )
1712 struct fd *fd_ptr;
1714 if (!fd->inode) return NULL;
1716 LIST_FOR_EACH_ENTRY( fd_ptr, &fd->inode->open, struct fd, inode_entry )
1717 if (fd_ptr->access == access && fd_ptr->sharing == sharing)
1718 return (struct fd *)grab_object( fd_ptr );
1720 return NULL;
1723 /* sets the user of an fd that previously had no user */
1724 void set_fd_user( struct fd *fd, const struct fd_ops *user_ops, struct object *user )
1726 assert( fd->fd_ops == NULL );
1727 fd->fd_ops = user_ops;
1728 fd->user = user;
1731 char *dup_fd_name( struct fd *root, const char *name )
1733 char *ret;
1735 if (!root) return strdup( name );
1736 if (!root->unix_name) return NULL;
1738 /* skip . prefix */
1739 if (name[0] == '.' && (!name[1] || name[1] == '/')) name++;
1741 if ((ret = malloc( strlen(root->unix_name) + strlen(name) + 2 )))
1743 strcpy( ret, root->unix_name );
1744 if (name[0] && name[0] != '/') strcat( ret, "/" );
1745 strcat( ret, name );
1747 return ret;
1750 /* open() wrapper that returns a struct fd with no fd user set */
1751 struct fd *open_fd( struct fd *root, const char *name, int flags, mode_t *mode, unsigned int access,
1752 unsigned int sharing, unsigned int options )
1754 struct stat st;
1755 struct closed_fd *closed_fd;
1756 struct fd *fd;
1757 int root_fd = -1;
1758 int rw_mode;
1760 if (((options & FILE_DELETE_ON_CLOSE) && !(access & DELETE)) ||
1761 ((options & FILE_DIRECTORY_FILE) && (flags & O_TRUNC)))
1763 set_error( STATUS_INVALID_PARAMETER );
1764 return NULL;
1767 if (!(fd = alloc_fd_object())) return NULL;
1769 fd->options = options;
1770 if (!(closed_fd = mem_alloc( sizeof(*closed_fd) )))
1772 release_object( fd );
1773 return NULL;
1776 if (root)
1778 if ((root_fd = get_unix_fd( root )) == -1) goto error;
1779 if (fchdir( root_fd ) == -1)
1781 file_set_error();
1782 root_fd = -1;
1783 goto error;
1787 /* create the directory if needed */
1788 if ((options & FILE_DIRECTORY_FILE) && (flags & O_CREAT))
1790 if (mkdir( name, *mode ) == -1)
1792 if (errno != EEXIST || (flags & O_EXCL))
1794 file_set_error();
1795 goto error;
1798 flags &= ~(O_CREAT | O_EXCL | O_TRUNC);
1801 if ((access & FILE_UNIX_WRITE_ACCESS) && !(options & FILE_DIRECTORY_FILE))
1803 if (access & FILE_UNIX_READ_ACCESS) rw_mode = O_RDWR;
1804 else rw_mode = O_WRONLY;
1806 else rw_mode = O_RDONLY;
1808 fd->unix_name = dup_fd_name( root, name );
1810 if ((fd->unix_fd = open( name, rw_mode | (flags & ~O_TRUNC), *mode )) == -1)
1812 /* if we tried to open a directory for write access, retry read-only */
1813 if (errno == EISDIR)
1815 if ((access & FILE_UNIX_WRITE_ACCESS) || (flags & O_CREAT))
1816 fd->unix_fd = open( name, O_RDONLY | (flags & ~(O_TRUNC | O_CREAT | O_EXCL)), *mode );
1819 if (fd->unix_fd == -1)
1821 file_set_error();
1822 goto error;
1826 closed_fd->unix_fd = fd->unix_fd;
1827 closed_fd->unlink = 0;
1828 closed_fd->unix_name = fd->unix_name;
1829 fstat( fd->unix_fd, &st );
1830 *mode = st.st_mode;
1832 /* only bother with an inode for normal files and directories */
1833 if (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode))
1835 unsigned int err;
1836 struct inode *inode = get_inode( st.st_dev, st.st_ino, fd->unix_fd );
1838 if (!inode)
1840 /* we can close the fd because there are no others open on the same file,
1841 * otherwise we wouldn't have failed to allocate a new inode
1843 goto error;
1845 fd->inode = inode;
1846 fd->closed = closed_fd;
1847 fd->cacheable = !inode->device->removable;
1848 list_add_head( &inode->open, &fd->inode_entry );
1849 closed_fd = NULL;
1851 /* check directory options */
1852 if ((options & FILE_DIRECTORY_FILE) && !S_ISDIR(st.st_mode))
1854 set_error( STATUS_NOT_A_DIRECTORY );
1855 goto error;
1857 if ((options & FILE_NON_DIRECTORY_FILE) && S_ISDIR(st.st_mode))
1859 set_error( STATUS_FILE_IS_A_DIRECTORY );
1860 goto error;
1862 if ((err = check_sharing( fd, access, sharing, flags, options )))
1864 set_error( err );
1865 goto error;
1868 /* can't unlink files if we don't have permission to access */
1869 if ((options & FILE_DELETE_ON_CLOSE) && !(flags & O_CREAT) &&
1870 !(st.st_mode & (S_IWUSR | S_IWGRP | S_IWOTH)))
1872 set_error( STATUS_CANNOT_DELETE );
1873 goto error;
1876 fd->closed->unlink = (options & FILE_DELETE_ON_CLOSE) ? -1 : 0;
1877 if (flags & O_TRUNC)
1879 if (S_ISDIR(st.st_mode))
1881 set_error( STATUS_OBJECT_NAME_COLLISION );
1882 goto error;
1884 ftruncate( fd->unix_fd, 0 );
1887 else /* special file */
1889 if (options & FILE_DELETE_ON_CLOSE) /* we can't unlink special files */
1891 set_error( STATUS_INVALID_PARAMETER );
1892 goto error;
1894 free( closed_fd );
1895 fd->cacheable = 1;
1897 if (root_fd != -1) fchdir( server_dir_fd ); /* go back to the server dir */
1898 return fd;
1900 error:
1901 release_object( fd );
1902 free( closed_fd );
1903 if (root_fd != -1) fchdir( server_dir_fd ); /* go back to the server dir */
1904 return NULL;
1907 /* create an fd for an anonymous file */
1908 /* if the function fails the unix fd is closed */
1909 struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops, int unix_fd, struct object *user,
1910 unsigned int options )
1912 struct fd *fd = alloc_fd_object();
1914 if (fd)
1916 set_fd_user( fd, fd_user_ops, user );
1917 fd->unix_fd = unix_fd;
1918 fd->options = options;
1919 return fd;
1921 close( unix_fd );
1922 return NULL;
1925 /* retrieve the object that is using an fd */
1926 void *get_fd_user( struct fd *fd )
1928 return fd->user;
1931 /* retrieve the opening options for the fd */
1932 unsigned int get_fd_options( struct fd *fd )
1934 return fd->options;
1937 /* check if fd is in overlapped mode */
1938 int is_fd_overlapped( struct fd *fd )
1940 return !(fd->options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT));
1943 /* retrieve the unix fd for an object */
1944 int get_unix_fd( struct fd *fd )
1946 if (fd->unix_fd == -1) set_error( fd->no_fd_status );
1947 return fd->unix_fd;
1950 /* check if two file descriptors point to the same file */
1951 int is_same_file_fd( struct fd *fd1, struct fd *fd2 )
1953 return fd1->inode == fd2->inode;
1956 /* allow the fd to be cached (can't be reset once set) */
1957 void allow_fd_caching( struct fd *fd )
1959 fd->cacheable = 1;
1962 /* check if fd is on a removable device */
1963 int is_fd_removable( struct fd *fd )
1965 return (fd->inode && fd->inode->device->removable);
1968 /* set or clear the fd signaled state */
1969 void set_fd_signaled( struct fd *fd, int signaled )
1971 if (fd->comp_flags & FILE_SKIP_SET_EVENT_ON_HANDLE) return;
1972 fd->signaled = signaled;
1973 if (signaled) wake_up( fd->user, 0 );
1976 /* check if fd is signaled */
1977 int is_fd_signaled( struct fd *fd )
1979 return fd->signaled;
1982 /* handler for close_handle that refuses to close fd-associated handles in other processes */
1983 int fd_close_handle( struct object *obj, struct process *process, obj_handle_t handle )
1985 return (!current || current->process == process);
1988 /* check if events are pending and if yes return which one(s) */
1989 int check_fd_events( struct fd *fd, int events )
1991 struct pollfd pfd;
1993 if (fd->unix_fd == -1) return POLLERR;
1994 if (fd->inode) return events; /* regular files are always signaled */
1996 pfd.fd = fd->unix_fd;
1997 pfd.events = events;
1998 if (poll( &pfd, 1, 0 ) <= 0) return 0;
1999 return pfd.revents;
2002 /* default signaled() routine for objects that poll() on an fd */
2003 int default_fd_signaled( struct object *obj, struct wait_queue_entry *entry )
2005 struct fd *fd = get_obj_fd( obj );
2006 int ret = fd->signaled;
2007 release_object( fd );
2008 return ret;
2011 /* default map_access() routine for objects that behave like an fd */
2012 unsigned int default_fd_map_access( struct object *obj, unsigned int access )
2014 if (access & GENERIC_READ) access |= FILE_GENERIC_READ;
2015 if (access & GENERIC_WRITE) access |= FILE_GENERIC_WRITE;
2016 if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
2017 if (access & GENERIC_ALL) access |= FILE_ALL_ACCESS;
2018 return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
2021 int default_fd_get_poll_events( struct fd *fd )
2023 int events = 0;
2025 if (async_waiting( &fd->read_q )) events |= POLLIN;
2026 if (async_waiting( &fd->write_q )) events |= POLLOUT;
2027 return events;
2030 /* default handler for poll() events */
2031 void default_poll_event( struct fd *fd, int event )
2033 if (event & (POLLIN | POLLERR | POLLHUP)) async_wake_up( &fd->read_q, STATUS_ALERTED );
2034 if (event & (POLLOUT | POLLERR | POLLHUP)) async_wake_up( &fd->write_q, STATUS_ALERTED );
2036 /* if an error occurred, stop polling this fd to avoid busy-looping */
2037 if (event & (POLLERR | POLLHUP)) set_fd_events( fd, -1 );
2038 else if (!fd->inode) set_fd_events( fd, fd->fd_ops->get_poll_events( fd ) );
2041 void fd_queue_async( struct fd *fd, struct async *async, int type )
2043 struct async_queue *queue;
2045 switch (type)
2047 case ASYNC_TYPE_READ:
2048 queue = &fd->read_q;
2049 break;
2050 case ASYNC_TYPE_WRITE:
2051 queue = &fd->write_q;
2052 break;
2053 case ASYNC_TYPE_WAIT:
2054 queue = &fd->wait_q;
2055 break;
2056 default:
2057 queue = NULL;
2058 assert(0);
2061 queue_async( queue, async );
2063 if (type != ASYNC_TYPE_WAIT)
2065 if (!fd->inode)
2066 set_fd_events( fd, fd->fd_ops->get_poll_events( fd ) );
2067 else /* regular files are always ready for read and write */
2068 async_wake_up( queue, STATUS_ALERTED );
2072 void fd_async_wake_up( struct fd *fd, int type, unsigned int status )
2074 switch (type)
2076 case ASYNC_TYPE_READ:
2077 async_wake_up( &fd->read_q, status );
2078 break;
2079 case ASYNC_TYPE_WRITE:
2080 async_wake_up( &fd->write_q, status );
2081 break;
2082 case ASYNC_TYPE_WAIT:
2083 async_wake_up( &fd->wait_q, status );
2084 break;
2085 default:
2086 assert(0);
2090 void fd_reselect_async( struct fd *fd, struct async_queue *queue )
2092 fd->fd_ops->reselect_async( fd, queue );
2095 void no_fd_queue_async( struct fd *fd, struct async *async, int type, int count )
2097 set_error( STATUS_OBJECT_TYPE_MISMATCH );
2100 void default_fd_queue_async( struct fd *fd, struct async *async, int type, int count )
2102 fd_queue_async( fd, async, type );
2103 set_error( STATUS_PENDING );
2106 /* default reselect_async() fd routine */
2107 void default_fd_reselect_async( struct fd *fd, struct async_queue *queue )
2109 if (queue == &fd->read_q || queue == &fd->write_q)
2111 int poll_events = fd->fd_ops->get_poll_events( fd );
2112 int events = check_fd_events( fd, poll_events );
2113 if (events) fd->fd_ops->poll_event( fd, events );
2114 else set_fd_events( fd, poll_events );
2118 static inline int is_valid_mounted_device( struct stat *st )
2120 #if defined(linux) || defined(__sun__)
2121 return S_ISBLK( st->st_mode );
2122 #else
2123 /* disks are char devices on *BSD */
2124 return S_ISCHR( st->st_mode );
2125 #endif
2128 /* close all Unix file descriptors on a device to allow unmounting it */
2129 static void unmount_device( struct fd *device_fd )
2131 unsigned int i;
2132 struct stat st;
2133 struct device *device;
2134 struct inode *inode;
2135 struct fd *fd;
2136 int unix_fd = get_unix_fd( device_fd );
2138 if (unix_fd == -1) return;
2140 if (fstat( unix_fd, &st ) == -1 || !is_valid_mounted_device( &st ))
2142 set_error( STATUS_INVALID_PARAMETER );
2143 return;
2146 if (!(device = get_device( st.st_rdev, -1 ))) return;
2148 for (i = 0; i < INODE_HASH_SIZE; i++)
2150 LIST_FOR_EACH_ENTRY( inode, &device->inode_hash[i], struct inode, entry )
2152 LIST_FOR_EACH_ENTRY( fd, &inode->open, struct fd, inode_entry )
2154 unmount_fd( fd );
2156 inode_close_pending( inode, 0 );
2159 /* remove it from the hash table */
2160 list_remove( &device->entry );
2161 list_init( &device->entry );
2162 release_object( device );
2165 /* default read() routine */
2166 int no_fd_read( struct fd *fd, struct async *async, file_pos_t pos )
2168 set_error( STATUS_OBJECT_TYPE_MISMATCH );
2169 return 0;
2172 /* default write() routine */
2173 int no_fd_write( struct fd *fd, struct async *async, file_pos_t pos )
2175 set_error( STATUS_OBJECT_TYPE_MISMATCH );
2176 return 0;
2179 /* default flush() routine */
2180 int no_fd_flush( struct fd *fd, struct async *async )
2182 set_error( STATUS_OBJECT_TYPE_MISMATCH );
2183 return 0;
2186 /* default get_file_info() routine */
2187 void no_fd_get_file_info( struct fd *fd, obj_handle_t handle, unsigned int info_class )
2189 set_error( STATUS_OBJECT_TYPE_MISMATCH );
2192 /* default get_file_info() routine */
2193 void default_fd_get_file_info( struct fd *fd, obj_handle_t handle, unsigned int info_class )
2195 switch (info_class)
2197 case FileAccessInformation:
2199 FILE_ACCESS_INFORMATION info;
2200 if (get_reply_max_size() < sizeof(info))
2202 set_error( STATUS_INFO_LENGTH_MISMATCH );
2203 return;
2205 info.AccessFlags = get_handle_access( current->process, handle );
2206 set_reply_data( &info, sizeof(info) );
2207 break;
2209 case FileModeInformation:
2211 FILE_MODE_INFORMATION info;
2212 if (get_reply_max_size() < sizeof(info))
2214 set_error( STATUS_INFO_LENGTH_MISMATCH );
2215 return;
2217 info.Mode = fd->options & ( FILE_WRITE_THROUGH
2218 | FILE_SEQUENTIAL_ONLY
2219 | FILE_NO_INTERMEDIATE_BUFFERING
2220 | FILE_SYNCHRONOUS_IO_ALERT
2221 | FILE_SYNCHRONOUS_IO_NONALERT );
2222 set_reply_data( &info, sizeof(info) );
2223 break;
2225 case FileIoCompletionNotificationInformation:
2227 FILE_IO_COMPLETION_NOTIFICATION_INFORMATION info;
2228 if (get_reply_max_size() < sizeof(info))
2230 set_error( STATUS_INFO_LENGTH_MISMATCH );
2231 return;
2233 info.Flags = fd->comp_flags;
2234 set_reply_data( &info, sizeof(info) );
2235 break;
2237 default:
2238 set_error( STATUS_NOT_IMPLEMENTED );
2242 /* default get_volume_info() routine */
2243 void no_fd_get_volume_info( struct fd *fd, unsigned int info_class )
2245 set_error( STATUS_OBJECT_TYPE_MISMATCH );
2248 /* default ioctl() routine */
2249 int no_fd_ioctl( struct fd *fd, ioctl_code_t code, struct async *async )
2251 set_error( STATUS_OBJECT_TYPE_MISMATCH );
2252 return 0;
2255 /* default ioctl() routine */
2256 int default_fd_ioctl( struct fd *fd, ioctl_code_t code, struct async *async )
2258 switch(code)
2260 case FSCTL_DISMOUNT_VOLUME:
2261 unmount_device( fd );
2262 return 1;
2263 default:
2264 set_error( STATUS_NOT_SUPPORTED );
2265 return 0;
2269 /* same as get_handle_obj but retrieve the struct fd associated to the object */
2270 static struct fd *get_handle_fd_obj( struct process *process, obj_handle_t handle,
2271 unsigned int access )
2273 struct fd *fd = NULL;
2274 struct object *obj;
2276 if ((obj = get_handle_obj( process, handle, access, NULL )))
2278 fd = get_obj_fd( obj );
2279 release_object( obj );
2281 return fd;
2284 /* set disposition for the fd */
2285 static void set_fd_disposition( struct fd *fd, int unlink )
2287 struct stat st;
2289 if (!fd->inode)
2291 set_error( STATUS_OBJECT_TYPE_MISMATCH );
2292 return;
2295 if (fd->unix_fd == -1)
2297 set_error( fd->no_fd_status );
2298 return;
2301 if (fstat( fd->unix_fd, &st ) == -1)
2303 file_set_error();
2304 return;
2307 /* can't unlink special files */
2308 if (unlink && !S_ISDIR(st.st_mode) && !S_ISREG(st.st_mode))
2310 set_error( STATUS_INVALID_PARAMETER );
2311 return;
2314 /* can't unlink files we don't have permission to write */
2315 if (unlink && !(st.st_mode & (S_IWUSR | S_IWGRP | S_IWOTH)) && !S_ISDIR(st.st_mode))
2317 set_error( STATUS_CANNOT_DELETE );
2318 return;
2321 fd->closed->unlink = unlink ? 1 : 0;
2322 if (fd->options & FILE_DELETE_ON_CLOSE)
2323 fd->closed->unlink = -1;
2326 /* set new name for the fd */
2327 static void set_fd_name( struct fd *fd, struct fd *root, const char *nameptr,
2328 data_size_t len, int create_link )
2330 struct inode *inode;
2331 struct stat st;
2332 char *name;
2334 if (!fd->inode || !fd->unix_name)
2336 set_error( STATUS_OBJECT_TYPE_MISMATCH );
2337 return;
2339 if (!len || ((nameptr[0] == '/') ^ !root))
2341 set_error( STATUS_OBJECT_PATH_SYNTAX_BAD );
2342 return;
2344 if (!(name = mem_alloc( len + 1 ))) return;
2345 memcpy( name, nameptr, len );
2346 name[len] = 0;
2348 if (root)
2350 char *combined_name = dup_fd_name( root, name );
2351 if (!combined_name)
2353 set_error( STATUS_NO_MEMORY );
2354 goto failed;
2356 free( name );
2357 name = combined_name;
2360 /* when creating a hard link, source cannot be a dir */
2361 if (create_link && fd->unix_fd != -1 &&
2362 !fstat( fd->unix_fd, &st ) && S_ISDIR( st.st_mode ))
2364 set_error( STATUS_FILE_IS_A_DIRECTORY );
2365 goto failed;
2368 if (!stat( name, &st ))
2370 /* can't replace directories or special files */
2371 if (!S_ISREG( st.st_mode ))
2373 set_error( STATUS_ACCESS_DENIED );
2374 goto failed;
2377 /* can't replace an opened file */
2378 if ((inode = get_inode( st.st_dev, st.st_ino, -1 )))
2380 int is_empty = list_empty( &inode->open );
2381 release_object( inode );
2382 if (!is_empty)
2384 set_error( STATUS_ACCESS_DENIED );
2385 goto failed;
2389 /* link() expects that the target doesn't exist */
2390 /* rename() cannot replace files with directories */
2391 if (create_link || (fd->unix_fd != -1 &&
2392 !fstat( fd->unix_fd, &st ) && S_ISDIR( st.st_mode )))
2394 if (unlink( name ))
2396 file_set_error();
2397 goto failed;
2402 if (create_link)
2404 if (link( fd->unix_name, name ))
2405 file_set_error();
2406 free( name );
2407 return;
2410 if (rename( fd->unix_name, name ))
2412 file_set_error();
2413 goto failed;
2416 free( fd->unix_name );
2417 fd->unix_name = name;
2418 fd->closed->unix_name = name;
2419 return;
2421 failed:
2422 free( name );
2425 struct completion *fd_get_completion( struct fd *fd, apc_param_t *p_key )
2427 *p_key = fd->comp_key;
2428 return fd->completion ? (struct completion *)grab_object( fd->completion ) : NULL;
2431 void fd_copy_completion( struct fd *src, struct fd *dst )
2433 assert( !dst->completion );
2434 dst->completion = fd_get_completion( src, &dst->comp_key );
2435 dst->comp_flags = src->comp_flags;
2438 /* flush a file buffers */
2439 DECL_HANDLER(flush)
2441 struct fd *fd = get_handle_fd_obj( current->process, req->async.handle, 0 );
2442 struct async *async;
2444 if (!fd) return;
2446 if ((async = create_request_async( fd, fd->comp_flags, &req->async )))
2448 reply->event = async_handoff( async, fd->fd_ops->flush( fd, async ), NULL, 1 );
2449 release_object( async );
2451 release_object( fd );
2454 /* query file info */
2455 DECL_HANDLER(get_file_info)
2457 struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
2459 if (fd)
2461 fd->fd_ops->get_file_info( fd, req->handle, req->info_class );
2462 release_object( fd );
2466 /* query volume info */
2467 DECL_HANDLER(get_volume_info)
2469 struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
2471 if (fd)
2473 fd->fd_ops->get_volume_info( fd, req->info_class );
2474 release_object( fd );
2478 /* open a file object */
2479 DECL_HANDLER(open_file_object)
2481 struct unicode_str name = get_req_unicode_str();
2482 struct object *obj, *result, *root = NULL;
2484 if (req->rootdir && !(root = get_handle_obj( current->process, req->rootdir, 0, NULL ))) return;
2486 obj = open_named_object( root, NULL, &name, req->attributes );
2487 if (root) release_object( root );
2488 if (!obj) return;
2490 if ((result = obj->ops->open_file( obj, req->access, req->sharing, req->options )))
2492 reply->handle = alloc_handle( current->process, result, req->access, req->attributes );
2493 release_object( result );
2495 release_object( obj );
2498 /* get the Unix name from a file handle */
2499 DECL_HANDLER(get_handle_unix_name)
2501 struct fd *fd;
2503 if ((fd = get_handle_fd_obj( current->process, req->handle, 0 )))
2505 if (fd->unix_name)
2507 data_size_t name_len = strlen( fd->unix_name );
2508 reply->name_len = name_len;
2509 if (name_len <= get_reply_max_size()) set_reply_data( fd->unix_name, name_len );
2510 else set_error( STATUS_BUFFER_OVERFLOW );
2512 else set_error( STATUS_OBJECT_TYPE_MISMATCH );
2513 release_object( fd );
2517 /* get a Unix fd to access a file */
2518 DECL_HANDLER(get_handle_fd)
2520 struct fd *fd;
2522 if ((fd = get_handle_fd_obj( current->process, req->handle, 0 )))
2524 int unix_fd = get_unix_fd( fd );
2525 reply->cacheable = fd->cacheable;
2526 if (unix_fd != -1)
2528 reply->type = fd->fd_ops->get_fd_type( fd );
2529 reply->options = fd->options;
2530 reply->access = get_handle_access( current->process, req->handle );
2531 send_client_fd( current->process, unix_fd, req->handle );
2533 release_object( fd );
2537 /* perform a read on a file object */
2538 DECL_HANDLER(read)
2540 struct fd *fd = get_handle_fd_obj( current->process, req->async.handle, FILE_READ_DATA );
2541 struct async *async;
2543 if (!fd) return;
2545 if ((async = create_request_async( fd, fd->comp_flags, &req->async )))
2547 reply->wait = async_handoff( async, fd->fd_ops->read( fd, async, req->pos ), NULL, 0 );
2548 reply->options = fd->options;
2549 release_object( async );
2551 release_object( fd );
2554 /* perform a write on a file object */
2555 DECL_HANDLER(write)
2557 struct fd *fd = get_handle_fd_obj( current->process, req->async.handle, FILE_WRITE_DATA );
2558 struct async *async;
2560 if (!fd) return;
2562 if ((async = create_request_async( fd, fd->comp_flags, &req->async )))
2564 reply->wait = async_handoff( async, fd->fd_ops->write( fd, async, req->pos ), &reply->size, 0 );
2565 reply->options = fd->options;
2566 release_object( async );
2568 release_object( fd );
2571 /* perform an ioctl on a file */
2572 DECL_HANDLER(ioctl)
2574 unsigned int access = (req->code >> 14) & (FILE_READ_DATA|FILE_WRITE_DATA);
2575 struct fd *fd = get_handle_fd_obj( current->process, req->async.handle, access );
2576 struct async *async;
2578 if (!fd) return;
2580 if ((async = create_request_async( fd, fd->comp_flags, &req->async )))
2582 reply->wait = async_handoff( async, fd->fd_ops->ioctl( fd, req->code, async ), NULL, 0 );
2583 reply->options = fd->options;
2584 release_object( async );
2586 release_object( fd );
2589 /* create / reschedule an async I/O */
2590 DECL_HANDLER(register_async)
2592 unsigned int access;
2593 struct async *async;
2594 struct fd *fd;
2596 switch(req->type)
2598 case ASYNC_TYPE_READ:
2599 access = FILE_READ_DATA;
2600 break;
2601 case ASYNC_TYPE_WRITE:
2602 access = FILE_WRITE_DATA;
2603 break;
2604 default:
2605 set_error( STATUS_INVALID_PARAMETER );
2606 return;
2609 if ((fd = get_handle_fd_obj( current->process, req->async.handle, access )))
2611 if (get_unix_fd( fd ) != -1 && (async = create_async( fd, current, &req->async, NULL )))
2613 fd->fd_ops->queue_async( fd, async, req->type, req->count );
2614 release_object( async );
2616 release_object( fd );
2620 /* attach completion object to a fd */
2621 DECL_HANDLER(set_completion_info)
2623 struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
2625 if (fd)
2627 if (is_fd_overlapped( fd ) && !fd->completion)
2629 fd->completion = get_completion_obj( current->process, req->chandle, IO_COMPLETION_MODIFY_STATE );
2630 fd->comp_key = req->ckey;
2632 else set_error( STATUS_INVALID_PARAMETER );
2633 release_object( fd );
2637 /* push new completion msg into a completion queue attached to the fd */
2638 DECL_HANDLER(add_fd_completion)
2640 struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
2641 if (fd)
2643 if (fd->completion && (req->async || !(fd->comp_flags & FILE_SKIP_COMPLETION_PORT_ON_SUCCESS)))
2644 add_completion( fd->completion, fd->comp_key, req->cvalue, req->status, req->information );
2645 release_object( fd );
2649 /* set fd completion information */
2650 DECL_HANDLER(set_fd_completion_mode)
2652 struct fd *fd = get_handle_fd_obj( current->process, req->handle, 0 );
2653 if (fd)
2655 if (is_fd_overlapped( fd ))
2657 if (req->flags & FILE_SKIP_SET_EVENT_ON_HANDLE)
2658 set_fd_signaled( fd, 0 );
2659 /* removing flags is not allowed */
2660 fd->comp_flags |= req->flags & ( FILE_SKIP_COMPLETION_PORT_ON_SUCCESS
2661 | FILE_SKIP_SET_EVENT_ON_HANDLE
2662 | FILE_SKIP_SET_USER_EVENT_ON_FAST_IO );
2664 else
2665 set_error( STATUS_INVALID_PARAMETER );
2666 release_object( fd );
2670 /* set fd disposition information */
2671 DECL_HANDLER(set_fd_disp_info)
2673 struct fd *fd = get_handle_fd_obj( current->process, req->handle, DELETE );
2674 if (fd)
2676 set_fd_disposition( fd, req->unlink );
2677 release_object( fd );
2681 /* set fd name information */
2682 DECL_HANDLER(set_fd_name_info)
2684 struct fd *fd, *root_fd = NULL;
2686 if (req->rootdir)
2688 struct dir *root;
2690 if (!(root = get_dir_obj( current->process, req->rootdir, 0 ))) return;
2691 root_fd = get_obj_fd( (struct object *)root );
2692 release_object( root );
2693 if (!root_fd) return;
2696 if ((fd = get_handle_fd_obj( current->process, req->handle, 0 )))
2698 set_fd_name( fd, root_fd, get_req_data(), get_req_data_size(), req->link );
2699 release_object( fd );
2701 if (root_fd) release_object( root_fd );