devtool 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. #!/usr/bin/env python3
  2. # OpenEmbedded Development tool
  3. #
  4. # Copyright (C) 2014-2015 Intel Corporation
  5. #
  6. # SPDX-License-Identifier: GPL-2.0-only
  7. #
  8. import sys
  9. import os
  10. import argparse
  11. import glob
  12. import re
  13. import configparser
  14. import subprocess
  15. import logging
  16. basepath = ''
  17. workspace = {}
  18. config = None
  19. context = None
  20. scripts_path = os.path.dirname(os.path.realpath(__file__))
  21. lib_path = scripts_path + '/lib'
  22. sys.path = sys.path + [lib_path]
  23. from devtool import DevtoolError, setup_tinfoil
  24. import scriptutils
  25. import argparse_oe
  26. logger = scriptutils.logger_create('devtool')
  27. plugins = []
  28. class ConfigHandler(object):
  29. config_file = ''
  30. config_obj = None
  31. init_path = ''
  32. workspace_path = ''
  33. def __init__(self, filename):
  34. self.config_file = filename
  35. self.config_obj = configparser.ConfigParser()
  36. def get(self, section, option, default=None):
  37. try:
  38. ret = self.config_obj.get(section, option)
  39. except (configparser.NoOptionError, configparser.NoSectionError):
  40. if default != None:
  41. ret = default
  42. else:
  43. raise
  44. return ret
  45. def read(self):
  46. if os.path.exists(self.config_file):
  47. self.config_obj.read(self.config_file)
  48. if self.config_obj.has_option('General', 'init_path'):
  49. pth = self.get('General', 'init_path')
  50. self.init_path = os.path.join(basepath, pth)
  51. if not os.path.exists(self.init_path):
  52. logger.error('init_path %s specified in config file cannot be found' % pth)
  53. return False
  54. else:
  55. self.config_obj.add_section('General')
  56. self.workspace_path = self.get('General', 'workspace_path', os.path.join(basepath, 'workspace'))
  57. return True
  58. def write(self):
  59. logger.debug('writing to config file %s' % self.config_file)
  60. self.config_obj.set('General', 'workspace_path', self.workspace_path)
  61. with open(self.config_file, 'w') as f:
  62. self.config_obj.write(f)
  63. def set(self, section, option, value):
  64. if not self.config_obj.has_section(section):
  65. self.config_obj.add_section(section)
  66. self.config_obj.set(section, option, value)
  67. class Context:
  68. def __init__(self, **kwargs):
  69. self.__dict__.update(kwargs)
  70. def read_workspace():
  71. global workspace
  72. workspace = {}
  73. if not os.path.exists(os.path.join(config.workspace_path, 'conf', 'layer.conf')):
  74. if context.fixed_setup:
  75. logger.error("workspace layer not set up")
  76. sys.exit(1)
  77. else:
  78. logger.info('Creating workspace layer in %s' % config.workspace_path)
  79. _create_workspace(config.workspace_path, config, basepath)
  80. if not context.fixed_setup:
  81. _enable_workspace_layer(config.workspace_path, config, basepath)
  82. logger.debug('Reading workspace in %s' % config.workspace_path)
  83. externalsrc_re = re.compile(r'^EXTERNALSRC(_pn-([^ =]+))? *= *"([^"]*)"$')
  84. for fn in glob.glob(os.path.join(config.workspace_path, 'appends', '*.bbappend')):
  85. with open(fn, 'r') as f:
  86. pnvalues = {}
  87. for line in f:
  88. res = externalsrc_re.match(line.rstrip())
  89. if res:
  90. recipepn = os.path.splitext(os.path.basename(fn))[0].split('_')[0]
  91. pn = res.group(2) or recipepn
  92. # Find the recipe file within the workspace, if any
  93. bbfile = os.path.basename(fn).replace('.bbappend', '.bb').replace('%', '*')
  94. recipefile = glob.glob(os.path.join(config.workspace_path,
  95. 'recipes',
  96. recipepn,
  97. bbfile))
  98. if recipefile:
  99. recipefile = recipefile[0]
  100. pnvalues['srctree'] = res.group(3)
  101. pnvalues['bbappend'] = fn
  102. pnvalues['recipefile'] = recipefile
  103. elif line.startswith('# srctreebase: '):
  104. pnvalues['srctreebase'] = line.split(':', 1)[1].strip()
  105. if pnvalues:
  106. if not pnvalues.get('srctreebase', None):
  107. pnvalues['srctreebase'] = pnvalues['srctree']
  108. logger.debug('Found recipe %s' % pnvalues)
  109. workspace[pn] = pnvalues
  110. def create_workspace(args, config, basepath, workspace):
  111. if args.layerpath:
  112. workspacedir = os.path.abspath(args.layerpath)
  113. else:
  114. workspacedir = os.path.abspath(os.path.join(basepath, 'workspace'))
  115. _create_workspace(workspacedir, config, basepath)
  116. if not args.create_only:
  117. _enable_workspace_layer(workspacedir, config, basepath)
  118. def _create_workspace(workspacedir, config, basepath):
  119. import bb
  120. confdir = os.path.join(workspacedir, 'conf')
  121. if os.path.exists(os.path.join(confdir, 'layer.conf')):
  122. logger.info('Specified workspace already set up, leaving as-is')
  123. else:
  124. # Add a config file
  125. bb.utils.mkdirhier(confdir)
  126. with open(os.path.join(confdir, 'layer.conf'), 'w') as f:
  127. f.write('# ### workspace layer auto-generated by devtool ###\n')
  128. f.write('BBPATH =. "$' + '{LAYERDIR}:"\n')
  129. f.write('BBFILES += "$' + '{LAYERDIR}/recipes/*/*.bb \\\n')
  130. f.write(' $' + '{LAYERDIR}/appends/*.bbappend"\n')
  131. f.write('BBFILE_COLLECTIONS += "workspacelayer"\n')
  132. f.write('BBFILE_PATTERN_workspacelayer = "^$' + '{LAYERDIR}/"\n')
  133. f.write('BBFILE_PATTERN_IGNORE_EMPTY_workspacelayer = "1"\n')
  134. f.write('BBFILE_PRIORITY_workspacelayer = "99"\n')
  135. f.write('LAYERSERIES_COMPAT_workspacelayer = "${LAYERSERIES_COMPAT_core}"\n')
  136. # Add a README file
  137. with open(os.path.join(workspacedir, 'README'), 'w') as f:
  138. f.write('This layer was created by the OpenEmbedded devtool utility in order to\n')
  139. f.write('contain recipes and bbappends that are currently being worked on. The idea\n')
  140. f.write('is that the contents is temporary - once you have finished working on a\n')
  141. f.write('recipe you use the appropriate method to move the files you have been\n')
  142. f.write('working on to a proper layer. In most instances you should use the\n')
  143. f.write('devtool utility to manage files within it rather than modifying files\n')
  144. f.write('directly (although recipes added with "devtool add" will often need\n')
  145. f.write('direct modification.)\n')
  146. f.write('\nIf you no longer need to use devtool or the workspace layer\'s contents\n')
  147. f.write('you can remove the path to this workspace layer from your conf/bblayers.conf\n')
  148. f.write('file (and then delete the layer, if you wish).\n')
  149. f.write('\nNote that by default, if devtool fetches and unpacks source code, it\n')
  150. f.write('will place it in a subdirectory of a "sources" subdirectory of the\n')
  151. f.write('layer. If you prefer it to be elsewhere you can specify the source\n')
  152. f.write('tree path on the command line.\n')
  153. def _enable_workspace_layer(workspacedir, config, basepath):
  154. """Ensure the workspace layer is in bblayers.conf"""
  155. import bb
  156. bblayers_conf = os.path.join(basepath, 'conf', 'bblayers.conf')
  157. if not os.path.exists(bblayers_conf):
  158. logger.error('Unable to find bblayers.conf')
  159. return
  160. if os.path.abspath(workspacedir) != os.path.abspath(config.workspace_path):
  161. removedir = config.workspace_path
  162. else:
  163. removedir = None
  164. _, added = bb.utils.edit_bblayers_conf(bblayers_conf, workspacedir, removedir)
  165. if added:
  166. logger.info('Enabling workspace layer in bblayers.conf')
  167. if config.workspace_path != workspacedir:
  168. # Update our config to point to the new location
  169. config.workspace_path = workspacedir
  170. config.write()
  171. def main():
  172. global basepath
  173. global config
  174. global context
  175. if sys.getfilesystemencoding() != "utf-8":
  176. sys.exit("Please use a locale setting which supports utf-8.\nPython can't change the filesystem locale after loading so we need a utf-8 when python starts or things won't work.")
  177. context = Context(fixed_setup=False)
  178. # Default basepath
  179. basepath = os.path.dirname(os.path.abspath(__file__))
  180. parser = argparse_oe.ArgumentParser(description="OpenEmbedded development tool",
  181. add_help=False,
  182. epilog="Use %(prog)s <subcommand> --help to get help on a specific command")
  183. parser.add_argument('--basepath', help='Base directory of SDK / build directory')
  184. parser.add_argument('--bbpath', help='Explicitly specify the BBPATH, rather than getting it from the metadata')
  185. parser.add_argument('-d', '--debug', help='Enable debug output', action='store_true')
  186. parser.add_argument('-q', '--quiet', help='Print only errors', action='store_true')
  187. parser.add_argument('--color', choices=['auto', 'always', 'never'], default='auto', help='Colorize output (where %(metavar)s is %(choices)s)', metavar='COLOR')
  188. global_args, unparsed_args = parser.parse_known_args()
  189. # Help is added here rather than via add_help=True, as we don't want it to
  190. # be handled by parse_known_args()
  191. parser.add_argument('-h', '--help', action='help', default=argparse.SUPPRESS,
  192. help='show this help message and exit')
  193. if global_args.debug:
  194. logger.setLevel(logging.DEBUG)
  195. elif global_args.quiet:
  196. logger.setLevel(logging.ERROR)
  197. if global_args.basepath:
  198. # Override
  199. basepath = global_args.basepath
  200. if os.path.exists(os.path.join(basepath, '.devtoolbase')):
  201. context.fixed_setup = True
  202. else:
  203. pth = basepath
  204. while pth != '' and pth != os.sep:
  205. if os.path.exists(os.path.join(pth, '.devtoolbase')):
  206. context.fixed_setup = True
  207. basepath = pth
  208. break
  209. pth = os.path.dirname(pth)
  210. if not context.fixed_setup:
  211. basepath = os.environ.get('BUILDDIR')
  212. if not basepath:
  213. logger.error("This script can only be run after initialising the build environment (e.g. by using oe-init-build-env)")
  214. sys.exit(1)
  215. logger.debug('Using basepath %s' % basepath)
  216. config = ConfigHandler(os.path.join(basepath, 'conf', 'devtool.conf'))
  217. if not config.read():
  218. return -1
  219. context.config = config
  220. bitbake_subdir = config.get('General', 'bitbake_subdir', '')
  221. if bitbake_subdir:
  222. # Normally set for use within the SDK
  223. logger.debug('Using bitbake subdir %s' % bitbake_subdir)
  224. sys.path.insert(0, os.path.join(basepath, bitbake_subdir, 'lib'))
  225. core_meta_subdir = config.get('General', 'core_meta_subdir')
  226. sys.path.insert(0, os.path.join(basepath, core_meta_subdir, 'lib'))
  227. else:
  228. # Standard location
  229. import scriptpath
  230. bitbakepath = scriptpath.add_bitbake_lib_path()
  231. if not bitbakepath:
  232. logger.error("Unable to find bitbake by searching parent directory of this script or PATH")
  233. sys.exit(1)
  234. logger.debug('Using standard bitbake path %s' % bitbakepath)
  235. scriptpath.add_oe_lib_path()
  236. scriptutils.logger_setup_color(logger, global_args.color)
  237. if global_args.bbpath is None:
  238. try:
  239. tinfoil = setup_tinfoil(config_only=True, basepath=basepath)
  240. try:
  241. global_args.bbpath = tinfoil.config_data.getVar('BBPATH')
  242. finally:
  243. tinfoil.shutdown()
  244. except bb.BBHandledException:
  245. return 2
  246. # Search BBPATH first to allow layers to override plugins in scripts_path
  247. for path in global_args.bbpath.split(':') + [scripts_path]:
  248. pluginpath = os.path.join(path, 'lib', 'devtool')
  249. scriptutils.load_plugins(logger, plugins, pluginpath)
  250. subparsers = parser.add_subparsers(dest="subparser_name", title='subcommands', metavar='<subcommand>')
  251. subparsers.required = True
  252. subparsers.add_subparser_group('sdk', 'SDK maintenance', -2)
  253. subparsers.add_subparser_group('advanced', 'Advanced', -1)
  254. subparsers.add_subparser_group('starting', 'Beginning work on a recipe', 100)
  255. subparsers.add_subparser_group('info', 'Getting information')
  256. subparsers.add_subparser_group('working', 'Working on a recipe in the workspace')
  257. subparsers.add_subparser_group('testbuild', 'Testing changes on target')
  258. if not context.fixed_setup:
  259. parser_create_workspace = subparsers.add_parser('create-workspace',
  260. help='Set up workspace in an alternative location',
  261. description='Sets up a new workspace. NOTE: other devtool subcommands will create a workspace automatically as needed, so you only need to use %(prog)s if you want to specify where the workspace should be located.',
  262. group='advanced')
  263. parser_create_workspace.add_argument('layerpath', nargs='?', help='Path in which the workspace layer should be created')
  264. parser_create_workspace.add_argument('--create-only', action="store_true", help='Only create the workspace layer, do not alter configuration')
  265. parser_create_workspace.set_defaults(func=create_workspace, no_workspace=True)
  266. for plugin in plugins:
  267. if hasattr(plugin, 'register_commands'):
  268. plugin.register_commands(subparsers, context)
  269. args = parser.parse_args(unparsed_args, namespace=global_args)
  270. if not getattr(args, 'no_workspace', False):
  271. read_workspace()
  272. try:
  273. ret = args.func(args, config, basepath, workspace)
  274. except DevtoolError as err:
  275. if str(err):
  276. logger.error(str(err))
  277. ret = err.exitcode
  278. except argparse_oe.ArgumentUsageError as ae:
  279. parser.error_subcommand(ae.message, ae.subcommand)
  280. return ret
  281. if __name__ == "__main__":
  282. try:
  283. ret = main()
  284. except Exception:
  285. ret = 1
  286. import traceback
  287. traceback.print_exc()
  288. sys.exit(ret)