perfuse_priv.h revision 1.1 1 /* $NetBSD: perfuse_priv.h,v 1.1 2010/08/25 07:16:00 manu Exp $ */
2
3 /*-
4 * Copyright (c) 2010 Emmanuel Dreyfus. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 * POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #ifndef _PERFUSE_PRIV_H_
29 #define _PERFUSE_PRIV_H_
30
31 #include <syslog.h>
32 #include <paths.h>
33 #include <err.h>
34 #include <sysexits.h>
35 #include <puffs.h>
36
37 #include "perfuse_if.h"
38 #include "fuse.h"
39
40 struct perfuse_state {
41 void *ps_private; /* Private field for libperfuse user */
42 struct puffs_usermount *ps_pu;
43 struct puffs_node *ps_root;
44 uid_t ps_uid;
45 gid_t ps_gid;
46 pid_t ps_pid;
47 int ps_flags;
48 #define PS_NO_ACCESS 0x0001 /* access is unimplemented; */
49 #define PS_NO_FSYNC 0x0002 /* fsync is unimplemented */
50 #define PS_NO_CREAT 0x0004 /* create is unimplemented */
51 #define PS_INLOOP 0x0008 /* puffs mainloop started */
52 long ps_fsid;
53 uint32_t ps_max_readahead;
54 uint32_t ps_max_write;
55 uint64_t ps_syncreads;
56 uint64_t ps_syncwrites;
57 uint64_t ps_asyncreads;
58 uint64_t ps_asyncwrites;
59 char *ps_source;
60 char *ps_target;
61 char *ps_filesystemtype;
62 int ps_mountflags;
63 uint64_t ps_unique;
64 uint32_t ps_readahead;
65 uint32_t ps_write;
66 perfuse_new_msg_fn ps_new_msg;
67 perfuse_xchg_msg_fn ps_xchg_msg;
68 perfuse_destroy_msg_fn ps_destroy_msg;
69 perfuse_get_inhdr_fn ps_get_inhdr;
70 perfuse_get_inpayload_fn ps_get_inpayload;
71 perfuse_get_outhdr_fn ps_get_outhdr;
72 perfuse_get_outpayload_fn ps_get_outpayload;
73 };
74
75
76 struct perfuse_file_handle {
77 uint64_t pfh_fh;
78 TAILQ_ENTRY(perfuse_file_handle) pfh_entries;
79 };
80
81
82 enum perfuse_qtype { PCQ_READDIR, PCQ_READ, PCQ_WRITE };
83
84 struct perfuse_cc_queue {
85 enum perfuse_qtype pcq_type;
86 struct puffs_cc *pcq_cc;
87 TAILQ_ENTRY(perfuse_cc_queue) pcq_next;
88 };
89
90
91 struct perfuse_node_data {
92 TAILQ_HEAD(,perfuse_file_handle) pnd_fh;
93 uint64_t pnd_ino; /* inode */
94 uint64_t pnd_nlookup; /* vnode refcount */
95 uint64_t pnd_offset; /* seek state */
96 uint64_t pnd_lock_owner;
97 struct dirent *pnd_dirent; /* native buffer for readdir */
98 size_t pnd_dirent_len;
99 struct fuse_dirent *pnd_all_fd; /* FUSE buffer for readdir */
100 size_t pnd_all_fd_len;
101 TAILQ_HEAD(,perfuse_cc_queue) pnd_pcq; /* queued requests */
102 int pnd_flags;
103 #define PND_RECLAIMED 0x1 /* reclaim pending */
104 #define PND_INREADDIR 0x2 /* readdir in progress */
105 puffs_cookie_t pnd_parent;
106 int pnd_childcount;
107 };
108
109 #define PERFUSE_NODE_DATA(opc) \
110 ((struct perfuse_node_data *)puffs_pn_getpriv((struct puffs_node *)opc))
111
112
113 #define UNSPEC_REPLY_LEN PERFUSE_UNSPEC_REPLY_LEN /* shorter! */
114 #define NO_PAYLOAD_REPLY_LEN 0
115
116 #define GET_INHDR(ps, pm) ps->ps_get_inhdr(pm)
117 #define GET_INPAYLOAD(ps, pm, type) \
118 (struct type *)(void *)ps->ps_get_inpayload(pm)
119 #define _GET_INPAYLOAD(ps, pm, type) (type)ps->ps_get_inpayload(pm)
120 #define GET_OUTHDR(ps, pm) ps->ps_get_outhdr(pm)
121 #define GET_OUTPAYLOAD(ps, pm, type) \
122 (struct type *)(void *)ps->ps_get_outpayload(pm)
123 #define _GET_OUTPAYLOAD(ps, pm, type) (type)ps->ps_get_outpayload(pm)
124
125 #define XCHG_MSG(ps, pu, opc, len) ps->ps_xchg_msg(pu, opc, len, wait_reply)
126 #define XCHG_MSG_NOREPLY(ps, pu, opc, len) \
127 ps->ps_xchg_msg(pu, opc, len, no_reply)
128
129 __BEGIN_DECLS
130
131 struct puffs_node *perfuse_new_pn(struct puffs_usermount *,
132 struct puffs_node *);
133 void perfuse_destroy_pn(struct puffs_node *);
134 void perfuse_new_fh(puffs_cookie_t, uint64_t);
135 void perfuse_destroy_fh(puffs_cookie_t, uint64_t);
136 uint64_t perfuse_get_fh(puffs_cookie_t);
137 uint64_t perfuse_next_unique(struct puffs_usermount *);
138
139 char *perfuse_fs_mount(int, ssize_t);
140
141
142 /*
143 * opc.c - filesystem operations
144 */
145 int perfuse_fs_unmount(struct puffs_usermount *, int);
146 int perfuse_fs_statvfs(struct puffs_usermount *, struct statvfs *);
147 int perfuse_fs_sync(struct puffs_usermount *, int,
148 const struct puffs_cred *);
149 int perfuse_fs_fhtonode(struct puffs_usermount *, void *, size_t,
150 struct puffs_newinfo *);
151 int perfuse_fs_nodetofh(struct puffs_usermount *, puffs_cookie_t,
152 void *, size_t *);
153 void perfuse_fs_suspend(struct puffs_usermount *, int);
154 int perfuse_node_lookup(struct puffs_usermount *,
155 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *);
156 int perfuse_node_create(struct puffs_usermount *,
157 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
158 const struct vattr *);
159 int perfuse_node_mknod(struct puffs_usermount *,
160 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
161 const struct vattr *);
162 int perfuse_node_open(struct puffs_usermount *,
163 puffs_cookie_t, int, const struct puffs_cred *);
164 int perfuse_node_close(struct puffs_usermount *,
165 puffs_cookie_t, int, const struct puffs_cred *);
166 int perfuse_node_access(struct puffs_usermount *,
167 puffs_cookie_t, int, const struct puffs_cred *);
168 int perfuse_node_getattr(struct puffs_usermount *,
169 puffs_cookie_t, struct vattr *, const struct puffs_cred *);
170 int perfuse_node_setattr(struct puffs_usermount *,
171 puffs_cookie_t, const struct vattr *, const struct puffs_cred *);
172 int perfuse_node_poll(struct puffs_usermount *, puffs_cookie_t, int *);
173 int perfuse_node_mmap(struct puffs_usermount *,
174 puffs_cookie_t, vm_prot_t, const struct puffs_cred *);
175 int perfuse_node_fsync(struct puffs_usermount *,
176 puffs_cookie_t, const struct puffs_cred *, int, off_t, off_t);
177 int perfuse_node_seek(struct puffs_usermount *,
178 puffs_cookie_t, off_t, off_t, const struct puffs_cred *);
179 int perfuse_node_remove(struct puffs_usermount *,
180 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
181 int perfuse_node_link(struct puffs_usermount *,
182 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
183 int perfuse_node_rename(struct puffs_usermount *,
184 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *,
185 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
186 int perfuse_node_mkdir(struct puffs_usermount *,
187 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
188 const struct vattr *);
189 int perfuse_node_rmdir(struct puffs_usermount *,
190 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
191 int perfuse_node_symlink(struct puffs_usermount *,
192 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
193 const struct vattr *, const char *);
194 int perfuse_node_readdir(struct puffs_usermount *,
195 puffs_cookie_t, struct dirent *, off_t *, size_t *,
196 const struct puffs_cred *, int *, off_t *, size_t *);
197 int perfuse_node_readlink(struct puffs_usermount *,
198 puffs_cookie_t, const struct puffs_cred *, char *, size_t *);
199 int perfuse_node_reclaim(struct puffs_usermount *, puffs_cookie_t);
200 int perfuse_node_inactive(struct puffs_usermount *, puffs_cookie_t);
201 int perfuse_node_print(struct puffs_usermount *, puffs_cookie_t);
202 int perfuse_node_pathconf(struct puffs_usermount *,
203 puffs_cookie_t, int, int *);
204 int perfuse_node_advlock(struct puffs_usermount *,
205 puffs_cookie_t, void *, int, struct flock *, int);
206 int perfuse_node_read(struct puffs_usermount *, puffs_cookie_t,
207 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
208 int perfuse_node_write(struct puffs_usermount *, puffs_cookie_t,
209 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
210 void perfuse_cache_write(struct puffs_usermount *,
211 puffs_cookie_t, size_t, struct puffs_cacherun *);
212
213 __END_DECLS
214
215 #endif /* _PERFUSE_PRIV_H_ */
216