[mirror_ubuntu-bionic-kernel.git] / block / partitions / ldm.h

/**
 * ldm - Part of the Linux-NTFS project.
 *
 * Copyright (C) 2001,2002 Richard Russon <ldm@flatcap.org>
 * Copyright (c) 2001-2007 Anton Altaparmakov
 * Copyright (C) 2001,2002 Jakob Kemi <jakob.kemi@telia.com>
 *
 * Documentation is available at http://www.linux-ntfs.org/doku.php?id=downloads 
 *
 * 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 (in the main directory of the Linux-NTFS source
 * in the file COPYING); if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _FS_PT_LDM_H_
#define _FS_PT_LDM_H_

#include <linux/types.h>
#include <linux/list.h>
#include <linux/genhd.h>
#include <linux/fs.h>
#include <asm/unaligned.h>
#include <asm/byteorder.h>

struct parsed_partitions;

/* Magic numbers in CPU format. */
#define MAGIC_VMDB	0x564D4442		/* VMDB */
#define MAGIC_VBLK	0x56424C4B		/* VBLK */
#define MAGIC_PRIVHEAD	0x5052495648454144ULL	/* PRIVHEAD */
#define MAGIC_TOCBLOCK	0x544F43424C4F434BULL	/* TOCBLOCK */

/* The defined vblk types. */
#define VBLK_VOL5		0x51		/* Volume,     version 5 */
#define VBLK_CMP3		0x32		/* Component,  version 3 */
#define VBLK_PRT3		0x33		/* Partition,  version 3 */
#define VBLK_DSK3		0x34		/* Disk,       version 3 */
#define VBLK_DSK4		0x44		/* Disk,       version 4 */
#define VBLK_DGR3		0x35		/* Disk Group, version 3 */
#define VBLK_DGR4		0x45		/* Disk Group, version 4 */

/* vblk flags indicating extra information will be present */
#define	VBLK_FLAG_COMP_STRIPE	0x10
#define	VBLK_FLAG_PART_INDEX	0x08
#define	VBLK_FLAG_DGR3_IDS	0x08
#define	VBLK_FLAG_DGR4_IDS	0x08
#define	VBLK_FLAG_VOLU_ID1	0x08
#define	VBLK_FLAG_VOLU_ID2	0x20
#define	VBLK_FLAG_VOLU_SIZE	0x80
#define	VBLK_FLAG_VOLU_DRIVE	0x02

/* size of a vblk's static parts */
#define VBLK_SIZE_HEAD		16
#define VBLK_SIZE_CMP3		22		/* Name and version */
#define VBLK_SIZE_DGR3		12
#define VBLK_SIZE_DGR4		44
#define VBLK_SIZE_DSK3		12
#define VBLK_SIZE_DSK4		45
#define VBLK_SIZE_PRT3		28
#define VBLK_SIZE_VOL5		58

/* component types */
#define COMP_STRIPE		0x01		/* Stripe-set */
#define COMP_BASIC		0x02		/* Basic disk */
#define COMP_RAID		0x03		/* Raid-set */

/* Other constants. */
#define LDM_DB_SIZE		2048		/* Size in sectors (= 1MiB). */

#define OFF_PRIV1		6		/* Offset of the first privhead
						   relative to the start of the
						   device in sectors */

/* Offsets to structures within the LDM Database in sectors. */
#define OFF_PRIV2		1856		/* Backup private headers. */
#define OFF_PRIV3		2047

#define OFF_TOCB1		1		/* Tables of contents. */
#define OFF_TOCB2		2
#define OFF_TOCB3		2045
#define OFF_TOCB4		2046

#define OFF_VMDB		17		/* List of partitions. */

#define LDM_PARTITION		0x42		/* Formerly SFS (Landis). */

#define TOC_BITMAP1		"config"	/* Names of the two defined */
#define TOC_BITMAP2		"log"		/* bitmaps in the TOCBLOCK. */

/* Borrowed from msdos.c */
#define SYS_IND(p)		(get_unaligned(&(p)->sys_ind))

struct frag {				/* VBLK Fragment handling */
	struct list_head list;
	u32		group;
	u8		num;		/* Total number of records */
	u8		rec;		/* This is record number n */
	u8		map;		/* Which portions are in use */
	u8		data[0];
};

/* In memory LDM database structures. */

struct privhead {			/* Offsets and sizes are in sectors. */
	u16	ver_major;
	u16	ver_minor;
	u64	logical_disk_start;
	u64	logical_disk_size;
	u64	config_start;
	u64	config_size;
	uuid_t	disk_id;
};

struct tocblock {			/* We have exactly two bitmaps. */
	u8	bitmap1_name[16];
	u64	bitmap1_start;
	u64	bitmap1_size;
	u8	bitmap2_name[16];
	u64	bitmap2_start;
	u64	bitmap2_size;
};

struct vmdb {				/* VMDB: The database header */
	u16	ver_major;
	u16	ver_minor;
	u32	vblk_size;
	u32	vblk_offset;
	u32	last_vblk_seq;
};

