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