xref: /freebsd/share/man/man9/pfind.9 (revision b64c5a0ace59af62eff52bfe110a521dc73c937b)
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.Dd December 3, 2024
26.Dt PFIND 9
27.Os
28.Sh NAME
29.Nm pfind , zpfind
30.Nd locate a process by number
31.Sh SYNOPSIS
32.In sys/param.h
33.In sys/proc.h
34.Ft "struct proc *"
35.Fn pfind "pid_t pid"
36.Ft "struct proc *"
37.Fn pfind_any "pid_t pid"
38.Ft "struct proc *"
39.Fn pfind_any_locked "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 pfind_any
53takes a
54.Fa pid
55as its argument.
56.Fn pfind_any
57searches the
58.Va allproc
59list and returns the first process whose PID matches and whose state is
60.Va PRS_ZOMBIE .
61.Pp
62.Fn pfind_any_locked
63is similar to
64.Fn pfind_any
65,but it does not lock the process hash bucket
66for the given
67.Vt pid .
68Instead, it asserts the corresponding process hash bucket is already locked.
69All three functions
70.Fn pfind ,
71.Fn pfind_any ,
72and
73.Fn pgfind_any_locked
74lock the
75.Vt proc
76structure before returning.
77.Sh RETURN VALUES
78.Fn pfind ,
79.Fn pfind_any ,
80and
81.Fn pfind_any_locked
82return pointer to a
83.Vt proc
84structure on success or
85.Dv NULL
86on failure.
87.Sh SEE ALSO
88.Xr pgfind 9
89.Sh AUTHORS
90This manual page was written by
91.An Evan Sarmiento Aq Mt kaworu@sektor7.ath.cx .
92