/* User functions for run-time dynamic loading.

[0] Fix | Delete

Copyright (C) 1995-2018 Free Software Foundation, Inc.

[1] Fix | Delete

This file is part of the GNU C Library.

[2] Fix | Delete

[3] Fix | Delete

The GNU C Library is free software; you can redistribute it and/or

[4] Fix | Delete

modify it under the terms of the GNU Lesser General Public

[5] Fix | Delete

License as published by the Free Software Foundation; either

[6] Fix | Delete

version 2.1 of the License, or (at your option) any later version.

[7] Fix | Delete

[8] Fix | Delete

The GNU C Library is distributed in the hope that it will be useful,

[9] Fix | Delete

but WITHOUT ANY WARRANTY; without even the implied warranty of

[10] Fix | Delete

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

[11] Fix | Delete

Lesser General Public License for more details.

[12] Fix | Delete

[13] Fix | Delete

You should have received a copy of the GNU Lesser General Public

[14] Fix | Delete

License along with the GNU C Library; if not, see

[15] Fix | Delete

<http://www.gnu.org/licenses/>. */

[16] Fix | Delete

[17] Fix | Delete

#ifndef _DLFCN_H

[18] Fix | Delete

#define _DLFCN_H 1

[19] Fix | Delete

[20] Fix | Delete

#include <features.h>

[21] Fix | Delete

#define __need_size_t

[22] Fix | Delete

#include <stddef.h>

[23] Fix | Delete

[24] Fix | Delete

/* Collect various system dependent definitions and declarations. */

[25] Fix | Delete

#include <bits/dlfcn.h>

[26] Fix | Delete

[27] Fix | Delete

[28] Fix | Delete

#ifdef __USE_GNU

[29] Fix | Delete

/* If the first argument of `dlsym' or `dlvsym' is set to RTLD_NEXT

[30] Fix | Delete

the run-time address of the symbol called NAME in the next shared

[31] Fix | Delete

object is returned. The "next" relation is defined by the order

[32] Fix | Delete

the shared objects were loaded. */

[33] Fix | Delete

# define RTLD_NEXT ((void *) -1l)

[34] Fix | Delete

[35] Fix | Delete

/* If the first argument to `dlsym' or `dlvsym' is set to RTLD_DEFAULT

[36] Fix | Delete

the run-time address of the symbol called NAME in the global scope

[37] Fix | Delete

is returned. */

[38] Fix | Delete

# define RTLD_DEFAULT ((void *) 0)

[39] Fix | Delete

[40] Fix | Delete

[41] Fix | Delete

/* Type for namespace indeces. */

[42] Fix | Delete

typedef long int Lmid_t;

[43] Fix | Delete

[44] Fix | Delete

/* Special namespace ID values. */

[45] Fix | Delete

# define LM_ID_BASE 0 /* Initial namespace. */

[46] Fix | Delete

# define LM_ID_NEWLM -1 /* For dlmopen: request new namespace. */

[47] Fix | Delete

#endif

[48] Fix | Delete

[49] Fix | Delete

[50] Fix | Delete

__BEGIN_DECLS

[51] Fix | Delete

[52] Fix | Delete

/* Open the shared object FILE and map it in; return a handle that can be

[53] Fix | Delete

passed to `dlsym' to get symbol values from it. */

[54] Fix | Delete

extern void *dlopen (const char *__file, int __mode) __THROWNL;

[55] Fix | Delete

[56] Fix | Delete

/* Unmap and close a shared object opened by `dlopen'.

[57] Fix | Delete

The handle cannot be used again after calling `dlclose'. */

[58] Fix | Delete

extern int dlclose (void *__handle) __THROWNL __nonnull ((1));

[59] Fix | Delete

[60] Fix | Delete

/* Find the run-time address in the shared object HANDLE refers to

[61] Fix | Delete

of the symbol called NAME. */

[62] Fix | Delete

extern void *dlsym (void *__restrict __handle,

[63] Fix | Delete

const char *__restrict __name) __THROW __nonnull ((2));

[64] Fix | Delete

[65] Fix | Delete

#ifdef __USE_GNU

[66] Fix | Delete

/* Like `dlopen', but request object to be allocated in a new namespace. */

