smbd: Simplify brl_locktest

[Samba.git] / source3 / locking / locking.c

/* 
   Unix SMB/CIFS implementation.
   Locking functions
   Copyright (C) Andrew Tridgell 1992-2000
   Copyright (C) Jeremy Allison 1992-2006
   Copyright (C) Volker Lendecke 2005

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Revision History:

   12 aug 96: Erik.Devriendt@te6.siemens.be
   added support for shared memory implementation of share mode locking

   May 1997. Jeremy Allison (jallison@whistle.com). Modified share mode
   locking to deal with multiple share modes per open file.

   September 1997. Jeremy Allison (jallison@whistle.com). Added oplock
   support.

   rewritten completely to use new tdb code. Tridge, Dec '99

   Added POSIX locking support. Jeremy Allison (jeremy@valinux.com), Apr. 2000.
   Added Unix Extensions POSIX locking support. Jeremy Allison Mar 2006.
*/

#include "includes.h"
#include "system/filesys.h"
#include "locking/proto.h"
#include "smbd/globals.h"
#include "dbwrap/dbwrap.h"
#include "dbwrap/dbwrap_open.h"
#include "../libcli/security/security.h"
#include "serverid.h"
#include "messages.h"
#include "util_tdb.h"
#include "../librpc/gen_ndr/ndr_open_files.h"

#undef DBGC_CLASS
#define DBGC_CLASS DBGC_LOCKING

#define NO_LOCKING_COUNT (-1)

/****************************************************************************
 Debugging aids :-).
****************************************************************************/

const char *lock_type_name(enum brl_type lock_type)
{
        switch (lock_type) {
                case READ_LOCK:
                        return "READ";
                case WRITE_LOCK:
                        return "WRITE";
                case PENDING_READ_LOCK:
                        return "PENDING_READ";
                case PENDING_WRITE_LOCK:
                        return "PENDING_WRITE";
                default:
                        return "other";
        }
}

const char *lock_flav_name(enum brl_flavour lock_flav)
{
        return (lock_flav == WINDOWS_LOCK) ? "WINDOWS_LOCK" : "POSIX_LOCK";
}

/****************************************************************************
 Utility function called to see if a file region is locked.
 Called in the read/write codepath.
****************************************************************************/

void init_strict_lock_struct(files_struct *fsp,
                                uint64_t smblctx,
                                br_off start,
                                br_off size,
                                enum brl_type lock_type,
                                struct lock_struct *plock)
{
        SMB_ASSERT(lock_type == READ_LOCK || lock_type == WRITE_LOCK);

        plock->context.smblctx = smblctx;
        plock->context.tid = fsp->conn->cnum;
        plock->context.pid = messaging_server_id(fsp->conn->sconn->msg_ctx);
        plock->start = start;
        plock->size = size;
        plock->fnum = fsp->fnum;
        plock->lock_type = lock_type;
        plock->lock_flav = lp_posix_cifsu_locktype(fsp);
}

bool strict_lock_default(files_struct *fsp, struct lock_struct *plock)
{
        struct byte_range_lock *br_lck;
        int strict_locking = lp_strict_locking(fsp->conn->params);
        bool ret = False;

        if (plock->size == 0) {
                return True;
        }

        if (!lp_locking(fsp->conn->params) || !strict_locking) {
                return True;
        }

        if (strict_locking == Auto) {
                if  (EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type) &&
                     (plock->lock_type == READ_LOCK ||
                      plock->lock_type == WRITE_LOCK)) {
                        DEBUG(10, ("is_locked: optimisation - exclusive oplock "
                                   "on file %s\n", fsp_str_dbg(fsp)));
                        return true;
                }
                if ((fsp->oplock_type == LEVEL_II_OPLOCK) &&
                    (plock->lock_type == READ_LOCK)) {
                        DEBUG(10, ("is_locked: optimisation - level II oplock "
                                   "on file %s\n", fsp_str_dbg(fsp)));
                        return true;
                }
        }

        br_lck = brl_get_locks_readonly(fsp);
        if (!br_lck) {
                return true;
        }
        ret = brl_locktest(br_lck, plock);

        DEBUG(10, ("strict_lock_default: flavour = %s brl start=%ju "
                   "len=%ju %s for fnum %ju file %s\n",
                   lock_flav_name(plock->lock_flav),
                   (uintmax_t)plock->start, (uintmax_t)plock->size,
                   ret ? "unlocked" : "locked",
                   (uintmax_t)plock->fnum, fsp_str_dbg(fsp)));

        return ret;
}

