2 * Server-side change notification management
4 * Copyright (C) 1998 Alexandre Julliard
5 * Copyright (C) 2006 Mike McCormack
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 #include "wine/port.h"
31 #include <sys/types.h>
35 #ifdef HAVE_SYS_ERRNO_H
36 #include <sys/errno.h>
40 #define WIN32_NO_STATUS
54 #define DN_ACCESS 0x00000001 /* File accessed */
55 #define DN_MODIFY 0x00000002 /* File modified */
56 #define DN_CREATE 0x00000004 /* File created */
57 #define DN_DELETE 0x00000008 /* File removed */
58 #define DN_RENAME 0x00000010 /* File renamed */
59 #define DN_ATTRIB 0x00000020 /* File changed attibutes */
60 #define DN_MULTISHOT 0x80000000 /* Don't remove notifier */
66 #if defined(__linux__) && defined(__i386__)
68 #define SYS_inotify_init 291
69 #define SYS_inotify_add_watch 292
70 #define SYS_inotify_rm_watch 293
72 struct inotify_event {
80 #define IN_ACCESS 0x00000001
81 #define IN_MODIFY 0x00000002
82 #define IN_ATTRIB 0x00000004
83 #define IN_CLOSE_WRITE 0x00000008
84 #define IN_CLOSE_NOWRITE 0x00000010
85 #define IN_OPEN 0x00000020
86 #define IN_MOVED_FROM 0x00000040
87 #define IN_MOVED_TO 0x00000080
88 #define IN_CREATE 0x00000100
89 #define IN_DELETE 0x00000200
90 #define IN_DELETE_SELF 0x00000400
92 static inline int inotify_init( void )
95 __asm__ __volatile__( "int $0x80"
97 : "0" (SYS_inotify_init));
98 if (ret<0) { errno = -ret; ret = -1; }
102 static inline int inotify_add_watch( int fd, const char *name, unsigned int mask )
105 __asm__ __volatile__( "pushl %%ebx;\n\t"
109 : "=a" (ret) : "0" (SYS_inotify_add_watch),
110 "r" (fd), "c" (name), "d" (mask) );
111 if (ret<0) { errno = -ret; ret = -1; }
115 static inline int inotify_remove_watch( int fd, int wd )
118 __asm__ __volatile__( "pushl %%ebx;\n\t"
122 : "=a" (ret) : "0" (SYS_inotify_rm_watch),
123 "r" (fd), "c" (wd) );
124 if (ret<0) { errno = -ret; ret = -1; }
134 static void free_inode( struct inode *inode );
136 static struct fd *inotify_fd;
138 struct change_record {
147 struct object obj; /* object header */
148 struct fd *fd; /* file descriptor to the directory */
149 struct list entry; /* entry in global change notifications list */
150 unsigned int filter; /* notification filter */
151 int notified; /* SIGIO counter */
152 int want_data; /* return change data */
153 int subtree; /* do we want to watch subdirectories? */
154 struct list change_records; /* data for the change */
155 struct list in_entry; /* entry in the inode dirs list */
156 struct inode *inode; /* inode of the associated directory */
159 static struct fd *dir_get_fd( struct object *obj );
160 static void dir_dump( struct object *obj, int verbose );
161 static void dir_destroy( struct object *obj );
163 static const struct object_ops dir_ops =
165 sizeof(struct dir), /* size */
167 add_queue, /* add_queue */
168 remove_queue, /* remove_queue */
169 default_fd_signaled, /* signaled */
170 no_satisfied, /* satisfied */
171 no_signal, /* signal */
172 dir_get_fd, /* get_fd */
173 default_fd_map_access, /* map_access */
174 no_lookup_name, /* lookup_name */
175 no_open_file, /* open_file */
176 fd_close_handle, /* close_handle */
177 dir_destroy /* destroy */
180 static int dir_get_poll_events( struct fd *fd );
181 static enum server_fd_type dir_get_fd_type( struct fd *fd );
183 static const struct fd_ops dir_fd_ops =
185 dir_get_poll_events, /* get_poll_events */
186 default_poll_event, /* poll_event */
187 no_flush, /* flush */
188 dir_get_fd_type, /* get_fd_type */
189 default_fd_ioctl, /* ioctl */
190 default_fd_queue_async, /* queue_async */
191 default_fd_reselect_async, /* reselect_async */
192 default_fd_cancel_async /* cancel_async */
195 static struct list change_list = LIST_INIT(change_list);
197 static void dnotify_adjust_changes( struct dir *dir )
199 #if defined(F_SETSIG) && defined(F_NOTIFY)
200 int fd = get_unix_fd( dir->fd );
201 unsigned int filter = dir->filter;
203 if ( 0 > fcntl( fd, F_SETSIG, SIGIO) )
207 if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
208 val |= DN_RENAME | DN_DELETE | DN_CREATE;
209 if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
210 val |= DN_RENAME | DN_DELETE | DN_CREATE;
211 if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
213 if (filter & FILE_NOTIFY_CHANGE_SIZE)
215 if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
217 if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
219 if (filter & FILE_NOTIFY_CHANGE_CREATION)
221 if (filter & FILE_NOTIFY_CHANGE_SECURITY)
223 fcntl( fd, F_NOTIFY, val );
227 /* insert change in the global list */
228 static inline void insert_change( struct dir *dir )
232 sigemptyset( &sigset );
233 sigaddset( &sigset, SIGIO );
234 sigprocmask( SIG_BLOCK, &sigset, NULL );
235 list_add_head( &change_list, &dir->entry );
236 sigprocmask( SIG_UNBLOCK, &sigset, NULL );
239 /* remove change from the global list */
240 static inline void remove_change( struct dir *dir )
244 sigemptyset( &sigset );
245 sigaddset( &sigset, SIGIO );
246 sigprocmask( SIG_BLOCK, &sigset, NULL );
247 list_remove( &dir->entry );
248 sigprocmask( SIG_UNBLOCK, &sigset, NULL );
251 static void dir_dump( struct object *obj, int verbose )
253 struct dir *dir = (struct dir *)obj;
254 assert( obj->ops == &dir_ops );
255 fprintf( stderr, "Dirfile fd=%p filter=%08x\n", dir->fd, dir->filter );
258 /* enter here directly from SIGIO signal handler */
259 void do_change_notify( int unix_fd )
263 /* FIXME: this is O(n) ... probably can be improved */
264 LIST_FOR_EACH_ENTRY( dir, &change_list, struct dir, entry )
266 if (get_unix_fd( dir->fd ) != unix_fd) continue;
267 interlocked_xchg_add( &dir->notified, 1 );
272 /* SIGIO callback, called synchronously with the poll loop */
273 void sigio_callback(void)
277 LIST_FOR_EACH_ENTRY( dir, &change_list, struct dir, entry )
279 if (interlocked_xchg( &dir->notified, 0 ))
280 fd_async_wake_up( dir->fd, ASYNC_TYPE_WAIT, STATUS_NOTIFY_ENUM_DIR );
284 static struct fd *dir_get_fd( struct object *obj )
286 struct dir *dir = (struct dir *)obj;
287 assert( obj->ops == &dir_ops );
288 return (struct fd *)grab_object( dir->fd );
291 static struct change_record *get_first_change_record( struct dir *dir )
293 struct list *ptr = list_head( &dir->change_records );
294 if (!ptr) return NULL;
296 return LIST_ENTRY( ptr, struct change_record, entry );
299 static void dir_destroy( struct object *obj )
301 struct change_record *record;
302 struct dir *dir = (struct dir *)obj;
303 assert (obj->ops == &dir_ops);
306 remove_change( dir );
310 list_remove( &dir->in_entry );
311 free_inode( dir->inode );
314 while ((record = get_first_change_record( dir ))) free( record );
316 release_object( dir->fd );
318 if (inotify_fd && list_empty( &change_list ))
320 release_object( inotify_fd );
326 get_dir_obj( struct process *process, obj_handle_t handle, unsigned int access )
328 return (struct dir *)get_handle_obj( process, handle, access, &dir_ops );
331 static int dir_get_poll_events( struct fd *fd )
336 static enum server_fd_type dir_get_fd_type( struct fd *fd )
346 struct list ch_entry; /* entry in the children list */
347 struct list children; /* children of this inode */
348 struct inode *parent; /* parent of this inode */
349 struct list dirs; /* directory handles watching this inode */
350 struct list ino_entry; /* entry in the inode hash */
351 struct list wd_entry; /* entry in the watch descriptor hash */
352 dev_t dev; /* device number */
353 ino_t ino; /* device's inode number */
354 int wd; /* inotify's watch descriptor */
355 char *name; /* basename name of the inode */
358 struct list inode_hash[ HASH_SIZE ];
359 struct list wd_hash[ HASH_SIZE ];
361 static int inotify_add_dir( char *path, unsigned int filter );
363 static struct inode *inode_from_wd( int wd )
365 struct list *bucket = &wd_hash[ wd % HASH_SIZE ];
368 LIST_FOR_EACH_ENTRY( inode, bucket, struct inode, wd_entry )
375 static inline struct list *get_hash_list( dev_t dev, ino_t ino )
377 return &inode_hash[ (ino ^ dev) % HASH_SIZE ];
380 static struct inode *find_inode( dev_t dev, ino_t ino )
382 struct list *bucket = get_hash_list( dev, ino );
385 LIST_FOR_EACH_ENTRY( inode, bucket, struct inode, ino_entry )
386 if (inode->ino == ino && inode->dev == dev)
392 static struct inode *create_inode( dev_t dev, ino_t ino )
396 inode = malloc( sizeof *inode );
399 list_init( &inode->children );
400 list_init( &inode->dirs );
404 inode->parent = NULL;
406 list_add_tail( get_hash_list( dev, ino ), &inode->ino_entry );
411 static struct inode *get_inode( dev_t dev, ino_t ino )
415 inode = find_inode( dev, ino );
418 return create_inode( dev, ino );
421 static void inode_set_wd( struct inode *inode, int wd )
424 list_remove( &inode->wd_entry );
426 list_add_tail( &wd_hash[ wd % HASH_SIZE ], &inode->wd_entry );
429 static void inode_set_name( struct inode *inode, const char *name )
432 inode->name = name ? strdup( name ) : NULL;
435 static void free_inode( struct inode *inode )
437 int subtree = 0, watches = 0;
440 LIST_FOR_EACH_ENTRY( dir, &inode->dirs, struct dir, in_entry )
442 subtree |= dir->subtree;
446 if (!subtree && !inode->parent)
448 struct inode *tmp, *next;
449 LIST_FOR_EACH_ENTRY_SAFE( tmp, next, &inode->children,
450 struct inode, ch_entry )
452 assert( tmp != inode );
453 assert( tmp->parent == inode );
462 list_remove( &inode->ch_entry );
466 inotify_remove_watch( get_unix_fd( inotify_fd ), inode->wd );
467 list_remove( &inode->wd_entry );
469 list_remove( &inode->ino_entry );
475 static struct inode *inode_add( struct inode *parent,
476 dev_t dev, ino_t ino, const char *name )
480 inode = get_inode( dev, ino );
486 list_add_tail( &parent->children, &inode->ch_entry );
487 inode->parent = parent;
488 assert( inode != parent );
490 inode_set_name( inode, name );
495 static struct inode *inode_from_name( struct inode *inode, const char *name )
499 LIST_FOR_EACH_ENTRY( i, &inode->children, struct inode, ch_entry )
500 if (i->name && !strcmp( i->name, name ))
505 static int inotify_get_poll_events( struct fd *fd );
506 static void inotify_poll_event( struct fd *fd, int event );
508 static const struct fd_ops inotify_fd_ops =
510 inotify_get_poll_events, /* get_poll_events */
511 inotify_poll_event, /* poll_event */
513 NULL, /* get_fd_type */
515 NULL, /* queue_async */
516 NULL, /* reselect_async */
517 NULL, /* cancel_async */
520 static int inotify_get_poll_events( struct fd *fd )
525 static void inotify_do_change_notify( struct dir *dir, unsigned int action,
526 const char *relpath )
528 struct change_record *record;
530 assert( dir->obj.ops == &dir_ops );
534 size_t len = strlen(relpath);
535 record = malloc( offsetof(struct change_record, name[len]) );
539 record->action = action;
540 memcpy( record->name, relpath, len );
543 list_add_tail( &dir->change_records, &record->entry );
546 fd_async_wake_up( dir->fd, ASYNC_TYPE_WAIT, STATUS_ALERTED );
549 static unsigned int filter_from_event( struct inotify_event *ie )
551 unsigned int filter = 0;
553 if (ie->mask & (IN_MOVED_FROM | IN_MOVED_TO | IN_DELETE | IN_CREATE))
554 filter |= FILE_NOTIFY_CHANGE_FILE_NAME | FILE_NOTIFY_CHANGE_DIR_NAME;
555 if (ie->mask & IN_MODIFY)
556 filter |= FILE_NOTIFY_CHANGE_SIZE | FILE_NOTIFY_CHANGE_LAST_WRITE;
557 if (ie->mask & IN_ATTRIB)
558 filter |= FILE_NOTIFY_CHANGE_ATTRIBUTES | FILE_NOTIFY_CHANGE_SECURITY;
559 if (ie->mask & IN_ACCESS)
560 filter |= FILE_NOTIFY_CHANGE_LAST_ACCESS;
561 if (ie->mask & IN_CREATE)
562 filter |= FILE_NOTIFY_CHANGE_CREATION;
567 /* scan up the parent directories for watches */
568 static unsigned int filter_from_inode( struct inode *inode, int is_parent )
570 unsigned int filter = 0;
573 /* combine filters from parents watching subtrees */
576 LIST_FOR_EACH_ENTRY( dir, &inode->dirs, struct dir, in_entry )
577 if (dir->subtree || !is_parent)
578 filter |= dir->filter;
580 inode = inode->parent;
586 static char *inode_get_path( struct inode *inode, int sz )
595 head = list_head( &inode->dirs );
598 int unix_fd = get_unix_fd( LIST_ENTRY( head, struct dir, in_entry )->fd );
599 path = malloc ( 32 + sz );
601 sprintf( path, "/proc/self/fd/%u/", unix_fd );
608 len = strlen( inode->name );
609 path = inode_get_path( inode->parent, sz + len + 1 );
613 strcat( path, inode->name );
619 static int inode_check_dir( struct inode *parent, const char *name )
627 path = inode_get_path( parent, strlen(name) );
631 strcat( path, name );
633 r = stat( path, &st );
636 if (!S_ISDIR(st.st_mode))
644 filter = filter_from_inode( parent, 1 );
648 inode = inode_add( parent, st.st_dev, st.st_ino, name );
649 if (!inode || inode->wd != -1)
652 wd = inotify_add_dir( path, filter );
654 inode_set_wd( inode, wd );
663 static int prepend( char **path, const char *segment )
668 extra = strlen( segment ) + 1;
671 int len = strlen( *path ) + 1;
672 p = realloc( *path, len + extra );
674 memmove( &p[ extra ], p, len );
675 p[ extra - 1 ] = '/';
676 memcpy( p, segment, extra - 1 );
682 memcpy( p, segment, extra );
690 static void inotify_notify_all( struct inotify_event *ie )
692 unsigned int filter, action;
693 struct inode *inode, *i;
697 inode = inode_from_wd( ie->wd );
700 fprintf( stderr, "no inode matches %d\n", ie->wd);
704 filter = filter_from_event( ie );
706 if (ie->mask & IN_CREATE)
708 switch (inode_check_dir( inode, ie->name ))
711 filter &= ~FILE_NOTIFY_CHANGE_FILE_NAME;
714 filter &= ~FILE_NOTIFY_CHANGE_DIR_NAME;
718 /* Maybe the file disappeared before we could check it? */
720 action = FILE_ACTION_ADDED;
722 else if (ie->mask & IN_DELETE)
723 action = FILE_ACTION_REMOVED;
725 action = FILE_ACTION_MODIFIED;
728 * Work our way up the inode hierarchy
729 * extending the relative path as we go
730 * and notifying all recursive watches.
732 if (!prepend( &path, ie->name ))
735 for (i = inode; i; i = i->parent)
737 LIST_FOR_EACH_ENTRY( dir, &i->dirs, struct dir, in_entry )
738 if ((filter & dir->filter) && (i==inode || dir->subtree))
739 inotify_do_change_notify( dir, action, path );
741 if (!i->name || !prepend( &path, i->name ))
747 if (ie->mask & IN_DELETE)
749 i = inode_from_name( inode, ie->name );
755 static void inotify_poll_event( struct fd *fd, int event )
759 struct inotify_event *ie;
761 unix_fd = get_unix_fd( fd );
762 r = read( unix_fd, buffer, sizeof buffer );
765 fprintf(stderr,"inotify_poll_event(): inotify read failed!\n");
769 for( ofs = 0; ofs < r - offsetof(struct inotify_event, name); )
771 ie = (struct inotify_event*) &buffer[ofs];
774 ofs += offsetof( struct inotify_event, name[ie->len] );
776 inotify_notify_all( ie );
780 static inline struct fd *create_inotify_fd( void )
784 unix_fd = inotify_init();
787 return create_anonymous_fd( &inotify_fd_ops, unix_fd, NULL, 0 );
790 static int map_flags( unsigned int filter )
794 /* always watch these so we can track subdirectories in recursive watches */
795 mask = (IN_MOVED_FROM | IN_MOVED_TO | IN_DELETE | IN_CREATE | IN_DELETE_SELF);
797 if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
799 if (filter & FILE_NOTIFY_CHANGE_SIZE)
801 if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
803 if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
805 if (filter & FILE_NOTIFY_CHANGE_SECURITY)
811 static int inotify_add_dir( char *path, unsigned int filter )
813 int wd = inotify_add_watch( get_unix_fd( inotify_fd ),
814 path, map_flags( filter ) );
816 set_fd_events( inotify_fd, POLLIN );
820 static int init_inotify( void )
827 inotify_fd = create_inotify_fd();
831 for (i=0; i<HASH_SIZE; i++)
833 list_init( &inode_hash[i] );
834 list_init( &wd_hash[i] );
840 static int inotify_adjust_changes( struct dir *dir )
851 unix_fd = get_unix_fd( dir->fd );
856 /* check if this fd is already being watched */
857 if (-1 == fstat( unix_fd, &st ))
860 inode = get_inode( st.st_dev, st.st_ino );
862 inode = create_inode( st.st_dev, st.st_ino );
865 list_add_tail( &inode->dirs, &dir->in_entry );
869 filter = filter_from_inode( inode, 0 );
871 sprintf( path, "/proc/self/fd/%u", unix_fd );
872 wd = inotify_add_dir( path, filter );
873 if (wd == -1) return 0;
875 inode_set_wd( inode, wd );
880 static char *get_basename( const char *link )
882 char *buffer, *name = NULL;
887 buffer = malloc( n );
888 if (!buffer) return NULL;
890 r = readlink( link, buffer, n );
905 while (r > 0 && name[ r - 1 ] == '/' )
909 name = strrchr( name, '/' );
911 name = strdup( &name[1] );
918 static int dir_add_to_existing_notify( struct dir *dir )
920 struct inode *inode, *parent;
921 unsigned int filter = 0;
922 struct stat st, st_new;
923 char link[35], *name;
929 unix_fd = get_unix_fd( dir->fd );
931 /* check if it's in the list of inodes we want to watch */
932 if (-1 == fstat( unix_fd, &st_new ))
934 inode = find_inode( st_new.st_dev, st_new.st_ino );
938 /* lookup the parent */
939 sprintf( link, "/proc/self/fd/%u/..", unix_fd );
940 if (-1 == stat( link, &st ))
944 * If there's no parent, stop. We could keep going adding
945 * ../ to the path until we hit the root of the tree or
946 * find a recursively watched ancestor.
947 * Assume it's too expensive to search up the tree for now.
949 parent = find_inode( st.st_dev, st.st_ino );
953 if (parent->wd == -1)
956 filter = filter_from_inode( parent, 1 );
960 sprintf( link, "/proc/self/fd/%u", unix_fd );
961 name = get_basename( link );
964 inode = inode_add( parent, st_new.st_dev, st_new.st_ino, name );
969 /* Couldn't find this inode at the start of the function, must be new */
970 assert( inode->wd == -1 );
972 wd = inotify_add_dir( link, filter );
974 inode_set_wd( inode, wd );
981 static int init_inotify( void )
986 static int inotify_adjust_changes( struct dir *dir )
991 static void free_inode( struct inode *inode )
996 static int dir_add_to_existing_notify( struct dir *dir )
1001 #endif /* USE_INOTIFY */
1003 struct object *create_dir_obj( struct fd *fd )
1007 dir = alloc_object( &dir_ops );
1011 list_init( &dir->change_records );
1018 set_fd_user( fd, &dir_fd_ops, &dir->obj );
1020 dir_add_to_existing_notify( dir );
1025 /* enable change notifications for a directory */
1026 DECL_HANDLER(read_directory_changes)
1029 struct async *async;
1033 set_error(STATUS_INVALID_PARAMETER);
1037 dir = get_dir_obj( current->process, req->handle, 0 );
1041 /* requests don't timeout */
1042 if (!(async = fd_queue_async( dir->fd, &req->async, ASYNC_TYPE_WAIT, 0 ))) goto end;
1044 /* assign it once */
1048 insert_change( dir );
1049 dir->filter = req->filter;
1050 dir->subtree = req->subtree;
1051 dir->want_data = req->want_data;
1054 /* if there's already a change in the queue, send it */
1055 if (!list_empty( &dir->change_records ))
1056 fd_async_wake_up( dir->fd, ASYNC_TYPE_WAIT, STATUS_ALERTED );
1058 /* setup the real notification */
1059 if (!inotify_adjust_changes( dir ))
1060 dnotify_adjust_changes( dir );
1062 release_object( async );
1063 set_error(STATUS_PENDING);
1066 release_object( dir );
1069 DECL_HANDLER(read_change)
1071 struct change_record *record;
1074 dir = get_dir_obj( current->process, req->handle, 0 );
1078 if ((record = get_first_change_record( dir )) != NULL)
1080 reply->action = record->action;
1081 set_reply_data( record->name, record->len );
1085 set_error( STATUS_NO_DATA_DETECTED );
1087 release_object( dir );