1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
#!/usr/bin/python2
# Copyright 2015 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Configuration Option Checker.
Script to ensure that all configuration options for the Chrome EC are defined
in config.h.
"""
from __future__ import print_function
import re
import os
import argparse
# Master file which is supposed to include all CONFIG_xxxx descriptions.
CONFIG_FILE = 'include/config.h'
def find_files_to_check(args):
"""Returns a list of files to check."""
file_list = []
if args.all_files:
cwd = os.getcwd()
for (dirpath, dirnames, filenames) in os.walk(cwd, topdown=True):
# Ignore the build and private directories (taken from .gitignore)
if 'build' in dirnames:
dirnames.remove('build')
if 'private' in dirnames:
dirnames.remove('private')
for f in filenames:
# Only consider C source and assembler files.
if f.endswith(('.c', '.h', '.inc', '.S')):
file_list.append(os.path.join(dirpath, f))
else:
# Form list from presubmit environment variable.
file_list = os.environ['PRESUBMIT_FILES'].split()
return file_list
def obtain_current_config_options():
"""Obtains current config options from include/config.h"""
config_options = []
config_option_re = re.compile(r'^#(define|undef)\s+(CONFIG_[A-Z0-9_]+)')
with open(CONFIG_FILE, 'r') as config_file:
for line in config_file:
result = config_option_re.search(line)
if not result:
continue
word = result.groups()[1]
if word not in config_options:
config_options.append(word)
return config_options
def print_missing_config_options(file_list, config_options):
"""Searches through all files in file_list for missing config options.
TODO: make it search only added lines instead.
"""
missing_config_option = False
print_banner = True
# Determine longest CONFIG_* length to be used for formatting.
max_option_length = max(len(option) for option in config_options)
config_option_re = re.compile(r'\s+(CONFIG_[a-zA-Z0-9_]*)\s*')
for f in file_list:
if os.path.realpath(f) == os.path.realpath(CONFIG_FILE):
continue
extension = os.path.splitext(f)[1]
# Do not examine files which are not likely to actually use CONFIG_xxx.
# TODO: this list should be fine tuned.
if not extension in ('.c', '.h', '.mk', '.inc') and not 'Makefile' in f:
continue
with open(f, 'r') as cur_file:
line_num = 0
for line in cur_file:
line_num += 1
if extension == '.mk' and line.startswith('#'):
# Ignore pattern found in comments. TODO: this needs to be way more
# robust: different file extensions require different comment
# encapsulation logic, the comment could be not starting in the
# first column, etc.
continue
match = re.search(config_option_re, line)
if match:
if match.group(1) not in config_options:
missing_config_option = True
# Print the banner once.
if print_banner:
print('The following config options were found to be missing '
'from %s.\n'
'Please add new config options there along with '
'descriptions.\n\n' % CONFIG_FILE)
print_banner = False
# Print the misssing config option.
print('> %-*s %s:%s' % (max_option_length, match.group(1), f,
line_num))
return missing_config_option
def main():
"""Searches through specified source files for missing config options.
Checks through specified C source and assembler file (not in the build/ and
private/ directories) for CONFIG_* options. Then checks to make sure that
all CONFIG_* options are defined in include/config.h. Finally, reports any
missing config options. By default, it will check just the files in the CL.
To check all files in EC code base, run with the flag --all_files.
"""
# Create argument options to specify checking either all the files in the EC
# code base or just the files in the CL.
parser = argparse.ArgumentParser(description='configuration option checker.')
parser.add_argument('--all_files', help='check all files in EC code base',
action='store_true')
args = parser.parse_args()
# Create list of files to search.
file_list = find_files_to_check(args)
# Obtain config options from include/config.h.
config_options = obtain_current_config_options()
# Find any missing config options from file list and print them.
missing_opts = print_missing_config_options(file_list, config_options)
if missing_opts:
print('\nIt may also be possible that you have a typo.')
os.sys.exit(1)
if __name__ == '__main__':
main()
|
