summaryrefslogtreecommitdiffstats
path: root/bitbake/bin/bitbake-layers
blob: 572487d2db794cb2caa2e8ef2caf5aba7287fd64 (plain)
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
#!/usr/bin/env python

# This script has subcommands which operate against your bitbake layers, either
# displaying useful information, or acting against them.
# See the help output for details on available commands.

import cmd
import logging
import os
import sys

bindir = os.path.dirname(__file__)
topdir = os.path.dirname(bindir)
sys.path[0:0] = [os.path.join(topdir, 'lib')]

import bb.cache
import bb.cooker
import bb.providers
import bb.utils
from bb.cooker import state
import bb.fetch2


logger = logging.getLogger('BitBake')


def main(args):
    # Set up logging
    console = logging.StreamHandler(sys.stdout)
    format = bb.msg.BBLogFormatter("%(levelname)s: %(message)s")
    bb.msg.addDefaultlogFilter(console)
    console.setFormatter(format)
    logger.addHandler(console)

    initialenv = os.environ.copy()
    bb.utils.clean_environment()

    cmds = Commands(initialenv)
    if args:
        cmds.onecmd(' '.join(args))
    else:
        cmds.do_help('')
    return cmds.returncode


class Commands(cmd.Cmd):
    def __init__(self, initialenv):
        cmd.Cmd.__init__(self)
        self.returncode = 0
        self.config = Config(parse_only=True)
        self.cooker = bb.cooker.BBCooker(self.config,
                                         self.register_idle_function,
                                         initialenv)
        self.config_data = self.cooker.configuration.data
        bb.providers.logger.setLevel(logging.ERROR)
        self.cooker_data = None

    def register_idle_function(self, function, data):
        pass

    def prepare_cooker(self):
        sys.stderr.write("Parsing recipes..")
        logger.setLevel(logging.WARNING)

        try:
            while self.cooker.state in (state.initial, state.parsing):
                self.cooker.updateCache()
        except KeyboardInterrupt:
            self.cooker.shutdown()
            self.cooker.updateCache()
            sys.exit(2)

        logger.setLevel(logging.INFO)
        sys.stderr.write("done.\n")

        self.cooker_data = self.cooker.status
        self.cooker_data.appends = self.cooker.appendlist

    def check_prepare_cooker(self):
        if not self.cooker_data:
            self.prepare_cooker()

    def default(self, line):
        """Handle unrecognised commands"""
        sys.stderr.write("Unrecognised command or option\n")
        self.do_help('')

    def do_help(self, topic):
        """display general help or help on a specified command"""
        if topic:
            sys.stdout.write('%s: ' % topic)
            cmd.Cmd.do_help(self,topic)
        else:
            sys.stdout.write("usage: bitbake-layers <command> [arguments]\n\n")
            sys.stdout.write("Available commands:\n")
            procnames = self.get_names()
            for procname in procnames:
                if procname[:3] == 'do_':
                    sys.stdout.write("  %s\n" % procname[3:])
                    doc = getattr(self, procname).__doc__
                    if doc:
                        sys.stdout.write("    %s\n" % doc.splitlines()[0])

    def do_show_layers(self, args):
        """show current configured layers"""
        self.check_prepare_cooker()
        logger.plain('')
        logger.plain("%s  %s  %s" % ("layer".ljust(20), "path".ljust(40), "priority"))
        logger.plain('=' * 74)
        layerdirs = str(self.config_data.getVar('BBLAYERS', True)).split()
        for layerdir in layerdirs:
            layername = '?'
            layerpri = 0
            for layer, _, regex, pri in self.cooker.status.bbfile_config_priorities:
                if regex.match(os.path.join(layerdir, 'test')):
                    layername = layer
                    layerpri = pri
                    break

            logger.plain("%s  %s  %d" % (layername.ljust(20), layerdir.ljust(40), layerpri))

    def do_show_overlayed(self, args):
        """list overlayed recipes (where there is a recipe in another layer that has a higher layer priority)

usage: show_overlayed

Highest priority recipes are listed with the recipes they overlay as subitems.
"""
        self.check_prepare_cooker()
        if self.cooker.overlayed:
            logger.plain('Overlayed recipes:')
            for f in self.cooker.overlayed.iterkeys():
                logger.plain('%s' % f)
                for of in self.cooker.overlayed[f]:
                    logger.plain('  %s' % of)
        else:
            logger.plain('No overlayed recipes found')

    def do_flatten(self, args):
        """flattens layer configuration into a separate output directory.

usage: flatten [layer1 layer2 [layer3]...] <outputdir>

Takes the specified layers (or all layers in the current layer
configuration if none are specified) and builds a "flattened" directory
containing the contents of all layers, with any overlayed recipes removed
and bbappends appended to the corresponding recipes. Note that some manual
cleanup may still be necessary afterwards, in particular:

* where non-recipe files (such as patches) are overwritten (the flatten
  command will show a warning for these)
* where anything beyond the normal layer setup has been added to
  layer.conf (only the lowest priority number layer's layer.conf is used)
* overridden/appended items from bbappends will need to be tidied up

Warning: if you flatten several layers where another layer is intended to
be used "inbetween" them (in layer priority order) such that recipes /
bbappends in the layers interact, and then attempt to use the new output
layer together with that other layer, you may no longer get the same
build results (as the layer priority order has effectively changed).
"""
        arglist = args.split()
        if len(arglist) < 1:
            logger.error('Please specify an output directory')
            self.do_help('flatten')
            return

        if len(arglist) == 2:
            logger.error('If you specify layers to flatten you must specify at least two')
            self.do_help('flatten')
            return

        outputdir = arglist[-1]
        if os.path.exists(outputdir) and os.listdir(outputdir):
            logger.error('Directory %s exists and is non-empty, please clear it out first' % outputdir)
            return

        self.check_prepare_cooker()
        layers = (self.config_data.getVar('BBLAYERS', True) or "").split()
        if len(arglist) > 2:
            layernames = arglist[:-1]
            found_layernames = []
            found_layerdirs = []
            for layerdir in layers:
                for layername, _, regex, _ in self.cooker.status.bbfile_config_priorities:
                    if layername in layernames:
                        if regex.match(os.path.join(layerdir, 'test')):
                            found_layerdirs.append(layerdir)
                            found_layernames.append(layername)
                            break

            for layername in layernames:
                if not layername in found_layernames:
                    logger.error('Unable to find layer %s in current configuration, please run "%s show_layers" to list configured layers' % (layername, os.path.basename(sys.argv[0])))
                    return
            layers = found_layerdirs

        # Ensure a specified path matches our list of layers
        def layer_path_match(path):
            for layerdir in layers:
                if path.startswith(os.path.join(layerdir, '')):
                    return layerdir
            return None

        appended_recipes = []
        for layer in layers:
            overlayed = []
            for f in self.cooker.overlayed.iterkeys():
                for of in self.cooker.overlayed[f]:
                    if of.startswith(layer):
                        overlayed.append(of)

            logger.plain('Copying files from %s...' % layer )
            for root, dirs, files in os.walk(layer):
                for f1 in files:
                    f1full = os.sep.join([root, f1])
                    if f1full in overlayed:
                        logger.plain('  Skipping overlayed file %s' % f1full )
                    else:
                        ext = os.path.splitext(f1)[1]
                        if ext != '.bbappend':
                            fdest = f1full[len(layer):]
                            fdest = os.path.normpath(os.sep.join([outputdir,fdest]))
                            bb.utils.mkdirhier(os.path.dirname(fdest))
                            if os.path.exists(fdest):
                                if f1 == 'layer.conf' and root.endswith('/conf'):
                                    logger.plain('  Skipping layer config file %s' % f1full )
                                    continue
                                else:
                                    logger.warn('Overwriting file %s', fdest)
                            bb.utils.copyfile(f1full, fdest)
                            if ext == '.bb':
                                if f1 in self.cooker_data.appends:
                                    appends = self.cooker_data.appends[f1]
                                    if appends:
                                        logger.plain('  Applying appends to %s' % fdest )
                                        for appendname in appends:
                                            if layer_path_match(appendname):
                                                self.apply_append(appendname, fdest)
                                    appended_recipes.append(f1)

        # Take care of when some layers are excluded and yet we have included bbappends for those recipes
        for recipename in self.cooker_data.appends.iterkeys():
            if recipename not in appended_recipes:
                appends = self.cooker_data.appends[recipename]
                first_append = None
                for appendname in appends:
                    layer = layer_path_match(appendname)
                    if layer:
                        if first_append:
                            self.apply_append(appendname, first_append)
                        else:
                            fdest = appendname[len(layer):]
                            fdest = os.path.normpath(os.sep.join([outputdir,fdest]))
                            bb.utils.mkdirhier(os.path.dirname(fdest))
                            bb.utils.copyfile(appendname, fdest)
                            first_append = fdest


    def get_append_layer(self, appendname):
        for layer, _, regex, _ in self.cooker.status.bbfile_config_priorities:
            if regex.match(appendname):
                return layer
        return "?"

    def apply_append(self, appendname, recipename):
        appendfile = open(appendname, 'r')
        recipefile = open(recipename, 'a')
        recipefile.write('\n')
        recipefile.write('##### bbappended from %s #####\n' % self.get_append_layer(appendname))
        recipefile.writelines(appendfile.readlines())

    def do_show_appends(self, args):
        """list bbappend files and recipe files they apply to

usage: show_appends

Recipes are listed with the bbappends that apply to them as subitems.
"""
        self.check_prepare_cooker()
        if not self.cooker_data.appends:
            logger.plain('No append files found')
            return

        logger.plain('State of append files:')

        pnlist = list(self.cooker_data.pkg_pn.keys())
        pnlist.sort()
        for pn in pnlist:
            self.show_appends_for_pn(pn)

        self.show_appends_for_skipped()

    def show_appends_for_pn(self, pn):
        filenames = self.cooker_data.pkg_pn[pn]

        best = bb.providers.findBestProvider(pn,
                                             self.cooker.configuration.data,
                                             self.cooker_data,
                                             self.cooker_data.pkg_pn)
        best_filename = os.path.basename(best[3])

        self.show_appends_output(filenames, best_filename)

    def show_appends_for_skipped(self):
        filenames = [os.path.basename(f)
                    for f in self.cooker.skiplist.iterkeys()]
        self.show_appends_output(filenames, None, " (skipped)")

    def show_appends_output(self, filenames, best_filename, name_suffix = ''):
        appended, missing = self.get_appends_for_files(filenames)
        if appended:
            for basename, appends in appended:
                logger.plain('%s%s:', basename, name_suffix)
                for append in appends:
                    logger.plain('  %s', append)

            if best_filename:
                if best_filename in missing:
                    logger.warn('%s: missing append for preferred version',
                                best_filename)
                    self.returncode |= 1


    def get_appends_for_files(self, filenames):
        appended, notappended = [], []
        for filename in filenames:
            _, cls = bb.cache.Cache.virtualfn2realfn(filename)
            if cls:
                continue

            basename = os.path.basename(filename)
            appends = self.cooker_data.appends.get(basename)
            if appends:
                appended.append((basename, list(appends)))
            else:
                notappended.append(basename)
        return appended, notappended


class Config(object):
    def __init__(self, **options):
        self.pkgs_to_build = []
        self.debug_domains = []
        self.extra_assume_provided = []
        self.prefile = []
        self.postfile = []
        self.debug = 0
        self.__dict__.update(options)

    def __getattr__(self, attribute):
        try:
            return super(Config, self).__getattribute__(attribute)
        except AttributeError:
            return None


if __name__ == '__main__':
    sys.exit(main(sys.argv[1:]) or 0)