block.c

   1 /*
   2  * QEMU System Emulator block driver
   3  *
   4  * Copyright (c) 2003 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #include "vl.h"
  25 #include "block_int.h"
  26
  27 #ifdef _BSD
  28 #include <sys/types.h>
  29 #include <sys/stat.h>
  30 #include <sys/ioctl.h>
  31 #include <sys/queue.h>
  32 #include <sys/disk.h>
  33 #endif
  34
  35 #define SECTOR_BITS 9
  36 #define SECTOR_SIZE (1 << SECTOR_BITS)
  37
  38 #ifndef ENOMEDIUM
  39 #define ENOMEDIUM ENODEV
  40 #endif
  41
  42 typedef struct BlockDriverAIOCBSync {
  43     BlockDriverAIOCB common;
  44     QEMUBH *bh;
  45     int ret;
  46 } BlockDriverAIOCBSync;
  47
  48 static BlockDriverAIOCB *bdrv_aio_read_em(BlockDriverState *bs,
  49         int64_t sector_num, uint8_t *buf, int nb_sectors,
  50         BlockDriverCompletionFunc *cb, void *opaque);
  51 static BlockDriverAIOCB *bdrv_aio_write_em(BlockDriverState *bs,
  52         int64_t sector_num, const uint8_t *buf, int nb_sectors,
  53         BlockDriverCompletionFunc *cb, void *opaque);
  54 static void bdrv_aio_cancel_em(BlockDriverAIOCB *acb);
  55 static int bdrv_read_em(BlockDriverState *bs, int64_t sector_num,
  56                         uint8_t *buf, int nb_sectors);
  57 static int bdrv_write_em(BlockDriverState *bs, int64_t sector_num,
  58                          const uint8_t *buf, int nb_sectors);
  59
  60 static BlockDriverState *bdrv_first;
  61 static BlockDriver *first_drv;
  62
  63 int path_is_absolute(const char *path)
  64 {
  65     const char *p;
  66 #ifdef _WIN32
  67     /* specific case for names like: "\\.\d:" */
  68     if (*path == '/' || *path == '\\')
  69         return 1;
  70 #endif
  71     p = strchr(path, ':');
  72     if (p)
  73         p++;
  74     else
  75         p = path;
  76 #ifdef _WIN32
  77     return (*p == '/' || *p == '\\');
  78 #else
  79     return (*p == '/');
  80 #endif
  81 }
  82
  83 /* if filename is absolute, just copy it to dest. Otherwise, build a
  84    path to it by considering it is relative to base_path. URL are
  85    supported. */
  86 void path_combine(char *dest, int dest_size,
  87                   const char *base_path,
  88                   const char *filename)
  89 {
  90     const char *p, *p1;
  91     int len;
  92
  93     if (dest_size <= 0)
  94         return;
  95     if (path_is_absolute(filename)) {
  96         pstrcpy(dest, dest_size, filename);
  97     } else {
  98         p = strchr(base_path, ':');
  99         if (p)
 100             p++;
 101         else
 102             p = base_path;
 103         p1 = strrchr(base_path, '/');
 104 #ifdef _WIN32
 105         {
 106             const char *p2;
 107             p2 = strrchr(base_path, '\\');
 108             if (!p1 || p2 > p1)
 109                 p1 = p2;
 110         }
 111 #endif
 112         if (p1)
 113             p1++;
 114         else
 115             p1 = base_path;
 116         if (p1 > p)
 117             p = p1;
 118         len = p - base_path;
 119         if (len > dest_size - 1)
 120             len = dest_size - 1;
 121         memcpy(dest, base_path, len);
 122         dest[len] = '\0';
 123         pstrcat(dest, dest_size, filename);
 124     }
 125 }
 126
 127
 128 void bdrv_register(BlockDriver *bdrv)
 129 {
 130     if (!bdrv->bdrv_aio_read) {
 131         /* add AIO emulation layer */
 132         bdrv->bdrv_aio_read = bdrv_aio_read_em;
 133         bdrv->bdrv_aio_write = bdrv_aio_write_em;
 134         bdrv->bdrv_aio_cancel = bdrv_aio_cancel_em;
 135         bdrv->aiocb_size = sizeof(BlockDriverAIOCBSync);
 136     } else if (!bdrv->bdrv_read && !bdrv->bdrv_pread) {
 137         /* add synchronous IO emulation layer */
 138         bdrv->bdrv_read = bdrv_read_em;
 139         bdrv->bdrv_write = bdrv_write_em;
 140     }
 141     bdrv->next = first_drv;
 142     first_drv = bdrv;
 143 }
 144
 145 /* create a new block device (by default it is empty) */
 146 BlockDriverState *bdrv_new(const char *device_name)
 147 {
 148     BlockDriverState **pbs, *bs;
 149
 150     bs = qemu_mallocz(sizeof(BlockDriverState));
 151     if(!bs)
 152         return NULL;
 153     pstrcpy(bs->device_name, sizeof(bs->device_name), device_name);
 154     if (device_name[0] != '\0') {
 155         /* insert at the end */
 156         pbs = &bdrv_first;
 157         while (*pbs != NULL)
 158             pbs = &(*pbs)->next;
 159         *pbs = bs;
 160     }
 161     return bs;
 162 }
 163
 164 BlockDriver *bdrv_find_format(const char *format_name)
 165 {
 166     BlockDriver *drv1;
 167     for(drv1 = first_drv; drv1 != NULL; drv1 = drv1->next) {
 168         if (!strcmp(drv1->format_name, format_name))
 169             return drv1;
 170     }
 171     return NULL;
 172 }
 173
 174 int bdrv_create(BlockDriver *drv,
 175                 const char *filename, int64_t size_in_sectors,
 176                 const char *backing_file, int flags)
 177 {
 178     if (!drv->bdrv_create)
 179         return -ENOTSUP;
 180     return drv->bdrv_create(filename, size_in_sectors, backing_file, flags);
 181 }
 182
 183 #ifdef _WIN32
 184 void get_tmp_filename(char *filename, int size)
 185 {
 186     char temp_dir[MAX_PATH];
 187
 188     GetTempPath(MAX_PATH, temp_dir);
 189     GetTempFileName(temp_dir, "qem", 0, filename);
 190 }
 191 #else
 192 void get_tmp_filename(char *filename, int size)
 193 {
 194     int fd;
 195     /* XXX: race condition possible */
 196     pstrcpy(filename, size, "/tmp/vl.XXXXXX");
 197     fd = mkstemp(filename);
 198     close(fd);
 199 }
 200 #endif
 201
 202 #ifdef _WIN32
 203 static int is_windows_drive_prefix(const char *filename)
 204 {
 205     return (((filename[0] >= 'a' && filename[0] <= 'z') ||
 206              (filename[0] >= 'A' && filename[0] <= 'Z')) &&
 207             filename[1] == ':');
 208 }
 209
 210 static int is_windows_drive(const char *filename)
 211 {
 212     if (is_windows_drive_prefix(filename) &&
 213         filename[2] == '\0')
 214         return 1;
 215     if (strstart(filename, "\\\\.\\", NULL) ||
 216         strstart(filename, "//./", NULL))
 217         return 1;
 218     return 0;
 219 }
 220 #endif
 221
 222 static BlockDriver *find_protocol(const char *filename)
 223 {
 224     BlockDriver *drv1;
 225     char protocol[128];
 226     int len;
 227     const char *p;
 228
 229 #ifdef _WIN32
 230     if (is_windows_drive(filename) ||
 231         is_windows_drive_prefix(filename))
 232         return &bdrv_raw;
 233 #endif
 234     p = strchr(filename, ':');
 235     if (!p)
 236         return &bdrv_raw;
 237     len = p - filename;
 238     if (len > sizeof(protocol) - 1)
 239         len = sizeof(protocol) - 1;
 240     memcpy(protocol, filename, len);
 241     protocol[len] = '\0';
 242     for(drv1 = first_drv; drv1 != NULL; drv1 = drv1->next) {
 243         if (drv1->protocol_name &&
 244             !strcmp(drv1->protocol_name, protocol))
 245             return drv1;
 246     }
 247     return NULL;
 248 }
 249
 250 /* XXX: force raw format if block or character device ? It would
 251    simplify the BSD case */
 252 static BlockDriver *find_image_format(const char *filename)
 253 {
 254     int ret, score, score_max;
 255     BlockDriver *drv1, *drv;
 256     uint8_t buf[2048];
 257     BlockDriverState *bs;
 258
 259     /* detect host devices. By convention, /dev/cdrom[N] is always
 260        recognized as a host CDROM */
 261     if (strstart(filename, "/dev/cdrom", NULL))
 262         return &bdrv_host_device;
 263 #ifdef _WIN32
 264     if (is_windows_drive(filename))
 265         return &bdrv_host_device;
 266 #else
 267     {
 268         struct stat st;
 269         if (stat(filename, &st) >= 0 &&
 270             (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
 271             return &bdrv_host_device;
 272         }
 273     }
 274 #endif
 275
 276     drv = find_protocol(filename);
 277     /* no need to test disk image formats for vvfat */
 278     if (drv == &bdrv_vvfat)
 279         return drv;
 280
 281     ret = bdrv_file_open(&bs, filename, BDRV_O_RDONLY);
 282     if (ret < 0)
 283         return NULL;
 284     ret = bdrv_pread(bs, 0, buf, sizeof(buf));
 285     bdrv_delete(bs);
 286     if (ret < 0) {
 287         return NULL;
 288     }
 289
 290     score_max = 0;
 291     for(drv1 = first_drv; drv1 != NULL; drv1 = drv1->next) {
 292         if (drv1->bdrv_probe) {
 293             score = drv1->bdrv_probe(buf, ret, filename);
 294             if (score > score_max) {
 295                 score_max = score;
 296                 drv = drv1;
 297             }
 298         }
 299     }
 300     return drv;
 301 }
 302
 303 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags)
 304 {
 305     BlockDriverState *bs;
 306     int ret;
 307
 308     bs = bdrv_new("");
 309     if (!bs)
 310         return -ENOMEM;
 311     ret = bdrv_open2(bs, filename, flags | BDRV_O_FILE, NULL);
 312     if (ret < 0) {
 313         bdrv_delete(bs);
 314         return ret;
 315     }
 316     *pbs = bs;
 317     return 0;
 318 }
 319
 320 int bdrv_open(BlockDriverState *bs, const char *filename, int flags)
 321 {
 322     return bdrv_open2(bs, filename, flags, NULL);
 323 }
 324
 325 int bdrv_open2(BlockDriverState *bs, const char *filename, int flags,
 326                BlockDriver *drv)
 327 {
 328     int ret, open_flags;
 329     char tmp_filename[1024];
 330     char backing_filename[1024];
 331
 332     bs->read_only = 0;
 333     bs->is_temporary = 0;
 334     bs->encrypted = 0;
 335
 336     if (flags & BDRV_O_SNAPSHOT) {
 337         BlockDriverState *bs1;
 338         int64_t total_size;
 339
 340         /* if snapshot, we create a temporary backing file and open it
 341            instead of opening 'filename' directly */
 342
 343         /* if there is a backing file, use it */
 344         bs1 = bdrv_new("");
 345         if (!bs1) {
 346             return -ENOMEM;
 347         }
 348         if (bdrv_open(bs1, filename, 0) < 0) {
 349             bdrv_delete(bs1);
 350             return -1;
 351         }
 352         total_size = bdrv_getlength(bs1) >> SECTOR_BITS;
 353         bdrv_delete(bs1);
 354
 355         get_tmp_filename(tmp_filename, sizeof(tmp_filename));
 356         realpath(filename, backing_filename);
 357         if (bdrv_create(&bdrv_qcow2, tmp_filename,
 358                         total_size, backing_filename, 0) < 0) {
 359             return -1;
 360         }
 361         filename = tmp_filename;
 362         bs->is_temporary = 1;
 363     }
 364
 365     pstrcpy(bs->filename, sizeof(bs->filename), filename);
 366     if (flags & BDRV_O_FILE) {
 367         drv = find_protocol(filename);
 368         if (!drv)
 369             return -ENOENT;
 370     } else {
 371         if (!drv) {
 372             drv = find_image_format(filename);
 373             if (!drv)
 374                 return -1;
 375         }
 376     }
 377     bs->drv = drv;
 378     bs->opaque = qemu_mallocz(drv->instance_size);
 379     if (bs->opaque == NULL && drv->instance_size > 0)
 380         return -1;
 381     /* Note: for compatibility, we open disk image files as RDWR, and
 382        RDONLY as fallback */
 383     if (!(flags & BDRV_O_FILE))
 384         open_flags = BDRV_O_RDWR;
 385     else
 386         open_flags = flags & ~(BDRV_O_FILE | BDRV_O_SNAPSHOT);
 387     ret = drv->bdrv_open(bs, filename, open_flags);
 388     if (ret == -EACCES && !(flags & BDRV_O_FILE)) {
 389         ret = drv->bdrv_open(bs, filename, BDRV_O_RDONLY);
 390         bs->read_only = 1;
 391     }
 392     if (ret < 0) {
 393         qemu_free(bs->opaque);
 394         bs->opaque = NULL;
 395         bs->drv = NULL;
 396         return ret;
 397     }
 398     if (drv->bdrv_getlength) {
 399         bs->total_sectors = bdrv_getlength(bs) >> SECTOR_BITS;
 400     }
 401 #ifndef _WIN32
 402     if (bs->is_temporary) {
 403         unlink(filename);
 404     }
 405 #endif
 406     if (bs->backing_file[0] != '\0') {
 407         /* if there is a backing file, use it */
 408         bs->backing_hd = bdrv_new("");
 409         if (!bs->backing_hd) {
 410         fail:
 411             bdrv_close(bs);
 412             return -ENOMEM;
 413         }
 414         path_combine(backing_filename, sizeof(backing_filename),
 415                      filename, bs->backing_file);
 416         if (bdrv_open(bs->backing_hd, backing_filename, 0) < 0)
 417             goto fail;
 418     }
 419
 420     /* call the change callback */
 421     bs->media_changed = 1;
 422     if (bs->change_cb)
 423         bs->change_cb(bs->change_opaque);
 424
 425     return 0;
 426 }
 427
 428 void bdrv_close(BlockDriverState *bs)
 429 {
 430     if (bs->drv) {
 431         if (bs->backing_hd)
 432             bdrv_delete(bs->backing_hd);
 433         bs->drv->bdrv_close(bs);
 434         qemu_free(bs->opaque);
 435 #ifdef _WIN32
 436         if (bs->is_temporary) {
 437             unlink(bs->filename);
 438         }
 439 #endif
 440         bs->opaque = NULL;
 441         bs->drv = NULL;
 442
 443         /* call the change callback */
 444         bs->media_changed = 1;
 445         if (bs->change_cb)
 446             bs->change_cb(bs->change_opaque);
 447     }
 448 }
 449
 450 void bdrv_delete(BlockDriverState *bs)
 451 {
 452     /* XXX: remove the driver list */
 453     bdrv_close(bs);
 454     qemu_free(bs);
 455 }
 456
 457 /* commit COW file into the raw image */
 458 int bdrv_commit(BlockDriverState *bs)
 459 {
 460     BlockDriver *drv = bs->drv;
 461     int64_t i, total_sectors;
 462     int n, j;
 463     unsigned char sector[512];
 464
 465     if (!drv)
 466         return -ENOMEDIUM;
 467
 468     if (bs->read_only) {
 469         return -EACCES;
 470     }
 471
 472     if (!bs->backing_hd) {
 473         return -ENOTSUP;
 474     }
 475
 476     total_sectors = bdrv_getlength(bs) >> SECTOR_BITS;
 477     for (i = 0; i < total_sectors;) {
 478         if (drv->bdrv_is_allocated(bs, i, 65536, &n)) {
 479             for(j = 0; j < n; j++) {
 480                 if (bdrv_read(bs, i, sector, 1) != 0) {
 481                     return -EIO;
 482                 }
 483
 484                 if (bdrv_write(bs->backing_hd, i, sector, 1) != 0) {
 485                     return -EIO;
 486                 }
 487                 i++;
 488             }
 489         } else {
 490             i += n;
 491         }
 492     }
 493
 494     if (drv->bdrv_make_empty)
 495         return drv->bdrv_make_empty(bs);
 496
 497     return 0;
 498 }
 499
 500 /* return < 0 if error. See bdrv_write() for the return codes */
 501 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
 502               uint8_t *buf, int nb_sectors)
 503 {
 504     BlockDriver *drv = bs->drv;
 505
 506     if (!drv)
 507         return -ENOMEDIUM;
 508
 509     if (sector_num == 0 && bs->boot_sector_enabled && nb_sectors > 0) {
 510             memcpy(buf, bs->boot_sector_data, 512);
 511         sector_num++;
 512         nb_sectors--;
 513         buf += 512;
 514         if (nb_sectors == 0)
 515             return 0;
 516     }
 517     if (drv->bdrv_pread) {
 518         int ret, len;
 519         len = nb_sectors * 512;
 520         ret = drv->bdrv_pread(bs, sector_num * 512, buf, len);
 521         if (ret < 0)
 522             return ret;
 523         else if (ret != len)
 524             return -EINVAL;
 525         else
 526             return 0;
 527     } else {
 528         return drv->bdrv_read(bs, sector_num, buf, nb_sectors);
 529     }
 530 }
 531
 532 /* Return < 0 if error. Important errors are:
 533   -EIO         generic I/O error (may happen for all errors)
 534   -ENOMEDIUM   No media inserted.
 535   -EINVAL      Invalid sector number or nb_sectors
 536   -EACCES      Trying to write a read-only device
 537 */
 538 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
 539                const uint8_t *buf, int nb_sectors)
 540 {
 541     BlockDriver *drv = bs->drv;
 542     if (!bs->drv)
 543         return -ENOMEDIUM;
 544     if (bs->read_only)
 545         return -EACCES;
 546     if (sector_num == 0 && bs->boot_sector_enabled && nb_sectors > 0) {
 547         memcpy(bs->boot_sector_data, buf, 512);
 548     }
 549     if (drv->bdrv_pwrite) {
 550         int ret, len;
 551         len = nb_sectors * 512;
 552         ret = drv->bdrv_pwrite(bs, sector_num * 512, buf, len);
 553         if (ret < 0)
 554             return ret;
 555         else if (ret != len)
 556             return -EIO;
 557         else
 558             return 0;
 559     } else {
 560         return drv->bdrv_write(bs, sector_num, buf, nb_sectors);
 561     }
 562 }
 563
 564 static int bdrv_pread_em(BlockDriverState *bs, int64_t offset,
 565                          uint8_t *buf, int count1)
 566 {
 567     uint8_t tmp_buf[SECTOR_SIZE];
 568     int len, nb_sectors, count;
 569     int64_t sector_num;
 570
 571     count = count1;
 572     /* first read to align to sector start */
 573     len = (SECTOR_SIZE - offset) & (SECTOR_SIZE - 1);
 574     if (len > count)
 575         len = count;
 576     sector_num = offset >> SECTOR_BITS;
 577     if (len > 0) {
 578         if (bdrv_read(bs, sector_num, tmp_buf, 1) < 0)
 579             return -EIO;
 580         memcpy(buf, tmp_buf + (offset & (SECTOR_SIZE - 1)), len);
 581         count -= len;
 582         if (count == 0)
 583             return count1;
 584         sector_num++;
 585         buf += len;
 586     }
 587
 588     /* read the sectors "in place" */
 589     nb_sectors = count >> SECTOR_BITS;
 590     if (nb_sectors > 0) {
 591         if (bdrv_read(bs, sector_num, buf, nb_sectors) < 0)
 592             return -EIO;
 593         sector_num += nb_sectors;
 594         len = nb_sectors << SECTOR_BITS;
 595         buf += len;
 596         count -= len;
 597     }
 598
 599     /* add data from the last sector */
 600     if (count > 0) {
 601         if (bdrv_read(bs, sector_num, tmp_buf, 1) < 0)
 602             return -EIO;
 603         memcpy(buf, tmp_buf, count);
 604     }
 605     return count1;
 606 }
 607
 608 static int bdrv_pwrite_em(BlockDriverState *bs, int64_t offset,
 609                           const uint8_t *buf, int count1)
 610 {
 611     uint8_t tmp_buf[SECTOR_SIZE];
 612     int len, nb_sectors, count;
 613     int64_t sector_num;
 614
 615     count = count1;
 616     /* first write to align to sector start */
 617     len = (SECTOR_SIZE - offset) & (SECTOR_SIZE - 1);
 618     if (len > count)
 619         len = count;
 620     sector_num = offset >> SECTOR_BITS;
 621     if (len > 0) {
 622         if (bdrv_read(bs, sector_num, tmp_buf, 1) < 0)
 623             return -EIO;
 624         memcpy(tmp_buf + (offset & (SECTOR_SIZE - 1)), buf, len);
 625         if (bdrv_write(bs, sector_num, tmp_buf, 1) < 0)
 626             return -EIO;
 627         count -= len;
 628         if (count == 0)
 629             return count1;
 630         sector_num++;
 631         buf += len;
 632     }
 633
 634     /* write the sectors "in place" */
 635     nb_sectors = count >> SECTOR_BITS;
 636     if (nb_sectors > 0) {
 637         if (bdrv_write(bs, sector_num, buf, nb_sectors) < 0)
 638             return -EIO;
 639         sector_num += nb_sectors;
 640         len = nb_sectors << SECTOR_BITS;
 641         buf += len;
 642         count -= len;
 643     }
 644
 645     /* add data from the last sector */
 646     if (count > 0) {
 647         if (bdrv_read(bs, sector_num, tmp_buf, 1) < 0)
 648             return -EIO;
 649         memcpy(tmp_buf, buf, count);
 650         if (bdrv_write(bs, sector_num, tmp_buf, 1) < 0)
 651             return -EIO;
 652     }
 653     return count1;
 654 }
 655
 656 /**
 657  * Read with byte offsets (needed only for file protocols)
 658  */
 659 int bdrv_pread(BlockDriverState *bs, int64_t offset,
 660                void *buf1, int count1)
 661 {
 662     BlockDriver *drv = bs->drv;
 663
 664     if (!drv)
 665         return -ENOMEDIUM;
 666     if (!drv->bdrv_pread)
 667         return bdrv_pread_em(bs, offset, buf1, count1);
 668     return drv->bdrv_pread(bs, offset, buf1, count1);
 669 }
 670
 671 /**
 672  * Write with byte offsets (needed only for file protocols)
 673  */
 674 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
 675                 const void *buf1, int count1)
 676 {
 677     BlockDriver *drv = bs->drv;
 678
 679     if (!drv)
 680         return -ENOMEDIUM;
 681     if (!drv->bdrv_pwrite)
 682         return bdrv_pwrite_em(bs, offset, buf1, count1);
 683     return drv->bdrv_pwrite(bs, offset, buf1, count1);
 684 }
 685
 686 /**
 687  * Truncate file to 'offset' bytes (needed only for file protocols)
 688  */
 689 int bdrv_truncate(BlockDriverState *bs, int64_t offset)
 690 {
 691     BlockDriver *drv = bs->drv;
 692     if (!drv)
 693         return -ENOMEDIUM;
 694     if (!drv->bdrv_truncate)
 695         return -ENOTSUP;
 696     return drv->bdrv_truncate(bs, offset);
 697 }
 698
 699 /**
 700  * Length of a file in bytes. Return < 0 if error or unknown.
 701  */
 702 int64_t bdrv_getlength(BlockDriverState *bs)
 703 {
 704     BlockDriver *drv = bs->drv;
 705     if (!drv)
 706         return -ENOMEDIUM;
 707     if (!drv->bdrv_getlength) {
 708         /* legacy mode */
 709         return bs->total_sectors * SECTOR_SIZE;
 710     }
 711     return drv->bdrv_getlength(bs);
 712 }
 713
 714 /* return 0 as number of sectors if no device present or error */
 715 void bdrv_get_geometry(BlockDriverState *bs, int64_t *nb_sectors_ptr)
 716 {
 717     int64_t length;
 718     length = bdrv_getlength(bs);
 719     if (length < 0)
 720         length = 0;
 721     else
 722         length = length >> SECTOR_BITS;
 723     *nb_sectors_ptr = length;
 724 }
 725
 726 /* force a given boot sector. */
 727 void bdrv_set_boot_sector(BlockDriverState *bs, const uint8_t *data, int size)
 728 {
 729     bs->boot_sector_enabled = 1;
 730     if (size > 512)
 731         size = 512;
 732     memcpy(bs->boot_sector_data, data, size);
 733     memset(bs->boot_sector_data + size, 0, 512 - size);
 734 }
 735
 736 void bdrv_set_geometry_hint(BlockDriverState *bs,
 737                             int cyls, int heads, int secs)
 738 {
 739     bs->cyls = cyls;
 740     bs->heads = heads;
 741     bs->secs = secs;
 742 }
 743
 744 void bdrv_set_type_hint(BlockDriverState *bs, int type)
 745 {
 746     bs->type = type;
 747     bs->removable = ((type == BDRV_TYPE_CDROM ||
 748                       type == BDRV_TYPE_FLOPPY));
 749 }
 750
 751 void bdrv_set_translation_hint(BlockDriverState *bs, int translation)
 752 {
 753     bs->translation = translation;
 754 }
 755
 756 void bdrv_get_geometry_hint(BlockDriverState *bs,
 757                             int *pcyls, int *pheads, int *psecs)
 758 {
 759     *pcyls = bs->cyls;
 760     *pheads = bs->heads;
 761     *psecs = bs->secs;
 762 }
 763
 764 int bdrv_get_type_hint(BlockDriverState *bs)
 765 {
 766     return bs->type;
 767 }
 768
 769 int bdrv_get_translation_hint(BlockDriverState *bs)
 770 {
 771     return bs->translation;
 772 }
 773
 774 int bdrv_is_removable(BlockDriverState *bs)
 775 {
 776     return bs->removable;
 777 }
 778
 779 int bdrv_is_read_only(BlockDriverState *bs)
 780 {
 781     return bs->read_only;
 782 }
 783
 784 /* XXX: no longer used */
 785 void bdrv_set_change_cb(BlockDriverState *bs,
 786                         void (*change_cb)(void *opaque), void *opaque)
 787 {
 788     bs->change_cb = change_cb;
 789     bs->change_opaque = opaque;
 790 }
 791
 792 int bdrv_is_encrypted(BlockDriverState *bs)
 793 {
 794     if (bs->backing_hd && bs->backing_hd->encrypted)
 795         return 1;
 796     return bs->encrypted;
 797 }
 798
 799 int bdrv_set_key(BlockDriverState *bs, const char *key)
 800 {
 801     int ret;
 802     if (bs->backing_hd && bs->backing_hd->encrypted) {
 803         ret = bdrv_set_key(bs->backing_hd, key);
 804         if (ret < 0)
 805             return ret;
 806         if (!bs->encrypted)
 807             return 0;
 808     }
 809     if (!bs->encrypted || !bs->drv || !bs->drv->bdrv_set_key)
 810         return -1;
 811     return bs->drv->bdrv_set_key(bs, key);
 812 }
 813
 814 void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size)
 815 {
 816     if (!bs->drv) {
 817         buf[0] = '\0';
 818     } else {
 819         pstrcpy(buf, buf_size, bs->drv->format_name);
 820     }
 821 }
 822
 823 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
 824                          void *opaque)
 825 {
 826     BlockDriver *drv;
 827
 828     for (drv = first_drv; drv != NULL; drv = drv->next) {
 829         it(opaque, drv->format_name);
 830     }
 831 }
 832
 833 BlockDriverState *bdrv_find(const char *name)
 834 {
 835     BlockDriverState *bs;
 836
 837     for (bs = bdrv_first; bs != NULL; bs = bs->next) {
 838         if (!strcmp(name, bs->device_name))
 839             return bs;
 840     }
 841     return NULL;
 842 }
 843
 844 void bdrv_iterate(void (*it)(void *opaque, const char *name), void *opaque)
 845 {
 846     BlockDriverState *bs;
 847
 848     for (bs = bdrv_first; bs != NULL; bs = bs->next) {
 849         it(opaque, bs->device_name);
 850     }
 851 }
 852
 853 const char *bdrv_get_device_name(BlockDriverState *bs)
 854 {
 855     return bs->device_name;
 856 }
 857
 858 void bdrv_flush(BlockDriverState *bs)
 859 {
 860     if (bs->drv->bdrv_flush)
 861         bs->drv->bdrv_flush(bs);
 862     if (bs->backing_hd)
 863         bdrv_flush(bs->backing_hd);
 864 }
 865
 866 void bdrv_info(void)
 867 {
 868     BlockDriverState *bs;
 869
 870     for (bs = bdrv_first; bs != NULL; bs = bs->next) {
 871         term_printf("%s:", bs->device_name);
 872         term_printf(" type=");
 873         switch(bs->type) {
 874         case BDRV_TYPE_HD:
 875             term_printf("hd");
 876             break;
 877         case BDRV_TYPE_CDROM:
 878             term_printf("cdrom");
 879             break;
 880         case BDRV_TYPE_FLOPPY:
 881             term_printf("floppy");
 882             break;
 883         }
 884         term_printf(" removable=%d", bs->removable);
 885         if (bs->removable) {
 886             term_printf(" locked=%d", bs->locked);
 887         }
 888         if (bs->drv) {
 889             term_printf(" file=");
 890             term_print_filename(bs->filename);
 891             if (bs->backing_file[0] != '\0') {
 892                 term_printf(" backing_file=");
 893                 term_print_filename(bs->backing_file);
 894             }
 895             term_printf(" ro=%d", bs->read_only);
 896             term_printf(" drv=%s", bs->drv->format_name);
 897             if (bs->encrypted)
 898                 term_printf(" encrypted");
 899         } else {
 900             term_printf(" [not inserted]");
 901         }
 902         term_printf("\n");
 903     }
 904 }
 905
 906 void bdrv_get_backing_filename(BlockDriverState *bs,
 907                                char *filename, int filename_size)
 908 {
 909     if (!bs->backing_hd) {
 910         pstrcpy(filename, filename_size, "");
 911     } else {
 912         pstrcpy(filename, filename_size, bs->backing_file);
 913     }
 914 }
 915
 916 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
 917                           const uint8_t *buf, int nb_sectors)
 918 {
 919     BlockDriver *drv = bs->drv;
 920     if (!drv)
 921         return -ENOMEDIUM;
 922     if (!drv->bdrv_write_compressed)
 923         return -ENOTSUP;
 924     return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors);
 925 }
 926
 927 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
 928 {
 929     BlockDriver *drv = bs->drv;
 930     if (!drv)
 931         return -ENOMEDIUM;
 932     if (!drv->bdrv_get_info)
 933         return -ENOTSUP;
 934     memset(bdi, 0, sizeof(*bdi));
 935     return drv->bdrv_get_info(bs, bdi);
 936 }
 937
 938 /**************************************************************/
 939 /* handling of snapshots */
 940
 941 int bdrv_snapshot_create(BlockDriverState *bs,
 942                          QEMUSnapshotInfo *sn_info)
 943 {
 944     BlockDriver *drv = bs->drv;
 945     if (!drv)
 946         return -ENOMEDIUM;
 947     if (!drv->bdrv_snapshot_create)
 948         return -ENOTSUP;
 949     return drv->bdrv_snapshot_create(bs, sn_info);
 950 }
 951
 952 int bdrv_snapshot_goto(BlockDriverState *bs,
 953                        const char *snapshot_id)
 954 {
 955     BlockDriver *drv = bs->drv;
 956     if (!drv)
 957         return -ENOMEDIUM;
 958     if (!drv->bdrv_snapshot_goto)
 959         return -ENOTSUP;
 960     return drv->bdrv_snapshot_goto(bs, snapshot_id);
 961 }
 962
 963 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id)
 964 {
 965     BlockDriver *drv = bs->drv;
 966     if (!drv)
 967         return -ENOMEDIUM;
 968     if (!drv->bdrv_snapshot_delete)
 969         return -ENOTSUP;
 970     return drv->bdrv_snapshot_delete(bs, snapshot_id);
 971 }
 972
 973 int bdrv_snapshot_list(BlockDriverState *bs,
 974                        QEMUSnapshotInfo **psn_info)
 975 {
 976     BlockDriver *drv = bs->drv;
 977     if (!drv)
 978         return -ENOMEDIUM;
 979     if (!drv->bdrv_snapshot_list)
 980         return -ENOTSUP;
 981     return drv->bdrv_snapshot_list(bs, psn_info);
 982 }
 983
 984 #define NB_SUFFIXES 4
 985
 986 char *get_human_readable_size(char *buf, int buf_size, int64_t size)
 987 {
 988     static const char suffixes[NB_SUFFIXES] = "KMGT";
 989     int64_t base;
 990     int i;
 991
 992     if (size <= 999) {
 993         snprintf(buf, buf_size, "%" PRId64, size);
 994     } else {
 995         base = 1024;
 996         for(i = 0; i < NB_SUFFIXES; i++) {
 997             if (size < (10 * base)) {
 998                 snprintf(buf, buf_size, "%0.1f%c",
 999                          (double)size / base,
1000                          suffixes[i]);
1001                 break;
1002             } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
1003                 snprintf(buf, buf_size, "%" PRId64 "%c",
1004                          ((size + (base >> 1)) / base),
1005                          suffixes[i]);
1006                 break;
1007             }
1008             base = base * 1024;
1009         }
1010     }
1011     return buf;
1012 }
1013
1014 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn)
1015 {
1016     char buf1[128], date_buf[128], clock_buf[128];
1017 #ifdef _WIN32
1018     struct tm *ptm;
1019 #else
1020     struct tm tm;
1021 #endif
1022     time_t ti;
1023     int64_t secs;
1024
1025     if (!sn) {
1026         snprintf(buf, buf_size,
1027                  "%-10s%-20s%7s%20s%15s",
1028                  "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
1029     } else {
1030         ti = sn->date_sec;
1031 #ifdef _WIN32
1032         ptm = localtime(&ti);
1033         strftime(date_buf, sizeof(date_buf),
1034                  "%Y-%m-%d %H:%M:%S", ptm);
1035 #else
1036         localtime_r(&ti, &tm);
1037         strftime(date_buf, sizeof(date_buf),
1038                  "%Y-%m-%d %H:%M:%S", &tm);
1039 #endif
1040         secs = sn->vm_clock_nsec / 1000000000;
1041         snprintf(clock_buf, sizeof(clock_buf),
1042                  "%02d:%02d:%02d.%03d",
1043                  (int)(secs / 3600),
1044                  (int)((secs / 60) % 60),
1045                  (int)(secs % 60),
1046                  (int)((sn->vm_clock_nsec / 1000000) % 1000));
1047         snprintf(buf, buf_size,
1048                  "%-10s%-20s%7s%20s%15s",
1049                  sn->id_str, sn->name,
1050                  get_human_readable_size(buf1, sizeof(buf1), sn->vm_state_size),
1051                  date_buf,
1052                  clock_buf);
1053     }
1054     return buf;
1055 }
1056
1057
1058 /**************************************************************/
1059 /* async I/Os */
1060
1061 BlockDriverAIOCB *bdrv_aio_read(BlockDriverState *bs, int64_t sector_num,
1062                                 uint8_t *buf, int nb_sectors,
1063                                 BlockDriverCompletionFunc *cb, void *opaque)
1064 {
1065     BlockDriver *drv = bs->drv;
1066
1067     if (!drv)
1068         return NULL;
1069
1070     /* XXX: we assume that nb_sectors == 0 is suppored by the async read */
1071     if (sector_num == 0 && bs->boot_sector_enabled && nb_sectors > 0) {
1072         memcpy(buf, bs->boot_sector_data, 512);
1073         sector_num++;
1074         nb_sectors--;
1075         buf += 512;
1076     }
1077
1078     return drv->bdrv_aio_read(bs, sector_num, buf, nb_sectors, cb, opaque);
1079 }
1080
1081 BlockDriverAIOCB *bdrv_aio_write(BlockDriverState *bs, int64_t sector_num,
1082                                  const uint8_t *buf, int nb_sectors,
1083                                  BlockDriverCompletionFunc *cb, void *opaque)
1084 {
1085     BlockDriver *drv = bs->drv;
1086
1087     if (!drv)
1088         return NULL;
1089     if (bs->read_only)
1090         return NULL;
1091     if (sector_num == 0 && bs->boot_sector_enabled && nb_sectors > 0) {
1092         memcpy(bs->boot_sector_data, buf, 512);
1093     }
1094
1095     return drv->bdrv_aio_write(bs, sector_num, buf, nb_sectors, cb, opaque);
1096 }
1097
1098 void bdrv_aio_cancel(BlockDriverAIOCB *acb)
1099 {
1100     BlockDriver *drv = acb->bs->drv;
1101
1102     drv->bdrv_aio_cancel(acb);
1103 }
1104
1105
1106 /**************************************************************/
1107 /* async block device emulation */
1108
1109 #ifdef QEMU_TOOL
1110 static BlockDriverAIOCB *bdrv_aio_read_em(BlockDriverState *bs,
1111         int64_t sector_num, uint8_t *buf, int nb_sectors,
1112         BlockDriverCompletionFunc *cb, void *opaque)
1113 {
1114     int ret;
1115     ret = bdrv_read(bs, sector_num, buf, nb_sectors);
1116     cb(opaque, ret);
1117     return NULL;
1118 }
1119
1120 static BlockDriverAIOCB *bdrv_aio_write_em(BlockDriverState *bs,
1121         int64_t sector_num, const uint8_t *buf, int nb_sectors,
1122         BlockDriverCompletionFunc *cb, void *opaque)
1123 {
1124     int ret;
1125     ret = bdrv_write(bs, sector_num, buf, nb_sectors);
1126     cb(opaque, ret);
1127     return NULL;
1128 }
1129
1130 static void bdrv_aio_cancel_em(BlockDriverAIOCB *acb)
1131 {
1132 }
1133 #else
1134 static void bdrv_aio_bh_cb(void *opaque)
1135 {
1136     BlockDriverAIOCBSync *acb = opaque;
1137     acb->common.cb(acb->common.opaque, acb->ret);
1138     qemu_aio_release(acb);
1139 }
1140
1141 static BlockDriverAIOCB *bdrv_aio_read_em(BlockDriverState *bs,
1142         int64_t sector_num, uint8_t *buf, int nb_sectors,
1143         BlockDriverCompletionFunc *cb, void *opaque)
1144 {
1145     BlockDriverAIOCBSync *acb;
1146     int ret;
1147
1148     acb = qemu_aio_get(bs, cb, opaque);
1149     if (!acb->bh)
1150         acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
1151     ret = bdrv_read(bs, sector_num, buf, nb_sectors);
1152     acb->ret = ret;
1153     qemu_bh_schedule(acb->bh);
1154     return &acb->common;
1155 }
1156
1157 static BlockDriverAIOCB *bdrv_aio_write_em(BlockDriverState *bs,
1158         int64_t sector_num, const uint8_t *buf, int nb_sectors,
1159         BlockDriverCompletionFunc *cb, void *opaque)
1160 {
1161     BlockDriverAIOCBSync *acb;
1162     int ret;
1163
1164     acb = qemu_aio_get(bs, cb, opaque);
1165     if (!acb->bh)
1166         acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
1167     ret = bdrv_write(bs, sector_num, buf, nb_sectors);
1168     acb->ret = ret;
1169     qemu_bh_schedule(acb->bh);
1170     return &acb->common;
1171 }
1172
1173 static void bdrv_aio_cancel_em(BlockDriverAIOCB *blockacb)
1174 {
1175     BlockDriverAIOCBSync *acb = (BlockDriverAIOCBSync *)blockacb;
1176     qemu_bh_cancel(acb->bh);
1177     qemu_aio_release(acb);
1178 }
1179 #endif /* !QEMU_TOOL */
1180
1181 /**************************************************************/
1182 /* sync block device emulation */
1183
1184 static void bdrv_rw_em_cb(void *opaque, int ret)
1185 {
1186     *(int *)opaque = ret;
1187 }
1188
1189 #define NOT_DONE 0x7fffffff
1190
1191 static int bdrv_read_em(BlockDriverState *bs, int64_t sector_num,
1192                         uint8_t *buf, int nb_sectors)
1193 {
1194     int async_ret;
1195     BlockDriverAIOCB *acb;
1196
1197     async_ret = NOT_DONE;
1198     qemu_aio_wait_start();
1199     acb = bdrv_aio_read(bs, sector_num, buf, nb_sectors,
1200                         bdrv_rw_em_cb, &async_ret);
1201     if (acb == NULL) {
1202         qemu_aio_wait_end();
1203         return -1;
1204     }
1205     while (async_ret == NOT_DONE) {
1206         qemu_aio_wait();
1207     }
1208     qemu_aio_wait_end();
1209     return async_ret;
1210 }
1211
1212 static int bdrv_write_em(BlockDriverState *bs, int64_t sector_num,
1213                          const uint8_t *buf, int nb_sectors)
1214 {
1215     int async_ret;
1216     BlockDriverAIOCB *acb;
1217
1218     async_ret = NOT_DONE;
1219     qemu_aio_wait_start();
1220     acb = bdrv_aio_write(bs, sector_num, buf, nb_sectors,
1221                          bdrv_rw_em_cb, &async_ret);
1222     if (acb == NULL) {
1223         qemu_aio_wait_end();
1224         return -1;
1225     }
1226     while (async_ret == NOT_DONE) {
1227         qemu_aio_wait();
1228     }
1229     qemu_aio_wait_end();
1230     return async_ret;
1231 }
1232
1233 void bdrv_init(void)
1234 {
1235     bdrv_register(&bdrv_raw);
1236     bdrv_register(&bdrv_host_device);
1237 #ifndef _WIN32
1238     bdrv_register(&bdrv_cow);
1239 #endif
1240     bdrv_register(&bdrv_qcow);
1241     bdrv_register(&bdrv_vmdk);
1242     bdrv_register(&bdrv_cloop);
1243     bdrv_register(&bdrv_dmg);
1244     bdrv_register(&bdrv_bochs);
1245     bdrv_register(&bdrv_vpc);
1246     bdrv_register(&bdrv_vvfat);
1247     bdrv_register(&bdrv_qcow2);
1248 }
1249
1250 void *qemu_aio_get(BlockDriverState *bs, BlockDriverCompletionFunc *cb,
1251                    void *opaque)
1252 {
1253     BlockDriver *drv;
1254     BlockDriverAIOCB *acb;
1255
1256     drv = bs->drv;
1257     if (drv->free_aiocb) {
1258         acb = drv->free_aiocb;
1259         drv->free_aiocb = acb->next;
1260     } else {
1261         acb = qemu_mallocz(drv->aiocb_size);
1262         if (!acb)
1263             return NULL;
1264     }
1265     acb->bs = bs;
1266     acb->cb = cb;
1267     acb->opaque = opaque;
1268     return acb;
1269 }
1270
1271 void qemu_aio_release(void *p)
1272 {
1273     BlockDriverAIOCB *acb = p;
1274     BlockDriver *drv = acb->bs->drv;
1275     acb->next = drv->free_aiocb;
1276     drv->free_aiocb = acb;
1277 }
1278
1279 /**************************************************************/
1280 /* removable device support */
1281
1282 /**
1283  * Return TRUE if the media is present
1284  */
1285 int bdrv_is_inserted(BlockDriverState *bs)
1286 {
1287     BlockDriver *drv = bs->drv;
1288     int ret;
1289     if (!drv)
1290         return 0;
1291     if (!drv->bdrv_is_inserted)
1292         return 1;
1293     ret = drv->bdrv_is_inserted(bs);
1294     return ret;
1295 }
1296
1297 /**
1298  * Return TRUE if the media changed since the last call to this
1299  * function. It is currently only used for floppy disks
1300  */
1301 int bdrv_media_changed(BlockDriverState *bs)
1302 {
1303     BlockDriver *drv = bs->drv;
1304     int ret;
1305
1306     if (!drv || !drv->bdrv_media_changed)
1307         ret = -ENOTSUP;
1308     else
1309         ret = drv->bdrv_media_changed(bs);
1310     if (ret == -ENOTSUP)
1311         ret = bs->media_changed;
1312     bs->media_changed = 0;
1313     return ret;
1314 }
1315
1316 /**
1317  * If eject_flag is TRUE, eject the media. Otherwise, close the tray
1318  */
1319 void bdrv_eject(BlockDriverState *bs, int eject_flag)
1320 {
1321     BlockDriver *drv = bs->drv;
1322     int ret;
1323
1324     if (!drv || !drv->bdrv_eject) {
1325         ret = -ENOTSUP;
1326     } else {
1327         ret = drv->bdrv_eject(bs, eject_flag);
1328     }
1329     if (ret == -ENOTSUP) {
1330         if (eject_flag)
1331             bdrv_close(bs);
1332     }
1333 }
1334
1335 int bdrv_is_locked(BlockDriverState *bs)
1336 {
1337     return bs->locked;
1338 }
1339
1340 /**
1341  * Lock or unlock the media (if it is locked, the user won't be able
1342  * to eject it manually).
1343  */
1344 void bdrv_set_locked(BlockDriverState *bs, int locked)
1345 {
1346     BlockDriver *drv = bs->drv;
1347
1348     bs->locked = locked;
1349     if (drv && drv->bdrv_set_locked) {
1350         drv->bdrv_set_locked(bs, locked);
1351     }
1352 }