struct vblk_comp {			/* VBLK Component */
	u8	state[16];
	u64	parent_id;
	u8	type;
	u8	children;
	u16	chunksize;
};

struct vblk_dgrp {			/* VBLK Disk Group */
	u8	disk_id[64];
};

struct vblk_disk {			/* VBLK Disk */
	uuid_t	disk_id;
	u8	alt_name[128];
};

struct vblk_part {			/* VBLK Partition */
	u64	start;
	u64	size;			/* start, size and vol_off in sectors */
	u64	volume_offset;
	u64	parent_id;
	u64	disk_id;
	u8	partnum;
};

struct vblk_volu {			/* VBLK Volume */
	u8	volume_type[16];
	u8	volume_state[16];
	u8	guid[16];
	u8	drive_hint[4];
	u64	size;
	u8	partition_type;
};

struct vblk_head {			/* VBLK standard header */
	u32 group;
	u16 rec;
	u16 nrec;
};

struct vblk {				/* Generalised VBLK */
	u8	name[64];
	u64	obj_id;
	u32	sequence;
	u8	flags;
	u8	type;
	union {
		struct vblk_comp comp;
		struct vblk_dgrp dgrp;
		struct vblk_disk disk;
		struct vblk_part part;
		struct vblk_volu volu;
	} vblk;
	struct list_head list;
};

struct ldmdb {				/* Cache of the database */
	struct privhead ph;
	struct tocblock toc;
	struct vmdb     vm;
	struct list_head v_dgrp;
	struct list_head v_disk;
	struct list_head v_volu;
	struct list_head v_comp;
	struct list_head v_part;
};

int ldm_partition(struct parsed_partitions *state);

#endif /* _FS_PT_LDM_H_ */
Commit	Line	Data
1da177e4 LT	1	/**
	2	* ldm - Part of the Linux-NTFS project.
	3	*
	4	* Copyright (C) 2001,2002 Richard Russon <ldm@flatcap.org>
dde33348	5	* Copyright (c) 2001-2007 Anton Altaparmakov
1da177e4 LT	6	* Copyright (C) 2001,2002 Jakob Kemi <jakob.kemi@telia.com>
1da177e4 LT	7	*
631dd1a8	8	* Documentation is available at http://www.linux-ntfs.org/doku.php?id=downloads
1da177e4 LT	9	*
	10	* This program is free software; you can redistribute it and/or modify it
	11	* under the terms of the GNU General Public License as published by the Free
	12	* Software Foundation; either version 2 of the License, or (at your option)
	13	* any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program (in the main directory of the Linux-NTFS source
	22	* in the file COPYING); if not, write to the Free Software Foundation,
	23	* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	24	*/
	25
	26	#ifndef _FS_PT_LDM_H_
	27	#define _FS_PT_LDM_H_
	28
	29	#include <linux/types.h>
	30	#include <linux/list.h>
	31	#include <linux/genhd.h>
	32	#include <linux/fs.h>
	33	#include <asm/unaligned.h>
	34	#include <asm/byteorder.h>
	35
	36	struct parsed_partitions;
	37
	38	/* Magic numbers in CPU format. */
	39	#define MAGIC_VMDB 0x564D4442 /* VMDB */
	40	#define MAGIC_VBLK 0x56424C4B /* VBLK */
	41	#define MAGIC_PRIVHEAD 0x5052495648454144ULL /* PRIVHEAD */
	42	#define MAGIC_TOCBLOCK 0x544F43424C4F434BULL /* TOCBLOCK */
	43
	44	/* The defined vblk types. */
	45	#define VBLK_VOL5 0x51 /* Volume, version 5 */
	46	#define VBLK_CMP3 0x32 /* Component, version 3 */
	47	#define VBLK_PRT3 0x33 /* Partition, version 3 */
	48	#define VBLK_DSK3 0x34 /* Disk, version 3 */
	49	#define VBLK_DSK4 0x44 /* Disk, version 4 */
	50	#define VBLK_DGR3 0x35 /* Disk Group, version 3 */
	51	#define VBLK_DGR4 0x45 /* Disk Group, version 4 */
	52
	53	/* vblk flags indicating extra information will be present */
	54	#define VBLK_FLAG_COMP_STRIPE 0x10
	55	#define VBLK_FLAG_PART_INDEX 0x08
	56	#define VBLK_FLAG_DGR3_IDS 0x08
	57	#define VBLK_FLAG_DGR4_IDS 0x08
	58	#define VBLK_FLAG_VOLU_ID1 0x08
	59	#define VBLK_FLAG_VOLU_ID2 0x20
	60	#define VBLK_FLAG_VOLU_SIZE 0x80
	61	#define VBLK_FLAG_VOLU_DRIVE 0x02
	62
	63	/* size of a vblk's static parts */
	64	#define VBLK_SIZE_HEAD 16
	65	#define VBLK_SIZE_CMP3 22 /* Name and version */
	66	#define VBLK_SIZE_DGR3 12
	67	#define VBLK_SIZE_DGR4 44
	68	#define VBLK_SIZE_DSK3 12
	69	#define VBLK_SIZE_DSK4 45
	70	#define VBLK_SIZE_PRT3 28
