/*
This file is part of GOTCHA.  For copyright information see the COPYRIGHT
file in the top level directory, or at
https://github.com/LLNL/gotcha/blob/master/COPYRIGHT
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License (as published by the Free
Software Foundation) version 2.1 dated February 1999.  This program is
distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the IMPLIED WARRANTY OF MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the terms and conditions of the GNU Lesser General Public License
for more details.  You should have received a copy of the GNU Lesser General
Public License along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

/*!
 ******************************************************************************
 *
 * \file gotcha_utils.h
 *
 * \brief   Header file containing the internal gotcha mechanisms
 *          for manipulating the running process to redirect calls
 *
 ******************************************************************************
 */
#ifndef GOTCHA_UTILS_H
#define GOTCHA_UTILS_H
#include <sys/mman.h>

#include "gotcha/gotcha_types.h"
#include "hash.h"
// TODO: remove these includes
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
// END TODO
#include <elf.h>
#include <link.h>
#include <string.h>

#define KNOWN_UNUSED __attribute__((unused))

#define GOTCHA_DEBUG_ENV "GOTCHA_DEBUG"
extern int debug_level;
void gotcha_init_internal();
extern hash_table_t function_hash_table;
extern hash_table_t notfound_binding_table;
#define debug_bare_printf(lvl, format, ...)     \
  do {                                          \
    if (debug_level >= lvl) {                   \
      gotcha_dbg_printf(format, ##__VA_ARGS__); \
    }                                           \
  } while (0);

#define SHORT_FILE__ ((strrchr(__FILE__, '/') ?: __FILE__ - 1) + 1)

#define debug_printf(lvl, format, ...)                               \
  do {                                                               \
    if (debug_level >= lvl) {                                        \
      gotcha_dbg_printf("[%d/%d][%s:%u] - " format, gotcha_gettid(), \
                        gotcha_getpid(), SHORT_FILE__, __LINE__,     \
                        ##__VA_ARGS__);                              \
    }                                                                \
  } while (0);

#define error_printf(format, ...)                                          \
  do {                                                                     \
    if (debug_level) {                                                     \
      gotcha_dbg_printf("ERROR [%d/%d][%s:%u] - " format, gotcha_gettid(), \
                        gotcha_getpid(), SHORT_FILE__, __LINE__,           \
                        ##__VA_ARGS__);                                    \
    }                                                                      \
  } while (0);

#define LIB_NAME(X) \
  (!X->l_name ? "[NULL]" : (!*X->l_name ? "[EMPTY]" : X->l_name))

/*!
 ******************************************************************************
 * \def R_SYM(X)
 * \brief Returns an ELF symbol which is correct for the current architecture
 * \param X The value you wish to cast to Symbol type
 ******************************************************************************
 */
#if __WORDSIZE == 64
#define R_SYM(X) ELF64_R_SYM(X)
#else
#define R_SYM(X) ELF32_R_SYM(X)
#endif

/*!
 ******************************************************************************
 * \def BOUNDARY_BEFORE(ptr,pagesize)
 * \brief Returns the address on page boundary before the given pointer
 * \param ptr The address you wish to get the page boundary before
 * \param pagesize The page size you wish to align to
 ******************************************************************************
 */
#define BOUNDARY_BEFORE(ptr, pagesize) \
  (ElfW(Addr))(((ElfW(Addr))ptr) & (-pagesize))

#endif