r25026: Move param/param.h out of includes.h
[kai/samba-autobuild/.git] / source4 / ntvfs / common / opendb.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    Copyright (C) Andrew Tridgell 2004
5    
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.
10    
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.
15    
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/>.
18 */
19
20 /*
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.
24
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
28   pair.
29
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.
34
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.
38 */
39
40 #include "includes.h"
41 #include "ntvfs/ntvfs.h"
42 #include "ntvfs/common/ntvfs_common.h"
43 #include "cluster/cluster.h"
44 #include "param/param.h"
45
46 static const struct opendb_ops *ops;
47
48 /*
49   set the odb backend ops
50 */
51 void odb_set_ops(const struct opendb_ops *new_ops)
52 {
53         ops = new_ops;
54 }
55
56 /*
57   Open up the openfiles.tdb database. Close it down using
58   talloc_free(). We need the messaging_ctx to allow for pending open
59   notifications.
60 */
61 _PUBLIC_ struct odb_context *odb_init(TALLOC_CTX *mem_ctx, 
62                                       struct ntvfs_context *ntvfs_ctx)
63 {
64         if (ops == NULL) {
65                 if (lp_parm_bool(-1, "ctdb", "opendb", False)) {
66                         odb_ctdb_init_ops();
67                 } else {
68                         odb_tdb_init_ops();
69                 }
70         }
71         return ops->odb_init(mem_ctx, ntvfs_ctx);
72 }
73
74 /*
75   get a lock on a entry in the odb. This call returns a lock handle,
76   which the caller should unlock using talloc_free().
77 */
78 _PUBLIC_ struct odb_lock *odb_lock(TALLOC_CTX *mem_ctx,
79                                    struct odb_context *odb, DATA_BLOB *file_key)
80 {
81         return ops->odb_lock(mem_ctx, odb, file_key);
82 }
83
84
85 /*
86   register an open file in the open files database. This implements the share_access
87   rules
88
89   Note that the path is only used by the delete on close logic, not
90   for comparing with other filenames
91 */
92 _PUBLIC_ NTSTATUS odb_open_file(struct odb_lock *lck, void *file_handle,
93                                 uint32_t stream_id, uint32_t share_access, 
94                                 uint32_t access_mask, BOOL delete_on_close,
95                                 const char *path, 
96                                 uint32_t oplock_level, uint32_t *oplock_granted)
97 {
98         return ops->odb_open_file(lck, file_handle, stream_id, share_access,
99                                   access_mask, delete_on_close, path, oplock_level,
100                                   oplock_granted);
101 }
102
103
104 /*
105   register a pending open file in the open files database
106 */
107 _PUBLIC_ NTSTATUS odb_open_file_pending(struct odb_lock *lck, void *private)
108 {
109         return ops->odb_open_file_pending(lck, private);
110 }
111
112
113 /*
114   remove a opendb entry
115 */
116 _PUBLIC_ NTSTATUS odb_close_file(struct odb_lock *lck, void *file_handle)
117 {
118         return ops->odb_close_file(lck, file_handle);
119 }
120
121
122 /*
123   remove a pending opendb entry
124 */
125 _PUBLIC_ NTSTATUS odb_remove_pending(struct odb_lock *lck, void *private)
126 {
127         return ops->odb_remove_pending(lck, private);
128 }
129
130
131 /*
132   rename the path in a open file
133 */
134 _PUBLIC_ NTSTATUS odb_rename(struct odb_lock *lck, const char *path)
135 {
136         return ops->odb_rename(lck, path);
137 }
138
139 /*
140   update delete on close flag on an open file
141 */
142 _PUBLIC_ NTSTATUS odb_set_delete_on_close(struct odb_lock *lck, BOOL del_on_close)
143 {
144         return ops->odb_set_delete_on_close(lck, del_on_close);
145 }
146
147 /*
148   return the current value of the delete_on_close bit, and how many
149   people still have the file open
150 */
151 _PUBLIC_ NTSTATUS odb_get_delete_on_close(struct odb_context *odb, 
152                                           DATA_BLOB *key, BOOL *del_on_close, 
153                                           int *open_count, char **path)
154 {
155         return ops->odb_get_delete_on_close(odb, key, del_on_close, open_count, path);
156 }
157
158
159 /*
160   determine if a file can be opened with the given share_access,
161   create_options and access_mask
162 */
163 _PUBLIC_ NTSTATUS odb_can_open(struct odb_lock *lck,
164                                uint32_t share_access, uint32_t create_options, 
165                                uint32_t access_mask)
166 {
167         return ops->odb_can_open(lck, share_access, create_options, access_mask);
168 }