usr/src/man/man3proc/Plmid.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 PLMID 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm Plmid
  19 .Nd get the link-map identifier of an address
  20 .Sh SYNOPSIS
  21 .Lb libproc
  22 .In libproc.h
  23 .Ft int
  24 .Fo Plmid
  25 .Fa "struct ps_prochandle *P"
  26 .Fa "uintptr_t addr"
  27 .Fa "Lmid_t *lmidp"
  28 .Fc
  29 .Sh DESCRIPTION
  30 The
  31 .Fn Plmid
  32 function attempts to determine the link-map identifier that corresponds
  33 to the address
  34 .Fa addr
  35 in the process
  36 .Fa P .
  37 If
  38 .Fa addr
  39 does not correspond to an address from an object mapped in by the
  40 run-time link editor, such as anonymous mapping created with
  41 .Xr mmap 2 ,
  42 then there will be no corresponding link-map identifier.
  43 .Pp
  44 .Fa lmidp
  45 must be a
  46 .Pf non- Dv NULL
  47 pointer that will be filled in with the link-map identifier when it is
  48 successfully determined by the run-time link-editor.
  49 .Sh RETURN VALUES
  50 Upon successful completion, the
  51 .Fn Plmid
  52 function returns
  53 .Sy 0
  54 and updates
  55 .Fa lmidp
  56 with the link-map identifier of
  57 .Fa addr .
  58 Otherwise,
  59 .Sy -1
  60 is returned to indicate that the link-map identifier could not be
  61 determined.
  62 .Sh INTERFACE STABILITY
  63 .Sy Uncommitted
  64 .Sh MT-LEVEL
  65 See
  66 .Sy LOCKING
  67 in
  68 .Xr libproc 3LIB .
  69 .Sh SEE ALSO
  70 .Xr libproc 3LIB ,
  71 .Xr proc 4