From patchwork Mon May 11 10:08:23 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Florian Weimer X-Patchwork-Id: 38948 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id B508B383E818; Mon, 11 May 2020 10:08:37 +0000 (GMT) X-Original-To: libc-alpha@sourceware.org Delivered-To: libc-alpha@sourceware.org Received: from albireo.enyo.de (albireo.enyo.de [37.24.231.21]) by sourceware.org (Postfix) with ESMTPS id D2EC0383E816 for ; Mon, 11 May 2020 10:08:25 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org D2EC0383E816 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=deneb.enyo.de Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=fw@deneb.enyo.de Received: from [172.17.203.2] (helo=deneb.enyo.de) by albireo.enyo.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) id 1jY5MF-0000OP-SK for libc-alpha@sourceware.org; Mon, 11 May 2020 10:08:23 +0000 Received: from fw by deneb.enyo.de with local (Exim 4.92) (envelope-from ) id 1jY5MF-0007fY-Op for libc-alpha@sourceware.org; Mon, 11 May 2020 12:08:23 +0200 From: Florian Weimer To: libc-alpha@sourceware.org Subject: [PATCH] Linux: Enhance glibcsyscalls.py to support listing system calls Date: Mon, 11 May 2020 12:08:23 +0200 Message-ID: <87y2pyg4x4.fsf@mid.deneb.enyo.de> MIME-Version: 1.0 X-Spam-Status: No, score=-13.4 required=5.0 tests=BAYES_00, GIT_PATCH_0, KAM_DMARC_STATUS, KAM_SHORT, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on server2.sourceware.org X-BeenThere: libc-alpha@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libc-alpha-bounces@sourceware.org Sender: "Libc-alpha" The script can now be called to query the definition status of system call numbers across all architectures, like this: $ python3 sysdeps/unix/sysv/linux/glibcsyscalls.py query-syscall sync_file_range sync_file_range2 sync_file_range: defined: aarch64 alpha csky hppa i386 ia64 m68k microblaze mips/mips32 mips/mips64/n32 mips/mips64/n64 nios2 riscv/rv64 s390/s390-32 s390/s390-64 sh sparc/sparc32 sparc/sparc64 x86_64/64 x86_64/x32 undefined: arm powerpc/powerpc32 powerpc/powerpc64 sync_file_range2: defined: arm powerpc/powerpc32 powerpc/powerpc64 undefined: aarch64 alpha csky hppa i386 ia64 m68k microblaze mips/mips32 mips/mips64/n32 mips/mips64/n64 nios2 riscv/rv64 s390/s390-32 s390/s390-64 sh sparc/sparc32 sparc/sparc64 x86_64/64 x86_64/x32 This command lists the headers containing the system call numbers: $ python3 sysdeps/unix/sysv/linux/glibcsyscalls.py list-headers The argument parser code is based on a suggestion from Adhemerval Zanella. ----- sysdeps/unix/sysv/linux/glibcsyscalls.py | 84 +++++++++++++++++++++++++++++++- 1 file changed, 83 insertions(+), 1 deletion(-) Reviewed-by: Adhemerval Zanella diff --git a/sysdeps/unix/sysv/linux/glibcsyscalls.py b/sysdeps/unix/sysv/linux/glibcsyscalls.py index de4d707e48..8d45cd4333 100644 --- a/sysdeps/unix/sysv/linux/glibcsyscalls.py +++ b/sysdeps/unix/sysv/linux/glibcsyscalls.py @@ -17,9 +17,12 @@ # License along with the GNU C Library; if not, see # . +import os import re -import glibcextract +if __name__ != '__main__': + # When called as a main program, this is not needed. + import glibcextract def extract_system_call_name(macro): """Convert the macro name (with __NR_) to a system call name.""" @@ -168,3 +171,82 @@ def linux_kernel_version(cc): val = glibcextract.compute_c_consts(sym_data, cc)['LINUX_VERSION_CODE'] val = int(val) return ((val & 0xff0000) >> 16, (val & 0xff00) >> 8) + +class ArchSyscall: + """Canonical name and location of a syscall header.""" + + def __init__(self, name, path): + self.name = name + self.path = path + + def __repr__(self): + return 'ArchSyscall(name={!r}, patch={!r})'.format( + self.name, self.path) + +def list_arch_syscall_headers(topdir): + """A generator which returns all the ArchSyscall objects in a tree.""" + + sysdeps = os.path.join(topdir, 'sysdeps', 'unix', 'sysv', 'linux') + for root, dirs, files in os.walk(sysdeps): + if root != sysdeps: + for filename in files: + if filename == 'arch-syscall.h': + yield ArchSyscall( + name=os.path.relpath(root, sysdeps), + path=os.path.join(root, filename)) + +def __main(): + """Entry point when called as the main program.""" + + import argparse + import sys + + # Top-level directory of the source tree. + topdir = os.path.realpath(os.path.join( + os.path.dirname(os.path.realpath(__file__)), *('..',) * 4)) + + def get_parser(): + parser = argparse.ArgumentParser(description=__doc__) + subparsers = parser.add_subparsers(dest='command', required=True) + subparsers.add_parser('list-headers', + help='Print the absolute paths of all arch-syscall.h header files') + subparser = subparsers.add_parser('query-syscall', + help='Summarize the implementation status of system calls') + subparser.add_argument('syscalls', help='Which syscalls to check', + nargs='+') + return parser + parser = get_parser() + args = parser.parse_args() + + if args.command == 'list-headers': + for header in sorted([syscall.path for syscall + in list_arch_syscall_headers(topdir)]): + print(header) + + elif args.command == 'query-syscall': + # List of system call tables. + tables = sorted(list_arch_syscall_headers(topdir), + key=lambda syscall: syscall.name) + for table in tables: + table.numbers = load_arch_syscall_header(table.path) + + for nr in args.syscalls: + defined = [table.name for table in tables + if nr in table.numbers] + undefined = [table.name for table in tables + if nr not in table.numbers] + if not defined: + print('{}: not defined on any architecture'.format(nr)) + elif not undefined: + print('{}: defined on all architectures'.format(nr)) + else: + print('{}:'.format(nr)) + print(' defined: {}'.format(' '.join(defined))) + print(' undefined: {}'.format(' '.join(undefined))) + + else: + # Unrecognized command. + usage(1) + +if __name__ == '__main__': + __main()