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 attributes */
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 no_get_type, /* get_type */
168 add_queue, /* add_queue */
169 remove_queue, /* remove_queue */
170 default_fd_signaled, /* signaled */
171 no_satisfied, /* satisfied */
172 no_signal, /* signal */
173 dir_get_fd, /* get_fd */
174 default_fd_map_access, /* map_access */
175 default_get_sd, /* get_sd */
176 default_set_sd, /* set_sd */
177 no_lookup_name, /* lookup_name */
178 no_open_file, /* open_file */
179 fd_close_handle, /* close_handle */
180 dir_destroy /* destroy */
183 static int dir_get_poll_events( struct fd *fd );
184 static enum server_fd_type dir_get_fd_type( struct fd *fd );
186 static const struct fd_ops dir_fd_ops =
188 dir_get_poll_events, /* get_poll_events */
189 default_poll_event, /* poll_event */
190 no_flush, /* flush */
191 dir_get_fd_type, /* get_fd_type */
192 default_fd_ioctl, /* ioctl */
193 default_fd_queue_async, /* queue_async */
194 default_fd_reselect_async, /* reselect_async */
195 default_fd_cancel_async /* cancel_async */
198 static struct list change_list = LIST_INIT(change_list);
200 static void dnotify_adjust_changes( struct dir *dir )
202 #if defined(F_SETSIG) && defined(F_NOTIFY)
203 int fd = get_unix_fd( dir->fd );
204 unsigned int filter = dir->filter;
206 if ( 0 > fcntl( fd, F_SETSIG, SIGIO) )
210 if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
211 val |= DN_RENAME | DN_DELETE | DN_CREATE;
212 if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
213 val |= DN_RENAME | DN_DELETE | DN_CREATE;
214 if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
216 if (filter & FILE_NOTIFY_CHANGE_SIZE)
218 if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
220 if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
222 if (filter & FILE_NOTIFY_CHANGE_CREATION)
224 if (filter & FILE_NOTIFY_CHANGE_SECURITY)
226 fcntl( fd, F_NOTIFY, val );
230 /* insert change in the global list */
231 static inline void insert_change( struct dir *dir )
235 sigemptyset( &sigset );
236 sigaddset( &sigset, SIGIO );
237 sigprocmask( SIG_BLOCK, &sigset, NULL );
238 list_add_head( &change_list, &dir->entry );
239 sigprocmask( SIG_UNBLOCK, &sigset, NULL );
242 /* remove change from the global list */
243 static inline void remove_change( struct dir *dir )
247 sigemptyset( &sigset );
248 sigaddset( &sigset, SIGIO );
249 sigprocmask( SIG_BLOCK, &sigset, NULL );
250 list_remove( &dir->entry );
251 sigprocmask( SIG_UNBLOCK, &sigset, NULL );
254 static void dir_dump( struct object *obj, int verbose )
256 struct dir *dir = (struct dir *)obj;
257 assert( obj->ops == &dir_ops );
258 fprintf( stderr, "Dirfile fd=%p filter=%08x\n", dir->fd, dir->filter );
261 /* enter here directly from SIGIO signal handler */
262 void do_change_notify( int unix_fd )
266 /* FIXME: this is O(n) ... probably can be improved */
267 LIST_FOR_EACH_ENTRY( dir, &change_list, struct dir, entry )
269 if (get_unix_fd( dir->fd ) != unix_fd) continue;
270 interlocked_xchg_add( &dir->notified, 1 );
275 /* SIGIO callback, called synchronously with the poll loop */
276 void sigio_callback(void)
280 LIST_FOR_EACH_ENTRY( dir, &change_list, struct dir, entry )
282 if (interlocked_xchg( &dir->notified, 0 ))
283 fd_async_wake_up( dir->fd, ASYNC_TYPE_WAIT, STATUS_NOTIFY_ENUM_DIR );
287 static struct fd *dir_get_fd( struct object *obj )
289 struct dir *dir = (struct dir *)obj;
290 assert( obj->ops == &dir_ops );
291 return (struct fd *)grab_object( dir->fd );
294 static struct change_record *get_first_change_record( struct dir *dir )
296 struct list *ptr = list_head( &dir->change_records );
297 if (!ptr) return NULL;
299 return LIST_ENTRY( ptr, struct change_record, entry );
302 static void dir_destroy( struct object *obj )
304 struct change_record *record;
305 struct dir *dir = (struct dir *)obj;
306 assert (obj->ops == &dir_ops);
309 remove_change( dir );
313 list_remove( &dir->in_entry );
314 free_inode( dir->inode );
317 while ((record = get_first_change_record( dir ))) free( record );
319 release_object( dir->fd );
321 if (inotify_fd && list_empty( &change_list ))
323 release_object( inotify_fd );
329 get_dir_obj( struct process *process, obj_handle_t handle, unsigned int access )
331 return (struct dir *)get_handle_obj( process, handle, access, &dir_ops );
334 static int dir_get_poll_events( struct fd *fd )
339 static enum server_fd_type dir_get_fd_type( struct fd *fd )
349 struct list ch_entry; /* entry in the children list */
350 struct list children; /* children of this inode */
351 struct inode *parent; /* parent of this inode */
352 struct list dirs; /* directory handles watching this inode */
353 struct list ino_entry; /* entry in the inode hash */
354 struct list wd_entry; /* entry in the watch descriptor hash */
355 dev_t dev; /* device number */
356 ino_t ino; /* device's inode number */
357 int wd; /* inotify's watch descriptor */
358 char *name; /* basename name of the inode */
361 struct list inode_hash[ HASH_SIZE ];
362 struct list wd_hash[ HASH_SIZE ];
364 static int inotify_add_dir( char *path, unsigned int filter );
366 static struct inode *inode_from_wd( int wd )
368 struct list *bucket = &wd_hash[ wd % HASH_SIZE ];
371 LIST_FOR_EACH_ENTRY( inode, bucket, struct inode, wd_entry )
378 static inline struct list *get_hash_list( dev_t dev, ino_t ino )
380 return &inode_hash[ (ino ^ dev) % HASH_SIZE ];
383 static struct inode *find_inode( dev_t dev, ino_t ino )
385 struct list *bucket = get_hash_list( dev, ino );
388 LIST_FOR_EACH_ENTRY( inode, bucket, struct inode, ino_entry )
389 if (inode->ino == ino && inode->dev == dev)
395 static struct inode *create_inode( dev_t dev, ino_t ino )
399 inode = malloc( sizeof *inode );
402 list_init( &inode->children );
403 list_init( &inode->dirs );
407 inode->parent = NULL;
409 list_add_tail( get_hash_list( dev, ino ), &inode->ino_entry );
414 static struct inode *get_inode( dev_t dev, ino_t ino )
418 inode = find_inode( dev, ino );
421 return create_inode( dev, ino );
424 static void inode_set_wd( struct inode *inode, int wd )
427 list_remove( &inode->wd_entry );
429 list_add_tail( &wd_hash[ wd % HASH_SIZE ], &inode->wd_entry );
432 static void inode_set_name( struct inode *inode, const char *name )
435 inode->name = name ? strdup( name ) : NULL;
438 static void free_inode( struct inode *inode )
440 int subtree = 0, watches = 0;
441 struct inode *tmp, *next;
444 LIST_FOR_EACH_ENTRY( dir, &inode->dirs, struct dir, in_entry )
446 subtree |= dir->subtree;
450 if (!subtree && !inode->parent)
452 LIST_FOR_EACH_ENTRY_SAFE( tmp, next, &inode->children,
453 struct inode, ch_entry )
455 assert( tmp != inode );
456 assert( tmp->parent == inode );
465 list_remove( &inode->ch_entry );
467 /* disconnect remaining children from the parent */
468 LIST_FOR_EACH_ENTRY_SAFE( tmp, next, &inode->children, struct inode, ch_entry )
470 list_remove( &tmp->ch_entry );
476 inotify_remove_watch( get_unix_fd( inotify_fd ), inode->wd );
477 list_remove( &inode->wd_entry );
479 list_remove( &inode->ino_entry );
485 static struct inode *inode_add( struct inode *parent,
486 dev_t dev, ino_t ino, const char *name )
490 inode = get_inode( dev, ino );
496 list_add_tail( &parent->children, &inode->ch_entry );
497 inode->parent = parent;
498 assert( inode != parent );
500 inode_set_name( inode, name );
505 static struct inode *inode_from_name( struct inode *inode, const char *name )
509 LIST_FOR_EACH_ENTRY( i, &inode->children, struct inode, ch_entry )
510 if (i->name && !strcmp( i->name, name ))
515 static int inotify_get_poll_events( struct fd *fd );
516 static void inotify_poll_event( struct fd *fd, int event );
518 static const struct fd_ops inotify_fd_ops =
520 inotify_get_poll_events, /* get_poll_events */
521 inotify_poll_event, /* poll_event */
523 NULL, /* get_fd_type */
525 NULL, /* queue_async */
526 NULL, /* reselect_async */
527 NULL, /* cancel_async */
530 static int inotify_get_poll_events( struct fd *fd )
535 static void inotify_do_change_notify( struct dir *dir, unsigned int action,
536 const char *relpath )
538 struct change_record *record;
540 assert( dir->obj.ops == &dir_ops );
544 size_t len = strlen(relpath);
545 record = malloc( offsetof(struct change_record, name[len]) );
549 record->action = action;
550 memcpy( record->name, relpath, len );
553 list_add_tail( &dir->change_records, &record->entry );
556 fd_async_wake_up( dir->fd, ASYNC_TYPE_WAIT, STATUS_ALERTED );
559 static unsigned int filter_from_event( struct inotify_event *ie )
561 unsigned int filter = 0;
563 if (ie->mask & (IN_MOVED_FROM | IN_MOVED_TO | IN_DELETE | IN_CREATE))
564 filter |= FILE_NOTIFY_CHANGE_FILE_NAME | FILE_NOTIFY_CHANGE_DIR_NAME;
565 if (ie->mask & IN_MODIFY)
566 filter |= FILE_NOTIFY_CHANGE_SIZE | FILE_NOTIFY_CHANGE_LAST_WRITE;
567 if (ie->mask & IN_ATTRIB)
568 filter |= FILE_NOTIFY_CHANGE_ATTRIBUTES | FILE_NOTIFY_CHANGE_SECURITY;
569 if (ie->mask & IN_ACCESS)
570 filter |= FILE_NOTIFY_CHANGE_LAST_ACCESS;
571 if (ie->mask & IN_CREATE)
572 filter |= FILE_NOTIFY_CHANGE_CREATION;
577 /* scan up the parent directories for watches */
578 static unsigned int filter_from_inode( struct inode *inode, int is_parent )
580 unsigned int filter = 0;
583 /* combine filters from parents watching subtrees */
586 LIST_FOR_EACH_ENTRY( dir, &inode->dirs, struct dir, in_entry )
587 if (dir->subtree || !is_parent)
588 filter |= dir->filter;
590 inode = inode->parent;
596 static char *inode_get_path( struct inode *inode, int sz )
605 head = list_head( &inode->dirs );
608 int unix_fd = get_unix_fd( LIST_ENTRY( head, struct dir, in_entry )->fd );
609 path = malloc ( 32 + sz );
611 sprintf( path, "/proc/self/fd/%u/", unix_fd );
618 len = strlen( inode->name );
619 path = inode_get_path( inode->parent, sz + len + 1 );
623 strcat( path, inode->name );
629 static int inode_check_dir( struct inode *parent, const char *name )
637 path = inode_get_path( parent, strlen(name) );
641 strcat( path, name );
643 r = stat( path, &st );
646 if (!S_ISDIR(st.st_mode))
654 filter = filter_from_inode( parent, 1 );
658 inode = inode_add( parent, st.st_dev, st.st_ino, name );
659 if (!inode || inode->wd != -1)
662 wd = inotify_add_dir( path, filter );
664 inode_set_wd( inode, wd );
673 static int prepend( char **path, const char *segment )
678 extra = strlen( segment ) + 1;
681 int len = strlen( *path ) + 1;
682 p = realloc( *path, len + extra );
684 memmove( &p[ extra ], p, len );
685 p[ extra - 1 ] = '/';
686 memcpy( p, segment, extra - 1 );
692 memcpy( p, segment, extra );
700 static void inotify_notify_all( struct inotify_event *ie )
702 unsigned int filter, action;
703 struct inode *inode, *i;
707 inode = inode_from_wd( ie->wd );
710 fprintf( stderr, "no inode matches %d\n", ie->wd);
714 filter = filter_from_event( ie );
716 if (ie->mask & IN_CREATE)
718 switch (inode_check_dir( inode, ie->name ))
721 filter &= ~FILE_NOTIFY_CHANGE_FILE_NAME;
724 filter &= ~FILE_NOTIFY_CHANGE_DIR_NAME;
728 /* Maybe the file disappeared before we could check it? */
730 action = FILE_ACTION_ADDED;
732 else if (ie->mask & IN_DELETE)
733 action = FILE_ACTION_REMOVED;
735 action = FILE_ACTION_MODIFIED;
738 * Work our way up the inode hierarchy
739 * extending the relative path as we go
740 * and notifying all recursive watches.
742 if (!prepend( &path, ie->name ))
745 for (i = inode; i; i = i->parent)
747 LIST_FOR_EACH_ENTRY( dir, &i->dirs, struct dir, in_entry )
748 if ((filter & dir->filter) && (i==inode || dir->subtree))
749 inotify_do_change_notify( dir, action, path );
751 if (!i->name || !prepend( &path, i->name ))
757 if (ie->mask & IN_DELETE)
759 i = inode_from_name( inode, ie->name );
765 static void inotify_poll_event( struct fd *fd, int event )
769 struct inotify_event *ie;
771 unix_fd = get_unix_fd( fd );
772 r = read( unix_fd, buffer, sizeof buffer );
775 fprintf(stderr,"inotify_poll_event(): inotify read failed!\n");
779 for( ofs = 0; ofs < r - offsetof(struct inotify_event, name); )
781 ie = (struct inotify_event*) &buffer[ofs];
784 ofs += offsetof( struct inotify_event, name[ie->len] );
786 inotify_notify_all( ie );
790 static inline struct fd *create_inotify_fd( void )
794 unix_fd = inotify_init();
797 return create_anonymous_fd( &inotify_fd_ops, unix_fd, NULL, 0 );
800 static int map_flags( unsigned int filter )
804 /* always watch these so we can track subdirectories in recursive watches */
805 mask = (IN_MOVED_FROM | IN_MOVED_TO | IN_DELETE | IN_CREATE | IN_DELETE_SELF);
807 if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
809 if (filter & FILE_NOTIFY_CHANGE_SIZE)
811 if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
813 if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
815 if (filter & FILE_NOTIFY_CHANGE_SECURITY)
821 static int inotify_add_dir( char *path, unsigned int filter )
823 int wd = inotify_add_watch( get_unix_fd( inotify_fd ),
824 path, map_flags( filter ) );
826 set_fd_events( inotify_fd, POLLIN );
830 static int init_inotify( void )
837 inotify_fd = create_inotify_fd();
841 for (i=0; i<HASH_SIZE; i++)
843 list_init( &inode_hash[i] );
844 list_init( &wd_hash[i] );
850 static int inotify_adjust_changes( struct dir *dir )
861 unix_fd = get_unix_fd( dir->fd );
866 /* check if this fd is already being watched */
867 if (-1 == fstat( unix_fd, &st ))
870 inode = get_inode( st.st_dev, st.st_ino );
872 inode = create_inode( st.st_dev, st.st_ino );
875 list_add_tail( &inode->dirs, &dir->in_entry );
879 filter = filter_from_inode( inode, 0 );
881 sprintf( path, "/proc/self/fd/%u", unix_fd );
882 wd = inotify_add_dir( path, filter );
883 if (wd == -1) return 0;
885 inode_set_wd( inode, wd );
890 static char *get_basename( const char *link )
892 char *buffer, *name = NULL;
897 buffer = malloc( n );
898 if (!buffer) return NULL;
900 r = readlink( link, buffer, n );
915 while (r > 0 && name[ r - 1 ] == '/' )
919 name = strrchr( name, '/' );
921 name = strdup( &name[1] );
928 static int dir_add_to_existing_notify( struct dir *dir )
930 struct inode *inode, *parent;
931 unsigned int filter = 0;
932 struct stat st, st_new;
933 char link[35], *name;
939 unix_fd = get_unix_fd( dir->fd );
941 /* check if it's in the list of inodes we want to watch */
942 if (-1 == fstat( unix_fd, &st_new ))
944 inode = find_inode( st_new.st_dev, st_new.st_ino );
948 /* lookup the parent */
949 sprintf( link, "/proc/self/fd/%u/..", unix_fd );
950 if (-1 == stat( link, &st ))
954 * If there's no parent, stop. We could keep going adding
955 * ../ to the path until we hit the root of the tree or
956 * find a recursively watched ancestor.
957 * Assume it's too expensive to search up the tree for now.
959 parent = find_inode( st.st_dev, st.st_ino );
963 if (parent->wd == -1)
966 filter = filter_from_inode( parent, 1 );
970 sprintf( link, "/proc/self/fd/%u", unix_fd );
971 name = get_basename( link );
974 inode = inode_add( parent, st_new.st_dev, st_new.st_ino, name );
979 /* Couldn't find this inode at the start of the function, must be new */
980 assert( inode->wd == -1 );
982 wd = inotify_add_dir( link, filter );
984 inode_set_wd( inode, wd );
991 static int init_inotify( void )
996 static int inotify_adjust_changes( struct dir *dir )
1001 static void free_inode( struct inode *inode )
1006 static int dir_add_to_existing_notify( struct dir *dir )
1011 #endif /* USE_INOTIFY */
1013 struct object *create_dir_obj( struct fd *fd )
1017 dir = alloc_object( &dir_ops );
1021 list_init( &dir->change_records );
1028 set_fd_user( fd, &dir_fd_ops, &dir->obj );
1030 dir_add_to_existing_notify( dir );
1035 /* enable change notifications for a directory */
1036 DECL_HANDLER(read_directory_changes)
1039 struct async *async;
1043 set_error(STATUS_INVALID_PARAMETER);
1047 dir = get_dir_obj( current->process, req->handle, 0 );
1051 /* requests don't timeout */
1052 if (!(async = fd_queue_async( dir->fd, &req->async, ASYNC_TYPE_WAIT, 0 ))) goto end;
1054 /* assign it once */
1058 insert_change( dir );
1059 dir->filter = req->filter;
1060 dir->subtree = req->subtree;
1061 dir->want_data = req->want_data;
1064 /* if there's already a change in the queue, send it */
1065 if (!list_empty( &dir->change_records ))
1066 fd_async_wake_up( dir->fd, ASYNC_TYPE_WAIT, STATUS_ALERTED );
1068 /* setup the real notification */
1069 if (!inotify_adjust_changes( dir ))
1070 dnotify_adjust_changes( dir );
1072 release_object( async );
1073 set_error(STATUS_PENDING);
1076 release_object( dir );
1079 DECL_HANDLER(read_change)
1081 struct change_record *record;
1084 dir = get_dir_obj( current->process, req->handle, 0 );
1088 if ((record = get_first_change_record( dir )) != NULL)
1090 reply->action = record->action;
1091 set_reply_data( record->name, record->len );
1095 set_error( STATUS_NO_DATA_DETECTED );
1097 release_object( dir );