include/isl_ctx.h

   1 /*
   2  * Copyright 2008-2009 Katholieke Universiteit Leuven
   3  *
   4  * Use of this software is governed by the GNU LGPLv2.1 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 <assert.h>
  14 #include <stdlib.h>
  15
  16 #include <isl_int.h>
  17 #include <isl_options.h>
  18 #include <isl_blk.h>
  19 #include <isl_hash.h>
  20 #include <isl_config.h>
  21
  22 #define __isl_give
  23 #define __isl_take
  24 #define __isl_keep
  25
  26 #ifdef GCC_WARN_UNUSED_RESULT
  27 #define WARN_UNUSED     GCC_WARN_UNUSED_RESULT
  28 #else
  29 #define WARN_UNUSED
  30 #endif
  31
  32 #if defined(__cplusplus)
  33 extern "C" {
  34 #endif
  35
  36 /* Nearly all isa functions require a struct isl_ctx allocated using
  37  * isl_ctx_alloc.  This ctx contains (or will contain) options that
  38  * control the behavior of the library and some caches.
  39  *
  40  * An object allocated within a given ctx should never be used inside
  41  * another ctx.  Functions for moving objects from one ctx to another
  42  * will be added as the need arises.
  43  *
  44  * A given context should only be used inside a single thread.
  45  * A global context for synchronization between different threads
  46  * as well as functions for moving a context to a different thread
  47  * will be added as the need arises.
  48  *
  49  * If anything goes wrong (out of memory, failed assertion), then
  50  * the library will currently simply abort.  This will be made
  51  * configurable in the future.
  52  * Users of the library should expect functions that return
  53  * a pointer to a structure, to return NULL, indicating failure.
  54  * Any function accepting a pointer to a structure will treat
  55  * a NULL argument as a failure, resulting in the function freeing
  56  * the remaining structures (if any) and returning NULL itself
  57  * (in case of pointer return type).
  58  * The only exception is the isl_ctx argument, which shoud never be NULL.
  59  */
  60 struct isl_stats {
  61         long    gbr_solved_lps;
  62 };
  63 struct isl_ctx {
  64         int                     ref;
  65
  66         struct isl_stats        *stats;
  67
  68         int                      opt_allocated;
  69         struct isl_options      *opt;
  70         void                    *user_opt;
  71         struct isl_arg          *user_arg;
  72
  73         isl_int                 zero;
  74         isl_int                 one;
  75         isl_int                 negone;
  76
  77         isl_int                 normalize_gcd;
  78
  79         int                     n_cached;
  80         struct isl_blk          cache[ISL_BLK_CACHE_SIZE];
  81         struct isl_hash_table   name_hash;
  82 };
  83 typedef struct isl_ctx isl_ctx;
  84
  85 /* Some helper macros */
  86
  87 #define ISL_FL_INIT(l, f)   (l) = (f)               /* Specific flags location. */
  88 #define ISL_FL_SET(l, f)    ((l) |= (f))
  89 #define ISL_FL_CLR(l, f)    ((l) &= ~(f))
  90 #define ISL_FL_ISSET(l, f)  (!!((l) & (f)))
  91
  92 #define ISL_F_INIT(p, f)    ISL_FL_INIT((p)->flags, f)  /* Structure element flags. */
  93 #define ISL_F_SET(p, f)     ISL_FL_SET((p)->flags, f)
  94 #define ISL_F_CLR(p, f)     ISL_FL_CLR((p)->flags, f)
  95 #define ISL_F_ISSET(p, f)   ISL_FL_ISSET((p)->flags, f)
  96
  97 #define isl_alloc(ctx,type,size)        (type *)malloc(size)
  98 #define isl_calloc(ctx,type,size)       (type *)calloc(1, size)
  99 #define isl_realloc(ctx,ptr,type,size)  (type *)realloc(ptr,size)
 100 #define isl_alloc_type(ctx,type)        isl_alloc(ctx,type,sizeof(type))
 101 #define isl_calloc_type(ctx,type)       isl_calloc(ctx,type,sizeof(type))
 102 #define isl_realloc_type(ctx,ptr,type)  isl_realloc(ctx,ptr,type,sizeof(type))
 103 #define isl_alloc_array(ctx,type,n)     isl_alloc(ctx,type,(n)*sizeof(type))
 104 #define isl_calloc_array(ctx,type,n)    (type *)calloc(n, sizeof(type))
 105 #define isl_realloc_array(ctx,ptr,type,n) \
 106                                     isl_realloc(ctx,ptr,type,(n)*sizeof(type))
 107
 108 #define isl_assert(ctx,test,code)                                       \
 109         do {                                                            \
 110                 assert(test);                                           \
 111                 if (0 && !ctx) {                                        \
 112                         code;                                           \
 113                 }                                                       \
 114         } while(0)
 115
 116 #define isl_min(a,b)                    ((a < b) ? (a) : (b))
 117
 118 /* struct isl_ctx functions */
 119
 120 struct isl_options *isl_ctx_options(isl_ctx *ctx);
 121
 122 isl_ctx *isl_ctx_alloc_with_options(struct isl_arg *arg, __isl_take void *opt);
 123 isl_ctx *isl_ctx_alloc();
 124 void isl_ctx_ref(struct isl_ctx *ctx);
 125 void isl_ctx_deref(struct isl_ctx *ctx);
 126 void isl_ctx_free(isl_ctx *ctx);
 127
 128 #if defined(__cplusplus)
 129 }
 130 #endif
 131
 132 #endif