gentoo-x86/eclass/check-reqs.eclass

# Copyright 1999-2004 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/check-reqs.eclass,v 1.4 2005/07/06 20:23:20 agriffis Exp $
#
# Original Author: Ciaran McCreesh <ciaranm@gentoo.org>
#
# This eclass provides a uniform way of handling ebuilds which have very high
# build requirements in terms of memory or disc space. It provides a function
# which should usually be called during pkg_setup().
#
# From a user perspective, the variable CHECKREQS_ACTION can be set to:
#    * "warn" (default), which will display a warning and wait for 15s
#    * "error", which will make the ebuild error out
#    * "ignore", which will not take any action
# The chosen action only happens when the system's resources are detected
# correctly and only if they are below the threshold specified by the package.
#
# For ebuild authors: only use this eclass if you reaaalllllly have stupidly
# high build requirements. At an absolute minimum, you shouldn't be using this
# unless the ebuild needs >256MBytes RAM or >1GByte temporary or install space.
# The code should look something like:
#
# pkg_setup() {
#     # values in MBytes
#
#     # need this much memory (does *not* check swap)
#     CHECKREQS_MEMORY="256"
#
#     # need this much temporary build space
#     CHECKREQS_DISK_BUILD="2048"
#
#     # install will need this much space in /usr
#     CHECKREQS_DISK_USR="1024"
#
#     # install will need this much space in /var
#     CHECKREQS_DISK_VAR="1024"
#
#     # go!
#     check_reqs
# }
#
# You should *not* override the user's CHECKREQS_ACTION setting, nor should you
# attempt to provide a value if it is unset. Note that the environment variables
# are used rather than parameters for a few reasons:
#   * easier to do if use blah ; then things
#   * we might add in additional requirements things later
# If you don't specify a value for, say, CHECKREQS_MEMORY, then the test is not
# carried out.
#
# These checks should probably mostly work on non-Linux, and they should
# probably degrade gracefully if they don't. Probably.

inherit eutils


check_reqs() {
        [ -n "$1" ] && die "Usage: check_reqs"

        export CHECKREQS_NEED_SLEEP="" CHECKREQS_NEED_DIE=""
        if [ "$CHECKREQS_ACTION" != "ignore" ] ; then
                [ -n "$CHECKREQS_MEMORY" ] && check_build_memory
                [ -n "$CHECKREQS_DISK_BUILD" ] && check_build_disk \
                        "${PORTAGE_TMPDIR}" "\${PORTAGE_TMPDIR}" "${CHECKREQS_DISK_BUILD}"
                [ -n "$CHECKREQS_DISK_USR" ] && check_build_disk \
                        "${ROOT}/usr"  "\${ROOT}/usr" "${CHECKREQS_DISK_USR}"
                [ -n "$CHECKREQS_DISK_VAR" ] && check_build_disk \
                        "${ROOT}/var"  "\${ROOT}/var" "${CHECKREQS_DISK_VAR}"
        fi

        if [ -n "${CHECKREQS_NEED_SLEEP}" ] ; then
                echo
                ewarn "Bad things may happen! You may abort the build by pressing ctrl+c in"
                ewarn "the next 15 seconds."
                ewarn " "
                einfo "To make this kind of warning a fatal error, add a line to /etc/make.conf"
                einfo "setting CHECKREQS_ACTION=\"error\". To skip build requirements checking,"
                einfo "set CHECKREQS_ACTION=\"ignore\"."
                epause 15
        fi

        if [ -n "${CHECKREQS_NEED_DIE}" ] ; then
                eerror "Bailing out as specified by CHECKREQS_ACTION"
                die "Build requirements not met"
        fi
}

# internal use only!
check_build_memory() {
        [ -n "$1" ] && die "Usage: check_build_memory"
        check_build_msg_begin "${CHECKREQS_MEMORY}" "MBytes" "RAM"
        if [ -r /proc/meminfo ] ; then
                actual_memory=$(sed -n -e '/MemTotal:/s/^[^:]*: *\([0-9]\+\) kB/\1/p' \
                        /proc/meminfo)
        else
                actual_memory=$(sysctl hw.physmem 2>/dev/null )
                [ "$?" == "0" ] &&
                        actual_memory=$(echo $actual_memory | sed -e 's/^[^:=]*[:=]//' )
        fi
        if [ -n "${actual_memory}" ] ; then
                if [ ${actual_memory} -lt $((1024 * ${CHECKREQS_MEMORY})) ] ; then
                        eend 1
                        check_build_msg_ick "${CHECKREQS_MEMORY}" "MBytes" "RAM"
                else
                        eend 0
                fi
        else
                eend 1
                ewarn "Couldn't determine amount of memory, skipping ..."
        fi
}

