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
  18 #ifndef __isl_give
  19 #define __isl_give
  20 #endif
  21 #ifndef __isl_take
  22 #define __isl_take
  23 #endif
  24 #ifndef __isl_keep
  25 #define __isl_keep
  26 #endif
  27 #ifndef __isl_null
  28 #define __isl_null
  29 #endif
  30 #ifndef __isl_export
  31 #define __isl_export
  32 #endif
  33 #ifndef __isl_overload
  34 #define __isl_overload
  35 #endif
  36 #ifndef __isl_constructor
  37 #define __isl_constructor
  38 #endif
  39 #ifndef __isl_subclass
  40 #define __isl_subclass(super)
  41 #endif
  42
  43 #if defined(__cplusplus)
  44 extern "C" {
  45 #endif
  46
  47 /* Nearly all isa functions require a struct isl_ctx allocated using
  48  * isl_ctx_alloc.  This ctx contains (or will contain) options that
  49  * control the behavior of the library and some caches.
  50  *
  51  * An object allocated within a given ctx should never be used inside
  52  * another ctx.  Functions for moving objects from one ctx to another
  53  * will be added as the need arises.
  54  *
  55  * A given context should only be used inside a single thread.
  56  * A global context for synchronization between different threads
  57  * as well as functions for moving a context to a different thread
  58  * will be added as the need arises.
  59  *
  60  * If anything goes wrong (out of memory, failed assertion), then
  61  * the library will currently simply abort.  This will be made
  62  * configurable in the future.
  63  * Users of the library should expect functions that return
  64  * a pointer to a structure, to return NULL, indicating failure.
  65  * Any function accepting a pointer to a structure will treat
  66  * a NULL argument as a failure, resulting in the function freeing
  67  * the remaining structures (if any) and returning NULL itself
  68  * (in case of pointer return type).
  69  * The only exception is the isl_ctx argument, which should never be NULL.
  70  */
  71 struct isl_stats {
  72         long    gbr_solved_lps;
  73 };
  74 enum isl_error {
  75         isl_error_none = 0,
  76         isl_error_abort,
  77         isl_error_alloc,
  78         isl_error_unknown,
  79         isl_error_internal,
  80         isl_error_invalid,
  81         isl_error_quota,
  82         isl_error_unsupported
  83 };
  84 typedef enum {
  85         isl_stat_error = -1,
  86         isl_stat_ok = 0
  87 } isl_stat;
  88 typedef enum {
  89         isl_bool_error = -1,
  90         isl_bool_false = 0,
  91         isl_bool_true = 1
  92 } isl_bool;
  93 isl_bool isl_bool_not(isl_bool b);
  94 isl_bool isl_bool_ok(int b);
  95 typedef int     isl_size;
  96 #define isl_size_error  ((int) -1)
  97 struct isl_ctx;
  98 typedef struct isl_ctx isl_ctx;
  99
 100 /* Some helper macros */
 101
 102 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
 103 #define ISL_DEPRECATED  __attribute__((__deprecated__))
 104 #else
 105 #define ISL_DEPRECATED
 106 #endif
 107
 108 #define ISL_FL_INIT(l, f)   (l) = (f)               /* Specific flags location. */
 109 #define ISL_FL_SET(l, f)    ((l) |= (f))
 110 #define ISL_FL_CLR(l, f)    ((l) &= ~(f))
 111 #define ISL_FL_ISSET(l, f)  (!!((l) & (f)))
 112
 113 #define ISL_F_INIT(p, f)    ISL_FL_INIT((p)->flags, f)  /* Structure element flags. */
 114 #define ISL_F_SET(p, f)     ISL_FL_SET((p)->flags, f)
 115 #define ISL_F_CLR(p, f)     ISL_FL_CLR((p)->flags, f)
 116 #define ISL_F_ISSET(p, f)   ISL_FL_ISSET((p)->flags, f)
 117
 118 void *isl_malloc_or_die(isl_ctx *ctx, size_t size);
 119 void *isl_calloc_or_die(isl_ctx *ctx, size_t nmemb, size_t size);
 120 void *isl_realloc_or_die(isl_ctx *ctx, void *ptr, size_t size);
 121
 122 #define isl_alloc(ctx,type,size)        ((type *)isl_malloc_or_die(ctx, size))
 123 #define isl_calloc(ctx,type,size)       ((type *)isl_calloc_or_die(ctx,\
 124                                                                     1, size))
 125 #define isl_realloc(ctx,ptr,type,size)  ((type *)isl_realloc_or_die(ctx,\
 126                                                                     ptr, size))
 127 #define isl_alloc_type(ctx,type)        isl_alloc(ctx,type,sizeof(type))
 128 #define isl_calloc_type(ctx,type)       isl_calloc(ctx,type,sizeof(type))
 129 #define isl_realloc_type(ctx,ptr,type)  isl_realloc(ctx,ptr,type,sizeof(type))
 130 #define isl_alloc_array(ctx,type,n)     isl_alloc(ctx,type,(n)*sizeof(type))
 131 #define isl_calloc_array(ctx,type,n)    ((type *)isl_calloc_or_die(ctx,\
 132                                                             n, sizeof(type)))
 133 #define isl_realloc_array(ctx,ptr,type,n) \
 134                                     isl_realloc(ctx,ptr,type,(n)*sizeof(type))
 135
 136 #define isl_die(ctx,errno,msg,code)                                     \
 137         do {                                                            \
 138                 isl_handle_error(ctx, errno, msg, __FILE__, __LINE__);  \
 139                 code;                                                   \
 140         } while (0)
 141
 142 void isl_handle_error(isl_ctx *ctx, enum isl_error error, const char *msg,
 143         const char *file, int line);
 144
 145 #define isl_assert4(ctx,test,code,errno)                                \
 146         do {                                                            \
 147                 if (test)                                               \
 148                         break;                                          \
 149                 isl_die(ctx, errno, "Assertion \"" #test "\" failed", code);    \
 150         } while (0)
 151 #define isl_assert(ctx,test,code)                                       \
 152         isl_assert4(ctx,test,code,isl_error_unknown)
 153
 154 #define isl_min(a,b)                    ((a < b) ? (a) : (b))
 155
 156 /* struct isl_ctx functions */
 157
 158 struct isl_options *isl_ctx_options(isl_ctx *ctx);
 159
 160 isl_ctx *isl_ctx_alloc_with_options(struct isl_args *args,
 161         __isl_take void *opt);
 162 isl_ctx *isl_ctx_alloc(void);
 163 void *isl_ctx_peek_options(isl_ctx *ctx, struct isl_args *args);
 164 int isl_ctx_parse_options(isl_ctx *ctx, int argc, char **argv, unsigned flags);
 165 void isl_ctx_ref(struct isl_ctx *ctx);
 166 void isl_ctx_deref(struct isl_ctx *ctx);
 167 void isl_ctx_free(isl_ctx *ctx);
 168
 169 void isl_ctx_abort(isl_ctx *ctx);
 170 void isl_ctx_resume(isl_ctx *ctx);
 171 int isl_ctx_aborted(isl_ctx *ctx);
 172
 173 void isl_ctx_set_max_operations(isl_ctx *ctx, unsigned long max_operations);
 174 unsigned long isl_ctx_get_max_operations(isl_ctx *ctx);
 175 void isl_ctx_reset_operations(isl_ctx *ctx);
 176
 177 #define ISL_ARG_CTX_DECL(prefix,st,args)                                \
 178 st *isl_ctx_peek_ ## prefix(isl_ctx *ctx);
 179
 180 #define ISL_ARG_CTX_DEF(prefix,st,args)                                 \
 181 st *isl_ctx_peek_ ## prefix(isl_ctx *ctx)                               \
 182 {                                                                       \
 183         return (st *)isl_ctx_peek_options(ctx, &(args));                \
 184 }
 185
 186 #define ISL_CTX_GET_INT_DEF(prefix,st,args,field)                       \
 187 int prefix ## _get_ ## field(isl_ctx *ctx)                              \
 188 {                                                                       \
 189         st *options;                                                    \
 190         options = isl_ctx_peek_ ## prefix(ctx);                         \
 191         if (!options)                                                   \
 192                 isl_die(ctx, isl_error_invalid,                         \
 193                         "isl_ctx does not reference " #prefix,          \
 194                         return -1);                                     \
 195         return options->field;                                          \
 196 }
 197
 198 #define ISL_CTX_SET_INT_DEF(prefix,st,args,field)                       \
 199 isl_stat prefix ## _set_ ## field(isl_ctx *ctx, int val)                \
 200 {                                                                       \
 201         st *options;                                                    \
 202         options = isl_ctx_peek_ ## prefix(ctx);                         \
 203         if (!options)                                                   \
 204                 isl_die(ctx, isl_error_invalid,                         \
 205                         "isl_ctx does not reference " #prefix,          \
 206                         return isl_stat_error);                         \
 207         options->field = val;                                           \
 208         return isl_stat_ok;                                             \
 209 }
 210
 211 #define ISL_CTX_GET_STR_DEF(prefix,st,args,field)                       \
 212 const char *prefix ## _get_ ## field(isl_ctx *ctx)                      \
 213 {                                                                       \
 214         st *options;                                                    \
 215         options = isl_ctx_peek_ ## prefix(ctx);                         \
 216         if (!options)                                                   \
 217                 isl_die(ctx, isl_error_invalid,                         \
 218                         "isl_ctx does not reference " #prefix,          \
 219                         return NULL);                                   \
 220         return options->field;                                          \
 221 }
 222
 223 #define ISL_CTX_SET_STR_DEF(prefix,st,args,field)                       \
 224 isl_stat prefix ## _set_ ## field(isl_ctx *ctx, const char *val)        \
 225 {                                                                       \
 226         st *options;                                                    \
 227         options = isl_ctx_peek_ ## prefix(ctx);                         \
 228         if (!options)                                                   \
 229                 isl_die(ctx, isl_error_invalid,                         \
 230                         "isl_ctx does not reference " #prefix,          \
 231                         return isl_stat_error);                         \
 232         if (!val)                                                       \
 233                 return isl_stat_error;                                  \
 234         free(options->field);                                           \
 235         options->field = strdup(val);                                   \
 236         if (!options->field)                                            \
 237                 return isl_stat_error;                                  \
 238         return isl_stat_ok;                                             \
 239 }
 240
 241 #define ISL_CTX_GET_BOOL_DEF(prefix,st,args,field)                      \
 242         ISL_CTX_GET_INT_DEF(prefix,st,args,field)
 243
 244 #define ISL_CTX_SET_BOOL_DEF(prefix,st,args,field)                      \
 245         ISL_CTX_SET_INT_DEF(prefix,st,args,field)
 246
 247 #define ISL_CTX_GET_CHOICE_DEF(prefix,st,args,field)                    \
 248         ISL_CTX_GET_INT_DEF(prefix,st,args,field)
 249
 250 #define ISL_CTX_SET_CHOICE_DEF(prefix,st,args,field)                    \
 251         ISL_CTX_SET_INT_DEF(prefix,st,args,field)
 252
 253 enum isl_error isl_ctx_last_error(isl_ctx *ctx);
 254 const char *isl_ctx_last_error_msg(isl_ctx *ctx);
 255 const char *isl_ctx_last_error_file(isl_ctx *ctx);
 256 int isl_ctx_last_error_line(isl_ctx *ctx);
 257 void isl_ctx_reset_error(isl_ctx *ctx);
 258 void isl_ctx_set_error(isl_ctx *ctx, enum isl_error error);
 259
 260 #if defined(__cplusplus)
 261 }
 262 #endif
 263
 264 #endif