8158 Want named threads API
9857 proc manpages should have LIBRARY section

          --- old/usr/src/man/man3proc/Plwp_getasrs.3proc
          +++ new/usr/src/man/man3proc/Plwp_getasrs.3proc

   1    1  .\"
   2    2  .\" This file and its contents are supplied under the terms of the
   3    3  .\" Common Development and Distribution License ("CDDL"), version 1.0.
   4    4  .\" You may only use this file in accordance with the terms of version
   5    5  .\" 1.0 of the CDDL.
   6    6  .\"
   7    7  .\" A full copy of the text of the CDDL should have accompanied this
   8    8  .\" source.  A copy of the CDDL is also available via the Internet at
   9    9  .\" http://www.illumos.org/license/CDDL.
  10   10  .\"

  11   11  .\"
  12   12  .\" Copyright 2015 Joyent, Inc.
  13   13  .\"
  14   14  .Dd May 11, 2016
  15   15  .Dt PLWP_GETASRS 3PROC
  16   16  .Os
  17   17  .Sh NAME
  18   18  .Nm Plwp_getasrs ,
  19   19  .Nm Plwp_setasrs
  20   20  .Nd get and set SPARCv9 ancillary state registers
  21      -.Sh SYNOPSIS
       21 +.Sh LIBRARY
  22   22  .Lb libproc
       23 +.Sh SYNOPSIS
  23   24  .In libproc.h
  24   25  .Ft int
  25   26  .Fo Plwp_getasrs
  26   27  .Fa "struct ps_prochandle *P"
  27   28  .Fa "lwpid_t lwpid"
  28   29  .Fa "asrset_t asrs"
  29   30  .Fc
  30   31  .Ft int
  31   32  .Fo Plwp_setasrs
  32   33  .Fa "struct ps_prochandle *P"

  33   34  .Fa "lwpid_t lwpid"
  34   35  .Fa "const asrset_t asrs"
  35   36  .Fc
  36   37  .Sh DESCRIPTION
  37   38  The
  38   39  .Fn Plwp_getasrs
  39   40  and
  40   41  .Fn Plwp_setasrs
  41   42  functions get and set the ancillary thread-specific register set of the
  42   43  thread
  43   44  .Fa lwpid
  44   45  in the process handle
  45   46  .Fa P .
  46   47  .Pp
  47   48  The ancillary state registers are only present on 64-bit
  48   49  .Sy SPARCv9
  49   50  processes.
  50   51  They contain information that is specific to the platform and are not included
  51   52  in the information obtained through functions such as
  52   53  .Xr Plwp_getregs 3PROC ,
  53   54  .Xr Plwp_getfpregs 3PROC ,
  54   55  and
  55   56  .Xr Plwp_getxregs 3PROC .
  56   57  .Pp
  57   58  The
  58   59  .Fn Plwp_getasrs
  59   60  function reads the ancillary registers into
  60   61  .Fa asrs ,
  61   62  while the
  62   63  .Fn Plwp_setasrs
  63   64  sets the thread's ancillary registers to the values provided by
  64   65  .Fa asrs .
  65   66  .Pp
  66   67  Processes should be stopped prior to obtaining the register state of
  67   68  individual threads.
  68   69  Processes may be stopped with
  69   70  .Xr Pstop 3PROC .
  70   71  .Pp
  71   72  The
  72   73  .Sy asrset_t
  73   74  structure is described in
  74   75  .Xr proc 4 .
  75   76  .Pp
  76   77  One may not set the register values of a process that is not an active
  77   78  process, e.g. a process handle that refers to a file or a core file.
  78   79  .Sh RETURN VALUES
  79   80  Upon successful completion, the
  80   81  .Fn Plwp_getasrs
  81   82  and
  82   83  .Fn Plwp_setasrs
  83   84  functions return
  84   85  .Sy 0
  85   86  and get or set the register state.
  86   87  Otherwise,
  87   88  .Sy -1
  88   89  is returned and
  89   90  .Sy errno
  90   91  is set to indicate the error.
  91   92  .Sh ERRORS
  92   93  For a full list of possible errors see the
  93   94  .Sy DIAGNOSTICS
  94   95  section in
  95   96  .Xr proc 4 .
  96   97  .Pp
  97   98  The
  98   99  .Fn Plwp_getasrs
  99  100  and
 100  101  .Fn Plwp_setasrs
 101  102  function will fail if:
 102  103  .Bl -tag -width Er
 103  104  .It Er ENODATA
 104  105  The process handle
 105  106  .Fa P
 106  107  does not have any ancillary register state information.
 107  108  .It Er EBUSY
 108  109  The process handle
 109  110  .Fa P
 110  111  refers to a live process and it is not stopped.
 111  112  .It Er ENOENT
 112  113  The process handle
 113  114  .Fa P
 114  115  refers to a live process and there is no thread with id
 115  116  .Fa lwpid
 116  117  or it is not a 64-bit SPARCv9 process.
 117  118  .It Er EINVAL
 118  119  The process handle
 119  120  .Fa P
 120  121  refers to a core file and there is no thread with id
 121  122  .Fa lwpid .
 122  123  .El
 123  124  .Sh ARCHITECTURE
 124  125  The
 125  126  .Fn Plwp_getasrs
 126  127  and
 127  128  .Fn Plwp_setasrs
 128  129  functions are only available on
 129  130  64-bit
 130  131  .Sy SPARCv9
 131  132  platforms.
 132  133  .Sh INTERFACE STABILITY
 133  134  .Sy Uncommitted
 134  135  .Sh MT-LEVEL
 135  136  See
 136  137  .Sy LOCKING
 137  138  in
 138  139  .Xr libproc 3LIB .
 139  140  .Sh SEE ALSO
 140  141  .Xr libproc 3LIB ,
 141  142  .Xr Plwp_getfpregs 3PROC ,
 142  143  .Xr Plwp_getregs 3PROC ,
 143  144  .Xr Plwp_setregs 3PROC ,
 144  145  .Xr Plwp_setregs 3PROC ,
 145  146  .Xr Pstop 3PROC ,
 146  147  .Xr proc 4

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX