monitor_ext.h

Go to the documentation of this file.

// -*-Mode: C++;-*- // technically C99

// * BeginRiceCopyright *****************************************************
//
// $HeadURL$
// $Id$
//
// --------------------------------------------------------------------------
// Part of HPCToolkit (hpctoolkit.org)
//
// Information about sources of support for research and development of
// HPCToolkit is at 'hpctoolkit.org' and in 'README.Acknowledgments'.
// --------------------------------------------------------------------------
//
// Copyright ((c)) 2002-2019, Rice University
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
//   notice, this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright
//   notice, this list of conditions and the following disclaimer in the
//   documentation and/or other materials provided with the distribution.
//
// * Neither the name of Rice University (RICE) nor the names of its
//   contributors may be used to endorse or promote products derived from
//   this software without specific prior written permission.
//
// This software is provided by RICE and contributors "as is" and any
// express or implied warranties, including, but not limited to, the
// implied warranties of merchantability and fitness for a particular
// purpose are disclaimed. In no event shall RICE or contributors be
// liable for any direct, indirect, incidental, special, exemplary, or
// consequential damages (including, but not limited to, procurement of
// substitute goods or services; loss of use, data, or profits; or
// business interruption) however caused and on any theory of liability,
// whether in contract, strict liability, or tort (including negligence
// or otherwise) arising in any way out of the use of this software, even
// if advised of the possibility of such damage.
//
// ******************************************************* EndRiceCopyright *

/*
 * Macros for extending monitor's overrides.
 */

#ifndef _MONITOR_EXT_H_
#define _MONITOR_EXT_H_

#include <pthread.h>
#  include <messages/messages.h>

#ifdef HPCRUN_STATIC_LINK

#define MONITOR_EXT_CONCAT(x, y) x ## y

// N.B.: the 'name' argument to MONITOR_EXT_WRAP_NAME() will be macro
// expanded once because of MONITOR_EXT_CONCAT()
#define MONITOR_EXT_WRAP_NAME(name)  MONITOR_EXT_CONCAT(__wrap_, name)
#define MONITOR_EXT_GET_NAME(var, name)  var = & name
#define MONITOR_EXT_GET_NAME_WRAP(var, name)  var = & __real_ ## name

#define MONITOR_EXT_DECLARE_REAL_FN(type, realname) \
    extern type MONITOR_EXT_CONCAT(__, realname); \
    static type * realname = NULL

#else  /* HPCRUN DYNAMIC */

#include <dlfcn.h>

#ifndef RTLD_NEXT
#define RTLD_NEXT  ((void *) -1L)
#endif

#define MONITOR_EXT_GET_DLSYM(var, name)  do {          \
    if (var == NULL) {                                  \
        const char *err_str;                            \
        dlerror();                                      \
        var = dlsym(RTLD_NEXT, #name );                 \
        err_str = dlerror();                            \
        if (var == NULL) {                              \
            hpcrun_abort("dlsym(%s) failed: %s", #name , err_str); \
        }                                               \
        TMSG(MONITOR_EXTS, "%s() = %p", #name , var);   \
    }                                                   \
} while (0)

#define MONITOR_EXT_WRAP_NAME(name)  name
#define MONITOR_EXT_GET_NAME(var, name)  MONITOR_EXT_GET_DLSYM(var, name)
#define MONITOR_EXT_GET_NAME_WRAP(var, name)  MONITOR_EXT_GET_DLSYM(var, name)

#define MONITOR_EXT_DECLARE_REAL_FN(type, realname) \
    static type * realname = NULL

#endif  /* HPCRUN_STATIC_LINK */

#endif  /* ! _MONITOR_EXT_H_ */