void strict_unlock_default(files_struct *fsp, struct lock_struct *plock)
{
}

/****************************************************************************
 Find out if a lock could be granted - return who is blocking us if we can't.
****************************************************************************/

NTSTATUS query_lock(files_struct *fsp,
                        uint64_t *psmblctx,
                        uint64_t *pcount,
                        uint64_t *poffset,
                        enum brl_type *plock_type,
                        enum brl_flavour lock_flav)
{
        struct byte_range_lock *br_lck = NULL;

        if (!fsp->can_lock) {
                return fsp->is_directory ? NT_STATUS_INVALID_DEVICE_REQUEST : NT_STATUS_INVALID_HANDLE;
        }

        if (!lp_locking(fsp->conn->params)) {
                return NT_STATUS_OK;
        }

        br_lck = brl_get_locks_readonly(fsp);
        if (!br_lck) {
                return NT_STATUS_NO_MEMORY;
        }

        return brl_lockquery(br_lck,
                        psmblctx,
                        messaging_server_id(fsp->conn->sconn->msg_ctx),
                        poffset,
                        pcount,
                        plock_type,
                        lock_flav);
}

static void increment_current_lock_count(files_struct *fsp,
    enum brl_flavour lock_flav)
{
        if (lock_flav == WINDOWS_LOCK &&
            fsp->current_lock_count != NO_LOCKING_COUNT) {
                /* blocking ie. pending, locks also count here,
                 * as this is an efficiency counter to avoid checking
                 * the lock db. on close. JRA. */

                fsp->current_lock_count++;
        } else {
                /* Notice that this has had a POSIX lock request.
                 * We can't count locks after this so forget them.
                 */
                fsp->current_lock_count = NO_LOCKING_COUNT;
        }
}

static void decrement_current_lock_count(files_struct *fsp,
    enum brl_flavour lock_flav)
{
        if (lock_flav == WINDOWS_LOCK &&
            fsp->current_lock_count != NO_LOCKING_COUNT) {
                SMB_ASSERT(fsp->current_lock_count > 0);
                fsp->current_lock_count--;
        }
}

/****************************************************************************
 Utility function called by locking requests.
****************************************************************************/

struct byte_range_lock *do_lock(struct messaging_context *msg_ctx,
                        files_struct *fsp,
                        uint64_t smblctx,
                        uint64_t count,
                        uint64_t offset,
                        enum brl_type lock_type,
                        enum brl_flavour lock_flav,
                        bool blocking_lock,
                        NTSTATUS *perr,
                        uint64_t *psmblctx)
{
        struct byte_range_lock *br_lck = NULL;

        /* silently return ok on print files as we don't do locking there */
        if (fsp->print_file) {
                *perr = NT_STATUS_OK;
                return NULL;
        }

        if (!fsp->can_lock) {
                *perr = fsp->is_directory ? NT_STATUS_INVALID_DEVICE_REQUEST : NT_STATUS_INVALID_HANDLE;
                return NULL;
        }

        if (!lp_locking(fsp->conn->params)) {
                *perr = NT_STATUS_OK;
                return NULL;
        }

        /* NOTE! 0 byte long ranges ARE allowed and should be stored  */

        DEBUG(10,("do_lock: lock flavour %s lock type %s start=%ju len=%ju "
                "blocking_lock=%s requested for %s file %s\n",
                lock_flav_name(lock_flav), lock_type_name(lock_type),
                (uintmax_t)offset, (uintmax_t)count, blocking_lock ? "true" :
                "false", fsp_fnum_dbg(fsp), fsp_str_dbg(fsp)));

        br_lck = brl_get_locks(talloc_tos(), fsp);
        if (!br_lck) {
                *perr = NT_STATUS_NO_MEMORY;
                return NULL;
        }

        *perr = brl_lock(msg_ctx,
                        br_lck,
                        smblctx,
                        messaging_server_id(fsp->conn->sconn->msg_ctx),
                        offset,
                        count,
                        lock_type,
                        lock_flav,
                        blocking_lock,
                        psmblctx);

        DEBUG(10, ("do_lock: returning status=%s\n", nt_errstr(*perr)));

        increment_current_lock_count(fsp, lock_flav);
        return br_lck;
}

