src/binreloc/binreloc.h

   1 /*
   2  * BinReloc - a library for creating relocatable executables
   3  * Written by: Hongli Lai <h.lai@chello.nl>
   4  * http://autopackage.org/
   5  *
   6  * This source code is public domain. You can relicense this code
   7  * under whatever license you want.
   8  *
   9  * See http://autopackage.org/docs/binreloc/ for
  10  * more information and how to use this.
  11  */
  12
  13 #ifndef __BINRELOC_H__
  14 #define __BINRELOC_H__
  15
  16 // [Christoph] use config.h, which defines ENABLE_BINRELOC
  17 #include "config.h"
  18
  19 #ifdef __cplusplus
  20 extern "C" {
  21 #endif /* __cplusplus */
  22
  23
  24 /** These error codes can be returned by br_init(), br_init_lib(), gbr_init() or gbr_init_lib(). */
  25 typedef enum {
  26         /** Cannot allocate memory. */
  27         BR_INIT_ERROR_NOMEM,
  28         /** Unable to open /proc/self/maps; see errno for details. */
  29         BR_INIT_ERROR_OPEN_MAPS,
  30         /** Unable to read from /proc/self/maps; see errno for details. */
  31         BR_INIT_ERROR_READ_MAPS,
  32         /** The file format of /proc/self/maps is invalid; kernel bug? */
  33         BR_INIT_ERROR_INVALID_MAPS,
  34         /** BinReloc is disabled (the ENABLE_BINRELOC macro is not defined). */
  35         BR_INIT_ERROR_DISABLED
  36 } BrInitError;
  37
  38
  39 #ifndef BINRELOC_RUNNING_DOXYGEN
  40 /* Mangle symbol names to avoid symbol collisions with other ELF objects. */
  41         #define br_init             PTeH3518859728963_br_init
  42         #define br_init_lib         PTeH3518859728963_br_init_lib
  43         #define br_find_exe         PTeH3518859728963_br_find_exe
  44         #define br_find_exe_dir     PTeH3518859728963_br_find_exe_dir
  45         #define br_find_prefix      PTeH3518859728963_br_find_prefix
  46         #define br_find_bin_dir     PTeH3518859728963_br_find_bin_dir
  47         #define br_find_sbin_dir    PTeH3518859728963_br_find_sbin_dir
  48         #define br_find_data_dir    PTeH3518859728963_br_find_data_dir
  49         #define br_find_locale_dir  PTeH3518859728963_br_find_locale_dir
  50         #define br_find_lib_dir     PTeH3518859728963_br_find_lib_dir
  51         #define br_find_libexec_dir PTeH3518859728963_br_find_libexec_dir
  52         #define br_find_etc_dir     PTeH3518859728963_br_find_etc_dir
  53         #define br_strcat           PTeH3518859728963_br_strcat
  54         #define br_build_path       PTeH3518859728963_br_build_path
  55         #define br_dirname          PTeH3518859728963_br_dirname
  56
  57
  58 #endif
  59 int   br_init             (BrInitError *error);
  60 int   br_init_lib         (BrInitError *error);
  61
  62 char *br_find_exe         (const char *default_exe);
  63 char *br_find_exe_dir     (const char *default_dir);
  64 char *br_find_prefix      (const char *default_prefix);
  65 char *br_find_bin_dir     (const char *default_bin_dir);
  66 char *br_find_sbin_dir    (const char *default_sbin_dir);
  67 char *br_find_data_dir    (const char *default_data_dir);
  68 char *br_find_locale_dir  (const char *default_locale_dir);
  69 char *br_find_lib_dir     (const char *default_lib_dir);
  70 char *br_find_libexec_dir (const char *default_libexec_dir);
  71 char *br_find_etc_dir     (const char *default_etc_dir);
  72
  73 /* Utility functions */
  74 char *br_strcat  (const char *str1, const char *str2);
  75 char *br_build_path (const char *dir, const char *file);
  76 char *br_dirname (const char *path);
  77
  78
  79 #ifdef __cplusplus
  80 }
  81 #endif /* __cplusplus */
  82
  83 #endif /* __BINRELOC_H__ */