lib_mk.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331
  1. # See utils/checkpackagelib/readme.txt before editing this file.
  2. # There are already dependency checks during the build, so below check
  3. # functions don't need to check for things already checked by exploring the
  4. # menu options using "make menuconfig" and by running "make" with appropriate
  5. # packages enabled.
  6. import os
  7. import re
  8. from checkpackagelib.base import _CheckFunction
  9. from checkpackagelib.lib import ConsecutiveEmptyLines # noqa: F401
  10. from checkpackagelib.lib import EmptyLastLine # noqa: F401
  11. from checkpackagelib.lib import NewlineAtEof # noqa: F401
  12. from checkpackagelib.lib import TrailingSpace # noqa: F401
  13. from checkpackagelib.lib import Utf8Characters # noqa: F401
  14. # used in more than one check
  15. start_conditional = ["ifdef", "ifeq", "ifndef", "ifneq"]
  16. continue_conditional = ["elif", "else"]
  17. end_conditional = ["endif"]
  18. class Indent(_CheckFunction):
  19. COMMENT = re.compile(r"^\s*#")
  20. CONDITIONAL = re.compile(r"^\s*({})\s".format("|".join(start_conditional + end_conditional + continue_conditional)))
  21. ENDS_WITH_BACKSLASH = re.compile(r"^[^#].*\\$")
  22. END_DEFINE = re.compile(r"^\s*endef\s")
  23. MAKEFILE_TARGET = re.compile(r"^[^# \t]+:\s")
  24. START_DEFINE = re.compile(r"^\s*define\s")
  25. def before(self):
  26. self.define = False
  27. self.backslash = False
  28. self.makefile_target = False
  29. def check_line(self, lineno, text):
  30. if self.START_DEFINE.search(text):
  31. self.define = True
  32. return
  33. if self.END_DEFINE.search(text):
  34. self.define = False
  35. return
  36. expect_tabs = False
  37. if self.define or self.backslash or self.makefile_target:
  38. expect_tabs = True
  39. if not self.backslash and self.CONDITIONAL.search(text):
  40. expect_tabs = False
  41. # calculate for next line
  42. if self.ENDS_WITH_BACKSLASH.search(text):
  43. self.backslash = True
  44. else:
  45. self.backslash = False
  46. if self.MAKEFILE_TARGET.search(text):
  47. self.makefile_target = True
  48. return
  49. if text.strip() == "":
  50. self.makefile_target = False
  51. return
  52. # comment can be indented or not inside define ... endef, so ignore it
  53. if self.define and self.COMMENT.search(text):
  54. return
  55. if expect_tabs:
  56. if not text.startswith("\t"):
  57. return ["{}:{}: expected indent with tabs"
  58. .format(self.filename, lineno),
  59. text]
  60. else:
  61. if text.startswith("\t"):
  62. return ["{}:{}: unexpected indent with tabs"
  63. .format(self.filename, lineno),
  64. text]
  65. class OverriddenVariable(_CheckFunction):
  66. CONCATENATING = re.compile(r"^([A-Z0-9_]+)\s*(\+|:|)=\s*\$\(\\1\)")
  67. END_CONDITIONAL = re.compile(r"^\s*({})".format("|".join(end_conditional)))
  68. OVERRIDING_ASSIGNMENTS = [':=', "="]
  69. START_CONDITIONAL = re.compile(r"^\s*({})".format("|".join(start_conditional)))
  70. VARIABLE = re.compile(r"^([A-Z0-9_]+)\s*((\+|:|)=)")
  71. USUALLY_OVERRIDDEN = re.compile(r"^[A-Z0-9_]+({})".format("|".join([
  72. r"_ARCH\s*=\s*",
  73. r"_CPU\s*=\s*",
  74. r"_SITE\s*=\s*",
  75. r"_SOURCE\s*=\s*",
  76. r"_VERSION\s*=\s*"])))
  77. def before(self):
  78. self.conditional = 0
  79. self.unconditionally_set = []
  80. self.conditionally_set = []
  81. def check_line(self, lineno, text):
  82. if self.START_CONDITIONAL.search(text):
  83. self.conditional += 1
  84. return
  85. if self.END_CONDITIONAL.search(text):
  86. self.conditional -= 1
  87. return
  88. m = self.VARIABLE.search(text)
  89. if m is None:
  90. return
  91. variable, assignment = m.group(1, 2)
  92. if self.conditional == 0:
  93. if variable in self.conditionally_set:
  94. self.unconditionally_set.append(variable)
  95. if assignment in self.OVERRIDING_ASSIGNMENTS:
  96. return ["{}:{}: unconditional override of variable {} previously conditionally set"
  97. .format(self.filename, lineno, variable),
  98. text]
  99. if variable not in self.unconditionally_set:
  100. self.unconditionally_set.append(variable)
  101. return
  102. if assignment in self.OVERRIDING_ASSIGNMENTS:
  103. return ["{}:{}: unconditional override of variable {}"
  104. .format(self.filename, lineno, variable),
  105. text]
  106. else:
  107. if variable not in self.unconditionally_set:
  108. self.conditionally_set.append(variable)
  109. return
  110. if self.CONCATENATING.search(text):
  111. return ["{}:{}: immediate assignment to append to variable {}"
  112. .format(self.filename, lineno, variable),
  113. text]
  114. if self.USUALLY_OVERRIDDEN.search(text):
  115. return
  116. if assignment in self.OVERRIDING_ASSIGNMENTS:
  117. return ["{}:{}: conditional override of variable {}"
  118. .format(self.filename, lineno, variable),
  119. text]
  120. class PackageHeader(_CheckFunction):
  121. def before(self):
  122. self.skip = False
  123. def check_line(self, lineno, text):
  124. if self.skip or lineno > 6:
  125. return
  126. if lineno in [1, 5]:
  127. if lineno == 1 and text.startswith("include "):
  128. self.skip = True
  129. return
  130. if text.rstrip() != "#" * 80:
  131. return ["{}:{}: should be 80 hashes ({}#writing-rules-mk)"
  132. .format(self.filename, lineno, self.url_to_manual),
  133. text,
  134. "#" * 80]
  135. elif lineno in [2, 4]:
  136. if text.rstrip() != "#":
  137. return ["{}:{}: should be 1 hash ({}#writing-rules-mk)"
  138. .format(self.filename, lineno, self.url_to_manual),
  139. text]
  140. elif lineno == 6:
  141. if text.rstrip() != "":
  142. return ["{}:{}: should be a blank line ({}#writing-rules-mk)"
  143. .format(self.filename, lineno, self.url_to_manual),
  144. text]
  145. class RemoveDefaultPackageSourceVariable(_CheckFunction):
  146. packages_that_may_contain_default_source = ["binutils", "gcc", "gdb"]
  147. def before(self):
  148. package, _ = os.path.splitext(os.path.basename(self.filename))
  149. package_upper = package.replace("-", "_").upper()
  150. self.package = package
  151. self.FIND_SOURCE = re.compile(
  152. r"^{}_SOURCE\s*=\s*{}-\$\({}_VERSION\)\.tar\.gz"
  153. .format(package_upper, package, package_upper))
  154. def check_line(self, lineno, text):
  155. if self.FIND_SOURCE.search(text):
  156. if self.package in self.packages_that_may_contain_default_source:
  157. return
  158. return ["{}:{}: remove default value of _SOURCE variable "
  159. "({}#generic-package-reference)"
  160. .format(self.filename, lineno, self.url_to_manual),
  161. text]
  162. class SpaceBeforeBackslash(_CheckFunction):
  163. TAB_OR_MULTIPLE_SPACES_BEFORE_BACKSLASH = re.compile(r"^.*( |\t ?)\\$")
  164. def check_line(self, lineno, text):
  165. if self.TAB_OR_MULTIPLE_SPACES_BEFORE_BACKSLASH.match(text.rstrip()):
  166. return ["{}:{}: use only one space before backslash"
  167. .format(self.filename, lineno),
  168. text]
  169. class TrailingBackslash(_CheckFunction):
  170. ENDS_WITH_BACKSLASH = re.compile(r"^[^#].*\\$")
  171. def before(self):
  172. self.backslash = False
  173. def check_line(self, lineno, text):
  174. last_line_ends_in_backslash = self.backslash
  175. # calculate for next line
  176. if self.ENDS_WITH_BACKSLASH.search(text):
  177. self.backslash = True
  178. self.lastline = text
  179. return
  180. self.backslash = False
  181. if last_line_ends_in_backslash and text.strip() == "":
  182. return ["{}:{}: remove trailing backslash"
  183. .format(self.filename, lineno - 1),
  184. self.lastline]
  185. class TypoInPackageVariable(_CheckFunction):
  186. ALLOWED = re.compile(r"|".join([
  187. "ACLOCAL_DIR",
  188. "ACLOCAL_HOST_DIR",
  189. "ACLOCAL_PATH",
  190. "BR_CCACHE_INITIAL_SETUP",
  191. "BR_LIBC",
  192. "BR_NO_CHECK_HASH_FOR",
  193. "LINUX_EXTENSIONS",
  194. "LINUX_POST_PATCH_HOOKS",
  195. "LINUX_TOOLS",
  196. "LUA_RUN",
  197. "MKFS_JFFS2",
  198. "MKIMAGE_ARCH",
  199. "PACKAGES_PERMISSIONS_TABLE",
  200. "PKG_CONFIG_HOST_BINARY",
  201. "SUMTOOL",
  202. "TARGET_FINALIZE_HOOKS",
  203. "TARGETS_ROOTFS",
  204. "XTENSA_CORE_NAME"]))
  205. VARIABLE = re.compile(r"^([A-Z0-9_]+_[A-Z0-9_]+)\s*(\+|)=")
  206. def before(self):
  207. package, _ = os.path.splitext(os.path.basename(self.filename))
  208. package = package.replace("-", "_").upper()
  209. # linux tools do not use LINUX_TOOL_ prefix for variables
  210. package = package.replace("LINUX_TOOL_", "")
  211. # linux extensions do not use LINUX_EXT_ prefix for variables
  212. package = package.replace("LINUX_EXT_", "")
  213. self.package = package
  214. self.REGEX = re.compile(r"^(HOST_|ROOTFS_)?({}_[A-Z0-9_]+)".format(package))
  215. self.FIND_VIRTUAL = re.compile(
  216. r"^{}_PROVIDES\s*(\+|)=\s*(.*)".format(package))
  217. self.virtual = []
  218. def check_line(self, lineno, text):
  219. m = self.VARIABLE.search(text)
  220. if m is None:
  221. return
  222. variable = m.group(1)
  223. # allow to set variables for virtual package this package provides
  224. v = self.FIND_VIRTUAL.search(text)
  225. if v:
  226. self.virtual += v.group(2).upper().split()
  227. return
  228. for virtual in self.virtual:
  229. if variable.startswith("{}_".format(virtual)):
  230. return
  231. if self.ALLOWED.match(variable):
  232. return
  233. if self.REGEX.search(text) is None:
  234. return ["{}:{}: possible typo: {} -> *{}*"
  235. .format(self.filename, lineno, variable, self.package),
  236. text]
  237. class UselessFlag(_CheckFunction):
  238. DEFAULT_AUTOTOOLS_FLAG = re.compile(r"^.*{}".format("|".join([
  239. r"_AUTORECONF\s*=\s*NO",
  240. r"_LIBTOOL_PATCH\s*=\s*YES"])))
  241. DEFAULT_GENERIC_FLAG = re.compile(r"^.*{}".format("|".join([
  242. r"_INSTALL_IMAGES\s*=\s*NO",
  243. r"_INSTALL_REDISTRIBUTE\s*=\s*YES",
  244. r"_INSTALL_STAGING\s*=\s*NO",
  245. r"_INSTALL_TARGET\s*=\s*YES"])))
  246. END_CONDITIONAL = re.compile(r"^\s*({})".format("|".join(end_conditional)))
  247. START_CONDITIONAL = re.compile(r"^\s*({})".format("|".join(start_conditional)))
  248. def before(self):
  249. self.conditional = 0
  250. def check_line(self, lineno, text):
  251. if self.START_CONDITIONAL.search(text):
  252. self.conditional += 1
  253. return
  254. if self.END_CONDITIONAL.search(text):
  255. self.conditional -= 1
  256. return
  257. # allow non-default conditionally overridden by default
  258. if self.conditional > 0:
  259. return
  260. if self.DEFAULT_GENERIC_FLAG.search(text):
  261. return ["{}:{}: useless default value ({}#"
  262. "_infrastructure_for_packages_with_specific_build_systems)"
  263. .format(self.filename, lineno, self.url_to_manual),
  264. text]
  265. if self.DEFAULT_AUTOTOOLS_FLAG.search(text) and not text.lstrip().startswith("HOST_"):
  266. return ["{}:{}: useless default value "
  267. "({}#_infrastructure_for_autotools_based_packages)"
  268. .format(self.filename, lineno, self.url_to_manual),
  269. text]
  270. class VariableWithBraces(_CheckFunction):
  271. VARIABLE_WITH_BRACES = re.compile(r"^[^#].*[^$]\${\w+}")
  272. def check_line(self, lineno, text):
  273. if self.VARIABLE_WITH_BRACES.match(text.rstrip()):
  274. return ["{}:{}: use $() to delimit variables, not ${{}}"
  275. .format(self.filename, lineno),
  276. text]