xref: /netbsd-src/lib/libperfuse/perfuse.c (revision c2f76ff004a2cb67efe5b12d97bd3ef7fe89e18d)
1 /*  $NetBSD: perfuse.c,v 1.11 2010/10/11 05:37:58 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 #include <stdio.h>
29 #include <unistd.h>
30 #include <stdlib.h>
31 #include <fcntl.h>
32 #include <string.h>
33 #include <errno.h>
34 #include <puffs.h>
35 #include <sys/types.h>
36 #include <sys/socket.h>
37 #include <sys/un.h>
38 #include <machine/vmparam.h>
39 
40 #define LIBPERFUSE
41 #include "perfuse.h"
42 #include "perfuse_if.h"
43 #include "perfuse_priv.h"
44 
45 int perfuse_diagflags = 0; /* global used only in DPRINTF/DERR/DWARN */
46 
47 static struct perfuse_state *init_state(void);
48 static int get_fd(const char *);
49 
50 static struct perfuse_state *
51 init_state(void)
52 {
53 	struct perfuse_state *ps;
54 
55 	if ((ps = malloc(sizeof(*ps))) == NULL)
56 		DERR(EX_OSERR, "malloc failed");
57 
58 	(void)memset(ps, 0, sizeof(*ps));
59 	ps->ps_max_write = UINT_MAX;
60 	ps->ps_max_readahead = UINT_MAX;
61 
62 	return ps;
63 }
64 
65 
66 static int
67 get_fd(data)
68 	const char *data;
69 {
70 	char *string;
71 	const char fdopt[] = "fd=";
72 	char *lastp;
73 	char *opt;
74 	int fd = -1;
75 
76 	if ((string = strdup(data)) == NULL)
77 		return -1;
78 
79 	for (opt = strtok_r(string, ",", &lastp);
80 	     opt != NULL;
81 	     opt = strtok_r(NULL, ",", &lastp)) {
82 		if (strncmp(opt, fdopt, strlen(fdopt)) == 0) {
83 			fd =  atoi(opt + strlen(fdopt));
84 			break;
85 		}
86 	}
87 
88 	/*
89 	 * No file descriptor found
90 	 */
91 	if (fd == -1)
92 		errno = EINVAL;
93 
94 	free(string);
95 	return fd;
96 
97 }
98 
99 int
100 perfuse_open(path, flags, mode)
101 	const char *path;
102 	int flags;
103 	mode_t mode;
104 {
105 	int sv[2];
106 	struct sockaddr_un sun;
107 	struct sockaddr *sa;
108 	char progname[] = _PATH_PERFUSED;
109 	char minus_i[] = "-i";
110 	char fdstr[16];
111 	char *const argv[] = { progname, minus_i, fdstr, NULL};
112 	char *const envp[] = { NULL };
113 	uint32_t opt;
114 
115 	if (strcmp(path, _PATH_FUSE) != 0)
116 		return open(path, flags, mode);
117 
118 	if ((sv[0] = socket(PF_LOCAL, SOCK_DGRAM, 0)) == -1) {
119 #ifdef PERFUSE_DEBUG
120 		DWARN("%s:%d socket failed: %s", __func__, __LINE__);
121 #endif
122 		return -1;
123 	}
124 
125 	/*
126 	 * Set a buffer lentgh large enough so that any FUSE packet
127 	 * will fit.
128 	 */
129 	opt = FUSE_BUFSIZE;
130 	if (setsockopt(sv[0], SOL_SOCKET, SO_SNDBUF, &opt, sizeof(opt)) != 0)
131 		DWARN("%s: setsockopt SO_SNDBUF to %d failed", __func__, opt);
132 
133 	opt = FUSE_BUFSIZE;
134 	if (setsockopt(sv[0], SOL_SOCKET, SO_RCVBUF, &opt, sizeof(opt)) != 0)
135 		DWARN("%s: setsockopt SO_RCVBUF to %d failed", __func__, opt);
136 
137 	sa = (struct sockaddr *)(void *)&sun;
138 	sun.sun_len = sizeof(sun);
139 	sun.sun_family = AF_LOCAL;
140 	(void)strcpy(sun.sun_path, path);
141 
142 	if (connect(sv[0], sa, (socklen_t)sun.sun_len) == 0)
143 		return sv[0];
144 
145 
146 	/*
147 	 * Attempt to run perfused on our own
148 	 * if it does not run yet; In that case
149 	 * we will talk using a socketpair
150 	 * instead of /dev/fuse.
151 	 */
152 	if (socketpair(PF_LOCAL, SOCK_DGRAM, 0, sv) != 0) {
153 		DWARN("%s:%d: socketpair failed", __func__, __LINE__);
154 		return -1;
155 	}
156 
157 	/*
158 	 * Set a buffer lentgh large enough so that any FUSE packet
159 	 * will fit.
160 	 */
161 	opt = FUSE_BUFSIZE;
162 	if (setsockopt(sv[0], SOL_SOCKET, SO_SNDBUF, &opt, sizeof(opt)) != 0)
163 		DWARN("%s: setsockopt SO_SNDBUF to %d failed", __func__, opt);
164 
165 	opt = FUSE_BUFSIZE;
166 	if (setsockopt(sv[0], SOL_SOCKET, SO_RCVBUF, &opt, sizeof(opt)) != 0)
167 		DWARN("%s: setsockopt SO_RCVBUF to %d failed", __func__, opt);
168 
169 	opt = FUSE_BUFSIZE;
170 	if (setsockopt(sv[1], SOL_SOCKET, SO_SNDBUF, &opt, sizeof(opt)) != 0)
171 		DWARN("%s: setsockopt SO_SNDBUF to %d failed", __func__, opt);
172 
173 	opt = FUSE_BUFSIZE;
174 	if (setsockopt(sv[1], SOL_SOCKET, SO_RCVBUF, &opt, sizeof(opt)) != 0)
175 		DWARN("%s: setsockopt SO_RCVBUF to %d failed", __func__, opt);
176 
177 	/*
178 	 * Request peer credentials. This musr be done before first
179 	 * frame is sent.
180 	 */
181 	opt = 1;
182 	if (setsockopt(sv[1], 0, LOCAL_CREDS, &opt, sizeof(opt)) != 0)
183 		DWARN("%s: setsockopt LOCAL_CREDS failed", __func__);
184 
185 	(void)sprintf(fdstr, "%d", sv[1]);
186 
187 	switch(fork()) {
188 	case -1:
189 #ifdef PERFUSE_DEBUG
190 		DWARN("%s:%d: fork failed", __func__, __LINE__);
191 #endif
192 		return -1;
193 		/* NOTREACHED */
194 		break;
195 	case 0:
196 		(void)execve(argv[0], argv, envp);
197 #ifdef PERFUSE_DEBUG
198 		DWARN("%s:%d: execve failed", __func__, __LINE__);
199 #endif
200 		return -1;
201 		/* NOTREACHED */
202 		break;
203 	default:
204 		break;
205 	}
206 
207 	return sv[0];
208 }
209 
210 int
211 perfuse_mount(source, target, filesystemtype, mountflags, data)
212 	const char *source;
213 	const char *target;
214 	const char *filesystemtype;
215 	long mountflags;
216 	const void *data;
217 {
218 	int s;
219 	size_t len;
220 	struct perfuse_mount_out *pmo;
221 	struct sockaddr_storage ss;
222 	struct sockaddr_un *sun;
223 	struct sockaddr *sa;
224 	socklen_t sa_len;
225 	size_t sock_len;
226 	char *frame;
227 	char *cp;
228 
229 #ifdef PERFUSE_DEBUG
230 	if (perfuse_diagflags & PDF_MISC)
231 		DPRINTF("%s(\"%s\", \"%s\", \"%s\", 0x%lx, \"%s\")\n",
232 			__func__, source, target, filesystemtype,
233 			mountflags, (const char *)data);
234 #endif
235 
236 	if ((s = get_fd(data)) == -1)
237 		return -1;
238 
239 	/*
240 	 * If we are connected to /dev/fuse, we need a second
241 	 * socket to get replies from perfused.
242 	 * XXX This socket is not removed at exit time yet
243 	 */
244 	sock_len = 0;
245 	sa = (struct sockaddr *)(void *)&ss;
246 	sun = (struct sockaddr_un *)(void *)&ss;
247 	sa_len = sizeof(ss);
248 	if ((getpeername(s, sa, &sa_len) == 0) &&
249 	    (sa->sa_family = AF_LOCAL) &&
250 	    (strcmp(sun->sun_path, _PATH_FUSE) == 0)) {
251 
252 		sun->sun_len = sizeof(*sun);
253 		sun->sun_family = AF_LOCAL;
254 		(void)sprintf(sun->sun_path, "%s/%s-%d",
255 			      _PATH_TMP, getprogname(), getpid());
256 
257 		if (bind(s, sa, (socklen_t)sa->sa_len) != 0)
258 			DERR(EX_OSERR, "%s:%d bind to \"%s\" failed",
259 			     __func__, __LINE__, sun->sun_path);
260 
261 		sock_len = strlen(sun->sun_path) + 1;
262 	}
263 
264 	len = sizeof(*pmo);
265 	len += source ? (uint32_t)strlen(source) + 1 : 0;
266 	len += target ? (uint32_t)strlen(target) + 1 : 0;
267 	len += filesystemtype ? (uint32_t)strlen(filesystemtype) + 1 : 0;
268 	len += data ? (uint32_t)strlen(data) + 1 : 0;
269 	len += sock_len;
270 
271 	if ((frame = malloc(len)) == NULL) {
272 #ifdef PERFUSE_DEBUG
273 		if (perfuse_diagflags & PDF_MISC)
274 			DWARN("%s:%d malloc failed", __func__, __LINE__);
275 #endif
276 		return -1;
277 	}
278 
279 	pmo = (struct perfuse_mount_out *)(void *)frame;
280 	pmo->pmo_len = len;
281 	pmo->pmo_error = 0;
282 	pmo->pmo_unique = (uint64_t)-1;
283 	(void)strcpy(pmo->pmo_magic, PERFUSE_MOUNT_MAGIC);
284 
285 	pmo->pmo_source_len = source ? (uint32_t)strlen(source) + 1 : 0;
286 	pmo->pmo_target_len = target ? (uint32_t)strlen(target) + 1: 0;
287 	pmo->pmo_filesystemtype_len =
288 	    filesystemtype ? (uint32_t)strlen(filesystemtype) + 1 : 0;
289 	pmo->pmo_mountflags = (uint32_t)mountflags;
290 	pmo->pmo_data_len = data ? (uint32_t)strlen(data) + 1 : 0;
291 	pmo->pmo_sock_len = sock_len;
292 
293 	cp = (char *)(void *)(pmo + 1);
294 
295 	if (source) {
296 		(void)strcpy(cp, source);
297 		cp += pmo->pmo_source_len;
298 	}
299 
300 	if (target) {
301 		(void)strcpy(cp, target);
302 		cp += pmo->pmo_target_len;
303 	}
304 
305 	if (filesystemtype) {
306 		(void)strcpy(cp, filesystemtype);
307 		cp += pmo->pmo_filesystemtype_len;
308 	}
309 
310 	if (data) {
311 		(void)strcpy(cp, data);
312 		cp += pmo->pmo_data_len;
313 	}
314 
315 	if (sock_len != 0) {
316 		(void)strcpy(cp, sun->sun_path);
317 		cp += pmo->pmo_sock_len;
318 	}
319 
320 	if (send(s, frame, len, MSG_NOSIGNAL) != len) {
321 #ifdef PERFUSE_DEBUG
322 		DWARN("%s:%d sendto failed", __func__, __LINE__);
323 #endif
324 		return -1;
325 	}
326 
327 	return 0;
328 }
329 
330 
331 uint64_t
332 perfuse_next_unique(pu)
333 	struct puffs_usermount *pu;
334 {
335 	struct perfuse_state *ps;
336 
337 	ps = puffs_getspecific(pu);
338 
339 	return ps->ps_unique++;
340 }
341 
342 struct puffs_usermount *
343 perfuse_init(pc, pmi)
344 	struct perfuse_callbacks *pc;
345 	struct perfuse_mount_info *pmi;
346 {
347 	struct perfuse_state *ps;
348 	struct puffs_usermount *pu;
349 	struct puffs_ops *pops;
350 	char name[] = "perfuse";
351 	unsigned int puffs_flags;
352 	struct puffs_node *pn_root;
353 	struct puffs_pathobj *po_root;
354 
355 	ps = init_state();
356 	ps->ps_owner_uid = pmi->pmi_uid;
357 
358 	if (pmi->pmi_source)
359 		ps->ps_source = strdup(pmi->pmi_source);
360 	if (pmi->pmi_filesystemtype)
361 		ps->ps_filesystemtype = strdup(pmi->pmi_filesystemtype);
362 	ps->ps_target = strdup(pmi->pmi_target);
363 	ps->ps_mountflags = pmi->pmi_mountflags;
364 
365 	/*
366 	 * Some options are forbidden for non root users
367 	 */
368 	if (ps->ps_owner_uid != 0)
369 	    ps->ps_mountflags |= MNT_NOSUID|MNT_NODEV;
370 
371 	PUFFSOP_INIT(pops);
372 	PUFFSOP_SET(pops, perfuse, fs, unmount);
373 	PUFFSOP_SET(pops, perfuse, fs, statvfs);
374 	PUFFSOP_SET(pops, perfuse, fs, sync);
375 	PUFFSOP_SET(pops, perfuse, node, lookup);
376 	PUFFSOP_SET(pops, perfuse, node, create);
377 	PUFFSOP_SET(pops, perfuse, node, mknod);
378 	PUFFSOP_SET(pops, perfuse, node, open);
379 	PUFFSOP_SET(pops, perfuse, node, close);
380 	PUFFSOP_SET(pops, perfuse, node, access);
381 	PUFFSOP_SET(pops, perfuse, node, getattr);
382 	PUFFSOP_SET(pops, perfuse, node, setattr);
383 	PUFFSOP_SET(pops, perfuse, node, poll);
384 #if 0
385 	PUFFSOP_SET(pops, perfuse, node, mmap);
386 #endif
387 	PUFFSOP_SET(pops, perfuse, node, fsync);
388 	PUFFSOP_SET(pops, perfuse, node, seek);
389 	PUFFSOP_SET(pops, perfuse, node, remove);
390 	PUFFSOP_SET(pops, perfuse, node, link);
391 	PUFFSOP_SET(pops, perfuse, node, rename);
392 	PUFFSOP_SET(pops, perfuse, node, mkdir);
393 	PUFFSOP_SET(pops, perfuse, node, rmdir);
394 	PUFFSOP_SET(pops, perfuse, node, symlink);
395 	PUFFSOP_SET(pops, perfuse, node, readdir);
396 	PUFFSOP_SET(pops, perfuse, node, readlink);
397 	PUFFSOP_SET(pops, perfuse, node, reclaim);
398 	PUFFSOP_SET(pops, perfuse, node, inactive);
399 	PUFFSOP_SET(pops, perfuse, node, print);
400 	PUFFSOP_SET(pops, perfuse, node, advlock);
401 	PUFFSOP_SET(pops, perfuse, node, read);
402 	PUFFSOP_SET(pops, perfuse, node, write);
403 
404 	puffs_flags = PUFFS_KFLAG_WTCACHE;
405 
406 	if (perfuse_diagflags & PDF_PUFFS)
407 		puffs_flags |= PUFFS_FLAG_OPDUMP;
408 
409 	if ((pu = puffs_init(pops, _PATH_PUFFS, name, ps, puffs_flags)) == NULL)
410 		DERR(EX_OSERR, "puffs_init failed");
411 
412 	ps->ps_pu = pu;
413 
414 	/*
415 	 * Setup filesystem root
416 	 */
417 	pn_root = perfuse_new_pn(pu, "", NULL);
418 	PERFUSE_NODE_DATA(pn_root)->pnd_ino = FUSE_ROOT_ID;
419 	PERFUSE_NODE_DATA(pn_root)->pnd_parent = pn_root;
420 	puffs_setroot(pu, pn_root);
421 	ps->ps_fsid = pn_root->pn_va.va_fsid;
422 
423 	po_root = puffs_getrootpathobj(pu);
424 	if ((po_root->po_path = strdup("/")) == NULL)
425 		DERRX(EX_OSERR, "perfuse_mount_start() failed");
426 
427 	po_root->po_len = 1;
428 	puffs_path_buildhash(pu, po_root);
429 
430 	puffs_vattr_null(&pn_root->pn_va);
431 	pn_root->pn_va.va_type = VDIR;
432 	pn_root->pn_va.va_mode = 0755;
433 
434 	ps->ps_root = pn_root;
435 
436 	/*
437 	 *  Callbacks
438 	 */
439 	ps->ps_new_msg = pc->pc_new_msg;
440 	ps->ps_xchg_msg = pc->pc_xchg_msg;
441 	ps->ps_destroy_msg = pc->pc_destroy_msg;
442 	ps->ps_get_inhdr = pc->pc_get_inhdr;
443 	ps->ps_get_inpayload = pc->pc_get_inpayload;
444 	ps->ps_get_outhdr = pc->pc_get_outhdr;
445 	ps->ps_get_outpayload = pc->pc_get_outpayload;
446 
447 	return pu;
448 }
449 
450 void
451 perfuse_setspecific(pu, priv)
452 	struct puffs_usermount *pu;
453 	void *priv;
454 {
455 	struct perfuse_state *ps;
456 
457 	ps = puffs_getspecific(pu);
458 	ps->ps_private = priv;
459 
460 	return;
461 }
462 
463 void *
464 perfuse_getspecific(pu)
465 	struct puffs_usermount *pu;
466 {
467 	struct perfuse_state *ps;
468 
469 	ps = puffs_getspecific(pu);
470 
471 	return ps->ps_private;
472 }
473 
474 int
475 perfuse_inloop(pu)
476 	struct puffs_usermount *pu;
477 {
478 	struct perfuse_state *ps;
479 
480 	ps = puffs_getspecific(pu);
481 
482 	return ps->ps_flags & PS_INLOOP;
483 }
484 
485 int
486 perfuse_mainloop(pu)
487 	struct puffs_usermount *pu;
488 {
489 	struct perfuse_state *ps;
490 
491 	ps = puffs_getspecific(pu);
492 
493 	ps->ps_flags |= PS_INLOOP;
494 	if (puffs_mainloop(ps->ps_pu) != 0)
495 		DERR(EX_OSERR, "puffs_mainloop failed");
496 	DERR(EX_OSERR, "puffs_mainloop exit");
497 
498 	/* NOTREACHED */
499 	return -1;
500 }
501 
502 /* ARGSUSED0 */
503 uint64_t
504 perfuse_get_ino(pu, opc)
505 	struct puffs_usermount *pu;
506 	puffs_cookie_t opc;
507 {
508 	return PERFUSE_NODE_DATA(opc)->pnd_ino;
509 }
510 
511 int
512 perfuse_unmount(pu)
513 	struct puffs_usermount *pu;
514 {
515 	struct perfuse_state *ps;
516 
517 	ps = puffs_getspecific(pu);
518 
519 	return unmount(ps->ps_target, MNT_FORCE);
520 }
521