1/* $NetBSD: hfs.h,v 1.12 2020/07/24 05:26:37 skrll 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)
45 #include "opt_ddb.h"
46 #endif /* defined(_KERNEL_) */
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
57struct hfs_args {
58 char *fspec; /* block special device to mount */
59};
60
61struct hfsmount {
62 struct mount *hm_mountp; /* filesystem vfs structure */
63 dev_t hm_dev; /* device mounted */
64 struct vnode *hm_devvp; /* block device mounted vnode */
65 hfs_volume hm_vol; /* essential volume information */
66};
67
68struct hfsnode_key {
69 hfs_cnid_t hnk_cnid;
70 uint8_t hnk_fork;
71};
72
73struct hfsnode {
74 struct genfs_node h_gnode;
75 struct vnode *h_vnode; /* vnode associated with this hnode */
76 struct hfsmount *h_hmp; /* mount point associated with this hnode */
77 struct vnode *h_devvp; /* vnode for block I/O */
78 dev_t h_dev; /* device associated with this hnode */
79
80 union {
81 hfs_file_record_t file;
82 hfs_folder_record_t folder;
83 struct {
84 int16_t rec_type;
85 uint16_t flags;
86 uint32_t valence;
87 hfs_cnid_t cnid;
88 } u; /* convenience for accessing common record info */
89 } h_rec; /* catalog record for this hnode */
90
91 /*
92 * We cache this vnode's parent CNID here upon vnode creation (i.e., during
93 * hfs_vop_vget()) for quick access without needing to search the catalog.
94 * Note, however, that this value must also be updated whenever this file
95 * is moved.
96 */
97 hfs_cnid_t h_parent;
98
99 struct hfsnode_key h_key;
100#define h_fork h_key.hnk_fork
101
102 long dummy; /* FOR DEVELOPMENT ONLY */
103};
104
105typedef struct {
106 struct vnode* devvp; /* vnode for device I/O */
107 size_t devblksz; /* device block size (NOT HFS+ allocation block size)*/
108} hfs_libcb_data; /* custom data used in hfs_volume.cbdata */
109
110typedef struct {
111 kauth_cred_t cred;
112 struct lwp *l;
113 struct vnode *devvp;
114} hfs_libcb_argsopen;
115
116typedef struct {
117 struct lwp *l;
118} hfs_libcb_argsclose;
119
120typedef struct {
121 kauth_cred_t cred;
122 struct lwp *l;
123} hfs_libcb_argsread;
124
125#ifdef _KERNEL
126#include <sys/malloc.h>
127
128MALLOC_DECLARE(M_HFSMNT); /* defined in hfs_vfsops.c */
129
130/*
131 * Convenience macros
132 */
133
134/* Convert mount ptr to hfsmount ptr. */
135#define VFSTOHFS(mp) ((struct hfsmount *)((mp)->mnt_data))
136
137/* Convert between vnode ptrs and hfsnode ptrs. */
138#define VTOH(vp) ((struct hfsnode *)(vp)->v_data)
139#define HTOV(hp) ((hp)->h_vnode)
140
141/* Get volume's allocation block size given a vnode ptr */
142#define HFS_BLOCKSIZE(vp) (VTOH(vp)->h_hmp->hm_vol.vh.block_size)
143
144
145/* Convert special device major/minor */
146#define HFS_CONVERT_RDEV(x) makedev((x)>>24, (x)&0xffffff)
147
148/*
149 * Global variables
150 */
151
152extern const struct vnodeopv_desc hfs_vnodeop_opv_desc;
153extern const struct vnodeopv_desc hfs_specop_opv_desc;
154extern const struct vnodeopv_desc hfs_fifoop_opv_desc;
155extern int (**hfs_specop_p) (void *);
156extern int (**hfs_fifoop_p) (void *);
157extern struct pool hfs_node_pool;
158
159
160/*
161 * Function prototypes
162 */
163
164/* hfs_subr.c */
165void hfs_vinit (struct mount *, int (**)(void *), int (**)(void *),
166 struct vnode **);
167int hfs_pread(struct vnode*, void*, size_t, uint64_t, uint64_t, kauth_cred_t);
168char* hfs_unicode_to_ascii(const unichar_t*, uint8_t, char*);
169unichar_t* hfs_ascii_to_unicode(const char*, uint8_t, unichar_t*);
170
171void hfs_time_to_timespec(uint32_t, struct timespec *);
172enum vtype hfs_catalog_keyed_record_vtype(const hfs_catalog_keyed_record_t *);
173
174void hfs_libcb_error(const char*, const char*, int, va_list);
175void* hfs_libcb_malloc(size_t, hfs_callback_args*);
176void* hfs_libcb_realloc(void*, size_t, hfs_callback_args*);
177void hfs_libcb_free(void*, hfs_callback_args*);
178int hfs_libcb_opendev(hfs_volume*, const char*, hfs_callback_args*);
179void hfs_libcb_closedev(hfs_volume*, hfs_callback_args*);
180int hfs_libcb_read(hfs_volume*, void*, uint64_t, uint64_t,
181 hfs_callback_args*);
182
183uint16_t be16tohp(void**);
184uint32_t be32tohp(void**);
185uint64_t be64tohp(void**);
186
187
188/* hfs_vfsops.c */
189VFS_PROTOS(hfs);
190
191int hfs_mountfs (struct vnode *, struct mount *, struct lwp *, const char *);
192int hfs_vget_internal(struct mount *, ino_t, uint8_t, struct vnode **);
193
194/* hfs_vnops.c */
195extern int (**hfs_vnodeop_p) (void *);
196
197#endif /* _KERNEL */
198
199#endif /* !_FS_HFS_HFS_H_ */