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 extern struct autofs_softc *autofs_softc; 63 extern struct dev_ops autofs_ops; 64 65 extern struct vop_ops autofs_vnode_vops; 66 67 extern int autofs_debug; 68 extern int autofs_mount_on_stat; 69 70 #define AUTOFS_DEBUG(X, ...) \ 71 do { \ 72 if (autofs_debug > 1) \ 73 kprintf("%s: " X "\n", \ 74 __func__, ## __VA_ARGS__); \ 75 } while (0) 76 77 #define AUTOFS_WARN(X, ...) \ 78 do { \ 79 if (autofs_debug > 0) { \ 80 kprintf("WARNING: %s: " X "\n", \ 81 __func__, ## __VA_ARGS__); \ 82 } \ 83 } while (0) 84 85 #define AUTOFS_FATAL(X, ...) \ 86 kprintf("FATAL: %s: " X "\n", __func__, ## __VA_ARGS__) 87 88 /* 89 * APRINTF is only for debugging. 90 */ 91 #define APRINTF(X, ...) \ 92 kprintf("### %s(%s): " X, \ 93 __func__, curproc->p_comm, ## __VA_ARGS__) 94 95 struct autofs_node { 96 RB_ENTRY(autofs_node) an_link; 97 char *an_name; 98 ino_t an_ino; 99 struct autofs_node *an_parent; 100 RB_HEAD(autofs_node_tree, 101 autofs_node) an_children; 102 struct autofs_mount *an_mount; 103 struct vnode *an_vnode; 104 mtx_t an_vnode_lock; 105 bool an_cached; 106 bool an_wildcards; 107 struct callout an_callout; 108 int an_retries; 109 struct timespec an_ctime; 110 }; 111 112 struct autofs_mount { 113 TAILQ_ENTRY(autofs_mount) am_next; 114 struct autofs_node *am_root; 115 struct mount *am_mp; 116 mtx_t am_lock; 117 char am_from[MAXPATHLEN]; 118 char am_on[MAXPATHLEN]; 119 char am_options[MAXPATHLEN]; 120 char am_prefix[MAXPATHLEN]; 121 ino_t am_last_ino; 122 }; 123 124 struct autofs_request { 125 TAILQ_ENTRY(autofs_request) ar_next; 126 struct autofs_mount *ar_mount; 127 int ar_id; 128 bool ar_done; 129 int ar_error; 130 bool ar_wildcards; 131 bool ar_in_progress; 132 char ar_from[MAXPATHLEN]; 133 char ar_path[MAXPATHLEN]; 134 char ar_prefix[MAXPATHLEN]; 135 char ar_key[MAXPATHLEN]; 136 char ar_options[MAXPATHLEN]; 137 struct timeout_task ar_task; 138 volatile u_int ar_refcount; 139 }; 140 141 struct autofs_softc { 142 device_t sc_dev; 143 struct cdev *sc_cdev; 144 struct cv sc_cv; 145 struct lock sc_lock; 146 TAILQ_HEAD(, autofs_request) sc_requests; 147 bool sc_dev_opened; 148 pid_t sc_dev_sid; 149 int sc_last_request_id; 150 }; 151 152 int autofs_trigger(struct autofs_node *anp, const char *component, 153 int componentlen); 154 bool autofs_cached(struct autofs_node *anp, const char *component, 155 int componentlen); 156 char* autofs_path(struct autofs_node *anp); 157 void autofs_flush(struct autofs_mount *amp); 158 bool autofs_ignore_thread(void); 159 int autofs_node_new(struct autofs_node *parent, struct autofs_mount *amp, 160 const char *name, int namelen, struct autofs_node **anpp); 161 int autofs_node_find(struct autofs_node *parent, 162 const char *name, int namelen, struct autofs_node **anpp); 163 void autofs_node_delete(struct autofs_node *anp); 164 int autofs_node_vn(struct autofs_node *anp, struct mount *mp, 165 int flags, struct vnode **vpp); 166 167 static __inline void 168 autofs_node_cache(struct autofs_node *anp) 169 { 170 anp->an_cached = true; 171 } 172 173 static __inline void 174 autofs_node_uncache(struct autofs_node *anp) 175 { 176 anp->an_cached = false; 177 } 178 179 RB_PROTOTYPE(autofs_node_tree, autofs_node, an_link, autofs_node_cmp); 180 181 #endif /* !AUTOFS_H */ 182