s3:smbd/oplock: pass smbd_server_connection to linux_init_kernel_oplocks()
[kai/samba.git] / source3 / smbd / oplock_linux.c
index d8496ca9ca3caa5e116110c741732cc56632533a..f796e8c9b817be15d9dea98f20a0d29ea2b4bef1 100644 (file)
-#define OLD_NTDOMAIN 1
-#if HAVE_KERNEL_OPLOCKS_LINUX
-
 /* 
-   Unix SMB/Netbios implementation.
-   Version 3.0
+   Unix SMB/CIFS implementation.
    kernel oplock processing for Linux
    Copyright (C) Andrew Tridgell 2000
-   
+
    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
+   the Free Software Foundation; either version 3 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.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+#define DBGC_CLASS DBGC_LOCKING
 #include "includes.h"
+#include "system/filesys.h"
+#include "smbd/smbd.h"
+#include "smbd/globals.h"
+
+#if HAVE_KERNEL_OPLOCKS_LINUX
+
+#ifndef F_SETLEASE
+#define F_SETLEASE     1024
+#endif
 
-extern int DEBUGLEVEL;
+#ifndef F_GETLEASE
+#define F_GETLEASE     1025
+#endif
 
-static unsigned signals_received;
-static unsigned signals_processed;
-static int fd_pending; /* the fd of the current pending SIGIO */
+#ifndef CAP_LEASE
+#define CAP_LEASE 28
+#endif
+
+#ifndef RT_SIGNAL_LEASE
+#define RT_SIGNAL_LEASE (SIGRTMIN+1)
+#endif
+
+#ifndef F_SETSIG
+#define F_SETSIG 10
+#endif
+
+/*
+ * public function to get linux lease capability. Needed by some VFS modules (eg. gpfs.c)
+ */
+void linux_set_lease_capability(void)
+{
+       set_effective_capability(LEASE_CAPABILITY);
+}
+
+/* 
+ * Call to set the kernel lease signal handler
+ */
+int linux_set_lease_sighandler(int fd)
+{
+        if (fcntl(fd, F_SETSIG, RT_SIGNAL_LEASE) == -1) {
+                DEBUG(3,("Failed to set signal handler for kernel lease\n"));
+                return -1;
+        }
+
+       return 0;
+}
 
 /****************************************************************************
-handle a SIGIO, incrementing the signals_received and blocking SIGIO
+ Call SETLEASE. If we get EACCES then we try setting up the right capability and
+ try again.
+ Use the SMB_VFS_LINUX_SETLEASE instead of this call directly.
 ****************************************************************************/
-static void sigio_handler(int signal, siginfo_t *info, void *unused)
+
+int linux_setlease(int fd, int leasetype)
 {
-       fd_pending = info->si_fd;
-       signals_received++;
-       BlockSignals(True, SIGIO);
+       int ret;
+
+       ret = fcntl(fd, F_SETLEASE, leasetype);
+       if (ret == -1 && errno == EACCES) {
+               set_effective_capability(LEASE_CAPABILITY);
+               ret = fcntl(fd, F_SETLEASE, leasetype);
+       }
+
+       return ret;
 }
 
 /****************************************************************************
  * Deal with the Linux kernel <--> smbd
  * oplock break protocol.
 ****************************************************************************/
