perfuse_priv.h revision 1.9 1 /* $NetBSD: perfuse_priv.h,v 1.9 2010/09/09 09:12:35 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_owner_uid;
45 int ps_flags;
46 #define PS_NO_ACCESS 0x0001 /* access is unimplemented; */
47 #define PS_NO_CREAT 0x0004 /* create is unimplemented */
48 #define PS_INLOOP 0x0008 /* puffs mainloop started */
49 long ps_fsid;
50 uint32_t ps_max_readahead;
51 uint32_t ps_max_write;
52 uint64_t ps_syncreads;
53 uint64_t ps_syncwrites;
54 uint64_t ps_asyncreads;
55 uint64_t ps_asyncwrites;
56 char *ps_source;
57 char *ps_target;
58 char *ps_filesystemtype;
59 int ps_mountflags;
60 uint64_t ps_unique;
61 size_t ps_readahead;
62 size_t ps_write;
63 perfuse_new_msg_fn ps_new_msg;
64 perfuse_xchg_msg_fn ps_xchg_msg;
65 perfuse_destroy_msg_fn ps_destroy_msg;
66 perfuse_get_inhdr_fn ps_get_inhdr;
67 perfuse_get_inpayload_fn ps_get_inpayload;
68 perfuse_get_outhdr_fn ps_get_outhdr;
69 perfuse_get_outpayload_fn ps_get_outpayload;
70 };
71
72
73 enum perfuse_qtype { PCQ_READDIR, PCQ_READ, PCQ_WRITE, PCQ_AFTERWRITE };
74
75 struct perfuse_cc_queue {
76 enum perfuse_qtype pcq_type;
77 struct puffs_cc *pcq_cc;
78 TAILQ_ENTRY(perfuse_cc_queue) pcq_next;
79 };
80
81
82 struct perfuse_node_data {
83 uint64_t pnd_rfh;
84 uint64_t pnd_wfh;
85 uint64_t pnd_ino; /* inode */
86 uint64_t pnd_nlookup; /* vnode refcount */
87 uint64_t pnd_offset; /* seek state */
88 uint64_t pnd_lock_owner;
89 struct dirent *pnd_dirent; /* native buffer for readdir */
90 off_t pnd_dirent_len;
91 struct fuse_dirent *pnd_all_fd; /* FUSE buffer for readdir */
92 size_t pnd_all_fd_len;
93 TAILQ_HEAD(,perfuse_cc_queue) pnd_pcq; /* queued requests */
94 int pnd_flags;
95 #define PND_RECLAIMED 0x01 /* reclaim pending */
96 #define PND_INREADDIR 0x02 /* readdir in progress */
97 #define PND_DIRTY 0x04 /* There is some data to sync */
98 #define PND_RFH 0x08 /* Read FH allocated */
99 #define PND_WFH 0x10 /* Write FH allocated */
100 #define PND_REMOVED 0x20 /* Node was removed */
101 #define PND_INWRITE 0x40 /* write in progress */
102
103 #define PND_OPEN (PND_RFH|PND_WFH) /* File is open */
104 puffs_cookie_t pnd_parent;
105 int pnd_childcount;
106 };
107
108 #define PERFUSE_NODE_DATA(opc) \
109 ((struct perfuse_node_data *)puffs_pn_getpriv((struct puffs_node *)opc))
110
111
112 #define UNSPEC_REPLY_LEN PERFUSE_UNSPEC_REPLY_LEN /* shorter! */
113 #define NO_PAYLOAD_REPLY_LEN 0
114
115 #define GET_INHDR(ps, pm) ps->ps_get_inhdr(pm)
116 #define GET_INPAYLOAD(ps, pm, type) \
117 (struct type *)(void *)ps->ps_get_inpayload(pm)
118 #define _GET_INPAYLOAD(ps, pm, type) (type)ps->ps_get_inpayload(pm)
119 #define GET_OUTHDR(ps, pm) ps->ps_get_outhdr(pm)
120 #define GET_OUTPAYLOAD(ps, pm, type) \
121 (struct type *)(void *)ps->ps_get_outpayload(pm)
122 #define _GET_OUTPAYLOAD(ps, pm, type) (type)ps->ps_get_outpayload(pm)
123
124 #define XCHG_MSG(ps, pu, opc, len) ps->ps_xchg_msg(pu, opc, len, wait_reply)
125 #define XCHG_MSG_NOREPLY(ps, pu, opc, len) \
126 ps->ps_xchg_msg(pu, opc, len, no_reply)
127
128 __BEGIN_DECLS
129
130 struct puffs_node *perfuse_new_pn(struct puffs_usermount *,
131 struct puffs_node *);
132 void perfuse_destroy_pn(struct puffs_node *);
133 void perfuse_new_fh(puffs_cookie_t, uint64_t, int);
134 void perfuse_destroy_fh(puffs_cookie_t, uint64_t);
135 uint64_t perfuse_get_fh(puffs_cookie_t, int);
136 uint64_t perfuse_next_unique(struct puffs_usermount *);
137
138 char *perfuse_fs_mount(int, ssize_t);
139
140
141 /*
142 * opc.c - filesystem operations
143 */
144 int perfuse_fs_unmount(struct puffs_usermount *, int);
145 int perfuse_fs_statvfs(struct puffs_usermount *, struct statvfs *);
146 int perfuse_fs_sync(struct puffs_usermount *, int,
147 const struct puffs_cred *);
148 int perfuse_fs_fhtonode(struct puffs_usermount *, void *, size_t,
149 struct puffs_newinfo *);
150 int perfuse_fs_nodetofh(struct puffs_usermount *, puffs_cookie_t,
151 void *, size_t *);
152 void perfuse_fs_suspend(struct puffs_usermount *, int);
153 int perfuse_node_lookup(struct puffs_usermount *,
154 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *);
155 int perfuse_node_create(struct puffs_usermount *,
156 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
157 const struct vattr *);
158 int perfuse_node_mknod(struct puffs_usermount *,
159 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
160 const struct vattr *);
161 int perfuse_node_open(struct puffs_usermount *,
162 puffs_cookie_t, int, const struct puffs_cred *);
163 int perfuse_node_close(struct puffs_usermount *,
164 puffs_cookie_t, int, const struct puffs_cred *);
165 int perfuse_node_access(struct puffs_usermount *,
166 puffs_cookie_t, int, const struct puffs_cred *);
167 int perfuse_node_getattr(struct puffs_usermount *,
168 puffs_cookie_t, struct vattr *, const struct puffs_cred *);
169 int perfuse_node_setattr(struct puffs_usermount *,
170 puffs_cookie_t, const struct vattr *, const struct puffs_cred *);
171 int perfuse_node_poll(struct puffs_usermount *, puffs_cookie_t, int *);
172 int perfuse_node_mmap(struct puffs_usermount *,
173 puffs_cookie_t, vm_prot_t, const struct puffs_cred *);
174 int perfuse_node_fsync(struct puffs_usermount *,
175 puffs_cookie_t, const struct puffs_cred *, int, off_t, off_t);
176 int perfuse_node_seek(struct puffs_usermount *,
177 puffs_cookie_t, off_t, off_t, const struct puffs_cred *);
178 int perfuse_node_remove(struct puffs_usermount *,
179 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
180 int perfuse_node_link(struct puffs_usermount *,
181 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
182 int perfuse_node_rename(struct puffs_usermount *,
183 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *,
184 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
185 int perfuse_node_mkdir(struct puffs_usermount *,
186 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
187 const struct vattr *);
188 int perfuse_node_rmdir(struct puffs_usermount *,
189 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
190 int perfuse_node_symlink(struct puffs_usermount *,
191 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
192 const struct vattr *, const char *);
193 int perfuse_node_readdir(struct puffs_usermount *,
194 puffs_cookie_t, struct dirent *, off_t *, size_t *,
195 const struct puffs_cred *, int *, off_t *, size_t *);
196 int perfuse_node_readlink(struct puffs_usermount *,
197 puffs_cookie_t, const struct puffs_cred *, char *, size_t *);
198 int perfuse_node_reclaim(struct puffs_usermount *, puffs_cookie_t);
199 int perfuse_node_inactive(struct puffs_usermount *, puffs_cookie_t);
200 int perfuse_node_print(struct puffs_usermount *, puffs_cookie_t);
201 int perfuse_node_pathconf(struct puffs_usermount *,
202 puffs_cookie_t, int, int *);
203 int perfuse_node_advlock(struct puffs_usermount *,
204 puffs_cookie_t, void *, int, struct flock *, int);
205 int perfuse_node_read(struct puffs_usermount *, puffs_cookie_t,
206 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
207 int perfuse_node_write(struct puffs_usermount *, puffs_cookie_t,
208 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
209 void perfuse_cache_write(struct puffs_usermount *,
210 puffs_cookie_t, size_t, struct puffs_cacherun *);
211
212 __END_DECLS
213
214 #endif /* _PERFUSE_PRIV_H_ */
215