2001-07-10 07:25:18 +00:00
|
|
|
.\"
|
|
|
|
|
.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" 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(s), this list of conditions and the following disclaimer as
|
|
|
|
|
.\" the first lines of this file unmodified other than the possible
|
|
|
|
|
.\" addition of one or more copyright notices.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
2001-07-13 18:35:48 +00:00
|
|
|
.Dd July 10, 2001
|
|
|
|
|
.Dt UIDINFO 9
|
2001-07-10 07:25:18 +00:00
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
2001-07-13 18:35:48 +00:00
|
|
|
.Nm uidinfo ,
|
|
|
|
|
.Nm uihashinit ,
|
|
|
|
|
.Nm uifind ,
|
|
|
|
|
.Nm uihold ,
|
|
|
|
|
.Nm uifree
|
|
|
|
|
.Nd "functions for managing UID information"
|
2001-07-10 07:25:18 +00:00
|
|
|
.Sh SYNOPSIS
|
2001-07-13 18:35:48 +00:00
|
|
|
.In sys/param.h
|
2001-12-26 23:14:04 +00:00
|
|
|
.In sys/proc.h
|
2001-07-13 18:35:48 +00:00
|
|
|
.In sys/resourcevar.h
|
|
|
|
|
.Ft void
|
|
|
|
|
.Fn uihashinit void
|
|
|
|
|
.Ft "struct uidinfo *"
|
|
|
|
|
.Fn uifind "uid_t uid"
|
|
|
|
|
.Ft void
|
|
|
|
|
.Fn uihold "struct uidinfo *uip"
|
|
|
|
|
.Ft void
|
|
|
|
|
.Fn uifree "struct uidinfo *uip"
|
2001-07-10 07:25:18 +00:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
2001-07-13 18:35:48 +00:00
|
|
|
.Nm
|
|
|
|
|
family of functions
|
|
|
|
|
is used to manage
|
|
|
|
|
.Vt uidinfo
|
|
|
|
|
structures.
|
2002-06-10 17:36:05 +00:00
|
|
|
Each
|
2001-07-13 18:35:48 +00:00
|
|
|
.Vt uidinfo
|
2002-06-10 17:36:05 +00:00
|
|
|
structure maintains per uid resource consumption counts, including the
|
|
|
|
|
process count and socket buffer space usage.
|
2001-07-13 18:35:48 +00:00
|
|
|
.Pp
|
|
|
|
|
The
|
|
|
|
|
.Fn uihashinit
|
|
|
|
|
function initializes the
|
|
|
|
|
.Vt uidinfo
|
2002-06-10 17:36:05 +00:00
|
|
|
hash table and its mutex.
|
2001-07-13 18:35:48 +00:00
|
|
|
This function should only be called during system initialization.
|
|
|
|
|
.Pp
|
|
|
|
|
The
|
|
|
|
|
.Fn uifind
|
|
|
|
|
function looks up and returns the
|
|
|
|
|
.Vt uidinfo
|
2002-06-10 17:36:05 +00:00
|
|
|
structure for
|
2001-07-13 18:35:48 +00:00
|
|
|
.Fa uid .
|
2002-08-13 15:01:26 +00:00
|
|
|
If no
|
2001-07-13 18:35:48 +00:00
|
|
|
.Vt uidinfo
|
2002-06-10 17:36:05 +00:00
|
|
|
structure exists for
|
|
|
|
|
.Fa uid ,
|
|
|
|
|
a new structure will be allocated and initialized.
|
2002-08-13 15:01:26 +00:00
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
hash mutex is acquired and released.
|
2001-07-13 18:35:48 +00:00
|
|
|
.Pp
|
|
|
|
|
The
|
|
|
|
|
.Fn uihold
|
2002-06-10 17:36:05 +00:00
|
|
|
function increases the reference count on
|
|
|
|
|
.Fa uip .
|
2002-08-13 15:01:26 +00:00
|
|
|
.Fa uip Ns 's
|
2002-06-10 17:36:05 +00:00
|
|
|
lock is acquired and released.
|
2001-07-10 07:25:18 +00:00
|
|
|
.Pp
|
2001-07-13 18:35:48 +00:00
|
|
|
The
|
|
|
|
|
.Fn uifree
|
2002-06-10 17:36:05 +00:00
|
|
|
function decreases the reference count on
|
|
|
|
|
.Fa uip ,
|
|
|
|
|
and if the count reaches 0
|
|
|
|
|
.Fa uip
|
|
|
|
|
is freed.
|
2002-08-13 15:01:26 +00:00
|
|
|
.Fa uip Ns 's
|
2002-06-10 17:36:05 +00:00
|
|
|
lock is acquired and release and the uidinfo hash mutex may be
|
|
|
|
|
acquired and released.
|
2001-07-10 07:25:18 +00:00
|
|
|
.Sh RETURN VALUES
|
2002-06-10 17:36:05 +00:00
|
|
|
.Fn uifind
|
|
|
|
|
returns a pointer to an initialized
|
2001-07-13 18:35:48 +00:00
|
|
|
.Vt uidinfo
|
2002-06-10 17:36:05 +00:00
|
|
|
structure, and should not fail.
|
2001-07-10 07:25:18 +00:00
|
|
|
.Sh AUTHORS
|
2001-07-11 10:31:49 +00:00
|
|
|
This man page was written by
|
2001-07-13 18:35:48 +00:00
|
|
|
.An Chad David Aq davidc@acns.ab.ca .
|
