Commit | Line | Data |
---|---|---|
b7150b71 | 1 | #!/bin/bash |
b7cdc182 | 2 | # SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only) |
61baff6e | 3 | # SPDX-FileCopyrightText: 2014-2024 EfficiOS Inc. |
b75d00c4 MD |
4 | |
5 | # example usage: | |
a16d5130 | 6 | # lttng-get-syscall-inout.sh arm-64 select 5 1 |
b75d00c4 | 7 | |
9497697f | 8 | ARCH_NAME=$1 |
b75d00c4 | 9 | SYSCALL_NAME=$2 |
6ae73da4 MJ |
10 | NB_ARGS=$3 |
11 | ARG_NR=$4 | |
2879dbbc | 12 | TMPFILE=$(mktemp) |
9497697f | 13 | GENERIC_INOUT_DESCRIPTION_FILE="$(dirname "$0")/table-syscall-inout.txt" |
2879dbbc MJ |
14 | |
15 | # Delete temp file on exit | |
16 | trap 'rm -f "$TMPFILE"' EXIT | |
17 | ||
a16d5130 MJ |
18 | if [ "${ARCH_NAME}" = "" ]; then |
19 | echo "Error: Please specify the arch name as first argument" >&2 | |
b75d00c4 MD |
20 | exit 1 |
21 | fi | |
22 | ||
b03cf820 | 23 | if [ "${SYSCALL_NAME}" = "" ]; then |
a16d5130 MJ |
24 | echo "Error: Please specify the system call name as second argument" >&2 |
25 | exit 1 | |
26 | fi | |
27 | ||
28 | if [[ "${NB_ARGS}" = "" ]]; then | |
29 | echo "Error: Please specify a number of arguments as third argument" >&2 | |
b75d00c4 MD |
30 | exit 1 |
31 | fi | |
32 | ||
b03cf820 | 33 | if [[ "${ARG_NR}" = "" || ${ARG_NR} == 0 ]]; then |
a16d5130 | 34 | echo "Error: Please specify an argument number larger than 0 as fourth argument" >&2 |
b75d00c4 MD |
35 | exit 1 |
36 | fi | |
37 | ||
9497697f JG |
38 | # Search for the in/out description of a syscall. This function attempts to find |
39 | # a matching description in the per-architecture description override file (if it exists) | |
40 | # and falls back to the generic description file otherwise. | |
41 | # | |
42 | # Returns 0 if a description was found and written to the output file, 1 otherwise. | |
43 | function write_inout_description () | |
44 | { | |
45 | local arch_name=$1 | |
46 | local syscall_name=$2 | |
6ae73da4 MJ |
47 | local nb_args=$3 |
48 | local output_file=$4 | |
9497697f | 49 | local description_files=("$(dirname "$0")/table-syscall-inout-${arch_name}-override.txt" "$GENERIC_INOUT_DESCRIPTION_FILE") |
b03cf820 | 50 | local match_count |
9497697f | 51 | |
b03cf820 | 52 | for file in "${description_files[@]}"; do |
9497697f JG |
53 | if [ ! -f "$file" ]; then |
54 | continue | |
55 | fi | |
56 | ||
57 | # Look for the syscall's in/out description | |
b03cf820 | 58 | grep "^syscall ${syscall_name} " "${file}" > "${output_file}" || true |
9497697f JG |
59 | |
60 | # Error out if we got more than one syscall | |
b03cf820 | 61 | match_count=$(wc -l < "${output_file}") |
9497697f JG |
62 | if [ "${match_count}" -gt 1 ]; then |
63 | # Fatal error; invalid description file | |
b03cf820 | 64 | echo "Error: more than one system call match for ${SYSCALL_NAME}" >&2 |
9497697f JG |
65 | exit 1 |
66 | elif [ "${match_count}" -eq 1 ]; then | |
6ae73da4 MJ |
67 | if ! grep -q "^syscall ${syscall_name} nbargs ${nb_args}" "${output_file}"; then |
68 | echo "Error: number of arguments doesn't match for ${SYSCALL_NAME}" >&2 | |
69 | exit 1 | |
70 | fi | |
9497697f JG |
71 | # Description found |
72 | return 0 | |
73 | fi | |
74 | done | |
75 | ||
76 | return 1 | |
77 | } | |
78 | ||
2879dbbc MJ |
79 | # Abort on error and undefined variable |
80 | set -eu | |
81 | ||
b75d00c4 | 82 | |
2879dbbc | 83 | # Default to sc_inout for unknown syscalls |
6ae73da4 | 84 | if ! write_inout_description "$ARCH_NAME" "$SYSCALL_NAME" "$NB_ARGS" "$TMPFILE"; then |
2879dbbc | 85 | echo "Warning: no match for syscall '${SYSCALL_NAME}', set to 'inout'" >&2 |
b75d00c4 MD |
86 | # no match, default to inout |
87 | echo "sc_inout" | |
88 | exit 0 | |
89 | fi | |
90 | ||
2879dbbc MJ |
91 | # Get the number of argument |
92 | SC_ARGS=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) .*/\2/g' "${TMPFILE}") | |
b75d00c4 | 93 | |
2879dbbc | 94 | if [ "${ARG_NR}" -gt "${SC_ARGS}" ]; then |
b03cf820 | 95 | echo "Error: argument number (${ARG_NR}) for ${SYSCALL_NAME} is larger than number of syscall arguments (${SC_ARGS})" >&2 |
b75d00c4 MD |
96 | exit 1 |
97 | fi | |
98 | ||
2879dbbc MJ |
99 | if [ "${ARG_NR}" == 1 ]; then |
100 | SC_ARG_TYPE=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) rw: (\([^,)]*\).*/\3/g' "${TMPFILE}") | |
b75d00c4 MD |
101 | fi |
102 | ||
2879dbbc MJ |
103 | if [ "${ARG_NR}" == 2 ]; then |
104 | SC_ARG_TYPE=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) rw: ([^,]*, \([^,)]*\).*/\3/g' "${TMPFILE}") | |
b75d00c4 MD |
105 | fi |
106 | ||
2879dbbc MJ |
107 | if [ "${ARG_NR}" == 3 ]; then |
108 | SC_ARG_TYPE=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) rw: ([^,]*, [^,]*, \([^,)]*\).*/\3/g' "${TMPFILE}") | |
b75d00c4 MD |
109 | fi |
110 | ||
2879dbbc MJ |
111 | if [ "${ARG_NR}" == 4 ]; then |
112 | SC_ARG_TYPE=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) rw: ([^,]*, [^,]*, [^,]*, \([^,)]*\).*/\3/g' "${TMPFILE}") | |
b75d00c4 MD |
113 | fi |
114 | ||
2879dbbc MJ |
115 | if [ "${ARG_NR}" == 5 ]; then |
116 | SC_ARG_TYPE=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) rw: ([^,]*, [^,]*, [^,]*, [^,]*, \([^,)]*\).*/\3/g' "${TMPFILE}") | |
b75d00c4 MD |
117 | fi |
118 | ||
2879dbbc MJ |
119 | if [ "${ARG_NR}" == 6 ]; then |
120 | SC_ARG_TYPE=$(sed 's/^syscall \([^ ]*\) nbargs \([^ ]*\) rw: ([^,]*, [^,]*, [^,]*, [^,]*, [^,]*, \([^,)]*\).*/\3/g' "${TMPFILE}") | |
b75d00c4 MD |
121 | fi |
122 | ||
b75d00c4 | 123 | |
2879dbbc | 124 | if [ "${SC_ARG_TYPE}" = "r" ]; then |
b75d00c4 MD |
125 | echo "sc_in" |
126 | fi | |
2879dbbc | 127 | if [ "${SC_ARG_TYPE}" = "w" ]; then |
b75d00c4 MD |
128 | echo "sc_out" |
129 | fi | |
2879dbbc | 130 | if [ "${SC_ARG_TYPE}" = "rw" ]; then |
b75d00c4 MD |
131 | echo "sc_inout" |
132 | fi | |
133 | ||
2879dbbc | 134 | # EOF |