/* SPDX-License-Identifier: LGPL-2.1 */
#ifndef _COMMON_SMB2PDU_H
#define _COMMON_SMB2PDU_H

#include <linux/types.h>
#include <linux/build_bug.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
 * able to match against the protocol specification.
 *
 * 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
#define SMB2_SERVER_TO_CLIENT_NOTIFICATION 0x0013

/* 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 SMB2_INTERNAL_CMD       cpu_to_le16(0xFFFF)

#define NUMBER_OF_SMB2_COMMANDS 0x0013

/*
 * Size of the session key (crypto key encrypted with the password
 */
#define SMB2_NTLMV2_SESSKEY_SIZE        16
#define SMB2_SIGNATURE_SIZE             16
#define SMB2_HMACSHA256_SIZE            32
#define SMB2_CMACAES_SIZE               16
#define SMB3_GCM128_CRYPTKEY_SIZE       16
#define SMB3_GCM256_CRYPTKEY_SIZE       32

/*
 * Size of the smb3 encryption/decryption keys
 * This size is big enough to store any cipher key types.
 */
#define SMB3_ENC_DEC_KEY_SIZE           32

/*
 * Size of the smb3 signing key
 */
#define SMB3_SIGN_KEY_SIZE              16

#define CIFS_CLIENT_CHALLENGE_SIZE      8

/* Maximum buffer size value we can send with 1 credit */
#define SMB2_MAX_BUFFER_SIZE 65536

/*
 * The default wsize is 1M for SMB2 (and for some CIFS cases).
 * find_get_pages seems to return a maximum of 256
 * pages in a single call. With PAGE_SIZE == 4k, this means we can
 * fill a single wsize request with a single call.
 */
#define SMB3_DEFAULT_IOSIZE (4 * 1024 * 1024)

/* According to MS-SMB2 specification The minimum recommended value is 65536.*/
#define CIFS_MIN_DEFAULT_IOSIZE (65536)

/*
 * 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    64
#define SMB2_HEADER_STRUCTURE_SIZE                              \
        cpu_to_le16(__SMB2_HEADER_STRUCTURE_SIZE)

#define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
#define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
#define SMB2_COMPRESSION_TRANSFORM_ID cpu_to_le32(0x424d53fc)

/*
 *      SMB2 flag definitions
 */
#define SMB2_FLAGS_SERVER_TO_REDIR      cpu_to_le32(0x00000001)
#define SMB2_FLAGS_ASYNC_COMMAND        cpu_to_le32(0x00000002)
#define SMB2_FLAGS_RELATED_OPERATIONS   cpu_to_le32(0x00000004)
#define SMB2_FLAGS_SIGNED               cpu_to_le32(0x00000008)
#define SMB2_FLAGS_PRIORITY_MASK        cpu_to_le32(0x00000070) /* SMB3.1.1 */
#define SMB2_FLAGS_DFS_OPERATIONS       cpu_to_le32(0x10000000)
#define SMB2_FLAGS_REPLAY_OPERATION     cpu_to_le32(0x20000000) /* SMB3 & up */

/*
 *      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.
 *
 */

/* See MS-SMB2 section 2.2.1 */
struct smb2_hdr {
        __le32 ProtocolId;      /* 0xFE 'S' 'M' 'B' */
        __le16 StructureSize;   /* 64 */
        __le16 CreditCharge;    /* MBZ */
        __le32 Status;          /* Error from server */
        __le16 Command;
        __le16 CreditRequest;   /* CreditResponse */
        __le32 Flags;
        __le32 NextCommand;
        __le64 MessageId;
        union {
                struct {
                        __le32 ProcessId;
                        __le32  TreeId;
                } __packed SyncId;
                __le64  AsyncId;
        } __packed Id;
        __le64  SessionId;
        __u8   Signature[16];
} __packed;

struct smb3_hdr_req {
        __le32 ProtocolId;      /* 0xFE 'S' 'M' 'B' */
        __le16 StructureSize;   /* 64 */
        __le16 CreditCharge;    /* MBZ */
        __le16 ChannelSequence; /* See MS-SMB2 3.2.4.1 and 3.2.7.1 */
        __le16 Reserved;
        __le16 Command;
        __le16 CreditRequest;   /* CreditResponse */
        __le32 Flags;
        __le32 NextCommand;
        __le64 MessageId;
        union {
                struct {
                        __le32 ProcessId;
                        __le32  TreeId;
                } __packed SyncId;
                __le64  AsyncId;
        } __packed Id;
        __le64  SessionId;
        __u8   Signature[16];
} __packed;

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

#define SMB2_ERROR_STRUCTURE_SIZE2      9
#define SMB2_ERROR_STRUCTURE_SIZE2_LE   cpu_to_le16(SMB2_ERROR_STRUCTURE_SIZE2)

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

#define SMB3_AES_CCM_NONCE 11
#define SMB3_AES_GCM_NONCE 12

/* Transform flags (for 3.0 dialect this flag indicates CCM */
#define TRANSFORM_FLAG_ENCRYPTED        0x0001
struct smb2_transform_hdr {
        __le32 ProtocolId;      /* 0xFD 'S' 'M' 'B' */
        __u8   Signature[16];
        __u8   Nonce[16];
        __le32 OriginalMessageSize;
        __u16  Reserved1;
        __le16 Flags; /* EncryptionAlgorithm for 3.0, enc enabled for 3.1.1 */
        __le64  SessionId;
} __packed;

/*
 * These are simplified versions from the spec, as we don't need a fully fledged
 * form of both unchained and chained structs.
 *
 * Moreover, even in chained compressed payloads, the initial compression header
 * has the form of the unchained one -- i.e. it never has the
 * OriginalPayloadSize field and ::Offset field always represent an offset
 * (instead of a length, as it is in the chained header).
 *
 * See MS-SMB2 2.2.42 for more details.
 */
#define SMB2_COMPRESSION_FLAG_NONE      0x0000
#define SMB2_COMPRESSION_FLAG_CHAINED   0x0001

struct smb2_compression_hdr {
        __le32 ProtocolId; /* 0xFC 'S' 'M' 'B' */
        __le32 OriginalCompressedSegmentSize;
        __le16 CompressionAlgorithm;
        __le16 Flags;
        __le32 Offset; /* this is the size of the uncompressed SMB2 header below */
        /* uncompressed SMB2 header (READ or WRITE) goes here */
        /* compressed data goes here */
} __packed;

/*
 * ... OTOH, set compression payload header to always have OriginalPayloadSize
 * as it's easier to pass the struct size minus sizeof(OriginalPayloadSize)
 * than to juggle around the header/data memory.
 */
struct smb2_compression_payload_hdr {
        __le16  CompressionAlgorithm;
        __le16  Flags;
        __le32  Length; /* length of compressed playload including field below if present */
        __le32 OriginalPayloadSize; /* accounted when LZNT1, LZ77, LZ77+Huffman */
} __packed;

struct smb2_compression_pattern_v1 {
        __u8    Pattern;
        __u8    Reserved1;
        __le16  Reserved2;
        __le32  Repetitions;
} __packed;

/* See MS-SMB2 section 2.2.9.2 */
/* Context Types */
#define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
#define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)

struct tree_connect_contexts {
        __le16 ContextType;
        __le16 DataLength;
        __le32 Reserved;
        __u8   Data[];
} __packed;

/* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
struct smb3_blob_data {
        __le16 BlobSize;
        __u8   BlobData[];
} __packed;

/* Valid values for Attr */
#define SE_GROUP_MANDATORY              0x00000001
#define SE_GROUP_ENABLED_BY_DEFAULT     0x00000002
#define SE_GROUP_ENABLED                0x00000004
#define SE_GROUP_OWNER                  0x00000008
#define SE_GROUP_USE_FOR_DENY_ONLY      0x00000010
#define SE_GROUP_INTEGRITY              0x00000020
#define SE_GROUP_INTEGRITY_ENABLED      0x00000040
#define SE_GROUP_RESOURCE               0x20000000
#define SE_GROUP_LOGON_ID               0xC0000000