[67] Fix | Delete

extern void *dlmopen (Lmid_t __nsid, const char *__file, int __mode) __THROWNL;

[68] Fix | Delete

[69] Fix | Delete

/* Find the run-time address in the shared object HANDLE refers to

[70] Fix | Delete

of the symbol called NAME with VERSION. */

[71] Fix | Delete

extern void *dlvsym (void *__restrict __handle,

[72] Fix | Delete

const char *__restrict __name,

[73] Fix | Delete

const char *__restrict __version)

[74] Fix | Delete

__THROW __nonnull ((2, 3));

[75] Fix | Delete

#endif

[76] Fix | Delete

[77] Fix | Delete

/* When any of the above functions fails, call this function

[78] Fix | Delete

to return a string describing the error. Each call resets

[79] Fix | Delete

the error string so that a following call returns null. */

[80] Fix | Delete

extern char *dlerror (void) __THROW;

[81] Fix | Delete

[82] Fix | Delete

[83] Fix | Delete

#ifdef __USE_GNU

[84] Fix | Delete

/* Structure containing information about object searched using

[85] Fix | Delete

`dladdr'. */

[86] Fix | Delete

typedef struct

[87] Fix | Delete

{

[88] Fix | Delete

const char *dli_fname; /* File name of defining object. */

[89] Fix | Delete

void *dli_fbase; /* Load address of that object. */

[90] Fix | Delete

const char *dli_sname; /* Name of nearest symbol. */

[91] Fix | Delete

void *dli_saddr; /* Exact value of nearest symbol. */

[92] Fix | Delete

} Dl_info;

[93] Fix | Delete

[94] Fix | Delete

/* Fill in *INFO with the following information about ADDRESS.

[95] Fix | Delete

Returns 0 iff no shared object's segments contain that address. */

[96] Fix | Delete

extern int dladdr (const void *__address, Dl_info *__info)

[97] Fix | Delete

__THROW __nonnull ((2));

[98] Fix | Delete

[99] Fix | Delete

/* Same as `dladdr', but additionally sets *EXTRA_INFO according to FLAGS. */

[100] Fix | Delete

extern int dladdr1 (const void *__address, Dl_info *__info,

[101] Fix | Delete

void **__extra_info, int __flags) __THROW __nonnull ((2));

[102] Fix | Delete

[103] Fix | Delete

/* These are the possible values for the FLAGS argument to `dladdr1'.

[104] Fix | Delete

This indicates what extra information is stored at *EXTRA_INFO.

[105] Fix | Delete

It may also be zero, in which case the EXTRA_INFO argument is not used. */

[106] Fix | Delete

enum

[107] Fix | Delete

{

[108] Fix | Delete

/* Matching symbol table entry (const ElfNN_Sym *). */

[109] Fix | Delete

RTLD_DL_SYMENT = 1,

[110] Fix | Delete

[111] Fix | Delete

/* The object containing the address (struct link_map *). */

[112] Fix | Delete

RTLD_DL_LINKMAP = 2

[113] Fix | Delete

};

[114] Fix | Delete

[115] Fix | Delete

[116] Fix | Delete

/* Get information about the shared object HANDLE refers to.

[117] Fix | Delete

REQUEST is from among the values below, and determines the use of ARG.

[118] Fix | Delete

[119] Fix | Delete

On success, returns zero. On failure, returns -1 and records an error

[120] Fix | Delete

message to be fetched with `dlerror'. */

[121] Fix | Delete

extern int dlinfo (void *__restrict __handle,

[122] Fix | Delete

int __request, void *__restrict __arg)

[123] Fix | Delete

__THROW __nonnull ((1, 3));

[124] Fix | Delete

[125] Fix | Delete

/* These are the possible values for the REQUEST argument to `dlinfo'. */

[126] Fix | Delete

enum

[127] Fix | Delete

