s3/locking: Fix comments to reflect code flow
[samba.git] / source3 / locking / leases_util.c
1 /*
2    Unix SMB/CIFS implementation.
3    Lease utility functions
4
5    Copyright (C) Jeremy Allison 2017.
6    Copyright (C) Stefan (metze) Metzmacher 2017.
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #define DBGC_CLASS DBGC_LOCKING
23 #include "includes.h"
24 #include "../librpc/gen_ndr/open_files.h"
25 #include "locking/proto.h"
26
27 uint32_t map_oplock_to_lease_type(uint16_t op_type)
28 {
29         uint32_t ret;
30
31         switch(op_type) {
32         case BATCH_OPLOCK:
33         case BATCH_OPLOCK|EXCLUSIVE_OPLOCK:
34                 ret = SMB2_LEASE_READ|SMB2_LEASE_WRITE|SMB2_LEASE_HANDLE;
35                 break;
36         case EXCLUSIVE_OPLOCK:
37                 ret = SMB2_LEASE_READ|SMB2_LEASE_WRITE;
38                 break;
39         case LEVEL_II_OPLOCK:
40                 ret = SMB2_LEASE_READ;
41                 break;
42         default:
43                 ret = SMB2_LEASE_NONE;
44                 break;
45         }
46         return ret;
47 }
48
49 uint32_t fsp_lease_type(const struct files_struct *fsp)
50 {
51         if (fsp->oplock_type == LEASE_OPLOCK) {
52                 return fsp->lease->lease.lease_state;
53         }
54         return map_oplock_to_lease_type(fsp->oplock_type);
55 }
56
57 uint32_t lease_type_is_exclusive(uint32_t lease_type)
58 {
59         if ((lease_type & (SMB2_LEASE_READ | SMB2_LEASE_WRITE)) ==
60             (SMB2_LEASE_READ | SMB2_LEASE_WRITE)) {
61                 return true;
62         }
63
64         return false;
65 }
66
67 bool fsp_lease_type_is_exclusive(const struct files_struct *fsp)
68 {
69         uint32_t lease_type = fsp_lease_type(fsp);
70
71         return lease_type_is_exclusive(lease_type);
72 }