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