path: root/src/cuda-sim/ptx_loader.cc

// Copyright (c) 2009-2011, Tor M. Aamodt
// The University of British Columbia
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
// 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.
// Neither the name of The University of British Columbia nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.

#include "ptx_loader.h"
#include "ptx_ir.h"
#include "cuda-sim.h"
#include "ptx_parser.h"
#include <unistd.h>
#include <dirent.h>
#include <fstream>

/// globals

memory_space *g_global_mem;
memory_space *g_tex_mem;
memory_space *g_surf_mem;
memory_space *g_param_mem;
bool g_override_embedded_ptx = false;

/// extern prototypes

extern int ptx_parse();
extern int ptx__scan_string(const char*);

extern std::map<unsigned,const char*> get_duplicate();

const char *g_ptxinfo_filename;
extern int ptxinfo_parse();
extern int ptxinfo_debug;
extern FILE *ptxinfo_in;

static bool g_save_embedded_ptx;
bool g_keep_intermediate_files;
bool m_ptx_save_converted_ptxplus;

bool keep_intermediate_files() {return g_keep_intermediate_files;}

void ptx_reg_options(option_parser_t opp)
{
   option_parser_register(opp, "-save_embedded_ptx", OPT_BOOL, &g_save_embedded_ptx, 
                "saves ptx files embedded in binary as <n>.ptx",
                "0");
   option_parser_register(opp, "-keep", OPT_BOOL, &g_keep_intermediate_files, 
                "keep intermediate files created by GPGPU-Sim when interfacing with external programs",
                "0");
   option_parser_register(opp, "-gpgpu_ptx_save_converted_ptxplus", OPT_BOOL,
                &m_ptx_save_converted_ptxplus,
                "Saved converted ptxplus to a file",
                "0");
}

void print_ptx_file( const char *p, unsigned source_num, const char *filename )
{
   printf("\nGPGPU-Sim PTX: file _%u.ptx contents:\n\n", source_num );
   char *s = strdup(p);
   char *t = s;
   unsigned n=1;
   while ( *t != '\0'  ) {
      char *u = t;
      while ( (*u != '\n') && (*u != '\0') ) u++;
      unsigned last = (*u == '\0');
      *u = '\0';
      const ptx_instruction *pI = ptx_instruction_lookup(filename,n);
      char pc[64];
      if( pI && pI->get_PC() )
         snprintf(pc,64,"%4u", pI->get_PC() );
      else 
         snprintf(pc,64,"    ");
      printf("    _%u.ptx  %4u (pc=%s):  %s\n", source_num, n, pc, t );
      if ( last ) break;
      t = u+1;
      n++;
   }
   free(s);
   fflush(stdout);
}

char* gpgpu_ptx_sim_convert_ptx_and_sass_to_ptxplus(const std::string ptxfilename, const std::string elffilename, const std::string sassfilename)
{

	printf("GPGPU-Sim PTX: converting EMBEDDED .ptx file to ptxplus \n");

    char fname_ptxplus[1024];
    snprintf(fname_ptxplus,1024,"_ptxplus_XXXXXX");
    int fd4=mkstemp(fname_ptxplus);
    close(fd4);

	// Run cuobjdump_to_ptxplus
	char commandline[1024];
	int result;
	snprintf(commandline, 1024, "$GPGPUSIM_ROOT/build/$GPGPUSIM_CONFIG/cuobjdump_to_ptxplus/cuobjdump_to_ptxplus %s %s %s %s",
			ptxfilename.c_str(),
			sassfilename.c_str(),
			elffilename.c_str(),
			fname_ptxplus);
	fflush(stdout);
	printf("GPGPU-Sim PTX: calling cuobjdump_to_ptxplus\ncommandline: %s\n", commandline);
	result = system(commandline);
	if(result){printf("GPGPU-Sim PTX: ERROR ** could not execute %s\n", commandline); exit(1);}


	// Get ptxplus from file
	std::ifstream fileStream(fname_ptxplus, std::ios::in);
	std::string text, line;
	while(getline(fileStream,line)) {
		text += (line + "\n");
	}
	fileStream.close();

	char* ptxplus_str = new char [strlen(text.c_str())+1];
	strcpy(ptxplus_str, text.c_str());

	if (!m_ptx_save_converted_ptxplus){
		char rm_commandline[1024];

		snprintf(rm_commandline,1024,"rm -f %s", fname_ptxplus);

		printf("GPGPU-Sim PTX: removing temporary files using \"%s\"\n", rm_commandline);
		int rm_result = system(rm_commandline);
		if( rm_result != 0 ) {
			printf("GPGPU-Sim PTX: ERROR ** while removing temporary files %d\n", rm_result);
			exit(1);
		}
	}
	printf("GPGPU-Sim PTX: DONE converting EMBEDDED .ptx file to ptxplus \n");

	return ptxplus_str;
}


