xref: /illumos-gate/usr/src/man/man3proc/Plwp_getgwindows.3proc (revision cc6b30399e68fb9666466c57ed822f297b2c6ae4)
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. Otherwise,
46.Sy -1
47is returned and
48.Sy errno
49is set to indicate the error.
50.Sh ERRORS
51For a full list of possible errors see the
52.Sy DIAGNOSTICS
53section in
54.Xr proc 4 .
55.Pp
56The
57.Fn Plwp_getgwindows
58function will fail if:
59.Bl -tag -width Er
60.It Er ENODATA
61The process handle
62.Fa P
63does not have any
64.Sy gwindows
65information.
66.It Er EBUSY
67The process handle
68.Fa P
69refers to a live process and it is not stopped.
70.It Er ENOENT
71The process handle
72.Fa P
73refers to a live process and there is no thread with id
74.Fa lwpid .
75.It Er EINVAL
76The process handle
77.Fa P
78refers to a core file and there is no thread with id
79.Fa lwpid .
80.El
81.Sh ARCHITECTURE
82The
83.Fn Plwp_getgwindows
84function is only available on
85.Sy SPARC
86platforms.
87.Sh INTERFACE STABILITY
88.Sy Uncommitted
89.Sh MT-LEVEL
90See
91.Sy LOCKING
92in
93.Xr libproc 3LIB .
94.Sh SEE ALSO
95.Xr libproc 3LIB ,
96.Xr proc 4
97