struct sid_array_data {
        __le16 SidAttrCount;
        /* SidAttrList - array of sid_attr_data structs */
} __packed;

/* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
struct sid_attr_data {
        __le16 BlobSize;
        __u8 BlobData[];
        /* __le32 Attr */
} __packed;

/*
 * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
 * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
 */

struct privilege_array_data {
        __le16 PrivilegeCount;
        /* array of privilege_data structs */
} __packed;

struct remoted_identity_tcon_context {
        __le16 TicketType; /* must be 0x0001 */
        __le16 TicketSize; /* total size of this struct */
        __le16 User; /* offset to SID_ATTR_DATA struct with user info */
        __le16 UserName; /* offset to null terminated Unicode username string */
        __le16 Domain; /* offset to null terminated Unicode domain name */
        __le16 Groups; /* offset to SID_ARRAY_DATA struct with group info */
        __le16 RestrictedGroups; /* similar to above */
        __le16 Privileges; /* offset to PRIVILEGE_ARRAY_DATA struct */
        __le16 PrimaryGroup; /* offset to SID_ARRAY_DATA struct */
        __le16 Owner; /* offset to BLOB_DATA struct */
        __le16 DefaultDacl; /* offset to BLOB_DATA struct */
        __le16 DeviceGroups; /* offset to SID_ARRAY_DATA struct */
        __le16 UserClaims; /* offset to BLOB_DATA struct */
        __le16 DeviceClaims; /* offset to BLOB_DATA struct */
        __u8   TicketInfo[]; /* variable length buf - remoted identity data */
} __packed;

struct smb2_tree_connect_req_extension {
        __le32 TreeConnectContextOffset;
        __le16 TreeConnectContextCount;
        __u8  Reserved[10];
        __u8  PathName[]; /* variable sized array */
        /* followed by array of TreeConnectContexts */
} __packed;

/* Flags/Reserved for SMB3.1.1 */
#define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
#define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
#define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)

struct smb2_tree_connect_req {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 9 */
        __le16 Flags;           /* Flags in SMB3.1.1 */
        __le16 PathOffset;
        __le16 PathLength;
        __u8   Buffer[];        /* variable length */
} __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 SMB2_SHAREFLAG_RESTRICT_EXCLUSIVE_OPENS         0x00000100
#define SMB2_SHAREFLAG_FORCE_SHARED_DELETE              0x00000200
#define SMB2_SHAREFLAG_ALLOW_NAMESPACE_CACHING          0x00000400
#define SMB2_SHAREFLAG_ACCESS_BASED_DIRECTORY_ENUM      0x00000800
#define SMB2_SHAREFLAG_FORCE_LEVELII_OPLOCK             0x00001000
#define SMB2_SHAREFLAG_ENABLE_HASH_V1                   0x00002000
#define SMB2_SHAREFLAG_ENABLE_HASH_V2                   0x00004000
#define SHI1005_FLAGS_ENCRYPT_DATA                      0x00008000
#define SMB2_SHAREFLAG_IDENTITY_REMOTING                0x00040000 /* 3.1.1 */
#define SMB2_SHAREFLAG_COMPRESS_DATA                    0x00100000 /* 3.1.1 */
#define SMB2_SHAREFLAG_ISOLATED_TRANSPORT               0x00200000
#define SHI1005_FLAGS_ALL                               0x0034FF33

/* 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 */
#define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */

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;

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;


/*
 * SMB2_NEGOTIATE_PROTOCOL  See MS-SMB2 section 2.2.3
 */
/* SecurityMode flags */
#define SMB2_NEGOTIATE_SIGNING_ENABLED     0x0001
#define SMB2_NEGOTIATE_SIGNING_ENABLED_LE  cpu_to_le16(0x0001)
#define SMB2_NEGOTIATE_SIGNING_REQUIRED    0x0002
#define SMB2_NEGOTIATE_SIGNING_REQUIRED_LE cpu_to_le16(0x0002)
#define SMB2_SEC_MODE_FLAGS_ALL            0x0003

/* 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 */
#define SMB2_GLOBAL_CAP_NOTIFICATIONS   0x00000080 /* New to SMB3.1.1 */
/* Internal types */
#define SMB2_NT_FIND                    0x00100000
#define SMB2_LARGE_FILES                0x00200000

#define SMB2_CLIENT_GUID_SIZE           16
#define SMB2_CREATE_GUID_SIZE           16

/* Dialects */
#define SMB10_PROT_ID  0x0000 /* local only, not sent on wire w/CIFS negprot */
#define SMB20_PROT_ID  0x0202
#define SMB21_PROT_ID  0x0210
#define SMB2X_PROT_ID  0x02FF
#define SMB30_PROT_ID  0x0300
#define SMB302_PROT_ID 0x0302
#define SMB311_PROT_ID 0x0311
#define BAD_PROT_ID    0xFFFF

#define SMB311_SALT_SIZE                        32
/* Hash Algorithm Types */
#define SMB2_PREAUTH_INTEGRITY_SHA512   cpu_to_le16(0x0001)
#define SMB2_PREAUTH_HASH_SIZE 64

/* Negotiate Contexts - ContextTypes. See MS-SMB2 section 2.2.3.1 for details */
#define SMB2_PREAUTH_INTEGRITY_CAPABILITIES     cpu_to_le16(1)
#define SMB2_ENCRYPTION_CAPABILITIES            cpu_to_le16(2)
#define SMB2_COMPRESSION_CAPABILITIES           cpu_to_le16(3)
#define SMB2_NETNAME_NEGOTIATE_CONTEXT_ID       cpu_to_le16(5)
#define SMB2_TRANSPORT_CAPABILITIES             cpu_to_le16(6)
#define SMB2_RDMA_TRANSFORM_CAPABILITIES        cpu_to_le16(7)
#define SMB2_SIGNING_CAPABILITIES               cpu_to_le16(8)
#define SMB2_POSIX_EXTENSIONS_AVAILABLE         cpu_to_le16(0x100)

struct smb2_neg_context {
        __le16  ContextType;
        __le16  DataLength;
        __le32  Reserved;
        /* Followed by array of data. NOTE: some servers require padding to 8 byte boundary */
} __packed;

/*
 * SaltLength that the server send can be zero, so the only three required
 * fields (all __le16) end up six bytes total, so the minimum context data len
 * in the response is six bytes which accounts for
 *
 *      HashAlgorithmCount, SaltLength, and 1 HashAlgorithm.
 */
#define MIN_PREAUTH_CTXT_DATA_LEN 6

struct smb2_preauth_neg_context {
        __le16  ContextType; /* 1 */
        __le16  DataLength;
        __le32  Reserved;
        __le16  HashAlgorithmCount; /* 1 */
        __le16  SaltLength;
        __le16  HashAlgorithms; /* HashAlgorithms[0] since only one defined */
        __u8    Salt[SMB311_SALT_SIZE];
} __packed;

/* Encryption Algorithms Ciphers */
#define SMB2_ENCRYPTION_AES128_CCM      cpu_to_le16(0x0001)
#define SMB2_ENCRYPTION_AES128_GCM      cpu_to_le16(0x0002)
#define SMB2_ENCRYPTION_AES256_CCM      cpu_to_le16(0x0003)
#define SMB2_ENCRYPTION_AES256_GCM      cpu_to_le16(0x0004)

/* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
#define MIN_ENCRYPT_CTXT_DATA_LEN       4
struct smb2_encryption_neg_context {
        __le16  ContextType; /* 2 */
        __le16  DataLength;
        __le32  Reserved;
        /* CipherCount usually 2, but can be 3 when AES256-GCM enabled */
        __le16  CipherCount; /* AES128-GCM and AES128-CCM by default */
        __le16  Ciphers[];
} __packed;

