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