3 # Author: Masahiro Yamada <yamada.masahiro@socionext.com>
5 # SPDX-License-Identifier: GPL-2.0+
9 Move config options from headers to defconfig files.
11 Since Kconfig was introduced to U-Boot, we have worked on moving
12 config options from headers to Kconfig (defconfig).
14 This tool intends to help this tremendous work.
20 First, you must edit the Kconfig to add the menu entries for the configs
23 And then run this tool giving CONFIG names you want to move.
24 For example, if you want to move CONFIG_CMD_USB and CONFIG_SYS_TEXT_BASE,
25 simply type as follows:
27 $ tools/moveconfig.py CONFIG_CMD_USB CONFIG_SYS_TEXT_BASE
29 The tool walks through all the defconfig files and move the given CONFIGs.
31 The log is also displayed on the terminal.
33 The log is printed for each defconfig as follows:
41 <defconfig_name> is the name of the defconfig.
43 <action*> shows what the tool did for that defconfig.
44 It looks like one of the followings:
47 This config option was moved to the defconfig
49 - CONFIG_... is not defined in Kconfig. Do nothing.
50 The entry for this CONFIG was not found in Kconfig.
51 There are two common cases:
52 - You forgot to create an entry for the CONFIG before running
53 this tool, or made a typo in a CONFIG passed to this tool.
54 - The entry was hidden due to unmet 'depends on'.
55 This is correct behavior.
57 - 'CONFIG_...' is the same as the define in Kconfig. Do nothing.
58 The define in the config header matched the one in Kconfig.
59 We do not need to touch it.
61 - Undefined. Do nothing.
62 This config option was not found in the config header.
65 - Compiler is missing. Do nothing.
66 The compiler specified for this architecture was not found
67 in your PATH environment.
68 (If -e option is passed, the tool exits immediately.)
71 An error occurred during processing this defconfig. Skipped.
72 (If -e option is passed, the tool exits immediately on error.)
74 Finally, you will be asked, Clean up headers? [y/n]:
76 If you say 'y' here, the unnecessary config defines are removed
77 from the config headers (include/configs/*.h).
78 It just uses the regex method, so you should not rely on it.
79 Just in case, please do 'git diff' to see what happened.
85 This tool runs configuration and builds include/autoconf.mk for every
86 defconfig. The config options defined in Kconfig appear in the .config
87 file (unless they are hidden because of unmet dependency.)
88 On the other hand, the config options defined by board headers are seen
89 in include/autoconf.mk. The tool looks for the specified options in both
90 of them to decide the appropriate action for the options. If the given
91 config option is found in the .config, but its value does not match the
92 one from the board header, the config option in the .config is replaced
93 with the define in the board header. Then, the .config is synced by
94 "make savedefconfig" and the defconfig is updated with it.
96 For faster processing, this tool handles multi-threading. It creates
97 separate build directories where the out-of-tree build is run. The
98 temporary build directories are automatically created and deleted as
99 needed. The number of threads are chosen based on the number of the CPU
100 cores of your system although you can change it via -j (--jobs) option.
106 Appropriate toolchain are necessary to generate include/autoconf.mk
107 for all the architectures supported by U-Boot. Most of them are available
108 at the kernel.org site, some are not provided by kernel.org.
110 The default per-arch CROSS_COMPILE used by this tool is specified by
111 the list below, CROSS_COMPILE. You may wish to update the list to
112 use your own. Instead of modifying the list directly, you can give
113 them via environments.
120 Surround each portion of the log with escape sequences to display it
121 in color on the terminal.
124 Specify a file containing a list of defconfigs to move
127 Perform a trial run that does not make any changes. It is useful to
128 see what is going to happen before one actually runs it.
131 Exit immediately if Make exits with a non-zero status while processing
135 Only cleanup the headers; skip the defconfig processing
138 Specify the number of threads to run simultaneously. If not specified,
139 the number of threads is the same as the number of CPU cores.
142 Show any build errors as boards are built
144 To see the complete list of supported options, run
146 $ tools/moveconfig.py -h
151 import multiprocessing
161 SHOW_GNU_MAKE = 'scripts/show-gnu-make'
164 # Here is the list of cross-tools I use.
165 # Most of them are available at kernel.org
166 # (https://www.kernel.org/pub/tools/crosstool/files/bin/), except the followings:
167 # arc: https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain/releases
168 # blackfin: http://sourceforge.net/projects/adi-toolchain/files/
169 # nds32: http://osdk.andestech.com/packages/nds32le-linux-glibc-v1.tgz
170 # nios2: https://sourcery.mentor.com/GNUToolchain/subscription42545
171 # sh: http://sourcery.mentor.com/public/gnu_toolchain/sh-linux-gnu
173 # openrisc kernel.org toolchain is out of date, download latest one from
174 # http://opencores.org/or1k/OpenRISC_GNU_tool_chain#Prebuilt_versions
177 'aarch64': 'aarch64-linux-',
178 'arm': 'arm-unknown-linux-gnueabi-',
179 'avr32': 'avr32-linux-',
180 'blackfin': 'bfin-elf-',
181 'm68k': 'm68k-linux-',
182 'microblaze': 'microblaze-linux-',
183 'mips': 'mips-linux-',
184 'nds32': 'nds32le-linux-',
185 'nios2': 'nios2-linux-gnu-',
186 'openrisc': 'or1k-elf-',
187 'powerpc': 'powerpc-linux-',
188 'sh': 'sh-linux-gnu-',
189 'sparc': 'sparc-linux-',
196 STATE_SAVEDEFCONFIG = 3
207 COLOR_PURPLE = '0;35'
209 COLOR_LIGHT_GRAY = '0;37'
210 COLOR_DARK_GRAY = '1;30'
211 COLOR_LIGHT_RED = '1;31'
212 COLOR_LIGHT_GREEN = '1;32'
213 COLOR_YELLOW = '1;33'
214 COLOR_LIGHT_BLUE = '1;34'
215 COLOR_LIGHT_PURPLE = '1;35'
216 COLOR_LIGHT_CYAN = '1;36'
219 ### helper functions ###
221 """Get the file object of '/dev/null' device."""
223 devnull = subprocess.DEVNULL # py3k
224 except AttributeError:
225 devnull = open(os.devnull, 'wb')
228 def check_top_directory():
229 """Exit if we are not at the top of source directory."""
230 for f in ('README', 'Licenses'):
231 if not os.path.exists(f):
232 sys.exit('Please run at the top of source directory.')
234 def check_clean_directory():
235 """Exit if the source tree is not clean."""
236 for f in ('.config', 'include/config'):
237 if os.path.exists(f):
238 sys.exit("source tree is not clean, please run 'make mrproper'")
241 """Get the command name of GNU Make.
243 U-Boot needs GNU Make for building, but the command name is not
244 necessarily "make". (for example, "gmake" on FreeBSD).
245 Returns the most appropriate command name on your system.
247 process = subprocess.Popen([SHOW_GNU_MAKE], stdout=subprocess.PIPE)
248 ret = process.communicate()
249 if process.returncode:
250 sys.exit('GNU Make not found')
251 return ret[0].rstrip()
253 def color_text(color_enabled, color, string):
254 """Return colored string."""
256 # LF should not be surrounded by the escape sequence.
257 # Otherwise, additional whitespace or line-feed might be printed.
258 return '\n'.join([ '\033[' + color + 'm' + s + '\033[0m' if s else ''
259 for s in string.split('\n') ])
263 def update_cross_compile(color_enabled):
264 """Update per-arch CROSS_COMPILE via environment variables
266 The default CROSS_COMPILE values are available
267 in the CROSS_COMPILE list above.
269 You can override them via environment variables
270 CROSS_COMPILE_{ARCH}.
272 For example, if you want to override toolchain prefixes
273 for ARM and PowerPC, you can do as follows in your shell:
275 export CROSS_COMPILE_ARM=...
276 export CROSS_COMPILE_POWERPC=...
278 Then, this function checks if specified compilers really exist in your
283 for arch in os.listdir('arch'):
284 if os.path.exists(os.path.join('arch', arch, 'Makefile')):
287 # arm64 is a special case
288 archs.append('aarch64')
291 env = 'CROSS_COMPILE_' + arch.upper()
292 cross_compile = os.environ.get(env)
293 if not cross_compile:
294 cross_compile = CROSS_COMPILE.get(arch, '')
296 for path in os.environ["PATH"].split(os.pathsep):
297 gcc_path = os.path.join(path, cross_compile + 'gcc')
298 if os.path.isfile(gcc_path) and os.access(gcc_path, os.X_OK):
301 print >> sys.stderr, color_text(color_enabled, COLOR_YELLOW,
302 'warning: %sgcc: not found in PATH. %s architecture boards will be skipped'
303 % (cross_compile, arch))
306 CROSS_COMPILE[arch] = cross_compile
308 def cleanup_one_header(header_path, patterns, dry_run):
309 """Clean regex-matched lines away from a file.
312 header_path: path to the cleaned file.
313 patterns: list of regex patterns. Any lines matching to these
314 patterns are deleted.
315 dry_run: make no changes, but still display log.
317 with open(header_path) as f:
318 lines = f.readlines()
321 for i, line in enumerate(lines):
322 for pattern in patterns:
323 m = pattern.search(line)
325 print '%s: %s: %s' % (header_path, i + 1, line),
329 if dry_run or not matched:
332 with open(header_path, 'w') as f:
333 for i, line in enumerate(lines):
337 def cleanup_headers(configs, dry_run):
338 """Delete config defines from board headers.
341 configs: A list of CONFIGs to remove.
342 dry_run: make no changes, but still display log.
345 choice = raw_input('Clean up headers? [y/n]: ').lower()
347 if choice == 'y' or choice == 'n':
354 for config in configs:
355 patterns.append(re.compile(r'#\s*define\s+%s\W' % config))
356 patterns.append(re.compile(r'#\s*undef\s+%s\W' % config))
358 for dir in 'include', 'arch', 'board':
359 for (dirpath, dirnames, filenames) in os.walk(dir):
360 for filename in filenames:
361 if not fnmatch.fnmatch(filename, '*~'):
362 cleanup_one_header(os.path.join(dirpath, filename),
368 """Progress Indicator"""
370 def __init__(self, total):
371 """Create a new progress indicator.
374 total: A number of defconfig files to process.
380 """Increment the number of processed defconfig files."""
385 """Display the progress."""
386 print ' %d defconfigs out of %d\r' % (self.current, self.total),
391 """A parser of .config and include/autoconf.mk."""
393 re_arch = re.compile(r'CONFIG_SYS_ARCH="(.*)"')
394 re_cpu = re.compile(r'CONFIG_SYS_CPU="(.*)"')
396 def __init__(self, configs, options, build_dir):
397 """Create a new parser.
400 configs: A list of CONFIGs to move.
401 options: option flags.
402 build_dir: Build directory.
404 self.configs = configs
405 self.options = options
406 self.dotconfig = os.path.join(build_dir, '.config')
407 self.autoconf = os.path.join(build_dir, 'include', 'autoconf.mk')
408 self.config_autoconf = os.path.join(build_dir, 'include', 'config',
411 def get_cross_compile(self):
412 """Parse .config file and return CROSS_COMPILE.
415 A string storing the compiler prefix for the architecture.
416 Return a NULL string for architectures that do not require
417 compiler prefix (Sandbox and native build is the case).
418 Return None if the specified compiler is missing in your PATH.
419 Caller should distinguish '' and None.
423 for line in open(self.dotconfig):
424 m = self.re_arch.match(line)
428 m = self.re_cpu.match(line)
436 if arch == 'arm' and cpu == 'armv8':
439 return CROSS_COMPILE.get(arch, None)
441 def parse_one_config(self, config, dotconfig_lines, autoconf_lines):
442 """Parse .config, defconfig, include/autoconf.mk for one config.
444 This function looks for the config options in the lines from
445 defconfig, .config, and include/autoconf.mk in order to decide
446 which action should be taken for this defconfig.
449 config: CONFIG name to parse.
450 dotconfig_lines: lines from the .config file.
451 autoconf_lines: lines from the include/autoconf.mk file.
454 A tupple of the action for this defconfig and the line
455 matched for the config.
457 not_set = '# %s is not set' % config
459 for line in dotconfig_lines:
461 if line.startswith(config + '=') or line == not_set:
465 return (ACTION_NO_ENTRY, config)
467 for line in autoconf_lines:
469 if line.startswith(config + '='):
475 if old_val == new_val:
476 return (ACTION_NO_CHANGE, new_val)
478 # If this CONFIG is neither bool nor trisate
479 if old_val[-2:] != '=y' and old_val[-2:] != '=m' and old_val != not_set:
480 # tools/scripts/define2mk.sed changes '1' to 'y'.
481 # This is a problem if the CONFIG is int type.
482 # Check the type in Kconfig and handle it correctly.
483 if new_val[-2:] == '=y':
484 new_val = new_val[:-1] + '1'
486 return (ACTION_MOVE, new_val)
488 def update_dotconfig(self):
489 """Parse files for the config options and update the .config.
491 This function parses the generated .config and include/autoconf.mk
492 searching the target options.
493 Move the config option(s) to the .config as needed.
496 defconfig: defconfig name.
504 with open(self.dotconfig) as f:
505 dotconfig_lines = f.readlines()
507 with open(self.autoconf) as f:
508 autoconf_lines = f.readlines()
510 for config in self.configs:
511 result = self.parse_one_config(config, dotconfig_lines,
513 results.append(result)
517 for (action, value) in results:
518 if action == ACTION_MOVE:
519 actlog = "Move '%s'" % value
520 log_color = COLOR_LIGHT_GREEN
521 elif action == ACTION_NO_ENTRY:
522 actlog = "%s is not defined in Kconfig. Do nothing." % value
523 log_color = COLOR_LIGHT_BLUE
524 elif action == ACTION_NO_CHANGE:
525 actlog = "'%s' is the same as the define in Kconfig. Do nothing." \
527 log_color = COLOR_LIGHT_PURPLE
529 sys.exit("Internal Error. This should not happen.")
531 log += color_text(self.options.color, log_color, actlog) + '\n'
533 with open(self.dotconfig, 'a') as f:
534 for (action, value) in results:
535 if action == ACTION_MOVE:
536 f.write(value + '\n')
538 os.remove(self.config_autoconf)
539 os.remove(self.autoconf)
545 """A slot to store a subprocess.
547 Each instance of this class handles one subprocess.
548 This class is useful to control multiple threads
549 for faster processing.
552 def __init__(self, configs, options, progress, devnull, make_cmd):
553 """Create a new process slot.
556 configs: A list of CONFIGs to move.
557 options: option flags.
558 progress: A progress indicator.
559 devnull: A file object of '/dev/null'.
560 make_cmd: command name of GNU Make.
562 self.options = options
563 self.progress = progress
564 self.build_dir = tempfile.mkdtemp()
565 self.devnull = devnull
566 self.make_cmd = (make_cmd, 'O=' + self.build_dir)
567 self.parser = KconfigParser(configs, options, self.build_dir)
568 self.state = STATE_IDLE
569 self.failed_boards = []
572 """Delete the working directory
574 This function makes sure the temporary directory is cleaned away
575 even if Python suddenly dies due to error. It should be done in here
576 because it is guranteed the destructor is always invoked when the
577 instance of the class gets unreferenced.
579 If the subprocess is still running, wait until it finishes.
581 if self.state != STATE_IDLE:
582 while self.ps.poll() == None:
584 shutil.rmtree(self.build_dir)
586 def add(self, defconfig):
587 """Assign a new subprocess for defconfig and add it to the slot.
589 If the slot is vacant, create a new subprocess for processing the
590 given defconfig and add it to the slot. Just returns False if
591 the slot is occupied (i.e. the current subprocess is still running).
594 defconfig: defconfig name.
597 Return True on success or False on failure
599 if self.state != STATE_IDLE:
601 cmd = list(self.make_cmd)
602 cmd.append(defconfig)
603 self.ps = subprocess.Popen(cmd, stdout=self.devnull,
604 stderr=subprocess.PIPE)
605 self.defconfig = defconfig
606 self.state = STATE_DEFCONFIG
611 """Check the status of the subprocess and handle it as needed.
613 Returns True if the slot is vacant (i.e. in idle state).
614 If the configuration is successfully finished, assign a new
615 subprocess to build include/autoconf.mk.
616 If include/autoconf.mk is generated, invoke the parser to
617 parse the .config and the include/autoconf.mk, and then set the
618 slot back to the idle state.
621 Return True if the subprocess is terminated, False otherwise
623 if self.state == STATE_IDLE:
626 if self.ps.poll() == None:
629 if self.ps.poll() != 0:
630 self.log += color_text(self.options.color, COLOR_LIGHT_RED,
631 "Failed to process.\n")
632 if self.options.verbose:
633 self.log += color_text(self.options.color, COLOR_LIGHT_CYAN,
634 self.ps.stderr.read())
638 if self.state == STATE_AUTOCONF:
639 self.log += self.parser.update_dotconfig()
641 """Save off the defconfig in a consistent way"""
642 cmd = list(self.make_cmd)
643 cmd.append('savedefconfig')
644 self.ps = subprocess.Popen(cmd, stdout=self.devnull,
645 stderr=subprocess.PIPE)
646 self.state = STATE_SAVEDEFCONFIG
649 if self.state == STATE_SAVEDEFCONFIG:
650 if not self.options.dry_run:
651 shutil.move(os.path.join(self.build_dir, 'defconfig'),
652 os.path.join('configs', self.defconfig))
656 self.cross_compile = self.parser.get_cross_compile()
657 if self.cross_compile is None:
658 self.log += color_text(self.options.color, COLOR_YELLOW,
659 "Compiler is missing. Do nothing.\n")
663 cmd = list(self.make_cmd)
664 if self.cross_compile:
665 cmd.append('CROSS_COMPILE=%s' % self.cross_compile)
666 cmd.append('KCONFIG_IGNORE_DUPLICATES=1')
667 cmd.append('include/config/auto.conf')
668 self.ps = subprocess.Popen(cmd, stdout=self.devnull,
669 stderr=subprocess.PIPE)
670 self.state = STATE_AUTOCONF
673 def finish(self, success):
674 """Display log along with progress and go to the idle state.
677 success: Should be True when the defconfig was processed
678 successfully, or False when it fails.
680 # output at least 30 characters to hide the "* defconfigs out of *".
681 log = self.defconfig.ljust(30) + '\n'
683 log += '\n'.join([ ' ' + s for s in self.log.split('\n') ])
684 # Some threads are running in parallel.
685 # Print log atomically to not mix up logs from different threads.
686 print >> (sys.stdout if success else sys.stderr), log
689 if self.options.exit_on_error:
690 sys.exit("Exit on error.")
691 # If --exit-on-error flag is not set, skip this board and continue.
692 # Record the failed board.
693 self.failed_boards.append(self.defconfig)
697 self.state = STATE_IDLE
699 def get_failed_boards(self):
700 """Returns a list of failed boards (defconfigs) in this slot.
702 return self.failed_boards
706 """Controller of the array of subprocess slots."""
708 def __init__(self, configs, options, progress):
709 """Create a new slots controller.
712 configs: A list of CONFIGs to move.
713 options: option flags.
714 progress: A progress indicator.
716 self.options = options
718 devnull = get_devnull()
719 make_cmd = get_make_cmd()
720 for i in range(options.jobs):
721 self.slots.append(Slot(configs, options, progress, devnull,
724 def add(self, defconfig):
725 """Add a new subprocess if a vacant slot is found.
728 defconfig: defconfig name to be put into.
731 Return True on success or False on failure
733 for slot in self.slots:
734 if slot.add(defconfig):
739 """Check if there is a vacant slot.
742 Return True if at lease one vacant slot is found, False otherwise.
744 for slot in self.slots:
750 """Check if all slots are vacant.
753 Return True if all the slots are vacant, False otherwise.
756 for slot in self.slots:
761 def show_failed_boards(self):
762 """Display all of the failed boards (defconfigs)."""
765 for slot in self.slots:
766 failed_boards += slot.get_failed_boards()
768 if len(failed_boards) > 0:
769 msg = [ "The following boards were not processed due to error:" ]
772 print >> sys.stderr, color_text(self.options.color,
773 COLOR_LIGHT_RED, line)
775 with open('moveconfig.failed', 'w') as f:
776 for board in failed_boards:
777 f.write(board + '\n')
779 def move_config(configs, options):
780 """Move config options to defconfig files.
783 configs: A list of CONFIGs to move.
784 options: option flags
786 if len(configs) == 0:
787 print 'Nothing to do. exit.'
790 print 'Move %s (jobs: %d)' % (', '.join(configs), options.jobs)
792 if options.defconfigs:
793 defconfigs = [line.strip() for line in open(options.defconfigs)]
794 for i, defconfig in enumerate(defconfigs):
795 if not defconfig.endswith('_defconfig'):
796 defconfigs[i] = defconfig + '_defconfig'
797 if not os.path.exists(os.path.join('configs', defconfigs[i])):
798 sys.exit('%s - defconfig does not exist. Stopping.' %
801 # All the defconfig files to be processed
803 for (dirpath, dirnames, filenames) in os.walk('configs'):
804 dirpath = dirpath[len('configs') + 1:]
805 for filename in fnmatch.filter(filenames, '*_defconfig'):
806 defconfigs.append(os.path.join(dirpath, filename))
808 progress = Progress(len(defconfigs))
809 slots = Slots(configs, options, progress)
811 # Main loop to process defconfig files:
812 # Add a new subprocess into a vacant slot.
813 # Sleep if there is no available slot.
814 for defconfig in defconfigs:
815 while not slots.add(defconfig):
816 while not slots.available():
817 # No available slot: sleep for a while
818 time.sleep(SLEEP_TIME)
820 # wait until all the subprocesses finish
821 while not slots.empty():
822 time.sleep(SLEEP_TIME)
825 slots.show_failed_boards()
829 cpu_count = multiprocessing.cpu_count()
830 except NotImplementedError:
833 parser = optparse.OptionParser()
835 parser.add_option('-c', '--color', action='store_true', default=False,
836 help='display the log in color')
837 parser.add_option('-d', '--defconfigs', type='string',
838 help='a file containing a list of defconfigs to move')
839 parser.add_option('-n', '--dry-run', action='store_true', default=False,
840 help='perform a trial run (show log with no changes)')
841 parser.add_option('-e', '--exit-on-error', action='store_true',
843 help='exit immediately on any error')
844 parser.add_option('-H', '--headers-only', dest='cleanup_headers_only',
845 action='store_true', default=False,
846 help='only cleanup the headers')
847 parser.add_option('-j', '--jobs', type='int', default=cpu_count,
848 help='the number of jobs to run simultaneously')
849 parser.add_option('-v', '--verbose', action='store_true', default=False,
850 help='show any build errors as boards are built')
851 parser.usage += ' CONFIG ...'
853 (options, configs) = parser.parse_args()
855 if len(configs) == 0:
859 # prefix the option name with CONFIG_ if missing
860 configs = [ config if config.startswith('CONFIG_') else 'CONFIG_' + config
861 for config in configs ]
863 check_top_directory()
865 check_clean_directory()
867 update_cross_compile(options.color)
869 if not options.cleanup_headers_only:
870 move_config(configs, options)
872 cleanup_headers(configs, options.dry_run)
874 if __name__ == '__main__':