/* See MS-SMB2 2.2.3.1.3 */
#define SMB3_COMPRESS_NONE      cpu_to_le16(0x0000)
#define SMB3_COMPRESS_LZNT1     cpu_to_le16(0x0001)
#define SMB3_COMPRESS_LZ77      cpu_to_le16(0x0002)
#define SMB3_COMPRESS_LZ77_HUFF cpu_to_le16(0x0003)
/* Pattern scanning algorithm See MS-SMB2 3.1.4.4.1 */
#define SMB3_COMPRESS_PATTERN   cpu_to_le16(0x0004) /* Pattern_V1 */
#define SMB3_COMPRESS_LZ4       cpu_to_le16(0x0005)

/* Compression Flags */
#define SMB2_COMPRESSION_CAPABILITIES_FLAG_NONE         cpu_to_le32(0x00000000)
#define SMB2_COMPRESSION_CAPABILITIES_FLAG_CHAINED      cpu_to_le32(0x00000001)

struct smb2_compression_capabilities_context {
        __le16  ContextType; /* 3 */
        __le16  DataLength;
        __le32  Reserved;
        __le16  CompressionAlgorithmCount;
        __le16  Padding;
        __le32  Flags;
        __le16  CompressionAlgorithms[3];
        __u16   Pad;  /* Some servers require pad to DataLen multiple of 8 */
        /* Check if pad needed */
} __packed;

/*
 * For smb2_netname_negotiate_context_id See MS-SMB2 2.2.3.1.4.
 * Its struct simply contains NetName, an array of Unicode characters
 */
struct smb2_netname_neg_context {
        __le16  ContextType; /* 5 */
        __le16  DataLength;
        __le32  Reserved;
        __le16  NetName[]; /* hostname of target converted to UCS-2 */
} __packed;

/*
 * For smb2_transport_capabilities context see MS-SMB2 2.2.3.1.5
 * and 2.2.4.1.5
 */

/* Flags */
#define SMB2_ACCEPT_TRANSPORT_LEVEL_SECURITY    0x00000001

struct smb2_transport_capabilities_context {
        __le16  ContextType; /* 6 */
        __le16  DataLength;
        __u32   Reserved;
        __le32  Flags;
        __u32   Pad;
} __packed;

/*
 * For rdma transform capabilities context see MS-SMB2 2.2.3.1.6
 * and 2.2.4.1.6
 */

/* RDMA Transform IDs */
#define SMB2_RDMA_TRANSFORM_NONE        0x0000
#define SMB2_RDMA_TRANSFORM_ENCRYPTION  0x0001
#define SMB2_RDMA_TRANSFORM_SIGNING     0x0002

struct smb2_rdma_transform_capabilities_context {
        __le16  ContextType; /* 7 */
        __le16  DataLength;
        __u32   Reserved;
        __le16  TransformCount;
        __u16   Reserved1;
        __u32   Reserved2;
        __le16  RDMATransformIds[];
} __packed;

/*
 * For signing capabilities context see MS-SMB2 2.2.3.1.7
 * and 2.2.4.1.7
 */

/* Signing algorithms */
#define SIGNING_ALG_HMAC_SHA256    0
#define SIGNING_ALG_HMAC_SHA256_LE cpu_to_le16(0)
#define SIGNING_ALG_AES_CMAC       1
#define SIGNING_ALG_AES_CMAC_LE    cpu_to_le16(1)
#define SIGNING_ALG_AES_GMAC       2
#define SIGNING_ALG_AES_GMAC_LE    cpu_to_le16(2)

struct smb2_signing_capabilities {
        __le16  ContextType; /* 8 */
        __le16  DataLength;
        __le32  Reserved;
        __le16  SigningAlgorithmCount;
        __le16  SigningAlgorithms[];
        /*  Followed by padding to 8 byte boundary (required by some servers) */
} __packed;

#define POSIX_CTXT_DATA_LEN     16
struct smb2_posix_neg_context {
        __le16  ContextType; /* 0x100 */
        __le16  DataLength;
        __le32  Reserved;
        __u8    Name[16]; /* POSIX ctxt GUID 93AD25509CB411E7B42383DE968BCD7C */
} __packed;

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];
        /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
        __le32 NegotiateContextOffset; /* SMB3.1.1 only. MBZ earlier */
        __le16 NegotiateContextCount;  /* SMB3.1.1 only. MBZ earlier */
        __le16 Reserved2;
        __le16 Dialects[];
} __packed;

struct smb2_negotiate_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 65 */
        __le16 SecurityMode;
        __le16 DialectRevision;
        __le16 NegotiateContextCount;   /* Prior to SMB3.1.1 was Reserved & MBZ */
        __u8   ServerGUID[16];
        __le32 Capabilities;
        __le32 MaxTransactSize;
        __le32 MaxReadSize;
        __le32 MaxWriteSize;
        __le64 SystemTime;      /* MBZ */
        __le64 ServerStartTime;
        __le16 SecurityBufferOffset;
        __le16 SecurityBufferLength;
        __le32 NegotiateContextOffset;  /* Pre:SMB3.1.1 was reserved/ignored */
        __u8   Buffer[];        /* variable length GSS security buffer */
} __packed;


/*
 * SMB2_SESSION_SETUP  See MS-SMB2 section 2.2.5
 */
/* Flags */
#define SMB2_SESSION_REQ_FLAG_BINDING           0x01
#define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA      0x04

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

/* Currently defined SessionFlags */
#define SMB2_SESSION_FLAG_IS_GUEST        0x0001
#define SMB2_SESSION_FLAG_IS_GUEST_LE     cpu_to_le16(0x0001)
#define SMB2_SESSION_FLAG_IS_NULL         0x0002
#define SMB2_SESSION_FLAG_IS_NULL_LE      cpu_to_le16(0x0002)
#define SMB2_SESSION_FLAG_ENCRYPT_DATA    0x0004
#define SMB2_SESSION_FLAG_ENCRYPT_DATA_LE cpu_to_le16(0x0004)

struct smb2_sess_setup_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 9 */
        __le16 SessionFlags;
        __le16 SecurityBufferOffset;
        __le16 SecurityBufferLength;
        __u8   Buffer[];        /* variable length GSS security buffer */
} __packed;


/*
 * SMB2_LOGOFF  See MS-SMB2 section 2.2.7
 */
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;


/*
 * SMB2_CLOSE  See MS-SMB2 section 2.2.15
 */
/* 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;

/*
 * Maximum size of a SMB2_CLOSE response is 64 (smb2 header) + 60 (data)
 */
#define MAX_SMB2_CLOSE_RESPONSE_SIZE 124

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


/*
 * SMB2_READ  See MS-SMB2 section 2.2.19
 */
/* For read request Flags field below, following flag is defined for SMB3.02 */
#define SMB2_READFLAG_READ_UNBUFFERED   0x01
#define SMB2_READFLAG_REQUEST_COMPRESSED 0x02 /* See MS-SMB2 2.2.19 */

/* Channel field for read and write: exactly one of following flags can be set*/
#define SMB2_CHANNEL_NONE               cpu_to_le32(0x00000000)
#define SMB2_CHANNEL_RDMA_V1            cpu_to_le32(0x00000001)
#define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002)
#define SMB2_CHANNEL_RDMA_TRANSFORM     cpu_to_le32(0x00000003)

/* SMB2 read request without RFC1001 length at the beginning */
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;
        __u64  VolatileFileId;
        __le32 MinimumCount;
        __le32 Channel; /* MBZ except for SMB3 or later */
        __le32 RemainingBytes;
        __le16 ReadChannelInfoOffset;
        __le16 ReadChannelInfoLength;
        __u8   Buffer[];
} __packed;

