xref: /kernel/linux/linux-6.6/fs/udf/udfdecl.h (revision 62306a36)
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __UDF_DECL_H
3#define __UDF_DECL_H
4
5#define pr_fmt(fmt) "UDF-fs: " fmt
6
7#include "ecma_167.h"
8#include "osta_udf.h"
9
10#include <linux/fs.h>
11#include <linux/types.h>
12#include <linux/buffer_head.h>
13#include <linux/udf_fs_i.h>
14
15#include "udf_sb.h"
16#include "udfend.h"
17#include "udf_i.h"
18
19#define UDF_DEFAULT_PREALLOC_BLOCKS	8
20
21extern __printf(3, 4) void _udf_err(struct super_block *sb,
22		const char *function, const char *fmt, ...);
23#define udf_err(sb, fmt, ...)					\
24	_udf_err(sb, __func__, fmt, ##__VA_ARGS__)
25
26extern __printf(3, 4) void _udf_warn(struct super_block *sb,
27		const char *function, const char *fmt, ...);
28#define udf_warn(sb, fmt, ...)					\
29	_udf_warn(sb, __func__, fmt, ##__VA_ARGS__)
30
31#define udf_info(fmt, ...)					\
32	pr_info("INFO " fmt, ##__VA_ARGS__)
33
34#define udf_debug(fmt, ...)					\
35	pr_debug("%s:%d:%s: " fmt, __FILE__, __LINE__, __func__, ##__VA_ARGS__)
36
37#define UDF_EXTENT_LENGTH_MASK	0x3FFFFFFF
38#define UDF_EXTENT_FLAG_MASK	0xC0000000
39
40#define UDF_INVALID_ID ((uint32_t)-1)
41
42#define UDF_NAME_PAD		4
43#define UDF_NAME_LEN		254
44#define UDF_NAME_LEN_CS0	255
45
46static inline size_t udf_file_entry_alloc_offset(struct inode *inode)
47{
48	struct udf_inode_info *iinfo = UDF_I(inode);
49	if (iinfo->i_use)
50		return sizeof(struct unallocSpaceEntry);
51	else if (iinfo->i_efe)
52		return sizeof(struct extendedFileEntry) + iinfo->i_lenEAttr;
53	else
54		return sizeof(struct fileEntry) + iinfo->i_lenEAttr;
55}
56
57static inline size_t udf_ext0_offset(struct inode *inode)
58{
59	if (UDF_I(inode)->i_alloc_type == ICBTAG_FLAG_AD_IN_ICB)
60		return udf_file_entry_alloc_offset(inode);
61	else
62		return 0;
63}
64
65/* computes tag checksum */
66u8 udf_tag_checksum(const struct tag *t);
67
68typedef uint32_t udf_pblk_t;
69
70struct dentry;
71struct inode;
72struct task_struct;
73struct buffer_head;
74struct super_block;
75
76extern const struct export_operations udf_export_ops;
77extern const struct inode_operations udf_dir_inode_operations;
78extern const struct file_operations udf_dir_operations;
79extern const struct inode_operations udf_file_inode_operations;
80extern const struct file_operations udf_file_operations;
81extern const struct inode_operations udf_symlink_inode_operations;
82extern const struct address_space_operations udf_aops;
83extern const struct address_space_operations udf_symlink_aops;
84
85struct udf_fileident_iter {
86	struct inode *dir;		/* Directory we are working with */
87	loff_t pos;			/* Logical position in a dir */
88	struct buffer_head *bh[2];	/* Buffer containing 'pos' and possibly
89					 * next buffer if entry straddles
90					 * blocks */
91	struct kernel_lb_addr eloc;	/* Start of extent containing 'pos' */
92	uint32_t elen;			/* Length of extent containing 'pos' */
93	sector_t loffset;		/* Block offset of 'pos' within above
94					 * extent */
95	struct extent_position epos;	/* Position after the above extent */
96	struct fileIdentDesc fi;	/* Copied directory entry */
97	uint8_t *name;			/* Pointer to entry name */
98	uint8_t *namebuf;		/* Storage for entry name in case
99					 * the name is split between two blocks
100					 */
101};
102
103struct udf_vds_record {
104	uint32_t block;
105	uint32_t volDescSeqNum;
106};
107
108struct generic_desc {
109	struct tag	descTag;
110	__le32		volDescSeqNum;
111};
112
113
114/* super.c */
115
116static inline void udf_updated_lvid(struct super_block *sb)
117{
118	struct buffer_head *bh = UDF_SB(sb)->s_lvid_bh;
119
120	BUG_ON(!bh);
121	WARN_ON_ONCE(((struct logicalVolIntegrityDesc *)
122		     bh->b_data)->integrityType !=
123		     cpu_to_le32(LVID_INTEGRITY_TYPE_OPEN));
124	UDF_SB(sb)->s_lvid_dirty = 1;
125}
126extern u64 lvid_get_unique_id(struct super_block *sb);
127struct inode *udf_find_metadata_inode_efe(struct super_block *sb,
128					u32 meta_file_loc, u32 partition_num);
129
130/* namei.c */
131static inline unsigned int udf_dir_entry_len(struct fileIdentDesc *cfi)
132{
133	return ALIGN(sizeof(struct fileIdentDesc) +
134		le16_to_cpu(cfi->lengthOfImpUse) + cfi->lengthFileIdent,
135		UDF_NAME_PAD);
136}
137
138/* file.c */
139extern long udf_ioctl(struct file *, unsigned int, unsigned long);
140
141/* inode.c */
142extern struct inode *__udf_iget(struct super_block *, struct kernel_lb_addr *,
143				bool hidden_inode);
144static inline struct inode *udf_iget_special(struct super_block *sb,
145					     struct kernel_lb_addr *ino)
146{
147	return __udf_iget(sb, ino, true);
148}
149static inline struct inode *udf_iget(struct super_block *sb,
150				     struct kernel_lb_addr *ino)
151{
152	return __udf_iget(sb, ino, false);
153}
154extern int udf_expand_file_adinicb(struct inode *);
155extern struct buffer_head *udf_bread(struct inode *inode, udf_pblk_t block,
156				      int create, int *err);
157extern int udf_setsize(struct inode *, loff_t);
158extern void udf_evict_inode(struct inode *);
159extern int udf_write_inode(struct inode *, struct writeback_control *wbc);
160extern int8_t inode_bmap(struct inode *, sector_t, struct extent_position *,
161			 struct kernel_lb_addr *, uint32_t *, sector_t *);
162int udf_get_block(struct inode *, sector_t, struct buffer_head *, int);
163extern int udf_setup_indirect_aext(struct inode *inode, udf_pblk_t block,
164				   struct extent_position *epos);
165extern int __udf_add_aext(struct inode *inode, struct extent_position *epos,
166			  struct kernel_lb_addr *eloc, uint32_t elen, int inc);
167extern int udf_add_aext(struct inode *, struct extent_position *,
168			struct kernel_lb_addr *, uint32_t, int);
169extern void udf_write_aext(struct inode *, struct extent_position *,
170			   struct kernel_lb_addr *, uint32_t, int);
171extern int8_t udf_delete_aext(struct inode *, struct extent_position);
172extern int8_t udf_next_aext(struct inode *, struct extent_position *,
173			    struct kernel_lb_addr *, uint32_t *, int);
174extern int8_t udf_current_aext(struct inode *, struct extent_position *,
175			       struct kernel_lb_addr *, uint32_t *, int);
176extern void udf_update_extra_perms(struct inode *inode, umode_t mode);
177
178/* misc.c */
179extern struct genericFormat *udf_add_extendedattr(struct inode *, uint32_t,
180						  uint32_t, uint8_t);
181extern struct genericFormat *udf_get_extendedattr(struct inode *, uint32_t,
182						  uint8_t);
183extern struct buffer_head *udf_read_tagged(struct super_block *, uint32_t,
184					   uint32_t, uint16_t *);
185extern struct buffer_head *udf_read_ptagged(struct super_block *,
186					    struct kernel_lb_addr *, uint32_t,
187					    uint16_t *);
188extern void udf_update_tag(char *, int);
189extern void udf_new_tag(char *, uint16_t, uint16_t, uint16_t, uint32_t, int);
190
191/* lowlevel.c */
192extern unsigned int udf_get_last_session(struct super_block *);
193udf_pblk_t udf_get_last_block(struct super_block *);
194
195/* partition.c */
196extern uint32_t udf_get_pblock(struct super_block *, uint32_t, uint16_t,
197			       uint32_t);
198extern uint32_t udf_get_pblock_virt15(struct super_block *, uint32_t, uint16_t,
199				      uint32_t);
200extern uint32_t udf_get_pblock_virt20(struct super_block *, uint32_t, uint16_t,
201				      uint32_t);
202extern uint32_t udf_get_pblock_spar15(struct super_block *, uint32_t, uint16_t,
203				      uint32_t);
204extern uint32_t udf_get_pblock_meta25(struct super_block *, uint32_t, uint16_t,
205					  uint32_t);
206extern int udf_relocate_blocks(struct super_block *, long, long *);
207
208static inline uint32_t
209udf_get_lb_pblock(struct super_block *sb, struct kernel_lb_addr *loc,
210		  uint32_t offset)
211{
212	return udf_get_pblock(sb, loc->logicalBlockNum,
213			loc->partitionReferenceNum, offset);
214}
215
216/* unicode.c */
217extern int udf_get_filename(struct super_block *, const uint8_t *, int,
218			    uint8_t *, int);
219extern int udf_put_filename(struct super_block *, const uint8_t *, int,
220			    uint8_t *, int);
221extern int udf_dstrCS0toChar(struct super_block *, uint8_t *, int,
222			     const uint8_t *, int);
223
224/* ialloc.c */
225extern void udf_free_inode(struct inode *);
226extern struct inode *udf_new_inode(struct inode *, umode_t);
227
228/* truncate.c */
229extern void udf_truncate_tail_extent(struct inode *);
230extern void udf_discard_prealloc(struct inode *);
231extern int udf_truncate_extents(struct inode *);
232
233/* balloc.c */
234extern void udf_free_blocks(struct super_block *, struct inode *,
235			    struct kernel_lb_addr *, uint32_t, uint32_t);
236extern int udf_prealloc_blocks(struct super_block *, struct inode *, uint16_t,
237			       uint32_t, uint32_t);
238extern udf_pblk_t udf_new_block(struct super_block *sb, struct inode *inode,
239				 uint16_t partition, uint32_t goal, int *err);
240
241/* directory.c */
242int udf_fiiter_init(struct udf_fileident_iter *iter, struct inode *dir,
243		    loff_t pos);
244int udf_fiiter_advance(struct udf_fileident_iter *iter);
245void udf_fiiter_release(struct udf_fileident_iter *iter);
246void udf_fiiter_write_fi(struct udf_fileident_iter *iter, uint8_t *impuse);
247void udf_fiiter_update_elen(struct udf_fileident_iter *iter, uint32_t new_elen);
248int udf_fiiter_append_blk(struct udf_fileident_iter *iter);
249extern struct long_ad *udf_get_filelongad(uint8_t *, int, uint32_t *, int);
250extern struct short_ad *udf_get_fileshortad(uint8_t *, int, uint32_t *, int);
251
252/* udftime.c */
253extern void udf_disk_stamp_to_time(struct timespec64 *dest,
254						struct timestamp src);
255extern void udf_time_to_disk_stamp(struct timestamp *dest, struct timespec64 src);
256
257#endif				/* __UDF_DECL_H */
258