xref: /netbsd-src/share/man/man9/proc_find.9 (revision 796519303723746a61d1bd36926322db5733a432)
1.\" $NetBSD: proc_find.9,v 1.1 2010/07/01 14:54:44 jruoho Exp $
2.\"
3.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Jukka Ruohonen.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd July 1, 2010
31.Dt PROC_FIND 9
32.Os
33.Sh NAME
34.Nm proc_find ,
35.Nm pgrp_find
36.Nd find process or process group
37.Sh SYNOPSIS
38.In sys/proc.h
39.Ft struct proc *
40.Fn proc_find "pid_t pid"
41.Ft struct pgrp *
42.Fn pgrp_find "pid_t pgid"
43.Pp
44.Va extern kmutex_t *proc_lock;
45.Sh DESCRIPTION
46The
47.Fn proc_find
48and
49.Fn pgrp_find
50functions retrieve process and process group structures from process
51.Tn ID
52.Fa pid
53and process group
54.Tn ID
55.Fa pgid .
56Both functions must be called by holding a
57.Xr mutex 9
58on
59.Va proc_lock .
60.Sh RETURN VALUES
61Upon successful completion, the described functions return a pointer to either
62.Em struct proc
63or
64.Em struct pgrp .
65Otherwise, if the requested
66.Tn ID
67was not found,
68.Dv NULL
69is returned.
70.Sh SEE ALSO
71.Xr curproc 9
72