xref: /illumos-gate/usr/src/man/man3proc/Plwp_getpsinfo.3proc (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
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 PLWP_GETPSINFO 3PROC
1643051d27SRobert Mustacchi.Os
1743051d27SRobert Mustacchi.Sh NAME
1843051d27SRobert Mustacchi.Nm Plwp_getpsinfo
1943051d27SRobert Mustacchi.Nd get thread specific ps information
20ab618543SJohn Levon.Sh LIBRARY
2143051d27SRobert Mustacchi.Lb libproc
22ab618543SJohn Levon.Sh SYNOPSIS
2343051d27SRobert Mustacchi.In libproc.h
2443051d27SRobert Mustacchi.Ft int
2543051d27SRobert Mustacchi.Fo Plwp_getpsinfo
2643051d27SRobert Mustacchi.Fa "struct ps_prochandle *P"
2743051d27SRobert Mustacchi.Fa "lwpid_t lwpid"
2843051d27SRobert Mustacchi.Fa "lwpsinfo_t *lps"
2943051d27SRobert Mustacchi.Fc
3043051d27SRobert Mustacchi.Sh DESCRIPTION
3143051d27SRobert MustacchiThe
3243051d27SRobert Mustacchi.Fn Plwp_getpsinfo
3343051d27SRobert Mustacchifunction
3443051d27SRobert Mustacchilooks up the thread-specific
3543051d27SRobert Mustacchi.Xr ps 1
3643051d27SRobert Mustacchiinformation for the thread specified by
3743051d27SRobert Mustacchi.Fa lwpid
3843051d27SRobert Mustacchiin the process handle
3943051d27SRobert Mustacchi.Fa P .
4043051d27SRobert MustacchiThe caller should provide a pointer to an
4143051d27SRobert Mustacchi.Sy lwpsinfo_t ,
4243051d27SRobert Mustacchi.Fa lps ,
4343051d27SRobert Mustacchiwhose definition can be found in
44*bbf21555SRichard Lowe.Xr proc 5 .
4543051d27SRobert Mustacchi.Fa lps
4643051d27SRobert Mustacchiwill be filled in with information such as the thread's id, its current
4743051d27SRobert Mustacchistate, priority, and run-time.
4843051d27SRobert Mustacchi.Pp
4943051d27SRobert MustacchiThe
5043051d27SRobert Mustacchi.Fn Plwp_getpsinfo
5143051d27SRobert Mustacchifunction only works on process handles that refer to active processes
5243051d27SRobert Mustacchiand core files, it does not work on process handles that refer to
5343051d27SRobert Mustacchiindividual files.
5443051d27SRobert Mustacchi.Sh RETURN VALUES
5543051d27SRobert MustacchiUpon successful completion, the
5643051d27SRobert Mustacchi.Fn Plwp_getpsinfo
5743051d27SRobert Mustacchifunction returns
5843051d27SRobert Mustacchi.Sy 0
5943051d27SRobert Mustacchiand
6043051d27SRobert Mustacchi.Fa lps
6143051d27SRobert Mustacchiis filled in with the
6243051d27SRobert Mustacchithread-specific
6343051d27SRobert Mustacchi.Xr ps 1
6472d3dbb9SYuri Pankovinformation.
6572d3dbb9SYuri PankovOtherwise,
6643051d27SRobert Mustacchi.Sy -1
6743051d27SRobert Mustacchiis returned and
6843051d27SRobert Mustacchi.Sy errno
6943051d27SRobert Mustacchiis set to indicate the error.
7043051d27SRobert Mustacchi.Sh ERRORS
7143051d27SRobert MustacchiFor a full list of possible errors also see the
7243051d27SRobert Mustacchi.Sy DIAGNOSTICS
7343051d27SRobert Mustacchisection in
74*bbf21555SRichard Lowe.Xr proc 5 .
7543051d27SRobert Mustacchi.Pp
7643051d27SRobert MustacchiThe
7743051d27SRobert Mustacchi.Fn Plwp_getpsinfo
7843051d27SRobert Mustacchifunction will fail if:
7943051d27SRobert Mustacchi.Bl -tag -width Er
8043051d27SRobert Mustacchi.It Er ENODATA
8143051d27SRobert Mustacchi.Fa P
8243051d27SRobert Mustacchirefers to a file handle obtained through
8343051d27SRobert Mustacchi.Xr Pgrab_file 3PROC .
8443051d27SRobert Mustacchi.It Er EINVAL
8543051d27SRobert MustacchiThe process handle
8643051d27SRobert Mustacchi.Fa P
8743051d27SRobert Mustacchirefers to a core file and the specified thread does not exist.
8843051d27SRobert Mustacchi.It Er ENOENT
8943051d27SRobert MustacchiThe process handle
9043051d27SRobert Mustacchi.Fa P
9143051d27SRobert Mustacchirefers to an active process and the specified thread does not exist.
9243051d27SRobert Mustacchi.El
9343051d27SRobert Mustacchi.Sh INTERFACE STABILITY
9443051d27SRobert Mustacchi.Sy Uncommitted
9543051d27SRobert Mustacchi.Sh MT-LEVEL
9643051d27SRobert MustacchiSee
9743051d27SRobert Mustacchi.Sy LOCKING
9843051d27SRobert Mustacchiin
9943051d27SRobert Mustacchi.Xr ps 1 ,
10043051d27SRobert Mustacchi.Xr libproc 3LIB .
10143051d27SRobert Mustacchi.Sh SEE ALSO
10243051d27SRobert Mustacchi.Xr libproc 3LIB ,
103*bbf21555SRichard Lowe.Xr proc 5
104