Merge branch 'v4-0-test' into id10ts-registry
[samba.git] / source / cluster / ctdb / opendb_ctdb.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    Copyright (C) Ronnie Sahlberg 2007
5    Copyright (C) Andrew Tridgell 2007
6    
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11    
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16    
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 /*
22   this is the open files database, ctdb backend. It implements shared
23   storage of what files are open between server instances, and
24   implements the rules of shared access to files.
25
26   The caller needs to provide a file_key, which specifies what file
27   they are talking about. This needs to be a unique key across all
28   filesystems, and is usually implemented in terms of a device/inode
29   pair.
30
31   Before any operations can be performed the caller needs to establish
32   a lock on the record associated with file_key. That is done by
33   calling odb_lock(). The caller releases this lock by calling
34   talloc_free() on the returned handle.
35
36   All other operations on a record are done by passing the odb_lock()
37   handle back to this module. The handle contains internal
38   information about what file_key is being operated on.
39 */
40
41 #include "includes.h"
42 #include "system/filesys.h"
43 #include "lib/tdb/include/tdb.h"
44 #include "messaging/messaging.h"
45 #include "tdb_wrap.h"
46 #include "lib/messaging/irpc.h"
47 #include "librpc/gen_ndr/ndr_opendb.h"
48 #include "ntvfs/ntvfs.h"
49 #include "ntvfs/common/ntvfs_common.h"
50 #include "cluster/cluster.h"
51 #include "include/ctdb.h"
52 #include "param/param.h"
53
54 struct odb_context {
55         struct ctdb_context *ctdb;
56         struct ctdb_db_context *ctdb_db;
57         struct ntvfs_context *ntvfs_ctx;
58         bool oplocks;
59 };
60
61 /*
62   an odb lock handle. You must obtain one of these using odb_lock() before doing
63   any other operations. 
64 */
65 struct odb_lock {
66         struct odb_context *odb;
67         struct ctdb_record_handle *rec;
68         TDB_DATA key;
69         TDB_DATA data;
70 };
71
72 /*
73   Open up the openfiles.tdb database. Close it down using
74   talloc_free(). We need the messaging_ctx to allow for pending open
75   notifications.
76 */
77 static struct odb_context *odb_ctdb_init(TALLOC_CTX *mem_ctx, 
78                                         struct ntvfs_context *ntvfs_ctx)
79 {
80         struct odb_context *odb;
81         struct ctdb_context *ctdb = talloc_get_type(cluster_backend_handle(), 
82                                                     struct ctdb_context);
83
84         odb = talloc(mem_ctx, struct odb_context);
85         if (odb == NULL) {
86                 return NULL;
87         }
88
89         odb->ctdb = ctdb;
90         odb->ctdb_db = ctdb_attach(ctdb, "opendb");
91         if (!odb->ctdb_db) {
92                 DEBUG(0,("Failed to get attached ctdb db handle for opendb\n"));
93                 talloc_free(odb);
94                 return NULL;
95         }
96
97         odb->ntvfs_ctx = ntvfs_ctx;
98
99         /* leave oplocks disabled by default until the code is working */
100         odb->oplocks = lp_parm_bool(ntvfs_ctx->lp_ctx, NULL, "opendb", "oplocks", false);
101
102         return odb;
103 }
104
105 /*
106   get a lock on a entry in the odb. This call returns a lock handle,
107   which the caller should unlock using talloc_free().
108 */
109 static struct odb_lock *odb_ctdb_lock(TALLOC_CTX *mem_ctx,
110                                      struct odb_context *odb, DATA_BLOB *file_key)
111 {
112         struct odb_lock *lck;
113
114         lck = talloc(mem_ctx, struct odb_lock);
115         if (lck == NULL) {
116                 return NULL;
117         }
118
119         lck->odb = talloc_reference(lck, odb);
120         lck->key.dptr = talloc_memdup(lck, file_key->data, file_key->length);
121         lck->key.dsize = file_key->length;
122         if (lck->key.dptr == NULL) {
123                 talloc_free(lck);
124                 return NULL;
125         }
126
127         lck->rec = ctdb_fetch_lock(odb->ctdb_db, (TALLOC_CTX *)lck, lck->key, &lck->data);
128         if (!lck->rec) {
129                 talloc_free(lck);
130                 return NULL;
131         }
132
133         return lck;
134 }
135
136 static DATA_BLOB odb_ctdb_get_key(TALLOC_CTX *mem_ctx, struct odb_lock *lck)
137 {
138         /*
139          * as this file will went away and isn't used yet,
140          * copy the implementation from the tdb backend
141          * --metze
142          */
143         return data_blob_const(NULL, 0);
144 }
145
146 /*
147   determine if two odb_entry structures conflict
148
149   return NT_STATUS_OK on no conflict
150 */
151 static NTSTATUS share_conflict(struct opendb_entry *e1, struct opendb_entry *e2)
152 {
153         /* if either open involves no read.write or delete access then
154            it can't conflict */
155         if (!(e1->access_mask & (SEC_FILE_WRITE_DATA |
156                                  SEC_FILE_APPEND_DATA |
157                                  SEC_FILE_READ_DATA |
158                                  SEC_FILE_EXECUTE |
159                                  SEC_STD_DELETE))) {
160                 return NT_STATUS_OK;
161         }
162         if (!(e2->access_mask & (SEC_FILE_WRITE_DATA |
163                                  SEC_FILE_APPEND_DATA |
164                                  SEC_FILE_READ_DATA |
165                                  SEC_FILE_EXECUTE |
166                                  SEC_STD_DELETE))) {
167                 return NT_STATUS_OK;
168         }
169
170         /* data IO access masks. This is skipped if the two open handles
171            are on different streams (as in that case the masks don't
172            interact) */
173         if (e1->stream_id != e2->stream_id) {
174                 return NT_STATUS_OK;
175         }
176
177 #define CHECK_MASK(am, right, sa, share) \
178         if (((am) & (right)) && !((sa) & (share))) return NT_STATUS_SHARING_VIOLATION
179
180         CHECK_MASK(e1->access_mask, SEC_FILE_WRITE_DATA | SEC_FILE_APPEND_DATA,
181                    e2->share_access, NTCREATEX_SHARE_ACCESS_WRITE);
182         CHECK_MASK(e2->access_mask, SEC_FILE_WRITE_DATA | SEC_FILE_APPEND_DATA,
183                    e1->share_access, NTCREATEX_SHARE_ACCESS_WRITE);
184         
185         CHECK_MASK(e1->access_mask, SEC_FILE_READ_DATA | SEC_FILE_EXECUTE,
186                    e2->share_access, NTCREATEX_SHARE_ACCESS_READ);
187         CHECK_MASK(e2->access_mask, SEC_FILE_READ_DATA | SEC_FILE_EXECUTE,
188                    e1->share_access, NTCREATEX_SHARE_ACCESS_READ);
189
190         CHECK_MASK(e1->access_mask, SEC_STD_DELETE,
191                    e2->share_access, NTCREATEX_SHARE_ACCESS_DELETE);
192         CHECK_MASK(e2->access_mask, SEC_STD_DELETE,
193                    e1->share_access, NTCREATEX_SHARE_ACCESS_DELETE);
194
195         return NT_STATUS_OK;
196 }
197
198 /*
199   pull a record, translating from the db format to the opendb_file structure defined
200   in opendb.idl
201 */
202 static NTSTATUS odb_pull_record(struct odb_lock *lck, struct opendb_file *file)
203 {
204         TDB_DATA dbuf;
205         DATA_BLOB blob;
206         enum ndr_err_code ndr_err;
207
208         dbuf = lck->data;
209
210         if (dbuf.dsize == 0) {
211                 /* empty record in ctdb means the record isn't there */
212                 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
213         }
214
215         blob.data = dbuf.dptr;
216         blob.length = dbuf.dsize;
217
218         ndr_err = ndr_pull_struct_blob(&blob, lck, lp_iconv_convenience(lck->odb->ntvfs_ctx->lp_ctx), file, (ndr_pull_flags_fn_t)ndr_pull_opendb_file);
219         if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
220                 return ndr_map_error2ntstatus(ndr_err);
221         }
222
223         return NT_STATUS_OK;
224 }
225
226 /*
227   push a record, translating from the opendb_file structure defined in opendb.idl
228 */
229 static NTSTATUS odb_push_record(struct odb_lock *lck, struct opendb_file *file)
230 {
231         TDB_DATA dbuf;
232         DATA_BLOB blob;
233         enum ndr_err_code ndr_err;
234         int ret;
235
236         if (!file->num_entries) {
237                 dbuf.dptr  = NULL;
238                 dbuf.dsize = 0;
239                 ctdb_record_store(lck->rec, dbuf);
240                 talloc_free(lck->rec);
241                 return NT_STATUS_OK;
242         }
243
244         ndr_err = ndr_push_struct_blob(&blob, lck, 
245                                        lp_iconv_convenience(lck->odb->ntvfs_ctx->lp_ctx),
246                                        file, (ndr_push_flags_fn_t)ndr_push_opendb_file);
247         if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
248                 return ndr_map_error2ntstatus(ndr_err);
249         }
250
251         dbuf.dptr = blob.data;
252         dbuf.dsize = blob.length;
253                 
254         ret = ctdb_record_store(lck->rec, dbuf);
255         talloc_free(lck->rec);
256         data_blob_free(&blob);
257         if (ret != 0) {
258                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
259         }
260
261         return NT_STATUS_OK;
262 }
263
264 /*
265   send an oplock break to a client
266 */
267 static NTSTATUS odb_oplock_break_send(struct odb_context *odb, struct opendb_entry *e)
268 {
269         /* tell the server handling this open file about the need to send the client
270            a break */
271         return messaging_send_ptr(odb->ntvfs_ctx->msg_ctx, e->server, 
272                                   MSG_NTVFS_OPLOCK_BREAK, e->file_handle);
273 }
274
275 /*
276   register an open file in the open files database. This implements the share_access
277   rules
278
279   Note that the path is only used by the delete on close logic, not
280   for comparing with other filenames
281 */
282 static NTSTATUS odb_ctdb_open_file(struct odb_lock *lck,
283                                    void *file_handle, const char *path,
284                                    uint32_t stream_id, uint32_t share_access,
285                                    uint32_t access_mask, bool delete_on_close,
286                                    uint32_t open_disposition, bool break_to_none,
287                                    uint32_t oplock_level, uint32_t *oplock_granted)
288
289 {
290         struct odb_context *odb = lck->odb;
291         struct opendb_entry e;
292         int i;
293         struct opendb_file file;
294         NTSTATUS status;
295
296         if (odb->oplocks == false) {
297                 oplock_level = OPLOCK_NONE;
298         }
299
300         status = odb_pull_record(lck, &file);
301         if (NT_STATUS_EQUAL(status, NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
302                 /* initialise a blank structure */
303                 ZERO_STRUCT(file);
304                 file.path = path;
305         } else {
306                 NT_STATUS_NOT_OK_RETURN(status);
307         }
308
309         /* see if it conflicts */
310         e.server          = odb->ntvfs_ctx->server_id;
311         e.file_handle     = file_handle;
312         e.stream_id       = stream_id;
313         e.share_access    = share_access;
314         e.access_mask     = access_mask;
315         e.delete_on_close = delete_on_close;
316         e.oplock_level    = OPLOCK_NONE;
317                 
318         /* see if anyone has an oplock, which we need to break */
319         for (i=0;i<file.num_entries;i++) {
320                 if (file.entries[i].oplock_level == OPLOCK_BATCH) {
321                         /* a batch oplock caches close calls, which
322                            means the client application might have
323                            already closed the file. We have to allow
324                            this close to propogate by sending a oplock
325                            break request and suspending this call
326                            until the break is acknowledged or the file
327                            is closed */
328                         odb_oplock_break_send(odb, &file.entries[i]);
329                         return NT_STATUS_OPLOCK_NOT_GRANTED;
330                 }
331         }
332
333         if (file.delete_on_close || 
334             (file.num_entries != 0 && delete_on_close)) {
335                 /* while delete on close is set, no new opens are allowed */
336                 return NT_STATUS_DELETE_PENDING;
337         }
338
339         /* check for sharing violations */
340         for (i=0;i<file.num_entries;i++) {
341                 status = share_conflict(&file.entries[i], &e);
342                 NT_STATUS_NOT_OK_RETURN(status);
343         }
344
345         /* we now know the open could succeed, but we need to check
346            for any exclusive oplocks. We can't grant a second open
347            till these are broken. Note that we check for batch oplocks
348            before checking for sharing violations, and check for
349            exclusive oplocks afterwards. */
350         for (i=0;i<file.num_entries;i++) {
351                 if (file.entries[i].oplock_level == OPLOCK_EXCLUSIVE) {
352                         odb_oplock_break_send(odb, &file.entries[i]);
353                         return NT_STATUS_OPLOCK_NOT_GRANTED;
354                 }
355         }
356
357         /*
358           possibly grant an exclusive or batch oplock if this is the only client
359           with the file open. We don't yet grant levelII oplocks.
360         */
361         if (oplock_granted != NULL) {
362                 if ((oplock_level == OPLOCK_BATCH ||
363                      oplock_level == OPLOCK_EXCLUSIVE) &&
364                     file.num_entries == 0) {
365                         (*oplock_granted) = oplock_level;
366                 } else {
367                         (*oplock_granted) = OPLOCK_NONE;
368                 }
369                 e.oplock_level = (*oplock_granted);
370         }
371
372         /* it doesn't conflict, so add it to the end */
373         file.entries = talloc_realloc(lck, file.entries, struct opendb_entry, 
374                                       file.num_entries+1);
375         NT_STATUS_HAVE_NO_MEMORY(file.entries);
376
377         file.entries[file.num_entries] = e;
378         file.num_entries++;
379
380         return odb_push_record(lck, &file);
381 }
382
383
384 /*
385   register a pending open file in the open files database
386 */
387 static NTSTATUS odb_ctdb_open_file_pending(struct odb_lock *lck, void *private)
388 {
389         struct odb_context *odb = lck->odb;
390         struct opendb_file file;
391         NTSTATUS status;
392                 
393         status = odb_pull_record(lck, &file);
394         NT_STATUS_NOT_OK_RETURN(status);
395
396         file.pending = talloc_realloc(lck, file.pending, struct opendb_pending, 
397                                       file.num_pending+1);
398         NT_STATUS_HAVE_NO_MEMORY(file.pending);
399
400         file.pending[file.num_pending].server = odb->ntvfs_ctx->server_id;
401         file.pending[file.num_pending].notify_ptr = private;
402
403         file.num_pending++;
404
405         return odb_push_record(lck, &file);
406 }
407
408
409 /*
410   remove a opendb entry
411 */
412 static NTSTATUS odb_ctdb_close_file(struct odb_lock *lck, void *file_handle,
413                                     const char **_delete_path)
414 {
415         struct odb_context *odb = lck->odb;
416         struct opendb_file file;
417         const char *delete_path = NULL;
418         int i;
419         NTSTATUS status;
420
421         status = odb_pull_record(lck, &file);
422         NT_STATUS_NOT_OK_RETURN(status);
423
424         /* find the entry, and delete it */
425         for (i=0;i<file.num_entries;i++) {
426                 if (file_handle == file.entries[i].file_handle &&
427                     cluster_id_equal(&odb->ntvfs_ctx->server_id, &file.entries[i].server)) {
428                         if (file.entries[i].delete_on_close) {
429                                 file.delete_on_close = true;
430                         }
431                         if (i < file.num_entries-1) {
432                                 memmove(file.entries+i, file.entries+i+1, 
433                                         (file.num_entries - (i+1)) * 
434                                         sizeof(struct opendb_entry));
435                         }
436                         break;
437                 }
438         }
439
440         if (i == file.num_entries) {
441                 return NT_STATUS_UNSUCCESSFUL;
442         }
443
444         /* send any pending notifications, removing them once sent */
445         for (i=0;i<file.num_pending;i++) {
446                 messaging_send_ptr(odb->ntvfs_ctx->msg_ctx, file.pending[i].server, 
447                                    MSG_PVFS_RETRY_OPEN, 
448                                    file.pending[i].notify_ptr);
449         }
450         file.num_pending = 0;
451
452         file.num_entries--;
453
454         if (file.num_entries == 0 && file.delete_on_close) {
455                 delete_path = talloc_strdup(lck, file.path);
456                 NT_STATUS_HAVE_NO_MEMORY(delete_path);
457         }
458
459         if (_delete_path) {
460                 *_delete_path = delete_path;
461         }
462         
463         return odb_push_record(lck, &file);
464 }
465
466 /*
467   update the oplock level of the client
468 */
469 static NTSTATUS odb_ctdb_update_oplock(struct odb_lock *lck, void *file_handle,
470                                        uint32_t oplock_level)
471 {
472         /*
473          * as this file will went away and isn't used yet,
474          * copy the implementation from the tdb backend
475          * --metze
476          */
477         return NT_STATUS_FOOBAR;
478 }
479
480 static NTSTATUS odb_ctdb_break_oplocks(struct odb_lock *lck)
481 {
482         /*
483          * as this file will went away and isn't used yet,
484          * copy the implementation from the tdb backend
485          * --metze
486          */
487         return NT_STATUS_FOOBAR;
488 }
489
490 /*
491   remove a pending opendb entry
492 */
493 static NTSTATUS odb_ctdb_remove_pending(struct odb_lock *lck, void *private)
494 {
495         struct odb_context *odb = lck->odb;
496         int i;
497         NTSTATUS status;
498         struct opendb_file file;
499
500         status = odb_pull_record(lck, &file);
501         NT_STATUS_NOT_OK_RETURN(status);
502
503         /* find the entry, and delete it */
504         for (i=0;i<file.num_pending;i++) {
505                 if (private == file.pending[i].notify_ptr &&
506                     cluster_id_equal(&odb->ntvfs_ctx->server_id, &file.pending[i].server)) {
507                         if (i < file.num_pending-1) {
508                                 memmove(file.pending+i, file.pending+i+1, 
509                                         (file.num_pending - (i+1)) * 
510                                         sizeof(struct opendb_pending));
511                         }
512                         break;
513                 }
514         }
515
516         if (i == file.num_pending) {
517                 return NT_STATUS_UNSUCCESSFUL;
518         }
519
520         file.num_pending--;
521         
522         return odb_push_record(lck, &file);
523 }
524
525
526 /*
527   rename the path in a open file
528 */
529 static NTSTATUS odb_ctdb_rename(struct odb_lock *lck, const char *path)
530 {
531         struct opendb_file file;
532         NTSTATUS status;
533
534         status = odb_pull_record(lck, &file);
535         if (NT_STATUS_EQUAL(NT_STATUS_OBJECT_NAME_NOT_FOUND, status)) {
536                 /* not having the record at all is OK */
537                 return NT_STATUS_OK;
538         }
539         NT_STATUS_NOT_OK_RETURN(status);
540
541         file.path = path;
542         return odb_push_record(lck, &file);
543 }
544
545 /*
546   get the path of an open file
547 */
548 static NTSTATUS odb_ctdb_get_path(struct odb_lock *lck, const char **path)
549 {
550         struct opendb_file file;
551         NTSTATUS status;
552
553         *path = NULL;
554
555         status = odb_pull_record(lck, &file);
556         /* we don't ignore NT_STATUS_OBJECT_NAME_NOT_FOUND here */
557         NT_STATUS_NOT_OK_RETURN(status);
558
559         *path = file.path;
560
561         return NT_STATUS_OK;
562 }
563
564 /*
565   update delete on close flag on an open file
566 */
567 static NTSTATUS odb_ctdb_set_delete_on_close(struct odb_lock *lck, bool del_on_close)
568 {
569         NTSTATUS status;
570         struct opendb_file file;
571
572         status = odb_pull_record(lck, &file);
573         NT_STATUS_NOT_OK_RETURN(status);
574
575         file.delete_on_close = del_on_close;
576
577         return odb_push_record(lck, &file);
578 }
579
580 /*
581   return the current value of the delete_on_close bit, and how many
582   people still have the file open
583 */
584 static NTSTATUS odb_ctdb_get_delete_on_close(struct odb_context *odb, 
585                                             DATA_BLOB *key, bool *del_on_close)
586 {
587         NTSTATUS status;
588         struct opendb_file file;
589         struct odb_lock *lck;
590
591         (*del_on_close) = false;
592
593         lck = odb_lock(odb, odb, key);
594         NT_STATUS_HAVE_NO_MEMORY(lck);
595
596         status = odb_pull_record(lck, &file);
597         if (NT_STATUS_EQUAL(NT_STATUS_OBJECT_NAME_NOT_FOUND, status)) {
598                 talloc_free(lck);
599                 return NT_STATUS_OK;
600         }
601         if (!NT_STATUS_IS_OK(status)) {
602                 talloc_free(lck);
603                 return status;
604         }
605
606         (*del_on_close) = file.delete_on_close;
607
608         talloc_free(lck);
609
610         return NT_STATUS_OK;
611 }
612
613
614 /*
615   determine if a file can be opened with the given share_access,
616   create_options and access_mask
617 */
618 static NTSTATUS odb_ctdb_can_open(struct odb_lock *lck,
619                                   uint32_t stream_id, uint32_t share_access,
620                                   uint32_t access_mask, bool delete_on_close,
621                                   uint32_t open_disposition, bool break_to_none)
622 {
623         struct odb_context *odb = lck->odb;
624         NTSTATUS status;
625         struct opendb_file file;
626         struct opendb_entry e;
627         int i;
628
629         status = odb_pull_record(lck, &file);
630         if (NT_STATUS_EQUAL(status, NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
631                 return NT_STATUS_OK;
632         }
633         NT_STATUS_NOT_OK_RETURN(status);
634
635         if (delete_on_close &&
636             file.num_entries != 0) {
637                 return NT_STATUS_SHARING_VIOLATION;
638         }
639
640         if (file.delete_on_close) {
641                 return NT_STATUS_DELETE_PENDING;
642         }
643
644         e.server       = odb->ntvfs_ctx->server_id;
645         e.file_handle  = NULL;
646         e.stream_id    = 0;
647         e.share_access = share_access;
648         e.access_mask  = access_mask;
649                 
650         for (i=0;i<file.num_entries;i++) {
651                 status = share_conflict(&file.entries[i], &e);
652                 if (!NT_STATUS_IS_OK(status)) {
653                         /* note that we discard the error code
654                            here. We do this as unless we are actually
655                            doing an open (which comes via a different
656                            function), we need to return a sharing
657                            violation */
658                         return NT_STATUS_SHARING_VIOLATION;
659                 }
660         }
661
662         return NT_STATUS_OK;
663 }
664
665
666 static const struct opendb_ops opendb_ctdb_ops = {
667         .odb_init                = odb_ctdb_init,
668         .odb_lock                = odb_ctdb_lock,
669         .odb_get_key             = odb_ctdb_get_key,
670         .odb_open_file           = odb_ctdb_open_file,
671         .odb_open_file_pending   = odb_ctdb_open_file_pending,
672         .odb_close_file          = odb_ctdb_close_file,
673         .odb_remove_pending      = odb_ctdb_remove_pending,
674         .odb_rename              = odb_ctdb_rename,
675         .odb_get_path            = odb_ctdb_get_path,
676         .odb_set_delete_on_close = odb_ctdb_set_delete_on_close,
677         .odb_get_delete_on_close = odb_ctdb_get_delete_on_close,
678         .odb_can_open            = odb_ctdb_can_open,
679         .odb_update_oplock       = odb_ctdb_update_oplock,
680         .odb_break_oplocks       = odb_ctdb_break_oplocks
681 };
682
683
684 void odb_ctdb_init_ops(void)
685 {
686         odb_set_ops(&opendb_ctdb_ops);
687 }