/*
 *   fs/cifs/smb2pdu.h
 *
 *   Copyright (c) International Business Machines  Corp., 2009, 2013
 *                 Etersoft, 2012
 *   Author(s): Steve French (sfrench@us.ibm.com)
 *              Pavel Shilovsky (pshilovsky@samba.org) 2012
 *
 *   This library is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser General Public License as published
 *   by the Free Software Foundation; either version 2.1 of the License, or
 *   (at your option) any later version.
 *
 *   This library is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
 *   the GNU Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public License
 *   along with this library; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#ifndef _SMB2PDU_H
#define _SMB2PDU_H

#include <net/sock.h>

/*
 * Note that, due to trying to use names similar to the protocol specifications,
 * there are many mixed case field names in the structures below.  Although
 * this does not match typical Linux kernel style, it is necessary to be
 * be able to match against the protocol specfication.
 *
 * SMB2 commands
 * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
 * (ie no useful data other than the SMB error code itself) and are marked such.
 * Knowing this helps avoid response buffer allocations and copy in some cases.
 */

/* List of commands in host endian */
#define SMB2_NEGOTIATE_HE       0x0000
#define SMB2_SESSION_SETUP_HE   0x0001
#define SMB2_LOGOFF_HE          0x0002 /* trivial request/resp */
#define SMB2_TREE_CONNECT_HE    0x0003
#define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
#define SMB2_CREATE_HE          0x0005
#define SMB2_CLOSE_HE           0x0006
#define SMB2_FLUSH_HE           0x0007 /* trivial resp */
#define SMB2_READ_HE            0x0008
#define SMB2_WRITE_HE           0x0009
#define SMB2_LOCK_HE            0x000A
#define SMB2_IOCTL_HE           0x000B
#define SMB2_CANCEL_HE          0x000C
#define SMB2_ECHO_HE            0x000D
#define SMB2_QUERY_DIRECTORY_HE 0x000E
#define SMB2_CHANGE_NOTIFY_HE   0x000F
#define SMB2_QUERY_INFO_HE      0x0010
#define SMB2_SET_INFO_HE        0x0011
#define SMB2_OPLOCK_BREAK_HE    0x0012

/* The same list in little endian */
#define SMB2_NEGOTIATE          cpu_to_le16(SMB2_NEGOTIATE_HE)
#define SMB2_SESSION_SETUP      cpu_to_le16(SMB2_SESSION_SETUP_HE)
#define SMB2_LOGOFF             cpu_to_le16(SMB2_LOGOFF_HE)
#define SMB2_TREE_CONNECT       cpu_to_le16(SMB2_TREE_CONNECT_HE)
#define SMB2_TREE_DISCONNECT    cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
#define SMB2_CREATE             cpu_to_le16(SMB2_CREATE_HE)
#define SMB2_CLOSE              cpu_to_le16(SMB2_CLOSE_HE)
#define SMB2_FLUSH              cpu_to_le16(SMB2_FLUSH_HE)
#define SMB2_READ               cpu_to_le16(SMB2_READ_HE)
#define SMB2_WRITE              cpu_to_le16(SMB2_WRITE_HE)
#define SMB2_LOCK               cpu_to_le16(SMB2_LOCK_HE)
#define SMB2_IOCTL              cpu_to_le16(SMB2_IOCTL_HE)
#define SMB2_CANCEL             cpu_to_le16(SMB2_CANCEL_HE)
#define SMB2_ECHO               cpu_to_le16(SMB2_ECHO_HE)
#define SMB2_QUERY_DIRECTORY    cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
#define SMB2_CHANGE_NOTIFY      cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
#define SMB2_QUERY_INFO         cpu_to_le16(SMB2_QUERY_INFO_HE)
#define SMB2_SET_INFO           cpu_to_le16(SMB2_SET_INFO_HE)
#define SMB2_OPLOCK_BREAK       cpu_to_le16(SMB2_OPLOCK_BREAK_HE)

#define NUMBER_OF_SMB2_COMMANDS 0x0013

/* BB FIXME - analyze following length BB */
#define MAX_SMB2_HDR_SIZE 0x78 /* 4 len + 64 hdr + (2*24 wct) + 2 bct + 2 pad */

#define SMB2_PROTO_NUMBER __constant_cpu_to_le32(0x424d53fe)

/*
 * SMB2 Header Definition
 *
 * "MBZ" :  Must be Zero
 * "BB"  :  BugBug, Something to check/review/analyze later
 * "PDU" :  "Protocol Data Unit" (ie a network "frame")
 *
 */

#define SMB2_HEADER_STRUCTURE_SIZE __constant_cpu_to_le16(64)

struct smb2_hdr {
        __be32 smb2_buf_length; /* big endian on wire */
                                /* length is only two or three bytes - with
                                 one or two byte type preceding it that MBZ */
        __u8   ProtocolId[4];   /* 0xFE 'S' 'M' 'B' */
        __le16 StructureSize;   /* 64 */
        __le16 CreditCharge;    /* MBZ */
        __le32 Status;          /* Error from server */
        __le16 Command;
        __le16 CreditRequest;  /* CreditResponse */
        __le32 Flags;
        __le32 NextCommand;
        __u64  MessageId;       /* opaque - so can stay little endian */
        __le32 ProcessId;
        __u32  TreeId;          /* opaque - so do not make little endian */
        __u64  SessionId;       /* opaque - so do not make little endian */
        __u8   Signature[16];
} __packed;

