#!/usr/bin/perl
###############################################################################
#
# MCX Benchmark and Speed Contest
#
# Author:  Qianqian Fang <q.fang at neu.edu>
# License: GPLv3
# Version: 0.5
# URL:     http://mcx.space/computebench
# Github:  https://github.com/fangq/mcx/
#
###############################################################################
#
# Dependencies:
#
# For Linux and Mac OS: no additional package is needed, Perl is supported by default
#
# For Windows: please install cygwin64 (http://cygwin.com/) or MSYS2 (http://msys2.org/)
#
# Specifically, this script requires Perl 5.x and curl (if curl is not install 
# in the path, mcxcontest.pl looks for the LWP::UserAgent and LWP::Simple perl modules.
#
# How to use:
#    type "mcxcontest.pl --help" to see the format
#
###############################################################################

use strict;
use warnings;
use Term::ANSIColor qw(:constants);

my $MCX="../bin/mcxcl";
my $URL="http://mcx.space/computebench/";
my $POSTURL="http://mcx.space/computebench/gpucontest.cgi";

my %report=();
my $prettyjson=1;

# parse commandline options
my $options='';
my $mcxopt='-n 1e8';
while(my $opt = $ARGV[0]) {
    if($opt =~ /^-[coslnGWL-]/){
        if($opt eq '-s'){
		$options.='s';
	}elsif($opt eq '-c'){
		$prettyjson=0;
	}elsif($opt eq '-l'){
		$options.='l';
	}elsif($opt eq '-L'){
		system("$MCX -L");
		exit 0;
	}elsif($opt eq '-o'){
		shift;
		$mcxopt=shift;
		next;
        }elsif($opt =~ /^-[nGW]$/){
                shift;
                $mcxopt.=" $opt ".shift;
                next;
	}elsif($opt eq '--bin'){
		shift;
		$MCX=shift;
		next;
	}elsif($opt eq '--get'){
		shift;
		$URL=shift;
		next;
	}elsif($opt eq '--post'){
		shift;
		$POSTURL=shift;
		next;
	}elsif($opt eq '--help'){
		printf("mcxcontest - running MCX benchmarks and submit to MCX Speed Contest
	Format: %s <option1> <option2> ...\n
The supported options include (multiple parameters can be used, separated by spaces)
	-s      submit result to MCX Speed Contest by default (will ask if not used)
        -c      print JSON in compact form, otherwise, print in the indented form
	-l      compare your GPU with other GPUs in the database (will ask if not used)
	-L      list all GPUs supported on your system
	-o 'mcx options'   supply additional mcx command line options, such as '-n 1e6'
	-n <num> / -G <01> / -W <w1,w2,..> additional mcx command options add after those in -o
	--bin /path/to/mcxcl  manually specify mcx binary location (default: ../bin/mcx)
	--get url  specify mcx benchmark web link (default: http://mcx.space/computebench)
	--post url specify submission link (default: http://mcx.space/computebench/gpucontest.cgi)\n",
		$0);
		exit 0;
	}else{
		die('invalid command line option');
	}
	shift;
    }else{
        die('invalid command line option');
    }
}

my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
$report{'date'} = sprintf("%.4d-%.2d-%.2d %.2d:%.2d:%.2d", $year+1900, $mon+1, $mday, $hour, $min, $sec);

## perform benchmark

&listgpu(\%report,'gpu',$mcxopt);
&runbench('cube60',\%report,'benchmark1',17.69,$mcxopt);
&runbench('cubesph60b',\%report,'benchmark2',27.02,$mcxopt);
&runbench('cube60planar',\%report,'benchmark3',25.51,$mcxopt);

## assemble report data

$report{'speedsum'}=$report{'benchmark1'}{'speed'}+$report{'benchmark2'}{'speed'}
    +$report{'benchmark3'}{'speed'};
$report{'version'}=1;
$report{'mcxversion'}=$report{'benchmark1'}{'mcxversion'};

print("Speed test completed\nYour device(s) score is ");
print(RED);
printf("%.0f\n",$report{'speedsum'});
print(RESET);

## download report and compare

my $ans='';

if(! ($options=~/l/)){
	print "Do you want to compare your score with other submitted results ([yes]/no)?\n";
	$ans=<STDIN>;
	chomp $ans; 
}
if($options=~/l/ || $ans =~/^yes/i || $ans eq ''){
	&comparegpu($URL);
}
$ans='';

## submit report
if(! ($options=~/s/)){
	print "\nDo you wish to submit your GPU benchmark data to our database (yes/[no])?\n";
	$ans=<STDIN>;
	chomp $ans; 
}
if($options=~/s/ || $ans =~/^yes/i){
	&submitresult(\%report,$POSTURL,$prettyjson);
}
$ans='';

#==============================================================================
sub listgpu(){
	my ($report, $keyname, $mcxopt)=@_;
	my $mcxoutput=`$MCX -L`;

	$mcxoutput=~s/\e\[\d+(?>(;\d+)*)m//g;

	printf("Running '$MCX -L' to inquire GPUs ...\n");

	if($mcxoutput =~ /Global Memory/i){
		my @gpustr=split(/=+\s+[CG]PU .*\s+=+/,$mcxoutput);
		foreach my $gpurec (@gpustr){
			my @gpudata=split(/\n/,$gpurec);
			my %gpuinfo=();
			foreach my $info (@gpudata){
				if($info =~ /Device (\d+) of (\d+)\s*:\s*(.*)$/){
					$gpuinfo{'name'}=$3;
					$gpuinfo{'id'}=$1+0;
					$gpuinfo{'devcount'}=$2+0;
				}elsif($info =~ /Compute Capability\s*:\s*(\d+)\.(\d+)/i){
					$gpuinfo{'major'}=$1+0;
					$gpuinfo{'minor'}=$2+0;
				}elsif($info =~ /Global Memory\s*:\s*(\d+)\s*B/i){
					$gpuinfo{'globalmem'}=$1+0;
				}elsif($info =~ /Constant Memory\s*:\s*(\d+)\s*B/i){
					$gpuinfo{'constmem'}=$1+0;
				}elsif($info =~ /Shared Memory\s*:\s*(\d+)\s*B/i){
					$gpuinfo{'sharedmem'}=$1+0;
				}elsif($info =~ /Registers\s*:\s*(\d+)$/){
					$gpuinfo{'regcount'}=$1+0;
				}elsif($info =~ /Clock Speed\s*:\s*([0-9.]+)\s+GHz/i){
					$gpuinfo{'clock'}=$1*1e6;
				}elsif($info =~ /Compute units\s*:\s*(\d+)$/){
					$gpuinfo{'core'}=$1+0;
				}elsif($info =~ /Number of SM.*\s*:\s*(\d+)$/){
					$gpuinfo{'sm'}=$1+0;
				}elsif($info =~ /Auto-thread\s*:\s*(\d+)$/){
					$gpuinfo{'autothread'}=$1+0;
				}elsif($info =~ /Auto-block\s*:\s*(\d+)$/){
					$gpuinfo{'autoblock'}=$1+0;
				}
			}
			if(%gpuinfo){
				push(@{$report{$keyname}}, \%gpuinfo);
				if(!($mcxopt=~/-G\s+["']*[0-9]+['"]*/ || $mcxopt=~/--gpu\s+['"]*[0-9]+['"]*/)){
					last;
				}
			}
		}
		if(length($report{$keyname})==0){
			die('no GPU found on your system, can not continue');
		}
	}else{
                die('GPU listing failed, output incomplete');
        }
	if($mcxopt=~/-G\s+['"]*([0-9]+)['"]*/ || $mcxopt=~/--gpu\s+['"]*([0-9]+)['"]*/){
		if($1 ne '' && $1>0){
			my @newgpu=();
			my $mask=$1;
			my $count=0;
			if($mask =~/^[01]+$/){
				foreach my $i (split(//,$mask)){
					if($count>=@{$report{$keyname}}){
						last;
					}
					push(@newgpu,$report{$keyname}[$count])  if($i==1);
					$count++;
				}
			}elsif($mask <= @{$report{$keyname}}){
				push(@newgpu,$report{$keyname}[$mask-1]);
			}
			@{$report{$keyname}} = @newgpu;
		}
	}
}

#==============================================================================

sub runbench(){
	my ($benchname, $report, $keyname, $absorb, $mcxopt)=@_;

	my $mcxoutput=`$MCX --bench $benchname $mcxopt`;
	$mcxoutput=~s/\e\[\d+(?>(;\d+)*)m//g;

	printf("Running benchmark '$MCX --bench $benchname $mcxopt' ... ");

	if($mcxoutput =~ /total simulated energy:/){
		my @lines=split(/\n/,$mcxoutput);
		my %bench=();
		my $tstart=0;
		foreach my $line (@lines){
			if($line =~ /np=(d+)\s+nthread=/){
				$bench{'stat'}{'nphoton'}=$1;
			}elsif($line =~ /simulation speed:\s*([-0-9.]+)/){
				$bench{'speed'}=$1+0;
                                printf(RED);
                                printf("Speed: %.0f photon/ms", $bench{'speed'});
                                printf(RESET);
			}elsif($line =~ /total simulated energy:\s*([-0-9.]+)\s*absorbed: ([-0-9.]+)%/){
				$bench{'stat'}{'energytot'}=$1+0;
				$bench{'stat'}{'absorbfrac'}=$2+0;
				$bench{'stat'}{'energyabs'}=$1*0.01*$2;
			}elsif($line =~ /normalization factor alpha=([-0-9.]+)/){
				$bench{'stat'}{'normalizer'}=$1+0;
			}elsif($line =~ /init complete\s*:\s*([0-9.]+)\s+ms/){
				$tstart=$1;
			}elsif($line =~ /kernel complete:\s+([0-9.]+)\s+ms/){
				$bench{'stat'}{'runtime'}=$1-$tstart;
			}elsif($line =~ /\$Rev::.*(\$Date::[^\$]+\$)/){
				$bench{'mcxversion'}=$1;
			}
		}
		if($mcxopt=~/-W\s+['"]*\s*(([0-9.-]+\s*,\s*)*[0-9.-]+)\s*['"]*/ || $mcxopt=~/--workload\s+['"]*\s*(([0-9.-]+\s*,\s*)*[0-9.-]+)\s*['"]*/){
			$bench{'workload'}="[$1]";
        	}
		if(%bench){
			$report{$keyname}=\%bench;
			my $absfrac=$bench{'stat'}{'absorbfrac'};
			if(abs($absfrac - $absorb)/$absorb > 0.1){
				die('$benchname failed (expected $absorb, got $absfrac), can not continue');
			}
		}else{
			die('$benchname failed, output incomplete');
		}
	}else{
                die('$benchname failed, output incomplete');
	}
        print("\n");
}

#==============================================================================

sub comparegpu(){
	my ($url)=@_;
	my $database;
        $database = `curl --silent $url`;

        if(!defined($database)){
                eval("use LWP::Simple; 1") or warn "LWP::Simple is not available: $@";
                $database = get($url);
		die("fail to download database from $url") if(!defined($database));
	}
	my @res=split(/\n/,$database);
	my $pos=0;
	for my $line (@res){
		if($line =~/<span class='score'>(\d+)</ && $report{'speedsum'}>= $1){
			last;
		}
		$pos++;
	}
	my $wid=`tput cols`;
	if($wid eq ''){
	    $wid=80;
	}

	my $maxscore=$report{'speedsum'};
	foreach my $id (($pos-5)..($pos+4)){
		next if($id<0 || $id>$#res);
		my $linewid=$wid-37;
		if($id==$pos){
			printf(RED);
			printf("%-25s:%8.0f [%s]\n", '>> Your GPU <<',$report{'speedsum'},'#' x int($linewid*($report{'speedsum'}/$maxscore)));
			printf(RESET);
		}
		if($res[$id]=~/<td>(.*)<\/td><td>\/\s*(.*)\s*\/<br\/><span class='hostid'>(.*)<\/span><\/td><td><div class='barchart'><span class='score'>(\d+)<\/span>/){
			$maxscore=($4>$maxscore)?$4:$maxscore;
			printf("%-25s:%8.0f [%s]\n",substr($2,0,25),$4,'#' x int($linewid*($4/$maxscore)));
		}
	}
}

#==============================================================================

sub submitresult(){
	use JSON::PP;

	my ($report, $url, $ispretty)=@_;
	my %form=();
	my $ans='';
	my %userinfo=(
	  "name"=>"Please provide your full name (will not publish)",
	  "email"=>"Please provide your email (will not publish)[required]",
	  "institution"=>"What is your institution/company (will not publish)?",
	  "nickname"=>"Please provide your web name/ID (visible on webpage)[required]",
	  "machine"=>"Short description of your computer (OS/version/driver, visible)[required]",
	  "comment"=>"Optional comment"
	);
	my @formitem=('name','email','institution','nickname','machine','comment');
	foreach my $key (@formitem){
		print $userinfo{$key}."\n\t";
		$ans=<STDIN>;
		chomp $ans;
		if(($key eq 'nickname' || $key eq 'email' ||  $key eq 'machine' ) && $ans eq ''){
			while($ans eq ''){
				print "required field, can not be empty, please input again\n\t";
				$ans=<STDIN>;
				chomp $ans;
			}
		}
		$report{'userinfo'}{$key}=$ans;
	}
	$form{'name'}=$report{'userinfo'}{'nickname'};
	$form{'time'}= time();
	$form{'ver'}=substr($report{'mcxversion'},7,100);
	$form{'ver'}=~s/\$//g;
	$form{'b1'}=$report{'benchmark1'}{'speed'};
	$form{'b2'}=$report{'benchmark2'}{'speed'};
	$form{'b3'}=$report{'benchmark3'}{'speed'};
	$form{'score'}=$report{'speedsum'};
	$form{'computer'}=$report{'userinfo'}{'machine'}.":/";
	foreach my $gpu (@{$report{'gpu'}}){
		my $gpuname=$gpu->{'name'};
		$gpuname=~s/\s*GeForce\s*//g;
		$gpuname=~s/\s*NVIDIA\s*//g;
		$form{'computer'}.=$gpuname."/";
	}

	my $json = JSON::PP->new;
        $json = $json->pretty($ispretty);

	$form{'report'}= $json->encode($report);

	print "Do you want to see the full data to be submitted ([yes]/no)?";
	$ans=<STDIN>;
	chomp $ans;
	if($ans =~/^yes/i || $ans eq ''){
		print "---------------- begin data -----------------\n";
		print $json->encode(\%form);
		print "\n----------------- end data ------------------\n";
	}
        $ans='';

	print "\nFinal confirmation - please type enter or yes to submit, type no to cancel ([yes]/no)?";
	$ans=<STDIN>;
	chomp $ans;
	if($ans =~/^yes/i || $ans eq ''){
		my $submitdata=$json->encode(\%form);
		my $content=`curl --header 'Content-Type: application/json' --request POST --data '$submitdata' $url`;
		if($content eq ''){
	                eval("use LWP::UserAgent (); 1")  or warn "LWP::UserAgent is not available: $@";;
			my $ua      = LWP::UserAgent->new(); 
			my $response = $ua->post( $url, \%form);
			$content = $response->decoded_content;
			die("fail to submit benchmark data") if($content eq '');
		}
		if($content=~/success/i){
			print "Submission is successful, please browse http://mcx.space/computebench/ to see the result\n";
		}
	}
}
