2 # Thierry Parmentelat - INRIA Sophia Antipolis
10 # this extracts all specfiles and computes .mk from specfiles
11 # you need to specify PLDISTRO here if relevant - see below
13 # for more info on how to invoke this stuff
15 #################### (fedora) distributions
17 # (*) as of nov. 2007, myplc-devel is deprecated
18 # (*) instead, we create a fresh vserver that holds required tools (see e.g. planetlab-devel.lst)
19 # (*) the build uses the current fedora version as a target for the produced images
20 # (*) so you simply need to create a fedora 8 build image for building fedora-8 images
22 #################### (planetlab) distributions
24 # (*) the default distribution is called 'planetlab'
25 # (*) you may define an alternative distribution, e.g. onelab
26 # in this case you need to
27 # (*) create onelab.mk that defines your *packages* (see below)
28 # (*) create onelab-tags.mk that defines where to fetch your *modules*
29 # (*) create your main yumgroups.xml as groups/<distro>.xml
30 # (*) there are also various places where a set of modules are defined.
31 # check for .lst files in the various modules that build root images
32 # and mimick what's done for planetlab
33 # (*) then you need to run
34 # make stage1=true PLDISTRO=onelab
37 # This build deals with 2 kinds of objects
39 # (*) packages are named upon the RPM name; they are moslty lowercase
40 # Add a package to ALL if you want it built as part of the default set.
41 # (*) modules are named after the subversion tree; as of this writing their names
42 # are mostly mixedcase like MyPLC or Vserverreference
44 #################### packages
45 # basics: how to build a package - you need/may define the following variables
48 # a package needs one or several modules to build.
51 # the package's specfile; this is relative to the FIRST module in package-MODULES
52 # see 'codebase' below
56 # (*) package-SPECVARS
57 # space-separated list of spec variable definitions, where you can reference make variable that relate to
58 # packages defined BEFORE the current one (note: you should use = - as opposed to := - to define these)
59 # e.g. mydriver-SPECVARS = foo=$(kernel-rpm-release)
60 # would let you use the %release from the kernel's package when rpmbuild'ing mydriver - see automatic below
62 # a set of *packages* that this package depends on
63 # (*) package-DEPENDFILES
64 # a set of files that the package depends on - and that make needs to know about
65 # if this contains RPMS/yumgroups.xml, then the toplevel RPMS's index
66 # is refreshed with createrepo prior to running rpmbuild
67 # (*) package-RPMFLAGS: Miscellaneous RPM flags
68 # (*) package-RPMBUILD: If not rpmbuild - mostly used for sudo'ing rpmbuild
70 #################### modules
71 # Required information about the various modules (set this in e.g. planetlab-tags.mk)
74 # the complete path where this module lies;
75 # you can specify the trunk or a given tag with this variable
77 # OR if the module is managed under cvs (will be obsoleted)
82 #################### automatic variables
84 # the build defines the following make variables - these are extracted from spec files
85 # (*) package-TARBALL : from the Source<n>: declaration
86 # example: kernel-i386-TARBALL = SOURCES/linux-2.6.20.tar.bz2
87 # (*) package-SOURCE :
88 # example: kernel-i386-SOURCE = SOURCES/linux-2.6.20
90 # example: kernel-i386-SRPM = SRPMS/kernel-2.6.20-1.2949.fc6.vs2.2.0.1.0.planetlab.src.rpm
92 # example: kernel-i386-RPM = \
93 # RPMS/i686/kernel-2.6.20-1.2949.fc6.vs2.2.0.1.0.planetlab.i686.rpm \
94 # RPMS/i686/kernel-devel-2.6.20-1.2949.fc6.vs2.2.0.1.0.planetlab.i686.rpm \
95 # RPMS/i686/kernel-vserver-2.6.20-1.2949.fc6.vs2.2.0.1.0.planetlab.i686.rpm \
96 # RPMS/i686/kernel-debuginfo-2.6.20-1.2949.fc6.vs2.2.0.1.0.planetlab.i686.rpm
97 # (*) package-rpm-name
98 # example: kernel-i386-rpm-name = kernel
99 # (*) package-rpm-release
100 # example: kernel-i386-rpm-release = 1.2949.fc6.vs2.2.0.1.0.planetlab
101 # (*) package-version
102 # example: kernel-i386-rpm-version = 2.6.20
103 # (*) package-subversion
104 # example: myplc-rpm-subversion = 15
110 HOSTARCH := $(shell uname -i)
111 DISTRO := $(shell ./getdistro.sh)
112 RELEASE := $(shell ./getrelease.sh)
114 #################### Makefile
120 PLDISTRO := planetlab
122 export CVS_RSH := ssh
124 ########## pldistro.mk holds PLDISTRO - it is generated at stage1 (see below)
129 #################### include onelab.mk
130 # describes the set of components
131 PLDISTROCONTENTS := $(PLDISTRO).mk
132 include $(PLDISTROCONTENTS)
134 #################### include <pldistro>-tags.mk
135 # describes where to fetch components, and the related tags if using cvs
136 PLDISTROTAGS := $(PLDISTRO)-tags.mk
137 include $(PLDISTROTAGS)
139 ########## stage1 and stage2
140 # extract specs and compute .mk files by running
142 # entering stage1, we compute all the spec files
143 # then we use stage2 to compute the .mk iteratively,
144 # ensuring that the n-1 first makefiles are loaded when creating the n-th one
145 # when stage2 is set, it is supposed to be an index (starting at 1) in $(ALL)
147 ALLMKS := $(foreach package, $(ALL), MAKE/$(package).mk)
149 ### stage2 : need some arithmetic, see
150 # http://www.cmcrossroads.com/articles/ask-mr.-make/learning-gnu-make-functions-with-arithmetic.html
152 # the first n packages
153 packages := $(wordlist 1,$(words $(stage2)),$(ALL))
155 package := $(word $(words $(packages)),$(packages))
156 # the n-1 first packages
157 stage2_1 := $(wordlist 2,$(words $(stage2)),$(stage2))
158 previous := $(wordlist 1,$(words $(stage2_1)),$(ALL))
159 previousmks := $(foreach package,$(previous),MAKE/$(package).mk)
160 include $(previousmks)
163 @echo "========== stage2 : $(package)"
164 # @echo "stage2 : included .mk files : $(previousmks)"
165 all: $($(package)_specpath)
166 all: MAKE/$(package).mk
172 @echo "========== stage1"
175 # specs and makes are done sequentially by stage2
178 arg=""; for n in $(ALL) ; do arg="$$arg x"; $(MAKE) --no-print-directory stage2="$$arg"; done
181 ### once .mks are OK, you can run make normally
194 # gather build information for the 'About' page
195 SOURCES/myplc-release:
196 @echo 'Creating myplc-release'
199 (echo -n 'Build bdate: ' ; date '+%Y.%m.%d') >> $@
200 (echo -n 'Build btime: ' ; date '+%H:%M') >> $@
201 (echo -n 'Build hostname: ' ; hostname) >> $@
202 (echo -n 'Build location: ' ; pwd) >> $@
203 (echo -n 'Build tags file: ' ; fgrep '$$''Id' $(PLDISTROTAGS)) >> $@
204 echo "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx modules versions info" >> $@
205 $(MAKE) --no-print-directory versions >> $@
209 # * to make configuration easier, we always use the first module's
210 # definitions (CVSROOT,TAG, or SVNPATH) to extract the spec file
211 # * for the same reason, in case cvs is used, the first module name is added to
212 # $(package)-SPEC - otherwise the cvs modules have to define spec as
213 # <module>/<module>.spec while svn modules just define it as <module>.spec
215 define stage1_variables
216 $(1)_spec = $(notdir $($(1)-SPEC))
217 $(1)_specpath = SPECS/$(notdir $($(1)-SPEC))
218 $(1)_module = $(firstword $($(1)-MODULES))
221 $(foreach package, $(ALL), $(eval $(call stage1_variables,$(package))))
224 # for each package, compute whether we need to set date (i.e. whether we use the trunk)
225 # the myplc package is forced to have a date, because it is more convenient
226 # (we cannot bump its number everytime something changes in the system)
228 define package_hasdate
229 $(1)_hasdate = $(if $(subst myplc,,$(1)), \
230 $(if $($(1)-SVNPATH),\
231 $(if $(findstring /trunk,$($(1)-SVNPATH)),yes,),\
232 $(if $(findstring HEAD,$($(1)-TAG)),yes,)), \
236 $(foreach package, $(ALL), $(eval $(call package_hasdate,$(package))))
238 ### extract spec file from scm
239 # usage: extract_spec_file package
240 # see early releases for comments on other possible implementations
241 # cannot use variables in such rules, we need to inline everything, sigh
245 (echo -n "# Generated by planetlab build from $($(1)-SPEC) on " ; date) > $($(1)_specpath)
246 echo "%define distroname $(DISTRO)" >> $($(1)_specpath)
247 echo "%define distrorelease $(RELEASE)" >> $($(1)_specpath)
248 echo "%define pldistro $(PLDISTRO)" >> $($(1)_specpath)
249 $(if $($(1)_hasdate),echo "%define date $(shell date +%Y.%m.%d)" >> $($(1)_specpath),)
250 echo "# included from codebase specfile" >> $($(1)_specpath)
251 $(if $($(1)-SPECVARS), \
252 $(foreach line,$($(1)-SPECVARS), \
253 echo "%define" $(word 1,$(subst =, ,$(line))) "$(word 2,$(subst =, ,$(line)))" >> $($(1)_specpath) ;))
254 $(if $($($(1)_module)-SVNPATH),\
255 svn cat $($($(1)_module)-SVNPATH)/$($(1)-SPEC) >> $($(1)_specpath),\
256 cvs -d $($($(1)_module)-CVSROOT) checkout \
257 -r $($($(1)_module)-TAG) \
258 -p $($(1)_module)/$($(1)-SPEC) >> $($(1)_specpath))
259 @if [ -z $($(1)_specpath) ] ; then rm $($(1)_specpath) ; exit 1 ; fi
262 $(foreach package,$(ALL),$(eval $(call target_spec,$(package))))
264 ### this utility allows to extract various info from a spec file
265 ### and to define them in makefiles
266 spec2make: spec2make.c
267 $(CC) -g -Wall $< -o $@ -lrpm -lrpmbuild
269 # Base rpmbuild in the current directory
270 # trying a longer topdir
271 # http://forums.fedoraforum.org/showthread.php?t=39625
272 # and more specifically post#6
274 export HOME := /building
276 rm -f /building ; ln -s /build /building
278 echo "%_topdir $(HOME)" >> $@
279 echo "%_tmppath $(HOME)/tmp" >> $@
280 echo "%_netsharedpath /proc:/dev/pts" >> $@
281 echo "%_install_langs C:de:en:es:fr" >> $@
283 ### run spec2make on the spec file and include the result
284 # usage: spec2make package
286 MAKE/$(1).mk: $($(1)_specpath) spec2make .rpmmacros
288 ./spec2make $($(1)-RPMFLAGS) $($(1)_specpath) $(1) > MAKE/$(1).mk
289 @if [ -z MAKE/$(1).mk ] ; then rm MAKE/$(1).mk ; exit 1 ; fi
292 $(foreach package,$(ALL),$(eval $(call target_mk,$(package))))
294 # stores PLDISTRO in a file
295 # this is done at stage1. later run wont get confused
297 echo "PLDISTRO:=$(PLDISTRO)" > $@
298 echo "PLDISTROTAGS:=$(PLDISTROTAGS)" >> $@
300 savepldistro: pldistro.mk
303 # always refresh this
307 ### pack sources into tarballs
308 ALLTARBALLS:= $(foreach package, $(ALL), $($(package)-TARBALL))
309 tarballs: $(ALLTARBALLS)
310 @echo $(words $(ALLTARBALLS)) source tarballs OK
313 SOURCES/%.tar.bz2: SOURCES/%
314 tar chpjf $@ -C SOURCES $*
316 SOURCES/%.tar.gz: SOURCES/%
317 tar chpzf $@ -C SOURCES $*
319 SOURCES/%.tgz: SOURCES/%
320 tar chpzf $@ -C SOURCES $*
323 URLS/%: url=$(subst @colon@,:,$(subst @slash@,/,$(notdir $@)))
324 URLS/%: basename=$(notdir $(url))
326 echo curl $(url) -o SOURCES/$(basename)
329 ### the directory SOURCES/<package>-<version> is made
330 # with a copy -rl from CODEBASES/<package>
331 # the former is $(package-SOURCE) and the latter is $(package-CODEBASE)
332 ALLSOURCES:=$(foreach package, $(ALL), $($(package)-SOURCE))
333 # so that make does not use the rule below directly for creating the tarball files
334 .SECONDARY: $(ALLSOURCES)
336 sources: $(ALLSOURCES)
337 @echo $(words $(ALLSOURCES)) versioned source trees OK
340 define target_link_codebase_sources
341 $($(1)-SOURCE): $($(1)-CODEBASE) ; mkdir -p SOURCES ; cp -rl $($(1)-CODEBASE) $($(1)-SOURCE)
344 $(foreach package,$(ALL),$(eval $(call target_link_codebase_sources,$(package))))
346 ### codebase extraction
347 ALLCODEBASES:=$(foreach package, $(ALL), $($(package)-CODEBASE))
348 # so that make does not use the rule below directly for creating the tarball files
349 .SECONDARY: $(ALLCODEBASES)
351 codebases : $(ALLCODEBASES)
352 @echo $(words $(ALLCODEBASES)) codebase OK
356 # usage: extract_single_module package
357 define extract_single_module
359 $(if $($($(1)_module)-SVNPATH), cd CODEBASES && svn export $($($(1)_module)-SVNPATH) $(1), cd CODEBASES && cvs -d $($($(1)_module)-CVSROOT) export -r $($($(1)_module)-TAG) -d $(1) $($(1)_module))
362 # usage: extract_multi_module package
363 define extract_multi_module
364 mkdir -p CODEBASES/$(1) && cd CODEBASES/$(1) && (\
365 $(foreach m,$($(1)-MODULES), $(if $($(m)-SVNPATH), svn export $($(m)-SVNPATH) $(m);, cvs -d $($(m)-CVSROOT) export -r $($(m)-TAG) $(m);)))
368 CODEBASES/%: package=$(notdir $@)
369 CODEBASES/%: multi_module=$(word 2,$($(package)-MODULES))
371 @(echo -n "XXXXXXXXXXXXXXX -- BEG CODEBASE $(package) : $@ " ; date)
372 $(if $(multi_module),\
373 $(call extract_multi_module,$(package)),\
374 $(call extract_single_module,$(package)))
375 @(echo -n "XXXXXXXXXXXXXXX -- END CODEBASE $(package) : $@ " ; date)
377 ### rpmbuild invokation
378 ALLRPMS:=$(foreach package,$(ALL),$($(package)-RPM))
380 @echo $(words $(ALLRPMS)) binary rpms OK
383 # usage: build_binary_rpm package
384 # xxx hacky - invoke createrepo if DEPENDFILES mentions RPMS/yumgroups.xml
385 define target_binary_rpm
386 $($(1)-RPM): $($(1)_specpath) $($(1)-TARBALL) .rpmmacros
387 mkdir -p BUILD RPMS tmp
388 @(echo -n "XXXXXXXXXXXXXXX -- BEG RPM $(1) " ; date)
389 $(if $(findstring RPMS/yumgroups.xml,$($(1)-DEPENDFILES)), createrepo --quiet -g yumgroups.xml RPMS/ , )
390 $(if $($(1)-RPMBUILD),\
391 $($(1)-RPMBUILD) $($(1)-RPMFLAGS) -bb $($(1)_specpath), \
392 $(RPMBUILD) $($(1)-RPMFLAGS) -bb $($(1)_specpath))
393 @(echo -n "XXXXXXXXXXXXXXX -- END RPM $(1) " ; date)
396 $(foreach package,$(ALL),$(eval $(call target_binary_rpm,$(package))))
399 ALLSRPMS:=$(foreach package,$(ALL),$($(package)-SRPM))
401 @echo $(words $(ALLSRPMS)) source rpms OK
404 # usage: target_source_rpm package
405 # select upon the package name, whether it contains srpm or not
406 define target_source_rpm
407 ifeq "$(subst srpm,,$(1))" "$(1)"
408 $($(1)-SRPM): $($(1)_specpath) .rpmmacros $($(1)-TARBALL)
409 mkdir -p BUILD SRPMS tmp
410 @(echo -n "XXXXXXXXXXXXXXX -- BEG SRPM $(1) " ; date)
411 $(if $($(1)-RPMBUILD),\
412 $($(1)-RPMBUILD) $($(1)-RPMFLAGS) -bs $($(1)_specpath),
413 $(RPMBUILD) $($(1)-RPMFLAGS) -bs $($(1)_specpath))
414 @(echo -n "XXXXXXXXXXXXXXX -- END SRPM $(1) " ; date)
416 $($(1)-SRPM): $($(1)_specpath) .rpmmacros $($(1)-CODEBASE)
417 mkdir -p BUILD SRPMS tmp
418 @(echo -n "XXXXXXXXXXXXXXX -- BEG SRPM $(1) (using make srpm) " ; date)
419 make -C $($(1)-CODEBASE) srpm && \
420 rm -f SRPMS/$(notdir $($(1)-SRPM)) && \
421 ln $($(1)-CODEBASE)/$(notdir $($(1)-SRPM)) SRPMS/$(notdir $($(1)-SRPM))
422 @(echo -n "XXXXXXXXXXXXXXX -- END SRPM $(1) " ; date)
426 $(foreach package,$(ALL),$(eval $(call target_source_rpm,$(package))))
428 ### RPMS/yumgroups.xml
430 YUMGROUPS := groups/$(PLDISTRO).xml
432 RPMS/yumgroups.xml: $(YUMGROUPS)
433 install -D -m 644 $(YUMGROUPS) $@
436 # e.g. make proper -> does propers rpms
437 # usage shorthand_target package
438 define target_shorthand
439 $(1): $($(package)-RPM)
441 $(1)-spec: $($(package)-SPEC)
443 $(1)-mk: $($(package)-MK)
445 $(1)-tarball: $($(package)-TARBALL)
447 $(1)-codebase: $($(package)-CODEBASE)
449 $(1)-source: $($(package)-SOURCE)
450 .PHONY: $(1)-codebase
451 $(1)-rpm: $($(package)-RPM)
453 $(1)-srpm: $($(package)-SRPM)
457 $(foreach package,$(ALL),$(eval $(call target_shorthand,$(package))))
460 define package_depends_on_file
465 define target_dependfiles
466 $(foreach file,$($(1)-DEPENDFILES),$(eval $(call package_depends_on_file,$(1),$(file))))
469 define package_depends_on_package
472 $($(1)-RPM):$($(2)-RPM)
475 define target_depends
476 $(foreach package,$($(1)-DEPENDS),$(eval $(call package_depends_on_package,$(1),$(package))))
479 $(foreach package,$(ALL),$(eval $(call target_depends,$(package))))
480 $(foreach package,$(ALL),$(eval $(call target_dependfiles,$(package))))
484 # usage: target_clean package
487 rm -rf $($(1)-CODEBASE)
488 .PHONY: $(1)-clean-codebase
489 CLEANS += $(1)-clean-codebase
491 rm -rf $($(1)-SOURCE)
492 .PHONY: $(1)-clean-source
493 CLEANS += $(1)-clean-source
495 rm -rf $($(1)-TARBALL)
496 .PHONY: $(1)-clean-tarball
497 CLEANS += $(1)-clean-tarball
499 rm -rf BUILD/$(notdir $($(1)-SOURCE))
500 CLEANS += $(1)-clean-build
503 .PHONY: $(1)-clean-rpm
504 CLEANS += $(1)-clean-rpm
507 .PHONY: $(1)-clean-srpm
508 CLEANS += $(1)-clean-srpm
509 $(1)-clean: $(1)-clean-codebase $(1)-clean-source $(1)-clean-tarball $(1)-clean-build $(1)-clean-rpm $(1)-clean-srpm
513 $(foreach package,$(ALL),$(eval $(call target_clean,$(package))))
521 @echo Available clean targets
524 ### brute force clean
526 rm -rf pldistro.mk .rpmmacros spec2make SPECS MAKE
528 rm -rf CODEBASES SOURCES BUILD RPMS SRPMS tmp
529 distclean: distclean1 distclean2
530 .PHONY: distclean1 distclean2 distclean
532 # xxx tmp - I cannot use this on my mac for local testing
533 ISMACOS=$(findstring Darwin,$(shell uname))
534 ifneq "$(ISMACOS)" ""
535 #################### produce reliable version information
537 VFORMAT="%30s := %s\n"
540 @$(if $($(1)-SVNPATH),\
541 printf $(VFORMAT) $(1)-SVNPATH "$($(1)-SVNPATH)",\
542 printf $(VFORMAT) $(1)-CVSROOT "$($(1)-CVSROOT)" ; printf $(VFORMAT) $(1)-TAG "$($(1)-TAG)")
545 # compute all modules
547 $(foreach package,$(ALL), $(eval ALL-MODULES+=$($(package)-MODULES)))
548 ALL-MODULES:=$(sort $(ALL-MODULES))
550 $(foreach module,$(ALL-MODULES), $(eval $(call print_version,$(module))))
552 versions: $(foreach module, $(ALL-MODULES), $(module)-version)
555 @echo "warning : the 'versions' target is not supported on macos"
558 #################### include install Makefile
559 # the default is to use the distro-dependent install file
560 # however the main distro file can redefine PLDISTROINSTALL
561 ifndef PLDISTROINSTALL
562 PLDISTROINSTALL := $(PLDISTRO)-install.mk
565 -include $(PLDISTROINSTALL)
569 @echo "Known pakages are"
571 @echo "Run make in two stages:"
573 @echo "make stage1=true PLDISTRO=onelab"
574 @echo " -> extracts all spec files in SPECS/ and mk files in MAKE/"
575 @echo " as well as save PLDISTRO for subsequent runs"
577 @echo "Then you can use the following targets"
579 @echo " rebuilds everything"
580 @echo '$ make util-vserver'
581 @echo " makes the RPMS related to util-vserver"
582 @echo " equivalent to 'make util-vserver-rpm'"
584 @echo "Or, vertically - step-by-step for a given package"
585 @echo '$ make util-vserver-codebase'
586 @echo " performs codebase extraction in CODEBASES/util-vserver"
587 @echo '$ make util-vserver-source'
588 @echo " creates source link in SOURCES/util-vserver-<version>"
589 @echo '$ make util-vserver-tarball'
590 @echo " creates source tarball in SOURCES/util-vserver-<version>.<tarextension>"
591 @echo '$ make util-vserver-rpm'
592 @echo " build rpm(s) in RPMS/"
593 @echo '$ make util-vserver-srpm'
594 @echo " build source rpm in SRPMS/"
596 @echo "Or, horizontally, reach a step for all known packages"
597 @echo '$ make codebases'
598 @echo '$ make sources'
599 @echo '$ make tarballs'
603 @echo "Cleaning examples"
605 @echo " removes the files made by make"
606 @echo "$ make distclean"
607 @echo " brute-force cleaning, removes entire directories - requires a new stage1"
608 @echo "$ make util-vserver-clean"
609 @echo " removes codebase, source, tarball, build, rpm and srpm for util-vserver"
610 @echo "$ make util-vserver-clean-codebase"
611 @echo " and so on for source, tarball, build, rpm and srpm"
613 #################### convenience, for debugging only
614 # make +foo : prints the value of $(foo)
615 # make ++foo : idem but verbose, i.e. foo=$(foo)
616 ++%: varname=$(subst +,,$@)
618 @echo "$(varname)=$($(varname))"
619 +%: varname=$(subst +,,$@)
621 @echo "$($(varname))"