xref: /OK3568_Linux_fs/yocto/poky/meta/classes/features_check.bbclass (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1# Allow checking of required and conflicting features
2#
3# xxx = [DISTRO,MACHINE,COMBINED,IMAGE]
4#
5# ANY_OF_xxx_FEATURES:        ensure at least one item on this list is included
6#                             in xxx_FEATURES.
7# REQUIRED_xxx_FEATURES:      ensure every item on this list is included
8#                             in xxx_FEATURES.
9# CONFLICT_xxx_FEATURES:      ensure no item in this list is included in
10#                             xxx_FEATURES.
11#
12# Copyright 2019 (C) Texas Instruments Inc.
13# Copyright 2013 (C) O.S. Systems Software LTDA.
14
15python () {
16    if d.getVar('PARSE_ALL_RECIPES', False):
17        return
18
19    unused = True
20
21    for kind in ['DISTRO', 'MACHINE', 'COMBINED', 'IMAGE']:
22        if d.getVar('ANY_OF_' + kind + '_FEATURES') is None and not d.hasOverrides('ANY_OF_' + kind + '_FEATURES') and \
23           d.getVar('REQUIRED_' + kind + '_FEATURES') is None and not d.hasOverrides('REQUIRED_' + kind + '_FEATURES') and \
24           d.getVar('CONFLICT_' + kind + '_FEATURES') is None and not d.hasOverrides('CONFLICT_' + kind + '_FEATURES'):
25            continue
26
27        unused = False
28
29        # Assume at least one var is set.
30        features = set((d.getVar(kind + '_FEATURES') or '').split())
31
32        any_of_features = set((d.getVar('ANY_OF_' + kind + '_FEATURES') or '').split())
33        if any_of_features:
34            if set.isdisjoint(any_of_features, features):
35                raise bb.parse.SkipRecipe("one of '%s' needs to be in %s_FEATURES"
36                    % (' '.join(any_of_features), kind))
37
38        required_features = set((d.getVar('REQUIRED_' + kind + '_FEATURES') or '').split())
39        if required_features:
40            missing = set.difference(required_features, features)
41            if missing:
42                raise bb.parse.SkipRecipe("missing required %s feature%s '%s' (not in %s_FEATURES)"
43                    % (kind.lower(), 's' if len(missing) > 1 else '', ' '.join(missing), kind))
44
45        conflict_features = set((d.getVar('CONFLICT_' + kind + '_FEATURES') or '').split())
46        if conflict_features:
47            conflicts = set.intersection(conflict_features, features)
48            if conflicts:
49                raise bb.parse.SkipRecipe("conflicting %s feature%s '%s' (in %s_FEATURES)"
50                    % (kind.lower(), 's' if len(conflicts) > 1 else '', ' '.join(conflicts), kind))
51
52    if unused:
53        bb.warn("Recipe inherits features_check but doesn't use it")
54}
55