xref: /illumos-gate/usr/src/man/man3proc/Preopen.3proc (revision 843c398e8904ed9d833d2af3103894f909fb4b52)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright 2015 Joyent, Inc.
13.\"
14.Dd May 11, 2016
15.Dt PREOPEN 3PROC
16.Os
17.Sh NAME
18.Nm Preopen
19.Nd reopen a process
20.Sh SYNOPSIS
21.Lb libproc
22.In libproc.h
23.Ft int
24.Fo Preopen
25.Fa "struct ps_prochandle *P"
26.Fc
27.Sh DESCRIPTION
28The
29.Fn Preopen
30function is used to regain control of the process represented by the
31handle
32.Fa P .
33A loss of control is indicated by the
34.Xr Pstatus 3PROC
35function returning the value
36.Dv PS_LOST .
37This may occur when the controlled process performs an
38.Xr exec 2
39of a setuid or setgid binary or one where the controlling process cannot
40read the object file. For more information on this, see the
41.Sy PROGRAMMING NOTES
42section of
43.Xr proc 4 .
44.Pp
45If successful, the controlling process will obtain control of the
46process specified by
47.Fa P .
48If it fails, the controlling process should release the handle with
49.Xr Prelease 3PROC .
50Note there are occasions where due to permissions it may not be possible
51to obtain control again.
52.Sh RETURN VALUES
53Upon successful completion, the
54.Fn Preopen
55function returns
56.Sy 0.
57Otherwise,
58.Sy -1
59is returned.
60.Sh INTERFACE STABILITY
61.Sy Uncommitted
62.Sh MT-LEVEL
63See
64.Sy LOCKING
65in
66.Xr libproc 3LIB .
67.Sh SEE ALSO
68.Xr exec 2 ,
69.Xr libproc 3LIB ,
70.Xr Prelease 3PROC ,
71.Xr Pstatus 3PROC ,
72.Xr proc 4
73