devtool 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. #!/usr/bin/env python
  2. # OpenEmbedded Development tool
  3. #
  4. # Copyright (C) 2014-2015 Intel Corporation
  5. #
  6. # This program is free software; you can redistribute it and/or modify
  7. # it under the terms of the GNU General Public License version 2 as
  8. # published by the Free Software Foundation.
  9. #
  10. # This program is distributed in the hope that it will be useful,
  11. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. # GNU General Public License for more details.
  14. #
  15. # You should have received a copy of the GNU General Public License along
  16. # with this program; if not, write to the Free Software Foundation, Inc.,
  17. # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18. import sys
  19. import os
  20. import argparse
  21. import glob
  22. import re
  23. import ConfigParser
  24. import subprocess
  25. import logging
  26. basepath = ''
  27. workspace = {}
  28. config = None
  29. context = None
  30. scripts_path = os.path.dirname(os.path.realpath(__file__))
  31. lib_path = scripts_path + '/lib'
  32. sys.path = sys.path + [lib_path]
  33. from devtool import DevtoolError, setup_tinfoil
  34. import scriptutils
  35. logger = scriptutils.logger_create('devtool')
  36. plugins = []
  37. class ConfigHandler(object):
  38. config_file = ''
  39. config_obj = None
  40. init_path = ''
  41. workspace_path = ''
  42. def __init__(self, filename):
  43. self.config_file = filename
  44. self.config_obj = ConfigParser.SafeConfigParser()
  45. def get(self, section, option, default=None):
  46. try:
  47. ret = self.config_obj.get(section, option)
  48. except (ConfigParser.NoOptionError, ConfigParser.NoSectionError):
  49. if default != None:
  50. ret = default
  51. else:
  52. raise
  53. return ret
  54. def read(self):
  55. if os.path.exists(self.config_file):
  56. self.config_obj.read(self.config_file)
  57. if self.config_obj.has_option('General', 'init_path'):
  58. pth = self.get('General', 'init_path')
  59. self.init_path = os.path.join(basepath, pth)
  60. if not os.path.exists(self.init_path):
  61. logger.error('init_path %s specified in config file cannot be found' % pth)
  62. return False
  63. else:
  64. self.config_obj.add_section('General')
  65. self.workspace_path = self.get('General', 'workspace_path', os.path.join(basepath, 'workspace'))
  66. return True
  67. def write(self):
  68. logger.debug('writing to config file %s' % self.config_file)
  69. self.config_obj.set('General', 'workspace_path', self.workspace_path)
  70. with open(self.config_file, 'w') as f:
  71. self.config_obj.write(f)
  72. class Context:
  73. def __init__(self, **kwargs):
  74. self.__dict__.update(kwargs)
  75. def read_workspace():
  76. global workspace
  77. workspace = {}
  78. if not os.path.exists(os.path.join(config.workspace_path, 'conf', 'layer.conf')):
  79. if context.fixed_setup:
  80. logger.error("workspace layer not set up")
  81. sys.exit(1)
  82. else:
  83. logger.info('Creating workspace layer in %s' % config.workspace_path)
  84. _create_workspace(config.workspace_path, config, basepath)
  85. if not context.fixed_setup:
  86. _enable_workspace_layer(config.workspace_path, config, basepath)
  87. logger.debug('Reading workspace in %s' % config.workspace_path)
  88. externalsrc_re = re.compile(r'^EXTERNALSRC(_pn-([^ =]+))? *= *"([^"]*)"$')
  89. for fn in glob.glob(os.path.join(config.workspace_path, 'appends', '*.bbappend')):
  90. with open(fn, 'r') as f:
  91. for line in f:
  92. res = externalsrc_re.match(line.rstrip())
  93. if res:
  94. pn = res.group(2) or os.path.splitext(os.path.basename(fn))[0].split('_')[0]
  95. workspace[pn] = {'srctree': res.group(3),
  96. 'bbappend': fn}
  97. def create_workspace(args, config, basepath, workspace):
  98. if args.layerpath:
  99. workspacedir = os.path.abspath(args.layerpath)
  100. else:
  101. workspacedir = os.path.abspath(os.path.join(basepath, 'workspace'))
  102. _create_workspace(workspacedir, config, basepath)
  103. if not args.create_only:
  104. _enable_workspace_layer(workspacedir, config, basepath)
  105. def _create_workspace(workspacedir, config, basepath):
  106. import bb
  107. confdir = os.path.join(workspacedir, 'conf')
  108. if os.path.exists(os.path.join(confdir, 'layer.conf')):
  109. logger.info('Specified workspace already set up, leaving as-is')
  110. else:
  111. # Add a config file
  112. bb.utils.mkdirhier(confdir)
  113. with open(os.path.join(confdir, 'layer.conf'), 'w') as f:
  114. f.write('# ### workspace layer auto-generated by devtool ###\n')
  115. f.write('BBPATH =. "$' + '{LAYERDIR}:"\n')
  116. f.write('BBFILES += "$' + '{LAYERDIR}/recipes/*/*.bb \\\n')
  117. f.write(' $' + '{LAYERDIR}/appends/*.bbappend"\n')
  118. f.write('BBFILE_COLLECTIONS += "workspacelayer"\n')
  119. f.write('BBFILE_PATTERN_workspacelayer = "^$' + '{LAYERDIR}/"\n')
  120. f.write('BBFILE_PATTERN_IGNORE_EMPTY_workspacelayer = "1"\n')
  121. f.write('BBFILE_PRIORITY_workspacelayer = "99"\n')
  122. # Add a README file
  123. with open(os.path.join(workspacedir, 'README'), 'w') as f:
  124. f.write('This layer was created by the OpenEmbedded devtool utility in order to\n')
  125. f.write('contain recipes and bbappends. In most instances you should use the\n')
  126. f.write('devtool utility to manage files within it rather than modifying files\n')
  127. f.write('directly (although recipes added with "devtool add" will often need\n')
  128. f.write('direct modification.)\n')
  129. f.write('\nIf you no longer need to use devtool you can remove the path to this\n')
  130. f.write('workspace layer from your conf/bblayers.conf file (and then delete the\n')
  131. f.write('layer, if you wish).\n')
  132. def _enable_workspace_layer(workspacedir, config, basepath):
  133. """Ensure the workspace layer is in bblayers.conf"""
  134. import bb
  135. bblayers_conf = os.path.join(basepath, 'conf', 'bblayers.conf')
  136. if not os.path.exists(bblayers_conf):
  137. logger.error('Unable to find bblayers.conf')
  138. return
  139. _, added = bb.utils.edit_bblayers_conf(bblayers_conf, workspacedir, config.workspace_path)
  140. if added:
  141. logger.info('Enabling workspace layer in bblayers.conf')
  142. if config.workspace_path != workspacedir:
  143. # Update our config to point to the new location
  144. config.workspace_path = workspacedir
  145. config.write()
  146. def main():
  147. global basepath
  148. global config
  149. global context
  150. context = Context(fixed_setup=False)
  151. # Default basepath
  152. basepath = os.path.dirname(os.path.abspath(__file__))
  153. pth = basepath
  154. while pth != '' and pth != os.sep:
  155. if os.path.exists(os.path.join(pth, '.devtoolbase')):
  156. context.fixed_setup = True
  157. basepath = pth
  158. break
  159. pth = os.path.dirname(pth)
  160. parser = argparse.ArgumentParser(description="OpenEmbedded development tool",
  161. add_help=False,
  162. epilog="Use %(prog)s <subcommand> --help to get help on a specific command")
  163. parser.add_argument('--basepath', help='Base directory of SDK / build directory')
  164. parser.add_argument('--bbpath', help='Explicitly specify the BBPATH, rather than getting it from the metadata')
  165. parser.add_argument('-d', '--debug', help='Enable debug output', action='store_true')
  166. parser.add_argument('-q', '--quiet', help='Print only errors', action='store_true')
  167. parser.add_argument('--color', choices=['auto', 'always', 'never'], default='auto', help='Colorize output (where %(metavar)s is %(choices)s)', metavar='COLOR')
  168. global_args, unparsed_args = parser.parse_known_args()
  169. # Help is added here rather than via add_help=True, as we don't want it to
  170. # be handled by parse_known_args()
  171. parser.add_argument('-h', '--help', action='help', default=argparse.SUPPRESS,
  172. help='show this help message and exit')
  173. if global_args.debug:
  174. logger.setLevel(logging.DEBUG)
  175. elif global_args.quiet:
  176. logger.setLevel(logging.ERROR)
  177. if global_args.basepath:
  178. # Override
  179. basepath = global_args.basepath
  180. elif not context.fixed_setup:
  181. basepath = os.environ.get('BUILDDIR')
  182. if not basepath:
  183. logger.error("This script can only be run after initialising the build environment (e.g. by using oe-init-build-env)")
  184. sys.exit(1)
  185. logger.debug('Using basepath %s' % basepath)
  186. config = ConfigHandler(os.path.join(basepath, 'conf', 'devtool.conf'))
  187. if not config.read():
  188. return -1
  189. bitbake_subdir = config.get('General', 'bitbake_subdir', '')
  190. if bitbake_subdir:
  191. # Normally set for use within the SDK
  192. logger.debug('Using bitbake subdir %s' % bitbake_subdir)
  193. sys.path.insert(0, os.path.join(basepath, bitbake_subdir, 'lib'))
  194. core_meta_subdir = config.get('General', 'core_meta_subdir')
  195. sys.path.insert(0, os.path.join(basepath, core_meta_subdir, 'lib'))
  196. else:
  197. # Standard location
  198. import scriptpath
  199. bitbakepath = scriptpath.add_bitbake_lib_path()
  200. if not bitbakepath:
  201. logger.error("Unable to find bitbake by searching parent directory of this script or PATH")
  202. sys.exit(1)
  203. logger.debug('Using standard bitbake path %s' % bitbakepath)
  204. scriptpath.add_oe_lib_path()
  205. scriptutils.logger_setup_color(logger, global_args.color)
  206. if global_args.bbpath is None:
  207. tinfoil = setup_tinfoil(config_only=True, basepath=basepath)
  208. global_args.bbpath = tinfoil.config_data.getVar('BBPATH', True)
  209. else:
  210. tinfoil = None
  211. for path in [scripts_path] + global_args.bbpath.split(':'):
  212. pluginpath = os.path.join(path, 'lib', 'devtool')
  213. scriptutils.load_plugins(logger, plugins, pluginpath)
  214. if tinfoil:
  215. tinfoil.shutdown()
  216. subparsers = parser.add_subparsers(dest="subparser_name", title='subcommands', metavar='<subcommand>')
  217. if not context.fixed_setup:
  218. parser_create_workspace = subparsers.add_parser('create-workspace',
  219. help='Set up a workspace',
  220. 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.')
  221. parser_create_workspace.add_argument('layerpath', nargs='?', help='Path in which the workspace layer should be created')
  222. parser_create_workspace.add_argument('--create-only', action="store_true", help='Only create the workspace layer, do not alter configuration')
  223. parser_create_workspace.set_defaults(func=create_workspace)
  224. for plugin in plugins:
  225. if hasattr(plugin, 'register_commands'):
  226. plugin.register_commands(subparsers, context)
  227. args = parser.parse_args(unparsed_args, namespace=global_args)
  228. if args.subparser_name != 'create-workspace':
  229. read_workspace()
  230. try:
  231. ret = args.func(args, config, basepath, workspace)
  232. except DevtoolError as err:
  233. if str(err):
  234. logger.error(str(err))
  235. ret = 1
  236. return ret
  237. if __name__ == "__main__":
  238. try:
  239. ret = main()
  240. except Exception:
  241. ret = 1
  242. import traceback
  243. traceback.print_exc(5)
  244. sys.exit(ret)