perfuse_if.h revision 1.13
1 /* $NetBSD: perfuse_if.h,v 1.13 2011/05/30 14:50:08 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_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 char fmterr[BUFSIZ]; \ 81 char strerrbuf[BUFSIZ]; \ 82 \ 83 (void)strerror_r(errno, strerrbuf, sizeof(strerrbuf)); \ 84 (void)sprintf(fmterr, "%s: %s\n", fmt, strerrbuf); \ 85 \ 86 if (perfuse_diagflags & PDF_SYSLOG) \ 87 syslog(LOG_ERR, fmterr, ## __VA_ARGS__); \ 88 \ 89 if (perfuse_diagflags & PDF_FOREGROUND) { \ 90 (void)fprintf(stderr, fmterr, ## __VA_ARGS__); \ 91 abort(); \ 92 } else { \ 93 errx(status, fmt, ## __VA_ARGS__); \ 94 } \ 95 } while (0 /* CONSTCOND */) 96 97 #define DWARNX(fmt, ...) do { \ 98 if (perfuse_diagflags & PDF_SYSLOG) \ 99 syslog(LOG_WARNING, fmt, ## __VA_ARGS__); \ 100 \ 101 warnx(fmt, ## __VA_ARGS__); \ 102 } while (0 /* CONSTCOND */) 103 104 #define DWARN(fmt, ...) do { \ 105 char fmterr[BUFSIZ]; \ 106 char strerrbuf[BUFSIZ]; \ 107 \ 108 (void)strerror_r(errno, strerrbuf, sizeof(strerrbuf)); \ 109 (void)sprintf(fmterr, "%s: %s\n", fmt, strerrbuf); \ 110 \ 111 if (perfuse_diagflags & PDF_SYSLOG) \ 112 syslog(LOG_WARNING, fmterr, ## __VA_ARGS__); \ 113 \ 114 warn(fmterr, ## __VA_ARGS__); \ 115 } while (0 /* CONSTCOND */) 116 117 /* 118 * frame handling callbacks 119 */ 120 #ifndef PEFUSE_MSG_T 121 #define PEFUSE_MSG_T struct perfuse_framebuf 122 #endif 123 typedef PEFUSE_MSG_T perfuse_msg_t; 124 125 #define PERFUSE_UNSPEC_REPLY_LEN (size_t)-1 126 127 enum perfuse_xchg_pb_reply { wait_reply, no_reply }; 128 typedef perfuse_msg_t *(*perfuse_new_msg_fn)(struct puffs_usermount *, 129 puffs_cookie_t, int, size_t, const struct puffs_cred *); 130 typedef int (*perfuse_xchg_msg_fn)(struct puffs_usermount *, 131 perfuse_msg_t *, size_t, enum perfuse_xchg_pb_reply); 132 typedef void (*perfuse_destroy_msg_fn)(perfuse_msg_t *); 133 typedef struct fuse_out_header *(*perfuse_get_outhdr_fn)(perfuse_msg_t *); 134 typedef struct fuse_in_header *(*perfuse_get_inhdr_fn)(perfuse_msg_t *); 135 typedef char *(*perfuse_get_inpayload_fn)(perfuse_msg_t *); 136 typedef char *(*perfuse_get_outpayload_fn)(perfuse_msg_t *); 137 typedef void (*perfuse_umount_fn)(struct puffs_usermount *); 138 139 struct perfuse_callbacks { 140 perfuse_new_msg_fn pc_new_msg; 141 perfuse_xchg_msg_fn pc_xchg_msg; 142 perfuse_destroy_msg_fn pc_destroy_msg; 143 perfuse_get_inhdr_fn pc_get_inhdr; 144 perfuse_get_inpayload_fn pc_get_inpayload; 145 perfuse_get_outhdr_fn pc_get_outhdr; 146 perfuse_get_outpayload_fn pc_get_outpayload; 147 perfuse_umount_fn pc_umount; 148 }; 149 150 /* 151 * mount request 152 */ 153 struct perfuse_mount_out { 154 uint32_t pmo_len; 155 int32_t pmo_error; 156 uint64_t pmo_unique; 157 char pmo_magic[sizeof(PERFUSE_MOUNT_MAGIC)]; 158 uint32_t pmo_source_len; 159 uint32_t pmo_target_len; 160 uint32_t pmo_filesystemtype_len; 161 uint32_t pmo_mountflags; 162 uint32_t pmo_data_len; 163 uint32_t pmo_sock_len; 164 }; 165 166 struct perfuse_mount_info { 167 const char *pmi_source; 168 const char *pmi_target; 169 const char *pmi_filesystemtype; 170 int pmi_mountflags; 171 void *pmi_data; 172 uid_t pmi_uid; 173 }; 174 175 /* 176 * Duplicated from fuse.h to avoid making it public 177 */ 178 #ifndef FUSE_BUFSIZE 179 #define FUSE_MIN_BUFSIZE 0x21000 180 #define FUSE_PREF_BUFSIZE (sysconf(_SC_PAGESIZE) + 0x1000) 181 #define FUSE_BUFSIZE MAX(FUSE_PREF_BUFSIZE /* CONSTCOND */, FUSE_MIN_BUFSIZE) 182 #endif /* FUSE_BUFSIZE */ 183 184 struct fuse_in_header { 185 uint32_t len; 186 uint32_t opcode; 187 uint64_t unique; 188 uint64_t nodeid; 189 uint32_t uid; 190 uint32_t gid; 191 uint32_t pid; 192 uint32_t padding; 193 }; 194 195 struct fuse_out_header { 196 uint32_t len; 197 int32_t error; 198 uint64_t unique; 199 }; 200 201 __BEGIN_DECLS 202 203 struct puffs_usermount *perfuse_init(struct perfuse_callbacks *, 204 struct perfuse_mount_info *); 205 void perfuse_setspecific(struct puffs_usermount *, void *); 206 void *perfuse_getspecific(struct puffs_usermount *); 207 uint64_t perfuse_next_unique(struct puffs_usermount *); 208 uint64_t perfuse_get_ino(struct puffs_usermount *, puffs_cookie_t); 209 int perfuse_inloop(struct puffs_usermount *); 210 const char *perfuse_opname(int); 211 void perfuse_fs_init(struct puffs_usermount *); 212 int perfuse_mainloop(struct puffs_usermount *); 213 int perfuse_unmount(struct puffs_usermount *); 214 215 #endif /* _PERFUSE_IF_H */ 216
Indexes created Thu Oct 02 14:10:14 GMT 2025