8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3proc / Pupdate_syms.3proc
blob9e6e819aa5fb2cf32e41b75954becb8e9442c07a
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 PUPDATE_SYMS 3PROC
16 .Os
17 .Sh NAME
18 .Nm Pupdate_syms
19 .Nd update cached symbol tables
20 .Sh SYNOPSIS
21 .Lb libproc
22 .In libproc.h
23 .Ft void
24 .Fo Pupdate_syms
25 .Fa "struct ps_prochandle *P"
26 .Fc
27 .Sh DESCRIPTION
28 The
29 .Fn Pupdate_syms
30 function is used to update all of the cached symbol tables in the
31 process handle
32 .Fa P :
33 updating, invalidating, and caching new symbol tables as appropriate for
34 functions such as
35 .Xr Psymbol_iter 3PROC .
36 This is generally called in response to activity by the run-time
37 link-editor.
38 In general, the
39 .Sy libproc
40 library takes care of managing the need to call this function;
41 however, debuggers, introspection tools, and others that are
42 interposing on rtld activity may need to call this function.
43 Note that the
44 .Fn Pupdate_syms
45 function is only meaningful for active processes.
46 It will do nothing on process handles that refer to core files, zombie
47 processes, and ELF objects.
48 .Sh INTERFACE STABILITY
49 .Sy Uncommitted
50 .Sh MT-LEVEL
51 See
52 .Sy LOCKING
54 .Xr libproc 3LIB .
55 .Sh SEE ALSO
56 .Xr libproc 3LIB ,
57 .Xr Pupdate_maps 3PROC