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

          --- old/usr/src/man/man3proc/Paddr_to_loadobj.3proc
          +++ new/usr/src/man/man3proc/Paddr_to_loadobj.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 PADDR_TO_LOADOBJ 3PROC
  16   16  .Os
  17   17  .Sh NAME
  18   18  .Nm Paddr_to_loadobj ,
  19   19  .Nm Plmid_to_loadobj ,
  20   20  .Nm Pname_to_loadobj
  21   21  .Nd lookup loaded object information
  22      -.Sh SYNOPSIS
       22 +.Sh LIBRARY
  23   23  .Lb libproc
       24 +.Sh SYNOPSIS
  24   25  .In libproc.h
  25   26  .Ft "const rd_loadobj_t *"
  26   27  .Fo Paddr_to_loadobj
  27   28  .Fa "struct ps_prochandle *P"
  28   29  .Fa "uintptr_t addr"
  29   30  .Fc
  30   31  .Ft "const rd_loadobj_t *"
  31   32  .Fo Plmid_to_loadobj
  32   33  .Fa "struct ps_prochandle *P"
  33   34  .Fa "Lmid_t lmid"

  34   35  .Fa "const char *name"
  35   36  .Fc
  36   37  .Ft "const rd_loadobj_t *"
  37   38  .Fo Pname_to_loadobj
  38   39  .Fa "struct ps_prochandle *P"
  39   40  .Fa "const char *name"
  40   41  .Fc
  41   42  .Sh DESCRIPTION
  42   43  The
  43   44  .Fn Paddr_to_loadobj ,
  44   45  .Fn Plmid_to_loadobj ,
  45   46  and
  46   47  .Fn Pname_to_loadobj
  47   48  functions lookup loaded object information from the process handle
  48   49  .Fa P .
  49   50  This information is provided by the run-time link-editor,
  50   51  .Xr ld.so.1 1 ,
  51   52  and provides information about the loaded object such as the link-map
  52   53  identifier, the TLS module ID, and the address of various sections.
  53   54  .Pp
  54   55  The pointer to the data returned by the library will only be valid for
  55   56  as long as the handle
  56   57  .Fa P
  57   58  is valid.
  58   59  Any calls to
  59   60  .Xr Prelease 3PROC
  60   61  will invalidate the data.
  61   62  .Pp
  62   63  The
  63   64  .Fn Paddr_to_loadobj
  64   65  function attempts to find the loaded object information, if any, that exists for
  65   66  the address
  66   67  .Fa addr .
  67   68  Not all address correspond to memory regions that were loaded by the
  68   69  run-time link-editor.
  69   70  For example, if a user creates a region of anonymous memory through the
  70   71  .Xr mmap 2
  71   72  function, then it will not have any corresponding loaded module.
  72   73  .Pp
  73   74  The
  74   75  .Fn Pname_to_loadobj
  75   76  function looks up the object named
  76   77  .Fa name
  77   78  and returns the corresponding loaded object information.
  78   79  Two special values may be used for name.
  79   80  The macro
  80   81  .Dv PR_OBJ_EXEC
  81   82  refers to the executable object itself and the macro
  82   83  .Dv PR_OBJ_LDSO refers to the object ld.so.1 .
  83   84  .Pp
  84   85  The
  85   86  .Fn Plmid_to_loadobj
  86   87  function is similar to
  87   88  .Fn Pname_to_loadobj .
  88   89  It allows the use of a link-map identifier,
  89   90  .Fa lmid ,
  90   91  which constricts the search of the object named with
  91   92  .Fa name
  92   93  to that link-map.
  93   94  The special value of
  94   95  .Dv PR_LMID_EVERY
  95   96  may be passed to indicate that every link-map should be searched, which
  96   97  is equivalent in behavior to the
  97   98  .Fn Pname_to_loadobj
  98   99  function.
  99  100  .Sh RETURN VALUES
 100  101  Upon successful completion, the
 101  102  .Fn Paddr_to_loadobj ,
 102  103  .Fn Plmid_to_loadobj ,
 103  104  and
 104  105  .Fn Pname_to_loadobj
 105  106  functions return a pointer to the corresponding loadable object
 106  107  information.
 107  108  Otherwise, if none exists then
 108  109  .Dv NULL
 109  110  is returned.
 110  111  .Sh INTERFACE STABILITY
 111  112  .Sy Uncommitted
 112  113  .Sh MT-LEVEL
 113  114  See
 114  115  .Sy LOCKING
 115  116  in
 116  117  .Xr libproc 3LIB .
 117  118  .Sh SEE ALSO
 118  119  .Xr libproc 3LIB ,
 119  120  .Xr librtld_db 3LIB ,
 120  121  .Xr Prelease 3PROC

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX