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_alloc,
  80         isl_error_unknown,
  81         isl_error_internal,
  82         isl_error_invalid,
  83         isl_error_unsupported
  84 };
  85 struct isl_ctx;
  86 typedef struct isl_ctx isl_ctx;
  87
  88 /* Some helper macros */
  89
  90 #define ISL_FL_INIT(l, f)   (l) = (f)               /* Specific flags location. */
  91 #define ISL_FL_SET(l, f)    ((l) |= (f))
  92 #define ISL_FL_CLR(l, f)    ((l) &= ~(f))
  93 #define ISL_FL_ISSET(l, f)  (!!((l) & (f)))
  94
  95 #define ISL_F_INIT(p, f)    ISL_FL_INIT((p)->flags, f)  /* Structure element flags. */
  96 #define ISL_F_SET(p, f)     ISL_FL_SET((p)->flags, f)
  97 #define ISL_F_CLR(p, f)     ISL_FL_CLR((p)->flags, f)
  98 #define ISL_F_ISSET(p, f)   ISL_FL_ISSET((p)->flags, f)
  99
 100 void *isl_malloc_or_die(isl_ctx *ctx, size_t size);
 101 void *isl_calloc_or_die(isl_ctx *ctx, size_t nmemb, size_t size);
 102 void *isl_realloc_or_die(isl_ctx *ctx, void *ptr, size_t size);
 103
 104 #define isl_alloc(ctx,type,size)        ((type *)isl_malloc_or_die(ctx, size))
 105 #define isl_calloc(ctx,type,size)       ((type *)isl_calloc_or_die(ctx,\
 106                                                                     1, size))
 107 #define isl_realloc(ctx,ptr,type,size)  ((type *)isl_realloc_or_die(ctx,\
 108                                                                     ptr, size))
 109 #define isl_alloc_type(ctx,type)        isl_alloc(ctx,type,sizeof(type))
 110 #define isl_calloc_type(ctx,type)       isl_calloc(ctx,type,sizeof(type))
 111 #define isl_realloc_type(ctx,ptr,type)  isl_realloc(ctx,ptr,type,sizeof(type))
 112 #define isl_alloc_array(ctx,type,n)     isl_alloc(ctx,type,(n)*sizeof(type))
 113 #define isl_calloc_array(ctx,type,n)    ((type *)isl_calloc_or_die(ctx,\
 114                                                             n, sizeof(type)))
 115 #define isl_realloc_array(ctx,ptr,type,n) \
 116                                     isl_realloc(ctx,ptr,type,(n)*sizeof(type))
 117
 118 #define isl_die(ctx,errno,msg,code)                                     \
 119         do {                                                            \
 120                 isl_handle_error(ctx, errno, msg, __FILE__, __LINE__);  \
 121                 code;                                                   \
 122         } while (0)
 123
 124 void isl_handle_error(isl_ctx *ctx, enum isl_error error, const char *msg,
 125         const char *file, int line);
 126
 127 #define isl_assert4(ctx,test,code,errno)                                \
 128         do {                                                            \
 129                 if (test)                                               \
 130                         break;                                          \
 131                 isl_die(ctx, errno, "Assertion \"" #test "\" failed", code);    \
 132         } while (0)
 133 #define isl_assert(ctx,test,code)                                       \
 134         isl_assert4(ctx,test,code,isl_error_unknown)
 135
 136 #define isl_min(a,b)                    ((a < b) ? (a) : (b))
 137
 138 /* struct isl_ctx functions */
 139
 140 struct isl_options *isl_ctx_options(isl_ctx *ctx);
 141
 142 isl_ctx *isl_ctx_alloc_with_options(struct isl_args *args,
 143         __isl_take void *opt);
 144 isl_ctx *isl_ctx_alloc(void);
 145 void *isl_ctx_peek_options(isl_ctx *ctx, struct isl_args *args);
 146 int isl_ctx_parse_options(isl_ctx *ctx, int argc, char **argv, unsigned flags);
 147 void isl_ctx_ref(struct isl_ctx *ctx);
 148 void isl_ctx_deref(struct isl_ctx *ctx);
 149 void isl_ctx_free(isl_ctx *ctx);
 150
 151 void isl_ctx_abort(isl_ctx *ctx);
 152 void isl_ctx_resume(isl_ctx *ctx);
 153 int isl_ctx_aborted(isl_ctx *ctx);
 154
 155 #define ISL_ARG_CTX_DECL(prefix,st,args)                                \
 156 st *isl_ctx_peek_ ## prefix(isl_ctx *ctx);
 157
 158 #define ISL_ARG_CTX_DEF(prefix,st,args)                                 \
 159 st *isl_ctx_peek_ ## prefix(isl_ctx *ctx)                               \
 160 {                                                                       \
 161         return (st *)isl_ctx_peek_options(ctx, &(args));                \
 162 }
 163
 164 #define ISL_CTX_GET_INT_DEF(prefix,st,args,field)                       \
 165 int prefix ## _get_ ## field(isl_ctx *ctx)                              \
 166 {                                                                       \
 167         st *options;                                                    \
 168         options = isl_ctx_peek_ ## prefix(ctx);                         \
 169         if (!options)                                                   \
 170                 isl_die(ctx, isl_error_invalid,                         \
 171                         "isl_ctx does not reference " #prefix,          \
 172                         return -1);                                     \
 173         return options->field;                                          \
 174 }
 175
 176 #define ISL_CTX_SET_INT_DEF(prefix,st,args,field)                       \
 177 int prefix ## _set_ ## field(isl_ctx *ctx, int val)                     \
 178 {                                                                       \
 179         st *options;                                                    \
 180         options = isl_ctx_peek_ ## prefix(ctx);                         \
 181         if (!options)                                                   \
 182                 isl_die(ctx, isl_error_invalid,                         \
 183                         "isl_ctx does not reference " #prefix,          \
 184                         return -1);                                     \
 185         options->field = val;                                           \
 186         return 0;                                                       \
 187 }
 188
 189 #define ISL_CTX_GET_STR_DEF(prefix,st,args,field)                       \
 190 const char *prefix ## _get_ ## field(isl_ctx *ctx)                      \
 191 {                                                                       \
 192         st *options;                                                    \
 193         options = isl_ctx_peek_ ## prefix(ctx);                         \
 194         if (!options)                                                   \
 195                 isl_die(ctx, isl_error_invalid,                         \
 196                         "isl_ctx does not reference " #prefix,          \
 197                         return NULL);                                   \
 198         return options->field;                                          \
 199 }
 200
 201 #define ISL_CTX_SET_STR_DEF(prefix,st,args,field)                       \
 202 int prefix ## _set_ ## field(isl_ctx *ctx, const char *val)             \
 203 {                                                                       \
 204         st *options;                                                    \
 205         options = isl_ctx_peek_ ## prefix(ctx);                         \
 206         if (!options)                                                   \
 207                 isl_die(ctx, isl_error_invalid,                         \
 208                         "isl_ctx does not reference " #prefix,          \
 209                         return -1);                                     \
 210         if (!val)                                                       \
 211                 return -1;                                              \
 212         free(options->field);                                           \
 213         options->field = strdup(val);                                   \
 214         if (!options->field)                                            \
 215                 return -1;                                              \
 216         return 0;                                                       \
 217 }
 218
 219 #define ISL_CTX_GET_BOOL_DEF(prefix,st,args,field)                      \
 220         ISL_CTX_GET_INT_DEF(prefix,st,args,field)
 221
 222 #define ISL_CTX_SET_BOOL_DEF(prefix,st,args,field)                      \
 223         ISL_CTX_SET_INT_DEF(prefix,st,args,field)
 224
 225 #define ISL_CTX_GET_CHOICE_DEF(prefix,st,args,field)                    \
 226         ISL_CTX_GET_INT_DEF(prefix,st,args,field)
 227
 228 #define ISL_CTX_SET_CHOICE_DEF(prefix,st,args,field)                    \
 229         ISL_CTX_SET_INT_DEF(prefix,st,args,field)
 230
 231 enum isl_error isl_ctx_last_error(isl_ctx *ctx);
 232 void isl_ctx_reset_error(isl_ctx *ctx);
 233 void isl_ctx_set_error(isl_ctx *ctx, enum isl_error error);
 234
 235 #if defined(__cplusplus)
 236 }
 237 #endif
 238
 239 #endif