include/virtdisk.h

   1 /*
   2  * Copyright 2017 Louis Lenders
   3  * Copyright 2018 Gijs Vermeulen
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  18  */
  19
  20 #ifndef __WINE_VIRTDISK_DLL_H
  21 #define __WINE_VIRTDISK_DLL_H
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27 #define VIRTUAL_STORAGE_TYPE_DEVICE_UNKNOWN     0
  28 #define VIRTUAL_STORAGE_TYPE_DEVICE_ISO         1
  29 #define VIRTUAL_STORAGE_TYPE_DEVICE_VHD         2
  30
  31 typedef enum _ATTACH_VIRTUAL_DISK_FLAG {
  32     ATTACH_VIRTUAL_DISK_FLAG_NONE                   = 0x00,
  33     ATTACH_VIRTUAL_DISK_FLAG_READ_ONLY              = 0x01,
  34     ATTACH_VIRTUAL_DISK_FLAG_NO_DRIVE_LETTER        = 0x02,
  35     ATTACH_VIRTUAL_DISK_FLAG_PERMANENT_LIFETIME     = 0x04,
  36     ATTACH_VIRTUAL_DISK_FLAG_NO_LOCAL_HOST          = 0x08,
  37     ATTACH_VIRTUAL_DISK_FLAG_NO_SECURITY_DESCRIPTOR = 0x10
  38 } ATTACH_VIRTUAL_DISK_FLAG;
  39
  40 typedef enum _ATTACH_VIRTUAL_DISK_VERSION {
  41     ATTACH_VIRTUAL_DISK_VERSION_UNSPECIFIED,
  42     ATTACH_VIRTUAL_DISK_VERSION_1
  43 } ATTACH_VIRTUAL_DISK_VERSION;
  44
  45 typedef enum _COMPACT_VIRTUAL_DISK_FLAG {
  46     COMPACT_VIRTUAL_DISK_FLAG_NONE           = 0x00,
  47     COMPACT_VIRTUAL_DISK_FLAG_NO_ZERO_SCAN   = 0x01,
  48     COMPACT_VIRTUAL_DISK_FLAG_NO_BLOCK_MOVES = 0x02
  49 } COMPACT_VIRTUAL_DISK_FLAG;
  50
  51 typedef enum _COMPACT_VIRTUAL_DISK_VERSION {
  52     COMPACT_VIRTUAL_DISK_VERSION_UNSPECIFIED,
  53     COMPACT_VIRTUAL_DISK_VERSION_1
  54 } COMPACT_VIRTUAL_DISK_VERSION;
  55
  56 typedef enum _DEPENDENT_DISK_FLAG
  57 {
  58     DEPENDENT_DISK_FLAG_NONE                 = 0x00000000,
  59     DEPENDENT_DISK_FLAG_MULT_BACKING_FILES   = 0x00000001,
  60     DEPENDENT_DISK_FLAG_FULLY_ALLOCATED      = 0x00000002,
  61     DEPENDENT_DISK_FLAG_READ_ONLY            = 0x00000004,
  62     DEPENDENT_DISK_FLAG_REMOTE               = 0x00000008,
  63     DEPENDENT_DISK_FLAG_SYSTEM_VOLUME        = 0x00000010,
  64     DEPENDENT_DISK_FLAG_SYSTEM_VOLUME_PARENT = 0x00000020,
  65     DEPENDENT_DISK_FLAG_REMOVABLE            = 0x00000040,
  66     DEPENDENT_DISK_FLAG_NO_DRIVE_LETTER      = 0x00000080,
  67     DEPENDENT_DISK_FLAG_PARENT               = 0x00000100,
  68     DEPENDENT_DISK_FLAG_NO_HOST_DISK         = 0x00000200,
  69     DEPENDENT_DISK_FLAG_PERMANENT_LIFETIME   = 0x00000400
  70 } DEPENDENT_DISK_FLAG;
  71
  72 typedef enum _EXPAND_VIRTUAL_DISK_VERSION {
  73     EXPAND_VIRTUAL_DISK_VERSION_UNSPECIFIED,
  74     EXPAND_VIRTUAL_DISK_VERSION_1
  75 } EXPAND_VIRTUAL_DISK_VERSION;
  76
  77 typedef enum _DETACH_VIRTUAL_DISK_FLAG {
  78     DETACH_VIRTUAL_DISK_FLAG_NONE = 0x00000000
  79 } DETACH_VIRTUAL_DISK_FLAG;
  80
  81 typedef enum _EXPAND_VIRTUAL_DISK_FLAG {
  82     EXPAND_VIRTUAL_DISK_FLAG_NONE = 0x00000000
  83 } EXPAND_VIRTUAL_DISK_FLAG;
  84
  85 typedef enum _GET_STORAGE_DEPENDENCY_FLAG
  86 {
  87     GET_STORAGE_DEPENDENCY_FLAG_NONE         = 0x00,
  88     GET_STORAGE_DEPENDENCY_FLAG_HOST_VOLUMES = 0x01,
  89     GET_STORAGE_DEPENDENCY_FLAG_DISK_HANDLE  = 0x02
  90 } GET_STORAGE_DEPENDENCY_FLAG;
  91
  92 typedef enum _MIRROR_VIRTUAL_DISK_FLAG {
  93     MIRROR_VIRTUAL_DISK_FLAG_NONE           = 0x00,
  94     MIRROR_VIRTUAL_DISK_FLAG_EXISTING_FILE  = 0x01
  95 } MIRROR_VIRTUAL_DISK_FLAG;
  96
  97 typedef enum _MIRROR_VIRTUAL_DISK_VERSION {
  98     MIRROR_VIRTUAL_DISK_VERSION_UNSPECIFIED,
  99     MIRROR_VIRTUAL_DISK_VERSION_1
 100 } MIRROR_VIRTUAL_DISK_VERSION;
 101
 102 typedef enum _MERGE_VIRTUAL_DISK_FLAG {
 103     MERGE_VIRTUAL_DISK_FLAG_NONE = 0x00000000
 104 } MERGE_VIRTUAL_DISK_FLAG;
 105
 106 typedef enum _STORAGE_DEPENDENCY_INFO_VERSION
 107 {
 108     STORAGE_DEPENDENCY_INFO_VERSION_UNSPECIFIED = 0x0,
 109     STORAGE_DEPENDENCY_INFO_VERSION_1           = 0x1,
 110     STORAGE_DEPENDENCY_INFO_VERSION_2           = 0x2
 111 } STORAGE_DEPENDENCY_INFO_VERSION;
 112
 113 typedef enum _VIRTUAL_DISK_ACCESS_MASK {
 114     VIRTUAL_DISK_ACCESS_NONE        = 0x00000000,
 115     VIRTUAL_DISK_ACCESS_ATTACH_RO   = 0x00010000,
 116     VIRTUAL_DISK_ACCESS_ATTACH_RW   = 0x00020000,
 117     VIRTUAL_DISK_ACCESS_DETACH      = 0x00040000,
 118     VIRTUAL_DISK_ACCESS_GET_INFO    = 0x00080000,
 119     VIRTUAL_DISK_ACCESS_CREATE      = 0x00100000,
 120     VIRTUAL_DISK_ACCESS_METAOPS     = 0x00200000,
 121     VIRTUAL_DISK_ACCESS_READ        = 0x000d0000,
 122     VIRTUAL_DISK_ACCESS_ALL         = 0x003f0000,
 123     VIRTUAL_DISK_ACCESS_WRITABLE    = 0x00320000
 124 } VIRTUAL_DISK_ACCESS_MASK;
 125
 126 typedef struct _VIRTUAL_STORAGE_TYPE
 127 {
 128     ULONG DeviceId;
 129     GUID  VendorId;
 130 } VIRTUAL_STORAGE_TYPE, *PVIRTUAL_STORAGE_TYPE;
 131
 132 typedef struct _ATTACH_VIRTUAL_DISK_PARAMETERS {
 133     ATTACH_VIRTUAL_DISK_VERSION Version;
 134     __C89_NAMELESS union {
 135         struct {
 136             ULONG Reserved;
 137         } Version1;
 138     } DUMMYUNIONNAME;
 139 } ATTACH_VIRTUAL_DISK_PARAMETERS, *PATTACH_VIRTUAL_DISK_PARAMETERS;
 140
 141 typedef struct _COMPACT_VIRTUAL_DISK_PARAMETERS {
 142     COMPACT_VIRTUAL_DISK_VERSION Version;
 143     __C89_NAMELESS union {
 144         struct {
 145             ULONG Reserved;
 146         } Version1;
 147     } DUMMYUNIONNAME;
 148 } COMPACT_VIRTUAL_DISK_PARAMETERS, *PCOMPACT_VIRTUAL_DISK_PARAMETERS;
 149
 150 typedef struct _EXPAND_VIRTUAL_DISK_PARAMETERS {
 151     EXPAND_VIRTUAL_DISK_VERSION Version;
 152     __C89_NAMELESS union {
 153         struct {
 154             ULONGLONG NewSize;
 155         } Version1;
 156     } DUMMYUNIONNAME;
 157 } EXPAND_VIRTUAL_DISK_PARAMETERS, *PEXPAND_VIRTUAL_DISK_PARAMETERS;
 158
 159 typedef struct _STORAGE_DEPENDENCY_INFO_TYPE_1
 160 {
 161     DEPENDENT_DISK_FLAG  DependencyTypeFlags;
 162     ULONG                ProviderSpecificFlags;
 163     VIRTUAL_STORAGE_TYPE VirtualStorageType;
 164 } STORAGE_DEPENDENCY_INFO_TYPE_1, *PSTORAGE_DEPENDENCY_INFO_TYPE_1;
 165
 166 typedef struct _STORAGE_DEPENDENCY_INFO_TYPE_2
 167 {
 168     DEPENDENT_DISK_FLAG  DependencyTypeFlags;
 169     ULONG                ProviderSpecificFlags;
 170     VIRTUAL_STORAGE_TYPE VirtualStorageType;
 171     ULONG                AncestorLevel;
 172     PWSTR                DependencyDeviceName;
 173     PWSTR                HostVolumeName;
 174     PWSTR                DependentVolumeName;
 175     PWSTR                DependentVolumeRelativePath;
 176 } STORAGE_DEPENDENCY_INFO_TYPE_2, *PSTORAGE_DEPENDENCY_INFO_TYPE_2;
 177
 178 typedef struct _STORAGE_DEPENDENCY_INFO
 179 {
 180     STORAGE_DEPENDENCY_INFO_VERSION Version;
 181     ULONG                           NumberEntries;
 182 #if !defined(__WINESRC__) && (defined(_MSC_EXTENSIONS) || ((defined(__GNUC__) && __GNUC__ >= 3)))
 183     __C89_NAMELESS union
 184     {
 185         STORAGE_DEPENDENCY_INFO_TYPE_1 Version1Entries[];
 186         STORAGE_DEPENDENCY_INFO_TYPE_2 Version2Entries[];
 187     } __C89_NAMELESSUNIONNAME;
 188 #endif
 189 } STORAGE_DEPENDENCY_INFO, *PSTORAGE_DEPENDENCY_INFO;
 190
 191 typedef struct _VIRTUAL_DISK_PROGRESS {
 192     DWORD     OperationStatus;
 193     ULONGLONG CurrentValue;
 194     ULONGLONG CompletionValue;
 195 } VIRTUAL_DISK_PROGRESS, *PVIRTUAL_DISK_PROGRESS;
 196
 197 DWORD WINAPI GetStorageDependencyInformation(HANDLE obj, GET_STORAGE_DEPENDENCY_FLAG flags, ULONG size, STORAGE_DEPENDENCY_INFO *info, ULONG *used);
 198
 199 #ifdef __cplusplus
 200 }
 201 #endif
 202
 203 #endif  /* __WINE_VIRTDISK_DLL_H */