include/isl/ctx.h

   1 /*
   2  * Copyright 2008-2009 Katholieke Universiteit Leuven
   3  *
   4  * Use of this software is governed by the MIT license
   5  *
   6  * Written by Sven Verdoolaege, K.U.Leuven, Departement
   7  * Computerwetenschappen, Celestijnenlaan 200A, B-3001 Leuven, Belgium
   8  */
   9
  10 #ifndef ISL_CTX_H
  11 #define ISL_CTX_H
  12
  13 #include <stdio.h>
  14 #include <stdlib.h>
  15
  16 #include <isl/arg.h>
  17 #include <isl/hash.h>
  18 #include <isl/config.h>
  19
  20 #ifndef __isl_give
  21 #define __isl_give
  22 #endif
  23 #ifndef __isl_take
  24 #define __isl_take
  25 #endif
  26 #ifndef __isl_keep
  27 #define __isl_keep
  28 #endif
  29 #ifndef __isl_export
  30 #define __isl_export
  31 #endif
  32 #ifndef __isl_constructor
  33 #define __isl_constructor
  34 #endif
  35 #ifndef __isl_subclass
  36 #define __isl_subclass(super)
  37 #endif
  38
  39 #ifdef GCC_WARN_UNUSED_RESULT
  40 #define WARN_UNUSED     GCC_WARN_UNUSED_RESULT
  41 #else
  42 #define WARN_UNUSED
  43 #endif
  44
  45 #if defined(__cplusplus)
  46 extern "C" {
  47 #endif
  48
  49 /* Nearly all isa functions require a struct isl_ctx allocated using
  50  * isl_ctx_alloc.  This ctx contains (or will contain) options that
  51  * control the behavior of the library and some caches.
  52  *
  53  * An object allocated within a given ctx should never be used inside
  54  * another ctx.  Functions for moving objects from one ctx to another
  55  * will be added as the need arises.
  56  *
  57  * A given context should only be used inside a single thread.
  58  * A global context for synchronization between different threads
  59  * as well as functions for moving a context to a different thread
  60  * will be added as the need arises.
  61  *
  62  * If anything goes wrong (out of memory, failed assertion), then
  63  * the library will currently simply abort.  This will be made
  64  * configurable in the future.
  65  * Users of the library should expect functions that return
  66  * a pointer to a structure, to return NULL, indicating failure.
  67  * Any function accepting a pointer to a structure will treat
  68  * a NULL argument as a failure, resulting in the function freeing
  69  * the remaining structures (if any) and returning NULL itself
  70  * (in case of pointer return type).
  71  * The only exception is the isl_ctx argument, which should never be NULL.
  72  */
  73 struct isl_stats {
  74         long    gbr_solved_lps;
  75 };
  76 enum isl_error {
  77         isl_error_none = 0,
  78         isl_error_abort,
  79         isl_error_unknown,
  80         isl_error_internal,
  81         isl_error_invalid,
  82         isl_error_unsupported
  83 };
  84 struct isl_ctx;
  85 typedef struct isl_ctx isl_ctx;
  86
  87 /* Some helper macros */
  88
  89 #define ISL_FL_INIT(l, f)   (l) = (f)               /* Specific flags location. */
  90 #define ISL_FL_SET(l, f)    ((l) |= (f))
  91 #define ISL_FL_CLR(l, f)    ((l) &= ~(f))
  92 #define ISL_FL_ISSET(l, f)  (!!((l) & (f)))
  93
  94 #define ISL_F_INIT(p, f)    ISL_FL_INIT((p)->flags, f)  /* Structure element flags. */
  95 #define ISL_F_SET(p, f)     ISL_FL_SET((p)->flags, f)
  96 #define ISL_F_CLR(p, f)     ISL_FL_CLR((p)->flags, f)
  97 #define ISL_F_ISSET(p, f)   ISL_FL_ISSET((p)->flags, f)
  98
  99 /* isl_check_ctx() checks at compile time if 'ctx' is of type 'isl_ctx *' and
 100  * returns the value of 'expr'. It is used to ensure, that always an isl_ctx is
 101  * passed to the following macros, even if they currently do not use it.
 102  */
 103 #define isl_check_ctx(ctx, expr)        ((ctx != (isl_ctx *) 0) ? expr : NULL)
 104
 105 #define isl_alloc(ctx,type,size)        ((type *)isl_check_ctx(ctx,\
 106                                                         malloc(size)))
 107 #define isl_calloc(ctx,type,size)       ((type *)isl_check_ctx(ctx,\
 108                                                         calloc(1, size)))
 109 #define isl_realloc(ctx,ptr,type,size)  ((type *)isl_check_ctx(ctx,\
 110                                                         realloc(ptr,size)))
 111 #define isl_alloc_type(ctx,type)        isl_alloc(ctx,type,sizeof(type))
 112 #define isl_calloc_type(ctx,type)       isl_calloc(ctx,type,sizeof(type))
 113 #define isl_realloc_type(ctx,ptr,type)  isl_realloc(ctx,ptr,type,sizeof(type))
 114 #define isl_alloc_array(ctx,type,n)     isl_alloc(ctx,type,(n)*sizeof(type))
 115 #define isl_calloc_array(ctx,type,n)    ((type *)isl_check_ctx(ctx,\
 116                                                 calloc(n, sizeof(type))))
 117 #define isl_realloc_array(ctx,ptr,type,n) \
 118                                     isl_realloc(ctx,ptr,type,(n)*sizeof(type))
 119
 120 #define isl_die(ctx,errno,msg,code)                                     \
 121         do {                                                            \
 122                 isl_handle_error(ctx, errno, msg, __FILE__, __LINE__);  \
 123                 code;                                                   \
 124         } while (0)
 125
 126 void isl_handle_error(isl_ctx *ctx, enum isl_error error, const char *msg,
 127         const char *file, int line);
 128
 129 #define isl_assert4(ctx,test,code,errno)                                \
 130         do {                                                            \
 131                 if (test)                                               \
 132                         break;                                          \
 133                 isl_die(ctx, errno, "Assertion \"" #test "\" failed", code);    \
 134         } while (0)
 135 #define isl_assert(ctx,test,code)                                       \
 136         isl_assert4(ctx,test,code,isl_error_unknown)
 137
 138 #define isl_min(a,b)                    ((a < b) ? (a) : (b))
 139
 140 /* struct isl_ctx functions */
 141
 142 struct isl_options *isl_ctx_options(isl_ctx *ctx);
 143
 144 isl_ctx *isl_ctx_alloc_with_options(struct isl_args *args,
 145         __isl_take void *opt);
 146 isl_ctx *isl_ctx_alloc(void);
 147 void *isl_ctx_peek_options(isl_ctx *ctx, struct isl_args *args);
 148 int isl_ctx_parse_options(isl_ctx *ctx, int argc, char **argv, unsigned flags);
 149 void isl_ctx_ref(struct isl_ctx *ctx);
 150 void isl_ctx_deref(struct isl_ctx *ctx);
 151 void isl_ctx_free(isl_ctx *ctx);
 152
 153 void isl_ctx_abort(isl_ctx *ctx);
 154 void isl_ctx_resume(isl_ctx *ctx);
 155 int isl_ctx_aborted(isl_ctx *ctx);
 156
 157 #define ISL_ARG_CTX_DECL(prefix,st,args)                                \
 158 st *isl_ctx_peek_ ## prefix(isl_ctx *ctx);
 159
 160 #define ISL_ARG_CTX_DEF(prefix,st,args)                                 \
 161 st *isl_ctx_peek_ ## prefix(isl_ctx *ctx)                               \
 162 {                                                                       \
 163         return (st *)isl_ctx_peek_options(ctx, &(args));                \
 164 }
 165
 166 #define ISL_CTX_GET_INT_DEF(prefix,st,args,field)                       \
 167 int prefix ## _get_ ## field(isl_ctx *ctx)                              \
 168 {                                                                       \
 169         st *options;                                                    \
 170         options = isl_ctx_peek_ ## prefix(ctx);                         \
 171         if (!options)                                                   \
 172                 isl_die(ctx, isl_error_invalid,                         \
 173                         "isl_ctx does not reference " #prefix,          \
 174                         return -1);                                     \
 175         return options->field;                                          \
 176 }
 177
 178 #define ISL_CTX_SET_INT_DEF(prefix,st,args,field)                       \
 179 int prefix ## _set_ ## field(isl_ctx *ctx, int val)                     \
 180 {                                                                       \
 181         st *options;                                                    \
 182         options = isl_ctx_peek_ ## prefix(ctx);                         \
 183         if (!options)                                                   \
 184                 isl_die(ctx, isl_error_invalid,                         \
 185                         "isl_ctx does not reference " #prefix,          \
 186                         return -1);                                     \
 187         options->field = val;                                           \
 188         return 0;                                                       \
 189 }
 190
 191 #define ISL_CTX_GET_STR_DEF(prefix,st,args,field)                       \
 192 const char *prefix ## _get_ ## field(isl_ctx *ctx)                      \
 193 {                                                                       \
 194         st *options;                                                    \
 195         options = isl_ctx_peek_ ## prefix(ctx);                         \
 196         if (!options)                                                   \
 197                 isl_die(ctx, isl_error_invalid,                         \
 198                         "isl_ctx does not reference " #prefix,          \
 199                         return NULL);                                   \
 200         return options->field;                                          \
 201 }
 202
 203 #define ISL_CTX_SET_STR_DEF(prefix,st,args,field)                       \
 204 int prefix ## _set_ ## field(isl_ctx *ctx, const char *val)             \
 205 {                                                                       \
 206         st *options;                                                    \
 207         options = isl_ctx_peek_ ## prefix(ctx);                         \
 208         if (!options)                                                   \
 209                 isl_die(ctx, isl_error_invalid,                         \
 210                         "isl_ctx does not reference " #prefix,          \
 211                         return -1);                                     \
 212         if (!val)                                                       \
 213                 return -1;                                              \
 214         free(options->field);                                           \
 215         options->field = strdup(val);                                   \
 216         if (!options->field)                                            \
 217                 return -1;                                              \
 218         return 0;                                                       \
 219 }
 220
 221 #define ISL_CTX_GET_BOOL_DEF(prefix,st,args,field)                      \
 222         ISL_CTX_GET_INT_DEF(prefix,st,args,field)
 223
 224 #define ISL_CTX_SET_BOOL_DEF(prefix,st,args,field)                      \
 225         ISL_CTX_SET_INT_DEF(prefix,st,args,field)
 226
 227 #define ISL_CTX_GET_CHOICE_DEF(prefix,st,args,field)                    \
 228         ISL_CTX_GET_INT_DEF(prefix,st,args,field)
 229
 230 #define ISL_CTX_SET_CHOICE_DEF(prefix,st,args,field)                    \
 231         ISL_CTX_SET_INT_DEF(prefix,st,args,field)
 232
 233 enum isl_error isl_ctx_last_error(isl_ctx *ctx);
 234 void isl_ctx_reset_error(isl_ctx *ctx);
 235 void isl_ctx_set_error(isl_ctx *ctx, enum isl_error error);
 236
 237 #if defined(__cplusplus)
 238 }
 239 #endif
 240
 241 #endif