udf_subr.h revision 1.5 1 /* $NetBSD: udf_subr.h,v 1.5 2008/05/14 16:49:48 reinoud Exp $ */
2
3 /*
4 * Copyright (c) 2006, 2008 Reinoud Zandijk
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 */
28
29 #ifndef _FS_UDF_UDF_SUBR_H_
30 #define _FS_UDF_UDF_SUBR_H_
31
32 /* handies */
33 #define VFSTOUDF(mp) ((struct udf_mount *)mp->mnt_data)
34
35
36 /* device information updating */
37 int udf_update_trackinfo(struct udf_mount *ump, struct mmc_trackinfo *trackinfo);
38 int udf_update_discinfo(struct udf_mount *ump);
39 int udf_search_tracks(struct udf_mount *ump, struct udf_args *args,
40 int *first_tracknr, int *last_tracknr);
41 int udf_search_writing_tracks(struct udf_mount *ump);
42 int udf_setup_writeparams(struct udf_mount *ump);
43 int udf_synchronise_caches(struct udf_mount *ump);
44
45 /* tags operations */
46 int udf_fidsize(struct fileid_desc *fid);
47 int udf_check_tag(void *blob);
48 int udf_check_tag_payload(void *blob, uint32_t max_length);
49 void udf_validate_tag_sum(void *blob);
50 void udf_validate_tag_and_crc_sums(void *blob);
51 int udf_tagsize(union dscrptr *dscr, uint32_t udf_sector_size);
52
53 /* read/write descriptors */
54 int udf_read_phys_dscr(
55 struct udf_mount *ump,
56 uint32_t sector,
57 struct malloc_type *mtype, /* where to allocate */
58 union dscrptr **dstp); /* out */
59
60 int udf_write_phys_dscr_sync(struct udf_mount *ump, struct udf_node *udf_node,
61 int what, union dscrptr *dscr,
62 uint32_t sector, uint32_t logsector);
63 int udf_write_phys_dscr_async(struct udf_mount *ump, struct udf_node *udf_node,
64 int what, union dscrptr *dscr,
65 uint32_t sector, uint32_t logsector,
66 void (*dscrwr_callback)(struct buf *));
67
68 /* read/write node descriptors */
69 int udf_create_logvol_dscr(struct udf_mount *ump, struct udf_node *udf_node,
70 struct long_ad *icb, union dscrptr **dscrptr);
71 void udf_free_logvol_dscr(struct udf_mount *ump, struct long_ad *icb_loc,
72 void *dscr);
73 int udf_read_logvol_dscr(struct udf_mount *ump, struct long_ad *icb,
74 union dscrptr **dscrptr);
75 int udf_write_logvol_dscr(struct udf_node *udf_node, union dscrptr *dscr,
76 struct long_ad *icb, int waitfor);
77
78
79 /* volume descriptors readers and checkers */
80 int udf_read_anchors(struct udf_mount *ump);
81 int udf_read_vds_space(struct udf_mount *ump);
82 int udf_process_vds(struct udf_mount *ump);
83 int udf_read_vds_tables(struct udf_mount *ump);
84 int udf_read_rootdirs(struct udf_mount *ump);
85
86 /* open/close and sync volumes */
87 int udf_open_logvol(struct udf_mount *ump);
88 int udf_close_logvol(struct udf_mount *ump, int mntflags);
89 int udf_writeout_vat(struct udf_mount *ump);
90 int udf_write_partition_spacetables(struct udf_mount *ump, int waitfor);
91 void udf_do_sync(struct udf_mount *ump, kauth_cred_t cred, int waitfor);
92
93 /* translation services */
94 int udf_translate_vtop(struct udf_mount *ump, struct long_ad *icb_loc,
95 uint32_t *lb_numres, uint32_t *extres);
96 int udf_translate_file_extent(struct udf_node *node,
97 uint32_t from, uint32_t num_lb, uint64_t *map);
98 void udf_get_adslot(struct udf_node *udf_node, int slot, struct long_ad *icb, int *eof);
99 int udf_append_adslot(struct udf_node *udf_node, int slot, struct long_ad *icb);
100
101 int udf_vat_read(struct udf_node *vat_node, uint8_t *blob, int size, uint32_t offset);
102 int udf_vat_write(struct udf_node *vat_node, uint8_t *blob, int size, uint32_t offset);
103
104 /* disc allocation */
105 void udf_late_allocate_buf(struct udf_mount *ump, struct buf *buf, uint64_t *lmapping, uint64_t *pmapping, struct long_ad *node_ad_cpy);
106 void udf_free_allocated_space(struct udf_mount *ump, uint32_t lb_num, uint16_t vpart_num, uint32_t num_lb);
107 int udf_pre_allocate_space(struct udf_mount *ump, int udf_c_type, int num_lb, uint16_t *alloc_partp, uint64_t *lmapping, uint64_t *pmapping);
108 int udf_grow_node(struct udf_node *node, uint64_t new_size);
109 int udf_shrink_node(struct udf_node *node, uint64_t new_size);
110
111 /* node readers and writers */
112 uint64_t udf_advance_uniqueid(struct udf_mount *ump);
113
114 #define UDF_LOCK_NODE(udf_node, flag) udf_lock_node(udf_node, (flag), __FILE__, __LINE__)
115 #define UDF_UNLOCK_NODE(udf_node, flag) udf_unlock_node(udf_node, (flag))
116 void udf_lock_node(struct udf_node *udf_node, int flag, char const *fname, const int lineno);
117 void udf_unlock_node(struct udf_node *udf_node, int flag);
118
119 int udf_get_node(struct udf_mount *ump, struct long_ad *icbloc, struct udf_node **noderes);
120 int udf_writeout_node(struct udf_node *udf_node, int waitfor);
121 int udf_dispose_node(struct udf_node *node);
122
123 /* node ops */
124 int udf_resize_node(struct udf_node *node, uint64_t new_size, int *extended);
125 int udf_extattr_search_intern(struct udf_node *node, uint32_t sattr, char const *sattrname, uint32_t *offsetp, uint32_t *lengthp);
126
127 /* node data buffer read/write */
128 void udf_read_filebuf(struct udf_node *node, struct buf *buf);
129 void udf_write_filebuf(struct udf_node *node, struct buf *buf);
130 void udf_fixup_fid_block(uint8_t *blob, int lb_size, int rfix_pos, int max_rfix_pos, uint32_t lb_num);
131 void udf_fixup_internal_extattr(uint8_t *blob, uint32_t lb_num);
132 void udf_fixup_node_internals(struct udf_mount *ump, uint8_t *blob, int udf_c_type);
133
134 /* device strategy */
135 void udf_discstrat_init(struct udf_mount *ump);
136 void udf_discstrat_finish(struct udf_mount *ump);
137 void udf_discstrat_queuebuf(struct udf_mount *ump, struct buf *nestbuf);
138
139 /* structure writers */
140 int udf_write_terminator(struct udf_mount *ump, uint32_t sector);
141
142 /* structure creators */
143 void udf_set_regid(struct regid *regid, char const *name);
144 void udf_add_domain_regid(struct udf_mount *ump, struct regid *regid);
145 void udf_add_udf_regid(struct udf_mount *ump, struct regid *regid);
146 void udf_add_impl_regid(struct udf_mount *ump, struct regid *regid);
147 void udf_add_app_regid(struct udf_mount *ump, struct regid *regid);
148
149 /* directory operations and helpers */
150 void udf_osta_charset(struct charspec *charspec);
151 int udf_read_fid_stream(struct vnode *vp, uint64_t *offset, struct fileid_desc *fid, struct dirent *dirent);
152 int udf_lookup_name_in_dir(struct vnode *vp, const char *name, int namelen, struct long_ad *icb_loc);
153 int udf_create_node(struct vnode *dvp, struct vnode **vpp, struct vattr *vap, struct componentname *cnp);
154 void udf_delete_node(struct udf_node *udf_node);
155
156 int udf_chsize(struct vnode *vp, u_quad_t newsize, kauth_cred_t cred);
157 int udf_dir_detach(struct udf_mount *ump, struct udf_node *dir_node, struct udf_node *udf_node, struct componentname *cnp);
158 int udf_dir_attach(struct udf_mount *ump, struct udf_node *dir_node, struct udf_node *udf_node, struct vattr *vap, struct componentname *cnp);
159
160 /* update and times */
161 void udf_add_to_dirtylist(struct udf_node *udf_node);
162 void udf_remove_from_dirtylist(struct udf_node *udf_node);
163 void udf_itimes(struct udf_node *udf_node, struct timespec *acc,
164 struct timespec *mod, struct timespec *changed);
165 int udf_update(struct vnode *node, struct timespec *acc,
166 struct timespec *mod, int updflags);
167
168 /* helpers and converters */
169 long udf_calchash(struct long_ad *icbptr); /* for `inode' numbering */
170 uint32_t udf_getaccessmode(struct udf_node *node);
171 void udf_setaccessmode(struct udf_node *udf_node, mode_t mode);
172 void udf_getownership(struct udf_node *udf_node, uid_t *uidp, gid_t *gidp);
173 void udf_setownership(struct udf_node *udf_node, uid_t uid, gid_t gid);
174
175 void udf_to_unix_name(char *result, char *id, int len, struct charspec *chsp);
176 void unix_to_udf_name(char *result, uint8_t *result_len, char const *name, int name_len, struct charspec *chsp);
177
178 void udf_timestamp_to_timespec(struct udf_mount *ump, struct timestamp *timestamp, struct timespec *timespec);
179 void udf_timespec_to_timestamp(struct timespec *timespec, struct timestamp *timestamp);
180
181 /* vnode operations */
182 int udf_inactive(void *v);
183 int udf_reclaim(void *v);
184 int udf_readdir(void *v);
185 int udf_getattr(void *v);
186 int udf_setattr(void *v);
187 int udf_pathconf(void *v);
188 int udf_open(void *v);
189 int udf_close(void *v);
190 int udf_access(void *v);
191 int udf_read(void *v);
192 int udf_write(void *v);
193 int udf_trivial_bmap(void *v);
194 int udf_vfsstrategy(void *v);
195 int udf_lookup(void *v);
196 int udf_create(void *v);
197 int udf_mknod(void *v);
198 int udf_link(void *);
199 int udf_symlink(void *v);
200 int udf_readlink(void *v);
201 int udf_rename(void *v);
202 int udf_remove(void *v);
203 int udf_mkdir(void *v);
204 int udf_rmdir(void *v);
205 int udf_fsync(void *v);
206 int udf_advlock(void *v);
207
208 #endif /* !_FS_UDF_UDF_SUBR_H_ */
209