[linux.git] / fs / hfsplus / wrapper.c

// SPDX-License-Identifier: GPL-2.0
/*
 *  linux/fs/hfsplus/wrapper.c
 *
 * Copyright (C) 2001
 * Brad Boyer ([email protected])
 * (C) 2003 Ardis Technologies <[email protected]>
 *
 * Handling of HFS wrappers around HFS+ volumes
 */

#include <linux/fs.h>
#include <linux/blkdev.h>
#include <linux/cdrom.h>
#include <linux/genhd.h>
#include <asm/unaligned.h>

#include "hfsplus_fs.h"
#include "hfsplus_raw.h"

struct hfsplus_wd {
	u32 ablk_size;
	u16 ablk_start;
	u16 embed_start;
	u16 embed_count;
};

/**
 * hfsplus_submit_bio - Perform block I/O
 * @sb: super block of volume for I/O
 * @sector: block to read or write, for blocks of HFSPLUS_SECTOR_SIZE bytes
 * @buf: buffer for I/O
 * @data: output pointer for location of requested data
 * @op: direction of I/O
 * @op_flags: request op flags
 *
 * The unit of I/O is hfsplus_min_io_size(sb), which may be bigger than
 * HFSPLUS_SECTOR_SIZE, and @buf must be sized accordingly. On reads
 * @data will return a pointer to the start of the requested sector,
 * which may not be the same location as @buf.
 *
 * If @sector is not aligned to the bdev logical block size it will
 * be rounded down. For writes this means that @buf should contain data
 * that starts at the rounded-down address. As long as the data was
 * read using hfsplus_submit_bio() and the same buffer is used things
 * will work correctly.
 */
int hfsplus_submit_bio(struct super_block *sb, sector_t sector,
		       void *buf, void **data, int op, int op_flags)
{
	struct bio *bio;
	int ret = 0;
	u64 io_size;
	loff_t start;
	int offset;

	/*
	 * Align sector to hardware sector size and find offset. We
	 * assume that io_size is a power of two, which _should_
	 * be true.
	 */
	io_size = hfsplus_min_io_size(sb);
	start = (loff_t)sector << HFSPLUS_SECTOR_SHIFT;
	offset = start & (io_size - 1);
	sector &= ~((io_size >> HFSPLUS_SECTOR_SHIFT) - 1);

	bio = bio_alloc(GFP_NOIO, 1);
	bio->bi_iter.bi_sector = sector;
	bio_set_dev(bio, sb->s_bdev);
	bio_set_op_attrs(bio, op, op_flags);

	if (op != WRITE && data)
		*data = (u8 *)buf + offset;

	while (io_size > 0) {
		unsigned int page_offset = offset_in_page(buf);
		unsigned int len = min_t(unsigned int, PAGE_SIZE - page_offset,
					 io_size);

		ret = bio_add_page(bio, virt_to_page(buf), len, page_offset);
		if (ret != len) {
			ret = -EIO;
			goto out;
		}
		io_size -= len;
		buf = (u8 *)buf + len;
	}

	ret = submit_bio_wait(bio);
out:
	bio_put(bio);
	return ret < 0 ? ret : 0;
}

static int hfsplus_read_mdb(void *bufptr, struct hfsplus_wd *wd)
{
	u32 extent;
	u16 attrib;
	__be16 sig;

	sig = *(__be16 *)(bufptr + HFSP_WRAPOFF_EMBEDSIG);
	if (sig != cpu_to_be16(HFSPLUS_VOLHEAD_SIG) &&
	    sig != cpu_to_be16(HFSPLUS_VOLHEAD_SIGX))
		return 0;

	attrib = be16_to_cpu(*(__be16 *)(bufptr + HFSP_WRAPOFF_ATTRIB));
	if (!(attrib & HFSP_WRAP_ATTRIB_SLOCK) ||
	   !(attrib & HFSP_WRAP_ATTRIB_SPARED))
		return 0;

	wd->ablk_size =
		be32_to_cpu(*(__be32 *)(bufptr + HFSP_WRAPOFF_ABLKSIZE));
	if (wd->ablk_size < HFSPLUS_SECTOR_SIZE)
		return 0;
	if (wd->ablk_size % HFSPLUS_SECTOR_SIZE)
		return 0;
	wd->ablk_start =
		be16_to_cpu(*(__be16 *)(bufptr + HFSP_WRAPOFF_ABLKSTART));

	extent = get_unaligned_be32(bufptr + HFSP_WRAPOFF_EMBEDEXT);
	wd->embed_start = (extent >> 16) & 0xFFFF;
	wd->embed_count = extent & 0xFFFF;

	return 1;
}

