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