From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas De Schampheleire Date: Tue, 19 Jan 2016 13:43:53 +0100 Subject: [Buildroot] [PATCH v2 2/2] support/scripts: add size-stats-compare script In-Reply-To: <1453207433-32589-1-git-send-email-patrickdepinguin@gmail.com> References: <1453207433-32589-1-git-send-email-patrickdepinguin@gmail.com> Message-ID: <1453207433-32589-2-git-send-email-patrickdepinguin@gmail.com> List-Id: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: buildroot@busybox.net From: Thomas De Schampheleire Leverage the CSV files produces by size-stats (make graph-size) to allow for a comparison of rootfs size between two different buildroot compilations. The script takes the file-size CSV files of two compilations as input, and produces a textual report of the differences per package. Using the -d/--detail flag, the report will show the file size changes instead of package size changes. The -t/--threshold option allows to ignore file size differences smaller or equal than the given threshold (in bytes). Signed-off-by: Thomas De Schampheleire --- docs/manual/common-usage.txt | 10 +++ support/scripts/size-stats-compare | 129 +++++++++++++++++++++++++++++++++++++ 2 files changed, 139 insertions(+) create mode 100755 support/scripts/size-stats-compare v2: Addressing Arnout's comments: - improve help text - remove references to commits-to-be-backported - fix references to 'package' while really file or package could be meant - verify header of CSV file is as expected - don't print output header for sections that are empty - use <= instead of < for threshold - use argparse.Filetype for file path verification - use positional args for input files - improve string wrapping - add reference to script in manual - ensure Python 3 compatibility Other changes: - also print out total size difference - add docstrings to methods - add TODO with possible improvements diff --git a/docs/manual/common-usage.txt b/docs/manual/common-usage.txt index 8d0ba63..18677b8 100644 --- a/docs/manual/common-usage.txt +++ b/docs/manual/common-usage.txt @@ -317,6 +317,16 @@ The collected filesystem size data is only meaningful after a complete clean rebuild. Be sure to run +make clean all+ before using +make graph-size+. +To compare the root filesystem size of two different Buildroot compilations, +for example after adjusting the configuration or when switching to another +Buildroot release, use the +size-stats-compare+ script. It takes two ++file-size-stats.csv+ files (produced by +make graph-size+) as input. +Refer to the help text of this script for more details: + +---------------- +support/scripts/size-stats-compare -h +---------------- + include::eclipse-integration.txt[] include::advanced.txt[] diff --git a/support/scripts/size-stats-compare b/support/scripts/size-stats-compare new file mode 100755 index 0000000..47163f4 --- /dev/null +++ b/support/scripts/size-stats-compare @@ -0,0 +1,129 @@ +#!/usr/bin/env python + +# Copyright (C) 2016 Thomas De Schampheleire + +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +# TODO (improvements) +# - support K,M,G size suffixes for threshold +# - output CSV file in addition to stdout reporting + +import csv +import argparse +import sys + +def read_file_size_csv(inputf, detail=None): + """Extract package or file sizes from CSV file into size dictionary""" + sizes = {} + reader = csv.reader(inputf) + + header = next(reader) + if (header[0] != 'File name' or header[1] != 'Package name' or + header[2] != 'File size' or header[3] != 'Package size'): + print(("Input file %s does not contain the expected header. Are you " + "sure this file corresponds to the file-size-stats.csv " + "file created by 'make graph-size'?") % inputf.name) + sys.exit(1) + + for row in reader: + if detail: + sizes[row[0]] = int(row[2]) + else: + sizes[row[1]] = int(row[3]) + + return sizes + +def compare_sizes(this, other): + """Return delta/added/removed dictionaries based on two input size + dictionaries""" + delta = {} + removed = {} + added = {} + thiskeys = set(this.keys()) + otherkeys = set(other.keys()) + + # packages/files in both + for entry in thiskeys.intersection(otherkeys): + delta[entry] = this[entry] - other[entry] + # packages/files only in this + for entry in thiskeys.difference(otherkeys): + added[entry] = this[entry] + # packages/files only in other + for entry in otherkeys.difference(thiskeys): + removed[entry] = -other[entry] + + return delta, added, removed + +def print_results(result, title, threshold): + """Print the given delta/added/removed dictionary, ignoring any entries + below or equal to threshold""" + if not result: + return + + print('%s:' % title) + for entry in result.keys(): + if threshold is not None and abs(result[entry]) <= threshold: + continue + print('%12d %s' % (result[entry], entry)) + + +# main ######################################################################### + +description = """ +Compare rootfs size between Buildroot compilations, for example after changing +configuration options or after switching to another Buildroot release. + +This script compares the file-size-stats.csv file generated by 'make graph-size' +with the corresponding file from another Buildroot compilation. +The size differences can be reported per package or per file. +Size differences smaller or equal than a given threshold can be ignored. +""" + +parser = argparse.ArgumentParser(description=description, + formatter_class=argparse.RawDescriptionHelpFormatter) + +parser.add_argument('-d', '--detail', action='store_true', + help='''report differences for individual files rather than + packages''') +parser.add_argument('-t', '--threshold', type=int, + help='''ignore size differences smaller or equal than this + value (bytes)''') +parser.add_argument('file_size_csv', type=argparse.FileType('r'), + metavar='file-size-stats.csv', + help="""CSV file with file and package size statistics, + generated by 'make graph-size'""") +parser.add_argument('other_file_size_csv', type=argparse.FileType('r'), + metavar='other-file-size-stats.csv', + help='''CSV file with file and package size statistics to + compare with''') +args = parser.parse_args() + +if args.detail: + keyword = 'file' +else: + keyword = 'package' + +sizes = read_file_size_csv(args.file_size_csv, args.detail) +other_sizes = read_file_size_csv(args.other_file_size_csv, args.detail) + +print_results({'total': sum(sizes.values()) - sum(other_sizes.values())}, + 'Total difference (bytes)', + threshold=None) + +delta, added, removed = compare_sizes(sizes, other_sizes) + +print_results(delta, 'Size difference per %s (bytes)' % keyword, args.threshold) +print_results(added, 'Size difference due to added %ss (bytes)' % keyword, args.threshold) +print_results(removed, 'Size difference due to removed %ss (bytes)' % keyword, args.threshold) -- 2.4.10