source: ProjectBuilder/devel/pbmkbm/bin/pbmkbm@ 1671

Last change on this file since 1671 was 1671, checked in by Bruno Cornec, 11 years ago

r4928@localhost: bruno | 2012-06-07 19:07:57 +0200

  • pbmkbm now support terminfo and stop on error (off by default)
File size: 18.6 KB
Line 
1#!/usr/bin/perl -w
2#
3# pbmkbm, a project-builder.org utility to make boot media
4#
5# $Id$
6#
7# Copyright B. Cornec 2011
8# Provided under the GPL v2
9
10# Syntax: see at end
11
12use strict 'vars';
13use Getopt::Long qw(:config auto_abbrev no_ignore_case);
14use Carp qw/confess cluck/;
15use Data::Dumper;
16use English;
17use File::Basename;
18use File::Copy;
19use File::Find;
20use POSIX qw(strftime);
21
22use ProjectBuilder::Version;
23use ProjectBuilder::Base;
24use ProjectBuilder::Env;
25use ProjectBuilder::Conf;
26use ProjectBuilder::Distribution;
27use ProjectBuilder::VE;
28
29# Global variables
30my %opts; # CLI Options
31
32=pod
33
34=head1 NAME
35
36pbmkbm - a project-builder.org utility to make boot media
37
38=head1 DESCRIPTION
39
40pbmkbm creates a bootable media (CD/DVD, USB device, Network, tape, ...)
41with a minimal distribution in it, suited for building packages for example.
42It aims at supporting all distributions supported by project-builder.org
43(RHEL, RH, Fedora, OpeSUSE, SLES, Mandriva, ...)
44
45It is inspired by work done by Jean-Marc André around the HP SSSTK and
46aim at replacing the mindi project (http://www.mondorescue.org), but
47fully integrated with project-builder.org
48
49pbmkbm works in different phases. The first one is to check all
50
51pbmkbm needs to gather a certain number of components that could come
52from various sources and could be put on a different target media.
53We need a kernel, an initrd/initramfs for additional modules and init script,
54a root filesystem and a boot configuration file.
55Kernel, modules could come either from the local installed system
56(typically for disaster recovery context) or from a kernel package of a
57given configuration or a referenced content.
58Utilities could come from busybox, local utilities or set of packages.
59The root filesystem is made with them.
60The initrd/initramfs could be made internaly or by calling dracut.
61The boot config file is generated from analysis content or provided externally.
62
63=head1 SYNOPSIS
64
65pbmkbm [-vhq][-t boot-type [-d device]][-b boot-method][-m os-ver-arch]
66[-s script][-a pkg1[,pkg2,...]] [target-dir]
67
68pbmkbm [--verbose][--help][--man][--quiet][--type boot-type [--device device]]
69[--machine os-ver-arch][--boot boot-method]
70[--script script][--add pkg1,[pkg2,...]] [target-dir]
71
72=head1 OPTIONS
73
74=over 4
75
76=item B<-v|--verbose>
77
78Print a brief help message and exits.
79
80=item B<-h|--help>
81
82Print a brief help message and exits.
83
84=item B<--man>
85
86Prints the manual page and exits.
87
88=item B<-q|--quiet>
89
90Do not print any output.
91
92=item B<-t|--type boot-type>
93
94Type of the boot device to generate. A boot-type can be:
95
96=over 4
97
98=item B<iso>
99
100Generate an ISO9660 image format (suitable to be burned later on or loopback mounted. Uses isolinux.
101
102=item B<usb>
103
104Generate a USB image format (typically a key of external hard drive). Uses syslinux.
105
106=item B<pxe>
107
108Generate a PXE environement (suitable to be integrated in a PXElinux configuration). Uses pxelinux.
109
110=back
111
112=item B<-d|--device device-file>
113
114Name of the device or file on which you want to create the boot media.
115
116=item B<-b|--boot boot-method>
117
118This is the boot method to use to create the boot media. A boot-method can be:
119
120=over 4
121
122=item B<native>
123
124Use the tools of the native distribution to create the boot media. No other dependency.
125
126=item B<ve>
127
128Use the project-builder.org virtual environment notion to create the boot media. No other dependency outside of the project.
129
130=item B<busybox>
131
132Use the busybox tool to create the boot media. Cf: L<http://www.busybox.net>
133
134=item B<dracut>
135
136Use the dracut tool to create the boot media. Cf: L<http://www.dracut.net>
137
138=back
139
140=item B<-s|--script script>
141
142Name of the script you want to execute on the related boot media at the end of the build.
143
144=item B<-a|--add pkg1[,pkg2,...]>
145
146Additional packages to add from the distribution you want to install on the related boot media
147at the end of the build.
148
149=item B<-m|--machine os-ver-arch>
150
151This is the target tuple operating system-version-architecture for which you want to create the boot media.
152
153=back
154
155=head1 ARGUMENTS
156
157target-dir is the directory under which the boot media will be build.
158
159=over 4
160
161=back
162
163=head1 EXAMPLE
164
165To setup a USB busybox based boot media on the /dev/sdb device for a Fedora 12 distribution with an i386 architecture issue:
166
167pbmkbm -t usb -d /dev/sdb -m fedora-12-i386 -b busybox
168
169To setup an ISO image under /tmp for a RHEL 6 x86_64 distribution issue using the native environment:
170
171pbmkbm -t iso -d /tmp -m rhel-6-x86_64 -b ve
172
173=head1 WEB SITES
174
175The main Web site of the project is available at L<http://www.project-builder.org/>.
176Bug reports should be filled using the trac instance of the project at L<http://trac.project-builder.org/>.
177
178=head1 USER MAILING LIST
179
180Cf: L<http://www.mondorescue.org/sympa/info/pb-announce> for announces and
181L<http://www.mondorescue.org/sympa/info/pb-devel> for the development of the pb project.
182
183=head1 CONFIGURATION FILE
184
185Uses Project-Builder.org configuration file (/etc/pb/pb.conf or /usr/local/etc/pb/pb.conf)
186
187=head1 AUTHORS
188
189The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
190
191=head1 COPYRIGHT
192
193Project-Builder.org is distributed under the GPL v2.0 license
194described in the file C<COPYING> included with the distribution.
195
196=cut
197
198# ---------------------------------------------------------------------------
199
200my ($projectbuilderver,$projectbuilderrev) = pb_version_init();
201my $appname = "pbmkbm";
202$ENV{'PBPROJ'} = $appname;
203
204$Global::pb_stop_on_error = 0; # False by default
205
206# Initialize the syntax string
207
208pb_syntax_init("$appname Version $projectbuilderver-$projectbuilderrev\n");
209pb_temp_init();
210
211GetOptions("help|?|h" => \$opts{'h'},
212 "man" => \$opts{'man'},
213 "verbose|v+" => \$opts{'v'},
214 "quiet|q" => \$opts{'q'},
215 "log-files|l=s" => \$opts{'l'},
216 "script|s=s" => \$opts{'s'},
217 "machine|m=s" => \$opts{'m'},
218 "add|a=s" => \$opts{'a'},
219 "device|d=s" => \$opts{'d'},
220 "type|t=s" => \$opts{'t'},
221 "boot|b=s" => \$opts{'b'},
222 "version|V=s" => \$opts{'V'},
223 "stop-on-error!" => \$Global::pb_stop_on_error,
224) || pb_syntax(-1,0);
225
226if (defined $opts{'h'}) {
227 pb_syntax(0,1);
228}
229if (defined $opts{'man'}) {
230 pb_syntax(0,2);
231}
232if (defined $opts{'v'}) {
233 $pbdebug = $opts{'v'};
234}
235if (defined $opts{'q'}) {
236 $pbdebug=-1;
237}
238if (defined $opts{'l'}) {
239 open(pbLOG,"> $opts{'l'}") || die "Unable to log to $opts{'l'}: $!";
240 $pbLOG = \*pbLOG;
241 $pbdebug = 0 if ($pbdebug == -1);
242}
243pb_log_init($pbdebug, $pbLOG);
244pb_log(1,"$appname Version $projectbuilderver-$projectbuilderrev\n");
245my @date = pb_get_date();
246my $pbdate = strftime("%Y-%m-%d %H:%M:%S", @date);
247
248pb_log(1,"Start: $pbdate\n");
249
250# Get VE name
251$ENV{'PBV'} = $opts{'m'};
252
253#
254# Initialize distribution info from pb conf file
255#
256my $pbos = pb_distro_get_context($ENV{'PBV'});
257pb_log(0,"Starting boot media build for $pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}\n");
258
259pb_env_init_pbrc(); # to get content of HOME/.pbrc
260
261# Global hash containing all the configuration information
262my %mkbm;
263
264#
265# Check target dir
266# Create if not existent and use default if none given
267#
268$mkbm{'targetdir'} = shift @ARGV;
269
270#
271# Check for command requirements
272#
273my ($req,$opt,$pbstoponerr) = pb_conf_get_if("oscmd","oscmdopt","pbstoponerr");
274$Global::pb_stop_on_error = 1 if ((defined $pbstoponerr) && (defined $pbstoponerr->{$ENV{'PBPROJ'}}) && ($pbstoponerr->{$ENV{'PBPROJ'}} =~ /true/oi));
275#pb_check_requirements($req,$opt,$appname);
276
277# After that we will need root access
278die "$appname needs to be run as root" if ($EFFECTIVE_USER_ID != 0);
279
280#
281# Where is our build target directory
282#
283if (not defined $mkbm{'targetdir'}) {
284 $mkbm{'targetdir'} = "/var/cache/pbmkbm";
285 my ($vestdpath) = pb_conf_get("mkbmpath");
286 $mkbm{'targetdir'} = "$vestdpath->{'default'}/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}" if (defined $vestdpath->{'default'});
287 pb_log(1,"No target-dir specified, using $mkbm{'targetdir'}\n");
288}
289
290# Point to the right subdir and create it if needed
291pb_mkdir_p($mkbm{'targetdir'}) if (! -d $mkbm{'targetdir'});
292
293# Log information on our system
294# TODO: this should be put in a subfunction
295my ($logcmd) = pb_conf_get("logcmd");
296my ($logopt) = pb_conf_get_if("logopt");
297# check that the command is there first and then use it.
298if ($logcmd->{$appname} ne "internal") {
299 $logcmd = pb_check_req($logcmd->{$appname},1);
300 if (not defined $logcmd) {
301 pb_log(1,"INFO: command $logcmd->{$appname} doesn't exist. No log report is available\n");
302 } else {
303 my $c = $logcmd->{$appname};
304 $c .= " $logopt->{$appname}" if (defined $logopt->{$appname});
305 pb_system("$c","Creating a log report of your system");
306 }
307} else {
308 # We provide our own internal log reporter as a std one isn't found
309 my ($lcmds,$lfiles) = pb_conf_get_if("logcommands","logfiles");
310 pb_log(1,"------------------\n");
311 if (defined $lcmds->{$appname}) {
312 foreach my $c (split(/,/,$lcmds->{$appname})) {
313 my $lcmd = $c;
314 $lcmd =~ s/ .*$//;
315 $lcmd = pb_check_req($lcmd,1);
316 if (not defined $lcmd) {
317 pb_log(1,"INFO: command $c doesn't exist\n");
318 pb_log(1,"------------------\n");
319 next;
320 }
321 pb_log(1,"Execution of $c\n");
322 pb_log(1,"------------------\n");
323 pb_system($c,"",1);
324 pb_log(1,"------------------\n");
325 }
326 }
327 if (defined $lfiles->{$appname}) {
328 foreach my $f (split(/,/,$lfiles->{$appname})) {
329 if (! -e $f) {
330 pb_log(1,"INFO: $f doesn't exist\n");
331 pb_log(1,"------------------\n");
332 next;
333 }
334 if (! -r $f) {
335 pb_log(1,"INFO: $f isn't readable\n");
336 pb_log(1,"------------------\n");
337 next;
338 }
339 if ((-f $f) || (-l $f)) {
340 if (! open(FILE,$f)) {
341 pb_log(1,"INFO: Unable to open $f\n");
342 pb_log(1,"------------------\n");
343 next;
344 }
345 pb_log(1,"Content of $f\n");
346 pb_log(1,"------------------\n");
347 while (<FILE>) {
348 pb_log(1,$_);
349 }
350 close(FILE);
351 pb_log(1,"------------------\n");
352 } elsif (-d $f) {
353 my $dh;
354 if (! opendir($dh,$f)) {
355 pb_log(1,"INFO: Unable to opendir $f\n");
356 pb_log(1,"------------------\n");
357 next;
358 }
359 pb_log(1,"Content of directory $f\n");
360 pb_log(1,"----------------------------\n");
361 while (readdir $dh) {
362 my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,$atime,$mtime,$ctime,$blksize,$blocks) = stat("$f/$_");
363 my $str = sprintf("%10s %2s %5s %5s %10s %14s %s",$mode,$ino,$uid,$gid,$size,$mtime,$_);
364 pb_log(1,"$str\n");
365 }
366 closedir($dh);
367 pb_log(1,"------------------\n");
368 } else {
369 pb_log(1,"INFO: $f is special\n");
370 pb_log(1,"------------------\n");
371 }
372 }
373 }
374}
375
376# Now the preparation is over, we need to do something useful :-)
377# But it all depends on how we're asked to do it.
378#
379# First we need to copy into the target dir all the relevant content
380pb_mkbm_create_content();
381
382# Then we need to package this content in the destination format
383pb_mkbm_create_media();
384
385@date = pb_get_date();
386$pbdate = strftime("%Y-%m-%d %H:%M:%S", @date);
387
388pb_log(1,"End: $pbdate\n");
389
390pb_exit();
391
392sub pb_mkbm_create_content {
393
394pb_log(1,"Creating boot media content\n");
395
396# If not defined use VE mode by default
397$opts{'b'} = "ve" if (not defined $opts{'b'});
398
399# Hash of target content
400# atribute could be, copy, remove, link, dir
401my %targettree;
402
403if ($opts{'b'} eq "ve") {
404 # Use project-builder VE mecanism to create a good VE !
405 pb_ve_launch($ENV{'PBV'},1);
406} elsif ($opts{'b'} eq "native") {
407 # Use native tools to create a good VE !
408} elsif ($opts{'b'} eq "drakut") {
409 # Use drakut to create a good VE !
410} elsif ($opts{'b'} eq "busybox") {
411 # Use busybox to create a good VE !
412 pb_mkbm_create_busybox_ve(\%targettree);
413} else {
414 die "Unknown method $opts{'b'} used to create the media content";
415}
416
417# Create the directory structure needed on the target dir
418my ($tdirs,$bdirs,$bfiles,$bcmds) = pb_distro_get_param($pbos,pb_conf_get("mkbmtargetdirs","mkbmbootdirs","mkbmbootfiles","mkbmbootcmds"));
419# Create empty dirs for these
420foreach my $d (split(/,/,$tdirs)) {
421 $targettree{$d} = "emptydir";
422}
423# And copy dirs for those
424foreach my $d (split(/,/,$bdirs)) {
425 if (-d $d) {
426 $targettree{$d} = "recurdir";
427 } elsif (-l $d) {
428 $targettree{$d} = "link:$d";
429 } else {
430 pb_log(1,"INFO: Directory $d doesn't exist\n");
431 }
432}
433foreach my $f (split(/,/,$bfiles)) {
434 $targettree{$f} = "file";
435}
436# Once the environment is made, add what is needed for this boot media to it.
437# Keyboard
438pb_mkbm_find_keyboard(\%targettree);
439# Terminfo
440pb_mkbm_find_terminfo(\%targettree);
441# List of commands
442# List of dependencies
443# Kernel - We use 2 objects, the running kernel and the target kernel which could be different
444my %rkernel;
445my %tkernel;
446pb_mkbm_find_kernel(\%rkernel);
447# Initrd
448# init
449# BootLoader and its configuration
450# Additional data files coming from a potential caller (MondoRescue/Mindi e.g. with fstab, LVM, mountlist, ...)
451pb_log(1,"INFO: Target Tree is now: ".Dumper(%targettree)."\n");
452pb_log(1,"End of boot media creation\n");
453}
454
455sub pb_mkbm_create_busybox_ve {
456
457my $tgtree = shift;
458
459pb_log(1,"Analyzing your busybox's configuration\n");
460# First, check which are the supported command in that version of busybox
461# and create the links for it in the target VE
462
463my $busycmd = pb_distro_get_param($pbos,pb_conf_get("ospathcmd-busybox"));
464open(BUSY,"$busycmd |") || die "Unable to execute $busycmd";
465my $cmdlist = 0;
466while (<BUSY>) {
467 pb_log(3,"busybox line : $_");
468 chomp($_);
469 # After these words, we have the list of functions, so trigger their analysis
470 if ($_ =~ /defined functions:/) {
471 $cmdlist = 1;
472 next;
473 }
474 # Analyse the list of commands provided by that busybox (, separated)
475 if ($cmdlist == 1) {
476 pb_log(3,"Analyzing that busybox line\n");
477 foreach my $c (split(/,/,$_)) {
478 $c =~ s/\s*//g;
479 # skip empty strings
480 next if ($c =~ /^$/);
481 my $c1 = pb_check_req($c,0);
482 if (defined $c1) {
483 $tgtree->{$c1} = "link:$busycmd";
484 } else {
485 # When not found on the system, create the link under /usr/bin by default
486 $tgtree->{"/usr/bin/$c"} = "link:$busycmd";
487 }
488 }
489 }
490}
491pb_log(1,"Target Tree is now: ".Dumper($tgtree)."\n");
492close(BUSY);
493pb_log(1,"End of busybox analysis\n");
494}
495
496sub pb_mkbm_find_keyboard {
497
498my $tgtree = shift;
499
500pb_log(1,"Analyzing your keyboard's configuration\n");
501my $keyfile = pb_distro_get_param($pbos,pb_conf_get("ospathcmd-keyfile"));
502die "Unable to read the keyfile $keyfile" if ((not defined $keyfile) || (! -r $keyfile));
503my $keymapdir = pb_distro_get_param($pbos,pb_conf_get("ospathcmd-keymapdir"));
504die "Unable to read the keymapdir $keymapdir" if ((not defined $keymapdir) || (! -d $keymapdir));
505my $keymapre = pb_distro_get_param($pbos,pb_conf_get("ospathcmd-keymapre"));
506die "Unable to read the keymapre $keymapre" if (not defined $keymapre);
507
508# if a direct keymap file is given as keyfile, use only the first existing one and return
509my $foundkmap = 0;
510foreach my $f (split(/,/,$keyfile)) {
511 next if ($f !~ /\.gz$/);
512 $foundkmap = 1;
513 if (-l $f) {
514 $tgtree->{$f} = "link:$f";
515 pb_log(1,"Using Keymap file $f\n");
516 last;
517 } elsif (-r $f) {
518 $tgtree->{$f} = "file";
519 pb_log(1,"Using Keymap file $f\n");
520 last;
521 } else {
522 next;
523 }
524}
525return() if ($foundkmap eq 1);
526
527pb_log(1,"Using Keyfile $keyfile and Keymap directory $keymapdir\n");
528my $locale="";
529open(KEYMAP,"$keyfile") || die "Unable to read $keyfile";
530# Depending on the format of the keymap we look for various strings
531while (<KEYMAP>) {
532 $locale =~ $keymapre;
533}
534close(KEYMAP);
535pb_log(1,"Found locale $locale\n");
536
537pb_log(1,"End of keyboard analysis\n");
538}
539
540sub pb_mkbm_find_terminfo {
541
542my $tgtree = shift;
543
544pb_log(1,"Analyzing your terminfo's configuration\n");
545my $termdir = pb_distro_get_param($pbos,pb_conf_get("ospathcmd-termdir"));
546die "Unable to read the keymapdir $termdir" if ((not defined $termdir) || (! -d $termdir));
547$tgtree->{$termdir} = "recurdir";
548
549pb_log(1,"End of terminfo analysis\n");
550}
551
552sub pb_mkbm_find_kernel {
553
554my $kernel = shift;
555
556pb_log(1,"Analyzing your kernel's configuration\n");
557$kernel->{"is_xen"} = undef;
558# See if we're booted from a Xen kernel
559# From http://wiki.xensource.com/xenwiki/XenCommonProblems#head-26434581604cc8357d9762aaaf040e8d87b37752
560if ( -f "/proc/xen/capabilities") {
561 # It's a Xen kernel
562 pb_log(2,"INFO: We found a Xen Kernel running\n");
563 $kernel->{"is_xen"} = 1;
564}
565$kernel->{"release"} = pb_get_osrelease();
566
567my $kfile = pb_distro_get_param($pbos,pb_conf_get_if("mkbmkernelfile"));
568if ((defined $kfile) && ($kfile ne "")) {
569 pb_log(1,"INFO: You specified your kernel as $kfile, so using it\n");
570 $kernel->{"file"} = $kfile;
571} else {
572 $kernel->{"dir"} = pb_distro_get_param($pbos,pb_conf_get("mkbmkerneldir"));
573 die "ERROR: The mkbmkerneldir content ($kernel->{'dir'}) doesn't refer to a directory\n" if (! -d $kernel->{"dir"});
574 pb_log(1,"INFO: Analyzing directory $kernel->{'dir'} to find your kernel\n");
575 $kernel->{"namere"} = pb_distro_get_param($pbos,pb_conf_get("mkbmkernelnamere"));
576
577 # TODO: Look at a better way to find the name of the kernel we run
578 # look at /proc/sys/kernel/bootloader_type /proc/sys/kernel/bootloader_version
579 # to have a better guess
580 my $dh;
581 die "ERROR: Unable to open the mkbmkerneldir content ($kernel->{'dir'})\n" if (! opendir($dh,$kernel->{"dir"}));
582 while (readdir $dh) {
583 pb_log(3,"Potential kernel file: $_\n");
584 # Skip non-files
585 next if (! -f "$kernel->{'dir'}/$_");
586 # Skip files not correpsonding to the RE planned
587 next if ($_ !~ /$kernel->{"namere"}/);
588 # We now have a candidate. Analyze further
589 pb_log(3,"Potential kernel file 2: $_\n");
590 eval
591 {
592 require File::MimeInfo;
593 File::MimeInfo->import();
594 };
595 if ($@) {
596 # File::MimeInfo not found
597 die("ERROR: Install File::MimeInfo to handle kernel file detection\n");
598 }
599 my $mm = mimetype("$kernel->{'dir'}/$_");
600 # Skip symlinks
601 next if ($mm =~ /inode\/symlink/);
602 pb_log(2,"file $_ mimetype: $mm\n");
603 if ($mm =~ /\/x-gzip/) {
604 # on ia64 kernel are gzip compressed
605 }
606 next if (pb_get_content("$kernel->{'dir'}/$_") !~ /$kernel->{"release"}/);
607 pb_log(3,"Potential kernel file 3: $_\n");
608 $kernel->{"file"} = "$kernel->{'dir'}/$_";
609 #my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,$atime,$mtime,$ctime,$blksize,$blocks) = stat("$f/$_");
610 }
611 closedir($dh);
612}
613pb_log(1,"INFO: kernel is ".Dumper($kernel)."\n");
614pb_log(1,"End of kernel analysis\n");
615}
616
617sub pb_mkbm_create_media {
618
619}
620
621# Get the package list to download, store them in a cache directory
622#
623#my ($mkbmcachedir) = pb_conf_get_if("mkbmcachedir");
624#my ($pkgs) = pb_distro_get_param($pbos,pb_conf_get("mkbmmindep"));
625
626#
627# /proc needed
628#
629#pb_system("mount -o bind /proc $targetdir/proc","Mounting /proc");
630
631# Installed additional packages we were asked to
632#if (defined $opts{'a'}) {
633#$opts{'a'} =~ s/,/ /g;
634#pb_system("chroot $targetdir /bin/bash -c \"$pbos->{'install'} $opts{'a'} \"","Adding packages to OS by running $pbos->{'install'} $opts{'a'}");
635#}
636
637#
638# Clean up
639#
640#pb_log(1,"Cleaning up\n");
641#pb_system("umount $targetdir/proc","Unmounting /proc");
642
643# Executes post-install step if asked for
644#if ($opts{'s'}) {
645#pb_system("$opts{'s'} $targetdir","Executing the post-install script: $opts{'s'} $targetdir");
646#}
Note: See TracBrowser for help on using the repository browser.