struct smb2_pdu {
        struct smb2_hdr hdr;
        __le16 StructureSize2; /* size of wct area (varies, request specific) */
} __packed;

struct smb2_transform_hdr {
        __be32 smb2_buf_length; /* big endian on wire */
                                /* length is only two or three bytes - with
                                 one or two byte type preceding it that MBZ */
        __u8   ProtocolId[4];   /* 0xFD 'S' 'M' 'B' */
        __u8   Signature[16];
        __u8   Nonce[11];
        __u8   Reserved[5];
        __le32 OriginalMessageSize;
        __u16  Reserved1;
        __le16 EncryptionAlgorithm;
        __u64  SessionId;
} __packed;

/* Encryption Algorithms */
#define SMB2_ENCRYPTION_AES128_CCM      __constant_cpu_to_le16(0x0001)

/*
 *      SMB2 flag definitions
 */
#define SMB2_FLAGS_SERVER_TO_REDIR      __constant_cpu_to_le32(0x00000001)
#define SMB2_FLAGS_ASYNC_COMMAND        __constant_cpu_to_le32(0x00000002)
#define SMB2_FLAGS_RELATED_OPERATIONS   __constant_cpu_to_le32(0x00000004)
#define SMB2_FLAGS_SIGNED               __constant_cpu_to_le32(0x00000008)
#define SMB2_FLAGS_DFS_OPERATIONS       __constant_cpu_to_le32(0x10000000)

/*
 *      Definitions for SMB2 Protocol Data Units (network frames)
 *
 *  See MS-SMB2.PDF specification for protocol details.
 *  The Naming convention is the lower case version of the SMB2
 *  command code name for the struct. Note that structures must be packed.
 *
 */

#define SMB2_ERROR_STRUCTURE_SIZE2 __constant_cpu_to_le16(9)

struct smb2_err_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize;
        __le16 Reserved; /* MBZ */
        __le32 ByteCount;  /* even if zero, at least one byte follows */
        __u8   ErrorData[1];  /* variable length */
} __packed;

struct smb2_symlink_err_rsp {
        __le32 SymLinkLength;
        __le32 SymLinkErrorTag;
        __le32 ReparseTag;
        __le16 ReparseDataLength;
        __le16 UnparsedPathLength;
        __le16 SubstituteNameOffset;
        __le16 SubstituteNameLength;
        __le16 PrintNameOffset;
        __le16 PrintNameLength;
        __le32 Flags;
        __u8  PathBuffer[0];
} __packed;

#define SMB2_CLIENT_GUID_SIZE 16

struct smb2_negotiate_req {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 36 */
        __le16 DialectCount;
        __le16 SecurityMode;
        __le16 Reserved;        /* MBZ */
        __le32 Capabilities;
        __u8   ClientGUID[SMB2_CLIENT_GUID_SIZE];
        __le64 ClientStartTime; /* MBZ */
        __le16 Dialects[1]; /* One dialect (vers=) at a time for now */
} __packed;

/* Dialects */
#define SMB20_PROT_ID 0x0202
#define SMB21_PROT_ID 0x0210
#define SMB30_PROT_ID 0x0300
#define SMB302_PROT_ID 0x0302
#define BAD_PROT_ID   0xFFFF

/* SecurityMode flags */
#define SMB2_NEGOTIATE_SIGNING_ENABLED  0x0001
#define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
/* Capabilities flags */
#define SMB2_GLOBAL_CAP_DFS             0x00000001
#define SMB2_GLOBAL_CAP_LEASING         0x00000002 /* Resp only New to SMB2.1 */
#define SMB2_GLOBAL_CAP_LARGE_MTU       0X00000004 /* Resp only New to SMB2.1 */
#define SMB2_GLOBAL_CAP_MULTI_CHANNEL   0x00000008 /* New to SMB3 */
#define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
#define SMB2_GLOBAL_CAP_DIRECTORY_LEASING  0x00000020 /* New to SMB3 */
#define SMB2_GLOBAL_CAP_ENCRYPTION      0x00000040 /* New to SMB3 */
/* Internal types */
#define SMB2_NT_FIND                    0x00100000
#define SMB2_LARGE_FILES                0x00200000

struct smb2_negotiate_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 65 */
        __le16 SecurityMode;
        __le16 DialectRevision;
        __le16 Reserved;        /* MBZ */
        __u8   ServerGUID[16];
        __le32 Capabilities;
        __le32 MaxTransactSize;
        __le32 MaxReadSize;
        __le32 MaxWriteSize;
        __le64 SystemTime;      /* MBZ */
        __le64 ServerStartTime;
        __le16 SecurityBufferOffset;
        __le16 SecurityBufferLength;
        __le32 Reserved2;       /* may be any value, ignore */
        __u8   Buffer[1];       /* variable length GSS security buffer */
} __packed;

