share/man/man3proc/Plwp_getgwindows.3proc

   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
  28 The
  29 .Fn Plwp_getgwindows
  30 function returns information about register windows that were not
  31 spilled to the stack for the thread identified by
  32 .Fa lwpid
  33 in the process handle
  34 .Fa P .
  35 The argument
  36 .Fa gwins
  37 will be filled in with information about the register windows.
  38 .Sh RETURN VALUES
  39 Upon successful completion, the
  40 .Fn Plwp_getgwindows
  41 function returns
  42 .Sy 0
  43 and
  44 .Fa gwins
  45 is filled in with information about the windows.
  46 Otherwise,
  47 .Sy -1
  48 is returned and
  49 .Sy errno
  50 is set to indicate the error.
  51 .Sh ERRORS
  52 For a full list of possible errors see the
  53 .Sy DIAGNOSTICS
  54 section in
  55 .Xr proc 4 .
  56 .Pp
  57 The
  58 .Fn Plwp_getgwindows
  59 function will fail if:
  60 .Bl -tag -width Er
  61 .It Er ENODATA
  62 The process handle
  63 .Fa P
  64 does not have any
  65 .Sy gwindows
  66 information.
  67 .It Er EBUSY
  68 The process handle
  69 .Fa P
  70 refers to a live process and it is not stopped.
  71 .It Er ENOENT
  72 The process handle
  73 .Fa P
  74 refers to a live process and there is no thread with id
  75 .Fa lwpid .
  76 .It Er EINVAL
  77 The process handle
  78 .Fa P
  79 refers to a core file and there is no thread with id
  80 .Fa lwpid .
  81 .El
  82 .Sh ARCHITECTURE
  83 The
  84 .Fn Plwp_getgwindows
  85 function is only available on
  86 .Sy SPARC
  87 platforms.
  88 .Sh INTERFACE STABILITY
  89 .Sy Uncommitted
  90 .Sh MT-LEVEL
  91 See
  92 .Sy LOCKING
  93 in
  94 .Xr libproc 3LIB .
  95 .Sh SEE ALSO
  96 .Xr libproc 3LIB ,
  97 .Xr proc 4