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