Bug 116480

Summary: sysctl(3) description of kern.file no longer applies since 5.0
Product: Documentation Reporter: Ighighi <ighighi>
Component: Books & ArticlesAssignee: Jilles Tjoelker <jilles>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Ighighi 2007-09-20 03:30:01 UTC
Quoting sysctl(3):
KERN_FILE
        Return the entire file table.  The returned data consists of a
        single struct filehead followed by an array of struct file, whose
        size depends on the current number of such objects in the system.

This is no longer the case since 5.0.  The entire file table is an array of
"struct xfile" structures (defined in <sys/file.h>).
Comment 1 Jason 2010-02-25 07:16:01 UTC
This could probably be consolidated as part of docs/44034 PR.

-j
Comment 2 dfilter service freebsd_committer freebsd_triage 2010-04-25 13:35:54 UTC
Author: jilles
Date: Sun Apr 25 12:35:39 2010
New Revision: 207186
URL: http://svn.freebsd.org/changeset/base/207186

Log:
  sysctl(3): Update description of various kern.* variables.
  Also add xrefs for confstr(3) (as sysconf(3) but for strings) and kvm(3)
  (which is a more convenient way to access some of the variables).
  
  PR:		116480
  MFC after:	1 week

Modified:
  head/lib/libc/gen/sysctl.3

Modified: head/lib/libc/gen/sysctl.3
==============================================================================
--- head/lib/libc/gen/sysctl.3	Sun Apr 25 05:09:08 2010	(r207185)
+++ head/lib/libc/gen/sysctl.3	Sun Apr 25 12:35:39 2010	(r207186)
@@ -28,7 +28,7 @@
 .\"	@(#)sysctl.3	8.4 (Berkeley) 5/9/95
 .\" $FreeBSD$
 .\"
-.Dd February 21, 2010
+.Dd April 25, 2010
 .Dt SYSCTL 3
 .Os
 .Sh NAME
@@ -325,7 +325,7 @@ information.
 .It "KERN_BOOTFILE	string	yes"
 .It "KERN_BOOTTIME	struct timeval	no"
 .It "KERN_CLOCKRATE	struct clockinfo	no"
-.It "KERN_FILE	struct file	no"
+.It "KERN_FILE	struct xfile	no"
 .It "KERN_HOSTID	integer	yes"
 .It "KERN_HOSTUUID	string	yes"
 .It "KERN_HOSTNAME	string	yes"
@@ -342,14 +342,14 @@ information.
 .It "KERN_OSREV	integer	no"
 .It "KERN_OSTYPE	string	no"
 .It "KERN_POSIX1	integer	no"
-.It "KERN_PROC	struct proc	no"
+.It "KERN_PROC	node	not applicable"
 .It "KERN_PROF	node	not applicable"
 .It "KERN_QUANTUM	integer	yes"
 .It "KERN_SAVED_IDS	integer	no"
 .It "KERN_SECURELVL	integer	raise only"
 .It "KERN_UPDATEINTERVAL	integer	no"
 .It "KERN_VERSION	string	no"
-.It "KERN_VNODE	struct vnode	no"
+.It "KERN_VNODE	struct xvnode	no"
 .El
 .Bl -tag -width 6n
 .It Li KERN_ARGMAX
@@ -370,10 +370,8 @@ This structure contains the clock, stati
 frequencies, the number of micro-seconds per hz tick and the skew rate.
 .It Li KERN_FILE
 Return the entire file table.
-The returned data consists of a single
-.Va struct filehead
-followed by an array of
-.Va struct file ,
+The returned data consists of an array of
+.Va struct xfile ,
 whose size depends on the current number of such objects in the system.
 .It Li KERN_HOSTID
 Get or set the host ID.
@@ -525,10 +523,8 @@ Note, the vnode table is not necessarily
 the system.
 The returned data consists of an array whose size depends on the
 current number of such objects in the system.
-Each element of the array contains the kernel address of a vnode
-.Va struct vnode *
-followed by the vnode itself
-.Va struct vnode .
+Each element of the array consists of a
+.Va struct xvnode .
 .El
 .Ss CTL_NET
 The string and integer information available for the CTL_NET level
@@ -854,6 +850,8 @@ An attempt is made to set a read-only va
 A process without appropriate privilege attempts to set a value.
 .El
 .Sh SEE ALSO
