Prevent fileio extended, checkin now copies checkout.tcl and cleanup scripts, bsp now support <processor>, git HEAD hash query

Author: Elod Gyorgy

checkin.tcl

@@ -12,6 +12,12 @@ if {[info exists ::create_path]} {
 	set dest_dir [file normalize $script_dir/../src]
 }
 
+if {[info exists ::debug_prevent_fileio]} {
+	set debug_prevent_fileio $::debug_prevent_fileio
+} else {
+	set debug_prevent_fileio 0
+}
+
 puts "INFO: Targeting $dest_dir for export"
 set var_overwrite_ok [dict create]
 
@@ -76,12 +82,24 @@ foreach pf $pf_names {
 	}
 	# For some reason it needs to be made active for report to work
 	platform active $pf
+	set pf_dest [file normalize $dest_dir/$pf/]
 	# Get the xsa
-	set xsa [dict get [platform report -dict $pf] {hw spec}]
-	file copy -force -- "$xsa" $dest_dir/$pf/
-	set pf_subscript $dest_dir/$pf/5_hw_pf_xsa.tcl
-	file copy -force -- $script_dir/sub/hw_pf_xsa.tcl "$pf_subscript"
-	set fid [open "$pf_subscript" a]
+	set xsa [file normalize [dict get [platform report -dict $pf] {hw spec}]]
+	set pf_subscript [file normalize $pf_dest/5_hw_pf_xsa.tcl]
+	
+	if {$debug_prevent_fileio == 0} {
+		# Check if xsa is linked from src already, copy if not
+		if { [file dirname $xsa] ne $pf_dest } {
+			file copy -force -- "$xsa" $pf_dest
+		}
+		file copy -force -- $script_dir/sub/hw_pf_xsa.tcl "$pf_subscript"
+		set fid [open "$pf_subscript" a]
+	} else {
+		puts "TRACE: file copy -force -- \"$xsa\" $pf_dest"
+		puts "TRACE: file copy -force -- $script_dir/sub/hw_pf_xsa.tcl \"$pf_subscript\""
+		set fid stdout
+	}
+	
 	catch {
 		# Export platform config
 		puts $fid "\n"
@@ -90,7 +108,9 @@ foreach pf $pf_names {
 		puts $fid "platform config -extra-compiler-flags pmufw \"[platform config -extra-compiler-flags pmufw]\""
 		puts $fid "platform config -extra-linker-flags pmufw \"[platform config -extra-linker-flags pmufw]\""
 	} result options
-	close $fid
+	if {$debug_prevent_fileio == 0} {
+		close $fid
+	}
 	return -options $options $result
 
 	# Do the domains
@@ -130,16 +150,20 @@ foreach pf $pf_names {
 		set d_subscript $dest_dir/$d/25_standalone_bsp.tcl
 		puts "INFO: Generating $d_subscript."
 
-		set dfid [open $d_subscript w]
+		if {$debug_prevent_fileio == 0} {
+			set dfid [open $d_subscript w]
+		} else {
+			set dfid stdout
+		}
 		set sfid [open $script_dir/sub/standalone_bsp.tcl r]
 		catch {
 			# Get domain properties
 			set proc [dict get [domain report -dict $d] {processor}]
-			# Write to subscript's beginning
-			puts $dfid "set proc \"$proc\""
-			# Copy the rest of the subscript
+			set var_map [list <processor>   $proc   \
+						]
+			# Copy the subcript while replacing variables
 			while { [gets $sfid line] >= 0 } {
-				puts $dfid $line
+				puts $dfid [string map $var_map $line]
 			}
 			# Only SOME of the config params possible
 			set bsp_configs {\
@@ -167,18 +191,14 @@ foreach pf $pf_names {
 			}
 
 		} result options
-		close $dfid
+		if {$debug_prevent_fileio == 0} {
+			close $dfid
+		}
 		close $sfid
 		return -options $options $result
 	}
 }
 
-if {[info exists ::debug_prevent_fileio]} {
-	set debug_prevent_fileio $::debug_prevent_fileio
-} else {
-	set debug_prevent_fileio 0
-}
-
 # Do the applications
 set app_names ""
 if { [catch {app list}] != 0 } {
@@ -342,4 +362,33 @@ foreach app_name $app_names {
 		close $outfile
 	}
 	return -options $options $result
-}
+}
+
+# When all sources are checked into src/, copy checkout script and README too
+if {$debug_prevent_fileio == 0} {
+	file copy -force -- [file normalize $script_dir/checkout.tcl] $dest_dir/
+	file copy -force -- [file normalize $script_dir/README.md] [file normalize $dest_dir/]
+	# Attempt to query git HEAD hash
+	if { [catch { set fid [open "|git -C \"$script_dir\" rev-parse HEAD" r] } errmsg] } {
+		puts "WARNING: $errmsg"
+		puts "WARNING: git command cannot be found (not in PATH?), so could not append $dest_dir/README.md with script versioning info."
+	} elseif { [gets $fid hash] eq -1 } {
+		puts "WARNING: git error so could not append $dest_dir/README.md with script versioning info."
+	} else {
+		set dfid [open [file normalize $dest_dir/README.md] a]
+		catch {
+			puts $dfid "\nThis README.md was created by the following commit hash:\n$hash"
+		} result options
+		close $dfid
+		close $fid
+		return -options $options $result
+	}
+}
+
+# Copy cleanup scripts to ws/, which is the default destination for checkout.tcl
+if {$debug_prevent_fileio == 0} {
+	file copy -force -- [file normalize $script_dir/sub/cleanup._sh] [file normalize $dest_dir/../ws/cleanup.sh]
+	file copy -force -- [file normalize $script_dir/sub/cleanup._cmd] [file normalize $dest_dir/../ws/cleanup.cmd]
+}
+
+puts "INFO: Checked in workspace [getws] to $dest_dir"