symbol_table *gpgpu_ptx_sim_load_ptx_from_string( const char *p, unsigned source_num )
{
    char buf[1024];
    snprintf(buf,1024,"_%u.ptx", source_num );
    if( g_save_embedded_ptx ) {
       FILE *fp = fopen(buf,"w");
       fprintf(fp,"%s",p);
       fclose(fp);
    }
    symbol_table *symtab=init_parser(buf);
    ptx__scan_string(p);
    int errors = ptx_parse ();
    if ( errors ) {
        char fname[1024];
        snprintf(fname,1024,"_ptx_errors_XXXXXX");
        int fd=mkstemp(fname); 
        close(fd);
        printf("GPGPU-Sim PTX: parser error detected, exiting... but first extracting .ptx to \"%s\"\n", fname);
        FILE *ptxfile = fopen(fname,"w");
        fprintf(ptxfile,"%s", p );
        fclose(ptxfile);
        abort();
        exit(40);
    }

    if ( g_debug_execution >= 100 ) 
       print_ptx_file(p,source_num,buf);

    printf("GPGPU-Sim PTX: finished parsing EMBEDDED .ptx file %s\n",buf);
    return symtab;
}

void fix_duplicate_errors(char fname2[1024]) {
	char tempfile[1024] = "_temp_ptx";
	char commandline[1024];

	// change the name of the ptx file to _temp_ptx
	snprintf(commandline,1024,"mv %s %s",fname2,tempfile);
	printf("Running: %s\n", commandline);
	int result = system(commandline);
	if (result != 0) {
		printf("GPGPU-Sim PTX: ERROR ** while changing filename from %s to %s", fname2, tempfile);
		exit(1);
	}

	// store all of the ptx into a char array
	FILE *ptxsource = fopen(tempfile,"r");
	fseek(ptxsource, 0, SEEK_END);
	long filesize = ftell(ptxsource);
	rewind(ptxsource);
	char *ptxdata = (char*)malloc((filesize+1)*sizeof(char));
	fread(ptxdata, filesize, 1, ptxsource);
	fclose(ptxsource);

	FILE *ptxdest = fopen(fname2,"w");
	std::map<unsigned,const char*> duplicate = get_duplicate();
	unsigned offset;
	unsigned oldlinenum = 1;
	unsigned linenum;
	char *startptr = ptxdata;
	char *funcptr;
	char *tempptr = ptxdata - 1;
	char *lineptr = ptxdata - 1;

	// recreate the ptx file without duplications
	for (	std::map<unsigned,const char*>::iterator iter = duplicate.begin();
			iter != duplicate.end();
			iter++){
		// find the line of the next error
		linenum = iter->first;
		for (int i = oldlinenum; i < linenum; i++) {
			lineptr = strchr(lineptr + 1, '\n');
		}
		
		// find the end of the current section to be copied over
		// then find the start of the next section that will be copied
		if (strcmp("function", iter->second) == 0) {
			// get location of most recent .func
			while (tempptr < lineptr && tempptr != NULL) {
				funcptr = tempptr;
				tempptr = strstr(funcptr + 1, ".func");
			}

			// get the start of the previous line
			offset = 0;
			while (*(funcptr - offset) != '\n') offset++;

			fwrite(startptr, sizeof(char), funcptr - offset + 1 - startptr, ptxdest);

			//find next location of startptr
			if (*(lineptr + 3) == ';') {
				// for function definitions
				startptr = lineptr + 5;
			} else if (*(lineptr + 3) == '{') {
				// for functions enclosed with curly brackets
				offset = 5;
				unsigned bracket = 1;
				while (bracket != 0) {
					if (*(lineptr + offset) == '{') bracket++;
					else if (*(lineptr + offset) == '}') bracket--;
					offset++;
				}
				startptr = lineptr + offset + 1;
			} else {
				printf("GPGPU-Sim PTX: ERROR ** Unrecognized function format\n");
				abort();
			}
		} else if (strcmp("variable", iter->second) == 0) {
			fwrite(startptr, sizeof(char), (int)(lineptr + 1 - startptr), ptxdest);
			
			//find next location of startptr
			offset = 1;
			while (*(lineptr + offset) != '\n') offset++;
			startptr = lineptr + offset + 1;
		} else {
			printf("GPGPU-Sim PTX: ERROR ** Unsupported duplicate type: %s\n", iter->second);
		}

		oldlinenum = linenum;
	}
	// copy over the rest of the file
	fwrite(startptr, sizeof(char), ptxdata + filesize - startptr, ptxdest);

	// cleanup
	free(ptxdata);
	fclose(ptxdest);
	snprintf(commandline,1024,"rm -f %s",tempfile);
	printf("Running: %s\n", commandline);
	result = system(commandline);
	if (result != 0) {
		printf("GPGPU-Sim PTX: ERROR ** while deleting %s", tempfile);
		exit(1);
	}
}

