lib_mk.py 12 KB

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