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

[Petri Latvala]

On Tue, Feb 18, 2020 at 08:35:40AM -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
> 
> Signed-off-by: Akeem G Abodunrin <akeem.g.abodunrin at intel.com>
> ---
>  scripts/asm_eu_kernel.sh                | 149 ++++++++++++++++++++++++
>  tools/assembly_source/hsw_clear_buf.asm | 141 ++++++++++++++++++++++
>  tools/assembly_source/ivb_clear_buf.asm | 139 ++++++++++++++++++++++
>  3 files changed, 429 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..f2669e52
> --- /dev/null
> +++ b/scripts/asm_eu_kernel.sh
> @@ -0,0 +1,149 @@
> +#!/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 "Remember to run this as root"

I can't spot why this would need root.


> +        echo " "
> +        echo "Please make sure your MESA tool is compiled, and run this script from igt home directory"

Mesa written as "Mesa" and IGT written as "IGT". And it's "source root
directory", not "home directory".

Does the assembler require specific build options for Mesa? Note them here.

> +        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 result - otherwise default would be used"

output file to store result - default "name of the default filename"

> +        echo " -m=mesa                  directory specify mesa directory"

"Mesa source directory"

> +        echo " "
> +        echo " Usage example: \"scripts/asm_eu_kernel.sh -g hsw -o hsw_clear_buffer.h -m /home/OgbojuOde/intel_gpu/mesa\""

For an example Mesa directory, use something that's more obviously a placeholder.   -m /path/to/mesa/sources


This script writes two files, does it not? And -o only selects one of
them, other being hardcoded... That could use a mention in the help
text.


> +}
> +
> +function include_guard # $1=filename
> +{
> +	echo "__$(basename $1)__" | tr [:lower:] [:upper:] | tr [:punct:] _
> +}
> +
> +function prefix_header # $1=filename $2=comment
> +{
> +	guard=$(include_guard $1)
> +	comment=$2
> +
> +	cat <<EOF
> +/* SPDX-License-Identifier: MIT */
> +/*
> + * Copyright © 2020 Intel Corporation
> + *
> + * Generate by: Intel-gpu-tools on $(date)

"Generated"

"IGT Gpu Tools"


> + */
> +
> +#ifndef $guard
> +#define $guard
> +
> +#include <linux/types.h>
> +
> +/* $comment */
> +EOF
> +}
> +
> +function postfix_footer # filename
> +{
> +	guard=$(include_guard $1)
> +
> +	cat <<EOF
> +
> +
> +#endif /* $guard */
> +EOF
> +}
> +
> +function asm_cb_kernel # as-root <args>
> +{
> +        if [ -f "$output_file" ]; then
> +                echo -e "Warning: The \"$output_file\" file already exist - choose another file name"
> +                echo -e "Otherwise, it will be overwritten, and default file for i915 will be generated\n"
> +        fi

You print this warning, and yet still overwrite the 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 header file \"gen7_5_clearbuffer.h\" for i915 driver..."
> +
> +                i915_filename=gen7_5_clearbuffer.h
> +                prefix_header $i915_filename "Media CB Kernel for gen7.5 devices" > $i915_filename
> +                cat $output_file >> $i915_filename
> +                postfix_footer $i915_filename >> $i915_filename
> +
> +        elif [ "$gen_device" == "ivb" ]; then
> +                echo "Generating gen7 CB Kernel header file \"gen7_clearbuffer.h\" for i915 driver..."
> +
> +                i915_filename=gen7_clearbuffer.h
> +                prefix_header $i915_filename "Media CB Kernel for gen7 devices" > $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 "Unknown option: -$OPTARG"
> +			get_help
> +			exit 1
> +			;;
> +	esac
> +done
> +shift $(($OPTIND-1))
> +
> +if [ "x$1" != "x" ]; then
> +	echo "Unknown option: $1"
> +	get_help
> +	exit 1
> +fi
> +
> +I965_ASM="$mesa_dir/build/debug/src/intel/tools/i965_asm"
> +if [ ! -f ${I965_ASM} ]; then
> +        echo "i965_asm not found at ${I965_ASM}"
> +        get_help
> +        exit 1
> +fi
> +
> +if [ "x$gen_device" != "x" ]; then
> +        if [ "$gen_device" == "hsw" ]; then
> +                input_asm_source="${ASSEMBLY_SOURCE}/hsw_clear_buf.asm"
> +        elif [ "$gen_device" == "ivb" ]; then
> +                input_asm_source="${ASSEMBLY_SOURCE}/ivb_clear_buf.asm"
> +        else
> +                echo "Unknown platform specified"
> +                get_help
> +                exit 1
> +        fi
> +	asm_cb_kernel
> +fi

If -g is not given at all, the script exits silently.



-- 
Petri Latvala