#define DBGC_CLASS DBGC_LOCKING
#include "includes.h"
static int32 exclusive_oplocks_open = 0;
static int32 level_II_oplocks_open = 0;
BOOL global_client_failed_oplock_break = False;
extern uint32 global_client_caps;
extern int smb_read_error;
static struct kernel_oplocks *koplocks;
int32 get_number_of_exclusive_open_oplocks(void)
{
return exclusive_oplocks_open;
}
BOOL oplock_message_waiting(fd_set *fds)
{
if (koplocks && koplocks->msg_waiting(fds)) {
return True;
}
return False;
}
void process_kernel_oplocks(fd_set *pfds)
{
if (!koplocks) {
return;
}
while (koplocks->msg_waiting(pfds)) {
files_struct *fsp;
char msg[MSG_SMB_KERNEL_BREAK_SIZE];
fsp = koplocks->receive_message(pfds);
if (fsp == NULL) {
DEBUG(3, ("Kernel oplock message announced, but none "
"received\n"));
return;
}
SDEV_T_VAL(msg,0,fsp->dev);
SINO_T_VAL(msg,8,fsp->inode);
SIVAL(msg,16,fsp->fh->file_id);
message_send_pid(pid_to_procid(sys_getpid()),
MSG_SMB_KERNEL_BREAK,
&msg, MSG_SMB_KERNEL_BREAK_SIZE, True);
}
}
BOOL set_file_oplock(files_struct *fsp, int oplock_type)
{
if (koplocks && !koplocks->set_oplock(fsp, oplock_type)) {
return False;
}
fsp->oplock_type = oplock_type;
fsp->sent_oplock_break = NO_BREAK_SENT;
if (oplock_type == LEVEL_II_OPLOCK) {
level_II_oplocks_open++;
} else {
exclusive_oplocks_open++;
}
DEBUG(5,("set_file_oplock: granted oplock on file %s, 0x%x/%.0f/%lu, "
"tv_sec = %x, tv_usec = %x\n",
fsp->fsp_name, (unsigned int)fsp->dev, (double)fsp->inode,
fsp->fh->file_id, (int)fsp->open_time.tv_sec,
(int)fsp->open_time.tv_usec ));
return True;
}
void release_file_oplock(files_struct *fsp)
{
if ((fsp->oplock_type != NO_OPLOCK) &&
(fsp->oplock_type != FAKE_LEVEL_II_OPLOCK) &&
koplocks) {
koplocks->release_oplock(fsp);
}
if (fsp->oplock_type == LEVEL_II_OPLOCK) {
level_II_oplocks_open--;
} else if (EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type)) {
exclusive_oplocks_open--;
}
SMB_ASSERT(exclusive_oplocks_open>=0);
SMB_ASSERT(level_II_oplocks_open>=0);
fsp->oplock_type = NO_OPLOCK;
fsp->sent_oplock_break = NO_BREAK_SENT;
flush_write_cache(fsp, OPLOCK_RELEASE_FLUSH);
TALLOC_FREE(fsp->oplock_timeout);
}
static void downgrade_file_oplock(files_struct *fsp)
{
if (koplocks) {
koplocks->release_oplock(fsp);
}
fsp->oplock_type = LEVEL_II_OPLOCK;
exclusive_oplocks_open--;
level_II_oplocks_open++;
fsp->sent_oplock_break = NO_BREAK_SENT;
}
BOOL remove_oplock(files_struct *fsp)
{
SMB_DEV_T dev = fsp->dev;
SMB_INO_T inode = fsp->inode;
BOOL ret;
struct share_mode_lock *lck;
lck = get_share_mode_lock(NULL, fsp->dev, fsp->inode, NULL, NULL);
if (lck == NULL) {
DEBUG(0,("remove_oplock: failed to lock share entry for "
"file %s\n", fsp->fsp_name ));
return False;
}
ret = remove_share_oplock(lck, fsp);
if (!ret) {
DEBUG(0,("remove_oplock: failed to remove share oplock for "
"file %s fnum %d, 0x%x/%.0f\n",
fsp->fsp_name, fsp->fnum, (unsigned int)dev,
(double)inode));
}
release_file_oplock(fsp);
TALLOC_FREE(lck);
return ret;
}
BOOL downgrade_oplock(files_struct *fsp)
{
SMB_DEV_T dev = fsp->dev;
SMB_INO_T inode = fsp->inode;
BOOL ret;
struct share_mode_lock *lck;
lck = get_share_mode_lock(NULL, fsp->dev, fsp->inode, NULL, NULL);
if (lck == NULL) {
DEBUG(0,("downgrade_oplock: failed to lock share entry for "
"file %s\n", fsp->fsp_name ));
return False;
}
ret = downgrade_share_oplock(lck, fsp);
if (!ret) {
DEBUG(0,("downgrade_oplock: failed to downgrade share oplock "
"for file %s fnum %d, dev = %x, inode = %.0f\n",
fsp->fsp_name, fsp->fnum, (unsigned int)dev,
(double)inode));
}
downgrade_file_oplock(fsp);
TALLOC_FREE(lck);
return ret;
}
int oplock_notify_fd(void)
{
if (koplocks) {
return koplocks->notification_fd;
}
return -1;
}
static char *new_break_smb_message(TALLOC_CTX *mem_ctx,
files_struct *fsp, uint8 cmd)
{
char *result = TALLOC_ARRAY(mem_ctx, char, smb_size + 8*2 + 0);
if (result == NULL) {
DEBUG(0, ("talloc failed\n"));
return NULL;
}
memset(result,'\0',smb_size);
set_message(result,8,0,True);
SCVAL(result,smb_com,SMBlockingX);
SSVAL(result,smb_tid,fsp->conn->cnum);
SSVAL(result,smb_pid,0xFFFF);
SSVAL(result,smb_uid,0);
SSVAL(result,smb_mid,0xFFFF);
SCVAL(result,smb_vwv0,0xFF);
SSVAL(result,smb_vwv2,fsp->fnum);
SCVAL(result,smb_vwv3,LOCKING_ANDX_OPLOCK_RELEASE);
SCVAL(result,smb_vwv3+1,cmd);
return result;
}
static void wait_before_sending_break(void)
{
long wait_time = (long)lp_oplock_break_wait_time();
if (wait_time) {
smb_msleep(wait_time);
}
}
static files_struct *initial_break_processing(SMB_DEV_T dev, SMB_INO_T inode, unsigned long file_id)
{
files_struct *fsp = NULL;
if( DEBUGLVL( 3 ) ) {
dbgtext( "initial_break_processing: called for 0x%x/%.0f/%u\n",
(unsigned int)dev, (double)inode, (int)file_id);
dbgtext( "Current oplocks_open (exclusive = %d, levelII = %d)\n",
exclusive_oplocks_open, level_II_oplocks_open );
}
fsp = file_find_dif(dev, inode, file_id);
if(fsp == NULL) {
if( DEBUGLVL( 3 ) ) {
dbgtext( "initial_break_processing: cannot find open file with " );
dbgtext( "dev = 0x%x, inode = %.0f file_id = %lu", (unsigned int)dev,
(double)inode, file_id);
dbgtext( "allowing break to succeed.\n" );
}
return NULL;
}
if(fsp->oplock_type == NO_OPLOCK) {
if( DEBUGLVL( 3 ) ) {
dbgtext( "initial_break_processing: file %s ", fsp->fsp_name );
dbgtext( "(dev = %x, inode = %.0f, file_id = %lu) has no oplock.\n",
(unsigned int)dev, (double)inode, fsp->fh->file_id );
dbgtext( "Allowing break to succeed regardless.\n" );
}
return NULL;
}
return fsp;
}
static void oplock_timeout_handler(struct event_context *ctx,
struct timed_event *te,
const struct timeval *now,
void *private_data)
{
files_struct *fsp = (files_struct *)private_data;
TALLOC_FREE(fsp->oplock_timeout);
DEBUG(0, ("Oplock break failed for file %s -- replying anyway\n", fsp->fsp_name));
global_client_failed_oplock_break = True;
remove_oplock(fsp);
reply_to_oplock_break_requests(fsp);
}
static void add_oplock_timeout_handler(files_struct *fsp)
{
if (fsp->oplock_timeout != NULL) {
DEBUG(0, ("Logic problem -- have an oplock event hanging "
"around\n"));
}
fsp->oplock_timeout =
event_add_timed(smbd_event_context(), NULL,
timeval_current_ofs(OPLOCK_BREAK_TIMEOUT, 0),
"oplock_timeout_handler",
oplock_timeout_handler, fsp);
if (fsp->oplock_timeout == NULL) {
DEBUG(0, ("Could not add oplock timeout handler\n"));
}
}
static void process_oplock_async_level2_break_message(int msg_type, struct process_id src,
void *buf, size_t len,
void *private_data)
{
struct share_mode_entry msg;
files_struct *fsp;
char *break_msg;
BOOL sign_state;
if (buf == NULL) {
DEBUG(0, ("Got NULL buffer\n"));
return;
}
if (len != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
DEBUG(0, ("Got invalid msg len %d\n", (int)len));
return;
}
message_to_share_mode_entry(&msg, (char *)buf);
DEBUG(10, ("Got oplock async level 2 break message from pid %d: 0x%x/%.0f/%lu\n",
(int)procid_to_pid(&src), (unsigned int)msg.dev,
(double)msg.inode, msg.share_file_id));
fsp = initial_break_processing(msg.dev, msg.inode,
msg.share_file_id);
if (fsp == NULL) {
DEBUG(3, ("process_oplock_async_level2_break_message: Did not find fsp, ignoring\n"));
return;
}
if (fsp->oplock_type == NO_OPLOCK) {
DEBUG(3, ("process_oplock_async_level2_break_message: already broken to none, ignoring.\n"));
return;
}
if (fsp->oplock_type == FAKE_LEVEL_II_OPLOCK) {
DEBUG(3, ("process_oplock_async_level2_break_message: downgrading fake level 2 oplock.\n"));
remove_oplock(fsp);
return;
}
SMB_ASSERT(fsp->oplock_type == LEVEL_II_OPLOCK);
break_msg = new_break_smb_message(NULL, fsp, OPLOCKLEVEL_NONE);
if (break_msg == NULL) {
exit_server("Could not talloc break_msg\n");
}
if (procid_to_pid(&src) == sys_getpid()) {
wait_before_sending_break();
}
sign_state = srv_oplock_set_signing(False);
show_msg(break_msg);
if (!send_smb(smbd_server_fd(), break_msg)) {
exit_server_cleanly("oplock_break: send_smb failed.");
}
srv_oplock_set_signing(sign_state);
TALLOC_FREE(break_msg);
remove_oplock(fsp);
}
static void process_oplock_break_message(int msg_type, struct process_id src,
void *buf, size_t len,
void *private_data)
{
struct share_mode_entry msg;
files_struct *fsp;
char *break_msg;
BOOL break_to_level2 = False;
BOOL sign_state;
if (buf == NULL) {
DEBUG(0, ("Got NULL buffer\n"));
return;
}
if (len != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
DEBUG(0, ("Got invalid msg len %d\n", (int)len));
return;
}
message_to_share_mode_entry(&msg, (char *)buf);
DEBUG(10, ("Got oplock break message from pid %d: 0x%x/%.0f/%lu\n",
(int)procid_to_pid(&src), (unsigned int)msg.dev,
(double)msg.inode, msg.share_file_id));
fsp = initial_break_processing(msg.dev, msg.inode,
msg.share_file_id);
if (fsp == NULL) {
DEBUG(3, ("Did not find fsp\n"));
message_send_pid(src, MSG_SMB_BREAK_RESPONSE,
buf, MSG_SMB_SHARE_MODE_ENTRY_SIZE, True);
return;
}
if (fsp->sent_oplock_break != NO_BREAK_SENT) {
msg.pid = src;
ADD_TO_ARRAY(NULL, struct share_mode_entry, msg,
&fsp->pending_break_messages,
&fsp->num_pending_break_messages);
return;
}
if (EXCLUSIVE_OPLOCK_TYPE(msg.op_type) &&
!EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type)) {
DEBUG(3, ("Already downgraded oplock on 0x%x/%.0f: %s\n",
(unsigned int)fsp->dev, (double)fsp->inode,
fsp->fsp_name));
message_send_pid(src, MSG_SMB_BREAK_RESPONSE,
buf, MSG_SMB_SHARE_MODE_ENTRY_SIZE, True);
return;
}
if ((global_client_caps & CAP_LEVEL_II_OPLOCKS) &&
!(msg.op_type & FORCE_OPLOCK_BREAK_TO_NONE) &&
!koplocks &&
lp_level2_oplocks(SNUM(fsp->conn))) {
break_to_level2 = True;
}
break_msg = new_break_smb_message(NULL, fsp, break_to_level2 ?
OPLOCKLEVEL_II : OPLOCKLEVEL_NONE);
if (break_msg == NULL) {
exit_server("Could not talloc break_msg\n");
}
if (procid_to_pid(&src) == sys_getpid()) {
wait_before_sending_break();
}
sign_state = srv_oplock_set_signing(False);
show_msg(break_msg);
if (!send_smb(smbd_server_fd(), break_msg)) {
exit_server_cleanly("oplock_break: send_smb failed.");
}
srv_oplock_set_signing(sign_state);
TALLOC_FREE(break_msg);
fsp->sent_oplock_break = break_to_level2 ? LEVEL_II_BREAK_SENT:BREAK_TO_NONE_SENT;
msg.pid = src;
ADD_TO_ARRAY(NULL, struct share_mode_entry, msg,
&fsp->pending_break_messages,
&fsp->num_pending_break_messages);
add_oplock_timeout_handler(fsp);
}
static void process_kernel_oplock_break(int msg_type, struct process_id src,
void *buf, size_t len,
void *private_data)
{
SMB_DEV_T dev;
SMB_INO_T inode;
unsigned long file_id;
files_struct *fsp;
char *break_msg;
BOOL sign_state;
if (buf == NULL) {
DEBUG(0, ("Got NULL buffer\n"));
return;
}
if (len != MSG_SMB_KERNEL_BREAK_SIZE) {
DEBUG(0, ("Got invalid msg len %d\n", (int)len));
return;
}
dev = DEV_T_VAL(buf, 0);
inode = INO_T_VAL(buf, 8);
file_id = (unsigned long)IVAL(buf, 16);
DEBUG(10, ("Got kernel oplock break message from pid %d: 0x%x/%.0f/%u\n",
(int)procid_to_pid(&src), (unsigned int)dev, (double)inode,
(unsigned int)file_id));
fsp = initial_break_processing(dev, inode, file_id);
if (fsp == NULL) {
DEBUG(3, ("Got a kernel oplock break message for a file "
"I don't know about\n"));
return;
}
if (fsp->sent_oplock_break != NO_BREAK_SENT) {
DEBUG(3, ("Got a kernel oplock request while waiting for a "
"break reply\n"));
return;
}
break_msg = new_break_smb_message(NULL, fsp, OPLOCKLEVEL_NONE);
if (break_msg == NULL) {
exit_server("Could not talloc break_msg\n");
}
sign_state = srv_oplock_set_signing(False);
show_msg(break_msg);
if (!send_smb(smbd_server_fd(), break_msg)) {
exit_server_cleanly("oplock_break: send_smb failed.");
}
srv_oplock_set_signing(sign_state);
TALLOC_FREE(break_msg);
fsp->sent_oplock_break = BREAK_TO_NONE_SENT;
add_oplock_timeout_handler(fsp);
}
void reply_to_oplock_break_requests(files_struct *fsp)
{
int i;
for (i=0; i<fsp->num_pending_break_messages; i++) {
struct share_mode_entry *e = &fsp->pending_break_messages[i];
char msg[MSG_SMB_SHARE_MODE_ENTRY_SIZE];
share_mode_entry_to_message(msg, e);
message_send_pid(e->pid, MSG_SMB_BREAK_RESPONSE,
msg, MSG_SMB_SHARE_MODE_ENTRY_SIZE, True);
}
SAFE_FREE(fsp->pending_break_messages);
fsp->num_pending_break_messages = 0;
if (fsp->oplock_timeout != NULL) {
TALLOC_FREE(fsp->oplock_timeout);
fsp->oplock_timeout = NULL;
}
return;
}
static void process_oplock_break_response(int msg_type, struct process_id src,
void *buf, size_t len,
void *private_data)
{
struct share_mode_entry msg;
if (buf == NULL) {
DEBUG(0, ("Got NULL buffer\n"));
return;
}
if (len != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
DEBUG(0, ("Got invalid msg len %u\n", (unsigned int)len));
return;
}
message_to_share_mode_entry(&msg, (char *)buf);
DEBUG(10, ("Got oplock break response from pid %d: 0x%x/%.0f/%lu mid %u\n",
(int)procid_to_pid(&src), (unsigned int)msg.dev,
(double)msg.inode, msg.share_file_id,
(unsigned int)msg.op_mid));
schedule_deferred_open_smb_message(msg.op_mid);
}
static void process_open_retry_message(int msg_type, struct process_id src,
void *buf, size_t len,
void *private_data)
{
struct share_mode_entry msg;
if (buf == NULL) {
DEBUG(0, ("Got NULL buffer\n"));
return;
}
if (len != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
DEBUG(0, ("Got invalid msg len %d\n", (int)len));
return;
}
message_to_share_mode_entry(&msg, (char *)buf);
DEBUG(10, ("Got open retry msg from pid %d: 0x%x/%.0f/%lu mid %u\n",
(int)procid_to_pid(&src), (unsigned int)msg.dev,
(double)msg.inode, msg.share_file_id,
(unsigned int)msg.op_mid));
schedule_deferred_open_smb_message(msg.op_mid);
}
void release_level_2_oplocks_on_change(files_struct *fsp)
{
int i;
struct share_mode_lock *lck;
if (!LEVEL_II_OPLOCK_TYPE(fsp->oplock_type))
return;
lck = get_share_mode_lock(NULL, fsp->dev, fsp->inode, NULL, NULL);
if (lck == NULL) {
DEBUG(0,("release_level_2_oplocks_on_change: failed to lock "
"share mode entry for file %s.\n", fsp->fsp_name ));
return;
}
DEBUG(10,("release_level_2_oplocks_on_change: num_share_modes = %d\n",
lck->num_share_modes ));
for(i = 0; i < lck->num_share_modes; i++) {
struct share_mode_entry *share_entry = &lck->share_modes[i];
char msg[MSG_SMB_SHARE_MODE_ENTRY_SIZE];
if (!is_valid_share_mode_entry(share_entry)) {
continue;
}
DEBUG(10,("release_level_2_oplocks_on_change: "
"share_entry[%i]->op_type == %d\n",
i, share_entry->op_type ));
if (share_entry->op_type == NO_OPLOCK) {
continue;
}
if (EXCLUSIVE_OPLOCK_TYPE(share_entry->op_type)) {
DEBUG(0,("release_level_2_oplocks_on_change: PANIC. "
"share mode entry %d is an exlusive "
"oplock !\n", i ));
TALLOC_FREE(lck);
abort();
}
share_mode_entry_to_message(msg, share_entry);
message_send_pid(share_entry->pid, MSG_SMB_ASYNC_LEVEL2_BREAK,
msg, MSG_SMB_SHARE_MODE_ENTRY_SIZE, True);
}
TALLOC_FREE(lck);
}
void share_mode_entry_to_message(char *msg, struct share_mode_entry *e)
{
SIVAL(msg,0,(uint32)e->pid.pid);
SSVAL(msg,4,e->op_mid);
SSVAL(msg,6,e->op_type);
SIVAL(msg,8,e->access_mask);
SIVAL(msg,12,e->share_access);
SIVAL(msg,16,e->private_options);
SIVAL(msg,20,(uint32)e->time.tv_sec);
SIVAL(msg,24,(uint32)e->time.tv_usec);
SDEV_T_VAL(msg,28,e->dev);
SINO_T_VAL(msg,36,e->inode);
SIVAL(msg,44,e->share_file_id);
SIVAL(msg,48,e->uid);
SSVAL(msg,52,e->flags);
}
void message_to_share_mode_entry(struct share_mode_entry *e, char *msg)
{
e->pid.pid = (pid_t)IVAL(msg,0);
e->op_mid = SVAL(msg,4);
e->op_type = SVAL(msg,6);
e->access_mask = IVAL(msg,8);
e->share_access = IVAL(msg,12);
e->private_options = IVAL(msg,16);
e->time.tv_sec = (time_t)IVAL(msg,20);
e->time.tv_usec = (int)IVAL(msg,24);
e->dev = DEV_T_VAL(msg,28);
e->inode = INO_T_VAL(msg,36);
e->share_file_id = (unsigned long)IVAL(msg,44);
e->uid = (uint32)IVAL(msg,48);
e->flags = (uint16)SVAL(msg,52);
}
BOOL init_oplocks(void)
{
DEBUG(3,("init_oplocks: initializing messages.\n"));
message_register(MSG_SMB_BREAK_REQUEST,
process_oplock_break_message,
NULL);
message_register(MSG_SMB_ASYNC_LEVEL2_BREAK,
process_oplock_async_level2_break_message,
NULL);
message_register(MSG_SMB_BREAK_RESPONSE,
process_oplock_break_response,
NULL);
message_register(MSG_SMB_KERNEL_BREAK,
process_kernel_oplock_break,
NULL);
message_register(MSG_SMB_OPEN_RETRY,
process_open_retry_message,
NULL);
if (lp_kernel_oplocks()) {
#if HAVE_KERNEL_OPLOCKS_IRIX
koplocks = irix_init_kernel_oplocks();
#elif HAVE_KERNEL_OPLOCKS_LINUX
koplocks = linux_init_kernel_oplocks();
#endif
}
return True;
}