struct smb2_sess_setup_req {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 25 */
        __u8   VcNumber;
        __u8   SecurityMode;
        __le32 Capabilities;
        __le32 Channel;
        __le16 SecurityBufferOffset;
        __le16 SecurityBufferLength;
        __le64 PreviousSessionId;
        __u8   Buffer[1];       /* variable length GSS security buffer */
} __packed;

/* Currently defined SessionFlags */
#define SMB2_SESSION_FLAG_IS_GUEST      0x0001
#define SMB2_SESSION_FLAG_IS_NULL       0x0002
#define SMB2_SESSION_FLAG_ENCRYPT_DATA  0x0004
struct smb2_sess_setup_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 9 */
        __le16 SessionFlags;
        __le16 SecurityBufferOffset;
        __le16 SecurityBufferLength;
        __u8   Buffer[1];       /* variable length GSS security buffer */
} __packed;

struct smb2_logoff_req {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 4 */
        __le16 Reserved;
} __packed;

struct smb2_logoff_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 4 */
        __le16 Reserved;
} __packed;

struct smb2_tree_connect_req {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 9 */
        __le16 Reserved;
        __le16 PathOffset;
        __le16 PathLength;
        __u8   Buffer[1];       /* variable length */
} __packed;

struct smb2_tree_connect_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 16 */
        __u8   ShareType;  /* see below */
        __u8   Reserved;
        __le32 ShareFlags; /* see below */
        __le32 Capabilities; /* see below */
        __le32 MaximalAccess;
} __packed;

/* Possible ShareType values */
#define SMB2_SHARE_TYPE_DISK    0x01
#define SMB2_SHARE_TYPE_PIPE    0x02
#define SMB2_SHARE_TYPE_PRINT   0x03

/*
 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
 * must be set (any of the remaining, SHI1005, flags may be set individually
 * or in combination.
 */
#define SMB2_SHAREFLAG_MANUAL_CACHING                   0x00000000
#define SMB2_SHAREFLAG_AUTO_CACHING                     0x00000010
#define SMB2_SHAREFLAG_VDO_CACHING                      0x00000020
#define SMB2_SHAREFLAG_NO_CACHING                       0x00000030
#define SHI1005_FLAGS_DFS                               0x00000001
#define SHI1005_FLAGS_DFS_ROOT                          0x00000002
#define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS          0x00000100
#define SHI1005_FLAGS_FORCE_SHARED_DELETE               0x00000200
#define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING           0x00000400
#define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM       0x00000800
#define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK              0x00001000
#define SHI1005_FLAGS_ENABLE_HASH_V1                    0x00002000
#define SHI1005_FLAGS_ENABLE_HASH_V2                    0x00004000
#define SHI1005_FLAGS_ENCRYPT_DATA                      0x00008000
#define SHI1005_FLAGS_ALL                               0x0000FF33

/* Possible share capabilities */
#define SMB2_SHARE_CAP_DFS      cpu_to_le32(0x00000008) /* all dialects */
#define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
#define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
#define SMB2_SHARE_CAP_CLUSTER  cpu_to_le32(0x00000040) /* 3.0 */
#define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */

struct smb2_tree_disconnect_req {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 4 */
        __le16 Reserved;
} __packed;

struct smb2_tree_disconnect_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 4 */
        __le16 Reserved;
} __packed;

/* File Attrubutes */
#define FILE_ATTRIBUTE_READONLY                 0x00000001
#define FILE_ATTRIBUTE_HIDDEN                   0x00000002
#define FILE_ATTRIBUTE_SYSTEM                   0x00000004
#define FILE_ATTRIBUTE_DIRECTORY                0x00000010
#define FILE_ATTRIBUTE_ARCHIVE                  0x00000020
#define FILE_ATTRIBUTE_NORMAL                   0x00000080
#define FILE_ATTRIBUTE_TEMPORARY                0x00000100
#define FILE_ATTRIBUTE_SPARSE_FILE              0x00000200
#define FILE_ATTRIBUTE_REPARSE_POINT            0x00000400
#define FILE_ATTRIBUTE_COMPRESSED               0x00000800
#define FILE_ATTRIBUTE_OFFLINE                  0x00001000
#define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED      0x00002000
#define FILE_ATTRIBUTE_ENCRYPTED                0x00004000

/* Oplock levels */
#define SMB2_OPLOCK_LEVEL_NONE          0x00
#define SMB2_OPLOCK_LEVEL_II            0x01
#define SMB2_OPLOCK_LEVEL_EXCLUSIVE     0x08
#define SMB2_OPLOCK_LEVEL_BATCH         0x09
#define SMB2_OPLOCK_LEVEL_LEASE         0xFF
/* Non-spec internal type */
#define SMB2_OPLOCK_LEVEL_NOCHANGE      0x99

