xref: /freebsd/sys/fs/udf/udf.h (revision 74bf4e164ba5851606a27d4feff27717452583e5)
1 /*-
2  * Copyright (c) 2001, 2002 Scott Long <scottl@freebsd.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #define UDF_HASHTBLSIZE 100
30 
31 struct udf_node {
32 	LIST_ENTRY(udf_node)	le;
33 	struct vnode	*i_vnode;
34 	struct vnode	*i_devvp;
35 	struct udf_mnt	*udfmp;
36 	struct cdev *i_dev;
37 	ino_t		hash_id;
38 	long		diroff;
39 	struct file_entry *fentry;
40 };
41 
42 struct udf_mnt {
43 	int			im_flags;
44 	struct mount		*im_mountp;
45 	struct cdev *im_dev;
46 	struct vnode		*im_devvp;
47 	int			bsize;
48 	int			bshift;
49 	int			bmask;
50 	uint32_t		part_start;
51 	uint32_t		part_len;
52 	uint64_t		root_id;
53 	struct vnode		*root_vp;
54 	struct long_ad		root_icb;
55 	LIST_HEAD(udf_hash_lh, udf_node)	*hashtbl;
56 	u_long			hashsz;
57 	struct mtx		hash_mtx;
58 	int			p_sectors;
59 	int			s_table_entries;
60 	struct udf_sparing_table *s_table;
61 	void			*im_d2l;	/* disk->local iconv handle */
62 #if 0
63 	void			*im_l2d;	/* local->disk iconv handle */
64 #endif
65 };
66 
67 struct udf_dirstream {
68 	struct udf_node	*node;
69 	struct udf_mnt	*udfmp;
70 	struct buf	*bp;
71 	uint8_t		*data;
72 	uint8_t		*buf;
73 	int		fsize;
74 	int		off;
75 	int		this_off;
76 	int		offset;
77 	int		size;
78 	int		error;
79 	int		fid_fragment;
80 };
81 
82 #define	VFSTOUDFFS(mp)	((struct udf_mnt *)((mp)->mnt_data))
83 #define	VTON(vp)	((struct udf_node *)((vp)->v_data))
84 
85 /*
86  * The block layer refers to things in terms of 512 byte blocks by default.
87  * btodb() is expensive, so speed things up.
88  * XXX Can the block layer be forced to use a different block size?
89  */
90 #define	RDSECTOR(devvp, sector, size, bp) \
91 	bread(devvp, sector << (udfmp->bshift - DEV_BSHIFT), size, NOCRED, bp)
92 
93 MALLOC_DECLARE(M_UDFFENTRY);
94 
95 static __inline int
96 udf_readlblks(struct udf_mnt *udfmp, int sector, int size, struct buf **bp)
97 {
98 	return (RDSECTOR(udfmp->im_devvp, sector,
99 			 (size + udfmp->bmask) & ~udfmp->bmask, bp));
100 }
101 
102 static __inline int
103 udf_readalblks(struct udf_mnt *udfmp, int lsector, int size, struct buf **bp)
104 {
105 	daddr_t rablock, lblk;
106 	int rasize;
107 
108 	lblk = (lsector + udfmp->part_start) << (udfmp->bshift - DEV_BSHIFT);
109 	rablock = (lblk + 1) << udfmp->bshift;
110 	rasize = size;
111 
112 	return (breadn(udfmp->im_devvp, lblk,
113 		       (size + udfmp->bmask) & ~udfmp->bmask,
114 		       &rablock, &rasize, 1,  NOCRED, bp));
115 }
116 
117 /*
118  * Produce a suitable file number from an ICB.  The passed in ICB is expected
119  * to be in little endian (meaning that it hasn't been swapped for big
120  * endian machines yet).
121  * XXX If the fileno resolves to 0, we might be in big trouble.
122  * XXX Assumes the ICB is a long_ad.  This struct is compatible with short_ad,
123  *     but not ext_ad.
124  */
125 static __inline ino_t
126 udf_getid(struct long_ad *icb)
127 {
128 	return (le32toh(icb->loc.lb_num));
129 }
130 
131 int udf_allocv(struct mount *, struct vnode **, struct thread *);
132 int udf_hashlookup(struct udf_mnt *, ino_t, int, struct vnode **);
133 int udf_hashins(struct udf_node *);
134 int udf_hashrem(struct udf_node *);
135 int udf_checktag(struct desc_tag *, uint16_t);
136 int udf_vget(struct mount *, ino_t, int, struct vnode **);
137 
138 extern uma_zone_t udf_zone_trans;
139 extern uma_zone_t udf_zone_node;
140 extern uma_zone_t udf_zone_ds;
141