perfuse_if.h revision 1.15
1 /* $NetBSD: perfuse_if.h,v 1.15 2011/08/14 08:19:04 christos 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_IF_H 29 #define _PERFUSE_IF_H 30 31 #ifndef _PATH_PERFUSED 32 #define _PATH_PERFUSED "/usr/sbin/perfused" 33 #endif /* _PATH_PERFUSED */ 34 #define _PATH_FUSE "/dev/fuse" 35 #define FUSE_COMMFD_ENV "_FUSE_COMMFD" 36 #define PERFUSE_MOUNT_MAGIC "noFuseRq" 37 #define PERFUSE_UNKNOWN_INO 0xffffffff 38 39 /* 40 * Diagnostic flags. This global is used only for DPRINTF/DERR/DWARN 41 */ 42 extern int perfuse_diagflags; 43 #define PDF_FOREGROUND 0x001 /* we run in foreground */ 44 #define PDF_FUSE 0x002 /* Display FUSE reqeusts and reply */ 45 #define PDF_DUMP 0x004 /* Dump FUSE frames */ 46 #define PDF_PUFFS 0x008 /* Display PUFFS requets and reply */ 47 #define PDF_FH 0x010 /* File handles */ 48 #define PDF_RECLAIM 0x020 /* Reclaimed files */ 49 #define PDF_READDIR 0x040 /* readdir operations */ 50 #define PDF_REQUEUE 0x080 /* reueued messages */ 51 #define PDF_SYNC 0x100 /* fsync and dirty flags */ 52 #define PDF_MISC 0x200 /* Miscelaneous messages */ 53 #define PDF_SYSLOG 0x400 /* use syslog */ 54 #define PDF_FILENAME 0x800 /* File names */ 55 56 /* 57 * Diagnostic functions 58 */ 59 #define DPRINTF(fmt, ...) do { \ 60 if (perfuse_diagflags & PDF_SYSLOG) \ 61 syslog(LOG_INFO, fmt, ## __VA_ARGS__); \ 62 \ 63 if (perfuse_diagflags & PDF_FOREGROUND) \ 64 (void)printf(fmt, ## __VA_ARGS__); \ 65 } while (0 /* CONSTCOND */) 66 67 #define DERRX(status, fmt, ...) do { \ 68 if (perfuse_diagflags & PDF_SYSLOG) \ 69 syslog(LOG_ERR, fmt, ## __VA_ARGS__); \ 70 \ 71 if (perfuse_diagflags & PDF_FOREGROUND) { \ 72 (void)fprintf(stderr, fmt, ## __VA_ARGS__); \ 73 abort(); \ 74 } else { \ 75 errx(status, fmt, ## __VA_ARGS__); \ 76 } \ 77 } while (0 /* CONSTCOND */) 78 79 #define DERR(status, fmt, ...) do { \ 80 if (perfuse_diagflags & PDF_SYSLOG) \ 81 syslog(LOG_ERR, fmt ": %m", ## __VA_ARGS__); \ 82 \ 83 if (perfuse_diagflags & PDF_FOREGROUND) { \ 84 char strerrbuf[BUFSIZ]; \ 85 \ 86 (void)strerror_r(errno, strerrbuf, sizeof(strerrbuf)); \ 87 (void)fprintf(stderr, fmt ": %s", ## __VA_ARGS__, \ 88 strerrbuf); \ 89 abort(); \ 90 } else { \ 91 err(status, fmt, ## __VA_ARGS__); \ 92 } \ 93 } while (0 /* CONSTCOND */) 94 95 #define DWARNX(fmt, ...) do { \ 96 if (perfuse_diagflags & PDF_SYSLOG) \ 97 syslog(LOG_WARNING, fmt, ## __VA_ARGS__); \ 98 \ 99 warnx(fmt, ## __VA_ARGS__); \ 100 } while (0 /* CONSTCOND */) 101 102 #define DWARN(fmt, ...) do { \ 103 \ 104 if (perfuse_diagflags & PDF_SYSLOG) \ 105 syslog(LOG_WARNING, fmt ": %m", ## __VA_ARGS__); \ 106 \ 107 warn(fmt, ## __VA_ARGS__); \ 108 } while (0 /* CONSTCOND */) 109 110 /* 111 * frame handling callbacks 112 */ 113 #ifndef PEFUSE_MSG_T 114 #define PEFUSE_MSG_T struct perfuse_framebuf 115 #endif 116 typedef PEFUSE_MSG_T perfuse_msg_t; 117 118 #define PERFUSE_UNSPEC_REPLY_LEN (size_t)-1 119 120 enum perfuse_xchg_pb_reply { wait_reply, no_reply }; 121 typedef perfuse_msg_t *(*perfuse_new_msg_fn)(struct puffs_usermount *, 122 puffs_cookie_t, int, size_t, const struct puffs_cred *); 123 typedef int (*perfuse_xchg_msg_fn)(struct puffs_usermount *, 124 perfuse_msg_t *, size_t, enum perfuse_xchg_pb_reply); 125 typedef void (*perfuse_destroy_msg_fn)(perfuse_msg_t *); 126 typedef struct fuse_out_header *(*perfuse_get_outhdr_fn)(perfuse_msg_t *); 127 typedef struct fuse_in_header *(*perfuse_get_inhdr_fn)(perfuse_msg_t *); 128 typedef char *(*perfuse_get_inpayload_fn)(perfuse_msg_t *); 129 typedef char *(*perfuse_get_outpayload_fn)(perfuse_msg_t *); 130 typedef void (*perfuse_umount_fn)(struct puffs_usermount *); 131 132 struct perfuse_callbacks { 133 perfuse_new_msg_fn pc_new_msg; 134 perfuse_xchg_msg_fn pc_xchg_msg; 135 perfuse_destroy_msg_fn pc_destroy_msg; 136 perfuse_get_inhdr_fn pc_get_inhdr; 137 perfuse_get_inpayload_fn pc_get_inpayload; 138 perfuse_get_outhdr_fn pc_get_outhdr; 139 perfuse_get_outpayload_fn pc_get_outpayload; 140 perfuse_umount_fn pc_umount; 141 }; 142 143 /* 144 * mount request 145 */ 146 struct perfuse_mount_out { 147 uint32_t pmo_len; 148 int32_t pmo_error; 149 uint64_t pmo_unique; 150 char pmo_magic[sizeof(PERFUSE_MOUNT_MAGIC)]; 151 uint32_t pmo_source_len; 152 uint32_t pmo_target_len; 153 uint32_t pmo_filesystemtype_len; 154 uint32_t pmo_mountflags; 155 uint32_t pmo_data_len; 156 uint32_t pmo_sock_len; 157 }; 158 159 struct perfuse_mount_info { 160 const char *pmi_source; 161 const char *pmi_target; 162 const char *pmi_filesystemtype; 163 int pmi_mountflags; 164 void *pmi_data; 165 uid_t pmi_uid; 166 }; 167 168 /* 169 * Duplicated from fuse.h to avoid making it public 170 */ 171 #ifndef FUSE_BUFSIZE 172 #define FUSE_MIN_BUFSIZE 0x21000 173 #define FUSE_PREF_BUFSIZE (sysconf(_SC_PAGESIZE) + 0x1000) 174 #define FUSE_BUFSIZE MAX(FUSE_PREF_BUFSIZE /* CONSTCOND */, FUSE_MIN_BUFSIZE) 175 #endif /* FUSE_BUFSIZE */ 176 177 struct fuse_in_header { 178 uint32_t len; 179 uint32_t opcode; 180 uint64_t unique; 181 uint64_t nodeid; 182 uint32_t uid; 183 uint32_t gid; 184 uint32_t pid; 185 uint32_t padding; 186 }; 187 188 struct fuse_out_header { 189 uint32_t len; 190 int32_t error; 191 uint64_t unique; 192 }; 193 194 __BEGIN_DECLS 195 196 struct puffs_usermount *perfuse_init(struct perfuse_callbacks *, 197 struct perfuse_mount_info *); 198 void perfuse_setspecific(struct puffs_usermount *, void *); 199 void *perfuse_getspecific(struct puffs_usermount *); 200 uint64_t perfuse_next_unique(struct puffs_usermount *); 201 uint64_t perfuse_get_ino(struct puffs_usermount *, puffs_cookie_t); 202 int perfuse_inloop(struct puffs_usermount *); 203 const char *perfuse_opname(int); 204 void perfuse_fs_init(struct puffs_usermount *); 205 int perfuse_mainloop(struct puffs_usermount *); 206 int perfuse_unmount(struct puffs_usermount *); 207 208 #endif /* _PERFUSE_IF_H */ 209
Indexes created Tue Sep 23 23:09:58 GMT 2025