1 (* Memory info for virtual domains.
2 (C) Copyright 2008 Richard W.M. Jones, Red Hat Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 (* This program takes the kernel database (in kernels/ in toplevel
21 directory) and generates parsing code for the various structures
22 in the kernel that we are interested in.
24 The output programs -- *.ml, *.mli files of generated code -- go
25 into lib/ at the toplevel, eg. lib/kernel_task_struct.ml
27 The stuff at the top of this file determine what structures
28 and fields we try to parse.
33 "struct task_struct {", "};", true,
34 [ "state"; "prio"; "normal_prio"; "static_prio";
35 "tasks'prev"; "tasks'next"; "mm"; "active_mm"; "comm"; "pid" ]
39 "struct mm_struct {", "};", true,
44 "struct net_device {", "};", true,
45 [ "name"; "dev_addr" ]
59 let (//) = Filename.concat
62 let args = Array.to_list Sys.argv in
64 let kernelsdir, outputdir =
68 let arg0 = Filename.basename Sys.executable_name in
69 eprintf "%s - Turn kernels database into code modules.
72 %s <kernelsdir> <outputdir>
74 Example (from toplevel of virt-mem source tree):
79 (* Get the *.info files from the kernels database. *)
80 let infos = Sys.readdir kernelsdir in
81 let infos = Array.to_list infos in
82 let infos = List.filter (fun name -> String.ends_with name ".info") infos in
83 let infos = List.map ( (//) kernelsdir) infos in
85 (* Regular expressions. We really really should use ocaml-mikmatch ... *)
86 let re_oldformat = Pcre.regexp "^RPM: \\d+: \\(build \\d+\\) ([-\\w]+) ([\\w.]+) ([\\w.]+) \\(.*?\\) (\\w+)" in
87 let re_keyvalue = Pcre.regexp "^(\\w+): (.*)" in
89 (* Parse in the *.info files. These have historically had a few different
90 * formats that we need to support.
92 let infos = List.map (
94 (* Get the basename (for getting the .data file later on). *)
95 let basename = Filename.chop_suffix filename ".info" in
97 let chan = open_in filename in
98 let line = input_line chan in
100 (* Kernel version string. *)
102 if Pcre.pmatch ~rex:re_oldformat line then (
103 (* If the file starts with "RPM: \d+: ..." then it's the
104 * original Fedora format. Everything in one line.
106 let subs = Pcre.exec ~rex:re_oldformat line in
107 (* let name = Pcre.get_substring subs 1 in *)
108 let version = Pcre.get_substring subs 2 in
109 let release = Pcre.get_substring subs 3 in
110 let arch = Pcre.get_substring subs 4 in
112 (* XXX Map name -> PAE, hugemem etc. *)
113 (* name, *) sprintf "%s-%s.%s" version release arch, arch
115 (* New-style "key: value" entries, up to end of file or the first
118 let (*name,*) version, release, arch =
119 (*ref "",*) ref "", ref "", ref "" in
122 let subs = Pcre.exec ~rex:re_keyvalue line in
123 let key = Pcre.get_substring subs 1 in
124 let value = Pcre.get_substring subs 2 in
125 (*if key = "Name" then name := value
126 else*) if key = "Version" then version := value
127 else if key = "Release" then release := value
128 else if key = "Architecture" then arch := value;
129 let line = input_line chan in
132 Not_found | End_of_file ->
136 let (*name,*) version, release, arch =
137 (*!name,*) !version, !release, !arch in
138 if (*name = "" ||*) version = "" || release = "" || arch = "" then
139 failwith (sprintf "%s: missing Name, Version, Release or Architecture key" filename);
140 (* XXX Map name -> PAE, hugemem etc. *)
141 (* name, *) sprintf "%s-%s.%s" version release arch, arch
144 (*printf "%s -> %s %s\n%!" basename version arch;*)
146 (basename, version, arch)
149 (* For quick access to the opener strings, build a hash. *)
150 let openers = Hashtbl.create 13 in
152 fun (name, (opener, closer, _, _)) ->
153 Hashtbl.add openers opener (closer, name)
156 (* Now read the data files and parse out the structures of interest. *)
157 let datas = List.map (
158 fun (basename, version, arch) ->
159 let file_exists name =
160 try Unix.access name [Unix.F_OK]; true
161 with Unix.Unix_error _ -> false
163 let close_process_in cmd chan =
164 match Unix.close_process_in chan with
165 | Unix.WEXITED 0 -> ()
167 eprintf "%s: command exited with code %d\n" cmd i; exit i
168 | Unix.WSIGNALED i ->
169 eprintf "%s: command exited with signal %d\n" cmd i; exit 1
171 eprintf "%s: command stopped by signal %d\n" cmd i; exit 1
174 (* Open the data file, uncompressing it on the fly if necessary. *)
176 if file_exists (basename ^ ".data") then
177 open_in (basename ^ ".data"), close_in
178 else if file_exists (basename ^ ".data.gz") then (
180 sprintf "gzip -cd %s" (Filename.quote (basename ^ ".data.gz")) in
181 Unix.open_process_in cmd, close_process_in cmd
183 else if file_exists (basename ^ ".data.bz2") then (
185 sprintf "bzip2 -cd %s" (Filename.quote (basename ^ ".data.bz2")) in
186 Unix.open_process_in cmd, close_process_in cmd
189 (sprintf "%s: cannot find corresponding data file" basename) in
191 (* Read the data file in, looking for structures of interest to us. *)
192 let bodies = Hashtbl.create 13 in
194 let line = input_line chan in
196 (* If the line is an opener for one of the structures we
197 * are looking for, then for now just save all the text until
198 * we get to the closer line.
201 let closer, name = Hashtbl.find openers line in
202 let rec loop2 lines =
203 let line = input_line chan in
204 let lines = line :: lines in
205 if String.starts_with line closer then List.rev lines
212 failwith (sprintf "%s: %s: %S not matched by closing %S" basename name line closer) in
214 Hashtbl.replace bodies name body
215 with Not_found -> ());
219 (try loop () with End_of_file -> ());
223 (* Make sure we got all the mandatory structures. *)
225 fun (name, (_, _, mandatory, _)) ->
226 if mandatory && not (Hashtbl.mem bodies name) then
227 failwith (sprintf "%s: structure %s not found in this kernel" basename name)
230 (basename, version, arch, bodies)
233 (* Now parse each structure body.
234 * XXX This would be better as a proper lex/yacc parser.
235 * XXX Even better would be to have a proper interface to libdwarves.
237 let re_offsetsize = Pcre.regexp "/\\*\\s+(\\d+)\\s+(\\d+)\\s+\\*/" in
238 let re_intfield = Pcre.regexp "int\\s+(\\w+);" in
239 let re_ptrfield = Pcre.regexp "struct\\s+(\\w+)\\s*\\*\\s*(\\w+);" in
240 let re_strfield = Pcre.regexp "char\\s+(\\w+)\\[(\\d+)\\];" in
241 let re_structopener = Pcre.regexp "(struct|union)\\s+.*{$" in
242 let re_structcloser = Pcre.regexp "}\\s*(\\w+)?(\\[\\d+\\])?;" in
244 (* 'basename' is the source file, and second parameter ('body') is
245 * the list of text lines which covers this structure (minus the
246 * opener line). Result is the list of parsed fields from this
249 let rec parse basename = function
251 | [_] -> [] (* Just the closer line, finished. *)
252 | line :: lines when Pcre.pmatch ~rex:re_structopener line ->
253 (* Recursively parse a sub-structure. First search for the
254 * corresponding closer line.
256 let rec loop depth acc = function
258 eprintf "%s: %S has no matching close structure line\n%!"
261 | line :: lines when Pcre.pmatch ~rex:re_structopener line ->
262 loop (depth+1) (line :: acc) lines
264 when depth = 0 && Pcre.pmatch ~rex:re_structcloser line ->
267 when depth > 0 && Pcre.pmatch ~rex:re_structcloser line ->
268 loop (depth-1) (line :: acc) lines
269 | line :: lines -> loop depth (line :: acc) lines
271 let nested_body, rest = loop 0 [] lines in
273 (* Then parse the sub-structure. *)
274 let struct_name, nested_body =
275 match nested_body with
278 let subs = Pcre.exec ~rex:re_structcloser closer in
280 try Some (Pcre.get_substring subs 1) with Not_found -> None in
281 struct_name, List.rev nested_body in
282 let nested_fields = parse basename nested_body in
284 (* Prefix the sub-fields with the name of the structure. *)
286 match struct_name with
287 | None -> nested_fields
290 fun (name, details) -> (prefix ^ "'" ^ name, details)
293 (* Parse the rest. *)
294 nested_fields @ parse basename rest
296 | line :: lines when Pcre.pmatch ~rex:re_intfield line ->
298 let subs = Pcre.exec ~rex:re_intfield line in
299 let name = Pcre.get_substring subs 1 in
301 let subs = Pcre.exec ~rex:re_offsetsize line in
302 let offset = int_of_string (Pcre.get_substring subs 1) in
303 let size = int_of_string (Pcre.get_substring subs 2) in
304 (name, (`Int, offset, size)) :: parse basename lines
306 Not_found -> parse basename lines
309 | line :: lines when Pcre.pmatch ~rex:re_ptrfield line ->
310 (* A pointer-to-struct field. *)
311 let subs = Pcre.exec ~rex:re_ptrfield line in
312 let struct_name = Pcre.get_substring subs 1 in
313 let name = Pcre.get_substring subs 2 in
315 let subs = Pcre.exec ~rex:re_offsetsize line in
316 let offset = int_of_string (Pcre.get_substring subs 1) in
317 let size = int_of_string (Pcre.get_substring subs 2) in
318 (name, (`Ptr struct_name, offset, size))
319 :: parse basename lines
321 Not_found -> parse basename lines
324 | line :: lines when Pcre.pmatch ~rex:re_strfield line ->
325 (* A string (char array) field. *)
326 let subs = Pcre.exec ~rex:re_strfield line in
327 let name = Pcre.get_substring subs 1 in
328 let width = int_of_string (Pcre.get_substring subs 2) in
330 let subs = Pcre.exec ~rex:re_offsetsize line in
331 let offset = int_of_string (Pcre.get_substring subs 1) in
332 let size = int_of_string (Pcre.get_substring subs 2) in
333 (name, (`Str width, offset, size))
334 :: parse basename lines
336 Not_found -> parse basename lines
340 (* Just ignore any other field we can't parse. *)
345 let datas = List.map (
346 fun (basename, version, arch, bodies) ->
347 let structures = List.filter_map (
348 fun (struct_name, (_, _, _, wanted_fields)) ->
350 try Some (Hashtbl.find bodies struct_name)
351 with Not_found -> None in
355 let body = List.tl body in (* Don't care about opener line. *)
356 let fields = parse basename body in
358 (* Compute total size of the structure. *)
360 let fields = List.map (
361 fun (_, (_, offset, size)) -> offset + size
363 List.fold_left max 0 fields in
365 (* That got us all the fields, but we only care about
368 let fields = List.filter (
369 fun (name, _) -> List.mem name wanted_fields
372 (* Also check we have all the wanted fields. *)
375 if not (List.mem_assoc wanted_field fields) then
376 failwith (sprintf "%s: structure %s is missing required field %s" basename struct_name wanted_field)
379 (* Prefix all the field names with the structure name. *)
381 List.map (fun (name, details) ->
382 struct_name ^ "_" ^ name, details) fields in
384 Some (struct_name, (fields, total_size))
387 (basename, version, arch, structures)
392 fun (basename, version, arch, structures) ->
393 printf "%s (version: %s, arch: %s):\n" basename version arch;
395 fun (struct_name, (fields, total_size)) ->
396 printf " struct %s {\n" struct_name;
398 fun (field_name, (typ, offset, size)) ->
401 printf " int %s; " field_name
402 | `Ptr struct_name ->
403 printf " struct %s *%s; " struct_name field_name
405 printf " char %s[%d]; " field_name width
407 printf " /* offset = %d, size = %d */\n" offset size
409 printf " } /* %d bytes */\n\n" total_size;
413 (* We'll generate a code file for each structure type (eg. task_struct
414 * across all kernel versions), so rearrange 'datas' for that purpose.
416 * XXX This loop is O(n^3), luckily n is small!
423 fun (basename, version, arch, structures) ->
424 try Some (basename, version, arch, List.assoc name structures)
425 with Not_found -> None
429 let datas = () in ignore datas; (* garbage collect *)
431 (* Get just the field types. It's plausible that a field with the
432 * same name has a different type between kernel versions, so we must
433 * check that didn't happen.
435 let files = List.map (
436 fun (struct_name, kernels) ->
440 | (_, _, _, (fields, _)) :: kernels ->
441 let field_types_of_fields fields =
444 fun (field_name, (typ, _, _)) -> field_name, typ
448 let field_types = field_types_of_fields fields in
450 fun (_, _, _, (fields, _)) ->
451 if field_types <> field_types_of_fields fields then
452 failwith (sprintf "%s: one of the structure fields changed type between kernel versions" struct_name)
455 (struct_name, kernels, field_types)
458 (* To minimize generated code size, we want to fold together all
459 * structures where the particulars (eg. offsets, sizes, endianness)
460 * of the fields we care about are the same -- eg. between kernel
461 * versions which are very similar.
463 let endian_of_architecture arch =
464 if String.starts_with arch "i386" ||
465 String.starts_with arch "i486" ||
466 String.starts_with arch "i586" ||
467 String.starts_with arch "i686" ||
468 String.starts_with arch "x86_64" ||
469 String.starts_with arch "x86-64" then
470 Bitstring.LittleEndian
471 else if String.starts_with arch "ia64" then
472 Bitstring.LittleEndian (* XXX usually? *)
473 else if String.starts_with arch "ppc" then
475 else if String.starts_with arch "sparc" then
478 failwith (sprintf "endian_of_architecture: cannot parse %S" arch)
483 fun (struct_name, kernels, field_types) ->
484 let hash = Hashtbl.create 13 in
489 fun (basename, version, arch, (fields, total_size)) ->
490 let key = endian_of_architecture arch, fields in
492 try Hashtbl.find hash key
495 xs := (!i, key) :: !xs; Hashtbl.add hash key !i;
497 (basename, version, arch, total_size, j)
499 struct_name, kernels, field_types, List.rev !xs
502 (* How much did we save by sharing? *)
505 fun (struct_name, kernels, _, parsers) ->
506 printf "struct %s:\n" struct_name;
507 printf " number of kernel versions: %d\n" (List.length kernels);
508 printf " number of parser functions needed after sharing: %d\n"
509 (List.length parsers)
512 (* Let's generate some code! *)
515 fun (struct_name, kernels, field_types, parsers) ->
516 (* Dummy location required - there are no real locations for
519 let _loc = Loc.ghost in
521 (* The structure type. *)
522 let struct_type, struct_sig =
523 let fields = List.map (
526 <:ctyp< $lid:name$ : int64 >>
528 <:ctyp< $lid:name$ : Virt_mem_mmap.addr >>
530 <:ctyp< $lid:name$ : string >>
532 let f, fs = match fields with
533 | [] -> failwith (sprintf "%s: structure has no fields" struct_name)
534 | f :: fs -> f, fs in
535 let fields = List.fold_left (
536 fun fs f -> <:ctyp< $fs$ ; $f$ >>
539 let struct_type = <:str_item< type t = { $fields$ } >> in
540 let struct_sig = <:sig_item< type t = { $fields$ } >> in
541 struct_type, struct_sig in
543 (* The shared parser functions.
545 * We could include bitmatch statements directly in here, but
546 * what happens is that the macros get expanded here, resulting
547 * in (even more) unreadable generated code. So instead just
548 * do a textual substitution later by post-processing the
549 * generated files. Not type-safe, but we can't have
552 let parser_stmts, parser_subs =
553 let parser_stmts = List.map (
555 let fnname = sprintf "parser_%d" i in
557 let $lid:fnname$ bits = $str:fnname$
562 match parser_stmts with
563 | [] -> <:str_item< >>
565 List.fold_left (fun ps p -> <:str_item< $ps$ $p$ >>) p ps in
567 (* What gets substituted for "parser_NN" ... *)
568 let parser_subs = List.map (
569 fun (i, (endian, fields)) ->
570 let fnname = sprintf "parser_%d" i in
573 | Bitstring.LittleEndian -> "littleendian"
574 | Bitstring.BigEndian -> "bigendian"
575 | _ -> assert false in
577 (* Fields must be sorted by offset, otherwise bitmatch
580 let cmp (_, (_, o1, _)) (_, (_, o2, _)) = compare o1 o2 in
581 let fields = List.sort ~cmp fields in
582 String.concat ";\n " (
585 | (field_name, (`Int, offset, size))
586 | (field_name, (`Ptr _, offset, size)) ->
587 (* 'zero+' is a hack to force the type to int64. *)
588 sprintf "%s : zero+%d : offset(%d), %s"
589 field_name (size*8) (offset*8) endian
590 | (field_name, (`Str width, offset, size)) ->
591 sprintf "%s : %d : offset(%d), string"
592 field_name (width*8) (offset*8)
596 String.concat ";\n " (
599 | (field_name, (`Ptr "list_head", offset, size)) ->
600 sprintf "%s = Int64.sub %s %dL" field_name field_name offset
602 sprintf "%s = %s" field_name field_name
610 | { _ } -> raise (ParseError (%S, %S, \"failed to match kernel structure\"))"
611 patterns assignments struct_name fnname in
616 parser_stmts, parser_subs in
618 (* Define a map from kernel versions to parsing functions. *)
620 let stmts = List.fold_left (
621 fun stmts (_, version, arch, total_size, i) ->
622 let parserfn = sprintf "parser_%d" i in
625 let v = ($lid:parserfn$, $`int:total_size$)
626 let map = StringMap.add $str:version$ v map
628 ) <:str_item< let map = StringMap.empty >> kernels in
631 module StringMap = Map.Make (String) ;;
635 (* Code (.ml file). *)
636 let code = <:str_item<
637 let warning = "This code is automatically generated from the kernel database by kerneldb-to-parser program. Any edits you make will be lost."
639 exception ParseError of string * string * string;;
644 type kernel_version = string
645 let $lid:struct_name^"_known"$ version = StringMap.mem version map
646 let $lid:struct_name^"_size"$ version =
647 let _, size = StringMap.find version map in
649 let $lid:struct_name^"_of_bits"$ version bits =
650 let parsefn, _ = StringMap.find version map in
652 let $lid:"get_"^struct_name$ version mem addr =
653 let parsefn, size = StringMap.find version map in
654 let bytes = Virt_mem_mmap.get_bytes mem addr size in
655 let bits = Bitstring.bitstring_of_string bytes in
659 (* Interface (.mli file). *)
660 let interface = <:sig_item<
661 exception ParseError of string * string * string;;
664 type kernel_version = string
665 val $lid:struct_name^"_known"$ : kernel_version -> bool
666 val $lid:struct_name^"_size"$ : kernel_version -> int
667 val $lid:struct_name^"_of_bits"$ :
668 kernel_version -> Bitstring.bitstring -> t
669 val $lid:"get_"^struct_name$ : kernel_version ->
670 ('a, 'b, [`HasMapping]) Virt_mem_mmap.t -> Virt_mem_mmap.addr -> t
673 (struct_name, code, interface, parser_subs)
676 (* Finally generate the output files. *)
677 let re_subst = Pcre.regexp "^(.*)\"(parser_\\d+)\"(.*)$" in
680 fun (struct_name, code, interface, parser_subs) ->
681 (* Interface (.mli file). *)
682 let output_file = outputdir // "kernel_" ^ struct_name ^ ".mli" in
683 printf "Writing %s interface to %s ...\n%!" struct_name output_file;
684 Printers.OCaml.print_interf ~output_file interface;
686 (* Implementation (.ml file). *)
687 let output_file = outputdir // "kernel_" ^ struct_name ^ ".ml" in
688 printf "Writing %s implementation to %s ...\n%!" struct_name output_file;
690 let new_output_file = output_file ^ ".new" in
691 Printers.OCaml.print_implem ~output_file:new_output_file code;
693 (* Substitute the parser bodies in the output file. *)
694 let ichan = open_in new_output_file in
695 let ochan = open_out output_file in
698 let line = input_line ichan in
700 if Pcre.pmatch ~rex:re_subst line then (
701 let subs = Pcre.exec ~rex:re_subst line in
702 let start = Pcre.get_substring subs 1 in
703 let template = Pcre.get_substring subs 2 in
704 let rest = Pcre.get_substring subs 3 in
705 let sub = List.assoc template parser_subs in
708 output_string ochan line; output_char ochan '\n';
711 (try loop () with End_of_file -> ());
716 Unix.unlink new_output_file