/****************************************************************************
 Utility function called by unlocking requests.
****************************************************************************/

NTSTATUS do_unlock(struct messaging_context *msg_ctx,
                        files_struct *fsp,
                        uint64_t smblctx,
                        uint64_t count,
                        uint64_t offset,
                        enum brl_flavour lock_flav)
{
        bool ok = False;
        struct byte_range_lock *br_lck = NULL;

        if (!fsp->can_lock) {
                return fsp->is_directory ? NT_STATUS_INVALID_DEVICE_REQUEST : NT_STATUS_INVALID_HANDLE;
        }

        if (!lp_locking(fsp->conn->params)) {
                return NT_STATUS_OK;
        }

        DEBUG(10, ("do_unlock: unlock start=%ju len=%ju requested for %s file "
                   "%s\n", (uintmax_t)offset, (uintmax_t)count,
                   fsp_fnum_dbg(fsp), fsp_str_dbg(fsp)));

        br_lck = brl_get_locks(talloc_tos(), fsp);
        if (!br_lck) {
                return NT_STATUS_NO_MEMORY;
        }

        ok = brl_unlock(msg_ctx,
                        br_lck,
                        smblctx,
                        messaging_server_id(fsp->conn->sconn->msg_ctx),
                        offset,
                        count,
                        lock_flav);

        TALLOC_FREE(br_lck);

        if (!ok) {
                DEBUG(10,("do_unlock: returning ERRlock.\n" ));
                return NT_STATUS_RANGE_NOT_LOCKED;
        }

        decrement_current_lock_count(fsp, lock_flav);
        return NT_STATUS_OK;
}

/****************************************************************************
 Cancel any pending blocked locks.
****************************************************************************/

NTSTATUS do_lock_cancel(files_struct *fsp,
                        uint64 smblctx,
                        uint64_t count,
                        uint64_t offset,
                        enum brl_flavour lock_flav)
{
        bool ok = False;
        struct byte_range_lock *br_lck = NULL;

        if (!fsp->can_lock) {
                return fsp->is_directory ?
                        NT_STATUS_INVALID_DEVICE_REQUEST : NT_STATUS_INVALID_HANDLE;
        }

        if (!lp_locking(fsp->conn->params)) {
                return NT_STATUS_DOS(ERRDOS, ERRcancelviolation);
        }

        DEBUG(10, ("do_lock_cancel: cancel start=%ju len=%ju requested for "
                   "%s file %s\n", (uintmax_t)offset, (uintmax_t)count,
                   fsp_fnum_dbg(fsp), fsp_str_dbg(fsp)));

        br_lck = brl_get_locks(talloc_tos(), fsp);
        if (!br_lck) {
                return NT_STATUS_NO_MEMORY;
        }

        ok = brl_lock_cancel(br_lck,
                        smblctx,
                        messaging_server_id(fsp->conn->sconn->msg_ctx),
                        offset,
                        count,
                        lock_flav);

        TALLOC_FREE(br_lck);

        if (!ok) {
                DEBUG(10,("do_lock_cancel: returning ERRcancelviolation.\n" ));
                return NT_STATUS_DOS(ERRDOS, ERRcancelviolation);
        }

        decrement_current_lock_count(fsp, lock_flav);
        return NT_STATUS_OK;
}

/****************************************************************************
 Remove any locks on this fd. Called from file_close().
****************************************************************************/

void locking_close_file(struct messaging_context *msg_ctx,
                        files_struct *fsp,
                        enum file_close_type close_type)
{
        struct byte_range_lock *br_lck;

        if (!lp_locking(fsp->conn->params)) {
                return;
        }

