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