1 /*- 2 * Copyright (c) 2016 Tomohiro Kusumi <kusumi.tomohiro@gmail.com> 3 * Copyright (c) 2016 The DragonFly Project 4 * Copyright (c) 2014 The FreeBSD Foundation 5 * All rights reserved. 6 * 7 * This software was developed by Edward Tomasz Napierala under sponsorship 8 * from the FreeBSD Foundation. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * $FreeBSD$ 32 */ 33 34 #ifndef AUTOFS_H 35 #define AUTOFS_H 36 37 #include <sys/kernel.h> 38 #include <sys/module.h> 39 #include <sys/types.h> 40 #include <sys/systm.h> 41 #include <sys/malloc.h> 42 #include <sys/objcache.h> 43 #include <sys/tree.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 /* 86 * APRINTF is only for debugging. 87 */ 88 #define APRINTF(X, ...) \ 89 kprintf("### %s(%s): " X, \ 90 __func__, curproc->p_comm, ## __VA_ARGS__) 91 92 struct autofs_node { 93 RB_ENTRY(autofs_node) an_link; 94 char *an_name; 95 ino_t an_ino; 96 struct autofs_node *an_parent; 97 RB_HEAD(autofs_node_tree, 98 autofs_node) an_children; 99 struct autofs_mount *an_mount; 100 struct vnode *an_vnode; 101 mtx_t an_vnode_lock; 102 bool an_cached; 103 bool an_wildcards; 104 struct callout an_callout; 105 int an_retries; 106 struct timespec an_ctime; 107 }; 108 109 struct autofs_mount { 110 TAILQ_ENTRY(autofs_mount) am_next; 111 struct autofs_node *am_root; 112 struct mount *am_mp; 113 mtx_t am_lock; 114 char am_from[MAXPATHLEN]; 115 char am_on[MAXPATHLEN]; 116 char am_options[MAXPATHLEN]; 117 char am_prefix[MAXPATHLEN]; 118 ino_t am_last_ino; 119 }; 120 121 struct autofs_request { 122 TAILQ_ENTRY(autofs_request) ar_next; 123 struct autofs_mount *ar_mount; 124 int ar_id; 125 bool ar_done; 126 int ar_error; 127 bool ar_wildcards; 128 bool ar_in_progress; 129 char ar_from[MAXPATHLEN]; 130 char ar_path[MAXPATHLEN]; 131 char ar_prefix[MAXPATHLEN]; 132 char ar_key[MAXPATHLEN]; 133 char ar_options[MAXPATHLEN]; 134 struct timeout_task ar_task; 135 volatile unsigned int ar_refcount; 136 }; 137 138 struct autofs_softc { 139 device_t sc_dev; 140 struct cdev *sc_cdev; 141 struct cv sc_cv; 142 struct mtx sc_lock; 143 TAILQ_HEAD(, autofs_request) sc_requests; 144 bool sc_dev_opened; 145 pid_t sc_dev_sid; 146 int sc_last_request_id; 147 }; 148 149 int autofs_trigger(struct autofs_node *anp, const char *component, 150 int componentlen); 151 bool autofs_cached(struct autofs_node *anp, const char *component, 152 int componentlen); 153 char* autofs_path(struct autofs_node *anp); 154 void autofs_flush(struct autofs_mount *amp); 155 bool autofs_ignore_thread(void); 156 int autofs_node_new(struct autofs_node *parent, struct autofs_mount *amp, 157 const char *name, int namelen, struct autofs_node **anpp); 158 int autofs_node_find(struct autofs_node *parent, 159 const char *name, int namelen, struct autofs_node **anpp); 160 void autofs_node_delete(struct autofs_node *anp); 161 int autofs_node_vn(struct autofs_node *anp, struct mount *mp, 162 int flags, struct vnode **vpp); 163 164 static __inline void 165 autofs_node_cache(struct autofs_node *anp) 166 { 167 anp->an_cached = true; 168 } 169 170 static __inline void 171 autofs_node_uncache(struct autofs_node *anp) 172 { 173 anp->an_cached = false; 174 } 175 176 RB_PROTOTYPE(autofs_node_tree, autofs_node, an_link, autofs_node_cmp); 177 178 #endif /* !AUTOFS_H */ 179