/* Read flags */
#define SMB2_READFLAG_RESPONSE_NONE            cpu_to_le32(0x00000000)
#define SMB2_READFLAG_RESPONSE_RDMA_TRANSFORM  cpu_to_le32(0x00000001)

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


/*
 * SMB2_WRITE  See MS-SMB2 section 2.2.21
 */
/* 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; /* MBZ unless SMB3.02 or later */
        __le32 RemainingBytes;
        __le16 WriteChannelInfoOffset;
        __le16 WriteChannelInfoLength;
        __le32 Flags;
        __u8   Buffer[];
} __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[];
} __packed;


/*
 * SMB2_FLUSH  See MS-SMB2 section 2.2.17
 */
struct smb2_flush_req {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 24 */
        __le16 Reserved1;
        __le32 Reserved2;
        __u64  PersistentFileId;
        __u64  VolatileFileId;
} __packed;

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

#define SMB2_LOCKFLAG_SHARED            0x0001
#define SMB2_LOCKFLAG_EXCLUSIVE         0x0002
#define SMB2_LOCKFLAG_UNLOCK            0x0004
#define SMB2_LOCKFLAG_FAIL_IMMEDIATELY  0x0010
#define SMB2_LOCKFLAG_MASK              0x0007

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;
        /*
         * The least significant four bits are the index, the other 28 bits are
         * the lock sequence number (0 to 64). See MS-SMB2 2.2.26
         */
        __le32 LockSequenceNumber;
        __u64  PersistentFileId;
        __u64  VolatileFileId;
        /* Followed by at least one */
        union {
                struct smb2_lock_element lock;
                DECLARE_FLEX_ARRAY(struct smb2_lock_element, locks);
        };
} __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;

/*
 * Valid FileInformation classes for query directory
 *
 * Note that these are a subset of the (file) QUERY_INFO levels defined
 * later in this file (but since QUERY_DIRECTORY uses equivalent numbers
 * we do not redefine them here)
 *
 * FileDirectoryInfomation              0x01
 * FileFullDirectoryInformation         0x02
 * FileIdFullDirectoryInformation       0x26
 * FileBothDirectoryInformation         0x03
 * FileIdBothDirectoryInformation       0x25
 * FileNamesInformation                 0x0C
 * FileIdExtdDirectoryInformation       0x3C
 */

/* 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;
        __u64  VolatileFileId;
        __le16 FileNameOffset;
        __le16 FileNameLength;
        __le32 OutputBufferLength;
        __u8   Buffer[];
} __packed;

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

/* DeviceType Flags */
#define FILE_DEVICE_CD_ROM              0x00000002
#define FILE_DEVICE_CD_ROM_FILE_SYSTEM  0x00000003
#define FILE_DEVICE_DFS                 0x00000006
#define FILE_DEVICE_DISK                0x00000007
#define FILE_DEVICE_DISK_FILE_SYSTEM    0x00000008
#define FILE_DEVICE_FILE_SYSTEM         0x00000009
#define FILE_DEVICE_NAMED_PIPE          0x00000011
#define FILE_DEVICE_NETWORK             0x00000012
#define FILE_DEVICE_NETWORK_FILE_SYSTEM 0x00000014
#define FILE_DEVICE_NULL                0x00000015
#define FILE_DEVICE_PARALLEL_PORT       0x00000016
#define FILE_DEVICE_PRINTER             0x00000018
#define FILE_DEVICE_SERIAL_PORT         0x0000001b
#define FILE_DEVICE_STREAMS             0x0000001e
#define FILE_DEVICE_TAPE                0x0000001f
#define FILE_DEVICE_TAPE_FILE_SYSTEM    0x00000020
#define FILE_DEVICE_VIRTUAL_DISK        0x00000024
#define FILE_DEVICE_NETWORK_REDIRECTOR  0x00000028

/* Device Characteristics */
#define FILE_REMOVABLE_MEDIA                    0x00000001
#define FILE_READ_ONLY_DEVICE                   0x00000002
#define FILE_FLOPPY_DISKETTE                    0x00000004
#define FILE_WRITE_ONCE_MEDIA                   0x00000008
#define FILE_REMOTE_DEVICE                      0x00000010
#define FILE_DEVICE_IS_MOUNTED                  0x00000020
#define FILE_VIRTUAL_VOLUME                     0x00000040
#define FILE_DEVICE_SECURE_OPEN                 0x00000100
#define FILE_CHARACTERISTIC_TS_DEVICE           0x00001000
#define FILE_CHARACTERISTIC_WEBDAV_DEVICE       0x00002000
#define FILE_PORTABLE_DEVICE                    0x00004000
#define FILE_DEVICE_ALLOW_APPCONTAINER_TRAVERSAL 0x00020000

/*
 * Maximum number of iovs we need for a set-info request.
 * The largest one is rename/hardlink
 * [0] : struct smb2_set_info_req + smb2_file_[rename|link]_info
 * [1] : path
 * [2] : compound padding
 */
#define SMB2_SET_INFO_IOV_SIZE 3

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;
        __u64  VolatileFileId;
        __u8   Buffer[];
} __packed;

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

/*
 * SMB2_NOTIFY  See MS-SMB2 section 2.2.35
 */
/* notify flags */
#define SMB2_WATCH_TREE                 0x0001

/* notify completion filter flags. See MS-FSCC 2.6 and MS-SMB2 2.2.35 */
#define FILE_NOTIFY_CHANGE_FILE_NAME            0x00000001
#define FILE_NOTIFY_CHANGE_DIR_NAME             0x00000002
#define FILE_NOTIFY_CHANGE_NAME                 0x00000003
#define FILE_NOTIFY_CHANGE_ATTRIBUTES           0x00000004
#define FILE_NOTIFY_CHANGE_SIZE                 0x00000008
#define FILE_NOTIFY_CHANGE_LAST_WRITE           0x00000010
#define FILE_NOTIFY_CHANGE_LAST_ACCESS          0x00000020
#define FILE_NOTIFY_CHANGE_CREATION             0x00000040
#define FILE_NOTIFY_CHANGE_EA                   0x00000080
#define FILE_NOTIFY_CHANGE_SECURITY             0x00000100
#define FILE_NOTIFY_CHANGE_STREAM_NAME          0x00000200
#define FILE_NOTIFY_CHANGE_STREAM_SIZE          0x00000400
#define FILE_NOTIFY_CHANGE_STREAM_WRITE         0x00000800

/*
 * SMB2 Notify Action Flags
 * See MS-FSCC 2.7.1
 */
#define FILE_ACTION_ADDED                       0x00000001
#define FILE_ACTION_REMOVED                     0x00000002
#define FILE_ACTION_MODIFIED                    0x00000003
#define FILE_ACTION_RENAMED_OLD_NAME            0x00000004
#define FILE_ACTION_RENAMED_NEW_NAME            0x00000005
#define FILE_ACTION_ADDED_STREAM                0x00000006
#define FILE_ACTION_REMOVED_STREAM              0x00000007
#define FILE_ACTION_MODIFIED_STREAM             0x00000008
#define FILE_ACTION_REMOVED_BY_DELETE           0x00000009
#define FILE_ACTION_ID_NOT_TUNNELLED            0x0000000A
#define FILE_ACTION_TUNNELLED_ID_COLLISION      0x0000000B

/* See MS-SMB2 2.2.35 */
struct smb2_change_notify_req {
        struct smb2_hdr hdr;
        __le16  StructureSize;
        __le16  Flags;
        __le32  OutputBufferLength;
        __u64   PersistentFileId; /* opaque endianness */
        __u64   VolatileFileId; /* opaque endianness */
        __le32  CompletionFilter;
        __u32   Reserved;
} __packed;

/* See MS-SMB2 2.2.36 */
struct smb2_change_notify_rsp {
        struct smb2_hdr hdr;
        __le16  StructureSize;  /* Must be 9 */
        __le16  OutputBufferOffset;
        __le32  OutputBufferLength;
        __u8    Buffer[]; /* array of file notify structs */
} __packed;

