static/freebsd/man9/vflush.9 4.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

<table class="head">
  <tr>
    <td class="head-ltitle">VFLUSH(9)</td>
    <td class="head-vol">Kernel Developer's Manual</td>
    <td class="head-rtitle">VFLUSH(9)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">vflush</code> &#x2014; <span class="Nd">flush
    vnodes for a mount point</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="In">#include
    &lt;<a class="In">sys/param.h</a>&gt;</code>
  <br/>
  <code class="In">#include &lt;<a class="In">sys/vnode.h</a>&gt;</code></p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">vflush</code>(<var class="Fa" style="white-space: nowrap;">struct
    mount *mp</var>, <var class="Fa" style="white-space: nowrap;">int
    rootrefs</var>, <var class="Fa" style="white-space: nowrap;">int
    flags</var>, <var class="Fa" style="white-space: nowrap;">struct thread
    *td</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The
    <a class="permalink" href="#vflush"><code class="Fn" id="vflush">vflush</code></a>()
    function removes any vnodes in the vnode table that belong to the given
    <var class="Vt">mount</var> structure.</p>
<p class="Pp">Its arguments are:</p>
<dl class="Bl-tag">
  <dt><var class="Fa">mp</var></dt>
  <dd>The mount point whose vnodes should be removed.</dd>
  <dt><var class="Fa">rootrefs</var></dt>
  <dd>The number of references expected on the root vnode.
      <a class="Xr">vrele(9)</a> will be invoked on the root vnode
      <var class="Fa">rootrefs</var> times.</dd>
  <dt><var class="Fa">flags</var></dt>
  <dd>The flags indicating how vnodes should be handled.
    <dl class="Bl-tag">
      <dt id="FORCECLOSE"><a class="permalink" href="#FORCECLOSE"><code class="Dv">FORCECLOSE</code></a></dt>
      <dd>If set, busy vnodes will be forcibly closed.</dd>
      <dt id="SKIPSYSTEM"><a class="permalink" href="#SKIPSYSTEM"><code class="Dv">SKIPSYSTEM</code></a></dt>
      <dd>If set, vnodes with the <code class="Dv">VV_SYSTEM</code> flag set
          will be skipped.</dd>
      <dt id="WRITECLOSE"><a class="permalink" href="#WRITECLOSE"><code class="Dv">WRITECLOSE</code></a></dt>
      <dd>If set, only regular files currently opened for writing will be
          removed.</dd>
    </dl>
  </dd>
  <dt><var class="Fa">td</var></dt>
  <dd>The calling thread.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
  VALUES</a></h1>
<p class="Pp">A value of 0 is returned if the flush is successful; otherwise,
    <code class="Er">EBUSY</code> will be returned.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">vgone(9)</a>, <a class="Xr">vrele(9)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">This manual page was written by <span class="An">Chad David</span>
    &lt;<a class="Mt" href="mailto:davidc@acns.ab.ca">davidc@acns.ab.ca</a>&gt;.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">November 21, 2001</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>