        /* If we have no outstanding locks or pending
         * locks then we don't need to look in the lock db.
         */

        if (fsp->current_lock_count == 0) {
                return;
        }

        br_lck = brl_get_locks(talloc_tos(),fsp);

        if (br_lck) {
                cancel_pending_lock_requests_by_fid(fsp, br_lck, close_type);
                brl_close_fnum(msg_ctx, br_lck);
                TALLOC_FREE(br_lck);
        }
}

/*******************************************************************
 Print out a share mode.
********************************************************************/

char *share_mode_str(TALLOC_CTX *ctx, int num, const struct share_mode_entry *e)
{
        return talloc_asprintf(ctx, "share_mode_entry[%d]: "
                 "pid = %s, share_access = 0x%x, private_options = 0x%x, "
                 "access_mask = 0x%x, mid = 0x%llx, type= 0x%x, gen_id = %llu, "
                 "uid = %u, flags = %u, file_id %s, name_hash = 0x%x",
                 num,
                 procid_str_static(&e->pid),
                 e->share_access, e->private_options,
                 e->access_mask, (unsigned long long)e->op_mid,
                 e->op_type, (unsigned long long)e->share_file_id,
                 (unsigned int)e->uid, (unsigned int)e->flags,
                 file_id_string_tos(&e->id),
                 (unsigned int)e->name_hash);
}

/*******************************************************************
 Fetch a share mode where we know one MUST exist. This call reference
 counts it internally to allow for nested lock fetches.
********************************************************************/

struct share_mode_lock *get_existing_share_mode_lock(TALLOC_CTX *mem_ctx,
                                                     const struct file_id id)
{
        return get_share_mode_lock(mem_ctx, id, NULL, NULL, NULL);
}

/*******************************************************************
 Sets the service name and filename for rename.
 At this point we emit "file renamed" messages to all
 process id's that have this file open.
 Based on an initial code idea from SATOH Fumiyasu <fumiya@samba.gr.jp>
********************************************************************/

bool rename_share_filename(struct messaging_context *msg_ctx,
                        struct share_mode_lock *lck,
                        struct file_id id,
                        const char *servicepath,
                        uint32_t orig_name_hash,
                        uint32_t new_name_hash,
                        const struct smb_filename *smb_fname_dst)
{
        struct share_mode_data *d = lck->data;
        size_t sp_len;
        size_t bn_len;
        size_t sn_len;
        size_t msg_len;
        char *frm = NULL;
        int i;
        bool strip_two_chars = false;
        bool has_stream = smb_fname_dst->stream_name != NULL;
        struct server_id self_pid = messaging_server_id(msg_ctx);

        DEBUG(10, ("rename_share_filename: servicepath %s newname %s\n",
                   servicepath, smb_fname_dst->base_name));

        /*
         * rename_internal_fsp() and rename_internals() add './' to
         * head of newname if newname does not contain a '/'.
         */
        if (smb_fname_dst->base_name[0] &&
            smb_fname_dst->base_name[1] &&
            smb_fname_dst->base_name[0] == '.' &&
            smb_fname_dst->base_name[1] == '/') {
                strip_two_chars = true;
        }

        d->servicepath = talloc_strdup(d, servicepath);
        d->base_name = talloc_strdup(d, smb_fname_dst->base_name +
                                       (strip_two_chars ? 2 : 0));
        d->stream_name = talloc_strdup(d, smb_fname_dst->stream_name);
        if (d->base_name == NULL ||
            (has_stream && d->stream_name == NULL) ||
            d->servicepath == NULL) {
                DEBUG(0, ("rename_share_filename: talloc failed\n"));
                return False;
        }
        d->modified = True;

        sp_len = strlen(d->servicepath);
        bn_len = strlen(d->base_name);
        sn_len = has_stream ? strlen(d->stream_name) : 0;

        msg_len = MSG_FILE_RENAMED_MIN_SIZE + sp_len + 1 + bn_len + 1 +
            sn_len + 1;

        /* Set up the name changed message. */
        frm = talloc_array(d, char, msg_len);
        if (!frm) {
                return False;
        }

        push_file_id_24(frm, &id);

        DEBUG(10,("rename_share_filename: msg_len = %u\n", (unsigned int)msg_len ));

        strlcpy(&frm[24],
                d->servicepath ? d->servicepath : "",
                sp_len+1);
        strlcpy(&frm[24 + sp_len + 1],
                d->base_name ? d->base_name : "",
                bn_len+1);
        strlcpy(&frm[24 + sp_len + 1 + bn_len + 1],
                d->stream_name ? d->stream_name : "",
                sn_len+1);

        /* Send the messages. */
        for (i=0; i<d->num_share_modes; i++) {
                struct share_mode_entry *se = &d->share_modes[i];
                if (!is_valid_share_mode_entry(se)) {
                        continue;
                }

                /* If this is a hardlink to the inode
                   with a different name, skip this. */
                if (se->name_hash != orig_name_hash) {
                        continue;
                }

                se->name_hash = new_name_hash;

                /* But not to ourselves... */
                if (serverid_equal(&se->pid, &self_pid)) {
                        continue;
                }

                if (share_mode_stale_pid(d, i)) {
                        continue;
                }

                DEBUG(10,("rename_share_filename: sending rename message to "
                          "pid %s file_id %s sharepath %s base_name %s "
                          "stream_name %s\n",
                          procid_str_static(&se->pid),
                          file_id_string_tos(&id),
                          d->servicepath, d->base_name,
                        has_stream ? d->stream_name : ""));

                messaging_send_buf(msg_ctx, se->pid, MSG_SMB_FILE_RENAME,
                                   (uint8 *)frm, msg_len);
        }

        return True;
}