/*
 * SMB2_SERVER_TO_CLIENT_NOTIFICATION: See MS-SMB2 section 2.2.44
 */

#define SMB2_NOTIFY_SESSION_CLOSED      0x0000

struct smb2_server_client_notification {
        struct smb2_hdr hdr;
        __le16  StructureSize;
        __u16   Reserved; /* MBZ */
        __le32  NotificationType;
        __u8    NotificationBuffer[4]; /* MBZ */
} __packed;

/*
 * SMB2_CREATE  See MS-SMB2 section 2.2.13
 */
/* 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

/* Impersonation Levels. See MS-WPO section 9.7 and MSDN-IMPERS */
#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)

/* Desired Access Flags */
#define FILE_READ_DATA_LE               cpu_to_le32(0x00000001)
#define FILE_LIST_DIRECTORY_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_ADD_SUBDIRECTORY_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_DELETE_CHILD_LE            cpu_to_le32(0x00000040)
#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)
#define DESIRED_ACCESS_MASK             cpu_to_le32(0xF21F01FF)


#define FILE_READ_DESIRED_ACCESS_LE     (FILE_READ_DATA_LE        |     \
                                         FILE_READ_EA_LE          |     \
                                         FILE_GENERIC_READ_LE)
#define FILE_WRITE_DESIRE_ACCESS_LE     (FILE_WRITE_DATA_LE       |     \
                                         FILE_APPEND_DATA_LE      |     \
                                         FILE_WRITE_EA_LE         |     \
                                         FILE_WRITE_ATTRIBUTES_LE |     \
                                         FILE_GENERIC_WRITE_LE)

/* 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)
#define FILE_CREATE_MASK_LE             cpu_to_le32(0x00000007)

/* 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_BUFFERING_LE cpu_to_le32(0x00000008)
/* FILE_SYNCHRONOUS_IO_ALERT_LE         cpu_to_le32(0x00000010) should be zero, ignored */
/* FILE_SYNCHRONOUS_IO_NONALERT         cpu_to_le32(0x00000020) should be zero, ignored */
#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)
/* FILE_OPEN_REMOTE_INSTANCE            cpu_to_le32(0x00000400) should be zero, ignored */
#define FILE_RANDOM_ACCESS_LE           cpu_to_le32(0x00000800)
#define FILE_DELETE_ON_CLOSE_LE         cpu_to_le32(0x00001000) /* MBZ */
#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)
/* FILE_OPEN_REQUIRING_OPLOCK           cpu_to_le32(0x00010000) should be zero, ignored */
/* FILE_DISALLOW_EXCLUSIVE              cpu_to_le32(0x00020000) should be zero, ignored */
/* FILE_RESERVE_OPFILTER                cpu_to_le32(0x00100000) MBZ */
#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 cpu_to_le32(0x00800000) should be zero, ignored */
#define CREATE_OPTIONS_MASK_LE          cpu_to_le32(0x00FFFFFF)

#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)

/* 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             "AlSi"
#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_TAG_POSIX           "\x93\xAD\x25\x50\x9C\xB4\x11\xE7\xB4\x23\x83\xDE\x96\x8B\xCD\x7C"
#define SMB2_CREATE_APP_INSTANCE_ID     "\x45\xBC\xA6\x6A\xEF\xA7\xF7\x4A\x90\x08\xFA\x46\x2E\x14\x4D\x74"
#define SMB2_CREATE_APP_INSTANCE_VERSION "\xB9\x82\xD0\xB7\x3B\x56\x07\x4F\xA0\x7B\x52\x4A\x81\x16\xA0\x10"
#define SVHDX_OPEN_DEVICE_CONTEXT       "\x9C\xCB\xCF\x9E\x04\xC1\xE6\x43\x98\x0E\x15\x8D\xA1\xF6\xEC\x83"
#define SMB2_CREATE_TAG_AAPL                    "AAPL"

/* Flag (SMB3 open response) values */
#define SMB2_CREATE_FLAG_REPARSEPOINT 0x01

struct create_context {
        /* New members must be added within the struct_group() macro below. */
        __struct_group(create_context_hdr, hdr, __packed,
                __le32 Next;
                __le16 NameOffset;
                __le16 NameLength;
                __le16 Reserved;
                __le16 DataOffset;
                __le32 DataLength;
        );
        __u8 Buffer[];
} __packed;
static_assert(offsetof(struct create_context, Buffer) == sizeof(struct create_context_hdr),
              "struct member likely outside of __struct_group()");

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[];
} __packed;

struct smb2_create_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize;   /* Must be 89 */
        __u8   OplockLevel;
        __u8   Flags;  /* 0x01 if reparse point */
        __le32 CreateAction;
        __le64 CreationTime;
        __le64 LastAccessTime;
        __le64 LastWriteTime;
        __le64 ChangeTime;
        __le64 AllocationSize;
        __le64 EndofFile;
        __le32 FileAttributes;
        __le32 Reserved2;
        __u64  PersistentFileId;
        __u64  VolatileFileId;
        __le32 CreateContextsOffset;
        __le32 CreateContextsLength;
        __u8   Buffer[];
} __packed;

struct create_posix {
        struct create_context_hdr ccontext;
        __u8    Name[16];
        __le32  Mode;
        __u32   Reserved;
} __packed;

/* See MS-SMB2 2.2.13.2.3 and MS-SMB2 2.2.13.2.4 */
typedef struct {
        struct create_context_hdr ccontext;
        __u8   Name[8];
        union {
                __u8  Reserved[16];
                struct {
                        __u64 PersistentFileId;
                        __u64 VolatileFileId;
                } Fid;
        } Data;
} __packed create_durable_req_t, create_durable_reconn_t;

/* See MS-SMB2 2.2.13.2.5 */
struct create_mxac_req {
        struct create_context_hdr ccontext;
        __u8   Name[8];
        __le64 Timestamp;
} __packed;

/*
 * Flags
 * See MS-SMB2 2.2.13.2.11
 *     MS-SMB2 2.2.13.2.12
 *     MS-SMB2 2.2.14.2.12
 */
#define SMB2_DHANDLE_FLAG_PERSISTENT    0x00000002

/* See MS-SMB2 2.2.13.2.11 */
struct durable_context_v2_req {
        __le32 Timeout;
        __le32 Flags; /* see SMB2_DHANDLE_FLAG_PERSISTENT */
        __u64 Reserved;
        __u8 CreateGuid[16];
} __packed;

struct create_durable_req_v2 {
        struct create_context_hdr ccontext;
        __u8   Name[8];
        struct durable_context_v2_req dcontext;
} __packed;

/* See MS-SMB2 2.2.13.2.12 */
struct durable_reconnect_context_v2 {
        struct {
                __u64 PersistentFileId;
                __u64 VolatileFileId;
        } Fid;
        __u8 CreateGuid[16];
        __le32 Flags; /* see SMB2_DHANDLE_FLAG_PERSISTENT */
} __packed;

struct create_durable_handle_reconnect_v2 {
        struct create_context_hdr ccontext;
        __u8   Name[8];
        struct durable_reconnect_context_v2 dcontext;
        __u8 Pad[4];
} __packed;

/* See MS-SMB2 2.2.14.2.12 */
struct durable_context_v2_rsp {
        __le32 Timeout;
        __le32 Flags; /* see SMB2_DHANDLE_FLAG_PERSISTENT */
} __packed;

struct create_durable_rsp_v2 {
        struct create_context_hdr ccontext;
        __u8   Name[8];
        struct durable_context_v2_rsp dcontext;
} __packed;

/* See MS-SMB2 2.2.14.2.5 */
struct create_mxac_rsp {
        struct create_context_hdr ccontext;
        __u8   Name[8];
        __le32 QueryStatus;
        __le32 MaximalAccess;
} __packed;

