blob: b1d359ec3816ee2d9a0e049653796dfc048b9c08 [file] [log] [blame]
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001# Copyright (c) 2013 LG Electronics, Inc.
2# Copyright (C) 2014 Intel Corp.
3
4# This recipe creates packages for the bootchart2 system-wide profiler daemon
5# and related utilities. Depending on the images you're building, additional
6# configuration may be needed in order to use it.
7#
8# Packages:
9# * bootchart2 - The daemon itself.
10# * pybootchartgui - Python program to visualize and display the data
11# collected by bootchart2 or compatible daemons such as the original
12# bootchart.
13# * bootchartd-stop-initscript - A SysV init script to stop data collection
14# when booting completes (see below for details.)
15#
16# While bootchart2 is designed to stop collecting data roughly when the boot
17# process completes, it is not exactly a stopwatch. It has a list of programs
18# which are supposed signify that the boot process has completed (for example,
19# openbox or gnome-shell,) but it waits a full 20 seconds after such a program
20# is launched before stopping itself, to collect additional data.
21#
22# If you are using a window manager or GUI which isn't included in bootchart2's
23# default configuration file, you should write bbappend file to amend
24# bootchartd.conf and add it to EXIT_PROC. An example of this is shown in this
25# recipe, where the Matchbox window manager (used by Sato) is added.
26#
27# If you want data collection to end at a certain point exactly, you should
28# arrange for the following command to be run:
29# bootchartd stop
30# You might set this command to be launched by the desktop environment shipped
31# on the image you're building after the other startup programs are complete.
32# This will not incur the 20 second wait period and will cause bootchart2 to
33# behave a bit more like a stopwatch. An example of this is shown in this
34# recipe, specifically the bootchartd-stop-initscript package, which stops data
35# collection as the last action when switching to runlevels 2 through 5. You can
36# add bootchartd-stop-initscript to IMAGE_INSTALL if you need to use it.
37#
38# Unless you're doing something special, if your image does not launch an X
39# window manager, you will need to add bootchartd-stop-initscript to your image.
40#
41# Bootchart2 can be started in two ways. Data collection can be initiated by
42# running the following command:
43# bootchartd start
44# However, for the most complete data, the bootchart2 developers recommend
45# running it as PID 1. This can be done by adding the following to the kernel
46# command line parameters in the bootloader setup:
47# init=/sbin/bootchartd
48# When invoked this way, bootchart2 will set itself up and then automatically
49# run /sbin/init. For example, when booting the default qemux86 image, one might
50# use a command like this:
51# runqemu qemux86 bootparams="initcall_debug printk.time=y quiet \
52# init=/sbin/bootchartd"
53#
54# Neither method is actually implemented here, choose what works for you.
55#
56# If you are building your image with systemd instead of SysV init, bootchart2
57# includes systemd service files to begin collection automatically at boot and
58# end collection automatically 20 seconds after the boot process has completed.
59# However, be aware that systemd tends to start bootchart2 relatively late into
60# the boot process, so it's highly recommended to use bootchart2 as PID 1. If
61# you're using systemd and you wish to use another method to stop data
62# collection at a time of your choosing, you may do so as long as you get to it
63# before the 20 second timeout of the systemd service files. Also, you may write
64# a bbappend to patch bootchart2-done.timer.in to increase or decrease the
65# timeout. Decreasing it to 0 will make it behave like
66# bootchartd-stop-initscript.
67#
68# By default, when data collection is stopped, a file named bootchart.tgz will
69# be created in /var/log. If pybootchartgui is included in your image,
70# bootchart.png will also be created at the same time. However, this results in
71# a noticeable hitch or pause at boot time, which may not be what you want on an
72# embedded device. So you may prefer to omit pybootchartgui from your image. In
73# that case, copy bootchart.tgz over to your development system and generate
74# bootchart.png there. To get pybootchartgui on your development system, you can
75# either install it directly from some other source, or build bootchart2-native
76# and find pybootchartgui in the native sysroot:
77# bitbake bootchart2-native
78# ./tmp/sysroots/x86_64-linux/usr/bin/pybootchartgui /path/to/bootchart.tgz
79# Note that, whether installed on your build system or on your image, the
80# pybootchartgui provided by this recipe does not support the -i option. You
81# will need to install pybootchartgui by other means in order to run it in
82# interactive mode.
83
84SUMMARY = "Booting sequence and CPU,I/O usage monitor"
85DESCRIPTION = "Monitors where the system spends its time at start, creating a graph of all processes, disk utilization, and wait time."
86AUTHOR = "Wonhong Kwon <wonhong.kwon@lge.com>"
87HOMEPAGE = "https://github.com/mmeeks/bootchart"
88LICENSE = "GPL-3.0"
89LIC_FILES_CHKSUM = "file://COPYING;md5=44ac4678311254db62edf8fd39cb8124"
90
91UPSTREAM_CHECK_GITTAGREGEX = "(?P<pver>\d+\.\d+(\.\d+)*)"
92
Brad Bishop316dfdd2018-06-25 12:45:53 -040093SRC_URI = "git://github.com/xrmx/bootchart.git \
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050094 file://bootchartd_stop.sh \
Patrick Williamsc0f7c042017-02-23 20:41:17 -060095 file://0001-collector-Allocate-space-on-heap-for-chunks.patch \
Brad Bishop79641f22019-09-10 07:20:22 -040096 file://0001-bootchart2-support-usrmerge.patch \
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050097 "
98
99S = "${WORKDIR}/git"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500100SRCREV = "868a2afab9da34f32c007d773b77253c93104636"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500101
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600102inherit systemd update-rc.d python3native update-alternatives
103
Patrick Williams213cb262021-08-07 19:21:33 -0500104ALTERNATIVE:${PN} = "bootchartd"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600105ALTERNATIVE_LINK_NAME[bootchartd] = "${base_sbindir}/bootchartd"
106ALTERNATIVE_PRIORITY = "100"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500107
108# The only reason to build bootchart2-native is for a native pybootchartgui.
109BBCLASSEXTEND = "native"
110
Patrick Williams213cb262021-08-07 19:21:33 -0500111SYSTEMD_SERVICE:${PN} = "bootchart2.service bootchart2-done.service bootchart2-done.timer"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500112
113UPDATERCPN = "bootchartd-stop-initscript"
114INITSCRIPT_NAME = "bootchartd_stop.sh"
115INITSCRIPT_PARAMS = "start 99 2 3 4 5 ."
116
Brad Bishop79641f22019-09-10 07:20:22 -0400117EXTRA_OEMAKE = 'BASE_SBINDIR="${base_sbindir}"'
118
Patrick Williams213cb262021-08-07 19:21:33 -0500119do_compile:prepend () {
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500120 export PY_LIBDIR="${libdir}/${PYTHON_DIR}"
121 export BINDIR="${bindir}"
122 export LIBDIR="${base_libdir}"
123}
124
125do_install () {
126 install -d ${D}${sysconfdir} # needed for -native
127 export PY_LIBDIR="${libdir}/${PYTHON_DIR}"
128 export BINDIR="${bindir}"
129 export DESTDIR="${D}"
130 export LIBDIR="${base_libdir}"
Brad Bishop79641f22019-09-10 07:20:22 -0400131 export PKGLIBDIR="${base_libdir}/bootchart"
132 export SYSTEMD_UNIT_DIR="${systemd_unitdir}/system"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500133
134 oe_runmake install
135 install -d ${D}${sysconfdir}/init.d
136 install -m 0755 ${WORKDIR}/bootchartd_stop.sh ${D}${sysconfdir}/init.d
137
138 echo 'EXIT_PROC="$EXIT_PROC matchbox-window-manager"' >> ${D}${sysconfdir}/bootchartd.conf
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600139
140 # Use python 3 instead of python 2
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500141 sed -i -e '1s,#!.*python.*,#!${USRBINPATH}/env python3,' ${D}${bindir}/pybootchartgui
Andrew Geissler90fd73c2021-03-05 15:25:55 -0600142
143 # The timestamps embedded in compressed man pages is not reproducible
144 gzip -d ${D}${mandir}/man1/*.gz
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500145}
146
147PACKAGES =+ "pybootchartgui"
Patrick Williams213cb262021-08-07 19:21:33 -0500148FILES:pybootchartgui += "${PYTHON_SITEPACKAGES_DIR}/pybootchartgui ${bindir}/pybootchartgui"
149RDEPENDS:pybootchartgui = "python3-pycairo python3-compression python3-image python3-shell python3-compression python3-codecs"
150RDEPENDS:${PN}:class-target += "${@bb.utils.contains('DISTRO_FEATURES', 'sysvinit', 'sysvinit-pidof', 'procps', d)}"
151RDEPENDS:${PN}:class-target += "lsb-release"
152DEPENDS:append:class-native = " python3-pycairo-native"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500153
154PACKAGES =+ "bootchartd-stop-initscript"
Patrick Williams213cb262021-08-07 19:21:33 -0500155FILES:bootchartd-stop-initscript += "${sysconfdir}/init.d ${sysconfdir}/rc*.d"
156RDEPENDS:bootchartd-stop-initscript = "${PN}"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500157
Patrick Williams213cb262021-08-07 19:21:33 -0500158FILES:${PN} += "${base_libdir}/bootchart/bootchart-collector"
159FILES:${PN} += "${base_libdir}/bootchart/tmpfs"
160FILES:${PN} += "${libdir}"
161FILES:${PN}-doc += "${datadir}/docs"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500162
Patrick Williams213cb262021-08-07 19:21:33 -0500163RCONFLICTS:${PN} = "bootchart"