cleanup: add correct error messages to lttng-get-syscall-inout.sh

[lttng-modules.git] / tools / syscalls / lttng-get-syscall-inout.sh

#!/bin/bash
# SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)

# example usage:
# lttng-get-syscall-inout.sh arm-64 select 5 1

ARCH_NAME=$1
SYSCALL_NAME=$2
NB_ARGS=$3
ARG_NR=$4
TMPFILE=$(mktemp)
GENERIC_INOUT_DESCRIPTION_FILE="$(dirname "$0")/table-syscall-inout.txt"

# Delete temp file on exit
trap 'rm -f "$TMPFILE"' EXIT

if [ "${ARCH_NAME}" = "" ]; then
	echo "Error: Please specify the arch name as first argument" >&2
	exit 1
fi

if [ "${SYSCALL_NAME}" = "" ]; then
	echo "Error: Please specify the system call name as second argument" >&2
	exit 1
fi

if [[ "${NB_ARGS}" = "" ]]; then
	echo "Error: Please specify a number of arguments as third argument" >&2
	exit 1
fi

if [[ "${ARG_NR}" = "" || ${ARG_NR} == 0 ]]; then
	echo "Error: Please specify an argument number larger than 0 as fourth argument" >&2
	exit 1
fi

# Search for the in/out description of a syscall. This function attempts to find
# a matching description in the per-architecture description override file (if it exists)
# and falls back to the generic description file otherwise.
#
# Returns 0 if a description was found and written to the output file, 1 otherwise.
function write_inout_description ()
{
	local arch_name=$1
	local syscall_name=$2
	local nb_args=$3
	local output_file=$4
	local description_files=("$(dirname "$0")/table-syscall-inout-${arch_name}-override.txt" "$GENERIC_INOUT_DESCRIPTION_FILE")
	local match_count

	for file in "${description_files[@]}"; do
		if [ ! -f "$file" ]; then
			continue
		fi

		# Look for the syscall's in/out description
		grep "^syscall ${syscall_name} " "${file}" > "${output_file}" || true

		# Error out if we got more than one syscall
		match_count=$(wc -l < "${output_file}")
		if [ "${match_count}" -gt 1 ]; then
			# Fatal error; invalid description file
			echo "Error: more than one system call match for ${SYSCALL_NAME}" >&2
			exit 1
		elif [ "${match_count}" -eq 1 ]; then
			if ! grep -q "^syscall ${syscall_name} nbargs ${nb_args}" "${output_file}"; then
				echo "Error: number of arguments doesn't match for ${SYSCALL_NAME}" >&2
				exit 1
			fi
			# Description found
			return 0
		fi
	done

	return 1
}

# Abort on error and undefined variable
set -eu


# Default to sc_inout for unknown syscalls
if ! write_inout_description "$ARCH_NAME" "$SYSCALL_NAME" "$NB_ARGS" "$TMPFILE"; then
	echo "Warning: no match for syscall '${SYSCALL_NAME}', set to 'inout'" >&2
	# no match, default to inout
	echo "sc_inout"
	exit 0
fi

# Get the number of argument
SC_ARGS=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) .*/\2/g' "${TMPFILE}")

if [ "${ARG_NR}" -gt "${SC_ARGS}" ]; then
	echo "Error: argument number (${ARG_NR}) for ${SYSCALL_NAME} is larger than number of syscall arguments (${SC_ARGS})" >&2
	exit 1
fi

if [ "${ARG_NR}" == 1 ]; then
	SC_ARG_TYPE=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) rw: (\([^,)]*\).*/\3/g' "${TMPFILE}")
fi

if [ "${ARG_NR}" == 2 ]; then
	SC_ARG_TYPE=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) rw: ([^,]*, \([^,)]*\).*/\3/g' "${TMPFILE}")
fi

if [ "${ARG_NR}" == 3 ]; then
	SC_ARG_TYPE=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) rw: ([^,]*, [^,]*, \([^,)]*\).*/\3/g' "${TMPFILE}")
fi

if [ "${ARG_NR}" == 4 ]; then
	SC_ARG_TYPE=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) rw: ([^,]*, [^,]*, [^,]*, \([^,)]*\).*/\3/g' "${TMPFILE}")
fi

if [ "${ARG_NR}" == 5 ]; then
	SC_ARG_TYPE=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) rw: ([^,]*, [^,]*, [^,]*, [^,]*, \([^,)]*\).*/\3/g' "${TMPFILE}")
fi

if [ "${ARG_NR}" == 6 ]; then
	SC_ARG_TYPE=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) rw: ([^,]*, [^,]*, [^,]*, [^,]*, [^,]*, \([^,)]*\).*/\3/g' "${TMPFILE}")
fi


if [ "${SC_ARG_TYPE}" = "r" ]; then
	echo "sc_in"
fi
if [ "${SC_ARG_TYPE}" = "w" ]; then
	echo "sc_out"
fi
if [ "${SC_ARG_TYPE}" = "rw" ]; then
	echo "sc_inout"
fi

# EOF