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 Each line is printed in the format
34 <defconfig_name> : <action>
36 <defconfig_name> is the name of the defconfig
37 (without the suffix _defconfig).
39 <action> shows what the tool did for that defconfig.
40 It looks like one of the followings:
43 This config option was moved to the defconfig
45 - CONFIG_... is not defined in Kconfig. Do nothing.
46 The entry for this CONFIG was not found in Kconfig.
47 There are two common cases:
48 - You forgot to create an entry for the CONFIG before running
49 this tool, or made a typo in a CONFIG passed to this tool.
50 - The entry was hidden due to unmet 'depends on'.
51 This is correct behavior.
53 - 'CONFIG_...' is the same as the define in Kconfig. Do nothing.
54 The define in the config header matched the one in Kconfig.
55 We do not need to touch it.
57 - Undefined. Do nothing.
58 This config option was not found in the config header.
61 - Compiler is missing. Do nothing.
62 The compiler specified for this architecture was not found
63 in your PATH environment.
64 (If -e option is passed, the tool exits immediately.)
67 An error occurred during processing this defconfig. Skipped.
68 (If -e option is passed, the tool exits immediately on error.)
70 Finally, you will be asked, Clean up headers? [y/n]:
72 If you say 'y' here, the unnecessary config defines are removed
73 from the config headers (include/configs/*.h).
74 It just uses the regex method, so you should not rely on it.
75 Just in case, please do 'git diff' to see what happened.
81 This tool runs configuration and builds include/autoconf.mk for every
82 defconfig. The config options defined in Kconfig appear in the .config
83 file (unless they are hidden because of unmet dependency.)
84 On the other hand, the config options defined by board headers are seen
85 in include/autoconf.mk. The tool looks for the specified options in both
86 of them to decide the appropriate action for the options. If the given
87 config option is found in the .config, but its value does not match the
88 one from the board header, the config option in the .config is replaced
89 with the define in the board header. Then, the .config is synced by
90 "make savedefconfig" and the defconfig is updated with it.
92 For faster processing, this tool handles multi-threading. It creates
93 separate build directories where the out-of-tree build is run. The
94 temporary build directories are automatically created and deleted as
95 needed. The number of threads are chosen based on the number of the CPU
96 cores of your system although you can change it via -j (--jobs) option.
102 Appropriate toolchain are necessary to generate include/autoconf.mk
103 for all the architectures supported by U-Boot. Most of them are available
104 at the kernel.org site, some are not provided by kernel.org.
106 The default per-arch CROSS_COMPILE used by this tool is specified by
107 the list below, CROSS_COMPILE. You may wish to update the list to
108 use your own. Instead of modifying the list directly, you can give
109 them via environments.
116 Surround each portion of the log with escape sequences to display it
117 in color on the terminal.
120 Specify a file containing a list of defconfigs to move
123 Perform a trial run that does not make any changes. It is useful to
124 see what is going to happen before one actually runs it.
127 Exit immediately if Make exits with a non-zero status while processing
131 Only cleanup the headers; skip the defconfig processing
134 Specify the number of threads to run simultaneously. If not specified,
135 the number of threads is the same as the number of CPU cores.
138 Show any build errors as boards are built
140 To see the complete list of supported options, run
142 $ tools/moveconfig.py -h
147 import multiprocessing
157 SHOW_GNU_MAKE = 'scripts/show-gnu-make'
160 # Here is the list of cross-tools I use.
161 # Most of them are available at kernel.org
162 # (https://www.kernel.org/pub/tools/crosstool/files/bin/), except the followings:
163 # arc: https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain/releases
164 # blackfin: http://sourceforge.net/projects/adi-toolchain/files/
165 # nds32: http://osdk.andestech.com/packages/nds32le-linux-glibc-v1.tgz
166 # nios2: https://sourcery.mentor.com/GNUToolchain/subscription42545
167 # sh: http://sourcery.mentor.com/public/gnu_toolchain/sh-linux-gnu
169 # openrisc kernel.org toolchain is out of date, download latest one from
170 # http://opencores.org/or1k/OpenRISC_GNU_tool_chain#Prebuilt_versions
173 'aarch64': 'aarch64-linux-',
174 'arm': 'arm-unknown-linux-gnueabi-',
175 'avr32': 'avr32-linux-',
176 'blackfin': 'bfin-elf-',
177 'm68k': 'm68k-linux-',
178 'microblaze': 'microblaze-linux-',
179 'mips': 'mips-linux-',
180 'nds32': 'nds32le-linux-',
181 'nios2': 'nios2-linux-gnu-',
182 'openrisc': 'or1k-elf-',
183 'powerpc': 'powerpc-linux-',
184 'sh': 'sh-linux-gnu-',
185 'sparc': 'sparc-linux-',
192 STATE_SAVEDEFCONFIG = 3
203 COLOR_PURPLE = '0;35'
205 COLOR_LIGHT_GRAY = '0;37'
206 COLOR_DARK_GRAY = '1;30'
207 COLOR_LIGHT_RED = '1;31'
208 COLOR_LIGHT_GREEN = '1;32'
209 COLOR_YELLOW = '1;33'
210 COLOR_LIGHT_BLUE = '1;34'
211 COLOR_LIGHT_PURPLE = '1;35'
212 COLOR_LIGHT_CYAN = '1;36'
215 ### helper functions ###
217 """Get the file object of '/dev/null' device."""
219 devnull = subprocess.DEVNULL # py3k
220 except AttributeError:
221 devnull = open(os.devnull, 'wb')
224 def check_top_directory():
225 """Exit if we are not at the top of source directory."""
226 for f in ('README', 'Licenses'):
227 if not os.path.exists(f):
228 sys.exit('Please run at the top of source directory.')
230 def check_clean_directory():
231 """Exit if the source tree is not clean."""
232 for f in ('.config', 'include/config'):
233 if os.path.exists(f):
234 sys.exit("source tree is not clean, please run 'make mrproper'")
237 """Get the command name of GNU Make.
239 U-Boot needs GNU Make for building, but the command name is not
240 necessarily "make". (for example, "gmake" on FreeBSD).
241 Returns the most appropriate command name on your system.
243 process = subprocess.Popen([SHOW_GNU_MAKE], stdout=subprocess.PIPE)
244 ret = process.communicate()
245 if process.returncode:
246 sys.exit('GNU Make not found')
247 return ret[0].rstrip()
249 def color_text(color_enabled, color, string):
250 """Return colored string."""
252 return '\033[' + color + 'm' + string + '\033[0m'
256 def log_msg(color_enabled, color, defconfig, msg):
257 """Return the formated line for the log."""
258 return defconfig[:-len('_defconfig')].ljust(37) + ': ' + \
259 color_text(color_enabled, color, msg) + '\n'
261 def update_cross_compile(color_enabled):
262 """Update per-arch CROSS_COMPILE via environment variables
264 The default CROSS_COMPILE values are available
265 in the CROSS_COMPILE list above.
267 You can override them via environment variables
268 CROSS_COMPILE_{ARCH}.
270 For example, if you want to override toolchain prefixes
271 for ARM and PowerPC, you can do as follows in your shell:
273 export CROSS_COMPILE_ARM=...
274 export CROSS_COMPILE_POWERPC=...
276 Then, this function checks if specified compilers really exist in your
281 for arch in os.listdir('arch'):
282 if os.path.exists(os.path.join('arch', arch, 'Makefile')):
285 # arm64 is a special case
286 archs.append('aarch64')
289 env = 'CROSS_COMPILE_' + arch.upper()
290 cross_compile = os.environ.get(env)
291 if not cross_compile:
292 cross_compile = CROSS_COMPILE.get(arch, '')
294 for path in os.environ["PATH"].split(os.pathsep):
295 gcc_path = os.path.join(path, cross_compile + 'gcc')
296 if os.path.isfile(gcc_path) and os.access(gcc_path, os.X_OK):
299 print >> sys.stderr, color_text(color_enabled, COLOR_YELLOW,
300 'warning: %sgcc: not found in PATH. %s architecture boards will be skipped'
301 % (cross_compile, arch))
304 CROSS_COMPILE[arch] = cross_compile
306 def cleanup_one_header(header_path, patterns, dry_run):
307 """Clean regex-matched lines away from a file.
310 header_path: path to the cleaned file.
311 patterns: list of regex patterns. Any lines matching to these
312 patterns are deleted.
313 dry_run: make no changes, but still display log.
315 with open(header_path) as f:
316 lines = f.readlines()
319 for i, line in enumerate(lines):
320 for pattern in patterns:
321 m = pattern.search(line)
323 print '%s: %s: %s' % (header_path, i + 1, line),
327 if dry_run or not matched:
330 with open(header_path, 'w') as f:
331 for i, line in enumerate(lines):
335 def cleanup_headers(configs, dry_run):
336 """Delete config defines from board headers.
339 configs: A list of CONFIGs to remove.
340 dry_run: make no changes, but still display log.
343 choice = raw_input('Clean up headers? [y/n]: ').lower()
345 if choice == 'y' or choice == 'n':
352 for config in configs:
353 patterns.append(re.compile(r'#\s*define\s+%s\W' % config))
354 patterns.append(re.compile(r'#\s*undef\s+%s\W' % config))
356 for dir in 'include', 'arch', 'board':
357 for (dirpath, dirnames, filenames) in os.walk(dir):
358 for filename in filenames:
359 if not fnmatch.fnmatch(filename, '*~'):
360 cleanup_one_header(os.path.join(dirpath, filename),
366 """Progress Indicator"""
368 def __init__(self, total):
369 """Create a new progress indicator.
372 total: A number of defconfig files to process.
378 """Increment the number of processed defconfig files."""
383 """Display the progress."""
384 print ' %d defconfigs out of %d\r' % (self.current, self.total),
389 """A parser of .config and include/autoconf.mk."""
391 re_arch = re.compile(r'CONFIG_SYS_ARCH="(.*)"')
392 re_cpu = re.compile(r'CONFIG_SYS_CPU="(.*)"')
394 def __init__(self, configs, options, progress, build_dir):
395 """Create a new parser.
398 configs: A list of CONFIGs to move.
399 options: option flags.
400 progress: A progress indicator
401 build_dir: Build directory.
403 self.configs = configs
404 self.options = options
405 self.progress = progress
406 self.build_dir = build_dir
408 def get_cross_compile(self):
409 """Parse .config file and return CROSS_COMPILE.
412 A string storing the compiler prefix for the architecture.
413 Return a NULL string for architectures that do not require
414 compiler prefix (Sandbox and native build is the case).
415 Return None if the specified compiler is missing in your PATH.
416 Caller should distinguish '' and None.
420 dotconfig = os.path.join(self.build_dir, '.config')
421 for line in open(dotconfig):
422 m = self.re_arch.match(line)
426 m = self.re_cpu.match(line)
434 if arch == 'arm' and cpu == 'armv8':
437 return CROSS_COMPILE.get(arch, None)
439 def parse_one_config(self, config, dotconfig_lines, autoconf_lines):
440 """Parse .config, defconfig, include/autoconf.mk for one config.
442 This function looks for the config options in the lines from
443 defconfig, .config, and include/autoconf.mk in order to decide
444 which action should be taken for this defconfig.
447 config: CONFIG name to parse.
448 dotconfig_lines: lines from the .config file.
449 autoconf_lines: lines from the include/autoconf.mk file.
452 A tupple of the action for this defconfig and the line
453 matched for the config.
455 not_set = '# %s is not set' % config
457 for line in dotconfig_lines:
459 if line.startswith(config + '=') or line == not_set:
463 return (ACTION_NO_ENTRY, config)
465 for line in autoconf_lines:
467 if line.startswith(config + '='):
473 if old_val == new_val:
474 return (ACTION_NO_CHANGE, new_val)
476 # If this CONFIG is neither bool nor trisate
477 if old_val[-2:] != '=y' and old_val[-2:] != '=m' and old_val != not_set:
478 # tools/scripts/define2mk.sed changes '1' to 'y'.
479 # This is a problem if the CONFIG is int type.
480 # Check the type in Kconfig and handle it correctly.
481 if new_val[-2:] == '=y':
482 new_val = new_val[:-1] + '1'
484 return (ACTION_MOVE, new_val)
486 def update_dotconfig(self, defconfig):
487 """Parse files for the config options and update the .config.
489 This function parses the generated .config and include/autoconf.mk
490 searching the target options.
491 Move the config option(s) to the .config as needed.
492 Also, display the log to show what happened to the .config.
495 defconfig: defconfig name.
498 dotconfig_path = os.path.join(self.build_dir, '.config')
499 autoconf_path = os.path.join(self.build_dir, 'include', 'autoconf.mk')
502 with open(dotconfig_path) as f:
503 dotconfig_lines = f.readlines()
505 with open(autoconf_path) as f:
506 autoconf_lines = f.readlines()
508 for config in self.configs:
509 result = self.parse_one_config(config, dotconfig_lines,
511 results.append(result)
515 for (action, value) in results:
516 if action == ACTION_MOVE:
517 actlog = "Move '%s'" % value
518 log_color = COLOR_LIGHT_GREEN
519 elif action == ACTION_NO_ENTRY:
520 actlog = "%s is not defined in Kconfig. Do nothing." % value
521 log_color = COLOR_LIGHT_BLUE
522 elif action == ACTION_NO_CHANGE:
523 actlog = "'%s' is the same as the define in Kconfig. Do nothing." \
525 log_color = COLOR_LIGHT_PURPLE
527 sys.exit("Internal Error. This should not happen.")
529 log += log_msg(self.options.color, log_color, defconfig, actlog)
531 # Some threads are running in parallel.
532 # Print log in one shot to not mix up logs from different threads.
536 with open(dotconfig_path, 'a') as f:
537 for (action, value) in results:
538 if action == ACTION_MOVE:
539 f.write(value + '\n')
541 os.remove(os.path.join(self.build_dir, 'include', 'config', 'auto.conf'))
542 os.remove(autoconf_path)
546 """A slot to store a subprocess.
548 Each instance of this class handles one subprocess.
549 This class is useful to control multiple threads
550 for faster processing.
553 def __init__(self, configs, options, progress, devnull, make_cmd):
554 """Create a new process slot.
557 configs: A list of CONFIGs to move.
558 options: option flags.
559 progress: A progress indicator.
560 devnull: A file object of '/dev/null'.
561 make_cmd: command name of GNU Make.
563 self.options = options
564 self.progress = progress
565 self.build_dir = tempfile.mkdtemp()
566 self.devnull = devnull
567 self.make_cmd = (make_cmd, 'O=' + self.build_dir)
568 self.parser = KconfigParser(configs, options, progress, self.build_dir)
569 self.state = STATE_IDLE
570 self.failed_boards = []
573 """Delete the working directory
575 This function makes sure the temporary directory is cleaned away
576 even if Python suddenly dies due to error. It should be done in here
577 because it is guranteed the destructor is always invoked when the
578 instance of the class gets unreferenced.
580 If the subprocess is still running, wait until it finishes.
582 if self.state != STATE_IDLE:
583 while self.ps.poll() == None:
585 shutil.rmtree(self.build_dir)
587 def add(self, defconfig):
588 """Assign a new subprocess for defconfig and add it to the slot.
590 If the slot is vacant, create a new subprocess for processing the
591 given defconfig and add it to the slot. Just returns False if
592 the slot is occupied (i.e. the current subprocess is still running).
595 defconfig: defconfig name.
598 Return True on success or False on failure
600 if self.state != STATE_IDLE:
602 cmd = list(self.make_cmd)
603 cmd.append(defconfig)
604 self.ps = subprocess.Popen(cmd, stdout=self.devnull,
605 stderr=subprocess.PIPE)
606 self.defconfig = defconfig
607 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 print >> sys.stderr, log_msg(self.options.color, COLOR_LIGHT_RED,
631 self.defconfig, "Failed to process."),
632 if self.options.verbose:
633 print >> sys.stderr, color_text(self.options.color,
635 self.ps.stderr.read())
638 if self.options.exit_on_error:
639 sys.exit("Exit on error.")
640 # If --exit-on-error flag is not set, skip this board and continue.
641 # Record the failed board.
642 self.failed_boards.append(self.defconfig)
643 self.state = STATE_IDLE
646 if self.state == STATE_AUTOCONF:
647 self.parser.update_dotconfig(self.defconfig)
649 """Save off the defconfig in a consistent way"""
650 cmd = list(self.make_cmd)
651 cmd.append('savedefconfig')
652 self.ps = subprocess.Popen(cmd, stdout=self.devnull,
653 stderr=subprocess.PIPE)
654 self.state = STATE_SAVEDEFCONFIG
657 if self.state == STATE_SAVEDEFCONFIG:
658 if not self.options.dry_run:
659 shutil.move(os.path.join(self.build_dir, 'defconfig'),
660 os.path.join('configs', self.defconfig))
662 self.state = STATE_IDLE
665 self.cross_compile = self.parser.get_cross_compile()
666 if self.cross_compile is None:
667 print >> sys.stderr, log_msg(self.options.color, COLOR_YELLOW,
669 "Compiler is missing. Do nothing."),
672 if self.options.exit_on_error:
673 sys.exit("Exit on error.")
674 # If --exit-on-error flag is not set, skip this board and continue.
675 # Record the failed board.
676 self.failed_boards.append(self.defconfig)
677 self.state = STATE_IDLE
680 cmd = list(self.make_cmd)
681 if self.cross_compile:
682 cmd.append('CROSS_COMPILE=%s' % self.cross_compile)
683 cmd.append('KCONFIG_IGNORE_DUPLICATES=1')
684 cmd.append('include/config/auto.conf')
685 self.ps = subprocess.Popen(cmd, stdout=self.devnull,
686 stderr=subprocess.PIPE)
687 self.state = STATE_AUTOCONF
690 def get_failed_boards(self):
691 """Returns a list of failed boards (defconfigs) in this slot.
693 return self.failed_boards
697 """Controller of the array of subprocess slots."""
699 def __init__(self, configs, options, progress):
700 """Create a new slots controller.
703 configs: A list of CONFIGs to move.
704 options: option flags.
705 progress: A progress indicator.
707 self.options = options
709 devnull = get_devnull()
710 make_cmd = get_make_cmd()
711 for i in range(options.jobs):
712 self.slots.append(Slot(configs, options, progress, devnull,
715 def add(self, defconfig):
716 """Add a new subprocess if a vacant slot is found.
719 defconfig: defconfig name to be put into.
722 Return True on success or False on failure
724 for slot in self.slots:
725 if slot.add(defconfig):
730 """Check if there is a vacant slot.
733 Return True if at lease one vacant slot is found, False otherwise.
735 for slot in self.slots:
741 """Check if all slots are vacant.
744 Return True if all the slots are vacant, False otherwise.
747 for slot in self.slots:
752 def show_failed_boards(self):
753 """Display all of the failed boards (defconfigs)."""
756 for slot in self.slots:
757 failed_boards += slot.get_failed_boards()
759 if len(failed_boards) > 0:
760 msg = [ "The following boards were not processed due to error:" ]
763 print >> sys.stderr, color_text(self.options.color,
764 COLOR_LIGHT_RED, line)
766 with open('moveconfig.failed', 'w') as f:
767 for board in failed_boards:
768 f.write(board + '\n')
770 def move_config(configs, options):
771 """Move config options to defconfig files.
774 configs: A list of CONFIGs to move.
775 options: option flags
777 if len(configs) == 0:
778 print 'Nothing to do. exit.'
781 print 'Move %s (jobs: %d)' % (', '.join(configs), options.jobs)
783 if options.defconfigs:
784 defconfigs = [line.strip() for line in open(options.defconfigs)]
785 for i, defconfig in enumerate(defconfigs):
786 if not defconfig.endswith('_defconfig'):
787 defconfigs[i] = defconfig + '_defconfig'
788 if not os.path.exists(os.path.join('configs', defconfigs[i])):
789 sys.exit('%s - defconfig does not exist. Stopping.' %
792 # All the defconfig files to be processed
794 for (dirpath, dirnames, filenames) in os.walk('configs'):
795 dirpath = dirpath[len('configs') + 1:]
796 for filename in fnmatch.filter(filenames, '*_defconfig'):
797 defconfigs.append(os.path.join(dirpath, filename))
799 progress = Progress(len(defconfigs))
800 slots = Slots(configs, options, progress)
802 # Main loop to process defconfig files:
803 # Add a new subprocess into a vacant slot.
804 # Sleep if there is no available slot.
805 for defconfig in defconfigs:
806 while not slots.add(defconfig):
807 while not slots.available():
808 # No available slot: sleep for a while
809 time.sleep(SLEEP_TIME)
811 # wait until all the subprocesses finish
812 while not slots.empty():
813 time.sleep(SLEEP_TIME)
817 slots.show_failed_boards()
821 cpu_count = multiprocessing.cpu_count()
822 except NotImplementedError:
825 parser = optparse.OptionParser()
827 parser.add_option('-c', '--color', action='store_true', default=False,
828 help='display the log in color')
829 parser.add_option('-d', '--defconfigs', type='string',
830 help='a file containing a list of defconfigs to move')
831 parser.add_option('-n', '--dry-run', action='store_true', default=False,
832 help='perform a trial run (show log with no changes)')
833 parser.add_option('-e', '--exit-on-error', action='store_true',
835 help='exit immediately on any error')
836 parser.add_option('-H', '--headers-only', dest='cleanup_headers_only',
837 action='store_true', default=False,
838 help='only cleanup the headers')
839 parser.add_option('-j', '--jobs', type='int', default=cpu_count,
840 help='the number of jobs to run simultaneously')
841 parser.add_option('-v', '--verbose', action='store_true', default=False,
842 help='show any build errors as boards are built')
843 parser.usage += ' CONFIG ...'
845 (options, configs) = parser.parse_args()
847 if len(configs) == 0:
851 # prefix the option name with CONFIG_ if missing
852 configs = [ config if config.startswith('CONFIG_') else 'CONFIG_' + config
853 for config in configs ]
855 check_top_directory()
857 check_clean_directory()
859 update_cross_compile(options.color)
861 if not options.cleanup_headers_only:
862 move_config(configs, options)
864 cleanup_headers(configs, options.dry_run)
866 if __name__ == '__main__':