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