1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2014 The FreeBSD Foundation 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 31 #ifndef AUTOFS_H 32 #define AUTOFS_H 33 34 #define VFSTOAUTOFS(mp) ((struct autofs_mount *)((mp)->mnt_data)) 35 36 MALLOC_DECLARE(M_AUTOFS); 37 38 extern uma_zone_t autofs_request_zone; 39 extern uma_zone_t autofs_node_zone; 40 41 extern int autofs_debug; 42 extern int autofs_mount_on_stat; 43 44 #define AUTOFS_DEBUG(X, ...) \ 45 do { \ 46 if (autofs_debug > 1) \ 47 printf("%s: " X "\n", __func__, ## __VA_ARGS__);\ 48 } while (0) 49 50 #define AUTOFS_WARN(X, ...) \ 51 do { \ 52 if (autofs_debug > 0) { \ 53 printf("WARNING: %s: " X "\n", \ 54 __func__, ## __VA_ARGS__); \ 55 } \ 56 } while (0) 57 58 #define AUTOFS_SLOCK(X) sx_slock(&X->am_lock) 59 #define AUTOFS_XLOCK(X) sx_xlock(&X->am_lock) 60 #define AUTOFS_SUNLOCK(X) sx_sunlock(&X->am_lock) 61 #define AUTOFS_XUNLOCK(X) sx_xunlock(&X->am_lock) 62 #define AUTOFS_ASSERT_LOCKED(X) sx_assert(&X->am_lock, SA_LOCKED) 63 #define AUTOFS_ASSERT_XLOCKED(X) sx_assert(&X->am_lock, SA_XLOCKED) 64 #define AUTOFS_ASSERT_UNLOCKED(X) sx_assert(&X->am_lock, SA_UNLOCKED) 65 66 struct autofs_node { 67 RB_ENTRY(autofs_node) an_link; 68 char *an_name; 69 int an_fileno; 70 struct autofs_node *an_parent; 71 RB_HEAD(autofs_node_tree, 72 autofs_node) an_children; 73 struct autofs_mount *an_mount; 74 struct vnode *an_vnode; 75 struct sx an_vnode_lock; 76 bool an_cached; 77 bool an_wildcards; 78 struct callout an_callout; 79 int an_retries; 80 struct timespec an_ctime; 81 }; 82 83 struct autofs_mount { 84 TAILQ_ENTRY(autofs_mount) am_next; 85 struct autofs_node *am_root; 86 struct mount *am_mp; 87 struct sx am_lock; 88 char am_from[MAXPATHLEN]; 89 char am_mountpoint[MAXPATHLEN]; 90 char am_options[MAXPATHLEN]; 91 char am_prefix[MAXPATHLEN]; 92 int am_last_fileno; 93 }; 94 95 struct autofs_request { 96 TAILQ_ENTRY(autofs_request) ar_next; 97 struct autofs_mount *ar_mount; 98 int ar_id; 99 bool ar_done; 100 int ar_error; 101 bool ar_wildcards; 102 bool ar_in_progress; 103 char ar_from[MAXPATHLEN]; 104 char ar_path[MAXPATHLEN]; 105 char ar_prefix[MAXPATHLEN]; 106 char ar_key[MAXPATHLEN]; 107 char ar_options[MAXPATHLEN]; 108 struct timeout_task ar_task; 109 volatile u_int ar_refcount; 110 }; 111 112 struct autofs_softc { 113 device_t sc_dev; 114 struct cdev *sc_cdev; 115 struct cv sc_cv; 116 struct sx sc_lock; 117 TAILQ_HEAD(, autofs_request) sc_requests; 118 bool sc_dev_opened; 119 pid_t sc_dev_sid; 120 int sc_last_request_id; 121 }; 122 123 int autofs_init(struct vfsconf *vfsp); 124 int autofs_uninit(struct vfsconf *vfsp); 125 int autofs_trigger(struct autofs_node *anp, const char *component, 126 int componentlen); 127 bool autofs_cached(struct autofs_node *anp, const char *component, 128 int componentlen); 129 void autofs_flush(struct autofs_mount *amp); 130 bool autofs_ignore_thread(const struct thread *td); 131 int autofs_node_new(struct autofs_node *parent, struct autofs_mount *amp, 132 const char *name, int namelen, struct autofs_node **anpp); 133 int autofs_node_find(struct autofs_node *parent, 134 const char *name, int namelen, struct autofs_node **anpp); 135 void autofs_node_delete(struct autofs_node *anp); 136 int autofs_node_vn(struct autofs_node *anp, struct mount *mp, 137 int flags, struct vnode **vpp); 138 139 RB_PROTOTYPE(autofs_node_tree, autofs_node, an_link, autofs_node_cmp); 140 141 #endif /* !AUTOFS_H */ 142