source3/locking/share_mode_lock.h

   1 /*
   2  * This program is free software; you can redistribute it and/or modify
   3  * it under the terms of the GNU General Public License as published by
   4  * the Free Software Foundation; either version 3 of the License, or
   5  * (at your option) any later version.
   6  *
   7  * This program is distributed in the hope that it will be useful,
   8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10  * GNU General Public License for more details.
  11  *
  12  * You should have received a copy of the GNU General Public License
  13  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  14  */
  15
  16 #ifndef __LOCKING_SHARE_MODE_LOCK_H__
  17 #define __LOCKING_SHARE_MODE_LOCK_H__
  18
  19 #include "replace.h"
  20 #include <tevent.h>
  21 #include "librpc/gen_ndr/file_id.h"
  22 #include "lib/util/time.h"
  23
  24 struct share_mode_data;
  25 struct share_mode_lock;
  26 struct share_mode_entry;
  27 struct smb_filename;
  28 struct files_struct;
  29 struct smb2_lease_key;
  30
  31 bool locking_init(void);
  32 bool locking_init_readonly(void);
  33 bool locking_end(void);
  34
  35 struct share_mode_lock *get_share_mode_lock(
  36         TALLOC_CTX *mem_ctx,
  37         struct file_id id,
  38         const char *servicepath,
  39         const struct smb_filename *smb_fname,
  40         const struct timespec *old_write_time);
  41 struct share_mode_lock *get_existing_share_mode_lock(TALLOC_CTX *mem_ctx,
  42                                                      struct file_id id);
  43
  44 bool del_share_mode(struct share_mode_lock *lck,
  45                     struct files_struct *fsp);
  46 bool downgrade_share_oplock(struct share_mode_lock *lck,
  47                             struct files_struct *fsp);
  48 bool remove_share_oplock(struct share_mode_lock *lck,
  49                          struct files_struct *fsp);
  50 bool file_has_read_lease(struct files_struct *fsp);
  51
  52 bool set_share_mode(
  53         struct share_mode_lock *lck,
  54         struct files_struct *fsp,
  55         uid_t uid,
  56         uint64_t mid,
  57         uint16_t op_type,
  58         const struct smb2_lease_key *lease_key,
  59         uint32_t share_access,
  60         uint32_t access_mask);
  61 bool reset_share_mode_entry(
  62         struct share_mode_lock *lck,
  63         struct server_id old_pid,
  64         uint64_t old_share_file_id,
  65         struct server_id new_pid,
  66         uint64_t new_mid,
  67         uint64_t new_share_file_id);
  68
  69 bool mark_share_mode_disconnected(
  70         struct share_mode_lock *lck, struct files_struct *fsp);
  71
  72 struct share_mode_lock *fetch_share_mode_unlocked(
  73         TALLOC_CTX *mem_ctx,
  74         struct file_id id);
  75
  76 struct tevent_req *fetch_share_mode_send(
  77         TALLOC_CTX *mem_ctx,
  78         struct tevent_context *ev,
  79         struct file_id id,
  80         bool *queued);
  81 NTSTATUS fetch_share_mode_recv(
  82         struct tevent_req *req,
  83         TALLOC_CTX *mem_ctx,
  84         struct share_mode_lock **_lck);
  85
  86 int share_entry_forall(
  87         int (*fn)(struct file_id fid,
  88                   const struct share_mode_data *data,
  89                   const struct share_mode_entry *entry,
  90                   void *private_data),
  91         void *private_data);
  92
  93 NTSTATUS share_mode_count_entries(struct file_id fid, size_t *num_share_modes);
  94 NTSTATUS share_mode_do_locked(
  95         struct file_id id,
  96         void (*fn)(const uint8_t *buf,
  97                    size_t buflen,
  98                    bool *modified_dependent,
  99                    void *private_data),
 100         void *private_data);
 101 int share_mode_forall(
 102         int (*fn)(struct file_id fid,
 103                   const struct share_mode_data *data,
 104                   void *private_data),
 105         void *private_data);
 106 bool share_mode_forall_entries(
 107         struct share_mode_lock *lck,
 108         bool (*fn)(struct share_mode_entry *e,
 109                    bool *modified,
 110                    void *private_data),
 111         void *private_data);
 112
 113 NTTIME share_mode_changed_write_time(struct share_mode_lock *lck);
 114 const char *share_mode_servicepath(struct share_mode_lock *lck);
 115 char *share_mode_filename(TALLOC_CTX *mem_ctx, struct share_mode_lock *lck);
 116 char *share_mode_data_dump(
 117         TALLOC_CTX *mem_ctx, struct share_mode_lock *lck);
 118
 119 void share_mode_flags_get(
 120         struct share_mode_lock *lck,
 121         uint32_t *access_mask,
 122         uint32_t *share_mode,
 123         uint32_t *lease_type);
 124 void share_mode_flags_set(
 125         struct share_mode_lock *lck,
 126         uint32_t access_mask,
 127         uint32_t share_mode,
 128         uint32_t lease_type,
 129         bool *modified);
 130
 131 struct tevent_req *share_mode_watch_send(
 132         TALLOC_CTX *mem_ctx,
 133         struct tevent_context *ev,
 134         struct share_mode_lock *lck,
 135         struct server_id blocker);
 136 NTSTATUS share_mode_watch_recv(
 137         struct tevent_req *req, bool *blockerdead, struct server_id *blocker);
 138 NTSTATUS share_mode_wakeup_waiters(struct file_id id);
 139
 140 #endif