1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 2007-2009 Google Inc. and Amit Singh 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 are 9 * met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above 14 * copyright notice, this list of conditions and the following disclaimer 15 * in the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Google Inc. nor the names of its 18 * contributors may be used to endorse or promote products derived from 19 * this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 * 33 * Copyright (C) 2005 Csaba Henk. 34 * All rights reserved. 35 * 36 * Redistribution and use in source and binary forms, with or without 37 * modification, are permitted provided that the following conditions 38 * are met: 39 * 1. Redistributions of source code must retain the above copyright 40 * notice, this list of conditions and the following disclaimer. 41 * 2. Redistributions in binary form must reproduce the above copyright 42 * notice, this list of conditions and the following disclaimer in the 43 * documentation and/or other materials provided with the distribution. 44 * 45 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 46 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 47 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 48 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 49 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 50 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 51 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 54 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 55 * SUCH DAMAGE. 56 * 57 * $FreeBSD$ 58 */ 59 60 #ifndef _FUSE_IPC_H_ 61 #define _FUSE_IPC_H_ 62 63 #include <sys/param.h> 64 #include <sys/refcount.h> 65 66 struct fuse_iov { 67 void *base; 68 size_t len; 69 size_t allocated_size; 70 int credit; 71 }; 72 73 void fiov_init(struct fuse_iov *fiov, size_t size); 74 void fiov_teardown(struct fuse_iov *fiov); 75 void fiov_refresh(struct fuse_iov *fiov); 76 void fiov_adjust(struct fuse_iov *fiov, size_t size); 77 78 #define FUSE_DIMALLOC(fiov, spc1, spc2, amnt) \ 79 do { \ 80 fiov_adjust(fiov, (sizeof(*(spc1)) + (amnt))); \ 81 (spc1) = (fiov)->base; \ 82 (spc2) = (char *)(fiov)->base + (sizeof(*(spc1))); \ 83 } while (0) 84 85 #define FU_AT_LEAST(siz) max((siz), 160) 86 87 #define FUSE_ASSERT_AW_DONE(ftick) \ 88 KASSERT((ftick)->tk_aw_link.tqe_next == NULL && \ 89 (ftick)->tk_aw_link.tqe_prev == NULL, \ 90 ("FUSE: ticket still on answer delivery list %p", (ftick))) \ 91 92 #define FUSE_ASSERT_MS_DONE(ftick) \ 93 KASSERT((ftick)->tk_ms_link.stqe_next == NULL, \ 94 ("FUSE: ticket still on message list %p", (ftick))) 95 96 struct fuse_ticket; 97 struct fuse_data; 98 99 typedef int fuse_handler_t(struct fuse_ticket *ftick, struct uio *uio); 100 101 struct fuse_ticket { 102 /* fields giving the identity of the ticket */ 103 uint64_t tk_unique; 104 struct fuse_data *tk_data; 105 int tk_flag; 106 u_int tk_refcount; 107 108 /* fields for initiating an upgoing message */ 109 struct fuse_iov tk_ms_fiov; 110 void *tk_ms_bufdata; 111 size_t tk_ms_bufsize; 112 enum { FT_M_FIOV, FT_M_BUF } tk_ms_type; 113 STAILQ_ENTRY(fuse_ticket) tk_ms_link; 114 115 /* fields for handling answers coming from userspace */ 116 struct fuse_iov tk_aw_fiov; 117 void *tk_aw_bufdata; 118 size_t tk_aw_bufsize; 119 enum { FT_A_FIOV, FT_A_BUF } tk_aw_type; 120 121 struct fuse_out_header tk_aw_ohead; 122 int tk_aw_errno; 123 struct mtx tk_aw_mtx; 124 fuse_handler_t *tk_aw_handler; 125 TAILQ_ENTRY(fuse_ticket) tk_aw_link; 126 }; 127 128 #define FT_ANSW 0x01 /* request of ticket has already been answered */ 129 #define FT_DIRTY 0x04 /* ticket has been used */ 130 131 static __inline__ 132 struct fuse_iov * 133 fticket_resp(struct fuse_ticket *ftick) 134 { 135 return (&ftick->tk_aw_fiov); 136 } 137 138 static __inline__ 139 int 140 fticket_answered(struct fuse_ticket *ftick) 141 { 142 DEBUGX(FUSE_DEBUG_IPC, "-> ftick=%p\n", ftick); 143 mtx_assert(&ftick->tk_aw_mtx, MA_OWNED); 144 return (ftick->tk_flag & FT_ANSW); 145 } 146 147 static __inline__ 148 void 149 fticket_set_answered(struct fuse_ticket *ftick) 150 { 151 DEBUGX(FUSE_DEBUG_IPC, "-> ftick=%p\n", ftick); 152 mtx_assert(&ftick->tk_aw_mtx, MA_OWNED); 153 ftick->tk_flag |= FT_ANSW; 154 } 155 156 static __inline__ 157 enum fuse_opcode 158 fticket_opcode(struct fuse_ticket *ftick) 159 { 160 DEBUGX(FUSE_DEBUG_IPC, "-> ftick=%p\n", ftick); 161 return (((struct fuse_in_header *)(ftick->tk_ms_fiov.base))->opcode); 162 } 163 164 int fticket_pull(struct fuse_ticket *ftick, struct uio *uio); 165 166 enum mountpri { FM_NOMOUNTED, FM_PRIMARY, FM_SECONDARY }; 167 168 /* 169 * The data representing a FUSE session. 170 */ 171 struct fuse_data { 172 struct cdev *fdev; 173 struct mount *mp; 174 struct vnode *vroot; 175 struct ucred *daemoncred; 176 int dataflags; 177 int ref; 178 179 struct mtx ms_mtx; 180 STAILQ_HEAD(, fuse_ticket) ms_head; 181 182 struct mtx aw_mtx; 183 TAILQ_HEAD(, fuse_ticket) aw_head; 184 185 u_long ticketer; 186 187 struct sx rename_lock; 188 189 uint32_t fuse_libabi_major; 190 uint32_t fuse_libabi_minor; 191 192 uint32_t max_write; 193 uint32_t max_read; 194 uint32_t subtype; 195 char volname[MAXPATHLEN]; 196 197 struct selinfo ks_rsel; 198 199 int daemon_timeout; 200 uint64_t notimpl; 201 }; 202 203 #define FSESS_DEAD 0x0001 /* session is to be closed */ 204 #define FSESS_UNUSED0 0x0002 /* unused */ 205 #define FSESS_INITED 0x0004 /* session has been inited */ 206 #define FSESS_DAEMON_CAN_SPY 0x0010 /* let non-owners access this fs */ 207 /* (and being observed by the daemon) */ 208 #define FSESS_PUSH_SYMLINKS_IN 0x0020 /* prefix absolute symlinks with mp */ 209 #define FSESS_DEFAULT_PERMISSIONS 0x0040 /* kernel does permission checking */ 210 #define FSESS_NO_ATTRCACHE 0x0080 /* no attribute caching */ 211 #define FSESS_NO_READAHEAD 0x0100 /* no readaheads */ 212 #define FSESS_NO_DATACACHE 0x0200 /* disable buffer cache */ 213 #define FSESS_NO_NAMECACHE 0x0400 /* disable name cache */ 214 #define FSESS_NO_MMAP 0x0800 /* disable mmap */ 215 #define FSESS_BROKENIO 0x1000 /* fix broken io */ 216 217 extern int fuse_data_cache_enable; 218 extern int fuse_data_cache_invalidate; 219 extern int fuse_mmap_enable; 220 extern int fuse_sync_resize; 221 extern int fuse_fix_broken_io; 222 223 static __inline__ 224 struct fuse_data * 225 fuse_get_mpdata(struct mount *mp) 226 { 227 return mp->mnt_data; 228 } 229 230 static __inline int 231 fsess_isimpl(struct mount *mp, int opcode) 232 { 233 struct fuse_data *data = fuse_get_mpdata(mp); 234 235 return (data->notimpl & (1ULL << opcode)) == 0; 236 237 } 238 static __inline void 239 fsess_set_notimpl(struct mount *mp, int opcode) 240 { 241 struct fuse_data *data = fuse_get_mpdata(mp); 242 243 data->notimpl |= (1ULL << opcode); 244 } 245 246 static __inline int 247 fsess_opt_datacache(struct mount *mp) 248 { 249 struct fuse_data *data = fuse_get_mpdata(mp); 250 251 return (fuse_data_cache_enable || 252 (data->dataflags & FSESS_NO_DATACACHE) == 0); 253 } 254 255 static __inline int 256 fsess_opt_mmap(struct mount *mp) 257 { 258 struct fuse_data *data = fuse_get_mpdata(mp); 259 260 if (!(fuse_mmap_enable && fuse_data_cache_enable)) 261 return 0; 262 return ((data->dataflags & (FSESS_NO_DATACACHE | FSESS_NO_MMAP)) == 0); 263 } 264 265 static __inline int 266 fsess_opt_brokenio(struct mount *mp) 267 { 268 struct fuse_data *data = fuse_get_mpdata(mp); 269 270 return (fuse_fix_broken_io || (data->dataflags & FSESS_BROKENIO)); 271 } 272 273 static __inline__ 274 void 275 fuse_ms_push(struct fuse_ticket *ftick) 276 { 277 DEBUGX(FUSE_DEBUG_IPC, "ftick=%p refcount=%d\n", 278 ftick, ftick->tk_refcount + 1); 279 mtx_assert(&ftick->tk_data->ms_mtx, MA_OWNED); 280 refcount_acquire(&ftick->tk_refcount); 281 STAILQ_INSERT_TAIL(&ftick->tk_data->ms_head, ftick, tk_ms_link); 282 } 283 284 static __inline__ 285 struct fuse_ticket * 286 fuse_ms_pop(struct fuse_data *data) 287 { 288 struct fuse_ticket *ftick = NULL; 289 290 mtx_assert(&data->ms_mtx, MA_OWNED); 291 292 if ((ftick = STAILQ_FIRST(&data->ms_head))) { 293 STAILQ_REMOVE_HEAD(&data->ms_head, tk_ms_link); 294 #ifdef INVARIANTS 295 ftick->tk_ms_link.stqe_next = NULL; 296 #endif 297 } 298 DEBUGX(FUSE_DEBUG_IPC, "ftick=%p refcount=%d\n", 299 ftick, ftick ? ftick->tk_refcount : -1); 300 301 return ftick; 302 } 303 304 static __inline__ 305 void 306 fuse_aw_push(struct fuse_ticket *ftick) 307 { 308 DEBUGX(FUSE_DEBUG_IPC, "ftick=%p refcount=%d\n", 309 ftick, ftick->tk_refcount + 1); 310 mtx_assert(&ftick->tk_data->aw_mtx, MA_OWNED); 311 refcount_acquire(&ftick->tk_refcount); 312 TAILQ_INSERT_TAIL(&ftick->tk_data->aw_head, ftick, tk_aw_link); 313 } 314 315 static __inline__ 316 void 317 fuse_aw_remove(struct fuse_ticket *ftick) 318 { 319 DEBUGX(FUSE_DEBUG_IPC, "ftick=%p refcount=%d\n", 320 ftick, ftick->tk_refcount); 321 mtx_assert(&ftick->tk_data->aw_mtx, MA_OWNED); 322 TAILQ_REMOVE(&ftick->tk_data->aw_head, ftick, tk_aw_link); 323 #ifdef INVARIANTS 324 ftick->tk_aw_link.tqe_next = NULL; 325 ftick->tk_aw_link.tqe_prev = NULL; 326 #endif 327 } 328 329 static __inline__ 330 struct fuse_ticket * 331 fuse_aw_pop(struct fuse_data *data) 332 { 333 struct fuse_ticket *ftick = NULL; 334 335 mtx_assert(&data->aw_mtx, MA_OWNED); 336 337 if ((ftick = TAILQ_FIRST(&data->aw_head))) { 338 fuse_aw_remove(ftick); 339 } 340 DEBUGX(FUSE_DEBUG_IPC, "ftick=%p refcount=%d\n", 341 ftick, ftick ? ftick->tk_refcount : -1); 342 343 return ftick; 344 } 345 346 struct fuse_ticket *fuse_ticket_fetch(struct fuse_data *data); 347 int fuse_ticket_drop(struct fuse_ticket *ftick); 348 void fuse_insert_callback(struct fuse_ticket *ftick, fuse_handler_t *handler); 349 void fuse_insert_message(struct fuse_ticket *ftick); 350 351 static __inline__ 352 int 353 fuse_libabi_geq(struct fuse_data *data, uint32_t abi_maj, uint32_t abi_min) 354 { 355 return (data->fuse_libabi_major > abi_maj || 356 (data->fuse_libabi_major == abi_maj && data->fuse_libabi_minor >= abi_min)); 357 } 358 359 struct fuse_data *fdata_alloc(struct cdev *dev, struct ucred *cred); 360 void fdata_trydestroy(struct fuse_data *data); 361 void fdata_set_dead(struct fuse_data *data); 362 363 static __inline__ 364 int 365 fdata_get_dead(struct fuse_data *data) 366 { 367 return (data->dataflags & FSESS_DEAD); 368 } 369 370 struct fuse_dispatcher { 371 372 struct fuse_ticket *tick; 373 struct fuse_in_header *finh; 374 375 void *indata; 376 size_t iosize; 377 uint64_t nodeid; 378 int answ_stat; 379 void *answ; 380 }; 381 382 static __inline__ 383 void 384 fdisp_init(struct fuse_dispatcher *fdisp, size_t iosize) 385 { 386 DEBUGX(FUSE_DEBUG_IPC, "-> fdisp=%p, iosize=%zx\n", fdisp, iosize); 387 fdisp->iosize = iosize; 388 fdisp->tick = NULL; 389 } 390 391 static __inline__ 392 void 393 fdisp_destroy(struct fuse_dispatcher *fdisp) 394 { 395 DEBUGX(FUSE_DEBUG_IPC, "-> fdisp=%p, ftick=%p\n", fdisp, fdisp->tick); 396 fuse_ticket_drop(fdisp->tick); 397 #ifdef INVARIANTS 398 fdisp->tick = NULL; 399 #endif 400 } 401 402 void fdisp_make(struct fuse_dispatcher *fdip, enum fuse_opcode op, 403 struct mount *mp, uint64_t nid, struct thread *td, 404 struct ucred *cred); 405 406 void fdisp_make_pid(struct fuse_dispatcher *fdip, enum fuse_opcode op, 407 struct mount *mp, uint64_t nid, pid_t pid, 408 struct ucred *cred); 409 410 void fdisp_make_vp(struct fuse_dispatcher *fdip, enum fuse_opcode op, 411 struct vnode *vp, struct thread *td, struct ucred *cred); 412 413 int fdisp_wait_answ(struct fuse_dispatcher *fdip); 414 415 static __inline__ 416 int 417 fdisp_simple_putget_vp(struct fuse_dispatcher *fdip, enum fuse_opcode op, 418 struct vnode *vp, struct thread *td, struct ucred *cred) 419 { 420 DEBUGX(FUSE_DEBUG_IPC, "-> fdip=%p, opcode=%d, vp=%p\n", fdip, op, vp); 421 fdisp_make_vp(fdip, op, vp, td, cred); 422 return fdisp_wait_answ(fdip); 423 } 424 425 #endif /* _FUSE_IPC_H_ */ 426