pluto_unroll.c

Go to the documentation of this file.

    /*+-----------------------------------------------------------------**
     **                       OpenScop Library                          **
     **-----------------------------------------------------------------**
     **                 extensions/pluto_unroll.c                       **
     **-----------------------------------------------------------------**
     **                   First version: 26/06/2014                     **
     **-----------------------------------------------------------------**

 
 *****************************************************************************
 * OpenScop: Structures and formats for polyhedral tools to talk together    *
 *****************************************************************************
 *    ,___,,_,__,,__,,__,,__,,_,__,,_,__,,__,,___,_,__,,_,__,                *
 *    /   / /  //  //  //  // /   / /  //  //   / /  // /  /|,_,             *
 *   /   / /  //  //  //  // /   / /  //  //   / /  // /  / / /\             *
 *  |~~~|~|~~~|~~~|~~~|~~~|~|~~~|~|~~~|~~~|~~~|~|~~~|~|~~~|/_/  \            *
 *  | G |C| P | = | L | P |=| = |C| = | = | = |=| = |=| C |\  \ /\           *
 *  | R |l| o | = | e | l |=| = |a| = | = | = |=| = |=| L | \# \ /\          *
 *  | A |a| l | = | t | u |=| = |n| = | = | = |=| = |=| o | |\# \  \         *
 *  | P |n| l | = | s | t |=| = |d| = | = | = | |   |=| o | | \# \  \        *
 *  | H | | y |   | e | o | | = |l|   |   | = | |   | | G | |  \  \  \       *
 *  | I | |   |   | e |   | |   | |   |   |   | |   | |   | |   \  \  \      *
 *  | T | |   |   |   |   | |   | |   |   |   | |   | |   | |    \  \  \     *
 *  | E | |   |   |   |   | |   | |   |   |   | |   | |   | |     \  \  \    *
 *  | * |*| * | * | * | * |*| * |*| * | * | * |*| * |*| * | /      \* \  \   *
 *  | O |p| e | n | S | c |o| p |-| L | i | b |r| a |r| y |/        \  \ /   *
 *  '---'-'---'---'---'---'-'---'-'---'---'---'-'---'-'---'          '--'    *
 *                                                                           *
 * Copyright (C) 2014 Inria                                                  *
 *                                                                           *
 * (3-clause BSD license)                                                    *
 * Redistribution and use in source  and binary forms, with or without       *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 * 3. The name of the author may not be used to endorse or promote products  *
 *    derived from this software without specific prior written permission.  *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR      *
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES *
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.   *
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,          *
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT  *
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, *
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY     *
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       *
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF  *
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.         *
 *                                                                           *
 * OpenScop Library, a library to manipulate OpenScop formats and data       *
 * structures. Written by:                                                   *
 * Cedric Bastoul     <Cedric.Bastoul@u-psud.fr> and                         *
 * Louis-Noel Pouchet <Louis-Noel.pouchet@inria.fr>                          *
 *                                                                           *
 *****************************************************************************/


#include <stdlib.h>
#include <string.h>

#include "../include/osl/extensions/pluto_unroll.h"
#include "../include/osl/macros.h"


/*+***************************************************************************
 *                          Structure display function                       *
 *****************************************************************************/


void osl_pluto_unroll_idump(FILE * file,
                            osl_pluto_unroll_p pluto_unroll, int level) {
  int j, first = 1, number=1;

  // Go to the right level.
  for (j = 0; j < level; j++)
    fprintf(file, "|\t");

  if (pluto_unroll != NULL)
    fprintf(file, "+-- osl_pluto_unroll_t\n");
  else
    fprintf(file, "+-- NULL pluto_unroll\n");

  while (pluto_unroll != NULL) {
    // Go to the right level.
    if (!first) {
      // Go to the right level.
      for (j = 0; j < level; j++)
        fprintf(file, "|\t");

      fprintf(file, "|   osl_pluto_unroll_t (node %d)\n", number);
    } else {
      first = 0;
    }

    // A blank line.
    for (j = 0; j <= level+1; j++)
      fprintf(file, "|\t");
    fprintf(file, "\n");
  
    // Display the names of iterators.
    for (j = 0; j <= level; j++)
      fprintf(file, "|\t");
    fprintf(file, "+--iterator: %s\n", pluto_unroll->iter);
  
    // Display the names of iterators.
    for (j = 0; j <= level; j++)
      fprintf(file, "|\t");
    fprintf(file, "+--jam: %i\n", pluto_unroll->jam);
  
    // Display the names of iterators.
    for (j = 0; j <= level; j++)
      fprintf(file, "|\t");
    fprintf(file, "+--factor: %i\n", pluto_unroll->factor);

    pluto_unroll = pluto_unroll->next;

    // Next line.
    if (pluto_unroll != NULL) {
      for (j = 0; j <= level; j++)
        fprintf(file, "|\t");
      fprintf(file, "V\n");
    }
  }

  // The last line.
  for (j = 0; j <= level; j++)
    fprintf(file, "|\t");
  fprintf(file, "\n");
}


void osl_pluto_unroll_dump(FILE * file, osl_pluto_unroll_p pluto_unroll) {
  osl_pluto_unroll_idump(file, pluto_unroll, 0);
}


