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