-static BOOL linux_oplock_receive_message(fd_set *fds, char *buffer, int buffer_len)
-{
-       SMB_DEV_T dev;
-       SMB_INO_T inode;
-       SMB_STRUCT_STAT sbuf;
-       BOOL ret;
 
-       if (signals_received == signals_processed) return False;
-
-       if (sys_fstat(fd_pending,&sbuf) == -1) {
-               DEBUG(0,("Invalid file descriptor %d in kernel oplock break!\n", fd_pending));
-               ret = False;
-               goto out;
+static void linux_oplock_signal_handler(struct tevent_context *ev_ctx,
+                                       struct tevent_signal *se,
+                                       int signum, int count,
+                                       void *_info, void *private_data)
+{
+       struct kernel_oplocks *ctx =
+               talloc_get_type_abort(private_data,
+               struct kernel_oplocks);
+       struct smbd_server_connection *sconn =
+               talloc_get_type_abort(ctx->private_data,
+               struct smbd_server_connection);
+       siginfo_t *info = (siginfo_t *)_info;
+       int fd = info->si_fd;
+       files_struct *fsp;
+
+       fsp = file_find_fd(sconn, fd);
+       if (fsp == NULL) {
+               DEBUG(0,("linux_oplock_signal_handler: failed to find fsp for file fd=%d (file was closed ?)\n", fd ));
+               return;
        }
-
-       dev = sbuf.st_dev;
-       inode = sbuf.st_ino;
-     
-       DEBUG(5,("receive_local_message: kernel oplock break request received for \
-dev = %x, inode = %.0f\n", (unsigned int)dev, (double)inode ));
-     
-       /*
-        * Create a kernel oplock break message.
-        */
-     
-       /* Setup the message header */
-       SIVAL(buffer,OPBRK_CMD_LEN_OFFSET,KERNEL_OPLOCK_BREAK_MSG_LEN);
-       SSVAL(buffer,OPBRK_CMD_PORT_OFFSET,0);
-     
-       buffer += OPBRK_CMD_HEADER_LEN;
-     
-       SSVAL(buffer,OPBRK_MESSAGE_CMD_OFFSET,KERNEL_OPLOCK_BREAK_CMD);
-     
-       memcpy(buffer + KERNEL_OPLOCK_BREAK_DEV_OFFSET, (char *)&dev, sizeof(dev));
-       memcpy(buffer + KERNEL_OPLOCK_BREAK_INODE_OFFSET, (char *)&inode, sizeof(inode));       
-
- out:
-       /* now we can receive more signals */
-       fd_pending = -1;
-       signals_processed++;
-       BlockSignals(False, SIGIO);
-     
-       return True;
+       break_kernel_oplock(sconn->msg_ctx, fsp);
 }
 
-
 /****************************************************************************
  Attempt to set an kernel oplock on a file.
 ****************************************************************************/
-static BOOL linux_set_kernel_oplock(files_struct *fsp, int oplock_type)
+
+static bool linux_set_kernel_oplock(struct kernel_oplocks *ctx,
+                                   files_struct *fsp, int oplock_type)
 {
-       if (fcntl(fsp->fd, F_SETLEASE, F_WRLCK) == -1) {
-               DEBUG(5,("set_file_oplock: Refused oplock on file %s, fd = %d, dev = %x, \
-inode = %.0f.\n",
-                        fsp->fsp_name, fsp->fd, (unsigned int)fsp->dev, (double)fsp->inode));
+       if ( SMB_VFS_LINUX_SETLEASE(fsp, F_WRLCK) == -1) {
+               DEBUG(3,("linux_set_kernel_oplock: Refused oplock on file %s, "
+                        "fd = %d, file_id = %s. (%s)\n",
+                        fsp_str_dbg(fsp), fsp->fh->fd,
+                        file_id_string_tos(&fsp->file_id),
+                        strerror(errno)));
                return False;
        }
        
-       DEBUG(10,("set_file_oplock: got kernel oplock on file %s, dev = %x, inode = %.0f\n",
-                 fsp->fsp_name, (unsigned int)fsp->dev, (double)fsp->inode));
+       DEBUG(3,("linux_set_kernel_oplock: got kernel oplock on file %s, "
+                "file_id = %s gen_id = %lu\n",
+                fsp_str_dbg(fsp), file_id_string_tos(&fsp->file_id),
+                fsp->fh->gen_id));
 
        return True;
 }
 
-
 /****************************************************************************
  Release a kernel oplock on a file.
 ****************************************************************************/
-static void linux_release_kernel_oplock(files_struct *fsp)
+
+static void linux_release_kernel_oplock(struct kernel_oplocks *ctx,
+                                       files_struct *fsp, int oplock_type)
 {
        if (DEBUGLVL(10)) {
                /*
                 * Check and print out the current kernel
                 * oplock state of this file.
                 */
-               int state = fcntl(fsp->fd, F_GETLEASE, 0);
-               dbgtext("release_kernel_oplock: file %s, dev = %x, inode = %.0f has kernel \
-oplock state of %x.\n", fsp->fsp_name, (unsigned int)fsp->dev,
-                        (double)fsp->inode, state );
+               int state = fcntl(fsp->fh->fd, F_GETLEASE, 0);
+               dbgtext("linux_release_kernel_oplock: file %s, file_id = %s "
+                       "gen_id = %lu has kernel oplock state "
+                       "of %x.\n", fsp_str_dbg(fsp),
+                       file_id_string_tos(&fsp->file_id),
+                       fsp->fh->gen_id, state );
        }
 
        /*
         * Remove the kernel oplock on this file.
         */
-       if (fcntl(fsp->fd, F_SETLEASE, F_UNLCK) == -1) {
+       if ( SMB_VFS_LINUX_SETLEASE(fsp, F_UNLCK) == -1) {
                if (DEBUGLVL(0)) {
-                       dbgtext("release_kernel_oplock: Error when removing kernel oplock on file " );
-                       dbgtext("%s, dev = %x, inode = %.0f. Error was %s\n",
-                               fsp->fsp_name, (unsigned int)fsp->dev, 
-                               (double)fsp->inode, strerror(errno) );
+                       dbgtext("linux_release_kernel_oplock: Error when "
+                               "removing kernel oplock on file " );
+                       dbgtext("%s, file_id = %s, gen_id = %lu. "
+                               "Error was %s\n", fsp_str_dbg(fsp),
+                               file_id_string_tos(&fsp->file_id),
+                               fsp->fh->gen_id, strerror(errno) );
                }
        }
 }
 
-
 /****************************************************************************
-parse a kernel oplock message
+ See if the kernel supports oplocks.
 ****************************************************************************/
-static BOOL linux_kernel_oplock_parse(char *msg_start, int msg_len, SMB_INO_T *inode, SMB_DEV_T *dev)
-{
-       /* Ensure that the msg length is correct. */
-       if (msg_len != KERNEL_OPLOCK_BREAK_MSG_LEN) {
-               DEBUG(0,("process_local_message: incorrect length for KERNEL_OPLOCK_BREAK_CMD (was %d, \
-should be %d).\n", msg_len, KERNEL_OPLOCK_BREAK_MSG_LEN));
-               return False;
-       }
-
-        memcpy((char *)inode, msg_start+KERNEL_OPLOCK_BREAK_INODE_OFFSET, sizeof(*inode));
-        memcpy((char *)dev, msg_start+KERNEL_OPLOCK_BREAK_DEV_OFFSET, sizeof(*dev));
 
-        DEBUG(5,("process_local_message: kernel oplock break request for \
-file dev = %x, inode = %.0f\n", (unsigned int)dev, (double)inode));
-
-       return True;
+static bool linux_oplocks_available(void)
+{
+       int fd, ret;
+       fd = open("/dev/null", O_RDONLY);
+       if (fd == -1)
+               return False; /* uggh! */
+       ret = fcntl(fd, F_GETLEASE, 0);
+       close(fd);
+       return ret == F_UNLCK;
 }
 
-
 /****************************************************************************
-see if a oplock message is waiting
+ Setup kernel oplocks.
 ****************************************************************************/
-static BOOL linux_oplock_msg_waiting(fd_set *fds)
-{
-       return signals_processed != signals_received;
-}
 
+static const struct kernel_oplocks_ops linux_koplocks = {
+       .set_oplock                     = linux_set_kernel_oplock,
+       .release_oplock                 = linux_release_kernel_oplock,
+       .contend_level2_oplocks_begin   = NULL,
+       .contend_level2_oplocks_end     = NULL,
+};
 
-/****************************************************************************
-setup kernel oplocks
-****************************************************************************/
-struct kernel_oplocks *linux_init_kernel_oplocks(void) 
+struct kernel_oplocks *linux_init_kernel_oplocks(struct smbd_server_connection *sconn)
 {
-       static struct kernel_oplocks koplocks;
-        struct sigaction act;
-
-        act.sa_handler = NULL;
-        act.sa_sigaction = sigio_handler;
-        act.sa_flags = SA_SIGINFO;
-        if (sigaction(SIGIO, &act, NULL) != 0) {
-               DEBUG(0,("Failed to setup SIGIO handler\n"));
+       struct kernel_oplocks *ctx;
+       struct tevent_signal *se;
+
+       if (!linux_oplocks_available()) {
+               DEBUG(3,("Linux kernel oplocks not available\n"));
                return NULL;
-        }
+       }
 
-       koplocks.receive_message = linux_oplock_receive_message;
-       koplocks.set_oplock = linux_set_kernel_oplock;
-       koplocks.release_oplock = linux_release_kernel_oplock;
-       koplocks.parse_message = linux_kernel_oplock_parse;
-       koplocks.msg_waiting = linux_oplock_msg_waiting;
-       koplocks.notification_fd = -1;
+       ctx = talloc_zero(sconn, struct kernel_oplocks);
+       if (!ctx) {
+               DEBUG(0,("Linux Kernel oplocks talloc_Zero failed\n"));
+               return NULL;
+       }
 
-       return &koplocks;
-}
+       ctx->ops = &linux_koplocks;
+       ctx->private_data = sconn;
+
+       se = tevent_add_signal(sconn->ev_ctx,
+                              ctx,
+                              RT_SIGNAL_LEASE, SA_SIGINFO,
+                              linux_oplock_signal_handler,
+                              ctx);
+       if (!se) {
+               DEBUG(0,("Failed to setup RT_SIGNAL_LEASE handler"));
+               TALLOC_FREE(ctx);
+               return NULL;
+       }
 
+       ctx->private_data = se;
 
+       DEBUG(3,("Linux kernel oplocks enabled\n"));
 
+       return ctx;
+}
 #else
+ void oplock_linux_dummy(void);
+
  void oplock_linux_dummy(void) {}
 #endif /* HAVE_KERNEL_OPLOCKS_LINUX */
-
-#undef OLD_NTDOMAIN