d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ccc09458fa
freebsd-nq/share/man/man9/VOP_INACTIVE.9

114 lines
2.9 KiB
Groff
Raw Normal View History

This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.\" -*- nroff -*-
.\"
.\" Copyright (c) 1996 Doug Rabson
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.\"
.Dd July 24, 1996
.Os
.Dt VOP_INACTIVE 9
.Sh NAME
.Nm VOP_INACTIVE ,
.Nm VOP_RECLAIM
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
.Nd reclaim file system resources for a vnode
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In sys/param.h
.In sys/vnode.h
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Ft int
- Fix a number of man pages broken by the KSE merger.
2001-11-20 18:19:19 +00:00
.Fn VOP_INACTIVE "struct vnode *vp" "struct thread *td"
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Ft int
- Fix a number of man pages broken by the KSE merger.
2001-11-20 18:19:19 +00:00
.Fn VOP_RECLAIM "struct vnode *vp" "struct thread *td"
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Sh DESCRIPTION
The arguments are:
mdoc(7) police: eliminate warnings.
2000-11-17 15:40:57 +00:00
.Bl -tag -width 2n
Some mdoc(7) fixes: Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately. The .Ar mdoc(7) specifier should only be used when displaying command line arguments. Approved by: des (mentor)
2003-05-31 14:07:25 +00:00
.It Fa vp
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
the vnode being reclaimed
.El
.Pp
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_INACTIVE
Mdoc Janitor: * Fix hard sentence breaks in VFS_*(9) and VOP_*(9) manual pages.
2003-10-23 02:11:14 +00:00
is called when the kernel is no longer using the vnode.
This may be
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
because the reference count reaches zero or it may be that the
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
file system is being forcibly unmounted while there are open files.
Mdoc Janitor: * Make use of .Sq mdoc command. * Add a .Pp for separating VOP_RECLAIM text from VOP_INACTIVE * Make use of .Fa for the vnode pointer function arg.
2003-10-23 03:07:56 +00:00
It can be used to reclaim space for
.Sq open but deleted
files.
.Pp
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_RECLAIM
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
is called when a vnode is being reused for a different file system.
Any file system specific resources associated with the vnode should be
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
freed.
Update errors in documentation for various VOP_ calls. Specifically, describe the correct locking state expected on entry and return.
1999-09-24 07:07:02 +00:00
.Sh LOCKS
Mdoc Janitor: * Make use of .Sq mdoc command. * Add a .Pp for separating VOP_RECLAIM text from VOP_INACTIVE * Make use of .Fa for the vnode pointer function arg.
2003-10-23 03:07:56 +00:00
For VOP_INACTIVE, the
.Fa vp
will be locked on entry.
Mdoc Janitor: * Fix hard sentence breaks in VFS_*(9) and VOP_*(9) manual pages.
2003-10-23 02:11:14 +00:00
Your VOP_INACTIVE code
Mdoc Janitor: * Make use of .Sq mdoc command. * Add a .Pp for separating VOP_RECLAIM text from VOP_INACTIVE * Make use of .Fa for the vnode pointer function arg.
2003-10-23 03:07:56 +00:00
must unlock the
.Fa vp
prior to returning.
Update errors in documentation for various VOP_ calls. Specifically, describe the correct locking state expected on entry and return.
1999-09-24 07:07:02 +00:00
.Pp
Mdoc Janitor: * Make use of .Sq mdoc command. * Add a .Pp for separating VOP_RECLAIM text from VOP_INACTIVE * Make use of .Fa for the vnode pointer function arg.
2003-10-23 03:07:56 +00:00
For VOP_RECLAIM, the
.Fa vp
will not be locked on entry and should be left unlocked on return.
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Sh PSEUDOCODE
.Bd -literal
int
- Fix a number of man pages broken by the KSE merger.
2001-11-20 18:19:19 +00:00
vop_inactive(struct vnode *vp, struct thread *td)
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
{
if (link count of vp == 0) {
/*
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
* Reclaim space in file system for vp.
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
*/
...;
}
- Fix a number of man pages broken by the KSE merger.
2001-11-20 18:19:19 +00:00
VOP_UNLOCK(vp, 0, td);
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
return 0;
}
int
- Fix a number of man pages broken by the KSE merger.
2001-11-20 18:19:19 +00:00
vop_reclaim(struct vnode *vp, struct thread *td)
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
{
/*
* Clean out the name cache.
*/
cache_purge(vp);
/*
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
* Free file system related data.
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
*/
...;
return 0;
}
.Ed
.Sh SEE ALSO
.Xr vnode 9
.Sh AUTHORS
.Sh AUTHOR -> .Sh AUTHORS according to mdoc specs. Use .An/.Aq.
1998-03-12 07:31:21 +00:00
This man page was written by
.An Doug Rabson .
Reference in New Issue Copy Permalink