static int hfsplus_get_last_session(struct super_block *sb,
				    sector_t *start, sector_t *size)
{
	struct cdrom_multisession ms_info;
	struct cdrom_tocentry te;
	int res;

	/* default values */
	*start = 0;
	*size = i_size_read(sb->s_bdev->bd_inode) >> 9;

	if (HFSPLUS_SB(sb)->session >= 0) {
		te.cdte_track = HFSPLUS_SB(sb)->session;
		te.cdte_format = CDROM_LBA;
		res = ioctl_by_bdev(sb->s_bdev,
			CDROMREADTOCENTRY, (unsigned long)&te);
		if (!res && (te.cdte_ctrl & CDROM_DATA_TRACK) == 4) {
			*start = (sector_t)te.cdte_addr.lba << 2;
			return 0;
		}
		pr_err("invalid session number or type of track\n");
		return -EINVAL;
	}
	ms_info.addr_format = CDROM_LBA;
	res = ioctl_by_bdev(sb->s_bdev, CDROMMULTISESSION,
		(unsigned long)&ms_info);
	if (!res && ms_info.xa_flag)
		*start = (sector_t)ms_info.addr.lba << 2;
	return 0;
}

/* Find the volume header and fill in some minimum bits in superblock */
/* Takes in super block, returns true if good data read */
int hfsplus_read_wrapper(struct super_block *sb)
{
	struct hfsplus_sb_info *sbi = HFSPLUS_SB(sb);
	struct hfsplus_wd wd;
	sector_t part_start, part_size;
	u32 blocksize;
	int error = 0;

	error = -EINVAL;
	blocksize = sb_min_blocksize(sb, HFSPLUS_SECTOR_SIZE);
	if (!blocksize)
		goto out;

	if (hfsplus_get_last_session(sb, &part_start, &part_size))
		goto out;

	error = -ENOMEM;
	sbi->s_vhdr_buf = kmalloc(hfsplus_min_io_size(sb), GFP_KERNEL);
	if (!sbi->s_vhdr_buf)
		goto out;
	sbi->s_backup_vhdr_buf = kmalloc(hfsplus_min_io_size(sb), GFP_KERNEL);
	if (!sbi->s_backup_vhdr_buf)
		goto out_free_vhdr;

reread:
	error = hfsplus_submit_bio(sb, part_start + HFSPLUS_VOLHEAD_SECTOR,
				   sbi->s_vhdr_buf, (void **)&sbi->s_vhdr,
				   REQ_OP_READ, 0);
	if (error)
		goto out_free_backup_vhdr;

	error = -EINVAL;
	switch (sbi->s_vhdr->signature) {
	case cpu_to_be16(HFSPLUS_VOLHEAD_SIGX):
		set_bit(HFSPLUS_SB_HFSX, &sbi->flags);
		/*FALLTHRU*/
	case cpu_to_be16(HFSPLUS_VOLHEAD_SIG):
		break;
	case cpu_to_be16(HFSP_WRAP_MAGIC):
		if (!hfsplus_read_mdb(sbi->s_vhdr, &wd))
			goto out_free_backup_vhdr;
		wd.ablk_size >>= HFSPLUS_SECTOR_SHIFT;
		part_start += (sector_t)wd.ablk_start +
			       (sector_t)wd.embed_start * wd.ablk_size;
		part_size = (sector_t)wd.embed_count * wd.ablk_size;
		goto reread;
	default:
		/*
		 * Check for a partition block.
		 *
		 * (should do this only for cdrom/loop though)
		 */
		if (hfs_part_find(sb, &part_start, &part_size))
			goto out_free_backup_vhdr;
		goto reread;
	}

	error = hfsplus_submit_bio(sb, part_start + part_size - 2,
				   sbi->s_backup_vhdr_buf,
				   (void **)&sbi->s_backup_vhdr, REQ_OP_READ,
				   0);
	if (error)
		goto out_free_backup_vhdr;

	error = -EINVAL;
	if (sbi->s_backup_vhdr->signature != sbi->s_vhdr->signature) {
		pr_warn("invalid secondary volume header\n");
		goto out_free_backup_vhdr;
	}

	blocksize = be32_to_cpu(sbi->s_vhdr->blocksize);

	/*
	 * Block size must be at least as large as a sector and a multiple of 2.
	 */
	if (blocksize < HFSPLUS_SECTOR_SIZE || ((blocksize - 1) & blocksize))
		goto out_free_backup_vhdr;
	sbi->alloc_blksz = blocksize;
	sbi->alloc_blksz_shift = ilog2(blocksize);
	blocksize = min_t(u32, sbi->alloc_blksz, PAGE_SIZE);

	/*
	 * Align block size to block offset.
	 */
	while (part_start & ((blocksize >> HFSPLUS_SECTOR_SHIFT) - 1))
		blocksize >>= 1;

	if (sb_set_blocksize(sb, blocksize) != blocksize) {
		pr_err("unable to set blocksize to %u!\n", blocksize);
		goto out_free_backup_vhdr;
	}

	sbi->blockoffset =
		part_start >> (sb->s_blocksize_bits - HFSPLUS_SECTOR_SHIFT);
	sbi->part_start = part_start;
	sbi->sect_count = part_size;
	sbi->fs_shift = sbi->alloc_blksz_shift - sb->s_blocksize_bits;
	return 0;

out_free_backup_vhdr:
	kfree(sbi->s_backup_vhdr_buf);
out_free_vhdr:
	kfree(sbi->s_vhdr_buf);
out:
	return error;
}
Commit	Line	Data
b2441318	1	// SPDX-License-Identifier: GPL-2.0
1da177e4 LT	2	/*
	3	* linux/fs/hfsplus/wrapper.c
	4	*
	5	* Copyright (C) 2001
	6	* Brad Boyer ([email protected])
	7	* (C) 2003 Ardis Technologies <[email protected]>
	8	*
	9	* Handling of HFS wrappers around HFS+ volumes
	10	*/
	11
	12	#include <linux/fs.h>
	13	#include <linux/blkdev.h>
	14	#include <linux/cdrom.h>
	15	#include <linux/genhd.h>
