plugins/linuxdisk/virtual-disk.h

   1 /* nbdkit
   2  * Copyright Red Hat
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *
  11  * * Redistributions in binary form must reproduce the above copyright
  12  * notice, this list of conditions and the following disclaimer in the
  13  * documentation and/or other materials provided with the distribution.
  14  *
  15  * * Neither the name of Red Hat nor the names of its contributors may be
  16  * used to endorse or promote products derived from this software without
  17  * specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  21  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  22  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #ifndef NBDKIT_VIRTUAL_DISK_H
  34 #define NBDKIT_VIRTUAL_DISK_H
  35
  36 #include <stdbool.h>
  37 #include <stdint.h>
  38
  39 #include "regions.h"
  40
  41 extern const char *dir;
  42 extern const char *label;
  43 extern const char *type;
  44 extern int64_t size;
  45 extern bool size_add_estimate;
  46
  47 extern struct random_state random_state;
  48
  49 #define SECTOR_SIZE 512
  50
  51 struct virtual_disk {
  52   /* Virtual disk layout. */
  53   struct regions regions;
  54
  55   /* Disk protective MBR. */
  56   uint8_t *protective_mbr;
  57
  58   /* GPT primary partition table header. */
  59   uint8_t *primary_header;
  60
  61   /* GPT primary and secondary (backup) PTs.  These are the same. */
  62   uint8_t *pt;
  63
  64   /* GPT secondary (backup) PT header. */
  65   uint8_t *secondary_header;
  66
  67   /* Size of the filesystem in bytes. */
  68   uint64_t filesystem_size;
  69
  70   /* Unique partition GUID. */
  71   char guid[16];
  72
  73   /* File descriptor of the temporary file containing the filesystem. */
  74   int fd;
  75 };
  76
  77 /* virtual-disk.c */
  78 extern void init_virtual_disk (struct virtual_disk *disk)
  79   __attribute__ ((__nonnull__ (1)));
  80 extern int create_virtual_disk (struct virtual_disk *disk)
  81   __attribute__ ((__nonnull__ (1)));
  82 extern void free_virtual_disk (struct virtual_disk *disk)
  83   __attribute__ ((__nonnull__ (1)));
  84
  85 /* partition-gpt.c */
  86 extern int create_partition_table (struct virtual_disk *disk);
  87
  88 /* filesystem.c */
  89 extern int create_filesystem (struct virtual_disk *disk);
  90
  91 #endif /* NBDKIT_VIRTUAL_DISK_H */