8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3proc / Ppltdest.3proc
blob56eea82f85e5d4ed710a4a5fde48a8b78b6159d8
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 PPLTDEST 3PROC
16 .Os
17 .Sh NAME
18 .Nm Ppltdest
19 .Nd determine PLT destination symbol
20 .Sh SYNOPSIS
21 .Lb libproc
22 .In libproc.h
23 .Ft "const char *"
24 .Fo Ppltdest
25 .Fa "struct ps_prochandle *P"
26 .Fa "uintptr_t addr"
27 .Fc
28 .Sh DESCRIPTION
29 The
30 .Fn Ppltdest
31 function determines if the address at
32 .Fa addr
33 in the process handle
34 .Fa P
35 corresponds to an entry in the procedure linkage table (PLT) and if so,
36 returns a pointer to a null-terminated character string that contains
37 the symbol's name.
38 The returned pointer is not valid after any other calls to function in
39 .Xr libproc 3LIB .
40 The
41 .Fn Ppltdest
42 is also a useful way to determine if
43 .Fa addr
44 corresponds to an address in the PLT.
45 .Sh RETURN VALUES
46 Upon successful completion, the
47 .Fn Ppltdest
48 returns a pointer to a character string with the name.
49 Otherwise,
50 .Dv NULL
51 is returned.
52 .Sh INTERFACE STABILITY
53 .Sy Uncommitted
54 .Sh MT-LEVEL
55 See
56 .Sy LOCKING
58 .Xr libproc 3LIB .
59 .Sh SEE ALSO
60 .Xr libproc 3LIB
61 .Rs
62 .%T Linkers and Libraries Guide
63 .Re