include/openscop/macros.h

   1
   2     /*+-----------------------------------------------------------------**
   3      **                       OpenScop Library                          **
   4      **-----------------------------------------------------------------**
   5      **                           macros.h                              **
   6      **-----------------------------------------------------------------**
   7      **                   First version: 30/04/2008                     **
   8      **-----------------------------------------------------------------**
   9
  10
  11  *****************************************************************************
  12  * OpenScop: Structures and formats for polyhedral tools to talk together    *
  13  *****************************************************************************
  14  *    ,___,,_,__,,__,,__,,__,,_,__,,_,__,,__,,___,_,__,,_,__,                *
  15  *    /   / /  //  //  //  // /   / /  //  //   / /  // /  /|,_,             *
  16  *   /   / /  //  //  //  // /   / /  //  //   / /  // /  / / /\             *
  17  *  |~~~|~|~~~|~~~|~~~|~~~|~|~~~|~|~~~|~~~|~~~|~|~~~|~|~~~|/_/  \            *
  18  *  | G |C| P | = | L | P |=| = |C| = | = | = |=| = |=| C |\  \ /\           *
  19  *  | R |l| o | = | e | l |=| = |a| = | = | = |=| = |=| L | \# \ /\          *
  20  *  | A |a| l | = | t | u |=| = |n| = | = | = |=| = |=| o | |\# \  \         *
  21  *  | P |n| l | = | s | t |=| = |d| = | = | = | |   |=| o | | \# \  \        *
  22  *  | H | | y |   | e | o | | = |l|   |   | = | |   | | G | |  \  \  \       *
  23  *  | I | |   |   | e |   | |   | |   |   |   | |   | |   | |   \  \  \      *
  24  *  | T | |   |   |   |   | |   | |   |   |   | |   | |   | |    \  \  \     *
  25  *  | E | |   |   |   |   | |   | |   |   |   | |   | |   | |     \  \  \    *
  26  *  | * |*| * | * | * | * |*| * |*| * | * | * |*| * |*| * | /      \* \  \   *
  27  *  | O |p| e | n | S | c |o| p |-| L | i | b |r| a |r| y |/        \  \ /   *
  28  *  '---'-'---'---'---'---'-'---'-'---'---'---'-'---'-'---'          '--'    *
  29  *                                                                           *
  30  * Copyright (C) 2008 University Paris-Sud 11 and INRIA                      *
  31  *                                                                           *
  32  * (3-clause BSD license)                                                    *
  33  * Redistribution and use in source  and binary forms, with or without       *
  34  * modification, are permitted provided that the following conditions        *
  35  * are met:                                                                  *
  36  *                                                                           *
  37  * 1. Redistributions of source code must retain the above copyright notice, *
  38  *    this list of conditions and the following disclaimer.                  *
  39  * 2. Redistributions in binary form must reproduce the above copyright      *
  40  *    notice, this list of conditions and the following disclaimer in the    *
  41  *    documentation and/or other materials provided with the distribution.   *
  42  * 3. The name of the author may not be used to endorse or promote products  *
  43  *    derived from this software without specific prior written permission.  *
  44  *                                                                           *
  45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR      *
  46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES *
  47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.   *
  48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,          *
  49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT  *
  50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, *
  51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY     *
  52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       *
  53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF  *
  54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.         *
  55  *                                                                           *
  56  * OpenScop Library, a library to manipulate OpenScop formats and data       *
  57  * structures. Written by:                                                   *
  58  * Cedric Bastoul     <Cedric.Bastoul@u-psud.fr> and                         *
  59  * Louis-Noel Pouchet <Louis-Noel.pouchet@inria.fr>                          *
  60  *                                                                           *
  61  *****************************************************************************/
  62
  63
  64 #ifndef OPENSCOP_MACROS_H
  65 # define OPENSCOP_MACROS_H
  66
  67
  68 # define OPENSCOP_TAG_START_SCOP        "<OpenScop>"
  69 # define OPENSCOP_TAG_END_SCOP          "</OpenScop>"
  70
  71 # define OPENSCOP_PRECISION_ENV         "OPENSCOP_PRECISION"
  72 # define OPENSCOP_PRECISION_ENV_SP      "32"
  73 # define OPENSCOP_PRECISION_ENV_DP      "64"
  74 # define OPENSCOP_PRECISION_ENV_MP      "0"
  75 # define OPENSCOP_PRECISION_SP          32
  76 # define OPENSCOP_PRECISION_DP          64
  77 # define OPENSCOP_PRECISION_MP          0
  78
  79 # define OPENSCOP_FMT_SP                "%4ld"
  80 # define OPENSCOP_FMT_DP                "%4lld"
  81 # define OPENSCOP_FMT_MP                "%4s"
  82 # define OPENSCOP_FMT_TXT_SP            "%ld"
  83 # define OPENSCOP_FMT_TXT_DP            "%lld"
  84 # define OPENSCOP_FMT_TXT_MP            "%s"
  85
  86
  87 # define OPENSCOP_DEBUG                 0    // 1 for debug mode, 0 otherwise.
  88 # define OPENSCOP_BACKEND_C             0
  89 # define OPENSCOP_BACKEND_FORTRAN       1
  90 # define OPENSCOP_UNDEFINED             -1
  91 # define OPENSCOP_MAX_STRING            2048
  92 # define OPENSCOP_MAX_ARRAYS            128
  93
  94 # define OPENSCOP_TYPE_GENERIC          0
  95 # define OPENSCOP_TYPE_STRING           1
  96 # define OPENSCOP_TYPE_CONTEXT          2
  97 # define OPENSCOP_TYPE_DOMAIN           3
  98 # define OPENSCOP_TYPE_SCATTERING       4
  99 # define OPENSCOP_TYPE_ACCESS           5
 100 # define OPENSCOP_TYPE_READ             6
 101 # define OPENSCOP_TYPE_WRITE            7
 102 # define OPENSCOP_TYPE_MAY_WRITE        8
 103
 104 # define OPENSCOP_FAKE_ARRAY            "fakearray"
 105
 106 # define OPENSCOP_STRING_UNDEFINED      "UNDEFINED"
 107 # define OPENSCOP_STRING_CONTEXT        "CONTEXT"
 108 # define OPENSCOP_STRING_DOMAIN         "DOMAIN"
 109 # define OPENSCOP_STRING_SCATTERING     "SCATTERING"
 110 # define OPENSCOP_STRING_READ           "READ"
 111 # define OPENSCOP_STRING_WRITE          "WRITE"
 112 # define OPENSCOP_STRING_MAY_WRITE      "MAY_WRITE"
 113
 114 /*+***************************************************************************
 115  *                               UTILITY MACROS                              *
 116  *****************************************************************************/
 117
 118 # define OPENSCOP_info(msg)                                                \
 119          do {                                                              \
 120            fprintf(stderr,"[OpenScop] Info: "msg" (%s).\n", __func__);     \
 121          } while (0)
 122
 123 # define OPENSCOP_warning(msg)                                             \
 124          do {                                                              \
 125            fprintf(stderr,"[OpenScop] Warning: "msg" (%s).\n", __func__);  \
 126          } while (0)
 127
 128 # define OPENSCOP_error(msg)                                               \
 129          do {                                                              \
 130            fprintf(stderr,"[OpenScop] Error: "msg" (%s).\n", __func__);    \
 131            exit(1);                                                        \
 132          } while (0)
 133
 134 # define OPENSCOP_malloc(ptr, type, size)                                  \
 135          do {                                                              \
 136            if (((ptr) = (type)malloc(size)) == NULL)                       \
 137              OPENSCOP_error("memory overflow");                            \
 138          } while (0)
 139
 140 # define OPENSCOP_realloc(ptr, type, size)                                 \
 141          do {                                                              \
 142            if (((ptr) = (type)realloc(ptr, size)) == NULL)                 \
 143              OPENSCOP_error("memory overflow");                            \
 144          } while (0)
 145
 146 # define OPENSCOP_strdup(destination, source)                              \
 147          do {                                                              \
 148            if (source != NULL) {                                           \
 149              if (((destination) = strdup(source)) == NULL)                 \
 150                OPENSCOP_error("memory overflow");                          \
 151            }                                                               \
 152            else {                                                          \
 153              destination = NULL;                                           \
 154              OPENSCOP_warning("strdup of a NULL string");                  \
 155            }                                                               \
 156          } while (0)
 157
 158
 159 #endif /* define OPENSCOP_MACROS_H */