xref: /titanic_51/usr/src/uts/common/fs/smbsrv/smb_lock_byte_range.c (revision bbf6f00c25b6a2bed23c35eac6d62998ecdb338c)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 /*
26  * SMB: lock_byte_range
27  *
28  * The lock record message is sent to lock the given byte range.  More than
29  * one non-overlapping byte range may be locked in a given file.  Locks
30  * prevent attempts to lock, read or write the locked portion of the file
31  * by other clients or Pids.  Overlapping locks are not allowed. Offsets
32  * beyond the current end of file may be locked.  Such locks will not cause
33  * allocation of file space.
34  *
35  * Since Offset is a 32 bit quantity, this request is inappropriate for
36  * general locking within a very large file.
37  *
38  * Client Request                     Description
39  * ================================== =================================
40  *
41  * UCHAR WordCount;                   Count of parameter words = 5
42  * USHORT Fid;                        File handle
43  * ULONG Count;                       Count of bytes to lock
44  * ULONG Offset;                      Offset from start of file
45  * USHORT ByteCount;                  Count of data bytes = 0
46  *
47  * Locks may only be unlocked by the Pid that performed the lock.
48  *
49  * Server Response                    Description
50  * ================================== =================================
51  *
52  * UCHAR WordCount;                   Count of parameter words = 0
53  * USHORT ByteCount;                  Count of data bytes = 0
54  *
55  * This client request does not wait for the lock to be granted.  If the
56  * lock can not be immediately granted (within 200-300 ms), the server
57  * should return failure to the client
58  */
59 
60 #include <smbsrv/smb_kproto.h>
61 
62 smb_sdrc_t
63 smb_pre_lock_byte_range(smb_request_t *sr)
64 {
65 	DTRACE_SMB_1(op__LockByteRange__start, smb_request_t *, sr);
66 	return (SDRC_SUCCESS);
67 }
68 
69 void
70 smb_post_lock_byte_range(smb_request_t *sr)
71 {
72 	DTRACE_SMB_1(op__LockByteRange__done, smb_request_t *, sr);
73 }
74 
75 smb_sdrc_t
76 smb_com_lock_byte_range(struct smb_request *sr)
77 {
78 	uint32_t	count;
79 	uint32_t	off;
80 	DWORD		result;
81 	int		rc;
82 
83 	if (smbsr_decode_vwv(sr, "wll", &sr->smb_fid, &count, &off) != 0)
84 		return (SDRC_ERROR);
85 
86 	smbsr_lookup_file(sr);
87 	if (sr->fid_ofile == NULL) {
88 		smbsr_error(sr, NT_STATUS_INVALID_HANDLE,
89 		    ERRDOS, ERRbadfid);
90 		return (SDRC_ERROR);
91 	}
92 
93 	/*
94 	 * The last parameter is lock type. This is dependent on
95 	 * lock flag (3rd parameter). Since the lock flag is
96 	 * set to be exclusive, lock type is passed as
97 	 * normal lock (write lock).
98 	 */
99 	result = smb_lock_range(sr, (u_offset_t)off, (uint64_t)count,  0,
100 	    SMB_LOCK_TYPE_READWRITE);
101 	if (result != NT_STATUS_SUCCESS) {
102 		smb_lock_range_error(sr, result);
103 		return (SDRC_ERROR);
104 	}
105 
106 	rc = smbsr_encode_empty_result(sr);
107 	return ((rc == 0) ? SDRC_SUCCESS : SDRC_ERROR);
108 }
109