/* Desired Access Flags */
#define FILE_READ_DATA_LE               cpu_to_le32(0x00000001)
#define FILE_WRITE_DATA_LE              cpu_to_le32(0x00000002)
#define FILE_APPEND_DATA_LE             cpu_to_le32(0x00000004)
#define FILE_READ_EA_LE                 cpu_to_le32(0x00000008)
#define FILE_WRITE_EA_LE                cpu_to_le32(0x00000010)
#define FILE_EXECUTE_LE                 cpu_to_le32(0x00000020)
#define FILE_READ_ATTRIBUTES_LE         cpu_to_le32(0x00000080)
#define FILE_WRITE_ATTRIBUTES_LE        cpu_to_le32(0x00000100)
#define FILE_DELETE_LE                  cpu_to_le32(0x00010000)
#define FILE_READ_CONTROL_LE            cpu_to_le32(0x00020000)
#define FILE_WRITE_DAC_LE               cpu_to_le32(0x00040000)
#define FILE_WRITE_OWNER_LE             cpu_to_le32(0x00080000)
#define FILE_SYNCHRONIZE_LE             cpu_to_le32(0x00100000)
#define FILE_ACCESS_SYSTEM_SECURITY_LE  cpu_to_le32(0x01000000)
#define FILE_MAXIMAL_ACCESS_LE          cpu_to_le32(0x02000000)
#define FILE_GENERIC_ALL_LE             cpu_to_le32(0x10000000)
#define FILE_GENERIC_EXECUTE_LE         cpu_to_le32(0x20000000)
#define FILE_GENERIC_WRITE_LE           cpu_to_le32(0x40000000)
#define FILE_GENERIC_READ_LE            cpu_to_le32(0x80000000)

/* ShareAccess Flags */
#define FILE_SHARE_READ_LE              cpu_to_le32(0x00000001)
#define FILE_SHARE_WRITE_LE             cpu_to_le32(0x00000002)
#define FILE_SHARE_DELETE_LE            cpu_to_le32(0x00000004)
#define FILE_SHARE_ALL_LE               cpu_to_le32(0x00000007)

/* CreateDisposition Flags */
#define FILE_SUPERSEDE_LE               cpu_to_le32(0x00000000)
#define FILE_OPEN_LE                    cpu_to_le32(0x00000001)
#define FILE_CREATE_LE                  cpu_to_le32(0x00000002)
#define FILE_OPEN_IF_LE                 cpu_to_le32(0x00000003)
#define FILE_OVERWRITE_LE               cpu_to_le32(0x00000004)
#define FILE_OVERWRITE_IF_LE            cpu_to_le32(0x00000005)

/* CreateOptions Flags */
#define FILE_DIRECTORY_FILE_LE          cpu_to_le32(0x00000001)
/* same as #define CREATE_NOT_FILE_LE   cpu_to_le32(0x00000001) */
#define FILE_WRITE_THROUGH_LE           cpu_to_le32(0x00000002)
#define FILE_SEQUENTIAL_ONLY_LE         cpu_to_le32(0x00000004)
#define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
#define FILE_SYNCHRONOUS_IO_ALERT_LE    cpu_to_le32(0x00000010)
#define FILE_SYNCHRONOUS_IO_NON_ALERT_LE        cpu_to_le32(0x00000020)
#define FILE_NON_DIRECTORY_FILE_LE      cpu_to_le32(0x00000040)
#define FILE_COMPLETE_IF_OPLOCKED_LE    cpu_to_le32(0x00000100)
#define FILE_NO_EA_KNOWLEDGE_LE         cpu_to_le32(0x00000200)
#define FILE_RANDOM_ACCESS_LE           cpu_to_le32(0x00000800)
#define FILE_DELETE_ON_CLOSE_LE         cpu_to_le32(0x00001000)
#define FILE_OPEN_BY_FILE_ID_LE         cpu_to_le32(0x00002000)
#define FILE_OPEN_FOR_BACKUP_INTENT_LE  cpu_to_le32(0x00004000)
#define FILE_NO_COMPRESSION_LE          cpu_to_le32(0x00008000)
#define FILE_RESERVE_OPFILTER_LE        cpu_to_le32(0x00100000)
#define FILE_OPEN_REPARSE_POINT_LE      cpu_to_le32(0x00200000)
#define FILE_OPEN_NO_RECALL_LE          cpu_to_le32(0x00400000)
#define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)

#define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
                        | FILE_READ_ATTRIBUTES_LE)
#define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
                        | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
#define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)

/* Impersonation Levels */
#define IL_ANONYMOUS            cpu_to_le32(0x00000000)
#define IL_IDENTIFICATION       cpu_to_le32(0x00000001)
#define IL_IMPERSONATION        cpu_to_le32(0x00000002)
#define IL_DELEGATE             cpu_to_le32(0x00000003)

/* Create Context Values */
#define SMB2_CREATE_EA_BUFFER                   "ExtA" /* extended attributes */
#define SMB2_CREATE_SD_BUFFER                   "SecD" /* security descriptor */
#define SMB2_CREATE_DURABLE_HANDLE_REQUEST      "DHnQ"
#define SMB2_CREATE_DURABLE_HANDLE_RECONNECT    "DHnC"
#define SMB2_CREATE_ALLOCATION_SIZE             "AISi"
#define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
#define SMB2_CREATE_TIMEWARP_REQUEST            "TWrp"
#define SMB2_CREATE_QUERY_ON_DISK_ID            "QFid"
#define SMB2_CREATE_REQUEST_LEASE               "RqLs"
#define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2   "DH2Q"
#define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
#define SMB2_CREATE_APP_INSTANCE_ID     0x45BCA66AEFA7F74A9008FA462E144D74
#define SVHDX_OPEN_DEVICE_CONTEXT       0x83CE6F1AD851E0986E34401CC9BCFCE9

