nvml-sys 0.0.6

#!/usr/bin/env sh
# This file is part of nvml-sys. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/nvml-sys/master/COPYRIGHT. No part of nvml-sys, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
# Copyright © 2016 The developers of nvml-sys. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/nvml-sys/master/COPYRIGHT.


# This script exists because doing complex builds of non-Rust code under Cargo is tedious and error-prone
# Not least because Cargo does not display stdout and stderr 'as it goes'
# This script exists to allow testing of the build without running Cargo


set -e
set -u
set -f


_program_path_find()
{
    if [ "${_program_fattening_program_path+set}" = 'set' ]; then
        printf '%s\n' "$_program_fattening_program_path"

    elif [ "${0%/*}" = "$0" ]; then

        # We've been invoked by the interpreter as, say, bash program
        if [ -r "$0" ]; then
            pwd -P
        # Clutching at straws; probably run via a download, anonymous script, etc, weird execve, etc
        else
            printf '\n'
        fi

    else

        # We've been invoked with a relative or absolute path (also when invoked via PATH in a shell)

        _program_path_find_parentPath()
        {
            parentPath="${scriptPath%/*}"
            if [ -z "$parentPath" ]; then
                parentPath='/'
            fi
            cd "$parentPath" 1>/dev/null
        }

        # pdksh / mksh have problems with unsetting a variable that was never set...
        if [ "${CDPATH+set}" = 'set' ]; then
            unset CDPATH
        fi

        if command -v realpath 1>/dev/null 2>/dev/null; then
            (
                scriptPath="$(realpath "$0")"

                _program_path_find_parentPath
                pwd -P
            )
        elif command -v readlink 1>/dev/null 2>/dev/null; then
            (
                scriptPath="$0"

                while [ -L "$scriptPath" ]
                do
                    _program_path_find_parentPath
                    scriptPath="$(readlink "$scriptPath")"
                done

                _program_path_find_parentPath
                pwd -P
            )
        else
            # This approach will fail in corner cases where the script itself is a symlink in a path not parallel with the concrete script
            (
                scriptPath="$0"

                _program_path_find_parentPath
                pwd -P
            )
        fi

    fi
}

build_under_cargo_fail()
{
	local message="$1"
	
	printf 'build-under-cargo:FAIL:%s\n' "$message" 1>&2
	exit 1
}

_build_under_cargo_reRunIfChanged_print()
{
	local folderOrFilePath="$1"
	printf 'cargo:rerun-if-changed=%s\n' "$folderOrFilePath"
}

