1 /*	$NetBSD: fstrans.h,v 1.10 2008/11/07 00:15:42 joerg Exp $	*/
2 
3 /*-
4  * Copyright (c) 2007 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Juergen Hannken-Illjes.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * File system transaction operations.
34  */
35 
36 #ifndef _SYS_FSTRANS_H_
37 #define	_SYS_FSTRANS_H_
38 
39 #include <sys/mount.h>
40 
41 #define SUSPEND_SUSPEND	0x0001		/* VFS_SUSPENDCTL: suspend */
42 #define SUSPEND_RESUME	0x0002		/* VFS_SUSPENDCTL: resume */
43 
44 enum fstrans_lock_type {
45 	FSTRANS_LAZY = 1,		/* Granted while not suspended */
46 	FSTRANS_SHARED = 2		/* Granted while not suspending */
47 #ifdef _FSTRANS_API_PRIVATE
48 	,
49 	FSTRANS_EXCL = 3		/* Internal: exclusive lock */
50 #endif /* _FSTRANS_API_PRIVATE */
51 };
52 
53 enum fstrans_state {
54 	FSTRANS_NORMAL,
55 	FSTRANS_SUSPENDING,
56 	FSTRANS_SUSPENDED
57 };
58 
59 void	fstrans_init(void);
60 #define fstrans_start(mp, t)		_fstrans_start((mp), (t), 1)
61 #define fstrans_start_nowait(mp, t)	_fstrans_start((mp), (t), 0)
62 int	_fstrans_start(struct mount *, enum fstrans_lock_type, int);
63 void	fstrans_done(struct mount *);
64 int	fstrans_is_owner(struct mount *);
65 int	fstrans_mount(struct mount *);
66 void	fstrans_unmount(struct mount *);
67 
68 int	fstrans_setstate(struct mount *, enum fstrans_state);
69 enum fstrans_state fstrans_getstate(struct mount *);
70 
71 int	fscow_establish(struct mount *, int (*)(void *, struct buf *, bool),
72 	    void *);
73 int	fscow_disestablish(struct mount *, int (*)(void *, struct buf *, bool),
74 	    void *);
75 int	fscow_run(struct buf *, bool);
76 
77 int	vfs_suspend(struct mount *, int);
78 void	vfs_resume(struct mount *);
79 
80 #endif /* _SYS_FSTRANS_H_ */
81