[thirdparty/kernel/linux.git] / fs / udf / udfdecl.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __UDF_DECL_H
#define __UDF_DECL_H

#define pr_fmt(fmt) "UDF-fs: " fmt

#include "ecma_167.h"
#include "osta_udf.h"

#include <linux/fs.h>
#include <linux/types.h>
#include <linux/buffer_head.h>
#include <linux/udf_fs_i.h>

#include "udf_sb.h"
#include "udfend.h"
#include "udf_i.h"

#define UDF_DEFAULT_PREALLOC_BLOCKS	8

extern __printf(3, 4) void _udf_err(struct super_block *sb,
		const char *function, const char *fmt, ...);
#define udf_err(sb, fmt, ...)					\
	_udf_err(sb, __func__, fmt, ##__VA_ARGS__)

extern __printf(3, 4) void _udf_warn(struct super_block *sb,
		const char *function, const char *fmt, ...);
#define udf_warn(sb, fmt, ...)					\
	_udf_warn(sb, __func__, fmt, ##__VA_ARGS__)

#define udf_info(fmt, ...)					\
	pr_info("INFO " fmt, ##__VA_ARGS__)

#undef UDFFS_DEBUG

#ifdef UDFFS_DEBUG
#define udf_debug(fmt, ...)					\
	printk(KERN_DEBUG pr_fmt("%s:%d:%s: " fmt),		\
	       __FILE__, __LINE__, __func__, ##__VA_ARGS__)
#else
#define udf_debug(fmt, ...)					\
	no_printk(fmt, ##__VA_ARGS__)
#endif

#define udf_fixed_to_variable(x) ( ( ( (x) >> 5 ) * 39 ) + ( (x) & 0x0000001F ) )
#define udf_variable_to_fixed(x) ( ( ( (x) / 39 ) << 5 ) + ( (x) % 39 ) )

#define UDF_EXTENT_LENGTH_MASK	0x3FFFFFFF
#define UDF_EXTENT_FLAG_MASK	0xC0000000

#define UDF_NAME_PAD		4
#define UDF_NAME_LEN		254
#define UDF_NAME_LEN_CS0	255

static inline size_t udf_file_entry_alloc_offset(struct inode *inode)
{
	struct udf_inode_info *iinfo = UDF_I(inode);
	if (iinfo->i_use)
		return sizeof(struct unallocSpaceEntry);
	else if (iinfo->i_efe)
		return sizeof(struct extendedFileEntry) + iinfo->i_lenEAttr;
	else
		return sizeof(struct fileEntry) + iinfo->i_lenEAttr;
}

static inline size_t udf_ext0_offset(struct inode *inode)
{
	if (UDF_I(inode)->i_alloc_type == ICBTAG_FLAG_AD_IN_ICB)
		return udf_file_entry_alloc_offset(inode);
	else
		return 0;
}

/* computes tag checksum */
u8 udf_tag_checksum(const struct tag *t);

struct dentry;
struct inode;
struct task_struct;
struct buffer_head;
struct super_block;

extern const struct export_operations udf_export_ops;
extern const struct inode_operations udf_dir_inode_operations;
extern const struct file_operations udf_dir_operations;
extern const struct inode_operations udf_file_inode_operations;
extern const struct file_operations udf_file_operations;
extern const struct inode_operations udf_symlink_inode_operations;
extern const struct address_space_operations udf_aops;
extern const struct address_space_operations udf_adinicb_aops;
extern const struct address_space_operations udf_symlink_aops;

struct udf_fileident_bh {
	struct buffer_head *sbh;
	struct buffer_head *ebh;
	int soffset;
	int eoffset;
};

struct udf_vds_record {
	uint32_t block;
	uint32_t volDescSeqNum;
};

struct generic_desc {
	struct tag	descTag;
	__le32		volDescSeqNum;
};


/* super.c */

static inline void udf_updated_lvid(struct super_block *sb)
{
	struct buffer_head *bh = UDF_SB(sb)->s_lvid_bh;

	BUG_ON(!bh);
	WARN_ON_ONCE(((struct logicalVolIntegrityDesc *)
		     bh->b_data)->integrityType !=
		     cpu_to_le32(LVID_INTEGRITY_TYPE_OPEN));
	UDF_SB(sb)->s_lvid_dirty = 1;
}
extern u64 lvid_get_unique_id(struct super_block *sb);
struct inode *udf_find_metadata_inode_efe(struct super_block *sb,
					u32 meta_file_loc, u32 partition_num);

/* namei.c */
extern int udf_write_fi(struct inode *inode, struct fileIdentDesc *,
			struct fileIdentDesc *, struct udf_fileident_bh *,
			uint8_t *, uint8_t *);

/* file.c */
extern long udf_ioctl(struct file *, unsigned int, unsigned long);
/* inode.c */
extern struct inode *__udf_iget(struct super_block *, struct kernel_lb_addr *,
				bool hidden_inode);
static inline struct inode *udf_iget_special(struct super_block *sb,
					     struct kernel_lb_addr *ino)
{
	return __udf_iget(sb, ino, true);
}
static inline struct inode *udf_iget(struct super_block *sb,
				     struct kernel_lb_addr *ino)
{
	return __udf_iget(sb, ino, false);
}
extern int udf_expand_file_adinicb(struct inode *);
extern struct buffer_head *udf_expand_dir_adinicb(struct inode *, int *, int *);
extern struct buffer_head *udf_bread(struct inode *, int, int, int *);
extern int udf_setsize(struct inode *, loff_t);
extern void udf_evict_inode(struct inode *);
extern int udf_write_inode(struct inode *, struct writeback_control *wbc);
extern long udf_block_map(struct inode *, sector_t);
extern int8_t inode_bmap(struct inode *, sector_t, struct extent_position *,
			 struct kernel_lb_addr *, uint32_t *, sector_t *);
extern int udf_setup_indirect_aext(struct inode *inode, int block,
				   struct extent_position *epos);
extern int __udf_add_aext(struct inode *inode, struct extent_position *epos,
			  struct kernel_lb_addr *eloc, uint32_t elen, int inc);
extern int udf_add_aext(struct inode *, struct extent_position *,
			struct kernel_lb_addr *, uint32_t, int);
extern void udf_write_aext(struct inode *, struct extent_position *,
			   struct kernel_lb_addr *, uint32_t, int);
extern int8_t udf_delete_aext(struct inode *, struct extent_position,
			      struct kernel_lb_addr, uint32_t);
extern int8_t udf_next_aext(struct inode *, struct extent_position *,
			    struct kernel_lb_addr *, uint32_t *, int);
extern int8_t udf_current_aext(struct inode *, struct extent_position *,
			       struct kernel_lb_addr *, uint32_t *, int);

/* misc.c */
extern struct buffer_head *udf_tgetblk(struct super_block *, int);
extern struct buffer_head *udf_tread(struct super_block *, int);
extern struct genericFormat *udf_add_extendedattr(struct inode *, uint32_t,
						  uint32_t, uint8_t);
extern struct genericFormat *udf_get_extendedattr(struct inode *, uint32_t,
						  uint8_t);
extern struct buffer_head *udf_read_tagged(struct super_block *, uint32_t,
					   uint32_t, uint16_t *);
extern struct buffer_head *udf_read_ptagged(struct super_block *,
					    struct kernel_lb_addr *, uint32_t,
					    uint16_t *);
extern void udf_update_tag(char *, int);
extern void udf_new_tag(char *, uint16_t, uint16_t, uint16_t, uint32_t, int);

/* lowlevel.c */
extern unsigned int udf_get_last_session(struct super_block *);
extern unsigned long udf_get_last_block(struct super_block *);

/* partition.c */
extern uint32_t udf_get_pblock(struct super_block *, uint32_t, uint16_t,
			       uint32_t);
extern uint32_t udf_get_pblock_virt15(struct super_block *, uint32_t, uint16_t,
				      uint32_t);
extern uint32_t udf_get_pblock_virt20(struct super_block *, uint32_t, uint16_t,
				      uint32_t);
extern uint32_t udf_get_pblock_spar15(struct super_block *, uint32_t, uint16_t,
				      uint32_t);
extern uint32_t udf_get_pblock_meta25(struct super_block *, uint32_t, uint16_t,
					  uint32_t);
extern int udf_relocate_blocks(struct super_block *, long, long *);

static inline uint32_t
udf_get_lb_pblock(struct super_block *sb, struct kernel_lb_addr *loc,
		  uint32_t offset)
{
	return udf_get_pblock(sb, loc->logicalBlockNum,
			loc->partitionReferenceNum, offset);
}

/* unicode.c */
extern int udf_get_filename(struct super_block *, const uint8_t *, int,
			    uint8_t *, int);
extern int udf_put_filename(struct super_block *, const uint8_t *, int,
			    uint8_t *, int);
extern int udf_dstrCS0toUTF8(uint8_t *, int, const uint8_t *, int);

/* ialloc.c */
extern void udf_free_inode(struct inode *);
extern struct inode *udf_new_inode(struct inode *, umode_t);

/* truncate.c */
extern void udf_truncate_tail_extent(struct inode *);
extern void udf_discard_prealloc(struct inode *);
extern void udf_truncate_extents(struct inode *);

/* balloc.c */
extern void udf_free_blocks(struct super_block *, struct inode *,
			    struct kernel_lb_addr *, uint32_t, uint32_t);
extern int udf_prealloc_blocks(struct super_block *, struct inode *, uint16_t,
			       uint32_t, uint32_t);
extern int udf_new_block(struct super_block *, struct inode *, uint16_t,
			 uint32_t, int *);

/* directory.c */
extern struct fileIdentDesc *udf_fileident_read(struct inode *, loff_t *,
						struct udf_fileident_bh *,
						struct fileIdentDesc *,
						struct extent_position *,
						struct kernel_lb_addr *, uint32_t *,
						sector_t *);
extern struct fileIdentDesc *udf_get_fileident(void *buffer, int bufsize,
					       int *offset);
extern struct long_ad *udf_get_filelongad(uint8_t *, int, uint32_t *, int);
extern struct short_ad *udf_get_fileshortad(uint8_t *, int, uint32_t *, int);

/* udftime.c */
extern struct timespec *udf_disk_stamp_to_time(struct timespec *dest,
						struct timestamp src);
extern struct timestamp *udf_time_to_disk_stamp(struct timestamp *dest, struct timespec src);

#endif				/* __UDF_DECL_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef __UDF_DECL_H
	3	#define __UDF_DECL_H
	4
78ace70c JP	5	#define pr_fmt(fmt) "UDF-fs: " fmt
78ace70c JP	6
1da177e4 LT	7	#include "ecma_167.h"
	8	#include "osta_udf.h"
	9
	10	#include <linux/fs.h>
1da177e4	11	#include <linux/types.h>
1da177e4	12	#include <linux/buffer_head.h>
15aebd28	13	#include <linux/udf_fs_i.h>
1da177e4	14
15aebd28	15	#include "udf_sb.h"
1da177e4	16	#include "udfend.h"
d652eefb	17	#include "udf_i.h"
1da177e4	18
15aebd28 CH	19	#define UDF_DEFAULT_PREALLOC_BLOCKS 8
15aebd28 CH	20
34116645 LT	21	extern __printf(3, 4) void _udf_err(struct super_block *sb,
34116645 LT	22	const char function, const char fmt, ...);
78ace70c JP	23	#define udf_err(sb, fmt, ...) \
78ace70c JP	24	_udf_err(sb, __func__, fmt, ##__VA_ARGS__)
15aebd28	25
34116645 LT	26	extern __printf(3, 4) void _udf_warn(struct super_block *sb,
34116645 LT	27	const char function, const char fmt, ...);
a40ecd7b JP	28	#define udf_warn(sb, fmt, ...) \
a40ecd7b JP	29	_udf_warn(sb, __func__, fmt, ##__VA_ARGS__)
7e273e3b	30
78ace70c JP	31	#define udf_info(fmt, ...) \
78ace70c JP	32	pr_info("INFO " fmt, ##__VA_ARGS__)
7e273e3b	33
e4f3ec06	34	#undef UDFFS_DEBUG
15aebd28 CH	35
15aebd28 CH	36	#ifdef UDFFS_DEBUG
78ace70c JP	37	#define udf_debug(fmt, ...) \
	38	printk(KERN_DEBUG pr_fmt("%s:%d:%s: " fmt), \
	39	__FILE__, __LINE__, __func__, ##__VA_ARGS__)
15aebd28	40	#else
78ace70c JP	41	#define udf_debug(fmt, ...) \
78ace70c JP	42	no_printk(fmt, ##__VA_ARGS__)
15aebd28 CH	43	#endif
15aebd28 CH	44
1da177e4 LT	45	#define udf_fixed_to_variable(x) ( ( ( (x) >> 5 ) * 39 ) + ( (x) & 0x0000001F ) )
	46	#define udf_variable_to_fixed(x) ( ( ( (x) / 39 ) << 5 ) + ( (x) % 39 ) )
	47
	48	#define UDF_EXTENT_LENGTH_MASK 0x3FFFFFFF
	49	#define UDF_EXTENT_FLAG_MASK 0xC0000000
	50
	51	#define UDF_NAME_PAD 4
9fba7056 AG	52	#define UDF_NAME_LEN 254
9fba7056 AG	53	#define UDF_NAME_LEN_CS0 255
1da177e4	54
d652eefb	55	static inline size_t udf_file_entry_alloc_offset(struct inode *inode)
	56	{
	57	struct udf_inode_info *iinfo = UDF_I(inode);
	58	if (iinfo->i_use)
	59	return sizeof(struct unallocSpaceEntry);
	60	else if (iinfo->i_efe)
	61	return sizeof(struct extendedFileEntry) + iinfo->i_lenEAttr;
	62	else
	63	return sizeof(struct fileEntry) + iinfo->i_lenEAttr;
	64	}
	65
	66	static inline size_t udf_ext0_offset(struct inode *inode)
	67	{
	68	if (UDF_I(inode)->i_alloc_type == ICBTAG_FLAG_AD_IN_ICB)
	69	return udf_file_entry_alloc_offset(inode);
	70	else
	71	return 0;
	72	}
1da177e4	73
3f2587bb	74	/* computes tag checksum */
5ca4e4be	75	u8 udf_tag_checksum(const struct tag *t);
3f2587bb	76
1da177e4 LT	77	struct dentry;
	78	struct inode;
	79	struct task_struct;
	80	struct buffer_head;
	81	struct super_block;
	82
221e583a	83	extern const struct export_operations udf_export_ops;
c5ef1c42	84	extern const struct inode_operations udf_dir_inode_operations;
4b6f5d20	85	extern const struct file_operations udf_dir_operations;
c5ef1c42	86	extern const struct inode_operations udf_file_inode_operations;
4b6f5d20	87	extern const struct file_operations udf_file_operations;
ad4d0532	88	extern const struct inode_operations udf_symlink_inode_operations;
f5e54d6e CH	89	extern const struct address_space_operations udf_aops;
	90	extern const struct address_space_operations udf_adinicb_aops;
	91	extern const struct address_space_operations udf_symlink_aops;
1da177e4	92
cb00ea35	93	struct udf_fileident_bh {
1da177e4 LT	94	struct buffer_head *sbh;
	95	struct buffer_head *ebh;
	96	int soffset;
	97	int eoffset;
	98	};
	99
cb00ea35	100	struct udf_vds_record {
1da177e4 LT	101	uint32_t block;
	102	uint32_t volDescSeqNum;
	103	};
	104
cb00ea35	105	struct generic_desc {
5ca4e4be	106	struct tag descTag;
28de7948	107	__le32 volDescSeqNum;
1da177e4 LT	108	};
1da177e4 LT	109
ff116fc8	110
1da177e4	111	/* super.c */
fab3c858	112
146bca72 JK	113	static inline void udf_updated_lvid(struct super_block *sb)
	114	{
	115	struct buffer_head *bh = UDF_SB(sb)->s_lvid_bh;
	116
	117	BUG_ON(!bh);
	118	WARN_ON_ONCE(((struct logicalVolIntegrityDesc *)
	119	bh->b_data)->integrityType !=
	120	cpu_to_le32(LVID_INTEGRITY_TYPE_OPEN));
146bca72 JK	121	UDF_SB(sb)->s_lvid_dirty = 1;
146bca72 JK	122	}
d664b6af	123	extern u64 lvid_get_unique_id(struct super_block *sb);
3080a74e NJ	124	struct inode udf_find_metadata_inode_efe(struct super_block sb,
3080a74e NJ	125	u32 meta_file_loc, u32 partition_num);
1da177e4 LT	126
1da177e4 LT	127	/* namei.c */
cb00ea35 CG	128	extern int udf_write_fi(struct inode inode, struct fileIdentDesc ,
	129	struct fileIdentDesc , struct udf_fileident_bh ,
	130	uint8_t , uint8_t );
1da177e4 LT	131
1da177e4 LT	132	/* file.c */
2f07a88b	133	extern long udf_ioctl(struct file *, unsigned int, unsigned long);
1da177e4	134	/* inode.c */
6174c2eb JK	135	extern struct inode __udf_iget(struct super_block , struct kernel_lb_addr *,
	136	bool hidden_inode);
	137	static inline struct inode udf_iget_special(struct super_block sb,
	138	struct kernel_lb_addr *ino)
	139	{
	140	return __udf_iget(sb, ino, true);
	141	}
	142	static inline struct inode udf_iget(struct super_block sb,
	143	struct kernel_lb_addr *ino)
	144	{
	145	return __udf_iget(sb, ino, false);
	146	}
7e49b6f2	147	extern int udf_expand_file_adinicb(struct inode *);
cb00ea35 CG	148	extern struct buffer_head udf_expand_dir_adinicb(struct inode , int , int );
cb00ea35 CG	149	extern struct buffer_head udf_bread(struct inode , int, int, int *);
7e49b6f2	150	extern int udf_setsize(struct inode *, loff_t);
3aac2b62	151	extern void udf_evict_inode(struct inode *);
a9185b41	152	extern int udf_write_inode(struct inode , struct writeback_control wbc);
60448b1d	153	extern long udf_block_map(struct inode *, sector_t);
cb00ea35	154	extern int8_t inode_bmap(struct inode , sector_t, struct extent_position ,
5ca4e4be	155	struct kernel_lb_addr , uint32_t , sector_t *);
fcea62ba JK	156	extern int udf_setup_indirect_aext(struct inode *inode, int block,
	157	struct extent_position *epos);
	158	extern int __udf_add_aext(struct inode inode, struct extent_position epos,
	159	struct kernel_lb_addr *eloc, uint32_t elen, int inc);
7e49b6f2 JK	160	extern int udf_add_aext(struct inode , struct extent_position ,
	161	struct kernel_lb_addr *, uint32_t, int);
	162	extern void udf_write_aext(struct inode , struct extent_position ,
97e961fd	163	struct kernel_lb_addr *, uint32_t, int);
cb00ea35	164	extern int8_t udf_delete_aext(struct inode *, struct extent_position,
5ca4e4be	165	struct kernel_lb_addr, uint32_t);
cb00ea35	166	extern int8_t udf_next_aext(struct inode , struct extent_position ,
5ca4e4be	167	struct kernel_lb_addr , uint32_t , int);
cb00ea35	168	extern int8_t udf_current_aext(struct inode , struct extent_position ,
5ca4e4be	169	struct kernel_lb_addr , uint32_t , int);
1da177e4 LT	170
	171	/* misc.c */
	172	extern struct buffer_head udf_tgetblk(struct super_block , int);
	173	extern struct buffer_head udf_tread(struct super_block , int);
cb00ea35 CG	174	extern struct genericFormat udf_add_extendedattr(struct inode , uint32_t,
	175	uint32_t, uint8_t);
	176	extern struct genericFormat udf_get_extendedattr(struct inode , uint32_t,
	177	uint8_t);
	178	extern struct buffer_head udf_read_tagged(struct super_block , uint32_t,
	179	uint32_t, uint16_t *);
	180	extern struct buffer_head udf_read_ptagged(struct super_block ,
97e961fd	181	struct kernel_lb_addr *, uint32_t,
cb00ea35	182	uint16_t *);
1da177e4 LT	183	extern void udf_update_tag(char *, int);
	184	extern void udf_new_tag(char *, uint16_t, uint16_t, uint16_t, uint32_t, int);
	185
	186	/* lowlevel.c */
	187	extern unsigned int udf_get_last_session(struct super_block *);
	188	extern unsigned long udf_get_last_block(struct super_block *);
	189
	190	/* partition.c */
cb00ea35 CG	191	extern uint32_t udf_get_pblock(struct super_block *, uint32_t, uint16_t,
	192	uint32_t);
	193	extern uint32_t udf_get_pblock_virt15(struct super_block *, uint32_t, uint16_t,
	194	uint32_t);
	195	extern uint32_t udf_get_pblock_virt20(struct super_block *, uint32_t, uint16_t,
	196	uint32_t);
	197	extern uint32_t udf_get_pblock_spar15(struct super_block *, uint32_t, uint16_t,
	198	uint32_t);
bfb257a5 JK	199	extern uint32_t udf_get_pblock_meta25(struct super_block *, uint32_t, uint16_t,
bfb257a5 JK	200	uint32_t);
1da177e4 LT	201	extern int udf_relocate_blocks(struct super_block , long, long );
1da177e4 LT	202
97e961fd PE	203	static inline uint32_t
	204	udf_get_lb_pblock(struct super_block sb, struct kernel_lb_addr loc,
	205	uint32_t offset)
	206	{
	207	return udf_get_pblock(sb, loc->logicalBlockNum,
	208	loc->partitionReferenceNum, offset);
	209	}
	210
1da177e4	211	/* unicode.c */
9293fcfb AG	212	extern int udf_get_filename(struct super_block , const uint8_t , int,
9293fcfb AG	213	uint8_t *, int);
525e2c56 AG	214	extern int udf_put_filename(struct super_block , const uint8_t , int,
525e2c56 AG	215	uint8_t *, int);
c26f6c61	216	extern int udf_dstrCS0toUTF8(uint8_t , int, const uint8_t , int);
1da177e4 LT	217
	218	/* ialloc.c */
	219	extern void udf_free_inode(struct inode *);
0b93a92b	220	extern struct inode udf_new_inode(struct inode , umode_t);
1da177e4 LT	221
1da177e4 LT	222	/* truncate.c */
74584ae5	223	extern void udf_truncate_tail_extent(struct inode *);
1da177e4 LT	224	extern void udf_discard_prealloc(struct inode *);
	225	extern void udf_truncate_extents(struct inode *);
	226
	227	/* balloc.c */
cb00ea35	228	extern void udf_free_blocks(struct super_block , struct inode ,
97e961fd	229	struct kernel_lb_addr *, uint32_t, uint32_t);
cb00ea35 CG	230	extern int udf_prealloc_blocks(struct super_block , struct inode , uint16_t,
	231	uint32_t, uint32_t);
	232	extern int udf_new_block(struct super_block , struct inode , uint16_t,
	233	uint32_t, int *);
1da177e4	234
1da177e4	235	/* directory.c */
cb00ea35 CG	236	extern struct fileIdentDesc udf_fileident_read(struct inode , loff_t *,
	237	struct udf_fileident_bh *,
	238	struct fileIdentDesc *,
	239	struct extent_position *,
5ca4e4be	240	struct kernel_lb_addr , uint32_t ,
cb00ea35 CG	241	sector_t *);
	242	extern struct fileIdentDesc udf_get_fileident(void buffer, int bufsize,
	243	int *offset);
5ca4e4be PE	244	extern struct long_ad udf_get_filelongad(uint8_t , int, uint32_t *, int);
5ca4e4be PE	245	extern struct short_ad udf_get_fileshortad(uint8_t , int, uint32_t *, int);
1da177e4	246
1da177e4	247	/* udftime.c */
56774805	248	extern struct timespec udf_disk_stamp_to_time(struct timespec dest,
5ca4e4be PE	249	struct timestamp src);
5ca4e4be PE	250	extern struct timestamp udf_time_to_disk_stamp(struct timestamp dest, struct timespec src);
1da177e4	251
cb00ea35	252	#endif /* __UDF_DECL_H */