+.Xr confstr 3 ,
+.Xr kvm 3 ,
 .Xr sysconf 3 ,
 .Xr sysctl 8
 .Sh HISTORY
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 3 Jilles Tjoelker freebsd_committer freebsd_triage 2010-04-25 13:36:38 UTC
State Changed
From-To: open->patched

Fixed in 9-CURRENT. 


Comment 4 Jilles Tjoelker freebsd_committer freebsd_triage 2010-04-25 13:36:38 UTC
Responsible Changed
From-To: freebsd-doc->jilles

Take.
Comment 5 dfilter service freebsd_committer freebsd_triage 2010-05-05 23:01:08 UTC
Author: jilles
Date: Wed May  5 22:00:57 2010
New Revision: 207679
URL: http://svn.freebsd.org/changeset/base/207679

Log:
  MFC r207186: sysctl(3): Update description of various kern.* variables.
  Also add xrefs for confstr(3) (as sysconf(3) but for strings) and kvm(3)
  (which is a more convenient way to access some of the variables).
  
  PR:		116480

Modified:
  stable/8/lib/libc/gen/sysctl.3
Directory Properties:
  stable/8/lib/libc/   (props changed)
  stable/8/lib/libc/stdtime/   (props changed)

Modified: stable/8/lib/libc/gen/sysctl.3
==============================================================================
--- stable/8/lib/libc/gen/sysctl.3	Wed May  5 21:48:40 2010	(r207678)
+++ stable/8/lib/libc/gen/sysctl.3	Wed May  5 22:00:57 2010	(r207679)
@@ -28,7 +28,7 @@
 .\"	@(#)sysctl.3	8.4 (Berkeley) 5/9/95
 .\" $FreeBSD$
 .\"
-.Dd January 28, 2009
+.Dd April 25, 2010
 .Dt SYSCTL 3
 .Os
 .Sh NAME
@@ -326,7 +326,7 @@ information.
 .It "KERN_BOOTFILE	string	yes"
 .It "KERN_BOOTTIME	struct timeval	no"
 .It "KERN_CLOCKRATE	struct clockinfo	no"
-.It "KERN_FILE	struct file	no"
+.It "KERN_FILE	struct xfile	no"
 .It "KERN_HOSTID	integer	yes"
 .It "KERN_HOSTUUID	string	yes"
 .It "KERN_HOSTNAME	string	yes"
@@ -343,14 +343,14 @@ information.
 .It "KERN_OSREV	integer	no"
 .It "KERN_OSTYPE	string	no"
 .It "KERN_POSIX1	integer	no"
-.It "KERN_PROC	struct proc	no"
+.It "KERN_PROC	node	not applicable"
 .It "KERN_PROF	node	not applicable"
 .It "KERN_QUANTUM	integer	yes"
 .It "KERN_SAVED_IDS	integer	no"
 .It "KERN_SECURELVL	integer	raise only"
 .It "KERN_UPDATEINTERVAL	integer	no"
 .It "KERN_VERSION	string	no"
-.It "KERN_VNODE	struct vnode	no"
+.It "KERN_VNODE	struct xvnode	no"
 .El
 .Pp
 .Bl -tag -width 6n
@@ -372,10 +372,8 @@ This structure contains the clock, stati
 frequencies, the number of micro-seconds per hz tick and the skew rate.
 .It Li KERN_FILE
 Return the entire file table.
-The returned data consists of a single
-.Va struct filehead
-followed by an array of
-.Va struct file ,
+The returned data consists of an array of
+.Va struct xfile ,
 whose size depends on the current number of such objects in the system.
 .It Li KERN_HOSTID
 Get or set the host ID.
@@ -527,10 +525,8 @@ Note, the vnode table is not necessarily
 the system.
 The returned data consists of an array whose size depends on the
 current number of such objects in the system.
-Each element of the array contains the kernel address of a vnode
-.Va struct vnode *
-followed by the vnode itself
-.Va struct vnode .
+Each element of the array consists of a
+.Va struct xvnode .
 .El
 .Ss CTL_NET
 The string and integer information available for the CTL_NET level
@@ -859,6 +855,8 @@ An attempt is made to set a read-only va
 A process without appropriate privilege attempts to set a value.
 .El
 .Sh SEE ALSO
