source4/ntvfs/sysdep/inotify.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Copyright (C) Andrew Tridgell 2006
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program 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
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 /*
  22   notify implementation using inotify
  23 */
  24
  25 #include "includes.h"
  26 #include "system/filesys.h"
  27 #include "ntvfs/sysdep/sys_notify.h"
  28 #include "lib/events/events.h"
  29 #include "smb.h"
  30 #include "dlinklist.h"
  31
  32 #include <linux/inotify.h>
  33 #include <asm/unistd.h>
  34
  35 #ifndef HAVE_INOTIFY_INIT
  36 /*
  37   glibc doesn't define these functions yet (as of March 2006)
  38 */
  39 static int inotify_init(void)
  40 {
  41         return syscall(__NR_inotify_init);
  42 }
  43
  44 static int inotify_add_watch(int fd, const char *path, __u32 mask)
  45 {
  46         return syscall(__NR_inotify_add_watch, fd, path, mask);
  47 }
  48
  49 static int inotify_rm_watch(int fd, int wd)
  50 {
  51         return syscall(__NR_inotify_rm_watch, fd, wd);
  52 }
  53 #endif
  54
  55
  56 /* older glibc headers don't have these defines either */
  57 #ifndef IN_ONLYDIR
  58 #define IN_ONLYDIR 0x01000000
  59 #endif
  60 #ifndef IN_MASK_ADD
  61 #define IN_MASK_ADD 0x20000000
  62 #endif
  63
  64 struct inotify_private {
  65         struct sys_notify_context *ctx;
  66         int fd;
  67         struct watch_context *watches;
  68 };
  69
  70 struct watch_context {
  71         struct watch_context *next, *prev;
  72         struct inotify_private *in;
  73         int wd;
  74         sys_notify_callback_t callback;
  75         void *private;
  76         uint32_t mask; /* the inotify mask */
  77         uint32_t filter; /* the windows completion filter */
  78         const char *path;
  79 };
  80
  81
  82 /*
  83   destroy the inotify private context
  84 */
  85 static int inotify_destructor(void *ptr)
  86 {
  87         struct inotify_private *in = talloc_get_type(ptr, struct inotify_private);
  88         close(in->fd);
  89         return 0;
  90 }
  91
  92
  93 /*
  94   see if a particular event from inotify really does match a requested
  95   notify event in SMB
  96 */
  97 static BOOL filter_match(struct watch_context *w, struct inotify_event *e)
  98 {
  99         if ((e->mask & w->mask) == 0) {
 100                 /* this happens because inotify_add_watch() coalesces watches on the same
 101                    path, oring their masks together */
 102                 return False;
 103         }
 104
 105         /* SMB separates the filters for files and directories */
 106         if (e->mask & IN_ISDIR) {
 107                 if ((w->filter & FILE_NOTIFY_CHANGE_DIR_NAME) == 0) {
 108                         return False;
 109                 }
 110         } else {
 111                 if ((e->mask & IN_ATTRIB) &&
 112                     (w->filter & (FILE_NOTIFY_CHANGE_ATTRIBUTES|
 113                                   FILE_NOTIFY_CHANGE_LAST_WRITE|
 114                                   FILE_NOTIFY_CHANGE_LAST_ACCESS|
 115                                   FILE_NOTIFY_CHANGE_EA|
 116                                   FILE_NOTIFY_CHANGE_SECURITY))) {
 117                         return True;
 118                 }
 119                 if ((e->mask & IN_MODIFY) &&
 120                     (w->filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)) {
 121                         return True;
 122                 }
 123                 if ((w->filter & FILE_NOTIFY_CHANGE_FILE_NAME) == 0) {
 124                         return False;
 125                 }
 126         }
 127
 128         return True;
 129 }
 130
 131
 132
 133 /*
 134   dispatch one inotify event
 135
 136   the cookies are used to correctly handle renames
 137 */
 138 static void inotify_dispatch(struct inotify_private *in,
 139                              struct inotify_event *e,
 140                              uint32_t prev_cookie,
 141                              struct inotify_event *e2)
 142 {
 143         struct watch_context *w, *next;
 144         struct notify_event ne;
 145
 146         /* ignore extraneous events, such as unmount and IN_IGNORED events */
 147         if ((e->mask & (IN_ATTRIB|IN_MODIFY|IN_CREATE|IN_DELETE|
 148                         IN_MOVED_FROM|IN_MOVED_TO)) == 0) {
 149                 return;
 150         }
 151
 152         /* map the inotify mask to a action. This gets complicated for
 153            renames */
 154         if (e->mask & IN_CREATE) {
 155                 ne.action = NOTIFY_ACTION_ADDED;
 156         } else if (e->mask & IN_DELETE) {
 157                 ne.action = NOTIFY_ACTION_REMOVED;
 158         } else if (e->mask & IN_MOVED_FROM) {
 159                 if (e2 != NULL && e2->cookie == e->cookie) {
 160                         ne.action = NOTIFY_ACTION_OLD_NAME;
 161                 } else {
 162                         ne.action = NOTIFY_ACTION_REMOVED;
 163                 }
 164         } else if (e->mask & IN_MOVED_TO) {
 165                 if (e->cookie == prev_cookie) {
 166                         ne.action = NOTIFY_ACTION_NEW_NAME;
 167                 } else {
 168                         ne.action = NOTIFY_ACTION_ADDED;
 169                 }
 170         } else {
 171                 ne.action = NOTIFY_ACTION_MODIFIED;
 172         }
 173         ne.path = e->name;
 174
 175         /* find any watches that have this watch descriptor */
 176         for (w=in->watches;w;w=next) {
 177                 next = w->next;
 178                 if (w->wd == e->wd && filter_match(w, e)) {
 179                         w->callback(in->ctx, w->private, &ne);
 180                 }
 181         }
 182
 183         /* SMB expects a file rename to generate three events, two for
 184            the rename and the other for a modify of the
 185            destination. Strange! */
 186         if (ne.action != NOTIFY_ACTION_NEW_NAME ||
 187             (e->mask & IN_ISDIR) != 0) {
 188                 return;
 189         }
 190
 191         ne.action = NOTIFY_ACTION_MODIFIED;
 192         e->mask = IN_ATTRIB;
 193
 194         for (w=in->watches;w;w=next) {
 195                 next = w->next;
 196                 if (w->wd == e->wd && filter_match(w, e) &&
 197                     !(w->filter & FILE_NOTIFY_CHANGE_CREATION)) {
 198                         w->callback(in->ctx, w->private, &ne);
 199                 }
 200         }
 201 }
 202
 203 /*
 204   called when the kernel has some events for us
 205 */
 206 static void inotify_handler(struct event_context *ev, struct fd_event *fde,
 207                             uint16_t flags, void *private)
 208 {
 209         struct inotify_private *in = talloc_get_type(private, struct inotify_private);
 210         int bufsize = 0;
 211         struct inotify_event *e0, *e;
 212         uint32_t prev_cookie=0;
 213
 214         /*
 215           we must use FIONREAD as we cannot predict the length of the
 216           filenames, and thus can't know how much to allocate
 217           otherwise
 218         */
 219         if (ioctl(in->fd, FIONREAD, &bufsize) != 0 ||
 220             bufsize == 0) {
 221                 DEBUG(0,("No data on inotify fd?!\n"));
 222                 return;
 223         }
 224
 225         e0 = e = talloc_size(in, bufsize);
 226         if (e == NULL) return;
 227
 228         if (read(in->fd, e0, bufsize) != bufsize) {
 229                 DEBUG(0,("Failed to read all inotify data\n"));
 230                 talloc_free(e0);
 231                 return;
 232         }
 233
 234         /* we can get more than one event in the buffer */
 235         while (bufsize >= sizeof(*e)) {
 236                 struct inotify_event *e2 = NULL;
 237                 bufsize -= e->len + sizeof(*e);
 238                 if (bufsize >= sizeof(*e)) {
 239                         e2 = (struct inotify_event *)(e->len + sizeof(*e) + (char *)e);
 240                 }
 241                 inotify_dispatch(in, e, prev_cookie, e2);
 242                 prev_cookie = e->cookie;
 243                 e = e2;
 244         }
 245
 246         talloc_free(e0);
 247 }
 248
 249 /*
 250   setup the inotify handle - called the first time a watch is added on
 251   this context
 252 */
 253 static NTSTATUS inotify_setup(struct sys_notify_context *ctx)
 254 {
 255         struct inotify_private *in;
 256
 257         in = talloc(ctx, struct inotify_private);
 258         NT_STATUS_HAVE_NO_MEMORY(in);
 259         in->fd = inotify_init();
 260         if (in->fd == -1) {
 261                 DEBUG(0,("Failed to init inotify - %s\n", strerror(errno)));
 262                 talloc_free(in);
 263                 return map_nt_error_from_unix(errno);
 264         }
 265         in->ctx = ctx;
 266         in->watches = NULL;
 267
 268         ctx->private = in;
 269         talloc_set_destructor(in, inotify_destructor);
 270
 271         /* add a event waiting for the inotify fd to be readable */
 272         event_add_fd(ctx->ev, in, in->fd, EVENT_FD_READ, inotify_handler, in);
 273
 274         return NT_STATUS_OK;
 275 }
 276
 277
 278 /*
 279   map from a change notify mask to a inotify mask. Remove any bits
 280   which we can handle
 281 */
 282 static const struct {
 283         uint32_t notify_mask;
 284         uint32_t inotify_mask;
 285 } inotify_mapping[] = {
 286         {FILE_NOTIFY_CHANGE_FILE_NAME,   IN_CREATE|IN_DELETE|IN_MOVED_FROM|IN_MOVED_TO},
 287         {FILE_NOTIFY_CHANGE_DIR_NAME,    IN_CREATE|IN_DELETE|IN_MOVED_FROM|IN_MOVED_TO},
 288         {FILE_NOTIFY_CHANGE_ATTRIBUTES,  IN_ATTRIB|IN_MOVED_TO|IN_MOVED_FROM|IN_MODIFY},
 289         {FILE_NOTIFY_CHANGE_LAST_WRITE,  IN_ATTRIB},
 290         {FILE_NOTIFY_CHANGE_LAST_ACCESS, IN_ATTRIB},
 291         {FILE_NOTIFY_CHANGE_EA,          IN_ATTRIB},
 292         {FILE_NOTIFY_CHANGE_SECURITY,    IN_ATTRIB}
 293 };
 294
 295 static uint32_t inotify_map(struct notify_entry *e)
 296 {
 297         int i;
 298         uint32_t out=0;
 299         for (i=0;i<ARRAY_SIZE(inotify_mapping);i++) {
 300                 if (inotify_mapping[i].notify_mask & e->filter) {
 301                         out |= inotify_mapping[i].inotify_mask;
 302                         e->filter &= ~inotify_mapping[i].notify_mask;
 303                 }
 304         }
 305         return out;
 306 }
 307
 308 /*
 309   destroy a watch
 310 */
 311 static int watch_destructor(void *ptr)
 312 {
 313         struct watch_context *w = talloc_get_type(ptr, struct watch_context);
 314         struct inotify_private *in = w->in;
 315         int wd = w->wd;
 316         DLIST_REMOVE(w->in->watches, w);
 317
 318         /* only rm the watch if its the last one with this wd */
 319         for (w=in->watches;w;w=w->next) {
 320                 if (w->wd == wd) break;
 321         }
 322         if (w == NULL) {
 323                 inotify_rm_watch(in->fd, wd);
 324         }
 325         return 0;
 326 }
 327
 328
 329 /*
 330   add a watch. The watch is removed when the caller calls
 331   talloc_free() on *handle
 332 */
 333 static NTSTATUS inotify_watch(struct sys_notify_context *ctx, struct notify_entry *e,
 334                               sys_notify_callback_t callback, void *private,
 335                               void **handle)
 336 {
 337         struct inotify_private *in;
 338         int wd;
 339         uint32_t mask;
 340         struct watch_context *w;
 341         uint32_t filter = e->filter;
 342
 343         /* maybe setup the inotify fd */
 344         if (ctx->private == NULL) {
 345                 NTSTATUS status;
 346                 status = inotify_setup(ctx);
 347                 NT_STATUS_NOT_OK_RETURN(status);
 348         }
 349
 350         in = talloc_get_type(ctx->private, struct inotify_private);
 351
 352         mask = inotify_map(e);
 353         if (mask == 0) {
 354                 /* this filter can't be handled by inotify */
 355                 return NT_STATUS_INVALID_PARAMETER;
 356         }
 357
 358         /* using IN_MASK_ADD allows us to cope with inotify() returning the same
 359            watch descriptor for muliple watches on the same path */
 360         mask |= (IN_MASK_ADD | IN_ONLYDIR);
 361
 362         /* get a new watch descriptor for this path */
 363         wd = inotify_add_watch(in->fd, e->path, mask);
 364         if (wd == -1) {
 365                 e->filter = filter;
 366                 return map_nt_error_from_unix(errno);
 367         }
 368
 369         w = talloc(in, struct watch_context);
 370         if (w == NULL) {
 371                 inotify_rm_watch(in->fd, wd);
 372                 e->filter = filter;
 373                 return NT_STATUS_NO_MEMORY;
 374         }
 375
 376         w->in = in;
 377         w->wd = wd;
 378         w->callback = callback;
 379         w->private = private;
 380         w->mask = mask;
 381         w->filter = filter;
 382         w->path = talloc_strdup(w, e->path);
 383         if (w->path == NULL) {
 384                 inotify_rm_watch(in->fd, wd);
 385                 e->filter = filter;
 386                 return NT_STATUS_NO_MEMORY;
 387         }
 388
 389         (*handle) = w;
 390
 391         DLIST_ADD(in->watches, w);
 392
 393         /* the caller frees the handle to stop watching */
 394         talloc_set_destructor(w, watch_destructor);
 395
 396         return NT_STATUS_OK;
 397 }
 398
 399
 400 static struct sys_notify_backend inotify = {
 401         .name = "inotify",
 402         .notify_watch = inotify_watch
 403 };
 404
 405 /*
 406   initialialise the inotify module
 407  */
 408 NTSTATUS sys_notify_inotify_init(void)
 409 {
 410         /* register ourselves as a system inotify module */
 411         return sys_notify_register(&inotify);
 412 }