/* SPDX-License-Identifier: GPL-2.0 */


#ifndef _HFS_COMMON_H_
#define _HFS_COMMON_H_

#ifdef pr_fmt
#undef pr_fmt
#endif

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#define hfs_dbg(fmt, ...)							\
	pr_debug("pid %d:%s:%d %s(): " fmt,					\
		 current->pid, __FILE__, __LINE__, __func__, ##__VA_ARGS__)	\




#define HFS_DD_BLK			0	
#define HFS_PMAP_BLK			1	
#define HFS_MDB_BLK			2	


#define HFS_DRVR_DESC_MAGIC		0x4552	
#define HFS_OLD_PMAP_MAGIC		0x5453	
#define HFS_NEW_PMAP_MAGIC		0x504D	
#define HFS_SUPER_MAGIC			0x4244	
#define HFS_MFS_SUPER_MAGIC		0xD2D7	

#define HFSPLUS_VOLHEAD_SIG		0x482b
#define HFSPLUS_VOLHEAD_SIGX		0x4858
#define HFSPLUS_SUPER_MAGIC		0x482b

#define HFSP_WRAP_MAGIC			0x4244
#define HFSP_WRAP_ATTRIB_SLOCK		0x8000
#define HFSP_WRAP_ATTRIB_SPARED		0x0200

#define HFSP_WRAPOFF_SIG		0x00
#define HFSP_WRAPOFF_ATTRIB		0x0A
#define HFSP_WRAPOFF_ABLKSIZE		0x14
#define HFSP_WRAPOFF_ABLKSTART		0x1C
#define HFSP_WRAPOFF_EMBEDSIG		0x7C
#define HFSP_WRAPOFF_EMBEDEXT		0x7E

#define HFSP_HARDLINK_TYPE		0x686c6e6b	
#define HFSP_HFSPLUS_CREATOR		0x6866732b	

#define HFSP_SYMLINK_TYPE		0x736c6e6b	
#define HFSP_SYMLINK_CREATOR		0x72686170	

#define HFSP_MOUNT_VERSION		0x482b4c78	

#define HFSP_HIDDENDIR_NAME \
	"\xe2\x90\x80\xe2\x90\x80\xe2\x90\x80\xe2\x90\x80HFS+ Private Data"


#define HFS_SECTOR_SIZE			512	
#define HFS_SECTOR_SIZE_BITS		9	
#define HFS_MAX_VALENCE			32767U

#define HFSPLUS_SECTOR_SIZE		HFS_SECTOR_SIZE
#define HFSPLUS_SECTOR_SHIFT		HFS_SECTOR_SIZE_BITS
#define HFSPLUS_VOLHEAD_SECTOR		2
#define HFSPLUS_MIN_VERSION		4
#define HFSPLUS_CURRENT_VERSION		5

#define HFS_NAMELEN			31	
#define HFS_MAX_NAMELEN			128

#define HFSPLUS_MAX_STRLEN		255
#define HFSPLUS_ATTR_MAX_STRLEN		127


#define HFS_SB_ATTRIB_HLOCK	(1 << 7)
#define HFS_SB_ATTRIB_UNMNT	(1 << 8)
#define HFS_SB_ATTRIB_SPARED	(1 << 9)
#define HFS_SB_ATTRIB_INCNSTNT	(1 << 11)
#define HFS_SB_ATTRIB_SLOCK	(1 << 15)


#define HFS_CDR_DIR		0x01	
#define HFS_CDR_FIL		0x02	
#define HFS_CDR_THD		0x03	
#define HFS_CDR_FTH		0x04	


#define HFS_FK_DATA		0x00
#define HFS_FK_RSRC		0xFF


#define HFS_FIL_LOCK		0x01	
#define HFS_FIL_THD		0x02	
#define HFS_FIL_DOPEN		0x04	
#define HFS_FIL_ROPEN		0x08	
#define HFS_FIL_DIR		0x10	
#define HFS_FIL_NOCOPY		0x40	
#define HFS_FIL_USED		0x80	


#define HFS_DIR_LOCK		0x01	
#define HFS_DIR_THD		0x02	
#define HFS_DIR_INEXPFOLDER	0x04	
#define HFS_DIR_MOUNTED		0x08	
#define HFS_DIR_DIR		0x10	
#define HFS_DIR_EXPFOLDER	0x20	


#define HFS_FLG_INITED		0x0100
#define HFS_FLG_LOCKED		0x1000
#define HFS_FLG_INVISIBLE	0x4000


#define HFS_POR_CNID		1	
#define HFSPLUS_POR_CNID	HFS_POR_CNID
#define HFS_ROOT_CNID		2	
#define HFSPLUS_ROOT_CNID	HFS_ROOT_CNID
#define HFS_EXT_CNID		3	
#define HFSPLUS_EXT_CNID	HFS_EXT_CNID
#define HFS_CAT_CNID		4	
#define HFSPLUS_CAT_CNID	HFS_CAT_CNID
#define HFS_BAD_CNID		5	
#define HFSPLUS_BAD_CNID	HFS_BAD_CNID
#define HFS_ALLOC_CNID		6	
#define HFSPLUS_ALLOC_CNID	HFS_ALLOC_CNID
#define HFS_START_CNID		7	
#define HFSPLUS_START_CNID	HFS_START_CNID
#define HFS_ATTR_CNID		8	
#define HFSPLUS_ATTR_CNID	HFS_ATTR_CNID
#define HFS_EXCH_CNID		15	
#define HFSPLUS_EXCH_CNID	HFS_EXCH_CNID
#define HFS_FIRSTUSER_CNID	16	
#define HFSPLUS_FIRSTUSER_CNID	HFS_FIRSTUSER_CNID



typedef __be32 hfsplus_cnid;
typedef __be16 hfsplus_unichr;


struct hfs_name {
	u8 len;
	u8 name[HFS_NAMELEN];
} __packed;


struct hfsplus_unistr {
	__be16 length;
	hfsplus_unichr unicode[HFSPLUS_MAX_STRLEN];
} __packed;


struct hfsplus_attr_unistr {
	__be16 length;
	hfsplus_unichr unicode[HFSPLUS_ATTR_MAX_STRLEN];
} __packed;

struct hfs_extent {
	__be16 block;
	__be16 count;
};
typedef struct hfs_extent hfs_extent_rec[3];


struct hfsplus_extent {
	__be32 start_block;
	__be32 block_count;
} __packed;
typedef struct hfsplus_extent hfsplus_extent_rec[8];


struct hfsplus_fork_raw {
	__be64 total_size;
	__be32 clump_size;
	__be32 total_blocks;
	hfsplus_extent_rec extents;
} __packed;

struct hfs_mdb {
	__be16 drSigWord;		
	__be32 drCrDate;		
	__be32 drLsMod;			
	__be16 drAtrb;			
	__be16 drNmFls;			
	__be16 drVBMSt;			
	__be16 drAllocPtr;		
	__be16 drNmAlBlks;		
	__be32 drAlBlkSiz;		
	__be32 drClpSiz;		
	__be16 drAlBlSt;		
	__be32 drNxtCNID;		
	__be16 drFreeBks;		
	u8 drVN[28];			
	__be32 drVolBkUp;		
	__be16 drVSeqNum;		
	__be32 drWrCnt;			
	__be32 drXTClpSiz;		
	__be32 drCTClpSiz;		
	__be16 drNmRtDirs;		
	__be32 drFilCnt;		
	__be32 drDirCnt;		
	u8 drFndrInfo[32];		
	__be16 drEmbedSigWord;		
	__be32 drEmbedExtent;		
	__be32 drXTFlSize;		
	hfs_extent_rec drXTExtRec;	
	__be32 drCTFlSize;		
	hfs_extent_rec drCTExtRec;	
} __packed;


struct hfsplus_vh {
	__be16 signature;
	__be16 version;
	__be32 attributes;
	__be32 last_mount_vers;
	u32 reserved;

	__be32 create_date;
	__be32 modify_date;
	__be32 backup_date;
	__be32 checked_date;

	__be32 file_count;
	__be32 folder_count;

	__be32 blocksize;
	__be32 total_blocks;
	__be32 free_blocks;

	__be32 next_alloc;
	__be32 rsrc_clump_sz;
	__be32 data_clump_sz;
	hfsplus_cnid next_cnid;

	__be32 write_count;
	__be64 encodings_bmp;

	u32 finder_info[8];

	struct hfsplus_fork_raw alloc_file;
	struct hfsplus_fork_raw ext_file;
	struct hfsplus_fork_raw cat_file;
	struct hfsplus_fork_raw attr_file;
	struct hfsplus_fork_raw start_file;
} __packed;


#define HFSPLUS_VOL_UNMNT		(1 << 8)
#define HFSPLUS_VOL_SPARE_BLK		(1 << 9)
#define HFSPLUS_VOL_NOCACHE		(1 << 10)
#define HFSPLUS_VOL_INCNSTNT		(1 << 11)
#define HFSPLUS_VOL_NODEID_REUSED	(1 << 12)
#define HFSPLUS_VOL_JOURNALED		(1 << 13)
#define HFSPLUS_VOL_SOFTLOCK		(1 << 15)
#define HFSPLUS_VOL_UNUSED_NODE_FIX	(1 << 31)

struct hfs_point {
	__be16 v;
	__be16 h;
} __packed;

typedef struct hfs_point hfsp_point;

struct hfs_rect {
	__be16 top;
	__be16 left;
	__be16 bottom;
	__be16 right;
} __packed;

typedef struct hfs_rect hfsp_rect;

struct hfs_finfo {
	__be32 fdType;
	__be32 fdCreator;
	__be16 fdFlags;
	struct hfs_point fdLocation;
	__be16 fdFldr;
} __packed;

typedef struct hfs_finfo FInfo;

struct hfs_fxinfo {
	__be16 fdIconID;
	u8 fdUnused[8];
	__be16 fdComment;
	__be32 fdPutAway;
} __packed;

typedef struct hfs_fxinfo FXInfo;

struct hfs_dinfo {
	struct hfs_rect frRect;
	__be16 frFlags;
	struct hfs_point frLocation;
	__be16 frView;
} __packed;

typedef struct hfs_dinfo DInfo;

struct hfs_dxinfo {
	struct hfs_point frScroll;
	__be32 frOpenChain;
	__be16 frUnused;
	__be16 frComment;
	__be32 frPutAway;
} __packed;

typedef struct hfs_dxinfo DXInfo;

union hfs_finder_info {
	struct {
		struct hfs_finfo finfo;
		struct hfs_fxinfo fxinfo;
	} file;
	struct {
		struct hfs_dinfo dinfo;
		struct hfs_dxinfo dxinfo;
	} dir;
} __packed;


struct hfs_cat_key {
	u8 key_len;		
	u8 reserved;		
	__be32 ParID;		
	struct hfs_name	CName;	
} __packed;


struct hfsplus_cat_key {
	__be16 key_len;
	hfsplus_cnid parent;
	struct hfsplus_unistr name;
} __packed;

#define HFSPLUS_CAT_KEYLEN	(sizeof(struct hfsplus_cat_key))


struct hfs_ext_key {
	u8 key_len;		
	u8 FkType;		
	__be32 FNum;		
	__be16 FABN;		
} __packed;


struct hfsplus_ext_key {
	__be16 key_len;
	u8 fork_type;
	u8 pad;
	hfsplus_cnid cnid;
	__be32 start_block;
} __packed;

#define HFSPLUS_EXT_KEYLEN	sizeof(struct hfsplus_ext_key)

typedef union hfs_btree_key {
	u8 key_len;			
	struct hfs_cat_key cat;
	struct hfs_ext_key ext;
} hfs_btree_key;

#define HFS_MAX_CAT_KEYLEN	(sizeof(struct hfs_cat_key) - sizeof(u8))
#define HFS_MAX_EXT_KEYLEN	(sizeof(struct hfs_ext_key) - sizeof(u8))

typedef union hfs_btree_key btree_key;


struct hfs_cat_file {
	s8 type;			
	u8 reserved;
	u8 Flags;			
	s8 Typ;				
	struct hfs_finfo UsrWds;	
	__be32 FlNum;			
	__be16 StBlk;			
	__be32 LgLen;			
	__be32 PyLen;			
	__be16 RStBlk;			
	__be32 RLgLen;			
	__be32 RPyLen;			
	__be32 CrDat;			
	__be32 MdDat;			
	__be32 BkDat;			
	struct hfs_fxinfo FndrInfo;	
	__be16 ClpSize;			
	hfs_extent_rec ExtRec;		
	hfs_extent_rec RExtRec;		
	u32 Resrv;			
} __packed;


struct hfs_cat_dir {
	s8 type;			
	u8 reserved;
	__be16 Flags;			
	__be16 Val;			
	__be32 DirID;			
	__be32 CrDat;			
	__be32 MdDat;			
	__be32 BkDat;			
	struct hfs_dinfo UsrInfo;	
	struct hfs_dxinfo FndrInfo;	
	u8 Resrv[16];			
} __packed;


struct hfs_cat_thread {
	s8 type;			
	u8 reserved[9];			
	__be32 ParID;			
	struct hfs_name CName;		
}  __packed;


typedef union hfs_cat_rec {
	s8 type;			
	struct hfs_cat_file file;
	struct hfs_cat_dir dir;
	struct hfs_cat_thread thread;
} hfs_cat_rec;


struct hfsplus_perm {
	__be32 owner;
	__be32 group;
	u8  rootflags;
	u8  userflags;
	__be16 mode;
	__be32 dev;
} __packed;

#define HFSPLUS_FLG_NODUMP	0x01
#define HFSPLUS_FLG_IMMUTABLE	0x02
#define HFSPLUS_FLG_APPEND	0x04


struct hfs_bnode_desc {
	__be32 next;		
	__be32 prev;		
	u8 type;		
	u8 height;		
	__be16 num_recs;	
	u16 reserved;
} __packed;


#define HFS_NODE_INDEX	0x00	
#define HFS_NODE_HEADER	0x01	
#define HFS_NODE_MAP	0x02	
#define HFS_NODE_LEAF	0xFF	


struct hfs_btree_header_rec {
	__be16 depth;		
	__be32 root;		
	__be32 leaf_count;	
	__be32 leaf_head;	
	__be32 leaf_tail;	
	__be16 node_size;	
	__be16 max_key_len;	
	__be32 node_count;	
	__be32 free_nodes;	
	u16 reserved1;
	__be32 clump_size;	
	u8 btree_type;		
	u8 key_type;
	__be32 attributes;	
	u32 reserved3[16];
} __packed;


#define BTREE_ATTR_BADCLOSE	0x00000001	
#define HFS_TREE_BIGKEYS	0x00000002	
#define HFS_TREE_VARIDXKEYS	0x00000004	


#define HFSPLUS_TREE_HEAD			0
#define HFSPLUS_NODE_MXSZ			32768
#define HFSPLUS_ATTR_TREE_NODE_SIZE		8192
#define HFSPLUS_BTREE_HDR_NODE_RECS_COUNT	3
#define HFSPLUS_BTREE_HDR_USER_BYTES		128


#define HFSPLUS_KEY_CASEFOLDING		0xCF	
#define HFSPLUS_KEY_BINARY		0xBC	


struct hfsplus_cat_folder {
	__be16 type;
	__be16 flags;
	__be32 valence;
	hfsplus_cnid id;
	__be32 create_date;
	__be32 content_mod_date;
	__be32 attribute_mod_date;
	__be32 access_date;
	__be32 backup_date;
	struct hfsplus_perm permissions;
	struct_group_attr(info, __packed,
		DInfo user_info;
		DXInfo finder_info;
	);
	__be32 text_encoding;
	__be32 subfolders;	
} __packed;


struct hfsplus_cat_file {
	__be16 type;
	__be16 flags;
	u32 reserved1;
	hfsplus_cnid id;
	__be32 create_date;
	__be32 content_mod_date;
	__be32 attribute_mod_date;
	__be32 access_date;
	__be32 backup_date;
	struct hfsplus_perm permissions;
	struct_group_attr(info, __packed,
		FInfo user_info;
		FXInfo finder_info;
	);
	__be32 text_encoding;
	u32 reserved2;

	struct hfsplus_fork_raw data_fork;
	struct hfsplus_fork_raw rsrc_fork;
} __packed;


#define HFSPLUS_FILE_LOCKED		0x0001
#define HFSPLUS_FILE_THREAD_EXISTS	0x0002
#define HFSPLUS_XATTR_EXISTS		0x0004
#define HFSPLUS_ACL_EXISTS		0x0008
#define HFSPLUS_HAS_FOLDER_COUNT	0x0010	


struct hfsplus_cat_thread {
	__be16 type;
	s16 reserved;
	hfsplus_cnid parentID;
	struct hfsplus_unistr nodeName;
} __packed;

#define HFSPLUS_MIN_THREAD_SZ		10


typedef union {
	__be16 type;
	struct hfsplus_cat_folder folder;
	struct hfsplus_cat_file file;
	struct hfsplus_cat_thread thread;
} __packed hfsplus_cat_entry;


#define HFSPLUS_FOLDER		0x0001
#define HFSPLUS_FILE		0x0002
#define HFSPLUS_FOLDER_THREAD	0x0003
#define HFSPLUS_FILE_THREAD	0x0004

#define HFSPLUS_XATTR_FINDER_INFO_NAME	"com.apple.FinderInfo"
#define HFSPLUS_XATTR_ACL_NAME		"com.apple.system.Security"

#define HFSPLUS_ATTR_INLINE_DATA	0x10
#define HFSPLUS_ATTR_FORK_DATA		0x20
#define HFSPLUS_ATTR_EXTENTS		0x30


struct hfsplus_attr_key {
	__be16 key_len;
	__be16 pad;
	hfsplus_cnid cnid;
	__be32 start_block;
	struct hfsplus_attr_unistr key_name;
} __packed;

#define HFSPLUS_ATTR_KEYLEN	sizeof(struct hfsplus_attr_key)


struct hfsplus_attr_fork_data {
	__be32 record_type;
	__be32 reserved;
	struct hfsplus_fork_raw the_fork;
} __packed;


struct hfsplus_attr_extents {
	__be32 record_type;
	__be32 reserved;
	struct hfsplus_extent extents;
} __packed;

#define HFSPLUS_MAX_INLINE_DATA_SIZE	3802


struct hfsplus_attr_inline_data {
	__be32 record_type;
	__be32 reserved1;
	u8 reserved2[6];
	__be16 length;
	u8 raw_bytes[HFSPLUS_MAX_INLINE_DATA_SIZE];
} __packed;


typedef union {
	__be32 record_type;
	struct hfsplus_attr_fork_data fork_data;
	struct hfsplus_attr_extents extents;
	struct hfsplus_attr_inline_data inline_data;
} __packed hfsplus_attr_entry;


typedef union {
	__be16 key_len;
	struct hfsplus_cat_key cat;
	struct hfsplus_ext_key ext;
	struct hfsplus_attr_key attr;
} __packed hfsplus_btree_key;

#endif 