#define SMB2_LEASE_NONE_LE                      cpu_to_le32(0x00)
#define SMB2_LEASE_READ_CACHING_LE              cpu_to_le32(0x01)
#define SMB2_LEASE_HANDLE_CACHING_LE            cpu_to_le32(0x02)
#define SMB2_LEASE_WRITE_CACHING_LE             cpu_to_le32(0x04)

#define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS_LE    cpu_to_le32(0x02)
#define SMB2_LEASE_FLAG_PARENT_LEASE_KEY_SET_LE cpu_to_le32(0x04)

#define SMB2_LEASE_KEY_SIZE                     16

/* See MS-SMB2 2.2.13.2.8 */
struct lease_context {
        __u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
        __le32 LeaseState;
        __le32 LeaseFlags;
        __le64 LeaseDuration;
} __packed;

/* See MS-SMB2 2.2.13.2.10 */
struct lease_context_v2 {
        __u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
        __le32 LeaseState;
        __le32 LeaseFlags;
        __le64 LeaseDuration;
        __u8 ParentLeaseKey[SMB2_LEASE_KEY_SIZE];
        __le16 Epoch;
        __le16 Reserved;
} __packed;

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

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

/* See MS-SMB2 2.2.14.2.9 */
struct create_disk_id_rsp {
        struct create_context_hdr ccontext;
        __u8   Name[8];
        __le64 DiskFileId;
        __le64 VolumeId;
        __u8  Reserved[16];
} __packed;

/* See MS-SMB2 2.2.13.2.13 */
struct create_app_inst_id {
        struct create_context_hdr ccontext;
        __u8 Name[16];
        __le32 StructureSize; /* Must be 20 */
        __u16 Reserved;
        __u8 AppInstanceId[16];
} __packed;

/* See MS-SMB2 2.2.13.2.15 */
struct create_app_inst_id_vers {
        struct create_context_hdr ccontext;
        __u8 Name[16];
        __le32 StructureSize; /* Must be 24 */
        __u16 Reserved;
        __u32 Padding;
        __le64 AppInstanceVersionHigh;
        __le64 AppInstanceVersionLow;
} __packed;

/* See MS-SMB2 2.2.31 and 2.2.32 */
struct smb2_ioctl_req {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 57 */
        __le16 Reserved; /* offset from start of SMB2 header to write data */
        __le32 CtlCode;
        __u64  PersistentFileId;
        __u64  VolatileFileId;
        __le32 InputOffset; /* Reserved MBZ */
        __le32 InputCount;
        __le32 MaxInputResponse;
        __le32 OutputOffset;
        __le32 OutputCount;
        __le32 MaxOutputResponse;
        __le32 Flags;
        __le32 Reserved2;
        __u8   Buffer[];
} __packed;

/* See MS-SMB2 2.2.31.1.1 */
struct srv_copychunk {
        __le64 SourceOffset;
        __le64 TargetOffset;
        __le32 Length;
        __le32 Reserved;
} __packed;

#define COPY_CHUNK_RES_KEY_SIZE 24

/* See MS-SMB2 2.2.31.1 */
/* this goes in the ioctl buffer when doing a copychunk request */
struct copychunk_ioctl_req {
        union {
                char SourceKey[COPY_CHUNK_RES_KEY_SIZE];
                __le64 SourceKeyU64[3];
        };
        __le32 ChunkCount;
        __le32 Reserved;
        struct srv_copychunk Chunks[] __counted_by_le(ChunkCount);
} __packed;

/* See MS-SMB2 2.2.32.1 */
struct copychunk_ioctl_rsp {
        __le32 ChunksWritten;
        __le32 ChunkBytesWritten;
        __le32 TotalBytesWritten;
} __packed;

/* See MS-SMB2 2.2.32.3 */
struct resume_key_ioctl_rsp {
        union {
                char ResumeKey[COPY_CHUNK_RES_KEY_SIZE];
                __u64 ResumeKeyU64[3];
        };
        __le32  ContextLength;  /* MBZ */
        char    Context[];      /* ignored, Windows sets to 4 bytes of zero */
} __packed;

struct smb2_ioctl_rsp {
        struct smb2_hdr hdr;
        __le16 StructureSize; /* Must be 49 */
        __le16 Reserved;
        __le32 CtlCode;
        __u64  PersistentFileId;
        __u64  VolatileFileId;
        __le32 InputOffset; /* Reserved MBZ */
        __le32 InputCount;
        __le32 OutputOffset;
        __le32 OutputCount;
        __le32 Flags;
        __le32 Reserved2;
        __u8   Buffer[];
} __packed;

/* See MS-SMB2 2.2.32.5.1.1 */
struct smb_sockaddr_in {
        __be16 Port;
        __be32 IPv4Address;
        __u8   Reserved[8];
} __packed;

/* See MS-SMB2 2.2.32.5.1.2 */
struct smb_sockaddr_in6 {
        __be16 Port;
        __be32 FlowInfo;
        __u8   IPv6Address[16];
        __be32 ScopeId;
} __packed;

/* See MS-SMB2 2.2.32.5 and MS-SMB2 2.2.32.5.1 */
#define RSS_CAPABLE     cpu_to_le32(0x00000001)
#define RDMA_CAPABLE    cpu_to_le32(0x00000002)
#define INTERNETWORK    cpu_to_le16(0x0002)
#define INTERNETWORKV6  cpu_to_le16(0x0017)
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;
        union {
                char    SockAddr_Storage[128];
                struct {
                        __le16 Family;
                        __u8 Buffer[126];
                };
        };
} __packed;

/* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
struct file_zero_data_information {
        __le64  FileOffset;
        __le64  BeyondFinalZero;
} __packed;

/* See MS-FSCC 2.3.7 */
struct duplicate_extents_to_file {
        __u64 PersistentFileHandle; /* source file handle, opaque endianness */
        __u64 VolatileFileHandle;
        __le64 SourceFileOffset;
        __le64 TargetFileOffset;
        __le64 ByteCount;  /* Bytes to be copied */
} __packed;

/* See MS-FSCC 2.3.9 */
#define DUPLICATE_EXTENTS_DATA_EX_SOURCE_ATOMIC 0x00000001
struct duplicate_extents_to_file_ex {
        __le64 StructureSize; /* MUST be set to 0x30 */
        __u64 PersistentFileHandle; /* source file handle, opaque endianness */
        __u64 VolatileFileHandle;
        __le64 SourceFileOffset;
        __le64 TargetFileOffset;
        __le64 ByteCount;  /* Bytes to be copied */
        __le32 Flags;
        __le32 Reserved;
} __packed;


/* See MS-FSCC 2.3.20 */
struct fsctl_get_integrity_information_rsp {
        __le16  ChecksumAlgorithm;
        __le16  Reserved;
        __le32  Flags;
        __le32  ChecksumChunkSizeInBytes;
        __le32  ClusterSizeInBytes;
} __packed;

/* See MS-FSCC 2.3.55 */
struct fsctl_query_file_regions_req {
        __le64  FileOffset;
        __le64  Length;
        __le32  DesiredUsage;
        __le32  Reserved;
} __packed;

/* DesiredUsage flags see MS-FSCC 2.3.56.1 */
#define FILE_USAGE_INVALID_RANGE        0x00000000
#define FILE_USAGE_VALID_CACHED_DATA    0x00000001
#define FILE_USAGE_NONCACHED_DATA       0x00000002

struct file_region_info {
        __le64  FileOffset;
        __le64  Length;
        __le32  DesiredUsage;
        __le32  Reserved;
} __packed;

/* See MS-FSCC 2.3.56 */
struct fsctl_query_file_region_rsp {
        __le32 Flags;
        __le32 TotalRegionEntryCount;
        __le32 RegionEntryCount;
        __u32  Reserved;
        struct  file_region_info Regions[];
} __packed;

