2 * Copyright 2008-2009 Katholieke Universiteit Leuven
4 * Use of this software is governed by the MIT license
6 * Written by Sven Verdoolaege, K.U.Leuven, Departement
7 * Computerwetenschappen, Celestijnenlaan 200A, B-3001 Leuven, Belgium
20 #include <isl/config.h>
34 #ifndef __isl_constructor
35 #define __isl_constructor
37 #ifndef __isl_subclass
38 #define __isl_subclass(super)
41 #ifdef GCC_WARN_UNUSED_RESULT
42 #define WARN_UNUSED GCC_WARN_UNUSED_RESULT
47 #if defined(__cplusplus)
51 /* Nearly all isa functions require a struct isl_ctx allocated using
52 * isl_ctx_alloc. This ctx contains (or will contain) options that
53 * control the behavior of the library and some caches.
55 * An object allocated within a given ctx should never be used inside
56 * another ctx. Functions for moving objects from one ctx to another
57 * will be added as the need arises.
59 * A given context should only be used inside a single thread.
60 * A global context for synchronization between different threads
61 * as well as functions for moving a context to a different thread
62 * will be added as the need arises.
64 * If anything goes wrong (out of memory, failed assertion), then
65 * the library will currently simply abort. This will be made
66 * configurable in the future.
67 * Users of the library should expect functions that return
68 * a pointer to a structure, to return NULL, indicating failure.
69 * Any function accepting a pointer to a structure will treat
70 * a NULL argument as a failure, resulting in the function freeing
71 * the remaining structures (if any) and returning NULL itself
72 * (in case of pointer return type).
73 * The only exception is the isl_ctx argument, which should never be NULL.
87 typedef struct isl_ctx isl_ctx
;
89 /* Some helper macros */
91 #define ISL_FL_INIT(l, f) (l) = (f) /* Specific flags location. */
92 #define ISL_FL_SET(l, f) ((l) |= (f))
93 #define ISL_FL_CLR(l, f) ((l) &= ~(f))
94 #define ISL_FL_ISSET(l, f) (!!((l) & (f)))
96 #define ISL_F_INIT(p, f) ISL_FL_INIT((p)->flags, f) /* Structure element flags. */
97 #define ISL_F_SET(p, f) ISL_FL_SET((p)->flags, f)
98 #define ISL_F_CLR(p, f) ISL_FL_CLR((p)->flags, f)
99 #define ISL_F_ISSET(p, f) ISL_FL_ISSET((p)->flags, f)
101 /* isl_check_ctx() checks at compile time if 'ctx' is of type 'isl_ctx *' and
102 * returns the value of 'expr'. It is used to ensure, that always an isl_ctx is
103 * passed to the following macros, even if they currently do not use it.
105 #define isl_check_ctx(ctx, expr) ((ctx != (isl_ctx *) 0) ? expr : expr)
107 #define isl_alloc(ctx,type,size) ((type *)isl_check_ctx(ctx,\
109 #define isl_calloc(ctx,type,size) ((type *)isl_check_ctx(ctx,\
111 #define isl_realloc(ctx,ptr,type,size) ((type *)isl_check_ctx(ctx,\
113 #define isl_alloc_type(ctx,type) isl_alloc(ctx,type,sizeof(type))
114 #define isl_calloc_type(ctx,type) isl_calloc(ctx,type,sizeof(type))
115 #define isl_realloc_type(ctx,ptr,type) isl_realloc(ctx,ptr,type,sizeof(type))
116 #define isl_alloc_array(ctx,type,n) isl_alloc(ctx,type,(n)*sizeof(type))
117 #define isl_calloc_array(ctx,type,n) ((type *)isl_check_ctx(ctx,\
118 calloc(n, sizeof(type))))
119 #define isl_realloc_array(ctx,ptr,type,n) \
120 isl_realloc(ctx,ptr,type,(n)*sizeof(type))
122 #define isl_die(ctx,errno,msg,code) \
124 isl_handle_error(ctx, errno, msg, __FILE__, __LINE__); \
128 void isl_handle_error(isl_ctx
*ctx
, enum isl_error error
, const char *msg
,
129 const char *file
, int line
);
131 #define isl_assert4(ctx,test,code,errno) \
135 isl_die(ctx, errno, "Assertion \"" #test "\" failed", code); \
137 #define isl_assert(ctx,test,code) \
138 isl_assert4(ctx,test,code,isl_error_unknown)
140 #define isl_min(a,b) ((a < b) ? (a) : (b))
142 /* struct isl_ctx functions */
144 struct isl_options
*isl_ctx_options(isl_ctx
*ctx
);
146 isl_ctx
*isl_ctx_alloc_with_options(struct isl_args
*args
,
147 __isl_take
void *opt
);
148 isl_ctx
*isl_ctx_alloc(void);
149 void *isl_ctx_peek_options(isl_ctx
*ctx
, struct isl_args
*args
);
150 int isl_ctx_parse_options(isl_ctx
*ctx
, int argc
, char **argv
, unsigned flags
);
151 void isl_ctx_ref(struct isl_ctx
*ctx
);
152 void isl_ctx_deref(struct isl_ctx
*ctx
);
153 void isl_ctx_free(isl_ctx
*ctx
);
155 void isl_ctx_abort(isl_ctx
*ctx
);
156 void isl_ctx_resume(isl_ctx
*ctx
);
157 int isl_ctx_aborted(isl_ctx
*ctx
);
159 #define ISL_ARG_CTX_DECL(prefix,st,args) \
160 st *isl_ctx_peek_ ## prefix(isl_ctx *ctx);
162 #define ISL_ARG_CTX_DEF(prefix,st,args) \
163 st *isl_ctx_peek_ ## prefix(isl_ctx *ctx) \
165 return (st *)isl_ctx_peek_options(ctx, &(args)); \
168 #define ISL_CTX_GET_INT_DEF(prefix,st,args,field) \
169 int prefix ## _get_ ## field(isl_ctx *ctx) \
172 options = isl_ctx_peek_ ## prefix(ctx); \
174 isl_die(ctx, isl_error_invalid, \
175 "isl_ctx does not reference " #prefix, \
177 return options->field; \
180 #define ISL_CTX_SET_INT_DEF(prefix,st,args,field) \
181 int prefix ## _set_ ## field(isl_ctx *ctx, int val) \
184 options = isl_ctx_peek_ ## prefix(ctx); \
186 isl_die(ctx, isl_error_invalid, \
187 "isl_ctx does not reference " #prefix, \
189 options->field = val; \
193 #define ISL_CTX_GET_BOOL_DEF(prefix,st,args,field) \
194 ISL_CTX_GET_INT_DEF(prefix,st,args,field)
196 #define ISL_CTX_SET_BOOL_DEF(prefix,st,args,field) \
197 ISL_CTX_SET_INT_DEF(prefix,st,args,field)
199 #define ISL_CTX_GET_CHOICE_DEF(prefix,st,args,field) \
200 ISL_CTX_GET_INT_DEF(prefix,st,args,field)
202 #define ISL_CTX_SET_CHOICE_DEF(prefix,st,args,field) \
203 ISL_CTX_SET_INT_DEF(prefix,st,args,field)
205 enum isl_error
isl_ctx_last_error(isl_ctx
*ctx
);
206 void isl_ctx_reset_error(isl_ctx
*ctx
);
207 void isl_ctx_set_error(isl_ctx
*ctx
, enum isl_error error
);
209 #if defined(__cplusplus)