xref: /illumos-gate/usr/src/man/man3proc/Pasfd.3proc (revision dcbf3bd6a1f1360fc1afcee9e22c6dcff7844bf2)
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 PASFD 3PROC
16.Os
17.Sh NAME
18.Nm Pasfd
19.Nd obtain the process address space file descriptor
20.Sh SYNOPSIS
21.Lb libproc
22.In libproc.h
23.Ft int
24.Fo Pasfd
25.Fa "struct ps_prochandle *P"
26.Fc
27.Sh DESCRIPTION
28The
29.Fn Pasfd
30funtion returns a file descriptor that allows direct access to the
31address space of the process handle
32.Fa P .
33A defined file descriptor is provided when using the
34.Xr Pcreate ,
35.Xr Pgrab 3PROC ,
36.Xr Pgrab_file 3PROC ,
37and
38.Xr Pgrab_core 3PROC
39functions. Note that the address space may be different in each of these
40cases and doesn't necessarily correspond to the /proc
41.Sy as
42file, except for live processes. Other means of obtaining a
43.Sy libproc
44process handle may not define a file descriptor that contains the
45address space.
46.Pp
47The returned file descriptor must not be closed and is only valid for
48as long as the corresponding process handle
49.Fa P
50is valid. After a call to
51.Xr Prelease 3PROC
52the file descriptor is invalidated.
53.Sh RETURN VALUES
54Upon successful completion, the
55.Fn Pasfd
56function returns a valid file descriptor. Otherwise, if none exists,
57then
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 libproc 3LIB ,
69.Xr Pcreate 3PROC ,
70.Xr Pgrab 3PROC ,
71.Xr Pgrab_core 3PROC ,
72.Xr Pgrab_file 3PROC ,
73.Xr Prelease 3PROC ,
74.Xr proc 4
75