xref: /netbsd/lib/librefuse/fuse_internal.h (revision 0183fe03)
1 /* $NetBSD: fuse_internal.h,v 1.5 2022/01/22 08:09:39 pho Exp $ */
2 
3 /*
4  * Copyright (c) 2021 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote
16  *    products derived from this software without specific prior written
17  *    permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
20  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
25  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 #if !defined(FUSE_INTERNAL_H)
32 #define FUSE_INTERNAL_H
33 
34 /* We emit a compiler warning for anyone including <fuse.h> without
35  * defining FUSE_USE_VERSION. Exempt ourselves here, or we'll be
36  * warned too. */
37 #define _REFUSE_IMPLEMENTATION_
38 
39 #include <fuse.h>
40 #include <fuse_lowlevel.h>
41 #include <sys/cdefs.h>
42 
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
47 /* This is the private fuse structure. We can freely change its size
48  * and/or layout without worrying about ABI breakage. */
49 struct fuse {
50 	struct puffs_usermount	*pu;
51 	int			dead;
52 	struct fuse_fs		*fs; /* The base filesystem layer. */
53 };
54 
55 enum refuse_show_help_variant {
56 	REFUSE_SHOW_HELP_FULL		= 1,
57 	REFUSE_SHOW_HELP_NO_HEADER	= 2,
58 };
59 
60 /* Internal functions, hidden from users */
61 __BEGIN_HIDDEN_DECLS
62 int __fuse_set_signal_handlers(struct fuse* fuse);
63 int __fuse_remove_signal_handlers(struct fuse* fuse);
64 struct fuse* __fuse_setup(int argc, char* argv[],
65                           const void* op, int op_version, void* user_data,
66                           struct fuse_cmdline_opts* opts);
67 void __fuse_teardown(struct fuse* fuse);
68 
69 /* Generic implementation of fuse_new(). The exact type of "op" is
70  * determined by op_version. */
71 struct fuse* __fuse_new(struct fuse_args *args, const void* op,
72                         int op_version, void* user_data);
73 
74 int __fuse_mount(struct fuse *fuse, const char *mountpoint);
75 void __fuse_unmount(struct fuse *fuse);
76 void __fuse_destroy(struct fuse *fuse);
77 int __fuse_loop_mt(struct fuse *fuse, struct fuse_loop_config *config);
78 int __fuse_parse_cmdline(struct fuse_args *args, struct fuse_cmdline_opts *opts);
79 __END_HIDDEN_DECLS
80 
81 #ifdef __cplusplus
82 }
83 #endif
84 
85 #endif
86