xref: /openbmc/linux/fs/udf/udfdecl.h (revision 8bd1369b)
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 
21 extern __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 
26 extern __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 #undef UDFFS_DEBUG
35 
36 #ifdef UDFFS_DEBUG
37 #define udf_debug(fmt, ...)					\
38 	printk(KERN_DEBUG pr_fmt("%s:%d:%s: " fmt),		\
39 	       __FILE__, __LINE__, __func__, ##__VA_ARGS__)
40 #else
41 #define udf_debug(fmt, ...)					\
42 	no_printk(fmt, ##__VA_ARGS__)
43 #endif
44 
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_INVALID_ID ((uint32_t)-1)
52 
53 #define UDF_NAME_PAD		4
54 #define UDF_NAME_LEN		254
55 #define UDF_NAME_LEN_CS0	255
56 
57 static inline size_t udf_file_entry_alloc_offset(struct inode *inode)
58 {
59 	struct udf_inode_info *iinfo = UDF_I(inode);
60 	if (iinfo->i_use)
61 		return sizeof(struct unallocSpaceEntry);
62 	else if (iinfo->i_efe)
63 		return sizeof(struct extendedFileEntry) + iinfo->i_lenEAttr;
64 	else
65 		return sizeof(struct fileEntry) + iinfo->i_lenEAttr;
66 }
67 
68 static inline size_t udf_ext0_offset(struct inode *inode)
69 {
70 	if (UDF_I(inode)->i_alloc_type == ICBTAG_FLAG_AD_IN_ICB)
71 		return udf_file_entry_alloc_offset(inode);
72 	else
73 		return 0;
74 }
75 
76 /* computes tag checksum */
77 u8 udf_tag_checksum(const struct tag *t);
78 
79 typedef uint32_t udf_pblk_t;
80 
81 struct dentry;
82 struct inode;
83 struct task_struct;
84 struct buffer_head;
85 struct super_block;
86 
87 extern const struct export_operations udf_export_ops;
88 extern const struct inode_operations udf_dir_inode_operations;
89 extern const struct file_operations udf_dir_operations;
90 extern const struct inode_operations udf_file_inode_operations;
91 extern const struct file_operations udf_file_operations;
92 extern const struct inode_operations udf_symlink_inode_operations;
93 extern const struct address_space_operations udf_aops;
94 extern const struct address_space_operations udf_adinicb_aops;
95 extern const struct address_space_operations udf_symlink_aops;
96 
97 struct udf_fileident_bh {
98 	struct buffer_head *sbh;
99 	struct buffer_head *ebh;
100 	int soffset;
101 	int eoffset;
102 };
103 
104 struct udf_vds_record {
105 	uint32_t block;
106 	uint32_t volDescSeqNum;
107 };
108 
109 struct generic_desc {
110 	struct tag	descTag;
111 	__le32		volDescSeqNum;
112 };
113 
114 
115 /* super.c */
116 
117 static inline void udf_updated_lvid(struct super_block *sb)
118 {
119 	struct buffer_head *bh = UDF_SB(sb)->s_lvid_bh;
120 
121 	BUG_ON(!bh);
122 	WARN_ON_ONCE(((struct logicalVolIntegrityDesc *)
123 		     bh->b_data)->integrityType !=
124 		     cpu_to_le32(LVID_INTEGRITY_TYPE_OPEN));
125 	UDF_SB(sb)->s_lvid_dirty = 1;
126 }
127 extern u64 lvid_get_unique_id(struct super_block *sb);
128 struct inode *udf_find_metadata_inode_efe(struct super_block *sb,
129 					u32 meta_file_loc, u32 partition_num);
130 
131 /* namei.c */
132 extern int udf_write_fi(struct inode *inode, struct fileIdentDesc *,
133 			struct fileIdentDesc *, struct udf_fileident_bh *,
134 			uint8_t *, uint8_t *);
135 static inline unsigned int udf_dir_entry_len(struct fileIdentDesc *cfi)
136 {
137 	return ALIGN(sizeof(struct fileIdentDesc) +
138 		le16_to_cpu(cfi->lengthOfImpUse) + cfi->lengthFileIdent,
139 		UDF_NAME_PAD);
140 }
141 
142 /* file.c */
143 extern long udf_ioctl(struct file *, unsigned int, unsigned long);
144 /* inode.c */
145 extern struct inode *__udf_iget(struct super_block *, struct kernel_lb_addr *,
146 				bool hidden_inode);
147 static inline struct inode *udf_iget_special(struct super_block *sb,
148 					     struct kernel_lb_addr *ino)
149 {
150 	return __udf_iget(sb, ino, true);
151 }
152 static inline struct inode *udf_iget(struct super_block *sb,
153 				     struct kernel_lb_addr *ino)
154 {
155 	return __udf_iget(sb, ino, false);
156 }
157 extern int udf_expand_file_adinicb(struct inode *);
158 extern struct buffer_head *udf_expand_dir_adinicb(struct inode *inode,
159 						  udf_pblk_t *block, int *err);
160 extern struct buffer_head *udf_bread(struct inode *inode, udf_pblk_t block,
161 				      int create, int *err);
162 extern int udf_setsize(struct inode *, loff_t);
163 extern void udf_evict_inode(struct inode *);
164 extern int udf_write_inode(struct inode *, struct writeback_control *wbc);
165 extern udf_pblk_t udf_block_map(struct inode *inode, sector_t block);
166 extern int8_t inode_bmap(struct inode *, sector_t, struct extent_position *,
167 			 struct kernel_lb_addr *, uint32_t *, sector_t *);
168 extern int udf_setup_indirect_aext(struct inode *inode, udf_pblk_t block,
169 				   struct extent_position *epos);
170 extern int __udf_add_aext(struct inode *inode, struct extent_position *epos,
171 			  struct kernel_lb_addr *eloc, uint32_t elen, int inc);
172 extern int udf_add_aext(struct inode *, struct extent_position *,
173 			struct kernel_lb_addr *, uint32_t, int);
174 extern void udf_write_aext(struct inode *, struct extent_position *,
175 			   struct kernel_lb_addr *, uint32_t, int);
176 extern int8_t udf_delete_aext(struct inode *, struct extent_position);
177 extern int8_t udf_next_aext(struct inode *, struct extent_position *,
178 			    struct kernel_lb_addr *, uint32_t *, int);
179 extern int8_t udf_current_aext(struct inode *, struct extent_position *,
180 			       struct kernel_lb_addr *, uint32_t *, int);
181 
182 /* misc.c */
183 extern struct buffer_head *udf_tgetblk(struct super_block *sb,
184 					udf_pblk_t block);
185 extern struct buffer_head *udf_tread(struct super_block *sb, udf_pblk_t block);
186 extern struct genericFormat *udf_add_extendedattr(struct inode *, uint32_t,
187 						  uint32_t, uint8_t);
188 extern struct genericFormat *udf_get_extendedattr(struct inode *, uint32_t,
189 						  uint8_t);
190 extern struct buffer_head *udf_read_tagged(struct super_block *, uint32_t,
191 					   uint32_t, uint16_t *);
192 extern struct buffer_head *udf_read_ptagged(struct super_block *,
193 					    struct kernel_lb_addr *, uint32_t,
194 					    uint16_t *);
195 extern void udf_update_tag(char *, int);
196 extern void udf_new_tag(char *, uint16_t, uint16_t, uint16_t, uint32_t, int);
197 
198 /* lowlevel.c */
199 extern unsigned int udf_get_last_session(struct super_block *);
200 extern unsigned long udf_get_last_block(struct super_block *);
201 
202 /* partition.c */
203 extern uint32_t udf_get_pblock(struct super_block *, uint32_t, uint16_t,
204 			       uint32_t);
205 extern uint32_t udf_get_pblock_virt15(struct super_block *, uint32_t, uint16_t,
206 				      uint32_t);
207 extern uint32_t udf_get_pblock_virt20(struct super_block *, uint32_t, uint16_t,
208 				      uint32_t);
209 extern uint32_t udf_get_pblock_spar15(struct super_block *, uint32_t, uint16_t,
210 				      uint32_t);
211 extern uint32_t udf_get_pblock_meta25(struct super_block *, uint32_t, uint16_t,
212 					  uint32_t);
213 extern int udf_relocate_blocks(struct super_block *, long, long *);
214 
215 static inline uint32_t
216 udf_get_lb_pblock(struct super_block *sb, struct kernel_lb_addr *loc,
217 		  uint32_t offset)
218 {
219 	return udf_get_pblock(sb, loc->logicalBlockNum,
220 			loc->partitionReferenceNum, offset);
221 }
222 
223 /* unicode.c */
224 extern int udf_get_filename(struct super_block *, const uint8_t *, int,
225 			    uint8_t *, int);
226 extern int udf_put_filename(struct super_block *, const uint8_t *, int,
227 			    uint8_t *, int);
228 extern int udf_dstrCS0toChar(struct super_block *, uint8_t *, int,
229 			     const uint8_t *, int);
230 
231 /* ialloc.c */
232 extern void udf_free_inode(struct inode *);
233 extern struct inode *udf_new_inode(struct inode *, umode_t);
234 
235 /* truncate.c */
236 extern void udf_truncate_tail_extent(struct inode *);
237 extern void udf_discard_prealloc(struct inode *);
238 extern void udf_truncate_extents(struct inode *);
239 
240 /* balloc.c */
241 extern void udf_free_blocks(struct super_block *, struct inode *,
242 			    struct kernel_lb_addr *, uint32_t, uint32_t);
243 extern int udf_prealloc_blocks(struct super_block *, struct inode *, uint16_t,
244 			       uint32_t, uint32_t);
245 extern udf_pblk_t udf_new_block(struct super_block *sb, struct inode *inode,
246 				 uint16_t partition, uint32_t goal, int *err);
247 
248 /* directory.c */
249 extern struct fileIdentDesc *udf_fileident_read(struct inode *, loff_t *,
250 						struct udf_fileident_bh *,
251 						struct fileIdentDesc *,
252 						struct extent_position *,
253 						struct kernel_lb_addr *, uint32_t *,
254 						sector_t *);
255 extern struct fileIdentDesc *udf_get_fileident(void *buffer, int bufsize,
256 					       int *offset);
257 extern struct long_ad *udf_get_filelongad(uint8_t *, int, uint32_t *, int);
258 extern struct short_ad *udf_get_fileshortad(uint8_t *, int, uint32_t *, int);
259 
260 /* udftime.c */
261 extern void udf_disk_stamp_to_time(struct timespec *dest,
262 						struct timestamp src);
263 extern void udf_time_to_disk_stamp(struct timestamp *dest, struct timespec src);
264 
265 #endif				/* __UDF_DECL_H */
266