ksplice-apply.in

   1 #!/usr/bin/perl
   2
   3 # Copyright (C) 2008  Jeffrey Brian Arnold <jbarnold@mit.edu>
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License, version 2.
   7 #
   8 # This program is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 # GNU General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU General Public License
  14 # along with this program; if not, write to the Free Software
  15 # Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
  16 # 02110-1301, USA.
  17
  18 use Getopt::Long;
  19 use Cwd 'abs_path', 'getcwd';
  20 use Pod::Usage;
  21 use strict;
  22 use warnings;
  23 use lib 'KSPLICE_DATA_DIR';
  24 use ksplice;
  25
  26 my ($help, $wantversion, $debug) = (0, 0, 0);
  27 GetOptions("help|?" => \$help,
  28         "version" => \$wantversion,
  29         "verbose|v!" => \$verbose,
  30         "debug=i" => \$debug) or pod2usage(1);
  31
  32 if($wantversion) {
  33         print $version_str;
  34         exit(0);
  35 }
  36 pod2usage(1) if($help || scalar(@ARGV) != 1);
  37
  38 my $file = abs_path($ARGV[0]);
  39
  40 my $tmpdir = init_tmpdir();
  41 runcd($tmpdir);
  42 my $ksplice = unpack_update($file);
  43 runcd($ksplice);
  44
  45 my $unload = runstr("lsmod") !~ m/- $/m;
  46
  47 foreach my $helper (glob('*-helper.ko')) {
  48
  49         (my $primary = $helper) =~ s/\-helper.ko$/.ko/;
  50         die unless(-e $primary && -e $helper);
  51
  52         if(runval_raw("insmod $primary debug=$debug") != 0) {
  53                 die "$primary";
  54         }
  55         if(runval_raw("insmod $helper") != 0) {
  56                 runval_raw("rmmod $primary") if $unload;
  57                 my $dmesg = runstr("dmesg | grep ksplice");
  58                 while($dmesg =~ /ksplice_h: Preparing and checking/) {
  59                         $dmesg = $';
  60                 }
  61
  62                 my $bugreport = 'PACKAGE_BUGREPORT';
  63                 if($dmesg =~ /could not match some sections/) {
  64                         print <<END
  65
  66 Ksplice has aborted the upgrade because Ksplice has been unable to match the
  67 object code produced by your current compiler and assembler against the running
  68 kernel's object code.  If you provided the exact kernel source to the running
  69 kernel, then it appears that your current compiler and/or assembler are
  70 behaving differently from the compiler and assembler used to build the running
  71 kernel.  If possible, please use the exact compiler and assembler that were
  72 used to build the running kernel.  If you are using exactly the same compiler
  73 and assembler, feel free to report a bug to $bugreport.
  74
  75 END
  76                 }
  77                 if($dmesg =~ /to-be-replaced code is busy/) {
  78                         print <<END
  79
  80 Ksplice has aborted the upgrade because it appears that the code that you are
  81 trying to patch is continuously in use by the system.  More specifically,
  82 Ksplice has been unable to find a moment when one or more of the to-be-patched
  83 functions is not on a thread's kernel stack.
  84
  85 END
  86                 }
  87                 if($dmesg =~ /System[.]map does not match kernel/) {
  88                         print <<END
  89
  90 Ksplice has aborted the upgrade because it appears that the System.map file
  91 provided to ksplice-create does not match the running kernel.
  92
  93 END
  94                 }
  95
  96                 die;
  97         }
  98         die if ($unload && runval_raw("rmmod $helper") != 0)
  99
 100 }
 101
 102 runval("rm -rf $tmpdir");
 103 print "Done!\n";
 104 exit(0);
 105
 106 =head1 NAME
 107
 108 ksplice-apply - Apply an on-disk Ksplice update to the running kernel
 109
 110 =head1 SYNOPSIS
 111
 112 B<ksplice-apply> I<UPDATE_TARBALL>
 113
 114 =head1 DESCRIPTION
 115
 116 B<ksplice-apply> takes as input a Ksplice update tarball, as generated by
 117 L<ksplice-create(8)>, and it applies the update to the running binary kernel.
 118
 119 Specifically, B<ksplice-apply> does the following:
 120
 121 =over
 122
 123 =item 1.
 124
 125 Inserts the "primary" module into the kernel.
 126
 127 =item 2.
 128
 129 Inserts the "helper" module into the kernel (doing so applies the
 130 update).
 131
 132 =item 3.
 133
 134 Removes the "helper" module from the kernel (that module is not needed
 135 after the update has been applied).
 136
 137 =back
 138
 139 The update tarball used with B<ksplice-apply> must have been generated for the
 140 running kernel's version.
 141
 142 =head1 OPTIONS
 143
 144 =over 8
 145
 146 =item B<--debug=>I<DEBUG_LEVEL>
 147
 148 Applies the update with debugging output enabled.  Recommended only for
 149 debugging.  I<DEBUG_LEVEL> should be an integer between 0 and 4.  B<--debug=4>
 150 provides the most debugging information.
 151
 152 =over
 153
 154 =item Z<> B<0>
 155
 156 No debugging output.
 157
 158 =item Z<> B<1>
 159
 160 Provides basic (pre-run matching and kernel stack check) debugging output.
 161
 162 =item Z<> B<2>
 163
 164 Also provides full kernel stack check debugging output.
 165
 166 =item Z<> B<3>
 167
 168 Also provides full pre-run matching debugging output.
 169
 170 =item Z<> B<4>
 171
 172 Also provides full Ksplice relocation debugging output.
 173
 174 =back
 175
 176 =back
 177
 178 =head1 SEE ALSO
 179
 180 L<ksplice-create(8)>, L<ksplice-view(8)>, L<ksplice-undo(8)>
 181
 182 =head1 COPYRIGHT
 183
 184 Copyright (C) 2008  Jeffrey Brian Arnold <jbarnold@mit.edu>.
 185
 186 This is free software and documentation.  You can redistribute and/or modify it
 187 under the terms of the GNU General Public License, version 2.
 188
 189 =cut