1da177e4 LT	16	#include <asm/unaligned.h>
	17
	18	#include "hfsplus_fs.h"
	19	#include "hfsplus_raw.h"
	20
	21	struct hfsplus_wd {
	22	u32 ablk_size;
	23	u16 ablk_start;
	24	u16 embed_start;
	25	u16 embed_count;
	26	};
	27
915ab236 FF	28	/**
915ab236 FF	29	* hfsplus_submit_bio - Perform block I/O
6596528e SF	30	* @sb: super block of volume for I/O
	31	* @sector: block to read or write, for blocks of HFSPLUS_SECTOR_SIZE bytes
	32	* @buf: buffer for I/O
	33	* @data: output pointer for location of requested data
67ed2596 MC	34	* @op: direction of I/O
67ed2596 MC	35	* @op_flags: request op flags
6596528e SF	36	*
	37	* The unit of I/O is hfsplus_min_io_size(sb), which may be bigger than
	38	* HFSPLUS_SECTOR_SIZE, and @buf must be sized accordingly. On reads
	39	* @data will return a pointer to the start of the requested sector,
	40	* which may not be the same location as @buf.
	41	*
	42	* If @sector is not aligned to the bdev logical block size it will
	43	* be rounded down. For writes this means that @buf should contain data
	44	* that starts at the rounded-down address. As long as the data was
	45	* read using hfsplus_submit_bio() and the same buffer is used things
	46	* will work correctly.
	47	*/
	48	int hfsplus_submit_bio(struct super_block *sb, sector_t sector,
67ed2596	49	void buf, void *data, int op, int op_flags)
52399b17	50	{
52399b17	51	struct bio *bio;
50176dde	52	int ret = 0;
a6dc8c04	53	u64 io_size;
6596528e SF	54	loff_t start;
	55	int offset;
	56
	57	/*
	58	* Align sector to hardware sector size and find offset. We
	59	* assume that io_size is a power of two, which _should_
	60	* be true.
	61	*/
	62	io_size = hfsplus_min_io_size(sb);
	63	start = (loff_t)sector << HFSPLUS_SECTOR_SHIFT;
	64	offset = start & (io_size - 1);
	65	sector &= ~((io_size >> HFSPLUS_SECTOR_SHIFT) - 1);
52399b17 CH	66
52399b17 CH	67	bio = bio_alloc(GFP_NOIO, 1);
4f024f37	68	bio->bi_iter.bi_sector = sector;
74d46992	69	bio_set_dev(bio, sb->s_bdev);
67ed2596	70	bio_set_op_attrs(bio, op, op_flags);
52399b17	71
67ed2596	72	if (op != WRITE && data)
6596528e SF	73	data = (u8 )buf + offset;
	74
	75	while (io_size > 0) {
	76	unsigned int page_offset = offset_in_page(buf);
	77	unsigned int len = min_t(unsigned int, PAGE_SIZE - page_offset,
	78	io_size);
	79
	80	ret = bio_add_page(bio, virt_to_page(buf), len, page_offset);
	81	if (ret != len) {
	82	ret = -EIO;
	83	goto out;
	84	}
	85	io_size -= len;
	86	buf = (u8 *)buf + len;
	87	}
52399b17	88
4e49ea4a	89	ret = submit_bio_wait(bio);
6596528e	90	out:
50176dde	91	bio_put(bio);
6596528e	92	return ret < 0 ? ret : 0;
52399b17 CH	93	}
52399b17 CH	94
1da177e4 LT	95	static int hfsplus_read_mdb(void bufptr, struct hfsplus_wd wd)
	96	{
	97	u32 extent;
	98	u16 attrib;
2179d372	99	__be16 sig;
1da177e4	100
2179d372 DE	101	sig = (__be16 )(bufptr + HFSP_WRAPOFF_EMBEDSIG);
	102	if (sig != cpu_to_be16(HFSPLUS_VOLHEAD_SIG) &&
	103	sig != cpu_to_be16(HFSPLUS_VOLHEAD_SIGX))
1da177e4 LT	104	return 0;
	105
	106	attrib = be16_to_cpu((__be16 )(bufptr + HFSP_WRAPOFF_ATTRIB));
	107	if (!(attrib & HFSP_WRAP_ATTRIB_SLOCK) \|\|
	108	!(attrib & HFSP_WRAP_ATTRIB_SPARED))
	109	return 0;
	110
2753cc28 AS	111	wd->ablk_size =
2753cc28 AS	112	be32_to_cpu((__be32 )(bufptr + HFSP_WRAPOFF_ABLKSIZE));
1da177e4 LT	113	if (wd->ablk_size < HFSPLUS_SECTOR_SIZE)
	114	return 0;
	115	if (wd->ablk_size % HFSPLUS_SECTOR_SIZE)
	116	return 0;
2753cc28 AS	117	wd->ablk_start =
2753cc28 AS	118	be16_to_cpu((__be16 )(bufptr + HFSP_WRAPOFF_ABLKSTART));
1da177e4	119
8b3789e5	120	extent = get_unaligned_be32(bufptr + HFSP_WRAPOFF_EMBEDEXT);
1da177e4 LT	121	wd->embed_start = (extent >> 16) & 0xFFFF;
	122	wd->embed_count = extent & 0xFFFF;
	123
	124	return 1;
	125	}
	126
	127	static int hfsplus_get_last_session(struct super_block *sb,
	128	sector_t start, sector_t size)
	129	{
	130	struct cdrom_multisession ms_info;
	131	struct cdrom_tocentry te;
	132	int res;
	133
	134	/* default values */
	135	*start = 0;
a3f22350	136	*size = i_size_read(sb->s_bdev->bd_inode) >> 9;
1da177e4	137
dd73a01a CH	138	if (HFSPLUS_SB(sb)->session >= 0) {
dd73a01a CH	139	te.cdte_track = HFSPLUS_SB(sb)->session;
1da177e4	140	te.cdte_format = CDROM_LBA;
2753cc28 AS	141	res = ioctl_by_bdev(sb->s_bdev,
2753cc28 AS	142	CDROMREADTOCENTRY, (unsigned long)&te);
1da177e4 LT	143	if (!res && (te.cdte_ctrl & CDROM_DATA_TRACK) == 4) {
	144	*start = (sector_t)te.cdte_addr.lba << 2;
	145	return 0;
	146	}
d6142673	147	pr_err("invalid session number or type of track\n");
1da177e4 LT	148	return -EINVAL;
	149	}
	150	ms_info.addr_format = CDROM_LBA;
2753cc28 AS	151	res = ioctl_by_bdev(sb->s_bdev, CDROMMULTISESSION,
2753cc28 AS	152	(unsigned long)&ms_info);
1da177e4 LT	153	if (!res && ms_info.xa_flag)
	154	*start = (sector_t)ms_info.addr.lba << 2;
	155	return 0;
	156	}
	157
	158	/* Find the volume header and fill in some minimum bits in superblock */
	159	/* Takes in super block, returns true if good data read */
	160	int hfsplus_read_wrapper(struct super_block *sb)
	161	{
dd73a01a	162	struct hfsplus_sb_info *sbi = HFSPLUS_SB(sb);
1da177e4 LT	163	struct hfsplus_wd wd;
	164	sector_t part_start, part_size;
	165	u32 blocksize;
52399b17	166	int error = 0;
1da177e4	167
52399b17	168	error = -EINVAL;
1da177e4 LT	169	blocksize = sb_min_blocksize(sb, HFSPLUS_SECTOR_SIZE);
1da177e4 LT	170	if (!blocksize)
52399b17	171	goto out;
1da177e4 LT	172
1da177e4 LT	173	if (hfsplus_get_last_session(sb, &part_start, &part_size))
52399b17	174	goto out;
1da177e4	175
52399b17	176	error = -ENOMEM;
6596528e SF	177	sbi->s_vhdr_buf = kmalloc(hfsplus_min_io_size(sb), GFP_KERNEL);
6596528e SF	178	if (!sbi->s_vhdr_buf)
52399b17	179	goto out;
6596528e SF	180	sbi->s_backup_vhdr_buf = kmalloc(hfsplus_min_io_size(sb), GFP_KERNEL);
6596528e SF	181	if (!sbi->s_backup_vhdr_buf)
52399b17 CH	182	goto out_free_vhdr;
	183
	184	reread:
6596528e SF	185	error = hfsplus_submit_bio(sb, part_start + HFSPLUS_VOLHEAD_SECTOR,
6596528e SF	186	sbi->s_vhdr_buf, (void **)&sbi->s_vhdr,
67ed2596	187	REQ_OP_READ, 0);
52399b17 CH	188	if (error)
	189	goto out_free_backup_vhdr;
	190
	191	error = -EINVAL;
	192	switch (sbi->s_vhdr->signature) {
	193	case cpu_to_be16(HFSPLUS_VOLHEAD_SIGX):
	194	set_bit(HFSPLUS_SB_HFSX, &sbi->flags);
	195	/FALLTHRU/
	196	case cpu_to_be16(HFSPLUS_VOLHEAD_SIG):
	197	break;
	198	case cpu_to_be16(HFSP_WRAP_MAGIC):
	199	if (!hfsplus_read_mdb(sbi->s_vhdr, &wd))
a1dbcef0	200	goto out_free_backup_vhdr;
52399b17	201	wd.ablk_size >>= HFSPLUS_SECTOR_SHIFT;
4ba2d5fd CH	202	part_start += (sector_t)wd.ablk_start +
	203	(sector_t)wd.embed_start * wd.ablk_size;
	204	part_size = (sector_t)wd.embed_count * wd.ablk_size;
52399b17 CH	205	goto reread;
	206	default:
	207	/*
	208	* Check for a partition block.
	209	*
1da177e4 LT	210	* (should do this only for cdrom/loop though)
	211	*/
	212	if (hfs_part_find(sb, &part_start, &part_size))
a1dbcef0	213	goto out_free_backup_vhdr;
52399b17 CH	214	goto reread;
	215	}
	216
6596528e SF	217	error = hfsplus_submit_bio(sb, part_start + part_size - 2,
6596528e SF	218	sbi->s_backup_vhdr_buf,
67ed2596 MC	219	(void **)&sbi->s_backup_vhdr, REQ_OP_READ,
67ed2596 MC	220	0);
52399b17 CH	221	if (error)
	222	goto out_free_backup_vhdr;
	223
	224	error = -EINVAL;
	225	if (sbi->s_backup_vhdr->signature != sbi->s_vhdr->signature) {
d6142673	226	pr_warn("invalid secondary volume header\n");
52399b17	227	goto out_free_backup_vhdr;
1da177e4 LT	228	}
1da177e4 LT	229
52399b17	230	blocksize = be32_to_cpu(sbi->s_vhdr->blocksize);
1da177e4	231
52399b17 CH	232	/*
52399b17 CH	233	* Block size must be at least as large as a sector and a multiple of 2.
1da177e4	234	*/
52399b17 CH	235	if (blocksize < HFSPLUS_SECTOR_SIZE \|\| ((blocksize - 1) & blocksize))
52399b17 CH	236	goto out_free_backup_vhdr;
dd73a01a	237	sbi->alloc_blksz = blocksize;
297cc272	238	sbi->alloc_blksz_shift = ilog2(blocksize);
915ab236	239	blocksize = min_t(u32, sbi->alloc_blksz, PAGE_SIZE);
1da177e4	240
52399b17 CH	241	/*
	242	* Align block size to block offset.
	243	*/
1da177e4 LT	244	while (part_start & ((blocksize >> HFSPLUS_SECTOR_SHIFT) - 1))
	245	blocksize >>= 1;
	246
	247	if (sb_set_blocksize(sb, blocksize) != blocksize) {
d6142673	248	pr_err("unable to set blocksize to %u!\n", blocksize);
52399b17	249	goto out_free_backup_vhdr;
1da177e4 LT	250	}
1da177e4 LT	251
dd73a01a CH	252	sbi->blockoffset =
dd73a01a CH	253	part_start >> (sb->s_blocksize_bits - HFSPLUS_SECTOR_SHIFT);
52399b17	254	sbi->part_start = part_start;
dd73a01a CH	255	sbi->sect_count = part_size;
dd73a01a CH	256	sbi->fs_shift = sbi->alloc_blksz_shift - sb->s_blocksize_bits;
1da177e4	257	return 0;
52399b17 CH	258
52399b17 CH	259	out_free_backup_vhdr:
f588c960	260	kfree(sbi->s_backup_vhdr_buf);
52399b17	261	out_free_vhdr:
f588c960	262	kfree(sbi->s_vhdr_buf);
52399b17 CH	263	out:
52399b17 CH	264	return error;
1da177e4	265	}