summaryrefslogtreecommitdiffstats
path: root/man7/rtld-audit.7
diff options
context:
space:
mode:
Diffstat (limited to 'man7/rtld-audit.7')
-rw-r--r--man7/rtld-audit.772
1 files changed, 36 insertions, 36 deletions
diff --git a/man7/rtld-audit.7 b/man7/rtld-audit.7
index df04a8c..67678b4 100644
--- a/man7/rtld-audit.7
+++ b/man7/rtld-audit.7
@@ -5,7 +5,7 @@
.\"
.\" 2009-01-12, mtk, Created
.\"
-.TH RTLD-AUDIT 7 2023-05-03 "Linux man-pages 6.05.01"
+.TH RTLD-AUDIT 7 2023-10-31 "Linux man-pages 6.7"
.SH NAME
rtld\-audit \- auditing API for the dynamic linker
.SH SYNOPSIS
@@ -21,14 +21,14 @@ This API is very similar to the auditing interface provided by the
Solaris run-time linker.
The necessary constants and prototypes are defined by including
.IR <link.h> .
-.PP
+.P
To use this interface, the programmer creates a shared library
that implements a standard set of function names.
Not all of the functions need to be implemented: in most cases,
if the programmer is not interested in a particular class of auditing event,
then no implementation needs to be provided for the corresponding
auditing function.
-.PP
+.P
To employ the auditing interface, the environment variable
.B LD_AUDIT
must be defined to contain a colon-separated list of shared libraries,
@@ -41,7 +41,7 @@ in the order that the libraries are listed.
.nf
.BI "unsigned int la_version(unsigned int " version );
.fi
-.PP
+.P
This is the only function that
.I must
be defined by an auditing library:
@@ -50,7 +50,7 @@ the auditing library.
When invoking this function, the dynamic linker passes, in
.IR version ,
the highest version of the auditing interface that the linker supports.
-.PP
+.P
A typical implementation of this function simply returns the constant
.BR LAV_CURRENT ,
which indicates the version of
@@ -61,7 +61,7 @@ not support this version of the audit interface, it will refuse to
activate this audit module.
If the function returns zero, the dynamic
linker also does not activate this audit module.
-.PP
+.P
In order to enable backwards compatibility with older dynamic linkers,
an audit module can examine the
.I version
@@ -83,7 +83,7 @@ definitions used to build the audit module.
.BI "char *la_objsearch(const char *" name ", uintptr_t *" cookie ,
.BI " unsigned int " flag );
.fi
-.PP
+.P
The dynamic linker invokes this function to inform the auditing library
that it is about to search for a shared object.
The
@@ -130,7 +130,7 @@ was found via a search of one of the default directories.
.B LA_SER_SECURE
.I name
is specific to a secure object (unused on Linux).
-.PP
+.P
As its function result,
.BR la_objsearch ()
returns the pathname that the dynamic linker should use
@@ -144,7 +144,7 @@ should be returned.
.nf
.BI "void la_activity( uintptr_t *" cookie ", unsigned int "flag );
.fi
-.PP
+.P
The dynamic linker calls this function to inform the auditing library
that link-map activity is occurring.
.I cookie
@@ -167,7 +167,7 @@ Link-map activity has been completed: the map is once again consistent.
.BI "unsigned int la_objopen(struct link_map *" map ", Lmid_t " lmid ,
.BI " uintptr_t *" cookie );
.fi
-.PP
+.P
The dynamic linker calls this function when a new shared object is loaded.
The
.I map
@@ -182,7 +182,7 @@ Link map is part of the initial namespace.
.B LM_ID_NEWLM
Link map is part of a new namespace requested via
.BR dlmopen (3).
-.PP
+.P
.I cookie
is a pointer to an identifier for this object.
The identifier is provided to later calls to functions
@@ -190,7 +190,7 @@ in the auditing library in order to identify this object.
This identifier is initialized to point to object's link map,
but the audit library can change the identifier to some other value
that it may prefer to use to identify the object.
-.PP
+.P
As its return value,
.BR la_objopen ()
returns a bit mask created by ORing zero or more of the
@@ -203,7 +203,7 @@ Audit symbol bindings to this object.
.TP
.B LA_FLG_BINDFROM
Audit symbol bindings from this object.
-.PP
+.P
A return value of 0 from
.BR la_objopen ()
indicates that no symbol bindings should be audited for this object.
@@ -212,7 +212,7 @@ indicates that no symbol bindings should be audited for this object.
.nf
.BI "unsigned int la_objclose(uintptr_t *" cookie );
.fi
-.PP
+.P
The dynamic linker invokes this function after any finalization
code for the object has been executed,
before the object is unloaded.
@@ -220,7 +220,7 @@ The
.I cookie
argument is the identifier obtained from a previous invocation of
.BR la_objopen ().
-.PP
+.P
In the current implementation, the value returned by
.BR la_objclose ()
is ignored.
@@ -229,7 +229,7 @@ is ignored.
.nf
.BI "void la_preinit(uintptr_t *" cookie );
.fi
-.PP
+.P
The dynamic linker invokes this function after all shared objects
have been loaded, before control is passed to the application
(i.e., before calling
@@ -248,7 +248,7 @@ may still later dynamically load objects using
.BI " uintptr_t *" refcook ", uintptr_t *" defcook ,
.BI " unsigned int *" flags ", const char *" symname );
.fi
-.PP
+.P
The dynamic linker invokes one of these functions
when a symbol binding occurs between two shared objects
that have been marked for auditing notification by
@@ -259,7 +259,7 @@ function is employed on 32-bit platforms;
the
.BR la_symbind64 ()
function is employed on 64-bit platforms.
-.PP
+.P
The
.I sym
argument is a pointer to a structure
@@ -269,12 +269,12 @@ The structure definition is shown in
Among the fields of this structure,
.I st_value
indicates the address to which the symbol is bound.
-.PP
+.P
The
.I ndx
argument gives the index of the symbol in the symbol table
of the bound shared object.
-.PP
+.P
The
.I refcook
argument identifies the shared object that is making the symbol reference;
@@ -289,11 +289,11 @@ this is the same identifier that is provided to the
.BR la_objopen ()
function that returned
.BR LA_FLG_BINDTO .
-.PP
+.P
The
.I symname
argument points a string containing the name of the symbol.
-.PP
+.P
The
.I flags
argument is a bit mask that both provides information about the symbol
@@ -310,7 +310,7 @@ The binding resulted from a call to
A previous
.BR la_symbind* ()
call returned an alternate value for this symbol.
-.PP
+.P
By default, if the auditing library implements
.BR la_pltenter ()
and
@@ -334,7 +334,7 @@ for this symbol.
Don't call
.BR la_pltexit ()
for this symbol.
-.PP
+.P
The return value of
.BR la_symbind32 ()
and
@@ -351,17 +351,17 @@ depend on the hardware platform.
(The appropriate definition is supplied by
.IR <link.h> .)
Here is the definition for x86-32:
-.PP
+.P
.nf
.BI "Elf32_Addr la_i86_gnu_pltenter(Elf32_Sym *" sym ", unsigned int " ndx ,
.BI " uintptr_t *" refcook ", uintptr_t *" defcook ,
.BI " La_i86_regs *" regs ", unsigned int *" flags ,
.BI " const char *" symname ", long *" framesizep );
.fi
-.PP
+.P
This function is invoked just before a PLT entry is called,
between two shared objects that have been marked for binding notification.
-.PP
+.P
The
.IR sym ,
.IR ndx ,
@@ -371,20 +371,20 @@ and
.I symname
are as for
.BR la_symbind* ().
-.PP
+.P
The
.I regs
argument points to a structure (defined in
.IR <link.h> )
containing the values of registers to be used for
the call to this PLT entry.
-.PP
+.P
The
.I flags
argument points to a bit mask that conveys information about,
and can be used to modify subsequent auditing of, this PLT entry, as for
.BR la_symbind* ().
-.PP
+.P
.\" FIXME . Is the following correct?
The
.I framesizep
@@ -400,7 +400,7 @@ The
.BR la_pltexit ()
function is called only if this buffer is
explicitly set to a suitable value.
-.PP
+.P
The return value of
.BR la_pltenter ()
is as for
@@ -411,20 +411,20 @@ depend on the hardware platform.
(The appropriate definition is supplied by
.IR <link.h> .)
Here is the definition for x86-32:
-.PP
+.P
.nf
.BI "unsigned int la_i86_gnu_pltexit(Elf32_Sym *" sym ", unsigned int " ndx ,
.BI " uintptr_t *" refcook ", uintptr_t *" defcook ,
.BI " const La_i86_regs *" inregs ", La_i86_retval *" outregs ,
.BI " const char *" symname );
.fi
-.PP
+.P
This function is called when a PLT entry,
made between two shared objects that have been marked
for binding notification, returns.
The function is called just before control returns to the caller
of the PLT entry.
-.PP
+.P
The
.IR sym ,
.IR ndx ,
@@ -434,7 +434,7 @@ and
.I symname
are as for
.BR la_symbind* ().
-.PP
+.P
The
.I inregs
argument points to a structure (defined in
@@ -447,7 +447,7 @@ argument points to a structure (defined in
containing return values for the call to this PLT entry.
These values can be modified by the caller,
and the changes will be visible to the caller of the PLT entry.
-.PP
+.P
In the current GNU implementation, the return value of
.BR la_pltexit ()
is ignored.