1 /* $NetBSD: udf_subr.h,v 1.21 2020/01/17 20:08:08 ad 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 void udf_mmc_synchronise_caches(struct udf_mount *ump); 44 void udf_synchronise_caches(struct udf_mount *ump); 45 46 /* tags operations */ 47 int udf_fidsize(struct fileid_desc *fid); 48 int udf_check_tag(void *blob); 49 int udf_check_tag_payload(void *blob, uint32_t max_length); 50 void udf_validate_tag_sum(void *blob); 51 void udf_validate_tag_and_crc_sums(void *blob); 52 int udf_tagsize(union dscrptr *dscr, uint32_t udf_sector_size); 53 54 /* read/write descriptors */ 55 int udf_read_phys_sectors(struct udf_mount *ump, int what, void *blob, 56 uint32_t start, uint32_t sectors); 57 int udf_write_phys_sectors(struct udf_mount *ump, int what, void *blob, 58 uint32_t start, uint32_t sectors); 59 int udf_read_phys_dscr( 60 struct udf_mount *ump, 61 uint32_t sector, 62 struct malloc_type *mtype, /* where to allocate */ 63 union dscrptr **dstp); /* out */ 64 65 int udf_write_phys_dscr_sync(struct udf_mount *ump, struct udf_node *udf_node, 66 int what, union dscrptr *dscr, 67 uint32_t sector, uint32_t logsector); 68 int udf_write_phys_dscr_async(struct udf_mount *ump, struct udf_node *udf_node, 69 int what, union dscrptr *dscr, 70 uint32_t sector, uint32_t logsector, 71 void (*dscrwr_callback)(struct buf *)); 72 73 /* read/write node descriptors */ 74 int udf_create_logvol_dscr(struct udf_mount *ump, struct udf_node *udf_node, 75 struct long_ad *icb, union dscrptr **dscrptr); 76 void udf_free_logvol_dscr(struct udf_mount *ump, struct long_ad *icb_loc, 77 void *dscr); 78 int udf_read_logvol_dscr(struct udf_mount *ump, struct long_ad *icb, 79 union dscrptr **dscrptr); 80 int udf_write_logvol_dscr(struct udf_node *udf_node, union dscrptr *dscr, 81 struct long_ad *icb, int waitfor); 82 83 84 /* volume descriptors readers and checkers */ 85 int udf_read_anchors(struct udf_mount *ump); 86 int udf_read_vds_space(struct udf_mount *ump); 87 int udf_process_vds(struct udf_mount *ump); 88 int udf_read_vds_tables(struct udf_mount *ump); 89 int udf_read_rootdirs(struct udf_mount *ump); 90 91 /* open/close and sync volumes */ 92 int udf_open_logvol(struct udf_mount *ump); 93 int udf_close_logvol(struct udf_mount *ump, int mntflags); 94 int udf_writeout_vat(struct udf_mount *ump); 95 int udf_write_physical_partition_spacetables(struct udf_mount *ump, int waitfor); 96 int udf_write_metadata_partition_spacetable(struct udf_mount *ump, int waitfor); 97 void udf_do_sync(struct udf_mount *ump, kauth_cred_t cred, int waitfor); 98 void udf_synchronise_metadatamirror_node(struct udf_mount *ump); 99 100 /* translation services */ 101 int udf_translate_vtop(struct udf_mount *ump, struct long_ad *icb_loc, 102 uint32_t *lb_numres, uint32_t *extres); 103 void udf_translate_vtop_list(struct udf_mount *ump, uint32_t sectors, 104 uint16_t vpart_num, uint64_t *lmapping, uint64_t *pmapping); 105 int udf_translate_file_extent(struct udf_node *node, 106 uint32_t from, uint32_t num_lb, uint64_t *map); 107 void udf_get_adslot(struct udf_node *udf_node, int slot, struct long_ad *icb, int *eof); 108 int udf_append_adslot(struct udf_node *udf_node, int *slot, struct long_ad *icb); 109 110 int udf_vat_read(struct udf_node *vat_node, uint8_t *blob, int size, uint32_t offset); 111 int udf_vat_write(struct udf_node *vat_node, uint8_t *blob, int size, uint32_t offset); 112 113 /* disc allocation */ 114 int udf_get_c_type(struct udf_node *udf_node); 115 int udf_get_record_vpart(struct udf_mount *ump, int udf_c_type); 116 void udf_do_reserve_space(struct udf_mount *ump, struct udf_node *udf_node, uint16_t vpart_num, uint32_t num_lb); 117 void udf_do_unreserve_space(struct udf_mount *ump, struct udf_node *udf_node, uint16_t vpart_num, uint32_t num_lb); 118 int udf_reserve_space(struct udf_mount *ump, struct udf_node *udf_node, int udf_c_type, uint16_t vpart_num, uint32_t num_lb, int can_fail); 119 void udf_cleanup_reservation(struct udf_node *udf_node); 120 int udf_allocate_space(struct udf_mount *ump, struct udf_node *udf_node, int udf_c_type, uint16_t vpart_num, uint32_t num_lb, uint64_t *lmapping); 121 void udf_free_allocated_space(struct udf_mount *ump, uint32_t lb_num, uint16_t vpart_num, uint32_t num_lb); 122 void udf_late_allocate_buf(struct udf_mount *ump, struct buf *buf, uint64_t *lmapping, struct long_ad *node_ad_cpy, uint16_t *vpart_num); 123 int udf_grow_node(struct udf_node *node, uint64_t new_size); 124 int udf_shrink_node(struct udf_node *node, uint64_t new_size); 125 void udf_calc_freespace(struct udf_mount *ump, uint64_t *sizeblks, uint64_t *freeblks); 126 127 /* node readers and writers */ 128 uint64_t udf_advance_uniqueid(struct udf_mount *ump); 129 130 #define UDF_LOCK_NODE(udf_node, flag) udf_lock_node(udf_node, (flag), __FILE__, __LINE__) 131 #define UDF_UNLOCK_NODE(udf_node, flag) udf_unlock_node(udf_node, (flag)) 132 void udf_lock_node(struct udf_node *udf_node, int flag, char const *fname, const int lineno); 133 void udf_unlock_node(struct udf_node *udf_node, int flag); 134 135 int udf_get_node(struct udf_mount *ump, struct long_ad *icbloc, struct udf_node **noderes, int); 136 int udf_writeout_node(struct udf_node *udf_node, int waitfor); 137 int udf_dispose_node(struct udf_node *node); 138 139 /* node ops */ 140 int udf_resize_node(struct udf_node *node, uint64_t new_size, int *extended); 141 int udf_extattr_search_intern(struct udf_node *node, uint32_t sattr, char const *sattrname, uint32_t *offsetp, uint32_t *lengthp); 142 143 /* node data buffer read/write */ 144 void udf_read_filebuf(struct udf_node *node, struct buf *buf); 145 void udf_write_filebuf(struct udf_node *node, struct buf *buf); 146 void udf_fixup_fid_block(uint8_t *blob, int lb_size, int rfix_pos, int max_rfix_pos, uint32_t lb_num); 147 void udf_fixup_internal_extattr(uint8_t *blob, uint32_t lb_num); 148 void udf_fixup_node_internals(struct udf_mount *ump, uint8_t *blob, int udf_c_type); 149 150 /* device strategy */ 151 void udf_discstrat_init(struct udf_mount *ump); 152 void udf_discstrat_finish(struct udf_mount *ump); 153 void udf_discstrat_queuebuf(struct udf_mount *ump, struct buf *nestbuf); 154 155 /* structure writers */ 156 int udf_write_terminator(struct udf_mount *ump, uint32_t sector); 157 158 /* structure creators */ 159 void udf_inittag(struct udf_mount *ump, struct desc_tag *tag, int tagid, uint32_t sector); 160 void udf_set_regid(struct regid *regid, char const *name); 161 void udf_add_domain_regid(struct udf_mount *ump, struct regid *regid); 162 void udf_add_udf_regid(struct udf_mount *ump, struct regid *regid); 163 void udf_add_impl_regid(struct udf_mount *ump, struct regid *regid); 164 void udf_add_app_regid(struct udf_mount *ump, struct regid *regid); 165 166 /* directory operations and helpers */ 167 void udf_osta_charset(struct charspec *charspec); 168 int udf_read_fid_stream(struct vnode *vp, uint64_t *offset, struct fileid_desc *fid, struct dirent *dirent); 169 int udf_lookup_name_in_dir(struct vnode *vp, const char *name, int namelen, struct long_ad *icb_loc, int *found); 170 int udf_create_node(struct vnode *dvp, struct vnode **vpp, struct vattr *vap, struct componentname *cnp); 171 void udf_delete_node(struct udf_node *udf_node); 172 173 int udf_chsize(struct vnode *vp, u_quad_t newsize, kauth_cred_t cred); 174 175 int udf_dir_detach(struct udf_mount *ump, struct udf_node *dir_node, struct udf_node *udf_node, struct componentname *cnp); 176 int udf_dir_attach(struct udf_mount *ump, struct udf_node *dir_node, struct udf_node *udf_node, struct vattr *vap, struct componentname *cnp); 177 int udf_dir_update_rootentry(struct udf_mount *ump, struct udf_node *dir_node, struct udf_node *new_parent_node); 178 int udf_dirhash_fill(struct udf_node *dir_node); 179 180 /* update and times */ 181 void udf_add_to_dirtylist(struct udf_node *udf_node); 182 void udf_remove_from_dirtylist(struct udf_node *udf_node); 183 void udf_itimes(struct udf_node *udf_node, struct timespec *acc, 184 struct timespec *mod, struct timespec *birth); 185 int udf_update(struct vnode *node, struct timespec *acc, 186 struct timespec *mod, struct timespec *birth, int updflags); 187 188 /* helpers and converters */ 189 void udf_init_nodes_tree(struct udf_mount *ump); 190 long udf_get_node_id(const struct long_ad *icbptr); /* for `inode' numbering */ 191 int udf_compare_icb(const struct long_ad *a, const struct long_ad *b); 192 uint32_t udf_getaccessmode(struct udf_node *node); 193 void udf_setaccessmode(struct udf_node *udf_node, mode_t mode); 194 void udf_getownership(struct udf_node *udf_node, uid_t *uidp, gid_t *gidp); 195 void udf_setownership(struct udf_node *udf_node, uid_t uid, gid_t gid); 196 197 void udf_to_unix_name(char *result, int result_len, char *id, int len, struct charspec *chsp); 198 void unix_to_udf_name(char *result, uint8_t *result_len, char const *name, int name_len, struct charspec *chsp); 199 200 void udf_timestamp_to_timespec(struct udf_mount *ump, struct timestamp *timestamp, struct timespec *timespec); 201 void udf_timespec_to_timestamp(struct timespec *timespec, struct timestamp *timestamp); 202 203 /* vnode operations */ 204 int udf_inactive(void *v); 205 int udf_reclaim(void *v); 206 int udf_readdir(void *v); 207 int udf_getattr(void *v); 208 int udf_setattr(void *v); 209 int udf_pathconf(void *v); 210 int udf_open(void *v); 211 int udf_close(void *v); 212 int udf_access(void *v); 213 int udf_read(void *v); 214 int udf_write(void *v); 215 int udf_trivial_bmap(void *v); 216 int udf_vfsstrategy(void *v); 217 int udf_lookup(void *v); 218 int udf_create(void *v); 219 int udf_mknod(void *v); 220 int udf_link(void *); 221 int udf_symlink(void *v); 222 int udf_readlink(void *v); 223 int udf_rename(void *v); 224 int udf_remove(void *v); 225 int udf_mkdir(void *v); 226 int udf_rmdir(void *v); 227 int udf_fsync(void *v); 228 int udf_advlock(void *v); 229 230 #endif /* !_FS_UDF_UDF_SUBR_H_ */ 231
Indexes created Sat Sep 20 22:09:52 GMT 2025