xref: /freebsd/share/man/man9/uidinfo.9 (revision 4772483c009be91716eb583c23c484b06bdd8f50)
1.\"
2.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice(s), this list of conditions and the following disclaimer as
9.\"    the first lines of this file unmodified other than the possible
10.\"    addition of one or more copyright notices.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice(s), this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
16.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18.\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
19.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
25.\" DAMAGE.
26.\"
27.\" $FreeBSD$
28.\"
29.Dd July 10, 2001
30.Dt UIDINFO 9
31.Os
32.Sh NAME
33.Nm uidinfo ,
34.Nm uihashinit ,
35.Nm uifind ,
36.Nm uihold ,
37.Nm uifree
38.Nd "functions for managing UID information"
39.Sh SYNOPSIS
40.In sys/param.h
41.In sys/resourcevar.h
42.Ft void
43.Fn uihashinit void
44.Ft "struct uidinfo *"
45.Fn uifind "uid_t uid"
46.Ft void
47.Fn uihold "struct uidinfo *uip"
48.Ft void
49.Fn uifree "struct uidinfo *uip"
50.Sh DESCRIPTION
51The
52.Nm
53family of functions
54is used to manage
55.Vt uidinfo
56structures.
57The
58.Vt uidinfo
59structure maintains the process count and socket buffer space usage
60for a given UID.
61.Pp
62The
63.Fn uihashinit
64function initializes the
65.Vt uidinfo
66hash table.
67This function should only be called during system initialization.
68.Pp
69The
70.Fn uifind
71function looks up and returns the
72.Vt uidinfo
73structure for the
74.Fa uid .
75If the
76.Vt uidinfo
77is not found, a new structure is allocated.
78.Pp
79The
80.Fn uihold
81function increases the reference count on the
82.Vt uidinfo
83structure.
84.Pp
85The
86.Fn uifree
87function decreases the reference count on the
88.Vt uidinfo
89structure.
90If the count reaches 0, the storage for the structure is freed.
91.Sh RETURN VALUES
92The functions that return values all return a pointer to a
93.Vt uidinfo
94structure.
95.Sh AUTHORS
96This man page was written by
97.An Chad David Aq davidc@acns.ab.ca .
98