hfs.h revision 1.3 1 /* $NetBSD: hfs.h,v 1.3 2007/03/22 13:21:28 dillo Exp $ */
2
3 /*-
4 * Copyright (c) 2005, 2007 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Yevgeny Binder and Dieter Baron.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef _FS_HFS_HFS_H_
33 #define _FS_HFS_HFS_H_
34
35 #include <sys/vnode.h>
36 #include <sys/mount.h>
37
38 #include <miscfs/genfs/genfs_node.h>
39
40 /* XXX remove before release */
41 /*#define HFS_DEBUG*/
42
43 #ifdef HFS_DEBUG
44 #if defined(_KERNEL) && !defined(_LKM)
45 #include "opt_ddb.h"
46 #endif /* defined(_KERNEL_) && !defined(_LKM) */
47 #endif /* HFS_DEBUG */
48
49 #include <fs/hfs/libhfs.h>
50
51 /* XXX: make these mount options */
52 #define HFS_DEFAULT_UID 0
53 #define HFS_DEFAULT_GID 0
54 #define HFS_DEFAULT_DIR_MODE 0755
55 #define HFS_DEFAULT_FILE_MODE 0755
56
57 MALLOC_DECLARE(M_HFSMNT); /* defined in hfs_vfsops.c */
58
59 struct hfs_args {
60 char *fspec; /* block special device to mount */
61 };
62
63 struct hfsmount {
64 struct mount *hm_mountp; /* filesystem vfs structure */
65 dev_t hm_dev; /* device mounted */
66 struct vnode *hm_devvp; /* block device mounted vnode */
67 hfs_volume hm_vol; /* essential volume information */
68 };
69
70 struct hfsnode {
71 struct genfs_node h_gnode;
72 LIST_ENTRY(hfsnode) h_hash;/* hash chain */
73 struct vnode *h_vnode; /* vnode associated with this hnode */
74 struct hfsmount *h_hmp; /* mount point associated with this hnode */
75 struct vnode *h_devvp; /* vnode for block I/O */
76 dev_t h_dev; /* device associated with this hnode */
77
78 union {
79 hfs_file_record_t file;
80 hfs_folder_record_t folder;
81 struct {
82 int16_t rec_type;
83 uint16_t flags;
84 uint32_t valence;
85 hfs_cnid_t cnid;
86 }; /* convenience for accessing common record info */
87 } h_rec; /* catalog record for this hnode */
88
89 /*
90 * We cache this vnode's parent CNID here upon vnode creation (i.e., during
91 * hfs_vop_vget()) for quick access without needing to search the catalog.
92 * Note, however, that this value must also be updated whenever this file
93 * is moved.
94 */
95 hfs_cnid_t h_parent;
96
97 uint8_t h_fork;
98
99 long dummy; /* FOR DEVELOPMENT ONLY */
100 };
101
102 typedef struct {
103 struct vnode* devvp; /* vnode for device I/O */
104 size_t devblksz; /* device block size (NOT HFS+ allocation block size)*/
105 } hfs_libcb_data; /* custom data used in hfs_volume.cbdata */
106
107 typedef struct {
108 kauth_cred_t cred;
109 struct lwp *l;
110 struct vnode *devvp;
111 } hfs_libcb_argsopen;
112
113 typedef struct {
114 struct lwp *l;
115 } hfs_libcb_argsclose;
116
117 typedef struct {
118 kauth_cred_t cred;
119 struct lwp *l;
120 } hfs_libcb_argsread;
121
122 /*
123 * Convenience macros
124 */
125
126 /* Convert mount ptr to hfsmount ptr. */
127 #define VFSTOHFS(mp) ((struct hfsmount *)((mp)->mnt_data))
128
129 /* Convert between vnode ptrs and hfsnode ptrs. */
130 #define VTOH(vp) ((struct hfsnode *)(vp)->v_data)
131 #define HTOV(hp) ((hp)->h_vnode)
132
133 /* Get volume's allocation block size given a vnode ptr */
134 #define HFS_BLOCKSIZE(vp) (VTOH(vp)->h_hmp->hm_vol.vh.block_size)
135
136
137 /* Convert special device major/minor */
138 #define HFS_CONVERT_RDEV(x) makedev((x)>>24, (x)&0xffffff)
139
140 /*
141 * Global variables
142 */
143
144 extern const struct vnodeopv_desc hfs_vnodeop_opv_desc;
145 extern const struct vnodeopv_desc hfs_specop_opv_desc;
146 extern const struct vnodeopv_desc hfs_fifoop_opv_desc;
147 extern int (**hfs_specop_p) (void *);
148 extern int (**hfs_fifoop_p) (void *);
149
150
151 /*
152 * Function prototypes
153 */
154
155 /* hfs_nhash.c */
156 void hfs_nhashinit (void);
157 void hfs_nhashdone (void);
158 struct vnode *hfs_nhashget (dev_t, hfs_cnid_t, uint8_t, int);
159 void hfs_nhashinsert (struct hfsnode *);
160 void hfs_nhashremove (struct hfsnode *);
161
162 /* hfs_subr.c */
163 void hfs_vinit (struct mount *, int (**)(void *), int (**)(void *),
164 struct vnode **);
165 int hfs_pread(struct vnode*, void*, size_t, uint64_t, uint64_t, kauth_cred_t);
166 char* hfs_unicode_to_ascii(const unichar_t*, uint8_t, char*);
167 unichar_t* hfs_ascii_to_unicode(const char*, uint8_t, unichar_t*);
168
169 void hfs_time_to_timespec(uint32_t, struct timespec *);
170 enum vtype hfs_catalog_keyed_record_vtype(const hfs_catalog_keyed_record_t *);
171
172 void hfs_libcb_error(const char*, const char*, int, va_list);
173 void* hfs_libcb_malloc(size_t, hfs_callback_args*);
174 void* hfs_libcb_realloc(void*, size_t, hfs_callback_args*);
175 void hfs_libcb_free(void*, hfs_callback_args*);
176 int hfs_libcb_opendev(hfs_volume*, const char*, hfs_callback_args*);
177 void hfs_libcb_closedev(hfs_volume*, hfs_callback_args*);
178 int hfs_libcb_read(hfs_volume*, void*, uint64_t, uint64_t,
179 hfs_callback_args*);
180
181 uint16_t be16tohp(void**);
182 uint32_t be32tohp(void**);
183 uint64_t be64tohp(void**);
184
185
186 /* hfs_vfsops.c */
187 int hfs_mount (struct mount *, const char *, void *, struct nameidata *,
188 struct lwp *);
189 int hfs_mountfs (struct vnode *, struct mount *, struct lwp *, const char *);
190 int hfs_start (struct mount *, int, struct lwp *);
191 int hfs_unmount (struct mount *, int, struct lwp *);
192 int hfs_root (struct mount *, struct vnode **);
193 int hfs_quotactl (struct mount *, int, uid_t, void *, struct lwp *);
194 int hfs_statvfs (struct mount *, struct statvfs *, struct lwp *);
195 int hfs_sync (struct mount *, int, kauth_cred_t , struct lwp *);
196 int hfs_vget (struct mount *, ino_t, struct vnode **);
197 int hfs_vget_internal(struct mount *, ino_t, uint8_t, struct vnode **);
198 int hfs_fhtovp (struct mount *, struct fid *, struct vnode **);
199 int hfs_vptofh (struct vnode *, struct fid *, size_t *);
200 void hfs_init (void);
201 void hfs_reinit (void);
202 void hfs_done (void);
203 int hfs_mountroot (void);
204 int hfs_extattrctl (struct mount *, int, struct vnode *, int, const char *,
205 struct lwp *);
206
207 /* hfs_vnops.c */
208 extern int (**hfs_vnodeop_p) (void *);
209
210 #endif /* !_FS_HFS_HFS_H_ */
211