struct smb2_create_req {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 57 */
        __u8   SecurityFlags;
        __u8   RequestedOplockLevel;
        __le32 ImpersonationLevel;
        __le64 SmbCreateFlags;
        __le64 Reserved;
        __le32 DesiredAccess;
        __le32 FileAttributes;
        __le32 ShareAccess;
        __le32 CreateDisposition;
        __le32 CreateOptions;
        __le16 NameOffset;
        __le16 NameLength;
        __le32 CreateContextsOffset;
        __le32 CreateContextsLength;
        __u8   Buffer[0];
} __packed;

struct smb2_create_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 89 */
        __u8   OplockLevel;
        __u8   Reserved;
        __le32 CreateAction;
        __le64 CreationTime;
        __le64 LastAccessTime;
        __le64 LastWriteTime;
        __le64 ChangeTime;
        __le64 AllocationSize;
        __le64 EndofFile;
        __le32 FileAttributes;
        __le32 Reserved2;
        __u64  PersistentFileId; /* opaque endianness */
        __u64  VolatileFileId; /* opaque endianness */
        __le32 CreateContextsOffset;
        __le32 CreateContextsLength;
        __u8   Buffer[1];
} __packed;

struct create_context {
        __le32 Next;
        __le16 NameOffset;
        __le16 NameLength;
        __le16 Reserved;
        __le16 DataOffset;
        __le32 DataLength;
        __u8 Buffer[0];
} __packed;

#define SMB2_LEASE_READ_CACHING_HE      0x01
#define SMB2_LEASE_HANDLE_CACHING_HE    0x02
#define SMB2_LEASE_WRITE_CACHING_HE     0x04

#define SMB2_LEASE_NONE                 __constant_cpu_to_le32(0x00)
#define SMB2_LEASE_READ_CACHING         __constant_cpu_to_le32(0x01)
#define SMB2_LEASE_HANDLE_CACHING       __constant_cpu_to_le32(0x02)
#define SMB2_LEASE_WRITE_CACHING        __constant_cpu_to_le32(0x04)

#define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS __constant_cpu_to_le32(0x02)

#define SMB2_LEASE_KEY_SIZE 16

struct lease_context {
        __le64 LeaseKeyLow;
        __le64 LeaseKeyHigh;
        __le32 LeaseState;
        __le32 LeaseFlags;
        __le64 LeaseDuration;
} __packed;

struct lease_context_v2 {
        __le64 LeaseKeyLow;
        __le64 LeaseKeyHigh;
        __le32 LeaseState;
        __le32 LeaseFlags;
        __le64 LeaseDuration;
        __le64 ParentLeaseKeyLow;
        __le64 ParentLeaseKeyHigh;
        __le16 Epoch;
        __le16 Reserved;
} __packed;

struct create_lease {
        struct create_context ccontext;
        __u8   Name[8];
        struct lease_context lcontext;
} __packed;

struct create_lease_v2 {
        struct create_context ccontext;
        __u8   Name[8];
        struct lease_context_v2 lcontext;
        __u8   Pad[4];
} __packed;

struct create_durable {
        struct create_context ccontext;
        __u8   Name[8];
        union {
                __u8  Reserved[16];
                struct {
                        __u64 PersistentFileId;
                        __u64 VolatileFileId;
                } Fid;
        } Data;
} __packed;

#define COPY_CHUNK_RES_KEY_SIZE 24
struct resume_key_req {
        char ResumeKey[COPY_CHUNK_RES_KEY_SIZE];
        __le32  ContextLength;  /* MBZ */
        char    Context[0];     /* ignored, Windows sets to 4 bytes of zero */
} __packed;

/* this goes in the ioctl buffer when doing a copychunk request */
struct copychunk_ioctl {
        char SourceKey[COPY_CHUNK_RES_KEY_SIZE];
        __le32 ChunkCount; /* we are only sending 1 */
        __le32 Reserved;
        /* array will only be one chunk long for us */
        __le64 SourceOffset;
        __le64 TargetOffset;
        __le32 Length; /* how many bytes to copy */
        __u32 Reserved2;
} __packed;

struct copychunk_ioctl_rsp {
        __le32 ChunksWritten;
        __le32 ChunkBytesWritten;
        __le32 TotalBytesWritten;
} __packed;

struct validate_negotiate_info_req {
        __le32 Capabilities;
        __u8   Guid[SMB2_CLIENT_GUID_SIZE];
        __le16 SecurityMode;
        __le16 DialectCount;
        __le16 Dialects[1]; /* dialect (someday maybe list) client asked for */
} __packed;

struct validate_negotiate_info_rsp {
        __le32 Capabilities;
        __u8   Guid[SMB2_CLIENT_GUID_SIZE];
        __le16 SecurityMode;
        __le16 Dialect; /* Dialect in use for the connection */
} __packed;

#define RSS_CAPABLE     0x00000001
#define RDMA_CAPABLE    0x00000002

