Simplified and generalized code for processing in-tree kernel patches.
[mirror/scst/.git] / scripts / generate-kernel-patch
1 #!/bin/bash
2
3 ############################################################################
4 #
5 # Script for converting the SCST source tree as it exists in the Subversion
6 # repository to a Linux kernel patch.
7 #
8 # Copyright (C) 2008 Bart Van Assche <bart.vanassche@gmail.com>
9 #
10 # This program is free software; you can redistribute it and/or
11 # modify it under the terms of the GNU General Public License
12 # as published by the Free Software Foundation, version 2
13 # of the License.
14 #
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
19 #
20 ############################################################################
21
22 ########################
23 # Function definitions #
24 ########################
25
26 function usage {
27   echo "Usage: $0 [-h] [-m] [-p <dir>] [-q] <kernel version>, where: "
28   echo "        -h - show this text"
29   echo "        -m - add mpt target driver"
30   echo "        -p - generate multiple patches instead of one big patch into"\
31        "the specified directory."
32   echo "        -q - add qla2x00t driver"
33 }
34
35 # Convert an existing patch.
36 # $1: path of patch to be added.
37 # $2: path in kernel tree of file to be patched.
38 function add_patch {
39   if [ ! -e "$1" ]; then
40     echo "Error: could not find $1." >&2
41     exit 1
42   fi
43
44   sed -e "s:^--- [^ ]*:--- orig/linux-${kernel_version}/$2:" \
45       -e "s:^+++ [^ ]*:+++ linux-${kernel_version}/$2:"      \
46       < "$1"
47 }
48
49 # Generate a patch for a file to be added to the kernel source tree, and strip
50 # trailing whitespace from C source files while converting the file to patch
51 # format.
52 # $1: path of file to be added.
53 # $2: path in kernel tree where file should be added.
54 function add_file {
55   local a b
56
57   if [ ! -e "$1" ]; then
58     echo "Error: could not find $1." >&2
59     exit 1
60   fi
61
62   # Only include files that were not generated by the build process
63   # -- skip *.mod.c.
64   if [ "$1" = "${1%.mod.c}" -a "$1" ]; then
65     cat <<EOF
66 diff -uprN orig/linux-${kernel_version}/$2 linux-${kernel_version}/$2
67 --- orig/linux-${kernel_version}/$2
68 +++ linux-${kernel_version}/$2
69 @@ -0,0 +1,$(wc -l "$1" | { read a b; echo $a; }) @@
70 EOF
71     if [ "${2%.[ch]}" != "$2" ]; then
72       sed -e 's/sBUG(/BUG(/g' -e 's/sBUG_ON(/BUG_ON(/g' -e 's/^/+/' \
73           -e 's/^ \([^ ]*:\)$/\1/' < "$1"
74     else
75       sed -e 's/sBUG(/BUG(/g' -e 's/sBUG_ON(/BUG_ON(/g' -e 's/^/+/' < "$1"
76     fi
77   fi
78 }
79
80 function add_empty_file {
81   local a b
82
83   cat <<EOF
84 diff -uprN orig/linux-${kernel_version}/$1 linux-${kernel_version}/$1
85 --- orig/linux-${kernel_version}/$1
86 +++ linux-${kernel_version}/$1
87 @@ -0,0 +1,1 @@
88 +
89 EOF
90 }
91
92 # Read a patch from stdin, specialize it for kernel version ${kernel_version}
93 # and write the output either to stdout or to the file $1 (if not empty),
94 # depending on the value of the variable ${multiple_patches}.
95 function process_patch {
96   if [ "${multiple_patches}" = "true" ]; then
97     if [ "$1" != "" ]; then
98       if [ -e "${patchdir}/$1" ]; then
99         echo "Warning: overwriting ${patchdir}/$1"
100       fi
101     (
102       echo "Signed-off-by: ${SIGNED_OFF_BY}"
103       echo ""
104       "$(dirname $0)/specialize-patch" -v kernel_version="${kernel_version}"
105     ) >"${patchdir}/$1"
106     else
107       # echo "Discarded $(wc -l) lines."
108       true
109     fi
110   else
111     "$(dirname $0)/specialize-patch" -v kernel_version="${kernel_version}" 
112   fi
113 }
114
115 # Returns 0 (true) if SCST core file "$1" should be added in a separate patch,
116 # and 1 (false) if not.
117 function in_separate_patch {
118   echo "${source_files_in_separate_patch}" | grep -qE "^$1 | $1 | $1\$|^$1\$"
119 }
120
121
122 #########################
123 # Argument verification #
124 #########################
125
126 qla2x00t="false"
127 srpt="true"
128 mpt_scst="false"
129 multiple_patches="false"
130 patchdir=""
131
132 if [ ! -e scst -o ! -e iscsi-scst -o ! -e srpt -o ! -e scst_local ]; then
133   echo "Please run this script from inside the SCST subversion source tree."
134   exit 1
135 fi
136
137 set -- $(/usr/bin/getopt hlmp:q "$@")
138 while [ "$1" != "${1#-}" ]
139 do
140   case "$1" in
141     '-h') usage; exit 1;;
142     '-l') shift;;
143     '-m') mpt_scst="true"; shift;;
144     '-p') multiple_patches="true"; patchdir="$2"; shift; shift;;
145     '-q') qla2x00t="true"; shift;;
146     '--') shift;;
147     *)    usage; exit 1;;
148   esac
149 done
150
151 if [ $# != 1 ]; then
152   usage
153   exit 1
154 fi
155
156 if [ "${multiple_patches}" = "" ]; then
157   if [ -e "${patchdir}" ]; then
158     echo "Patch output directory ${patchdir} already exists."
159   fi
160   if [ ! -d "${patchdir}" ]; then
161     echo "Error: ${patchdir} is not a directory."
162   fi
163 fi
164
165
166 ####################
167 # Patch Generation #
168 ####################
169
170 # Strip patch level from the kernel version number.
171 if [ "${1#[0-9]*.[0-9]*.[0-9]*.[0-9]*}" != "$1" ]; then
172   kernel_version="${1%.[0-9]*}"
173 else
174   kernel_version="$1"
175 fi
176
177 if [ "${multiple_patches}" = "false" ]; then
178   echo "Signed-off-by: ${SIGNED_OFF_BY}"
179   echo ""
180 fi
181
182
183 # General kernel patches.
184
185 for p in scst/kernel/*-${kernel_version}.patch \
186          iscsi-scst/kernel/patches/*-${kernel_version}.patch
187 do
188   diffname="${p#scst/kernel/}"
189   diffname="${p%-${kernel_version}.patch}.diff"
190   process_patch < "$p" "${diffname}"
191 done
192
193
194 scst_debug="scst/include/scst_debug.h scst/src/scst_debug.c"
195 scst_proc="scst/src/scst_proc.c"
196 scst_sgv="scst/include/scst_sgv.h scst/src/scst_mem.h scst/src/scst_mem.c"
197 scst_user="scst/include/scst_user.h scst/src/dev_handlers/scst_user.c"
198 scst_vdisk="scst/src/dev_handlers/scst_vdisk.c"
199 separate_patches="scst_debug scst_proc scst_sgv scst_user scst_vdisk"
200 source_files_in_separate_patch="${scst_debug} ${scst_proc} ${scst_sgv} ${scst_user} ${scst_vdisk}"
201
202
203 # Directory include/scst/
204
205 for f in $(ls scst/include/*h)
206 do
207   if ! in_separate_patch "${f}"; then
208     add_file "${f}" "include/scst/${f#scst/include/}"
209   fi
210 done \
211 | process_patch "scst_public_headers.diff"
212
213
214 # Directory drivers/
215
216 (
217 add_patch "scst/kernel/in-tree/Kconfig.drivers.Linux-${kernel_version}.patch" \
218           "drivers/Kconfig"
219
220 add_patch "scst/kernel/in-tree/Makefile.drivers.Linux-${kernel_version}.patch"\
221           "drivers/Makefile"
222 ) \
223 | process_patch "misc.diff"
224
225
226 # Directory drivers/scst/
227
228 (
229 add_file "scst/kernel/in-tree/Kconfig.scst"  "drivers/scst/Kconfig"
230
231 add_file "scst/kernel/in-tree/Makefile.scst" "drivers/scst/Makefile"
232
233 for f in $(ls scst/src/*.[ch])
234 do
235   if ! in_separate_patch "${f}"; then
236     add_file "${f}" "drivers/scst/${f#scst/src/}"
237   fi
238 done
239 ) \
240 | process_patch "scst_core.diff"
241
242 for s in ${separate_patches}
243 do
244   fileset=$s
245   for f in $(set | grep "^$s=" | sed -e "s/^$s='\(.*\)'\$/\1/" -e "s/^$s=\(.*\)\$/\1/")
246   do
247     if [ "${f#scst/include}" != "${f}" ]; then
248       add_file "${f}" "include/scst/${f#scst/include/}"
249     else
250       add_file "${f}" "drivers/scst/${f#scst/src/}"
251     fi
252   done \
253   | process_patch "${s}.diff"
254 done
255
256 add_file "scst/README_in-tree" "Documentation/scst/README.scst" \
257 | process_patch "scst_core_doc.diff"
258
259
260
261 # Directory drivers/scst/dev_handlers/
262
263 (
264 add_file "scst/kernel/in-tree/Makefile.dev_handlers" \
265          "drivers/scst/dev_handlers/Makefile" \
266 | process_patch "dev_handlers_makefile.diff"
267
268 for f in $(ls scst/src/dev_handlers/*.[ch])
269 do
270   if ! in_separate_patch "${f}"; then
271     add_file "${f}" "drivers/scst/dev_handlers/${f#scst/src/dev_handlers/}"
272   fi
273 done
274 ) \
275 | process_patch "scst_passthrough.diff"
276
277
278 # Directory drivers/scst/iscsi-scst/
279
280 # Make sure the file iscsi-scst/iscsi_scst_itf_ver.h is up to date.
281 make -s -C iscsi-scst include/iscsi_scst_itf_ver.h
282
283 (
284 for f in $(ls iscsi-scst/include/*h)
285 do
286   if [ "${f}" != "iscsi-scst/include/iscsi_scst_itf_ver.h" ]; then
287     add_file "${f}" "include/scst/${f#iscsi-scst/include/}"
288   fi
289 done
290
291 add_file "iscsi-scst/include/iscsi_scst_itf_ver.h" "include/scst/iscsi_scst_itf_ver.h" | process_patch ""
292
293 add_file "iscsi-scst/kernel/Makefile.in-kernel" \
294          "drivers/scst/iscsi-scst/Makefile"
295
296 add_file "iscsi-scst/kernel/Kconfig"  "drivers/scst/iscsi-scst/Kconfig"
297
298 for f in $(ls iscsi-scst/kernel/*.[ch])
299 do
300   add_file "${f}" "drivers/scst/iscsi-scst/${f#iscsi-scst/kernel/}"
301 done
302 ) \
303 | process_patch "iscsi-scst.diff"
304
305 add_file "iscsi-scst/README_in-tree" "Documentation/scst/README.iscsi" \
306 | process_patch "iscsi-scst-doc.diff"
307
308
309 # Directory drivers/scst/qla2x00-target/
310
311 if [ "${qla2x00t}" = "true" ]; then
312
313   add_file "qla2x00t/qla2x00-target/Makefile_in-tree" \
314            "drivers/scst/qla2xxx-target/Makefile"
315
316   add_file "qla2x00t/qla2x00-target/Kconfig" \
317            "drivers/scst/qla2xxx-target/Kconfig"
318
319 #  add_file "qla2x00t/qla2x_tgt_def.h" \
320 #           "drivers/scst/qla2x00-target/qla2x_tgt_def.h"
321
322   for f in $(ls qla2x00t/qla2x00-target/*.[ch])
323   do
324     add_file "${f}" "drivers/scst/qla2xxx-target/${f#qla2x00t/qla2x00-target/}"
325   done
326
327   add_file "qla2x00t/qla2x00-target/README" \
328            "Documentation/scst/README.qla2x00t" \
329   | process_patch "qla2x00t-doc.diff"
330
331 else
332
333   add_empty_file "drivers/scst/qla2xxx-target/Makefile"
334
335   add_empty_file "drivers/scst/qla2xxx-target/Kconfig"
336
337 fi \
338 | process_patch "qla2x00t.diff"
339
340
341 # Directory drivers/scst/srpt
342
343 if [ "$srpt" = "true" ]; then
344
345   add_file  "srpt/src/Kconfig"            "drivers/scst/srpt/Kconfig"
346
347   add_file  "srpt/src/Makefile.in_kernel" "drivers/scst/srpt/Makefile"
348
349   for f in $(ls srpt/src/*.[ch])
350   do
351     add_file "${f}" "drivers/scst/srpt/${f#srpt/src/}"
352   done
353
354 else
355
356   add_empty_file "drivers/scst/srpt/Kconfig"
357
358   add_empty_file "drivers/scst/srpt/Makefile"
359
360 fi \
361 | process_patch "srpt.diff"
362
363 add_file "srpt/README_in-tree" "Documentation/scst/README.srpt" \
364 | process_patch "srpt-doc.diff"
365
366
367 # Directory drivers/message/fusion/mpt_scst
368
369 if [ "$mpt_scst" = "true" ]; then
370
371   (
372   add_patch "mpt/in-tree/Kconfig-2.6.24.diff" "drivers/message/fusion/Kconfig"
373
374   add_patch "mpt/in-tree/Makefile.diff"       "drivers/message/fusion/Makefile"
375
376   add_file  "mpt/in-tree/Makefile" "drivers/message/fusion/mpt_scst/Makefile"
377
378   add_file  "mpt/in-tree/Kconfig"  "drivers/message/fusion/mpt_scst/Kconfig"
379
380   for f in $(ls mpt/*.[ch])
381   do
382     add_file "${f}" "drivers/message/fusion/mpt_scst/${f#mpt/}"
383   done
384   ) \
385   | process_patch "mpt_scst.diff"
386
387 fi
388
389
390 # Directory drivers/scst/scst_local
391
392 (
393   add_file "scst_local/in-tree/Kconfig" "drivers/scst/scst_local/Kconfig"
394
395   add_file "scst_local/in-tree/Makefile" "drivers/scst/scst_local/Makefile"
396
397   add_file "scst_local/scst_local.c" "drivers/scst/scst_local/scst_local.c"
398 ) \
399 | process_patch "scst_local.diff"
400
401 add_file "scst_local/README" "Documentation/scst/README.scst_local" \
402 | process_patch "scst_local-doc.diff"