void get_file_infos(struct file_id id,
                    uint32_t name_hash,
                    bool *delete_on_close,
                    struct timespec *write_time)
{
        struct share_mode_lock *lck;

        if (delete_on_close) {
                *delete_on_close = false;
        }

        if (write_time) {
                ZERO_STRUCTP(write_time);
        }

        if (!(lck = fetch_share_mode_unlocked(talloc_tos(), id))) {
                return;
        }

        if (delete_on_close) {
                *delete_on_close = is_delete_on_close_set(lck, name_hash);
        }

        if (write_time) {
                *write_time = get_share_mode_write_time(lck);
        }

        TALLOC_FREE(lck);
}

bool is_valid_share_mode_entry(const struct share_mode_entry *e)
{
        int num_props = 0;

        if (e->stale) {
                return false;
        }

        num_props += ((e->op_type == NO_OPLOCK) ? 1 : 0);
        num_props += (EXCLUSIVE_OPLOCK_TYPE(e->op_type) ? 1 : 0);
        num_props += (LEVEL_II_OPLOCK_TYPE(e->op_type) ? 1 : 0);

        if ((num_props > 1) && serverid_exists(&e->pid)) {
                smb_panic("Invalid share mode entry");
        }
        return (num_props != 0);
}

/*
 * In case d->share_modes[i] conflicts with something or otherwise is
 * being used, we need to make sure the corresponding process still
 * exists.
 */
bool share_mode_stale_pid(struct share_mode_data *d, uint32_t idx)
{
        struct share_mode_entry *e;

        if (idx > d->num_share_modes) {
                DEBUG(1, ("Asking for index %u, only %u around\n",
                          idx, (unsigned)d->num_share_modes));
                return false;
        }
        e = &d->share_modes[idx];
        if (e->stale) {
                /*
                 * Checked before
                 */
                return true;
        }
        if (serverid_exists(&e->pid)) {
                DEBUG(10, ("PID %s (index %u out of %u) still exists\n",
                           procid_str_static(&e->pid), idx,
                           (unsigned)d->num_share_modes));
                return false;
        }
        DEBUG(10, ("PID %s (index %u out of %u) does not exist anymore\n",
                   procid_str_static(&e->pid), idx,
                   (unsigned)d->num_share_modes));

        e->stale = true;

        if (d->num_delete_tokens != 0) {
                uint32_t i, num_stale;

                /*
                 * We cannot have any delete tokens
                 * if there are no valid share modes.
                 */

                num_stale = 0;

                for (i=0; i<d->num_share_modes; i++) {
                        if (d->share_modes[i].stale) {
                                num_stale += 1;
                        }
                }

                if (num_stale == d->num_share_modes) {
                        /*
                         * No non-stale share mode found
                         */
                        TALLOC_FREE(d->delete_tokens);
                        d->num_delete_tokens = 0;
                }
        }

        d->modified = true;
        return true;
}