struct network_interface_info_ioctl_rsp {
        __le32 Next; /* next interface. zero if this is last one */
        __le32 IfIndex;
        __le32 Capability; /* RSS or RDMA Capable */
        __le32 Reserved;
        __le64 LinkSpeed;
        char    SockAddr_Storage[128];
} __packed;

#define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */

struct compress_ioctl {
        __le16 CompressionState; /* See cifspdu.h for possible flag values */
} __packed;

struct smb2_ioctl_req {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 57 */
        __u16 Reserved;
        __le32 CtlCode;
        __u64  PersistentFileId; /* opaque endianness */
        __u64  VolatileFileId; /* opaque endianness */
        __le32 InputOffset;
        __le32 InputCount;
        __le32 MaxInputResponse;
        __le32 OutputOffset;
        __le32 OutputCount;
        __le32 MaxOutputResponse;
        __le32 Flags;
        __u32  Reserved2;
        __u8   Buffer[0];
} __packed;

struct smb2_ioctl_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 57 */
        __u16 Reserved;
        __le32 CtlCode;
        __u64  PersistentFileId; /* opaque endianness */
        __u64  VolatileFileId; /* opaque endianness */
        __le32 InputOffset;
        __le32 InputCount;
        __le32 OutputOffset;
        __le32 OutputCount;
        __le32 Flags;
        __u32  Reserved2;
        /* char * buffer[] */
} __packed;

/* Currently defined values for close flags */
#define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB        cpu_to_le16(0x0001)
struct smb2_close_req {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 24 */
        __le16 Flags;
        __le32 Reserved;
        __u64  PersistentFileId; /* opaque endianness */
        __u64  VolatileFileId; /* opaque endianness */
} __packed;

struct smb2_close_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* 60 */
        __le16 Flags;
        __le32 Reserved;
        __le64 CreationTime;
        __le64 LastAccessTime;
        __le64 LastWriteTime;
        __le64 ChangeTime;
        __le64 AllocationSize;  /* Beginning of FILE_STANDARD_INFO equivalent */
        __le64 EndOfFile;
        __le32 Attributes;
} __packed;

struct smb2_flush_req {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 24 */
        __le16 Reserved1;
        __le32 Reserved2;
        __u64  PersistentFileId; /* opaque endianness */
        __u64  VolatileFileId; /* opaque endianness */
} __packed;

struct smb2_flush_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize;
        __le16 Reserved;
} __packed;

/* For read request Flags field below, following flag is defined for SMB3.02 */
#define SMB2_READFLAG_READ_UNBUFFERED   0x01

/* Channel field for read and write: exactly one of following flags can be set*/
#define SMB2_CHANNEL_NONE               0x00000000
#define SMB2_CHANNEL_RDMA_V1            0x00000001 /* SMB3 or later */
#define SMB2_CHANNEL_RDMA_V1_INVALIDATE 0x00000001 /* SMB3.02 or later */

struct smb2_read_req {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 49 */
        __u8   Padding; /* offset from start of SMB2 header to place read */
        __u8   Flags; /* MBZ unless SMB3.02 or later */
        __le32 Length;
        __le64 Offset;
        __u64  PersistentFileId; /* opaque endianness */
        __u64  VolatileFileId; /* opaque endianness */
        __le32 MinimumCount;
        __le32 Channel; /* MBZ except for SMB3 or later */
        __le32 RemainingBytes;
        __le16 ReadChannelInfoOffset; /* Reserved MBZ */
        __le16 ReadChannelInfoLength; /* Reserved MBZ */
        __u8   Buffer[1];
} __packed;

struct smb2_read_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 17 */
        __u8   DataOffset;
        __u8   Reserved;
        __le32 DataLength;
        __le32 DataRemaining;
        __u32  Reserved2;
        __u8   Buffer[1];
} __packed;

/* For write request Flags field below the following flags are defined: */
#define SMB2_WRITEFLAG_WRITE_THROUGH    0x00000001      /* SMB2.1 or later */
#define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002      /* SMB3.02 or later */

struct smb2_write_req {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 49 */
        __le16 DataOffset; /* offset from start of SMB2 header to write data */
        __le32 Length;
        __le64 Offset;
        __u64  PersistentFileId; /* opaque endianness */
        __u64  VolatileFileId; /* opaque endianness */
        __le32 Channel; /* Reserved MBZ */
        __le32 RemainingBytes;
        __le16 WriteChannelInfoOffset; /* Reserved MBZ */
        __le16 WriteChannelInfoLength; /* Reserved MBZ */
        __le32 Flags;
        __u8   Buffer[1];
} __packed;

struct smb2_write_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 17 */
        __u8   DataOffset;
        __u8   Reserved;
        __le32 DataLength;
        __le32 DataRemaining;
        __u32  Reserved2;
        __u8   Buffer[1];
} __packed;

#define SMB2_LOCKFLAG_SHARED_LOCK       0x0001
#define SMB2_LOCKFLAG_EXCLUSIVE_LOCK    0x0002
#define SMB2_LOCKFLAG_UNLOCK            0x0004
#define SMB2_LOCKFLAG_FAIL_IMMEDIATELY  0x0010

struct smb2_lock_element {
        __le64 Offset;
        __le64 Length;
        __le32 Flags;
        __le32 Reserved;
} __packed;