+.Xr confstr 3 ,
+.Xr kvm 3 ,
 .Xr sysconf 3 ,
 .Xr sysctl 8
 .Sh HISTORY
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 6 dfilter service freebsd_committer freebsd_triage 2010-05-05 23:07:37 UTC
Author: jilles
Date: Wed May  5 22:07:28 2010
New Revision: 207681
URL: http://svn.freebsd.org/changeset/base/207681

Log:
  MFC r207186: sysctl(3): Update description of various kern.* variables.
  Also add xrefs for confstr(3) (as sysconf(3) but for strings) and kvm(3)
  (which is a more convenient way to access some of the variables).
  
  PR:		116480

Modified:
  stable/7/lib/libc/gen/sysctl.3
Directory Properties:
  stable/7/lib/libc/   (props changed)
  stable/7/lib/libc/stdtime/   (props changed)

Modified: stable/7/lib/libc/gen/sysctl.3
==============================================================================
--- stable/7/lib/libc/gen/sysctl.3	Wed May  5 22:06:05 2010	(r207680)
+++ stable/7/lib/libc/gen/sysctl.3	Wed May  5 22:07:28 2010	(r207681)
@@ -28,7 +28,7 @@
 .\"	@(#)sysctl.3	8.4 (Berkeley) 5/9/95
 .\" $FreeBSD$
 .\"
-.Dd April 10, 2007
+.Dd April 25, 2010
 .Dt SYSCTL 3
 .Os
 .Sh NAME
@@ -323,7 +323,7 @@ information.
 .It "KERN_BOOTFILE	string	yes"
 .It "KERN_BOOTTIME	struct timeval	no"
 .It "KERN_CLOCKRATE	struct clockinfo	no"
-.It "KERN_FILE	struct file	no"
+.It "KERN_FILE	struct xfile	no"
 .It "KERN_HOSTID	integer	yes"
 .It "KERN_HOSTUUID	string	yes"
 .It "KERN_HOSTNAME	string	yes"
@@ -340,14 +340,14 @@ information.
 .It "KERN_OSREV	integer	no"
 .It "KERN_OSTYPE	string	no"
 .It "KERN_POSIX1	integer	no"
-.It "KERN_PROC	struct proc	no"
+.It "KERN_PROC	node	not applicable"
 .It "KERN_PROF	node	not applicable"
 .It "KERN_QUANTUM	integer	yes"
 .It "KERN_SAVED_IDS	integer	no"
 .It "KERN_SECURELVL	integer	raise only"
 .It "KERN_UPDATEINTERVAL	integer	no"
 .It "KERN_VERSION	string	no"
-.It "KERN_VNODE	struct vnode	no"
+.It "KERN_VNODE	struct xvnode	no"
 .El
 .Pp
 .Bl -tag -width 6n
@@ -369,10 +369,8 @@ This structure contains the clock, stati
 frequencies, the number of micro-seconds per hz tick and the skew rate.
 .It Li KERN_FILE
 Return the entire file table.
-The returned data consists of a single
-.Va struct filehead
-followed by an array of
-.Va struct file ,
+The returned data consists of an array of
+.Va struct xfile ,
 whose size depends on the current number of such objects in the system.
 .It Li KERN_HOSTID
 Get or set the host ID.
@@ -526,10 +524,8 @@ Note, the vnode table is not necessarily
 the system.
 The returned data consists of an array whose size depends on the
 current number of such objects in the system.
-Each element of the array contains the kernel address of a vnode
-.Va struct vnode *
-followed by the vnode itself
-.Va struct vnode .
+Each element of the array consists of a
+.Va struct xvnode .
 .El
 .Ss CTL_MACHDEP
 The set of variables defined is architecture dependent.
@@ -869,6 +865,8 @@ An attempt is made to set a read-only va
 A process without appropriate privilege attempts to set a value.
 .El
 .Sh SEE ALSO
+.Xr confstr 3 ,
+.Xr kvm 3 ,
 .Xr sysconf 3 ,
 .Xr sysctl 8
 .Sh HISTORY
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 7 Jilles Tjoelker freebsd_committer freebsd_triage 2010-05-05 23:09:13 UTC
State Changed
From-To: patched->closed

Fixed in 9.x, 8.x, 7.x; no fix planned for 6.x. Thanks!