1 /*- 2 * Copyright (c) 2016 The DragonFly Project 3 * Copyright (c) 2014 The FreeBSD Foundation 4 * All rights reserved. 5 * 6 * This software was developed by Edward Tomasz Napierala under sponsorship 7 * from the FreeBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 * $FreeBSD$ 31 */ 32 33 #ifndef AUTOFS_H 34 #define AUTOFS_H 35 36 #include <sys/kernel.h> 37 #include <sys/module.h> 38 #include <sys/types.h> 39 #include <sys/systm.h> 40 #include <sys/malloc.h> 41 #include <sys/objcache.h> 42 #include <sys/tree.h> 43 #include <sys/lock.h> 44 #include <sys/mutex2.h> 45 #include <sys/condvar.h> 46 #include <sys/mount.h> 47 #include <sys/vnode.h> 48 #include <sys/timespec.h> 49 #include <sys/callout.h> 50 #include <sys/taskqueue.h> 51 #include <sys/conf.h> 52 #include <sys/bus.h> 53 54 #define AUTOFS_ROOTINO ((ino_t)1) 55 #define VFSTOAUTOFS(mp) ((struct autofs_mount *)((mp)->mnt_data)) 56 #define VTOI(vp) ((struct autofs_node *)((vp)->v_data)) 57 58 MALLOC_DECLARE(M_AUTOFS); 59 60 extern struct objcache *autofs_request_objcache; 61 extern struct objcache *autofs_node_objcache; 62 63 extern struct vop_ops autofs_vnode_vops; 64 65 extern int autofs_debug; 66 extern int autofs_mount_on_stat; 67 68 #define AUTOFS_DEBUG(X, ...) \ 69 do { \ 70 if (autofs_debug > 1) \ 71 kprintf("%s: " X "\n", \ 72 __func__, ## __VA_ARGS__); \ 73 } while (0) 74 75 #define AUTOFS_WARN(X, ...) \ 76 do { \ 77 if (autofs_debug > 0) { \ 78 kprintf("WARNING: %s: " X "\n", \ 79 __func__, ## __VA_ARGS__); \ 80 } \ 81 } while (0) 82 83 #define AUTOFS_FATAL(X, ...) \ 84 kprintf("FATAL: %s: " X "\n", __func__, ## __VA_ARGS__) 85 86 /* 87 * APRINTF is only for debugging. 88 */ 89 #define APRINTF(X, ...) \ 90 kprintf("### %s(%s): " X, \ 91 __func__, curproc->p_comm, ## __VA_ARGS__) 92 93 #define AUTOFS_LOCK_STATUS(lock) (lockstatus((lock), curthread)) 94 #define AUTOFS_ASSERT_LOCKED(X) \ 95 KKASSERT(AUTOFS_LOCK_STATUS(&(X)->am_lock) & (LK_EXCLUSIVE | LK_SHARED)) 96 #define AUTOFS_ASSERT_XLOCKED(X) \ 97 KKASSERT(AUTOFS_LOCK_STATUS(&(X)->am_lock) == LK_EXCLUSIVE) 98 #define AUTOFS_ASSERT_UNLOCKED(X) \ 99 KKASSERT(AUTOFS_LOCK_STATUS(&(X)->am_lock) == 0) 100 101 struct autofs_node { 102 RB_ENTRY(autofs_node) an_link; 103 char *an_name; 104 ino_t an_ino; 105 struct autofs_node *an_parent; 106 RB_HEAD(autofs_node_tree, 107 autofs_node) an_children; 108 struct autofs_mount *an_mount; 109 struct vnode *an_vnode; 110 mtx_t an_vnode_lock; 111 bool an_cached; 112 bool an_wildcards; 113 struct callout an_callout; 114 int an_retries; 115 struct timespec an_ctime; 116 }; 117 118 struct autofs_mount { 119 TAILQ_ENTRY(autofs_mount) am_next; 120 struct autofs_node *am_root; 121 struct mount *am_mp; 122 struct lock am_lock; 123 char am_from[MAXPATHLEN]; 124 char am_on[MAXPATHLEN]; 125 char am_options[MAXPATHLEN]; 126 char am_prefix[MAXPATHLEN]; 127 ino_t am_last_ino; 128 }; 129 130 struct autofs_request { 131 TAILQ_ENTRY(autofs_request) ar_next; 132 struct autofs_mount *ar_mount; 133 int ar_id; 134 bool ar_done; 135 int ar_error; 136 bool ar_wildcards; 137 bool ar_in_progress; 138 char ar_from[MAXPATHLEN]; 139 char ar_path[MAXPATHLEN]; 140 char ar_prefix[MAXPATHLEN]; 141 char ar_key[MAXPATHLEN]; 142 char ar_options[MAXPATHLEN]; 143 struct timeout_task ar_task; 144 volatile u_int ar_refcount; 145 }; 146 147 struct autofs_softc { 148 device_t sc_dev; 149 struct cdev *sc_cdev; 150 struct cv sc_cv; 151 struct lock sc_lock; 152 TAILQ_HEAD(, autofs_request) sc_requests; 153 bool sc_dev_opened; 154 pid_t sc_dev_sid; 155 int sc_last_request_id; 156 }; 157 158 int autofs_init(struct vfsconf *vfsp); 159 int autofs_uninit(struct vfsconf *vfsp); 160 int autofs_trigger(struct autofs_node *anp, const char *component, 161 int componentlen); 162 bool autofs_cached(struct autofs_node *anp, const char *component, 163 int componentlen); 164 char* autofs_path(struct autofs_node *anp); 165 void autofs_flush(struct autofs_mount *amp); 166 bool autofs_ignore_thread(void); 167 int autofs_node_new(struct autofs_node *parent, struct autofs_mount *amp, 168 const char *name, int namelen, struct autofs_node **anpp); 169 int autofs_node_find(struct autofs_node *parent, 170 const char *name, int namelen, struct autofs_node **anpp); 171 void autofs_node_delete(struct autofs_node *anp); 172 int autofs_node_vn(struct autofs_node *anp, struct mount *mp, 173 int flags, struct vnode **vpp); 174 175 static __inline void 176 autofs_node_cache(struct autofs_node *anp) 177 { 178 anp->an_cached = true; 179 } 180 181 static __inline void 182 autofs_node_uncache(struct autofs_node *anp) 183 { 184 anp->an_cached = false; 185 } 186 187 RB_PROTOTYPE(autofs_node_tree, autofs_node, an_link, autofs_node_cmp); 188 189 #endif /* !AUTOFS_H */ 190