void remove_stale_share_mode_entries(struct share_mode_data *d)
{
        uint32_t i;

        i = 0;
        while (i < d->num_share_modes) {
                if (d->share_modes[i].stale) {
                        struct share_mode_entry *m = d->share_modes;
                        m[i] = m[d->num_share_modes-1];
                        d->num_share_modes -= 1;
                } else {
                        i += 1;
                }
        }
}

bool set_share_mode(struct share_mode_lock *lck, files_struct *fsp,
                    uid_t uid, uint64_t mid, uint16 op_type)
{
        struct share_mode_data *d = lck->data;
        struct share_mode_entry *tmp, *e;

        tmp = talloc_realloc(d, d->share_modes, struct share_mode_entry,
                             d->num_share_modes+1);
        if (tmp == NULL) {
                return false;
        }
        d->share_modes = tmp;
        e = &d->share_modes[d->num_share_modes];
        d->num_share_modes += 1;
        d->modified = true;

        ZERO_STRUCTP(e);
        e->pid = messaging_server_id(fsp->conn->sconn->msg_ctx);
        e->share_access = fsp->share_access;
        e->private_options = fsp->fh->private_options;
        e->access_mask = fsp->access_mask;
        e->op_mid = mid;
        e->op_type = op_type;
        e->time.tv_sec = fsp->open_time.tv_sec;
        e->time.tv_usec = fsp->open_time.tv_usec;
        e->id = fsp->file_id;
        e->share_file_id = fsp->fh->gen_id;
        e->uid = (uint32)uid;
        e->flags = fsp->posix_open ? SHARE_MODE_FLAG_POSIX_OPEN : 0;
        e->name_hash = fsp->name_hash;

        return true;
}

static struct share_mode_entry *find_share_mode_entry(
        struct share_mode_lock *lck, files_struct *fsp)
{
        struct share_mode_data *d = lck->data;
        struct server_id pid;
        int i;

        pid = messaging_server_id(fsp->conn->sconn->msg_ctx);

        for (i=0; i<d->num_share_modes; i++) {
                struct share_mode_entry *e = &d->share_modes[i];

                if (!is_valid_share_mode_entry(e)) {
                        continue;
                }
                if (!serverid_equal(&pid, &e->pid)) {
                        continue;
                }
                if (!file_id_equal(&fsp->file_id, &e->id)) {
                        continue;
                }
                if (fsp->fh->gen_id != e->share_file_id) {
                        continue;
                }
                return e;
        }
        return NULL;
}

/*******************************************************************
 Del the share mode of a file for this process. Return the number of
 entries left.
********************************************************************/

bool del_share_mode(struct share_mode_lock *lck, files_struct *fsp)
{
        struct share_mode_entry *e;

        e = find_share_mode_entry(lck, fsp);
        if (e == NULL) {
                return False;
        }
        *e = lck->data->share_modes[lck->data->num_share_modes-1];
        lck->data->num_share_modes -= 1;
        lck->data->modified = True;
        return True;
}

bool mark_share_mode_disconnected(struct share_mode_lock *lck,
                                  struct files_struct *fsp)
{
        struct share_mode_entry *e;

        if (lck->data->num_share_modes != 1) {
                return false;
        }

        if (fsp->op == NULL) {
                return false;
        }
        if (!fsp->op->global->durable) {
                return false;
        }

        e = find_share_mode_entry(lck, fsp);
        if (e == NULL) {
                return false;
        }

        DEBUG(10, ("Marking share mode entry disconnected for durable handle\n"));

        server_id_set_disconnected(&e->pid);

        /*
         * On reopen the caller needs to check that
         * the client comes with the correct handle.
         */
        e->share_file_id = fsp->op->global->open_persistent_id;

        lck->data->modified = true;
        return true;
}