# internal use only!
check_build_disk() {
        [ -z "$3" ] && die "Usage: check_build_disk where name needed"
        check_build_msg_begin "${3}" "MBytes" \
                        "disk space at ${2}"
        actual_space=$(df -Pm ${1} 2>/dev/null | sed -n \
                        '$s/\(\S\+\s\+\)\{3\}\([0-9]\+\).*/\2/p' 2>/dev/null )
        if [ "$?" == "0" ] && [ -n "${actual_space}" ] ; then
                if [ ${actual_space} -lt ${3} ] ; then
                        eend 1
                        check_build_msg_ick "${3}" "MBytes" \
                                        "disk space at ${2}"
                else
                        eend 0
                fi
        else
                eend 1
                ewarn "Couldn't figure out disk space, skipping ..."
        fi
}

# internal use only!
check_build_msg_begin() {
        ebegin "Checking for at least ${1}${2} ${3}"
}

# internal use only!
check_build_msg_skip() {
        ewarn "Skipping check for at least ${1}${2} ${3}"
}

# internal use only!
check_build_msg_ick() {
        if [ "${CHECKREQS_ACTION}" == "error" ] ; then
                eerror "Don't have at least ${1}${2} ${3}"
                echo
                export CHECKREQS_NEED_DIE="yes"
        else
                ewarn "Don't have at least ${1}${2} ${3}"
                echo
                export CHECKREQS_NEED_SLEEP="yes"
        fi
}

