Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 | #!/usr/bin/env python3
#
# Copyright (c) 2019, Nordic Semiconductor ASA
#
# SPDX-License-Identifier: Apache-2.0
'''Tool for parsing a list of projects to determine if they are Zephyr
projects. If no projects are given then the output from `west list` will be
used as project list.
Include file is generated for Kconfig using --kconfig-out.
A <name>:<path> text file is generated for use with CMake using --cmake-out.
Using --twister-out <filename> an argument file for twister script will
be generated which would point to test and sample roots available in modules
that can be included during a twister run. This allows testing code
maintained in modules in addition to what is available in the main Zephyr tree.
'''
import argparse
import os
import re
import sys
import yaml
import pykwalify.core
from pathlib import Path, PurePath
from collections import namedtuple
METADATA_SCHEMA = '''
## A pykwalify schema for basic validation of the structure of a
## metadata YAML file.
##
# The zephyr/module.yml file is a simple list of key value pairs to be used by
# the build system.
type: map
mapping:
name:
required: false
type: str
build:
required: false
type: map
mapping:
cmake:
required: false
type: str
kconfig:
required: false
type: str
cmake-ext:
required: false
type: bool
default: false
kconfig-ext:
required: false
type: bool
default: false
depends:
required: false
type: seq
sequence:
- type: str
settings:
required: false
type: map
mapping:
board_root:
required: false
type: str
dts_root:
required: false
type: str
soc_root:
required: false
type: str
arch_root:
required: false
type: str
module_ext_root:
required: false
type: str
tests:
required: false
type: seq
sequence:
- type: str
samples:
required: false
type: seq
sequence:
- type: str
boards:
required: false
type: seq
sequence:
- type: str
'''
schema = yaml.safe_load(METADATA_SCHEMA)
def validate_setting(setting, module_path, filename=None):
if setting is not None:
if filename is not None:
checkfile = os.path.join(module_path, setting, filename)
else:
checkfile = os.path.join(module_path, setting)
if not os.path.isfile(checkfile):
return False
return True
def process_module(module):
module_path = PurePath(module)
module_yml = module_path.joinpath('zephyr/module.yml')
# The input is a module if zephyr/module.yml is a valid yaml file
# or if both zephyr/CMakeLists.txt and zephyr/Kconfig are present.
if Path(module_yml).is_file():
with Path(module_yml).open('r') as f:
meta = yaml.safe_load(f.read())
try:
pykwalify.core.Core(source_data=meta, schema_data=schema)\
.validate()
except pykwalify.errors.SchemaError as e:
sys.exit('ERROR: Malformed "build" section in file: {}\n{}'
.format(module_yml.as_posix(), e))
meta['name'] = meta.get('name', module_path.name)
meta['name-sanitized'] = re.sub('[^a-zA-Z0-9]', '_', meta['name'])
return meta
if Path(module_path.joinpath('zephyr/CMakeLists.txt')).is_file() and \
Path(module_path.joinpath('zephyr/Kconfig')).is_file():
return {'name': module_path.name,
'name-sanitized': re.sub('[^a-zA-Z0-9]', '_', module_path.name),
'build': {'cmake': 'zephyr', 'kconfig': 'zephyr/Kconfig'}}
return None
def process_cmake(module, meta):
section = meta.get('build', dict())
module_path = PurePath(module)
module_yml = module_path.joinpath('zephyr/module.yml')
cmake_extern = section.get('cmake-ext', False)
if cmake_extern:
return('\"{}\":\"{}\":\"{}\"\n'
.format(meta['name'],
module_path.as_posix(),
"${ZEPHYR_" + meta['name-sanitized'].upper() + "_CMAKE_DIR}"))
cmake_setting = section.get('cmake', None)
if not validate_setting(cmake_setting, module, 'CMakeLists.txt'):
sys.exit('ERROR: "cmake" key in {} has folder value "{}" which '
'does not contain a CMakeLists.txt file.'
.format(module_yml.as_posix(), cmake_setting))
cmake_path = os.path.join(module, cmake_setting or 'zephyr')
cmake_file = os.path.join(cmake_path, 'CMakeLists.txt')
if os.path.isfile(cmake_file):
return('\"{}\":\"{}\":\"{}\"\n'
.format(meta['name'],
module_path.as_posix(),
Path(cmake_path).resolve().as_posix()))
else:
return('\"{}\":\"{}\":\"\"\n'
.format(meta['name'],
module_path.as_posix()))
def process_settings(module, meta):
section = meta.get('build', dict())
build_settings = section.get('settings', None)
out_text = ""
if build_settings is not None:
for root in ['board', 'dts', 'soc', 'arch', 'module_ext']:
setting = build_settings.get(root+'_root', None)
if setting is not None:
root_path = PurePath(module) / setting
out_text += f'"{root.upper()}_ROOT":'
out_text += f'"{root_path.as_posix()}"\n'
return out_text
def kconfig_snippet(meta, path, kconfig_file=None):
name = meta['name']
name_sanitized = meta['name-sanitized']
snippet = (f'menu "{name} ({path})"',
f'osource "{kconfig_file.resolve().as_posix()}"' if kconfig_file
else f'osource "$(ZEPHYR_{name_sanitized.upper()}_KCONFIG)"',
f'config ZEPHYR_{name_sanitized.upper()}_MODULE',
' bool',
' default y',
'endmenu\n')
return '\n'.join(snippet)
def process_kconfig(module, meta):
section = meta.get('build', dict())
module_path = PurePath(module)
module_yml = module_path.joinpath('zephyr/module.yml')
kconfig_extern = section.get('kconfig-ext', False)
if kconfig_extern:
return kconfig_snippet(meta, module_path)
kconfig_setting = section.get('kconfig', None)
if not validate_setting(kconfig_setting, module):
sys.exit('ERROR: "kconfig" key in {} has value "{}" which does '
'not point to a valid Kconfig file.'
.format(module_yml, kconfig_setting))
kconfig_file = os.path.join(module, kconfig_setting or 'zephyr/Kconfig')
if os.path.isfile(kconfig_file):
return kconfig_snippet(meta, module_path, Path(kconfig_file))
else:
return ""
def process_twister(module, meta):
out = ""
tests = meta.get('tests', [])
samples = meta.get('samples', [])
boards = meta.get('boards', [])
for pth in tests + samples:
if pth:
dir = os.path.join(module, pth)
out += '-T\n{}\n'.format(PurePath(os.path.abspath(dir))
.as_posix())
for pth in boards:
if pth:
dir = os.path.join(module, pth)
out += '--board-root\n{}\n'.format(PurePath(os.path.abspath(dir))
.as_posix())
return out
def parse_modules(zephyr_base, modules=None, extra_modules=None):
if modules is None:
# West is imported here, as it is optional
# (and thus maybe not installed)
# if user is providing a specific modules list.
from west.manifest import Manifest
from west.util import WestNotFound
from west.version import __version__ as WestVersion
from packaging import version
try:
manifest = Manifest.from_file()
if version.parse(WestVersion) >= version.parse('0.9.0'):
projects = [p.posixpath for p in manifest.get_projects([])
if manifest.is_active(p)]
else:
projects = [p.posixpath for p in manifest.get_projects([])]
except WestNotFound:
# Only accept WestNotFound, meaning we are not in a west
# workspace. Such setup is allowed, as west may be installed
# but the project is not required to use west.
projects = []
else:
projects = modules.copy()
if extra_modules is None:
extra_modules = []
projects += extra_modules
Module = namedtuple('Module', ['project', 'meta', 'depends'])
# dep_modules is a list of all modules that has an unresolved dependency
dep_modules = []
# start_modules is a list modules with no depends left (no incoming edge)
start_modules = []
# sorted_modules is a topological sorted list of the modules
sorted_modules = []
for project in projects:
# Avoid including Zephyr base project as module.
if project == zephyr_base:
continue
meta = process_module(project)
if meta:
section = meta.get('build', dict())
deps = section.get('depends', [])
if not deps:
start_modules.append(Module(project, meta, []))
else:
dep_modules.append(Module(project, meta, deps))
elif project in extra_modules:
sys.exit(f'{project}, given in ZEPHYR_EXTRA_MODULES, '
'is not a valid zephyr module')
# This will do a topological sort to ensure the modules are ordered
# according to dependency settings.
while start_modules:
node = start_modules.pop(0)
sorted_modules.append(node)
node_name = node.meta['name']
to_remove = []
for module in dep_modules:
if node_name in module.depends:
module.depends.remove(node_name)
if not module.depends:
start_modules.append(module)
to_remove.append(module)
for module in to_remove:
dep_modules.remove(module)
if dep_modules:
# If there are any modules with unresolved dependencies, then the
# modules contains unmet or cyclic dependencies. Error out.
error = 'Unmet or cyclic dependencies in modules:\n'
for module in dep_modules:
error += f'{module.project} depends on: {module.depends}\n'
sys.exit(error)
return sorted_modules
def main():
parser = argparse.ArgumentParser(description='''
Process a list of projects and create Kconfig / CMake include files for
projects which are also a Zephyr module''')
parser.add_argument('--kconfig-out',
help="""File to write with resulting KConfig import
statements.""")
parser.add_argument('--twister-out',
help="""File to write with resulting twister
parameters.""")
parser.add_argument('--cmake-out',
help="""File to write with resulting <name>:<path>
values to use for including in CMake""")
parser.add_argument('--settings-out',
help="""File to write with resulting <name>:<value>
values to use for including in CMake""")
parser.add_argument('-m', '--modules', nargs='+',
help="""List of modules to parse instead of using `west
list`""")
parser.add_argument('-x', '--extra-modules', nargs='+',
help='List of extra modules to parse')
parser.add_argument('-z', '--zephyr-base',
help='Path to zephyr repository')
args = parser.parse_args()
kconfig = ""
cmake = ""
settings = ""
twister = ""
modules = parse_modules(args.zephyr_base, args.modules, args.extra_modules)
for module in modules:
kconfig += process_kconfig(module.project, module.meta)
cmake += process_cmake(module.project, module.meta)
settings += process_settings(module.project, module.meta)
twister += process_twister(module.project, module.meta)
if args.kconfig_out:
with open(args.kconfig_out, 'w', encoding="utf-8") as fp:
fp.write(kconfig)
if args.cmake_out:
with open(args.cmake_out, 'w', encoding="utf-8") as fp:
fp.write(cmake)
if args.settings_out:
with open(args.settings_out, 'w', encoding="utf-8") as fp:
fp.write('''\
# WARNING. THIS FILE IS AUTO-GENERATED. DO NOT MODIFY!
#
# This file contains build system settings derived from your modules.
#
# Modules may be set via ZEPHYR_MODULES, ZEPHYR_EXTRA_MODULES,
# and/or the west manifest file.
#
# See the Modules guide for more information.
''')
fp.write(settings)
if args.twister_out:
with open(args.twister_out, 'w', encoding="utf-8") as fp:
fp.write(twister)
if __name__ == "__main__":
main()
|