/* See MS-FSCC 2.3.58 */
struct fsctl_query_on_disk_vol_info_rsp {
        __le64  DirectoryCount;
        __le64  FileCount;
        __le16  FsFormatMajVersion;
        __le16  FsFormatMinVersion;
        __u8    FsFormatName[24];
        __le64  FormatTime;
        __le64  LastUpdateTime;
        __u8    CopyrightInfo[68];
        __u8    AbstractInfo[68];
        __u8    FormatImplInfo[68];
        __u8    LastModifyImplInfo[68];
} __packed;

/* See MS-FSCC 2.3.73 */
struct fsctl_set_integrity_information_req {
        __le16  ChecksumAlgorithm;
        __le16  Reserved;
        __le32  Flags;
} __packed;

/* See MS-FSCC 2.3.75 */
struct fsctl_set_integrity_info_ex_req {
        __u8    EnableIntegrity;
        __u8    KeepState;
        __u16   Reserved;
        __le32  Flags;
        __u8    Version;
        __u8    Reserved2[7];
} __packed;

/* Integrity ChecksumAlgorithm choices for above */
#define CHECKSUM_TYPE_NONE      0x0000
#define CHECKSUM_TYPE_CRC64     0x0002
#define CHECKSUM_TYPE_UNCHANGED 0xFFFF  /* set only */

/* Integrity flags for above */
#define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF   0x00000001

/* Reparse structures - see MS-FSCC 2.1.2 */

/* struct fsctl_reparse_info_req is empty, only response structs (see below) */
struct reparse_data_buffer {
        __le32  ReparseTag;
        __le16  ReparseDataLength;
        __u16   Reserved;
        __u8    DataBuffer[]; /* Variable Length */
} __packed;

struct reparse_guid_data_buffer {
        __le32  ReparseTag;
        __le16  ReparseDataLength;
        __u16   Reserved;
        __u8    ReparseGuid[16];
        __u8    DataBuffer[]; /* Variable Length */
} __packed;

struct reparse_mount_point_data_buffer {
        __le32  ReparseTag;
        __le16  ReparseDataLength;
        __u16   Reserved;
        __le16  SubstituteNameOffset;
        __le16  SubstituteNameLength;
        __le16  PrintNameOffset;
        __le16  PrintNameLength;
        __u8    PathBuffer[]; /* Variable Length */
} __packed;

#define SYMLINK_FLAG_RELATIVE 0x00000001

struct reparse_symlink_data_buffer {
        __le32  ReparseTag;
        __le16  ReparseDataLength;
        __u16   Reserved;
        __le16  SubstituteNameOffset;
        __le16  SubstituteNameLength;
        __le16  PrintNameOffset;
        __le16  PrintNameLength;
        __le32  Flags;
        __u8    PathBuffer[]; /* Variable Length */
} __packed;

/* For IO_REPARSE_TAG_NFS - see MS-FSCC 2.1.2.6 */
#define NFS_SPECFILE_LNK        0x00000000014B4E4C
#define NFS_SPECFILE_CHR        0x0000000000524843
#define NFS_SPECFILE_BLK        0x00000000004B4C42
#define NFS_SPECFILE_FIFO       0x000000004F464946
#define NFS_SPECFILE_SOCK       0x000000004B434F53
struct reparse_nfs_data_buffer {
        __le32  ReparseTag;
        __le16  ReparseDataLength;
        __u16   Reserved;
        __le64  InodeType; /* NFS_SPECFILE_* */
        __u8    DataBuffer[];
} __packed;

/* For IO_REPARSE_TAG_LX_SYMLINK - see MS-FSCC 2.1.2.7 */
struct reparse_wsl_symlink_data_buffer {
        __le32  ReparseTag;
        __le16  ReparseDataLength;
        __u16   Reserved;
        __le32  Version; /* Always 2 */
        __u8    Target[]; /* Variable Length UTF-8 string without nul-term */
} __packed;

struct validate_negotiate_info_req {
        __le32 Capabilities;
        __u8   Guid[SMB2_CLIENT_GUID_SIZE];
        __le16 SecurityMode;
        __le16 DialectCount;
        __le16 Dialects[4]; /* BB expand this if autonegotiate > 4 dialects */
} __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;


/* 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

/* SMB2 Query Info see MS-SMB2 (2.2.37) or MS-DTYP */

/* List of QUERY INFO levels (those also valid for QUERY_DIR are noted below */
#define FILE_DIRECTORY_INFORMATION      1       /* also for QUERY_DIR */
#define FILE_FULL_DIRECTORY_INFORMATION 2       /* also for QUERY_DIR */
#define FILE_BOTH_DIRECTORY_INFORMATION 3       /* also for QUERY_DIR */
#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      /* also for QUERY_DIR */
#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    /* also for QUERY_DIR */
#define FILEID_FULL_DIRECTORY_INFORMATION 38    /* also for QUERY_DIR */
#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
#define FILE_ID_INFORMATION             59
#define FILE_ID_EXTD_DIRECTORY_INFORMATION 60   /* also for QUERY_DIR */
/* Used for Query Info and Find File POSIX Info for SMB3.1.1 and SMB1 */
#define SMB_FIND_FILE_POSIX_INFO        0x064

/* Security info type additionalinfo flags. */
#define OWNER_SECINFO   0x00000001
#define GROUP_SECINFO   0x00000002
#define DACL_SECINFO   0x00000004
#define SACL_SECINFO   0x00000008
#define LABEL_SECINFO   0x00000010
#define ATTRIBUTE_SECINFO   0x00000020
#define SCOPE_SECINFO   0x00000040
#define BACKUP_SECINFO   0x00010000
#define UNPROTECTED_SACL_SECINFO   0x10000000
#define UNPROTECTED_DACL_SECINFO   0x20000000
#define PROTECTED_SACL_SECINFO   0x40000000
#define PROTECTED_DACL_SECINFO   0x80000000

/* Flags used for FileFullEAinfo */
#define SL_RESTART_SCAN         0x00000001
#define SL_RETURN_SINGLE_ENTRY  0x00000002
#define SL_INDEX_SPECIFIED      0x00000004

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;
        __u64  VolatileFileId;
        __u8   Buffer[];
} __packed;

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

/*
 *      PDU query infolevel structure definitions
 */

/* See MS-FSCC 2.3.52 */
struct file_allocated_range_buffer {
        __le64  file_offset;
        __le64  length;
} __packed;

struct smb2_file_internal_info {
        __le64 IndexNumber;
} __packed; /* level 6 Query */

struct smb2_file_rename_info { /* encoding of request for level 10 */
        /* New members MUST be added within the struct_group() macro below. */
        __struct_group(smb2_file_rename_info_hdr, __hdr, __packed,
                __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[];     /* New name to be assigned */
        /* padding - overall struct size must be >= 24 so filename + pad >= 6 */
} __packed; /* level 10 Set */
static_assert(offsetof(struct smb2_file_rename_info, FileName) == sizeof(struct smb2_file_rename_info_hdr),
              "struct member likely outside of __struct_group()");

struct smb2_file_link_info { /* encoding of request for level 11 */
        /* New members MUST be added within the struct_group() macro below. */
        __struct_group(smb2_file_link_info_hdr, __hdr, __packed,
                __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[];     /* Name to be assigned to new link */
} __packed; /* level 11 Set */
static_assert(offsetof(struct smb2_file_link_info, FileName) == sizeof(struct smb2_file_link_info_hdr),
              "struct member likely outside of __struct_group()");

/*
 * 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;
        union {
                char __pad;     /* Legacy structure padding */
                DECLARE_FLEX_ARRAY(char, FileName);
        };
} __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 */

