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