4 * Copyright (c) International Business Machines Corp., 2002
5 * Author(s): Steve French (sfrench@us.ibm.com)
7 * This library is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published
9 * by the Free Software Foundation; either version 2.1 of the License, or
10 * (at your option) any later version.
12 * This library 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
15 * the GNU Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #define BAD_PROT CIFS_PROT+1
30 /* SMB command codes */
31 /* Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
32 (ie which include no useful data other than the SMB error code itself).
33 Knowing this helps avoid response buffer allocations and copy in some cases */
34 #define SMB_COM_CREATE_DIRECTORY 0x00 /* trivial response */
35 #define SMB_COM_DELETE_DIRECTORY 0x01 /* trivial response */
36 #define SMB_COM_CLOSE 0x04 /* triv req/rsp, timestamp ignored */
37 #define SMB_COM_DELETE 0x06 /* trivial response */
38 #define SMB_COM_RENAME 0x07 /* trivial response */
39 #define SMB_COM_SETATTR 0x09 /* trivial response */
40 #define SMB_COM_LOCKING_ANDX 0x24 /* trivial response */
41 #define SMB_COM_COPY 0x29 /* trivial rsp, fail filename ignrd*/
42 #define SMB_COM_READ_ANDX 0x2E
43 #define SMB_COM_WRITE_ANDX 0x2F
44 #define SMB_COM_TRANSACTION2 0x32
45 #define SMB_COM_TRANSACTION2_SECONDARY 0x33
46 #define SMB_COM_FIND_CLOSE2 0x34 /* trivial response */
47 #define SMB_COM_TREE_DISCONNECT 0x71 /* trivial response */
48 #define SMB_COM_NEGOTIATE 0x72
49 #define SMB_COM_SESSION_SETUP_ANDX 0x73
50 #define SMB_COM_LOGOFF_ANDX 0x74 /* trivial response */
51 #define SMB_COM_TREE_CONNECT_ANDX 0x75
52 #define SMB_COM_NT_TRANSACT 0xA0
53 #define SMB_COM_NT_TRANSACT_SECONDARY 0xA1
54 #define SMB_COM_NT_CREATE_ANDX 0xA2
55 #define SMB_COM_NT_RENAME 0xA5 /* trivial response */
57 /* Transact2 subcommand codes */
58 #define TRANS2_OPEN 0x00
59 #define TRANS2_FIND_FIRST 0x01
60 #define TRANS2_FIND_NEXT 0x02
61 #define TRANS2_QUERY_FS_INFORMATION 0x03
62 #define TRANS2_SET_FS_INFORMATION 0x04
63 #define TRANS2_QUERY_PATH_INFORMATION 0x05
64 #define TRANS2_SET_PATH_INFORMATION 0x06
65 #define TRANS2_QUERY_FILE_INFORMATION 0x07
66 #define TRANS2_SET_FILE_INFORMATION 0x08
67 #define TRANS2_GET_DFS_REFERRAL 0x10
68 #define TRANS2_REPORT_DFS_INCOSISTENCY 0x11
70 /* NT Transact subcommand codes */
71 #define NT_TRANSACT_CREATE 0x01
72 #define NT_TRANSACT_IOCTL 0x02
73 #define NT_TRANSACT_SET_SECURITY_DESC 0x03
74 #define NT_TRANSACT_NOTIFY_CHANGE 0x04
75 #define NT_TRANSACT_RENAME 0x05
76 #define NT_TRANSACT_QUERY_SECURITY_DESC 0x06
77 #define NT_TRANSACT_GET_USER_QUOTA 0x07
78 #define NT_TRANSACT_SET_USER_QUOTA 0x08
80 #define MAX_CIFS_HDR_SIZE 256 /* chained NTCreateXReadX will probably be biggest */
82 /* internal cifs vfs structures */
83 /*****************************************************************
84 * All constants go here
85 *****************************************************************
89 * Starting value for maximum SMB size negotiation
91 #define CIFS_MAX_MSGSIZE (4*4096)
94 * Size of encrypted user password in bytes
96 #define CIFS_ENCPWD_SIZE (16)
99 * Size of the crypto key returned on the negotiate SMB in bytes
101 #define CIFS_CRYPTO_KEY_SIZE (8)
104 * Size of the session key (crypto key encrypted with the password
106 #define CIFS_SESSION_KEY_SIZE (24)
109 * Maximum user name length
111 #define CIFS_UNLEN (20)
116 #define SMBOPEN_WRITE_THROUGH 0x4000
117 #define SMBOPEN_DENY_ALL 0x0010
118 #define SMBOPEN_DENY_WRITE 0x0020
119 #define SMBOPEN_DENY_READ 0x0030
120 #define SMBOPEN_DENY_NONE 0x0040
121 #define SMBOPEN_READ 0x0000
122 #define SMBOPEN_WRITE 0x0001
123 #define SMBOPEN_READWRITE 0x0002
124 #define SMBOPEN_EXECUTE 0x0003
126 #define SMBOPEN_OCREATE 0x0010
127 #define SMBOPEN_OTRUNC 0x0002
128 #define SMBOPEN_OAPPEND 0x0001
131 * SMB flag definitions
133 #define SMBFLG_EXTD_LOCK 0x01 /* server supports lock-read write-unlock primitives */
134 #define SMBFLG_RCV_POSTED 0x02 /* obsolete */
135 #define SMBFLG_RSVD 0x04
136 #define SMBFLG_CASELESS 0x08 /* all pathnames treated as caseless (off implies case sensitive file handling requested) */
137 #define SMBFLG_CANONICAL_PATH_FORMAT 0x10 /* obsolete */
138 #define SMBFLG_OLD_OPLOCK 0x20 /* obsolete */
139 #define SMBFLG_OLD_OPLOCK_NOTIFY 0x40 /* obsolete */
140 #define SMBFLG_RESPONSE 0x80 /* this PDU is a response from server */
143 * SMB flag2 definitions
145 #define SMBFLG2_KNOWS_LONG_NAMES cpu_to_le16(1) /* can send long (non-8.3) path names in response */
146 #define SMBFLG2_KNOWS_EAS cpu_to_le16(2)
147 #define SMBFLG2_SECURITY_SIGNATURE cpu_to_le16(4)
148 #define SMBFLG2_IS_LONG_NAME cpu_to_le16(0x40)
149 #define SMBFLG2_EXT_SEC cpu_to_le16(0x800)
150 #define SMBFLG2_DFS cpu_to_le16(0x1000)
151 #define SMBFLG2_PAGING_IO cpu_to_le16(0x2000)
152 #define SMBFLG2_ERR_STATUS cpu_to_le16(0x4000)
153 #define SMBFLG2_UNICODE cpu_to_le16(0x8000)
156 * These are the file access permission bits defined in CIFS for the
157 * NTCreateAndX as well as the level 0x107
158 * TRANS2_QUERY_PATH_INFORMATION API. The level 0x107, SMB_QUERY_FILE_ALL_INFO
159 * responds with the AccessFlags.
160 * The AccessFlags specifies the access permissions a caller has to the
161 * file and can have any suitable combination of the following values:
164 #define FILE_READ_DATA 0x00000001 /* Data can be read from the file */
165 #define FILE_WRITE_DATA 0x00000002 /* Data can be written to the file */
166 #define FILE_APPEND_DATA 0x00000004 /* Data can be appended to the file */
167 #define FILE_READ_EA 0x00000008 /* Extended attributes associated */
168 /* with the file can be read */
169 #define FILE_WRITE_EA 0x00000010 /* Extended attributes associated */
170 /* with the file can be written */
171 #define FILE_EXECUTE 0x00000020 /*Data can be read into memory from */
172 /* the file using system paging I/O */
173 #define FILE_DELETE_CHILD 0x00000040
174 #define FILE_READ_ATTRIBUTES 0x00000080 /* Attributes associated with the */
175 /* file can be read */
176 #define FILE_WRITE_ATTRIBUTES 0x00000100 /* Attributes associated with the */
177 /* file can be written */
178 #define DELETE 0x00010000 /* The file can be deleted */
179 #define READ_CONTROL 0x00020000 /* The access control list and */
180 /* ownership associated with the */
181 /* file can be read */
182 #define WRITE_DAC 0x00040000 /* The access control list and */
183 /* ownership associated with the */
184 /* file can be written. */
185 #define WRITE_OWNER 0x00080000 /* Ownership information associated */
186 /* with the file can be written */
187 #define SYNCHRONIZE 0x00100000 /* The file handle can waited on to */
188 /* synchronize with the completion */
189 /* of an input/output request */
190 #define GENERIC_ALL 0x10000000
191 #define GENERIC_EXECUTE 0x20000000
192 #define GENERIC_WRITE 0x40000000
193 #define GENERIC_READ 0x80000000
194 /* In summary - Relevant file */
195 /* access flags from CIFS are */
196 /* file_read_data, file_write_data */
197 /* file_execute, file_read_attributes */
198 /* write_dac, and delete. */
201 * Invalid readdir handle
203 #define CIFS_NO_HANDLE 0xFFFF
206 #define CIFS_IPC_RESOURCE "\x49\x50\x43\x24"
208 /* IPC$ in Unicode */
209 #define CIFS_IPC_UNICODE_RESOURCE "\x00\x49\x00\x50\x00\x43\x00\x24\x00\x00"
211 /* Unicode Null terminate 2 bytes of 0 */
212 #define UNICODE_NULL "\x00\x00"
213 #define ASCII_NULL 0x00
216 * Server type values (returned on EnumServer API
218 #define CIFS_SV_TYPE_DC 0x00000008
219 #define CIFS_SV_TYPE_BACKDC 0x00000010
222 * Alias type flags (From EnumAlias API call
224 #define CIFS_ALIAS_TYPE_FILE 0x0001
225 #define CIFS_SHARE_TYPE_FILE 0x0000
228 * File Attribute flags
230 #define ATTR_READONLY 0x0001
231 #define ATTR_HIDDEN 0x0002
232 #define ATTR_SYSTEM 0x0004
233 #define ATTR_VOLUME 0x0008
234 #define ATTR_DIRECTORY 0x0010
235 #define ATTR_ARCHIVE 0x0020
236 #define ATTR_DEVICE 0x0040
237 #define ATTR_NORMAL 0x0080
238 #define ATTR_TEMPORARY 0x0100
239 #define ATTR_SPARSE 0x0200
240 #define ATTR_REPARSE 0x0400
241 #define ATTR_COMPRESSED 0x0800
242 #define ATTR_OFFLINE 0x1000 /* ie file not immediately available - offline storage */
243 #define ATTR_NOT_CONTENT_INDEXED 0x2000
244 #define ATTR_ENCRYPTED 0x4000
245 #define ATTR_POSIX_SEMANTICS 0x01000000
246 #define ATTR_BACKUP_SEMANTICS 0x02000000
247 #define ATTR_DELETE_ON_CLOSE 0x04000000
248 #define ATTR_SEQUENTIAL_SCAN 0x08000000
249 #define ATTR_RANDOM_ACCESS 0x10000000
250 #define ATTR_NO_BUFFERING 0x20000000
251 #define ATTR_WRITE_THROUGH 0x80000000
253 /* ShareAccess flags */
254 #define FILE_NO_SHARE 0x00000000
255 #define FILE_SHARE_READ 0x00000001
256 #define FILE_SHARE_WRITE 0x00000002
257 #define FILE_SHARE_DELETE 0x00000004
258 #define FILE_SHARE_ALL 0x00000007
260 /* CreateDisposition flags */
261 #define FILE_SUPERSEDE 0x00000000
262 #define FILE_OPEN 0x00000001
263 #define FILE_CREATE 0x00000002
264 #define FILE_OPEN_IF 0x00000003
265 #define FILE_OVERWRITE 0x00000004
266 #define FILE_OVERWRITE_IF 0x00000005
269 #define CREATE_NOT_FILE 0x00000001 /* if set must not be file */
270 #define CREATE_WRITE_THROUGH 0x00000002
271 #define CREATE_NOT_DIR 0x00000040 /* if set must not be directory */
272 #define CREATE_RANDOM_ACCESS 0x00000800
273 #define CREATE_DELETE_ON_CLOSE 0x00001000
274 #define OPEN_REPARSE_POINT 0x00200000
276 /* ImpersonationLevel flags */
277 #define SECURITY_ANONYMOUS 0
278 #define SECURITY_IDENTIFICATION 1
279 #define SECURITY_IMPERSONATION 2
280 #define SECURITY_DELEGATION 3
283 #define SECURITY_CONTEXT_TRACKING 0x01
284 #define SECURITY_EFFECTIVE_ONLY 0x02
287 * Default PID value, used in all SMBs where the PID is not important
289 #define CIFS_DFT_PID 0x1234
292 * We use the same routine for Copy and Move SMBs. This flag is used to
295 #define CIFS_COPY_OP 1
296 #define CIFS_RENAME_OP 2
298 #define GETU16(var) (*((__u16 *)var)) /* BB check for endian issues */
299 #define GETU32(var) (*((__u32 *)var)) /* BB check for endian issues */
304 __u32 smb_buf_length; /* big endian on wire *//* BB length is only two or three bytes - with one or two byte type preceding it but that is always zero - we could mask the type byte off just in case BB */
316 __le16 Flags2; /* note: le */
320 __le32 SequenceNumber; /* le */
321 __u32 Reserved; /* zero */
323 __u8 SecuritySignature[8]; /* le */
332 /* given a pointer to an smb_hdr retrieve the value of byte count */
333 #define BCC(smb_var) ( *(__u16 *)((char *)smb_var + sizeof(struct smb_hdr) + (2* smb_var->WordCount) ) )
334 #define BCC_LE(smb_var) ( *(__le16 *)((char *)smb_var + sizeof(struct smb_hdr) + (2* smb_var->WordCount) ) )
335 /* given a pointer to an smb_hdr retrieve the pointer to the byte area */
336 #define pByteArea(smb_var) ((unsigned char *)smb_var + sizeof(struct smb_hdr) + (2* smb_var->WordCount) + 2 )
339 * Computer Name Length
344 * Share Name Length @S8A
345 * Note: This length is limited by the SMB used to get @S8A
346 * the Share info. NetShareEnum only returns 13 @S8A
347 * chars, including the null termination. @S8A
349 #define SNLEN 12 /*@S8A */
354 #define MAXCOMMENTLEN 40
357 * The OS/2 maximum path name
359 #define MAX_PATHCONF 256
362 * SMB frame definitions (following must be packed structs)
363 * See the SNIA CIFS Specification for details.
365 * The Naming convention is the lower case version of the
366 * smb command code name for the struct and this is typedef to the
367 * uppercase version of the same name with the prefix SMB_ removed
368 * for brevity. Although typedefs are not commonly used for
369 * structure definitions in the Linux kernel, their use in the
370 * CIFS standards document, which this code is based on, may
371 * make this one of the cases where typedefs for structures make
372 * sense to improve readability for readers of the standards doc.
373 * Typedefs can always be removed later if they are too distracting
374 * and they are only used for the CIFSs PDUs themselves, not
375 * internal cifs vfs structures
379 typedef struct negotiate_req {
380 struct smb_hdr hdr; /* wct = 0 */
382 unsigned char DialectsArray[1];
385 typedef struct negotiate_rsp {
386 struct smb_hdr hdr; /* wct = 17 */
391 __le32 MaxBufferSize;
394 __le32 Capabilities; /* see below */
395 __le32 SystemTimeLow;
396 __le32 SystemTimeHigh;
397 __le16 ServerTimeZone;
398 __u8 EncryptionKeyLength;
401 unsigned char EncryptionKey[1]; /* if cap extended security is off */
402 /* followed by Domain name - if extended security is off */
403 /* followed by 16 bytes of server GUID */
404 /* followed by security blob if cap_extended_security negotiated */
406 unsigned char GUID[16];
407 unsigned char SecurityBlob[1];
412 /* SecurityMode bits */
413 #define SECMODE_USER 0x01 /* off indicates share level security */
414 #define SECMODE_PW_ENCRYPT 0x02
415 #define SECMODE_SIGN_ENABLED 0x04 /* SMB security signatures enabled */
416 #define SECMODE_SIGN_REQUIRED 0x08 /* SMB security signatures required */
418 /* Negotiate response Capabilities */
419 #define CAP_RAW_MODE 0x00000001
420 #define CAP_MPX_MODE 0x00000002
421 #define CAP_UNICODE 0x00000004
422 #define CAP_LARGE_FILES 0x00000008
423 #define CAP_NT_SMBS 0x00000010 /* implies CAP_NT_FIND */
424 #define CAP_RPC_REMOTE_APIS 0x00000020
425 #define CAP_STATUS32 0x00000040
426 #define CAP_LEVEL_II_OPLOCKS 0x00000080
427 #define CAP_LOCK_AND_READ 0x00000100
428 #define CAP_NT_FIND 0x00000200
429 #define CAP_DFS 0x00001000
430 #define CAP_INFOLEVEL_PASSTHRU 0x00002000
431 #define CAP_LARGE_READ_X 0x00004000
432 #define CAP_LARGE_WRITE_X 0x00008000
433 #define CAP_UNIX 0x00800000
434 #define CAP_RESERVED 0x02000000
435 #define CAP_BULK_TRANSFER 0x20000000
436 #define CAP_COMPRESSED_DATA 0x40000000
437 #define CAP_EXTENDED_SECURITY 0x80000000
439 typedef union smb_com_session_setup_andx {
440 struct { /* request format */
441 struct smb_hdr hdr; /* wct = 12 */
445 __le16 MaxBufferSize;
449 __le16 SecurityBlobLength;
451 __le32 Capabilities; /* see below */
453 unsigned char SecurityBlob[1]; /* followed by */
454 /* STRING NativeOS */
455 /* STRING NativeLanMan */
456 } req; /* NTLM request format (with extended security */
458 struct { /* request format */
459 struct smb_hdr hdr; /* wct = 13 */
463 __le16 MaxBufferSize;
467 __le16 CaseInsensitivePasswordLength; /* ASCII password length */
468 __le16 CaseSensitivePasswordLength; /* Unicode password length */
469 __u32 Reserved; /* see below */
472 unsigned char CaseInsensitivePassword[1]; /* followed by: */
473 /* unsigned char * CaseSensitivePassword; */
474 /* STRING AccountName */
475 /* STRING PrimaryDomain */
476 /* STRING NativeOS */
477 /* STRING NativeLanMan */
478 } req_no_secext; /* NTLM request format (without extended security */
480 struct { /* default (NTLM) response format */
481 struct smb_hdr hdr; /* wct = 4 */
485 __le16 Action; /* see below */
486 __le16 SecurityBlobLength;
488 unsigned char SecurityBlob[1]; /* followed by */
489 /* unsigned char * NativeOS; */
490 /* unsigned char * NativeLanMan; */
491 /* unsigned char * PrimaryDomain; */
492 } resp; /* NTLM response format (with or without extended security */
494 struct { /* request format */
495 struct smb_hdr hdr; /* wct = 10 */
499 __le16 MaxBufferSize;
503 __le16 PassswordLength;
506 unsigned char AccountPassword[1]; /* followed by */
507 /* STRING AccountName */
508 /* STRING PrimaryDomain */
509 /* STRING NativeOS */
510 /* STRING NativeLanMan */
511 } old_req; /* pre-NTLM (LANMAN2.1) request format */
513 struct { /* default (NTLM) response format */
514 struct smb_hdr hdr; /* wct = 3 */
518 __le16 Action; /* see below */
520 unsigned char NativeOS[1]; /* followed by */
521 /* unsigned char * NativeLanMan; */
522 /* unsigned char * PrimaryDomain; */
523 } old_resp; /* pre-NTLM (LANMAN2.1) response format */
524 } SESSION_SETUP_ANDX;
526 #define CIFS_NETWORK_OPSYS "CIFS VFS Client for Linux"
528 /* Capabilities bits (for NTLM SessSetup request) */
529 #define CAP_UNICODE 0x00000004
530 #define CAP_LARGE_FILES 0x00000008
531 #define CAP_NT_SMBS 0x00000010
532 #define CAP_STATUS32 0x00000040
533 #define CAP_LEVEL_II_OPLOCKS 0x00000080
534 #define CAP_NT_FIND 0x00000200 /* reserved should be zero (presumably because NT_SMBs implies the same thing) */
535 #define CAP_BULK_TRANSFER 0x20000000
536 #define CAP_EXTENDED_SECURITY 0x80000000
539 #define GUEST_LOGIN 1
541 typedef struct smb_com_tconx_req {
542 struct smb_hdr hdr; /* wct = 4 */
546 __le16 Flags; /* see below */
547 __le16 PasswordLength;
549 unsigned char Password[1]; /* followed by */
550 /* STRING Path *//* \\server\share name */
554 typedef struct smb_com_tconx_rsp {
555 struct smb_hdr hdr; /* wct = 3 *//* note that Win2000 has sent wct=7 in some cases on responses. Four unspecified words followed OptionalSupport */
559 __le16 OptionalSupport; /* see below */
561 unsigned char Service[1]; /* always ASCII, not Unicode */
562 /* STRING NativeFileSystem */
565 /* tree connect Flags */
566 #define DISCONNECT_TID 0x0001
567 #define TCON_EXTENDED_SECINFO 0x0008
568 /* OptionalSupport bits */
569 #define SMB_SUPPORT_SEARCH_BITS 0x0001 /* must have bits (exclusive searches suppt. */
570 #define SMB_SHARE_IS_IN_DFS 0x0002
572 typedef struct smb_com_logoff_andx_req {
573 struct smb_hdr hdr; /* wct = 2 */
580 typedef struct smb_com_logoff_andx_rsp {
581 struct smb_hdr hdr; /* wct = 2 */
588 typedef union smb_com_tree_disconnect { /* as an altetnative can use flag on tree_connect PDU to effect disconnect *//* probably the simplest SMB PDU */
590 struct smb_hdr hdr; /* wct = 0 */
591 __u16 ByteCount; /* bcc = 0 */
594 struct smb_hdr hdr; /* wct = 0 */
595 __u16 ByteCount; /* bcc = 0 */
599 typedef struct smb_com_close_req {
600 struct smb_hdr hdr; /* wct = 3 */
602 __u32 LastWriteTime; /* should be zero */
603 __u16 ByteCount; /* 0 */
606 typedef struct smb_com_close_rsp {
607 struct smb_hdr hdr; /* wct = 0 */
608 __u16 ByteCount; /* bct = 0 */
611 typedef struct smb_com_findclose_req {
612 struct smb_hdr hdr; /* wct = 1 */
614 __u16 ByteCount; /* 0 */
618 #define REQ_OPLOCK 0x00000002
619 #define REQ_BATCHOPLOCK 0x00000004
620 #define REQ_OPENDIRONLY 0x00000008
622 typedef struct smb_com_open_req { /* also handles create */
623 struct smb_hdr hdr; /* wct = 24 */
627 __u8 Reserved; /* Must Be Zero */
630 __le32 RootDirectoryFid;
631 __le32 DesiredAccess;
632 __le64 AllocationSize;
633 __le32 FileAttributes;
635 __le32 CreateDisposition;
636 __le32 CreateOptions;
637 __le32 ImpersonationLevel;
643 /* open response: oplock levels */
644 #define OPLOCK_NONE 0
645 #define OPLOCK_EXCLUSIVE 1
646 #define OPLOCK_BATCH 2
647 #define OPLOCK_READ 3 /* level 2 oplock */
649 /* open response for CreateAction shifted left */
650 #define CIFS_CREATE_ACTION 0x20000 /* file created */
652 typedef struct smb_com_open_rsp {
653 struct smb_hdr hdr; /* wct = 34 BB */
661 __le64 LastAccessTime;
662 __le64 LastWriteTime;
664 __le32 FileAttributes;
665 __le64 AllocationSize;
670 __u16 ByteCount; /* bct = 0 */
673 typedef struct smb_com_write_req {
674 struct smb_hdr hdr; /* wct = 14 */
683 __le16 DataLengthHigh;
684 __le16 DataLengthLow;
688 __u8 Pad; /* BB check for whether padded to DWORD boundary and optimum performance here */
692 typedef struct smb_com_write_rsp {
693 struct smb_hdr hdr; /* wct = 6 */
704 typedef struct smb_com_read_req {
705 struct smb_hdr hdr; /* wct = 12 */
712 __le16 MinCount; /* obsolete */
719 typedef struct smb_com_read_rsp {
720 struct smb_hdr hdr; /* wct = 12 */
725 __le16 DataCompactionMode;
729 __le16 DataLengthHigh;
732 __u8 Pad; /* BB check for whether padded to DWORD boundary and optimum performance here */
736 typedef struct locking_andx_range {
743 } LOCKING_ANDX_RANGE;
745 #define LOCKING_ANDX_SHARED_LOCK 0x01
746 #define LOCKING_ANDX_OPLOCK_RELEASE 0x02
747 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x04
748 #define LOCKING_ANDX_CANCEL_LOCK 0x08
749 #define LOCKING_ANDX_LARGE_FILES 0x10 /* always on for us */
751 typedef struct smb_com_lock_req {
752 struct smb_hdr hdr; /* wct = 8 */
760 __le16 NumberOfUnlocks;
761 __le16 NumberOfLocks;
763 LOCKING_ANDX_RANGE Locks[1];
767 typedef struct cifs_posix_lock {
768 __le16 lock_type; /* 0 = Read, 1 = Write, 2 = Unlock */
769 __le16 lock_flags; /* 1 = Wait (only valid for setlock) */
773 /* BB what about additional owner info to identify network client */
776 typedef struct smb_com_lock_rsp {
777 struct smb_hdr hdr; /* wct = 2 */
784 typedef struct smb_com_rename_req {
785 struct smb_hdr hdr; /* wct = 1 */
786 __le16 SearchAttributes; /* target file attributes */
788 __u8 BufferFormat; /* 4 = ASCII or Unicode */
789 unsigned char OldFileName[1];
790 /* followed by __u8 BufferFormat2 */
791 /* followed by NewFileName */
794 /* copy request flags */
795 #define COPY_MUST_BE_FILE 0x0001
796 #define COPY_MUST_BE_DIR 0x0002
797 #define COPY_TARGET_MODE_ASCII 0x0004 /* if not set, binary */
798 #define COPY_SOURCE_MODE_ASCII 0x0008 /* if not set, binary */
799 #define COPY_VERIFY_WRITES 0x0010
800 #define COPY_TREE 0x0020
802 typedef struct smb_com_copy_req {
803 struct smb_hdr hdr; /* wct = 3 */
808 __u8 BufferFormat; /* 4 = ASCII or Unicode */
809 unsigned char OldFileName[1];
810 /* followed by __u8 BufferFormat2 */
811 /* followed by NewFileName string */
814 typedef struct smb_com_copy_rsp {
815 struct smb_hdr hdr; /* wct = 1 */
816 __le16 CopyCount; /* number of files copied */
817 __u16 ByteCount; /* may be zero */
818 __u8 BufferFormat; /* 0x04 - only present if errored file follows */
819 unsigned char ErrorFileName[1]; /* only present if error in copy */
822 #define CREATE_HARD_LINK 0x103
823 #define MOVEFILE_COPY_ALLOWED 0x0002
824 #define MOVEFILE_REPLACE_EXISTING 0x0001
826 typedef struct smb_com_nt_rename_req { /* A5 - also used for create hardlink */
827 struct smb_hdr hdr; /* wct = 4 */
828 __le16 SearchAttributes; /* target file attributes */
829 __le16 Flags; /* spec says Information Level */
832 __u8 BufferFormat; /* 4 = ASCII or Unicode */
833 unsigned char OldFileName[1];
834 /* followed by __u8 BufferFormat2 */
835 /* followed by NewFileName */
838 typedef struct smb_com_rename_rsp {
839 struct smb_hdr hdr; /* wct = 0 */
840 __u16 ByteCount; /* bct = 0 */
843 typedef struct smb_com_delete_file_req {
844 struct smb_hdr hdr; /* wct = 1 */
845 __le16 SearchAttributes;
847 __u8 BufferFormat; /* 4 = ASCII */
848 unsigned char fileName[1];
851 typedef struct smb_com_delete_file_rsp {
852 struct smb_hdr hdr; /* wct = 0 */
853 __u16 ByteCount; /* bct = 0 */
856 typedef struct smb_com_delete_directory_req {
857 struct smb_hdr hdr; /* wct = 0 */
859 __u8 BufferFormat; /* 4 = ASCII */
860 unsigned char DirName[1];
861 } DELETE_DIRECTORY_REQ;
863 typedef struct smb_com_delete_directory_rsp {
864 struct smb_hdr hdr; /* wct = 0 */
865 __u16 ByteCount; /* bct = 0 */
866 } DELETE_DIRECTORY_RSP;
868 typedef struct smb_com_create_directory_req {
869 struct smb_hdr hdr; /* wct = 0 */
871 __u8 BufferFormat; /* 4 = ASCII */
872 unsigned char DirName[1];
873 } CREATE_DIRECTORY_REQ;
875 typedef struct smb_com_create_directory_rsp {
876 struct smb_hdr hdr; /* wct = 0 */
877 __u16 ByteCount; /* bct = 0 */
878 } CREATE_DIRECTORY_RSP;
880 typedef struct smb_com_setattr_req {
881 struct smb_hdr hdr; /* wct = 8 */
885 __le16 reserved[5]; /* must be zero */
887 __u8 BufferFormat; /* 4 = ASCII */
888 unsigned char fileName[1];
891 typedef struct smb_com_setattr_rsp {
892 struct smb_hdr hdr; /* wct = 0 */
893 __u16 ByteCount; /* bct = 0 */
896 /* empty wct response to setattr */
898 /***************************************************/
899 /* NT Transact structure defintions follow */
900 /* Currently only ioctl and notify are implemented */
901 /***************************************************/
902 typedef struct smb_com_transaction_ioctl_req {
903 struct smb_hdr hdr; /* wct = 23 */
906 __le32 TotalParameterCount;
907 __le32 TotalDataCount;
908 __le32 MaxParameterCount;
910 __le32 ParameterCount;
911 __le32 ParameterOffset;
914 __u8 SetupCount; /* four setup words follow subcommand */
915 /* SNIA spec incorrectly included spurious pad here */
916 __le16 SubCommand;/* 2 = IOCTL/FSCTL */
919 __u8 IsFsctl; /* 1 = File System Control, 0 = device control (IOCTL)*/
920 __u8 IsRootFlag; /* 1 = apply command to root of share (must be DFS share)*/
924 } TRANSACT_IOCTL_REQ;
926 typedef struct smb_com_transaction_ioctl_rsp {
927 struct smb_hdr hdr; /* wct = 19 */
929 __le32 TotalParameterCount;
930 __le32 TotalDataCount;
931 __le32 ParameterCount;
932 __le32 ParameterOffset;
933 __le32 ParameterDisplacement;
936 __le32 DataDisplacement;
937 __u8 SetupCount; /* 1 */
938 __le16 ReturnedDataLen;
941 } TRANSACT_IOCTL_RSP;
943 typedef struct smb_com_transaction_change_notify_req {
944 struct smb_hdr hdr; /* wct = 23 */
947 __le32 TotalParameterCount;
948 __le32 TotalDataCount;
949 __le32 MaxParameterCount;
951 __le32 ParameterCount;
952 __le32 ParameterOffset;
955 __u8 SetupCount; /* four setup words follow subcommand */
956 /* SNIA spec incorrectly included spurious pad here */
957 __le16 SubCommand;/* 4 = Change Notify */
958 __le32 CompletionFilter; /* operation to monitor */
960 __u8 WatchTree; /* 1 = Monitor subdirectories */
965 } TRANSACT_CHANGE_NOTIFY_REQ;
967 typedef struct smb_com_transaction_change_notify_rsp {
968 struct smb_hdr hdr; /* wct = 18 */
970 __le32 TotalParameterCount;
971 __le32 TotalDataCount;
972 __le32 ParameterCount;
973 __le32 ParameterOffset;
974 __le32 ParameterDisplacement;
977 __le32 DataDisplacement;
978 __u8 SetupCount; /* 0 */
981 } TRANSACT_CHANGE_NOTIFY_RSP;
982 /* Completion Filter flags for Notify */
983 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x00000001
984 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x00000002
985 #define FILE_NOTIFY_CHANGE_NAME 0x00000003
986 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x00000004
987 #define FILE_NOTIFY_CHANGE_SIZE 0x00000008
988 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x00000010
989 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x00000020
990 #define FILE_NOTIFY_CHANGE_CREATION 0x00000040
991 #define FILE_NOTIFY_CHANGE_EA 0x00000080
992 #define FILE_NOTIFY_CHANGE_SECURITY 0x00000100
993 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
994 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
995 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
997 #define FILE_ACTION_ADDED 0x00000001
998 #define FILE_ACTION_REMOVED 0x00000002
999 #define FILE_ACTION_MODIFIED 0x00000003
1000 #define FILE_ACTION_RENAMED_OLD_NAME 0x00000004
1001 #define FILE_ACTION_RENAMED_NEW_NAME 0x00000005
1002 #define FILE_ACTION_ADDED_STREAM 0x00000006
1003 #define FILE_ACTION_REMOVED_STREAM 0x00000007
1004 #define FILE_ACTION_MODIFIED_STREAM 0x00000008
1006 /* response contains array of the following structures */
1007 struct file_notify_information {
1008 __le32 NextEntryOffset;
1010 __le32 FileNameLength;
1014 struct reparse_data {
1016 __u16 ReparseDataLength;
1018 __u16 AltNameOffset;
1020 __u16 TargetNameOffset;
1021 __u16 TargetNameLen;
1022 char LinkNamesBuf[1];
1025 struct cifs_quota_data {
1026 __u32 rsrvd1; /* 0 */
1028 __u64 rsrvd2; /* 0 */
1032 char sid[1]; /* variable size? */
1035 /* quota sub commands */
1036 #define QUOTA_LIST_CONTINUE 0
1037 #define QUOTA_LIST_START 0x100
1038 #define QUOTA_FOR_SID 0x101
1041 /* struct smb_hdr hdr precedes. Set wct = 14+ */
1042 __le16 TotalParameterCount;
1043 __le16 TotalDataCount;
1044 __le16 MaxParameterCount;
1045 __le16 MaxDataCount;
1051 __le16 ParameterCount;
1052 __le16 ParameterOffset;
1057 __le16 SubCommand; /* 1st setup word - SetupCount words follow */
1063 struct trans2_req t2_req;
1066 struct trans2_resp {
1067 /* struct smb_hdr hdr precedes. Note wct = 10 + setup count */
1068 __le16 TotalParameterCount;
1069 __le16 TotalDataCount;
1071 __le16 ParameterCount;
1072 __le16 ParameterOffset;
1073 __le16 ParameterDisplacement;
1076 __le16 DataDisplacement;
1079 /* SetupWords[SetupCount];
1082 /* data area follows */
1087 struct trans2_resp t2_rsp;
1090 /* PathInfo/FileInfo infolevels */
1091 #define SMB_INFO_STANDARD 1
1092 #define SMB_SET_FILE_EA 2
1093 #define SMB_QUERY_FILE_EA_SIZE 2
1094 #define SMB_INFO_QUERY_EAS_FROM_LIST 3
1095 #define SMB_INFO_QUERY_ALL_EAS 4
1096 #define SMB_INFO_IS_NAME_VALID 6
1097 #define SMB_QUERY_FILE_BASIC_INFO 0x101
1098 #define SMB_QUERY_FILE_STANDARD_INFO 0x102
1099 #define SMB_QUERY_FILE_EA_INFO 0x103
1100 #define SMB_QUERY_FILE_NAME_INFO 0x104
1101 #define SMB_QUERY_FILE_ALLOCATION_INFO 0x105
1102 #define SMB_QUERY_FILE_END_OF_FILEINFO 0x106
1103 #define SMB_QUERY_FILE_ALL_INFO 0x107
1104 #define SMB_QUERY_ALT_NAME_INFO 0x108
1105 #define SMB_QUERY_FILE_STREAM_INFO 0x109
1106 #define SMB_QUERY_FILE_COMPRESSION_INFO 0x10B
1107 #define SMB_QUERY_FILE_UNIX_BASIC 0x200
1108 #define SMB_QUERY_FILE_UNIX_LINK 0x201
1109 #define SMB_QUERY_POSIX_ACL 0x204
1110 #define SMB_QUERY_XATTR 0x205
1111 #define SMB_QUERY_ATTR_FLAGS 0x206 /* append,immutable etc. */
1112 #define SMB_QUERY_POSIX_PERMISSION 0x207
1113 #define SMB_QUERY_POSIX_LOCK 0x208
1114 #define SMB_QUERY_FILE_INTERNAL_INFO 0x3ee
1115 #define SMB_QUERY_FILE_ACCESS_INFO 0x3f0
1116 #define SMB_QUERY_FILE_NAME_INFO2 0x3f1 /* 0x30 bytes */
1117 #define SMB_QUERY_FILE_POSITION_INFO 0x3f6
1118 #define SMB_QUERY_FILE_MODE_INFO 0x3f8
1119 #define SMB_QUERY_FILE_ALGN_INFO 0x3f9
1122 #define SMB_SET_FILE_BASIC_INFO 0x101
1123 #define SMB_SET_FILE_DISPOSITION_INFO 0x102
1124 #define SMB_SET_FILE_ALLOCATION_INFO 0x103
1125 #define SMB_SET_FILE_END_OF_FILE_INFO 0x104
1126 #define SMB_SET_FILE_UNIX_BASIC 0x200
1127 #define SMB_SET_FILE_UNIX_LINK 0x201
1128 #define SMB_SET_FILE_UNIX_HLINK 0x203
1129 #define SMB_SET_POSIX_ACL 0x204
1130 #define SMB_SET_XATTR 0x205
1131 #define SMB_SET_ATTR_FLAGS 0x206 /* append, immutable etc. */
1132 #define SMB_SET_POSIX_LOCK 0x208
1133 #define SMB_SET_FILE_BASIC_INFO2 0x3ec
1134 #define SMB_SET_FILE_RENAME_INFORMATION 0x3f2 /* BB check if qpathinfo level too */
1135 #define SMB_FILE_ALL_INFO2 0x3fa
1136 #define SMB_SET_FILE_ALLOCATION_INFO2 0x3fb
1137 #define SMB_SET_FILE_END_OF_FILE_INFO2 0x3fc
1138 #define SMB_FILE_MOVE_CLUSTER_INFO 0x407
1139 #define SMB_FILE_QUOTA_INFO 0x408
1140 #define SMB_FILE_REPARSEPOINT_INFO 0x409
1141 #define SMB_FILE_MAXIMUM_INFO 0x40d
1143 /* Find File infolevels */
1144 #define SMB_FIND_FILE_DIRECTORY_INFO 0x101
1145 #define SMB_FIND_FILE_FULL_DIRECTORY_INFO 0x102
1146 #define SMB_FIND_FILE_NAMES_INFO 0x103
1147 #define SMB_FIND_FILE_BOTH_DIRECTORY_INFO 0x104
1148 #define SMB_FIND_FILE_ID_FULL_DIR_INFO 0x105
1149 #define SMB_FIND_FILE_ID_BOTH_DIR_INFO 0x106
1150 #define SMB_FIND_FILE_UNIX 0x202
1152 typedef struct smb_com_transaction2_qpi_req {
1153 struct smb_hdr hdr; /* wct = 14+ */
1154 __le16 TotalParameterCount;
1155 __le16 TotalDataCount;
1156 __le16 MaxParameterCount;
1157 __le16 MaxDataCount;
1163 __le16 ParameterCount;
1164 __le16 ParameterOffset;
1169 __le16 SubCommand; /* one setup word */
1172 __le16 InformationLevel;
1175 } TRANSACTION2_QPI_REQ;
1177 typedef struct smb_com_transaction2_qpi_rsp {
1178 struct smb_hdr hdr; /* wct = 10 + SetupCount */
1179 struct trans2_resp t2;
1181 __u16 Reserved2; /* parameter word reserved - present for infolevels > 100 */
1182 } TRANSACTION2_QPI_RSP;
1184 typedef struct smb_com_transaction2_spi_req {
1185 struct smb_hdr hdr; /* wct = 15 */
1186 __le16 TotalParameterCount;
1187 __le16 TotalDataCount;
1188 __le16 MaxParameterCount;
1189 __le16 MaxDataCount;
1195 __le16 ParameterCount;
1196 __le16 ParameterOffset;
1201 __le16 SubCommand; /* one setup word */
1205 __le16 InformationLevel;
1208 } TRANSACTION2_SPI_REQ;
1210 typedef struct smb_com_transaction2_spi_rsp {
1211 struct smb_hdr hdr; /* wct = 10 + SetupCount */
1212 struct trans2_resp t2;
1214 __u16 Reserved2; /* parameter word reserved - present for infolevels > 100 */
1215 } TRANSACTION2_SPI_RSP;
1217 struct set_file_rename {
1218 __le32 overwrite; /* 1 = overwrite dest */
1219 __u32 root_fid; /* zero */
1220 __le32 target_name_len;
1221 char target_name[0]; /* Must be unicode */
1224 struct smb_com_transaction2_sfi_req {
1225 struct smb_hdr hdr; /* wct = 15 */
1226 __le16 TotalParameterCount;
1227 __le16 TotalDataCount;
1228 __le16 MaxParameterCount;
1229 __le16 MaxDataCount;
1235 __le16 ParameterCount;
1236 __le16 ParameterOffset;
1241 __le16 SubCommand; /* one setup word */
1246 __le16 InformationLevel;
1250 struct smb_com_transaction2_sfi_rsp {
1251 struct smb_hdr hdr; /* wct = 10 + SetupCount */
1252 struct trans2_resp t2;
1254 __u16 Reserved2; /* parameter word reserved -
1255 present for infolevels > 100 */
1258 struct smb_t2_qfi_req {
1260 struct trans2_req t2;
1263 __le16 InformationLevel;
1266 struct smb_t2_qfi_rsp {
1267 struct smb_hdr hdr; /* wct = 10 + SetupCount */
1268 struct trans2_resp t2;
1270 __u16 Reserved2; /* parameter word reserved -
1271 present for infolevels > 100 */
1275 * Flags on T2 FINDFIRST and FINDNEXT
1277 #define CIFS_SEARCH_CLOSE_ALWAYS 0x0001
1278 #define CIFS_SEARCH_CLOSE_AT_END 0x0002
1279 #define CIFS_SEARCH_RETURN_RESUME 0x0004
1280 #define CIFS_SEARCH_CONTINUE_FROM_LAST 0x0008
1281 #define CIFS_SEARCH_BACKUP_SEARCH 0x0010
1284 * Size of the resume key on FINDFIRST and FINDNEXT calls
1286 #define CIFS_SMB_RESUME_KEY_SIZE 4
1288 typedef struct smb_com_transaction2_ffirst_req {
1289 struct smb_hdr hdr; /* wct = 15 */
1290 __le16 TotalParameterCount;
1291 __le16 TotalDataCount;
1292 __le16 MaxParameterCount;
1293 __le16 MaxDataCount;
1299 __le16 ParameterCount;
1300 __le16 ParameterOffset;
1303 __u8 SetupCount; /* one */
1305 __le16 SubCommand; /* TRANS2_FIND_FIRST */
1308 __le16 SearchAttributes;
1311 __le16 InformationLevel;
1312 __le32 SearchStorageType;
1314 } TRANSACTION2_FFIRST_REQ;
1316 typedef struct smb_com_transaction2_ffirst_rsp {
1317 struct smb_hdr hdr; /* wct = 10 */
1318 struct trans2_resp t2;
1320 } TRANSACTION2_FFIRST_RSP;
1322 typedef struct smb_com_transaction2_ffirst_rsp_parms {
1326 __le16 EAErrorOffset;
1327 __le16 LastNameOffset;
1328 } T2_FFIRST_RSP_PARMS;
1330 typedef struct smb_com_transaction2_fnext_req {
1331 struct smb_hdr hdr; /* wct = 15 */
1332 __le16 TotalParameterCount;
1333 __le16 TotalDataCount;
1334 __le16 MaxParameterCount;
1335 __le16 MaxDataCount;
1341 __le16 ParameterCount;
1342 __le16 ParameterOffset;
1345 __u8 SetupCount; /* one */
1347 __le16 SubCommand; /* TRANS2_FIND_NEXT */
1352 __le16 InformationLevel;
1355 char ResumeFileName[1];
1356 } TRANSACTION2_FNEXT_REQ;
1358 typedef struct smb_com_transaction2_fnext_rsp {
1359 struct smb_hdr hdr; /* wct = 10 */
1360 struct trans2_resp t2;
1362 } TRANSACTION2_FNEXT_RSP;
1364 typedef struct smb_com_transaction2_fnext_rsp_parms {
1367 __le16 EAErrorOffset;
1368 __le16 LastNameOffset;
1369 } T2_FNEXT_RSP_PARMS;
1371 /* QFSInfo Levels */
1372 #define SMB_INFO_ALLOCATION 1
1373 #define SMB_INFO_VOLUME 2
1374 #define SMB_QUERY_FS_VOLUME_INFO 0x102
1375 #define SMB_QUERY_FS_SIZE_INFO 0x103
1376 #define SMB_QUERY_FS_DEVICE_INFO 0x104
1377 #define SMB_QUERY_FS_ATTRIBUTE_INFO 0x105
1378 #define SMB_QUERY_CIFS_UNIX_INFO 0x200
1379 #define SMB_QUERY_POSIX_FS_INFO 0x201
1380 #define SMB_QUERY_LABEL_INFO 0x3ea
1381 #define SMB_QUERY_FS_QUOTA_INFO 0x3ee
1382 #define SMB_QUERY_FS_FULL_SIZE_INFO 0x3ef
1383 #define SMB_QUERY_OBJECTID_INFO 0x3f0
1385 typedef struct smb_com_transaction2_qfsi_req {
1386 struct smb_hdr hdr; /* wct = 14+ */
1387 __le16 TotalParameterCount;
1388 __le16 TotalDataCount;
1389 __le16 MaxParameterCount;
1390 __le16 MaxDataCount;
1396 __le16 ParameterCount;
1397 __le16 ParameterOffset;
1402 __le16 SubCommand; /* one setup word */
1405 __le16 InformationLevel;
1406 } TRANSACTION2_QFSI_REQ;
1408 typedef struct smb_com_transaction_qfsi_rsp {
1409 struct smb_hdr hdr; /* wct = 10 + SetupCount */
1410 struct trans2_resp t2;
1412 __u8 Pad; /* may be three bytes *//* followed by data area */
1413 } TRANSACTION2_QFSI_RSP;
1416 /* SETFSInfo Levels */
1417 #define SMB_SET_CIFS_UNIX_INFO 0x200
1418 typedef struct smb_com_transaction2_setfsi_req {
1419 struct smb_hdr hdr; /* wct = 15 */
1420 __le16 TotalParameterCount;
1421 __le16 TotalDataCount;
1422 __le16 MaxParameterCount;
1423 __le16 MaxDataCount;
1429 __le16 ParameterCount; /* 4 */
1430 __le16 ParameterOffset;
1431 __le16 DataCount; /* 12 */
1433 __u8 SetupCount; /* one */
1435 __le16 SubCommand; /* TRANS2_SET_FS_INFORMATION */
1438 __u16 FileNum; /* Parameters start. */
1439 __le16 InformationLevel;/* Parameters end. */
1440 __le16 ClientUnixMajor; /* Data start. */
1441 __le16 ClientUnixMinor;
1442 __le64 ClientUnixCap; /* Data end */
1443 } TRANSACTION2_SETFSI_REQ;
1445 typedef struct smb_com_transaction2_setfsi_rsp {
1446 struct smb_hdr hdr; /* wct = 10 */
1447 struct trans2_resp t2;
1449 } TRANSACTION2_SETFSI_RSP;
1452 typedef struct smb_com_transaction2_get_dfs_refer_req {
1453 struct smb_hdr hdr; /* wct = 15 */
1454 __le16 TotalParameterCount;
1455 __le16 TotalDataCount;
1456 __le16 MaxParameterCount;
1457 __le16 MaxDataCount;
1463 __le16 ParameterCount;
1464 __le16 ParameterOffset;
1469 __le16 SubCommand; /* one setup word */
1471 __u8 Pad[3]; /* Win2K has sent 0x0F01 (max resp length perhaps?) followed by one byte pad - doesn't seem to matter though */
1472 __le16 MaxReferralLevel;
1473 char RequestFileName[1];
1474 } TRANSACTION2_GET_DFS_REFER_REQ;
1476 typedef struct dfs_referral_level_3 {
1477 __le16 VersionNumber;
1478 __le16 ReferralSize;
1479 __le16 ServerType; /* 0x0001 = CIFS server */
1480 __le16 ReferralFlags; /* or proximity - not clear which since always set to zero - SNIA spec says 0x01 means strip off PathConsumed chars before submitting RequestFileName to remote node */
1483 __le16 DfsPathOffset;
1484 __le16 DfsAlternatePathOffset;
1485 __le16 NetworkAddressOffset;
1488 typedef struct smb_com_transaction_get_dfs_refer_rsp {
1489 struct smb_hdr hdr; /* wct = 10 */
1490 struct trans2_resp t2;
1493 __le16 PathConsumed;
1494 __le16 NumberOfReferrals;
1497 REFERRAL3 referrals[1]; /* array of level 3 dfs_referral structures */
1498 /* followed by the strings pointed to by the referral structures */
1499 } TRANSACTION2_GET_DFS_REFER_RSP;
1502 #define DFSREF_REFERRAL_SERVER 0x0001
1503 #define DFSREF_STORAGE_SERVER 0x0002
1505 /* IOCTL information */
1506 /* List of ioctl function codes that look to be of interest to remote clients like this. */
1507 /* Need to do some experimentation to make sure they all work remotely. */
1508 /* Some of the following such as the encryption/compression ones would be */
1509 /* invoked from tools via a specialized hook into the VFS rather than via the */
1510 /* standard vfs entry points */
1511 #define FSCTL_REQUEST_OPLOCK_LEVEL_1 0x00090000
1512 #define FSCTL_REQUEST_OPLOCK_LEVEL_2 0x00090004
1513 #define FSCTL_REQUEST_BATCH_OPLOCK 0x00090008
1514 #define FSCTL_LOCK_VOLUME 0x00090018
1515 #define FSCTL_UNLOCK_VOLUME 0x0009001C
1516 #define FSCTL_GET_COMPRESSION 0x0009003C
1517 #define FSCTL_SET_COMPRESSION 0x0009C040
1518 #define FSCTL_REQUEST_FILTER_OPLOCK 0x0009008C
1519 #define FSCTL_FILESYS_GET_STATISTICS 0x00090090
1520 #define FSCTL_SET_REPARSE_POINT 0x000900A4
1521 #define FSCTL_GET_REPARSE_POINT 0x000900A8
1522 #define FSCTL_DELETE_REPARSE_POINT 0x000900AC
1523 #define FSCTL_SET_SPARSE 0x000900C4
1524 #define FSCTL_SET_ZERO_DATA 0x000900C8
1525 #define FSCTL_SET_ENCRYPTION 0x000900D7
1526 #define FSCTL_ENCRYPTION_FSCTL_IO 0x000900DB
1527 #define FSCTL_WRITE_RAW_ENCRYPTED 0x000900DF
1528 #define FSCTL_READ_RAW_ENCRYPTED 0x000900E3
1529 #define FSCTL_SIS_COPYFILE 0x00090100
1530 #define FSCTL_SIS_LINK_FILES 0x0009C104
1532 #define IO_REPARSE_TAG_MOUNT_POINT 0xA0000003
1533 #define IO_REPARSE_TAG_HSM 0xC0000004
1534 #define IO_REPARSE_TAG_SIS 0x80000007
1537 ************************************************************************
1538 * All structs for everything above the SMB PDUs themselves
1539 * (such as the T2 level specific data) go here
1540 ************************************************************************
1544 * Information on a server
1549 unsigned char versionMajor;
1550 unsigned char versionMinor;
1552 unsigned int commentOffset;
1556 * The following structure is the format of the data returned on a NetShareEnum
1557 * with level "90" (x5A)
1563 unsigned short type;
1564 unsigned int commentOffset;
1570 unsigned int commentOffset;
1571 unsigned char type[2];
1574 struct aliasInfo92 {
1575 int aliasNameOffset;
1576 int serverNameOffset;
1577 int shareNameOffset;
1581 __le64 TotalAllocationUnits;
1582 __le64 FreeAllocationUnits;
1583 __le32 SectorsPerAllocationUnit;
1584 __le32 BytesPerSector;
1585 } FILE_SYSTEM_INFO; /* size info, level 0x103 */
1588 __le16 MajorVersionNumber;
1589 __le16 MinorVersionNumber;
1591 } FILE_SYSTEM_UNIX_INFO; /* Unix extensions info, level 0x200 */
1593 /* Version numbers for CIFS UNIX major and minor. */
1594 #define CIFS_UNIX_MAJOR_VERSION 1
1595 #define CIFS_UNIX_MINOR_VERSION 0
1597 /* Linux/Unix extensions capability flags */
1598 #define CIFS_UNIX_FCNTL_CAP 0x00000001 /* support for fcntl locks */
1599 #define CIFS_UNIX_POSIX_ACL_CAP 0x00000002 /* support getfacl/setfacl */
1600 #define CIFS_UNIX_XATTR_CAP 0x00000004 /* support new namespace */
1601 #define CIFS_UNIX_EXTATTR_CAP 0x00000008 /* support chattr/chflag */
1602 #define CIFS_UNIX_POSIX_PATHNAMES_CAP 0x00000010 /* Use POSIX pathnames on the wire. */
1604 #define CIFS_POSIX_EXTENSIONS 0x00000010 /* support for new QFSInfo */
1607 /* For undefined recommended transfer size return -1 in that field */
1608 __le32 OptimalTransferSize; /* bsize on some os, iosize on other os */
1610 /* The next three fields are in terms of the block size.
1611 (above). If block size is unknown, 4096 would be a
1612 reasonable block size for a server to report.
1613 Note that returning the blocks/blocksavail removes need
1614 to make a second call (to QFSInfo level 0x103 to get this info.
1615 UserBlockAvail is typically less than or equal to BlocksAvail,
1616 if no distinction is made return the same value in each */
1618 __le64 BlocksAvail; /* bfree */
1619 __le64 UserBlocksAvail; /* bavail */
1620 /* For undefined Node fields or FSID return -1 */
1621 __le64 TotalFileNodes;
1622 __le64 FreeFileNodes;
1623 __le64 FileSysIdentifier; /* fsid */
1624 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1625 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1626 } FILE_SYSTEM_POSIX_INFO;
1628 /* DeviceType Flags */
1629 #define FILE_DEVICE_CD_ROM 0x00000002
1630 #define FILE_DEVICE_CD_ROM_FILE_SYSTEM 0x00000003
1631 #define FILE_DEVICE_DFS 0x00000006
1632 #define FILE_DEVICE_DISK 0x00000007
1633 #define FILE_DEVICE_DISK_FILE_SYSTEM 0x00000008
1634 #define FILE_DEVICE_FILE_SYSTEM 0x00000009
1635 #define FILE_DEVICE_NAMED_PIPE 0x00000011
1636 #define FILE_DEVICE_NETWORK 0x00000012
1637 #define FILE_DEVICE_NETWORK_FILE_SYSTEM 0x00000014
1638 #define FILE_DEVICE_NULL 0x00000015
1639 #define FILE_DEVICE_PARALLEL_PORT 0x00000016
1640 #define FILE_DEVICE_PRINTER 0x00000018
1641 #define FILE_DEVICE_SERIAL_PORT 0x0000001b
1642 #define FILE_DEVICE_STREAMS 0x0000001e
1643 #define FILE_DEVICE_TAPE 0x0000001f
1644 #define FILE_DEVICE_TAPE_FILE_SYSTEM 0x00000020
1645 #define FILE_DEVICE_VIRTUAL_DISK 0x00000024
1646 #define FILE_DEVICE_NETWORK_REDIRECTOR 0x00000028
1650 __le32 DeviceCharacteristics;
1651 } FILE_SYSTEM_DEVICE_INFO; /* device info, level 0x104 */
1655 __le32 MaxPathNameComponentLength;
1656 __le32 FileSystemNameLen;
1657 char FileSystemName[52]; /* do not really need to save this - so potentially get only subset of name */
1658 } FILE_SYSTEM_ATTRIBUTE_INFO;
1660 /******************************************************************************/
1661 /* QueryFileInfo/QueryPathinfo (also for SetPath/SetFile) data buffer formats */
1662 /******************************************************************************/
1663 typedef struct { /* data block encoding of response to level 263 QPathInfo */
1664 __le64 CreationTime;
1665 __le64 LastAccessTime;
1666 __le64 LastWriteTime;
1670 __le64 AllocationSize;
1671 __le64 EndOfFile; /* size ie offset to first free byte in file */
1672 __le32 NumberOfLinks; /* hard links */
1680 __le64 CurrentByteOffset;
1682 __le32 AlignmentRequirement;
1683 __le32 FileNameLength;
1685 } FILE_ALL_INFO; /* level 0x107 QPathInfo */
1687 /* defines for enumerating possible values of the Unix type field below */
1690 #define UNIX_SYMLINK 2
1691 #define UNIX_CHARDEV 3
1692 #define UNIX_BLOCKDEV 4
1694 #define UNIX_SOCKET 6
1698 __le64 LastStatusChange; /*SNIA specs DCE time for the 3 time fields */
1699 __le64 LastAccessTime;
1700 __le64 LastModificationTime;
1709 } FILE_UNIX_BASIC_INFO; /* level 0x200 QPathInfo */
1713 } FILE_UNIX_LINK_INFO; /* level 0x201 QPathInfo */
1715 /* The following three structures are needed only for
1716 setting time to NT4 and some older servers via
1717 the primitive DOS time format */
1731 __le16 CreationDate; /* SMB Date see above */
1732 __le16 CreationTime; /* SMB Time */
1733 __le16 LastAccessDate;
1734 __le16 LastAccessTime;
1735 __le16 LastWriteDate;
1736 __le16 LastWriteTime;
1737 __le32 DataSize; /* File Size (EOF) */
1738 __le32 AllocationSize;
1739 __le16 Attributes; /* verify not u32 */
1741 } FILE_INFO_STANDARD; /* level 1 SetPath/FileInfo */
1744 __le64 CreationTime;
1745 __le64 LastAccessTime;
1746 __le64 LastWriteTime;
1750 } FILE_BASIC_INFO; /* size info, level 0x101 */
1752 struct file_allocation_info {
1753 __le64 AllocationSize; /* Note old Samba srvr rounds this up too much */
1754 }; /* size used on disk, level 0x103 for set, 0x105 for query */
1756 struct file_end_of_file_info {
1757 __le64 FileSize; /* offset to end of file */
1758 }; /* size info, level 0x104 for set, 0x106 for query */
1760 struct file_alt_name_info {
1762 }; /* level 0x0108 */
1764 struct file_stream_info {
1765 __le32 number_of_streams; /* BB check sizes and verify location */
1766 /* followed by info on streams themselves
1770 }; /* level 0x109 */
1772 struct file_compression_info {
1773 __le64 compressed_size;
1779 }; /* level 0x10b */
1781 /* POSIX ACL set/query path info structures */
1782 #define CIFS_ACL_VERSION 1
1783 struct cifs_posix_ace { /* access control entry (ACE) */
1786 __le64 cifs_uid; /* or gid */
1789 struct cifs_posix_acl { /* access conrol list (ACL) */
1791 __le16 access_entry_count; /* access ACL - count of entries */
1792 __le16 default_entry_count; /* default ACL - count of entries */
1793 struct cifs_posix_ace ace_array[0];
1795 struct cifs_posix_ace default_ace_arraay[] */
1796 }; /* level 0x204 */
1798 /* types of access control entries already defined in posix_acl.h */
1799 /* #define CIFS_POSIX_ACL_USER_OBJ 0x01
1800 #define CIFS_POSIX_ACL_USER 0x02
1801 #define CIFS_POSIX_ACL_GROUP_OBJ 0x04
1802 #define CIFS_POSIX_ACL_GROUP 0x08
1803 #define CIFS_POSIX_ACL_MASK 0x10
1804 #define CIFS_POSIX_ACL_OTHER 0x20 */
1806 /* types of perms */
1807 /* #define CIFS_POSIX_ACL_EXECUTE 0x01
1808 #define CIFS_POSIX_ACL_WRITE 0x02
1809 #define CIFS_POSIX_ACL_READ 0x04 */
1811 /* end of POSIX ACL definitions */
1813 struct file_internal_info {
1814 __u64 UniqueId; /* inode number */
1815 }; /* level 0x3ee */
1816 struct file_mode_info {
1818 }; /* level 0x3f8 */
1820 struct file_attrib_tag {
1823 }; /* level 0x40b */
1826 /********************************************************/
1827 /* FindFirst/FindNext transact2 data buffer formats */
1828 /********************************************************/
1831 __le32 NextEntryOffset;
1832 __u32 ResumeKey; /* as with FileIndex - no need to convert */
1835 __le64 LastStatusChange; /*SNIA specs DCE time for the 3 time fields */
1836 __le64 LastAccessTime;
1837 __le64 LastModificationTime;
1847 } FILE_UNIX_INFO; /* level 0x202 */
1850 __le32 NextEntryOffset;
1852 __le64 CreationTime;
1853 __le64 LastAccessTime;
1854 __le64 LastWriteTime;
1857 __le64 AllocationSize;
1858 __le32 ExtFileAttributes;
1859 __le32 FileNameLength;
1861 } FILE_DIRECTORY_INFO; /* level 0x101 FF response data area */
1864 __le32 NextEntryOffset;
1866 __le64 CreationTime;
1867 __le64 LastAccessTime;
1868 __le64 LastWriteTime;
1871 __le64 AllocationSize;
1872 __le32 ExtFileAttributes;
1873 __le32 FileNameLength;
1874 __le32 EaSize; /* length of the xattrs */
1876 } FILE_FULL_DIRECTORY_INFO; /* level 0x102 FF response data area */
1879 __le32 NextEntryOffset;
1881 __le64 CreationTime;
1882 __le64 LastAccessTime;
1883 __le64 LastWriteTime;
1886 __le64 AllocationSize;
1887 __le32 ExtFileAttributes;
1888 __le32 FileNameLength;
1889 __le32 EaSize; /* EA size */
1891 __u64 UniqueId; /* inode num - le since Samba puts ino in low 32 bit*/
1893 } SEARCH_ID_FULL_DIR_INFO; /* level 0x105 FF response data area */
1896 __le32 NextEntryOffset;
1898 __le64 CreationTime;
1899 __le64 LastAccessTime;
1900 __le64 LastWriteTime;
1903 __le64 AllocationSize;
1904 __le32 ExtFileAttributes;
1905 __le32 FileNameLength;
1906 __le32 EaSize; /* length of the xattrs */
1907 __u8 ShortNameLength;
1911 } FILE_BOTH_DIRECTORY_INFO; /* level 0x104 FF response data area */
1915 unsigned char name_len;
1920 unsigned long list_len;
1925 unsigned char EA_flags;
1929 /* optionally followed by value */
1931 /* flags for _FEA.fEA */
1932 #define FEA_NEEDEA 0x80 /* need EA bit */
1939 /* used to hold an arbitrary blob of data */
1943 void (*free) (struct data_blob * data_blob);
1947 #ifdef CONFIG_CIFS_POSIX
1949 For better POSIX semantics from Linux client, (even better
1950 than the existing CIFS Unix Extensions) we need updated PDUs for:
1952 1) PosixCreateX - to set and return the mode, inode#, device info and
1953 perhaps add a CreateDevice - to create Pipes and other special .inodes
1954 Also note POSIX open flags
1955 2) Close - to return the last write time to do cache across close more safely
1956 3) PosixQFSInfo - to return statfs info
1957 4) FindFirst return unique inode number - what about resume key, two forms short (matches readdir) and full (enough info to cache inodes)
1960 And under consideration:
1961 6) FindClose2 (return nanosecond timestamp ??)
1962 7) Use nanosecond timestamps throughout all time fields if
1963 corresponding attribute flag is set
1964 8) sendfile - handle based copy
1966 10) "POSIX ACL" support
1969 what about fixing 64 bit alignment
1971 There are also various legacy SMB/CIFS requests used as is
1973 From existing Lanman and NTLM dialects:
1974 --------------------------------------
1976 SESSION_SETUP_ANDX (BB which?)
1977 TREE_CONNECT_ANDX (BB which wct?)
1978 TREE_DISCONNECT (BB add volume timestamp on response)
1980 DELETE (note delete open file behavior)
1984 LOCKING_AND_X (note posix lock semantics)
1985 RENAME (note rename across dirs and open file rename posix behaviors)
1986 NT_RENAME (for hardlinks) Is this good enough for all features?
1988 TRANSACTION2 (18 cases)
1989 SMB_SET_FILE_END_OF_FILE_INFO2 SMB_SET_PATH_END_OF_FILE_INFO2
1990 (BB verify that never need to set allocation size)
1991 SMB_SET_FILE_BASIC_INFO2 (setting times - BB can it be done via Unix ext?)
1993 COPY (note support for copy across directories) - FUTURE, OPTIONAL
1994 setting/getting OS/2 EAs - FUTURE (BB can this handle
1995 setting Linux xattrs perfectly) - OPTIONAL
1996 dnotify - FUTURE, OPTIONAL
1997 quota - FUTURE, OPTIONAL
1999 Note that various requests implemented for NT interop such as
2000 NT_TRANSACT (IOCTL) QueryReparseInfo
2001 are unneeded to servers compliant with the CIFS POSIX extensions
2003 From CIFS Unix Extensions:
2004 -------------------------
2005 T2 SET_PATH_INFO (SMB_SET_FILE_UNIX_LINK) for symlinks
2006 T2 SET_PATH_INFO (SMB_SET_FILE_BASIC_INFO2)
2007 T2 QUERY_PATH_INFO (SMB_QUERY_FILE_UNIX_LINK)
2008 T2 QUERY_PATH_INFO (SMB_QUERY_FILE_UNIX_BASIC) - BB check for missing inode fields
2009 Actually need QUERY_FILE_UNIX_INFO since has inode num
2010 BB what about a) blksize/blkbits/blocks
2016 T2 FIND_FIRST/FIND_NEXT FIND_FILE_UNIX
2017 TRANS2_GET_DFS_REFERRAL - OPTIONAL but recommended
2018 T2_QFS_INFO QueryDevice/AttributeInfo - OPTIONAL
2023 /* xsymlink is a symlink format that can be used
2024 to save symlink info in a regular file when
2025 mounted to operating systems that do not
2026 support the cifs Unix extensions or EAs (for xattr
2027 based symlinks). For such a file to be recognized
2028 as containing symlink data:
2030 1) file size must be 1067,
2031 2) signature must begin file data,
2032 3) length field must be set to ASCII representation
2033 of a number which is less than or equal to 1024,
2034 4) md5 must match that of the path data */
2038 char signature[4]; /* XSym */ /* not null terminated */
2040 /* ASCII representation of length (4 bytes decimal) terminated by \n not null */
2043 /* md5 of valid subset of path ie path[0] through path[length-1] */
2046 /* if room left, then end with \n then 0x20s by convention but not required */
2050 typedef struct file_xattr_info {
2051 /* BB do we need another field for flags? BB */
2052 __u32 xattr_name_len;
2053 __u32 xattr_value_len;
2055 /* followed by xattr_value[xattr_value_len], no pad */
2056 } FILE_XATTR_INFO; /* extended attribute, info level 0x205 */
2059 /* flags for chattr command */
2060 #define EXT_SECURE_DELETE 0x00000001 /* EXT3_SECRM_FL */
2061 #define EXT_ENABLE_UNDELETE 0x00000002 /* EXT3_UNRM_FL */
2062 /* Reserved for compress file 0x4 */
2063 #define EXT_SYNCHRONOUS 0x00000008 /* EXT3_SYNC_FL */
2064 #define EXT_IMMUTABLE_FL 0x00000010 /* EXT3_IMMUTABLE_FL */
2065 #define EXT_OPEN_APPEND_ONLY 0x00000020 /* EXT3_APPEND_FL */
2066 #define EXT_DO_NOT_BACKUP 0x00000040 /* EXT3_NODUMP_FL */
2067 #define EXT_NO_UPDATE_ATIME 0x00000080 /* EXT3_NOATIME_FL */
2068 /* 0x100 through 0x800 reserved for compression flags and are GET-ONLY */
2069 #define EXT_HASH_TREE_INDEXED_DIR 0x00001000 /* GET-ONLY EXT3_INDEX_FL */
2070 /* 0x2000 reserved for IMAGIC_FL */
2071 #define EXT_JOURNAL_THIS_FILE 0x00004000 /* GET-ONLY EXT3_JOURNAL_DATA_FL */
2072 /* 0x8000 reserved for EXT3_NOTAIL_FL */
2073 #define EXT_SYNCHRONOUS_DIR 0x00010000 /* EXT3_DIRSYNC_FL */
2074 #define EXT_TOPDIR 0x00020000 /* EXT3_TOPDIR_FL */
2076 #define EXT_SET_MASK 0x000300FF
2077 #define EXT_GET_MASK 0x0003DFFF
2079 typedef struct file_chattr_info {
2080 __le64 mask; /* list of all possible attribute bits */
2081 __le64 mode; /* list of actual attribute bits on this inode */
2082 } FILE_CHATTR_INFO; /* ext attributes (chattr, chflags) level 0x206 */
2086 #pragma pack() /* resume default structure packing */
2088 #endif /* _CIFSPDU_H */