959bc220	71	#define VBLK_SIZE_VOL5 58
1da177e4 LT	72
	73	/* component types */
	74	#define COMP_STRIPE 0x01 /* Stripe-set */
	75	#define COMP_BASIC 0x02 /* Basic disk */
	76	#define COMP_RAID 0x03 /* Raid-set */
	77
	78	/* Other constants. */
	79	#define LDM_DB_SIZE 2048 /* Size in sectors (= 1MiB). */
	80
	81	#define OFF_PRIV1 6 /* Offset of the first privhead
	82	relative to the start of the
	83	device in sectors */
	84
	85	/* Offsets to structures within the LDM Database in sectors. */
	86	#define OFF_PRIV2 1856 /* Backup private headers. */
	87	#define OFF_PRIV3 2047
	88
	89	#define OFF_TOCB1 1 /* Tables of contents. */
	90	#define OFF_TOCB2 2
	91	#define OFF_TOCB3 2045
	92	#define OFF_TOCB4 2046
	93
	94	#define OFF_VMDB 17 /* List of partitions. */
	95
dde33348	96	#define LDM_PARTITION 0x42 /* Formerly SFS (Landis). */
1da177e4 LT	97
	98	#define TOC_BITMAP1 "config" /* Names of the two defined */
	99	#define TOC_BITMAP2 "log" /* bitmaps in the TOCBLOCK. */
	100
1da177e4 LT	101	/* Borrowed from msdos.c */
	102	#define SYS_IND(p) (get_unaligned(&(p)->sys_ind))
	103
	104	struct frag { /* VBLK Fragment handling */
	105	struct list_head list;
	106	u32 group;
	107	u8 num; /* Total number of records */
	108	u8 rec; /* This is record number n */
	109	u8 map; /* Which portions are in use */
	110	u8 data[0];
	111	};
	112
	113	/* In memory LDM database structures. */
	114
1da177e4 LT	115	struct privhead { /* Offsets and sizes are in sectors. */
	116	u16 ver_major;
	117	u16 ver_minor;
	118	u64 logical_disk_start;
	119	u64 logical_disk_size;
	120	u64 config_start;
	121	u64 config_size;
59b9c629	122	uuid_t disk_id;
1da177e4 LT	123	};
	124
	125	struct tocblock { /* We have exactly two bitmaps. */
	126	u8 bitmap1_name[16];
	127	u64 bitmap1_start;
	128	u64 bitmap1_size;
	129	u8 bitmap2_name[16];
	130	u64 bitmap2_start;
	131	u64 bitmap2_size;
	132	};
	133
	134	struct vmdb { /* VMDB: The database header */
	135	u16 ver_major;
	136	u16 ver_minor;
	137	u32 vblk_size;
	138	u32 vblk_offset;
	139	u32 last_vblk_seq;
	140	};
	141
	142	struct vblk_comp { /* VBLK Component */
	143	u8 state[16];
	144	u64 parent_id;
	145	u8 type;
	146	u8 children;
	147	u16 chunksize;
	148	};
	149
	150	struct vblk_dgrp { /* VBLK Disk Group */
	151	u8 disk_id[64];
	152	};
	153
	154	struct vblk_disk { /* VBLK Disk */
59b9c629	155	uuid_t disk_id;
1da177e4 LT	156	u8 alt_name[128];
	157	};
	158
	159	struct vblk_part { /* VBLK Partition */
	160	u64 start;
	161	u64 size; /* start, size and vol_off in sectors */
	162	u64 volume_offset;
	163	u64 parent_id;
	164	u64 disk_id;
	165	u8 partnum;
	166	};
	167
	168	struct vblk_volu { /* VBLK Volume */
	169	u8 volume_type[16];
	170	u8 volume_state[16];
	171	u8 guid[16];
	172	u8 drive_hint[4];
	173	u64 size;
	174	u8 partition_type;
	175	};
	176
	177	struct vblk_head { /* VBLK standard header */
	178	u32 group;
	179	u16 rec;
	180	u16 nrec;
	181	};
	182
	183	struct vblk { /* Generalised VBLK */
	184	u8 name[64];
	185	u64 obj_id;
	186	u32 sequence;
	187	u8 flags;
	188	u8 type;
	189	union {
	190	struct vblk_comp comp;
	191	struct vblk_dgrp dgrp;
	192	struct vblk_disk disk;
	193	struct vblk_part part;
	194	struct vblk_volu volu;
	195	} vblk;
	196	struct list_head list;
	197	};
	198
	199	struct ldmdb { /* Cache of the database */
	200	struct privhead ph;
	201	struct tocblock toc;
	202	struct vmdb vm;
	203	struct list_head v_dgrp;
	204	struct list_head v_disk;
	205	struct list_head v_volu;
	206	struct list_head v_comp;
	207	struct list_head v_part;
	208	};
	209
1493bf21	210	int ldm_partition(struct parsed_partitions *state);
1da177e4 LT	211
	212	#endif /* _FS_PT_LDM_H_ */
	213