- Update README file to be slightly more user friendly (i.e., try not to imply user should bugger off and stop asking developer for help)

- Remove ridiculously long and cryptic comment from setup_environment.  Most people will use CUDA_INSTALL_PATH.
- Remove decuda targets from Makefile
- Add check to Makefile to insist that setup_environment was run first
- Add version file (eliminate redundancy) and remove version strings from src/cuda-sim/cuda-sim.cc

[git-p4: depot-paths = "//depot/gpgpu_sim_research/fermi/distribution/": change = 12874]

5 files changed, 28 insertions, 56 deletions

diff --git a/Makefile b/Makefile
index 5edc049..0c7891d 100644
--- a/Makefile
+++ b/Makefile
@@ -60,10 +60,18 @@ else ifeq ($(NVOPENCL_INCDIR),)
 else
 	TARGETS += $(SIM_LIB_DIR)/libOpenCL.so
 endif
-#	TARGETS += decuda_to_ptxplus/decuda_to_ptxplus
 	TARGETS += cuobjdump_to_ptxplus/cuobjdump_to_ptxplus
 
-gpgpusim: makedirs $(TARGETS)
+.PHONY: check_setup_environment
+gpgpusim: check_setup_environment makedirs $(TARGETS)
+
+
+check_setup_environment:
+	@if [ ! -n "$(GPGPUSIM_ROOT)" ]; then \
+		echo "ERROR *** run 'source setup_environment' before 'make'; please see README."; \
+		exit 101; \
+	 else true; \
+	 fi
 
 no_opencl_support:
 	@echo "Warning: gpgpu-sim is building without opencl support. Make sure NVOPENCL_LIBDIR and NVOPENCL_INCDIR are set"
@@ -126,10 +134,6 @@ opencllib: cuda-sim
 	$(MAKE) -C ./libopencl/ depend
 	$(MAKE) -C ./libopencl/
 
-decuda_to_ptxplus/decuda_to_ptxplus:
-	$(MAKE) -C ./decuda_to_ptxplus/ depend 
-	$(MAKE) -C ./decuda_to_ptxplus/
-
 .PHONY: cuobjdump_to_ptxplus/cuobjdump_to_ptxplus
 cuobjdump_to_ptxplus/cuobjdump_to_ptxplus:
 	$(MAKE) -C ./cuobjdump_to_ptxplus/ depend
@@ -143,7 +147,6 @@ makedirs:
 	if [ ! -d $(SIM_OBJ_FILES_DIR)/gpgpu-sim ]; then mkdir -p $(SIM_OBJ_FILES_DIR)/gpgpu-sim; fi;
 	if [ ! -d $(SIM_OBJ_FILES_DIR)/libopencl ]; then mkdir -p $(SIM_OBJ_FILES_DIR)/libopencl; fi;
 	if [ ! -d $(SIM_OBJ_FILES_DIR)/intersim ]; then mkdir -p $(SIM_OBJ_FILES_DIR)/intersim; fi;
-	if [ ! -d $(SIM_OBJ_FILES_DIR)/decuda_to_ptxplus ]; then mkdir -p $(SIM_OBJ_FILES_DIR)/decuda_to_ptxplus; fi;
 
 all:
 	$(MAKE) gpgpusim
@@ -166,7 +169,6 @@ endif
 	$(MAKE) clean -C ./src/cuda-sim/
 	$(MAKE) clean -C ./src/gpgpu-sim/
 	$(MAKE) clean -C ./src/
-#	$(MAKE) clean -C ./decuda_to_ptxplus/
 	$(MAKE) clean -C ./cuobjdump_to_ptxplus/
 	rm -rf $(SIM_LIB_DIR)
 	rm -rf $(SIM_OBJ_FILES_DIR)
diff --git a/README b/README
index d78ddbd..cd3b659 100644
--- a/README
+++ b/README
@@ -1,4 +1,6 @@
-GPGPU-Sim Simulator Version 3.1.0+edits (development branch) $Change$
+Welcome to GPGPU-Sim, a cycle-level simulator modeling contemporary graphics
+processing units (GPUs) running GPU computing workloads written in CUDA or
+OpenCL.  
 
 This version of GPGPU-Sim works with CUDA version 3.1 and 4.0.
 
@@ -23,9 +25,9 @@ support.  Questions answered on a best effort basis.
 
 To submit a bug report, go here: http://www.gpgpu-sim.org/bugs/
 
-
 See Section 2 "INSTALLING, BUILDING and RUNNING GPGPU-Sim" below to get started.
 
+
 1. CONTRIBUTIONS and HISTORY
 
 GPGPU-Sim was created by Tor Aamodt's research group at the University of
@@ -67,12 +69,12 @@ distribution as long as the following software dependencies are satisfied.
 Step 1: Dependencies
 ====================
 
-Download and install the CUDA Toolkit. It is recommended to use version 3.1
-for normal PTX simulation and version 4.0 for cuobjdump support and/or to use
+Download and install the CUDA Toolkit. It is recommended to use version 3.1 for
+normal PTX simulation and version 4.0 for cuobjdump support and/or to use
 PTXPlus (Harware instruction set support). Note that it is possible to have
 multiple versions of the CUDA toolkit installed on a single system -- just
-install them in different directories and update the setup_environment script
-to point to the version you want to use.
+install them in different directories and set your CUDA_INSTALL_PATH
+environment variable to point to the version you want to use.
 
 [Optional] If you want to run OpenCL on the simulator, download and install
 NVIDIA's OpenCL driver from <http://developer.nvidia.com/opencl>.  Update your
