+Installation doc.
[biosautoraid.git] / biosautoraid.pl
1 #! /usr/bin/perl
2 use strict;
3 use warnings;
4 use bytes;
5 use Getopt::Long;
6 use Fcntl qw(SEEK_SET);
7
8
9 sub signature($$$$;$)
10 {
11 my($hay,$hay_filename,$offset,$needle,$msg)=@_;
12
13         die if length($needle)%1;
14         my $len_bytes=length($needle)/2;
15         substr($hay,$offset,$len_bytes) eq pack("H*",$needle)
16                         or die "\"$hay_filename\" error reading signature 0x$needle @".sprintf("0x%X",$offset)
17                                         .(!$msg ? "" : "; $msg")."\n";
18 }
19
20 my $BACKUP_SECTOR_START=63;
21 my $MAX_BOOT_SIZE=0x1b6;        # LILO: leave some space for NT's and DR DOS' dirty
22
23
24 my $bin_filename="./biosautoraid.bin";
25 my $opt_install;
26 my $opt_uninstall;
27 my $options_error=!GetOptions(
28                 "bin=s"      ,\$bin_filename,
29                 "i|install"  ,\$opt_install,
30                 "u|uninstall",\$opt_uninstall,
31                 );
32 my $BIN;
33 open $BIN,$bin_filename or die "open \"$bin_filename\": $!";
34 my $bin=do { local $/; <$BIN>; } or die "read \"$bin_filename\": $!";
35 close $BIN or die "close \"$bin_filename\": $!";
36
37 my $bin_len=length($bin);
38 $bin_len>0 && !($bin_len%0x200) or die "Invalid length of \"$bin_filename\": $bin_len";
39 my $bin_short=($bin_len==0x200);        # => no 0xBEEF
40
41 signature $bin,$bin_filename,0x1FE     ,"55AA";
42 substr($bin,$MAX_BOOT_SIZE,0x1FE-$MAX_BOOT_SIZE)=~/^\x00*$/s or die "No empty magic+partitiontable: $bin_filename";
43
44 if (substr($bin,3,8) eq "BIOSRAID") {
45         signature $bin,$bin_filename,0x03      ,unpack("H*","BIOSRAID");
46         signature $bin,$bin_filename,0x43      ,"5E81A2".sprintf("%X",$BACKUP_SECTOR_START);
47         signature $bin,$bin_filename,$bin_len-2,"BEEF" if !$bin_short;
48         }
49 else {
50         signature $bin,$bin_filename,0x03      ,unpack("H*","BIOSRAI2")
51                         .sprintf("%X%X",$BACKUP_SECTOR_START,$MAX_BOOT_SIZE-0x100);
52         }
53
54 my $all_ok;
55 END {
56         warn "Syntax: $0 [--bin=<biosautoraid.bin>] [{-i|--install|-u|--uninstall} <device>]" if !$all_ok;
57         }
58
59 if (!@ARGV && !$options_error) {
60         print "OK, \"$bin_filename\" checked.\n";
61         $all_ok=1;
62         exit 0;
63         }
64
65 die "Type -i|--install or -u|--uninstall"                     if (!$opt_install && !$opt_uninstall) || $options_error;
66 die "Both -i|--install and -u|--uninstall forbidden together" if   $opt_install &&  $opt_uninstall;
67
68 @ARGV<=1 or die;
69 my $master_filename=$ARGV[0];
70
71 my $master_is_b=(-b $master_filename);
72 my $master_is_f=(-f $master_filename);
73 die "Invalid device file type: $master_filename" if !$master_is_b && !$master_is_f;
74 my $backup_filename;
75 my $backup_offset=$BACKUP_SECTOR_START*0x200;
76 if ($master_is_f) {
77         $backup_filename=$master_filename;
78         }
79 if ($master_is_b) {
80         die "Filename is block device but it is unsupported: $master_filename"
81                         if $master_filename!~m{^/dev/[hs]d[a-z]};
82         $backup_filename=$master_filename."1";
83
84         sub hdparm_g_start_check($$)
85         {
86         my($filename,$start_expected)=@_;
87         
88                 local *HDPARM;
89                 my $cmdname="hdparm -g '$filename'|";
90                 open HDPARM,$cmdname or die "open \"$cmdname\": $!";
91                 my $HDPARM=do { local $/; <HDPARM>; } or die "read \"$cmdname\": $!";
92                 close HDPARM or die "close \"$cmdname\": $!";
93                 my($start)=($HDPARM=~/^\s*\Q$filename\E:\s*geometry\s*=.*,\s*start\s*=\s*(\d+)\s*$/s)
94                                 or die "Unparsable output of \"$cmdname\":\n$HDPARM";
95                 die "Unexpected 'start' parameter $start (expected $start_expected) of: $filename"
96                                 if $start!=$start_expected;
97         }
98
99         hdparm_g_start_check($master_filename,0);
100         hdparm_g_start_check($backup_filename,$backup_offset/0x200);
101         $backup_offset=0;
102         }
103
104 my $MASTER;
105 open $MASTER,"+<".$master_filename or die "open \"$master_filename\": $!";
106
107 # Do not write to the '/dev/hda' areas being mapped by: /dev/hda1
108 # as reboot will rewrite '/dev/hda' with the contents of: /dev/hda1
109 my $BACKUP;
110 if ($master_filename ne $backup_filename) {
111         open $BACKUP,"+<".$backup_filename or die "open \"$backup_filename\": $!";
112         die if $backup_offset;
113         }
114 else {
115         $BACKUP=$MASTER;
116         die if !$backup_offset;
117         }
118
119 sysseek $MASTER,0,SEEK_SET or die "Error seeking $master_filename";
120 my $master;
121 $bin_len==sysread $MASTER,$master,$bin_len or die "read \"$master_filename\": $!";
122 length($master)==$bin_len or die "read \"$master_filename\": ".length($master)."!=$bin_len";
123 signature $master,$master_filename,0x1FE,"55AA";
124
125 sysseek $BACKUP,$backup_offset,SEEK_SET or die "Error seeking $backup_filename";
126 my $backup;
127 $bin_len==sysread $BACKUP,$backup,$bin_len or die "read \"$backup_filename\": $!";
128 length($backup)==$bin_len or die "read \"$backup_filename\": ".length($backup)."!=$bin_len";
129
130 my $zeroes="\x00"x$bin_len;
131 die if length($zeroes)!=$bin_len;
132
133 $bin=substr($bin,0,$MAX_BOOT_SIZE).substr($master,$MAX_BOOT_SIZE,0x1FE-$MAX_BOOT_SIZE).substr($bin,0x1FE);
134
135 my $installed=substr($master,0x03,7) eq "BIOSRAI";
136 print "Already instaled? ".($installed ? "YES" : "NO")."\n";
137
138 die "Nothing to uninstall!\n" if $opt_uninstall && !$installed;
139
140 if ($installed) {
141         signature $master,$master_filename,$bin_len-2,"BEEF","Different installed SECTOR_LEN?" if !$bin_short;
142         signature $master,$master_filename,0x03      ,unpack("H*","BIOSRAI");
143         signature $master,$master_filename,0x43      ,"5E81A2".sprintf("%X",$BACKUP_SECTOR_START) if !$bin_short;
144         signature $backup,$backup_filename,0x1FE,"55AA";
145         }
146 if ($opt_install) {
147         if (!$installed) {
148                 if ($backup ne $zeroes) {
149                         # Permit different DOS-volume area and 0x1FC..0x1FD bytes.
150                         die "Sensitive bytes at backup sectors" if !(1
151                                 && (0
152                                         || substr($backup,0x200) eq substr($zeroes,0x200)
153                                         || (substr($backup,$bin_len-2) eq pack("H*","BEEF") && !$bin_short)
154                                         )
155                                 && substr($backup,0,0x03) eq substr($master,0,0x03)
156                                 && substr($backup,0x5A,$MAX_BOOT_SIZE-0x5A) eq substr($master,0x5A,$MAX_BOOT_SIZE-0x5A)
157                                 );
158                         warn "WARNING: Dropping obsolete (but similiar) backup! Use --uninstall next time.\n";
159                         }
160                 sysseek $BACKUP,$backup_offset,SEEK_SET or die "Error seeking $backup_filename";
161                 $bin_len==syswrite $BACKUP,$master or die "Error backing up the master";
162                 }
163         sysseek $MASTER,0,SEEK_SET or die "Error seeking $master_filename";
164         $bin_len==syswrite $MASTER,$bin or die "Error writing new master of BIOSautoRAID";
165         }
166 if ($opt_uninstall) {
167         sysseek $MASTER,0,SEEK_SET or die "Error seeking $master_filename";
168         $bin_len==syswrite $MASTER,$backup or die "Error writing backup back to the master";
169         sysseek $BACKUP,$backup_offset,SEEK_SET or die "Error seeking $backup_filename";
170         $bin_len==syswrite $BACKUP,$zeroes or die "Error clearing the backup area";
171         }
172
173 close $MASTER or die "close \"$master_filename\": $!";
174 if ($master_filename ne $backup_filename) {
175         close $BACKUP or die "close \"$backup_filename\": $!";
176         }
177 system("sync") and die "Error running: sync: $!";
178
179 print "OK; ".($opt_install ? ($installed ? "re" : "")."installed" : "uninstalled")."\n";
180 $all_ok=1;