xref: /OK3568_Linux_fs/yocto/poky/meta/classes/kernel-yocto.bbclass (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1# remove tasks that modify the source tree in case externalsrc is inherited
2SRCTREECOVEREDTASKS += "do_validate_branches do_kernel_configcheck do_kernel_checkout do_fetch do_unpack do_patch"
3PATCH_GIT_USER_EMAIL ?= "kernel-yocto@oe"
4PATCH_GIT_USER_NAME ?= "OpenEmbedded"
5
6# The distro or local.conf should set this, but if nobody cares...
7LINUX_KERNEL_TYPE ??= "standard"
8
9# KMETA ?= ""
10KBRANCH ?= "master"
11KMACHINE ?= "${MACHINE}"
12SRCREV_FORMAT ?= "meta_machine"
13
14# LEVELS:
15#   0: no reporting
16#   1: report options that are specified, but not in the final config
17#   2: report options that are not hardware related, but set by a BSP
18KCONF_AUDIT_LEVEL ?= "1"
19KCONF_BSP_AUDIT_LEVEL ?= "0"
20KMETA_AUDIT ?= "yes"
21KMETA_AUDIT_WERROR ?= ""
22
23# returns local (absolute) path names for all valid patches in the
24# src_uri
25def find_patches(d,subdir):
26    patches = src_patches(d)
27    patch_list=[]
28    for p in patches:
29        _, _, local, _, _, parm = bb.fetch.decodeurl(p)
30        # if patchdir has been passed, we won't be able to apply it so skip
31        # the patch for now, and special processing happens later
32        patchdir = ''
33        if "patchdir" in parm:
34            patchdir = parm["patchdir"]
35        if subdir:
36            if subdir == patchdir:
37                patch_list.append(local)
38        else:
39            # skip the patch if a patchdir was supplied, it won't be handled
40            # properly
41            if not patchdir:
42                patch_list.append(local)
43
44    return patch_list
45
46# returns all the elements from the src uri that are .scc files
47def find_sccs(d):
48    sources=src_patches(d, True)
49    sources_list=[]
50    for s in sources:
51        base, ext = os.path.splitext(os.path.basename(s))
52        if ext and ext in [".scc", ".cfg"]:
53            sources_list.append(s)
54        elif base and 'defconfig' in base:
55            sources_list.append(s)
56
57    return sources_list
58
59# check the SRC_URI for "kmeta" type'd git repositories. Return the name of
60# the repository as it will be found in WORKDIR
61def find_kernel_feature_dirs(d):
62    feature_dirs=[]
63    fetch = bb.fetch2.Fetch([], d)
64    for url in fetch.urls:
65        urldata = fetch.ud[url]
66        parm = urldata.parm
67        type=""
68        if "type" in parm:
69            type = parm["type"]
70        if "destsuffix" in parm:
71            destdir = parm["destsuffix"]
72            if type == "kmeta":
73                feature_dirs.append(destdir)
74
75    return feature_dirs
76
77# find the master/machine source branch. In the same way that the fetcher proceses
78# git repositories in the SRC_URI we take the first repo found, first branch.
79def get_machine_branch(d, default):
80    fetch = bb.fetch2.Fetch([], d)
81    for url in fetch.urls:
82        urldata = fetch.ud[url]
83        parm = urldata.parm
84        if "branch" in parm:
85            branches = urldata.parm.get("branch").split(',')
86            btype = urldata.parm.get("type")
87            if btype != "kmeta":
88                return branches[0]
89
90    return default
91
92# returns a list of all directories that are on FILESEXTRAPATHS (and
93# hence available to the build) that contain .scc or .cfg files
94def get_dirs_with_fragments(d):
95    extrapaths = []
96    extrafiles = []
97    extrapathsvalue = (d.getVar("FILESEXTRAPATHS") or "")
98    # Remove default flag which was used for checking
99    extrapathsvalue = extrapathsvalue.replace("__default:", "")
100    extrapaths = extrapathsvalue.split(":")
101    for path in extrapaths:
102        if path + ":True" not in extrafiles:
103            extrafiles.append(path + ":" + str(os.path.exists(path)))
104
105    return " ".join(extrafiles)
106
107do_kernel_metadata() {
108	set +e
109
110	if [ -n "$1" ]; then
111		mode="$1"
112	else
113		mode="patch"
114	fi
115
116	cd ${S}
117	export KMETA=${KMETA}
118
119	bbnote "do_kernel_metadata: for summary/debug, set KCONF_AUDIT_LEVEL > 0"
120
121	# if kernel tools are available in-tree, they are preferred
122	# and are placed on the path before any external tools. Unless
123	# the external tools flag is set, in that case we do nothing.
124	if [ -f "${S}/scripts/util/configme" ]; then
125		if [ -z "${EXTERNAL_KERNEL_TOOLS}" ]; then
126			PATH=${S}/scripts/util:${PATH}
127		fi
128	fi
129
130	# In a similar manner to the kernel itself:
131	#
132	#   defconfig: $(obj)/conf
133	#   ifeq ($(KBUILD_DEFCONFIG),)
134	#	$< --defconfig $(Kconfig)
135	#   else
136	#	@echo "*** Default configuration is based on '$(KBUILD_DEFCONFIG)'"
137	#	$(Q)$< --defconfig=arch/$(SRCARCH)/configs/$(KBUILD_DEFCONFIG) $(Kconfig)
138	#   endif
139	#
140	# If a defconfig is specified via the KBUILD_DEFCONFIG variable, we copy it
141	# from the source tree, into a common location and normalized "defconfig" name,
142	# where the rest of the process will include and incoroporate it into the build
143	#
144	# If the fetcher has already placed a defconfig in WORKDIR (from the SRC_URI),
145	# we don't overwrite it, but instead warn the user that SRC_URI defconfigs take
146	# precendence.
147	#
148	if [ -n "${KBUILD_DEFCONFIG}" ]; then
149		if [ -f "${S}/arch/${ARCH}/configs/${KBUILD_DEFCONFIG}" ]; then
150			if [ -f "${WORKDIR}/defconfig" ]; then
151				# If the two defconfig's are different, warn that we overwrote the
152				# one already placed in WORKDIR
153				cmp "${WORKDIR}/defconfig" "${S}/arch/${ARCH}/configs/${KBUILD_DEFCONFIG}"
154				if [ $? -ne 0 ]; then
155					bbdebug 1 "detected SRC_URI or unpatched defconfig in WORKDIR. ${KBUILD_DEFCONFIG} copied over it"
156				fi
157				cp -f ${S}/arch/${ARCH}/configs/${KBUILD_DEFCONFIG} ${WORKDIR}/defconfig
158			else
159				cp -f ${S}/arch/${ARCH}/configs/${KBUILD_DEFCONFIG} ${WORKDIR}/defconfig
160			fi
161			in_tree_defconfig="${WORKDIR}/defconfig"
162		else
163			bbfatal "A KBUILD_DEFCONFIG '${KBUILD_DEFCONFIG}' was specified, but not present in the source tree (${S}/arch/${ARCH}/configs/)"
164		fi
165	fi
166
167	if [ "$mode" = "patch" ]; then
168		# was anyone trying to patch the kernel meta data ?, we need to do
169		# this here, since the scc commands migrate the .cfg fragments to the
170		# kernel source tree, where they'll be used later.
171		check_git_config
172		patches="${@" ".join(find_patches(d,'kernel-meta'))}"
173		for p in $patches; do
174		    (
175			cd ${WORKDIR}/kernel-meta
176			git am -s $p
177		    )
178		done
179	fi
180
181	sccs_from_src_uri="${@" ".join(find_sccs(d))}"
182	patches="${@" ".join(find_patches(d,''))}"
183	feat_dirs="${@" ".join(find_kernel_feature_dirs(d))}"
184
185	# a quick check to make sure we don't have duplicate defconfigs If
186	# there's a defconfig in the SRC_URI, did we also have one from the
187	# KBUILD_DEFCONFIG processing above ?
188	src_uri_defconfig=$(echo $sccs_from_src_uri | awk '(match($0, "defconfig") != 0) { print $0 }' RS=' ')
189	# drop and defconfig's from the src_uri variable, we captured it just above here if it existed
190	sccs_from_src_uri=$(echo $sccs_from_src_uri | awk '(match($0, "defconfig") == 0) { print $0 }' RS=' ')
191
192	if [ -n "$in_tree_defconfig" ]; then
193		sccs_defconfig=$in_tree_defconfig
194		if [ -n "$src_uri_defconfig" ]; then
195			bbwarn "[NOTE]: defconfig was supplied both via KBUILD_DEFCONFIG and SRC_URI. Dropping SRC_URI defconfig"
196		fi
197	else
198		# if we didn't have an in-tree one, make our defconfig the one
199		# from the src_uri. Note: there may not have been one from the
200		# src_uri, so this can be an empty variable.
201		sccs_defconfig=$src_uri_defconfig
202	fi
203	sccs="$sccs_from_src_uri"
204
205	# check for feature directories/repos/branches that were part of the
206	# SRC_URI. If they were supplied, we convert them into include directives
207	# for the update part of the process
208	for f in ${feat_dirs}; do
209		if [ -d "${WORKDIR}/$f/kernel-meta" ]; then
210			includes="$includes -I${WORKDIR}/$f/kernel-meta"
211		elif [ -d "${WORKDIR}/../oe-local-files/$f" ]; then
212			includes="$includes -I${WORKDIR}/../oe-local-files/$f"
213	        elif [ -d "${WORKDIR}/$f" ]; then
214			includes="$includes -I${WORKDIR}/$f"
215		fi
216	done
217	for s in ${sccs} ${patches}; do
218		sdir=$(dirname $s)
219		includes="$includes -I${sdir}"
220                # if a SRC_URI passed patch or .scc has a subdir of "kernel-meta",
221                # then we add it to the search path
222                if [ -d "${sdir}/kernel-meta" ]; then
223			includes="$includes -I${sdir}/kernel-meta"
224                fi
225	done
226
227	# expand kernel features into their full path equivalents
228	bsp_definition=$(spp ${includes} --find -DKMACHINE=${KMACHINE} -DKTYPE=${LINUX_KERNEL_TYPE})
229	if [ -z "$bsp_definition" ]; then
230		if [ -z "$sccs_defconfig" ]; then
231			bbfatal_log "Could not locate BSP definition for ${KMACHINE}/${LINUX_KERNEL_TYPE} and no defconfig was provided"
232		fi
233	else
234		# if the bsp definition has "define KMETA_EXTERNAL_BSP t",
235		# then we need to set a flag that will instruct the next
236		# steps to use the BSP as both configuration and patches.
237		grep -q KMETA_EXTERNAL_BSP $bsp_definition
238		if [ $? -eq 0 ]; then
239		    KMETA_EXTERNAL_BSPS="t"
240		fi
241	fi
242	meta_dir=$(kgit --meta)
243
244	KERNEL_FEATURES_FINAL=""
245	if [ -n "${KERNEL_FEATURES}" ]; then
246		for feature in ${KERNEL_FEATURES}; do
247			feature_found=f
248			for d in $includes; do
249				path_to_check=$(echo $d | sed 's/^-I//')
250				if [ "$feature_found" = "f" ] && [ -e "$path_to_check/$feature" ]; then
251				    feature_found=t
252				fi
253			done
254			if [ "$feature_found" = "f" ]; then
255				if [ -n "${KERNEL_DANGLING_FEATURES_WARN_ONLY}" ]; then
256				    bbwarn "Feature '$feature' not found, but KERNEL_DANGLING_FEATURES_WARN_ONLY is set"
257				    bbwarn "This may cause runtime issues, dropping feature and allowing configuration to continue"
258				else
259				    bberror "Feature '$feature' not found, this will cause configuration failures."
260				    bberror "Check the SRC_URI for meta-data repositories or directories that may be missing"
261				    bbfatal_log "Set KERNEL_DANGLING_FEATURES_WARN_ONLY to ignore this issue"
262				fi
263			else
264				KERNEL_FEATURES_FINAL="$KERNEL_FEATURES_FINAL $feature"
265			fi
266		done
267        fi
268
269	if [ "$mode" = "config" ]; then
270		# run1: pull all the configuration fragments, no matter where they come from
271		elements="`echo -n ${bsp_definition} $sccs_defconfig ${sccs} ${patches} $KERNEL_FEATURES_FINAL`"
272		if [ -n "${elements}" ]; then
273			echo "${bsp_definition}" > ${S}/${meta_dir}/bsp_definition
274			scc --force -o ${S}/${meta_dir}:cfg,merge,meta ${includes} $sccs_defconfig $bsp_definition $sccs $patches $KERNEL_FEATURES_FINAL
275			if [ $? -ne 0 ]; then
276				bbfatal_log "Could not generate configuration queue for ${KMACHINE}."
277			fi
278		fi
279	fi
280
281	# if KMETA_EXTERNAL_BSPS has been set, or it has been detected from
282	# the bsp definition, then we inject the bsp_definition into the
283	# patch phase below.  we'll piggy back on the sccs variable.
284	if [ -n "${KMETA_EXTERNAL_BSPS}" ]; then
285		sccs="${bsp_definition} ${sccs}"
286	fi
287
288	if [ "$mode" = "patch" ]; then
289		# run2: only generate patches for elements that have been passed on the SRC_URI
290		elements="`echo -n ${sccs} ${patches} $KERNEL_FEATURES_FINAL`"
291		if [ -n "${elements}" ]; then
292			scc --force -o ${S}/${meta_dir}:patch --cmds patch ${includes} ${sccs} ${patches} $KERNEL_FEATURES_FINAL
293			if [ $? -ne 0 ]; then
294				bbfatal_log "Could not generate configuration queue for ${KMACHINE}."
295			fi
296		fi
297	fi
298
299	if [ ${KCONF_AUDIT_LEVEL} -gt 0 ]; then
300		bbnote "kernel meta data summary for ${KMACHINE} (${LINUX_KERNEL_TYPE}):"
301		bbnote "======================================================================"
302		if [ -n "${KMETA_EXTERNAL_BSPS}" ]; then
303			bbnote "Non kernel-cache (external) bsp"
304		fi
305		bbnote "BSP entry point / definition: $bsp_definition"
306		if [ -n "$in_tree_defconfig" ]; then
307			bbnote "KBUILD_DEFCONFIG: ${KBUILD_DEFCONFIG}"
308		fi
309		bbnote "Fragments from SRC_URI: $sccs_from_src_uri"
310		bbnote "KERNEL_FEATURES: $KERNEL_FEATURES_FINAL"
311		bbnote "Final scc/cfg list: $sccs_defconfig $bsp_definition $sccs $KERNEL_FEATURES_FINAL"
312	fi
313
314	set -e
315}
316
317do_patch() {
318	set +e
319	cd ${S}
320
321	check_git_config
322	meta_dir=$(kgit --meta)
323	(cd ${meta_dir}; ln -sf patch.queue series)
324	if [ -f "${meta_dir}/series" ]; then
325		kgit_extra_args=""
326		if [ "${KERNEL_DEBUG_TIMESTAMPS}" != "1" ]; then
327		    kgit_extra_args="--commit-sha author"
328		fi
329		kgit-s2q --gen -v $kgit_extra_args --patches .kernel-meta/
330		if [ $? -ne 0 ]; then
331			bberror "Could not apply patches for ${KMACHINE}."
332			bbfatal_log "Patch failures can be resolved in the linux source directory ${S})"
333		fi
334	fi
335
336	if [ -f "${meta_dir}/merge.queue" ]; then
337		# we need to merge all these branches
338		for b in $(cat ${meta_dir}/merge.queue); do
339			git show-ref --verify --quiet refs/heads/${b}
340			if [ $? -eq 0 ]; then
341				bbnote "Merging branch ${b}"
342				git merge -q --no-ff -m "Merge branch ${b}" ${b}
343			else
344				bbfatal "branch ${b} does not exist, cannot merge"
345			fi
346		done
347	fi
348
349	set -e
350}
351
352do_kernel_checkout() {
353	set +e
354
355	source_dir=`echo ${S} | sed 's%/$%%'`
356	source_workdir="${WORKDIR}/git"
357	if [ -d "${WORKDIR}/git/" ]; then
358		# case: git repository
359		# if S is WORKDIR/git, then we shouldn't be moving or deleting the tree.
360		if [ "${source_dir}" != "${source_workdir}" ]; then
361			if [ -d "${source_workdir}/.git" ]; then
362				# regular git repository with .git
363				rm -rf ${S}
364				mv ${WORKDIR}/git ${S}
365			else
366				# create source for bare cloned git repository
367				git clone ${WORKDIR}/git ${S}
368				rm -rf ${WORKDIR}/git
369			fi
370		fi
371		cd ${S}
372
373		# convert any remote branches to local tracking ones
374		for i in `git branch -a --no-color | grep remotes | grep -v HEAD`; do
375			b=`echo $i | cut -d' ' -f2 | sed 's%remotes/origin/%%'`;
376			git show-ref --quiet --verify -- "refs/heads/$b"
377			if [ $? -ne 0 ]; then
378				git branch $b $i > /dev/null
379			fi
380		done
381
382		# Create a working tree copy of the kernel by checking out a branch
383		machine_branch="${@ get_machine_branch(d, "${KBRANCH}" )}"
384
385		# checkout and clobber any unimportant files
386		git checkout -f ${machine_branch}
387	else
388		# case: we have no git repository at all.
389		# To support low bandwidth options for building the kernel, we'll just
390		# convert the tree to a git repo and let the rest of the process work unchanged
391
392		# if ${S} hasn't been set to the proper subdirectory a default of "linux" is
393		# used, but we can't initialize that empty directory. So check it and throw a
394		# clear error
395
396	        cd ${S}
397		if [ ! -f "Makefile" ]; then
398			bberror "S is not set to the linux source directory. Check "
399			bbfatal "the recipe and set S to the proper extracted subdirectory"
400		fi
401		rm -f .gitignore
402		git init
403		check_git_config
404		git add .
405		git commit -q -m "baseline commit: creating repo for ${PN}-${PV}"
406		git clean -d -f
407	fi
408
409	set -e
410}
411do_kernel_checkout[dirs] = "${S} ${WORKDIR}"
412
413addtask kernel_checkout before do_kernel_metadata after do_symlink_kernsrc
414addtask kernel_metadata after do_validate_branches do_unpack before do_patch
415do_kernel_metadata[depends] = "kern-tools-native:do_populate_sysroot"
416do_kernel_metadata[file-checksums] = " ${@get_dirs_with_fragments(d)}"
417do_validate_branches[depends] = "kern-tools-native:do_populate_sysroot"
418
419do_kernel_configme[depends] += "virtual/${TARGET_PREFIX}binutils:do_populate_sysroot"
420do_kernel_configme[depends] += "virtual/${TARGET_PREFIX}gcc:do_populate_sysroot"
421do_kernel_configme[depends] += "bc-native:do_populate_sysroot bison-native:do_populate_sysroot"
422do_kernel_configme[depends] += "kern-tools-native:do_populate_sysroot"
423do_kernel_configme[dirs] += "${S} ${B}"
424do_kernel_configme() {
425	do_kernel_metadata config
426
427	# translate the kconfig_mode into something that merge_config.sh
428	# understands
429	case ${KCONFIG_MODE} in
430		*allnoconfig)
431			config_flags="-n"
432			;;
433		*alldefconfig)
434			config_flags=""
435			;;
436		*)
437			if [ -f ${WORKDIR}/defconfig ]; then
438				config_flags="-n"
439			fi
440			;;
441	esac
442
443	cd ${S}
444
445	meta_dir=$(kgit --meta)
446	configs="$(scc --configs -o ${meta_dir})"
447	if [ $? -ne 0 ]; then
448		bberror "${configs}"
449		bbfatal_log "Could not find configuration queue (${meta_dir}/config.queue)"
450	fi
451
452	CFLAGS="${CFLAGS} ${TOOLCHAIN_OPTIONS}" HOSTCC="${BUILD_CC} ${BUILD_CFLAGS} ${BUILD_LDFLAGS}" HOSTCPP="${BUILD_CPP}" CC="${KERNEL_CC}" LD="${KERNEL_LD}" ARCH=${ARCH} merge_config.sh -O ${B} ${config_flags} ${configs} > ${meta_dir}/cfg/merge_config_build.log 2>&1
453	if [ $? -ne 0 -o ! -f ${B}/.config ]; then
454		bberror "Could not generate a .config for ${KMACHINE}-${LINUX_KERNEL_TYPE}"
455		if [ ${KCONF_AUDIT_LEVEL} -gt 1 ]; then
456			bbfatal_log "`cat ${meta_dir}/cfg/merge_config_build.log`"
457		else
458			bbfatal_log "Details can be found at: ${S}/${meta_dir}/cfg/merge_config_build.log"
459		fi
460	fi
461
462	if [ ! -z "${LINUX_VERSION_EXTENSION}" ]; then
463		echo "# Global settings from linux recipe" >> ${B}/.config
464		echo "CONFIG_LOCALVERSION="\"${LINUX_VERSION_EXTENSION}\" >> ${B}/.config
465	fi
466}
467
468addtask kernel_configme before do_configure after do_patch
469addtask config_analysis
470
471do_config_analysis[depends] = "virtual/kernel:do_configure"
472do_config_analysis[depends] += "kern-tools-native:do_populate_sysroot"
473
474CONFIG_AUDIT_FILE ?= "${WORKDIR}/config-audit.txt"
475CONFIG_ANALYSIS_FILE ?= "${WORKDIR}/config-analysis.txt"
476
477python do_config_analysis() {
478    import re, string, sys, subprocess
479
480    s = d.getVar('S')
481
482    env = os.environ.copy()
483    env['PATH'] = "%s:%s%s" % (d.getVar('PATH'), s, "/scripts/util/")
484    env['LD'] = d.getVar('KERNEL_LD')
485    env['CC'] = d.getVar('KERNEL_CC')
486    env['ARCH'] = d.getVar('ARCH')
487    env['srctree'] = s
488
489    # read specific symbols from the kernel recipe or from local.conf
490    # i.e.: CONFIG_ANALYSIS:pn-linux-yocto-dev = 'NF_CONNTRACK LOCALVERSION'
491    config = d.getVar( 'CONFIG_ANALYSIS' )
492    if not config:
493       config = [ "" ]
494    else:
495       config = config.split()
496
497    for c in config:
498        for action in ["analysis","audit"]:
499            if action == "analysis":
500                try:
501                    analysis = subprocess.check_output(['symbol_why.py', '--dotconfig',  '{}'.format( d.getVar('B') + '/.config' ), '--blame', c], cwd=s, env=env ).decode('utf-8')
502                except subprocess.CalledProcessError as e:
503                    bb.fatal( "config analysis failed when running '%s': %s" % (" ".join(e.cmd), e.output.decode('utf-8')))
504
505                outfile = d.getVar( 'CONFIG_ANALYSIS_FILE' )
506
507            if action == "audit":
508                try:
509                    analysis = subprocess.check_output(['symbol_why.py', '--dotconfig',  '{}'.format( d.getVar('B') + '/.config' ), '--summary', '--extended', '--sanity', c], cwd=s, env=env ).decode('utf-8')
510                except subprocess.CalledProcessError as e:
511                    bb.fatal( "config analysis failed when running '%s': %s" % (" ".join(e.cmd), e.output.decode('utf-8')))
512
513                outfile = d.getVar( 'CONFIG_AUDIT_FILE' )
514
515            if c:
516                outdir = os.path.dirname( outfile )
517                outname = os.path.basename( outfile )
518                outfile = outdir + '/'+ c + '-' + outname
519
520            if config and os.path.isfile(outfile):
521                os.remove(outfile)
522
523            with open(outfile, 'w+') as f:
524                f.write( analysis )
525
526            bb.warn( "Configuration {} executed, see: {} for details".format(action,outfile ))
527            if c:
528                bb.warn( analysis )
529}
530
531python do_kernel_configcheck() {
532    import re, string, sys, subprocess
533
534    s = d.getVar('S')
535
536    # if KMETA isn't set globally by a recipe using this routine, use kgit to
537    # locate or create the meta directory. Otherwise, kconf_check is not
538    # passed a valid meta-series for processing
539    kmeta = d.getVar("KMETA")
540    if not kmeta or not os.path.exists('{}/{}'.format(s,kmeta)):
541        kmeta = subprocess.check_output(['kgit', '--meta'], cwd=d.getVar('S')).decode('utf-8').rstrip()
542
543    env = os.environ.copy()
544    env['PATH'] = "%s:%s%s" % (d.getVar('PATH'), s, "/scripts/util/")
545    env['LD'] = d.getVar('KERNEL_LD')
546    env['CC'] = d.getVar('KERNEL_CC')
547    env['ARCH'] = d.getVar('ARCH')
548    env['srctree'] = s
549
550    try:
551        configs = subprocess.check_output(['scc', '--configs', '-o', s + '/.kernel-meta'], env=env).decode('utf-8')
552    except subprocess.CalledProcessError as e:
553        bb.fatal( "Cannot gather config fragments for audit: %s" % e.output.decode("utf-8") )
554
555    config_check_visibility = int(d.getVar("KCONF_AUDIT_LEVEL") or 0)
556    bsp_check_visibility = int(d.getVar("KCONF_BSP_AUDIT_LEVEL") or 0)
557    kmeta_audit_werror = d.getVar("KMETA_AUDIT_WERROR") or ""
558    warnings_detected = False
559
560    # if config check visibility is "1", that's the lowest level of audit. So
561    # we add the --classify option to the run, since classification will
562    # streamline the output to only report options that could be boot issues,
563    # or are otherwise required for proper operation.
564    extra_params = ""
565    if config_check_visibility == 1:
566       extra_params = "--classify"
567
568    # category #1: mismatches
569    try:
570        analysis = subprocess.check_output(['symbol_why.py', '--dotconfig',  '{}'.format( d.getVar('B') + '/.config' ), '--mismatches', extra_params], cwd=s, env=env ).decode('utf-8')
571    except subprocess.CalledProcessError as e:
572        bb.fatal( "config analysis failed when running '%s': %s" % (" ".join(e.cmd), e.output.decode('utf-8')))
573
574    if analysis:
575        outfile = "{}/{}/cfg/mismatch.txt".format( s, kmeta )
576        if os.path.isfile(outfile):
577           os.remove(outfile)
578        with open(outfile, 'w+') as f:
579            f.write( analysis )
580
581        if config_check_visibility and os.stat(outfile).st_size > 0:
582            with open (outfile, "r") as myfile:
583                results = myfile.read()
584                bb.warn( "[kernel config]: specified values did not make it into the kernel's final configuration:\n\n%s" % results)
585                warnings_detected = True
586
587    # category #2: invalid fragment elements
588    extra_params = ""
589    if bsp_check_visibility > 1:
590        extra_params = "--strict"
591    try:
592        analysis = subprocess.check_output(['symbol_why.py', '--dotconfig',  '{}'.format( d.getVar('B') + '/.config' ), '--invalid', extra_params], cwd=s, env=env ).decode('utf-8')
593    except subprocess.CalledProcessError as e:
594        bb.fatal( "config analysis failed when running '%s': %s" % (" ".join(e.cmd), e.output.decode('utf-8')))
595
596    if analysis:
597        outfile = "{}/{}/cfg/invalid.txt".format(s,kmeta)
598        if os.path.isfile(outfile):
599           os.remove(outfile)
600        with open(outfile, 'w+') as f:
601            f.write( analysis )
602
603        if bsp_check_visibility and os.stat(outfile).st_size > 0:
604            with open (outfile, "r") as myfile:
605                results = myfile.read()
606                bb.warn( "[kernel config]: This BSP contains fragments with warnings:\n\n%s" % results)
607                warnings_detected = True
608
609    # category #3: redefined options (this is pretty verbose and is debug only)
610    try:
611        analysis = subprocess.check_output(['symbol_why.py', '--dotconfig',  '{}'.format( d.getVar('B') + '/.config' ), '--sanity'], cwd=s, env=env ).decode('utf-8')
612    except subprocess.CalledProcessError as e:
613        bb.fatal( "config analysis failed when running '%s': %s" % (" ".join(e.cmd), e.output.decode('utf-8')))
614
615    if analysis:
616        outfile = "{}/{}/cfg/redefinition.txt".format(s,kmeta)
617        if os.path.isfile(outfile):
618           os.remove(outfile)
619        with open(outfile, 'w+') as f:
620            f.write( analysis )
621
622        # if the audit level is greater than two, we report if a fragment has overriden
623        # a value from a base fragment. This is really only used for new kernel introduction
624        if bsp_check_visibility > 2 and os.stat(outfile).st_size > 0:
625            with open (outfile, "r") as myfile:
626                results = myfile.read()
627                bb.warn( "[kernel config]: This BSP has configuration options defined in more than one config, with differing values:\n\n%s" % results)
628                warnings_detected = True
629
630    if warnings_detected and kmeta_audit_werror:
631        bb.fatal( "configuration warnings detected, werror is set, promoting to fatal" )
632}
633
634# Ensure that the branches (BSP and meta) are on the locations specified by
635# their SRCREV values. If they are NOT on the right commits, the branches
636# are corrected to the proper commit.
637do_validate_branches() {
638	set +e
639	cd ${S}
640
641	machine_branch="${@ get_machine_branch(d, "${KBRANCH}" )}"
642	machine_srcrev="${SRCREV_machine}"
643
644	# if SRCREV is AUTOREV it shows up as AUTOINC there's nothing to
645	# check and we can exit early
646	if [ "${machine_srcrev}" = "AUTOINC" ]; then
647	    linux_yocto_dev='${@oe.utils.conditional("PREFERRED_PROVIDER_virtual/kernel", "linux-yocto-dev", "1", "", d)}'
648	    if [ -n "$linux_yocto_dev" ]; then
649		git checkout -q -f ${machine_branch}
650		ver=$(grep "^VERSION =" ${S}/Makefile | sed s/.*=\ *//)
651		patchlevel=$(grep "^PATCHLEVEL =" ${S}/Makefile | sed s/.*=\ *//)
652		sublevel=$(grep "^SUBLEVEL =" ${S}/Makefile | sed s/.*=\ *//)
653		kver="$ver.$patchlevel"
654		bbnote "dev kernel: performing version -> branch -> SRCREV validation"
655		bbnote "dev kernel: recipe version ${LINUX_VERSION}, src version: $kver"
656		echo "${LINUX_VERSION}" | grep -q $kver
657		if [ $? -ne 0 ]; then
658		    version="$(echo ${LINUX_VERSION} | sed 's/\+.*$//g')"
659		    versioned_branch="v$version/$machine_branch"
660
661		    machine_branch=$versioned_branch
662		    force_srcrev="$(git rev-parse $machine_branch 2> /dev/null)"
663		    if [ $? -ne 0 ]; then
664			bbfatal "kernel version mismatch detected, and no valid branch $machine_branch detected"
665		    fi
666
667		    bbnote "dev kernel: adjusting branch to $machine_branch, srcrev to: $force_srcrev"
668		fi
669	    else
670		bbnote "SRCREV validation is not required for AUTOREV"
671	    fi
672	elif [ "${machine_srcrev}" = "" ]; then
673		if [ "${SRCREV}" != "AUTOINC" ] && [ "${SRCREV}" != "INVALID" ]; then
674		       # SRCREV_machine_<MACHINE> was not set. This means that a custom recipe
675		       # that doesn't use the SRCREV_FORMAT "machine_meta" is being built. In
676		       # this case, we need to reset to the give SRCREV before heading to patching
677		       bbnote "custom recipe is being built, forcing SRCREV to ${SRCREV}"
678		       force_srcrev="${SRCREV}"
679		fi
680	else
681		git cat-file -t ${machine_srcrev} > /dev/null
682		if [ $? -ne 0 ]; then
683			bberror "${machine_srcrev} is not a valid commit ID."
684			bbfatal_log "The kernel source tree may be out of sync"
685		fi
686		force_srcrev=${machine_srcrev}
687	fi
688
689	git checkout -q -f ${machine_branch}
690	if [ -n "${force_srcrev}" ]; then
691		# see if the branch we are about to patch has been properly reset to the defined
692		# SRCREV .. if not, we reset it.
693		branch_head=`git rev-parse HEAD`
694		if [ "${force_srcrev}" != "${branch_head}" ]; then
695			current_branch=`git rev-parse --abbrev-ref HEAD`
696			git branch "$current_branch-orig"
697			git reset --hard ${force_srcrev}
698			# We've checked out HEAD, make sure we cleanup kgit-s2q fence post check
699			# so the patches are applied as expected otherwise no patching
700			# would be done in some corner cases.
701			kgit-s2q --clean
702		fi
703	fi
704
705	set -e
706}
707
708OE_TERMINAL_EXPORTS += "KBUILD_OUTPUT"
709KBUILD_OUTPUT = "${B}"
710
711python () {
712    # If diffconfig is available, ensure it runs after kernel_configme
713    if 'do_diffconfig' in d:
714        bb.build.addtask('do_diffconfig', None, 'do_kernel_configme', d)
715
716    externalsrc = d.getVar('EXTERNALSRC')
717    if externalsrc:
718        # If we deltask do_patch, do_kernel_configme is left without
719        # dependencies and runs too early
720        d.setVarFlag('do_kernel_configme', 'deps', (d.getVarFlag('do_kernel_configme', 'deps', False) or []) + ['do_unpack'])
721}
722
723# extra tasks
724addtask kernel_version_sanity_check after do_kernel_metadata do_kernel_checkout before do_compile
725addtask validate_branches before do_patch after do_kernel_checkout
726addtask kernel_configcheck after do_configure before do_compile
727