share/man/man3proc/Prd_agent.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 PRD_AGENT 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm Prd_agent
  19 .Nd get librtld_db agent
  20 .Sh SYNOPSIS
  21 .Lb libproc
  22 .In libproc.h
  23 .Ft "rd_agent_t *"
  24 .Fo Prd_agent
  25 .Fa "struct ps_prochandle *P"
  26 .Fc
  27 .Sh DESCRIPTION
  28 The
  29 .Fn Prd_agent
  30 function returns a pointer to an agent suitable for use with the
  31 run-time link editing database library,
  32 .Xr librtld_db 3LIB ,
  33 corresponding to the process handle
  34 .Fa P .
  35 .Pp
  36 The returned agent is valid until either the process handle executes a
  37 new process image through the
  38 .Xr exec 2
  39 family of calls or the process handle
  40 .Fa P
  41 is released through a call to
  42 .Xr Prelease 3PROC .
  43 .Sh RETURN VALUES
  44 Upon successful completion, the
  45 .Fn Prd_agent
  46 function returns a pointer to the librtld_db agent.
  47 Otherwise, it returns
  48 .Dv NULL
  49 to indicate failure.
  50 .Sh INTERFACE STABILITY
  51 .Sy Uncommitted
  52 .Sh MT-LEVEL
  53 See
  54 .Sy LOCKING
  55 in
  56 .Xr libproc 3LIB .
  57 .Sh SEE ALSO
  58 .Xr exec 2 ,
  59 .Xr libproc 3LIB ,
  60 .Xr librtld_db 3LIB ,
  61 .Xr proc 4