4 * Copyright (c) International Business Machines Corp., 2009, 2013
6 * Author(s): Steve French (sfrench@us.ibm.com)
7 * Pavel Shilovsky (pshilovsky@samba.org) 2012
9 * This library is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as published
11 * by the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
17 * the GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this library; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * Note that, due to trying to use names similar to the protocol specifications,
31 * there are many mixed case field names in the structures below. Although
32 * this does not match typical Linux kernel style, it is necessary to be
33 * be able to match against the protocol specfication.
36 * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
37 * (ie no useful data other than the SMB error code itself) and are marked such.
38 * Knowing this helps avoid response buffer allocations and copy in some cases.
41 /* List of commands in host endian */
42 #define SMB2_NEGOTIATE_HE 0x0000
43 #define SMB2_SESSION_SETUP_HE 0x0001
44 #define SMB2_LOGOFF_HE 0x0002 /* trivial request/resp */
45 #define SMB2_TREE_CONNECT_HE 0x0003
46 #define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
47 #define SMB2_CREATE_HE 0x0005
48 #define SMB2_CLOSE_HE 0x0006
49 #define SMB2_FLUSH_HE 0x0007 /* trivial resp */
50 #define SMB2_READ_HE 0x0008
51 #define SMB2_WRITE_HE 0x0009
52 #define SMB2_LOCK_HE 0x000A
53 #define SMB2_IOCTL_HE 0x000B
54 #define SMB2_CANCEL_HE 0x000C
55 #define SMB2_ECHO_HE 0x000D
56 #define SMB2_QUERY_DIRECTORY_HE 0x000E
57 #define SMB2_CHANGE_NOTIFY_HE 0x000F
58 #define SMB2_QUERY_INFO_HE 0x0010
59 #define SMB2_SET_INFO_HE 0x0011
60 #define SMB2_OPLOCK_BREAK_HE 0x0012
62 /* The same list in little endian */
63 #define SMB2_NEGOTIATE cpu_to_le16(SMB2_NEGOTIATE_HE)
64 #define SMB2_SESSION_SETUP cpu_to_le16(SMB2_SESSION_SETUP_HE)
65 #define SMB2_LOGOFF cpu_to_le16(SMB2_LOGOFF_HE)
66 #define SMB2_TREE_CONNECT cpu_to_le16(SMB2_TREE_CONNECT_HE)
67 #define SMB2_TREE_DISCONNECT cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
68 #define SMB2_CREATE cpu_to_le16(SMB2_CREATE_HE)
69 #define SMB2_CLOSE cpu_to_le16(SMB2_CLOSE_HE)
70 #define SMB2_FLUSH cpu_to_le16(SMB2_FLUSH_HE)
71 #define SMB2_READ cpu_to_le16(SMB2_READ_HE)
72 #define SMB2_WRITE cpu_to_le16(SMB2_WRITE_HE)
73 #define SMB2_LOCK cpu_to_le16(SMB2_LOCK_HE)
74 #define SMB2_IOCTL cpu_to_le16(SMB2_IOCTL_HE)
75 #define SMB2_CANCEL cpu_to_le16(SMB2_CANCEL_HE)
76 #define SMB2_ECHO cpu_to_le16(SMB2_ECHO_HE)
77 #define SMB2_QUERY_DIRECTORY cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
78 #define SMB2_CHANGE_NOTIFY cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
79 #define SMB2_QUERY_INFO cpu_to_le16(SMB2_QUERY_INFO_HE)
80 #define SMB2_SET_INFO cpu_to_le16(SMB2_SET_INFO_HE)
81 #define SMB2_OPLOCK_BREAK cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
83 #define NUMBER_OF_SMB2_COMMANDS 0x0013
85 /* BB FIXME - analyze following length BB */
86 #define MAX_SMB2_HDR_SIZE 0x78 /* 4 len + 64 hdr + (2*24 wct) + 2 bct + 2 pad */
88 #define SMB2_PROTO_NUMBER __constant_cpu_to_le32(0x424d53fe)
91 * SMB2 Header Definition
93 * "MBZ" : Must be Zero
94 * "BB" : BugBug, Something to check/review/analyze later
95 * "PDU" : "Protocol Data Unit" (ie a network "frame")
99 #define SMB2_HEADER_STRUCTURE_SIZE __constant_cpu_to_le16(64)
102 __be32 smb2_buf_length; /* big endian on wire */
103 /* length is only two or three bytes - with
104 one or two byte type preceding it that MBZ */
105 __u8 ProtocolId[4]; /* 0xFE 'S' 'M' 'B' */
106 __le16 StructureSize; /* 64 */
107 __le16 CreditCharge; /* MBZ */
108 __le32 Status; /* Error from server */
110 __le16 CreditRequest; /* CreditResponse */
113 __u64 MessageId; /* opaque - so can stay little endian */
115 __u32 TreeId; /* opaque - so do not make little endian */
116 __u64 SessionId; /* opaque - so do not make little endian */
122 __le16 StructureSize2; /* size of wct area (varies, request specific) */
126 * SMB2 flag definitions
128 #define SMB2_FLAGS_SERVER_TO_REDIR __constant_cpu_to_le32(0x00000001)
129 #define SMB2_FLAGS_ASYNC_COMMAND __constant_cpu_to_le32(0x00000002)
130 #define SMB2_FLAGS_RELATED_OPERATIONS __constant_cpu_to_le32(0x00000004)
131 #define SMB2_FLAGS_SIGNED __constant_cpu_to_le32(0x00000008)
132 #define SMB2_FLAGS_DFS_OPERATIONS __constant_cpu_to_le32(0x10000000)
135 * Definitions for SMB2 Protocol Data Units (network frames)
137 * See MS-SMB2.PDF specification for protocol details.
138 * The Naming convention is the lower case version of the SMB2
139 * command code name for the struct. Note that structures must be packed.
143 #define SMB2_ERROR_STRUCTURE_SIZE2 __constant_cpu_to_le16(9)
145 struct smb2_err_rsp {
147 __le16 StructureSize;
148 __le16 Reserved; /* MBZ */
149 __le32 ByteCount; /* even if zero, at least one byte follows */
150 __u8 ErrorData[1]; /* variable length */
153 #define SMB2_CLIENT_GUID_SIZE 16
155 extern __u8 cifs_client_guid[SMB2_CLIENT_GUID_SIZE];
157 struct smb2_negotiate_req {
159 __le16 StructureSize; /* Must be 36 */
162 __le16 Reserved; /* MBZ */
164 __u8 ClientGUID[SMB2_CLIENT_GUID_SIZE];
165 __le64 ClientStartTime; /* MBZ */
166 __le16 Dialects[1]; /* One dialect (vers=) at a time for now */
170 #define SMB20_PROT_ID 0x0202
171 #define SMB21_PROT_ID 0x0210
172 #define SMB30_PROT_ID 0x0300
173 #define SMB302_PROT_ID 0x0302
174 #define BAD_PROT_ID 0xFFFF
176 /* SecurityMode flags */
177 #define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
178 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
179 /* Capabilities flags */
180 #define SMB2_GLOBAL_CAP_DFS 0x00000001
181 #define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
182 #define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
183 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
184 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
185 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
186 #define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
188 #define SMB2_NT_FIND 0x00100000
189 #define SMB2_LARGE_FILES 0x00200000
191 struct smb2_negotiate_rsp {
193 __le16 StructureSize; /* Must be 65 */
195 __le16 DialectRevision;
196 __le16 Reserved; /* MBZ */
199 __le32 MaxTransactSize;
202 __le64 SystemTime; /* MBZ */
203 __le64 ServerStartTime;
204 __le16 SecurityBufferOffset;
205 __le16 SecurityBufferLength;
206 __le32 Reserved2; /* may be any value, ignore */
207 __u8 Buffer[1]; /* variable length GSS security buffer */
210 struct smb2_sess_setup_req {
212 __le16 StructureSize; /* Must be 25 */
217 __le16 SecurityBufferOffset;
218 __le16 SecurityBufferLength;
219 __le64 PreviousSessionId;
220 __u8 Buffer[1]; /* variable length GSS security buffer */
223 /* Currently defined SessionFlags */
224 #define SMB2_SESSION_FLAG_IS_GUEST 0x0001
225 #define SMB2_SESSION_FLAG_IS_NULL 0x0002
226 struct smb2_sess_setup_rsp {
228 __le16 StructureSize; /* Must be 9 */
230 __le16 SecurityBufferOffset;
231 __le16 SecurityBufferLength;
232 __u8 Buffer[1]; /* variable length GSS security buffer */
235 struct smb2_logoff_req {
237 __le16 StructureSize; /* Must be 4 */
241 struct smb2_logoff_rsp {
243 __le16 StructureSize; /* Must be 4 */
247 struct smb2_tree_connect_req {
249 __le16 StructureSize; /* Must be 9 */
253 __u8 Buffer[1]; /* variable length */
256 struct smb2_tree_connect_rsp {
258 __le16 StructureSize; /* Must be 16 */
259 __u8 ShareType; /* see below */
261 __le32 ShareFlags; /* see below */
262 __le32 Capabilities; /* see below */
263 __le32 MaximalAccess;
266 /* Possible ShareType values */
267 #define SMB2_SHARE_TYPE_DISK 0x01
268 #define SMB2_SHARE_TYPE_PIPE 0x02
269 #define SMB2_SHARE_TYPE_PRINT 0x03
272 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
273 * must be set (any of the remaining, SHI1005, flags may be set individually
276 #define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
277 #define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
278 #define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
279 #define SMB2_SHAREFLAG_NO_CACHING 0x00000030
280 #define SHI1005_FLAGS_DFS 0x00000001
281 #define SHI1005_FLAGS_DFS_ROOT 0x00000002
282 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
283 #define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
284 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
285 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
286 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
287 #define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
288 #define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
289 #define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
290 #define SHI1005_FLAGS_ALL 0x0000FF33
292 /* Possible share capabilities */
293 #define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
294 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
295 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
296 #define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
297 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
299 struct smb2_tree_disconnect_req {
301 __le16 StructureSize; /* Must be 4 */
305 struct smb2_tree_disconnect_rsp {
307 __le16 StructureSize; /* Must be 4 */
311 /* File Attrubutes */
312 #define FILE_ATTRIBUTE_READONLY 0x00000001
313 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
314 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
315 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
316 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
317 #define FILE_ATTRIBUTE_NORMAL 0x00000080
318 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
319 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
320 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
321 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
322 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
323 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
324 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
327 #define SMB2_OPLOCK_LEVEL_NONE 0x00
328 #define SMB2_OPLOCK_LEVEL_II 0x01
329 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
330 #define SMB2_OPLOCK_LEVEL_BATCH 0x09
331 #define SMB2_OPLOCK_LEVEL_LEASE 0xFF
332 /* Non-spec internal type */
333 #define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
335 /* Desired Access Flags */
336 #define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
337 #define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
338 #define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
339 #define FILE_READ_EA_LE cpu_to_le32(0x00000008)
340 #define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
341 #define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
342 #define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
343 #define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
344 #define FILE_DELETE_LE cpu_to_le32(0x00010000)
345 #define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
346 #define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
347 #define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
348 #define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
349 #define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
350 #define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
351 #define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
352 #define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
353 #define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
354 #define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
356 /* ShareAccess Flags */
357 #define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
358 #define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
359 #define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
360 #define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
362 /* CreateDisposition Flags */
363 #define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
364 #define FILE_OPEN_LE cpu_to_le32(0x00000001)
365 #define FILE_CREATE_LE cpu_to_le32(0x00000002)
366 #define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
367 #define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
368 #define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
370 /* CreateOptions Flags */
371 #define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
372 /* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
373 #define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
374 #define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
375 #define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
376 #define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
377 #define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
378 #define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
379 #define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
380 #define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
381 #define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
382 #define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
383 #define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
384 #define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
385 #define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
386 #define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
387 #define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
388 #define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
389 #define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
391 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
392 | FILE_READ_ATTRIBUTES_LE)
393 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
394 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
395 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
397 /* Impersonation Levels */
398 #define IL_ANONYMOUS cpu_to_le32(0x00000000)
399 #define IL_IDENTIFICATION cpu_to_le32(0x00000001)
400 #define IL_IMPERSONATION cpu_to_le32(0x00000002)
401 #define IL_DELEGATE cpu_to_le32(0x00000003)
403 /* Create Context Values */
404 #define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
405 #define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
406 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
407 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
408 #define SMB2_CREATE_ALLOCATION_SIZE "AlSi"
409 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
410 #define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
411 #define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
412 #define SMB2_CREATE_REQUEST_LEASE "RqLs"
414 struct smb2_create_req {
416 __le16 StructureSize; /* Must be 57 */
418 __u8 RequestedOplockLevel;
419 __le32 ImpersonationLevel;
420 __le64 SmbCreateFlags;
422 __le32 DesiredAccess;
423 __le32 FileAttributes;
425 __le32 CreateDisposition;
426 __le32 CreateOptions;
429 __le32 CreateContextsOffset;
430 __le32 CreateContextsLength;
434 struct smb2_create_rsp {
436 __le16 StructureSize; /* Must be 89 */
441 __le64 LastAccessTime;
442 __le64 LastWriteTime;
444 __le64 AllocationSize;
446 __le32 FileAttributes;
448 __u64 PersistentFileId; /* opaque endianness */
449 __u64 VolatileFileId; /* opaque endianness */
450 __le32 CreateContextsOffset;
451 __le32 CreateContextsLength;
455 struct create_context {
465 #define SMB2_LEASE_NONE __constant_cpu_to_le32(0x00)
466 #define SMB2_LEASE_READ_CACHING __constant_cpu_to_le32(0x01)
467 #define SMB2_LEASE_HANDLE_CACHING __constant_cpu_to_le32(0x02)
468 #define SMB2_LEASE_WRITE_CACHING __constant_cpu_to_le32(0x04)
470 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS __constant_cpu_to_le32(0x02)
472 #define SMB2_LEASE_KEY_SIZE 16
474 struct lease_context {
479 __le64 LeaseDuration;
482 struct create_lease {
483 struct create_context ccontext;
485 struct lease_context lcontext;
488 /* this goes in the ioctl buffer when doing a copychunk request */
489 struct copychunk_ioctl {
491 __le32 ChunkCount; /* we are only sending 1 */
493 /* array will only be one chunk long for us */
496 __le32 Length; /* how many bytes to copy */
500 /* Response and Request are the same format */
501 struct validate_negotiate_info {
503 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
509 #define RSS_CAPABLE 0x00000001
510 #define RDMA_CAPABLE 0x00000002
512 struct network_interface_info_ioctl_rsp {
513 __le32 Next; /* next interface. zero if this is last one */
515 __le32 Capability; /* RSS or RDMA Capable */
518 char SockAddr_Storage[128];
521 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
523 struct smb2_ioctl_req {
525 __le16 StructureSize; /* Must be 57 */
528 __u64 PersistentFileId; /* opaque endianness */
529 __u64 VolatileFileId; /* opaque endianness */
532 __le32 MaxInputResponse;
535 __le32 MaxOutputResponse;
541 struct smb2_ioctl_rsp {
543 __le16 StructureSize; /* Must be 57 */
546 __u64 PersistentFileId; /* opaque endianness */
547 __u64 VolatileFileId; /* opaque endianness */
554 /* char * buffer[] */
557 /* Currently defined values for close flags */
558 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
559 struct smb2_close_req {
561 __le16 StructureSize; /* Must be 24 */
564 __u64 PersistentFileId; /* opaque endianness */
565 __u64 VolatileFileId; /* opaque endianness */
568 struct smb2_close_rsp {
570 __le16 StructureSize; /* 60 */
574 __le64 LastAccessTime;
575 __le64 LastWriteTime;
577 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
582 struct smb2_flush_req {
584 __le16 StructureSize; /* Must be 24 */
587 __u64 PersistentFileId; /* opaque endianness */
588 __u64 VolatileFileId; /* opaque endianness */
591 struct smb2_flush_rsp {
593 __le16 StructureSize;
597 /* For read request Flags field below, following flag is defined for SMB3.02 */
598 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
600 /* Channel field for read and write: exactly one of following flags can be set*/
601 #define SMB2_CHANNEL_NONE 0x00000000
602 #define SMB2_CHANNEL_RDMA_V1 0x00000001 /* SMB3 or later */
603 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE 0x00000001 /* SMB3.02 or later */
605 struct smb2_read_req {
607 __le16 StructureSize; /* Must be 49 */
608 __u8 Padding; /* offset from start of SMB2 header to place read */
609 __u8 Flags; /* MBZ unless SMB3.02 or later */
612 __u64 PersistentFileId; /* opaque endianness */
613 __u64 VolatileFileId; /* opaque endianness */
615 __le32 Channel; /* MBZ except for SMB3 or later */
616 __le32 RemainingBytes;
617 __le16 ReadChannelInfoOffset; /* Reserved MBZ */
618 __le16 ReadChannelInfoLength; /* Reserved MBZ */
622 struct smb2_read_rsp {
624 __le16 StructureSize; /* Must be 17 */
628 __le32 DataRemaining;
633 /* For write request Flags field below the following flags are defined: */
634 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
635 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
637 struct smb2_write_req {
639 __le16 StructureSize; /* Must be 49 */
640 __le16 DataOffset; /* offset from start of SMB2 header to write data */
643 __u64 PersistentFileId; /* opaque endianness */
644 __u64 VolatileFileId; /* opaque endianness */
645 __le32 Channel; /* Reserved MBZ */
646 __le32 RemainingBytes;
647 __le16 WriteChannelInfoOffset; /* Reserved MBZ */
648 __le16 WriteChannelInfoLength; /* Reserved MBZ */
653 struct smb2_write_rsp {
655 __le16 StructureSize; /* Must be 17 */
659 __le32 DataRemaining;
664 #define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
665 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
666 #define SMB2_LOCKFLAG_UNLOCK 0x0004
667 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
669 struct smb2_lock_element {
676 struct smb2_lock_req {
678 __le16 StructureSize; /* Must be 48 */
681 __u64 PersistentFileId; /* opaque endianness */
682 __u64 VolatileFileId; /* opaque endianness */
683 /* Followed by at least one */
684 struct smb2_lock_element locks[1];
687 struct smb2_lock_rsp {
689 __le16 StructureSize; /* Must be 4 */
693 struct smb2_echo_req {
695 __le16 StructureSize; /* Must be 4 */
699 struct smb2_echo_rsp {
701 __le16 StructureSize; /* Must be 4 */
705 /* search (query_directory) Flags field */
706 #define SMB2_RESTART_SCANS 0x01
707 #define SMB2_RETURN_SINGLE_ENTRY 0x02
708 #define SMB2_INDEX_SPECIFIED 0x04
709 #define SMB2_REOPEN 0x10
711 struct smb2_query_directory_req {
713 __le16 StructureSize; /* Must be 33 */
714 __u8 FileInformationClass;
717 __u64 PersistentFileId; /* opaque endianness */
718 __u64 VolatileFileId; /* opaque endianness */
719 __le16 FileNameOffset;
720 __le16 FileNameLength;
721 __le32 OutputBufferLength;
725 struct smb2_query_directory_rsp {
727 __le16 StructureSize; /* Must be 9 */
728 __le16 OutputBufferOffset;
729 __le32 OutputBufferLength;
733 /* Possible InfoType values */
734 #define SMB2_O_INFO_FILE 0x01
735 #define SMB2_O_INFO_FILESYSTEM 0x02
736 #define SMB2_O_INFO_SECURITY 0x03
737 #define SMB2_O_INFO_QUOTA 0x04
739 struct smb2_query_info_req {
741 __le16 StructureSize; /* Must be 41 */
744 __le32 OutputBufferLength;
745 __le16 InputBufferOffset;
747 __le32 InputBufferLength;
748 __le32 AdditionalInformation;
750 __u64 PersistentFileId; /* opaque endianness */
751 __u64 VolatileFileId; /* opaque endianness */
755 struct smb2_query_info_rsp {
757 __le16 StructureSize; /* Must be 9 */
758 __le16 OutputBufferOffset;
759 __le32 OutputBufferLength;
763 struct smb2_set_info_req {
765 __le16 StructureSize; /* Must be 33 */
771 __le32 AdditionalInformation;
772 __u64 PersistentFileId; /* opaque endianness */
773 __u64 VolatileFileId; /* opaque endianness */
777 struct smb2_set_info_rsp {
779 __le16 StructureSize; /* Must be 2 */
782 struct smb2_oplock_break {
784 __le16 StructureSize; /* Must be 24 */
792 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
794 struct smb2_lease_break {
796 __le16 StructureSize; /* Must be 44 */
800 __le32 CurrentLeaseState;
801 __le32 NewLeaseState;
803 __le32 AccessMaskHint;
804 __le32 ShareMaskHint;
807 struct smb2_lease_ack {
809 __le16 StructureSize; /* Must be 36 */
814 __le64 LeaseDuration;
818 * PDU infolevel structure definitions
819 * BB consider moving to a different header
822 /* File System Information Classes */
823 #define FS_VOLUME_INFORMATION 1 /* Query */
824 #define FS_LABEL_INFORMATION 2 /* Set */
825 #define FS_SIZE_INFORMATION 3 /* Query */
826 #define FS_DEVICE_INFORMATION 4 /* Query */
827 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
828 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
829 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
830 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
831 #define FS_DRIVER_PATH_INFORMATION 9 /* Query */
833 struct smb2_fs_full_size_info {
834 __le64 TotalAllocationUnits;
835 __le64 CallerAvailableAllocationUnits;
836 __le64 ActualAvailableAllocationUnits;
837 __le32 SectorsPerAllocationUnit;
838 __le32 BytesPerSector;
841 /* partial list of QUERY INFO levels */
842 #define FILE_DIRECTORY_INFORMATION 1
843 #define FILE_FULL_DIRECTORY_INFORMATION 2
844 #define FILE_BOTH_DIRECTORY_INFORMATION 3
845 #define FILE_BASIC_INFORMATION 4
846 #define FILE_STANDARD_INFORMATION 5
847 #define FILE_INTERNAL_INFORMATION 6
848 #define FILE_EA_INFORMATION 7
849 #define FILE_ACCESS_INFORMATION 8
850 #define FILE_NAME_INFORMATION 9
851 #define FILE_RENAME_INFORMATION 10
852 #define FILE_LINK_INFORMATION 11
853 #define FILE_NAMES_INFORMATION 12
854 #define FILE_DISPOSITION_INFORMATION 13
855 #define FILE_POSITION_INFORMATION 14
856 #define FILE_FULL_EA_INFORMATION 15
857 #define FILE_MODE_INFORMATION 16
858 #define FILE_ALIGNMENT_INFORMATION 17
859 #define FILE_ALL_INFORMATION 18
860 #define FILE_ALLOCATION_INFORMATION 19
861 #define FILE_END_OF_FILE_INFORMATION 20
862 #define FILE_ALTERNATE_NAME_INFORMATION 21
863 #define FILE_STREAM_INFORMATION 22
864 #define FILE_PIPE_INFORMATION 23
865 #define FILE_PIPE_LOCAL_INFORMATION 24
866 #define FILE_PIPE_REMOTE_INFORMATION 25
867 #define FILE_MAILSLOT_QUERY_INFORMATION 26
868 #define FILE_MAILSLOT_SET_INFORMATION 27
869 #define FILE_COMPRESSION_INFORMATION 28
870 #define FILE_OBJECT_ID_INFORMATION 29
871 /* Number 30 not defined in documents */
872 #define FILE_MOVE_CLUSTER_INFORMATION 31
873 #define FILE_QUOTA_INFORMATION 32
874 #define FILE_REPARSE_POINT_INFORMATION 33
875 #define FILE_NETWORK_OPEN_INFORMATION 34
876 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
877 #define FILE_TRACKING_INFORMATION 36
878 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
879 #define FILEID_FULL_DIRECTORY_INFORMATION 38
880 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
881 #define FILE_SHORT_NAME_INFORMATION 40
882 #define FILE_SFIO_RESERVE_INFORMATION 44
883 #define FILE_SFIO_VOLUME_INFORMATION 45
884 #define FILE_HARD_LINK_INFORMATION 46
885 #define FILE_NORMALIZED_NAME_INFORMATION 48
886 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
887 #define FILE_STANDARD_LINK_INFORMATION 54
889 struct smb2_file_internal_info {
891 } __packed; /* level 6 Query */
893 struct smb2_file_rename_info { /* encoding of request for level 10 */
894 __u8 ReplaceIfExists; /* 1 = replace existing target with new */
895 /* 0 = fail if target already exists */
897 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
898 __le32 FileNameLength;
899 char FileName[0]; /* New name to be assigned */
900 } __packed; /* level 10 Set */
902 struct smb2_file_link_info { /* encoding of request for level 11 */
903 __u8 ReplaceIfExists; /* 1 = replace existing link with new */
904 /* 0 = fail if link already exists */
906 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
907 __le32 FileNameLength;
908 char FileName[0]; /* Name to be assigned to new link */
909 } __packed; /* level 11 Set */
912 * This level 18, although with struct with same name is different from cifs
913 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
916 struct smb2_file_all_info { /* data block encoding of response to level 18 */
917 __le64 CreationTime; /* Beginning of FILE_BASIC_INFO equivalent */
918 __le64 LastAccessTime;
919 __le64 LastWriteTime;
922 __u32 Pad1; /* End of FILE_BASIC_INFO_INFO equivalent */
923 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
924 __le64 EndOfFile; /* size ie offset to first free byte in file */
925 __le32 NumberOfLinks; /* hard links */
928 __u16 Pad2; /* End of FILE_STANDARD_INFO equivalent */
932 __le64 CurrentByteOffset;
934 __le32 AlignmentRequirement;
935 __le32 FileNameLength;
937 } __packed; /* level 18 Query */
939 struct smb2_file_eof_info { /* encoding of request for level 10 */
940 __le64 EndOfFile; /* new end of file value */
941 } __packed; /* level 20 Set */
943 #endif /* _SMB2PDU_H */