2 Unix SMB/CIFS implementation.
3 kernel oplock processing for Linux
4 Copyright (C) Andrew Tridgell 2000
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.
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.
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/>.
20 #define DBGC_CLASS DBGC_LOCKING
22 #include "smbd/globals.h"
24 #if HAVE_KERNEL_OPLOCKS_LINUX
27 #define F_SETLEASE 1024
31 #define F_GETLEASE 1025
38 #ifndef RT_SIGNAL_LEASE
39 #define RT_SIGNAL_LEASE (SIGRTMIN+1)
46 /****************************************************************************
47 Handle a LEASE signal, incrementing the signals_received and blocking the signal.
48 ****************************************************************************/
50 static void signal_handler(int sig, siginfo_t *info, void *unused)
52 if (oplock_signals_received < FD_PENDING_SIZE - 1) {
53 fd_pending_array[oplock_signals_received] = (SIG_ATOMIC_T)info->si_fd;
54 oplock_signals_received++;
55 } /* Else signal is lost. */
56 sys_select_signal(RT_SIGNAL_LEASE);
60 * public function to get linux lease capability. Needed by some VFS modules (eg. gpfs.c)
62 void linux_set_lease_capability(void)
64 set_effective_capability(LEASE_CAPABILITY);
68 * Call to set the kernel lease signal handler
70 int linux_set_lease_sighandler(int fd)
72 if (fcntl(fd, F_SETSIG, RT_SIGNAL_LEASE) == -1) {
73 DEBUG(3,("Failed to set signal handler for kernel lease\n"));
80 /****************************************************************************
81 Call SETLEASE. If we get EACCES then we try setting up the right capability and
83 Use the SMB_VFS_LINUX_SETLEASE instead of this call directly.
84 ****************************************************************************/
86 int linux_setlease(int fd, int leasetype)
90 ret = fcntl(fd, F_SETLEASE, leasetype);
91 if (ret == -1 && errno == EACCES) {
92 set_effective_capability(LEASE_CAPABILITY);
93 ret = fcntl(fd, F_SETLEASE, leasetype);
99 /****************************************************************************
100 * Deal with the Linux kernel <--> smbd
101 * oplock break protocol.
102 ****************************************************************************/
104 static files_struct *linux_oplock_receive_message(fd_set *fds)
109 BlockSignals(True, RT_SIGNAL_LEASE);
110 fd = fd_pending_array[0];
111 fsp = file_find_fd(fd);
112 fd_pending_array[0] = (SIG_ATOMIC_T)-1;
113 if (oplock_signals_received > 1)
114 memmove(CONST_DISCARD(void *, &fd_pending_array[0]),
115 CONST_DISCARD(void *, &fd_pending_array[1]),
116 sizeof(SIG_ATOMIC_T)*(oplock_signals_received-1));
117 oplock_signals_received--;
118 /* now we can receive more signals */
119 BlockSignals(False, RT_SIGNAL_LEASE);
124 /****************************************************************************
125 Attempt to set an kernel oplock on a file.
126 ****************************************************************************/
128 static bool linux_set_kernel_oplock(files_struct *fsp, int oplock_type)
130 if ( SMB_VFS_LINUX_SETLEASE(fsp, F_WRLCK) == -1) {
131 DEBUG(3,("linux_set_kernel_oplock: Refused oplock on file %s, "
132 "fd = %d, file_id = %s. (%s)\n",
133 fsp->fsp_name, fsp->fh->fd,
134 file_id_string_tos(&fsp->file_id),
139 DEBUG(3,("linux_set_kernel_oplock: got kernel oplock on file %s, "
140 "file_id = %s gen_id = %lu\n",
141 fsp->fsp_name, file_id_string_tos(&fsp->file_id),
147 /****************************************************************************
148 Release a kernel oplock on a file.
149 ****************************************************************************/
151 static void linux_release_kernel_oplock(files_struct *fsp)
155 * Check and print out the current kernel
156 * oplock state of this file.
158 int state = fcntl(fsp->fh->fd, F_GETLEASE, 0);
159 dbgtext("linux_release_kernel_oplock: file %s, file_id = %s "
160 "gen_id = %lu has kernel oplock state "
161 "of %x.\n", fsp->fsp_name, file_id_string_tos(&fsp->file_id),
162 fsp->fh->gen_id, state );
166 * Remove the kernel oplock on this file.
168 if ( SMB_VFS_LINUX_SETLEASE(fsp, F_UNLCK) == -1) {
170 dbgtext("linux_release_kernel_oplock: Error when "
171 "removing kernel oplock on file " );
172 dbgtext("%s, file_id = %s, gen_id = %lu. "
173 "Error was %s\n", fsp->fsp_name,
174 file_id_string_tos(&fsp->file_id),
175 fsp->fh->gen_id, strerror(errno) );
180 /****************************************************************************
181 See if a oplock message is waiting.
182 ****************************************************************************/
184 static bool linux_oplock_msg_waiting(fd_set *fds)
186 return oplock_signals_received != 0;
189 /****************************************************************************
190 See if the kernel supports oplocks.
191 ****************************************************************************/
193 static bool linux_oplocks_available(void)
196 fd = open("/dev/null", O_RDONLY);
198 return False; /* uggh! */
199 ret = fcntl(fd, F_GETLEASE, 0);
201 return ret == F_UNLCK;
204 /****************************************************************************
205 Setup kernel oplocks.
206 ****************************************************************************/
208 struct kernel_oplocks *linux_init_kernel_oplocks(void)
210 struct sigaction act;
212 if (!linux_oplocks_available()) {
213 DEBUG(3,("Linux kernel oplocks not available\n"));
219 act.sa_handler = NULL;
220 act.sa_sigaction = signal_handler;
221 act.sa_flags = SA_SIGINFO;
222 sigemptyset( &act.sa_mask );
223 if (sigaction(RT_SIGNAL_LEASE, &act, NULL) != 0) {
224 DEBUG(0,("Failed to setup RT_SIGNAL_LEASE handler\n"));
228 linux_koplocks.receive_message = linux_oplock_receive_message;
229 linux_koplocks.set_oplock = linux_set_kernel_oplock;
230 linux_koplocks.release_oplock = linux_release_kernel_oplock;
231 linux_koplocks.msg_waiting = linux_oplock_msg_waiting;
232 linux_koplocks.notification_fd = -1;
234 /* the signal can start off blocked due to a bug in bash */
235 BlockSignals(False, RT_SIGNAL_LEASE);
237 DEBUG(3,("Linux kernel oplocks enabled\n"));
239 return &linux_koplocks;
242 void oplock_linux_dummy(void);
244 void oplock_linux_dummy(void) {}
245 #endif /* HAVE_KERNEL_OPLOCKS_LINUX */