xref: /openbmc/qemu/block/vmdk.c (revision df22fbb7)
1  /*
2   * Block driver for the VMDK format
3   *
4   * Copyright (c) 2004 Fabrice Bellard
5   * Copyright (c) 2005 Filip Navara
6   *
7   * Permission is hereby granted, free of charge, to any person obtaining a copy
8   * of this software and associated documentation files (the "Software"), to deal
9   * in the Software without restriction, including without limitation the rights
10   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11   * copies of the Software, and to permit persons to whom the Software is
12   * furnished to do so, subject to the following conditions:
13   *
14   * The above copyright notice and this permission notice shall be included in
15   * all copies or substantial portions of the Software.
16   *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20   * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23   * THE SOFTWARE.
24   */
25  
26  #include "qemu/osdep.h"
27  #include "qapi/error.h"
28  #include "block/block_int.h"
29  #include "sysemu/block-backend.h"
30  #include "qapi/qmp/qdict.h"
31  #include "qapi/qmp/qerror.h"
32  #include "qemu/error-report.h"
33  #include "qemu/module.h"
34  #include "qemu/option.h"
35  #include "qemu/bswap.h"
36  #include "qemu/memalign.h"
37  #include "migration/blocker.h"
38  #include "qemu/cutils.h"
39  #include <zlib.h>
40  
41  #define VMDK3_MAGIC (('C' << 24) | ('O' << 16) | ('W' << 8) | 'D')
42  #define VMDK4_MAGIC (('K' << 24) | ('D' << 16) | ('M' << 8) | 'V')
43  #define VMDK4_COMPRESSION_DEFLATE 1
44  #define VMDK4_FLAG_NL_DETECT (1 << 0)
45  #define VMDK4_FLAG_RGD (1 << 1)
46  /* Zeroed-grain enable bit */
47  #define VMDK4_FLAG_ZERO_GRAIN   (1 << 2)
48  #define VMDK4_FLAG_COMPRESS (1 << 16)
49  #define VMDK4_FLAG_MARKER (1 << 17)
50  #define VMDK4_GD_AT_END 0xffffffffffffffffULL
51  
52  #define VMDK_EXTENT_MAX_SECTORS (1ULL << 32)
53  
54  #define VMDK_GTE_ZEROED 0x1
55  
56  /* VMDK internal error codes */
57  #define VMDK_OK      0
58  #define VMDK_ERROR   (-1)
59  /* Cluster not allocated */
60  #define VMDK_UNALLOC (-2)
61  #define VMDK_ZEROED  (-3)
62  
63  #define BLOCK_OPT_ZEROED_GRAIN "zeroed_grain"
64  #define BLOCK_OPT_TOOLSVERSION "toolsversion"
65  
66  typedef struct {
67      uint32_t version;
68      uint32_t flags;
69      uint32_t disk_sectors;
70      uint32_t granularity;
71      uint32_t l1dir_offset;
72      uint32_t l1dir_size;
73      uint32_t file_sectors;
74      uint32_t cylinders;
75      uint32_t heads;
76      uint32_t sectors_per_track;
77  } QEMU_PACKED VMDK3Header;
78  
79  typedef struct {
80      uint32_t version;
81      uint32_t flags;
82      uint64_t capacity;
83      uint64_t granularity;
84      uint64_t desc_offset;
85      uint64_t desc_size;
86      /* Number of GrainTableEntries per GrainTable */
87      uint32_t num_gtes_per_gt;
88      uint64_t rgd_offset;
89      uint64_t gd_offset;
90      uint64_t grain_offset;
91      char filler[1];
92      char check_bytes[4];
93      uint16_t compressAlgorithm;
94  } QEMU_PACKED VMDK4Header;
95  
96  typedef struct VMDKSESparseConstHeader {
97      uint64_t magic;
98      uint64_t version;
99      uint64_t capacity;
100      uint64_t grain_size;
101      uint64_t grain_table_size;
102      uint64_t flags;
103      uint64_t reserved1;
104      uint64_t reserved2;
105      uint64_t reserved3;
106      uint64_t reserved4;
107      uint64_t volatile_header_offset;
108      uint64_t volatile_header_size;
109      uint64_t journal_header_offset;
110      uint64_t journal_header_size;
111      uint64_t journal_offset;
112      uint64_t journal_size;
113      uint64_t grain_dir_offset;
114      uint64_t grain_dir_size;
115      uint64_t grain_tables_offset;
116      uint64_t grain_tables_size;
117      uint64_t free_bitmap_offset;
118      uint64_t free_bitmap_size;
119      uint64_t backmap_offset;
120      uint64_t backmap_size;
121      uint64_t grains_offset;
122      uint64_t grains_size;
123      uint8_t pad[304];
124  } QEMU_PACKED VMDKSESparseConstHeader;
125  
126  typedef struct VMDKSESparseVolatileHeader {
127      uint64_t magic;
128      uint64_t free_gt_number;
129      uint64_t next_txn_seq_number;
130      uint64_t replay_journal;
131      uint8_t pad[480];
132  } QEMU_PACKED VMDKSESparseVolatileHeader;
133  
134  #define L2_CACHE_SIZE 16
135  
136  typedef struct VmdkExtent {
137      BdrvChild *file;
138      bool flat;
139      bool compressed;
140      bool has_marker;
141      bool has_zero_grain;
142      bool sesparse;
143      uint64_t sesparse_l2_tables_offset;
144      uint64_t sesparse_clusters_offset;
145      int32_t entry_size;
146      int version;
147      int64_t sectors;
148      int64_t end_sector;
149      int64_t flat_start_offset;
150      int64_t l1_table_offset;
151      int64_t l1_backup_table_offset;
152      void *l1_table;
153      uint32_t *l1_backup_table;
154      unsigned int l1_size;
155      uint32_t l1_entry_sectors;
156  
157      unsigned int l2_size;
158      void *l2_cache;
159      uint32_t l2_cache_offsets[L2_CACHE_SIZE];
160      uint32_t l2_cache_counts[L2_CACHE_SIZE];
161  
162      int64_t cluster_sectors;
163      int64_t next_cluster_sector;
164      char *type;
165  } VmdkExtent;
166  
167  typedef struct BDRVVmdkState {
168      CoMutex lock;
169      uint64_t desc_offset;
170      bool cid_updated;
171      bool cid_checked;
172      uint32_t cid;
173      uint32_t parent_cid;
174      int num_extents;
175      /* Extent array with num_extents entries, ascend ordered by address */
176      VmdkExtent *extents;
177      Error *migration_blocker;
178      char *create_type;
179  } BDRVVmdkState;
180  
181  typedef struct BDRVVmdkReopenState {
182      bool *extents_using_bs_file;
183  } BDRVVmdkReopenState;
184  
185  typedef struct VmdkMetaData {
186      unsigned int l1_index;
187      unsigned int l2_index;
188      unsigned int l2_offset;
189      bool new_allocation;
190      uint32_t *l2_cache_entry;
191  } VmdkMetaData;
192  
193  typedef struct VmdkGrainMarker {
194      uint64_t lba;
195      uint32_t size;
196      uint8_t  data[];
197  } QEMU_PACKED VmdkGrainMarker;
198  
199  enum {
200      MARKER_END_OF_STREAM    = 0,
201      MARKER_GRAIN_TABLE      = 1,
202      MARKER_GRAIN_DIRECTORY  = 2,
203      MARKER_FOOTER           = 3,
204  };
205  
206  static int vmdk_probe(const uint8_t *buf, int buf_size, const char *filename)
207  {
208      uint32_t magic;
209  
210      if (buf_size < 4) {
211          return 0;
212      }
213      magic = be32_to_cpu(*(uint32_t *)buf);
214      if (magic == VMDK3_MAGIC ||
215          magic == VMDK4_MAGIC) {
216          return 100;
217      } else {
218          const char *p = (const char *)buf;
219          const char *end = p + buf_size;
220          while (p < end) {
221              if (*p == '#') {
222                  /* skip comment line */
223                  while (p < end && *p != '\n') {
224                      p++;
225                  }
226                  p++;
227                  continue;
228              }
229              if (*p == ' ') {
230                  while (p < end && *p == ' ') {
231                      p++;
232                  }
233                  /* skip '\r' if windows line endings used. */
234                  if (p < end && *p == '\r') {
235                      p++;
236                  }
237                  /* only accept blank lines before 'version=' line */
238                  if (p == end || *p != '\n') {
239                      return 0;
240                  }
241                  p++;
242                  continue;
243              }
244              if (end - p >= strlen("version=X\n")) {
245                  if (strncmp("version=1\n", p, strlen("version=1\n")) == 0 ||
246                      strncmp("version=2\n", p, strlen("version=2\n")) == 0 ||
247                      strncmp("version=3\n", p, strlen("version=3\n")) == 0) {
248                      return 100;
249                  }
250              }
251              if (end - p >= strlen("version=X\r\n")) {
252                  if (strncmp("version=1\r\n", p, strlen("version=1\r\n")) == 0 ||
253                      strncmp("version=2\r\n", p, strlen("version=2\r\n")) == 0 ||
254                      strncmp("version=3\r\n", p, strlen("version=3\r\n")) == 0) {
255                      return 100;
256                  }
257              }
258              return 0;
259          }
260          return 0;
261      }
262  }
263  
264  #define SECTOR_SIZE 512
265  #define DESC_SIZE (20 * SECTOR_SIZE)    /* 20 sectors of 512 bytes each */
266  #define BUF_SIZE 4096
267  #define HEADER_SIZE 512                 /* first sector of 512 bytes */
268  
269  static void vmdk_free_extents(BlockDriverState *bs)
270  {
271      int i;
272      BDRVVmdkState *s = bs->opaque;
273      VmdkExtent *e;
274  
275      for (i = 0; i < s->num_extents; i++) {
276          e = &s->extents[i];
277          g_free(e->l1_table);
278          g_free(e->l2_cache);
279          g_free(e->l1_backup_table);
280          g_free(e->type);
281          if (e->file != bs->file) {
282              bdrv_unref_child(bs, e->file);
283          }
284      }
285      g_free(s->extents);
286  }
287  
288  static void vmdk_free_last_extent(BlockDriverState *bs)
289  {
290      BDRVVmdkState *s = bs->opaque;
291  
292      if (s->num_extents == 0) {
293          return;
294      }
295      s->num_extents--;
296      s->extents = g_renew(VmdkExtent, s->extents, s->num_extents);
297  }
298  
299  /* Return -ve errno, or 0 on success and write CID into *pcid. */
300  static int vmdk_read_cid(BlockDriverState *bs, int parent, uint32_t *pcid)
301  {
302      char *desc;
303      uint32_t cid;
304      const char *p_name, *cid_str;
305      size_t cid_str_size;
306      BDRVVmdkState *s = bs->opaque;
307      int ret;
308  
309      desc = g_malloc0(DESC_SIZE);
310      ret = bdrv_pread(bs->file, s->desc_offset, DESC_SIZE, desc, 0);
311      if (ret < 0) {
312          goto out;
313      }
314  
315      if (parent) {
316          cid_str = "parentCID";
317          cid_str_size = sizeof("parentCID");
318      } else {
319          cid_str = "CID";
320          cid_str_size = sizeof("CID");
321      }
322  
323      desc[DESC_SIZE - 1] = '\0';
324      p_name = strstr(desc, cid_str);
325      if (p_name == NULL) {
326          ret = -EINVAL;
327          goto out;
328      }
329      p_name += cid_str_size;
330      if (sscanf(p_name, "%" SCNx32, &cid) != 1) {
331          ret = -EINVAL;
332          goto out;
333      }
334      *pcid = cid;
335      ret = 0;
336  
337  out:
338      g_free(desc);
339      return ret;
340  }
341  
342  static int vmdk_write_cid(BlockDriverState *bs, uint32_t cid)
343  {
344      char *desc, *tmp_desc;
345      char *p_name, *tmp_str;
346      BDRVVmdkState *s = bs->opaque;
347      int ret = 0;
348  
349      desc = g_malloc0(DESC_SIZE);
350      tmp_desc = g_malloc0(DESC_SIZE);
351      ret = bdrv_pread(bs->file, s->desc_offset, DESC_SIZE, desc, 0);
352      if (ret < 0) {
353          goto out;
354      }
355  
356      desc[DESC_SIZE - 1] = '\0';
357      tmp_str = strstr(desc, "parentCID");
358      if (tmp_str == NULL) {
359          ret = -EINVAL;
360          goto out;
361      }
362  
363      pstrcpy(tmp_desc, DESC_SIZE, tmp_str);
364      p_name = strstr(desc, "CID");
365      if (p_name != NULL) {
366          p_name += sizeof("CID");
367          snprintf(p_name, DESC_SIZE - (p_name - desc), "%" PRIx32 "\n", cid);
368          pstrcat(desc, DESC_SIZE, tmp_desc);
369      }
370  
371      ret = bdrv_pwrite_sync(bs->file, s->desc_offset, DESC_SIZE, desc, 0);
372  
373  out:
374      g_free(desc);
375      g_free(tmp_desc);
376      return ret;
377  }
378  
379  static int vmdk_is_cid_valid(BlockDriverState *bs)
380  {
381      BDRVVmdkState *s = bs->opaque;
382      uint32_t cur_pcid;
383  
384      if (!s->cid_checked && bs->backing) {
385          BlockDriverState *p_bs = bs->backing->bs;
386  
387          if (strcmp(p_bs->drv->format_name, "vmdk")) {
388              /* Backing file is not in vmdk format, so it does not have
389               * a CID, which makes the overlay's parent CID invalid */
390              return 0;
391          }
392  
393          if (vmdk_read_cid(p_bs, 0, &cur_pcid) != 0) {
394              /* read failure: report as not valid */
395              return 0;
396          }
397          if (s->parent_cid != cur_pcid) {
398              /* CID not valid */
399              return 0;
400          }
401      }
402      s->cid_checked = true;
403      /* CID valid */
404      return 1;
405  }
406  
407  static int vmdk_reopen_prepare(BDRVReopenState *state,
408                                 BlockReopenQueue *queue, Error **errp)
409  {
410      BDRVVmdkState *s;
411      BDRVVmdkReopenState *rs;
412      int i;
413  
414      assert(state != NULL);
415      assert(state->bs != NULL);
416      assert(state->opaque == NULL);
417  
418      s = state->bs->opaque;
419  
420      rs = g_new0(BDRVVmdkReopenState, 1);
421      state->opaque = rs;
422  
423      /*
424       * Check whether there are any extents stored in bs->file; if bs->file
425       * changes, we will need to update their .file pointers to follow suit
426       */
427      rs->extents_using_bs_file = g_new(bool, s->num_extents);
428      for (i = 0; i < s->num_extents; i++) {
429          rs->extents_using_bs_file[i] = s->extents[i].file == state->bs->file;
430      }
431  
432      return 0;
433  }
434  
435  static void vmdk_reopen_clean(BDRVReopenState *state)
436  {
437      BDRVVmdkReopenState *rs = state->opaque;
438  
439      g_free(rs->extents_using_bs_file);
440      g_free(rs);
441      state->opaque = NULL;
442  }
443  
444  static void vmdk_reopen_commit(BDRVReopenState *state)
445  {
446      BDRVVmdkState *s = state->bs->opaque;
447      BDRVVmdkReopenState *rs = state->opaque;
448      int i;
449  
450      for (i = 0; i < s->num_extents; i++) {
451          if (rs->extents_using_bs_file[i]) {
452              s->extents[i].file = state->bs->file;
453          }
454      }
455  
456      vmdk_reopen_clean(state);
457  }
458  
459  static void vmdk_reopen_abort(BDRVReopenState *state)
460  {
461      vmdk_reopen_clean(state);
462  }
463  
464  static int vmdk_parent_open(BlockDriverState *bs)
465  {
466      char *p_name;
467      char *desc;
468      BDRVVmdkState *s = bs->opaque;
469      int ret;
470  
471      desc = g_malloc0(DESC_SIZE + 1);
472      ret = bdrv_pread(bs->file, s->desc_offset, DESC_SIZE, desc, 0);
473      if (ret < 0) {
474          goto out;
475      }
476  
477      p_name = strstr(desc, "parentFileNameHint");
478      if (p_name != NULL) {
479          char *end_name;
480  
481          p_name += sizeof("parentFileNameHint") + 1;
482          end_name = strchr(p_name, '\"');
483          if (end_name == NULL) {
484              ret = -EINVAL;
485              goto out;
486          }
487          if ((end_name - p_name) > sizeof(bs->auto_backing_file) - 1) {
488              ret = -EINVAL;
489              goto out;
490          }
491  
492          pstrcpy(bs->auto_backing_file, end_name - p_name + 1, p_name);
493          pstrcpy(bs->backing_file, sizeof(bs->backing_file),
494                  bs->auto_backing_file);
495          pstrcpy(bs->backing_format, sizeof(bs->backing_format),
496                  "vmdk");
497      }
498  
499  out:
500      g_free(desc);
501      return ret;
502  }
503  
504  /* Create and append extent to the extent array. Return the added VmdkExtent
505   * address. return NULL if allocation failed. */
506  static int vmdk_add_extent(BlockDriverState *bs,
507                             BdrvChild *file, bool flat, int64_t sectors,
508                             int64_t l1_offset, int64_t l1_backup_offset,
509                             uint32_t l1_size,
510                             int l2_size, uint64_t cluster_sectors,
511                             VmdkExtent **new_extent,
512                             Error **errp)
513  {
514      VmdkExtent *extent;
515      BDRVVmdkState *s = bs->opaque;
516      int64_t nb_sectors;
517  
518      if (cluster_sectors > 0x200000) {
519          /* 0x200000 * 512Bytes = 1GB for one cluster is unrealistic */
520          error_setg(errp, "Invalid granularity, image may be corrupt");
521          return -EFBIG;
522      }
523      if (l1_size > 32 * 1024 * 1024) {
524          /*
525           * Although with big capacity and small l1_entry_sectors, we can get a
526           * big l1_size, we don't want unbounded value to allocate the table.
527           * Limit it to 32M, which is enough to store:
528           *     8TB  - for both VMDK3 & VMDK4 with
529           *            minimal cluster size: 512B
530           *            minimal L2 table size: 512 entries
531           *            8 TB is still more than the maximal value supported for
532           *            VMDK3 & VMDK4 which is 2TB.
533           *     64TB - for "ESXi seSparse Extent"
534           *            minimal cluster size: 512B (default is 4KB)
535           *            L2 table size: 4096 entries (const).
536           *            64TB is more than the maximal value supported for
537           *            seSparse VMDKs (which is slightly less than 64TB)
538           */
539          error_setg(errp, "L1 size too big");
540          return -EFBIG;
541      }
542  
543      nb_sectors = bdrv_nb_sectors(file->bs);
544      if (nb_sectors < 0) {
545          return nb_sectors;
546      }
547  
548      s->extents = g_renew(VmdkExtent, s->extents, s->num_extents + 1);
549      extent = &s->extents[s->num_extents];
550      s->num_extents++;
551  
552      memset(extent, 0, sizeof(VmdkExtent));
553      extent->file = file;
554      extent->flat = flat;
555      extent->sectors = sectors;
556      extent->l1_table_offset = l1_offset;
557      extent->l1_backup_table_offset = l1_backup_offset;
558      extent->l1_size = l1_size;
559      extent->l1_entry_sectors = l2_size * cluster_sectors;
560      extent->l2_size = l2_size;
561      extent->cluster_sectors = flat ? sectors : cluster_sectors;
562      extent->next_cluster_sector = ROUND_UP(nb_sectors, cluster_sectors);
563      extent->entry_size = sizeof(uint32_t);
564  
565      if (s->num_extents > 1) {
566          extent->end_sector = (*(extent - 1)).end_sector + extent->sectors;
567      } else {
568          extent->end_sector = extent->sectors;
569      }
570      bs->total_sectors = extent->end_sector;
571      if (new_extent) {
572          *new_extent = extent;
573      }
574      return 0;
575  }
576  
577  static int vmdk_init_tables(BlockDriverState *bs, VmdkExtent *extent,
578                              Error **errp)
579  {
580      int ret;
581      size_t l1_size;
582      int i;
583  
584      /* read the L1 table */
585      l1_size = extent->l1_size * extent->entry_size;
586      extent->l1_table = g_try_malloc(l1_size);
587      if (l1_size && extent->l1_table == NULL) {
588          return -ENOMEM;
589      }
590  
591      ret = bdrv_pread(extent->file, extent->l1_table_offset, l1_size,
592                       extent->l1_table, 0);
593      if (ret < 0) {
594          bdrv_refresh_filename(extent->file->bs);
595          error_setg_errno(errp, -ret,
596                           "Could not read l1 table from extent '%s'",
597                           extent->file->bs->filename);
598          goto fail_l1;
599      }
600      for (i = 0; i < extent->l1_size; i++) {
601          if (extent->entry_size == sizeof(uint64_t)) {
602              le64_to_cpus((uint64_t *)extent->l1_table + i);
603          } else {
604              assert(extent->entry_size == sizeof(uint32_t));
605              le32_to_cpus((uint32_t *)extent->l1_table + i);
606          }
607      }
608  
609      if (extent->l1_backup_table_offset) {
610          assert(!extent->sesparse);
611          extent->l1_backup_table = g_try_malloc(l1_size);
612          if (l1_size && extent->l1_backup_table == NULL) {
613              ret = -ENOMEM;
614              goto fail_l1;
615          }
616          ret = bdrv_pread(extent->file, extent->l1_backup_table_offset,
617                           l1_size, extent->l1_backup_table, 0);
618          if (ret < 0) {
619              bdrv_refresh_filename(extent->file->bs);
620              error_setg_errno(errp, -ret,
621                               "Could not read l1 backup table from extent '%s'",
622                               extent->file->bs->filename);
623              goto fail_l1b;
624          }
625          for (i = 0; i < extent->l1_size; i++) {
626              le32_to_cpus(&extent->l1_backup_table[i]);
627          }
628      }
629  
630      extent->l2_cache =
631          g_malloc(extent->entry_size * extent->l2_size * L2_CACHE_SIZE);
632      return 0;
633   fail_l1b:
634      g_free(extent->l1_backup_table);
635   fail_l1:
636      g_free(extent->l1_table);
637      return ret;
638  }
639  
640  static int vmdk_open_vmfs_sparse(BlockDriverState *bs,
641                                   BdrvChild *file,
642                                   int flags, Error **errp)
643  {
644      int ret;
645      uint32_t magic;
646      VMDK3Header header;
647      VmdkExtent *extent = NULL;
648  
649      ret = bdrv_pread(file, sizeof(magic), sizeof(header), &header, 0);
650      if (ret < 0) {
651          bdrv_refresh_filename(file->bs);
652          error_setg_errno(errp, -ret,
653                           "Could not read header from file '%s'",
654                           file->bs->filename);
655          return ret;
656      }
657      ret = vmdk_add_extent(bs, file, false,
658                            le32_to_cpu(header.disk_sectors),
659                            (int64_t)le32_to_cpu(header.l1dir_offset) << 9,
660                            0,
661                            le32_to_cpu(header.l1dir_size),
662                            4096,
663                            le32_to_cpu(header.granularity),
664                            &extent,
665                            errp);
666      if (ret < 0) {
667          return ret;
668      }
669      ret = vmdk_init_tables(bs, extent, errp);
670      if (ret) {
671          /* free extent allocated by vmdk_add_extent */
672          vmdk_free_last_extent(bs);
673      }
674      return ret;
675  }
676  
677  #define SESPARSE_CONST_HEADER_MAGIC UINT64_C(0x00000000cafebabe)
678  #define SESPARSE_VOLATILE_HEADER_MAGIC UINT64_C(0x00000000cafecafe)
679  
680  /* Strict checks - format not officially documented */
681  static int check_se_sparse_const_header(VMDKSESparseConstHeader *header,
682                                          Error **errp)
683  {
684      header->magic = le64_to_cpu(header->magic);
685      header->version = le64_to_cpu(header->version);
686      header->grain_size = le64_to_cpu(header->grain_size);
687      header->grain_table_size = le64_to_cpu(header->grain_table_size);
688      header->flags = le64_to_cpu(header->flags);
689      header->reserved1 = le64_to_cpu(header->reserved1);
690      header->reserved2 = le64_to_cpu(header->reserved2);
691      header->reserved3 = le64_to_cpu(header->reserved3);
692      header->reserved4 = le64_to_cpu(header->reserved4);
693  
694      header->volatile_header_offset =
695          le64_to_cpu(header->volatile_header_offset);
696      header->volatile_header_size = le64_to_cpu(header->volatile_header_size);
697  
698      header->journal_header_offset = le64_to_cpu(header->journal_header_offset);
699      header->journal_header_size = le64_to_cpu(header->journal_header_size);
700  
701      header->journal_offset = le64_to_cpu(header->journal_offset);
702      header->journal_size = le64_to_cpu(header->journal_size);
703  
704      header->grain_dir_offset = le64_to_cpu(header->grain_dir_offset);
705      header->grain_dir_size = le64_to_cpu(header->grain_dir_size);
706  
707      header->grain_tables_offset = le64_to_cpu(header->grain_tables_offset);
708      header->grain_tables_size = le64_to_cpu(header->grain_tables_size);
709  
710      header->free_bitmap_offset = le64_to_cpu(header->free_bitmap_offset);
711      header->free_bitmap_size = le64_to_cpu(header->free_bitmap_size);
712  
713      header->backmap_offset = le64_to_cpu(header->backmap_offset);
714      header->backmap_size = le64_to_cpu(header->backmap_size);
715  
716      header->grains_offset = le64_to_cpu(header->grains_offset);
717      header->grains_size = le64_to_cpu(header->grains_size);
718  
719      if (header->magic != SESPARSE_CONST_HEADER_MAGIC) {
720          error_setg(errp, "Bad const header magic: 0x%016" PRIx64,
721                     header->magic);
722          return -EINVAL;
723      }
724  
725      if (header->version != 0x0000000200000001) {
726          error_setg(errp, "Unsupported version: 0x%016" PRIx64,
727                     header->version);
728          return -ENOTSUP;
729      }
730  
731      if (header->grain_size != 8) {
732          error_setg(errp, "Unsupported grain size: %" PRIu64,
733                     header->grain_size);
734          return -ENOTSUP;
735      }
736  
737      if (header->grain_table_size != 64) {
738          error_setg(errp, "Unsupported grain table size: %" PRIu64,
739                     header->grain_table_size);
740          return -ENOTSUP;
741      }
742  
743      if (header->flags != 0) {
744          error_setg(errp, "Unsupported flags: 0x%016" PRIx64,
745                     header->flags);
746          return -ENOTSUP;
747      }
748  
749      if (header->reserved1 != 0 || header->reserved2 != 0 ||
750          header->reserved3 != 0 || header->reserved4 != 0) {
751          error_setg(errp, "Unsupported reserved bits:"
752                     " 0x%016" PRIx64 " 0x%016" PRIx64
753                     " 0x%016" PRIx64 " 0x%016" PRIx64,
754                     header->reserved1, header->reserved2,
755                     header->reserved3, header->reserved4);
756          return -ENOTSUP;
757      }
758  
759      /* check that padding is 0 */
760      if (!buffer_is_zero(header->pad, sizeof(header->pad))) {
761          error_setg(errp, "Unsupported non-zero const header padding");
762          return -ENOTSUP;
763      }
764  
765      return 0;
766  }
767  
768  static int check_se_sparse_volatile_header(VMDKSESparseVolatileHeader *header,
769                                             Error **errp)
770  {
771      header->magic = le64_to_cpu(header->magic);
772      header->free_gt_number = le64_to_cpu(header->free_gt_number);
773      header->next_txn_seq_number = le64_to_cpu(header->next_txn_seq_number);
774      header->replay_journal = le64_to_cpu(header->replay_journal);
775  
776      if (header->magic != SESPARSE_VOLATILE_HEADER_MAGIC) {
777          error_setg(errp, "Bad volatile header magic: 0x%016" PRIx64,
778                     header->magic);
779          return -EINVAL;
780      }
781  
782      if (header->replay_journal) {
783          error_setg(errp, "Image is dirty, Replaying journal not supported");
784          return -ENOTSUP;
785      }
786  
787      /* check that padding is 0 */
788      if (!buffer_is_zero(header->pad, sizeof(header->pad))) {
789          error_setg(errp, "Unsupported non-zero volatile header padding");
790          return -ENOTSUP;
791      }
792  
793      return 0;
794  }
795  
796  static int vmdk_open_se_sparse(BlockDriverState *bs,
797                                 BdrvChild *file,
798                                 int flags, Error **errp)
799  {
800      int ret;
801      VMDKSESparseConstHeader const_header;
802      VMDKSESparseVolatileHeader volatile_header;
803      VmdkExtent *extent = NULL;
804  
805      ret = bdrv_apply_auto_read_only(bs,
806              "No write support for seSparse images available", errp);
807      if (ret < 0) {
808          return ret;
809      }
810  
811      assert(sizeof(const_header) == SECTOR_SIZE);
812  
813      ret = bdrv_pread(file, 0, sizeof(const_header), &const_header, 0);
814      if (ret < 0) {
815          bdrv_refresh_filename(file->bs);
816          error_setg_errno(errp, -ret,
817                           "Could not read const header from file '%s'",
818                           file->bs->filename);
819          return ret;
820      }
821  
822      /* check const header */
823      ret = check_se_sparse_const_header(&const_header, errp);
824      if (ret < 0) {
825          return ret;
826      }
827  
828      assert(sizeof(volatile_header) == SECTOR_SIZE);
829  
830      ret = bdrv_pread(file, const_header.volatile_header_offset * SECTOR_SIZE,
831                       sizeof(volatile_header), &volatile_header, 0);
832      if (ret < 0) {
833          bdrv_refresh_filename(file->bs);
834          error_setg_errno(errp, -ret,
835                           "Could not read volatile header from file '%s'",
836                           file->bs->filename);
837          return ret;
838      }
839  
840      /* check volatile header */
841      ret = check_se_sparse_volatile_header(&volatile_header, errp);
842      if (ret < 0) {
843          return ret;
844      }
845  
846      ret = vmdk_add_extent(bs, file, false,
847                            const_header.capacity,
848                            const_header.grain_dir_offset * SECTOR_SIZE,
849                            0,
850                            const_header.grain_dir_size *
851                            SECTOR_SIZE / sizeof(uint64_t),
852                            const_header.grain_table_size *
853                            SECTOR_SIZE / sizeof(uint64_t),
854                            const_header.grain_size,
855                            &extent,
856                            errp);
857      if (ret < 0) {
858          return ret;
859      }
860  
861      extent->sesparse = true;
862      extent->sesparse_l2_tables_offset = const_header.grain_tables_offset;
863      extent->sesparse_clusters_offset = const_header.grains_offset;
864      extent->entry_size = sizeof(uint64_t);
865  
866      ret = vmdk_init_tables(bs, extent, errp);
867      if (ret) {
868          /* free extent allocated by vmdk_add_extent */
869          vmdk_free_last_extent(bs);
870      }
871  
872      return ret;
873  }
874  
875  static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf,
876                                 QDict *options, Error **errp);
877  
878  static char *vmdk_read_desc(BdrvChild *file, uint64_t desc_offset, Error **errp)
879  {
880      int64_t size;
881      char *buf;
882      int ret;
883  
884      size = bdrv_getlength(file->bs);
885      if (size < 0) {
886          error_setg_errno(errp, -size, "Could not access file");
887          return NULL;
888      }
889  
890      if (size < 4) {
891          /* Both descriptor file and sparse image must be much larger than 4
892           * bytes, also callers of vmdk_read_desc want to compare the first 4
893           * bytes with VMDK4_MAGIC, let's error out if less is read. */
894          error_setg(errp, "File is too small, not a valid image");
895          return NULL;
896      }
897  
898      size = MIN(size, (1 << 20) - 1);  /* avoid unbounded allocation */
899      buf = g_malloc(size + 1);
900  
901      ret = bdrv_pread(file, desc_offset, size, buf, 0);
902      if (ret < 0) {
903          error_setg_errno(errp, -ret, "Could not read from file");
904          g_free(buf);
905          return NULL;
906      }
907      buf[size] = 0;
908  
909      return buf;
910  }
911  
912  static int vmdk_open_vmdk4(BlockDriverState *bs,
913                             BdrvChild *file,
914                             int flags, QDict *options, Error **errp)
915  {
916      int ret;
917      uint32_t magic;
918      uint32_t l1_size, l1_entry_sectors;
919      VMDK4Header header;
920      VmdkExtent *extent = NULL;
921      BDRVVmdkState *s = bs->opaque;
922      int64_t l1_backup_offset = 0;
923      bool compressed;
924  
925      ret = bdrv_pread(file, sizeof(magic), sizeof(header), &header, 0);
926      if (ret < 0) {
927          bdrv_refresh_filename(file->bs);
928          error_setg_errno(errp, -ret,
929                           "Could not read header from file '%s'",
930                           file->bs->filename);
931          return -EINVAL;
932      }
933      if (header.capacity == 0) {
934          uint64_t desc_offset = le64_to_cpu(header.desc_offset);
935          if (desc_offset) {
936              char *buf = vmdk_read_desc(file, desc_offset << 9, errp);
937              if (!buf) {
938                  return -EINVAL;
939              }
940              ret = vmdk_open_desc_file(bs, flags, buf, options, errp);
941              g_free(buf);
942              return ret;
943          }
944      }
945  
946      if (!s->create_type) {
947          s->create_type = g_strdup("monolithicSparse");
948      }
949  
950      if (le64_to_cpu(header.gd_offset) == VMDK4_GD_AT_END) {
951          /*
952           * The footer takes precedence over the header, so read it in. The
953           * footer starts at offset -1024 from the end: One sector for the
954           * footer, and another one for the end-of-stream marker.
955           */
956          struct {
957              struct {
958                  uint64_t val;
959                  uint32_t size;
960                  uint32_t type;
961                  uint8_t pad[512 - 16];
962              } QEMU_PACKED footer_marker;
963  
964              uint32_t magic;
965              VMDK4Header header;
966              uint8_t pad[512 - 4 - sizeof(VMDK4Header)];
967  
968              struct {
969                  uint64_t val;
970                  uint32_t size;
971                  uint32_t type;
972                  uint8_t pad[512 - 16];
973              } QEMU_PACKED eos_marker;
974          } QEMU_PACKED footer;
975  
976          ret = bdrv_pread(file, bs->file->bs->total_sectors * 512 - 1536,
977                           sizeof(footer), &footer, 0);
978          if (ret < 0) {
979              error_setg_errno(errp, -ret, "Failed to read footer");
980              return ret;
981          }
982  
983          /* Some sanity checks for the footer */
984          if (be32_to_cpu(footer.magic) != VMDK4_MAGIC ||
985              le32_to_cpu(footer.footer_marker.size) != 0  ||
986              le32_to_cpu(footer.footer_marker.type) != MARKER_FOOTER ||
987              le64_to_cpu(footer.eos_marker.val) != 0  ||
988              le32_to_cpu(footer.eos_marker.size) != 0  ||
989              le32_to_cpu(footer.eos_marker.type) != MARKER_END_OF_STREAM)
990          {
991              error_setg(errp, "Invalid footer");
992              return -EINVAL;
993          }
994  
995          header = footer.header;
996      }
997  
998      compressed =
999          le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE;
1000      if (le32_to_cpu(header.version) > 3) {
1001          error_setg(errp, "Unsupported VMDK version %" PRIu32,
1002                     le32_to_cpu(header.version));
1003          return -ENOTSUP;
1004      } else if (le32_to_cpu(header.version) == 3 && (flags & BDRV_O_RDWR) &&
1005                 !compressed) {
1006          /* VMware KB 2064959 explains that version 3 added support for
1007           * persistent changed block tracking (CBT), and backup software can
1008           * read it as version=1 if it doesn't care about the changed area
1009           * information. So we are safe to enable read only. */
1010          error_setg(errp, "VMDK version 3 must be read only");
1011          return -EINVAL;
1012      }
1013  
1014      if (le32_to_cpu(header.num_gtes_per_gt) > 512) {
1015          error_setg(errp, "L2 table size too big");
1016          return -EINVAL;
1017      }
1018  
1019      l1_entry_sectors = le32_to_cpu(header.num_gtes_per_gt)
1020                          * le64_to_cpu(header.granularity);
1021      if (l1_entry_sectors == 0) {
1022          error_setg(errp, "L1 entry size is invalid");
1023          return -EINVAL;
1024      }
1025      l1_size = (le64_to_cpu(header.capacity) + l1_entry_sectors - 1)
1026                  / l1_entry_sectors;
1027      if (le32_to_cpu(header.flags) & VMDK4_FLAG_RGD) {
1028          l1_backup_offset = le64_to_cpu(header.rgd_offset) << 9;
1029      }
1030      if (bdrv_nb_sectors(file->bs) < le64_to_cpu(header.grain_offset)) {
1031          error_setg(errp, "File truncated, expecting at least %" PRId64 " bytes",
1032                     (int64_t)(le64_to_cpu(header.grain_offset)
1033                               * BDRV_SECTOR_SIZE));
1034          return -EINVAL;
1035      }
1036  
1037      ret = vmdk_add_extent(bs, file, false,
1038                            le64_to_cpu(header.capacity),
1039                            le64_to_cpu(header.gd_offset) << 9,
1040                            l1_backup_offset,
1041                            l1_size,
1042                            le32_to_cpu(header.num_gtes_per_gt),
1043                            le64_to_cpu(header.granularity),
1044                            &extent,
1045                            errp);
1046      if (ret < 0) {
1047          return ret;
1048      }
1049      extent->compressed =
1050          le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE;
1051      if (extent->compressed) {
1052          g_free(s->create_type);
1053          s->create_type = g_strdup("streamOptimized");
1054      }
1055      extent->has_marker = le32_to_cpu(header.flags) & VMDK4_FLAG_MARKER;
1056      extent->version = le32_to_cpu(header.version);
1057      extent->has_zero_grain = le32_to_cpu(header.flags) & VMDK4_FLAG_ZERO_GRAIN;
1058      ret = vmdk_init_tables(bs, extent, errp);
1059      if (ret) {
1060          /* free extent allocated by vmdk_add_extent */
1061          vmdk_free_last_extent(bs);
1062      }
1063      return ret;
1064  }
1065  
1066  /* find an option value out of descriptor file */
1067  static int vmdk_parse_description(const char *desc, const char *opt_name,
1068          char *buf, int buf_size)
1069  {
1070      char *opt_pos, *opt_end;
1071      const char *end = desc + strlen(desc);
1072  
1073      opt_pos = strstr(desc, opt_name);
1074      if (!opt_pos) {
1075          return VMDK_ERROR;
1076      }
1077      /* Skip "=\"" following opt_name */
1078      opt_pos += strlen(opt_name) + 2;
1079      if (opt_pos >= end) {
1080          return VMDK_ERROR;
1081      }
1082      opt_end = opt_pos;
1083      while (opt_end < end && *opt_end != '"') {
1084          opt_end++;
1085      }
1086      if (opt_end == end || buf_size < opt_end - opt_pos + 1) {
1087          return VMDK_ERROR;
1088      }
1089      pstrcpy(buf, opt_end - opt_pos + 1, opt_pos);
1090      return VMDK_OK;
1091  }
1092  
1093  /* Open an extent file and append to bs array */
1094  static int vmdk_open_sparse(BlockDriverState *bs, BdrvChild *file, int flags,
1095                              char *buf, QDict *options, Error **errp)
1096  {
1097      uint32_t magic;
1098  
1099      magic = ldl_be_p(buf);
1100      switch (magic) {
1101          case VMDK3_MAGIC:
1102              return vmdk_open_vmfs_sparse(bs, file, flags, errp);
1103          case VMDK4_MAGIC:
1104              return vmdk_open_vmdk4(bs, file, flags, options, errp);
1105          default:
1106              error_setg(errp, "Image not in VMDK format");
1107              return -EINVAL;
1108      }
1109  }
1110  
1111  static const char *next_line(const char *s)
1112  {
1113      while (*s) {
1114          if (*s == '\n') {
1115              return s + 1;
1116          }
1117          s++;
1118      }
1119      return s;
1120  }
1121  
1122  static int vmdk_parse_extents(const char *desc, BlockDriverState *bs,
1123                                QDict *options, Error **errp)
1124  {
1125      int ret;
1126      int matches;
1127      char access[11];
1128      char type[11];
1129      char fname[512];
1130      const char *p, *np;
1131      int64_t sectors = 0;
1132      int64_t flat_offset;
1133      char *desc_file_dir = NULL;
1134      char *extent_path;
1135      BdrvChild *extent_file;
1136      BdrvChildRole extent_role;
1137      BDRVVmdkState *s = bs->opaque;
1138      VmdkExtent *extent = NULL;
1139      char extent_opt_prefix[32];
1140      Error *local_err = NULL;
1141  
1142      for (p = desc; *p; p = next_line(p)) {
1143          /* parse extent line in one of below formats:
1144           *
1145           * RW [size in sectors] FLAT "file-name.vmdk" OFFSET
1146           * RW [size in sectors] SPARSE "file-name.vmdk"
1147           * RW [size in sectors] VMFS "file-name.vmdk"
1148           * RW [size in sectors] VMFSSPARSE "file-name.vmdk"
1149           * RW [size in sectors] SESPARSE "file-name.vmdk"
1150           */
1151          flat_offset = -1;
1152          matches = sscanf(p, "%10s %" SCNd64 " %10s \"%511[^\n\r\"]\" %" SCNd64,
1153                           access, &sectors, type, fname, &flat_offset);
1154          if (matches < 4 || strcmp(access, "RW")) {
1155              continue;
1156          } else if (!strcmp(type, "FLAT")) {
1157              if (matches != 5 || flat_offset < 0) {
1158                  goto invalid;
1159              }
1160          } else if (!strcmp(type, "VMFS")) {
1161              if (matches == 4) {
1162                  flat_offset = 0;
1163              } else {
1164                  goto invalid;
1165              }
1166          } else if (matches != 4) {
1167              goto invalid;
1168          }
1169  
1170          if (sectors <= 0 ||
1171              (strcmp(type, "FLAT") && strcmp(type, "SPARSE") &&
1172               strcmp(type, "VMFS") && strcmp(type, "VMFSSPARSE") &&
1173               strcmp(type, "SESPARSE")) ||
1174              (strcmp(access, "RW"))) {
1175              continue;
1176          }
1177  
1178          if (path_is_absolute(fname)) {
1179              extent_path = g_strdup(fname);
1180          } else {
1181              if (!desc_file_dir) {
1182                  desc_file_dir = bdrv_dirname(bs->file->bs, errp);
1183                  if (!desc_file_dir) {
1184                      bdrv_refresh_filename(bs->file->bs);
1185                      error_prepend(errp, "Cannot use relative paths with VMDK "
1186                                    "descriptor file '%s': ",
1187                                    bs->file->bs->filename);
1188                      ret = -EINVAL;
1189                      goto out;
1190                  }
1191              }
1192  
1193              extent_path = g_strconcat(desc_file_dir, fname, NULL);
1194          }
1195  
1196          ret = snprintf(extent_opt_prefix, 32, "extents.%d", s->num_extents);
1197          assert(ret < 32);
1198  
1199          extent_role = BDRV_CHILD_DATA;
1200          if (strcmp(type, "FLAT") != 0 && strcmp(type, "VMFS") != 0) {
1201              /* non-flat extents have metadata */
1202              extent_role |= BDRV_CHILD_METADATA;
1203          }
1204  
1205          extent_file = bdrv_open_child(extent_path, options, extent_opt_prefix,
1206                                        bs, &child_of_bds, extent_role, false,
1207                                        &local_err);
1208          g_free(extent_path);
1209          if (local_err) {
1210              error_propagate(errp, local_err);
1211              ret = -EINVAL;
1212              goto out;
1213          }
1214  
1215          /* save to extents array */
1216          if (!strcmp(type, "FLAT") || !strcmp(type, "VMFS")) {
1217              /* FLAT extent */
1218  
1219              ret = vmdk_add_extent(bs, extent_file, true, sectors,
1220                              0, 0, 0, 0, 0, &extent, errp);
1221              if (ret < 0) {
1222                  bdrv_unref_child(bs, extent_file);
1223                  goto out;
1224              }
1225              extent->flat_start_offset = flat_offset << 9;
1226          } else if (!strcmp(type, "SPARSE") || !strcmp(type, "VMFSSPARSE")) {
1227              /* SPARSE extent and VMFSSPARSE extent are both "COWD" sparse file*/
1228              char *buf = vmdk_read_desc(extent_file, 0, errp);
1229              if (!buf) {
1230                  ret = -EINVAL;
1231              } else {
1232                  ret = vmdk_open_sparse(bs, extent_file, bs->open_flags, buf,
1233                                         options, errp);
1234              }
1235              g_free(buf);
1236              if (ret) {
1237                  bdrv_unref_child(bs, extent_file);
1238                  goto out;
1239              }
1240              extent = &s->extents[s->num_extents - 1];
1241          } else if (!strcmp(type, "SESPARSE")) {
1242              ret = vmdk_open_se_sparse(bs, extent_file, bs->open_flags, errp);
1243              if (ret) {
1244                  bdrv_unref_child(bs, extent_file);
1245                  goto out;
1246              }
1247              extent = &s->extents[s->num_extents - 1];
1248          } else {
1249              error_setg(errp, "Unsupported extent type '%s'", type);
1250              bdrv_unref_child(bs, extent_file);
1251              ret = -ENOTSUP;
1252              goto out;
1253          }
1254          extent->type = g_strdup(type);
1255      }
1256  
1257      ret = 0;
1258      goto out;
1259  
1260  invalid:
1261      np = next_line(p);
1262      assert(np != p);
1263      if (np[-1] == '\n') {
1264          np--;
1265      }
1266      error_setg(errp, "Invalid extent line: %.*s", (int)(np - p), p);
1267      ret = -EINVAL;
1268  
1269  out:
1270      g_free(desc_file_dir);
1271      return ret;
1272  }
1273  
1274  static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf,
1275                                 QDict *options, Error **errp)
1276  {
1277      int ret;
1278      char ct[128];
1279      BDRVVmdkState *s = bs->opaque;
1280  
1281      if (vmdk_parse_description(buf, "createType", ct, sizeof(ct))) {
1282          error_setg(errp, "invalid VMDK image descriptor");
1283          ret = -EINVAL;
1284          goto exit;
1285      }
1286      if (strcmp(ct, "monolithicFlat") &&
1287          strcmp(ct, "vmfs") &&
1288          strcmp(ct, "vmfsSparse") &&
1289          strcmp(ct, "seSparse") &&
1290          strcmp(ct, "twoGbMaxExtentSparse") &&
1291          strcmp(ct, "twoGbMaxExtentFlat")) {
1292          error_setg(errp, "Unsupported image type '%s'", ct);
1293          ret = -ENOTSUP;
1294          goto exit;
1295      }
1296      s->create_type = g_strdup(ct);
1297      s->desc_offset = 0;
1298      ret = vmdk_parse_extents(buf, bs, options, errp);
1299  exit:
1300      return ret;
1301  }
1302  
1303  static int vmdk_open(BlockDriverState *bs, QDict *options, int flags,
1304                       Error **errp)
1305  {
1306      char *buf;
1307      int ret;
1308      BDRVVmdkState *s = bs->opaque;
1309      uint32_t magic;
1310  
1311      bs->file = bdrv_open_child(NULL, options, "file", bs, &child_of_bds,
1312                                 BDRV_CHILD_IMAGE, false, errp);
1313      if (!bs->file) {
1314          return -EINVAL;
1315      }
1316  
1317      buf = vmdk_read_desc(bs->file, 0, errp);
1318      if (!buf) {
1319          return -EINVAL;
1320      }
1321  
1322      magic = ldl_be_p(buf);
1323      switch (magic) {
1324          case VMDK3_MAGIC:
1325          case VMDK4_MAGIC:
1326              ret = vmdk_open_sparse(bs, bs->file, flags, buf, options,
1327                                     errp);
1328              s->desc_offset = 0x200;
1329              break;
1330          default:
1331              /* No data in the descriptor file */
1332              bs->file->role &= ~BDRV_CHILD_DATA;
1333  
1334              /* Must succeed because we have given up permissions if anything */
1335              bdrv_child_refresh_perms(bs, bs->file, &error_abort);
1336  
1337              ret = vmdk_open_desc_file(bs, flags, buf, options, errp);
1338              break;
1339      }
1340      if (ret) {
1341          goto fail;
1342      }
1343  
1344      /* try to open parent images, if exist */
1345      ret = vmdk_parent_open(bs);
1346      if (ret) {
1347          goto fail;
1348      }
1349      ret = vmdk_read_cid(bs, 0, &s->cid);
1350      if (ret) {
1351          goto fail;
1352      }
1353      ret = vmdk_read_cid(bs, 1, &s->parent_cid);
1354      if (ret) {
1355          goto fail;
1356      }
1357      qemu_co_mutex_init(&s->lock);
1358  
1359      /* Disable migration when VMDK images are used */
1360      error_setg(&s->migration_blocker, "The vmdk format used by node '%s' "
1361                 "does not support live migration",
1362                 bdrv_get_device_or_node_name(bs));
1363      ret = migrate_add_blocker(s->migration_blocker, errp);
1364      if (ret < 0) {
1365          error_free(s->migration_blocker);
1366          goto fail;
1367      }
1368  
1369      g_free(buf);
1370      return 0;
1371  
1372  fail:
1373      g_free(buf);
1374      g_free(s->create_type);
1375      s->create_type = NULL;
1376      vmdk_free_extents(bs);
1377      return ret;
1378  }
1379  
1380  
1381  static void vmdk_refresh_limits(BlockDriverState *bs, Error **errp)
1382  {
1383      BDRVVmdkState *s = bs->opaque;
1384      int i;
1385  
1386      for (i = 0; i < s->num_extents; i++) {
1387          if (!s->extents[i].flat) {
1388              bs->bl.pwrite_zeroes_alignment =
1389                  MAX(bs->bl.pwrite_zeroes_alignment,
1390                      s->extents[i].cluster_sectors << BDRV_SECTOR_BITS);
1391          }
1392      }
1393  }
1394  
1395  /**
1396   * get_whole_cluster
1397   *
1398   * Copy backing file's cluster that covers @sector_num, otherwise write zero,
1399   * to the cluster at @cluster_sector_num. If @zeroed is true, we're overwriting
1400   * a zeroed cluster in the current layer and must not copy data from the
1401   * backing file.
1402   *
1403   * If @skip_start_sector < @skip_end_sector, the relative range
1404   * [@skip_start_sector, @skip_end_sector) is not copied or written, and leave
1405   * it for call to write user data in the request.
1406   */
1407  static int get_whole_cluster(BlockDriverState *bs,
1408                               VmdkExtent *extent,
1409                               uint64_t cluster_offset,
1410                               uint64_t offset,
1411                               uint64_t skip_start_bytes,
1412                               uint64_t skip_end_bytes,
1413                               bool zeroed)
1414  {
1415      int ret = VMDK_OK;
1416      int64_t cluster_bytes;
1417      uint8_t *whole_grain;
1418      bool copy_from_backing;
1419  
1420      /* For COW, align request sector_num to cluster start */
1421      cluster_bytes = extent->cluster_sectors << BDRV_SECTOR_BITS;
1422      offset = QEMU_ALIGN_DOWN(offset, cluster_bytes);
1423      whole_grain = qemu_blockalign(bs, cluster_bytes);
1424      copy_from_backing = bs->backing && !zeroed;
1425  
1426      if (!copy_from_backing) {
1427          memset(whole_grain, 0, skip_start_bytes);
1428          memset(whole_grain + skip_end_bytes, 0, cluster_bytes - skip_end_bytes);
1429      }
1430  
1431      assert(skip_end_bytes <= cluster_bytes);
1432      /* we will be here if it's first write on non-exist grain(cluster).
1433       * try to read from parent image, if exist */
1434      if (bs->backing && !vmdk_is_cid_valid(bs)) {
1435          ret = VMDK_ERROR;
1436          goto exit;
1437      }
1438  
1439      /* Read backing data before skip range */
1440      if (skip_start_bytes > 0) {
1441          if (copy_from_backing) {
1442              /* qcow2 emits this on bs->file instead of bs->backing */
1443              BLKDBG_EVENT(extent->file, BLKDBG_COW_READ);
1444              ret = bdrv_pread(bs->backing, offset, skip_start_bytes,
1445                               whole_grain, 0);
1446              if (ret < 0) {
1447                  ret = VMDK_ERROR;
1448                  goto exit;
1449              }
1450          }
1451          BLKDBG_EVENT(extent->file, BLKDBG_COW_WRITE);
1452          ret = bdrv_pwrite(extent->file, cluster_offset, skip_start_bytes,
1453                            whole_grain, 0);
1454          if (ret < 0) {
1455              ret = VMDK_ERROR;
1456              goto exit;
1457          }
1458      }
1459      /* Read backing data after skip range */
1460      if (skip_end_bytes < cluster_bytes) {
1461          if (copy_from_backing) {
1462              /* qcow2 emits this on bs->file instead of bs->backing */
1463              BLKDBG_EVENT(extent->file, BLKDBG_COW_READ);
1464              ret = bdrv_pread(bs->backing, offset + skip_end_bytes,
1465                               cluster_bytes - skip_end_bytes,
1466                               whole_grain + skip_end_bytes, 0);
1467              if (ret < 0) {
1468                  ret = VMDK_ERROR;
1469                  goto exit;
1470              }
1471          }
1472          BLKDBG_EVENT(extent->file, BLKDBG_COW_WRITE);
1473          ret = bdrv_pwrite(extent->file, cluster_offset + skip_end_bytes,
1474                            cluster_bytes - skip_end_bytes,
1475                            whole_grain + skip_end_bytes, 0);
1476          if (ret < 0) {
1477              ret = VMDK_ERROR;
1478              goto exit;
1479          }
1480      }
1481  
1482      ret = VMDK_OK;
1483  exit:
1484      qemu_vfree(whole_grain);
1485      return ret;
1486  }
1487  
1488  static int vmdk_L2update(VmdkExtent *extent, VmdkMetaData *m_data,
1489                           uint32_t offset)
1490  {
1491      offset = cpu_to_le32(offset);
1492      /* update L2 table */
1493      BLKDBG_EVENT(extent->file, BLKDBG_L2_UPDATE);
1494      if (bdrv_pwrite(extent->file,
1495                  ((int64_t)m_data->l2_offset * 512)
1496                      + (m_data->l2_index * sizeof(offset)),
1497                  sizeof(offset), &offset, 0) < 0) {
1498          return VMDK_ERROR;
1499      }
1500      /* update backup L2 table */
1501      if (extent->l1_backup_table_offset != 0) {
1502          m_data->l2_offset = extent->l1_backup_table[m_data->l1_index];
1503          if (bdrv_pwrite(extent->file,
1504                      ((int64_t)m_data->l2_offset * 512)
1505                          + (m_data->l2_index * sizeof(offset)),
1506                      sizeof(offset), &offset, 0) < 0) {
1507              return VMDK_ERROR;
1508          }
1509      }
1510      if (bdrv_flush(extent->file->bs) < 0) {
1511          return VMDK_ERROR;
1512      }
1513      if (m_data->l2_cache_entry) {
1514          *m_data->l2_cache_entry = offset;
1515      }
1516  
1517      return VMDK_OK;
1518  }
1519  
1520  /**
1521   * get_cluster_offset
1522   *
1523   * Look up cluster offset in extent file by sector number, and store in
1524   * @cluster_offset.
1525   *
1526   * For flat extents, the start offset as parsed from the description file is
1527   * returned.
1528   *
1529   * For sparse extents, look up in L1, L2 table. If allocate is true, return an
1530   * offset for a new cluster and update L2 cache. If there is a backing file,
1531   * COW is done before returning; otherwise, zeroes are written to the allocated
1532   * cluster. Both COW and zero writing skips the sector range
1533   * [@skip_start_sector, @skip_end_sector) passed in by caller, because caller
1534   * has new data to write there.
1535   *
1536   * Returns: VMDK_OK if cluster exists and mapped in the image.
1537   *          VMDK_UNALLOC if cluster is not mapped and @allocate is false.
1538   *          VMDK_ERROR if failed.
1539   */
1540  static int get_cluster_offset(BlockDriverState *bs,
1541                                VmdkExtent *extent,
1542                                VmdkMetaData *m_data,
1543                                uint64_t offset,
1544                                bool allocate,
1545                                uint64_t *cluster_offset,
1546                                uint64_t skip_start_bytes,
1547                                uint64_t skip_end_bytes)
1548  {
1549      unsigned int l1_index, l2_offset, l2_index;
1550      int min_index, i, j;
1551      uint32_t min_count;
1552      void *l2_table;
1553      bool zeroed = false;
1554      int64_t ret;
1555      int64_t cluster_sector;
1556      unsigned int l2_size_bytes = extent->l2_size * extent->entry_size;
1557  
1558      if (m_data) {
1559          m_data->new_allocation = false;
1560      }
1561      if (extent->flat) {
1562          *cluster_offset = extent->flat_start_offset;
1563          return VMDK_OK;
1564      }
1565  
1566      offset -= (extent->end_sector - extent->sectors) * SECTOR_SIZE;
1567      l1_index = (offset >> 9) / extent->l1_entry_sectors;
1568      if (l1_index >= extent->l1_size) {
1569          return VMDK_ERROR;
1570      }
1571      if (extent->sesparse) {
1572          uint64_t l2_offset_u64;
1573  
1574          assert(extent->entry_size == sizeof(uint64_t));
1575  
1576          l2_offset_u64 = ((uint64_t *)extent->l1_table)[l1_index];
1577          if (l2_offset_u64 == 0) {
1578              l2_offset = 0;
1579          } else if ((l2_offset_u64 & 0xffffffff00000000) != 0x1000000000000000) {
1580              /*
1581               * Top most nibble is 0x1 if grain table is allocated.
1582               * strict check - top most 4 bytes must be 0x10000000 since max
1583               * supported size is 64TB for disk - so no more than 64TB / 16MB
1584               * grain directories which is smaller than uint32,
1585               * where 16MB is the only supported default grain table coverage.
1586               */
1587              return VMDK_ERROR;
1588          } else {
1589              l2_offset_u64 = l2_offset_u64 & 0x00000000ffffffff;
1590              l2_offset_u64 = extent->sesparse_l2_tables_offset +
1591                  l2_offset_u64 * l2_size_bytes / SECTOR_SIZE;
1592              if (l2_offset_u64 > 0x00000000ffffffff) {
1593                  return VMDK_ERROR;
1594              }
1595              l2_offset = (unsigned int)(l2_offset_u64);
1596          }
1597      } else {
1598          assert(extent->entry_size == sizeof(uint32_t));
1599          l2_offset = ((uint32_t *)extent->l1_table)[l1_index];
1600      }
1601      if (!l2_offset) {
1602          return VMDK_UNALLOC;
1603      }
1604      for (i = 0; i < L2_CACHE_SIZE; i++) {
1605          if (l2_offset == extent->l2_cache_offsets[i]) {
1606              /* increment the hit count */
1607              if (++extent->l2_cache_counts[i] == 0xffffffff) {
1608                  for (j = 0; j < L2_CACHE_SIZE; j++) {
1609                      extent->l2_cache_counts[j] >>= 1;
1610                  }
1611              }
1612              l2_table = (char *)extent->l2_cache + (i * l2_size_bytes);
1613              goto found;
1614          }
1615      }
1616      /* not found: load a new entry in the least used one */
1617      min_index = 0;
1618      min_count = 0xffffffff;
1619      for (i = 0; i < L2_CACHE_SIZE; i++) {
1620          if (extent->l2_cache_counts[i] < min_count) {
1621              min_count = extent->l2_cache_counts[i];
1622              min_index = i;
1623          }
1624      }
1625      l2_table = (char *)extent->l2_cache + (min_index * l2_size_bytes);
1626      BLKDBG_EVENT(extent->file, BLKDBG_L2_LOAD);
1627      if (bdrv_pread(extent->file,
1628                  (int64_t)l2_offset * 512,
1629                  l2_size_bytes,
1630                  l2_table,
1631                  0
1632              ) < 0) {
1633          return VMDK_ERROR;
1634      }
1635  
1636      extent->l2_cache_offsets[min_index] = l2_offset;
1637      extent->l2_cache_counts[min_index] = 1;
1638   found:
1639      l2_index = ((offset >> 9) / extent->cluster_sectors) % extent->l2_size;
1640      if (m_data) {
1641          m_data->l1_index = l1_index;
1642          m_data->l2_index = l2_index;
1643          m_data->l2_offset = l2_offset;
1644          m_data->l2_cache_entry = ((uint32_t *)l2_table) + l2_index;
1645      }
1646  
1647      if (extent->sesparse) {
1648          cluster_sector = le64_to_cpu(((uint64_t *)l2_table)[l2_index]);
1649          switch (cluster_sector & 0xf000000000000000) {
1650          case 0x0000000000000000:
1651              /* unallocated grain */
1652              if (cluster_sector != 0) {
1653                  return VMDK_ERROR;
1654              }
1655              break;
1656          case 0x1000000000000000:
1657              /* scsi-unmapped grain - fallthrough */
1658          case 0x2000000000000000:
1659              /* zero grain */
1660              zeroed = true;
1661              break;
1662          case 0x3000000000000000:
1663              /* allocated grain */
1664              cluster_sector = (((cluster_sector & 0x0fff000000000000) >> 48) |
1665                                ((cluster_sector & 0x0000ffffffffffff) << 12));
1666              cluster_sector = extent->sesparse_clusters_offset +
1667                  cluster_sector * extent->cluster_sectors;
1668              break;
1669          default:
1670              return VMDK_ERROR;
1671          }
1672      } else {
1673          cluster_sector = le32_to_cpu(((uint32_t *)l2_table)[l2_index]);
1674  
1675          if (extent->has_zero_grain && cluster_sector == VMDK_GTE_ZEROED) {
1676              zeroed = true;
1677          }
1678      }
1679  
1680      if (!cluster_sector || zeroed) {
1681          if (!allocate) {
1682              return zeroed ? VMDK_ZEROED : VMDK_UNALLOC;
1683          }
1684          assert(!extent->sesparse);
1685  
1686          if (extent->next_cluster_sector >= VMDK_EXTENT_MAX_SECTORS) {
1687              return VMDK_ERROR;
1688          }
1689  
1690          cluster_sector = extent->next_cluster_sector;
1691          extent->next_cluster_sector += extent->cluster_sectors;
1692  
1693          /* First of all we write grain itself, to avoid race condition
1694           * that may to corrupt the image.
1695           * This problem may occur because of insufficient space on host disk
1696           * or inappropriate VM shutdown.
1697           */
1698          ret = get_whole_cluster(bs, extent, cluster_sector * BDRV_SECTOR_SIZE,
1699                                  offset, skip_start_bytes, skip_end_bytes,
1700                                  zeroed);
1701          if (ret) {
1702              return ret;
1703          }
1704          if (m_data) {
1705              m_data->new_allocation = true;
1706          }
1707      }
1708      *cluster_offset = cluster_sector << BDRV_SECTOR_BITS;
1709      return VMDK_OK;
1710  }
1711  
1712  static VmdkExtent *find_extent(BDRVVmdkState *s,
1713                                  int64_t sector_num, VmdkExtent *start_hint)
1714  {
1715      VmdkExtent *extent = start_hint;
1716  
1717      if (!extent) {
1718          extent = &s->extents[0];
1719      }
1720      while (extent < &s->extents[s->num_extents]) {
1721          if (sector_num < extent->end_sector) {
1722              return extent;
1723          }
1724          extent++;
1725      }
1726      return NULL;
1727  }
1728  
1729  static inline uint64_t vmdk_find_offset_in_cluster(VmdkExtent *extent,
1730                                                     int64_t offset)
1731  {
1732      uint64_t extent_begin_offset, extent_relative_offset;
1733      uint64_t cluster_size = extent->cluster_sectors * BDRV_SECTOR_SIZE;
1734  
1735      extent_begin_offset =
1736          (extent->end_sector - extent->sectors) * BDRV_SECTOR_SIZE;
1737      extent_relative_offset = offset - extent_begin_offset;
1738      return extent_relative_offset % cluster_size;
1739  }
1740  
1741  static int coroutine_fn vmdk_co_block_status(BlockDriverState *bs,
1742                                               bool want_zero,
1743                                               int64_t offset, int64_t bytes,
1744                                               int64_t *pnum, int64_t *map,
1745                                               BlockDriverState **file)
1746  {
1747      BDRVVmdkState *s = bs->opaque;
1748      int64_t index_in_cluster, n, ret;
1749      uint64_t cluster_offset;
1750      VmdkExtent *extent;
1751  
1752      extent = find_extent(s, offset >> BDRV_SECTOR_BITS, NULL);
1753      if (!extent) {
1754          return -EIO;
1755      }
1756      qemu_co_mutex_lock(&s->lock);
1757      ret = get_cluster_offset(bs, extent, NULL, offset, false, &cluster_offset,
1758                               0, 0);
1759      qemu_co_mutex_unlock(&s->lock);
1760  
1761      index_in_cluster = vmdk_find_offset_in_cluster(extent, offset);
1762      switch (ret) {
1763      case VMDK_ERROR:
1764          ret = -EIO;
1765          break;
1766      case VMDK_UNALLOC:
1767          ret = 0;
1768          break;
1769      case VMDK_ZEROED:
1770          ret = BDRV_BLOCK_ZERO;
1771          break;
1772      case VMDK_OK:
1773          ret = BDRV_BLOCK_DATA;
1774          if (!extent->compressed) {
1775              ret |= BDRV_BLOCK_OFFSET_VALID;
1776              *map = cluster_offset + index_in_cluster;
1777              if (extent->flat) {
1778                  ret |= BDRV_BLOCK_RECURSE;
1779              }
1780          }
1781          *file = extent->file->bs;
1782          break;
1783      }
1784  
1785      n = extent->cluster_sectors * BDRV_SECTOR_SIZE - index_in_cluster;
1786      *pnum = MIN(n, bytes);
1787      return ret;
1788  }
1789  
1790  static int vmdk_write_extent(VmdkExtent *extent, int64_t cluster_offset,
1791                              int64_t offset_in_cluster, QEMUIOVector *qiov,
1792                              uint64_t qiov_offset, uint64_t n_bytes,
1793                              uint64_t offset)
1794  {
1795      int ret;
1796      VmdkGrainMarker *data = NULL;
1797      uLongf buf_len;
1798      QEMUIOVector local_qiov;
1799      int64_t write_offset;
1800      int64_t write_end_sector;
1801  
1802      if (extent->compressed) {
1803          void *compressed_data;
1804  
1805          /* Only whole clusters */
1806          if (offset_in_cluster ||
1807              n_bytes > (extent->cluster_sectors * SECTOR_SIZE) ||
1808              (n_bytes < (extent->cluster_sectors * SECTOR_SIZE) &&
1809               offset + n_bytes != extent->end_sector * SECTOR_SIZE))
1810          {
1811              ret = -EINVAL;
1812              goto out;
1813          }
1814  
1815          if (!extent->has_marker) {
1816              ret = -EINVAL;
1817              goto out;
1818          }
1819          buf_len = (extent->cluster_sectors << 9) * 2;
1820          data = g_malloc(buf_len + sizeof(VmdkGrainMarker));
1821  
1822          compressed_data = g_malloc(n_bytes);
1823          qemu_iovec_to_buf(qiov, qiov_offset, compressed_data, n_bytes);
1824          ret = compress(data->data, &buf_len, compressed_data, n_bytes);
1825          g_free(compressed_data);
1826  
1827          if (ret != Z_OK || buf_len == 0) {
1828              ret = -EINVAL;
1829              goto out;
1830          }
1831  
1832          data->lba = cpu_to_le64(offset >> BDRV_SECTOR_BITS);
1833          data->size = cpu_to_le32(buf_len);
1834  
1835          n_bytes = buf_len + sizeof(VmdkGrainMarker);
1836          qemu_iovec_init_buf(&local_qiov, data, n_bytes);
1837  
1838          BLKDBG_EVENT(extent->file, BLKDBG_WRITE_COMPRESSED);
1839      } else {
1840          qemu_iovec_init(&local_qiov, qiov->niov);
1841          qemu_iovec_concat(&local_qiov, qiov, qiov_offset, n_bytes);
1842  
1843          BLKDBG_EVENT(extent->file, BLKDBG_WRITE_AIO);
1844      }
1845  
1846      write_offset = cluster_offset + offset_in_cluster;
1847      ret = bdrv_co_pwritev(extent->file, write_offset, n_bytes,
1848                            &local_qiov, 0);
1849  
1850      write_end_sector = DIV_ROUND_UP(write_offset + n_bytes, BDRV_SECTOR_SIZE);
1851  
1852      if (extent->compressed) {
1853          extent->next_cluster_sector = write_end_sector;
1854      } else {
1855          extent->next_cluster_sector = MAX(extent->next_cluster_sector,
1856                                            write_end_sector);
1857      }
1858  
1859      if (ret < 0) {
1860          goto out;
1861      }
1862      ret = 0;
1863   out:
1864      g_free(data);
1865      if (!extent->compressed) {
1866          qemu_iovec_destroy(&local_qiov);
1867      }
1868      return ret;
1869  }
1870  
1871  static int vmdk_read_extent(VmdkExtent *extent, int64_t cluster_offset,
1872                              int64_t offset_in_cluster, QEMUIOVector *qiov,
1873                              int bytes)
1874  {
1875      int ret;
1876      int cluster_bytes, buf_bytes;
1877      uint8_t *cluster_buf, *compressed_data;
1878      uint8_t *uncomp_buf;
1879      uint32_t data_len;
1880      VmdkGrainMarker *marker;
1881      uLongf buf_len;
1882  
1883  
1884      if (!extent->compressed) {
1885          BLKDBG_EVENT(extent->file, BLKDBG_READ_AIO);
1886          ret = bdrv_co_preadv(extent->file,
1887                               cluster_offset + offset_in_cluster, bytes,
1888                               qiov, 0);
1889          if (ret < 0) {
1890              return ret;
1891          }
1892          return 0;
1893      }
1894      cluster_bytes = extent->cluster_sectors * 512;
1895      /* Read two clusters in case GrainMarker + compressed data > one cluster */
1896      buf_bytes = cluster_bytes * 2;
1897      cluster_buf = g_malloc(buf_bytes);
1898      uncomp_buf = g_malloc(cluster_bytes);
1899      BLKDBG_EVENT(extent->file, BLKDBG_READ_COMPRESSED);
1900      ret = bdrv_pread(extent->file, cluster_offset, buf_bytes, cluster_buf, 0);
1901      if (ret < 0) {
1902          goto out;
1903      }
1904      compressed_data = cluster_buf;
1905      buf_len = cluster_bytes;
1906      data_len = cluster_bytes;
1907      if (extent->has_marker) {
1908          marker = (VmdkGrainMarker *)cluster_buf;
1909          compressed_data = marker->data;
1910          data_len = le32_to_cpu(marker->size);
1911      }
1912      if (!data_len || data_len > buf_bytes) {
1913          ret = -EINVAL;
1914          goto out;
1915      }
1916      ret = uncompress(uncomp_buf, &buf_len, compressed_data, data_len);
1917      if (ret != Z_OK) {
1918          ret = -EINVAL;
1919          goto out;
1920  
1921      }
1922      if (offset_in_cluster < 0 ||
1923              offset_in_cluster + bytes > buf_len) {
1924          ret = -EINVAL;
1925          goto out;
1926      }
1927      qemu_iovec_from_buf(qiov, 0, uncomp_buf + offset_in_cluster, bytes);
1928      ret = 0;
1929  
1930   out:
1931      g_free(uncomp_buf);
1932      g_free(cluster_buf);
1933      return ret;
1934  }
1935  
1936  static int coroutine_fn
1937  vmdk_co_preadv(BlockDriverState *bs, int64_t offset, int64_t bytes,
1938                 QEMUIOVector *qiov, BdrvRequestFlags flags)
1939  {
1940      BDRVVmdkState *s = bs->opaque;
1941      int ret;
1942      uint64_t n_bytes, offset_in_cluster;
1943      VmdkExtent *extent = NULL;
1944      QEMUIOVector local_qiov;
1945      uint64_t cluster_offset;
1946      uint64_t bytes_done = 0;
1947  
1948      qemu_iovec_init(&local_qiov, qiov->niov);
1949      qemu_co_mutex_lock(&s->lock);
1950  
1951      while (bytes > 0) {
1952          extent = find_extent(s, offset >> BDRV_SECTOR_BITS, extent);
1953          if (!extent) {
1954              ret = -EIO;
1955              goto fail;
1956          }
1957          ret = get_cluster_offset(bs, extent, NULL,
1958                                   offset, false, &cluster_offset, 0, 0);
1959          offset_in_cluster = vmdk_find_offset_in_cluster(extent, offset);
1960  
1961          n_bytes = MIN(bytes, extent->cluster_sectors * BDRV_SECTOR_SIZE
1962                               - offset_in_cluster);
1963  
1964          if (ret != VMDK_OK) {
1965              /* if not allocated, try to read from parent image, if exist */
1966              if (bs->backing && ret != VMDK_ZEROED) {
1967                  if (!vmdk_is_cid_valid(bs)) {
1968                      ret = -EINVAL;
1969                      goto fail;
1970                  }
1971  
1972                  qemu_iovec_reset(&local_qiov);
1973                  qemu_iovec_concat(&local_qiov, qiov, bytes_done, n_bytes);
1974  
1975                  /* qcow2 emits this on bs->file instead of bs->backing */
1976                  BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO);
1977                  ret = bdrv_co_preadv(bs->backing, offset, n_bytes,
1978                                       &local_qiov, 0);
1979                  if (ret < 0) {
1980                      goto fail;
1981                  }
1982              } else {
1983                  qemu_iovec_memset(qiov, bytes_done, 0, n_bytes);
1984              }
1985          } else {
1986              qemu_iovec_reset(&local_qiov);
1987              qemu_iovec_concat(&local_qiov, qiov, bytes_done, n_bytes);
1988  
1989              ret = vmdk_read_extent(extent, cluster_offset, offset_in_cluster,
1990                                     &local_qiov, n_bytes);
1991              if (ret) {
1992                  goto fail;
1993              }
1994          }
1995          bytes -= n_bytes;
1996          offset += n_bytes;
1997          bytes_done += n_bytes;
1998      }
1999  
2000      ret = 0;
2001  fail:
2002      qemu_co_mutex_unlock(&s->lock);
2003      qemu_iovec_destroy(&local_qiov);
2004  
2005      return ret;
2006  }
2007  
2008  /**
2009   * vmdk_write:
2010   * @zeroed:       buf is ignored (data is zero), use zeroed_grain GTE feature
2011   *                if possible, otherwise return -ENOTSUP.
2012   * @zero_dry_run: used for zeroed == true only, don't update L2 table, just try
2013   *                with each cluster. By dry run we can find if the zero write
2014   *                is possible without modifying image data.
2015   *
2016   * Returns: error code with 0 for success.
2017   */
2018  static int vmdk_pwritev(BlockDriverState *bs, uint64_t offset,
2019                         uint64_t bytes, QEMUIOVector *qiov,
2020                         bool zeroed, bool zero_dry_run)
2021  {
2022      BDRVVmdkState *s = bs->opaque;
2023      VmdkExtent *extent = NULL;
2024      int ret;
2025      int64_t offset_in_cluster, n_bytes;
2026      uint64_t cluster_offset;
2027      uint64_t bytes_done = 0;
2028      VmdkMetaData m_data;
2029  
2030      if (DIV_ROUND_UP(offset, BDRV_SECTOR_SIZE) > bs->total_sectors) {
2031          error_report("Wrong offset: offset=0x%" PRIx64
2032                       " total_sectors=0x%" PRIx64,
2033                       offset, bs->total_sectors);
2034          return -EIO;
2035      }
2036  
2037      while (bytes > 0) {
2038          extent = find_extent(s, offset >> BDRV_SECTOR_BITS, extent);
2039          if (!extent) {
2040              return -EIO;
2041          }
2042          if (extent->sesparse) {
2043              return -ENOTSUP;
2044          }
2045          offset_in_cluster = vmdk_find_offset_in_cluster(extent, offset);
2046          n_bytes = MIN(bytes, extent->cluster_sectors * BDRV_SECTOR_SIZE
2047                               - offset_in_cluster);
2048  
2049          ret = get_cluster_offset(bs, extent, &m_data, offset,
2050                                   !(extent->compressed || zeroed),
2051                                   &cluster_offset, offset_in_cluster,
2052                                   offset_in_cluster + n_bytes);
2053          if (extent->compressed) {
2054              if (ret == VMDK_OK) {
2055                  /* Refuse write to allocated cluster for streamOptimized */
2056                  error_report("Could not write to allocated cluster"
2057                                " for streamOptimized");
2058                  return -EIO;
2059              } else if (!zeroed) {
2060                  /* allocate */
2061                  ret = get_cluster_offset(bs, extent, &m_data, offset,
2062                                           true, &cluster_offset, 0, 0);
2063              }
2064          }
2065          if (ret == VMDK_ERROR) {
2066              return -EINVAL;
2067          }
2068          if (zeroed) {
2069              /* Do zeroed write, buf is ignored */
2070              if (extent->has_zero_grain &&
2071                      offset_in_cluster == 0 &&
2072                      n_bytes >= extent->cluster_sectors * BDRV_SECTOR_SIZE) {
2073                  n_bytes = extent->cluster_sectors * BDRV_SECTOR_SIZE;
2074                  if (!zero_dry_run && ret != VMDK_ZEROED) {
2075                      /* update L2 tables */
2076                      if (vmdk_L2update(extent, &m_data, VMDK_GTE_ZEROED)
2077                              != VMDK_OK) {
2078                          return -EIO;
2079                      }
2080                  }
2081              } else {
2082                  return -ENOTSUP;
2083              }
2084          } else {
2085              ret = vmdk_write_extent(extent, cluster_offset, offset_in_cluster,
2086                                      qiov, bytes_done, n_bytes, offset);
2087              if (ret) {
2088                  return ret;
2089              }
2090              if (m_data.new_allocation) {
2091                  /* update L2 tables */
2092                  if (vmdk_L2update(extent, &m_data,
2093                                    cluster_offset >> BDRV_SECTOR_BITS)
2094                          != VMDK_OK) {
2095                      return -EIO;
2096                  }
2097              }
2098          }
2099          bytes -= n_bytes;
2100          offset += n_bytes;
2101          bytes_done += n_bytes;
2102  
2103          /* update CID on the first write every time the virtual disk is
2104           * opened */
2105          if (!s->cid_updated) {
2106              ret = vmdk_write_cid(bs, g_random_int());
2107              if (ret < 0) {
2108                  return ret;
2109              }
2110              s->cid_updated = true;
2111          }
2112      }
2113      return 0;
2114  }
2115  
2116  static int coroutine_fn
2117  vmdk_co_pwritev(BlockDriverState *bs, int64_t offset, int64_t bytes,
2118                  QEMUIOVector *qiov, BdrvRequestFlags flags)
2119  {
2120      int ret;
2121      BDRVVmdkState *s = bs->opaque;
2122      qemu_co_mutex_lock(&s->lock);
2123      ret = vmdk_pwritev(bs, offset, bytes, qiov, false, false);
2124      qemu_co_mutex_unlock(&s->lock);
2125      return ret;
2126  }
2127  
2128  static int coroutine_fn
2129  vmdk_co_pwritev_compressed(BlockDriverState *bs, int64_t offset, int64_t bytes,
2130                             QEMUIOVector *qiov)
2131  {
2132      if (bytes == 0) {
2133          /* The caller will write bytes 0 to signal EOF.
2134           * When receive it, we align EOF to a sector boundary. */
2135          BDRVVmdkState *s = bs->opaque;
2136          int i, ret;
2137          int64_t length;
2138  
2139          for (i = 0; i < s->num_extents; i++) {
2140              length = bdrv_getlength(s->extents[i].file->bs);
2141              if (length < 0) {
2142                  return length;
2143              }
2144              length = QEMU_ALIGN_UP(length, BDRV_SECTOR_SIZE);
2145              ret = bdrv_truncate(s->extents[i].file, length, false,
2146                                  PREALLOC_MODE_OFF, 0, NULL);
2147              if (ret < 0) {
2148                  return ret;
2149              }
2150          }
2151          return 0;
2152      }
2153      return vmdk_co_pwritev(bs, offset, bytes, qiov, 0);
2154  }
2155  
2156  static int coroutine_fn vmdk_co_pwrite_zeroes(BlockDriverState *bs,
2157                                                int64_t offset,
2158                                                int64_t bytes,
2159                                                BdrvRequestFlags flags)
2160  {
2161      int ret;
2162      BDRVVmdkState *s = bs->opaque;
2163  
2164      qemu_co_mutex_lock(&s->lock);
2165      /* write zeroes could fail if sectors not aligned to cluster, test it with
2166       * dry_run == true before really updating image */
2167      ret = vmdk_pwritev(bs, offset, bytes, NULL, true, true);
2168      if (!ret) {
2169          ret = vmdk_pwritev(bs, offset, bytes, NULL, true, false);
2170      }
2171      qemu_co_mutex_unlock(&s->lock);
2172      return ret;
2173  }
2174  
2175  static int vmdk_init_extent(BlockBackend *blk,
2176                              int64_t filesize, bool flat,
2177                              bool compress, bool zeroed_grain,
2178                              Error **errp)
2179  {
2180      int ret, i;
2181      VMDK4Header header;
2182      uint32_t tmp, magic, grains, gd_sectors, gt_size, gt_count;
2183      uint32_t *gd_buf = NULL;
2184      int gd_buf_size;
2185  
2186      if (flat) {
2187          ret = blk_truncate(blk, filesize, false, PREALLOC_MODE_OFF, 0, errp);
2188          goto exit;
2189      }
2190      magic = cpu_to_be32(VMDK4_MAGIC);
2191      memset(&header, 0, sizeof(header));
2192      if (compress) {
2193          header.version = 3;
2194      } else if (zeroed_grain) {
2195          header.version = 2;
2196      } else {
2197          header.version = 1;
2198      }
2199      header.flags = VMDK4_FLAG_RGD | VMDK4_FLAG_NL_DETECT
2200                     | (compress ? VMDK4_FLAG_COMPRESS | VMDK4_FLAG_MARKER : 0)
2201                     | (zeroed_grain ? VMDK4_FLAG_ZERO_GRAIN : 0);
2202      header.compressAlgorithm = compress ? VMDK4_COMPRESSION_DEFLATE : 0;
2203      header.capacity = filesize / BDRV_SECTOR_SIZE;
2204      header.granularity = 128;
2205      header.num_gtes_per_gt = BDRV_SECTOR_SIZE;
2206  
2207      grains = DIV_ROUND_UP(filesize / BDRV_SECTOR_SIZE, header.granularity);
2208      gt_size = DIV_ROUND_UP(header.num_gtes_per_gt * sizeof(uint32_t),
2209                             BDRV_SECTOR_SIZE);
2210      gt_count = DIV_ROUND_UP(grains, header.num_gtes_per_gt);
2211      gd_sectors = DIV_ROUND_UP(gt_count * sizeof(uint32_t), BDRV_SECTOR_SIZE);
2212  
2213      header.desc_offset = 1;
2214      header.desc_size = 20;
2215      header.rgd_offset = header.desc_offset + header.desc_size;
2216      header.gd_offset = header.rgd_offset + gd_sectors + (gt_size * gt_count);
2217      header.grain_offset =
2218          ROUND_UP(header.gd_offset + gd_sectors + (gt_size * gt_count),
2219                   header.granularity);
2220      /* swap endianness for all header fields */
2221      header.version = cpu_to_le32(header.version);
2222      header.flags = cpu_to_le32(header.flags);
2223      header.capacity = cpu_to_le64(header.capacity);
2224      header.granularity = cpu_to_le64(header.granularity);
2225      header.num_gtes_per_gt = cpu_to_le32(header.num_gtes_per_gt);
2226      header.desc_offset = cpu_to_le64(header.desc_offset);
2227      header.desc_size = cpu_to_le64(header.desc_size);
2228      header.rgd_offset = cpu_to_le64(header.rgd_offset);
2229      header.gd_offset = cpu_to_le64(header.gd_offset);
2230      header.grain_offset = cpu_to_le64(header.grain_offset);
2231      header.compressAlgorithm = cpu_to_le16(header.compressAlgorithm);
2232  
2233      header.check_bytes[0] = 0xa;
2234      header.check_bytes[1] = 0x20;
2235      header.check_bytes[2] = 0xd;
2236      header.check_bytes[3] = 0xa;
2237  
2238      /* write all the data */
2239      ret = blk_pwrite(blk, 0, sizeof(magic), &magic, 0);
2240      if (ret < 0) {
2241          error_setg(errp, QERR_IO_ERROR);
2242          goto exit;
2243      }
2244      ret = blk_pwrite(blk, sizeof(magic), sizeof(header), &header, 0);
2245      if (ret < 0) {
2246          error_setg(errp, QERR_IO_ERROR);
2247          goto exit;
2248      }
2249  
2250      ret = blk_truncate(blk, le64_to_cpu(header.grain_offset) << 9, false,
2251                         PREALLOC_MODE_OFF, 0, errp);
2252      if (ret < 0) {
2253          goto exit;
2254      }
2255  
2256      /* write grain directory */
2257      gd_buf_size = gd_sectors * BDRV_SECTOR_SIZE;
2258      gd_buf = g_malloc0(gd_buf_size);
2259      for (i = 0, tmp = le64_to_cpu(header.rgd_offset) + gd_sectors;
2260           i < gt_count; i++, tmp += gt_size) {
2261          gd_buf[i] = cpu_to_le32(tmp);
2262      }
2263      ret = blk_pwrite(blk, le64_to_cpu(header.rgd_offset) * BDRV_SECTOR_SIZE,
2264                       gd_buf_size, gd_buf, 0);
2265      if (ret < 0) {
2266          error_setg(errp, QERR_IO_ERROR);
2267          goto exit;
2268      }
2269  
2270      /* write backup grain directory */
2271      for (i = 0, tmp = le64_to_cpu(header.gd_offset) + gd_sectors;
2272           i < gt_count; i++, tmp += gt_size) {
2273          gd_buf[i] = cpu_to_le32(tmp);
2274      }
2275      ret = blk_pwrite(blk, le64_to_cpu(header.gd_offset) * BDRV_SECTOR_SIZE,
2276                       gd_buf_size, gd_buf, 0);
2277      if (ret < 0) {
2278          error_setg(errp, QERR_IO_ERROR);
2279      }
2280  
2281      ret = 0;
2282  exit:
2283      g_free(gd_buf);
2284      return ret;
2285  }
2286  
2287  static int vmdk_create_extent(const char *filename, int64_t filesize,
2288                                bool flat, bool compress, bool zeroed_grain,
2289                                BlockBackend **pbb,
2290                                QemuOpts *opts, Error **errp)
2291  {
2292      int ret;
2293      BlockBackend *blk = NULL;
2294  
2295      ret = bdrv_create_file(filename, opts, errp);
2296      if (ret < 0) {
2297          goto exit;
2298      }
2299  
2300      blk = blk_new_open(filename, NULL, NULL,
2301                         BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL,
2302                         errp);
2303      if (blk == NULL) {
2304          ret = -EIO;
2305          goto exit;
2306      }
2307  
2308      blk_set_allow_write_beyond_eof(blk, true);
2309  
2310      ret = vmdk_init_extent(blk, filesize, flat, compress, zeroed_grain, errp);
2311  exit:
2312      if (blk) {
2313          if (pbb) {
2314              *pbb = blk;
2315          } else {
2316              blk_unref(blk);
2317              blk = NULL;
2318          }
2319      }
2320      return ret;
2321  }
2322  
2323  static int filename_decompose(const char *filename, char *path, char *prefix,
2324                                char *postfix, size_t buf_len, Error **errp)
2325  {
2326      const char *p, *q;
2327  
2328      if (filename == NULL || !strlen(filename)) {
2329          error_setg(errp, "No filename provided");
2330          return VMDK_ERROR;
2331      }
2332      p = strrchr(filename, '/');
2333      if (p == NULL) {
2334          p = strrchr(filename, '\\');
2335      }
2336      if (p == NULL) {
2337          p = strrchr(filename, ':');
2338      }
2339      if (p != NULL) {
2340          p++;
2341          if (p - filename >= buf_len) {
2342              return VMDK_ERROR;
2343          }
2344          pstrcpy(path, p - filename + 1, filename);
2345      } else {
2346          p = filename;
2347          path[0] = '\0';
2348      }
2349      q = strrchr(p, '.');
2350      if (q == NULL) {
2351          pstrcpy(prefix, buf_len, p);
2352          postfix[0] = '\0';
2353      } else {
2354          if (q - p >= buf_len) {
2355              return VMDK_ERROR;
2356          }
2357          pstrcpy(prefix, q - p + 1, p);
2358          pstrcpy(postfix, buf_len, q);
2359      }
2360      return VMDK_OK;
2361  }
2362  
2363  /*
2364   * idx == 0: get or create the descriptor file (also the image file if in a
2365   *           non-split format.
2366   * idx >= 1: get the n-th extent if in a split subformat
2367   */
2368  typedef BlockBackend *(*vmdk_create_extent_fn)(int64_t size,
2369                                                 int idx,
2370                                                 bool flat,
2371                                                 bool split,
2372                                                 bool compress,
2373                                                 bool zeroed_grain,
2374                                                 void *opaque,
2375                                                 Error **errp);
2376  
2377  static void vmdk_desc_add_extent(GString *desc,
2378                                   const char *extent_line_fmt,
2379                                   int64_t size, const char *filename)
2380  {
2381      char *basename = g_path_get_basename(filename);
2382  
2383      g_string_append_printf(desc, extent_line_fmt,
2384                             DIV_ROUND_UP(size, BDRV_SECTOR_SIZE), basename);
2385      g_free(basename);
2386  }
2387  
2388  static int coroutine_fn vmdk_co_do_create(int64_t size,
2389                                            BlockdevVmdkSubformat subformat,
2390                                            BlockdevVmdkAdapterType adapter_type,
2391                                            const char *backing_file,
2392                                            const char *hw_version,
2393                                            const char *toolsversion,
2394                                            bool compat6,
2395                                            bool zeroed_grain,
2396                                            vmdk_create_extent_fn extent_fn,
2397                                            void *opaque,
2398                                            Error **errp)
2399  {
2400      int extent_idx;
2401      BlockBackend *blk = NULL;
2402      BlockBackend *extent_blk;
2403      Error *local_err = NULL;
2404      char *desc = NULL;
2405      int ret = 0;
2406      bool flat, split, compress;
2407      GString *ext_desc_lines;
2408      const int64_t split_size = 0x80000000;  /* VMDK has constant split size */
2409      int64_t extent_size;
2410      int64_t created_size = 0;
2411      const char *extent_line_fmt;
2412      char *parent_desc_line = g_malloc0(BUF_SIZE);
2413      uint32_t parent_cid = 0xffffffff;
2414      uint32_t number_heads = 16;
2415      uint32_t desc_offset = 0, desc_len;
2416      const char desc_template[] =
2417          "# Disk DescriptorFile\n"
2418          "version=1\n"
2419          "CID=%" PRIx32 "\n"
2420          "parentCID=%" PRIx32 "\n"
2421          "createType=\"%s\"\n"
2422          "%s"
2423          "\n"
2424          "# Extent description\n"
2425          "%s"
2426          "\n"
2427          "# The Disk Data Base\n"
2428          "#DDB\n"
2429          "\n"
2430          "ddb.virtualHWVersion = \"%s\"\n"
2431          "ddb.geometry.cylinders = \"%" PRId64 "\"\n"
2432          "ddb.geometry.heads = \"%" PRIu32 "\"\n"
2433          "ddb.geometry.sectors = \"63\"\n"
2434          "ddb.adapterType = \"%s\"\n"
2435          "ddb.toolsVersion = \"%s\"\n";
2436  
2437      ext_desc_lines = g_string_new(NULL);
2438  
2439      /* Read out options */
2440      if (compat6) {
2441          if (hw_version) {
2442              error_setg(errp,
2443                         "compat6 cannot be enabled with hwversion set");
2444              ret = -EINVAL;
2445              goto exit;
2446          }
2447          hw_version = "6";
2448      }
2449      if (!hw_version) {
2450          hw_version = "4";
2451      }
2452      if (!toolsversion) {
2453          toolsversion = "2147483647";
2454      }
2455  
2456      if (adapter_type != BLOCKDEV_VMDK_ADAPTER_TYPE_IDE) {
2457          /* that's the number of heads with which vmware operates when
2458             creating, exporting, etc. vmdk files with a non-ide adapter type */
2459          number_heads = 255;
2460      }
2461      split = (subformat == BLOCKDEV_VMDK_SUBFORMAT_TWOGBMAXEXTENTFLAT) ||
2462              (subformat == BLOCKDEV_VMDK_SUBFORMAT_TWOGBMAXEXTENTSPARSE);
2463      flat = (subformat == BLOCKDEV_VMDK_SUBFORMAT_MONOLITHICFLAT) ||
2464             (subformat == BLOCKDEV_VMDK_SUBFORMAT_TWOGBMAXEXTENTFLAT);
2465      compress = subformat == BLOCKDEV_VMDK_SUBFORMAT_STREAMOPTIMIZED;
2466  
2467      if (flat) {
2468          extent_line_fmt = "RW %" PRId64 " FLAT \"%s\" 0\n";
2469      } else {
2470          extent_line_fmt = "RW %" PRId64 " SPARSE \"%s\"\n";
2471      }
2472      if (flat && backing_file) {
2473          error_setg(errp, "Flat image can't have backing file");
2474          ret = -ENOTSUP;
2475          goto exit;
2476      }
2477      if (flat && zeroed_grain) {
2478          error_setg(errp, "Flat image can't enable zeroed grain");
2479          ret = -ENOTSUP;
2480          goto exit;
2481      }
2482  
2483      /* Create extents */
2484      if (split) {
2485          extent_size = split_size;
2486      } else {
2487          extent_size = size;
2488      }
2489      if (!split && !flat) {
2490          created_size = extent_size;
2491      } else {
2492          created_size = 0;
2493      }
2494      /* Get the descriptor file BDS */
2495      blk = extent_fn(created_size, 0, flat, split, compress, zeroed_grain,
2496                      opaque, errp);
2497      if (!blk) {
2498          ret = -EIO;
2499          goto exit;
2500      }
2501      if (!split && !flat) {
2502          vmdk_desc_add_extent(ext_desc_lines, extent_line_fmt, created_size,
2503                               blk_bs(blk)->filename);
2504      }
2505  
2506      if (backing_file) {
2507          BlockBackend *backing;
2508          char *full_backing =
2509              bdrv_get_full_backing_filename_from_filename(blk_bs(blk)->filename,
2510                                                           backing_file,
2511                                                           &local_err);
2512          if (local_err) {
2513              error_propagate(errp, local_err);
2514              ret = -ENOENT;
2515              goto exit;
2516          }
2517          assert(full_backing);
2518  
2519          backing = blk_new_open(full_backing, NULL, NULL,
2520                                 BDRV_O_NO_BACKING, errp);
2521          g_free(full_backing);
2522          if (backing == NULL) {
2523              ret = -EIO;
2524              goto exit;
2525          }
2526          if (strcmp(blk_bs(backing)->drv->format_name, "vmdk")) {
2527              error_setg(errp, "Invalid backing file format: %s. Must be vmdk",
2528                         blk_bs(backing)->drv->format_name);
2529              blk_unref(backing);
2530              ret = -EINVAL;
2531              goto exit;
2532          }
2533          ret = vmdk_read_cid(blk_bs(backing), 0, &parent_cid);
2534          blk_unref(backing);
2535          if (ret) {
2536              error_setg(errp, "Failed to read parent CID");
2537              goto exit;
2538          }
2539          snprintf(parent_desc_line, BUF_SIZE,
2540                  "parentFileNameHint=\"%s\"", backing_file);
2541      }
2542      extent_idx = 1;
2543      while (created_size < size) {
2544          int64_t cur_size = MIN(size - created_size, extent_size);
2545          extent_blk = extent_fn(cur_size, extent_idx, flat, split, compress,
2546                                 zeroed_grain, opaque, errp);
2547          if (!extent_blk) {
2548              ret = -EINVAL;
2549              goto exit;
2550          }
2551          vmdk_desc_add_extent(ext_desc_lines, extent_line_fmt, cur_size,
2552                               blk_bs(extent_blk)->filename);
2553          created_size += cur_size;
2554          extent_idx++;
2555          blk_unref(extent_blk);
2556      }
2557  
2558      /* Check whether we got excess extents */
2559      extent_blk = extent_fn(-1, extent_idx, flat, split, compress, zeroed_grain,
2560                             opaque, NULL);
2561      if (extent_blk) {
2562          blk_unref(extent_blk);
2563          error_setg(errp, "List of extents contains unused extents");
2564          ret = -EINVAL;
2565          goto exit;
2566      }
2567  
2568      /* generate descriptor file */
2569      desc = g_strdup_printf(desc_template,
2570                             g_random_int(),
2571                             parent_cid,
2572                             BlockdevVmdkSubformat_str(subformat),
2573                             parent_desc_line,
2574                             ext_desc_lines->str,
2575                             hw_version,
2576                             size /
2577                                 (int64_t)(63 * number_heads * BDRV_SECTOR_SIZE),
2578                             number_heads,
2579                             BlockdevVmdkAdapterType_str(adapter_type),
2580                             toolsversion);
2581      desc_len = strlen(desc);
2582      /* the descriptor offset = 0x200 */
2583      if (!split && !flat) {
2584          desc_offset = 0x200;
2585      }
2586  
2587      ret = blk_pwrite(blk, desc_offset, desc_len, desc, 0);
2588      if (ret < 0) {
2589          error_setg_errno(errp, -ret, "Could not write description");
2590          goto exit;
2591      }
2592      /* bdrv_pwrite write padding zeros to align to sector, we don't need that
2593       * for description file */
2594      if (desc_offset == 0) {
2595          ret = blk_truncate(blk, desc_len, false, PREALLOC_MODE_OFF, 0, errp);
2596          if (ret < 0) {
2597              goto exit;
2598          }
2599      }
2600      ret = 0;
2601  exit:
2602      if (blk) {
2603          blk_unref(blk);
2604      }
2605      g_free(desc);
2606      g_free(parent_desc_line);
2607      g_string_free(ext_desc_lines, true);
2608      return ret;
2609  }
2610  
2611  typedef struct {
2612      char *path;
2613      char *prefix;
2614      char *postfix;
2615      QemuOpts *opts;
2616  } VMDKCreateOptsData;
2617  
2618  static BlockBackend *vmdk_co_create_opts_cb(int64_t size, int idx,
2619                                              bool flat, bool split, bool compress,
2620                                              bool zeroed_grain, void *opaque,
2621                                              Error **errp)
2622  {
2623      BlockBackend *blk = NULL;
2624      BlockDriverState *bs = NULL;
2625      VMDKCreateOptsData *data = opaque;
2626      char *ext_filename = NULL;
2627      char *rel_filename = NULL;
2628  
2629      /* We're done, don't create excess extents. */
2630      if (size == -1) {
2631          assert(errp == NULL);
2632          return NULL;
2633      }
2634  
2635      if (idx == 0) {
2636          rel_filename = g_strdup_printf("%s%s", data->prefix, data->postfix);
2637      } else if (split) {
2638          rel_filename = g_strdup_printf("%s-%c%03d%s",
2639                                         data->prefix,
2640                                         flat ? 'f' : 's', idx, data->postfix);
2641      } else {
2642          assert(idx == 1);
2643          rel_filename = g_strdup_printf("%s-flat%s", data->prefix, data->postfix);
2644      }
2645  
2646      ext_filename = g_strdup_printf("%s%s", data->path, rel_filename);
2647      g_free(rel_filename);
2648  
2649      if (vmdk_create_extent(ext_filename, size,
2650                             flat, compress, zeroed_grain, &blk, data->opts,
2651                             errp)) {
2652          goto exit;
2653      }
2654      bdrv_unref(bs);
2655  exit:
2656      g_free(ext_filename);
2657      return blk;
2658  }
2659  
2660  static int coroutine_fn vmdk_co_create_opts(BlockDriver *drv,
2661                                              const char *filename,
2662                                              QemuOpts *opts,
2663                                              Error **errp)
2664  {
2665      Error *local_err = NULL;
2666      char *desc = NULL;
2667      int64_t total_size = 0;
2668      char *adapter_type = NULL;
2669      BlockdevVmdkAdapterType adapter_type_enum;
2670      char *backing_file = NULL;
2671      char *hw_version = NULL;
2672      char *toolsversion = NULL;
2673      char *fmt = NULL;
2674      BlockdevVmdkSubformat subformat;
2675      int ret = 0;
2676      char *path = g_malloc0(PATH_MAX);
2677      char *prefix = g_malloc0(PATH_MAX);
2678      char *postfix = g_malloc0(PATH_MAX);
2679      char *desc_line = g_malloc0(BUF_SIZE);
2680      char *ext_filename = g_malloc0(PATH_MAX);
2681      char *desc_filename = g_malloc0(PATH_MAX);
2682      char *parent_desc_line = g_malloc0(BUF_SIZE);
2683      bool zeroed_grain;
2684      bool compat6;
2685      VMDKCreateOptsData data;
2686      char *backing_fmt = NULL;
2687  
2688      backing_fmt = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FMT);
2689      if (backing_fmt && strcmp(backing_fmt, "vmdk") != 0) {
2690          error_setg(errp, "backing_file must be a vmdk image");
2691          ret = -EINVAL;
2692          goto exit;
2693      }
2694  
2695      if (filename_decompose(filename, path, prefix, postfix, PATH_MAX, errp)) {
2696          ret = -EINVAL;
2697          goto exit;
2698      }
2699      /* Read out options */
2700      total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2701                            BDRV_SECTOR_SIZE);
2702      adapter_type = qemu_opt_get_del(opts, BLOCK_OPT_ADAPTER_TYPE);
2703      backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
2704      hw_version = qemu_opt_get_del(opts, BLOCK_OPT_HWVERSION);
2705      toolsversion = qemu_opt_get_del(opts, BLOCK_OPT_TOOLSVERSION);
2706      compat6 = qemu_opt_get_bool_del(opts, BLOCK_OPT_COMPAT6, false);
2707      if (strcmp(hw_version, "undefined") == 0) {
2708          g_free(hw_version);
2709          hw_version = NULL;
2710      }
2711      fmt = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
2712      zeroed_grain = qemu_opt_get_bool_del(opts, BLOCK_OPT_ZEROED_GRAIN, false);
2713  
2714      if (adapter_type) {
2715          adapter_type_enum = qapi_enum_parse(&BlockdevVmdkAdapterType_lookup,
2716                                              adapter_type,
2717                                              BLOCKDEV_VMDK_ADAPTER_TYPE_IDE,
2718                                              &local_err);
2719          if (local_err) {
2720              error_propagate(errp, local_err);
2721              ret = -EINVAL;
2722              goto exit;
2723          }
2724      } else {
2725          adapter_type_enum = BLOCKDEV_VMDK_ADAPTER_TYPE_IDE;
2726      }
2727  
2728      if (!fmt) {
2729          /* Default format to monolithicSparse */
2730          subformat = BLOCKDEV_VMDK_SUBFORMAT_MONOLITHICSPARSE;
2731      } else {
2732          subformat = qapi_enum_parse(&BlockdevVmdkSubformat_lookup,
2733                                      fmt,
2734                                      BLOCKDEV_VMDK_SUBFORMAT_MONOLITHICSPARSE,
2735                                      &local_err);
2736          if (local_err) {
2737              error_propagate(errp, local_err);
2738              ret = -EINVAL;
2739              goto exit;
2740          }
2741      }
2742      data = (VMDKCreateOptsData){
2743          .prefix = prefix,
2744          .postfix = postfix,
2745          .path = path,
2746          .opts = opts,
2747      };
2748      ret = vmdk_co_do_create(total_size, subformat, adapter_type_enum,
2749                              backing_file, hw_version, toolsversion, compat6,
2750                              zeroed_grain, vmdk_co_create_opts_cb, &data, errp);
2751  
2752  exit:
2753      g_free(backing_fmt);
2754      g_free(adapter_type);
2755      g_free(backing_file);
2756      g_free(hw_version);
2757      g_free(toolsversion);
2758      g_free(fmt);
2759      g_free(desc);
2760      g_free(path);
2761      g_free(prefix);
2762      g_free(postfix);
2763      g_free(desc_line);
2764      g_free(ext_filename);
2765      g_free(desc_filename);
2766      g_free(parent_desc_line);
2767      return ret;
2768  }
2769  
2770  static BlockBackend *vmdk_co_create_cb(int64_t size, int idx,
2771                                         bool flat, bool split, bool compress,
2772                                         bool zeroed_grain, void *opaque,
2773                                         Error **errp)
2774  {
2775      int ret;
2776      BlockDriverState *bs;
2777      BlockBackend *blk;
2778      BlockdevCreateOptionsVmdk *opts = opaque;
2779  
2780      if (idx == 0) {
2781          bs = bdrv_open_blockdev_ref(opts->file, errp);
2782      } else {
2783          int i;
2784          BlockdevRefList *list = opts->extents;
2785          for (i = 1; i < idx; i++) {
2786              if (!list || !list->next) {
2787                  error_setg(errp, "Extent [%d] not specified", i);
2788                  return NULL;
2789              }
2790              list = list->next;
2791          }
2792          if (!list) {
2793              error_setg(errp, "Extent [%d] not specified", idx - 1);
2794              return NULL;
2795          }
2796          bs = bdrv_open_blockdev_ref(list->value, errp);
2797      }
2798      if (!bs) {
2799          return NULL;
2800      }
2801      blk = blk_new_with_bs(bs,
2802                            BLK_PERM_CONSISTENT_READ | BLK_PERM_WRITE | BLK_PERM_RESIZE,
2803                            BLK_PERM_ALL, errp);
2804      if (!blk) {
2805          return NULL;
2806      }
2807      blk_set_allow_write_beyond_eof(blk, true);
2808      bdrv_unref(bs);
2809  
2810      if (size != -1) {
2811          ret = vmdk_init_extent(blk, size, flat, compress, zeroed_grain, errp);
2812          if (ret) {
2813              blk_unref(blk);
2814              blk = NULL;
2815          }
2816      }
2817      return blk;
2818  }
2819  
2820  static int coroutine_fn vmdk_co_create(BlockdevCreateOptions *create_options,
2821                                         Error **errp)
2822  {
2823      int ret;
2824      BlockdevCreateOptionsVmdk *opts;
2825  
2826      opts = &create_options->u.vmdk;
2827  
2828      /* Validate options */
2829      if (!QEMU_IS_ALIGNED(opts->size, BDRV_SECTOR_SIZE)) {
2830          error_setg(errp, "Image size must be a multiple of 512 bytes");
2831          ret = -EINVAL;
2832          goto out;
2833      }
2834  
2835      ret = vmdk_co_do_create(opts->size,
2836                              opts->subformat,
2837                              opts->adapter_type,
2838                              opts->backing_file,
2839                              opts->hwversion,
2840                              opts->toolsversion,
2841                              false,
2842                              opts->zeroed_grain,
2843                              vmdk_co_create_cb,
2844                              opts, errp);
2845      return ret;
2846  
2847  out:
2848      return ret;
2849  }
2850  
2851  static void vmdk_close(BlockDriverState *bs)
2852  {
2853      BDRVVmdkState *s = bs->opaque;
2854  
2855      vmdk_free_extents(bs);
2856      g_free(s->create_type);
2857  
2858      migrate_del_blocker(s->migration_blocker);
2859      error_free(s->migration_blocker);
2860  }
2861  
2862  static int64_t vmdk_get_allocated_file_size(BlockDriverState *bs)
2863  {
2864      int i;
2865      int64_t ret = 0;
2866      int64_t r;
2867      BDRVVmdkState *s = bs->opaque;
2868  
2869      ret = bdrv_get_allocated_file_size(bs->file->bs);
2870      if (ret < 0) {
2871          return ret;
2872      }
2873      for (i = 0; i < s->num_extents; i++) {
2874          if (s->extents[i].file == bs->file) {
2875              continue;
2876          }
2877          r = bdrv_get_allocated_file_size(s->extents[i].file->bs);
2878          if (r < 0) {
2879              return r;
2880          }
2881          ret += r;
2882      }
2883      return ret;
2884  }
2885  
2886  static int vmdk_has_zero_init(BlockDriverState *bs)
2887  {
2888      int i;
2889      BDRVVmdkState *s = bs->opaque;
2890  
2891      /* If has a flat extent and its underlying storage doesn't have zero init,
2892       * return 0. */
2893      for (i = 0; i < s->num_extents; i++) {
2894          if (s->extents[i].flat) {
2895              if (!bdrv_has_zero_init(s->extents[i].file->bs)) {
2896                  return 0;
2897              }
2898          }
2899      }
2900      return 1;
2901  }
2902  
2903  static ImageInfo *vmdk_get_extent_info(VmdkExtent *extent)
2904  {
2905      ImageInfo *info = g_new0(ImageInfo, 1);
2906  
2907      bdrv_refresh_filename(extent->file->bs);
2908      *info = (ImageInfo){
2909          .filename         = g_strdup(extent->file->bs->filename),
2910          .format           = g_strdup(extent->type),
2911          .virtual_size     = extent->sectors * BDRV_SECTOR_SIZE,
2912          .compressed       = extent->compressed,
2913          .has_compressed   = extent->compressed,
2914          .cluster_size     = extent->cluster_sectors * BDRV_SECTOR_SIZE,
2915          .has_cluster_size = !extent->flat,
2916      };
2917  
2918      return info;
2919  }
2920  
2921  static int coroutine_fn vmdk_co_check(BlockDriverState *bs,
2922                                        BdrvCheckResult *result,
2923                                        BdrvCheckMode fix)
2924  {
2925      BDRVVmdkState *s = bs->opaque;
2926      VmdkExtent *extent = NULL;
2927      int64_t sector_num = 0;
2928      int64_t total_sectors = bdrv_nb_sectors(bs);
2929      int ret;
2930      uint64_t cluster_offset;
2931  
2932      if (fix) {
2933          return -ENOTSUP;
2934      }
2935  
2936      for (;;) {
2937          if (sector_num >= total_sectors) {
2938              return 0;
2939          }
2940          extent = find_extent(s, sector_num, extent);
2941          if (!extent) {
2942              fprintf(stderr,
2943                      "ERROR: could not find extent for sector %" PRId64 "\n",
2944                      sector_num);
2945              ret = -EINVAL;
2946              break;
2947          }
2948          ret = get_cluster_offset(bs, extent, NULL,
2949                                   sector_num << BDRV_SECTOR_BITS,
2950                                   false, &cluster_offset, 0, 0);
2951          if (ret == VMDK_ERROR) {
2952              fprintf(stderr,
2953                      "ERROR: could not get cluster_offset for sector %"
2954                      PRId64 "\n", sector_num);
2955              break;
2956          }
2957          if (ret == VMDK_OK) {
2958              int64_t extent_len = bdrv_getlength(extent->file->bs);
2959              if (extent_len < 0) {
2960                  fprintf(stderr,
2961                          "ERROR: could not get extent file length for sector %"
2962                          PRId64 "\n", sector_num);
2963                  ret = extent_len;
2964                  break;
2965              }
2966              if (cluster_offset >= extent_len) {
2967                  fprintf(stderr,
2968                          "ERROR: cluster offset for sector %"
2969                          PRId64 " points after EOF\n", sector_num);
2970                  ret = -EINVAL;
2971                  break;
2972              }
2973          }
2974          sector_num += extent->cluster_sectors;
2975      }
2976  
2977      result->corruptions++;
2978      return ret;
2979  }
2980  
2981  static ImageInfoSpecific *vmdk_get_specific_info(BlockDriverState *bs,
2982                                                   Error **errp)
2983  {
2984      int i;
2985      BDRVVmdkState *s = bs->opaque;
2986      ImageInfoSpecific *spec_info = g_new0(ImageInfoSpecific, 1);
2987      ImageInfoList **tail;
2988  
2989      *spec_info = (ImageInfoSpecific){
2990          .type = IMAGE_INFO_SPECIFIC_KIND_VMDK,
2991          .u = {
2992              .vmdk.data = g_new0(ImageInfoSpecificVmdk, 1),
2993          },
2994      };
2995  
2996      *spec_info->u.vmdk.data = (ImageInfoSpecificVmdk) {
2997          .create_type = g_strdup(s->create_type),
2998          .cid = s->cid,
2999          .parent_cid = s->parent_cid,
3000      };
3001  
3002      tail = &spec_info->u.vmdk.data->extents;
3003      for (i = 0; i < s->num_extents; i++) {
3004          QAPI_LIST_APPEND(tail, vmdk_get_extent_info(&s->extents[i]));
3005      }
3006  
3007      return spec_info;
3008  }
3009  
3010  static bool vmdk_extents_type_eq(const VmdkExtent *a, const VmdkExtent *b)
3011  {
3012      return a->flat == b->flat &&
3013             a->compressed == b->compressed &&
3014             (a->flat || a->cluster_sectors == b->cluster_sectors);
3015  }
3016  
3017  static int vmdk_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
3018  {
3019      int i;
3020      BDRVVmdkState *s = bs->opaque;
3021      assert(s->num_extents);
3022  
3023      /* See if we have multiple extents but they have different cases */
3024      for (i = 1; i < s->num_extents; i++) {
3025          if (!vmdk_extents_type_eq(&s->extents[0], &s->extents[i])) {
3026              return -ENOTSUP;
3027          }
3028      }
3029      bdi->needs_compressed_writes = s->extents[0].compressed;
3030      if (!s->extents[0].flat) {
3031          bdi->cluster_size = s->extents[0].cluster_sectors << BDRV_SECTOR_BITS;
3032      }
3033      return 0;
3034  }
3035  
3036  static void vmdk_gather_child_options(BlockDriverState *bs, QDict *target,
3037                                        bool backing_overridden)
3038  {
3039      /* No children but file and backing can be explicitly specified (TODO) */
3040      qdict_put(target, "file",
3041                qobject_ref(bs->file->bs->full_open_options));
3042  
3043      if (backing_overridden) {
3044          if (bs->backing) {
3045              qdict_put(target, "backing",
3046                        qobject_ref(bs->backing->bs->full_open_options));
3047          } else {
3048              qdict_put_null(target, "backing");
3049          }
3050      }
3051  }
3052  
3053  static QemuOptsList vmdk_create_opts = {
3054      .name = "vmdk-create-opts",
3055      .head = QTAILQ_HEAD_INITIALIZER(vmdk_create_opts.head),
3056      .desc = {
3057          {
3058              .name = BLOCK_OPT_SIZE,
3059              .type = QEMU_OPT_SIZE,
3060              .help = "Virtual disk size"
3061          },
3062          {
3063              .name = BLOCK_OPT_ADAPTER_TYPE,
3064              .type = QEMU_OPT_STRING,
3065              .help = "Virtual adapter type, can be one of "
3066                      "ide (default), lsilogic, buslogic or legacyESX"
3067          },
3068          {
3069              .name = BLOCK_OPT_BACKING_FILE,
3070              .type = QEMU_OPT_STRING,
3071              .help = "File name of a base image"
3072          },
3073          {
3074              .name = BLOCK_OPT_BACKING_FMT,
3075              .type = QEMU_OPT_STRING,
3076              .help = "Must be 'vmdk' if present",
3077          },
3078          {
3079              .name = BLOCK_OPT_COMPAT6,
3080              .type = QEMU_OPT_BOOL,
3081              .help = "VMDK version 6 image",
3082              .def_value_str = "off"
3083          },
3084          {
3085              .name = BLOCK_OPT_HWVERSION,
3086              .type = QEMU_OPT_STRING,
3087              .help = "VMDK hardware version",
3088              .def_value_str = "undefined"
3089          },
3090          {
3091              .name = BLOCK_OPT_TOOLSVERSION,
3092              .type = QEMU_OPT_STRING,
3093              .help = "VMware guest tools version",
3094          },
3095          {
3096              .name = BLOCK_OPT_SUBFMT,
3097              .type = QEMU_OPT_STRING,
3098              .help =
3099                  "VMDK flat extent format, can be one of "
3100                  "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} "
3101          },
3102          {
3103              .name = BLOCK_OPT_ZEROED_GRAIN,
3104              .type = QEMU_OPT_BOOL,
3105              .help = "Enable efficient zero writes "
3106                      "using the zeroed-grain GTE feature"
3107          },
3108          { /* end of list */ }
3109      }
3110  };
3111  
3112  static BlockDriver bdrv_vmdk = {
3113      .format_name                  = "vmdk",
3114      .instance_size                = sizeof(BDRVVmdkState),
3115      .bdrv_probe                   = vmdk_probe,
3116      .bdrv_open                    = vmdk_open,
3117      .bdrv_co_check                = vmdk_co_check,
3118      .bdrv_reopen_prepare          = vmdk_reopen_prepare,
3119      .bdrv_reopen_commit           = vmdk_reopen_commit,
3120      .bdrv_reopen_abort            = vmdk_reopen_abort,
3121      .bdrv_child_perm              = bdrv_default_perms,
3122      .bdrv_co_preadv               = vmdk_co_preadv,
3123      .bdrv_co_pwritev              = vmdk_co_pwritev,
3124      .bdrv_co_pwritev_compressed   = vmdk_co_pwritev_compressed,
3125      .bdrv_co_pwrite_zeroes        = vmdk_co_pwrite_zeroes,
3126      .bdrv_close                   = vmdk_close,
3127      .bdrv_co_create_opts          = vmdk_co_create_opts,
3128      .bdrv_co_create               = vmdk_co_create,
3129      .bdrv_co_block_status         = vmdk_co_block_status,
3130      .bdrv_get_allocated_file_size = vmdk_get_allocated_file_size,
3131      .bdrv_has_zero_init           = vmdk_has_zero_init,
3132      .bdrv_get_specific_info       = vmdk_get_specific_info,
3133      .bdrv_refresh_limits          = vmdk_refresh_limits,
3134      .bdrv_get_info                = vmdk_get_info,
3135      .bdrv_gather_child_options    = vmdk_gather_child_options,
3136  
3137      .is_format                    = true,
3138      .supports_backing             = true,
3139      .create_opts                  = &vmdk_create_opts,
3140  };
3141  
3142  static void bdrv_vmdk_init(void)
3143  {
3144      bdrv_register(&bdrv_vmdk);
3145  }
3146  
3147  block_init(bdrv_vmdk_init);
3148