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 extern int DEBUGLEVEL;
  27
  28 static VOLATILE sig_atomic_t signals_received;
  29 static VOLATILE sig_atomic_t signals_processed;
  30 static VOLATILE sig_atomic_t fd_pending; /* the fd of the current pending signal */
  31
  32 #ifndef F_SETLEASE
  33 #define F_SETLEASE      1024
  34 #endif
  35
  36 #ifndef F_GETLEASE
  37 #define F_GETLEASE      1025
  38 #endif
  39
  40 #ifndef CAP_LEASE
  41 #define CAP_LEASE 28
  42 #endif
  43
  44 #ifndef RT_SIGNAL_LEASE
  45 #define RT_SIGNAL_LEASE 33
  46 #endif
  47
  48 #ifndef F_SETSIG
  49 #define F_SETSIG 10
  50 #endif
  51
  52 /****************************************************************************
  53 handle a LEASE signal, incrementing the signals_received and blocking the signal
  54 ****************************************************************************/
  55 static void signal_handler(int sig, siginfo_t *info, void *unused)
  56 {
  57         BlockSignals(True, sig);
  58         fd_pending = (sig_atomic_t)info->si_fd;
  59         signals_received++;
  60         sys_select_signal();
  61 }
  62
  63 /****************************************************************************
  64 try to gain a linux capability
  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 /****************************************************************************
 100 call SETLEASE. If we get EACCES then we try setting up the right capability and
 101 try again
 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 /****************************************************************************
 123  * Deal with the Linux kernel <--> smbd
 124  * oplock break protocol.
 125 ****************************************************************************/
 126 static BOOL linux_oplock_receive_message(fd_set *fds, char *buffer, int buffer_len)
 127 {
 128         SMB_DEV_T dev;
 129         SMB_INO_T inode;
 130         SMB_STRUCT_STAT sbuf;
 131         BOOL ret = True;
 132
 133         if (signals_received == signals_processed) return False;
 134
 135         if (sys_fstat((int)fd_pending,&sbuf) == -1) {
 136                 DEBUG(0,("Invalid file descriptor %d in kernel oplock break!\n", (int)fd_pending));
 137                 ret = False;
 138                 goto out;
 139         }
 140
 141         dev = sbuf.st_dev;
 142         inode = sbuf.st_ino;
 143
 144         DEBUG(3,("receive_local_message: kernel oplock break request received for \
 145 dev = %x, inode = %.0f\n", (unsigned int)dev, (double)inode ));
 146
 147         /*
 148          * Create a kernel oplock break message.
 149          */
 150
 151         /* Setup the message header */
 152         SIVAL(buffer,OPBRK_CMD_LEN_OFFSET,KERNEL_OPLOCK_BREAK_MSG_LEN);
 153         SSVAL(buffer,OPBRK_CMD_PORT_OFFSET,0);
 154
 155         buffer += OPBRK_CMD_HEADER_LEN;
 156
 157         SSVAL(buffer,OPBRK_MESSAGE_CMD_OFFSET,KERNEL_OPLOCK_BREAK_CMD);
 158
 159         memcpy(buffer + KERNEL_OPLOCK_BREAK_DEV_OFFSET, (char *)&dev, sizeof(dev));
 160         memcpy(buffer + KERNEL_OPLOCK_BREAK_INODE_OFFSET, (char *)&inode, sizeof(inode));
 161
 162  out:
 163         /* now we can receive more signals */
 164         fd_pending = (sig_atomic_t)-1;
 165         signals_processed++;
 166         BlockSignals(False, RT_SIGNAL_LEASE);
 167
 168         return ret;
 169 }
 170
 171
 172 /****************************************************************************
 173  Attempt to set an kernel oplock on a file.
 174 ****************************************************************************/
 175 static BOOL linux_set_kernel_oplock(files_struct *fsp, int oplock_type)
 176 {
 177         if (linux_setlease(fsp->fd, F_WRLCK) == -1) {
 178                 DEBUG(3,("set_file_oplock: Refused oplock on file %s, fd = %d, dev = %x, \
 179 inode = %.0f. (%s)\n",
 180                          fsp->fsp_name, fsp->fd,
 181                          (unsigned int)fsp->dev, (double)fsp->inode, strerror(errno)));
 182                 return False;
 183         }
 184
 185         DEBUG(3,("set_file_oplock: got kernel oplock on file %s, dev = %x, inode = %.0f\n",
 186                   fsp->fsp_name, (unsigned int)fsp->dev, (double)fsp->inode));
 187
 188         return True;
 189 }
 190
 191
 192 /****************************************************************************
 193  Release a kernel oplock on a file.
 194 ****************************************************************************/
 195 static void linux_release_kernel_oplock(files_struct *fsp)
 196 {
 197         if (DEBUGLVL(10)) {
 198                 /*
 199                  * Check and print out the current kernel
 200                  * oplock state of this file.
 201                  */
 202                 int state = fcntl(fsp->fd, F_GETLEASE, 0);
 203                 dbgtext("release_kernel_oplock: file %s, dev = %x, inode = %.0f has kernel \
 204 oplock state of %x.\n", fsp->fsp_name, (unsigned int)fsp->dev,
 205                         (double)fsp->inode, state );
 206         }
 207
 208         /*
 209          * Remove the kernel oplock on this file.
 210          */
 211         if (linux_setlease(fsp->fd, F_UNLCK) == -1) {
 212                 if (DEBUGLVL(0)) {
 213                         dbgtext("release_kernel_oplock: Error when removing kernel oplock on file " );
 214                         dbgtext("%s, dev = %x, inode = %.0f. Error was %s\n",
 215                                 fsp->fsp_name, (unsigned int)fsp->dev,
 216                                 (double)fsp->inode, strerror(errno) );
 217                 }
 218         }
 219 }
 220
 221
 222 /****************************************************************************
 223 parse a kernel oplock message
 224 ****************************************************************************/
 225 static BOOL linux_kernel_oplock_parse(char *msg_start, int msg_len, SMB_INO_T *inode, SMB_DEV_T *dev)
 226 {
 227         /* Ensure that the msg length is correct. */
 228         if (msg_len != KERNEL_OPLOCK_BREAK_MSG_LEN) {
 229                 DEBUG(0,("incorrect length for KERNEL_OPLOCK_BREAK_CMD (was %d, should be %d).\n",
 230                          msg_len, KERNEL_OPLOCK_BREAK_MSG_LEN));
 231                 return False;
 232         }
 233
 234         memcpy((char *)inode, msg_start+KERNEL_OPLOCK_BREAK_INODE_OFFSET, sizeof(*inode));
 235         memcpy((char *)dev, msg_start+KERNEL_OPLOCK_BREAK_DEV_OFFSET, sizeof(*dev));
 236
 237         DEBUG(3,("kernel oplock break request for file dev = %x, inode = %.0f\n",
 238                  (unsigned int)*dev, (double)*inode));
 239
 240         return True;
 241 }
 242
 243
 244 /****************************************************************************
 245 see if a oplock message is waiting
 246 ****************************************************************************/
 247 static BOOL linux_oplock_msg_waiting(fd_set *fds)
 248 {
 249         return signals_processed != signals_received;
 250 }
 251
 252 /****************************************************************************
 253 see if the kernel supports oplocks
 254 ****************************************************************************/
 255 static BOOL linux_oplocks_available(void)
 256 {
 257         int fd, ret;
 258         fd = open("/dev/null", O_RDONLY);
 259         if (fd == -1) return False; /* uggh! */
 260         ret = fcntl(fd, F_GETLEASE, 0);
 261         close(fd);
 262         return ret == F_UNLCK;
 263 }
 264
 265
 266 /****************************************************************************
 267 setup kernel oplocks
 268 ****************************************************************************/
 269 struct kernel_oplocks *linux_init_kernel_oplocks(void)
 270 {
 271         static struct kernel_oplocks koplocks;
 272         struct sigaction act;
 273
 274         if (!linux_oplocks_available()) {
 275                 DEBUG(3,("Linux kernel oplocks not available\n"));
 276                 return NULL;
 277         }
 278
 279         act.sa_handler = NULL;
 280         act.sa_sigaction = signal_handler;
 281         act.sa_flags = SA_SIGINFO;
 282         if (sigaction(RT_SIGNAL_LEASE, &act, NULL) != 0) {
 283                 DEBUG(0,("Failed to setup RT_SIGNAL_LEASE handler\n"));
 284                 return NULL;
 285         }
 286
 287         koplocks.receive_message = linux_oplock_receive_message;
 288         koplocks.set_oplock = linux_set_kernel_oplock;
 289         koplocks.release_oplock = linux_release_kernel_oplock;
 290         koplocks.parse_message = linux_kernel_oplock_parse;
 291         koplocks.msg_waiting = linux_oplock_msg_waiting;
 292         koplocks.notification_fd = -1;
 293
 294         DEBUG(3,("Linux kernel oplocks enabled\n"));
 295
 296         return &koplocks;
 297 }
 298
 299
 300
 301 #else
 302  void oplock_linux_dummy(void) {}
 303 #endif /* HAVE_KERNEL_OPLOCKS_LINUX */