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 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 | #!/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 hashlib import os import re import subprocess import sys import yaml import pykwalify.core from pathlib import Path, PurePath, PurePosixPath from collections import namedtuple try: from yaml import CSafeLoader as SafeLoader except ImportError: from yaml import SafeLoader 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 sysbuild-cmake: required: false type: str sysbuild-kconfig: required: false type: str sysbuild-cmake-ext: required: false type: bool default: false sysbuild-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 snippet_root: required: false type: str soc_root: required: false type: str arch_root: required: false type: str module_ext_root: required: false type: str sca_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 blobs: required: false type: seq sequence: - type: map mapping: path: required: true type: str sha256: required: true type: str type: required: true type: str enum: ['img', 'lib'] version: required: true type: str license-path: required: true type: str click-through: required: false type: bool default: false url: required: true type: str description: required: true type: str doc-url: required: false type: str security: required: false type: map mapping: external-references: required: false type: seq sequence: - type: str package-managers: required: false type: map mapping: pip: required: false type: map mapping: requirement-files: required: false type: seq sequence: - type: str runners: required: false type: seq sequence: - type: map mapping: file: required: true type: str ''' MODULE_YML_PATH = PurePath('zephyr/module.yml') # Path to the blobs folder MODULE_BLOBS_PATH = PurePath('zephyr/blobs') BLOB_PRESENT = 'A' BLOB_NOT_PRESENT = 'D' BLOB_OUTDATED = 'M' schema = yaml.load(METADATA_SCHEMA, Loader=SafeLoader) def validate_setting(setting, module_path, filename=None): if setting is not None: if filename is not None: checkfile = Path(module_path) / setting / filename else: checkfile = Path(module_path) / setting if not checkfile.resolve().is_file(): return False return True def process_module(module): module_path = PurePath(module) # The input is a module if zephyr/module.{yml,yaml} is a valid yaml file # or if both zephyr/CMakeLists.txt and zephyr/Kconfig are present. for module_yml in [module_path / MODULE_YML_PATH, module_path / MODULE_YML_PATH.with_suffix('.yaml')]: if Path(module_yml).is_file(): with Path(module_yml).open('r', encoding='utf-8') as f: meta = yaml.load(f.read(), Loader=SafeLoader) 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_sysbuildcmake(module, meta): section = meta.get('build', dict()) module_path = PurePath(module) module_yml = module_path.joinpath('zephyr/module.yml') cmake_extern = section.get('sysbuild-cmake-ext', False) if cmake_extern: return('\"{}\":\"{}\":\"{}\"\n' .format(meta['name'], module_path.as_posix(), "${SYSBUILD_" + meta['name-sanitized'].upper() + "_CMAKE_DIR}")) cmake_setting = section.get('sysbuild-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)) if cmake_setting is None: return "" 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', 'snippet', 'soc', 'arch', 'module_ext', 'sca']: 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 get_blob_status(path, sha256): if not path.is_file(): return BLOB_NOT_PRESENT with path.open('rb') as f: m = hashlib.sha256() m.update(f.read()) if sha256.lower() == m.hexdigest(): return BLOB_PRESENT else: return BLOB_OUTDATED def process_blobs(module, meta): blobs = [] mblobs = meta.get('blobs', None) if not mblobs: return blobs blobs_path = Path(module) / MODULE_BLOBS_PATH for blob in mblobs: blob['module'] = meta.get('name', None) blob['abspath'] = blobs_path / Path(blob['path']) blob['license-abspath'] = Path(module) / Path(blob['license-path']) blob['status'] = get_blob_status(blob['abspath'], blob['sha256']) blobs.append(blob) return blobs def kconfig_module_opts(name_sanitized, blobs, taint_blobs): snippet = [f'config ZEPHYR_{name_sanitized.upper()}_MODULE', ' bool', ' default y'] if taint_blobs: snippet += [' select TAINT_BLOBS'] if blobs: snippet += [f'\nconfig ZEPHYR_{name_sanitized.upper()}_MODULE_BLOBS', ' bool'] if taint_blobs: snippet += [' default y'] return snippet def kconfig_snippet(meta, path, kconfig_file=None, blobs=False, taint_blobs=False, sysbuild=False): name = meta['name'] name_sanitized = meta['name-sanitized'] snippet = [f'menu "{name} ({path.as_posix()})"'] snippet += [f'osource "{kconfig_file.resolve().as_posix()}"' if kconfig_file else f'osource "$(SYSBUILD_{name_sanitized.upper()}_KCONFIG)"' if sysbuild is True else f'osource "$(ZEPHYR_{name_sanitized.upper()}_KCONFIG)"'] snippet += kconfig_module_opts(name_sanitized, blobs, taint_blobs) snippet += ['endmenu\n'] return '\n'.join(snippet) def process_kconfig(module, meta): blobs = process_blobs(module, meta) taint_blobs = any(b['status'] != BLOB_NOT_PRESENT for b in blobs) 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, blobs=blobs, taint_blobs=taint_blobs) 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), blobs=blobs, taint_blobs=taint_blobs) else: name_sanitized = meta['name-sanitized'] snippet = kconfig_module_opts(name_sanitized, blobs, taint_blobs) return '\n'.join(snippet) + '\n' def process_sysbuildkconfig(module, meta): section = meta.get('build', dict()) module_path = PurePath(module) module_yml = module_path.joinpath('zephyr/module.yml') kconfig_extern = section.get('sysbuild-kconfig-ext', False) if kconfig_extern: return kconfig_snippet(meta, module_path, sysbuild=True) kconfig_setting = section.get('sysbuild-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)) if kconfig_setting is not None: kconfig_file = os.path.join(module, kconfig_setting) if os.path.isfile(kconfig_file): return kconfig_snippet(meta, module_path, Path(kconfig_file)) name_sanitized = meta['name-sanitized'] return (f'config ZEPHYR_{name_sanitized.upper()}_MODULE\n' f' bool\n' f' default y\n') 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 is_valid_git_revision(revision): """ Returns True if the given string is a valid git revision hash (40 hex digits). """ if not isinstance(revision, str): return False return bool(re.fullmatch(r'[0-9a-fA-F]{40}', revision)) def _create_meta_project(project_path): def git_revision(path): rc = subprocess.Popen(['git', 'rev-parse', '--is-inside-work-tree'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, cwd=path).wait() if rc == 0: # A git repo. popen = subprocess.Popen(['git', 'rev-parse', 'HEAD'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, cwd=path) stdout, stderr = popen.communicate() stdout = stdout.decode('utf-8') if not (popen.returncode or stderr): revision = stdout.rstrip() rc = subprocess.Popen(['git', 'diff-index', '--quiet', 'HEAD', '--'], stdout=None, stderr=None, cwd=path).wait() if rc: return revision + '-dirty', True return revision, False return "unknown", False def git_remote(path): popen = subprocess.Popen(['git', 'remote'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, cwd=path) stdout, stderr = popen.communicate() stdout = stdout.decode('utf-8') remotes_name = [] if not (popen.returncode or stderr): remotes_name = stdout.rstrip().split('\n') remote_url = None # If more than one remote, do not return any remote if len(remotes_name) == 1: remote = remotes_name[0] popen = subprocess.Popen(['git', 'remote', 'get-url', remote], stdout=subprocess.PIPE, stderr=subprocess.PIPE, cwd=path) stdout, stderr = popen.communicate() stdout = stdout.decode('utf-8') if not (popen.returncode or stderr): remote_url = stdout.rstrip() return remote_url def git_tags(path, revision): if not revision or len(revision) == 0: return None popen = subprocess.Popen(['git', '-P', 'tag', '--points-at', revision], stdout=subprocess.PIPE, stderr=subprocess.PIPE, cwd=path) stdout, stderr = popen.communicate() stdout = stdout.decode('utf-8') tags = None if not (popen.returncode or stderr): tags = stdout.rstrip().splitlines() return tags workspace_dirty = False path = PurePath(project_path).as_posix() revision, dirty = git_revision(path) workspace_dirty |= dirty remote = git_remote(path) tags = git_tags(path, revision) meta_project = {'path': path, 'revision': revision} if remote: meta_project['remote'] = remote if tags: meta_project['tags'] = tags return meta_project, workspace_dirty def _get_meta_project(meta_projects_list, project_path): projects = [ prj for prj in meta_projects_list[1:] if prj["path"] == project_path ] return projects[0] if len(projects) == 1 else None def process_meta(zephyr_base, west_projs, modules, extra_modules=None, propagate_state=False): # Process zephyr_base, projects, and modules and create a dictionary # with meta information for each input. # # The dictionary will contain meta info in the following lists: # - zephyr: path and revision # - modules: name, path, and revision # - west-projects: path and revision # # returns the dictionary with said lists meta = {'zephyr': None, 'modules': None, 'workspace': None} zephyr_project, zephyr_dirty = _create_meta_project(zephyr_base) zephyr_off = zephyr_project.get("remote") is None workspace_dirty = zephyr_dirty workspace_extra = extra_modules is not None workspace_off = zephyr_off if zephyr_off and is_valid_git_revision(zephyr_project['revision']): zephyr_project['revision'] += '-off' meta['zephyr'] = zephyr_project meta['workspace'] = {} if west_projs is not None: from west.manifest import MANIFEST_REV_BRANCH projects = west_projs['projects'] meta_projects = [] manifest_path = projects[0].posixpath # Special treatment of manifest project # Git information (remote/revision) are not provided by west for the Manifest (west.yml) # To mitigate this, we check if we don't use the manifest from the zephyr repository or an other project. # If it's from zephyr, reuse zephyr information # If it's from an other project, ignore it, it will be added later # If it's not found, we extract data manually (remote/revision) from the directory manifest_project = None manifest_dirty = False manifest_off = False if zephyr_base == manifest_path: manifest_project = zephyr_project manifest_dirty = zephyr_dirty manifest_off = zephyr_off elif not [ prj for prj in projects[1:] if prj.posixpath == manifest_path ]: manifest_project, manifest_dirty = _create_meta_project( projects[0].posixpath) manifest_off = manifest_project.get("remote") is None if manifest_off and is_valid_git_revision(manifest_project['revision']): manifest_project["revision"] += "-off" if manifest_project: workspace_off |= manifest_off workspace_dirty |= manifest_dirty meta_projects.append(manifest_project) # Iterates on all projects except the first one (manifest) for project in projects[1:]: meta_project, dirty = _create_meta_project(project.posixpath) workspace_dirty |= dirty meta_projects.append(meta_project) off = False if not meta_project.get("remote") or project.sha(MANIFEST_REV_BRANCH) != meta_project['revision'].removesuffix("-dirty"): off = True if not meta_project.get('remote') or project.url != meta_project['remote']: # Force manifest URL and set commit as 'off' meta_project['url'] = project.url off = True if off: if is_valid_git_revision(meta_project['revision']): meta_project['revision'] += '-off' workspace_off |= off # If manifest is in project, updates related variables if project.posixpath == manifest_path: manifest_dirty |= dirty manifest_off |= off manifest_project = meta_project meta.update({'west': {'manifest': west_projs['manifest_path'], 'projects': meta_projects}}) meta['workspace'].update({'off': workspace_off}) # Iterates on all modules meta_modules = [] for module in modules: # Check if modules is not in projects # It allows to have the "-off" flag since `modules` variable` does not provide URL/remote meta_module = _get_meta_project(meta_projects, module.project) if not meta_module: meta_module, dirty = _create_meta_project(module.project) workspace_dirty |= dirty meta_module['name'] = module.meta.get('name') if module.meta.get('security'): meta_module['security'] = module.meta.get('security') meta_modules.append(meta_module) meta['modules'] = meta_modules meta['workspace'].update({'dirty': workspace_dirty, 'extra': workspace_extra}) if propagate_state: zephyr_revision = zephyr_project['revision'] if is_valid_git_revision(zephyr_revision): if workspace_dirty and not zephyr_dirty: zephyr_revision += '-dirty' if workspace_extra: zephyr_revision += '-extra' if workspace_off and not zephyr_off: zephyr_revision += '-off' zephyr_project.update({'revision': zephyr_revision}) if west_projs is not None: manifest_revision = manifest_project['revision'] if is_valid_git_revision(manifest_revision): if workspace_dirty and not manifest_dirty: manifest_revision += '-dirty' if workspace_extra: manifest_revision += '-extra' if workspace_off and not manifest_off: manifest_revision += '-off' manifest_project.update({'revision': manifest_revision}) return meta def west_projects(manifest=None): manifest_path = None projects = [] # West is imported here, as it is optional # (and thus maybe not installed) # if user is providing a specific modules list. try: from west.manifest import Manifest except ImportError: # West is not installed, so don't return any projects. return None # If west *is* installed, we need all of the following imports to # work. West versions that are excessively old may fail here: # west.configuration.MalformedConfig was # west.manifest.MalformedConfig until west v0.14.0, for example. # These should be hard errors. from west.manifest import \ ManifestImportFailed, MalformedManifest, ManifestVersionError from west.configuration import MalformedConfig from west.util import WestNotFound from west.version import __version__ as WestVersion from packaging import version try: if not manifest: manifest = Manifest.from_file() if version.parse(WestVersion) >= version.parse('0.9.0'): projects = [p for p in manifest.get_projects([]) if manifest.is_active(p)] else: projects = manifest.get_projects([]) manifest_path = manifest.path return {'manifest_path': manifest_path, 'projects': projects} except (ManifestImportFailed, MalformedManifest, ManifestVersionError, MalformedConfig) as e: sys.exit(f'ERROR: {e}') 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. pass return None def parse_modules(zephyr_base, manifest=None, west_projs=None, modules=None, extra_modules=None): if modules is None: west_projs = west_projs or west_projects(manifest) modules = ([p.posixpath for p in west_projs['projects']] if west_projs else []) if extra_modules is None: extra_modules = [] for var in ['EXTRA_ZEPHYR_MODULES', 'ZEPHYR_EXTRA_MODULES']: if var in os.environ: extra_modules.extend(PurePosixPath(p) for p in os.environ[var].split(';')) Module = namedtuple('Module', ['project', 'meta', 'depends']) all_modules_by_name = {} # 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 modules + extra_modules: # Avoid including Zephyr base project as module. if project == zephyr_base: continue meta = process_module(project) if meta: depends = meta.get('build', {}).get('depends', []) all_modules_by_name[meta['name']] = Module(project, meta, depends) elif project in extra_modules: sys.exit(f'{project}, given in ZEPHYR_EXTRA_MODULES, ' 'is not a valid zephyr module') for module in all_modules_by_name.values(): if not module.depends: start_modules.append(module) else: dep_modules.append(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''', allow_abbrev=False) 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('--sysbuild-kconfig-out', help="""File to write with resulting KConfig import statements.""") parser.add_argument('--sysbuild-cmake-out', help="""File to write with resulting <name>:<path> values to use for including in CMake""") parser.add_argument('--meta-out', help="""Write a build meta YaML file containing a list of Zephyr modules and west projects. If a module or project is also a git repository the current SHA revision will also be written.""") parser.add_argument('--meta-state-propagate', action='store_true', help="""Propagate state of modules and west projects to the suffix of the Zephyr SHA and if west is used, to the suffix of the manifest SHA""") 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 = "" sysbuild_kconfig = "" sysbuild_cmake = "" settings = "" twister = "" west_projs = west_projects() modules = parse_modules(args.zephyr_base, None, west_projs, args.modules, args.extra_modules) for module in modules: kconfig += process_kconfig(module.project, module.meta) cmake += process_cmake(module.project, module.meta) sysbuild_kconfig += process_sysbuildkconfig( module.project, module.meta) sysbuild_cmake += process_sysbuildcmake(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.sysbuild_kconfig_out: with open(args.sysbuild_kconfig_out, 'w', encoding="utf-8") as fp: fp.write(sysbuild_kconfig) if args.sysbuild_cmake_out: with open(args.sysbuild_cmake_out, 'w', encoding="utf-8") as fp: fp.write(sysbuild_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 args.meta_out: meta = process_meta(args.zephyr_base, west_projs, modules, args.extra_modules, args.meta_state_propagate) with open(args.meta_out, 'w', encoding="utf-8") as fp: # Ignore references and insert data instead yaml.Dumper.ignore_aliases = lambda self, data: True fp.write(yaml.dump(meta)) if __name__ == "__main__": main() |