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