source3/smbd/oplock_linux.c

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 3.0
   4    kernel oplock processing for Linux
   5    Copyright (C) Andrew Tridgell 2000
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #include "includes.h"
  23
  24 #if HAVE_KERNEL_OPLOCKS_LINUX
  25
  26 static VOLATILE sig_atomic_t signals_received;
  27 static VOLATILE sig_atomic_t signals_processed;
  28 static VOLATILE sig_atomic_t fd_pending; /* the fd of the current pending signal */
  29
  30 #ifndef F_SETLEASE
  31 #define F_SETLEASE      1024
  32 #endif
  33
  34 #ifndef F_GETLEASE
  35 #define F_GETLEASE      1025
  36 #endif
  37
  38 #ifndef CAP_LEASE
  39 #define CAP_LEASE 28
  40 #endif
  41
  42 #ifndef RT_SIGNAL_LEASE
  43 #define RT_SIGNAL_LEASE 33
  44 #endif
  45
  46 #ifndef F_SETSIG
  47 #define F_SETSIG 10
  48 #endif
  49
  50 /****************************************************************************
  51  Handle a LEASE signal, incrementing the signals_received and blocking the signal.
  52 ****************************************************************************/
  53
  54 static void signal_handler(int sig, siginfo_t *info, void *unused)
  55 {
  56         BlockSignals(True, sig);
  57         fd_pending = (sig_atomic_t)info->si_fd;
  58         signals_received++;
  59         sys_select_signal();
  60 }
  61
  62 /****************************************************************************
  63  Try to gain a linux capability.
  64 ****************************************************************************/
  65
  66 static void set_capability(unsigned capability)
  67 {
  68 #ifndef _LINUX_CAPABILITY_VERSION
  69 #define _LINUX_CAPABILITY_VERSION 0x19980330
  70 #endif
  71         /* these can be removed when they are in glibc headers */
  72         struct  {
  73                 uint32 version;
  74                 int pid;
  75         } header;
  76         struct {
  77                 uint32 effective;
  78                 uint32 permitted;
  79                 uint32 inheritable;
  80         } data;
  81
  82         header.version = _LINUX_CAPABILITY_VERSION;
  83         header.pid = 0;
  84
  85         if (capget(&header, &data) == -1) {
  86                 DEBUG(3,("Unable to get kernel capabilities (%s)\n", strerror(errno)));
  87                 return;
  88         }
  89
  90         data.effective |= (1<<capability);
  91
  92         if (capset(&header, &data) == -1) {
  93                 DEBUG(3,("Unable to set %d capability (%s)\n",
  94                          capability, strerror(errno)));
  95         }
  96 }
  97
  98 /****************************************************************************
  99  Call SETLEASE. If we get EACCES then we try setting up the right capability and
 100  try again
 101 ****************************************************************************/
 102
 103 static int linux_setlease(int fd, int leasetype)
 104 {
 105         int ret;
 106
 107         if (fcntl(fd, F_SETSIG, RT_SIGNAL_LEASE) == -1) {
 108                 DEBUG(3,("Failed to set signal handler for kernel lease\n"));
 109                 return -1;
 110         }
 111
 112         ret = fcntl(fd, F_SETLEASE, leasetype);
 113         if (ret == -1 && errno == EACCES) {
 114                 set_capability(CAP_LEASE);
 115                 ret = fcntl(fd, F_SETLEASE, leasetype);
 116         }
 117
 118         return ret;
 119 }
 120
 121 /****************************************************************************
 122  * Deal with the Linux kernel <--> smbd
 123  * oplock break protocol.
 124 ****************************************************************************/
 125
 126 static BOOL linux_oplock_receive_message(fd_set *fds, char *buffer, int buffer_len)
 127 {
 128         BOOL ret = True;
 129         struct files_struct *fsp;
 130
 131         if (signals_received == signals_processed)
 132                 return False;
 133
 134         if ((fsp = file_find_fd(fd_pending)) == NULL) {
 135                 DEBUG(0,("Invalid file descriptor %d in kernel oplock break!\n", (int)fd_pending));
 136                 ret = False;
 137                 goto out;
 138         }
 139
 140         DEBUG(3,("receive_local_message: kernel oplock break request received for \
 141 dev = %x, inode = %.0f\n", (unsigned int)fsp->dev, (double)fsp->inode ));
 142
 143         /*
 144          * Create a kernel oplock break message.
 145          */
 146
 147         /* Setup the message header */
 148         SIVAL(buffer,OPBRK_CMD_LEN_OFFSET,KERNEL_OPLOCK_BREAK_MSG_LEN);
 149         SSVAL(buffer,OPBRK_CMD_PORT_OFFSET,0);
 150
 151         buffer += OPBRK_CMD_HEADER_LEN;
 152
 153         SSVAL(buffer,OPBRK_MESSAGE_CMD_OFFSET,KERNEL_OPLOCK_BREAK_CMD);
 154
 155         memcpy(buffer + KERNEL_OPLOCK_BREAK_DEV_OFFSET, (char *)&fsp->dev, sizeof(fsp->dev));
 156         memcpy(buffer + KERNEL_OPLOCK_BREAK_INODE_OFFSET, (char *)&fsp->inode, sizeof(fsp->inode));
 157         memcpy(buffer + KERNEL_OPLOCK_BREAK_FILEID_OFFSET, (char *)&fsp->file_id, sizeof(fsp->file_id));
 158
 159  out:
 160         /* now we can receive more signals */
 161         fd_pending = (sig_atomic_t)-1;
 162         signals_processed++;
 163         BlockSignals(False, RT_SIGNAL_LEASE);
 164
 165         return ret;
 166 }
 167
 168 /****************************************************************************
 169  Attempt to set an kernel oplock on a file.
 170 ****************************************************************************/
 171
 172 static BOOL linux_set_kernel_oplock(files_struct *fsp, int oplock_type)
 173 {
 174         if (linux_setlease(fsp->fd, F_WRLCK) == -1) {
 175                 DEBUG(3,("set_file_oplock: Refused oplock on file %s, fd = %d, dev = %x, \
 176 inode = %.0f. (%s)\n",
 177                          fsp->fsp_name, fsp->fd,
 178                          (unsigned int)fsp->dev, (double)fsp->inode, strerror(errno)));
 179                 return False;
 180         }
 181
 182         DEBUG(3,("set_file_oplock: got kernel oplock on file %s, dev = %x, inode = %.0f, file_id = %lu\n",
 183                   fsp->fsp_name, (unsigned int)fsp->dev, (double)fsp->inode, fsp->file_id));
 184
 185         return True;
 186 }
 187
 188 /****************************************************************************
 189  Release a kernel oplock on a file.
 190 ****************************************************************************/
 191
 192 static void linux_release_kernel_oplock(files_struct *fsp)
 193 {
 194         if (DEBUGLVL(10)) {
 195                 /*
 196                  * Check and print out the current kernel
 197                  * oplock state of this file.
 198                  */
 199                 int state = fcntl(fsp->fd, F_GETLEASE, 0);
 200                 dbgtext("release_kernel_oplock: file %s, dev = %x, inode = %.0f file_id = %lu has kernel \
 201 oplock state of %x.\n", fsp->fsp_name, (unsigned int)fsp->dev,
 202                         (double)fsp->inode, fsp->file_id, state );
 203         }
 204
 205         /*
 206          * Remove the kernel oplock on this file.
 207          */
 208         if (linux_setlease(fsp->fd, F_UNLCK) == -1) {
 209                 if (DEBUGLVL(0)) {
 210                         dbgtext("release_kernel_oplock: Error when removing kernel oplock on file " );
 211                         dbgtext("%s, dev = %x, inode = %.0f, file_id = %lu. Error was %s\n",
 212                                 fsp->fsp_name, (unsigned int)fsp->dev,
 213                                 (double)fsp->inode, fsp->file_id, strerror(errno) );
 214                 }
 215         }
 216 }
 217
 218 /****************************************************************************
 219  Parse a kernel oplock message.
 220 ****************************************************************************/
 221
 222 static BOOL linux_kernel_oplock_parse(char *msg_start, int msg_len, SMB_INO_T *inode,
 223                 SMB_DEV_T *dev, unsigned long *file_id)
 224 {
 225         /* Ensure that the msg length is correct. */
 226         if (msg_len != KERNEL_OPLOCK_BREAK_MSG_LEN) {
 227                 DEBUG(0,("incorrect length for KERNEL_OPLOCK_BREAK_CMD (was %d, should be %d).\n",
 228                          msg_len, KERNEL_OPLOCK_BREAK_MSG_LEN));
 229                 return False;
 230         }
 231
 232         memcpy((char *)inode, msg_start+KERNEL_OPLOCK_BREAK_INODE_OFFSET, sizeof(*inode));
 233         memcpy((char *)dev, msg_start+KERNEL_OPLOCK_BREAK_DEV_OFFSET, sizeof(*dev));
 234         memcpy((char *)file_id, msg_start+KERNEL_OPLOCK_BREAK_FILEID_OFFSET, sizeof(*file_id));
 235
 236         DEBUG(3,("kernel oplock break request for file dev = %x, inode = %.0f, file_id = %lu\n",
 237                 (unsigned int)*dev, (double)*inode, *file_id));
 238
 239         return True;
 240 }
 241
 242 /****************************************************************************
 243  See if a oplock message is waiting.
 244 ****************************************************************************/
 245
 246 static BOOL linux_oplock_msg_waiting(fd_set *fds)
 247 {
 248         return signals_processed != signals_received;
 249 }
 250
 251 /****************************************************************************
 252  See if the kernel supports oplocks.
 253 ****************************************************************************/
 254
 255 static BOOL linux_oplocks_available(void)
 256 {
 257         int fd, ret;
 258         fd = open("/dev/null", O_RDONLY);
 259         if (fd == -1)
 260                 return False; /* uggh! */
 261         ret = fcntl(fd, F_GETLEASE, 0);
 262         close(fd);
 263         return ret == F_UNLCK;
 264 }
 265
 266 /****************************************************************************
 267  Setup kernel oplocks.
 268 ****************************************************************************/
 269
 270 struct kernel_oplocks *linux_init_kernel_oplocks(void)
 271 {
 272         static struct kernel_oplocks koplocks;
 273         struct sigaction act;
 274
 275         if (!linux_oplocks_available()) {
 276                 DEBUG(3,("Linux kernel oplocks not available\n"));
 277                 return NULL;
 278         }
 279
 280         act.sa_handler = NULL;
 281         act.sa_sigaction = signal_handler;
 282         act.sa_flags = SA_SIGINFO;
 283         if (sigaction(RT_SIGNAL_LEASE, &act, NULL) != 0) {
 284                 DEBUG(0,("Failed to setup RT_SIGNAL_LEASE handler\n"));
 285                 return NULL;
 286         }
 287
 288         koplocks.receive_message = linux_oplock_receive_message;
 289         koplocks.set_oplock = linux_set_kernel_oplock;
 290         koplocks.release_oplock = linux_release_kernel_oplock;
 291         koplocks.parse_message = linux_kernel_oplock_parse;
 292         koplocks.msg_waiting = linux_oplock_msg_waiting;
 293         koplocks.notification_fd = -1;
 294
 295         DEBUG(3,("Linux kernel oplocks enabled\n"));
 296
 297         return &koplocks;
 298 }
 299 #else
 300  void oplock_linux_dummy(void) {}
 301 #endif /* HAVE_KERNEL_OPLOCKS_LINUX */