2 Unix SMB/CIFS implementation.
3 IRIX kernel oplock processing
4 Copyright (C) Andrew Tridgell 1992-1998
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 "system/filesys.h"
23 #include "smbd/smbd.h"
24 #include "smbd/globals.h"
26 #if HAVE_KERNEL_OPLOCKS_IRIX
28 struct irix_oplocks_context {
29 struct kernel_oplocks *ctx;
32 struct fd_event *read_fde;
36 /****************************************************************************
37 Test to see if IRIX kernel oplocks work.
38 ****************************************************************************/
40 static bool irix_oplocks_available(void)
44 TALLOC_CTX *ctx = talloc_stackframe();
47 set_effective_capability(KERNEL_OPLOCK_CAPABILITY);
49 tmpname = talloc_asprintf(ctx,
59 DEBUG(0,("check_kernel_oplocks: Unable to create pipe. Error "
66 if((fd = sys_open(tmpname, O_RDWR|O_CREAT|O_EXCL|O_TRUNC, 0600)) < 0) {
67 DEBUG(0,("check_kernel_oplocks: Unable to open temp test file "
69 tmpname, strerror(errno) ));
81 if(sys_fcntl_long(fd, F_OPLKREG, pfd[1]) == -1) {
82 DEBUG(0,("check_kernel_oplocks: Kernel oplocks are not "
83 "available on this machine. Disabling kernel oplock "
91 if(sys_fcntl_long(fd, F_OPLKACK, OP_REVOKE) < 0 ) {
92 DEBUG(0,("check_kernel_oplocks: Error when removing kernel "
93 "oplock. Error was %s. Disabling kernel oplock "
94 "support.\n", strerror(errno) ));
109 * This is bad because the file_id should always be created through the vfs
110 * layer! Unfortunately, a conn struct isn't available here.
112 static struct file_id file_id_create_dev(SMB_DEV_T dev, SMB_INO_T inode)
116 /* the ZERO_STRUCT ensures padding doesn't break using the key as a
126 /****************************************************************************
127 * Deal with the IRIX kernel <--> smbd
128 * oplock break protocol.
129 ****************************************************************************/
131 static files_struct *irix_oplock_receive_message(struct kernel_oplocks *_ctx)
133 struct irix_oplocks_context *ctx = talloc_get_type(_ctx->private_data,
134 struct irix_oplocks_context);
137 struct file_id fileid;
141 * TODO: is it correct to assume we only get one
142 * oplock break, for each byte we read from the pipe?
144 ctx->pending = false;
147 * Read one byte of zero to clear the
148 * kernel break notify message.
151 if(read(ctx->read_fd, &dummy, 1) != 1) {
152 DEBUG(0,("irix_oplock_receive_message: read of kernel "
153 "notification failed. Error was %s.\n",
159 * Do a query to get the
160 * device and inode of the file that has the break
161 * request outstanding.
164 if(sys_fcntl_ptr(ctx->read_fd, F_OPLKSTAT, &os) < 0) {
165 DEBUG(0,("irix_oplock_receive_message: fcntl of kernel "
166 "notification failed. Error was %s.\n",
168 if(errno == EAGAIN) {
170 * Duplicate kernel break message - ignore.
178 * We only have device and inode info here - we have to guess that this
179 * is the first fsp open with this dev,ino pair.
181 * NOTE: this doesn't work if any VFS modules overloads
182 * the file_id_create() hook!
185 fileid = file_id_create_dev((SMB_DEV_T)os.os_dev,
186 (SMB_INO_T)os.os_ino);
187 if ((fsp = file_find_di_first(smbd_server_conn, fileid)) == NULL) {
188 DEBUG(0,("irix_oplock_receive_message: unable to find open "
189 "file with dev = %x, inode = %.0f\n",
190 (unsigned int)os.os_dev, (double)os.os_ino ));
194 DEBUG(5,("irix_oplock_receive_message: kernel oplock break request "
195 "received for file_id %s gen_id = %ul",
196 file_id_string_tos(&fsp->file_id),
202 /****************************************************************************
203 Attempt to set an kernel oplock on a file.
204 ****************************************************************************/
206 static bool irix_set_kernel_oplock(struct kernel_oplocks *_ctx,
207 files_struct *fsp, int oplock_type)
209 struct irix_oplocks_context *ctx = talloc_get_type(_ctx->private_data,
210 struct irix_oplocks_context);
212 if (sys_fcntl_long(fsp->fh->fd, F_OPLKREG, ctx->write_fd) == -1) {
213 if(errno != EAGAIN) {
214 DEBUG(0,("irix_set_kernel_oplock: Unable to get "
215 "kernel oplock on file %s, file_id %s "
216 "gen_id = %ul. Error was %s\n",
218 file_id_string_tos(&fsp->file_id),
222 DEBUG(5,("irix_set_kernel_oplock: Refused oplock on "
223 "file %s, fd = %d, file_id = %s, "
224 "gen_id = %ul. Another process had the file "
226 fsp_str_dbg(fsp), fsp->fh->fd,
227 file_id_string_tos(&fsp->file_id),
233 DEBUG(10,("irix_set_kernel_oplock: got kernel oplock on file %s, file_id = %s "
235 fsp_str_dbg(fsp), file_id_string_tos(&fsp->file_id),
241 /****************************************************************************
242 Release a kernel oplock on a file.
243 ****************************************************************************/
245 static void irix_release_kernel_oplock(struct kernel_oplocks *_ctx,
246 files_struct *fsp, int oplock_type)
250 * Check and print out the current kernel
251 * oplock state of this file.
253 int state = sys_fcntl_long(fsp->fh->fd, F_OPLKACK, -1);
254 dbgtext("irix_release_kernel_oplock: file %s, file_id = %s"
255 "gen_id = %ul, has kernel oplock state "
256 "of %x.\n", fsp_str_dbg(fsp),
257 file_id_string_tos(&fsp->file_id),
258 fsp->fh->gen_id, state );
262 * Remove the kernel oplock on this file.
264 if(sys_fcntl_long(fsp->fh->fd, F_OPLKACK, OP_REVOKE) < 0) {
266 dbgtext("irix_release_kernel_oplock: Error when "
267 "removing kernel oplock on file " );
268 dbgtext("%s, file_id = %s gen_id = %ul. "
271 file_id_string_tos(&fsp->file_id),
278 static void irix_oplocks_read_fde_handler(struct event_context *ev,
279 struct fd_event *fde,
283 struct irix_oplocks_context *ctx = talloc_get_type(private_data,
284 struct irix_oplocks_context);
287 fsp = irix_oplock_receive_message(ctx->ctx);
288 break_kernel_oplock(fsp->conn->sconn->msg_ctx, fsp);
291 /****************************************************************************
292 Setup kernel oplocks.
293 ****************************************************************************/
295 static const struct kernel_oplocks_ops irix_koplocks = {
296 .set_oplock = irix_set_kernel_oplock,
297 .release_oplock = irix_release_kernel_oplock,
298 .contend_level2_oplocks_begin = NULL,
299 .contend_level2_oplocks_end = NULL,
302 struct kernel_oplocks *irix_init_kernel_oplocks(TALLOC_CTX *mem_ctx)
304 struct kernel_oplocks *_ctx;
305 struct irix_oplocks_context *ctx;
308 if (!irix_oplocks_available())
311 _ctx = talloc_zero(mem_ctx, struct kernel_oplocks);
316 ctx = talloc_zero(_ctx, struct irix_oplocks_context);
321 _ctx->ops = &irix_koplocks;
322 _ctx->private_data = ctx;
327 DEBUG(0,("setup_kernel_oplock_pipe: Unable to create pipe. "
328 "Error was %s\n", strerror(errno) ));
332 ctx->read_fd = pfd[0];
333 ctx->write_fd = pfd[1];
335 ctx->read_fde = event_add_fd(smbd_event_context(),
339 irix_oplocks_read_fde_handler,
344 void oplock_irix_dummy(void);
345 void oplock_irix_dummy(void) {}
346 #endif /* HAVE_KERNEL_OPLOCKS_IRIX */