[igt-dev] [PATCH i-g-t v4 1/1] tools/generate_cb_buffer: Add script to assemble CB kernel

[Petri Latvala]

On Fri, Feb 21, 2020 at 12:22:43AM -0800, Akeem G Abodunrin wrote:
> This patch adds script and applicable assembly sources, so that we can use
> igt to assemble Clear Batch Buffer kernel for gen7 and gen7.5 devices -
> Resultant header files would be imported to i915, and used as they are...
> 
> With this patch, user need to have mesa configured on their platform,
> before igt could be used to achieve the purpose of assembling the kernel
> from source.
> 
> This is needed for "Security mitigation for Intel Gen7/7.5 HWs"
> Intel ID: PSIRT-TA-201910-001/CVEID: CVE-2019-14615
> 
> v2: Addressed formatting, -g option and other minor issues (Petri)
> V3: Update script due to suggested changes in i915, and Mesa tool
> v4: Update help comment with Mesa build option with meson (Petri)
> 
> Cc: Ville Syrjälä <ville.syrjala at linux.intel.com>
> Cc: Jani Nikula <jani.nikula at intel.com>
> Cc: Joonas Lahtinen <joonas.lahtinen at linux.intel.com>
> Cc: Petri Latvala <petri.latvala at intel.com>
> Cc: Bloomfield Jon <jon.bloomfield at intel.com>
> Signed-off-by: Akeem G Abodunrin <akeem.g.abodunrin at intel.com>
> ---
>  scripts/asm_eu_kernel.sh                | 153 ++++++++++++++++++++++++
>  tools/assembly_source/hsw_clear_buf.asm | 141 ++++++++++++++++++++++
>  tools/assembly_source/ivb_clear_buf.asm | 139 +++++++++++++++++++++
>  3 files changed, 433 insertions(+)
>  create mode 100755 scripts/asm_eu_kernel.sh
>  create mode 100644 tools/assembly_source/hsw_clear_buf.asm
>  create mode 100644 tools/assembly_source/ivb_clear_buf.asm
> 
> diff --git a/scripts/asm_eu_kernel.sh b/scripts/asm_eu_kernel.sh
> new file mode 100755
> index 00000000..1958829c
> --- /dev/null
> +++ b/scripts/asm_eu_kernel.sh
> @@ -0,0 +1,153 @@
> +#!/bin/bash
> +#
> +# SPDX-License-Identifier: MIT
> +#
> +# Copyright © 2020 Intel Corporation
> +#
> +# Permission is hereby granted, free of charge, to any person obtaining a
> +# copy of this software and associated documentation files (the "Software"),
> +# to deal in the Software without restriction, including without limitation
> +# the rights to use, copy, modify, merge, publish, distribute, sublicense,
> +# and/or sell copies of the Software, and to permit persons to whom the
> +# Software is furnished to do so, subject to the following conditions:
> +#
> +# The above copyright notice and this permission notice (including the next
> +# paragraph) shall be included in all copies or substantial portions of the
> +# Software.
> +#
> +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
> +# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
> +# IN THE SOFTWARE.
> +
> +export ASSEMBLY_SOURCE=./tools/assembly_source
> +
> +function get_help {
> +        echo "Usage:    asm_eu_kernel.sh [options]"
> +        echo "Note: hsw_clear_kernel.c/ivb_clear_kernel.c automatically generated by this script should never be modified - it would be imported to i915, to use as it is..."
> +        echo " "
> +        echo "Please make sure your Mesa tool is compiled with "-Dtools=intel" and "-Ddri-drivers=i965", and run this script from IGT source root directory"
> +        echo " "
> +        echo "Options are:"
> +        echo " -h                       display this help message, and exit"
> +        echo " -g=platform              generation of device: use "hsw" for gen7.5, and "ivb" for gen7 devices"
> +        echo " -o=name_of_file          output file to store Mesa assembled c-literal for the device - If none specified, default file will be used - ivb/hsw-cb_assembled"
> +        echo " -m=mesa                  Mesa source directory"
> +        echo " "
> +        echo " Usage example: \"scripts/asm_eu_kernel.sh -g hsw -o hsw_clear_buffer.h -m /path/to/Mesa/source/directory\""
> +}
> +
> +function include_array # $1=array_name
> +{
> +	echo "static const u32 $(basename $1)_clear_kernel[] = {"
> +}
> +function prefix_header # $1=filename $2=comment
> +{
> +	array_name=$(include_array $1)
> +
> +	cat <<EOF
> +// SPDX-License-Identifier: MIT
> +/*
> + * Copyright © 2020 Intel Corporation
> + *
> + * Generated by: IGT Gpu Tools on $(date)
> + */
> +
> +$array_name
> +EOF
> +}
> +
> +function postfix_footer # filename
> +{
> +	cat <<EOF
> +};
> +EOF
> +}
> +
> +function check_output_file #check output file
> +{
> +        if [ "x$output_file" != "x" ]; then
> +                if [ -f "$output_file" ]; then
> +                        echo -e "Warning: The \"$output_file\" file already exist - choose another file\n"
> +                        get_help
> +                        exit 1
> +                fi
> +        else
> +                # It is okay to overwrite default file created
> +                echo -e "Output file not specified - using default file \"$gen_device-cb_assembled\"\n"
> +                output_file="$gen_device-cb_assembled"
> +        fi
> +}
> +function asm_cb_kernel # as-root <args>
> +{
> +        check_output_file
> +
> +        # Using i965_asm tool to assemble hex file from assembly source
> +        $I965_ASM -g $gen_device -t c_literal  $input_asm_source -o $output_file
> +
> +        # Generate header file
> +        if [ "$gen_device" == "hsw" ]; then
> +                echo "Generating gen7.5 CB Kernel assembled file \"hsw_clear_kernel.c\" for i915 driver..."
> +
> +                i915_filename=hsw_clear_kernel.c
> +                prefix_header $gen_device > $i915_filename
> +                cat $output_file >> $i915_filename
> +                postfix_footer $i915_filename >> $i915_filename
> +
> +        elif [ "$gen_device" == "ivb" ]; then
> +                echo "Generating gen7 CB Kernel assembled file \"ivb_clear_kernel.c\" for i915 driver..."
> +
> +                i915_filename=ivb_clear_kernel.c
> +                prefix_header $gen_device > $i915_filename
> +                cat $output_file >> $i915_filename
> +                postfix_footer $i915_filename >> $i915_filename
> +        fi
> +}
> +
> +while getopts "hg:o:m:" opt; do
> +	case $opt in
> +		h) get_help; exit 0;;
> +		g) gen_device="$OPTARG" ;;
> +		o) output_file="$OPTARG" ;;
> +                m) mesa_dir="$OPTARG" ;;
> +		\?)
> +			echo -e "Unknown option: -$OPTARG\n"
> +			get_help
> +			exit 1
> +			;;
> +	esac
> +done
> +shift $(($OPTIND-1))
> +
> +if [ "x$1" != "x" ]; then
> +	echo -e "Unknown option: $1\n"
> +	get_help
> +	exit 1
> +fi
> +
> +I965_ASM="$mesa_dir/build/debug/src/intel/tools/i965_asm"

Should this be $mesa_dir/build/src/intel/tools/i965_asm instead?


After changing that I get

# scripts/asm_eu_kernel.sh -m ~/src/mesa -ghsw
Output file not specified - using default file "hsw-cb_assembled"

./tools/assembly_source/hsw_clear_buf.asm: 71: syntax error at "<"
Generating gen7.5 CB Kernel assembled file "hsw_clear_kernel.c" for i915 driver...


And then 'hsw-cb_assembled' is an empty file, 'hsw_clear_kernel.c'
contains an empty array but the script exited with success...

Line 71 in the asm is
shr(1)          g3<1>D          sr0<0,1,0>D     12D             { align1 1N };



-- 
Petri Latvala