struct smb2_lock_req {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 48 */
        __le16 LockCount;
        __le32 Reserved;
        __u64  PersistentFileId; /* opaque endianness */
        __u64  VolatileFileId; /* opaque endianness */
        /* Followed by at least one */
        struct smb2_lock_element locks[1];
} __packed;

struct smb2_lock_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 4 */
        __le16 Reserved;
} __packed;

struct smb2_echo_req {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 4 */
        __u16  Reserved;
} __packed;

struct smb2_echo_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 4 */
        __u16  Reserved;
} __packed;

/* search (query_directory) Flags field */
#define SMB2_RESTART_SCANS              0x01
#define SMB2_RETURN_SINGLE_ENTRY        0x02
#define SMB2_INDEX_SPECIFIED            0x04
#define SMB2_REOPEN                     0x10

struct smb2_query_directory_req {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 33 */
        __u8   FileInformationClass;
        __u8   Flags;
        __le32 FileIndex;
        __u64  PersistentFileId; /* opaque endianness */
        __u64  VolatileFileId; /* opaque endianness */
        __le16 FileNameOffset;
        __le16 FileNameLength;
        __le32 OutputBufferLength;
        __u8   Buffer[1];
} __packed;

struct smb2_query_directory_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 9 */
        __le16 OutputBufferOffset;
        __le32 OutputBufferLength;
        __u8   Buffer[1];
} __packed;

/* Possible InfoType values */
#define SMB2_O_INFO_FILE        0x01
#define SMB2_O_INFO_FILESYSTEM  0x02
#define SMB2_O_INFO_SECURITY    0x03
#define SMB2_O_INFO_QUOTA       0x04

struct smb2_query_info_req {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 41 */
        __u8   InfoType;
        __u8   FileInfoClass;
        __le32 OutputBufferLength;
        __le16 InputBufferOffset;
        __u16  Reserved;
        __le32 InputBufferLength;
        __le32 AdditionalInformation;
        __le32 Flags;
        __u64  PersistentFileId; /* opaque endianness */
        __u64  VolatileFileId; /* opaque endianness */
        __u8   Buffer[1];
} __packed;

struct smb2_query_info_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 9 */
        __le16 OutputBufferOffset;
        __le32 OutputBufferLength;
        __u8   Buffer[1];
} __packed;

struct smb2_set_info_req {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 33 */
        __u8   InfoType;
        __u8   FileInfoClass;
        __le32 BufferLength;
        __le16 BufferOffset;
        __u16  Reserved;
        __le32 AdditionalInformation;
        __u64  PersistentFileId; /* opaque endianness */
        __u64  VolatileFileId; /* opaque endianness */
        __u8   Buffer[1];
} __packed;

struct smb2_set_info_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 2 */
} __packed;

struct smb2_oplock_break {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 24 */
        __u8   OplockLevel;
        __u8   Reserved;
        __le32 Reserved2;
        __u64  PersistentFid;
        __u64  VolatileFid;
} __packed;

#define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)

struct smb2_lease_break {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 44 */
        __le16 Reserved;
        __le32 Flags;
        __u8   LeaseKey[16];
        __le32 CurrentLeaseState;
        __le32 NewLeaseState;
        __le32 BreakReason;
        __le32 AccessMaskHint;
        __le32 ShareMaskHint;
} __packed;

struct smb2_lease_ack {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 36 */
        __le16 Reserved;
        __le32 Flags;
        __u8   LeaseKey[16];
        __le32 LeaseState;
        __le64 LeaseDuration;
} __packed;

/*
 *      PDU infolevel structure definitions
 *      BB consider moving to a different header
 */

/* File System Information Classes */
#define FS_VOLUME_INFORMATION           1 /* Query */
#define FS_LABEL_INFORMATION            2 /* Local only */
#define FS_SIZE_INFORMATION             3 /* Query */
#define FS_DEVICE_INFORMATION           4 /* Query */
#define FS_ATTRIBUTE_INFORMATION        5 /* Query */
#define FS_CONTROL_INFORMATION          6 /* Query, Set */
#define FS_FULL_SIZE_INFORMATION        7 /* Query */
#define FS_OBJECT_ID_INFORMATION        8 /* Query, Set */
#define FS_DRIVER_PATH_INFORMATION      9 /* Local only */
#define FS_VOLUME_FLAGS_INFORMATION     10 /* Local only */
#define FS_SECTOR_SIZE_INFORMATION      11 /* SMB3 or later. Query */

struct smb2_fs_full_size_info {
        __le64 TotalAllocationUnits;
        __le64 CallerAvailableAllocationUnits;
        __le64 ActualAvailableAllocationUnits;
        __le32 SectorsPerAllocationUnit;
        __le32 BytesPerSector;
} __packed;

#define SSINFO_FLAGS_ALIGNED_DEVICE             0x00000001
#define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
#define SSINFO_FLAGS_NO_SEEK_PENALTY            0x00000004
#define SSINFO_FLAGS_TRIM_ENABLED               0x00000008

/* sector size info struct */
struct smb3_fs_ss_info {
        __le32 LogicalBytesPerSector;
        __le32 PhysicalBytesPerSectorForAtomicity;
        __le32 PhysicalBytesPerSectorForPerf;
        __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity;
        __le32 Flags;
        __le32 ByteOffsetForSectorAlignment;
        __le32 ByteOffsetForPartitionAlignment;
} __packed;

