2 * Copyright 2010, INRIA, University of Copenhagen
3 * Julia Lawall, Rene Rydhof Hansen, Gilles Muller, Nicolas Palix
4 * Copyright 2005-2009, Ecole des Mines de Nantes, University of Copenhagen
5 * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller, Nicolas Palix
6 * This file is part of Coccinelle.
8 * Coccinelle is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, according to version 2 of the License.
12 * Coccinelle is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Coccinelle. If not, see <http://www.gnu.org/licenses/>.
20 * The authors reserve the right to distribute this or future versions of
21 * Coccinelle under other licenses.
25 (* split patch per file *)
27 (* ------------------------------------------------------------------------ *)
28 (* The following are a reminder of what this information should look like.
29 These values are not used. See the README file for information on how to
30 create a .splitpatch file in your home directory. *)
32 let from = ref "email@xyz.org"
33 let git_tree = ref "/var/linuxes/linux-next"
34 let git_options = ref "--cc=kernel-janitors@vger.kernel.org --suppress-cc=self"
35 let prefix_before = ref (Some
"/var/linuxes/linux-next")
36 let prefix_after = ref (Some
"/var/julia/linuxcopy")
38 (* ------------------------------------------------------------------------ *)
41 let process_output_to_list2 = fun command
->
42 let chan = Unix.open_process_in command
in
43 let res = ref ([] : string list
) in
44 let rec process_otl_aux () =
45 let e = input_line
chan in
48 try process_otl_aux ()
50 let stat = Unix.close_process_in
chan in (List.rev
!res,stat)
51 let cmd_to_list command
=
52 let (l
,_
) = process_output_to_list2 command
in l
53 let process_output_to_list = cmd_to_list
54 let cmd_to_list_and_status = process_output_to_list2
56 let safe_chop_extension s
= try Filename.chop_extension s
with _
-> s
58 let safe_get_extension s
=
59 match List.rev
(Str.split
(Str.regexp_string
".") s
) with
60 ext
::_
::rest
-> Some
(String.concat
"." (List.rev rest
))
63 (* ------------------------------------------------------------------------ *)
64 (* set configuration variables *)
66 let from_from_template template
=
68 cmd_to_list (Printf.sprintf
"grep Signed-off-by: %s" template
) in
69 match signed_offs with
70 x
::xs
-> String.concat
" " (Str.split
(Str.regexp
"[ \t]+") x
)
71 | _
-> failwith
"No Signed-off-by in template file"
73 let from_from_gitconfig path
=
74 let config = path^
"/.git/config" in
75 if Sys.file_exists
config
77 let i = open_in
config in
78 let rec inner_loop _
=
79 let l = input_line
i in
80 match Str.split
(Str.regexp
"[ \t]+") l with
81 "from"::"="::f
-> from := String.concat
" " f
83 if String.length
l >= 1 && String.get
l 0 = '
['
86 let rec outer_loop _
=
87 let l = input_line
i in
91 (try outer_loop() with Not_found
-> ());
94 let read_configs template
=
95 let temporary_git_tree = ref None
in
97 prefix_before := None
;
99 (* get information in message template, lowest priority *)
100 from := from_from_template template
;
101 (* get information in git config *)
102 let rec loop = function
105 if Sys.file_exists
".git"
107 begin temporary_git_tree := Some path
; from_from_gitconfig path
end
108 else loop (Filename.dirname path
) in
110 (* get information from .splitpatch *)
111 let home = List.hd
(cmd_to_list "ls -d ~") in
112 let config = home^
"/.splitpatch" in
113 (if Sys.file_exists
config
115 let i = open_in
config in
117 let l = input_line
i in
118 (* bounded split doesn't split at = in value part *)
119 (match Str.bounded_split
(Str.regexp
"[ \t]*=[ \t]*") l 2 with
120 ["from";s
] -> from := s
121 | ["git_tree";s
] -> temporary_git_tree := Some s
122 | ["git_options";s
] -> git_options := s
123 | ["prefix_before";s
] -> prefix_before := Some s
124 | ["prefix_after";s
] -> prefix_after := Some s
125 | _
-> Printf.fprintf stderr
"unknown line: %s\n" l);
127 try loop() with End_of_file
-> close_in
i);
128 match !temporary_git_tree with
129 None
-> failwith
"Unable to find Linux source tree"
130 | Some g
-> git_tree := g
132 (* ------------------------------------------------------------------------ *)
134 let maintainer_command file
=
136 "cd %s; scripts/get_maintainer.pl --separator , --nogit -f %s"
139 let subsystem_command file
=
141 "cd %s; scripts/get_maintainer.pl --nogit --subsystem -f %s | grep -v @"
144 let checkpatch_command file
=
145 Printf.sprintf
"cd %s; scripts/checkpatch.pl %s" !git_tree file
147 let default_string = "THE REST" (* split by file *)
149 (* ------------------------------------------------------------------------ *)
150 (* ------------------------------------------------------------------------ *)
151 (* Template file processing *)
153 let read_up_to_dashes i =
154 let lines = ref [] in
156 let l = input_line
i in
159 else begin lines := l :: !lines; loop() end in
160 (try loop() with End_of_file
-> ());
163 ""::lines -> List.rev
lines (* drop last line if blank *)
164 | lines -> List.rev
lines in
166 ""::lines -> lines (* drop first line if blank *)
169 let get_template_information file
=
170 let i = open_in file
in
172 let subject = read_up_to_dashes i in
175 let cover = read_up_to_dashes i in
176 let message = read_up_to_dashes i in
178 then (subject,None
,cover)
179 else (subject,Some
cover,message)
182 ("Subject must be exactly one line "^
183 (string_of_int
(List.length
subject)))
185 (* ------------------------------------------------------------------------ *)
186 (* ------------------------------------------------------------------------ *)
187 (* Patch processing *)
189 let spaces = Str.regexp
"[ \t]+"
191 let fix_before_after l prefix
= function
193 (match Str.split
spaces l with
194 ("diff"|"+++"|"---")::_
->
195 (match Str.split
(Str.regexp old_prefix
) l with
197 (match Str.split_delim
(Str.regexp
("[ \t]"^prefix
)) a
with
198 [_
;""] -> a^b
(* prefix is already there *)
205 match Str.split
spaces l with
206 (("+++"|"---") as a
)::path
::rest
-> Printf.sprintf
"%s %s" a path
209 (* ------------------------------------------------------------------------ *)
211 let is_diff = Str.regexp
"diff "
213 let patches = ref [] in
216 match Str.split_delim
(Str.regexp
",") l with
217 [_
;size
] -> int_of_string size
218 | _
-> failwith
("bad size: "^
l) in
219 let rec read_diff_or_atat _
=
220 let l = input_line
i in
221 let l = fix_date(fix_before_after l "a" !prefix_before) in
222 let l = fix_date(fix_before_after l "b" !prefix_after) in
223 match Str.split
spaces l with
225 (if List.length
!cur > 0
226 then patches := List.rev
!cur :: !patches);
229 | "@@"::min
::pl
::"@@"::rest
->
230 let msize = get_size min
in
231 let psize = get_size pl
in
233 read_hunk
msize psize
234 | "\\"::_
-> cur := l :: !cur; read_diff_or_atat()
237 "expected diff or @@ (diffstat information should not be present)"
239 let l = input_line
i in
240 let l = fix_date(fix_before_after l "a" !prefix_before) in
241 let l = fix_date(fix_before_after l "b" !prefix_after) in
243 match Str.split
spaces l with
244 "+++"::_
-> read_diff_or_atat()
246 and read_hunk
msize psize =
247 if msize = 0 && psize = 0
248 then read_diff_or_atat()
250 let l = input_line
i in
252 match String.get
l 0 with
253 '
-'
-> read_hunk
(msize - 1) psize
254 | '
+'
-> read_hunk
msize (psize - 1)
255 | _
-> read_hunk
(msize - 1) (psize - 1) in
256 try read_diff_or_atat()
257 with End_of_file
-> List.rev
((List.rev
!cur)::!patches)
259 (* ------------------------------------------------------------------------ *)
261 let resolve_maintainers patches =
262 let maintainer_table = Hashtbl.create
(List.length
patches) in
266 (match Str.split
(Str.regexp
" a/") diff_line
with
268 (match Str.split
spaces after
with
271 List.hd
(cmd_to_list (maintainer_command file
)) in
273 cmd_to_list (subsystem_command file
) in
274 let info = (subsystems,maintainers) in
276 try Hashtbl.find
maintainer_table info
279 Hashtbl.add
maintainer_table info cell;
281 cell := (file
,(diff_line
:: rest
)) :: !cell
282 | _
-> failwith
"filename not found")
284 failwith
(Printf.sprintf
"prefix a/ not found in %s" diff_line
))
285 | _
-> failwith
"bad diff line")
289 (* ------------------------------------------------------------------------ *)
291 let common_prefix l1 l2
=
292 let rec loop = function
293 ([],_
) | (_
,[]) -> []
294 | (x
::xs
,y
::ys
) when x
= y
-> x
:: (loop (xs
,ys
))
296 match loop (l1
,l2
) with
299 (Printf.sprintf
"found nothing in common for %s and %s"
300 (String.concat
"/" l1
) (String.concat
"/" l2
))
303 let merge_files the_rest
= function
306 let butlast l = if the_rest
then l else List.rev
(List.tl
(List.rev
l)) in
307 match List.map
(function s
-> Str.split
(Str.regexp
"/") s
) files
with
309 let rec loop res = function
310 [] -> String.concat
"/" res
311 | x
::rest
-> loop (common_prefix res x
) rest
in
312 loop (butlast first
) rest
313 | _
-> failwith
"not possible"
315 (* ------------------------------------------------------------------------ *)
318 List.iter
(function x
-> Printf.fprintf o
"%s\n" x
) l
320 let make_mail_header o date
maintainers ctr number
subject =
321 Printf.fprintf o
"From nobody %s\n" date
;
322 Printf.fprintf o
"From: %s\n" !from;
323 (match Str.split
(Str.regexp_string
",") maintainers with
324 [x
] -> Printf.fprintf o
"To: %s\n" x
326 Printf.fprintf o
"To: %s\n" x
;
327 Printf.fprintf o
"Cc: %s\n" (String.concat
"," xs
)
328 | _
-> failwith
"no maintainers");
330 then Printf.fprintf o
"Subject: [PATCH] %s\n\n" subject
331 else Printf.fprintf o
"Subject: [PATCH %d/%d] %s\n\n" ctr number
subject
333 let make_message_files subject cover message date
maintainer_table
334 patch front add_ext
=
338 (function (services
,maintainers) ->
341 if services
=[default_string]
343 (* if no maintainer, then one file per diff *)
345 (function (file
,diff
) ->
347 (!ctr,true,maintainers,[file
],[diff
]))
353 let (files
,diffs
) = List.split
(List.rev
!diffs
) in
354 (!ctr,false,maintainers,files
,diffs
)::rest
356 maintainer_table [] in
357 let number = List.length
elements in
360 (function (ctr,the_rest
,maintainers,files
,diffs
) ->
361 let output_file = add_ext
(Printf.sprintf
"%s%d" front
ctr) in
362 let o = open_out
output_file in
363 make_mail_header o date
maintainers ctr number
364 (Printf.sprintf
"%s: %s" (merge_files the_rest files
) subject);
366 Printf.fprintf
o "\n---\n";
367 let (nm
,o1
) = Filename.open_temp_file
"patch" "patch" in
368 List.iter
(print_all o1
) (List.rev diffs
);
372 (Printf.sprintf
"diffstat -p1 < %s ; /bin/rm %s" nm nm
) in
373 List.iter
(print_all o) [diffstat];
374 Printf.fprintf
o "\n";
375 List.iter
(print_all o) diffs
;
376 Printf.fprintf
o "\n";
379 cmd_to_list_and_status
380 (checkpatch_command ((Sys.getcwd
())^
"/"^
output_file)) in
381 (if not
(stat = Unix.WEXITED
0)
382 then (print_all stderr
info; Printf.fprintf stderr
"\n"));
384 (List.rev
elements) in
385 let later = add_ext
(Printf.sprintf
"%s%d" front
(number+1)) in
386 if Sys.file_exists
later
387 then Printf.fprintf stderr
"Warning: %s and other files may be left over from a previous run\n" later;
390 let make_cover_file n
subject cover front date
maintainer_table =
394 let common_maintainers =
395 let intersect l1 l2
=
398 (function i -> function cur ->
399 if List.mem
cur l2
then cur :: i else i)
401 let start = ref true in
404 (function (services
,maintainers) ->
407 let cur = Str.split
(Str.regexp_string
",") maintainers in
409 then begin start := false; cur end
410 else intersect cur rest
)
411 maintainer_table []) in
412 let output_file = Printf.sprintf
"%s.cover" front
in
413 let o = open_out
output_file in
414 make_mail_header o date
common_maintainers 0 n
subject;
416 Printf.fprintf
o "\n";
419 let mail_sender = "git send-email" (* use this when it works *)
420 let mail_sender = "cocci-send-email.perl"
422 let generate_command front
cover generated =
423 let output_file = front^
".cmd" in
424 let o = open_out
output_file in
428 "%s --auto-to --no-thread --from=\"%s\" %s $* %s\n"
429 mail_sender !from !git_options
430 (String.concat
" " generated)
433 "%s --auto-to --thread --from=\"%s\" %s $* %s\n"
434 mail_sender !from !git_options
435 (String.concat
" " ((front^
".cover") :: generated)));
438 let make_output_files subject cover message maintainer_table patch
=
439 let date = List.hd
(cmd_to_list "date") in
440 let front = safe_chop_extension patch
in
442 match safe_get_extension patch
with
443 Some ext
-> (function s
-> s ^
"." ^ ext
)
444 | None
-> (function s
-> s
) in
446 make_message_files subject cover message date maintainer_table
447 patch
front add_ext in
448 make_cover_file (List.length
generated) subject cover front date
450 generate_command front cover generated
452 (* ------------------------------------------------------------------------ *)
455 let (other_args
,files
) =
457 (function a
-> String.length a
> 1 && String.get a
0 = '
-'
)
460 [file
] -> (file
,String.concat
" " other_args
)
461 | _
-> failwith
"Only one file allowed"
464 let (file
,git_args
) = parse_args (List.tl
(Array.to_list
Sys.argv
)) in
465 let message_file = (safe_chop_extension file
)^
".msg" in
466 (* set up environment *)
467 read_configs message_file;
468 (if not
(git_args
= "") then git_options := !git_options^
" "^git_args
);
469 (* get message information *)
470 let (subject,cover,message) = get_template_information message_file in
472 let i = open_in file
in
473 let patches = split_patch i in
475 let maintainer_table = resolve_maintainers patches in
476 make_output_files subject cover message maintainer_table file