Antonio de Angelis | 9ba31c3 | 2024-12-13 23:42:15 +0000 | [diff] [blame] | 1 | #!/usr/bin/env bash |
| 2 | |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 3 | #------------------------------------------------------------------------------- |
Antonio de Angelis | 9ba31c3 | 2024-12-13 23:42:15 +0000 | [diff] [blame] | 4 | # Copyright (c) 2018-2024, Arm Limited and Contributors. All rights reserved. |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 5 | # |
| 6 | # SPDX-License-Identifier: BSD-3-Clause |
| 7 | # |
| 8 | #------------------------------------------------------------------------------- |
| 9 | |
| 10 | ## |
| 11 | ##@file |
| 12 | ##@brief Execute checkpatch |
| 13 | ## |
| 14 | ##This bash script can be used to execute checkpatch for the tf-m project. |
| 15 | ##The script can be started with -h to give help on usage. |
| 16 | ## |
| 17 | |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 18 | ##@var SKIP_PATHS |
| 19 | ##@brief Folders and files to not be analysed by checkpatch |
| 20 | ## |
| 21 | ##This variable specifies the list of directories which shall not be analysed |
| 22 | ##by checkpatch. |
| 23 | ##This is a colon (:) separated list. |
| 24 | ## |
| 25 | #This is needed for Doxygen for now. |
| 26 | #!string SKIP_PATHS; |
Antonio de Angelis | 732d284 | 2024-09-19 16:58:54 +0100 | [diff] [blame] | 27 | SKIP_PATHS='./build-\*:./platform/\*:*/tz_\*:./lib/\*:./platform/ext/\*:./bl2/ext/\*:./docs/\*:./tools/\*:./interface/include/mbedtls/\*:./interface/include/psa/\*' |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 28 | |
| 29 | ##@var TFM_DIRECTORY_NAME |
| 30 | ##@brief Default path to tf-m source code. |
| 31 | ## |
| 32 | #This is needed for Doxygen for now. |
| 33 | #!path TFM_DIRECTORY_NAME; |
| 34 | TFM_DIRECTORY_NAME="./" |
| 35 | |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 36 | ##@var CHECKPATCH_PATH_DEF |
| 37 | ##@brief Default Path to checkpatch executable. |
| 38 | ## |
| 39 | #This is needed for Doxygen for now. |
| 40 | #!path CHECKPATCH_PATH_DEF; |
| 41 | CHECKPATCH_PATH_DEF=$(readlink -f $(dirname "$0")"/checkpatch") |
| 42 | |
| 43 | ##@var CHECKPATCH_PATH |
| 44 | ##@brief Path to checkpatch executable. |
| 45 | ## |
| 46 | ## Checkpatch path can be overriden by user argument. Initialized with Default |
| 47 | ## value of ./checkpatch |
| 48 | ## |
| 49 | #This is needed for Doxygen for now. |
| 50 | #!path CHECKPATCH_PATH; |
| 51 | CHECKPATCH_PATH=$CHECKPATCH_PATH_DEF |
| 52 | |
| 53 | ##@fn usage(void) |
| 54 | ##@brief Print help text on usage. |
| 55 | ##@returns n/a |
| 56 | ## |
| 57 | #This is needed for Doxygen for now. |
| 58 | #!void usage(void){}; |
| 59 | usage() { |
Antonio de Angelis | 9eb15a8 | 2024-12-13 10:49:53 +0000 | [diff] [blame] | 60 | echo "Usage: $(basename -- "$0") [-v] [-h] [-d <TF-M dir>] [-f <output_filename>] [-p <number>]" |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 61 | echo " -v, Verbose output" |
| 62 | echo " -h, Script help" |
| 63 | echo " -d, <TF-M dir>, TF-M directory" |
| 64 | echo " -f, <output_filename>, Output filename" |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 65 | echo " -l <number>, Check only the last <number> commits (HEAD~<number>)." |
Dean Birch | 62c4f08 | 2020-01-17 16:13:26 +0000 | [diff] [blame] | 66 | echo " -p <path>, Provide location of directory containing checkpatch." |
| 67 | echo " -r, Print raw output. Implies verbose." |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 68 | echo -e "\nNOTE: make sure checkpatch is located in '$CHECKPATCH_PATH'" |
| 69 | } |
| 70 | |
| 71 | ##@fn app_err(void) |
| 72 | ##@brief Print error massage. |
| 73 | ##@returns n/a |
| 74 | ## |
| 75 | #This is needed for Doxygen for now. |
| 76 | #!void app_err(void){}; |
| 77 | app_err() { |
Antonio de Angelis | 9ba31c3 | 2024-12-13 23:42:15 +0000 | [diff] [blame] | 78 | echo "run-checkpatch.sh($LINENO): Error: "$1 >&2 |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 79 | } |
| 80 | |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 81 | ##@fn check_tree() |
| 82 | ##@brief Run checkpatch in directory tree checking mode |
| 83 | ##@returns status code |
| 84 | ## |
| 85 | ##Execute checkpatch to check the full content of all source files under the |
| 86 | ##directory specified in \ref TFM_DIRECTORY_NAME. Directory content specified in |
| 87 | ##\ref SKIP_PATHS will be excluded. |
| 88 | ##This function uses xargs to execute multiple checkpatch instances in parallel. |
| 89 | ## |
| 90 | #This is needed for Doxygen for now. |
| 91 | #!void check_tree(){}; |
| 92 | check_tree() { |
| 93 | # Find all files to execute checkpatch on |
| 94 | FIND_CMD="find $TFM_DIRECTORY_NAME -name '*.[ch]' -a -not \( -path "${SKIP_PATHS//:/ -o -path }" \)" |
Antonio de Angelis | 9ba31c3 | 2024-12-13 23:42:15 +0000 | [diff] [blame] | 95 | echo "run-checkpatch.sh($LINENO): Scanning "$TFM_DIRECTORY_NAME" dir to find all .c and .h files to check..." |
| 96 | # Modify checkpatch command line to make checkpatch work on files. |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 97 | CHECKPATCH_CMD="$CHECKPATCH_CMD -f " |
| 98 | if [ $VERBOSE -eq 1 ]; then |
| 99 | eval "$FIND_CMD" | xargs -n 1 -i -P 8 $CHECKPATCH_CMD {} |tee -a "$OUTPUT_FILE_PATH" |
Dean Birch | 62c4f08 | 2020-01-17 16:13:26 +0000 | [diff] [blame] | 100 | RETURN_CODE=${PIPESTATUS[1]} |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 101 | else |
| 102 | eval "$FIND_CMD" | xargs -n 1 -i -P 8 $CHECKPATCH_CMD {} >> $OUTPUT_FILE_PATH |
Dean Birch | 62c4f08 | 2020-01-17 16:13:26 +0000 | [diff] [blame] | 103 | RETURN_CODE=${PIPESTATUS[1]} |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 104 | fi |
| 105 | } |
| 106 | |
| 107 | ##@fn check_diff() |
| 108 | ##@brief Run checkpatch in git diff mode. |
| 109 | ##@returns status code |
| 110 | ## |
| 111 | ##Execute checkpatch to check the last N (\ref CHECK_LAST_COMMITS) commits of |
| 112 | ##the branch checked out at directory specified in \ref TFM_DIRECTORY_NAME. |
| 113 | ##Directory content specified in \ref SKIP_PATHS will be excluded. |
| 114 | ## |
| 115 | #This is needed for Doxygen for now. |
| 116 | #!void check_diff(){}; |
| 117 | check_diff() { |
| 118 | BASE_COMMIT="HEAD~$CHECK_LAST_COMMITS" |
| 119 | #use find to limit diff content to the same set of files as when checking |
| 120 | #the whole tree. |
| 121 | FIND_CMD="find ./ -name '*.[ch]' -a -not \( -path "${SKIP_PATHS//:/ -o -path }" \)" |
| 122 | |
| 123 | #enter tf-m working copy to make git commands execute fine |
| 124 | pushd "$TFM_DIRECTORY_NAME" > /dev/null |
| 125 | #Execute popd when shell exits |
| 126 | trap popd 0 |
| 127 | |
| 128 | #List of files we care about. Filter out changed files from interesting |
| 129 | #list of files. This is needed to avoid GIT_CMD to break the argument |
| 130 | #list length. |
| 131 | CARE_LIST=$(eval $FIND_CMD | grep "$(git diff $BASE_COMMIT --name-only)" -) |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 132 | |
Minos Galanakis | ea42123 | 2019-06-20 17:11:28 +0100 | [diff] [blame] | 133 | if [ ! -z "$CARE_LIST" ]; then |
| 134 | # Only run checkpatch if there are files to check |
| 135 | GIT_CMD="git diff $BASE_COMMIT -- $CARE_LIST" |
Antonio de Angelis | 9ba31c3 | 2024-12-13 23:42:15 +0000 | [diff] [blame] | 136 | echo "run-checkpatch.sh($LINENO): $GIT_CMD" |
| 137 | echo "run-checkpatch.sh($LINENO): Checking commits: $(git log "$BASE_COMMIT"..HEAD --format=%h | tr $"\n" " ")" |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 138 | |
Minos Galanakis | ea42123 | 2019-06-20 17:11:28 +0100 | [diff] [blame] | 139 | #Modify checkpatch parameters to give more details when working on |
| 140 | #diff:s |
| 141 | CHECKPATCH_CMD="$CHECKPATCH_CMD --showfile -" |
| 142 | fi |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 143 | |
| 144 | if [ $VERBOSE -eq 1 ]; then |
| 145 | $GIT_CMD | $CHECKPATCH_CMD | tee -a "$OUTPUT_FILE_PATH" |
Dean Birch | 62c4f08 | 2020-01-17 16:13:26 +0000 | [diff] [blame] | 146 | RETURN_CODE=${PIPESTATUS[1]} |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 147 | else |
| 148 | $GIT_CMD | $CHECKPATCH_CMD >> $OUTPUT_FILE_PATH |
Dean Birch | 62c4f08 | 2020-01-17 16:13:26 +0000 | [diff] [blame] | 149 | RETURN_CODE=${PIPESTATUS[1]} |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 150 | fi |
| 151 | |
| 152 | popd > /dev/null |
| 153 | #Remove cleanup trap. |
| 154 | trap 0 |
| 155 | } |
| 156 | |
| 157 | #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 158 | #~~~~~~~~~~~~~~~~~~~~~~~~ Entry point ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 159 | #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 160 | #Internal variables not to be modified. |
| 161 | VERBOSE=0 |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 162 | |
| 163 | ##@var CHECK_LAST_COMMITS |
| 164 | ##@brief Number of commits to check. |
| 165 | ## |
| 166 | ##Number of commits relative to HEAD to check. When set to 0 full file content |
| 167 | ##is checked instead of commit diffs. |
| 168 | ## |
| 169 | #This is needed for Doxygen for now. |
| 170 | #!path CHECK_LAST_COMMITS; |
| 171 | CHECK_LAST_COMMITS=0 |
| 172 | |
Dean Birch | 62c4f08 | 2020-01-17 16:13:26 +0000 | [diff] [blame] | 173 | # Whether to print the output to screen. |
| 174 | RAW_OUTPUT=0 |
| 175 | |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 176 | # Getting options and setting variables required to execute the script. This |
| 177 | # script starts executing from here. |
Antonio de Angelis | 9eb15a8 | 2024-12-13 10:49:53 +0000 | [diff] [blame] | 178 | while getopts "vhd:f:l:p:r" opt |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 179 | do |
| 180 | case $opt in |
| 181 | v) VERBOSE=1 ;; |
| 182 | h) usage ; exit 0 ;; |
| 183 | d) TFM_DIRECTORY_NAME="$OPTARG" ;; |
| 184 | f) OUTPUT_FILE_PATH="$OPTARG" ;; |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 185 | l) CHECK_LAST_COMMITS="$OPTARG" ;; |
| 186 | p) CHECKPATCH_PATH="$OPTARG" ;; |
Dean Birch | 62c4f08 | 2020-01-17 16:13:26 +0000 | [diff] [blame] | 187 | r) RAW_OUTPUT=1 |
| 188 | VERBOSE=1 ;; |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 189 | \?) usage ; exit 1 ;; |
| 190 | esac |
| 191 | done |
| 192 | |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 193 | #Convert checkpath override path to full path |
| 194 | CHECKPATCH_PATH=$(readlink -f "$CHECKPATCH_PATH") |
| 195 | |
Xinyu Zhang | 27449ac | 2021-12-29 12:01:49 +0800 | [diff] [blame] | 196 | # Convert TF-M specific type defs file to full path |
| 197 | TFM_TYPE_DEF_FILE=$CHECKPATCH_PATH"/tfm_type_defs.txt" |
| 198 | |
| 199 | # Prepare CheckPatch config file |
Antonio de Angelis | 9ba31c3 | 2024-12-13 23:42:15 +0000 | [diff] [blame] | 200 | CHECKPATCH_CONFIG_FILENAME=$CHECKPATCH_PATH_DEF"/checkpatch.conf" |
| 201 | sed -i.bak "s#TFM_TYPE_DEF_FILE#$TFM_TYPE_DEF_FILE#g" $CHECKPATCH_CONFIG_FILENAME |
Xinyu Zhang | 27449ac | 2021-12-29 12:01:49 +0800 | [diff] [blame] | 202 | |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 203 | # Create checkpatch command |
| 204 | CHECKPATCH_APP=$CHECKPATCH_PATH"/checkpatch.pl" |
Antonio de Angelis | 9ba31c3 | 2024-12-13 23:42:15 +0000 | [diff] [blame] | 205 | CHECKPATCH_CMD=$CHECKPATCH_APP" $(grep -o '^[^#]*' $CHECKPATCH_CONFIG_FILENAME)" |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 206 | |
| 207 | # Check if checkpatch is present |
| 208 | if ! [ -f "$CHECKPATCH_APP" ]; then |
| 209 | app_err "checkpatch.pl was not found. checkpatch.pl has to be located in $CHECKPATCH_PATH" |
| 210 | exit 1 |
| 211 | fi |
| 212 | |
Antonio de Angelis | 9ba31c3 | 2024-12-13 23:42:15 +0000 | [diff] [blame] | 213 | OUTPUT_FILE_PATH=${OUTPUT_FILE_PATH:-"tfm_checkpatch_report.txt"} |
Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame] | 214 | #Truncate previous content |
| 215 | : > $OUTPUT_FILE_PATH |
| 216 | |
| 217 | #Do we need to work on a git diff? |
| 218 | if [ $CHECK_LAST_COMMITS -eq 0 ] |
| 219 | then |
| 220 | #Working on files |
| 221 | check_tree |
| 222 | else |
| 223 | #Working on git diff |
| 224 | check_diff |
| 225 | fi |
| 226 | |
Antonio de Angelis | 9ba31c3 | 2024-12-13 23:42:15 +0000 | [diff] [blame] | 227 | #Restore the contents of the config file to original values |
| 228 | sed -i.bak "s#$TFM_TYPE_DEF_FILE#TFM_TYPE_DEF_FILE#g" $CHECKPATCH_CONFIG_FILENAME |
| 229 | rm $CHECKPATCH_CONFIG_FILENAME.bak |
| 230 | |
Dean Birch | 62c4f08 | 2020-01-17 16:13:26 +0000 | [diff] [blame] | 231 | if [ "$RAW_OUTPUT" == "1" ] ; then |
| 232 | rm $OUTPUT_FILE_PATH |
| 233 | exit $RETURN_CODE |
| 234 | else |
Antonio de Angelis | 9ba31c3 | 2024-12-13 23:42:15 +0000 | [diff] [blame] | 235 | echo "run-checkpatch.sh($LINENO): checkpatch report \"$(readlink -f ${OUTPUT_FILE_PATH})\" is ready!" |
Dean Birch | 62c4f08 | 2020-01-17 16:13:26 +0000 | [diff] [blame] | 236 | fi |