libmpx/mpxrt/mpxrt-utils.h

   1 /* mpxrt-utils.h                  -*-C++-*-
   2  *
   3  *************************************************************************
   4  *
   5  *  @copyright
   6  *  Copyright (C) 2014, Intel Corporation
   7  *  All rights reserved.
   8  *
   9  *  @copyright
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *
  14  *    * Redistributions of source code must retain the above copyright
  15  *      notice, this list of conditions and the following disclaimer.
  16  *    * Redistributions in binary form must reproduce the above copyright
  17  *      notice, this list of conditions and the following disclaimer in
  18  *      the documentation and/or other materials provided with the
  19  *      distribution.
  20  *    * Neither the name of Intel Corporation nor the names of its
  21  *      contributors may be used to endorse or promote products derived
  22  *      from this software without specific prior written permission.
  23  *
  24  *  @copyright
  25  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  *  HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  30  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  31  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  32  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  33  *  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
  35  *  WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  36  *  POSSIBILITY OF SUCH DAMAGE.
  37  *
  38  **************************************************************************/
  39
  40 #ifndef MPXRT_UTILS_H
  41 #define MPXRT_UTILS_H
  42
  43 #include <stdint.h>
  44
  45 typedef enum {
  46   VERB_ERROR,
  47   VERB_INFO,
  48   VERB_BR,
  49   VERB_DEBUG
  50 } verbose_type;
  51
  52 typedef enum {
  53   MPX_RT_COUNT,
  54   MPX_RT_STOP
  55 } mpx_rt_mode_t;
  56
  57 typedef enum {
  58   MPX_RT_STOP_HANDLER_ABORT,
  59   MPX_RT_STOP_HANDLER_EXIT
  60 } mpx_rt_stop_mode_handler_t;
  61
  62 void __mpxrt_init_env_vars (int* bndpreserve);
  63 void __mpxrt_write_uint (verbose_type vt, uint64_t val, unsigned base);
  64 void __mpxrt_write (verbose_type vt, const char* str);
  65 void __mpxrt_print (verbose_type vt, const char* frmt, ...);
  66 mpx_rt_mode_t __mpxrt_mode (void);
  67 void __mpxrt_utils_free (void);
  68 void __mpxrt_print_summary (uint64_t num_brs, uint64_t l1_size);
  69 void __mpxrt_stop (void) __attribute__ ((noreturn));
  70
  71 #endif /* MPXRT_UTILS_H */