3 .\" The DragonFly Project. All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in
13 .\" the documentation and/or other materials provided with the
15 .\" 3. Neither the name of The DragonFly Project nor the names of its
16 .\" contributors may be used to endorse or promote products derived
17 .\" from this software without specific, prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 .Nd execute a mount control operation
44 .Fa "const char *path"
55 system call executes the mount control operation
59 An optional file descriptor
61 can be passed, or set to -1 if unneeded.
64 argument is for passing operation specific data and usually points to
66 .Sx CONTROL OPERATIONS
67 for further information).
68 The data's size is specified by
74 arguments are used if the operation needs to return data to the caller
78 .Sh CONTROL OPERATIONS
79 The following operations are defined in
81 .Bl -tag -width indent
82 .It Dv MOUNTCTL_SET_EXPORT
83 Set export control of a filesystem.
84 This operation needs a
85 .Vt struct export_args
88 Note that export control for numerous filesystems may still only be settable
91 New software should attempt to use
96 .It Dv MOUNTCTL_INSTALL_VFS_JOURNAL
97 Install a journal on a mount point.
98 This operation needs a
99 .Vt struct mountctl_install_journal
102 The journal file must be specified via
104 A mount point may have multiple journals attached to it.
105 .It Dv MOUNTCTL_REMOVE_VFS_JOURNAL
106 Disassociate a journal from a mount point.
107 This operation needs a
108 .Vt struct mountctl_remove_journal
111 .It Dv MOUNTCTL_RESTART_VFS_JOURNAL
112 Restart a journal with a new descriptor.
113 This operation needs a
114 .Vt struct mountctl_restart_journal
117 The journal file must be specified via
119 .It Dv MOUNTCTL_STATUS_VFS_JOURNAL
120 Return a journal's status.
121 This operation needs a
122 .Vt struct mountctl_status_journal
126 .Vt struct mountctl_journal_ret_status
129 .It MOUNTCTL_MOUNTFLAGS
130 It will store a comma separated string buffer in the
132 parameter with the name list of the currently set
133 user mount flags. The
135 will be sized at most
138 .\" XXX Not yet implemented:
139 .\".It Dv MOUNTCTL_INSTALL_BLK_JOURNAL
140 .\".It Dv MOUNTCTL_REMOVE_BLK_JOURNAL
141 .\".It Dv MOUNTCTL_RESYNC_BLK_JOURNAL
142 .\".It Dv MOUNTCTL_RESYNC_VFS_JOURNAL
143 .\".It Dv MOUNTCTL_STATUS_BLK_JOURNAL
146 Upon successful completion, the number
147 of copied bytes is returned; otherwise
148 the value -1 is returned and the
151 is set to indicate the error.
155 function will fail when one of the following occurs:
159 is not an active descriptor.
170 The caller is not the super-user.
178 system call first appeared in
184 system call was written by
186 and this manual page was written by