starpu-max/tools/starpu_perfmodel_recdump.c

/* StarPU --- Runtime system for heterogeneous multicore architectures.
 *
 * Copyright (C) 2011, 2013-2014, 2017  Université de Bordeaux
 * Copyright (C) 2011, 2012, 2013, 2014, 2016  CNRS
 * Copyright (C) 2011  Télécom-SudParis
 *
 * StarPU is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at
 * your option) any later version.
 *
 * StarPU is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * See the GNU Lesser General Public License in COPYING.LGPL for more details.
 */

#if !defined(_WIN32) || defined(__MINGW32__) || defined(__CYGWIN__)
#include <dirent.h>
#include <sys/stat.h>
#endif
#include <config.h>
#include <assert.h>
#include <getopt.h>
#include <unistd.h>
#include <stdio.h>

#include <starpu.h>
#include <common/utils.h>
#include <common/uthash.h>
#include <core/perfmodel/perfmodel.h> // we need to browse the list associated to history-based models
                                      // just like in starpu_perfmodel_plot

#define STRHEADCMP(s, head) strncmp(s, head, strlen(head))


#if defined(_WIN32) && !defined(__CYGWIN__)
#include <windows.h>
#endif

#define PROGNAME "starpu_perfmodel_recdump"

typedef struct _footprint_list {
  struct _footprint_list* next; 
  uint32_t footprint; 
} footprint_list;

footprint_list* add_footprint(footprint_list* list, uint32_t footprint) {
  footprint_list * l = list; 
  while(l) {
    if(l->footprint == footprint) break; 
    l = l->next; 
  }
  if(l) return list; 
  else {
    footprint_list * res = malloc(sizeof(footprint_list)); 
    res->footprint = footprint; 
    res->next = list; 
    return res; 
  }
}

static struct model {
  UT_hash_handle hh;
  char *name;
  struct starpu_perfmodel model;
  footprint_list* footprints; 
} *models;


void get_comb_name(int comb, char* name, int name_size) {
  char* space; 
  struct starpu_perfmodel_arch *arch_comb = starpu_perfmodel_arch_comb_fetch(comb);
  STARPU_ASSERT_MSG(arch_comb->ndevices == 1, "Cannot work with multi-device workers\n"); 
  snprintf(name, name_size, "%s%u", starpu_perfmodel_get_archtype_name(arch_comb->devices[0].type), arch_comb->devices[0].devid);
}

void print_archs(FILE* output) {
  int nb_combs = starpu_perfmodel_get_narch_combs();
  int nb_workers_per_comb[nb_combs]; 
  nb_combs = starpu_perfmodel_get_narch_combs();
  unsigned workerid; int comb; 
  for(comb = 0; comb < nb_combs; comb++) nb_workers_per_comb[comb] = 0; 

  fprintf(output, "%%rec: worker_count\n\n");
  for (workerid = 0; workerid < starpu_worker_get_count(); workerid++)
    {
      struct starpu_perfmodel_arch* arch = starpu_worker_get_perf_archtype(workerid, STARPU_NMAX_SCHED_CTXS);
      int comb = starpu_perfmodel_arch_comb_get(arch->ndevices, arch->devices);
      STARPU_ASSERT(comb >= 0);
      nb_workers_per_comb[comb] += 1; 
    }
  for(comb = 0; comb < nb_combs; comb++) {
    if(nb_workers_per_comb > 0 ) {
      char name[32]; 
      get_comb_name(comb, name, 32); 
      fprintf(output, "Architecture: %s\n", name); 
      fprintf(output, "NbWorkers: %d\n\n", nb_workers_per_comb[comb]); 
    }
  }
}

/* output file name */
static char* poutput = NULL; 
static char* pinput = NULL; 

static void usage()
{
	fprintf(stderr, "Dumps perfmodels to a rec file\n\n");
	fprintf(stderr, "Usage: %s [ output-file ]\n", PROGNAME);
        fprintf(stderr, "\n");
	fprintf(stderr, "If input or output file names are not given, stdin and stdout are used.");
	fprintf(stderr, "\n");
        fprintf(stderr, "Report bugs to <"PACKAGE_BUGREPORT">.");
        fprintf(stderr, "\n");
}