/* partial list of QUERY INFO levels */
#define FILE_DIRECTORY_INFORMATION      1
#define FILE_FULL_DIRECTORY_INFORMATION 2
#define FILE_BOTH_DIRECTORY_INFORMATION 3
#define FILE_BASIC_INFORMATION          4
#define FILE_STANDARD_INFORMATION       5
#define FILE_INTERNAL_INFORMATION       6
#define FILE_EA_INFORMATION             7
#define FILE_ACCESS_INFORMATION         8
#define FILE_NAME_INFORMATION           9
#define FILE_RENAME_INFORMATION         10
#define FILE_LINK_INFORMATION           11
#define FILE_NAMES_INFORMATION          12
#define FILE_DISPOSITION_INFORMATION    13
#define FILE_POSITION_INFORMATION       14
#define FILE_FULL_EA_INFORMATION        15
#define FILE_MODE_INFORMATION           16
#define FILE_ALIGNMENT_INFORMATION      17
#define FILE_ALL_INFORMATION            18
#define FILE_ALLOCATION_INFORMATION     19
#define FILE_END_OF_FILE_INFORMATION    20
#define FILE_ALTERNATE_NAME_INFORMATION 21
#define FILE_STREAM_INFORMATION         22
#define FILE_PIPE_INFORMATION           23
#define FILE_PIPE_LOCAL_INFORMATION     24
#define FILE_PIPE_REMOTE_INFORMATION    25
#define FILE_MAILSLOT_QUERY_INFORMATION 26
#define FILE_MAILSLOT_SET_INFORMATION   27
#define FILE_COMPRESSION_INFORMATION    28
#define FILE_OBJECT_ID_INFORMATION      29
/* Number 30 not defined in documents */
#define FILE_MOVE_CLUSTER_INFORMATION   31
#define FILE_QUOTA_INFORMATION          32
#define FILE_REPARSE_POINT_INFORMATION  33
#define FILE_NETWORK_OPEN_INFORMATION   34
#define FILE_ATTRIBUTE_TAG_INFORMATION  35
#define FILE_TRACKING_INFORMATION       36
#define FILEID_BOTH_DIRECTORY_INFORMATION 37
#define FILEID_FULL_DIRECTORY_INFORMATION 38
#define FILE_VALID_DATA_LENGTH_INFORMATION 39
#define FILE_SHORT_NAME_INFORMATION     40
#define FILE_SFIO_RESERVE_INFORMATION   44
#define FILE_SFIO_VOLUME_INFORMATION    45
#define FILE_HARD_LINK_INFORMATION      46
#define FILE_NORMALIZED_NAME_INFORMATION 48
#define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
#define FILE_STANDARD_LINK_INFORMATION  54

struct smb2_file_internal_info {
        __le64 IndexNumber;

} __packed; /* level 6 Query */

struct smb2_file_rename_info { /* encoding of request for level 10 */
        __u8   ReplaceIfExists; /* 1 = replace existing target with new */
                                /* 0 = fail if target already exists */
        __u8   Reserved[7];
        __u64  RootDirectory;  /* MBZ for network operations (why says spec?) */
        __le32 FileNameLength;
        char   FileName[0];     /* New name to be assigned */
} __packed; /* level 10 Set */

struct smb2_file_link_info { /* encoding of request for level 11 */
        __u8   ReplaceIfExists; /* 1 = replace existing link with new */
                                /* 0 = fail if link already exists */
        __u8   Reserved[7];
        __u64  RootDirectory;  /* MBZ for network operations (why says spec?) */
        __le32 FileNameLength;
        char   FileName[0];     /* Name to be assigned to new link */
} __packed; /* level 11 Set */

/*
 * This level 18, although with struct with same name is different from cifs
 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
 * CurrentByteOffset.
 */
struct smb2_file_all_info { /* data block encoding of response to level 18 */
        __le64 CreationTime;    /* Beginning of FILE_BASIC_INFO equivalent */
        __le64 LastAccessTime;
        __le64 LastWriteTime;
        __le64 ChangeTime;
        __le32 Attributes;
        __u32  Pad1;            /* End of FILE_BASIC_INFO_INFO equivalent */
        __le64 AllocationSize;  /* Beginning of FILE_STANDARD_INFO equivalent */
        __le64 EndOfFile;       /* size ie offset to first free byte in file */
        __le32 NumberOfLinks;   /* hard links */
        __u8   DeletePending;
        __u8   Directory;
        __u16  Pad2;            /* End of FILE_STANDARD_INFO equivalent */
        __le64 IndexNumber;
        __le32 EASize;
        __le32 AccessFlags;
        __le64 CurrentByteOffset;
        __le32 Mode;
        __le32 AlignmentRequirement;
        __le32 FileNameLength;
        char   FileName[1];
} __packed; /* level 18 Query */

struct smb2_file_eof_info { /* encoding of request for level 10 */
        __le64 EndOfFile; /* new end of file value */
} __packed; /* level 20 Set */

#endif                          /* _SMB2PDU_H */