[linux-2.6-block.git] / block / partitions / ldm.h

// SPDX-License-Identifier: GPL-2.0-or-later
/**
 * 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 
 */

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