_build_under_cargo_reRunIfChanged()
{
	local folderOrFilePath="$1"
	
	case "$folderOrFilePath" in
		
		*/temporary/*)
			return 0
		;;
	
	esac
	
	if [ -f "$folderOrFilePath" ]; then
		_build_under_cargo_reRunIfChanged_print "$folderOrFilePath"
	elif [ -d "$folderOrFilePath" ]; then
		_build_under_cargo_reRunIfChanged_print "$folderOrFilePath"
		
		local child
		set +f
		for child in "$folderOrFilePath"/*
		do
			set -f
			_build_under_cargo_reRunIfChanged "$child"
		done
		set f
	fi
}

build_under_cargo_reRunIfAnyChanged()
{
	cd "$CARGO_MANIFEST_DIR" 1>/dev/null 2>/dev/null

		local folderOrFilePath
		for folderOrFilePath in "$@"
		do
			if [ -e "$folderOrFilePath" ]; then
				_build_under_cargo_reRunIfChanged "$folderOrFilePath"
			else
				_build_under_cargo_reRunIfChanged_print "$folderOrFilePath"
			fi
		done
		
	cd - 1>/dev/null 2>/dev/null
}

build_under_cargo_determinePmdkRootFolderPath()
{
	if [ -z "${OUT_DIR+undefined}" ]; then
		pmdkRootFolderPath="$CARGO_MANIFEST_DIR"/bindgen-wrapper.conf.d/temporary/root
	else
		pmdkRootFolderPath="$OUT_DIR"/root
	fi
	
	if [ ! -d "$pmdkRootFolderPath" ]; then
		needsCompilation='true'
	fi
}

build_under_cargo_compileIfRequired()
{
	if $needsCompilation; then
		"$CARGO_MANIFEST_DIR"/tools/compile-pmdk
	fi
}

# This is extremely brittle, mostly because of bindgen being brittle
build_under_cargo_generatingRustBindingsToPmdkIfRquired()
{
	local rebuildBindings='false'
	
	if [ ! -d "$rustBindingsFolderPath" ]; then
		rebuildBindings='true'
	elif ! diff "$copyHeadersToKnownLocationForEmbeddedCCodeInRustIncludeFolderPath" "$pmdkIncludeFolderPath" 1>/dev/null 2>/dev/null; then
		rebuildBindings='true'
	fi
	
	if $rebuildBindings; then
		rm -rf "$rustBindingsFolderPath"
		"$CARGO_MANIFEST_DIR"/tools/bindgen-wrapper/bindgen-wrapper
	fi
}

build_under_cargo_copyHeadersToKnownLocationForEmbeddedCCodeInRust()
{
	rm -rf "$copyHeadersToKnownLocationForEmbeddedCCodeInRustIncludeFolderPath"
	mkdir -m 0700 -p "$copyHeadersToKnownLocationForEmbeddedCCodeInRustIncludeFolderPath"
	rsync --quiet --archive "$pmdkIncludeFolderPath"/ "$copyHeadersToKnownLocationForEmbeddedCCodeInRustIncludeFolderPath"/
}

build_under_cargo_outputCargoKeyValuePairs()
{
	printf 'cargo:rustc-link-lib=static-nobundle=libpmem\n'
	printf 'cargo:rustc-link-lib=static-nobundle=libpmemblk\n'
	printf 'cargo:rustc-link-lib=static-nobundle=libpmemcto\n'
	printf 'cargo:rustc-link-lib=static-nobundle=libpmemlog\n'
	printf 'cargo:rustc-link-lib=static-nobundle=libpmemobj\n'
	printf 'cargo:rustc-link-lib=static-nobundle=libpmempool\n'
	#printf 'cargo:rustc-link-lib=static-nobundle=librpmem\n'
	#printf 'cargo:rustc-link-lib=static-nobundle=libvmem\n'
	#printf 'cargo:rustc-link-lib=static-nobundle=libvmemmalloc\n'
	
	# Search path
	printf 'cargo:rustc-link-search=native=%s\n' "$pmdkLibFolderPath"
	
	# Not used by us, but useful for downstream potentially
	printf 'cargo:root=%s\n' "$pmdkRootFolderPath"
	printf 'cargo:include=%s\n' "$pmdkIncludeFolderPath"
	printf 'cargo:libdir=%s\n' "$pmdkLibFolderPath"
}

build_under_cargo_steps()
{	
	local pmdkRootFolderPath
	local needsCompilation='false'
	build_under_cargo_determinePmdkRootFolderPath
	
	local pmdkLibFolderPath="$pmdkRootFolderPath"/usr/lib
	local pmdkIncludeFolderPath="$pmdkRootFolderPath"/usr/include
	local srcFolderPath="$CARGO_MANIFEST_DIR"/src
	local rustBindingsFolderPath="$srcFolderPath"/bindgen
	local copyHeadersToKnownLocationForEmbeddedCCodeInRustIncludeFolderPath="$srcFolderPath"/include
	
	build_under_cargo_compileIfRequired
	
	build_under_cargo_copyHeadersToKnownLocationForEmbeddedCCodeInRust
	
	build_under_cargo_generatingRustBindingsToPmdkIfRquired

	build_under_cargo_outputCargoKeyValuePairs
}

build_under_cargo_main()
{
	case "$#" in
		
		0)
			:
		;;
		
		1)
			case "$1" in
				
				-h|--help)
					printf './build-under-cargo\n'
					printf './build-under-cargo -h|--help\n'
					exit 0
				;;
				
				*)
					build_under_cargo_fail "Does not take any arguments"
				;;
				
			esac
		;;
		
		*)
			build_under_cargo_fail "Does not take any arguments"
		;;
		
	esac
	
	if [ -n "${CARGO_MANIFEST_DIR+set}" ]; then
		printf 'build-under-cargo:%s\n' "Building with CARGO_MANIFEST_DIR '$CARGO_MANIFEST_DIR'" 1>&2
	else
		local programPath="$(_program_path_find)"
		cd "$programPath"/.. 1>/dev/null 2>/dev/null
			local homeFolder="$(pwd)"
		cd - 1>/dev/null 2>/dev/null
		
		printf 'build-under-cargo:%s\n' "Whilst this script is designed to be run under cargo, it can run independently. We're setting CARGO_MANIFEST_DIR to '$homeFolder'" 1>&2
		export CARGO_MANIFEST_DIR="$homeFolder"
	fi
	
	build_under_cargo_steps
}

build_under_cargo_main "$@"