plugins/vddk/vddk-structs.h

   1 /* nbdkit
   2  * Copyright Red Hat
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *
  11  * * Redistributions in binary form must reproduce the above copyright
  12  * notice, this list of conditions and the following disclaimer in the
  13  * documentation and/or other materials provided with the distribution.
  14  *
  15  * * Neither the name of Red Hat nor the names of its contributors may be
  16  * used to endorse or promote products derived from this software without
  17  * specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  21  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  22  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 /* Types and structs that we pass to or return from the VDDK API.
  34  *
  35  * Updated to VDDK 7.0
  36  */
  37
  38 #ifndef NBDKIT_VDDK_STRUCTS_H
  39 #define NBDKIT_VDDK_STRUCTS_H
  40
  41 #include <stdarg.h>
  42 #include <stdint.h>
  43
  44 typedef uint64_t VixError;
  45 #define VIX_OK 0
  46 #define VIX_E_FAIL 1
  47 #define VIX_E_NOT_SUPPORTED 6
  48 #define VIX_ASYNC 25000
  49
  50 #define VIXDISKLIB_FLAG_OPEN_UNBUFFERED 1
  51 #define VIXDISKLIB_FLAG_OPEN_SINGLE_LINK 2
  52 #define VIXDISKLIB_FLAG_OPEN_READ_ONLY 4
  53 #define VIXDISKLIB_FLAG_OPEN_COMPRESSION_ZLIB 16
  54 #define VIXDISKLIB_FLAG_OPEN_COMPRESSION_FASTLZ 32
  55 #define VIXDISKLIB_FLAG_OPEN_COMPRESSION_SKIPZ 64
  56
  57 #define VIXDISKLIB_SECTOR_SIZE 512
  58
  59 enum VixDiskLibDiskType {
  60   VIXDISKLIB_DISK_MONOLITHIC_SPARSE = 1,
  61   VIXDISKLIB_DISK_MONOLITHIC_FLAT = 2,
  62   VIXDISKLIB_DISK_SPLIT_SPARSE = 3,
  63   VIXDISKLIB_DISK_SPLIT_FLAT = 4,
  64   VIXDISKLIB_DISK_VMFS_FLAT = 5,
  65   VIXDISKLIB_DISK_STREAM_OPTIMIZED = 6,
  66   VIXDISKLIB_DISK_VMFS_THIN = 7,
  67   VIXDISKLIB_DISK_VMFS_SPARSE = 8
  68 };
  69
  70 #define VIXDISKLIB_HWVERSION_WORKSTATION_4 3
  71 #define VIXDISKLIB_HWVERSION_WORKSTATION_5 4
  72 #define VIXDISKLIB_HWVERSION_WORKSTATION_6 6
  73 #define VIXDISKLIB_HWVERSION_ESX30 4
  74 #define VIXDISKLIB_HWVERSION_ESX4X 7
  75 #define VIXDISKLIB_HWVERSION_ESX50 8
  76 #define VIXDISKLIB_HWVERSION_ESX51 9
  77 #define VIXDISKLIB_HWVERSION_ESX55 10
  78 #define VIXDISKLIB_HWVERSION_ESX60 11
  79 #define VIXDISKLIB_HWVERSION_ESX65 13
  80
  81 #define VIXDISKLIB_MIN_CHUNK_SIZE 128
  82 #define VIXDISKLIB_MAX_CHUNK_NUMBER (512*1024)
  83
  84 typedef void *VixDiskLibConnection;
  85 typedef void *VixDiskLibHandle;
  86
  87 typedef void VixDiskLibGenericLogFunc (const char *fmt, va_list args);
  88
  89 typedef void (*VixDiskLibCompletionCB) (void *data, VixError result);
  90
  91 enum VixDiskLibCredType {
  92   VIXDISKLIB_CRED_UID       = 1,
  93   VIXDISKLIB_CRED_SESSIONID = 2,
  94   VIXDISKLIB_CRED_TICKETID  = 3,
  95   VIXDISKLIB_CRED_SSPI      = 4,
  96   VIXDISKLIB_CRED_UNKNOWN   = 256
  97 };
  98
  99 enum VixDiskLibSpecType {
 100   VIXDISKLIB_SPEC_VMX             = 0,
 101   VIXDISKLIB_SPEC_VSTORAGE_OBJECT = 1,
 102   VIXDISKLIB_SPEC_UNKNOWN         = 2
 103 };
 104
 105 struct VixDiskLibVStorageObjectSpec {
 106   char *id;
 107   char *datastoreMoRef;
 108   char *ssId;
 109 };
 110
 111 typedef struct VixDiskLibConnectParams {
 112   char *vmxSpec;
 113   char *serverName;
 114   char *thumbPrint;
 115   long reserved1;
 116   enum VixDiskLibCredType credType;
 117   union {
 118     struct {
 119       char *userName;
 120       char *password;
 121     } uid;
 122     struct {
 123       char *cookie;
 124       char *userName;
 125       char *key;
 126     } sessionId;
 127     void *reserved2;
 128   } creds;
 129   uint32_t port;
 130   uint32_t nfcHostPort;
 131   char *reserved3;
 132   char reserved4[8];
 133   void *reserved5;
 134   union {
 135     struct VixDiskLibVStorageObjectSpec vStorageObjSpec;
 136   } spec;
 137   enum VixDiskLibSpecType specType;
 138 } VixDiskLibConnectParams;
 139
 140 struct VixDiskLibGeometry {
 141   uint32_t cylinders;
 142   uint32_t heads;
 143   uint32_t sectors;
 144 };
 145
 146 enum VixDiskLibAdapterType {
 147   VIXDISKLIB_ADAPTER_IDE           = 1,
 148   VIXDISKLIB_ADAPTER_SCSI_BUSLOGIC = 2,
 149   VIXDISKLIB_ADAPTER_SCSI_LSILOGIC = 3,
 150   VIXDISKLIB_ADAPTER_UNKNOWN       = 256
 151 };
 152
 153 typedef struct VixDiskLibInfo {
 154   struct VixDiskLibGeometry biosGeo;
 155   struct VixDiskLibGeometry physGeo;
 156   uint64_t capacity;
 157   enum VixDiskLibAdapterType adapterType;
 158   int numLinks;
 159   char *parentFileNameHint;
 160   char *uuid;
 161   uint32_t logicalSectorSize;   /* Added in 7.0. */
 162   uint32_t physicalSectorSize;  /* Added in 7.0. */
 163 } VixDiskLibInfo;
 164
 165 typedef struct {
 166   uint64_t offset;
 167   uint64_t length;
 168 } VixDiskLibBlock;
 169
 170 typedef struct {
 171   uint32_t numBlocks;
 172   VixDiskLibBlock blocks[1];
 173 } VixDiskLibBlockList;
 174
 175 typedef struct {
 176   enum VixDiskLibDiskType diskType;
 177   enum VixDiskLibAdapterType adapterType;
 178   uint16_t hwVersion;
 179   uint64_t capacity;
 180   uint32_t logicalSectorSize;
 181   uint32_t physicalSectorSize;
 182 } VixDiskLibCreateParams;
 183
 184 #endif /* NBDKIT_VDDK_STRUCTS_H */