@@ -132,19 +134,6 @@ To build the simulator, you first need to configure how you want it to be
 built. From the root directory of the simulator, do the following:
 
 cd v3.x
-
-then open the file 'setup_environment' with your favorite text editor. Read
-the file carefully and modify the environment variables in that file to your
-environment specific paths. In particular, you need to set CUDA_INSTALL_PATH
-correctly. If you set CUDA_INSTALL_PATH in your .bashrc file as per the
-instructions in the cuda toolkit installation, setup_environment will detect
-that automatically, in which case, you don't need to change it in
-setup_environment. The setup_environment script is engineered to work with a
-default system setup, so in the general case you will not need to modify it,
-however, you should still read it carefully to figure out if something specific
-to your system needs to be changed. After you have edited that file, save it
-and run
-
 source setup_environment <build_type>
 
 replace <build_type> with debug or release. Use release if you need faster
@@ -173,10 +162,9 @@ The documentation resides at v3.x/doc/doxygen/html.
 Step 3: Run
 ============
 
-Copy the contents of v3.x/configs/QuadroFX5800/ or v3.x/configs/Fermi/ to your 
-application's working directory.
-These files configure the microarchitecture models to resemble the respective
-GPGPU architectures.
+Copy the contents of v3.x/configs/QuadroFX5800/ or v3.x/configs/Fermi/ to your
+application's working directory.  These files configure the microarchitecture
+models to resemble the respective GPGPU architectures.
 
 To use ptxplus (native ISA) change the following options in the configuration
 file to "1" (Note: you need CUDA version 4.0) as follows:
diff --git a/setup_environment b/setup_environment
index c1288a9..c805ada 100644
--- a/setup_environment
+++ b/setup_environment
@@ -1,26 +1,7 @@
 # see README before running this
 
 if [ ! -n "$CUDA_INSTALL_PATH" ]; then
-
-	# Be sure to compile GPGPU-Sim with the same version of the CUDA
-	# Toolkit that you use to compile an application you want to run on
-	# GPGPU-Sim.
-	#
-	# If you need to use multiple CUDA Toolkit versions (e.g., one for
-	# GPGPU-Sim, and another for some other project), then you can change
-	# the following line to point to a local install of the CUDA Toolkit
-	# (this should be a verson that GPGPU-Sim supports).
-	
-	MYCUDA_INSTALL_PATH=$HOME/nvcuda/4.2.9/cuda
-
-	if [ -d $MYCUDA_INSTALL_PATH ]; then
-		export CUDA_INSTALL_PATH=$MYCUDA_INSTALL_PATH
-	fi
-fi
-if [ ! -n "$CUDA_INSTALL_PATH" ]; then
-	echo "";
-	echo "ERROR ** Install CUDA Toolkit then set CUDA_INSTALL_PATH or edit this file.";
-	echo "";
+	echo "ERROR ** Install CUDA Toolkit and set CUDA_INSTALL_PATH.";
 	return;
 fi
 
@@ -57,8 +38,8 @@ fi
 # static link setup in prior GPGPU-Sim releases.
 export LD_LIBRARY_PATH=`echo $LD_LIBRARY_PATH | sed -re 's/.*gpgpu_sim.*(release|debug)://'`
 export LD_LIBRARY_PATH=$GPGPUSIM_ROOT/lib/$GPGPUSIM_CONFIG:$LD_LIBRARY_PATH
-export PATH=`echo $PATH | sed "s#$GPGPUSIM_ROOT/decuda/:$GPGPUSIM_ROOT/bin:$CUDA_INSTALL_PATH/bin:##"`
-export PATH=$GPGPUSIM_ROOT/decuda/:$GPGPUSIM_ROOT/bin:$CUDA_INSTALL_PATH/bin:$PATH
+export PATH=`echo $PATH | sed "s#$GPGPUSIM_ROOT/bin:$CUDA_INSTALL_PATH/bin:##"`
+export PATH=$GPGPUSIM_ROOT/bin:$CUDA_INSTALL_PATH/bin:$PATH
 
 # The following sets OPENCL_REMOTE_GPU_HOST which is used by GPGPU-Sim to
 # SSH to remote node to generate PTX for OpenCL kernels when running on 
diff --git a/src/cuda-sim/cuda-sim.cc b/src/cuda-sim/cuda-sim.cc
index 81f255e..7fa13b2 100644
--- a/src/cuda-sim/cuda-sim.cc
+++ b/src/cuda-sim/cuda-sim.cc
@@ -1371,8 +1371,7 @@ kernel_info_t *gpgpu_opencl_ptx_sim_init_grid(class function_info *entry,
    return result;
 }
 
-const char *g_gpgpusim_build_string = "$Change$";
-const char *g_gpgpusim_version_string = "3.1.0+edits (development branch)";
+#include "../../version"
 
 void print_splash()
 {
@@ -1380,7 +1379,7 @@ void print_splash()
    if ( !splash_printed ) {
       unsigned build=0;
       sscanf(g_gpgpusim_build_string, "$Change"": %u $", &build);
-      fprintf(stdout, "\n\n        *** GPGPU-Sim Simulator Version %s (build %u) ***\n\n\n", g_gpgpusim_version_string, build );
+      fprintf(stdout, "\n\n        *** %s [build %u] ***\n\n\n", g_gpgpusim_version_string, build );
       splash_printed=1;
    }
 }
diff --git a/version b/version
new file mode 100644
index 0000000..f4afe4f
--- /dev/null
+++ b/version
@@ -0,0 +1,2 @@
+const char *g_gpgpusim_version_string = "GPGPU-Sim Simulator Version 3.1.0+edits (development branch)";
+const char *g_gpgpusim_build_string   = "$Change: 12865 $";