vfs_trans.c revision 1.49 1 1.49 manu /* $NetBSD: vfs_trans.c,v 1.49 2018/09/27 01:03:40 manu Exp $ */
2 1.1 hannken
3 1.1 hannken /*-
4 1.1 hannken * Copyright (c) 2007 The NetBSD Foundation, Inc.
5 1.1 hannken * All rights reserved.
6 1.1 hannken *
7 1.1 hannken * This code is derived from software contributed to The NetBSD Foundation
8 1.1 hannken * by Juergen Hannken-Illjes.
9 1.1 hannken *
10 1.1 hannken * Redistribution and use in source and binary forms, with or without
11 1.1 hannken * modification, are permitted provided that the following conditions
12 1.1 hannken * are met:
13 1.1 hannken * 1. Redistributions of source code must retain the above copyright
14 1.1 hannken * notice, this list of conditions and the following disclaimer.
15 1.1 hannken * 2. Redistributions in binary form must reproduce the above copyright
16 1.1 hannken * notice, this list of conditions and the following disclaimer in the
17 1.1 hannken * documentation and/or other materials provided with the distribution.
18 1.1 hannken *
19 1.1 hannken * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.1 hannken * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.1 hannken * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.1 hannken * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.1 hannken * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.1 hannken * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.1 hannken * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.1 hannken * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.1 hannken * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.1 hannken * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.1 hannken * POSSIBILITY OF SUCH DAMAGE.
30 1.1 hannken */
31 1.1 hannken
32 1.1 hannken #include <sys/cdefs.h>
33 1.49 manu __KERNEL_RCSID(0, "$NetBSD: vfs_trans.c,v 1.49 2018/09/27 01:03:40 manu Exp $");
34 1.1 hannken
35 1.1 hannken /*
36 1.1 hannken * File system transaction operations.
37 1.1 hannken */
38 1.1 hannken
39 1.34 pooka #ifdef _KERNEL_OPT
40 1.1 hannken #include "opt_ddb.h"
41 1.34 pooka #endif
42 1.1 hannken
43 1.1 hannken #include <sys/param.h>
44 1.1 hannken #include <sys/systm.h>
45 1.49 manu #include <sys/kernel.h>
46 1.26 hannken #include <sys/atomic.h>
47 1.24 pooka #include <sys/buf.h>
48 1.12 hannken #include <sys/kmem.h>
49 1.1 hannken #include <sys/mount.h>
50 1.26 hannken #include <sys/pserialize.h>
51 1.1 hannken #include <sys/vnode.h>
52 1.1 hannken #include <sys/fstrans.h>
53 1.10 ad #include <sys/proc.h>
54 1.1 hannken
55 1.12 hannken #include <miscfs/specfs/specdev.h>
56 1.1 hannken
57 1.46 hannken enum fstrans_lock_type {
58 1.46 hannken FSTRANS_SHARED, /* Granted while not suspending */
59 1.46 hannken FSTRANS_EXCL /* Internal: exclusive lock */
60 1.46 hannken };
61 1.46 hannken
62 1.16 ad struct fscow_handler {
63 1.26 hannken LIST_ENTRY(fscow_handler) ch_list;
64 1.16 ad int (*ch_func)(void *, struct buf *, bool);
65 1.16 ad void *ch_arg;
66 1.16 ad };
67 1.1 hannken struct fstrans_lwp_info {
68 1.1 hannken struct fstrans_lwp_info *fli_succ;
69 1.26 hannken struct lwp *fli_self;
70 1.1 hannken struct mount *fli_mount;
71 1.20 hannken int fli_trans_cnt;
72 1.20 hannken int fli_cow_cnt;
73 1.1 hannken enum fstrans_lock_type fli_lock_type;
74 1.26 hannken LIST_ENTRY(fstrans_lwp_info) fli_list;
75 1.1 hannken };
76 1.1 hannken struct fstrans_mount_info {
77 1.1 hannken enum fstrans_state fmi_state;
78 1.26 hannken unsigned int fmi_ref_cnt;
79 1.26 hannken bool fmi_cow_change;
80 1.26 hannken LIST_HEAD(, fscow_handler) fmi_cow_handler;
81 1.1 hannken };
82 1.1 hannken
83 1.26 hannken static specificdata_key_t lwp_data_key; /* Our specific data key. */
84 1.4 ad static kmutex_t vfs_suspend_lock; /* Serialize suspensions. */
85 1.26 hannken static kmutex_t fstrans_lock; /* Fstrans big lock. */
86 1.35 hannken static kmutex_t fstrans_mount_lock; /* Fstrans mount big lock. */
87 1.26 hannken static kcondvar_t fstrans_state_cv; /* Fstrans or cow state changed. */
88 1.26 hannken static kcondvar_t fstrans_count_cv; /* Fstrans or cow count changed. */
89 1.26 hannken static pserialize_t fstrans_psz; /* Pserialize state. */
90 1.26 hannken static LIST_HEAD(fstrans_lwp_head, fstrans_lwp_info) fstrans_fli_head;
91 1.26 hannken /* List of all fstrans_lwp_info. */
92 1.1 hannken
93 1.38 hannken static inline struct mount *fstrans_normalize_mount(struct mount *);
94 1.1 hannken static void fstrans_lwp_dtor(void *);
95 1.26 hannken static void fstrans_mount_dtor(struct mount *);
96 1.47 hannken static void fstrans_clear_lwp_info(void);
97 1.48 hannken static inline struct fstrans_lwp_info *
98 1.48 hannken fstrans_get_lwp_info(struct mount *, bool);
99 1.48 hannken static struct fstrans_lwp_info *fstrans_alloc_lwp_info(struct mount *);
100 1.46 hannken static inline int _fstrans_start(struct mount *, enum fstrans_lock_type, int);
101 1.26 hannken static bool grant_lock(const enum fstrans_state, const enum fstrans_lock_type);
102 1.26 hannken static bool state_change_done(const struct mount *);
103 1.26 hannken static bool cow_state_change_done(const struct mount *);
104 1.26 hannken static void cow_change_enter(const struct mount *);
105 1.26 hannken static void cow_change_done(const struct mount *);
106 1.1 hannken
107 1.1 hannken /*
108 1.26 hannken * Initialize.
109 1.1 hannken */
110 1.1 hannken void
111 1.1 hannken fstrans_init(void)
112 1.1 hannken {
113 1.28 martin int error __diagused;
114 1.1 hannken
115 1.1 hannken error = lwp_specific_key_create(&lwp_data_key, fstrans_lwp_dtor);
116 1.1 hannken KASSERT(error == 0);
117 1.7 ad
118 1.4 ad mutex_init(&vfs_suspend_lock, MUTEX_DEFAULT, IPL_NONE);
119 1.26 hannken mutex_init(&fstrans_lock, MUTEX_DEFAULT, IPL_NONE);
120 1.35 hannken mutex_init(&fstrans_mount_lock, MUTEX_DEFAULT, IPL_NONE);
121 1.26 hannken cv_init(&fstrans_state_cv, "fstchg");
122 1.26 hannken cv_init(&fstrans_count_cv, "fstcnt");
123 1.26 hannken fstrans_psz = pserialize_create();
124 1.26 hannken LIST_INIT(&fstrans_fli_head);
125 1.1 hannken }
126 1.1 hannken
127 1.1 hannken /*
128 1.38 hannken * Normalize mount.
129 1.38 hannken * Return mount if file system supports fstrans, NULL otherwise.
130 1.38 hannken */
131 1.38 hannken static inline struct mount *
132 1.38 hannken fstrans_normalize_mount(struct mount *mp)
133 1.38 hannken {
134 1.38 hannken
135 1.39 hannken while (mp && mp->mnt_lower)
136 1.39 hannken mp = mp->mnt_lower;
137 1.38 hannken if (mp == NULL)
138 1.38 hannken return NULL;
139 1.38 hannken if ((mp->mnt_iflag & IMNT_HAS_TRANS) == 0)
140 1.38 hannken return NULL;
141 1.38 hannken return mp;
142 1.38 hannken }
143 1.38 hannken
144 1.38 hannken /*
145 1.26 hannken * Deallocate lwp state.
146 1.1 hannken */
147 1.1 hannken static void
148 1.1 hannken fstrans_lwp_dtor(void *arg)
149 1.1 hannken {
150 1.1 hannken struct fstrans_lwp_info *fli, *fli_next;
151 1.1 hannken
152 1.1 hannken for (fli = arg; fli; fli = fli_next) {
153 1.20 hannken KASSERT(fli->fli_trans_cnt == 0);
154 1.20 hannken KASSERT(fli->fli_cow_cnt == 0);
155 1.26 hannken if (fli->fli_mount != NULL)
156 1.26 hannken fstrans_mount_dtor(fli->fli_mount);
157 1.1 hannken fli_next = fli->fli_succ;
158 1.30 hannken fli->fli_mount = NULL;
159 1.30 hannken membar_sync();
160 1.30 hannken fli->fli_self = NULL;
161 1.1 hannken }
162 1.26 hannken }
163 1.26 hannken
164 1.26 hannken /*
165 1.26 hannken * Dereference mount state.
166 1.26 hannken */
167 1.26 hannken static void
168 1.26 hannken fstrans_mount_dtor(struct mount *mp)
169 1.26 hannken {
170 1.26 hannken struct fstrans_mount_info *fmi;
171 1.26 hannken
172 1.35 hannken mutex_enter(&fstrans_mount_lock);
173 1.35 hannken
174 1.26 hannken fmi = mp->mnt_transinfo;
175 1.35 hannken KASSERT(fmi != NULL);
176 1.35 hannken fmi->fmi_ref_cnt -= 1;
177 1.35 hannken if (fmi->fmi_ref_cnt > 0) {
178 1.35 hannken mutex_exit(&fstrans_mount_lock);
179 1.26 hannken return;
180 1.35 hannken }
181 1.26 hannken
182 1.26 hannken KASSERT(fmi->fmi_state == FSTRANS_NORMAL);
183 1.26 hannken KASSERT(LIST_FIRST(&fmi->fmi_cow_handler) == NULL);
184 1.26 hannken
185 1.26 hannken mp->mnt_iflag &= ~IMNT_HAS_TRANS;
186 1.26 hannken mp->mnt_transinfo = NULL;
187 1.26 hannken
188 1.35 hannken mutex_exit(&fstrans_mount_lock);
189 1.35 hannken
190 1.35 hannken kmem_free(fmi, sizeof(*fmi));
191 1.42 hannken vfs_rele(mp);
192 1.1 hannken }
193 1.1 hannken
194 1.1 hannken /*
195 1.26 hannken * Allocate mount state.
196 1.1 hannken */
197 1.16 ad int
198 1.16 ad fstrans_mount(struct mount *mp)
199 1.1 hannken {
200 1.31 matt struct fstrans_mount_info *newfmi;
201 1.16 ad
202 1.32 pooka newfmi = kmem_alloc(sizeof(*newfmi), KM_SLEEP);
203 1.31 matt newfmi->fmi_state = FSTRANS_NORMAL;
204 1.31 matt newfmi->fmi_ref_cnt = 1;
205 1.31 matt LIST_INIT(&newfmi->fmi_cow_handler);
206 1.31 matt newfmi->fmi_cow_change = false;
207 1.16 ad
208 1.35 hannken mutex_enter(&fstrans_mount_lock);
209 1.31 matt mp->mnt_transinfo = newfmi;
210 1.16 ad mp->mnt_iflag |= IMNT_HAS_TRANS;
211 1.35 hannken mutex_exit(&fstrans_mount_lock);
212 1.1 hannken
213 1.43 hannken vfs_ref(mp);
214 1.26 hannken
215 1.16 ad return 0;
216 1.1 hannken }
217 1.1 hannken
218 1.1 hannken /*
219 1.26 hannken * Deallocate mount state.
220 1.1 hannken */
221 1.16 ad void
222 1.16 ad fstrans_unmount(struct mount *mp)
223 1.1 hannken {
224 1.1 hannken
225 1.38 hannken if ((mp->mnt_iflag & IMNT_HAS_TRANS) == 0)
226 1.38 hannken return;
227 1.38 hannken
228 1.26 hannken KASSERT(mp->mnt_transinfo != NULL);
229 1.1 hannken
230 1.26 hannken fstrans_mount_dtor(mp);
231 1.1 hannken }
232 1.1 hannken
233 1.1 hannken /*
234 1.47 hannken * Clear mount entries whose mount is gone.
235 1.20 hannken */
236 1.47 hannken static void
237 1.47 hannken fstrans_clear_lwp_info(void)
238 1.20 hannken {
239 1.47 hannken struct fstrans_lwp_info *fli;
240 1.20 hannken
241 1.26 hannken /*
242 1.47 hannken * Scan our list clearing entries whose mount is gone.
243 1.26 hannken */
244 1.20 hannken for (fli = lwp_getspecific(lwp_data_key); fli; fli = fli->fli_succ) {
245 1.47 hannken if (fli->fli_mount != NULL &&
246 1.26 hannken (fli->fli_mount->mnt_iflag & IMNT_GONE) != 0 &&
247 1.26 hannken fli->fli_trans_cnt == 0 && fli->fli_cow_cnt == 0) {
248 1.26 hannken fstrans_mount_dtor(fli->fli_mount);
249 1.26 hannken fli->fli_mount = NULL;
250 1.26 hannken }
251 1.20 hannken }
252 1.47 hannken }
253 1.47 hannken
254 1.47 hannken /*
255 1.48 hannken * Allocate and return per lwp info for this mount.
256 1.47 hannken */
257 1.47 hannken static struct fstrans_lwp_info *
258 1.48 hannken fstrans_alloc_lwp_info(struct mount *mp)
259 1.47 hannken {
260 1.47 hannken struct fstrans_lwp_info *fli;
261 1.47 hannken struct fstrans_mount_info *fmi;
262 1.47 hannken
263 1.47 hannken /*
264 1.26 hannken * Try to reuse a cleared entry or allocate a new one.
265 1.26 hannken */
266 1.26 hannken for (fli = lwp_getspecific(lwp_data_key); fli; fli = fli->fli_succ) {
267 1.48 hannken KASSERT(fli->fli_mount != mp);
268 1.26 hannken if (fli->fli_mount == NULL) {
269 1.26 hannken KASSERT(fli->fli_trans_cnt == 0);
270 1.26 hannken KASSERT(fli->fli_cow_cnt == 0);
271 1.26 hannken break;
272 1.26 hannken }
273 1.26 hannken }
274 1.26 hannken if (fli == NULL) {
275 1.30 hannken mutex_enter(&fstrans_lock);
276 1.30 hannken LIST_FOREACH(fli, &fstrans_fli_head, fli_list) {
277 1.30 hannken if (fli->fli_self == NULL) {
278 1.35 hannken KASSERT(fli->fli_mount == NULL);
279 1.30 hannken KASSERT(fli->fli_trans_cnt == 0);
280 1.30 hannken KASSERT(fli->fli_cow_cnt == 0);
281 1.30 hannken fli->fli_self = curlwp;
282 1.30 hannken fli->fli_succ = lwp_getspecific(lwp_data_key);
283 1.30 hannken lwp_setspecific(lwp_data_key, fli);
284 1.30 hannken break;
285 1.30 hannken }
286 1.30 hannken }
287 1.30 hannken mutex_exit(&fstrans_lock);
288 1.30 hannken }
289 1.30 hannken if (fli == NULL) {
290 1.30 hannken fli = kmem_alloc(sizeof(*fli), KM_SLEEP);
291 1.26 hannken mutex_enter(&fstrans_lock);
292 1.26 hannken memset(fli, 0, sizeof(*fli));
293 1.26 hannken fli->fli_self = curlwp;
294 1.26 hannken LIST_INSERT_HEAD(&fstrans_fli_head, fli, fli_list);
295 1.26 hannken mutex_exit(&fstrans_lock);
296 1.26 hannken fli->fli_succ = lwp_getspecific(lwp_data_key);
297 1.26 hannken lwp_setspecific(lwp_data_key, fli);
298 1.20 hannken }
299 1.20 hannken
300 1.26 hannken /*
301 1.44 hannken * Attach the entry to the mount if its mnt_transinfo is valid.
302 1.26 hannken */
303 1.35 hannken mutex_enter(&fstrans_mount_lock);
304 1.37 hannken fmi = mp->mnt_transinfo;
305 1.44 hannken if (__predict_true(fmi != NULL)) {
306 1.44 hannken fli->fli_mount = mp;
307 1.44 hannken fmi->fmi_ref_cnt += 1;
308 1.44 hannken } else {
309 1.44 hannken fli = NULL;
310 1.44 hannken }
311 1.35 hannken mutex_exit(&fstrans_mount_lock);
312 1.26 hannken
313 1.26 hannken return fli;
314 1.26 hannken }
315 1.26 hannken
316 1.26 hannken /*
317 1.48 hannken * Retrieve the per lwp info for this mount allocating if necessary.
318 1.48 hannken */
319 1.48 hannken static inline struct fstrans_lwp_info *
320 1.48 hannken fstrans_get_lwp_info(struct mount *mp, bool do_alloc)
321 1.48 hannken {
322 1.48 hannken struct fstrans_lwp_info *fli;
323 1.48 hannken
324 1.48 hannken /*
325 1.48 hannken * Scan our list for a match.
326 1.48 hannken */
327 1.48 hannken for (fli = lwp_getspecific(lwp_data_key); fli; fli = fli->fli_succ) {
328 1.48 hannken if (fli->fli_mount == mp)
329 1.48 hannken return fli;
330 1.48 hannken }
331 1.48 hannken
332 1.48 hannken return (do_alloc ? fstrans_alloc_lwp_info(mp) : NULL);
333 1.48 hannken }
334 1.48 hannken
335 1.48 hannken /*
336 1.26 hannken * Check if this lock type is granted at this state.
337 1.26 hannken */
338 1.26 hannken static bool
339 1.26 hannken grant_lock(const enum fstrans_state state, const enum fstrans_lock_type type)
340 1.26 hannken {
341 1.20 hannken
342 1.26 hannken if (__predict_true(state == FSTRANS_NORMAL))
343 1.26 hannken return true;
344 1.26 hannken if (type == FSTRANS_EXCL)
345 1.26 hannken return true;
346 1.20 hannken
347 1.26 hannken return false;
348 1.20 hannken }
349 1.20 hannken
350 1.20 hannken /*
351 1.1 hannken * Start a transaction. If this thread already has a transaction on this
352 1.1 hannken * file system increment the reference counter.
353 1.1 hannken */
354 1.46 hannken static inline int
355 1.1 hannken _fstrans_start(struct mount *mp, enum fstrans_lock_type lock_type, int wait)
356 1.1 hannken {
357 1.26 hannken int s;
358 1.40 hannken struct mount *lmp;
359 1.20 hannken struct fstrans_lwp_info *fli;
360 1.1 hannken struct fstrans_mount_info *fmi;
361 1.1 hannken
362 1.40 hannken if ((lmp = fstrans_normalize_mount(mp)) == NULL)
363 1.38 hannken return 0;
364 1.38 hannken
365 1.18 yamt ASSERT_SLEEPABLE();
366 1.1 hannken
367 1.40 hannken /*
368 1.40 hannken * Allocate per lwp info for layered file systems to
369 1.40 hannken * get a reference to the mount. No need to increment
370 1.40 hannken * the reference counter here.
371 1.40 hannken */
372 1.40 hannken for (lmp = mp; lmp->mnt_lower; lmp = lmp->mnt_lower) {
373 1.40 hannken fli = fstrans_get_lwp_info(lmp, true);
374 1.40 hannken }
375 1.40 hannken
376 1.40 hannken if ((fli = fstrans_get_lwp_info(lmp, true)) == NULL)
377 1.1 hannken return 0;
378 1.1 hannken
379 1.20 hannken if (fli->fli_trans_cnt > 0) {
380 1.26 hannken KASSERT(lock_type != FSTRANS_EXCL);
381 1.20 hannken fli->fli_trans_cnt += 1;
382 1.26 hannken
383 1.20 hannken return 0;
384 1.1 hannken }
385 1.1 hannken
386 1.26 hannken s = pserialize_read_enter();
387 1.40 hannken fmi = lmp->mnt_transinfo;
388 1.26 hannken if (__predict_true(grant_lock(fmi->fmi_state, lock_type))) {
389 1.26 hannken fli->fli_trans_cnt = 1;
390 1.26 hannken fli->fli_lock_type = lock_type;
391 1.26 hannken pserialize_read_exit(s);
392 1.1 hannken
393 1.26 hannken return 0;
394 1.26 hannken }
395 1.26 hannken pserialize_read_exit(s);
396 1.8 hannken
397 1.26 hannken if (! wait)
398 1.8 hannken return EBUSY;
399 1.1 hannken
400 1.26 hannken mutex_enter(&fstrans_lock);
401 1.26 hannken while (! grant_lock(fmi->fmi_state, lock_type))
402 1.26 hannken cv_wait(&fstrans_state_cv, &fstrans_lock);
403 1.20 hannken fli->fli_trans_cnt = 1;
404 1.20 hannken fli->fli_lock_type = lock_type;
405 1.26 hannken mutex_exit(&fstrans_lock);
406 1.1 hannken
407 1.1 hannken return 0;
408 1.1 hannken }
409 1.1 hannken
410 1.46 hannken void
411 1.46 hannken fstrans_start(struct mount *mp)
412 1.46 hannken {
413 1.46 hannken int error __diagused;
414 1.46 hannken
415 1.46 hannken error = _fstrans_start(mp, FSTRANS_SHARED, 1);
416 1.46 hannken KASSERT(error == 0);
417 1.46 hannken }
418 1.46 hannken
419 1.46 hannken int
420 1.46 hannken fstrans_start_nowait(struct mount *mp)
421 1.46 hannken {
422 1.46 hannken
423 1.46 hannken return _fstrans_start(mp, FSTRANS_SHARED, 0);
424 1.46 hannken }
425 1.46 hannken
426 1.1 hannken /*
427 1.1 hannken * Finish a transaction.
428 1.1 hannken */
429 1.1 hannken void
430 1.1 hannken fstrans_done(struct mount *mp)
431 1.1 hannken {
432 1.26 hannken int s;
433 1.1 hannken struct fstrans_lwp_info *fli;
434 1.1 hannken struct fstrans_mount_info *fmi;
435 1.1 hannken
436 1.38 hannken if ((mp = fstrans_normalize_mount(mp)) == NULL)
437 1.38 hannken return;
438 1.44 hannken if ((fli = fstrans_get_lwp_info(mp, false)) == NULL)
439 1.44 hannken return;
440 1.26 hannken KASSERT(fli->fli_trans_cnt > 0);
441 1.26 hannken
442 1.26 hannken if (fli->fli_trans_cnt > 1) {
443 1.26 hannken fli->fli_trans_cnt -= 1;
444 1.26 hannken
445 1.26 hannken return;
446 1.1 hannken }
447 1.1 hannken
448 1.47 hannken fstrans_clear_lwp_info();
449 1.47 hannken
450 1.26 hannken s = pserialize_read_enter();
451 1.26 hannken fmi = mp->mnt_transinfo;
452 1.26 hannken if (__predict_true(fmi->fmi_state == FSTRANS_NORMAL)) {
453 1.26 hannken fli->fli_trans_cnt = 0;
454 1.26 hannken pserialize_read_exit(s);
455 1.26 hannken
456 1.26 hannken return;
457 1.26 hannken }
458 1.26 hannken pserialize_read_exit(s);
459 1.20 hannken
460 1.26 hannken mutex_enter(&fstrans_lock);
461 1.26 hannken fli->fli_trans_cnt = 0;
462 1.26 hannken cv_signal(&fstrans_count_cv);
463 1.26 hannken mutex_exit(&fstrans_lock);
464 1.1 hannken }
465 1.1 hannken
466 1.1 hannken /*
467 1.1 hannken * Check if this thread has an exclusive lock.
468 1.1 hannken */
469 1.1 hannken int
470 1.1 hannken fstrans_is_owner(struct mount *mp)
471 1.1 hannken {
472 1.1 hannken struct fstrans_lwp_info *fli;
473 1.1 hannken
474 1.38 hannken if ((mp = fstrans_normalize_mount(mp)) == NULL)
475 1.38 hannken return 0;
476 1.38 hannken if ((fli = fstrans_get_lwp_info(mp, false)) == NULL)
477 1.1 hannken return 0;
478 1.1 hannken
479 1.35 hannken if (fli->fli_trans_cnt == 0)
480 1.1 hannken return 0;
481 1.1 hannken
482 1.1 hannken KASSERT(fli->fli_mount == mp);
483 1.20 hannken KASSERT(fli->fli_trans_cnt > 0);
484 1.26 hannken
485 1.2 hannken return (fli->fli_lock_type == FSTRANS_EXCL);
486 1.1 hannken }
487 1.1 hannken
488 1.1 hannken /*
489 1.26 hannken * True, if no thread is in a transaction not granted at the current state.
490 1.26 hannken */
491 1.26 hannken static bool
492 1.26 hannken state_change_done(const struct mount *mp)
493 1.26 hannken {
494 1.26 hannken struct fstrans_lwp_info *fli;
495 1.26 hannken struct fstrans_mount_info *fmi;
496 1.26 hannken
497 1.26 hannken KASSERT(mutex_owned(&fstrans_lock));
498 1.26 hannken
499 1.26 hannken fmi = mp->mnt_transinfo;
500 1.26 hannken LIST_FOREACH(fli, &fstrans_fli_head, fli_list) {
501 1.26 hannken if (fli->fli_mount != mp)
502 1.26 hannken continue;
503 1.26 hannken if (fli->fli_trans_cnt == 0)
504 1.26 hannken continue;
505 1.26 hannken if (grant_lock(fmi->fmi_state, fli->fli_lock_type))
506 1.26 hannken continue;
507 1.26 hannken
508 1.26 hannken return false;
509 1.26 hannken }
510 1.26 hannken
511 1.26 hannken return true;
512 1.26 hannken }
513 1.26 hannken
514 1.26 hannken /*
515 1.1 hannken * Set new file system state.
516 1.1 hannken */
517 1.1 hannken int
518 1.1 hannken fstrans_setstate(struct mount *mp, enum fstrans_state new_state)
519 1.1 hannken {
520 1.26 hannken int error;
521 1.26 hannken enum fstrans_state old_state;
522 1.1 hannken struct fstrans_mount_info *fmi;
523 1.1 hannken
524 1.16 ad fmi = mp->mnt_transinfo;
525 1.26 hannken old_state = fmi->fmi_state;
526 1.26 hannken if (old_state == new_state)
527 1.26 hannken return 0;
528 1.1 hannken
529 1.26 hannken mutex_enter(&fstrans_lock);
530 1.26 hannken fmi->fmi_state = new_state;
531 1.26 hannken pserialize_perform(fstrans_psz);
532 1.26 hannken
533 1.26 hannken /*
534 1.26 hannken * All threads see the new state now.
535 1.26 hannken * Wait for transactions invalid at this state to leave.
536 1.49 manu * We cannot wait forever because many processes would
537 1.49 manu * get stuck waiting for fstcnt in fstrans_start(). This
538 1.49 manu * is acute when suspending the root filesystem.
539 1.26 hannken */
540 1.26 hannken error = 0;
541 1.26 hannken while (! state_change_done(mp)) {
542 1.49 manu error = cv_timedwait_sig(&fstrans_count_cv,
543 1.49 manu &fstrans_lock, hz / 4);
544 1.26 hannken if (error) {
545 1.26 hannken new_state = fmi->fmi_state = FSTRANS_NORMAL;
546 1.26 hannken break;
547 1.26 hannken }
548 1.26 hannken }
549 1.26 hannken cv_broadcast(&fstrans_state_cv);
550 1.26 hannken mutex_exit(&fstrans_lock);
551 1.1 hannken
552 1.26 hannken if (old_state != new_state) {
553 1.26 hannken if (old_state == FSTRANS_NORMAL)
554 1.46 hannken _fstrans_start(mp, FSTRANS_EXCL, 1);
555 1.26 hannken if (new_state == FSTRANS_NORMAL)
556 1.1 hannken fstrans_done(mp);
557 1.1 hannken }
558 1.1 hannken
559 1.26 hannken return error;
560 1.1 hannken }
561 1.1 hannken
562 1.1 hannken /*
563 1.26 hannken * Get current file system state.
564 1.1 hannken */
565 1.1 hannken enum fstrans_state
566 1.1 hannken fstrans_getstate(struct mount *mp)
567 1.1 hannken {
568 1.1 hannken struct fstrans_mount_info *fmi;
569 1.1 hannken
570 1.16 ad fmi = mp->mnt_transinfo;
571 1.26 hannken KASSERT(fmi != NULL);
572 1.1 hannken
573 1.1 hannken return fmi->fmi_state;
574 1.1 hannken }
575 1.1 hannken
576 1.1 hannken /*
577 1.1 hannken * Request a filesystem to suspend all operations.
578 1.1 hannken */
579 1.1 hannken int
580 1.1 hannken vfs_suspend(struct mount *mp, int nowait)
581 1.1 hannken {
582 1.4 ad int error;
583 1.1 hannken
584 1.38 hannken if ((mp = fstrans_normalize_mount(mp)) == NULL)
585 1.38 hannken return EOPNOTSUPP;
586 1.4 ad if (nowait) {
587 1.4 ad if (!mutex_tryenter(&vfs_suspend_lock))
588 1.4 ad return EWOULDBLOCK;
589 1.4 ad } else
590 1.4 ad mutex_enter(&vfs_suspend_lock);
591 1.1 hannken
592 1.36 hannken if ((error = VFS_SUSPENDCTL(mp, SUSPEND_SUSPEND)) != 0)
593 1.4 ad mutex_exit(&vfs_suspend_lock);
594 1.1 hannken
595 1.1 hannken return error;
596 1.1 hannken }
597 1.1 hannken
598 1.1 hannken /*
599 1.1 hannken * Request a filesystem to resume all operations.
600 1.1 hannken */
601 1.1 hannken void
602 1.1 hannken vfs_resume(struct mount *mp)
603 1.1 hannken {
604 1.1 hannken
605 1.38 hannken mp = fstrans_normalize_mount(mp);
606 1.38 hannken KASSERT(mp != NULL);
607 1.38 hannken
608 1.1 hannken VFS_SUSPENDCTL(mp, SUSPEND_RESUME);
609 1.4 ad mutex_exit(&vfs_suspend_lock);
610 1.1 hannken }
611 1.1 hannken
612 1.1 hannken
613 1.26 hannken /*
614 1.26 hannken * True, if no thread is running a cow handler.
615 1.26 hannken */
616 1.26 hannken static bool
617 1.26 hannken cow_state_change_done(const struct mount *mp)
618 1.1 hannken {
619 1.1 hannken struct fstrans_lwp_info *fli;
620 1.28 martin struct fstrans_mount_info *fmi __diagused;
621 1.26 hannken
622 1.26 hannken fmi = mp->mnt_transinfo;
623 1.1 hannken
624 1.26 hannken KASSERT(mutex_owned(&fstrans_lock));
625 1.26 hannken KASSERT(fmi->fmi_cow_change);
626 1.26 hannken
627 1.26 hannken LIST_FOREACH(fli, &fstrans_fli_head, fli_list) {
628 1.26 hannken if (fli->fli_mount != mp)
629 1.26 hannken continue;
630 1.26 hannken if (fli->fli_cow_cnt == 0)
631 1.1 hannken continue;
632 1.26 hannken
633 1.26 hannken return false;
634 1.1 hannken }
635 1.26 hannken
636 1.26 hannken return true;
637 1.1 hannken }
638 1.1 hannken
639 1.26 hannken /*
640 1.26 hannken * Prepare for changing this mounts cow list.
641 1.26 hannken * Returns with fstrans_lock locked.
642 1.26 hannken */
643 1.1 hannken static void
644 1.26 hannken cow_change_enter(const struct mount *mp)
645 1.1 hannken {
646 1.1 hannken struct fstrans_mount_info *fmi;
647 1.1 hannken
648 1.16 ad fmi = mp->mnt_transinfo;
649 1.1 hannken
650 1.26 hannken mutex_enter(&fstrans_lock);
651 1.26 hannken
652 1.26 hannken /*
653 1.26 hannken * Wait for other threads changing the list.
654 1.26 hannken */
655 1.26 hannken while (fmi->fmi_cow_change)
656 1.26 hannken cv_wait(&fstrans_state_cv, &fstrans_lock);
657 1.26 hannken
658 1.26 hannken /*
659 1.26 hannken * Wait until all threads are aware of a state change.
660 1.26 hannken */
661 1.26 hannken fmi->fmi_cow_change = true;
662 1.26 hannken pserialize_perform(fstrans_psz);
663 1.26 hannken
664 1.26 hannken while (! cow_state_change_done(mp))
665 1.26 hannken cv_wait(&fstrans_count_cv, &fstrans_lock);
666 1.1 hannken }
667 1.1 hannken
668 1.26 hannken /*
669 1.26 hannken * Done changing this mounts cow list.
670 1.26 hannken */
671 1.26 hannken static void
672 1.26 hannken cow_change_done(const struct mount *mp)
673 1.1 hannken {
674 1.26 hannken struct fstrans_mount_info *fmi;
675 1.26 hannken
676 1.26 hannken KASSERT(mutex_owned(&fstrans_lock));
677 1.26 hannken
678 1.26 hannken fmi = mp->mnt_transinfo;
679 1.26 hannken
680 1.26 hannken fmi->fmi_cow_change = false;
681 1.26 hannken pserialize_perform(fstrans_psz);
682 1.1 hannken
683 1.26 hannken cv_broadcast(&fstrans_state_cv);
684 1.1 hannken
685 1.26 hannken mutex_exit(&fstrans_lock);
686 1.1 hannken }
687 1.12 hannken
688 1.26 hannken /*
689 1.26 hannken * Add a handler to this mount.
690 1.26 hannken */
691 1.12 hannken int
692 1.15 hannken fscow_establish(struct mount *mp, int (*func)(void *, struct buf *, bool),
693 1.15 hannken void *arg)
694 1.12 hannken {
695 1.16 ad struct fstrans_mount_info *fmi;
696 1.31 matt struct fscow_handler *newch;
697 1.12 hannken
698 1.16 ad if ((mp->mnt_iflag & IMNT_HAS_TRANS) == 0)
699 1.16 ad return EINVAL;
700 1.16 ad
701 1.16 ad fmi = mp->mnt_transinfo;
702 1.26 hannken KASSERT(fmi != NULL);
703 1.12 hannken
704 1.32 pooka newch = kmem_alloc(sizeof(*newch), KM_SLEEP);
705 1.31 matt newch->ch_func = func;
706 1.31 matt newch->ch_arg = arg;
707 1.26 hannken
708 1.26 hannken cow_change_enter(mp);
709 1.31 matt LIST_INSERT_HEAD(&fmi->fmi_cow_handler, newch, ch_list);
710 1.26 hannken cow_change_done(mp);
711 1.12 hannken
712 1.12 hannken return 0;
713 1.12 hannken }
714 1.12 hannken
715 1.26 hannken /*
716 1.26 hannken * Remove a handler from this mount.
717 1.26 hannken */
718 1.12 hannken int
719 1.15 hannken fscow_disestablish(struct mount *mp, int (*func)(void *, struct buf *, bool),
720 1.12 hannken void *arg)
721 1.12 hannken {
722 1.16 ad struct fstrans_mount_info *fmi;
723 1.12 hannken struct fscow_handler *hp = NULL;
724 1.12 hannken
725 1.16 ad if ((mp->mnt_iflag & IMNT_HAS_TRANS) == 0)
726 1.12 hannken return EINVAL;
727 1.12 hannken
728 1.16 ad fmi = mp->mnt_transinfo;
729 1.26 hannken KASSERT(fmi != NULL);
730 1.16 ad
731 1.26 hannken cow_change_enter(mp);
732 1.26 hannken LIST_FOREACH(hp, &fmi->fmi_cow_handler, ch_list)
733 1.12 hannken if (hp->ch_func == func && hp->ch_arg == arg)
734 1.12 hannken break;
735 1.12 hannken if (hp != NULL) {
736 1.26 hannken LIST_REMOVE(hp, ch_list);
737 1.12 hannken kmem_free(hp, sizeof(*hp));
738 1.12 hannken }
739 1.26 hannken cow_change_done(mp);
740 1.12 hannken
741 1.12 hannken return hp ? 0 : EINVAL;
742 1.12 hannken }
743 1.12 hannken
744 1.26 hannken /*
745 1.26 hannken * Check for need to copy block that is about to be written.
746 1.26 hannken */
747 1.12 hannken int
748 1.15 hannken fscow_run(struct buf *bp, bool data_valid)
749 1.12 hannken {
750 1.26 hannken int error, s;
751 1.12 hannken struct mount *mp;
752 1.20 hannken struct fstrans_lwp_info *fli;
753 1.16 ad struct fstrans_mount_info *fmi;
754 1.12 hannken struct fscow_handler *hp;
755 1.12 hannken
756 1.26 hannken /*
757 1.26 hannken * First check if we need run the copy-on-write handler.
758 1.26 hannken */
759 1.17 hannken if ((bp->b_flags & B_COWDONE))
760 1.26 hannken return 0;
761 1.26 hannken if (bp->b_vp == NULL) {
762 1.26 hannken bp->b_flags |= B_COWDONE;
763 1.26 hannken return 0;
764 1.26 hannken }
765 1.12 hannken if (bp->b_vp->v_type == VBLK)
766 1.27 hannken mp = spec_node_getmountedfs(bp->b_vp);
767 1.12 hannken else
768 1.12 hannken mp = bp->b_vp->v_mount;
769 1.26 hannken if (mp == NULL || (mp->mnt_iflag & IMNT_HAS_TRANS) == 0) {
770 1.26 hannken bp->b_flags |= B_COWDONE;
771 1.26 hannken return 0;
772 1.26 hannken }
773 1.12 hannken
774 1.26 hannken fli = fstrans_get_lwp_info(mp, true);
775 1.16 ad fmi = mp->mnt_transinfo;
776 1.12 hannken
777 1.26 hannken /*
778 1.26 hannken * On non-recursed run check if other threads
779 1.26 hannken * want to change the list.
780 1.26 hannken */
781 1.26 hannken if (fli->fli_cow_cnt == 0) {
782 1.26 hannken s = pserialize_read_enter();
783 1.26 hannken if (__predict_false(fmi->fmi_cow_change)) {
784 1.26 hannken pserialize_read_exit(s);
785 1.26 hannken mutex_enter(&fstrans_lock);
786 1.26 hannken while (fmi->fmi_cow_change)
787 1.26 hannken cv_wait(&fstrans_state_cv, &fstrans_lock);
788 1.26 hannken fli->fli_cow_cnt = 1;
789 1.26 hannken mutex_exit(&fstrans_lock);
790 1.26 hannken } else {
791 1.26 hannken fli->fli_cow_cnt = 1;
792 1.26 hannken pserialize_read_exit(s);
793 1.26 hannken }
794 1.26 hannken } else
795 1.26 hannken fli->fli_cow_cnt += 1;
796 1.20 hannken
797 1.26 hannken /*
798 1.26 hannken * Run all copy-on-write handlers, stop on error.
799 1.26 hannken */
800 1.26 hannken error = 0;
801 1.26 hannken LIST_FOREACH(hp, &fmi->fmi_cow_handler, ch_list)
802 1.15 hannken if ((error = (*hp->ch_func)(hp->ch_arg, bp, data_valid)) != 0)
803 1.12 hannken break;
804 1.17 hannken if (error == 0)
805 1.17 hannken bp->b_flags |= B_COWDONE;
806 1.15 hannken
807 1.26 hannken /*
808 1.26 hannken * Check if other threads want to change the list.
809 1.26 hannken */
810 1.26 hannken if (fli->fli_cow_cnt > 1) {
811 1.26 hannken fli->fli_cow_cnt -= 1;
812 1.26 hannken } else {
813 1.26 hannken s = pserialize_read_enter();
814 1.26 hannken if (__predict_false(fmi->fmi_cow_change)) {
815 1.26 hannken pserialize_read_exit(s);
816 1.26 hannken mutex_enter(&fstrans_lock);
817 1.26 hannken fli->fli_cow_cnt = 0;
818 1.26 hannken cv_signal(&fstrans_count_cv);
819 1.26 hannken mutex_exit(&fstrans_lock);
820 1.26 hannken } else {
821 1.26 hannken fli->fli_cow_cnt = 0;
822 1.26 hannken pserialize_read_exit(s);
823 1.26 hannken }
824 1.26 hannken }
825 1.26 hannken
826 1.12 hannken return error;
827 1.12 hannken }
828 1.26 hannken
829 1.26 hannken #if defined(DDB)
830 1.26 hannken void fstrans_dump(int);
831 1.26 hannken
832 1.26 hannken static void
833 1.26 hannken fstrans_print_lwp(struct proc *p, struct lwp *l, int verbose)
834 1.26 hannken {
835 1.26 hannken char prefix[9];
836 1.26 hannken struct fstrans_lwp_info *fli;
837 1.26 hannken
838 1.26 hannken snprintf(prefix, sizeof(prefix), "%d.%d", p->p_pid, l->l_lid);
839 1.26 hannken LIST_FOREACH(fli, &fstrans_fli_head, fli_list) {
840 1.26 hannken if (fli->fli_self != l)
841 1.26 hannken continue;
842 1.26 hannken if (fli->fli_trans_cnt == 0 && fli->fli_cow_cnt == 0) {
843 1.26 hannken if (! verbose)
844 1.26 hannken continue;
845 1.26 hannken }
846 1.26 hannken printf("%-8s", prefix);
847 1.26 hannken if (verbose)
848 1.26 hannken printf(" @%p", fli);
849 1.26 hannken if (fli->fli_mount != NULL)
850 1.26 hannken printf(" (%s)", fli->fli_mount->mnt_stat.f_mntonname);
851 1.26 hannken else
852 1.26 hannken printf(" NULL");
853 1.26 hannken if (fli->fli_trans_cnt == 0) {
854 1.26 hannken printf(" -");
855 1.26 hannken } else {
856 1.26 hannken switch (fli->fli_lock_type) {
857 1.26 hannken case FSTRANS_SHARED:
858 1.26 hannken printf(" shared");
859 1.26 hannken break;
860 1.26 hannken case FSTRANS_EXCL:
861 1.26 hannken printf(" excl");
862 1.26 hannken break;
863 1.26 hannken default:
864 1.26 hannken printf(" %#x", fli->fli_lock_type);
865 1.26 hannken break;
866 1.26 hannken }
867 1.26 hannken }
868 1.26 hannken printf(" %d cow %d\n", fli->fli_trans_cnt, fli->fli_cow_cnt);
869 1.26 hannken prefix[0] = '\0';
870 1.26 hannken }
871 1.26 hannken }
872 1.26 hannken
873 1.26 hannken static void
874 1.26 hannken fstrans_print_mount(struct mount *mp, int verbose)
875 1.26 hannken {
876 1.26 hannken struct fstrans_mount_info *fmi;
877 1.26 hannken
878 1.26 hannken fmi = mp->mnt_transinfo;
879 1.26 hannken if (!verbose && (fmi == NULL || fmi->fmi_state == FSTRANS_NORMAL))
880 1.26 hannken return;
881 1.26 hannken
882 1.26 hannken printf("%-16s ", mp->mnt_stat.f_mntonname);
883 1.26 hannken if (fmi == NULL) {
884 1.26 hannken printf("(null)\n");
885 1.26 hannken return;
886 1.26 hannken }
887 1.26 hannken switch (fmi->fmi_state) {
888 1.26 hannken case FSTRANS_NORMAL:
889 1.26 hannken printf("state normal\n");
890 1.26 hannken break;
891 1.26 hannken case FSTRANS_SUSPENDED:
892 1.26 hannken printf("state suspended\n");
893 1.26 hannken break;
894 1.26 hannken default:
895 1.26 hannken printf("state %#x\n", fmi->fmi_state);
896 1.26 hannken break;
897 1.26 hannken }
898 1.26 hannken }
899 1.26 hannken
900 1.26 hannken void
901 1.26 hannken fstrans_dump(int full)
902 1.26 hannken {
903 1.26 hannken const struct proclist_desc *pd;
904 1.26 hannken struct proc *p;
905 1.26 hannken struct lwp *l;
906 1.26 hannken struct mount *mp;
907 1.26 hannken
908 1.26 hannken printf("Fstrans locks by lwp:\n");
909 1.26 hannken for (pd = proclists; pd->pd_list != NULL; pd++)
910 1.26 hannken PROCLIST_FOREACH(p, pd->pd_list)
911 1.26 hannken LIST_FOREACH(l, &p->p_lwps, l_sibling)
912 1.26 hannken fstrans_print_lwp(p, l, full == 1);
913 1.26 hannken
914 1.26 hannken printf("Fstrans state by mount:\n");
915 1.41 hannken for (mp = _mountlist_next(NULL); mp; mp = _mountlist_next(mp))
916 1.26 hannken fstrans_print_mount(mp, full == 1);
917 1.26 hannken }
918 1.26 hannken #endif /* defined(DDB) */
919