include/link.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2014 Garrett D'Amore <garrett@damore.org>
  23  * Copyright (c) 1989, 2010, Oracle and/or its affiliates. All rights reserved.
  24  */
  25
  26 #ifndef _LINK_H
  27 #define _LINK_H
  28
  29 #include <sys/link.h>
  30
  31 #ifndef _ASM
  32 #include <elf.h>
  33 #include <sys/types.h>
  34 #include <dlfcn.h>
  35 #endif
  36
  37 #ifdef  __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 #ifndef _ASM
  42 /*
  43  * ld support library calls.
  44  *
  45  * These cannot be used in a 32bit large file capable environment because
  46  * libelf is not large-file safe.  Only define these interfaces if we are not
  47  * 32bit, or not in the large file environment.
  48  */
  49 #if !defined(_ILP32) || _FILE_OFFSET_BITS != 64
  50 #include <libelf.h>
  51 extern uint_t   ld_version(uint_t);
  52 extern void     ld_input_done(uint_t *);
  53
  54 extern void     ld_start(const char *, const Elf32_Half, const char *);
  55 extern void     ld_atexit(int);
  56 extern void     ld_open(const char **, const char **, int *, int, Elf **,
  57                         Elf *, size_t, const Elf_Kind);
  58 extern void     ld_file(const char *, const Elf_Kind, int, Elf *);
  59 extern void     ld_input_section(const char *, Elf32_Shdr **, Elf32_Word,
  60                         Elf_Data *, Elf *, uint_t *);
  61 extern void     ld_section(const char *, Elf32_Shdr *, Elf32_Word,
  62                         Elf_Data *, Elf *);
  63
  64 extern void     ld_start64(const char *, const Elf64_Half, const char *);
  65 extern void     ld_atexit64(int);
  66 extern void     ld_open64(const char **, const char **, int *, int, Elf **,
  67                         Elf *, size_t, const Elf_Kind);
  68 extern void     ld_file64(const char *, const Elf_Kind, int, Elf *);
  69 extern void     ld_input_section64(const char *, Elf64_Shdr **, Elf64_Word,
  70                         Elf_Data *, Elf *, uint_t *);
  71 extern void     ld_section64(const char *, Elf64_Shdr *, Elf64_Word,
  72                         Elf_Data *, Elf *);
  73
  74 #endif /* !defined(_ILP32) || _FILE_OFFSET_BITS != 64 */
  75
  76 /*
  77  * ld_version() version values.
  78  */
  79 #define LD_SUP_VNONE    0
  80 #define LD_SUP_VERSION1 1
  81 #define LD_SUP_VERSION2 2
  82 #define LD_SUP_VERSION3 3
  83 #define LD_SUP_VCURRENT LD_SUP_VERSION3
  84
  85 /*
  86  * Flags passed to ld support calls.
  87  */
  88 #define LD_SUP_DERIVED          0x1     /* derived filename */
  89 #define LD_SUP_INHERITED        0x2     /* file inherited from .so DT_NEEDED */
  90 #define LD_SUP_EXTRACTED        0x4     /* file extracted from archive */
  91 #endif
  92
  93 /*
  94  * Runtime link-map identifiers.
  95  */
  96 #define LM_ID_BASE              0x00
  97 #define LM_ID_LDSO              0x01
  98 #define LM_ID_NUM               2
  99
 100 #define LM_ID_BRAND             0xfd    /* brand emulation linkmap objs */
 101 #define LM_ID_NONE              0xfe    /* no link map specified */
 102 #define LM_ID_NEWLM             0xff    /* create a new link-map */
 103
 104 /*
 105  * Runtime Link-Edit Auditing.
 106  */
 107 #define LAV_NONE                0
 108 #define LAV_VERSION1            1
 109 #define LAV_VERSION2            2
 110 #define LAV_VERSION3            3
 111 #define LAV_VERSION4            4
 112 #define LAV_VERSION5            5
 113 #define LAV_CURRENT             LAV_VERSION5
 114 #define LAV_NUM                 6
 115
 116 /*
 117  * Flags that can be or'd into the la_objopen() return code
 118  */
 119 #define LA_FLG_BINDTO           0x0001  /* audit symbinds TO this object */
 120 #define LA_FLG_BINDFROM         0x0002  /* audit symbinding FROM this object */
 121
 122 /*
 123  * Flags that can be or'd into the 'flags' argument of la_symbind()
 124  */
 125 #define LA_SYMB_NOPLTENTER      0x0001  /* disable pltenter for this symbol */
 126 #define LA_SYMB_NOPLTEXIT       0x0002  /* disable pltexit for this symbol */
 127 #define LA_SYMB_STRUCTCALL      0x0004  /* this function call passes a */
 128                                         /*      structure as it's return code */
 129 #define LA_SYMB_DLSYM           0x0008  /* this symbol bindings is due to */
 130                                         /*      a call to dlsym() */
 131 #define LA_SYMB_ALTVALUE        0x0010  /* alternate symbol binding returned */
 132                                         /*      by la_symbind() */
 133
 134 /*
 135  * Flags that describe the object passed to la_objsearch()
 136  */
 137 #define LA_SER_ORIG             0x001   /* original (needed) name */
 138 #define LA_SER_LIBPATH          0x002   /* LD_LIBRARY_PATH entry prepended */
 139 #define LA_SER_RUNPATH          0x004   /* runpath entry prepended */
 140 #define LA_SER_CONFIG           0x008   /* configuration entry prepended */
 141 #define LA_SER_DEFAULT          0x040   /* default path prepended */
 142 #define LA_SER_SECURE           0x080   /* default (secure) path prepended */
 143
 144 #define LA_SER_MASK             0xfff   /* mask of known flags */
 145
 146 /*
 147  * Flags that describe the la_activity()
 148  */
 149 #define LA_ACT_CONSISTENT       0x00    /* add/deletion of objects complete */
 150 #define LA_ACT_ADD              0x01    /* objects being added */
 151 #define LA_ACT_DELETE           0x02    /* objects being deleted */
 152 #define LA_ACT_MAX              3
 153
 154
 155 #ifndef _KERNEL
 156 #ifndef _ASM
 157
 158 #if defined(_LP64)
 159 typedef long    lagreg_t;
 160 #else
 161 typedef int     lagreg_t;
 162 #endif
 163
 164 struct _la_sparc_regs {
 165         lagreg_t        lr_rego0;
 166         lagreg_t        lr_rego1;
 167         lagreg_t        lr_rego2;
 168         lagreg_t        lr_rego3;
 169         lagreg_t        lr_rego4;
 170         lagreg_t        lr_rego5;
 171         lagreg_t        lr_rego6;
 172         lagreg_t        lr_rego7;
 173 };
 174
 175 #if defined(_LP64)
 176 typedef struct _la_sparc_regs   La_sparcv9_regs;
 177 typedef struct {
 178         lagreg_t        lr_rsp;
 179         lagreg_t        lr_rbp;
 180         lagreg_t        lr_rdi;     /* arg1 */
 181         lagreg_t        lr_rsi;     /* arg2 */
 182         lagreg_t        lr_rdx;     /* arg3 */
 183         lagreg_t        lr_rcx;     /* arg4 */
 184         lagreg_t        lr_r8;      /* arg5 */
 185         lagreg_t        lr_r9;      /* arg6 */
 186 } La_amd64_regs;
 187 #else
 188 typedef struct _la_sparc_regs   La_sparcv8_regs;
 189 typedef struct {
 190         lagreg_t        lr_esp;
 191         lagreg_t        lr_ebp;
 192 } La_i86_regs;
 193 #endif
 194
 195 #if     !defined(_SYS_INT_TYPES_H)
 196 #if     defined(_LP64) || defined(_I32LPx)
 197 typedef unsigned long           uintptr_t;
 198 #else
 199 typedef unsigned int            uintptr_t;
 200 #endif
 201 #endif
 202
 203
 204 extern uint_t           la_version(uint_t);
 205 extern void             la_activity(uintptr_t *, uint_t);
 206 extern void             la_preinit(uintptr_t *);
 207 extern char             *la_objsearch(const char *, uintptr_t *, uint_t);
 208 extern uint_t           la_objopen(Link_map *, Lmid_t, uintptr_t *);
 209 extern uint_t           la_objclose(uintptr_t *);
 210 extern int              la_objfilter(uintptr_t *, const char *, uintptr_t *,
 211                                 uint_t);
 212 #if     defined(_LP64)
 213 extern uintptr_t        la_amd64_pltenter(Elf64_Sym *, uint_t, uintptr_t *,
 214                                 uintptr_t *, La_amd64_regs *,   uint_t *,
 215                                 const char *);
 216 extern uintptr_t        la_symbind64(Elf64_Sym *, uint_t, uintptr_t *,
 217                                 uintptr_t *, uint_t *, const char *);
 218 extern uintptr_t        la_sparcv9_pltenter(Elf64_Sym *, uint_t, uintptr_t *,
 219                                 uintptr_t *, La_sparcv9_regs *, uint_t *,
 220                                 const char *);
 221 extern uintptr_t        la_pltexit64(Elf64_Sym *, uint_t, uintptr_t *,
 222                                 uintptr_t *, uintptr_t, const char *);
 223 #else  /* !defined(_LP64) */
 224 extern uintptr_t        la_symbind32(Elf32_Sym *, uint_t, uintptr_t *,
 225                                 uintptr_t *, uint_t *);
 226 extern uintptr_t        la_sparcv8_pltenter(Elf32_Sym *, uint_t, uintptr_t *,
 227                                 uintptr_t *, La_sparcv8_regs *, uint_t *);
 228 extern uintptr_t        la_i86_pltenter(Elf32_Sym *, uint_t, uintptr_t *,
 229                                 uintptr_t *, La_i86_regs *, uint_t *);
 230 extern uintptr_t        la_pltexit(Elf32_Sym *, uint_t, uintptr_t *,
 231                                 uintptr_t *, uintptr_t);
 232 #endif /* _LP64 */
 233
 234 /*
 235  * The ElfW() macro is a GNU/Linux feature, provided as support for
 236  * the dl_phdr_info structure used by dl_phdr_iterate(), which also
 237  * originated under Linux. Given an ELF data type, without the ElfXX_
 238  * prefix, it supplies the appropriate prefix (Elf32_ or Elf64_) for
 239  * the ELFCLASS of the code being compiled.
 240  *
 241  * Note that ElfW() is not suitable in situations in which the ELFCLASS
 242  * of the code being compiled does not match that of the objects that
 243  * code is intended to operate on (e.g. a 32-bit link-editor building
 244  * a 64-bit object). The macros defined in <sys/machelf.h> are
 245  * recommended in such cases.
 246  */
 247 #ifdef _LP64
 248 #define ElfW(type)      Elf64_ ## type
 249 #else
 250 #define ElfW(type)      Elf32_ ## type
 251 #endif
 252
 253 /*
 254  * The callback function to dl_interate_phdr() receives a pointer
 255  * to a structure of this type.
 256  *
 257  * dlpi_addr is defined such that the address of any segment in
 258  * the program header array can be calculated as:
 259  *
 260  *      addr == info->dlpi_addr + info->dlpi_phdr[x].p_vaddr;
 261  *
 262  * It is therefore 0 for ET_EXEC objects, and the base address at
 263  * which the object is mapped otherwise.
 264  */
 265 struct dl_phdr_info {
 266         ElfW(Addr)              dlpi_addr;      /* Base address of object */
 267         const char              *dlpi_name;     /* Null-terminated obj name */
 268         const ElfW(Phdr)        *dlpi_phdr;     /* Ptr to ELF program hdr arr */
 269         ElfW(Half)              dlpi_phnum;     /* # of items in dlpi_phdr[] */
 270
 271         /*
 272          * Note: Following members were introduced after the first version
 273          * of this structure was available.  The dl_iterate_phdr() callback
 274          * function is passed a 'size' argument giving the size of the info
 275          * structure, and must compare that size to the offset of these fields
 276          * before accessing them to ensure that they are present.
 277          */
 278
 279         /* Incremented when a new object is mapped into the process */
 280         u_longlong_t            dlpi_adds;
 281         /* Incremented when an object is unmapped from the process */
 282         u_longlong_t            dlpi_subs;
 283 };
 284
 285 extern  int dl_iterate_phdr(int (*)(struct dl_phdr_info *, size_t, void *),
 286             void *);
 287
 288 #endif  /* _ASM */
 289 #endif /* _KERNEL */
 290
 291
 292 #ifdef __cplusplus
 293 }
 294 #endif
 295
 296 #endif  /* _LINK_H */