2
Unix SMB/CIFS implementation.
4
Copyright (C) Andrew Tridgell 2004
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/>.
21
this is the open files database. It implements shared storage of
22
what files are open between server instances, and implements the rules
23
of shared access to files.
25
The caller needs to provide a file_key, which specifies what file
26
they are talking about. This needs to be a unique key across all
27
filesystems, and is usually implemented in terms of a device/inode
30
Before any operations can be performed the caller needs to establish
31
a lock on the record associated with file_key. That is done by
32
calling odb_lock(). The caller releases this lock by calling
33
talloc_free() on the returned handle.
35
All other operations on a record are done by passing the odb_lock()
36
handle back to this module. The handle contains internal
37
information about what file_key is being operated on.
41
#include "ntvfs/ntvfs.h"
42
#include "ntvfs/common/ntvfs_common.h"
43
#include "cluster/cluster.h"
44
#include "param/param.h"
46
static const struct opendb_ops *ops;
49
set the odb backend ops
51
void odb_set_ops(const struct opendb_ops *new_ops)
57
Open up the openfiles.tdb database. Close it down using
58
talloc_free(). We need the messaging_ctx to allow for pending open
61
struct odb_context *odb_init(TALLOC_CTX *mem_ctx,
62
struct ntvfs_context *ntvfs_ctx)
67
return ops->odb_init(mem_ctx, ntvfs_ctx);
71
get a lock on a entry in the odb. This call returns a lock handle,
72
which the caller should unlock using talloc_free().
74
struct odb_lock *odb_lock(TALLOC_CTX *mem_ctx,
75
struct odb_context *odb, DATA_BLOB *file_key)
77
return ops->odb_lock(mem_ctx, odb, file_key);
80
DATA_BLOB odb_get_key(TALLOC_CTX *mem_ctx, struct odb_lock *lck)
82
return ops->odb_get_key(mem_ctx, lck);
86
register an open file in the open files database.
87
The share_access rules are implemented by odb_can_open()
88
and it's needed to call odb_can_open() before
89
odb_open_file() otherwise NT_STATUS_INTERNAL_ERROR is returned
91
Note that the path is only used by the delete on close logic, not
92
for comparing with other filenames
94
NTSTATUS odb_open_file(struct odb_lock *lck,
95
void *file_handle, const char *path,
96
int *fd, NTTIME open_write_time,
97
bool allow_level_II_oplock,
98
uint32_t oplock_level, uint32_t *oplock_granted)
100
return ops->odb_open_file(lck, file_handle, path,
102
allow_level_II_oplock,
103
oplock_level, oplock_granted);
108
register a pending open file in the open files database
110
NTSTATUS odb_open_file_pending(struct odb_lock *lck, void *private_data)
112
return ops->odb_open_file_pending(lck, private_data);
117
remove a opendb entry
119
NTSTATUS odb_close_file(struct odb_lock *lck, void *file_handle,
120
const char **delete_path)
122
return ops->odb_close_file(lck, file_handle, delete_path);
127
remove a pending opendb entry
129
NTSTATUS odb_remove_pending(struct odb_lock *lck, void *private_data)
131
return ops->odb_remove_pending(lck, private_data);
136
rename the path in a open file
138
NTSTATUS odb_rename(struct odb_lock *lck, const char *path)
140
return ops->odb_rename(lck, path);
144
get back the path of an open file
146
NTSTATUS odb_get_path(struct odb_lock *lck, const char **path)
148
return ops->odb_get_path(lck, path);
152
update delete on close flag on an open file
154
NTSTATUS odb_set_delete_on_close(struct odb_lock *lck, bool del_on_close)
156
return ops->odb_set_delete_on_close(lck, del_on_close);
160
update the write time on an open file
162
NTSTATUS odb_set_write_time(struct odb_lock *lck,
163
NTTIME write_time, bool force)
165
return ops->odb_set_write_time(lck, write_time, force);
169
return the current value of the delete_on_close bit,
170
and the current write time.
172
NTSTATUS odb_get_file_infos(struct odb_context *odb, DATA_BLOB *key,
173
bool *del_on_close, NTTIME *write_time)
175
return ops->odb_get_file_infos(odb, key, del_on_close, write_time);
179
determine if a file can be opened with the given share_access,
180
create_options and access_mask
182
NTSTATUS odb_can_open(struct odb_lock *lck,
183
uint32_t stream_id, uint32_t share_access,
184
uint32_t access_mask, bool delete_on_close,
185
uint32_t open_disposition, bool break_to_none)
187
return ops->odb_can_open(lck, stream_id, share_access, access_mask,
188
delete_on_close, open_disposition, break_to_none);
191
NTSTATUS odb_update_oplock(struct odb_lock *lck, void *file_handle,
192
uint32_t oplock_level)
194
return ops->odb_update_oplock(lck, file_handle, oplock_level);
197
NTSTATUS odb_break_oplocks(struct odb_lock *lck)
199
return ops->odb_break_oplocks(lck);