add isl_set_dim
[isl.git] / include / isl_ctx.h.in
blobcef5472dc5081ac33f6402e7f7743998c5dfba31
1 #ifndef ISL_CTX_H
2 #define ISL_CTX_H
4 #include <assert.h>
5 #include <stdlib.h>
7 #include <isl_int.h>
8 #include <isl_blk.h>
9 #include <isl_hash.h>
11 #undef ISL_POLYLIB
12 #undef ISL_PIPLIB
14 #if defined(__cplusplus)
15 extern "C" {
16 #endif
18 /* Nearly all isa functions require a struct isl_ctx allocated using
19 * isl_ctx_alloc. This ctx contains (or will contain) options that
20 * control the behavior of the library and some caches.
22 * An object allocated within a given ctx should never be used inside
23 * another ctx. Functions for moving objects from one ctx to another
24 * will be added as the need arises.
26 * A given context should only be used inside a single thread.
27 * A global context for synchronization between different threads
28 * as well as functions for moving a context to a different thread
29 * will be added as the need arises.
31 * If anything goes wrong (out of memory, failed assertion), then
32 * the library will currently simply abort. This will be made
33 * configurable in the future.
34 * Users of the library should expect functions that return
35 * a pointer to a structure, to return NULL, indicating failure.
36 * Any function accepting a pointer to a structure will treat
37 * a NULL argument as a failure, resulting in the function freeing
38 * the remaining structures (if any) and returning NULL itself
39 * (in case of pointer return type).
40 * The only exception is the isl_ctx argument, which shoud never be NULL.
42 struct isl_ctx {
43 int ref;
45 isl_int one;
47 int n_cached;
48 struct isl_blk cache[ISL_BLK_CACHE_SIZE];
49 struct isl_hash_table name_hash;
50 #ifdef ISL_POLYLIB
51 unsigned MaxRays;
52 #endif
55 /* Some helper macros */
57 #define ISL_FL_INIT(l, f) (l) = (f) /* Specific flags location. */
58 #define ISL_FL_SET(l, f) ((l) |= (f))
59 #define ISL_FL_CLR(l, f) ((l) &= ~(f))
60 #define ISL_FL_ISSET(l, f) (!!((l) & (f)))
62 #define ISL_F_INIT(p, f) ISL_FL_INIT((p)->flags, f) /* Structure element flags. */
63 #define ISL_F_SET(p, f) ISL_FL_SET((p)->flags, f)
64 #define ISL_F_CLR(p, f) ISL_FL_CLR((p)->flags, f)
65 #define ISL_F_ISSET(p, f) ISL_FL_ISSET((p)->flags, f)
67 #define isl_alloc(ctx,type,size) (type *)malloc(size)
68 #define isl_calloc(ctx,type,size) (type *)calloc(1, size)
69 #define isl_realloc(ctx,ptr,type,size) (type *)realloc(ptr,size)
70 #define isl_alloc_type(ctx,type) isl_alloc(ctx,type,sizeof(type))
71 #define isl_calloc_type(ctx,type) isl_calloc(ctx,type,sizeof(type))
72 #define isl_realloc_type(ctx,ptr,type) isl_realloc(ctx,ptr,type,sizeof(type))
73 #define isl_alloc_array(ctx,type,n) isl_alloc(ctx,type,(n)*sizeof(type))
74 #define isl_calloc_array(ctx,type,n) (type *)calloc(n, sizeof(type))
75 #define isl_realloc_array(ctx,ptr,type,n) \
76 isl_realloc(ctx,ptr,type,(n)*sizeof(type))
78 #define isl_assert(ctx,test,code) assert(test)
80 #define isl_min(a,b) ((a < b) ? (a) : (b))
82 /* struct isl_ctx functions */
84 struct isl_ctx *isl_ctx_alloc();
85 void isl_ctx_ref(struct isl_ctx *ctx);
86 void isl_ctx_deref(struct isl_ctx *ctx);
87 void isl_ctx_free(struct isl_ctx *ctx);
89 #if defined(__cplusplus)
91 #endif
93 #endif