/usr/include/ploop/ploop1_image.h is in libploop-dev 1.15-2+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 | /*
* Copyright (C) 2008-2012, Parallels, Inc. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __PLOOP1_IMAGE_H__
#define __PLOOP1_IMAGE_H__ 1
/* Definition of PVD (Parallels Virtual Disk) format
*
* 1. All the data are in ?little-endian? format.
* 2. All the data except for the first cluster are aligned and padded
* to size of cluster. First cluster is exception - it combines
* PVD header (first 64 bytes of the cluster) with L2 index table
* (L2 index table is an array of indices of blocks)
* 3. Image size must be multiple of cluster size. If it is not,
* we assume it is the result of image extension failed in the
* middle of transaction, therefore new allocations start at
* size rounded down to cluster size.
* 4. Update of indices must be done only after data clusters
* are committed to reliable storage. If we fail to update index,
* we can get an unused and, maybe, uninitialized or partially
* initialized data cluster. It is lost, forgotten and ignored
* until repair or image rebuild.
*/
/*
* copy/paste of IMAGE_PARAMETERS from DiskImageComp.h
*/
#pragma pack(push,1)
struct ploop_pvd_header
{
__u8 m_Sig[16]; /* Signature */
__u32 m_Type; /* Disk type */
__u32 m_Heads; /* heads count */
__u32 m_Cylinders; /* tracks count */
__u32 m_Sectors; /* Sectors per track count */
__u32 m_Size; /* Size of disk in tracks */
union { /* Size of disk in 512-byte sectors */
struct {
__u32 m_SizeInSectors_v1;
__u32 Unused;
};
__u64 m_SizeInSectors_v2;
};
__u32 m_DiskInUse; /* Disk in use */
__u32 m_FirstBlockOffset; /* First data block offset (in sectors) */
__u32 m_Flags; /* Misc flags */
__u8 m_Reserved[8]; /* Reserved */
};
#pragma pack(pop)
/* Compressed disk (version 1) */
#define PRL_IMAGE_COMPRESSED 2
/* Compressed disk v1 signature */
#define SIGNATURE_STRUCTURED_DISK_V1 "WithoutFreeSpace"
/* Compressed disk v2 signature */
#define SIGNATURE_STRUCTURED_DISK_V2 "WithouFreSpacExt"
/* Sign that the disk is in "using" state */
#define SIGNATURE_DISK_IN_USE 0x746F6E59
/**
* Compressed disk image flags
*/
#define CIF_NoFlags 0x00000000 /* No any flags */
#define CIF_Empty 0x00000001 /* No any data was written */
#define CIF_FmtVersionConvert 0x00000002 /* Version Convert in progree */
#define CIF_Invalid 0xFFFFFFFF /* Invalid flag */
#define PLOOP1_SECTOR_LOG 9
#define PLOOP1_DEF_CLUSTER_LOG 11 /* 1M cluster-block */
#define DEF_CLUSTER (1UL << (PLOOP1_DEF_CLUSTER_LOG + PLOOP1_SECTOR_LOG))
/* Helpers to generate PVD-header based on requested bdsize */
#define DEFAULT_HEADS_COUNT 16
#define DEFAULT_SECTORS_COUNT 63
#define SECTOR_SIZE (1 << PLOOP1_SECTOR_LOG)
struct CHSData
{
__u32 Sectors;
__u32 Heads;
__u32 Cylinders;
};
#ifdef __KERNEL__
# define ploop_do_div(n, base) do_div(n, base)
#else
# define ploop_do_div(n, base) ({ \
__u32 __rem = n % base; \
n /= base; \
__rem; \
})
#endif
/*
* Try to count disk sectors per track value
*/
static inline __u32
CalcSectors(const __u64 uiSize)
{
__u64 size = uiSize;
/* Try to determine sector count */
if (!ploop_do_div(size, DEFAULT_SECTORS_COUNT))
return DEFAULT_SECTORS_COUNT;
if (!(uiSize % 32))
return 32;
if (!(uiSize % 16))
return 16;
if (!(uiSize % 8))
return 8;
return ~0;
}
/*
* Try to count disk heads value
*/
static inline __u32
CalcHeads(const __u64 uiSize)
{
__u64 size = uiSize;
/* Try to determine heads count */
if (!ploop_do_div(size, DEFAULT_HEADS_COUNT))
return DEFAULT_HEADS_COUNT;
if (!(uiSize % 8))
return 8;
if (!(uiSize % 4))
return 4;
if (!(uiSize % 2))
return 2;
return ~0;
}
/*
* Convert size to CHS for disks from 504 Mb to 8 Gb
*/
static inline void
ConvertToCHSLow(__u64 From, struct CHSData *chs)
{
chs->Sectors = DEFAULT_SECTORS_COUNT;
chs->Heads = DEFAULT_HEADS_COUNT;
ploop_do_div(From, DEFAULT_SECTORS_COUNT * DEFAULT_HEADS_COUNT);
chs->Cylinders = From;
}
/*
* Convert size to pure LBA config
*/
static inline void
ConvertToPureLBA(__u64 From, struct CHSData *chs)
{
chs->Sectors = 1;
chs->Heads = 1;
chs->Cylinders = From;
}
static inline void
ConvertToCHS(__u64 From, struct CHSData *chs)
{
__u64 Size;
/*
* According to ATA2 specs:
* - If the device is above 1,032,192 sectors then the value should be 63.
* This value does not exceed 63 (3Fh). But note, that if device size
* above 16,777,216 the HDD reports proper 'magic' number in CHS values,
* so the situation in the middle must be handled separately
*/
if ((From > 1032192) && (From < 16777216))
{
ConvertToCHSLow(From, chs);
return;
}
Size = From;
/* Store size */
chs->Sectors = CalcSectors(Size);
if (chs->Sectors == (__u32)~0)
goto PureLBA;
ploop_do_div(Size, chs->Sectors);
chs->Heads = CalcHeads(Size);
if (chs->Heads == (__u32)~0)
goto PureLBA;
ploop_do_div(Size, chs->Heads);
chs->Cylinders = Size;
return;
PureLBA:
ConvertToPureLBA(From, chs);
}
static inline __u32
GetHeaderSize(__u32 m_Size)
{
__u32 Size = sizeof(struct ploop_pvd_header);
/* Add BAT */
Size += m_Size * sizeof(__u32);
/* Align to size of sector */
Size = (Size + SECTOR_SIZE - 1) & ~(SECTOR_SIZE - 1);
return Size;
}
static inline char *
ploop1_signature(int version)
{
switch (version) {
case PLOOP_FMT_V1:
return SIGNATURE_STRUCTURED_DISK_V1;
case PLOOP_FMT_V2:
return SIGNATURE_STRUCTURED_DISK_V2;
#ifdef __KERNEL__
default:
BUG();
#endif
}
return NULL;
}
static inline int
ploop1_version(struct ploop_pvd_header *vh)
{
if (!memcmp(vh->m_Sig, SIGNATURE_STRUCTURED_DISK_V1, sizeof(vh->m_Sig)))
return PLOOP_FMT_V1;
if (!memcmp(vh->m_Sig, SIGNATURE_STRUCTURED_DISK_V2, sizeof(vh->m_Sig)))
return PLOOP_FMT_V2;
return PLOOP_FMT_ERROR;
}
static inline void
put_SizeInSectors(__u64 SizeInSectors, struct ploop_pvd_header *vh,
int version)
{
switch (version) {
case PLOOP_FMT_V1:
vh->m_SizeInSectors_v1 = SizeInSectors;
break;
case PLOOP_FMT_V2:
vh->m_SizeInSectors_v2 = SizeInSectors;
break;
}
}
#ifdef __KERNEL__
static inline u64
get_SizeInSectors_from_le(struct ploop_pvd_header *vh, int version)
{
switch (version) {
case PLOOP_FMT_V1:
return le32_to_cpu(vh->m_SizeInSectors_v1);
case PLOOP_FMT_V2:
return le64_to_cpu(vh->m_SizeInSectors_v2);
default:
BUG();
}
return 0;
}
static inline void
cpu_to_le_SizeInSectors(struct ploop_pvd_header *vh, int version)
{
switch (version) {
case PLOOP_FMT_V1:
vh->m_SizeInSectors_v1 = cpu_to_le32(vh->m_SizeInSectors_v1);
break;
case PLOOP_FMT_V2:
vh->m_SizeInSectors_v2 = cpu_to_le64(vh->m_SizeInSectors_v2);
break;
default:
BUG();
}
}
#else
static inline __u64
get_SizeInSectors(struct ploop_pvd_header *vh)
{
switch (ploop1_version(vh)) {
case PLOOP_FMT_V1:
return vh->m_SizeInSectors_v1;
case PLOOP_FMT_V2:
return vh->m_SizeInSectors_v2;
}
return 0;
}
#endif
/*
* Returns: "size to fill" (in bytes)
*
* NB: m_Flags and m_DiskInUse are being kept as is; our caller
* should take care of them.
*
* NB: Both bdsize and blocksize are measured in sectors.
*/
static inline __u32
generate_pvd_header(struct ploop_pvd_header *vh, __u64 bdsize, __u32 blocksize,
int version)
{
struct CHSData chs;
__u32 SizeToFill;
__u32 uiAlignmentSize;
__u64 SizeInSectors;
memcpy(vh->m_Sig, ploop1_signature(version) , sizeof(vh->m_Sig));
vh->m_Type = PRL_IMAGE_COMPRESSED;
/* Round up to block size */
SizeInSectors = bdsize + blocksize - 1;
ploop_do_div(SizeInSectors, blocksize);
SizeInSectors *= blocksize;
put_SizeInSectors(SizeInSectors, vh, version);
ConvertToCHS(SizeInSectors, &chs);
vh->m_Sectors = blocksize;
vh->m_Heads = chs.Heads;
vh->m_Cylinders = chs.Cylinders;
ploop_do_div(SizeInSectors, blocksize);
vh->m_Size = SizeInSectors;
uiAlignmentSize = blocksize << PLOOP1_SECTOR_LOG;
SizeToFill = GetHeaderSize(vh->m_Size);
/* Align to block size */
if (SizeToFill % uiAlignmentSize)
SizeToFill += uiAlignmentSize - (SizeToFill % uiAlignmentSize);
vh->m_FirstBlockOffset = SizeToFill >> PLOOP1_SECTOR_LOG;
return SizeToFill;
}
/* Translation of sector number to offset in image */
#if 0
/* Those function are not really used */
/* Calculate virtual cluster number from virtual sector number */
static inline __u32
ploop1_cluster(struct ploop_img_header * info, __u64 sector)
{
return sector >> info->cluster_log;
}
/* Get amount of clusters covered by one L2 table, 32K by default,
* which can map 4G of data
*/
static inline __u32
ploop1_clusters_per_l2(struct ploop_img_header * info)
{
return 1 << (info->cluster_log + info->sector_log - 2);
}
/* Calculate index in L1 table mapping a cluster. */
static inline __u32
ploop1_l1_index(struct ploop_img_header * info, __u32 cluster)
{
return cluster >> (info->cluster_log + info->sector_log - 2);
}
/* Calculate index in L2 table mapping a cluster. */
static inline __u32
ploop1_l2_index(struct ploop_img_header * info, __u32 cluster)
{
return cluster & (ploop1_clusters_per_l2(info) - 1);
}
/* That's all, simple and stupid */
#endif
#endif /* __PLOOP1_IMAGE_H__ */
|