source/options.c

   1
   2    /**-------------------------------------------------------------------**
   3     **                              CLooG                                **
   4     **-------------------------------------------------------------------**
   5     **                            options.c                              **
   6     **-------------------------------------------------------------------**
   7     **                  First version: april 19th 2003                   **
   8     **-------------------------------------------------------------------**/
   9
  10
  11 /******************************************************************************
  12  *               CLooG : the Chunky Loop Generator (experimental)             *
  13  ******************************************************************************
  14  *                                                                            *
  15  * Copyright (C) 2001-2005 Cedric Bastoul                                     *
  16  *                                                                            *
  17  * This library is free software; you can redistribute it and/or              *
  18  * modify it under the terms of the GNU Lesser General Public                 *
  19  * License as published by the Free Software Foundation; either               *
  20  * version 2.1 of the License, or (at your option) any later version.         *
  21  *                                                                            *
  22  * This library is distributed in the hope that it will be useful,            *
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU          *
  25  * Lesser General Public License for more details.                            *
  26  *                                                                            *
  27  * You should have received a copy of the GNU Lesser General Public           *
  28  * License along with this library; if not, write to the Free Software        *
  29  * Foundation, Inc., 51 Franklin Street, Fifth Floor,                         *
  30  * Boston, MA  02110-1301  USA                                                *
  31  *                                                                            *
  32  * CLooG, the Chunky Loop Generator                                           *
  33  * Written by Cedric Bastoul, Cedric.Bastoul@inria.fr                         *
  34  *                                                                            *
  35  ******************************************************************************/
  36
  37
  38 #include <stdarg.h>
  39 # include <stdlib.h>
  40 # include <stdio.h>
  41 # include <string.h>
  42 # include "../include/cloog/cloog.h"
  43
  44
  45 /******************************************************************************
  46  *                          Error reporting functions                         *
  47  ******************************************************************************/
  48
  49 void cloog_vmsg(CloogOptions *options, enum cloog_msg_type type,
  50                 const char *msg, va_list ap)
  51 {
  52   const char *type_msg;
  53
  54   if (options && options->quiet &&
  55       (type == CLOOG_WARNING || type == CLOOG_INFO))
  56     return;
  57
  58   switch(type) {
  59   case CLOOG_WARNING:
  60         type_msg = "WARNING";
  61         break;
  62   case CLOOG_INFO:
  63         type_msg = "INFO";
  64         break;
  65   case CLOOG_ERROR:
  66   default:
  67         type_msg = "ERROR";
  68         break;
  69   }
  70   fprintf(stderr, "[CLooG] %s: ", type_msg);
  71   vfprintf(stderr, msg, ap);
  72 }
  73
  74 /**
  75  * Print message to stderr.
  76  * @param msg printf format string
  77  */
  78 void cloog_msg(CloogOptions *options, enum cloog_msg_type type,
  79                 const char *msg, ...)
  80 {
  81   va_list args;
  82
  83   va_start(args, msg);
  84   cloog_vmsg(options, type, msg, args);
  85   va_end(args);
  86 }
  87
  88 /**
  89  * Print error message to stderr and exit.
  90  * @param msg printf format string
  91  */
  92 void cloog_die(const char *msg, ...)
  93 {
  94   va_list args;
  95
  96   va_start(args, msg);
  97   cloog_vmsg(NULL, CLOOG_ERROR, msg, args);
  98   va_end(args);
  99   exit(1);
 100 }
 101
 102 /******************************************************************************
 103  *                          Structure display function                        *
 104  ******************************************************************************/
 105
 106
 107 /**
 108  * cloog_option_print function:
 109  * This function prints the content of a CloogOptions structure (program) into
 110  * a file (foo, possibly stdout).
 111  * - April 19th 2003: first version.
 112  */
 113 void cloog_options_print(FILE * foo, CloogOptions * options)
 114 { fprintf(foo,"Options:\n") ;
 115   fprintf(foo,"OPTIONS FOR LOOP GENERATION\n") ;
 116   fprintf(foo,"l           = %3d,\n",options->l) ;
 117   fprintf(foo,"f           = %3d,\n",options->f) ;
 118   fprintf(foo,"stop        = %3d,\n",options->stop) ;
 119   fprintf(foo,"strides     = %3d,\n",options->strides) ;
 120   fprintf(foo,"sh          = %3d,\n",options->sh);
 121   fprintf(foo,"OPTIONS FOR PRETTY PRINTING\n") ;
 122   fprintf(foo,"esp         = %3d,\n",options->esp) ;
 123   fprintf(foo,"fsp         = %3d,\n",options->fsp) ;
 124   fprintf(foo,"otl         = %3d.\n",options->otl) ;
 125   fprintf(foo,"block       = %3d.\n",options->block) ;
 126   fprintf(foo,"compilable  = %3d.\n",options->compilable) ;
 127   fprintf(foo,"callable    = %3d.\n",options->callable) ;
 128   fprintf(foo,"UNDOCUMENTED OPTIONS FOR THE AUTHOR ONLY\n") ;
 129   fprintf(foo,"leaks       = %3d.\n",options->leaks) ;
 130   fprintf(foo,"nobacktrack = %3d.\n",options->nobacktrack) ;
 131   fprintf(foo,"override    = %3d.\n",options->override) ;
 132   fprintf(foo,"structure   = %3d.\n",options->structure) ;
 133   fprintf(foo,"noscalars   = %3d.\n",options->noscalars) ;
 134   fprintf(foo,"noblocks    = %3d.\n",options->noblocks) ;
 135   fprintf(foo,"nosimplify  = %3d.\n",options->nosimplify) ;
 136 }
 137
 138
 139 /******************************************************************************
 140  *                         Memory deallocation function                       *
 141  ******************************************************************************/
 142
 143
 144 /**
 145  * cloog_options_free function:
 146  * This function frees the allocated memory for a CloogOptions structure.
 147  * - April 19th 2003: first version.
 148  */
 149 void cloog_options_free(CloogOptions *options)
 150 {
 151   free(options);
 152 }
 153
 154
 155 /******************************************************************************
 156  *                            Processing functions                            *
 157  ******************************************************************************/
 158
 159
 160 /**
 161  * cloog_options_help function:
 162  * This function displays the quick help when the user set the option -help
 163  * while calling cloog. Prints are cutted to respect the 509 characters
 164  * limitation of the ISO C 89 compilers.
 165  * - August 5th 2002: first version.
 166  */
 167 void cloog_options_help()
 168 { printf(
 169   "Usage: cloog [ options | file ] ...\n"
 170   "Options for code generation:\n"
 171   "  -l <depth>            Last loop depth to optimize (-1: infinity)\n"
 172   "                        (default setting: -1).\n"
 173   "  -f <depth>            First loop depth to start loop separation (-1: "
 174   "infinity)\n                        (default setting:  1).\n") ;
 175   printf(
 176   "  -stop <depth>         Loop depth to stop code generation (-1: infinity)"
 177   "\n                        (default setting: -1).\n"
 178   "  -strides <boolean>    Handle non-unit strides (1) or not (0)\n"
 179   "                        (default setting:  0).\n") ;
 180   printf(
 181   "\nOptions for pretty printing:\n"
 182   "  -otl <boolean>        Simplify loops running one time (1) or not (0)\n"
 183   "                        (default setting:  1).\n") ;
 184   printf(
 185   "  -esp <boolean>        Allow complex equalities spreading (1) or not (0)\n"
 186   "                        (default setting:  0).\n");
 187   printf(
 188   "  -fsp <level>          First level to begin the spreading\n"
 189   "                        (default setting:  1).\n"
 190   "  -block <boolean>      Make a new statement block per iterator in C\n"
 191   "                        programs (1) or not (0) (default setting: 0).\n") ;
 192   printf(
 193   "  -compilable <number>  Compilable code by using preprocessor (not 0) or"
 194   "\n                        not (0), number being the value of the parameters"
 195   "\n                        (default setting:  0).\n"
 196   "  -callable <boolean>   Testable code by using preprocessor (not 0) or"
 197   "\n                        not (0) (default setting:  0).\n");
 198   printf(
 199   "\nGeneral options:\n"
 200   "  -o <output>           Name of the output file; 'stdout' is a special\n"
 201   "                        value: when used, output is standard output\n"
 202   "                        (default setting: stdout).\n"
 203   "  -v, --version         Display the version information (and more).\n"
 204   "  -q, --quiet           Don't print any informational messages.\n"
 205   "  -h, --help            Display this information.\n\n") ;
 206   printf(
 207   "The special value 'stdin' for 'file' makes CLooG to read data on\n"
 208   "standard input.\n\n"
 209   "For bug reporting or any suggestions, please send an email to the author\n"
 210   "<cedric.bastoul@inria.fr>.\n") ;
 211 }
 212
 213
 214 /**
 215  * cloog_options_version function:
 216  * This function displays some version informations when the user set the
 217  * option -version while calling cloog. Prints are cutted to respect the 509
 218  * characters limitation of the ISO C 89 compilers.
 219  * - August 5th 2002: first version.
 220  */
 221 void cloog_options_version()
 222 { printf("%s       The Chunky Loop Generator\n", cloog_version());
 223   printf(
 224   "-----\n"
 225   "This is a loop generator for scanning Z-polyhedra. It is based on the "
 226   "work of\nF. Quillere and C. Bastoul on high level code generation and of "
 227   "the PolyLib Team\non polyhedral computation. This program is distributed "
 228   "under the terms of the\nGNU Lesser General Public License "
 229   "(details at http://www.gnu.org/licenses/lgpl-2.1.html).\n"
 230   "-----\n") ;
 231   printf(
 232   "It would be fair to refer the following paper in any publication "
 233   "resulting from\nthe use of this software or its library:\n"
 234   "@InProceedings{Bas04,\n"
 235   "author    =  {Cedric Bastoul},\n"
 236   "title     =  {Code Generation in the Polyhedral Model Is Easier Than You "
 237   "Think},\n"
 238   "booktitle =  {PACT'13 IEEE International Conference on Parallel "
 239   "Architecture\n             and Compilation Techniques},\n"
 240   "pages     =  {7--16},\n"
 241   "month     =  {september},\n"
 242   "year      =  2004,\n"
 243   "address   =  {Juan-les-Pins}\n"
 244   "}\n"
 245   "-----\n"
 246   "For any information, please ask the author at "
 247   "<cedric.bastoul@inria.fr>.\n") ;
 248 }
 249
 250
 251 /**
 252  * cloog_options_set function:
 253  * This function sets the value of an option thanks to the user's calling line.
 254  * - option is the value to set,
 255  * - argc are the elements of the user's calling line,
 256  * - number is the number of the element corresponding to the considered option,
 257  *   this function adds 1 to number to pass away the option value.
 258  **
 259  * - August 5th 2002: first version.
 260  * - June 29th 2003: (debug) lack of argument now detected.
 261  */
 262 void cloog_options_set(int * option, int argv, char ** argc, int * number)
 263 { char ** endptr ;
 264
 265   if (*number+1 >= argv)
 266     cloog_die("an option lacks of argument.\n");
 267
 268   endptr = NULL ;
 269   *option = strtol(argc[*number+1],endptr,10) ;
 270   if (endptr != NULL)
 271     cloog_die("value '%s' for option '%s' is not valid.\n",
 272               argc[*number+1], argc[*number]);
 273   *number = *number + 1 ;
 274 }
 275
 276
 277 /**
 278  * cloog_options_malloc function:
 279  * This functions allocate the memory space for a CLoogOptions structure and
 280  * fill its fields with the defaults values. It returns a pointer to the
 281  * allocated CloogOptions structure.
 282  * - April    19th 2003: first version.
 283  * - November 21th 2005: name changed (before it was cloog_options_init).
 284  */
 285 CloogOptions *cloog_options_malloc(CloogState *state)
 286 { CloogOptions * options ;
 287
 288   /* Memory allocation for the CloogOptions structure. */
 289   options = (CloogOptions *)malloc(sizeof(CloogOptions)) ;
 290   if (options == NULL)
 291     cloog_die("memory overflow.\n");
 292
 293   options->state = state;
 294
 295   /* We set the various fields with default values. */
 296   /* OPTIONS FOR LOOP GENERATION */
 297   options->l           = -1 ;  /* Last level to optimize: infinity. */
 298   options->f           =  1 ;  /* First level to optimize: the first. */
 299   options->stop        = -1 ;  /* Generate all the code. */
 300   options->strides     =  0 ;  /* Generate a code with unit strides. */
 301   options->sh          =  0;   /* Compute actual convex hull. */
 302   options->name        = "";
 303   /* OPTIONS FOR PRETTY PRINTING */
 304   options->esp         =  1 ;  /* We don't want Equality SPreading.*/
 305   options->fsp         =  1 ;  /* The First level to SPread is the first. */
 306   options->otl         =  1 ;  /* We want to fire One Time Loops. */
 307   options->block       =  0 ;  /* We don't want to force statement blocks. */
 308   options->compilable  =  0 ;  /* No compilable code. */
 309   options->callable    =  0 ;  /* No callable code. */
 310   options->quiet       =  0;   /* Do print informational messages. */
 311   /* UNDOCUMENTED OPTIONS FOR THE AUTHOR ONLY */
 312   options->leaks       =  0 ;  /* I don't want to print allocation statistics.*/
 313   options->nobacktrack =  0 ;  /* No backtrack in Quillere's algorithm.*/
 314   options->override    =  0 ;  /* I don't want to override CLooG decisions.*/
 315   options->structure   =  0 ;  /* I don't want to print internal structure.*/
 316   options->noblocks    =  0 ;  /* I do want to make statement blocks.*/
 317   options->noscalars   =  0 ;  /* I do want to use scalar dimensions.*/
 318   options->nosimplify  =  0 ;  /* I do want to simplify polyhedra.*/
 319
 320   return options ;
 321 }
 322
 323
 324
 325 /**
 326  * cloog_options_read function:
 327  * This functions reads all the options and the input/output files thanks
 328  * the the user's calling line elements (in argc). It fills a CloogOptions
 329  * structure and the FILE structure corresponding to input and output files.
 330  * - August 5th 2002: first version.
 331  * - April 19th 2003: now in options.c and support of the CloogOptions structure.
 332  */
 333 void cloog_options_read(CloogState *state, int argc, char **argv,
 334                         FILE **input, FILE **output, CloogOptions **options)
 335 { int i, infos=0, input_is_set=0 ;
 336
 337   /* CloogOptions structure allocation and initialization. */
 338   *options = cloog_options_malloc(state);
 339
 340   /* The default output is the standard output. */
 341   *output = stdout ;
 342
 343   for (i=1;i<argc;i++)
 344   if (argv[i][0] == '-')
 345   { if (strcmp(argv[i],"-l")   == 0)
 346     cloog_options_set(&(*options)->l,argc,argv,&i) ;
 347     else
 348     if (strcmp(argv[i],"-f")   == 0)
 349     cloog_options_set(&(*options)->f,argc,argv,&i) ;
 350     else
 351     if (strcmp(argv[i],"-stop")   == 0)
 352     cloog_options_set(&(*options)->stop,argc,argv,&i) ;
 353     else
 354     if (strcmp(argv[i],"-strides")   == 0)
 355     cloog_options_set(&(*options)->strides,argc,argv,&i) ;
 356     else if (strcmp(argv[i],"-sh")   == 0)
 357       cloog_options_set(&(*options)->sh,argc,argv,&i) ;
 358     else
 359     if (strcmp(argv[i],"-otl") == 0)
 360     cloog_options_set(&(*options)->otl,argc,argv,&i) ;
 361     else
 362     if (strcmp(argv[i],"-esp") == 0)
 363     cloog_options_set(&(*options)->esp,argc,argv,&i) ;
 364     else
 365     if (strcmp(argv[i],"-fsp") == 0)
 366     cloog_options_set(&(*options)->fsp,argc,argv,&i) ;
 367     else
 368     if (strcmp(argv[i],"-block") == 0)
 369     cloog_options_set(&(*options)->block,argc,argv,&i) ;
 370     else
 371     if (strcmp(argv[i],"-compilable") == 0)
 372       cloog_options_set(&(*options)->compilable, argc, argv, &i);
 373     else if (strcmp(argv[i], "-callable") == 0)
 374       cloog_options_set(&(*options)->callable, argc, argv, &i);
 375     else
 376     if (strcmp(argv[i],"-loopo") == 0) /* Special option for the LooPo team ! */
 377     { (*options)->esp   = 0 ;
 378       (*options)->block = 1 ;
 379     }
 380     else
 381     if (strcmp(argv[i],"-bipbip") == 0)/* Special option for the author only !*/
 382       (*options)->nobacktrack = 1 ;
 383     else
 384     if (strcmp(argv[i],"-leaks") == 0)
 385     (*options)->leaks = 1 ;
 386     else
 387     if (strcmp(argv[i],"-nobacktrack") == 0)
 388     (*options)->nobacktrack = 1 ;
 389     else
 390     if (strcmp(argv[i],"-override") == 0)
 391     (*options)->override = 1 ;
 392     else
 393     if (strcmp(argv[i],"-noblocks") == 0)
 394     (*options)->noblocks = 1 ;
 395     else
 396     if (strcmp(argv[i],"-noscalars") == 0)
 397     (*options)->noscalars = 1 ;
 398     else
 399     if (strcmp(argv[i],"-nosimplify") == 0)
 400     (*options)->nosimplify = 1 ;
 401     else
 402     if ((strcmp(argv[i],"-struct") == 0) || (strcmp(argv[i],"-structure") == 0))
 403     (*options)->structure = 1 ;
 404     else
 405     if ((strcmp(argv[i],"--help") == 0) || (strcmp(argv[i],"-h") == 0))
 406     { cloog_options_help() ;
 407       infos = 1 ;
 408     }
 409     else
 410     if ((strcmp(argv[i],"--version") == 0) || (strcmp(argv[i],"-v") == 0))
 411     { cloog_options_version() ;
 412       infos = 1 ;
 413     } else if ((strcmp(argv[i],"--quiet") == 0) || (strcmp(argv[i],"-q") == 0))
 414       (*options)->quiet = 1;
 415     else
 416     if (strcmp(argv[i],"-o") == 0)
 417     { if (i+1 >= argc)
 418         cloog_die("no output name for -o option.\n");
 419
 420       /* stdout is a special value, when used, we set output to standard
 421        * output.
 422        */
 423       if (strcmp(argv[i+1],"stdout") == 0)
 424       *output = stdout ;
 425       else
 426       { *output = fopen(argv[i+1],"w") ;
 427         if (*output == NULL)
 428           cloog_die("can't create output file %s.\n", argv[i+1]);
 429       }
 430       i ++ ;
 431     }
 432     else
 433       cloog_msg(*options, CLOOG_WARNING, "unknown %s option.\n", argv[i]);
 434   }
 435   else
 436   { if (!input_is_set)
 437     { input_is_set = 1 ;
 438       (*options)->name = argv[i] ;
 439       /* stdin is a special value, when used, we set input to standard input. */
 440       if (strcmp(argv[i],"stdin") == 0)
 441       *input = stdin ;
 442       else
 443       { *input = fopen(argv[i],"r") ;
 444         if (*input == NULL)
 445           cloog_die("%s file does not exist.\n", argv[i]);
 446       }
 447     }
 448     else
 449       cloog_die("multiple input files.\n");
 450   }
 451   if (!input_is_set)
 452   { if (!infos)
 453       cloog_die("no input file (-h for help).\n");
 454     exit(1) ;
 455   }
 456 }
 457