void gpgpu_ptxinfo_load_from_string( const char *p_for_info, unsigned source_num, unsigned sm_version )
{
    char fname[1024];
    snprintf(fname,1024,"_ptx_XXXXXX");
    int fd=mkstemp(fname); 
    close(fd);

    printf("GPGPU-Sim PTX: extracting embedded .ptx to temporary file \"%s\"\n", fname);
    FILE *ptxfile = fopen(fname,"w");
    fprintf(ptxfile,"%s", p_for_info);
    fclose(ptxfile);

    char fname2[1024];
    snprintf(fname2,1024,"_ptx2_XXXXXX");
    fd=mkstemp(fname2); 
    close(fd);
    char commandline2[4096];
    snprintf(commandline2,4096,"cat %s | sed 's/.version 1.5/.version 1.4/' | sed 's/, texmode_independent//' | sed 's/\\(\\.extern \\.const\\[1\\] .b8 \\w\\+\\)\\[\\]/\\1\\[1\\]/' | sed 's/const\\[.\\]/const\\[0\\]/g' > %s", fname, fname2);
    printf("Running: %s\n", commandline2);
    int result = system(commandline2);
    if( result != 0 ) {
       printf("GPGPU-Sim PTX: ERROR ** while loading PTX (a) %d\n", result);
       printf("               Ensure you have write access to simulation directory\n");
       printf("               and have \'cat\' and \'sed\' in your path.\n");
       exit(1);
    }

    char tempfile_ptxinfo[1024];
    snprintf(tempfile_ptxinfo,1024,"%sinfo",fname);
    char commandline[1024];
    char extra_flags[1024];
    extra_flags[0]=0;

#if CUDART_VERSION >= 3000
    if (sm_version == 0) sm_version = 20;
    extern bool g_cdp_enabled;
    if(!g_cdp_enabled)
        snprintf(extra_flags,1024,"--gpu-name=sm_%u",sm_version);
    else
        snprintf(extra_flags,1024,"--compile-only --gpu-name=sm_%u",sm_version);
#endif

    snprintf(commandline,1024,"$CUDA_INSTALL_PATH/bin/ptxas %s -v %s --output-file  /dev/null 2> %s",
             extra_flags, fname2, tempfile_ptxinfo);
    printf("GPGPU-Sim PTX: generating ptxinfo using \"%s\"\n", commandline);
    result = system(commandline);
    if( result != 0 ) {
    	// 65280 = duplicate errors
    	if (result == 65280) {
    		ptxinfo_in = fopen(tempfile_ptxinfo,"r");
		g_ptxinfo_filename = tempfile_ptxinfo;
		ptxinfo_parse();

    		fix_duplicate_errors(fname2);
    		snprintf(commandline,1024,"$CUDA_INSTALL_PATH/bin/ptxas %s -v %s --output-file  /dev/null 2> %s",
    			 extra_flags, fname2, tempfile_ptxinfo);
    		printf("GPGPU-Sim PTX: regenerating ptxinfo using \"%s\"\n", commandline);
    		result = system(commandline);
	}
	if (result != 0) {
		printf("GPGPU-Sim PTX: ERROR ** while loading PTX (b) %d\n", result);
		printf("               Ensure ptxas is in your path.\n");
		exit(1);
	}
    }

    ptxinfo_in = fopen(tempfile_ptxinfo,"r");
    g_ptxinfo_filename = tempfile_ptxinfo;
    ptxinfo_parse();

    if( ! g_save_embedded_ptx ) {
        snprintf(commandline,1024,"rm -f %s %s %s", fname, fname2, tempfile_ptxinfo);
        printf("GPGPU-Sim PTX: removing ptxinfo using \"%s\"\n", commandline);
        result = system(commandline);
        if( result != 0 ) {
    	    printf("GPGPU-Sim PTX: ERROR ** while loading PTX (c) %d\n", result);
    	    exit(1);
        }
    }
}