usr/src/man/man3ext/rtld_db.3ext

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH RTLD_DB 3EXT "Oct 12, 2007"
   7 .SH NAME
   8 rtld_db, rd_delete, rd_errstr, rd_event_addr, rd_event_enable, rd_event_getmsg,
   9 rd_init, rd_loadobj_iter, rd_log, rd_new, rd_objpad_enable, rd_plt_resolution,
  10 rd_reset \- runtime linker debugging functions
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 cc [ \fIflag\fR ... ] \fIfile\fR ... \fB-lrtld_db\fR [ \fIlibrary\fR ... ]
  15 #include <proc_service.h>
  16 #include <rtld_db.h>
  17
  18 \fBvoid\fR \fBrd_delete\fR(\fBstruct rd_agent *\fR\fIrdap\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBchar *\fR\fBrd_errstr\fR(\fBrd_err_e\fR \fIrderr\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBrd_err_e\fR \fBrd_event_addr\fR(\fBrd_agent *\fR\fIrdap\fR, \fBrd_notify_t *\fR\fInotify\fR);
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBrd_err_e\fR \fBrd_event_enable\fR(\fBstruct rd_agent *\fR\fIrdap\fR, \fBint\fR \fIonoff\fR);
  34 .fi
  35
  36 .LP
  37 .nf
  38 \fBrd_err_e\fR \fBrd_event_getmsg\fR(\fBstruct rd_agent *\fR\fIrdap\fR,
  39      \fBrd_event_msg_t *\fR\fImsg\fR);
  40 .fi
  41
  42 .LP
  43 .nf
  44 \fBrd_err_e\fR \fBrd_init\fR(\fBint\fR \fIversion\fR);
  45 .fi
  46
  47 .LP
  48 .nf
  49 \fBtypedef int\fR \fBrl_iter_f\fR(\fBconst rd_loadobj_t *,\fR void *);
  50 .fi
  51
  52 .LP
  53 .nf
  54 \fBrd_err_e\fR \fBrd_loadobj_iter\fR(\fBrd_agent_t *\fR\fIrap\fR, \fBrl_iter_f *\fR\fIcb\fR,
  55      \fBvoid *\fR\fIclnt_data\fR);
  56 .fi
  57
  58 .LP
  59 .nf
  60 \fBvoid\fR \fBrd_log\fR(\fBconst int\fR \fIonoff\fR);
  61 .fi
  62
  63 .LP
  64 .nf
  65 \fBrd_agent_t *\fR\fBrd_new\fR(\fBstruct ps_prochandle *\fR\fIphp\fR);
  66 .fi
  67
  68 .LP
  69 .nf
  70 \fBrd_err_e\fR \fBrd_objpad_enable\fR(\fBstruct rd_agent *\fR\fIrdap\fR, \fBsize_t\fR \fIpadsize\fR);
  71 .fi
  72
  73 .LP
  74 .nf
  75 \fBrd_err_e\fR \fBrd_plt_resolution\fR(\fBrd_agent *\fR\fIrdap\fR, \fBpaddr_t\fR \fIpc\fR,
  76      \fBlwpid_t\fR \fIlwpid\fR, \fBpaddr_t\fR \fIplt_base\fR, \fBrd_plt_info_t *\fR\fIrpi\fR);
  77 .fi
  78
  79 .LP
  80 .nf
  81 \fBrd_err_e\fR \fBrd_reset\fR(\fBstruct rd_agent *\fR\fIrdap\fR);
  82 .fi
  83
  84 .SH DESCRIPTION
  85 .sp
  86 .LP
  87 The \fBlibrtld_db\fR library provides support for monitoring and manipulating
  88 runtime linking aspects of a program. There are at least two processes
  89 involved,  the controlling process and one  or more target processes.  The
  90 controlling process is the \fBlibrtld_db\fR client that links with
  91 \fBlibrtld_db\fR and uses \fBlibrtld_db\fR to inspect or modify runtime linking
  92 aspects of one or more target processes. See the \fILinker and Libraries
  93 Guide\fR for a full description of the runtime linker debugger interface
  94 mechanism.
  95 .SH USAGE
  96 .sp
  97 .LP
  98 To use \fBlibrtld_db\fR, applications need to implement the interfaces
  99 documented in \fBps_pread\fR(3PROC) and \fBproc_service\fR(3PROC).
 100 .SH ATTRIBUTES
 101 .sp
 102 .LP
 103 See \fBattributes\fR(5) for description of the following attributes:
 104 .sp
 105
 106 .sp
 107 .TS
 108 box;
 109 c | c
 110 l | l .
 111 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 112 _
 113 Interface Stability     Committed
 114 _
 115 MT-Level        Safe
 116 .TE
 117
 118 .SH SEE ALSO
 119 .sp
 120 .LP
 121 \fBld.so.1\fR(1), \fBlibc_db\fR(3LIB), \fBlibrtld_db\fR(3LIB),
 122 \fBproc_service\fR(3PROC), \fBps_pread\fR(3PROC), \fBattributes\fR(5)
 123 .sp
 124 .LP
 125 \fILinker and Libraries Guide\fR