/*******************************************************************
 Remove an oplock mid and mode entry from a share mode.
********************************************************************/

bool remove_share_oplock(struct share_mode_lock *lck, files_struct *fsp)
{
        struct share_mode_entry *e;

        e = find_share_mode_entry(lck, fsp);
        if (e == NULL) {
                return False;
        }

        e->op_type = NO_OPLOCK;
        lck->data->modified = True;
        return True;
}

/*******************************************************************
 Downgrade a oplock type from exclusive to level II.
********************************************************************/

bool downgrade_share_oplock(struct share_mode_lock *lck, files_struct *fsp)
{
        struct share_mode_entry *e;

        e = find_share_mode_entry(lck, fsp);
        if (e == NULL) {
                return False;
        }

        e->op_type = LEVEL_II_OPLOCK;
        lck->data->modified = True;
        return True;
}

/****************************************************************************
 Adds a delete on close token.
****************************************************************************/

static bool add_delete_on_close_token(struct share_mode_data *d,
                        uint32_t name_hash,
                        const struct security_token *nt_tok,
                        const struct security_unix_token *tok)
{
        struct delete_token *tmp, *dtl;

        tmp = talloc_realloc(d, d->delete_tokens, struct delete_token,
                             d->num_delete_tokens+1);
        if (tmp == NULL) {
                return false;
        }
        d->delete_tokens = tmp;
        dtl = &d->delete_tokens[d->num_delete_tokens];

        dtl->name_hash = name_hash;
        dtl->delete_nt_token = dup_nt_token(d->delete_tokens, nt_tok);
        if (dtl->delete_nt_token == NULL) {
                return false;
        }
        dtl->delete_token = copy_unix_token(d->delete_tokens, tok);
        if (dtl->delete_token == NULL) {
                return false;
        }
        d->num_delete_tokens += 1;
        d->modified = true;
        return true;
}

/****************************************************************************
 Sets the delete on close flag over all share modes on this file.
 Modify the share mode entry for all files open
 on this device and inode to tell other smbds we have
 changed the delete on close flag. This will be noticed
 in the close code, the last closer will delete the file
 if flag is set.
 This makes a copy of any struct security_unix_token into the
 lck entry. This function is used when the lock is already granted.
****************************************************************************/

void set_delete_on_close_lck(files_struct *fsp,
                        struct share_mode_lock *lck,
                        bool delete_on_close,
                        const struct security_token *nt_tok,
                        const struct security_unix_token *tok)
{
        struct share_mode_data *d = lck->data;
        int i;
        bool ret;

        if (delete_on_close) {
                SMB_ASSERT(nt_tok != NULL);
                SMB_ASSERT(tok != NULL);
        } else {
                SMB_ASSERT(nt_tok == NULL);
                SMB_ASSERT(tok == NULL);
        }

        for (i=0; i<d->num_delete_tokens; i++) {
                struct delete_token *dt = &d->delete_tokens[i];
                if (dt->name_hash == fsp->name_hash) {
                        d->modified = true;
                        if (delete_on_close == false) {
                                /* Delete this entry. */
                                TALLOC_FREE(dt->delete_nt_token);
                                TALLOC_FREE(dt->delete_token);
                                *dt = d->delete_tokens[
                                        d->num_delete_tokens-1];
                                d->num_delete_tokens -= 1;
                        } else {
                                /* Replace this token with the
                                   given tok. */
                                TALLOC_FREE(dt->delete_nt_token);
                                dt->delete_nt_token = dup_nt_token(dt, nt_tok);
                                SMB_ASSERT(dt->delete_nt_token != NULL);
                                TALLOC_FREE(dt->delete_token);
                                dt->delete_token = copy_unix_token(dt, tok);
                                SMB_ASSERT(dt->delete_token != NULL);
                        }
                        return;
                }
        }

        if (!delete_on_close) {
                /* Nothing to delete - not found. */
                return;
        }

        ret = add_delete_on_close_token(lck->data, fsp->name_hash, nt_tok, tok);
        SMB_ASSERT(ret);
}

