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 Do "make savedefconfig" forcibly for all the defconfig files.
136 If not specified, "make savedefconfig" only occurs for cases
137 where at least one CONFIG was moved.
140 Only cleanup the headers; skip the defconfig processing
143 Specify the number of threads to run simultaneously. If not specified,
144 the number of threads is the same as the number of CPU cores.
147 Specify the git ref to clone for building the autoconf.mk. If unspecified
148 use the CWD. This is useful for when changes to the Kconfig affect the
149 default values and you want to capture the state of the defconfig from
150 before that change was in effect. If in doubt, specify a ref pre-Kconfig
151 changes (use HEAD if Kconfig changes are not committed). Worst case it will
152 take a bit longer to run, but will always do the right thing.
155 Show any build errors as boards are built
157 To see the complete list of supported options, run
159 $ tools/moveconfig.py -h
167 import multiprocessing
177 SHOW_GNU_MAKE = 'scripts/show-gnu-make'
180 # Here is the list of cross-tools I use.
181 # Most of them are available at kernel.org
182 # (https://www.kernel.org/pub/tools/crosstool/files/bin/), except the followings:
183 # arc: https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain/releases
184 # blackfin: http://sourceforge.net/projects/adi-toolchain/files/
185 # nds32: http://osdk.andestech.com/packages/nds32le-linux-glibc-v1.tgz
186 # nios2: https://sourcery.mentor.com/GNUToolchain/subscription42545
187 # sh: http://sourcery.mentor.com/public/gnu_toolchain/sh-linux-gnu
189 # openrisc kernel.org toolchain is out of date, download latest one from
190 # http://opencores.org/or1k/OpenRISC_GNU_tool_chain#Prebuilt_versions
193 'aarch64': 'aarch64-linux-',
194 'arm': 'arm-unknown-linux-gnueabi-',
195 'avr32': 'avr32-linux-',
196 'blackfin': 'bfin-elf-',
197 'm68k': 'm68k-linux-',
198 'microblaze': 'microblaze-linux-',
199 'mips': 'mips-linux-',
200 'nds32': 'nds32le-linux-',
201 'nios2': 'nios2-linux-gnu-',
202 'openrisc': 'or1k-elf-',
203 'powerpc': 'powerpc-linux-',
204 'sh': 'sh-linux-gnu-',
205 'sparc': 'sparc-linux-',
212 STATE_SAVEDEFCONFIG = 3
223 COLOR_PURPLE = '0;35'
225 COLOR_LIGHT_GRAY = '0;37'
226 COLOR_DARK_GRAY = '1;30'
227 COLOR_LIGHT_RED = '1;31'
228 COLOR_LIGHT_GREEN = '1;32'
229 COLOR_YELLOW = '1;33'
230 COLOR_LIGHT_BLUE = '1;34'
231 COLOR_LIGHT_PURPLE = '1;35'
232 COLOR_LIGHT_CYAN = '1;36'
235 ### helper functions ###
237 """Get the file object of '/dev/null' device."""
239 devnull = subprocess.DEVNULL # py3k
240 except AttributeError:
241 devnull = open(os.devnull, 'wb')
244 def check_top_directory():
245 """Exit if we are not at the top of source directory."""
246 for f in ('README', 'Licenses'):
247 if not os.path.exists(f):
248 sys.exit('Please run at the top of source directory.')
250 def check_clean_directory():
251 """Exit if the source tree is not clean."""
252 for f in ('.config', 'include/config'):
253 if os.path.exists(f):
254 sys.exit("source tree is not clean, please run 'make mrproper'")
257 """Get the command name of GNU Make.
259 U-Boot needs GNU Make for building, but the command name is not
260 necessarily "make". (for example, "gmake" on FreeBSD).
261 Returns the most appropriate command name on your system.
263 process = subprocess.Popen([SHOW_GNU_MAKE], stdout=subprocess.PIPE)
264 ret = process.communicate()
265 if process.returncode:
266 sys.exit('GNU Make not found')
267 return ret[0].rstrip()
269 def get_all_defconfigs():
270 """Get all the defconfig files under the configs/ directory."""
272 for (dirpath, dirnames, filenames) in os.walk('configs'):
273 dirpath = dirpath[len('configs') + 1:]
274 for filename in fnmatch.filter(filenames, '*_defconfig'):
275 defconfigs.append(os.path.join(dirpath, filename))
279 def color_text(color_enabled, color, string):
280 """Return colored string."""
282 # LF should not be surrounded by the escape sequence.
283 # Otherwise, additional whitespace or line-feed might be printed.
284 return '\n'.join([ '\033[' + color + 'm' + s + '\033[0m' if s else ''
285 for s in string.split('\n') ])
289 def show_diff(a, b, file_path, color_enabled):
290 """Show unidified diff.
293 a: A list of lines (before)
294 b: A list of lines (after)
295 file_path: Path to the file
296 color_enabled: Display the diff in color
299 diff = difflib.unified_diff(a, b,
300 fromfile=os.path.join('a', file_path),
301 tofile=os.path.join('b', file_path))
304 if line[0] == '-' and line[1] != '-':
305 print color_text(color_enabled, COLOR_RED, line),
306 elif line[0] == '+' and line[1] != '+':
307 print color_text(color_enabled, COLOR_GREEN, line),
311 def update_cross_compile(color_enabled):
312 """Update per-arch CROSS_COMPILE via environment variables
314 The default CROSS_COMPILE values are available
315 in the CROSS_COMPILE list above.
317 You can override them via environment variables
318 CROSS_COMPILE_{ARCH}.
320 For example, if you want to override toolchain prefixes
321 for ARM and PowerPC, you can do as follows in your shell:
323 export CROSS_COMPILE_ARM=...
324 export CROSS_COMPILE_POWERPC=...
326 Then, this function checks if specified compilers really exist in your
331 for arch in os.listdir('arch'):
332 if os.path.exists(os.path.join('arch', arch, 'Makefile')):
335 # arm64 is a special case
336 archs.append('aarch64')
339 env = 'CROSS_COMPILE_' + arch.upper()
340 cross_compile = os.environ.get(env)
341 if not cross_compile:
342 cross_compile = CROSS_COMPILE.get(arch, '')
344 for path in os.environ["PATH"].split(os.pathsep):
345 gcc_path = os.path.join(path, cross_compile + 'gcc')
346 if os.path.isfile(gcc_path) and os.access(gcc_path, os.X_OK):
349 print >> sys.stderr, color_text(color_enabled, COLOR_YELLOW,
350 'warning: %sgcc: not found in PATH. %s architecture boards will be skipped'
351 % (cross_compile, arch))
354 CROSS_COMPILE[arch] = cross_compile
356 def extend_matched_lines(lines, matched, pre_patterns, post_patterns, extend_pre,
358 """Extend matched lines if desired patterns are found before/after already
362 lines: A list of lines handled.
363 matched: A list of line numbers that have been already matched.
364 (will be updated by this function)
365 pre_patterns: A list of regular expression that should be matched as
367 post_patterns: A list of regular expression that should be matched as
369 extend_pre: Add the line number of matched preamble to the matched list.
370 extend_post: Add the line number of matched postamble to the matched list.
372 extended_matched = []
385 for p in pre_patterns:
386 if p.search(lines[i - 1]):
392 for p in post_patterns:
393 if p.search(lines[j]):
400 extended_matched.append(i - 1)
402 extended_matched.append(j)
404 matched += extended_matched
407 def cleanup_one_header(header_path, patterns, options):
408 """Clean regex-matched lines away from a file.
411 header_path: path to the cleaned file.
412 patterns: list of regex patterns. Any lines matching to these
413 patterns are deleted.
414 options: option flags.
416 with open(header_path) as f:
417 lines = f.readlines()
420 for i, line in enumerate(lines):
421 if i - 1 in matched and lines[i - 1][-2:] == '\\\n':
424 for pattern in patterns:
425 if pattern.search(line):
432 # remove empty #ifdef ... #endif, successive blank lines
433 pattern_if = re.compile(r'#\s*if(def|ndef)?\W') # #if, #ifdef, #ifndef
434 pattern_elif = re.compile(r'#\s*el(if|se)\W') # #elif, #else
435 pattern_endif = re.compile(r'#\s*endif\W') # #endif
436 pattern_blank = re.compile(r'^\s*$') # empty line
439 old_matched = copy.copy(matched)
440 extend_matched_lines(lines, matched, [pattern_if],
441 [pattern_endif], True, True)
442 extend_matched_lines(lines, matched, [pattern_elif],
443 [pattern_elif, pattern_endif], True, False)
444 extend_matched_lines(lines, matched, [pattern_if, pattern_elif],
445 [pattern_blank], False, True)
446 extend_matched_lines(lines, matched, [pattern_blank],
447 [pattern_elif, pattern_endif], True, False)
448 extend_matched_lines(lines, matched, [pattern_blank],
449 [pattern_blank], True, False)
450 if matched == old_matched:
453 tolines = copy.copy(lines)
455 for i in reversed(matched):
458 show_diff(lines, tolines, header_path, options.color)
463 with open(header_path, 'w') as f:
467 def cleanup_headers(configs, options):
468 """Delete config defines from board headers.
471 configs: A list of CONFIGs to remove.
472 options: option flags.
475 choice = raw_input('Clean up headers? [y/n]: ').lower()
477 if choice == 'y' or choice == 'n':
484 for config in configs:
485 patterns.append(re.compile(r'#\s*define\s+%s\W' % config))
486 patterns.append(re.compile(r'#\s*undef\s+%s\W' % config))
488 for dir in 'include', 'arch', 'board':
489 for (dirpath, dirnames, filenames) in os.walk(dir):
490 if dirpath == os.path.join('include', 'generated'):
492 for filename in filenames:
493 if not fnmatch.fnmatch(filename, '*~'):
494 cleanup_one_header(os.path.join(dirpath, filename),
497 def cleanup_one_extra_option(defconfig_path, configs, options):
498 """Delete config defines in CONFIG_SYS_EXTRA_OPTIONS in one defconfig file.
501 defconfig_path: path to the cleaned defconfig file.
502 configs: A list of CONFIGs to remove.
503 options: option flags.
506 start = 'CONFIG_SYS_EXTRA_OPTIONS="'
509 with open(defconfig_path) as f:
510 lines = f.readlines()
512 for i, line in enumerate(lines):
513 if line.startswith(start) and line.endswith(end):
516 # CONFIG_SYS_EXTRA_OPTIONS was not found in this defconfig
519 old_tokens = line[len(start):-len(end)].split(',')
522 for token in old_tokens:
523 pos = token.find('=')
524 if not (token[:pos] if pos >= 0 else token) in configs:
525 new_tokens.append(token)
527 if new_tokens == old_tokens:
530 tolines = copy.copy(lines)
533 tolines[i] = start + ','.join(new_tokens) + end
537 show_diff(lines, tolines, defconfig_path, options.color)
542 with open(defconfig_path, 'w') as f:
546 def cleanup_extra_options(configs, options):
547 """Delete config defines in CONFIG_SYS_EXTRA_OPTIONS in defconfig files.
550 configs: A list of CONFIGs to remove.
551 options: option flags.
554 choice = raw_input('Clean up CONFIG_SYS_EXTRA_OPTIONS? [y/n]: ').lower()
556 if choice == 'y' or choice == 'n':
562 configs = [ config[len('CONFIG_'):] for config in configs ]
564 defconfigs = get_all_defconfigs()
566 for defconfig in defconfigs:
567 cleanup_one_extra_option(os.path.join('configs', defconfig), configs,
573 """Progress Indicator"""
575 def __init__(self, total):
576 """Create a new progress indicator.
579 total: A number of defconfig files to process.
585 """Increment the number of processed defconfig files."""
590 """Display the progress."""
591 print ' %d defconfigs out of %d\r' % (self.current, self.total),
596 """A parser of .config and include/autoconf.mk."""
598 re_arch = re.compile(r'CONFIG_SYS_ARCH="(.*)"')
599 re_cpu = re.compile(r'CONFIG_SYS_CPU="(.*)"')
601 def __init__(self, configs, options, build_dir):
602 """Create a new parser.
605 configs: A list of CONFIGs to move.
606 options: option flags.
607 build_dir: Build directory.
609 self.configs = configs
610 self.options = options
611 self.dotconfig = os.path.join(build_dir, '.config')
612 self.autoconf = os.path.join(build_dir, 'include', 'autoconf.mk')
613 self.config_autoconf = os.path.join(build_dir, 'include', 'config',
615 self.defconfig = os.path.join(build_dir, 'defconfig')
617 def get_cross_compile(self):
618 """Parse .config file and return CROSS_COMPILE.
621 A string storing the compiler prefix for the architecture.
622 Return a NULL string for architectures that do not require
623 compiler prefix (Sandbox and native build is the case).
624 Return None if the specified compiler is missing in your PATH.
625 Caller should distinguish '' and None.
629 for line in open(self.dotconfig):
630 m = self.re_arch.match(line)
634 m = self.re_cpu.match(line)
642 if arch == 'arm' and cpu == 'armv8':
645 return CROSS_COMPILE.get(arch, None)
647 def parse_one_config(self, config, dotconfig_lines, autoconf_lines):
648 """Parse .config, defconfig, include/autoconf.mk for one config.
650 This function looks for the config options in the lines from
651 defconfig, .config, and include/autoconf.mk in order to decide
652 which action should be taken for this defconfig.
655 config: CONFIG name to parse.
656 dotconfig_lines: lines from the .config file.
657 autoconf_lines: lines from the include/autoconf.mk file.
660 A tupple of the action for this defconfig and the line
661 matched for the config.
663 not_set = '# %s is not set' % config
665 for line in dotconfig_lines:
667 if line.startswith(config + '=') or line == not_set:
671 return (ACTION_NO_ENTRY, config)
673 for line in autoconf_lines:
675 if line.startswith(config + '='):
681 # If this CONFIG is neither bool nor trisate
682 if old_val[-2:] != '=y' and old_val[-2:] != '=m' and old_val != not_set:
683 # tools/scripts/define2mk.sed changes '1' to 'y'.
684 # This is a problem if the CONFIG is int type.
685 # Check the type in Kconfig and handle it correctly.
686 if new_val[-2:] == '=y':
687 new_val = new_val[:-1] + '1'
689 return (ACTION_NO_CHANGE if old_val == new_val else ACTION_MOVE,
692 def update_dotconfig(self):
693 """Parse files for the config options and update the .config.
695 This function parses the generated .config and include/autoconf.mk
696 searching the target options.
697 Move the config option(s) to the .config as needed.
700 defconfig: defconfig name.
703 Return a tuple of (updated flag, log string).
704 The "updated flag" is True if the .config was updated, False
705 otherwise. The "log string" shows what happend to the .config.
711 with open(self.dotconfig) as f:
712 dotconfig_lines = f.readlines()
714 with open(self.autoconf) as f:
715 autoconf_lines = f.readlines()
717 for config in self.configs:
718 result = self.parse_one_config(config, dotconfig_lines,
720 results.append(result)
724 for (action, value) in results:
725 if action == ACTION_MOVE:
726 actlog = "Move '%s'" % value
727 log_color = COLOR_LIGHT_GREEN
728 elif action == ACTION_NO_ENTRY:
729 actlog = "%s is not defined in Kconfig. Do nothing." % value
730 log_color = COLOR_LIGHT_BLUE
731 elif action == ACTION_NO_CHANGE:
732 actlog = "'%s' is the same as the define in Kconfig. Do nothing." \
734 log_color = COLOR_LIGHT_PURPLE
736 sys.exit("Internal Error. This should not happen.")
738 log += color_text(self.options.color, log_color, actlog) + '\n'
740 with open(self.dotconfig, 'a') as f:
741 for (action, value) in results:
742 if action == ACTION_MOVE:
743 f.write(value + '\n')
746 self.results = results
747 os.remove(self.config_autoconf)
748 os.remove(self.autoconf)
750 return (updated, log)
752 def check_defconfig(self):
753 """Check the defconfig after savedefconfig
756 Return additional log if moved CONFIGs were removed again by
757 'make savedefconfig'.
762 with open(self.defconfig) as f:
763 defconfig_lines = f.readlines()
765 for (action, value) in self.results:
766 if action != ACTION_MOVE:
768 if not value + '\n' in defconfig_lines:
769 log += color_text(self.options.color, COLOR_YELLOW,
770 "'%s' was removed by savedefconfig.\n" %
777 """A slot to store a subprocess.
779 Each instance of this class handles one subprocess.
780 This class is useful to control multiple threads
781 for faster processing.
784 def __init__(self, configs, options, progress, devnull, make_cmd, reference_src_dir):
785 """Create a new process slot.
788 configs: A list of CONFIGs to move.
789 options: option flags.
790 progress: A progress indicator.
791 devnull: A file object of '/dev/null'.
792 make_cmd: command name of GNU Make.
793 reference_src_dir: Determine the true starting config state from this
796 self.options = options
797 self.progress = progress
798 self.build_dir = tempfile.mkdtemp()
799 self.devnull = devnull
800 self.make_cmd = (make_cmd, 'O=' + self.build_dir)
801 self.reference_src_dir = reference_src_dir
802 self.parser = KconfigParser(configs, options, self.build_dir)
803 self.state = STATE_IDLE
804 self.failed_boards = []
805 self.suspicious_boards = []
808 """Delete the working directory
810 This function makes sure the temporary directory is cleaned away
811 even if Python suddenly dies due to error. It should be done in here
812 because it is guaranteed the destructor is always invoked when the
813 instance of the class gets unreferenced.
815 If the subprocess is still running, wait until it finishes.
817 if self.state != STATE_IDLE:
818 while self.ps.poll() == None:
820 shutil.rmtree(self.build_dir)
822 def add(self, defconfig):
823 """Assign a new subprocess for defconfig and add it to the slot.
825 If the slot is vacant, create a new subprocess for processing the
826 given defconfig and add it to the slot. Just returns False if
827 the slot is occupied (i.e. the current subprocess is still running).
830 defconfig: defconfig name.
833 Return True on success or False on failure
835 if self.state != STATE_IDLE:
838 self.defconfig = defconfig
840 self.current_src_dir = self.reference_src_dir
845 """Check the status of the subprocess and handle it as needed.
847 Returns True if the slot is vacant (i.e. in idle state).
848 If the configuration is successfully finished, assign a new
849 subprocess to build include/autoconf.mk.
850 If include/autoconf.mk is generated, invoke the parser to
851 parse the .config and the include/autoconf.mk, moving
852 config options to the .config as needed.
853 If the .config was updated, run "make savedefconfig" to sync
854 it, update the original defconfig, and then set the slot back
858 Return True if the subprocess is terminated, False otherwise
860 if self.state == STATE_IDLE:
863 if self.ps.poll() == None:
866 if self.ps.poll() != 0:
868 elif self.state == STATE_DEFCONFIG:
869 if self.reference_src_dir and not self.current_src_dir:
870 self.do_savedefconfig()
873 elif self.state == STATE_AUTOCONF:
874 if self.current_src_dir:
875 self.current_src_dir = None
878 self.do_savedefconfig()
879 elif self.state == STATE_SAVEDEFCONFIG:
880 self.update_defconfig()
882 sys.exit("Internal Error. This should not happen.")
884 return True if self.state == STATE_IDLE else False
886 def handle_error(self):
887 """Handle error cases."""
889 self.log += color_text(self.options.color, COLOR_LIGHT_RED,
890 "Failed to process.\n")
891 if self.options.verbose:
892 self.log += color_text(self.options.color, COLOR_LIGHT_CYAN,
893 self.ps.stderr.read())
896 def do_defconfig(self):
897 """Run 'make <board>_defconfig' to create the .config file."""
899 cmd = list(self.make_cmd)
900 cmd.append(self.defconfig)
901 self.ps = subprocess.Popen(cmd, stdout=self.devnull,
902 stderr=subprocess.PIPE,
903 cwd=self.current_src_dir)
904 self.state = STATE_DEFCONFIG
906 def do_autoconf(self):
907 """Run 'make include/config/auto.conf'."""
909 self.cross_compile = self.parser.get_cross_compile()
910 if self.cross_compile is None:
911 self.log += color_text(self.options.color, COLOR_YELLOW,
912 "Compiler is missing. Do nothing.\n")
916 cmd = list(self.make_cmd)
917 if self.cross_compile:
918 cmd.append('CROSS_COMPILE=%s' % self.cross_compile)
919 cmd.append('KCONFIG_IGNORE_DUPLICATES=1')
920 cmd.append('include/config/auto.conf')
921 self.ps = subprocess.Popen(cmd, stdout=self.devnull,
922 stderr=subprocess.PIPE,
923 cwd=self.current_src_dir)
924 self.state = STATE_AUTOCONF
926 def do_savedefconfig(self):
927 """Update the .config and run 'make savedefconfig'."""
929 (updated, log) = self.parser.update_dotconfig()
932 if not self.options.force_sync and not updated:
936 self.log += color_text(self.options.color, COLOR_LIGHT_GREEN,
937 "Syncing by savedefconfig...\n")
939 self.log += "Syncing by savedefconfig (forced by option)...\n"
941 cmd = list(self.make_cmd)
942 cmd.append('savedefconfig')
943 self.ps = subprocess.Popen(cmd, stdout=self.devnull,
944 stderr=subprocess.PIPE)
945 self.state = STATE_SAVEDEFCONFIG
947 def update_defconfig(self):
948 """Update the input defconfig and go back to the idle state."""
950 log = self.parser.check_defconfig()
952 self.suspicious_boards.append(self.defconfig)
954 orig_defconfig = os.path.join('configs', self.defconfig)
955 new_defconfig = os.path.join(self.build_dir, 'defconfig')
956 updated = not filecmp.cmp(orig_defconfig, new_defconfig)
959 self.log += color_text(self.options.color, COLOR_LIGHT_BLUE,
960 "defconfig was updated.\n")
962 if not self.options.dry_run and updated:
963 shutil.move(new_defconfig, orig_defconfig)
966 def finish(self, success):
967 """Display log along with progress and go to the idle state.
970 success: Should be True when the defconfig was processed
971 successfully, or False when it fails.
973 # output at least 30 characters to hide the "* defconfigs out of *".
974 log = self.defconfig.ljust(30) + '\n'
976 log += '\n'.join([ ' ' + s for s in self.log.split('\n') ])
977 # Some threads are running in parallel.
978 # Print log atomically to not mix up logs from different threads.
979 print >> (sys.stdout if success else sys.stderr), log
982 if self.options.exit_on_error:
983 sys.exit("Exit on error.")
984 # If --exit-on-error flag is not set, skip this board and continue.
985 # Record the failed board.
986 self.failed_boards.append(self.defconfig)
990 self.state = STATE_IDLE
992 def get_failed_boards(self):
993 """Returns a list of failed boards (defconfigs) in this slot.
995 return self.failed_boards
997 def get_suspicious_boards(self):
998 """Returns a list of boards (defconfigs) with possible misconversion.
1000 return self.suspicious_boards
1004 """Controller of the array of subprocess slots."""
1006 def __init__(self, configs, options, progress, reference_src_dir):
1007 """Create a new slots controller.
1010 configs: A list of CONFIGs to move.
1011 options: option flags.
1012 progress: A progress indicator.
1013 reference_src_dir: Determine the true starting config state from this
1016 self.options = options
1018 devnull = get_devnull()
1019 make_cmd = get_make_cmd()
1020 for i in range(options.jobs):
1021 self.slots.append(Slot(configs, options, progress, devnull,
1022 make_cmd, reference_src_dir))
1024 def add(self, defconfig):
1025 """Add a new subprocess if a vacant slot is found.
1028 defconfig: defconfig name to be put into.
1031 Return True on success or False on failure
1033 for slot in self.slots:
1034 if slot.add(defconfig):
1038 def available(self):
1039 """Check if there is a vacant slot.
1042 Return True if at lease one vacant slot is found, False otherwise.
1044 for slot in self.slots:
1050 """Check if all slots are vacant.
1053 Return True if all the slots are vacant, False otherwise.
1056 for slot in self.slots:
1061 def show_failed_boards(self):
1062 """Display all of the failed boards (defconfigs)."""
1064 output_file = 'moveconfig.failed'
1066 for slot in self.slots:
1067 boards += slot.get_failed_boards()
1070 boards = '\n'.join(boards) + '\n'
1071 msg = "The following boards were not processed due to error:\n"
1073 msg += "(the list has been saved in %s)\n" % output_file
1074 print >> sys.stderr, color_text(self.options.color, COLOR_LIGHT_RED,
1077 with open(output_file, 'w') as f:
1080 def show_suspicious_boards(self):
1081 """Display all boards (defconfigs) with possible misconversion."""
1083 output_file = 'moveconfig.suspicious'
1085 for slot in self.slots:
1086 boards += slot.get_suspicious_boards()
1089 boards = '\n'.join(boards) + '\n'
1090 msg = "The following boards might have been converted incorrectly.\n"
1091 msg += "It is highly recommended to check them manually:\n"
1093 msg += "(the list has been saved in %s)\n" % output_file
1094 print >> sys.stderr, color_text(self.options.color, COLOR_YELLOW,
1097 with open(output_file, 'w') as f:
1100 class ReferenceSource:
1102 """Reference source against which original configs should be parsed."""
1104 def __init__(self, commit):
1105 """Create a reference source directory based on a specified commit.
1108 commit: commit to git-clone
1110 self.src_dir = tempfile.mkdtemp()
1111 print "Cloning git repo to a separate work directory..."
1112 subprocess.check_output(['git', 'clone', os.getcwd(), '.'],
1114 print "Checkout '%s' to build the original autoconf.mk." % \
1115 subprocess.check_output(['git', 'rev-parse', '--short', commit]).strip()
1116 subprocess.check_output(['git', 'checkout', commit],
1117 stderr=subprocess.STDOUT, cwd=self.src_dir)
1120 """Delete the reference source directory
1122 This function makes sure the temporary directory is cleaned away
1123 even if Python suddenly dies due to error. It should be done in here
1124 because it is guaranteed the destructor is always invoked when the
1125 instance of the class gets unreferenced.
1127 shutil.rmtree(self.src_dir)
1130 """Return the absolute path to the reference source directory."""
1134 def move_config(configs, options):
1135 """Move config options to defconfig files.
1138 configs: A list of CONFIGs to move.
1139 options: option flags
1141 if len(configs) == 0:
1142 if options.force_sync:
1143 print 'No CONFIG is specified. You are probably syncing defconfigs.',
1145 print 'Neither CONFIG nor --force-sync is specified. Nothing will happen.',
1147 print 'Move ' + ', '.join(configs),
1148 print '(jobs: %d)\n' % options.jobs
1151 reference_src = ReferenceSource(options.git_ref)
1152 reference_src_dir = reference_src.get_dir()
1154 reference_src_dir = None
1156 if options.defconfigs:
1157 defconfigs = [line.strip() for line in open(options.defconfigs)]
1158 for i, defconfig in enumerate(defconfigs):
1159 if not defconfig.endswith('_defconfig'):
1160 defconfigs[i] = defconfig + '_defconfig'
1161 if not os.path.exists(os.path.join('configs', defconfigs[i])):
1162 sys.exit('%s - defconfig does not exist. Stopping.' %
1165 defconfigs = get_all_defconfigs()
1167 progress = Progress(len(defconfigs))
1168 slots = Slots(configs, options, progress, reference_src_dir)
1170 # Main loop to process defconfig files:
1171 # Add a new subprocess into a vacant slot.
1172 # Sleep if there is no available slot.
1173 for defconfig in defconfigs:
1174 while not slots.add(defconfig):
1175 while not slots.available():
1176 # No available slot: sleep for a while
1177 time.sleep(SLEEP_TIME)
1179 # wait until all the subprocesses finish
1180 while not slots.empty():
1181 time.sleep(SLEEP_TIME)
1184 slots.show_failed_boards()
1185 slots.show_suspicious_boards()
1189 cpu_count = multiprocessing.cpu_count()
1190 except NotImplementedError:
1193 parser = optparse.OptionParser()
1195 parser.add_option('-c', '--color', action='store_true', default=False,
1196 help='display the log in color')
1197 parser.add_option('-d', '--defconfigs', type='string',
1198 help='a file containing a list of defconfigs to move')
1199 parser.add_option('-n', '--dry-run', action='store_true', default=False,
1200 help='perform a trial run (show log with no changes)')
1201 parser.add_option('-e', '--exit-on-error', action='store_true',
1203 help='exit immediately on any error')
1204 parser.add_option('-s', '--force-sync', action='store_true', default=False,
1205 help='force sync by savedefconfig')
1206 parser.add_option('-H', '--headers-only', dest='cleanup_headers_only',
1207 action='store_true', default=False,
1208 help='only cleanup the headers')
1209 parser.add_option('-j', '--jobs', type='int', default=cpu_count,
1210 help='the number of jobs to run simultaneously')
1211 parser.add_option('-r', '--git-ref', type='string',
1212 help='the git ref to clone for building the autoconf.mk')
1213 parser.add_option('-v', '--verbose', action='store_true', default=False,
1214 help='show any build errors as boards are built')
1215 parser.usage += ' CONFIG ...'
1217 (options, configs) = parser.parse_args()
1219 if len(configs) == 0 and not options.force_sync:
1220 parser.print_usage()
1223 # prefix the option name with CONFIG_ if missing
1224 configs = [ config if config.startswith('CONFIG_') else 'CONFIG_' + config
1225 for config in configs ]
1227 check_top_directory()
1229 if not options.cleanup_headers_only:
1230 check_clean_directory()
1231 update_cross_compile(options.color)
1232 move_config(configs, options)
1235 cleanup_headers(configs, options)
1236 cleanup_extra_options(configs, options)
1238 if __name__ == '__main__':