sim/common/gennltvals.py

   1 #!/usr/bin/env python3
   2 # Copyright (C) 1996-2021 Free Software Foundation, Inc.
   3 #
   4 # This file is part of the GNU simulators.
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 """Helper to generate nltvals.def.
  20
  21 nltvals.def is a file that describes various newlib/libgloss target values used
  22 by the host/target interface.  This needs to be rerun whenever the newlib source
  23 changes.  Developers manually run it.
  24
  25 If the path to newlib is not specified, it will be searched for in:
  26 - the root of this source tree
  27 - alongside this source tree
  28 """
  29
  30 import argparse
  31 from pathlib import Path
  32 import re
  33 import subprocess
  34 import sys
  35 from typing import Iterable, List, TextIO
  36
  37
  38 PROG = Path(__file__).name
  39
  40 # Unfortunately, each newlib/libgloss port has seen fit to define their own
  41 # syscall.h file.  This means that system call numbers can vary for each port.
  42 # Support for all this crud is kept here, rather than trying to get too fancy.
  43 # If you want to try to improve this, please do, but don't break anything.
  44 # Note that there is a standard syscall.h file (libgloss/syscall.h) now which
  45 # hopefully more targets can use.
  46 #
  47 # NB: New ports should use libgloss, not newlib.
  48 TARGET_DIRS = {
  49     'cr16': 'libgloss/cr16/sys',
  50     'd10v': 'newlib/libc/sys/d10v/sys',
  51     'i960': 'libgloss/i960',
  52     'mcore': 'libgloss/mcore',
  53     'riscv': 'libgloss/riscv/machine',
  54     'v850': 'libgloss/v850/sys',
  55 }
  56 TARGETS = {
  57     'bfin',
  58     'cr16',
  59     'd10v',
  60     'fr30',
  61     'frv',
  62     'i960',
  63     'iq2000',
  64     'lm32',
  65     'm32c',
  66     'm32r',
  67     'mcore',
  68     'mn10200',
  69     'mn10300',
  70     'msp430',
  71     'pru',
  72     'riscv',
  73     'sparc',
  74     'v850',
  75 }
  76
  77 # Make sure TARGET_DIRS doesn't gain any typos.
  78 assert not set(TARGET_DIRS) - TARGETS
  79
  80 # The header for the generated def file.
  81 FILE_HEADER = f"""\
  82 /* Newlib/libgloss macro values needed by remote target support.  */
  83 /* This file is machine generated by {PROG}.  */\
  84 """
  85
  86
  87 def gentvals(output: TextIO, cpp: str, srctype: str, srcdir: Path,
  88              headers: Iterable[str],
  89              pattern: str,
  90              target: str = None):
  91     """Extract constants from the specified files using a regular expression.
  92
  93     We'll run things through the preprocessor.
  94     """
  95     headers = tuple(headers)
  96
  97     # Require all files exist in order to regenerate properly.
  98     for header in headers:
  99         fullpath = srcdir / header
 100         assert fullpath.exists(), f'{fullpath} does not exist'
 101
 102     if target is None:
 103         print(f'#ifdef {srctype}_defs', file=output)
 104     else:
 105         print(f'#ifdef NL_TARGET_{target}', file=output)
 106         print(f'#ifdef {srctype}_defs', file=output)
 107
 108     print('\n'.join(f'/* from {x} */' for x in headers), file=output)
 109
 110     if target is None:
 111         print(f'/* begin {srctype} target macros */', file=output)
 112     else:
 113         print(f'/* begin {target} {srctype} target macros */', file=output)
 114
 115     # Extract all the symbols.
 116     srcfile = ''.join(f'#include <{x}>\n' for x in headers)
 117     syms = set()
 118     define_pattern = re.compile(r'^#\s*define\s+(' + pattern + ')')
 119     for header in headers:
 120         with open(srcdir / header, 'r', encoding='utf-8') as fp:
 121             data = fp.read()
 122         for line in data.splitlines():
 123             m = define_pattern.match(line)
 124             if m:
 125                 syms.add(m.group(1))
 126     for sym in sorted(syms):
 127         srcfile += f'#ifdef {sym}\nDEFVAL {{ "{sym}", {sym} }},\n#endif\n'
 128
 129     result = subprocess.run(
 130         f'{cpp} -E -I"{srcdir}" -', shell=True, check=True, encoding='utf-8',
 131         input=srcfile, capture_output=True)
 132     for line in result.stdout.splitlines():
 133         if line.startswith('DEFVAL '):
 134             print(line[6:].rstrip(), file=output)
 135
 136     if target is None:
 137         print(f'/* end {srctype} target macros */', file=output)
 138         print('#endif', file=output)
 139     else:
 140         print(f'/* end {target} {srctype} target macros */', file=output)
 141         print('#endif', file=output)
 142         print('#endif', file=output)
 143
 144
 145 def gen_common(output: TextIO, newlib: Path, cpp: str):
 146     """Generate the common C library constants.
 147
 148     No arch should override these.
 149     """
 150     gentvals(output, cpp, 'errno', newlib / 'newlib/libc/include',
 151              ('errno.h', 'sys/errno.h'), 'E[A-Z0-9]*')
 152
 153     gentvals(output, cpp, 'signal', newlib / 'newlib/libc/include',
 154              ('signal.h', 'sys/signal.h'), r'SIG[A-Z0-9]*')
 155
 156     gentvals(output, cpp, 'open', newlib / 'newlib/libc/include',
 157              ('fcntl.h', 'sys/fcntl.h', 'sys/_default_fcntl.h'), r'O_[A-Z0-9]*')
 158
 159
 160 def gen_targets(output: TextIO, newlib: Path, cpp: str):
 161     """Generate the target-specific lists."""
 162     for target in sorted(TARGETS):
 163         subdir = TARGET_DIRS.get(target, 'libgloss')
 164         gentvals(output, cpp, 'sys', newlib / subdir, ('syscall.h',),
 165                  r'SYS_[_a-zA-Z0-9]*', target=target)
 166
 167
 168 def gen(output: TextIO, newlib: Path, cpp: str):
 169     """Generate all the things!"""
 170     print(FILE_HEADER, file=output)
 171     gen_common(output, newlib, cpp)
 172     gen_targets(output, newlib, cpp)
 173
 174
 175 def get_parser() -> argparse.ArgumentParser:
 176     """Get CLI parser."""
 177     parser = argparse.ArgumentParser(
 178         description=__doc__,
 179         formatter_class=argparse.RawDescriptionHelpFormatter)
 180     parser.add_argument(
 181         '-o', '--output', type=Path,
 182         help='write to the specified file instead of stdout')
 183     parser.add_argument(
 184         '--cpp', type=str, default='cpp',
 185         help='the preprocessor to use')
 186     parser.add_argument(
 187         '--srcroot', type=Path,
 188         help='the root of this source tree')
 189     parser.add_argument(
 190         'newlib', nargs='?', type=Path,
 191         help='path to the newlib+libgloss source tree')
 192     return parser
 193
 194
 195 def parse_args(argv: List[str]) -> argparse.Namespace:
 196     """Process the command line & default options."""
 197     parser = get_parser()
 198     opts = parser.parse_args(argv)
 199
 200     if opts.srcroot is None:
 201         opts.srcroot = Path(__file__).resolve().parent.parent.parent
 202
 203     if opts.newlib is None:
 204         # Try to find newlib relative to our source tree.
 205         if (opts.srcroot / 'newlib').is_dir():
 206             # If newlib is manually in the same source tree, use it.
 207             if (opts.srcroot / 'libgloss').is_dir():
 208                 opts.newlib = opts.srcroot
 209             else:
 210                 opts.newlib = opts.srcroot / 'newlib'
 211         elif (opts.srcroot.parent / 'newlib').is_dir():
 212             # Or see if it's alongside the gdb/binutils repo.
 213             opts.newlib = opts.srcroot.parent / 'newlib'
 214     if opts.newlib is None or not opts.newlib.is_dir():
 215         parser.error('unable to find newlib')
 216
 217     return opts
 218
 219
 220 def main(argv: List[str]) -> int:
 221     """The main entry point for scripts."""
 222     opts = parse_args(argv)
 223
 224     if opts.output is not None:
 225         output = open(opts.output, 'w', encoding='utf-8')
 226     else:
 227         output = sys.stdout
 228
 229     gen(output, opts.newlib, opts.cpp)
 230     return 0
 231
 232
 233 if __name__ == '__main__':
 234     sys.exit(main(sys.argv[1:]))