{

[128] Fix | Delete

/* Treat ARG as `lmid_t *'; store namespace ID for HANDLE there. */

[129] Fix | Delete

RTLD_DI_LMID = 1,

[130] Fix | Delete

[131] Fix | Delete

/* Treat ARG as `struct link_map **';

[132] Fix | Delete

store the `struct link_map *' for HANDLE there. */

[133] Fix | Delete

RTLD_DI_LINKMAP = 2,

[134] Fix | Delete

[135] Fix | Delete

RTLD_DI_CONFIGADDR = 3, /* Unsupported, defined by Solaris. */

[136] Fix | Delete

[137] Fix | Delete

/* Treat ARG as `Dl_serinfo *' (see below), and fill in to describe the

[138] Fix | Delete

directories that will be searched for dependencies of this object.

[139] Fix | Delete

RTLD_DI_SERINFOSIZE fills in just the `dls_cnt' and `dls_size'

[140] Fix | Delete

entries to indicate the size of the buffer that must be passed to

[141] Fix | Delete

RTLD_DI_SERINFO to fill in the full information. */

[142] Fix | Delete

RTLD_DI_SERINFO = 4,

[143] Fix | Delete

RTLD_DI_SERINFOSIZE = 5,

[144] Fix | Delete

[145] Fix | Delete

/* Treat ARG as `char *', and store there the directory name used to

[146] Fix | Delete

expand $ORIGIN in this shared object's dependency file names. */

[147] Fix | Delete

RTLD_DI_ORIGIN = 6,

[148] Fix | Delete

[149] Fix | Delete

RTLD_DI_PROFILENAME = 7, /* Unsupported, defined by Solaris. */

[150] Fix | Delete

RTLD_DI_PROFILEOUT = 8, /* Unsupported, defined by Solaris. */

[151] Fix | Delete

[152] Fix | Delete

/* Treat ARG as `size_t *', and store there the TLS module ID

[153] Fix | Delete

of this object's PT_TLS segment, as used in TLS relocations;

[154] Fix | Delete

store zero if this object does not define a PT_TLS segment. */

[155] Fix | Delete

RTLD_DI_TLS_MODID = 9,

[156] Fix | Delete

[157] Fix | Delete

/* Treat ARG as `void **', and store there a pointer to the calling

[158] Fix | Delete

thread's TLS block corresponding to this object's PT_TLS segment.

[159] Fix | Delete

Store a null pointer if this object does not define a PT_TLS

[160] Fix | Delete

segment, or if the calling thread has not allocated a block for it. */

[161] Fix | Delete

RTLD_DI_TLS_DATA = 10,

[162] Fix | Delete

[163] Fix | Delete

/* Treat ARG as const ElfW(Phdr) **, and store the address of the

[164] Fix | Delete

program header array at that location. The dlinfo call returns

[165] Fix | Delete

the number of program headers in the array. */

[166] Fix | Delete

RTLD_DI_PHDR = 11,

[167] Fix | Delete

[168] Fix | Delete

RTLD_DI_MAX = 11

[169] Fix | Delete

};

[170] Fix | Delete

[171] Fix | Delete

[172] Fix | Delete

/* This is the type of elements in `Dl_serinfo', below.

[173] Fix | Delete

The `dls_name' member points to space in the buffer passed to `dlinfo'. */

[174] Fix | Delete

typedef struct

[175] Fix | Delete

{

[176] Fix | Delete

char *dls_name; /* Name of library search path directory. */

[177] Fix | Delete

unsigned int dls_flags; /* Indicates where this directory came from. */

[178] Fix | Delete

} Dl_serpath;

[179] Fix | Delete

[180] Fix | Delete

/* This is the structure that must be passed (by reference) to `dlinfo' for

[181] Fix | Delete

the RTLD_DI_SERINFO and RTLD_DI_SERINFOSIZE requests. */

[182] Fix | Delete

typedef struct

[183] Fix | Delete

{

[184] Fix | Delete

size_t dls_size; /* Size in bytes of the whole buffer. */

[185] Fix | Delete

unsigned int dls_cnt; /* Number of elements in `dls_serpath'. */

[186] Fix | Delete

Dl_serpath dls_serpath[1]; /* Actually longer, dls_cnt elements. */

[187] Fix | Delete

} Dl_serinfo;

[188] Fix | Delete

#endif /* __USE_GNU */

[189] Fix | Delete

[190] Fix | Delete

[191] Fix | Delete

__END_DECLS

[192] Fix | Delete

[193] Fix | Delete

#endif /* dlfcn.h */

[194] Fix | Delete

[195] Fix | Delete