xref: /illumos-gate/usr/src/man/man3proc/Pctlfd.3proc (revision bbf21555)
143051d27SRobert Mustacchi.\"
243051d27SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
343051d27SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
443051d27SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
543051d27SRobert Mustacchi.\" 1.0 of the CDDL.
643051d27SRobert Mustacchi.\"
743051d27SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
843051d27SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
943051d27SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
1043051d27SRobert Mustacchi.\"
1143051d27SRobert Mustacchi.\"
1243051d27SRobert Mustacchi.\" Copyright 2015 Joyent, Inc.
1343051d27SRobert Mustacchi.\"
1443051d27SRobert Mustacchi.Dd May 11, 2016
1543051d27SRobert Mustacchi.Dt PCTFLD 3PROC
1643051d27SRobert Mustacchi.Os
1743051d27SRobert Mustacchi.Sh NAME
1843051d27SRobert Mustacchi.Nm Pctlfd
1943051d27SRobert Mustacchi.Nd obtain the process control file descriptor
20ab618543SJohn Levon.Sh LIBRARY
2143051d27SRobert Mustacchi.Lb libproc
22ab618543SJohn Levon.Sh SYNOPSIS
2343051d27SRobert Mustacchi.In libproc.h
2443051d27SRobert Mustacchi.Ft int
2543051d27SRobert Mustacchi.Fo Pctlfd
2643051d27SRobert Mustacchi.Fa "struct ps_prochandle *P"
2743051d27SRobert Mustacchi.Fc
2843051d27SRobert Mustacchi.Sh DESCRIPTION
2943051d27SRobert MustacchiThe
3043051d27SRobert Mustacchi.Fn Pctlfd
3143051d27SRobert Mustacchifunction returns a file descriptor to the underlying /proc file system
3243051d27SRobert Mustacchi.Sy ctl
3343051d27SRobert Mustacchifile for the process identified by the handle
3443051d27SRobert Mustacchi.Fa P .
3543051d27SRobert MustacchiThis may be used for injecting control operations manually;
3643051d27SRobert Mustacchihowever, many interfaces for using it are provided by
3743051d27SRobert Mustacchi.Xr libproc 3LIB
3843051d27SRobert Mustacchiitself.
3943051d27SRobert Mustacchi.Pp
4072d3dbb9SYuri PankovOnly live processes have a control file descriptor.
4172d3dbb9SYuri PankovProcess handles that correspond to files and cores, created through
42b31ca922SChris Fraire.Xr Pgrab_file 3PROC
4343051d27SRobert Mustacchiand
4443051d27SRobert Mustacchi.Xr Pgrab_core 3PROC ,
4543051d27SRobert Mustacchido not have a corresponding file descriptor.
4643051d27SRobert Mustacchi.Pp
4743051d27SRobert MustacchiThe file descriptor is invalidated when the process handle is released
4843051d27SRobert Mustacchithrough
4943051d27SRobert Mustacchi.Xr Prelease 3PROC
5043051d27SRobert Mustacchior if control is lost and the handle is reopened.
5143051d27SRobert Mustacchi.Sh RETURN VALUES
5243051d27SRobert MustacchiUpon successful completion, the
5343051d27SRobert Mustacchi.Fn Pctlfd
5472d3dbb9SYuri Pankovfunction returns a valid file descriptor.
5572d3dbb9SYuri PankovOtherwise, if none exists, then
5643051d27SRobert Mustacchi.Sy -1
5743051d27SRobert Mustacchiis returned.
5843051d27SRobert Mustacchi.Sh INTERFACE STABILITY
5943051d27SRobert Mustacchi.Sy Uncommitted
6043051d27SRobert Mustacchi.Sh MT-LEVEL
6143051d27SRobert MustacchiSee
6243051d27SRobert Mustacchi.Sy LOCKING
6343051d27SRobert Mustacchiin
6443051d27SRobert Mustacchi.Xr libproc 3LIB .
6543051d27SRobert Mustacchi.Sh SEE ALSO
6643051d27SRobert Mustacchi.Xr libproc 3LIB ,
6743051d27SRobert Mustacchi.Xr Pcreate 3PROC ,
6843051d27SRobert Mustacchi.Xr Pgrab 3PROC ,
6943051d27SRobert Mustacchi.Xr Pgrab_core 3PROC ,
7043051d27SRobert Mustacchi.Xr Pgrab_file 3PROC ,
7143051d27SRobert Mustacchi.Xr Prelease 3PROC ,
7243051d27SRobert Mustacchi.Xr Preopen 3PROC ,
73*bbf21555SRichard Lowe.Xr proc 5
74