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

          --- old/usr/src/man/man3proc/Pdelbkpt.3proc
          +++ new/usr/src/man/man3proc/Pdelbkpt.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 PDELBKPT 3PROC
  16   16  .Os
  17   17  .Sh NAME
  18   18  .Nm Pdelbkpt
  19   19  .Nd clear a breakpoint in a process
  20      -.Sh SYNOPSIS
       20 +.Sh LIBRARY
  21   21  .Lb libproc
       22 +.Sh SYNOPSIS
  22   23  .In libproc.h
  23   24  .Ft int
  24   25  .Fo Pdelbkpt
  25   26  .Fa "struct ps_prochandle *P"
  26   27  .Fa "uintptr_t address"
  27   28  .Fa "ulong_t saved"
  28   29  .Fc
  29   30  .Sh DESCRIPTION
  30   31  The
  31   32  .Fn Pdelbkpt

  32   33  function removes the breakpoint installed at
  33   34  .Fa address
  34   35  from process
  35   36  .Fa P .
  36   37  Restoring the instruction present in
  37   38  .Fa saved .
  38   39  .Pp
  39   40  If the instruction at
  40   41  .Fa address
  41   42  is no longer the architecture-specific breakpoint instruction, then
  42   43  .Fa saved
  43   44  is not restored, but the function still returns successfully.
  44   45  This behavior is done due to the presence of setting breakpoints in
  45   46  self-modifying code, e.g. procedure linkage tables.
  46   47  .Pp
  47   48  The
  48   49  .Fn Pdelbkpt
  49   50  function only works on running processes, such as those created through
  50   51  .Xr Pgrab 3PROC
  51   52  and
  52   53  .Xr Pcreate 3PROC .
  53   54  Attempting to remove a breakpoint from process handles to core files,
  54   55  zombie processes, or ELF objects will fail.
  55   56  .Sh RETURN VALUES
  56   57  Upon successful completion, the
  57   58  .Fn Pdelbkpt
  58   59  function removes the breakpoint and
  59   60  returns
  60   61  .Sy 0 .
  61   62  Otherwise,
  62   63  .Sy -1
  63   64  is returned, and
  64   65  .Sy errno
  65   66  is set to indicate the error.
  66   67  .Sh ERRORS
  67   68  For a full list of possible errors see the
  68   69  .Sy DIAGNOSTICS
  69   70  section in
  70   71  .Xr proc 4 .
  71   72  .Pp
  72   73  The
  73   74  .Fn Pdelbkpt
  74   75  function will fail with:
  75   76  .Bl -tag -width Er
  76   77  .It Er ENOENT
  77   78  The handle
  78   79  .Fa P
  79   80  refers to a grabbed core file, a zombie process, or an ELF object.
  80   81  .El
  81   82  .Sh INTERFACE STABILITY
  82   83  .Sy Uncommitted
  83   84  .Sh MT-LEVEL
  84   85  See
  85   86  .Sy LOCKING
  86   87  in
  87   88  .Xr libproc 3LIB .
  88   89  .Sh SEE ALSO
  89   90  .Xr libproc 3LIB ,
  90   91  .Xr Pcreate 3PROC ,
  91   92  .Xr Pgrab 3PROC ,
  92   93  .Xr Pgrab_core 3PROC ,
  93   94  .Xr Pgrab_file 3PROC ,
  94   95  .Xr Psetbkpt 3PROC ,
  95   96  .Xr proc 4

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX