1/*  $NetBSD$ */
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 <unistd.h>
32#include <syslog.h>
33#include <paths.h>
34#include <err.h>
35#include <sysexits.h>
36#include <signal.h>
37#include <puffs.h>
38
39#include "perfuse_if.h"
40#include "fuse.h"
41
42/* From src/sys/fs/puffs/puffs_vfsops.c */
43#ifndef PUFFS_PNODEBUCKETS
44#define PUFFS_PNODEBUCKETS 256
45#endif /* PUFFS_PNODEBUCKETS */
46
47#define PERFUSE_TRACECOUNT_MAX 4096
48#define PERFUSE_TRACEPATH_MAX 256
49struct perfuse_trace {
50	int pt_opcode;
51	char pt_path[PERFUSE_TRACEPATH_MAX];
52	char pt_extra[BUFSIZ];
53	int pt_error;
54	enum { inxchg, done } pt_status;
55	struct timespec pt_start;
56	struct timespec pt_end;
57	TAILQ_ENTRY(perfuse_trace) pt_list;
58};
59
60LIST_HEAD(perfuse_node_hashlist, perfuse_node_data);
61struct perfuse_state {
62	void *ps_private;	/* Private field for libperfuse user */
63	struct puffs_usermount *ps_pu;
64	struct puffs_node *ps_root;
65	uid_t ps_owner_uid;
66	int ps_flags;
67#define PS_NO_ACCESS	0x0001	/* access is unimplemented; */
68#define PS_NO_CREAT	0x0004	/* create is unimplemented */
69#define PS_INLOOP	0x0008	/* puffs mainloop started */
70	uint64_t ps_fsid;
71	uint32_t ps_max_readahead;
72	uint32_t ps_max_write;
73	uint64_t ps_syncreads;
74	uint64_t ps_syncwrites;
75	uint64_t ps_asyncreads;
76	uint64_t ps_asyncwrites;
77	char *ps_source;
78	char *ps_target;
79	char *ps_filesystemtype;
80	int ps_mountflags;
81	uint64_t ps_unique;
82	perfuse_new_msg_fn ps_new_msg;
83	perfuse_xchg_msg_fn ps_xchg_msg;
84	perfuse_destroy_msg_fn ps_destroy_msg;
85	perfuse_get_inhdr_fn ps_get_inhdr;
86	perfuse_get_inpayload_fn ps_get_inpayload;
87	perfuse_get_outhdr_fn ps_get_outhdr;
88	perfuse_get_outpayload_fn ps_get_outpayload;
89	perfuse_umount_fn ps_umount;
90	TAILQ_HEAD(,perfuse_trace) ps_trace;
91	uint64_t ps_tracecount;
92	struct perfuse_node_hashlist *ps_nidhash;
93	int ps_nnidhash;
94	int ps_nodecount;
95	int ps_nodeleakcount;
96	int ps_xchgcount;
97};
98
99
100enum perfuse_qtype {
101	PCQ_READDIR,
102	PCQ_READ,
103	PCQ_WRITE,
104	PCQ_AFTERWRITE,
105	PCQ_OPEN,
106	PCQ_AFTERXCHG,
107	PCQ_RESIZE,
108	PCQ_REF
109};
110
111#ifdef PERFUSE_DEBUG
112extern const char * const perfuse_qtypestr[];
113#endif
114
115struct perfuse_cc_queue {
116	enum perfuse_qtype pcq_type;
117	struct puffs_cc *pcq_cc;
118	TAILQ_ENTRY(perfuse_cc_queue) pcq_next;
119	const char *pcq_func;
120	int pcq_line;
121};
122
123struct perfuse_node_data {
124	uint64_t pnd_rfh;
125	uint64_t pnd_wfh;
126	uint64_t pnd_nodeid;			/* nodeid, this is not inode */
127	uint64_t pnd_parent_nodeid;		/* parent's nodeid */
128	uint32_t pnd_hashidx;			/* node hash index */
129	uint64_t pnd_fuse_nlookup;		/* vnode refcount */
130	int pnd_puffs_nlookup;			/* vnode refcount */
131	uint64_t pnd_lock_owner;
132	struct dirent *pnd_dirent;		/* native buffer for readdir */
133	off_t pnd_dirent_len;
134	struct fuse_dirent *pnd_all_fd;		/* FUSE buffer for readdir */
135	size_t pnd_all_fd_len;
136	uint64_t pnd_fd_cookie;			/* opaque readdir ref from fs */
137	TAILQ_HEAD(,perfuse_cc_queue) pnd_pcq;	/* queued requests */
138	int pnd_flags;
139#define PND_RECLAIMED		0x001	/* reclaim pending */
140#define PND_INREADDIR		0x002	/* readdir in progress */
141#define PND_DIRTY		0x004	/* There is some data to sync */
142#define PND_RFH			0x008	/* Read FH allocated */
143#define PND_WFH			0x010	/* Write FH allocated */
144#define PND_REMOVED		0x020	/* Node was removed */
145#define PND_INWRITE		0x040	/* write in progress */
146#define PND_INOPEN		0x100	/* open in progress */
147#define PND_NODELEAK		0x200	/* node reclaim ignored */
148#define PND_INVALID		0x400	/* node freed, usage is a bug */
149#define PND_INRESIZE		0x800	/* resize in progress */
150
151#define PND_OPEN		(PND_RFH|PND_WFH)	/* File is open */
152#define PND_BUSY		(PND_INREADDIR|PND_INWRITE|PND_INOPEN)
153
154	LIST_ENTRY(perfuse_node_data) pnd_nident;
155	puffs_cookie_t pnd_pn;
156	char pnd_name[MAXPATHLEN];	/* node name */
157	struct timespec pnd_cn_expire;
158	int pnd_inxchg;
159	int pnd_ref;
160};
161
162#define PERFUSE_NODE_DATA(opc)	\
163	((struct perfuse_node_data *)puffs_pn_getpriv((struct puffs_node *)opc))
164
165
166#define UNSPEC_REPLY_LEN PERFUSE_UNSPEC_REPLY_LEN /* shorter! */
167#define NO_PAYLOAD_REPLY_LEN 0
168
169#define GET_INHDR(ps, pm) ps->ps_get_inhdr(pm)
170#define GET_INPAYLOAD(ps, pm, type) \
171	(struct type *)(void *)ps->ps_get_inpayload(pm)
172#define _GET_INPAYLOAD(ps, pm, type) (type)ps->ps_get_inpayload(pm)
173#define GET_OUTHDR(ps, pm) ps->ps_get_outhdr(pm)
174#define GET_OUTPAYLOAD(ps, pm, type) \
175	(struct type *)(void *)ps->ps_get_outpayload(pm)
176#define _GET_OUTPAYLOAD(ps, pm, type) (type)ps->ps_get_outpayload(pm)
177
178__BEGIN_DECLS
179
180struct puffs_node *perfuse_new_pn(struct puffs_usermount *, const char *,
181    struct puffs_node *);
182void perfuse_destroy_pn(struct puffs_usermount *, struct puffs_node *);
183void perfuse_new_fh(puffs_cookie_t, uint64_t, int);
184void perfuse_destroy_fh(puffs_cookie_t, uint64_t);
185uint64_t perfuse_get_fh(puffs_cookie_t, int);
186uint64_t perfuse_next_unique(struct puffs_usermount *);
187char *perfuse_node_path(struct perfuse_state *, puffs_cookie_t);
188int perfuse_node_close_common(struct puffs_usermount *, puffs_cookie_t, int);
189const char *perfuse_native_ns(const int, const char *, char *);
190
191char *perfuse_fs_mount(int, ssize_t);
192
193
194/*
195 * ops.c - filesystem operations
196 */
197int perfuse_fs_unmount(struct puffs_usermount *, int);
198int perfuse_fs_statvfs(struct puffs_usermount *, struct statvfs *);
199int perfuse_fs_sync(struct puffs_usermount *, int,
200    const struct puffs_cred *);
201int perfuse_fs_fhtonode(struct puffs_usermount *, void *, size_t,
202    struct puffs_newinfo *);
203int perfuse_fs_nodetofh(struct puffs_usermount *, puffs_cookie_t,
204    void *, size_t *);
205void perfuse_fs_suspend(struct puffs_usermount *, int);
206int perfuse_node_lookup(struct puffs_usermount *,
207    puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *);
208int perfuse_node_create(struct puffs_usermount *,
209    puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
210    const struct vattr *);
211int perfuse_node_mknod(struct puffs_usermount *,
212    puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
213    const struct vattr *);
214int perfuse_node_open(struct puffs_usermount *,
215    puffs_cookie_t, int, const struct puffs_cred *);
216int perfuse_node_close(struct puffs_usermount *,
217    puffs_cookie_t, int, const struct puffs_cred *);
218int perfuse_node_access(struct puffs_usermount *,
219    puffs_cookie_t, int, const struct puffs_cred *);
220int perfuse_node_getattr(struct puffs_usermount *,
221    puffs_cookie_t, struct vattr *, const struct puffs_cred *);
222int perfuse_node_setattr(struct puffs_usermount *,
223    puffs_cookie_t, const struct vattr *, const struct puffs_cred *);
224int perfuse_node_poll(struct puffs_usermount *, puffs_cookie_t, int *);
225int perfuse_node_mmap(struct puffs_usermount *,
226    puffs_cookie_t, vm_prot_t, const struct puffs_cred *);
227int perfuse_node_fsync(struct puffs_usermount *,
228    puffs_cookie_t, const struct puffs_cred *, int, off_t, off_t);
229int perfuse_node_seek(struct puffs_usermount *,
230    puffs_cookie_t, off_t, off_t, const struct puffs_cred *);
231int perfuse_node_remove(struct puffs_usermount *,
232    puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
233int perfuse_node_link(struct puffs_usermount *,
234    puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
235int perfuse_node_rename(struct puffs_usermount *,
236    puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *,
237    puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
238int perfuse_node_mkdir(struct puffs_usermount *,
239    puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
240    const struct vattr *);
241int perfuse_node_rmdir(struct puffs_usermount *,
242    puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
243int perfuse_node_symlink(struct puffs_usermount *,
244    puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
245    const struct vattr *, const char *);
246int perfuse_node_readdir(struct puffs_usermount *,
247    puffs_cookie_t, struct dirent *, off_t *, size_t *,
248    const struct puffs_cred *, int *, off_t *, size_t *);
249int perfuse_node_readlink(struct puffs_usermount *,
250    puffs_cookie_t, const struct puffs_cred *, char *, size_t *);
251int perfuse_node_reclaim(struct puffs_usermount *, puffs_cookie_t);
252int perfuse_node_inactive(struct puffs_usermount *, puffs_cookie_t);
253int perfuse_node_print(struct puffs_usermount *, puffs_cookie_t);
254int perfuse_node_pathconf(struct puffs_usermount *,
255    puffs_cookie_t, int, int *);
256int perfuse_node_advlock(struct puffs_usermount *,
257    puffs_cookie_t, void *, int, struct flock *, int);
258int perfuse_node_read(struct puffs_usermount *, puffs_cookie_t,
259    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
260int perfuse_node_write(struct puffs_usermount *, puffs_cookie_t,
261    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
262int perfuse_node_write2(struct puffs_usermount *, puffs_cookie_t,
263    uint8_t *, off_t, size_t *, const struct puffs_cred *, int, int);
264void perfuse_cache_write(struct puffs_usermount *,
265    puffs_cookie_t, size_t, struct puffs_cacherun *);
266int perfuse_node_getextattr(struct puffs_usermount *, puffs_cookie_t,
267    int, const char *, size_t *, uint8_t *, size_t *,
268    const struct puffs_cred *);
269int perfuse_node_setextattr(struct puffs_usermount *, puffs_cookie_t,
270    int, const char *, uint8_t *, size_t *, const struct puffs_cred *);
271int perfuse_node_listextattr(struct puffs_usermount *, puffs_cookie_t,
272    int, size_t *, uint8_t *, size_t *, int, const struct puffs_cred *);
273int perfuse_node_deleteextattr(struct puffs_usermount *, puffs_cookie_t,
274    int, const char *, const struct puffs_cred *);
275int perfuse_node_getattr_ttl(struct puffs_usermount *,
276    puffs_cookie_t, struct vattr *, const struct puffs_cred *,
277    struct timespec *);
278int perfuse_node_setattr_ttl(struct puffs_usermount *,
279    puffs_cookie_t, struct vattr *, const struct puffs_cred *,
280    struct timespec *, int);
281
282struct perfuse_trace *perfuse_trace_begin(struct perfuse_state *,
283    puffs_cookie_t, perfuse_msg_t *);
284void perfuse_trace_end(struct perfuse_state *, struct perfuse_trace *, int);
285char *perfuse_opdump_in(struct perfuse_state *, perfuse_msg_t *);
286struct perfuse_node_data *perfuse_node_bynodeid(struct perfuse_state *,
287    uint64_t);
288void perfuse_node_cache(struct perfuse_state *, puffs_cookie_t);
289void perfuse_cache_flush(puffs_cookie_t);
290
291__END_DECLS
292
293#endif /* _PERFUSE_PRIV_H_ */
294