xref: /openbmc/linux/fs/udf/udfdecl.h (revision f2e83347)
1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
21da177e4SLinus Torvalds #ifndef __UDF_DECL_H
31da177e4SLinus Torvalds #define __UDF_DECL_H
41da177e4SLinus Torvalds 
578ace70cSJoe Perches #define pr_fmt(fmt) "UDF-fs: " fmt
678ace70cSJoe Perches 
71da177e4SLinus Torvalds #include "ecma_167.h"
81da177e4SLinus Torvalds #include "osta_udf.h"
91da177e4SLinus Torvalds 
101da177e4SLinus Torvalds #include <linux/fs.h>
111da177e4SLinus Torvalds #include <linux/types.h>
121da177e4SLinus Torvalds #include <linux/buffer_head.h>
1315aebd28SChristoph Hellwig #include <linux/udf_fs_i.h>
141da177e4SLinus Torvalds 
1515aebd28SChristoph Hellwig #include "udf_sb.h"
161da177e4SLinus Torvalds #include "udfend.h"
17d652eefbSmarcin.slusarz@gmail.com #include "udf_i.h"
181da177e4SLinus Torvalds 
1915aebd28SChristoph Hellwig #define UDF_DEFAULT_PREALLOC_BLOCKS	8
2015aebd28SChristoph Hellwig 
2134116645SLinus Torvalds extern __printf(3, 4) void _udf_err(struct super_block *sb,
2234116645SLinus Torvalds 		const char *function, const char *fmt, ...);
2378ace70cSJoe Perches #define udf_err(sb, fmt, ...)					\
2478ace70cSJoe Perches 	_udf_err(sb, __func__, fmt, ##__VA_ARGS__)
2515aebd28SChristoph Hellwig 
2634116645SLinus Torvalds extern __printf(3, 4) void _udf_warn(struct super_block *sb,
2734116645SLinus Torvalds 		const char *function, const char *fmt, ...);
28a40ecd7bSJoe Perches #define udf_warn(sb, fmt, ...)					\
29a40ecd7bSJoe Perches 	_udf_warn(sb, __func__, fmt, ##__VA_ARGS__)
307e273e3bSJoe Perches 
3178ace70cSJoe Perches #define udf_info(fmt, ...)					\
3278ace70cSJoe Perches 	pr_info("INFO " fmt, ##__VA_ARGS__)
337e273e3bSJoe Perches 
3415aebd28SChristoph Hellwig #undef UDFFS_DEBUG
3515aebd28SChristoph Hellwig 
3615aebd28SChristoph Hellwig #ifdef UDFFS_DEBUG
3778ace70cSJoe Perches #define udf_debug(fmt, ...)					\
3878ace70cSJoe Perches 	printk(KERN_DEBUG pr_fmt("%s:%d:%s: " fmt),		\
3978ace70cSJoe Perches 	       __FILE__, __LINE__, __func__, ##__VA_ARGS__)
4015aebd28SChristoph Hellwig #else
4178ace70cSJoe Perches #define udf_debug(fmt, ...)					\
4278ace70cSJoe Perches 	no_printk(fmt, ##__VA_ARGS__)
4315aebd28SChristoph Hellwig #endif
4415aebd28SChristoph Hellwig 
451da177e4SLinus Torvalds #define udf_fixed_to_variable(x) ( ( ( (x) >> 5 ) * 39 ) + ( (x) & 0x0000001F ) )
461da177e4SLinus Torvalds #define udf_variable_to_fixed(x) ( ( ( (x) / 39 ) << 5 ) + ( (x) % 39 ) )
471da177e4SLinus Torvalds 
481da177e4SLinus Torvalds #define UDF_EXTENT_LENGTH_MASK	0x3FFFFFFF
491da177e4SLinus Torvalds #define UDF_EXTENT_FLAG_MASK	0xC0000000
501da177e4SLinus Torvalds 
510c9850f4SJan Kara #define UDF_INVALID_ID ((uint32_t)-1)
520c9850f4SJan Kara 
531da177e4SLinus Torvalds #define UDF_NAME_PAD		4
549fba7056SAndrew Gabbasov #define UDF_NAME_LEN		254
559fba7056SAndrew Gabbasov #define UDF_NAME_LEN_CS0	255
561da177e4SLinus Torvalds 
57d652eefbSmarcin.slusarz@gmail.com static inline size_t udf_file_entry_alloc_offset(struct inode *inode)
58d652eefbSmarcin.slusarz@gmail.com {
59d652eefbSmarcin.slusarz@gmail.com 	struct udf_inode_info *iinfo = UDF_I(inode);
60d652eefbSmarcin.slusarz@gmail.com 	if (iinfo->i_use)
61d652eefbSmarcin.slusarz@gmail.com 		return sizeof(struct unallocSpaceEntry);
62d652eefbSmarcin.slusarz@gmail.com 	else if (iinfo->i_efe)
63d652eefbSmarcin.slusarz@gmail.com 		return sizeof(struct extendedFileEntry) + iinfo->i_lenEAttr;
64d652eefbSmarcin.slusarz@gmail.com 	else
65d652eefbSmarcin.slusarz@gmail.com 		return sizeof(struct fileEntry) + iinfo->i_lenEAttr;
66d652eefbSmarcin.slusarz@gmail.com }
671da177e4SLinus Torvalds 
68d652eefbSmarcin.slusarz@gmail.com static inline size_t udf_ext0_offset(struct inode *inode)
69d652eefbSmarcin.slusarz@gmail.com {
70d652eefbSmarcin.slusarz@gmail.com 	if (UDF_I(inode)->i_alloc_type == ICBTAG_FLAG_AD_IN_ICB)
71d652eefbSmarcin.slusarz@gmail.com 		return udf_file_entry_alloc_offset(inode);
72d652eefbSmarcin.slusarz@gmail.com 	else
73d652eefbSmarcin.slusarz@gmail.com 		return 0;
74d652eefbSmarcin.slusarz@gmail.com }
751da177e4SLinus Torvalds 
763f2587bbSMarcin Slusarz /* computes tag checksum */
775ca4e4beSPekka Enberg u8 udf_tag_checksum(const struct tag *t);
783f2587bbSMarcin Slusarz 
79b490bdd6SSteve Magnani typedef uint32_t udf_pblk_t;
80b490bdd6SSteve Magnani 
811da177e4SLinus Torvalds struct dentry;
821da177e4SLinus Torvalds struct inode;
831da177e4SLinus Torvalds struct task_struct;
841da177e4SLinus Torvalds struct buffer_head;
851da177e4SLinus Torvalds struct super_block;
861da177e4SLinus Torvalds 
87221e583aSRasmus Rohde extern const struct export_operations udf_export_ops;
88c5ef1c42SArjan van de Ven extern const struct inode_operations udf_dir_inode_operations;
894b6f5d20SArjan van de Ven extern const struct file_operations udf_dir_operations;
90c5ef1c42SArjan van de Ven extern const struct inode_operations udf_file_inode_operations;
914b6f5d20SArjan van de Ven extern const struct file_operations udf_file_operations;
92ad4d0532SJan Kara extern const struct inode_operations udf_symlink_inode_operations;
93f5e54d6eSChristoph Hellwig extern const struct address_space_operations udf_aops;
94f5e54d6eSChristoph Hellwig extern const struct address_space_operations udf_adinicb_aops;
95f5e54d6eSChristoph Hellwig extern const struct address_space_operations udf_symlink_aops;
961da177e4SLinus Torvalds 
97cb00ea35SCyrill Gorcunov struct udf_fileident_bh {
981da177e4SLinus Torvalds 	struct buffer_head *sbh;
991da177e4SLinus Torvalds 	struct buffer_head *ebh;
1001da177e4SLinus Torvalds 	int soffset;
1011da177e4SLinus Torvalds 	int eoffset;
1021da177e4SLinus Torvalds };
1031da177e4SLinus Torvalds 
104cb00ea35SCyrill Gorcunov struct udf_vds_record {
1051da177e4SLinus Torvalds 	uint32_t block;
1061da177e4SLinus Torvalds 	uint32_t volDescSeqNum;
1071da177e4SLinus Torvalds };
1081da177e4SLinus Torvalds 
109cb00ea35SCyrill Gorcunov struct generic_desc {
1105ca4e4beSPekka Enberg 	struct tag	descTag;
1111da177e4SLinus Torvalds 	__le32		volDescSeqNum;
1121da177e4SLinus Torvalds };
1131da177e4SLinus Torvalds 
114ff116fc8SJan Kara 
1151da177e4SLinus Torvalds /* super.c */
116fab3c858SJoe Perches 
117146bca72SJan Kara static inline void udf_updated_lvid(struct super_block *sb)
118146bca72SJan Kara {
119146bca72SJan Kara 	struct buffer_head *bh = UDF_SB(sb)->s_lvid_bh;
120146bca72SJan Kara 
121146bca72SJan Kara 	BUG_ON(!bh);
122146bca72SJan Kara 	WARN_ON_ONCE(((struct logicalVolIntegrityDesc *)
123146bca72SJan Kara 		     bh->b_data)->integrityType !=
124146bca72SJan Kara 		     cpu_to_le32(LVID_INTEGRITY_TYPE_OPEN));
125146bca72SJan Kara 	UDF_SB(sb)->s_lvid_dirty = 1;
126146bca72SJan Kara }
127d664b6afSJan Kara extern u64 lvid_get_unique_id(struct super_block *sb);
1283080a74eSNamjae Jeon struct inode *udf_find_metadata_inode_efe(struct super_block *sb,
1293080a74eSNamjae Jeon 					u32 meta_file_loc, u32 partition_num);
1301da177e4SLinus Torvalds 
1311da177e4SLinus Torvalds /* namei.c */
132cb00ea35SCyrill Gorcunov extern int udf_write_fi(struct inode *inode, struct fileIdentDesc *,
133cb00ea35SCyrill Gorcunov 			struct fileIdentDesc *, struct udf_fileident_bh *,
134cb00ea35SCyrill Gorcunov 			uint8_t *, uint8_t *);
135f2e83347SJan Kara static inline unsigned int udf_dir_entry_len(struct fileIdentDesc *cfi)
136f2e83347SJan Kara {
137f2e83347SJan Kara 	return ALIGN(sizeof(struct fileIdentDesc) +
138f2e83347SJan Kara 		le16_to_cpu(cfi->lengthOfImpUse) + cfi->lengthFileIdent,
139f2e83347SJan Kara 		UDF_NAME_PAD);
140f2e83347SJan Kara }
1411da177e4SLinus Torvalds 
1421da177e4SLinus Torvalds /* file.c */
1432f07a88bSJohn Kacur extern long udf_ioctl(struct file *, unsigned int, unsigned long);
1441da177e4SLinus Torvalds /* inode.c */
1456174c2ebSJan Kara extern struct inode *__udf_iget(struct super_block *, struct kernel_lb_addr *,
1466174c2ebSJan Kara 				bool hidden_inode);
1476174c2ebSJan Kara static inline struct inode *udf_iget_special(struct super_block *sb,
1486174c2ebSJan Kara 					     struct kernel_lb_addr *ino)
1496174c2ebSJan Kara {
1506174c2ebSJan Kara 	return __udf_iget(sb, ino, true);
1516174c2ebSJan Kara }
1526174c2ebSJan Kara static inline struct inode *udf_iget(struct super_block *sb,
1536174c2ebSJan Kara 				     struct kernel_lb_addr *ino)
1546174c2ebSJan Kara {
1556174c2ebSJan Kara 	return __udf_iget(sb, ino, false);
1566174c2ebSJan Kara }
1577e49b6f2SJan Kara extern int udf_expand_file_adinicb(struct inode *);
158b490bdd6SSteve Magnani extern struct buffer_head *udf_expand_dir_adinicb(struct inode *inode,
159b490bdd6SSteve Magnani 						  udf_pblk_t *block, int *err);
160b490bdd6SSteve Magnani extern struct buffer_head *udf_bread(struct inode *inode, udf_pblk_t block,
161b490bdd6SSteve Magnani 				      int create, int *err);
1627e49b6f2SJan Kara extern int udf_setsize(struct inode *, loff_t);
1633aac2b62SAl Viro extern void udf_evict_inode(struct inode *);
164a9185b41SChristoph Hellwig extern int udf_write_inode(struct inode *, struct writeback_control *wbc);
165b490bdd6SSteve Magnani extern udf_pblk_t udf_block_map(struct inode *inode, sector_t block);
166cb00ea35SCyrill Gorcunov extern int8_t inode_bmap(struct inode *, sector_t, struct extent_position *,
1675ca4e4beSPekka Enberg 			 struct kernel_lb_addr *, uint32_t *, sector_t *);
168b490bdd6SSteve Magnani extern int udf_setup_indirect_aext(struct inode *inode, udf_pblk_t block,
169fcea62baSJan Kara 				   struct extent_position *epos);
170fcea62baSJan Kara extern int __udf_add_aext(struct inode *inode, struct extent_position *epos,
171fcea62baSJan Kara 			  struct kernel_lb_addr *eloc, uint32_t elen, int inc);
1727e49b6f2SJan Kara extern int udf_add_aext(struct inode *, struct extent_position *,
17397e961fdSPekka Enberg 			struct kernel_lb_addr *, uint32_t, int);
1747e49b6f2SJan Kara extern void udf_write_aext(struct inode *, struct extent_position *,
17597e961fdSPekka Enberg 			   struct kernel_lb_addr *, uint32_t, int);
176cb00ea35SCyrill Gorcunov extern int8_t udf_delete_aext(struct inode *, struct extent_position,
1775ca4e4beSPekka Enberg 			      struct kernel_lb_addr, uint32_t);
178cb00ea35SCyrill Gorcunov extern int8_t udf_next_aext(struct inode *, struct extent_position *,
1795ca4e4beSPekka Enberg 			    struct kernel_lb_addr *, uint32_t *, int);
180cb00ea35SCyrill Gorcunov extern int8_t udf_current_aext(struct inode *, struct extent_position *,
1815ca4e4beSPekka Enberg 			       struct kernel_lb_addr *, uint32_t *, int);
1821da177e4SLinus Torvalds 
1831da177e4SLinus Torvalds /* misc.c */
184b490bdd6SSteve Magnani extern struct buffer_head *udf_tgetblk(struct super_block *sb,
185b490bdd6SSteve Magnani 					udf_pblk_t block);
186b490bdd6SSteve Magnani extern struct buffer_head *udf_tread(struct super_block *sb, udf_pblk_t block);
187cb00ea35SCyrill Gorcunov extern struct genericFormat *udf_add_extendedattr(struct inode *, uint32_t,
188cb00ea35SCyrill Gorcunov 						  uint32_t, uint8_t);
189cb00ea35SCyrill Gorcunov extern struct genericFormat *udf_get_extendedattr(struct inode *, uint32_t,
190cb00ea35SCyrill Gorcunov 						  uint8_t);
191cb00ea35SCyrill Gorcunov extern struct buffer_head *udf_read_tagged(struct super_block *, uint32_t,
192cb00ea35SCyrill Gorcunov 					   uint32_t, uint16_t *);
193cb00ea35SCyrill Gorcunov extern struct buffer_head *udf_read_ptagged(struct super_block *,
19497e961fdSPekka Enberg 					    struct kernel_lb_addr *, uint32_t,
195cb00ea35SCyrill Gorcunov 					    uint16_t *);
1961da177e4SLinus Torvalds extern void udf_update_tag(char *, int);
1971da177e4SLinus Torvalds extern void udf_new_tag(char *, uint16_t, uint16_t, uint16_t, uint32_t, int);
1981da177e4SLinus Torvalds 
1991da177e4SLinus Torvalds /* lowlevel.c */
2001da177e4SLinus Torvalds extern unsigned int udf_get_last_session(struct super_block *);
2011da177e4SLinus Torvalds extern unsigned long udf_get_last_block(struct super_block *);
2021da177e4SLinus Torvalds 
2031da177e4SLinus Torvalds /* partition.c */
204cb00ea35SCyrill Gorcunov extern uint32_t udf_get_pblock(struct super_block *, uint32_t, uint16_t,
205cb00ea35SCyrill Gorcunov 			       uint32_t);
206cb00ea35SCyrill Gorcunov extern uint32_t udf_get_pblock_virt15(struct super_block *, uint32_t, uint16_t,
207cb00ea35SCyrill Gorcunov 				      uint32_t);
208cb00ea35SCyrill Gorcunov extern uint32_t udf_get_pblock_virt20(struct super_block *, uint32_t, uint16_t,
209cb00ea35SCyrill Gorcunov 				      uint32_t);
210cb00ea35SCyrill Gorcunov extern uint32_t udf_get_pblock_spar15(struct super_block *, uint32_t, uint16_t,
211cb00ea35SCyrill Gorcunov 				      uint32_t);
212bfb257a5SJan Kara extern uint32_t udf_get_pblock_meta25(struct super_block *, uint32_t, uint16_t,
213bfb257a5SJan Kara 					  uint32_t);
2141da177e4SLinus Torvalds extern int udf_relocate_blocks(struct super_block *, long, long *);
2151da177e4SLinus Torvalds 
21697e961fdSPekka Enberg static inline uint32_t
21797e961fdSPekka Enberg udf_get_lb_pblock(struct super_block *sb, struct kernel_lb_addr *loc,
21897e961fdSPekka Enberg 		  uint32_t offset)
21997e961fdSPekka Enberg {
22097e961fdSPekka Enberg 	return udf_get_pblock(sb, loc->logicalBlockNum,
22197e961fdSPekka Enberg 			loc->partitionReferenceNum, offset);
22297e961fdSPekka Enberg }
22397e961fdSPekka Enberg 
2241da177e4SLinus Torvalds /* unicode.c */
2259293fcfbSAndrew Gabbasov extern int udf_get_filename(struct super_block *, const uint8_t *, int,
2269293fcfbSAndrew Gabbasov 			    uint8_t *, int);
227525e2c56SAndrew Gabbasov extern int udf_put_filename(struct super_block *, const uint8_t *, int,
228525e2c56SAndrew Gabbasov 			    uint8_t *, int);
229e966fc8dSJan Kara extern int udf_dstrCS0toChar(struct super_block *, uint8_t *, int,
230e966fc8dSJan Kara 			     const uint8_t *, int);
2311da177e4SLinus Torvalds 
2321da177e4SLinus Torvalds /* ialloc.c */
2331da177e4SLinus Torvalds extern void udf_free_inode(struct inode *);
2340b93a92bSAl Viro extern struct inode *udf_new_inode(struct inode *, umode_t);
2351da177e4SLinus Torvalds 
2361da177e4SLinus Torvalds /* truncate.c */
23774584ae5SJan Kara extern void udf_truncate_tail_extent(struct inode *);
2381da177e4SLinus Torvalds extern void udf_discard_prealloc(struct inode *);
2391da177e4SLinus Torvalds extern void udf_truncate_extents(struct inode *);
2401da177e4SLinus Torvalds 
2411da177e4SLinus Torvalds /* balloc.c */
242cb00ea35SCyrill Gorcunov extern void udf_free_blocks(struct super_block *, struct inode *,
24397e961fdSPekka Enberg 			    struct kernel_lb_addr *, uint32_t, uint32_t);
244cb00ea35SCyrill Gorcunov extern int udf_prealloc_blocks(struct super_block *, struct inode *, uint16_t,
245cb00ea35SCyrill Gorcunov 			       uint32_t, uint32_t);
246b490bdd6SSteve Magnani extern udf_pblk_t udf_new_block(struct super_block *sb, struct inode *inode,
247b490bdd6SSteve Magnani 				 uint16_t partition, uint32_t goal, int *err);
2481da177e4SLinus Torvalds 
2491da177e4SLinus Torvalds /* directory.c */
250cb00ea35SCyrill Gorcunov extern struct fileIdentDesc *udf_fileident_read(struct inode *, loff_t *,
251cb00ea35SCyrill Gorcunov 						struct udf_fileident_bh *,
252cb00ea35SCyrill Gorcunov 						struct fileIdentDesc *,
253cb00ea35SCyrill Gorcunov 						struct extent_position *,
2545ca4e4beSPekka Enberg 						struct kernel_lb_addr *, uint32_t *,
255cb00ea35SCyrill Gorcunov 						sector_t *);
256cb00ea35SCyrill Gorcunov extern struct fileIdentDesc *udf_get_fileident(void *buffer, int bufsize,
257cb00ea35SCyrill Gorcunov 					       int *offset);
2585ca4e4beSPekka Enberg extern struct long_ad *udf_get_filelongad(uint8_t *, int, uint32_t *, int);
2595ca4e4beSPekka Enberg extern struct short_ad *udf_get_fileshortad(uint8_t *, int, uint32_t *, int);
2601da177e4SLinus Torvalds 
2611da177e4SLinus Torvalds /* udftime.c */
2620220eddaSDeepa Dinamani extern void udf_disk_stamp_to_time(struct timespec *dest,
2635ca4e4beSPekka Enberg 						struct timestamp src);
2640220eddaSDeepa Dinamani extern void udf_time_to_disk_stamp(struct timestamp *dest, struct timespec src);
2651da177e4SLinus Torvalds 
2661da177e4SLinus Torvalds #endif				/* __UDF_DECL_H */
267