1	ciaranm	1.1	# Copyright 1999-2004 Gentoo Foundation
2			# Distributed under the terms of the GNU General Public License v2
3	chriswhite	1.1.1.1	# $Header: /var/cvsroot/gentoo-x86/eclass/check-reqs.eclass,v 1.4 2005/07/06 20:23:20 agriffis Exp $
4	ciaranm	1.1	#
5			# Original Author: Ciaran McCreesh <ciaranm@gentoo.org>
6			#
7			# This eclass provides a uniform way of handling ebuilds which have very high
8			# build requirements in terms of memory or disc space. It provides a function
9			# which should usually be called during pkg_setup().
10			#
11	chriswhite	1.1.1.1	# From a user perspective, the variable CHECKREQS_ACTION can be set to:
12	ciaranm	1.1	# * "warn" (default), which will display a warning and wait for 15s
13			# * "error", which will make the ebuild error out
14			# * "ignore", which will not take any action
15			# The chosen action only happens when the system's resources are detected
16			# correctly and only if they are below the threshold specified by the package.
17			#
18			# For ebuild authors: only use this eclass if you reaaalllllly have stupidly
19			# high build requirements. At an absolute minimum, you shouldn't be using this
20			# unless the ebuild needs >256MBytes RAM or >1GByte temporary or install space.
21			# The code should look something like:
22			#
23			# pkg_setup() {
24			# # values in MBytes
25			#
26			# # need this much memory (does not check swap)
27	chriswhite	1.1.1.1	# CHECKREQS_MEMORY="256"
28	ciaranm	1.1	#
29			# # need this much temporary build space
30	chriswhite	1.1.1.1	# CHECKREQS_DISK_BUILD="2048"
31	ciaranm	1.1	#
32			# # install will need this much space in /usr
33	chriswhite	1.1.1.1	# CHECKREQS_DISK_USR="1024"
34	ciaranm	1.1	#
35			# # install will need this much space in /var
36	chriswhite	1.1.1.1	# CHECKREQS_DISK_VAR="1024"
37	ciaranm	1.1	#
38			# # go!
39			# check_reqs
40			# }
41			#
42	chriswhite	1.1.1.1	# You should not override the user's CHECKREQS_ACTION setting, nor should you
43	ciaranm	1.1	# attempt to provide a value if it is unset. Note that the environment variables
44			# are used rather than parameters for a few reasons:
45			# * easier to do if use blah ; then things
46			# * we might add in additional requirements things later
47	chriswhite	1.1.1.1	# If you don't specify a value for, say, CHECKREQS_MEMORY, then the test is not
48	ciaranm	1.1	# carried out.
49			#
50			# These checks should probably mostly work on non-Linux, and they should
51			# probably degrade gracefully if they don't. Probably.
52
53			inherit eutils
54
55
56			check_reqs() {
57			[ -n "$1" ] && die "Usage: check_reqs"
58
59	chriswhite	1.1.1.1	export CHECKREQS_NEED_SLEEP="" CHECKREQS_NEED_DIE=""
60			if [ "$CHECKREQS_ACTION" != "ignore" ] ; then
61			[ -n "$CHECKREQS_MEMORY" ] && check_build_memory
62			[ -n "$CHECKREQS_DISK_BUILD" ] && check_build_disk \
63			"${PORTAGE_TMPDIR}" "\${PORTAGE_TMPDIR}" "${CHECKREQS_DISK_BUILD}"
64			[ -n "$CHECKREQS_DISK_USR" ] && check_build_disk \
65			"${ROOT}/usr" "\${ROOT}/usr" "${CHECKREQS_DISK_USR}"
66			[ -n "$CHECKREQS_DISK_VAR" ] && check_build_disk \
67			"${ROOT}/var" "\${ROOT}/var" "${CHECKREQS_DISK_VAR}"
68	ciaranm	1.1	fi
69
70	chriswhite	1.1.1.1	if [ -n "${CHECKREQS_NEED_SLEEP}" ] ; then
71	ciaranm	1.1	echo
72			ewarn "Bad things may happen! You may abort the build by pressing ctrl+c in"
73			ewarn "the next 15 seconds."
74			ewarn " "
75			einfo "To make this kind of warning a fatal error, add a line to /etc/make.conf"
76	chriswhite	1.1.1.1	einfo "setting CHECKREQS_ACTION=\"error\". To skip build requirements checking,"
77			einfo "set CHECKREQS_ACTION=\"ignore\"."
78	ciaranm	1.1	epause 15
79			fi
80
81	chriswhite	1.1.1.1	if [ -n "${CHECKREQS_NEED_DIE}" ] ; then
82			eerror "Bailing out as specified by CHECKREQS_ACTION"
83	ciaranm	1.1	die "Build requirements not met"
84			fi
85			}
86
87			# internal use only!
88			check_build_memory() {
89			[ -n "$1" ] && die "Usage: check_build_memory"
90	chriswhite	1.1.1.1	check_build_msg_begin "${CHECKREQS_MEMORY}" "MBytes" "RAM"
91	ciaranm	1.1	if [ -r /proc/meminfo ] ; then
92			actual_memory=$(sed -n -e '/MemTotal:/s/^[^:]: \([0-9]\+\) kB/\1/p' \
93			/proc/meminfo)
94			else
95			actual_memory=$(sysctl hw.physmem 2>/dev/null )
96			[ "$?" == "0" ] &&
97			actual_memory=$(echo $actual_memory \| sed -e 's/^[^:=]*[:=]//' )
98			fi
99			if [ -n "${actual_memory}" ] ; then
100	chriswhite	1.1.1.1	if [ ${actual_memory} -lt $((1024 * ${CHECKREQS_MEMORY})) ] ; then
101	ciaranm	1.1	eend 1
102	chriswhite	1.1.1.1	check_build_msg_ick "${CHECKREQS_MEMORY}" "MBytes" "RAM"
103	ciaranm	1.1	else
104			eend 0
105			fi
106			else
107			eend 1
108			ewarn "Couldn't determine amount of memory, skipping ..."
109			fi
110			}
111
112			# internal use only!
113			check_build_disk() {
114			[ -z "$3" ] && die "Usage: check_build_disk where name needed"
115			check_build_msg_begin "${3}" "MBytes" \
116			"disk space at ${2}"
117			actual_space=$(df -Pm ${1} 2>/dev/null \| sed -n \
118			'$s/\(\S\+\s\+\)\{3\}\([0-9]\+\).*/\2/p' 2>/dev/null )
119			if [ "$?" == "0" ] && [ -n "${actual_space}" ] ; then
120			if [ ${actual_space} -lt ${3} ] ; then
121			eend 1
122			check_build_msg_ick "${3}" "MBytes" \
123			"disk space at ${2}"
124			else
125			eend 0
126			fi
127			else
128			eend 1
129			ewarn "Couldn't figure out disk space, skipping ..."
130			fi
131			}
132
133			# internal use only!
134			check_build_msg_begin() {
135			ebegin "Checking for at least ${1}${2} ${3}"
136			}
137
138			# internal use only!
139			check_build_msg_skip() {
140			ewarn "Skipping check for at least ${1}${2} ${3}"
141			}
142
143			# internal use only!
144			check_build_msg_ick() {
145	chriswhite	1.1.1.1	if [ "${CHECKREQS_ACTION}" == "error" ] ; then
146	ciaranm	1.1	eerror "Don't have at least ${1}${2} ${3}"
147			echo
148	chriswhite	1.1.1.1	export CHECKREQS_NEED_DIE="yes"
149	ciaranm	1.1	else
150			ewarn "Don't have at least ${1}${2} ${3}"
151			echo
152	chriswhite	1.1.1.1	export CHECKREQS_NEED_SLEEP="yes"
153	ciaranm	1.1	fi
154			}
155