char * osl_pluto_unroll_sprint(osl_pluto_unroll_p pluto_unroll) {
  
  char* string = NULL;
  char buffer[OSL_MAX_STRING] = { 0 };
  
  strcat(buffer, "# Pluto unroll\n");
  if (pluto_unroll != NULL) {
    strcat(buffer, "1\n");
  } else {
    strcat(buffer, "0\n");
  }
  
  while (pluto_unroll != NULL)
  {
    strcat(buffer, "# Iterator name\n");
    sprintf(buffer + strlen(buffer), "%s\n", pluto_unroll->iter);

    strcat(buffer, "# Jam\n");
    sprintf(buffer + strlen(buffer), "%i\n", pluto_unroll->jam);

    strcat(buffer, "# Factor\n");
    sprintf(buffer + strlen(buffer), "%i\n", pluto_unroll->factor);

    pluto_unroll = pluto_unroll->next;

    strcat(buffer, "# Next\n");
    if (pluto_unroll != NULL) {
      strcat(buffer, "1\n");
    } else {
      strcat(buffer, "0\n");
    }
  }
  
  OSL_realloc(string, char*, (strlen(buffer) + 1) * sizeof(char));
  strcpy(string, buffer);
  
  return string;
}


/*****************************************************************************
 *                               Reading function                            *
 *****************************************************************************/


osl_pluto_unroll_p osl_pluto_unroll_sread(char** input) {
  osl_pluto_unroll_p p = NULL;
  if (osl_util_read_int(NULL, input) == 1) { p = osl_pluto_unroll_malloc(); }
  osl_pluto_unroll_p r = p;
  
  while (p != NULL)
  {
    // iter
    p->iter = osl_util_read_line(NULL, input);
    // jam
    p->jam = osl_util_read_int(NULL, input);
    // factor
    p->factor = osl_util_read_int(NULL, input);
    // Next
    if (osl_util_read_int(NULL, input) == 1) {
      p->next = osl_pluto_unroll_malloc();
    }
    p = p->next;
  }
  
  return r;
}


/*+***************************************************************************
 *                    Memory allocation/deallocation function                *
 *****************************************************************************/


osl_pluto_unroll_p osl_pluto_unroll_malloc() {
  osl_pluto_unroll_p pluto_unroll = NULL;

  OSL_malloc(pluto_unroll, osl_pluto_unroll_p, sizeof(osl_pluto_unroll_t));
  pluto_unroll->iter   = NULL;
  pluto_unroll->jam    = false;
  pluto_unroll->factor = 0;
  pluto_unroll->next   = NULL;

  return pluto_unroll;
}


void osl_pluto_unroll_free(osl_pluto_unroll_p pluto_unroll) {
  if (pluto_unroll != NULL) {
    osl_pluto_unroll_free(pluto_unroll->next);

    free(pluto_unroll->iter);
    free(pluto_unroll); pluto_unroll = NULL;
  }
}


/*+***************************************************************************
 *                            Processing functions                           *
 *****************************************************************************/

void osl_pluto_unroll_fill(osl_pluto_unroll_p pluto_unroll,
                           char const * const iterator_name,
                           bool const jam, int const factor) {
  if (pluto_unroll != NULL) {
    // iter
    if (iterator_name != NULL) {
      OSL_realloc(pluto_unroll->iter,
                  char*, (strlen(iterator_name) + 1) * sizeof(char));
      strcpy(pluto_unroll->iter, iterator_name);
        }
    // jam
    pluto_unroll->jam = jam;
    // factor
    pluto_unroll->factor = factor;
  } else {
    OSL_warning("osl_pluto_unroll_fill can not fill NULL osl_pluto_unroll_p");
  }
}

osl_pluto_unroll_p osl_pluto_unroll_clone(osl_pluto_unroll_p pluto_unroll) {
  osl_pluto_unroll_p p = NULL;
  if (pluto_unroll != NULL) { p = osl_pluto_unroll_malloc(); }
  osl_pluto_unroll_p r = p;
  
  while (pluto_unroll != NULL)
  {
    osl_pluto_unroll_fill(p, pluto_unroll->iter,
                             pluto_unroll->jam,
                             pluto_unroll->factor);
    
    pluto_unroll = pluto_unroll->next;

    if (pluto_unroll != NULL) { p->next = osl_pluto_unroll_malloc(); }
    p = p->next;
  }

  return r;
}

int osl_pluto_unroll_equal(osl_pluto_unroll_p a, osl_pluto_unroll_p b) {
  
  if (a == b) { return 1; }
  
  if (a == NULL && b != NULL) { return 0; }
  if (a != NULL && b == NULL) { return 0; }
  
  while (a != NULL) {
    // Iter
    if (a->iter == NULL && b->iter != NULL) { return 0; }
    if (a->iter != NULL && b->iter == NULL) { return 0; }
    if (a->iter != NULL) {
      if (strcmp(a->iter, b->iter) != 0) { return 0; }
      
    }
    // Jam
    if (a->jam != b->jam) { return 0; }
    // Factor
    if (a->factor != b->factor) { return 0; }
    // Next
    if (a->next == b->next) { return 1; }
    if (a->next == NULL && b->next != NULL) { return 0; }
    if (a->next != NULL && b->next == NULL) { return 0; }
    a = a->next;
    b = b->next;
  }

  return 1;
}


osl_interface_p osl_pluto_unroll_interface() {
  osl_interface_p interface = osl_interface_malloc();
  
  OSL_strdup(interface->URI, OSL_URI_PLUTO_UNROLL);
  interface->idump  = (osl_idump_f)osl_pluto_unroll_idump;
  interface->sprint = (osl_sprint_f)osl_pluto_unroll_sprint;
  interface->sread  = (osl_sread_f)osl_pluto_unroll_sread;
  interface->malloc = (osl_malloc_f)osl_pluto_unroll_malloc;
  interface->free   = (osl_free_f)osl_pluto_unroll_free;
  interface->clone  = (osl_clone_f)osl_pluto_unroll_clone;
  interface->equal  = (osl_equal_f)osl_pluto_unroll_equal;

  return interface;
}