From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id B1BD0A0C4C; Mon, 4 Oct 2021 12:11:44 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3871341314; Mon, 4 Oct 2021 12:11:40 +0200 (CEST) Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by mails.dpdk.org (Postfix) with ESMTP id 84A2841300 for ; Mon, 4 Oct 2021 12:11:38 +0200 (CEST) X-IronPort-AV: E=McAfee;i="6200,9189,10126"; a="205501908" X-IronPort-AV: E=Sophos;i="5.85,345,1624345200"; d="scan'208";a="205501908" Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 04 Oct 2021 03:11:36 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.85,345,1624345200"; d="scan'208";a="558342028" Received: from silpixa00401215.ir.intel.com ([10.55.128.96]) by FMSMGA003.fm.intel.com with ESMTP; 04 Oct 2021 03:11:34 -0700 From: Sean Morrissey To: Cc: dev@dpdk.org, Sean Morrissey , Conor Fogarty Date: Mon, 4 Oct 2021 10:10:54 +0000 Message-Id: <20211004101058.2396458-2-sean.morrissey@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20211004101058.2396458-1-sean.morrissey@intel.com> References: <20211004101058.2396458-1-sean.morrissey@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v1 1/5] devtools: script to remove unused headers includes X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" This script can be used for removing headers flagged for removal by the include-what-you-use (IWYU) tool. The script has the ability to remove headers from specified sub-directories or dpdk as a whole. example usages: Remove headers flagged by iwyu_tool output file $ ./devtools/process_iwyu.py iwyu.out -b build Remove headers flagged by iwyu_tool output file from sub-directory $ ./devtools/process_iwyu.py iwyu.out -b build -d lib/kvargs Remove headers directly piped from the iwyu_tool $ iwyu_tool -p build | ./devtools/process_iwyu.py - -b build Signed-off-by: Sean Morrissey Signed-off-by: Conor Fogarty --- devtools/process_iwyu.py | 109 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100755 devtools/process_iwyu.py diff --git a/devtools/process_iwyu.py b/devtools/process_iwyu.py new file mode 100755 index 0000000000..ddc4ceafa4 --- /dev/null +++ b/devtools/process_iwyu.py @@ -0,0 +1,109 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2021 Intel Corporation +# + +import argparse +import fileinput +import sys +from os.path import abspath, relpath, join +from pathlib import Path +from mesonbuild import mesonmain + +def args_parse(): + parser = argparse.ArgumentParser(description='This script can be used to remove includes which are not in use\n') + parser.add_argument('-b', '--build_dir', type=str, help='Name of the build directory in which the IWYU tool was used in.', default="build") + parser.add_argument('-d', '--sub_dir', type=str, help='The sub-directory to remove headers from.', default="") + parser.add_argument('file', type=Path, help='The path to the IWYU log file or output from stdin.') + + args = parser.parse_args() + + return args + + +def run_meson(args): + "Runs a meson command logging output to process.log" + with open('process.log', 'a') as sys.stdout: + ret = mesonmain.run(args, abspath('meson')) + sys.stdout = sys.__stdout__ + return ret + + +def remove_includes(filename, include, dpdk_dir, build_dir): + # Load in file - readlines() + # loop through list once in mem -> make cpy of list with line removed + # write cpy -> stored in memory so write cpy to file then check + # run test build -> call ninja on the build folder, ninja -C build, subprocess + # if fails -> write original back to file otherwise continue on + # newlist = [ln for ln in lines if not ln.startswith(...)] filters out one element + filepath = filename + + with open(filepath, 'r+') as f: + lines = f.readlines() # Read lines when file is opened + + with open(filepath, 'w') as f: + for ln in lines: # Removes the include passed in + if ln.strip("\n") != include: + f.write(ln) + + ret = run_meson(['compile', '-C', join(dpdk_dir, build_dir)]) + if (ret == 0): # Include is not needed -> build is successful + print('SUCCESS') + else: + # failed, catch the error + # return file to original state + with open(filepath, 'w') as f: + f.writelines(lines) + print('FAILED') + + +def get_build_config(builddir, condition): + "returns contents of rte_build_config.h" + with open(join(builddir, 'rte_build_config.h')) as f: + return [ln for ln in f.readlines() if condition(ln)] + + +def uses_libbsd(builddir): + "return whether the build uses libbsd or not" + return bool(get_build_config(builddir, lambda ln: 'RTE_USE_LIBBSD' in ln)) + + +def process(args): + filename = None + build_dir = args.build_dir + dpdk_dir = abspath(__file__).split('/devtools')[0] + directory = args.sub_dir + # Use stdin if no iwyu_tool out file given + logfile = abspath(args.file) if str(args.file) != '-' else args.file + + keep_str_fns = uses_libbsd(join(dpdk_dir, build_dir)) # check for libbsd + if keep_str_fns: + print('Warning: libbsd is present, build will fail to detect incorrect removal of rte_string_fns.h', + file=sys.stderr) + run_meson(['configure', dpdk_dir + "/" + build_dir, '-Dwerror=true']) # turn on werror + + for line in fileinput.input(logfile): + if 'should remove' in line: + # If the file path in the iwyu_tool output is an absolute path + # it means the file is outside of the dpdk directory, therefore ignore it + # Also check to see if the file is within the specified sub directory + if line.split()[0] != abspath(line.split()[0]) and directory in line.split()[0]: + filename = relpath(join(build_dir, line.split()[0])) + elif line.startswith('-') and filename: + include = '#include ' + line.split()[2] + print(f"Remove {include} from {filename} ... ", end='', flush=True) + if keep_str_fns and '' in include: + print('skipped') + continue + remove_includes(filename, include, dpdk_dir, build_dir) + else: + filename = None + + +def main(): + args = args_parse() + process(args) + + +if __name__ == '__main__': + main() -- 2.25.1