/* Level 100 query info */
struct smb311_posix_qinfo {
        __le64 CreationTime;
        __le64 LastAccessTime;
        __le64 LastWriteTime;
        __le64 ChangeTime;
        __le64 EndOfFile;
        __le64 AllocationSize;
        __le32 DosAttributes;
        __le64 Inode;
        __le32 DeviceId;
        __le32 Zero;
        /* beginning of POSIX Create Context Response */
        __le32 HardLinks;
        __le32 ReparseTag;
        __le32 Mode;
        u8     Sids[];
        /*
         * var sized owner SID
         * var sized group SID
         * le32 filenamelength
         * u8  filename[]
         */
} __packed;

/* File System Information Classes */
#define FS_VOLUME_INFORMATION           1 /* Query */
#define FS_LABEL_INFORMATION            2 /* Set */
#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 /* Query */
#define FS_SECTOR_SIZE_INFORMATION      11 /* SMB3 or later. Query */
#define FS_POSIX_INFORMATION            100 /* SMB3.1.1 POSIX. 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 FSEffPhysicalBytesPerSectorForAtomicity;
        __le32 Flags;
        __le32 ByteOffsetForSectorAlignment;
        __le32 ByteOffsetForPartitionAlignment;
} __packed;

/* File System Control Information */
struct smb2_fs_control_info {
        __le64 FreeSpaceStartFiltering;
        __le64 FreeSpaceThreshold;
        __le64 FreeSpaceStopFiltering;
        __le64 DefaultQuotaThreshold;
        __le64 DefaultQuotaLimit;
        __le32 FileSystemControlFlags;
        __le32 Padding;
} __packed;

/* volume info struct - see MS-FSCC 2.5.9 */
#define MAX_VOL_LABEL_LEN       32
struct smb3_fs_vol_info {
        __le64  VolumeCreationTime;
        __u32   VolumeSerialNumber;
        __le32  VolumeLabelLength; /* includes trailing null */
        __u8    SupportsObjects; /* True if eg like NTFS, supports objects */
        __u8    Reserved;
        __u8    VolumeLabel[]; /* variable len */
} __packed;

/* See MS-SMB2 2.2.23 through 2.2.25 */
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 Epoch;
        __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;

#define OP_BREAK_STRUCT_SIZE_20         24
#define OP_BREAK_STRUCT_SIZE_21         36

/*
 * See MS-SMB2 2.2.13.1.1
 *     MS-SMB 2.2.1.4.1
 * These are the file access permission bits defined in CIFS for the
 * NTCreateAndX as well as the level 0x107
 * TRANS2_QUERY_PATH_INFORMATION API.  The level 0x107, SMB_QUERY_FILE_ALL_INFO
 * responds with the AccessFlags.
 * The AccessFlags specifies the access permissions a caller has to the
 * file and can have any suitable combination of the following values:
 */
#define FILE_READ_DATA        0x00000001  /* Data can be read from the file   */
                                          /* or directory child entries can   */
                                          /* be listed together with the      */
                                          /* associated child attributes      */
                                          /* (so the FILE_READ_ATTRIBUTES on  */
                                          /* the child entry is not needed)   */
#define FILE_WRITE_DATA       0x00000002  /* Data can be written to the file  */
                                          /* or new file can be created in    */
                                          /* the directory                    */
#define FILE_APPEND_DATA      0x00000004  /* Data can be appended to the file */
                                          /* (for non-local files over SMB it */
                                          /* is same as FILE_WRITE_DATA)      */
                                          /* or new subdirectory can be       */
                                          /* created in the directory         */
#define FILE_READ_EA          0x00000008  /* Extended attributes associated   */
                                          /* with the file can be read        */
#define FILE_WRITE_EA         0x00000010  /* Extended attributes associated   */
                                          /* with the file can be written     */
#define FILE_EXECUTE          0x00000020  /*Data can be read into memory from */
                                          /* the file using system paging I/O */
                                          /* for executing the file / script  */
                                          /* or right to traverse directory   */
                                          /* (but by default all users have   */
                                          /* directory bypass traverse        */
                                          /* privilege and do not need this   */
                                          /* permission on directories at all)*/
#define FILE_DELETE_CHILD     0x00000040  /* Child entry can be deleted from  */
                                          /* the directory (so the DELETE on  */
                                          /* the child entry is not needed)   */
#define FILE_READ_ATTRIBUTES  0x00000080  /* Attributes associated with the   */
                                          /* file or directory can be read    */
#define FILE_WRITE_ATTRIBUTES 0x00000100  /* Attributes associated with the   */
                                          /* file or directory can be written */
#define DELETE                0x00010000  /* The file or dir can be deleted   */
#define READ_CONTROL          0x00020000  /* The discretionary access control */
                                          /* list and ownership associated    */
                                          /* with the file or dir can be read */
#define WRITE_DAC             0x00040000  /* The discretionary access control */
                                          /* list associated with the file or */
                                          /* directory can be written         */
#define WRITE_OWNER           0x00080000  /* Ownership information associated */
                                          /* with the file/dir can be written */
#define SYNCHRONIZE           0x00100000  /* The file handle can waited on to */
                                          /* synchronize with the completion  */
                                          /* of an input/output request       */
#define SYSTEM_SECURITY       0x01000000  /* The system access control list   */
                                          /* associated with the file or      */
                                          /* directory can be read or written */
                                          /* (cannot be in DACL, can in SACL) */
#define MAXIMUM_ALLOWED       0x02000000  /* Maximal subset of GENERIC_ALL    */
                                          /* permissions which can be granted */
                                          /* (cannot be in DACL nor SACL)     */
#define GENERIC_ALL           0x10000000  /* Same as: GENERIC_EXECUTE |       */
                                          /*          GENERIC_WRITE |         */
                                          /*          GENERIC_READ |          */
                                          /*          FILE_DELETE_CHILD |     */
                                          /*          DELETE |                */
                                          /*          WRITE_DAC |             */
                                          /*          WRITE_OWNER             */
                                          /* So GENERIC_ALL contains all bits */
                                          /* mentioned above except these two */
                                          /* SYSTEM_SECURITY  MAXIMUM_ALLOWED */
#define GENERIC_EXECUTE       0x20000000  /* Same as: FILE_EXECUTE |          */
                                          /*          FILE_READ_ATTRIBUTES |  */
                                          /*          READ_CONTROL |          */
                                          /*          SYNCHRONIZE             */
#define GENERIC_WRITE         0x40000000  /* Same as: FILE_WRITE_DATA |       */
                                          /*          FILE_APPEND_DATA |      */
                                          /*          FILE_WRITE_EA |         */
                                          /*          FILE_WRITE_ATTRIBUTES | */
                                          /*          READ_CONTROL |          */
                                          /*          SYNCHRONIZE             */
#define GENERIC_READ          0x80000000  /* Same as: FILE_READ_DATA |        */
                                          /*          FILE_READ_EA |          */
                                          /*          FILE_READ_ATTRIBUTES |  */
                                          /*          READ_CONTROL |          */
                                          /*          SYNCHRONIZE             */

/* Combinations of file access permission bits */
#define FILE_READ_RIGHTS (FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES)
#define FILE_WRITE_RIGHTS (FILE_WRITE_DATA | FILE_APPEND_DATA \
                        | FILE_WRITE_EA | FILE_WRITE_ATTRIBUTES)
#define FILE_EXEC_RIGHTS (FILE_EXECUTE)
#define SET_FILE_EXEC_RIGHTS (FILE_READ_EA | FILE_WRITE_EA | FILE_EXECUTE \
                                | FILE_READ_ATTRIBUTES \
                                | FILE_WRITE_ATTRIBUTES \
                                | DELETE | READ_CONTROL | WRITE_DAC \
                                | WRITE_OWNER | SYNCHRONIZE)
#define SET_MINIMUM_RIGHTS (FILE_READ_EA | FILE_READ_ATTRIBUTES \
                                | READ_CONTROL | SYNCHRONIZE)

#endif                          /* _COMMON_SMB2PDU_H */