r21077: A step to minimize the diff later: This pulls in unmodified files from Samba4,

not compiled yet. This way the modifications become visible later.

ntvfs/common/notify.c -> smbd/notify_internal.c
ntvfs/sysdep/inotify.c -> smbd/notify_inotify.c

Naturally I had to disable notify again :-)

Volker
(This used to be commit cdb7d582b7397faa5926bff5783da7fef4209948)

1 files changed, 326 insertions, 171 deletions

diff --git a/source3/smbd/notify_inotify.c b/source3/smbd/notify_inotify.c
index 64ea62ff74..8bb0096dcc 100644
--- a/source3/smbd/notify_inotify.c
+++ b/source3/smbd/notify_inotify.c
@@ -1,27 +1,33 @@
+/* 
+   Unix SMB/CIFS implementation.
+
+   Copyright (C) Andrew Tridgell 2006
+   
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+   
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+   
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
 /*
- * inotify change notify support
- *
- * Copyright (c) Andrew Tridgell 2006
- * Copyright (c) Volker Lendecke 2007
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
- */
+  notify implementation using inotify
+*/
 
 #include "includes.h"
-
-#ifdef HAVE_INOTIFY
+#include "system/filesys.h"
+#include "ntvfs/sysdep/sys_notify.h"
+#include "lib/events/events.h"
+#include "lib/util/dlinklist.h"
+#include "libcli/raw/smb.h"
 
 #include <linux/inotify.h>
 #include <asm/unistd.h>
@@ -46,218 +52,367 @@ static int inotify_rm_watch(int fd, int wd)
 }
 #endif
 
-struct inotify_ctx {
-	struct inotify_ctx *prev, *next;
-	int wd;
-	files_struct *fsp;
-};
 
-static struct inotify_ctx *inotify_list;
+/* older glibc headers don't have these defines either */
+#ifndef IN_ONLYDIR
+#define IN_ONLYDIR 0x01000000
+#endif
+#ifndef IN_MASK_ADD
+#define IN_MASK_ADD 0x20000000
+#endif
 
-static int inotify_watch_fd;
+struct inotify_private {
+	struct sys_notify_context *ctx;
+	int fd;
+	struct watch_context *watches;
+};
 
