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