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 following:
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. The option is not
51 defined in the config header, either. So, this case can be just skipped.
53 - CONFIG_... is not defined in Kconfig (suspicious). Do nothing.
54 This option is defined in the config header, but its entry was not found
56 There are two common cases:
57 - You forgot to create an entry for the CONFIG before running
58 this tool, or made a typo in a CONFIG passed to this tool.
59 - The entry was hidden due to unmet 'depends on'.
60 The tool does not know if the result is reasonable, so please check it
63 - 'CONFIG_...' is the same as the define in Kconfig. Do nothing.
64 The define in the config header matched the one in Kconfig.
65 We do not need to touch it.
67 - Compiler is missing. Do nothing.
68 The compiler specified for this architecture was not found
69 in your PATH environment.
70 (If -e option is passed, the tool exits immediately.)
73 An error occurred during processing this defconfig. Skipped.
74 (If -e option is passed, the tool exits immediately on error.)
76 Finally, you will be asked, Clean up headers? [y/n]:
78 If you say 'y' here, the unnecessary config defines are removed
79 from the config headers (include/configs/*.h).
80 It just uses the regex method, so you should not rely on it.
81 Just in case, please do 'git diff' to see what happened.
87 This tool runs configuration and builds include/autoconf.mk for every
88 defconfig. The config options defined in Kconfig appear in the .config
89 file (unless they are hidden because of unmet dependency.)
90 On the other hand, the config options defined by board headers are seen
91 in include/autoconf.mk. The tool looks for the specified options in both
92 of them to decide the appropriate action for the options. If the given
93 config option is found in the .config, but its value does not match the
94 one from the board header, the config option in the .config is replaced
95 with the define in the board header. Then, the .config is synced by
96 "make savedefconfig" and the defconfig is updated with it.
98 For faster processing, this tool handles multi-threading. It creates
99 separate build directories where the out-of-tree build is run. The
100 temporary build directories are automatically created and deleted as
101 needed. The number of threads are chosen based on the number of the CPU
102 cores of your system although you can change it via -j (--jobs) option.
108 Appropriate toolchain are necessary to generate include/autoconf.mk
109 for all the architectures supported by U-Boot. Most of them are available
110 at the kernel.org site, some are not provided by kernel.org.
112 The default per-arch CROSS_COMPILE used by this tool is specified by
113 the list below, CROSS_COMPILE. You may wish to update the list to
114 use your own. Instead of modifying the list directly, you can give
115 them via environments.
122 Surround each portion of the log with escape sequences to display it
123 in color on the terminal.
126 Create a git commit with the changes when the operation is complete. A
127 standard commit message is used which may need to be edited.
130 Specify a file containing a list of defconfigs to move. The defconfig
131 files can be given with shell-style wildcards.
134 Perform a trial run that does not make any changes. It is useful to
135 see what is going to happen before one actually runs it.
138 Exit immediately if Make exits with a non-zero status while processing
142 Do "make savedefconfig" forcibly for all the defconfig files.
143 If not specified, "make savedefconfig" only occurs for cases
144 where at least one CONFIG was moved.
147 Look for moved config options in spl/include/autoconf.mk instead of
148 include/autoconf.mk. This is useful for moving options for SPL build
149 because SPL related options (mostly prefixed with CONFIG_SPL_) are
150 sometimes blocked by CONFIG_SPL_BUILD ifdef conditionals.
153 Only cleanup the headers; skip the defconfig processing
156 Specify the number of threads to run simultaneously. If not specified,
157 the number of threads is the same as the number of CPU cores.
160 Specify the git ref to clone for building the autoconf.mk. If unspecified
161 use the CWD. This is useful for when changes to the Kconfig affect the
162 default values and you want to capture the state of the defconfig from
163 before that change was in effect. If in doubt, specify a ref pre-Kconfig
164 changes (use HEAD if Kconfig changes are not committed). Worst case it will
165 take a bit longer to run, but will always do the right thing.
168 Show any build errors as boards are built
171 Instead of prompting, automatically go ahead with all operations. This
172 includes cleaning up headers and CONFIG_SYS_EXTRA_OPTIONS.
174 To see the complete list of supported options, run
176 $ tools/moveconfig.py -h
185 import multiprocessing
195 SHOW_GNU_MAKE = 'scripts/show-gnu-make'
198 # Here is the list of cross-tools I use.
199 # Most of them are available at kernel.org
200 # (https://www.kernel.org/pub/tools/crosstool/files/bin/), except the following:
201 # arc: https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain/releases
202 # nds32: http://osdk.andestech.com/packages/nds32le-linux-glibc-v1.tgz
203 # nios2: https://sourcery.mentor.com/GNUToolchain/subscription42545
204 # sh: http://sourcery.mentor.com/public/gnu_toolchain/sh-linux-gnu
207 'aarch64': 'aarch64-linux-',
208 'arm': 'arm-unknown-linux-gnueabi-',
209 'm68k': 'm68k-linux-',
210 'microblaze': 'microblaze-linux-',
211 'mips': 'mips-linux-',
212 'nds32': 'nds32le-linux-',
213 'nios2': 'nios2-linux-gnu-',
214 'powerpc': 'powerpc-linux-',
215 'sh': 'sh-linux-gnu-',
216 'x86': 'i386-linux-',
217 'xtensa': 'xtensa-linux-'
223 STATE_SAVEDEFCONFIG = 3
227 ACTION_NO_ENTRY_WARN = 2
235 COLOR_PURPLE = '0;35'
237 COLOR_LIGHT_GRAY = '0;37'
238 COLOR_DARK_GRAY = '1;30'
239 COLOR_LIGHT_RED = '1;31'
240 COLOR_LIGHT_GREEN = '1;32'
241 COLOR_YELLOW = '1;33'
242 COLOR_LIGHT_BLUE = '1;34'
243 COLOR_LIGHT_PURPLE = '1;35'
244 COLOR_LIGHT_CYAN = '1;36'
247 ### helper functions ###
249 """Get the file object of '/dev/null' device."""
251 devnull = subprocess.DEVNULL # py3k
252 except AttributeError:
253 devnull = open(os.devnull, 'wb')
256 def check_top_directory():
257 """Exit if we are not at the top of source directory."""
258 for f in ('README', 'Licenses'):
259 if not os.path.exists(f):
260 sys.exit('Please run at the top of source directory.')
262 def check_clean_directory():
263 """Exit if the source tree is not clean."""
264 for f in ('.config', 'include/config'):
265 if os.path.exists(f):
266 sys.exit("source tree is not clean, please run 'make mrproper'")
269 """Get the command name of GNU Make.
271 U-Boot needs GNU Make for building, but the command name is not
272 necessarily "make". (for example, "gmake" on FreeBSD).
273 Returns the most appropriate command name on your system.
275 process = subprocess.Popen([SHOW_GNU_MAKE], stdout=subprocess.PIPE)
276 ret = process.communicate()
277 if process.returncode:
278 sys.exit('GNU Make not found')
279 return ret[0].rstrip()
281 def get_matched_defconfig(line):
282 """Get the defconfig files that match a pattern
285 line: Path or filename to match, e.g. 'configs/snow_defconfig' or
286 'k2*_defconfig'. If no directory is provided, 'configs/' is
290 a list of matching defconfig files
292 dirname = os.path.dirname(line)
296 pattern = os.path.join('configs', line)
297 return glob.glob(pattern) + glob.glob(pattern + '_defconfig')
299 def get_matched_defconfigs(defconfigs_file):
300 """Get all the defconfig files that match the patterns in a file."""
302 for i, line in enumerate(open(defconfigs_file)):
305 continue # skip blank lines silently
306 matched = get_matched_defconfig(line)
308 print >> sys.stderr, "warning: %s:%d: no defconfig matched '%s'" % \
309 (defconfigs_file, i + 1, line)
311 defconfigs += matched
313 # use set() to drop multiple matching
314 return [ defconfig[len('configs') + 1:] for defconfig in set(defconfigs) ]
316 def get_all_defconfigs():
317 """Get all the defconfig files under the configs/ directory."""
319 for (dirpath, dirnames, filenames) in os.walk('configs'):
320 dirpath = dirpath[len('configs') + 1:]
321 for filename in fnmatch.filter(filenames, '*_defconfig'):
322 defconfigs.append(os.path.join(dirpath, filename))
326 def color_text(color_enabled, color, string):
327 """Return colored string."""
329 # LF should not be surrounded by the escape sequence.
330 # Otherwise, additional whitespace or line-feed might be printed.
331 return '\n'.join([ '\033[' + color + 'm' + s + '\033[0m' if s else ''
332 for s in string.split('\n') ])
336 def show_diff(a, b, file_path, color_enabled):
337 """Show unidified diff.
340 a: A list of lines (before)
341 b: A list of lines (after)
342 file_path: Path to the file
343 color_enabled: Display the diff in color
346 diff = difflib.unified_diff(a, b,
347 fromfile=os.path.join('a', file_path),
348 tofile=os.path.join('b', file_path))
351 if line[0] == '-' and line[1] != '-':
352 print color_text(color_enabled, COLOR_RED, line),
353 elif line[0] == '+' and line[1] != '+':
354 print color_text(color_enabled, COLOR_GREEN, line),
358 def update_cross_compile(color_enabled):
359 """Update per-arch CROSS_COMPILE via environment variables
361 The default CROSS_COMPILE values are available
362 in the CROSS_COMPILE list above.
364 You can override them via environment variables
365 CROSS_COMPILE_{ARCH}.
367 For example, if you want to override toolchain prefixes
368 for ARM and PowerPC, you can do as follows in your shell:
370 export CROSS_COMPILE_ARM=...
371 export CROSS_COMPILE_POWERPC=...
373 Then, this function checks if specified compilers really exist in your
378 for arch in os.listdir('arch'):
379 if os.path.exists(os.path.join('arch', arch, 'Makefile')):
382 # arm64 is a special case
383 archs.append('aarch64')
386 env = 'CROSS_COMPILE_' + arch.upper()
387 cross_compile = os.environ.get(env)
388 if not cross_compile:
389 cross_compile = CROSS_COMPILE.get(arch, '')
391 for path in os.environ["PATH"].split(os.pathsep):
392 gcc_path = os.path.join(path, cross_compile + 'gcc')
393 if os.path.isfile(gcc_path) and os.access(gcc_path, os.X_OK):
396 print >> sys.stderr, color_text(color_enabled, COLOR_YELLOW,
397 'warning: %sgcc: not found in PATH. %s architecture boards will be skipped'
398 % (cross_compile, arch))
401 CROSS_COMPILE[arch] = cross_compile
403 def extend_matched_lines(lines, matched, pre_patterns, post_patterns, extend_pre,
405 """Extend matched lines if desired patterns are found before/after already
409 lines: A list of lines handled.
410 matched: A list of line numbers that have been already matched.
411 (will be updated by this function)
412 pre_patterns: A list of regular expression that should be matched as
414 post_patterns: A list of regular expression that should be matched as
416 extend_pre: Add the line number of matched preamble to the matched list.
417 extend_post: Add the line number of matched postamble to the matched list.
419 extended_matched = []
432 for p in pre_patterns:
433 if p.search(lines[i - 1]):
439 for p in post_patterns:
440 if p.search(lines[j]):
447 extended_matched.append(i - 1)
449 extended_matched.append(j)
451 matched += extended_matched
454 def confirm(options, prompt):
457 choice = raw_input('{} [y/n]: '.format(prompt))
458 choice = choice.lower()
460 if choice == 'y' or choice == 'n':
468 def cleanup_one_header(header_path, patterns, options):
469 """Clean regex-matched lines away from a file.
472 header_path: path to the cleaned file.
473 patterns: list of regex patterns. Any lines matching to these
474 patterns are deleted.
475 options: option flags.
477 with open(header_path) as f:
478 lines = f.readlines()
481 for i, line in enumerate(lines):
482 if i - 1 in matched and lines[i - 1][-2:] == '\\\n':
485 for pattern in patterns:
486 if pattern.search(line):
493 # remove empty #ifdef ... #endif, successive blank lines
494 pattern_if = re.compile(r'#\s*if(def|ndef)?\W') # #if, #ifdef, #ifndef
495 pattern_elif = re.compile(r'#\s*el(if|se)\W') # #elif, #else
496 pattern_endif = re.compile(r'#\s*endif\W') # #endif
497 pattern_blank = re.compile(r'^\s*$') # empty line
500 old_matched = copy.copy(matched)
501 extend_matched_lines(lines, matched, [pattern_if],
502 [pattern_endif], True, True)
503 extend_matched_lines(lines, matched, [pattern_elif],
504 [pattern_elif, pattern_endif], True, False)
505 extend_matched_lines(lines, matched, [pattern_if, pattern_elif],
506 [pattern_blank], False, True)
507 extend_matched_lines(lines, matched, [pattern_blank],
508 [pattern_elif, pattern_endif], True, False)
509 extend_matched_lines(lines, matched, [pattern_blank],
510 [pattern_blank], True, False)
511 if matched == old_matched:
514 tolines = copy.copy(lines)
516 for i in reversed(matched):
519 show_diff(lines, tolines, header_path, options.color)
524 with open(header_path, 'w') as f:
528 def cleanup_headers(configs, options):
529 """Delete config defines from board headers.
532 configs: A list of CONFIGs to remove.
533 options: option flags.
535 if not confirm(options, 'Clean up headers?'):
539 for config in configs:
540 patterns.append(re.compile(r'#\s*define\s+%s\W' % config))
541 patterns.append(re.compile(r'#\s*undef\s+%s\W' % config))
543 for dir in 'include', 'arch', 'board':
544 for (dirpath, dirnames, filenames) in os.walk(dir):
545 if dirpath == os.path.join('include', 'generated'):
547 for filename in filenames:
548 if not fnmatch.fnmatch(filename, '*~'):
549 cleanup_one_header(os.path.join(dirpath, filename),
552 def cleanup_one_extra_option(defconfig_path, configs, options):
553 """Delete config defines in CONFIG_SYS_EXTRA_OPTIONS in one defconfig file.
556 defconfig_path: path to the cleaned defconfig file.
557 configs: A list of CONFIGs to remove.
558 options: option flags.
561 start = 'CONFIG_SYS_EXTRA_OPTIONS="'
564 with open(defconfig_path) as f:
565 lines = f.readlines()
567 for i, line in enumerate(lines):
568 if line.startswith(start) and line.endswith(end):
571 # CONFIG_SYS_EXTRA_OPTIONS was not found in this defconfig
574 old_tokens = line[len(start):-len(end)].split(',')
577 for token in old_tokens:
578 pos = token.find('=')
579 if not (token[:pos] if pos >= 0 else token) in configs:
580 new_tokens.append(token)
582 if new_tokens == old_tokens:
585 tolines = copy.copy(lines)
588 tolines[i] = start + ','.join(new_tokens) + end
592 show_diff(lines, tolines, defconfig_path, options.color)
597 with open(defconfig_path, 'w') as f:
601 def cleanup_extra_options(configs, options):
602 """Delete config defines in CONFIG_SYS_EXTRA_OPTIONS in defconfig files.
605 configs: A list of CONFIGs to remove.
606 options: option flags.
608 if not confirm(options, 'Clean up CONFIG_SYS_EXTRA_OPTIONS?'):
611 configs = [ config[len('CONFIG_'):] for config in configs ]
613 defconfigs = get_all_defconfigs()
615 for defconfig in defconfigs:
616 cleanup_one_extra_option(os.path.join('configs', defconfig), configs,
619 def cleanup_whitelist(configs, options):
620 """Delete config whitelist entries
623 configs: A list of CONFIGs to remove.
624 options: option flags.
626 if not confirm(options, 'Clean up whitelist entries?'):
629 with open(os.path.join('scripts', 'config_whitelist.txt')) as f:
630 lines = f.readlines()
632 lines = [x for x in lines if x.strip() not in configs]
634 with open(os.path.join('scripts', 'config_whitelist.txt'), 'w') as f:
635 f.write(''.join(lines))
637 def find_matching(patterns, line):
643 def cleanup_readme(configs, options):
644 """Delete config description in README
647 configs: A list of CONFIGs to remove.
648 options: option flags.
650 if not confirm(options, 'Clean up README?'):
654 for config in configs:
655 patterns.append(re.compile(r'^\s+%s' % config))
657 with open('README') as f:
658 lines = f.readlines()
664 found = find_matching(patterns, line)
668 if found and re.search(r'^\s+CONFIG', line):
672 newlines.append(line)
674 with open('README', 'w') as f:
675 f.write(''.join(newlines))
681 """Progress Indicator"""
683 def __init__(self, total):
684 """Create a new progress indicator.
687 total: A number of defconfig files to process.
693 """Increment the number of processed defconfig files."""
698 """Display the progress."""
699 print ' %d defconfigs out of %d\r' % (self.current, self.total),
704 """A parser of .config and include/autoconf.mk."""
706 re_arch = re.compile(r'CONFIG_SYS_ARCH="(.*)"')
707 re_cpu = re.compile(r'CONFIG_SYS_CPU="(.*)"')
709 def __init__(self, configs, options, build_dir):
710 """Create a new parser.
713 configs: A list of CONFIGs to move.
714 options: option flags.
715 build_dir: Build directory.
717 self.configs = configs
718 self.options = options
719 self.dotconfig = os.path.join(build_dir, '.config')
720 self.autoconf = os.path.join(build_dir, 'include', 'autoconf.mk')
721 self.spl_autoconf = os.path.join(build_dir, 'spl', 'include',
723 self.config_autoconf = os.path.join(build_dir, 'include', 'config',
725 self.defconfig = os.path.join(build_dir, 'defconfig')
727 def get_cross_compile(self):
728 """Parse .config file and return CROSS_COMPILE.
731 A string storing the compiler prefix for the architecture.
732 Return a NULL string for architectures that do not require
733 compiler prefix (Sandbox and native build is the case).
734 Return None if the specified compiler is missing in your PATH.
735 Caller should distinguish '' and None.
739 for line in open(self.dotconfig):
740 m = self.re_arch.match(line)
744 m = self.re_cpu.match(line)
752 if arch == 'arm' and cpu == 'armv8':
755 return CROSS_COMPILE.get(arch, None)
757 def parse_one_config(self, config, dotconfig_lines, autoconf_lines):
758 """Parse .config, defconfig, include/autoconf.mk for one config.
760 This function looks for the config options in the lines from
761 defconfig, .config, and include/autoconf.mk in order to decide
762 which action should be taken for this defconfig.
765 config: CONFIG name to parse.
766 dotconfig_lines: lines from the .config file.
767 autoconf_lines: lines from the include/autoconf.mk file.
770 A tupple of the action for this defconfig and the line
771 matched for the config.
773 not_set = '# %s is not set' % config
775 for line in autoconf_lines:
777 if line.startswith(config + '='):
783 for line in dotconfig_lines:
785 if line.startswith(config + '=') or line == not_set:
789 if new_val == not_set:
790 return (ACTION_NO_ENTRY, config)
792 return (ACTION_NO_ENTRY_WARN, config)
794 # If this CONFIG is neither bool nor trisate
795 if old_val[-2:] != '=y' and old_val[-2:] != '=m' and old_val != not_set:
796 # tools/scripts/define2mk.sed changes '1' to 'y'.
797 # This is a problem if the CONFIG is int type.
798 # Check the type in Kconfig and handle it correctly.
799 if new_val[-2:] == '=y':
800 new_val = new_val[:-1] + '1'
802 return (ACTION_NO_CHANGE if old_val == new_val else ACTION_MOVE,
805 def update_dotconfig(self):
806 """Parse files for the config options and update the .config.
808 This function parses the generated .config and include/autoconf.mk
809 searching the target options.
810 Move the config option(s) to the .config as needed.
813 defconfig: defconfig name.
816 Return a tuple of (updated flag, log string).
817 The "updated flag" is True if the .config was updated, False
818 otherwise. The "log string" shows what happend to the .config.
824 rm_files = [self.config_autoconf, self.autoconf]
827 if os.path.exists(self.spl_autoconf):
828 autoconf_path = self.spl_autoconf
829 rm_files.append(self.spl_autoconf)
833 return (updated, suspicious,
834 color_text(self.options.color, COLOR_BROWN,
835 "SPL is not enabled. Skipped.") + '\n')
837 autoconf_path = self.autoconf
839 with open(self.dotconfig) as f:
840 dotconfig_lines = f.readlines()
842 with open(autoconf_path) as f:
843 autoconf_lines = f.readlines()
845 for config in self.configs:
846 result = self.parse_one_config(config, dotconfig_lines,
848 results.append(result)
852 for (action, value) in results:
853 if action == ACTION_MOVE:
854 actlog = "Move '%s'" % value
855 log_color = COLOR_LIGHT_GREEN
856 elif action == ACTION_NO_ENTRY:
857 actlog = "%s is not defined in Kconfig. Do nothing." % value
858 log_color = COLOR_LIGHT_BLUE
859 elif action == ACTION_NO_ENTRY_WARN:
860 actlog = "%s is not defined in Kconfig (suspicious). Do nothing." % value
861 log_color = COLOR_YELLOW
863 elif action == ACTION_NO_CHANGE:
864 actlog = "'%s' is the same as the define in Kconfig. Do nothing." \
866 log_color = COLOR_LIGHT_PURPLE
867 elif action == ACTION_SPL_NOT_EXIST:
868 actlog = "SPL is not enabled for this defconfig. Skip."
869 log_color = COLOR_PURPLE
871 sys.exit("Internal Error. This should not happen.")
873 log += color_text(self.options.color, log_color, actlog) + '\n'
875 with open(self.dotconfig, 'a') as f:
876 for (action, value) in results:
877 if action == ACTION_MOVE:
878 f.write(value + '\n')
881 self.results = results
885 return (updated, suspicious, log)
887 def check_defconfig(self):
888 """Check the defconfig after savedefconfig
891 Return additional log if moved CONFIGs were removed again by
892 'make savedefconfig'.
897 with open(self.defconfig) as f:
898 defconfig_lines = f.readlines()
900 for (action, value) in self.results:
901 if action != ACTION_MOVE:
903 if not value + '\n' in defconfig_lines:
904 log += color_text(self.options.color, COLOR_YELLOW,
905 "'%s' was removed by savedefconfig.\n" %
912 """A slot to store a subprocess.
914 Each instance of this class handles one subprocess.
915 This class is useful to control multiple threads
916 for faster processing.
919 def __init__(self, configs, options, progress, devnull, make_cmd, reference_src_dir):
920 """Create a new process slot.
923 configs: A list of CONFIGs to move.
924 options: option flags.
925 progress: A progress indicator.
926 devnull: A file object of '/dev/null'.
927 make_cmd: command name of GNU Make.
928 reference_src_dir: Determine the true starting config state from this
931 self.options = options
932 self.progress = progress
933 self.build_dir = tempfile.mkdtemp()
934 self.devnull = devnull
935 self.make_cmd = (make_cmd, 'O=' + self.build_dir)
936 self.reference_src_dir = reference_src_dir
937 self.parser = KconfigParser(configs, options, self.build_dir)
938 self.state = STATE_IDLE
939 self.failed_boards = set()
940 self.suspicious_boards = set()
943 """Delete the working directory
945 This function makes sure the temporary directory is cleaned away
946 even if Python suddenly dies due to error. It should be done in here
947 because it is guaranteed the destructor is always invoked when the
948 instance of the class gets unreferenced.
950 If the subprocess is still running, wait until it finishes.
952 if self.state != STATE_IDLE:
953 while self.ps.poll() == None:
955 shutil.rmtree(self.build_dir)
957 def add(self, defconfig):
958 """Assign a new subprocess for defconfig and add it to the slot.
960 If the slot is vacant, create a new subprocess for processing the
961 given defconfig and add it to the slot. Just returns False if
962 the slot is occupied (i.e. the current subprocess is still running).
965 defconfig: defconfig name.
968 Return True on success or False on failure
970 if self.state != STATE_IDLE:
973 self.defconfig = defconfig
975 self.current_src_dir = self.reference_src_dir
980 """Check the status of the subprocess and handle it as needed.
982 Returns True if the slot is vacant (i.e. in idle state).
983 If the configuration is successfully finished, assign a new
984 subprocess to build include/autoconf.mk.
985 If include/autoconf.mk is generated, invoke the parser to
986 parse the .config and the include/autoconf.mk, moving
987 config options to the .config as needed.
988 If the .config was updated, run "make savedefconfig" to sync
989 it, update the original defconfig, and then set the slot back
993 Return True if the subprocess is terminated, False otherwise
995 if self.state == STATE_IDLE:
998 if self.ps.poll() == None:
1001 if self.ps.poll() != 0:
1003 elif self.state == STATE_DEFCONFIG:
1004 if self.reference_src_dir and not self.current_src_dir:
1005 self.do_savedefconfig()
1008 elif self.state == STATE_AUTOCONF:
1009 if self.current_src_dir:
1010 self.current_src_dir = None
1013 self.do_savedefconfig()
1014 elif self.state == STATE_SAVEDEFCONFIG:
1015 self.update_defconfig()
1017 sys.exit("Internal Error. This should not happen.")
1019 return True if self.state == STATE_IDLE else False
1021 def handle_error(self):
1022 """Handle error cases."""
1024 self.log += color_text(self.options.color, COLOR_LIGHT_RED,
1025 "Failed to process.\n")
1026 if self.options.verbose:
1027 self.log += color_text(self.options.color, COLOR_LIGHT_CYAN,
1028 self.ps.stderr.read())
1031 def do_defconfig(self):
1032 """Run 'make <board>_defconfig' to create the .config file."""
1034 cmd = list(self.make_cmd)
1035 cmd.append(self.defconfig)
1036 self.ps = subprocess.Popen(cmd, stdout=self.devnull,
1037 stderr=subprocess.PIPE,
1038 cwd=self.current_src_dir)
1039 self.state = STATE_DEFCONFIG
1041 def do_autoconf(self):
1042 """Run 'make include/config/auto.conf'."""
1044 self.cross_compile = self.parser.get_cross_compile()
1045 if self.cross_compile is None:
1046 self.log += color_text(self.options.color, COLOR_YELLOW,
1047 "Compiler is missing. Do nothing.\n")
1051 cmd = list(self.make_cmd)
1052 if self.cross_compile:
1053 cmd.append('CROSS_COMPILE=%s' % self.cross_compile)
1054 cmd.append('KCONFIG_IGNORE_DUPLICATES=1')
1055 cmd.append('include/config/auto.conf')
1056 self.ps = subprocess.Popen(cmd, stdout=self.devnull,
1057 stderr=subprocess.PIPE,
1058 cwd=self.current_src_dir)
1059 self.state = STATE_AUTOCONF
1061 def do_savedefconfig(self):
1062 """Update the .config and run 'make savedefconfig'."""
1064 (updated, suspicious, log) = self.parser.update_dotconfig()
1066 self.suspicious_boards.add(self.defconfig)
1069 if not self.options.force_sync and not updated:
1073 self.log += color_text(self.options.color, COLOR_LIGHT_GREEN,
1074 "Syncing by savedefconfig...\n")
1076 self.log += "Syncing by savedefconfig (forced by option)...\n"
1078 cmd = list(self.make_cmd)
1079 cmd.append('savedefconfig')
1080 self.ps = subprocess.Popen(cmd, stdout=self.devnull,
1081 stderr=subprocess.PIPE)
1082 self.state = STATE_SAVEDEFCONFIG
1084 def update_defconfig(self):
1085 """Update the input defconfig and go back to the idle state."""
1087 log = self.parser.check_defconfig()
1089 self.suspicious_boards.add(self.defconfig)
1091 orig_defconfig = os.path.join('configs', self.defconfig)
1092 new_defconfig = os.path.join(self.build_dir, 'defconfig')
1093 updated = not filecmp.cmp(orig_defconfig, new_defconfig)
1096 self.log += color_text(self.options.color, COLOR_LIGHT_BLUE,
1097 "defconfig was updated.\n")
1099 if not self.options.dry_run and updated:
1100 shutil.move(new_defconfig, orig_defconfig)
1103 def finish(self, success):
1104 """Display log along with progress and go to the idle state.
1107 success: Should be True when the defconfig was processed
1108 successfully, or False when it fails.
1110 # output at least 30 characters to hide the "* defconfigs out of *".
1111 log = self.defconfig.ljust(30) + '\n'
1113 log += '\n'.join([ ' ' + s for s in self.log.split('\n') ])
1114 # Some threads are running in parallel.
1115 # Print log atomically to not mix up logs from different threads.
1116 print >> (sys.stdout if success else sys.stderr), log
1119 if self.options.exit_on_error:
1120 sys.exit("Exit on error.")
1121 # If --exit-on-error flag is not set, skip this board and continue.
1122 # Record the failed board.
1123 self.failed_boards.add(self.defconfig)
1126 self.progress.show()
1127 self.state = STATE_IDLE
1129 def get_failed_boards(self):
1130 """Returns a set of failed boards (defconfigs) in this slot.
1132 return self.failed_boards
1134 def get_suspicious_boards(self):
1135 """Returns a set of boards (defconfigs) with possible misconversion.
1137 return self.suspicious_boards - self.failed_boards
1141 """Controller of the array of subprocess slots."""
1143 def __init__(self, configs, options, progress, reference_src_dir):
1144 """Create a new slots controller.
1147 configs: A list of CONFIGs to move.
1148 options: option flags.
1149 progress: A progress indicator.
1150 reference_src_dir: Determine the true starting config state from this
1153 self.options = options
1155 devnull = get_devnull()
1156 make_cmd = get_make_cmd()
1157 for i in range(options.jobs):
1158 self.slots.append(Slot(configs, options, progress, devnull,
1159 make_cmd, reference_src_dir))
1161 def add(self, defconfig):
1162 """Add a new subprocess if a vacant slot is found.
1165 defconfig: defconfig name to be put into.
1168 Return True on success or False on failure
1170 for slot in self.slots:
1171 if slot.add(defconfig):
1175 def available(self):
1176 """Check if there is a vacant slot.
1179 Return True if at lease one vacant slot is found, False otherwise.
1181 for slot in self.slots:
1187 """Check if all slots are vacant.
1190 Return True if all the slots are vacant, False otherwise.
1193 for slot in self.slots:
1198 def show_failed_boards(self):
1199 """Display all of the failed boards (defconfigs)."""
1201 output_file = 'moveconfig.failed'
1203 for slot in self.slots:
1204 boards |= slot.get_failed_boards()
1207 boards = '\n'.join(boards) + '\n'
1208 msg = "The following boards were not processed due to error:\n"
1210 msg += "(the list has been saved in %s)\n" % output_file
1211 print >> sys.stderr, color_text(self.options.color, COLOR_LIGHT_RED,
1214 with open(output_file, 'w') as f:
1217 def show_suspicious_boards(self):
1218 """Display all boards (defconfigs) with possible misconversion."""
1220 output_file = 'moveconfig.suspicious'
1222 for slot in self.slots:
1223 boards |= slot.get_suspicious_boards()
1226 boards = '\n'.join(boards) + '\n'
1227 msg = "The following boards might have been converted incorrectly.\n"
1228 msg += "It is highly recommended to check them manually:\n"
1230 msg += "(the list has been saved in %s)\n" % output_file
1231 print >> sys.stderr, color_text(self.options.color, COLOR_YELLOW,
1234 with open(output_file, 'w') as f:
1237 class ReferenceSource:
1239 """Reference source against which original configs should be parsed."""
1241 def __init__(self, commit):
1242 """Create a reference source directory based on a specified commit.
1245 commit: commit to git-clone
1247 self.src_dir = tempfile.mkdtemp()
1248 print "Cloning git repo to a separate work directory..."
1249 subprocess.check_output(['git', 'clone', os.getcwd(), '.'],
1251 print "Checkout '%s' to build the original autoconf.mk." % \
1252 subprocess.check_output(['git', 'rev-parse', '--short', commit]).strip()
1253 subprocess.check_output(['git', 'checkout', commit],
1254 stderr=subprocess.STDOUT, cwd=self.src_dir)
1257 """Delete the reference source directory
1259 This function makes sure the temporary directory is cleaned away
1260 even if Python suddenly dies due to error. It should be done in here
1261 because it is guaranteed the destructor is always invoked when the
1262 instance of the class gets unreferenced.
1264 shutil.rmtree(self.src_dir)
1267 """Return the absolute path to the reference source directory."""
1271 def move_config(configs, options):
1272 """Move config options to defconfig files.
1275 configs: A list of CONFIGs to move.
1276 options: option flags
1278 if len(configs) == 0:
1279 if options.force_sync:
1280 print 'No CONFIG is specified. You are probably syncing defconfigs.',
1282 print 'Neither CONFIG nor --force-sync is specified. Nothing will happen.',
1284 print 'Move ' + ', '.join(configs),
1285 print '(jobs: %d)\n' % options.jobs
1288 reference_src = ReferenceSource(options.git_ref)
1289 reference_src_dir = reference_src.get_dir()
1291 reference_src_dir = None
1293 if options.defconfigs:
1294 defconfigs = get_matched_defconfigs(options.defconfigs)
1296 defconfigs = get_all_defconfigs()
1298 progress = Progress(len(defconfigs))
1299 slots = Slots(configs, options, progress, reference_src_dir)
1301 # Main loop to process defconfig files:
1302 # Add a new subprocess into a vacant slot.
1303 # Sleep if there is no available slot.
1304 for defconfig in defconfigs:
1305 while not slots.add(defconfig):
1306 while not slots.available():
1307 # No available slot: sleep for a while
1308 time.sleep(SLEEP_TIME)
1310 # wait until all the subprocesses finish
1311 while not slots.empty():
1312 time.sleep(SLEEP_TIME)
1315 slots.show_failed_boards()
1316 slots.show_suspicious_boards()
1320 cpu_count = multiprocessing.cpu_count()
1321 except NotImplementedError:
1324 parser = optparse.OptionParser()
1326 parser.add_option('-c', '--color', action='store_true', default=False,
1327 help='display the log in color')
1328 parser.add_option('-C', '--commit', action='store_true', default=False,
1329 help='Create a git commit for the operation')
1330 parser.add_option('-d', '--defconfigs', type='string',
1331 help='a file containing a list of defconfigs to move')
1332 parser.add_option('-n', '--dry-run', action='store_true', default=False,
1333 help='perform a trial run (show log with no changes)')
1334 parser.add_option('-e', '--exit-on-error', action='store_true',
1336 help='exit immediately on any error')
1337 parser.add_option('-s', '--force-sync', action='store_true', default=False,
1338 help='force sync by savedefconfig')
1339 parser.add_option('-S', '--spl', action='store_true', default=False,
1340 help='parse config options defined for SPL build')
1341 parser.add_option('-H', '--headers-only', dest='cleanup_headers_only',
1342 action='store_true', default=False,
1343 help='only cleanup the headers')
1344 parser.add_option('-j', '--jobs', type='int', default=cpu_count,
1345 help='the number of jobs to run simultaneously')
1346 parser.add_option('-r', '--git-ref', type='string',
1347 help='the git ref to clone for building the autoconf.mk')
1348 parser.add_option('-y', '--yes', action='store_true', default=False,
1349 help="respond 'yes' to any prompts")
1350 parser.add_option('-v', '--verbose', action='store_true', default=False,
1351 help='show any build errors as boards are built')
1352 parser.usage += ' CONFIG ...'
1354 (options, configs) = parser.parse_args()
1356 if len(configs) == 0 and not options.force_sync:
1357 parser.print_usage()
1360 # prefix the option name with CONFIG_ if missing
1361 configs = [ config if config.startswith('CONFIG_') else 'CONFIG_' + config
1362 for config in configs ]
1364 check_top_directory()
1366 if not options.cleanup_headers_only:
1367 check_clean_directory()
1368 update_cross_compile(options.color)
1369 move_config(configs, options)
1372 cleanup_headers(configs, options)
1373 cleanup_extra_options(configs, options)
1374 cleanup_whitelist(configs, options)
1375 cleanup_readme(configs, options)
1378 subprocess.call(['git', 'add', '-u'])
1380 msg = 'Convert %s %sto Kconfig' % (configs[0],
1381 'et al ' if len(configs) > 1 else '')
1382 msg += ('\n\nThis converts the following to Kconfig:\n %s\n' %
1383 '\n '.join(configs))
1385 msg = 'configs: Resync with savedefconfig'
1386 msg += '\n\nRsync all defconfig files using moveconfig.py'
1387 subprocess.call(['git', 'commit', '-s', '-m', msg])
1389 if __name__ == '__main__':