checkout.tcl

@@ -1,4 +1,4 @@
-# Run this script to create the Vitis workspace in the ws/ sub-directory
+# Run this script to create the Vitis workspace in the <repo>/ws/ sub-directory
 # If ::create_path global variable is set, the project is created under that path instead of ws/
 
 set script [info script] 
@@ -72,6 +72,16 @@ catch {
 	}
 
 	set scripts [deep_traverse $src_dir "*.tcl"]
+	# Self should be there
+	set selfs [lsearch -all $scripts [file normalize $script]]
+	if { [llength $selfs] eq 0 } {
+		return -code error "ERROR: Self not found while deep searching $src_dir"
+	}
+	# Remove all instances of self to avoid recursive call below
+	foreach idx $selfs {
+		set scripts [lreplace $scripts $idx $idx]
+	}
+	# Order by integer prefix
 	set ordered_scripts [lsort -command sort_by_fileprefix $scripts]
 
 	puts "INFO: Found the following subscripts:"
@@ -89,4 +99,4 @@ catch {
 puts "Changing back working dir to: $popd"
 cd $popd
 
-return -options $options $result
+return -options $options $result

sub/cleanup._cmd

@@ -0,0 +1,24 @@
+@echo off
+rem save current working directory
+pushd %~dp0
+
+rem delete all files from subfolders
+for /d /r %%i in (*) do del /f /q %%i\*
+rem delete all subfolders
+for /d %%i in (*) do rd /S /Q %%i
+
+rem unmark read only from all files
+attrib -R .\* /S
+
+rem mark read only those we wish to keep
+attrib +R .\cleanup.sh
+attrib +R .\cleanup.cmd
+
+rem delete all non read-only
+del /Q /A:-R .\*
+
+rem unmark read-only
+attrib -R .\*
+
+rem restore original working directory
+popd

sub/cleanup._sh

@@ -0,0 +1,14 @@
+# This script is useful for cleaning up the 'project'
+# directory of a Digilent Vivado-project git repository
+###
+# Run the following command to change permissions of
+# this 'cleanup' file if needed:
+# chmod u+x cleanup.sh
+###
+script_dir=$(dirname ${BASH_SOURCE[0]})
+# Remove directories/subdirectories
+find $script_dir -mindepth 1 -type d -exec rm -rf {} +
+# Remove any other files than:
+find $script_dir -type f ! -name 'cleanup.sh' \
+               ! -name 'cleanup.cmd' \
+               -exec rm -rf {} +

sub/standalone_bsp.tcl

@@ -11,6 +11,7 @@ set domain_name [file tail $script_dir]
 # Modify these for custom domain/BSP settings
 set arch "64-bit"
 set os "standalone"
+set proc "<processor>"
 
 domain create -name $domain_name -proc $proc -arch $arch -os $os