bool set_delete_on_close(files_struct *fsp, bool delete_on_close,
                        const struct security_token *nt_tok,
                        const struct security_unix_token *tok)
{
        struct share_mode_lock *lck;

        DEBUG(10,("set_delete_on_close: %s delete on close flag for "
                  "%s, file %s\n",
                  delete_on_close ? "Adding" : "Removing", fsp_fnum_dbg(fsp),
                  fsp_str_dbg(fsp)));

        lck = get_existing_share_mode_lock(talloc_tos(), fsp->file_id);
        if (lck == NULL) {
                return False;
        }

        if (delete_on_close) {
                set_delete_on_close_lck(fsp, lck, true,
                        nt_tok,
                        tok);
        } else {
                set_delete_on_close_lck(fsp, lck, false,
                        NULL,
                        NULL);
        }

        if (fsp->is_directory) {
                SMB_ASSERT(!is_ntfs_stream_smb_fname(fsp->fsp_name));
                send_stat_cache_delete_message(fsp->conn->sconn->msg_ctx,
                                               fsp->fsp_name->base_name);
        }

        TALLOC_FREE(lck);

        fsp->delete_on_close = delete_on_close;

        return True;
}

static struct delete_token *find_delete_on_close_token(
        struct share_mode_data *d, uint32_t name_hash)
{
        uint32_t i;

        DEBUG(10, ("find_delete_on_close_token: name_hash = 0x%x\n",
                   (unsigned int)name_hash));

        for (i=0; i<d->num_delete_tokens; i++) {
                struct delete_token *dt = &d->delete_tokens[i];

                DEBUG(10, ("find__delete_on_close_token: dt->name_hash = 0x%x\n",
                           (unsigned int)dt->name_hash ));
                if (dt->name_hash == name_hash) {
                        return dt;
                }
        }
        return NULL;
}

/****************************************************************************
 Return the NT token and UNIX token if there's a match. Return true if
 found, false if not.
****************************************************************************/

bool get_delete_on_close_token(struct share_mode_lock *lck,
                                        uint32_t name_hash,
                                        const struct security_token **pp_nt_tok,
                                        const struct security_unix_token **pp_tok)
{
        struct delete_token *dt;

        dt = find_delete_on_close_token(lck->data, name_hash);
        if (dt == NULL) {
                return false;
        }
        *pp_nt_tok = dt->delete_nt_token;
        *pp_tok =  dt->delete_token;
        return true;
}

bool is_delete_on_close_set(struct share_mode_lock *lck, uint32_t name_hash)
{
        return find_delete_on_close_token(lck->data, name_hash) != NULL;
}

bool set_sticky_write_time(struct file_id fileid, struct timespec write_time)
{
        struct share_mode_lock *lck;

        DEBUG(5,("set_sticky_write_time: %s id=%s\n",
                 timestring(talloc_tos(),
                            convert_timespec_to_time_t(write_time)),
                 file_id_string_tos(&fileid)));

        lck = get_existing_share_mode_lock(talloc_tos(), fileid);
        if (lck == NULL) {
                return False;
        }

        if (timespec_compare(&lck->data->changed_write_time, &write_time) != 0) {
                lck->data->modified = True;
                lck->data->changed_write_time = write_time;
        }

        TALLOC_FREE(lck);
        return True;
}

bool set_write_time(struct file_id fileid, struct timespec write_time)
{
        struct share_mode_lock *lck;

        DEBUG(5,("set_write_time: %s id=%s\n",
                 timestring(talloc_tos(),
                            convert_timespec_to_time_t(write_time)),
                 file_id_string_tos(&fileid)));

        lck = get_existing_share_mode_lock(talloc_tos(), fileid);
        if (lck == NULL) {
                return False;
        }

        if (timespec_compare(&lck->data->old_write_time, &write_time) != 0) {
                lck->data->modified = True;
                lck->data->old_write_time = write_time;
        }

        TALLOC_FREE(lck);
        return True;
}

struct timespec get_share_mode_write_time(struct share_mode_lock *lck)
{
        struct share_mode_data *d = lck->data;

        if (!null_timespec(d->changed_write_time)) {
                return d->changed_write_time;
        }
        return d->old_write_time;
}