xref: /illumos-gate/usr/src/man/man3proc/Plwp_getgwindows.3proc (revision 16b76d3cb933ff92018a2a75594449010192eacb)
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 PLWP_GETGWINDOWS 3PROC
16.Os
17.Sh NAME
18.Nm Plwp_getgwindows
19.Nd get thread unspilled register windows
20.Sh SYNOPSIS
21.Ft int
22.Fo Plwp_getgwindows
23.Fa "struct ps_prochandle *P"
24.Fa "lwpid_t lwpid"
25.Fa "gwindows_t *gwins"
26.Fc
27.Sh DESCRIPTION
28The
29.Fn Plwp_getgwindows
30function returns information about register windows that were not
31spilled to the stack for the thread identified by
32.Fa lwpid
33in the process handle
34.Fa P .
35The argument
36.Fa gwins
37will be filled in with information about the register windows.
38.Sh RETURN VALUES
39Upon successful completion, the
40.Fn Plwp_getgwindows
41function returns
42.Sy 0
43and
44.Fa gwins
45is filled in with information about the windows.
46Otherwise,
47.Sy -1
48is returned and
49.Sy errno
50is set to indicate the error.
51.Sh ERRORS
52For a full list of possible errors see the
53.Sy DIAGNOSTICS
54section in
55.Xr proc 5 .
56.Pp
57The
58.Fn Plwp_getgwindows
59function will fail if:
60.Bl -tag -width Er
61.It Er ENODATA
62The process handle
63.Fa P
64does not have any
65.Sy gwindows
66information.
67.It Er EBUSY
68The process handle
69.Fa P
70refers to a live process and it is not stopped.
71.It Er ENOENT
72The process handle
73.Fa P
74refers to a live process and there is no thread with id
75.Fa lwpid .
76.It Er EINVAL
77The process handle
78.Fa P
79refers to a core file and there is no thread with id
80.Fa lwpid .
81.El
82.Sh ARCHITECTURE
83The
84.Fn Plwp_getgwindows
85function is only available on
86.Sy SPARC
87platforms.
88.Sh INTERFACE STABILITY
89.Sy Uncommitted
90.Sh MT-LEVEL
91See
92.Sy LOCKING
93in
94.Xr libproc 3LIB .
95.Sh SEE ALSO
96.Xr libproc 3LIB ,
97.Xr proc 5
98