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 /* Construct an isl_stat indicating whether "b" is not isl_bool_error.
  18  *
  19  * That is, return isl_stat_ok if "b" is not isl_bool_error and
  20  * isl_stat_error if it is.
  21  */
  22 isl_stat isl_stat_non_error_bool(isl_bool b)
  23 {
  24         if (b < 0)
  25                 return isl_stat_error;
  26         return isl_stat_ok;
  27 }
  28
  29 /* Construct an isl_stat indicating whether "obj" is non-NULL.
  30  *
  31  * That is, return isl_stat_ok if "obj" is non_NULL and
  32  * isl_stat_error otherwise.
  33  */
  34 isl_stat isl_stat_non_null(void *obj)
  35 {
  36         if (obj != NULL)
  37                 return isl_stat_ok;
  38         return isl_stat_error;
  39 }
  40
  41 /* Return the negation of "b", where the negation of isl_bool_error
  42  * is isl_bool_error again.
  43  */
  44 isl_bool isl_bool_not(isl_bool b)
  45 {
  46         if (b < 0)
  47                 return isl_bool_error;
  48         if (b == isl_bool_false)
  49                 return isl_bool_true;
  50         return isl_bool_false;
  51 }
  52
  53 /* Create an isl_bool from an integer.
  54  *
  55  * Return isl_bool_false if b is zero, otherwise return isl_bool_true.
  56  * This function never returns isl_bool_error.
  57  */
  58 isl_bool isl_bool_ok(int b)
  59 {
  60         if (b)
  61                 return isl_bool_true;
  62         return isl_bool_false;
  63 }
  64
  65 /* Check that the result of an allocation ("p") is not NULL and
  66  * complain if it is.
  67  * The only exception is when allocation size ("size") is equal to zero.
  68  */
  69 static void *check_non_null(isl_ctx *ctx, void *p, size_t size)
  70 {
  71         if (p || size == 0)
  72                 return p;
  73         isl_die(ctx, isl_error_alloc, "allocation failure", return NULL);
  74 }
  75
  76 /* Prepare for performing the next "operation" in the context.
  77  * Return 0 if we are allowed to perform this operation and
  78  * return -1 if we should abort the computation.
  79  *
  80  * In particular, we should stop if the user has explicitly aborted
  81  * the computation or if the maximal number of operations has been exceeded.
  82  */
  83 int isl_ctx_next_operation(isl_ctx *ctx)
  84 {
  85         if (!ctx)
  86                 return -1;
  87         if (ctx->abort) {
  88                 isl_ctx_set_error(ctx, isl_error_abort);
  89                 return -1;
  90         }
  91         if (ctx->max_operations && ctx->operations >= ctx->max_operations)
  92                 isl_die(ctx, isl_error_quota,
  93                         "maximal number of operations exceeded", return -1);
  94         ctx->operations++;
  95         return 0;
  96 }
  97
  98 /* Call malloc and complain if it fails.
  99  * If ctx is NULL, then return NULL.
 100  */
 101 void *isl_malloc_or_die(isl_ctx *ctx, size_t size)
 102 {
 103         if (isl_ctx_next_operation(ctx) < 0)
 104                 return NULL;
 105         return ctx ? check_non_null(ctx, malloc(size), size) : NULL;
 106 }
 107
 108 /* Call calloc and complain if it fails.
 109  * If ctx is NULL, then return NULL.
 110  */
 111 void *isl_calloc_or_die(isl_ctx *ctx, size_t nmemb, size_t size)
 112 {
 113         if (isl_ctx_next_operation(ctx) < 0)
 114                 return NULL;
 115         return ctx ? check_non_null(ctx, calloc(nmemb, size), nmemb) : NULL;
 116 }
 117
 118 /* Call realloc and complain if it fails.
 119  * If ctx is NULL, then return NULL.
 120  */
 121 void *isl_realloc_or_die(isl_ctx *ctx, void *ptr, size_t size)
 122 {
 123         if (isl_ctx_next_operation(ctx) < 0)
 124                 return NULL;
 125         return ctx ? check_non_null(ctx, realloc(ptr, size), size) : NULL;
 126 }
 127
 128 /* Keep track of all information about the current error ("error", "msg",
 129  * "file", "line") in "ctx".
 130  */
 131 void isl_ctx_set_full_error(isl_ctx *ctx, enum isl_error error, const char *msg,
 132         const char *file, int line)
 133 {
 134         if (!ctx)
 135                 return;
 136         ctx->error = error;
 137         ctx->error_msg = msg;
 138         ctx->error_file = file;
 139         ctx->error_line = line;
 140 }
 141
 142 void isl_handle_error(isl_ctx *ctx, enum isl_error error, const char *msg,
 143         const char *file, int line)
 144 {
 145         if (!ctx)
 146                 return;
 147
 148         isl_ctx_set_full_error(ctx, error, msg, file, line);
 149
 150         switch (ctx->opt->on_error) {
 151         case ISL_ON_ERROR_WARN:
 152                 fprintf(stderr, "%s:%d: %s\n", file, line, msg);
 153                 return;
 154         case ISL_ON_ERROR_CONTINUE:
 155                 return;
 156         case ISL_ON_ERROR_ABORT:
 157                 fprintf(stderr, "%s:%d: %s\n", file, line, msg);
 158                 abort();
 159                 return;
 160         }
 161 }
 162
 163 static struct isl_options *find_nested_options(struct isl_args *args,
 164         void *opt, struct isl_args *wanted)
 165 {
 166         int i;
 167         struct isl_options *options;
 168
 169         if (args == wanted)
 170                 return opt;
 171
 172         for (i = 0; args->args[i].type != isl_arg_end; ++i) {
 173                 struct isl_arg *arg = &args->args[i];
 174                 void *child;
 175
 176                 if (arg->type != isl_arg_child)
 177                         continue;
 178
 179                 if (arg->offset == ISL_ARG_OFFSET_NONE)
 180                         child = opt;
 181                 else
 182                         child = *(void **)(((char *)opt) + arg->offset);
 183
 184                 options = find_nested_options(arg->u.child.child,
 185                                                 child, wanted);
 186                 if (options)
 187                         return options;
 188         }
 189
 190         return NULL;
 191 }
 192
 193 static struct isl_options *find_nested_isl_options(struct isl_args *args,
 194         void *opt)
 195 {
 196         return find_nested_options(args, opt, &isl_options_args);
 197 }
 198
 199 void *isl_ctx_peek_options(isl_ctx *ctx, struct isl_args *args)
 200 {
 201         if (!ctx)
 202                 return NULL;
 203         if (args == &isl_options_args)
 204                 return ctx->opt;
 205         return find_nested_options(ctx->user_args, ctx->user_opt, args);
 206 }
 207
 208 isl_ctx *isl_ctx_alloc_with_options(struct isl_args *args, void *user_opt)
 209 {
 210         struct isl_ctx *ctx = NULL;
 211         struct isl_options *opt = NULL;
 212         int opt_allocated = 0;
 213
 214         if (!user_opt)
 215                 return NULL;
 216
 217         opt = find_nested_isl_options(args, user_opt);
 218         if (!opt) {
 219                 opt = isl_options_new_with_defaults();
 220                 if (!opt)
 221                         goto error;
 222                 opt_allocated = 1;
 223         }
 224
 225         ctx = __isl_calloc_type(struct isl_ctx);
 226         if (!ctx)
 227                 goto error;
 228
 229         if (isl_hash_table_init(ctx, &ctx->id_table, 0))
 230                 goto error;
 231
 232         ctx->stats = isl_calloc_type(ctx, struct isl_stats);
 233         if (!ctx->stats)
 234                 goto error;
 235
 236         ctx->user_args = args;
 237         ctx->user_opt = user_opt;
 238         ctx->opt_allocated = opt_allocated;
 239         ctx->opt = opt;
 240         ctx->ref = 0;
 241
 242         isl_int_init(ctx->zero);
 243         isl_int_set_si(ctx->zero, 0);
 244
 245         isl_int_init(ctx->one);
 246         isl_int_set_si(ctx->one, 1);
 247
 248         isl_int_init(ctx->two);
 249         isl_int_set_si(ctx->two, 2);
 250
 251         isl_int_init(ctx->negone);
 252         isl_int_set_si(ctx->negone, -1);
 253
 254         isl_int_init(ctx->normalize_gcd);
 255
 256         ctx->n_cached = 0;
 257         ctx->n_miss = 0;
 258
 259         isl_ctx_reset_error(ctx);
 260
 261         ctx->operations = 0;
 262         isl_ctx_set_max_operations(ctx, ctx->opt->max_operations);
 263
 264         return ctx;
 265 error:
 266         isl_args_free(args, user_opt);
 267         if (opt_allocated)
 268                 isl_options_free(opt);
 269         free(ctx);
 270         return NULL;
 271 }
 272
 273 struct isl_ctx *isl_ctx_alloc()
 274 {
 275         struct isl_options *opt;
 276
 277         opt = isl_options_new_with_defaults();
 278
 279         return isl_ctx_alloc_with_options(&isl_options_args, opt);
 280 }
 281
 282 void isl_ctx_ref(struct isl_ctx *ctx)
 283 {
 284         ctx->ref++;
 285 }
 286
 287 void isl_ctx_deref(struct isl_ctx *ctx)
 288 {
 289         isl_assert(ctx, ctx->ref > 0, return);
 290         ctx->ref--;
 291 }
 292
 293 /* Print statistics on usage.
 294  */
 295 static void print_stats(isl_ctx *ctx)
 296 {
 297         fprintf(stderr, "operations: %lu\n", ctx->operations);
 298 }
 299
 300 void isl_ctx_free(struct isl_ctx *ctx)
 301 {
 302         if (!ctx)
 303                 return;
 304         if (ctx->ref != 0)
 305                 isl_die(ctx, isl_error_invalid,
 306                         "isl_ctx not freed as some objects still reference it",
 307                         return);
 308
 309         if (ctx->opt->print_stats)
 310                 print_stats(ctx);
 311
 312         isl_hash_table_clear(&ctx->id_table);
 313         isl_blk_clear_cache(ctx);
 314         isl_int_clear(ctx->zero);
 315         isl_int_clear(ctx->one);
 316         isl_int_clear(ctx->two);
 317         isl_int_clear(ctx->negone);
 318         isl_int_clear(ctx->normalize_gcd);
 319         isl_args_free(ctx->user_args, ctx->user_opt);
 320         if (ctx->opt_allocated)
 321                 isl_options_free(ctx->opt);
 322         free(ctx->stats);
 323         free(ctx);
 324 }
 325
 326 struct isl_options *isl_ctx_options(isl_ctx *ctx)
 327 {
 328         if (!ctx)
 329                 return NULL;
 330         return ctx->opt;
 331 }
 332
 333 enum isl_error isl_ctx_last_error(isl_ctx *ctx)
 334 {
 335         return ctx ? ctx->error : isl_error_invalid;
 336 }
 337
 338 /* Return the error message of the last error in "ctx".
 339  */
 340 const char *isl_ctx_last_error_msg(isl_ctx *ctx)
 341 {
 342         return ctx ? ctx->error_msg : NULL;
 343 }
 344
 345 /* Return the file name where the last error in "ctx" occurred.
 346  */
 347 const char *isl_ctx_last_error_file(isl_ctx *ctx)
 348 {
 349         return ctx ? ctx->error_file : NULL;
 350 }
 351
 352 /* Return the line number where the last error in "ctx" occurred.
 353  */
 354 int isl_ctx_last_error_line(isl_ctx *ctx)
 355 {
 356         return ctx ? ctx->error_line : -1;
 357 }
 358
 359 void isl_ctx_reset_error(isl_ctx *ctx)
 360 {
 361         if (!ctx)
 362                 return;
 363         ctx->error = isl_error_none;
 364         ctx->error_msg = NULL;
 365         ctx->error_file = NULL;
 366         ctx->error_line = -1;
 367 }
 368
 369 void isl_ctx_set_error(isl_ctx *ctx, enum isl_error error)
 370 {
 371         isl_ctx_set_full_error(ctx, error, NULL, NULL, -1);
 372 }
 373
 374 void isl_ctx_abort(isl_ctx *ctx)
 375 {
 376         if (ctx)
 377                 ctx->abort = 1;
 378 }
 379
 380 void isl_ctx_resume(isl_ctx *ctx)
 381 {
 382         if (ctx)
 383                 ctx->abort = 0;
 384 }
 385
 386 int isl_ctx_aborted(isl_ctx *ctx)
 387 {
 388         return ctx ? ctx->abort : -1;
 389 }
 390
 391 int isl_ctx_parse_options(isl_ctx *ctx, int argc, char **argv, unsigned flags)
 392 {
 393         if (!ctx)
 394                 return -1;
 395         return isl_args_parse(ctx->user_args, argc, argv, ctx->user_opt, flags);
 396 }
 397
 398 /* Set the maximal number of iterations of "ctx" to "max_operations".
 399  */
 400 void isl_ctx_set_max_operations(isl_ctx *ctx, unsigned long max_operations)
 401 {
 402         if (!ctx)
 403                 return;
 404         ctx->max_operations = max_operations;
 405 }
 406
 407 /* Return the maximal number of iterations of "ctx".
 408  */
 409 unsigned long isl_ctx_get_max_operations(isl_ctx *ctx)
 410 {
 411         return ctx ? ctx->max_operations : 0;
 412 }
 413
 414 /* Reset the number of operations performed by "ctx".
 415  */
 416 void isl_ctx_reset_operations(isl_ctx *ctx)
 417 {
 418         if (!ctx)
 419                 return;
 420         ctx->operations = 0;
 421 }