xref: /freebsd/share/man/man9/pfind.9 (revision ea906c4152774dff300bb26fbfc1e4188351c89a)
1.\" Copyright (c) 2001 Evan Sarmiento.
2.\" 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, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd July 11, 2001
28.Os
29.Dt PFIND 9
30.Sh NAME
31.Nm pfind , zpfind
32.Nd locate a process by number
33.Sh SYNOPSIS
34.In sys/param.h
35.In sys/proc.h
36.Ft "struct proc *"
37.Fn pfind "pid_t pid"
38.Ft "struct proc *"
39.Fn zpfind "pid_t pid"
40.Sh DESCRIPTION
41.Fn pfind
42takes a
43.Fa pid
44as its argument and returns a pointer to the
45.Vt proc
46structure whose PID is specified in the argument only if the
47.Fa pid
48is on the
49.Va allproc
50list.
51.Pp
52.Fn zpfind
53takes a
54.Fa pid
55as its argument.
56If
57.Fn zpfind
58finds a process whose PID is equal to that of argument
59and is a zombie process, meaning that it must reside on the
60.Va zombproc
61list,
62.Fn zpfind
63returns a pointer to that
64.Vt proc
65structure.
66.Pp
67Both
68.Fn pfind
69and
70.Fn zpfind
71lock the
72.Vt proc
73structure that is returned using
74.Fn PROC_LOCK "p" .
75.Sh RETURN VALUES
76.Fn pfind
77and
78.Fn zpfind
79return a pointer to a
80.Vt proc
81structure on success and a
82.Dv NULL
83on failure.
84.Sh SEE ALSO
85.Xr pgfind 9
86.Sh AUTHORS
87This manual page was written by
88.An Evan Sarmiento Aq kaworu@sektor7.ath.cx .
89