-/*
-  map from a change notify mask to a inotify mask. Remove any bits
-  which we can handle
-*/
-static const struct {
-	uint32_t notify_mask;
-	uint32_t inotify_mask;
-} inotify_mapping[] = {
-	{FILE_NOTIFY_CHANGE_FILE_NAME,
-	 IN_CREATE|IN_DELETE|IN_MOVED_FROM|IN_MOVED_TO},
-	{FILE_NOTIFY_CHANGE_DIR_NAME,
-	 IN_CREATE|IN_DELETE|IN_MOVED_FROM|IN_MOVED_TO},
-	{FILE_NOTIFY_CHANGE_ATTRIBUTES,
-	 IN_ATTRIB|IN_MOVED_TO|IN_MOVED_FROM|IN_MODIFY},
-	{FILE_NOTIFY_CHANGE_LAST_WRITE,  IN_ATTRIB},
-	{FILE_NOTIFY_CHANGE_LAST_ACCESS, IN_ATTRIB},
-	{FILE_NOTIFY_CHANGE_EA,          IN_ATTRIB},
-	{FILE_NOTIFY_CHANGE_SECURITY,    IN_ATTRIB}
+struct watch_context {
+	struct watch_context *next, *prev;
+	struct inotify_private *in;
+	int wd;
+	sys_notify_callback_t callback;
+	void *private_data;
+	uint32_t mask; /* the inotify mask */
+	uint32_t filter; /* the windows completion filter */
+	const char *path;
 };
 
-static uint32_t inotify_map(uint32 *filter)
-{
-	int i;
-	uint32_t out=0;
-	for (i=0;i<ARRAY_SIZE(inotify_mapping);i++) {
-		if (inotify_mapping[i].notify_mask & *filter) {
-			out |= inotify_mapping[i].inotify_mask;
-			*filter &= ~inotify_mapping[i].notify_mask;
-		}
-	}
-	return out;
-}
 
-static int inotify_ctx_destructor(struct inotify_ctx *ctx)
+/*
+  destroy the inotify private context
+*/
+static int inotify_destructor(struct inotify_private *in)
 {
-	if (inotify_rm_watch(inotify_watch_fd, ctx->wd) == -1) {
-		DEBUG(0, ("inotify_rm_watch failed: %s\n", strerror(errno)));
-	}
-	DLIST_REMOVE(inotify_list, ctx);
+	close(in->fd);
 	return 0;
 }
 
-static void *inotify_add(TALLOC_CTX *mem_ctx, 
-			 struct event_context *event_ctx,
-			 files_struct *fsp, uint32 *pfilter)
-{
-	struct inotify_ctx *ctx;
-	uint32_t inotify_mask;
-	pstring fullpath;
-	uint32 filter;
-	
-	filter = *pfilter;
-	if ((filter & (FILE_NOTIFY_CHANGE_FILE
-		       |FILE_NOTIFY_CHANGE_DIR_NAME)) == 0) {
-		/*
-		 * This first implementation only looks at create/delete
-		 */
-		return NULL;
-	}
 
-	inotify_mask = inotify_map(&filter);
-
-	if (inotify_mask == 0) {
-		DEBUG(10, ("inotify_mask == 0, nothing to do\n"));
-		return NULL;
+/*
+  see if a particular event from inotify really does match a requested
+  notify event in SMB
+*/
+static BOOL filter_match(struct watch_context *w, struct inotify_event *e)
+{
+	if ((e->mask & w->mask) == 0) {
+		/* this happens because inotify_add_watch() coalesces watches on the same
+		   path, oring their masks together */
+		return False;
 	}
 
-	pstrcpy(fullpath, fsp->fsp_name);
-	if (!canonicalize_path(fsp->conn, fullpath)) {
-		DEBUG(0, ("failed to canonicalize path '%s'\n", fullpath));
-		return NULL;
+	/* SMB separates the filters for files and directories */
+	if (e->mask & IN_ISDIR) {
+		if ((w->filter & FILE_NOTIFY_CHANGE_DIR_NAME) == 0) {
+			return False;
+		}
+	} else {
+		if ((e->mask & IN_ATTRIB) &&
+		    (w->filter & (FILE_NOTIFY_CHANGE_ATTRIBUTES|
+				  FILE_NOTIFY_CHANGE_LAST_WRITE|
+				  FILE_NOTIFY_CHANGE_LAST_ACCESS|
+				  FILE_NOTIFY_CHANGE_EA|
+				  FILE_NOTIFY_CHANGE_SECURITY))) {
+			return True;
+		}
+		if ((e->mask & IN_MODIFY) && 
+		    (w->filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)) {
+			return True;
+		}
+		if ((w->filter & FILE_NOTIFY_CHANGE_FILE_NAME) == 0) {
+			return False;
+		}
 	}
 
-	if (*fullpath != '/') {
-		DEBUG(0, ("canonicalized path '%s' into `%s`\n", fsp->fsp_name,
-			  fullpath));
-		DEBUGADD(0, ("but expected an absolute path\n"));
-		return NULL;
-	}
+	return True;
+}
 	
-	if (!(ctx = TALLOC_P(mem_ctx, struct inotify_ctx))) {
-		DEBUG(0, ("talloc failed\n"));
-		return NULL;
-	}
-
-	ctx->fsp = fsp;
-	ctx->wd = inotify_add_watch(inotify_watch_fd, fullpath, inotify_mask);
 
-	if (ctx->wd == -1) {
-		DEBUG(5, ("inotify_add_watch failed: %s\n", strerror(errno)));
-		TALLOC_FREE(ctx);
-		return NULL;
-	}
-
-	DLIST_ADD(inotify_list, ctx);
-	talloc_set_destructor(ctx, inotify_ctx_destructor);
 
-	*pfilter = filter;
-	return ctx;
-}
-
-static void inotify_dispatch(struct inotify_event *e)
+/*
+  dispatch one inotify event
+  
+  the cookies are used to correctly handle renames
+*/
+static void inotify_dispatch(struct inotify_private *in, 
+			     struct inotify_event *e, 
+			     uint32_t prev_cookie,
+			     struct inotify_event *e2)
 {
-	struct inotify_ctx *ctx;
+	struct watch_context *w, *next;
+	struct notify_event ne;
+
+	/* ignore extraneous events, such as unmount and IN_IGNORED events */
+	if ((e->mask & (IN_ATTRIB|IN_MODIFY|IN_CREATE|IN_DELETE|
+			IN_MOVED_FROM|IN_MOVED_TO)) == 0) {
+		return;
+	}
 
-	for (ctx = inotify_list; ctx; ctx = ctx->next) {
-		if (ctx->wd == e->wd) {
-			break;
+	/* map the inotify mask to a action. This gets complicated for
+	   renames */
+	if (e->mask & IN_CREATE) {
+		ne.action = NOTIFY_ACTION_ADDED;
+	} else if (e->mask & IN_DELETE) {
+		ne.action = NOTIFY_ACTION_REMOVED;
+	} else if (e->mask & IN_MOVED_FROM) {
+		if (e2 != NULL && e2->cookie == e->cookie) {
+			ne.action = NOTIFY_ACTION_OLD_NAME;
+		} else {
+			ne.action = NOTIFY_ACTION_REMOVED;
+		}
+	} else if (e->mask & IN_MOVED_TO) {
+		if (e->cookie == prev_cookie) {
+			ne.action = NOTIFY_ACTION_NEW_NAME;
+		} else {
+			ne.action = NOTIFY_ACTION_ADDED;
 		}
+	} else {
+		ne.action = NOTIFY_ACTION_MODIFIED;
 	}
+	ne.path = e->name;
 
-	if (ctx == NULL) {
-		/* not found */
-		return;
+	/* find any watches that have this watch descriptor */
+	for (w=in->watches;w;w=next) {
+		next = w->next;
+		if (w->wd == e->wd && filter_match(w, e)) {
+			w->callback(in->ctx, w->private_data, &ne);
+		}
 	}
 
-	if (e->mask & IN_CREATE) {
-		notify_fsp(ctx->fsp, NOTIFY_ACTION_ADDED, e->name);
+	/* SMB expects a file rename to generate three events, two for
+	   the rename and the other for a modify of the
+	   destination. Strange! */
+	if (ne.action != NOTIFY_ACTION_NEW_NAME ||
+	    (e->mask & IN_ISDIR) != 0) {
+		return;
 	}
 
-	if (e->mask & IN_DELETE) {
-		notify_fsp(ctx->fsp, NOTIFY_ACTION_REMOVED, e->name);
+	ne.action = NOTIFY_ACTION_MODIFIED;
+	e->mask = IN_ATTRIB;
+	
+	for (w=in->watches;w;w=next) {
+		next = w->next;
+		if (w->wd == e->wd && filter_match(w, e) &&
+		    !(w->filter & FILE_NOTIFY_CHANGE_CREATION)) {
+			w->callback(in->ctx, w->private_data, &ne);
+		}
 	}
 }
 
-static void inotify_callback(struct event_context *event_ctx,
-			     struct fd_event *event,
-			     uint16 flags,
-			     void *private_data)
+/*
+  called when the kernel has some events for us
+*/
+static void inotify_handler(struct event_context *ev, struct fd_event *fde,
+			    uint16_t flags, void *private_data)
 {
-	char *buf, *p;
-	int bufsize;
+	struct inotify_private *in = talloc_get_type(private_data,
+						     struct inotify_private);
+	int bufsize = 0;
+	struct inotify_event *e0, *e;
+	uint32_t prev_cookie=0;
 
 	/*
 	  we must use FIONREAD as we cannot predict the length of the
 	  filenames, and thus can't know how much to allocate
 	  otherwise
 	*/
-	if ((ioctl(inotify_watch_fd, FIONREAD, &bufsize) != 0)
-	    || (bufsize == 0)) {
+	if (ioctl(in->fd, FIONREAD, &bufsize) != 0 || 
+	    bufsize == 0) {
 		DEBUG(0,("No data on inotify fd?!\n"));
 		return;
 	}
 
-	if (!(buf = SMB_MALLOC_ARRAY(char, bufsize))) {
-		DEBUG(0, ("malloc failed\n"));
-		return;
-	}
+	e0 = e = talloc_size(in, bufsize);
+	if (e == NULL) return;
 
-	if (read(inotify_watch_fd, buf, bufsize) != bufsize) {
+	if (read(in->fd, e0, bufsize) != bufsize) {
 		DEBUG(0,("Failed to read all inotify data\n"));
-		SAFE_FREE(buf);
+		talloc_free(e0);
 		return;
 	}
 
-	p = buf;
+	/* we can get more than one event in the buffer */
+	while (bufsize >= sizeof(*e)) {
+		struct inotify_event *e2 = NULL;
+		bufsize -= e->len + sizeof(*e);
+		if (bufsize >= sizeof(*e)) {
+			e2 = (struct inotify_event *)(e->len + sizeof(*e) + (char *)e);
+		}
+		inotify_dispatch(in, e, prev_cookie, e2);
+		prev_cookie = e->cookie;
+		e = e2;
+	}
 
-	while (bufsize > sizeof(struct inotify_event)) {
-		struct inotify_event *iev = (struct inotify_event *)p;
-		size_t len = sizeof(struct inotify_event) + iev->len;
+	talloc_free(e0);
+}
 
-		if ((len > bufsize)
-		    || ((iev->len != 0) && (iev->name[iev->len-1] != '\0'))) {
-			smb_panic("invalid inotify reply\n");
-		}
+/*
+  setup the inotify handle - called the first time a watch is added on
+  this context
+*/
+static NTSTATUS inotify_setup(struct sys_notify_context *ctx)
+{
+	struct inotify_private *in;
 
-		inotify_dispatch(iev);
+	if (!lp_parm_bool(-1, "notify", "inotify", True)) {
+		return NT_STATUS_INVALID_SYSTEM_SERVICE;
+	}
 
-		p += len;
-		bufsize -= len;
+	in = talloc(ctx, struct inotify_private);
+	NT_STATUS_HAVE_NO_MEMORY(in);
+	in->fd = inotify_init();
+	if (in->fd == -1) {
+		DEBUG(0,("Failed to init inotify - %s\n", strerror(errno)));
+		talloc_free(in);
+		return map_nt_error_from_unix(errno);
 	}
+	in->ctx = ctx;
+	in->watches = NULL;
+
+	ctx->private_data = in;
+	talloc_set_destructor(in, inotify_destructor);
 
-	SAFE_FREE(buf);
-	return;
+	/* add a event waiting for the inotify fd to be readable */
+	event_add_fd(ctx->ev, in, in->fd, EVENT_FD_READ, inotify_handler, in);
+	
+	return NT_STATUS_OK;
 }
 
-static struct cnotify_fns inotify_fns =
-{
-    inotify_add,
+
+/*
+  map from a change notify mask to a inotify mask. Remove any bits
+  which we can handle
+*/
+static const struct {
+	uint32_t notify_mask;
+	uint32_t inotify_mask;
+} inotify_mapping[] = {
+	{FILE_NOTIFY_CHANGE_FILE_NAME,   IN_CREATE|IN_DELETE|IN_MOVED_FROM|IN_MOVED_TO},
+	{FILE_NOTIFY_CHANGE_DIR_NAME,    IN_CREATE|IN_DELETE|IN_MOVED_FROM|IN_MOVED_TO},
+	{FILE_NOTIFY_CHANGE_ATTRIBUTES,  IN_ATTRIB|IN_MOVED_TO|IN_MOVED_FROM|IN_MODIFY},
+	{FILE_NOTIFY_CHANGE_LAST_WRITE,  IN_ATTRIB},
+	{FILE_NOTIFY_CHANGE_LAST_ACCESS, IN_ATTRIB},
+	{FILE_NOTIFY_CHANGE_EA,          IN_ATTRIB},
+	{FILE_NOTIFY_CHANGE_SECURITY,    IN_ATTRIB}
 };
 
-struct cnotify_fns *inotify_notify_init(struct event_context *event_ctx)
+static uint32_t inotify_map(struct notify_entry *e)
+{
+	int i;
+	uint32_t out=0;
+	for (i=0;i<ARRAY_SIZE(inotify_mapping);i++) {
+		if (inotify_mapping[i].notify_mask & e->filter) {
+			out |= inotify_mapping[i].inotify_mask;
+			e->filter &= ~inotify_mapping[i].notify_mask;
+		}
+	}
+	return out;
+}
+
+/*
+  destroy a watch
+*/
+static int watch_destructor(struct watch_context *w)
 {
-	inotify_watch_fd = inotify_init();
+	struct inotify_private *in = w->in;
+	int wd = w->wd;
+	DLIST_REMOVE(w->in->watches, w);
+
+	/* only rm the watch if its the last one with this wd */
+	for (w=in->watches;w;w=w->next) {
+		if (w->wd == wd) break;
+	}
+	if (w == NULL) {
+		inotify_rm_watch(in->fd, wd);
+	}
+	return 0;
+}
+
+
+/*
+  add a watch. The watch is removed when the caller calls
+  talloc_free() on *handle
+*/
+static NTSTATUS inotify_watch(struct sys_notify_context *ctx,
+			      struct notify_entry *e,
+			      sys_notify_callback_t callback,
+			      void *private_data, 
+			      void *handle_p)
+{
+	struct inotify_private *in;
+	int wd;
+	uint32_t mask;
+	struct watch_context *w;
+	uint32_t filter = e->filter;
+	void **handle = (void **)handle_p;
+
+	/* maybe setup the inotify fd */
+	if (ctx->private_data == NULL) {
+		NTSTATUS status;
+		status = inotify_setup(ctx);
+		NT_STATUS_NOT_OK_RETURN(status);
+	}
 
-	DEBUG(10, ("inotify_notify_init called\n"));
+	in = talloc_get_type(ctx->private_data, struct inotify_private);
 
-	if (inotify_watch_fd == -1) {
-		DEBUG(0, ("inotify_init failed: %s\n", strerror(errno)));
-		return NULL;
+	mask = inotify_map(e);
+	if (mask == 0) {
+		/* this filter can't be handled by inotify */
+		return NT_STATUS_INVALID_PARAMETER;
 	}
 
-	if (event_add_fd(event_ctx, NULL, inotify_watch_fd,
-			 EVENT_FD_READ, inotify_callback,
-			 NULL) == NULL) {
-		DEBUG(0, ("event_add_fd failed\n"));
-		close(inotify_watch_fd);
-		inotify_watch_fd = -1;
-		return NULL;
+	/* using IN_MASK_ADD allows us to cope with inotify() returning the same
+	   watch descriptor for muliple watches on the same path */
+	mask |= (IN_MASK_ADD | IN_ONLYDIR);
+
+	/* get a new watch descriptor for this path */
+	wd = inotify_add_watch(in->fd, e->path, mask);
+	if (wd == -1) {
+		e->filter = filter;
+		return map_nt_error_from_unix(errno);
 	}
 
-	return &inotify_fns;
+	w = talloc(in, struct watch_context);
+	if (w == NULL) {
+		inotify_rm_watch(in->fd, wd);
+		e->filter = filter;
+		return NT_STATUS_NO_MEMORY;
+	}
+
+	w->in = in;
+	w->wd = wd;
+	w->callback = callback;
+	w->private_data = private_data;
+	w->mask = mask;
+	w->filter = filter;
+	w->path = talloc_strdup(w, e->path);
+	if (w->path == NULL) {
+		inotify_rm_watch(in->fd, wd);
+		e->filter = filter;
+		return NT_STATUS_NO_MEMORY;
+	}
+
+	(*handle) = w;
+
+	DLIST_ADD(in->watches, w);
+
+	/* the caller frees the handle to stop watching */
+	talloc_set_destructor(w, watch_destructor);
+	
+	return NT_STATUS_OK;
 }
 
-#endif
+
+static struct sys_notify_backend inotify = {
+	.name = "inotify",
+	.notify_watch = inotify_watch
+};
+
+/*
+  initialialise the inotify module
+ */
+NTSTATUS sys_notify_inotify_init(void)
+{
+	/* register ourselves as a system inotify module */
+	return sys_notify_register(&inotify);
+}