xref: /openbmc/linux/fs/udf/misc.c (revision 5ce34554)
1*5ce34554SBagas Sanjaya // SPDX-License-Identifier: GPL-2.0-only
21da177e4SLinus Torvalds /*
31da177e4SLinus Torvalds  * misc.c
41da177e4SLinus Torvalds  *
51da177e4SLinus Torvalds  * PURPOSE
61da177e4SLinus Torvalds  *	Miscellaneous routines for the OSTA-UDF(tm) filesystem.
71da177e4SLinus Torvalds  *
81da177e4SLinus Torvalds  * COPYRIGHT
91da177e4SLinus Torvalds  *  (C) 1998 Dave Boynton
101da177e4SLinus Torvalds  *  (C) 1998-2004 Ben Fennema
111da177e4SLinus Torvalds  *  (C) 1999-2000 Stelias Computing Inc
121da177e4SLinus Torvalds  *
131da177e4SLinus Torvalds  * HISTORY
141da177e4SLinus Torvalds  *
151da177e4SLinus Torvalds  *  04/19/99 blf  partial support for reading/writing specific EA's
161da177e4SLinus Torvalds  */
171da177e4SLinus Torvalds 
181da177e4SLinus Torvalds #include "udfdecl.h"
191da177e4SLinus Torvalds 
201da177e4SLinus Torvalds #include <linux/fs.h>
211da177e4SLinus Torvalds #include <linux/string.h>
22f845fcedSBob Copeland #include <linux/crc-itu-t.h>
231da177e4SLinus Torvalds 
241da177e4SLinus Torvalds #include "udf_i.h"
251da177e4SLinus Torvalds #include "udf_sb.h"
261da177e4SLinus Torvalds 
udf_add_extendedattr(struct inode * inode,uint32_t size,uint32_t type,uint8_t loc)27cb00ea35SCyrill Gorcunov struct genericFormat *udf_add_extendedattr(struct inode *inode, uint32_t size,
28cb00ea35SCyrill Gorcunov 					   uint32_t type, uint8_t loc)
291da177e4SLinus Torvalds {
301da177e4SLinus Torvalds 	uint8_t *ea = NULL, *ad = NULL;
311da177e4SLinus Torvalds 	int offset;
321da177e4SLinus Torvalds 	uint16_t crclen;
3348d6d8ffSMarcin Slusarz 	struct udf_inode_info *iinfo = UDF_I(inode);
341da177e4SLinus Torvalds 
35382a2287SJan Kara 	ea = iinfo->i_data;
3648d6d8ffSMarcin Slusarz 	if (iinfo->i_lenEAttr) {
37382a2287SJan Kara 		ad = iinfo->i_data + iinfo->i_lenEAttr;
3828de7948SCyrill Gorcunov 	} else {
391da177e4SLinus Torvalds 		ad = ea;
401da177e4SLinus Torvalds 		size += sizeof(struct extendedAttrHeaderDesc);
411da177e4SLinus Torvalds 	}
421da177e4SLinus Torvalds 
431da177e4SLinus Torvalds 	offset = inode->i_sb->s_blocksize - udf_file_entry_alloc_offset(inode) -
4448d6d8ffSMarcin Slusarz 		iinfo->i_lenAlloc;
451da177e4SLinus Torvalds 
461da177e4SLinus Torvalds 	/* TODO - Check for FreeEASpace */
471da177e4SLinus Torvalds 
48cb00ea35SCyrill Gorcunov 	if (loc & 0x01 && offset >= size) {
491da177e4SLinus Torvalds 		struct extendedAttrHeaderDesc *eahd;
501da177e4SLinus Torvalds 		eahd = (struct extendedAttrHeaderDesc *)ea;
511da177e4SLinus Torvalds 
5248d6d8ffSMarcin Slusarz 		if (iinfo->i_lenAlloc)
5348d6d8ffSMarcin Slusarz 			memmove(&ad[size], ad, iinfo->i_lenAlloc);
541da177e4SLinus Torvalds 
5548d6d8ffSMarcin Slusarz 		if (iinfo->i_lenEAttr) {
561da177e4SLinus Torvalds 			/* check checksum/crc */
575e0f0017SMarcin Slusarz 			if (eahd->descTag.tagIdent !=
585e0f0017SMarcin Slusarz 					cpu_to_le16(TAG_IDENT_EAHD) ||
594b11111aSMarcin Slusarz 			    le32_to_cpu(eahd->descTag.tagLocation) !=
6048d6d8ffSMarcin Slusarz 					iinfo->i_location.logicalBlockNum)
611da177e4SLinus Torvalds 				return NULL;
62cb00ea35SCyrill Gorcunov 		} else {
636c79e987SMarcin Slusarz 			struct udf_sb_info *sbi = UDF_SB(inode->i_sb);
646c79e987SMarcin Slusarz 
651da177e4SLinus Torvalds 			size -= sizeof(struct extendedAttrHeaderDesc);
6648d6d8ffSMarcin Slusarz 			iinfo->i_lenEAttr +=
674b11111aSMarcin Slusarz 				sizeof(struct extendedAttrHeaderDesc);
681da177e4SLinus Torvalds 			eahd->descTag.tagIdent = cpu_to_le16(TAG_IDENT_EAHD);
696c79e987SMarcin Slusarz 			if (sbi->s_udfrev >= 0x0200)
701da177e4SLinus Torvalds 				eahd->descTag.descVersion = cpu_to_le16(3);
711da177e4SLinus Torvalds 			else
721da177e4SLinus Torvalds 				eahd->descTag.descVersion = cpu_to_le16(2);
734b11111aSMarcin Slusarz 			eahd->descTag.tagSerialNum =
744b11111aSMarcin Slusarz 					cpu_to_le16(sbi->s_serial_number);
754b11111aSMarcin Slusarz 			eahd->descTag.tagLocation = cpu_to_le32(
7648d6d8ffSMarcin Slusarz 					iinfo->i_location.logicalBlockNum);
771da177e4SLinus Torvalds 			eahd->impAttrLocation = cpu_to_le32(0xFFFFFFFF);
781da177e4SLinus Torvalds 			eahd->appAttrLocation = cpu_to_le32(0xFFFFFFFF);
791da177e4SLinus Torvalds 		}
801da177e4SLinus Torvalds 
8148d6d8ffSMarcin Slusarz 		offset = iinfo->i_lenEAttr;
82cb00ea35SCyrill Gorcunov 		if (type < 2048) {
834b11111aSMarcin Slusarz 			if (le32_to_cpu(eahd->appAttrLocation) <
8448d6d8ffSMarcin Slusarz 					iinfo->i_lenEAttr) {
854b11111aSMarcin Slusarz 				uint32_t aal =
864b11111aSMarcin Slusarz 					le32_to_cpu(eahd->appAttrLocation);
8728de7948SCyrill Gorcunov 				memmove(&ea[offset - aal + size],
8828de7948SCyrill Gorcunov 					&ea[aal], offset - aal);
891da177e4SLinus Torvalds 				offset -= aal;
904b11111aSMarcin Slusarz 				eahd->appAttrLocation =
914b11111aSMarcin Slusarz 						cpu_to_le32(aal + size);
921da177e4SLinus Torvalds 			}
934b11111aSMarcin Slusarz 			if (le32_to_cpu(eahd->impAttrLocation) <
9448d6d8ffSMarcin Slusarz 					iinfo->i_lenEAttr) {
954b11111aSMarcin Slusarz 				uint32_t ial =
964b11111aSMarcin Slusarz 					le32_to_cpu(eahd->impAttrLocation);
9728de7948SCyrill Gorcunov 				memmove(&ea[offset - ial + size],
9828de7948SCyrill Gorcunov 					&ea[ial], offset - ial);
991da177e4SLinus Torvalds 				offset -= ial;
1004b11111aSMarcin Slusarz 				eahd->impAttrLocation =
1014b11111aSMarcin Slusarz 						cpu_to_le32(ial + size);
1021da177e4SLinus Torvalds 			}
103cb00ea35SCyrill Gorcunov 		} else if (type < 65536) {
1044b11111aSMarcin Slusarz 			if (le32_to_cpu(eahd->appAttrLocation) <
10548d6d8ffSMarcin Slusarz 					iinfo->i_lenEAttr) {
1064b11111aSMarcin Slusarz 				uint32_t aal =
1074b11111aSMarcin Slusarz 					le32_to_cpu(eahd->appAttrLocation);
10828de7948SCyrill Gorcunov 				memmove(&ea[offset - aal + size],
10928de7948SCyrill Gorcunov 					&ea[aal], offset - aal);
1101da177e4SLinus Torvalds 				offset -= aal;
1114b11111aSMarcin Slusarz 				eahd->appAttrLocation =
1124b11111aSMarcin Slusarz 						cpu_to_le32(aal + size);
1131da177e4SLinus Torvalds 			}
1141da177e4SLinus Torvalds 		}
1151da177e4SLinus Torvalds 		/* rewrite CRC + checksum of eahd */
1165ca4e4beSPekka Enberg 		crclen = sizeof(struct extendedAttrHeaderDesc) - sizeof(struct tag);
1171da177e4SLinus Torvalds 		eahd->descTag.descCRCLength = cpu_to_le16(crclen);
118f845fcedSBob Copeland 		eahd->descTag.descCRC = cpu_to_le16(crc_itu_t(0, (char *)eahd +
1195ca4e4beSPekka Enberg 						sizeof(struct tag), crclen));
1203f2587bbSMarcin Slusarz 		eahd->descTag.tagChecksum = udf_tag_checksum(&eahd->descTag);
12148d6d8ffSMarcin Slusarz 		iinfo->i_lenEAttr += size;
1221da177e4SLinus Torvalds 		return (struct genericFormat *)&ea[offset];
1231da177e4SLinus Torvalds 	}
12428de7948SCyrill Gorcunov 
1251da177e4SLinus Torvalds 	return NULL;
1261da177e4SLinus Torvalds }
1271da177e4SLinus Torvalds 
udf_get_extendedattr(struct inode * inode,uint32_t type,uint8_t subtype)128cb00ea35SCyrill Gorcunov struct genericFormat *udf_get_extendedattr(struct inode *inode, uint32_t type,
129cb00ea35SCyrill Gorcunov 					   uint8_t subtype)
1301da177e4SLinus Torvalds {
1311da177e4SLinus Torvalds 	struct genericFormat *gaf;
1321da177e4SLinus Torvalds 	uint8_t *ea = NULL;
1331da177e4SLinus Torvalds 	uint32_t offset;
13448d6d8ffSMarcin Slusarz 	struct udf_inode_info *iinfo = UDF_I(inode);
1351da177e4SLinus Torvalds 
136382a2287SJan Kara 	ea = iinfo->i_data;
1371da177e4SLinus Torvalds 
13848d6d8ffSMarcin Slusarz 	if (iinfo->i_lenEAttr) {
1391da177e4SLinus Torvalds 		struct extendedAttrHeaderDesc *eahd;
1401da177e4SLinus Torvalds 		eahd = (struct extendedAttrHeaderDesc *)ea;
1411da177e4SLinus Torvalds 
1421da177e4SLinus Torvalds 		/* check checksum/crc */
1435e0f0017SMarcin Slusarz 		if (eahd->descTag.tagIdent !=
1445e0f0017SMarcin Slusarz 				cpu_to_le16(TAG_IDENT_EAHD) ||
1454b11111aSMarcin Slusarz 		    le32_to_cpu(eahd->descTag.tagLocation) !=
14648d6d8ffSMarcin Slusarz 				iinfo->i_location.logicalBlockNum)
1471da177e4SLinus Torvalds 			return NULL;
1481da177e4SLinus Torvalds 
1491da177e4SLinus Torvalds 		if (type < 2048)
1501da177e4SLinus Torvalds 			offset = sizeof(struct extendedAttrHeaderDesc);
1511da177e4SLinus Torvalds 		else if (type < 65536)
1521da177e4SLinus Torvalds 			offset = le32_to_cpu(eahd->impAttrLocation);
1531da177e4SLinus Torvalds 		else
1541da177e4SLinus Torvalds 			offset = le32_to_cpu(eahd->appAttrLocation);
1551da177e4SLinus Torvalds 
15658bc6d1bSStian Skjelstad 		while (offset + sizeof(*gaf) < iinfo->i_lenEAttr) {
15758bc6d1bSStian Skjelstad 			uint32_t attrLength;
15858bc6d1bSStian Skjelstad 
1591da177e4SLinus Torvalds 			gaf = (struct genericFormat *)&ea[offset];
16058bc6d1bSStian Skjelstad 			attrLength = le32_to_cpu(gaf->attrLength);
16158bc6d1bSStian Skjelstad 
16258bc6d1bSStian Skjelstad 			/* Detect undersized elements and buffer overflows */
16358bc6d1bSStian Skjelstad 			if ((attrLength < sizeof(*gaf)) ||
16458bc6d1bSStian Skjelstad 			    (attrLength > (iinfo->i_lenEAttr - offset)))
16558bc6d1bSStian Skjelstad 				break;
16658bc6d1bSStian Skjelstad 
1674b11111aSMarcin Slusarz 			if (le32_to_cpu(gaf->attrType) == type &&
1684b11111aSMarcin Slusarz 					gaf->attrSubtype == subtype)
1691da177e4SLinus Torvalds 				return gaf;
1701da177e4SLinus Torvalds 			else
17158bc6d1bSStian Skjelstad 				offset += attrLength;
1721da177e4SLinus Torvalds 		}
1731da177e4SLinus Torvalds 	}
17428de7948SCyrill Gorcunov 
1751da177e4SLinus Torvalds 	return NULL;
1761da177e4SLinus Torvalds }
1771da177e4SLinus Torvalds 
1781da177e4SLinus Torvalds /*
1791da177e4SLinus Torvalds  * udf_read_tagged
1801da177e4SLinus Torvalds  *
1811da177e4SLinus Torvalds  * PURPOSE
1821da177e4SLinus Torvalds  *	Read the first block of a tagged descriptor.
1831da177e4SLinus Torvalds  *
1841da177e4SLinus Torvalds  * HISTORY
1851da177e4SLinus Torvalds  *	July 1, 1997 - Andrew E. Mileski
1861da177e4SLinus Torvalds  *	Written, tested, and released.
1871da177e4SLinus Torvalds  */
udf_read_tagged(struct super_block * sb,uint32_t block,uint32_t location,uint16_t * ident)188cb00ea35SCyrill Gorcunov struct buffer_head *udf_read_tagged(struct super_block *sb, uint32_t block,
189cb00ea35SCyrill Gorcunov 				    uint32_t location, uint16_t *ident)
1901da177e4SLinus Torvalds {
1915ca4e4beSPekka Enberg 	struct tag *tag_p;
1921da177e4SLinus Torvalds 	struct buffer_head *bh = NULL;
1937e273e3bSJoe Perches 	u8 checksum;
1941da177e4SLinus Torvalds 
1951da177e4SLinus Torvalds 	/* Read the block */
1961da177e4SLinus Torvalds 	if (block == 0xFFFFFFFF)
1971da177e4SLinus Torvalds 		return NULL;
1981da177e4SLinus Torvalds 
199101ee137SJan Kara 	bh = sb_bread(sb, block);
200cb00ea35SCyrill Gorcunov 	if (!bh) {
201fcbf7637SSteve Magnani 		udf_err(sb, "read failed, block=%u, location=%u\n",
202f4bcbbd9SSebastian Manciulea 			block, location);
2031da177e4SLinus Torvalds 		return NULL;
2041da177e4SLinus Torvalds 	}
2051da177e4SLinus Torvalds 
2065ca4e4beSPekka Enberg 	tag_p = (struct tag *)(bh->b_data);
2071da177e4SLinus Torvalds 
2081da177e4SLinus Torvalds 	*ident = le16_to_cpu(tag_p->tagIdent);
2091da177e4SLinus Torvalds 
210cb00ea35SCyrill Gorcunov 	if (location != le32_to_cpu(tag_p->tagLocation)) {
2111da177e4SLinus Torvalds 		udf_debug("location mismatch block %u, tag %u != %u\n",
212f4bcbbd9SSebastian Manciulea 			  block, le32_to_cpu(tag_p->tagLocation), location);
2131da177e4SLinus Torvalds 		goto error_out;
2141da177e4SLinus Torvalds 	}
2151da177e4SLinus Torvalds 
2161da177e4SLinus Torvalds 	/* Verify the tag checksum */
2177e273e3bSJoe Perches 	checksum = udf_tag_checksum(tag_p);
2187e273e3bSJoe Perches 	if (checksum != tag_p->tagChecksum) {
2198076c363SJoe Perches 		udf_err(sb, "tag checksum failed, block %u: 0x%02x != 0x%02x\n",
2207e273e3bSJoe Perches 			block, checksum, tag_p->tagChecksum);
2211da177e4SLinus Torvalds 		goto error_out;
2221da177e4SLinus Torvalds 	}
2231da177e4SLinus Torvalds 
2241da177e4SLinus Torvalds 	/* Verify the tag version */
2255e0f0017SMarcin Slusarz 	if (tag_p->descVersion != cpu_to_le16(0x0002U) &&
2265e0f0017SMarcin Slusarz 	    tag_p->descVersion != cpu_to_le16(0x0003U)) {
2278076c363SJoe Perches 		udf_err(sb, "tag version 0x%04x != 0x0002 || 0x0003, block %u\n",
2281da177e4SLinus Torvalds 			le16_to_cpu(tag_p->descVersion), block);
2291da177e4SLinus Torvalds 		goto error_out;
2301da177e4SLinus Torvalds 	}
2311da177e4SLinus Torvalds 
2321da177e4SLinus Torvalds 	/* Verify the descriptor CRC */
2335ca4e4beSPekka Enberg 	if (le16_to_cpu(tag_p->descCRCLength) + sizeof(struct tag) > sb->s_blocksize ||
234f845fcedSBob Copeland 	    le16_to_cpu(tag_p->descCRC) == crc_itu_t(0,
2355ca4e4beSPekka Enberg 					bh->b_data + sizeof(struct tag),
236f845fcedSBob Copeland 					le16_to_cpu(tag_p->descCRCLength)))
2371da177e4SLinus Torvalds 		return bh;
2384b11111aSMarcin Slusarz 
239fcbf7637SSteve Magnani 	udf_debug("Crc failure block %u: crc = %u, crclen = %u\n", block,
2408076c363SJoe Perches 		  le16_to_cpu(tag_p->descCRC),
2418076c363SJoe Perches 		  le16_to_cpu(tag_p->descCRCLength));
2421da177e4SLinus Torvalds error_out:
2431da177e4SLinus Torvalds 	brelse(bh);
2441da177e4SLinus Torvalds 	return NULL;
2451da177e4SLinus Torvalds }
2461da177e4SLinus Torvalds 
udf_read_ptagged(struct super_block * sb,struct kernel_lb_addr * loc,uint32_t offset,uint16_t * ident)24797e961fdSPekka Enberg struct buffer_head *udf_read_ptagged(struct super_block *sb,
24897e961fdSPekka Enberg 				     struct kernel_lb_addr *loc,
249cb00ea35SCyrill Gorcunov 				     uint32_t offset, uint16_t *ident)
2501da177e4SLinus Torvalds {
2511da177e4SLinus Torvalds 	return udf_read_tagged(sb, udf_get_lb_pblock(sb, loc, offset),
25297e961fdSPekka Enberg 			       loc->logicalBlockNum + offset, ident);
2531da177e4SLinus Torvalds }
2541da177e4SLinus Torvalds 
udf_update_tag(char * data,int length)2551da177e4SLinus Torvalds void udf_update_tag(char *data, int length)
2561da177e4SLinus Torvalds {
2575ca4e4beSPekka Enberg 	struct tag *tptr = (struct tag *)data;
2585ca4e4beSPekka Enberg 	length -= sizeof(struct tag);
2591da177e4SLinus Torvalds 
2601da177e4SLinus Torvalds 	tptr->descCRCLength = cpu_to_le16(length);
2615ca4e4beSPekka Enberg 	tptr->descCRC = cpu_to_le16(crc_itu_t(0, data + sizeof(struct tag), length));
2623f2587bbSMarcin Slusarz 	tptr->tagChecksum = udf_tag_checksum(tptr);
2631da177e4SLinus Torvalds }
2641da177e4SLinus Torvalds 
udf_new_tag(char * data,uint16_t ident,uint16_t version,uint16_t snum,uint32_t loc,int length)2651da177e4SLinus Torvalds void udf_new_tag(char *data, uint16_t ident, uint16_t version, uint16_t snum,
2661da177e4SLinus Torvalds 		 uint32_t loc, int length)
2671da177e4SLinus Torvalds {
2685ca4e4beSPekka Enberg 	struct tag *tptr = (struct tag *)data;
2691da177e4SLinus Torvalds 	tptr->tagIdent = cpu_to_le16(ident);
2701da177e4SLinus Torvalds 	tptr->descVersion = cpu_to_le16(version);
2711da177e4SLinus Torvalds 	tptr->tagSerialNum = cpu_to_le16(snum);
2721da177e4SLinus Torvalds 	tptr->tagLocation = cpu_to_le32(loc);
2731da177e4SLinus Torvalds 	udf_update_tag(data, length);
2741da177e4SLinus Torvalds }
2753f2587bbSMarcin Slusarz 
udf_tag_checksum(const struct tag * t)2765ca4e4beSPekka Enberg u8 udf_tag_checksum(const struct tag *t)
2773f2587bbSMarcin Slusarz {
2783f2587bbSMarcin Slusarz 	u8 *data = (u8 *)t;
2793f2587bbSMarcin Slusarz 	u8 checksum = 0;
2803f2587bbSMarcin Slusarz 	int i;
2815ca4e4beSPekka Enberg 	for (i = 0; i < sizeof(struct tag); ++i)
2823f2587bbSMarcin Slusarz 		if (i != 4) /* position of checksum */
2833f2587bbSMarcin Slusarz 			checksum += data[i];
2843f2587bbSMarcin Slusarz 	return checksum;
2853f2587bbSMarcin Slusarz }
286