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