perfuse_priv.h revision 1.17 1 /* $NetBSD: perfuse_priv.h,v 1.17 2011/04/25 04:54:53 manu Exp $ */
2
3 /*-
4 * Copyright (c) 2010-2011 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 uint64_t 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 perfuse_new_msg_fn ps_new_msg;
62 perfuse_xchg_msg_fn ps_xchg_msg;
63 perfuse_destroy_msg_fn ps_destroy_msg;
64 perfuse_get_inhdr_fn ps_get_inhdr;
65 perfuse_get_inpayload_fn ps_get_inpayload;
66 perfuse_get_outhdr_fn ps_get_outhdr;
67 perfuse_get_outpayload_fn ps_get_outpayload;
68 };
69
70
71 enum perfuse_qtype {
72 PCQ_READDIR,
73 PCQ_READ,
74 PCQ_WRITE,
75 PCQ_AFTERWRITE,
76 PCQ_OPEN,
77 PCQ_AFTERXCHG
78 };
79
80 #ifdef PERFUSE_DEBUG
81 extern const char *perfuse_qtypestr[];
82 #endif
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 struct perfuse_node_data {
91 uint64_t pnd_rfh;
92 uint64_t pnd_wfh;
93 uint64_t pnd_ino; /* inode */
94 uint64_t pnd_nlookup; /* vnode refcount */
95 uint64_t pnd_lock_owner;
96 struct dirent *pnd_dirent; /* native buffer for readdir */
97 off_t pnd_dirent_len;
98 struct fuse_dirent *pnd_all_fd; /* FUSE buffer for readdir */
99 size_t pnd_all_fd_len;
100 TAILQ_HEAD(,perfuse_cc_queue) pnd_pcq; /* queued requests */
101 int pnd_flags;
102 #define PND_RECLAIMED 0x001 /* reclaim pending */
103 #define PND_INREADDIR 0x002 /* readdir in progress */
104 #define PND_DIRTY 0x004 /* There is some data to sync */
105 #define PND_RFH 0x008 /* Read FH allocated */
106 #define PND_WFH 0x010 /* Write FH allocated */
107 #define PND_REMOVED 0x020 /* Node was removed */
108 #define PND_INWRITE 0x040 /* write in progress */
109 #define PND_INOPEN 0x100 /* open in progress */
110 #define PND_INXCHG 0x400 /* FUSE exchange in progress */
111
112 #define PND_OPEN (PND_RFH|PND_WFH) /* File is open */
113 #define PND_BUSY (PND_INREADDIR|PND_INWRITE|PND_INOPEN)
114 puffs_cookie_t pnd_parent;
115 int pnd_childcount;
116 TAILQ_ENTRY(perfuse_node_data) pnd_next;
117 puffs_cookie_t pnd_pn;
118 char pnd_name[MAXPATHLEN]; /* node name */
119 TAILQ_HEAD(,perfuse_node_data) pnd_children;
120 };
121
122 #define PERFUSE_NODE_DATA(opc) \
123 ((struct perfuse_node_data *)puffs_pn_getpriv((struct puffs_node *)opc))
124
125
126 #define UNSPEC_REPLY_LEN PERFUSE_UNSPEC_REPLY_LEN /* shorter! */
127 #define NO_PAYLOAD_REPLY_LEN 0
128
129 #define GET_INHDR(ps, pm) ps->ps_get_inhdr(pm)
130 #define GET_INPAYLOAD(ps, pm, type) \
131 (struct type *)(void *)ps->ps_get_inpayload(pm)
132 #define _GET_INPAYLOAD(ps, pm, type) (type)ps->ps_get_inpayload(pm)
133 #define GET_OUTHDR(ps, pm) ps->ps_get_outhdr(pm)
134 #define GET_OUTPAYLOAD(ps, pm, type) \
135 (struct type *)(void *)ps->ps_get_outpayload(pm)
136 #define _GET_OUTPAYLOAD(ps, pm, type) (type)ps->ps_get_outpayload(pm)
137
138 __BEGIN_DECLS
139
140 struct puffs_node *perfuse_new_pn(struct puffs_usermount *, const char *,
141 struct puffs_node *);
142 void perfuse_destroy_pn(struct puffs_node *);
143 void perfuse_new_fh(puffs_cookie_t, uint64_t, int);
144 void perfuse_destroy_fh(puffs_cookie_t, uint64_t);
145 uint64_t perfuse_get_fh(puffs_cookie_t, int);
146 uint64_t perfuse_next_unique(struct puffs_usermount *);
147 char *perfuse_node_path(puffs_cookie_t);
148 int perfuse_node_close_common(struct puffs_usermount *, puffs_cookie_t, int);
149
150 char *perfuse_fs_mount(int, ssize_t);
151
152
153 /*
154 * opc.c - filesystem operations
155 */
156 int perfuse_fs_unmount(struct puffs_usermount *, int);
157 int perfuse_fs_statvfs(struct puffs_usermount *, struct statvfs *);
158 int perfuse_fs_sync(struct puffs_usermount *, int,
159 const struct puffs_cred *);
160 int perfuse_fs_fhtonode(struct puffs_usermount *, void *, size_t,
161 struct puffs_newinfo *);
162 int perfuse_fs_nodetofh(struct puffs_usermount *, puffs_cookie_t,
163 void *, size_t *);
164 void perfuse_fs_suspend(struct puffs_usermount *, int);
165 int perfuse_node_lookup(struct puffs_usermount *,
166 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *);
167 int perfuse_node_create(struct puffs_usermount *,
168 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
169 const struct vattr *);
170 int perfuse_node_mknod(struct puffs_usermount *,
171 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
172 const struct vattr *);
173 int perfuse_node_open(struct puffs_usermount *,
174 puffs_cookie_t, int, const struct puffs_cred *);
175 int perfuse_node_close(struct puffs_usermount *,
176 puffs_cookie_t, int, const struct puffs_cred *);
177 int perfuse_node_access(struct puffs_usermount *,
178 puffs_cookie_t, int, const struct puffs_cred *);
179 int perfuse_node_getattr(struct puffs_usermount *,
180 puffs_cookie_t, struct vattr *, const struct puffs_cred *);
181 int perfuse_node_setattr(struct puffs_usermount *,
182 puffs_cookie_t, const struct vattr *, const struct puffs_cred *);
183 int perfuse_node_poll(struct puffs_usermount *, puffs_cookie_t, int *);
184 int perfuse_node_mmap(struct puffs_usermount *,
185 puffs_cookie_t, vm_prot_t, const struct puffs_cred *);
186 int perfuse_node_fsync(struct puffs_usermount *,
187 puffs_cookie_t, const struct puffs_cred *, int, off_t, off_t);
188 int perfuse_node_seek(struct puffs_usermount *,
189 puffs_cookie_t, off_t, off_t, const struct puffs_cred *);
190 int perfuse_node_remove(struct puffs_usermount *,
191 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
192 int perfuse_node_link(struct puffs_usermount *,
193 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
194 int perfuse_node_rename(struct puffs_usermount *,
195 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *,
196 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
197 int perfuse_node_mkdir(struct puffs_usermount *,
198 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
199 const struct vattr *);
200 int perfuse_node_rmdir(struct puffs_usermount *,
201 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
202 int perfuse_node_symlink(struct puffs_usermount *,
203 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
204 const struct vattr *, const char *);
205 int perfuse_node_readdir(struct puffs_usermount *,
206 puffs_cookie_t, struct dirent *, off_t *, size_t *,
207 const struct puffs_cred *, int *, off_t *, size_t *);
208 int perfuse_node_readlink(struct puffs_usermount *,
209 puffs_cookie_t, const struct puffs_cred *, char *, size_t *);
210 int perfuse_node_reclaim(struct puffs_usermount *, puffs_cookie_t);
211 int perfuse_node_inactive(struct puffs_usermount *, puffs_cookie_t);
212 int perfuse_node_print(struct puffs_usermount *, puffs_cookie_t);
213 int perfuse_node_pathconf(struct puffs_usermount *,
214 puffs_cookie_t, int, int *);
215 int perfuse_node_advlock(struct puffs_usermount *,
216 puffs_cookie_t, void *, int, struct flock *, int);
217 int perfuse_node_read(struct puffs_usermount *, puffs_cookie_t,
218 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
219 int perfuse_node_write(struct puffs_usermount *, puffs_cookie_t,
220 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
221 void perfuse_cache_write(struct puffs_usermount *,
222 puffs_cookie_t, size_t, struct puffs_cacherun *);
223
224 __END_DECLS
225
226 #endif /* _PERFUSE_PRIV_H_ */
227