isl_ctx.c

   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 #include <isl_ctx_private.h>
  11 #include <isl/vec.h>
  12 #include <isl_options_private.h>
  13
  14 #define __isl_calloc(type,size)         ((type *)calloc(1, size))
  15 #define __isl_calloc_type(type)         __isl_calloc(type,sizeof(type))
  16
  17 /* Check that the result of an allocation ("p") is not NULL and
  18  * complain if it is.
  19  * The only exception is when allocation size ("size") is equal to zero.
  20  */
  21 static void *check_non_null(isl_ctx *ctx, void *p, size_t size)
  22 {
  23         if (p || size == 0)
  24                 return p;
  25         isl_die(ctx, isl_error_alloc, "allocation failure", return NULL);
  26 }
  27
  28 /* Prepare for performing the next "operation" in the context.
  29  * Return 0 if we are allowed to perform this operation and
  30  * return -1 if we should abort the computation.
  31  *
  32  * In particular, we should stop if the user has explicitly aborted
  33  * the computation or if the maximal number of operations has been exceeded.
  34  */
  35 int isl_ctx_next_operation(isl_ctx *ctx)
  36 {
  37         if (!ctx)
  38                 return -1;
  39         if (ctx->abort) {
  40                 isl_ctx_set_error(ctx, isl_error_abort);
  41                 return -1;
  42         }
  43         if (ctx->max_operations && ctx->operations >= ctx->max_operations)
  44                 isl_die(ctx, isl_error_quota,
  45                         "maximal number of operations exceeded", return -1);
  46         ctx->operations++;
  47         return 0;
  48 }
  49
  50 /* Call malloc and complain if it fails.
  51  * If ctx is NULL, then return NULL.
  52  */
  53 void *isl_malloc_or_die(isl_ctx *ctx, size_t size)
  54 {
  55         if (isl_ctx_next_operation(ctx) < 0)
  56                 return NULL;
  57         return ctx ? check_non_null(ctx, malloc(size), size) : NULL;
  58 }
  59
  60 /* Call calloc and complain if it fails.
  61  * If ctx is NULL, then return NULL.
  62  */
  63 void *isl_calloc_or_die(isl_ctx *ctx, size_t nmemb, size_t size)
  64 {
  65         if (isl_ctx_next_operation(ctx) < 0)
  66                 return NULL;
  67         return ctx ? check_non_null(ctx, calloc(nmemb, size), nmemb) : NULL;
  68 }
  69
  70 /* Call realloc and complain if it fails.
  71  * If ctx is NULL, then return NULL.
  72  */
  73 void *isl_realloc_or_die(isl_ctx *ctx, void *ptr, size_t size)
  74 {
  75         if (isl_ctx_next_operation(ctx) < 0)
  76                 return NULL;
  77         return ctx ? check_non_null(ctx, realloc(ptr, size), size) : NULL;
  78 }
  79
  80 void isl_handle_error(isl_ctx *ctx, enum isl_error error, const char *msg,
  81         const char *file, int line)
  82 {
  83         if (!ctx)
  84                 return;
  85
  86         isl_ctx_set_error(ctx, error);
  87
  88         switch (ctx->opt->on_error) {
  89         case ISL_ON_ERROR_WARN:
  90                 fprintf(stderr, "%s:%d: %s\n", file, line, msg);
  91                 return;
  92         case ISL_ON_ERROR_CONTINUE:
  93                 return;
  94         case ISL_ON_ERROR_ABORT:
  95                 fprintf(stderr, "%s:%d: %s\n", file, line, msg);
  96                 abort();
  97                 return;
  98         }
  99 }
 100
 101 static struct isl_options *find_nested_options(struct isl_args *args,
 102         void *opt, struct isl_args *wanted)
 103 {
 104         int i;
 105         struct isl_options *options;
 106
 107         if (args == wanted)
 108                 return opt;
 109
 110         for (i = 0; args->args[i].type != isl_arg_end; ++i) {
 111                 struct isl_arg *arg = &args->args[i];
 112                 void *child;
 113
 114                 if (arg->type != isl_arg_child)
 115                         continue;
 116
 117                 if (arg->offset == (size_t) -1)
 118                         child = opt;
 119                 else
 120                         child = *(void **)(((char *)opt) + arg->offset);
 121
 122                 options = find_nested_options(arg->u.child.child,
 123                                                 child, wanted);
 124                 if (options)
 125                         return options;
 126         }
 127
 128         return NULL;
 129 }
 130
 131 static struct isl_options *find_nested_isl_options(struct isl_args *args,
 132         void *opt)
 133 {
 134         return find_nested_options(args, opt, &isl_options_args);
 135 }
 136
 137 void *isl_ctx_peek_options(isl_ctx *ctx, struct isl_args *args)
 138 {
 139         if (!ctx)
 140                 return NULL;
 141         if (args == &isl_options_args)
 142                 return ctx->opt;
 143         return find_nested_options(ctx->user_args, ctx->user_opt, args);
 144 }
 145
 146 isl_ctx *isl_ctx_alloc_with_options(struct isl_args *args, void *user_opt)
 147 {
 148         struct isl_ctx *ctx = NULL;
 149         struct isl_options *opt = NULL;
 150         int opt_allocated = 0;
 151
 152         if (!user_opt)
 153                 return NULL;
 154
 155         opt = find_nested_isl_options(args, user_opt);
 156         if (!opt) {
 157                 opt = isl_options_new_with_defaults();
 158                 if (!opt)
 159                         goto error;
 160                 opt_allocated = 1;
 161         }
 162
 163         ctx = __isl_calloc_type(struct isl_ctx);
 164         if (!ctx)
 165                 goto error;
 166
 167         if (isl_hash_table_init(ctx, &ctx->id_table, 0))
 168                 goto error;
 169
 170         ctx->stats = isl_calloc_type(ctx, struct isl_stats);
 171         if (!ctx->stats)
 172                 goto error;
 173
 174         ctx->user_args = args;
 175         ctx->user_opt = user_opt;
 176         ctx->opt_allocated = opt_allocated;
 177         ctx->opt = opt;
 178         ctx->ref = 0;
 179
 180         isl_int_init(ctx->zero);
 181         isl_int_set_si(ctx->zero, 0);
 182
 183         isl_int_init(ctx->one);
 184         isl_int_set_si(ctx->one, 1);
 185
 186         isl_int_init(ctx->two);
 187         isl_int_set_si(ctx->two, 2);
 188
 189         isl_int_init(ctx->negone);
 190         isl_int_set_si(ctx->negone, -1);
 191
 192         isl_int_init(ctx->normalize_gcd);
 193
 194         ctx->n_cached = 0;
 195         ctx->n_miss = 0;
 196
 197         ctx->error = isl_error_none;
 198
 199         ctx->operations = 0;
 200         isl_ctx_set_max_operations(ctx, ctx->opt->max_operations);
 201
 202         return ctx;
 203 error:
 204         isl_args_free(args, user_opt);
 205         if (opt_allocated)
 206                 isl_options_free(opt);
 207         free(ctx);
 208         return NULL;
 209 }
 210
 211 struct isl_ctx *isl_ctx_alloc()
 212 {
 213         struct isl_options *opt;
 214
 215         opt = isl_options_new_with_defaults();
 216
 217         return isl_ctx_alloc_with_options(&isl_options_args, opt);
 218 }
 219
 220 void isl_ctx_ref(struct isl_ctx *ctx)
 221 {
 222         ctx->ref++;
 223 }
 224
 225 void isl_ctx_deref(struct isl_ctx *ctx)
 226 {
 227         isl_assert(ctx, ctx->ref > 0, return);
 228         ctx->ref--;
 229 }
 230
 231 /* Print statistics on usage.
 232  */
 233 static void print_stats(isl_ctx *ctx)
 234 {
 235         fprintf(stderr, "operations: %lu\n", ctx->operations);
 236 }
 237
 238 void isl_ctx_free(struct isl_ctx *ctx)
 239 {
 240         if (!ctx)
 241                 return;
 242         if (ctx->ref != 0)
 243                 isl_die(ctx, isl_error_invalid,
 244                         "isl_ctx freed, but some objects still reference it",
 245                         return);
 246
 247         if (ctx->opt->print_stats)
 248                 print_stats(ctx);
 249
 250         isl_hash_table_clear(&ctx->id_table);
 251         isl_blk_clear_cache(ctx);
 252         isl_int_clear(ctx->zero);
 253         isl_int_clear(ctx->one);
 254         isl_int_clear(ctx->two);
 255         isl_int_clear(ctx->negone);
 256         isl_int_clear(ctx->normalize_gcd);
 257         isl_args_free(ctx->user_args, ctx->user_opt);
 258         if (ctx->opt_allocated)
 259                 isl_options_free(ctx->opt);
 260         free(ctx->stats);
 261         free(ctx);
 262 }
 263
 264 struct isl_options *isl_ctx_options(isl_ctx *ctx)
 265 {
 266         if (!ctx)
 267                 return NULL;
 268         return ctx->opt;
 269 }
 270
 271 enum isl_error isl_ctx_last_error(isl_ctx *ctx)
 272 {
 273         return ctx->error;
 274 }
 275
 276 void isl_ctx_reset_error(isl_ctx *ctx)
 277 {
 278         ctx->error = isl_error_none;
 279 }
 280
 281 void isl_ctx_set_error(isl_ctx *ctx, enum isl_error error)
 282 {
 283         if (ctx)
 284                 ctx->error = error;
 285 }
 286
 287 void isl_ctx_abort(isl_ctx *ctx)
 288 {
 289         if (ctx)
 290                 ctx->abort = 1;
 291 }
 292
 293 void isl_ctx_resume(isl_ctx *ctx)
 294 {
 295         if (ctx)
 296                 ctx->abort = 0;
 297 }
 298
 299 int isl_ctx_aborted(isl_ctx *ctx)
 300 {
 301         return ctx ? ctx->abort : -1;
 302 }
 303
 304 int isl_ctx_parse_options(isl_ctx *ctx, int argc, char **argv, unsigned flags)
 305 {
 306         if (!ctx)
 307                 return -1;
 308         return isl_args_parse(ctx->user_args, argc, argv, ctx->user_opt, flags);
 309 }
 310
 311 /* Set the maximal number of iterations of "ctx" to "max_operations".
 312  */
 313 void isl_ctx_set_max_operations(isl_ctx *ctx, unsigned long max_operations)
 314 {
 315         if (!ctx)
 316                 return;
 317         ctx->max_operations = max_operations;
 318 }
 319
 320 /* Return the maximal number of iterations of "ctx".
 321  */
 322 unsigned long isl_ctx_get_max_operations(isl_ctx *ctx)
 323 {
 324         return ctx ? ctx->max_operations : 0;
 325 }
 326
 327 /* Reset the number of operations performed by "ctx".
 328  */
 329 void isl_ctx_reset_operations(isl_ctx *ctx)
 330 {
 331         if (!ctx)
 332                 return;
 333         ctx->operations = 0;
 334 }