static void parse_args(int argc, char **argv)
{
	int c;

	static struct option long_options[] =
	{
		{"help",      no_argument, NULL, 'h'},
		{"output",     required_argument, NULL, 'o'},
		{0, 0, 0, 0}
	};

	int option_index;
	while ((c = getopt_long(argc, argv, "ho:", long_options, &option_index)) != -1)
	{
		switch (c)
		{
                case 'h': /* display help */
		  usage(); 
		  exit(EXIT_SUCCESS); 
		  break;

		case 'o': 
		  poutput = optarg; 
		  break; 
		case '?':
		default:
			fprintf(stderr, "Unrecognized option: -%c\n", optopt);
		}
	}

	if(optind < argc) {
	  pinput = argv[optind++]; 
	  if(optind < argc) {
	    fprintf(stderr, "Unrecognized argument: %s\n", argv[optind]);
	    exit(EXIT_FAILURE); 
	  }
	}
}

int main(int argc, char **argv)
{
  FILE* output; 
#if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__MINGW32__)
	WSADATA wsadata;
	WSAStartup(MAKEWORD(1,0), &wsadata);
	_STARPU_MSG("Listing perfmodels is not implemented on pure Windows yet\n");
	return 1;
#else 
	parse_args(argc, argv);



	if(poutput != NULL) {
	  output = fopen(poutput, "w+"); 
	  if (!output)
	    {
	      fprintf(stderr, "couldn't open %s for write: %s\n", poutput, strerror(errno));
	      exit(EXIT_FAILURE);
	    }
	} else {
	  output = stdout; 
	}

	if (starpu_init(NULL) != 0)
	{
		fprintf(stderr, "StarPU initialization failure\n");
		exit(EXIT_FAILURE);
	}
	starpu_pause();


	if(pinput) {
	  FILE* input = fopen(pinput, "r");
	  char s[1024], *c;
	  struct model *model, *tmp; 
	  uint32_t footprint = 0;
	  char *model_name = NULL;
	  int ret; 
	  
	  if (!input) {
	      fprintf(stderr, "couldn't open %s for read: %s\n", pinput, strerror(errno));
	      exit(EXIT_FAILURE);
	    }
	  
	  while (fgets(s, sizeof(s), input))  {
	      if (strlen(s) == sizeof(s) - 1)
		{
			fprintf(stderr, "oops, very long line '%s', it's odd\n", s);
			exit(EXIT_FAILURE);
		}

		if (s[0] == '\n')
		{
			/* empty line, end of task */
			if (model_name)
			{
			  /* Try to get already-loaded model */
			  HASH_FIND_STR(models, model_name, model);
			  if (model == NULL)
			    {
			      model = malloc(sizeof(*model));
			      model->name = model_name;
			      model->footprints = NULL; 
			      memset(&model->model, 0, sizeof(model->model));
			      model->model.type = STARPU_PERFMODEL_INVALID;
			      ret = starpu_perfmodel_load_symbol(model_name, &model->model);
			      if (ret == 1)
				{
				  fprintf(stderr, "The performance model for the symbol <%s> could not be loaded\n", model_name);
				  exit(EXIT_FAILURE);
				}
			      HASH_ADD_STR(models, name, model);
			    }
			  else
			    free(model_name);
			  model->footprints = add_footprint(model->footprints, footprint); 
			  model_name = NULL;
			}
			continue;
		}

		/* Get rec field name */
		c = strchr(s, ':');
		if (!c)
		{
			fprintf(stderr, "odd line '%s'\n", s);
			exit(EXIT_FAILURE);
		}
		
		if (!STRHEADCMP(s, "Footprint: "))
		  {
		    footprint = strtoul(s + strlen("Footprint: "), NULL, 16);
		}
		else if (!STRHEADCMP(s, "Model: "))
		{
			model_name = strdup(s + strlen("Model: "));
			model_name[strlen(model_name) - 1] = '\0'; /* Drop '\n' */
		}
	  }
	  
	  
	  /* All models loaded */
	  { 
	    print_archs(output); 

	    fprintf(output, "%%rec: timing\n\n");

	    int nb_combs = starpu_perfmodel_get_narch_combs();
	    
	    HASH_ITER(hh, models, model, tmp) {
	    footprint_list* l = model->footprints, *ltmp;
	    int comb; 
	    while(l) {
	      for(comb = 0; comb < nb_combs; comb++) {
		  char archname[32]; 
		  get_comb_name(comb, archname, 32); 

		  if(!model->model.state || model->model.state->nimpls[comb] == 0){
		    _STARPU_DISP("Symbol %s does not have any implementation on comb %d, not dumping\n", model->name, comb);
		    continue; 
		  }
		  
		  if(model->model.state->nimpls[comb] > 1)  
		    _STARPU_DISP("Warning, more than one implementations in comb %d of symbol %s, using only the first one\n", comb, model->name); 
		  
		  struct starpu_perfmodel_per_arch *arch_model = &model->model.state->per_arch[comb][0];
		  struct starpu_perfmodel_history_list *ptr;
		  
		  ptr = arch_model->list;
		  if(!ptr) 
		    _STARPU_DISP("Implementation %d of symbol %s does not have history based model, not dumping\n", comb,  model->name); 
		  else while(ptr) {
		      struct starpu_perfmodel_history_entry *entry = ptr->entry;
		      if(entry->footprint == l->footprint) {
			fprintf(output, "Name: %s\n", model->name); 
			fprintf(output, "Architecture: %s\n", archname); 
			fprintf(output, "Footprint: %08x\n", l->footprint); 
			fprintf(output, "Mean: %-15e\nStddev: %-15e\n", 
				entry->mean, entry->deviation);
			fprintf(output, "\n");
			break; 
		      }
		      ptr=ptr->next; 
		    }
	      }
	      ltmp = l->next; 
	      free(l); 
	      l = ltmp; 
	    }
	   
	    free(model->name); 
	    HASH_DEL(models, model); 
	    }
	  }
	}
	else 
	
	{     
	  char *path;
	  DIR *dp;
	  struct dirent *ep;
	  
	  path = _starpu_get_perf_model_dir_codelet();
	  dp = opendir(path);
	  if (dp != NULL)
	    {
	      while ((ep = readdir(dp)))
		{
		  if (strcmp(ep->d_name, ".") && strcmp(ep->d_name, "..")) {
		    int comb, nb_combs; 
		    char* symbol = strdup(ep->d_name); 
		    char *dot = strchr(symbol, '.');
		    struct starpu_perfmodel model = {.type = STARPU_PERFMODEL_INVALID }; 
		    
		    if(dot) *dot = '\0'; 
		    STARPU_ASSERT(starpu_perfmodel_load_symbol(symbol, &model) == 0); 
		    if(model.state == NULL) 
		      continue; 


		    nb_combs = starpu_perfmodel_get_narch_combs();
		    for(comb = 0; comb < nb_combs; ++comb) {
			char name[32]; 
			get_comb_name(comb, name, 32); 

			if(!model.state || model.state->nimpls[comb] == 0) {
			  _STARPU_DISP("Symbol %s does not have any implementation on comb %d, not dumping\n", symbol, comb);
			  fprintf(output, "\n");
				continue; 
			}
			
			struct starpu_perfmodel_per_arch *arch_model = &model.state->per_arch[comb][0];
			struct starpu_perfmodel_history_list *ptr;
			
			ptr = arch_model->list;
			if(!ptr) 
			  _STARPU_DISP("Symbol %s for comb %d does not have history based model, not dumping\n", symbol,  comb); 
			else while(ptr) {
			    struct starpu_perfmodel_history_entry *entry = ptr->entry;
			    fprintf(output, "Name: %s\n", symbol); 
			    fprintf(output, "Architecture: %s\n", name); 
			    fprintf(output, "Footprint: %08x\nMean: %-15e\nStddev: %-15e\n", 
				    entry->footprint, entry->mean, entry->deviation);
			    fprintf(output, "\n");

			    ptr=ptr->next; 
			  
			  }
		    }

		  }
                }
	      closedir (dp);
	    }
	  else
	    {
	      _STARPU_DISP("Could not open the perfmodel directory <%s>: %s\n", path, strerror(errno));
	    }

	    print_archs(output); 
	    
	}
	


	starpu_resume();
	starpu_shutdown();

	  return 0;
#endif


}