xref: /openbmc/linux/fs/udf/udfdecl.h (revision b732539e)
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 
136 /* file.c */
137 extern long udf_ioctl(struct file *, unsigned int, unsigned long);
138 /* inode.c */
139 extern struct inode *__udf_iget(struct super_block *, struct kernel_lb_addr *,
140 				bool hidden_inode);
141 static inline struct inode *udf_iget_special(struct super_block *sb,
142 					     struct kernel_lb_addr *ino)
143 {
144 	return __udf_iget(sb, ino, true);
145 }
146 static inline struct inode *udf_iget(struct super_block *sb,
147 				     struct kernel_lb_addr *ino)
148 {
149 	return __udf_iget(sb, ino, false);
150 }
151 extern int udf_expand_file_adinicb(struct inode *);
152 extern struct buffer_head *udf_expand_dir_adinicb(struct inode *inode,
153 						  udf_pblk_t *block, int *err);
154 extern struct buffer_head *udf_bread(struct inode *inode, udf_pblk_t block,
155 				      int create, int *err);
156 extern int udf_setsize(struct inode *, loff_t);
157 extern void udf_evict_inode(struct inode *);
158 extern int udf_write_inode(struct inode *, struct writeback_control *wbc);
159 extern udf_pblk_t udf_block_map(struct inode *inode, sector_t block);
160 extern int8_t inode_bmap(struct inode *, sector_t, struct extent_position *,
161 			 struct kernel_lb_addr *, uint32_t *, sector_t *);
162 extern int udf_setup_indirect_aext(struct inode *inode, udf_pblk_t block,
163 				   struct extent_position *epos);
164 extern int __udf_add_aext(struct inode *inode, struct extent_position *epos,
165 			  struct kernel_lb_addr *eloc, uint32_t elen, int inc);
166 extern int udf_add_aext(struct inode *, struct extent_position *,
167 			struct kernel_lb_addr *, uint32_t, int);
168 extern void udf_write_aext(struct inode *, struct extent_position *,
169 			   struct kernel_lb_addr *, uint32_t, int);
170 extern int8_t udf_delete_aext(struct inode *, struct extent_position,
171 			      struct kernel_lb_addr, uint32_t);
172 extern int8_t udf_next_aext(struct inode *, struct extent_position *,
173 			    struct kernel_lb_addr *, uint32_t *, int);
174 extern int8_t udf_current_aext(struct inode *, struct extent_position *,
175 			       struct kernel_lb_addr *, uint32_t *, int);
176 
177 /* misc.c */
178 extern struct buffer_head *udf_tgetblk(struct super_block *sb,
179 					udf_pblk_t block);
180 extern struct buffer_head *udf_tread(struct super_block *sb, udf_pblk_t block);
181 extern struct genericFormat *udf_add_extendedattr(struct inode *, uint32_t,
182 						  uint32_t, uint8_t);
183 extern struct genericFormat *udf_get_extendedattr(struct inode *, uint32_t,
184 						  uint8_t);
185 extern struct buffer_head *udf_read_tagged(struct super_block *, uint32_t,
186 					   uint32_t, uint16_t *);
187 extern struct buffer_head *udf_read_ptagged(struct super_block *,
188 					    struct kernel_lb_addr *, uint32_t,
189 					    uint16_t *);
190 extern void udf_update_tag(char *, int);
191 extern void udf_new_tag(char *, uint16_t, uint16_t, uint16_t, uint32_t, int);
192 
193 /* lowlevel.c */
194 extern unsigned int udf_get_last_session(struct super_block *);
195 extern unsigned long udf_get_last_block(struct super_block *);
196 
197 /* partition.c */
198 extern uint32_t udf_get_pblock(struct super_block *, uint32_t, uint16_t,
199 			       uint32_t);
200 extern uint32_t udf_get_pblock_virt15(struct super_block *, uint32_t, uint16_t,
201 				      uint32_t);
202 extern uint32_t udf_get_pblock_virt20(struct super_block *, uint32_t, uint16_t,
203 				      uint32_t);
204 extern uint32_t udf_get_pblock_spar15(struct super_block *, uint32_t, uint16_t,
205 				      uint32_t);
206 extern uint32_t udf_get_pblock_meta25(struct super_block *, uint32_t, uint16_t,
207 					  uint32_t);
208 extern int udf_relocate_blocks(struct super_block *, long, long *);
209 
210 static inline uint32_t
211 udf_get_lb_pblock(struct super_block *sb, struct kernel_lb_addr *loc,
212 		  uint32_t offset)
213 {
214 	return udf_get_pblock(sb, loc->logicalBlockNum,
215 			loc->partitionReferenceNum, offset);
216 }
217 
218 /* unicode.c */
219 extern int udf_get_filename(struct super_block *, const uint8_t *, int,
220 			    uint8_t *, int);
221 extern int udf_put_filename(struct super_block *, const uint8_t *, int,
222 			    uint8_t *, int);
223 extern int udf_dstrCS0toUTF8(uint8_t *, int, const uint8_t *, int);
224 
225 /* ialloc.c */
226 extern void udf_free_inode(struct inode *);
227 extern struct inode *udf_new_inode(struct inode *, umode_t);
228 
229 /* truncate.c */
230 extern void udf_truncate_tail_extent(struct inode *);
231 extern void udf_discard_prealloc(struct inode *);
232 extern void udf_truncate_extents(struct inode *);
233 
234 /* balloc.c */
235 extern void udf_free_blocks(struct super_block *, struct inode *,
236 			    struct kernel_lb_addr *, uint32_t, uint32_t);
237 extern int udf_prealloc_blocks(struct super_block *, struct inode *, uint16_t,
238 			       uint32_t, uint32_t);
239 extern udf_pblk_t udf_new_block(struct super_block *sb, struct inode *inode,
240 				 uint16_t partition, uint32_t goal, int *err);
241 
242 /* directory.c */
243 extern struct fileIdentDesc *udf_fileident_read(struct inode *, loff_t *,
244 						struct udf_fileident_bh *,
245 						struct fileIdentDesc *,
246 						struct extent_position *,
247 						struct kernel_lb_addr *, uint32_t *,
248 						sector_t *);
249 extern struct fileIdentDesc *udf_get_fileident(void *buffer, int bufsize,
250 					       int *offset);
251 extern struct long_ad *udf_get_filelongad(uint8_t *, int, uint32_t *, int);
252 extern struct short_ad *udf_get_fileshortad(uint8_t *, int, uint32_t *, int);
253 
254 /* udftime.c */
255 extern struct timespec *udf_disk_stamp_to_time(struct timespec *dest,
256 						struct timestamp src);
257 extern struct timestamp *udf_time_to_disk_stamp(struct timestamp *dest, struct timespec src);
258 
259 #endif				/* __UDF_DECL_H */
260