1 (* Diskimage library for reading disk images.
2 (C) Copyright 2007-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.
26 include Diskimage_utils
28 (* Use as the natural block size for disk images, but really we should
29 * use the 'blockdev -getbsz' command to find the real block size.
31 let disk_block_size = ~^512
33 let partition_types = [
34 Diskimage_mbr.plugin_id,
35 ("MBR", Diskimage_mbr.probe);
38 let filesystem_types = [
39 Diskimage_ext2.plugin_id,
40 ("Linux ext2/3", Diskimage_ext2.probe);
41 Diskimage_linux_swap.plugin_id,
42 ("Linux swap", Diskimage_linux_swap.probe);
43 Diskimage_linux_swsuspend.plugin_id,
44 ("Linux s/w suspend", Diskimage_linux_swsuspend.probe);
48 Diskimage_lvm2.plugin_id,
49 ("Linux LVM2", Diskimage_lvm2.probe, Diskimage_lvm2.list);
52 let name_of_parts id =
53 let name, _ = List.assoc id partition_types in
55 let name_of_filesystem id =
56 let name, _ = List.assoc id filesystem_types in
59 let name, _, _ = List.assoc id lvm_types in
62 (* Probe a device for partitions. Returns [Some parts] or [None]. *)
63 let probe_for_partitions dev =
64 if !debug then eprintf "probing for partitions on %s ...\n%!" dev#name;
65 let rec loop = function
67 | (parts_plugin_id, (_, probe_fn)) :: rest ->
68 try Some (probe_fn dev)
69 with Not_found -> loop rest
71 let r = loop partition_types in
74 | None -> eprintf "no partitions found on %s\n%!" dev#name
75 | Some { parts_plugin_id = name; parts = parts } ->
76 eprintf "found %d %s partitions on %s\n"
77 (List.length parts) name dev#name
81 (* Probe a device for a filesystem. Returns [Some fs] or [None]. *)
82 let probe_for_filesystem dev =
83 if !debug then eprintf "probing for a filesystem on %s ...\n%!" dev#name;
84 let rec loop = function
86 | (fs_name, (_, probe_fn)) :: rest ->
87 try Some (probe_fn dev)
88 with Not_found -> loop rest
90 let r = loop filesystem_types in
93 | None -> eprintf "no filesystem found on %s\n%!" dev#name
95 eprintf "found a filesystem on %s:\n" dev#name;
96 eprintf "\t%s\n%!" fs.fs_plugin_id
100 (* Probe a device for a PV. Returns [Some lvm_name] or [None]. *)
101 let probe_for_pv dev =
102 if !debug then eprintf "probing if %s is a PV ...\n%!" dev#name;
103 let rec loop = function
105 | (lvm_name, (_, probe_fn, _)) :: rest ->
106 try Some (probe_fn lvm_name dev)
107 with Not_found -> loop rest
109 let r = loop lvm_types in
112 | None -> eprintf "no PV found on %s\n%!" dev#name
113 | Some { lvm_plugin_id = name } ->
114 eprintf "%s contains a %s PV\n%!" dev#name name
118 let list_lvs lvm_name devs =
119 let _, _, list_lvs_fn = List.assoc lvm_name lvm_types in
122 (* Create machine description. *)
123 let open_machine name disks =
124 let disks = List.map (
126 let dev = new block_device path disk_block_size (* XXX *) in
127 { d_name = name; d_dev = dev; d_content = `Unknown }
129 { m_name = name; m_disks = disks; m_lv_filesystems = [] }
131 let close_machine { m_disks = m_disks } =
132 (* Only close the disks, assume all other devices are derived from them. *)
133 List.iter (fun { d_dev = d_dev } -> d_dev#close ()) m_disks
135 let scan_machine ({ m_disks = m_disks } as machine) =
136 let m_disks = List.map (
137 fun ({ d_dev = dev } as disk) ->
138 let dev = (dev :> device) in
139 (* See if it is partitioned first. *)
140 let parts = probe_for_partitions dev in
143 { disk with d_content = `Partitions parts }
145 (* Not partitioned. Does it contain a filesystem? *)
146 let fs = probe_for_filesystem dev in
149 { disk with d_content = `Filesystem fs }
151 (* Not partitioned, no filesystem, is it a PV? *)
152 let pv = probe_for_pv dev in
155 { disk with d_content = `PhysicalVolume lvm_name }
157 disk (* Spare/unknown. *)
160 (* Now we have either detected partitions or a filesystem on each
161 * physical device (or perhaps neither). See what is on those
164 let m_disks = List.map (
166 | ({ d_dev = dev; d_content = `Partitions parts } as disk) ->
169 if p.part_status = Bootable || p.part_status = Nonbootable then (
170 let fs = probe_for_filesystem p.part_dev in
173 { p with part_content = `Filesystem fs }
176 let pv = probe_for_pv p.part_dev in
179 { p with part_content = `PhysicalVolume lvm_name }
181 p (* Spare/unknown. *)
184 let parts = { parts with parts = ps } in
185 { disk with d_content = `Partitions parts }
189 (* LVM filesystem detection
191 * Look for all disks/partitions which have been identified as PVs
192 * and pass those back to the respective LVM plugin for LV detection.
194 * (Note - a two-stage process because an LV can be spread over
195 * several PVs, so we have to detect all PVs belonging to a
198 * XXX To deal with RAID (ie. md devices) we will need to loop
199 * around here because RAID is like LVM except that they normally
200 * present as block devices which can be used by LVM.
202 (* First: LV detection.
203 * Find all physical volumes, can be disks or partitions.
205 let pvs_on_disks = List.filter_map (
208 d_content = `PhysicalVolume pv } -> Some (pv, (d_dev :> device))
211 let pvs_on_partitions = List.map (
213 | { d_content = `Partitions { parts = parts } } ->
216 | { part_dev = part_dev;
217 part_content = `PhysicalVolume pv } ->
223 let lvs = List.concat (pvs_on_disks :: pvs_on_partitions) in
225 (* Second: filesystem on LV detection.
226 * Group the LVs by plug-in type.
228 let cmp (a,_) (b,_) = compare a b in
229 let lvs = List.sort ~cmp lvs in
230 let lvs = group_by lvs in
233 List.map (fun (pv, devs) -> list_lvs pv.lvm_plugin_id devs) lvs in
234 let lvs = List.concat lvs in
236 (* lvs is a list of potential LV devices. Now run them through the
237 * probes to see if any contain filesystems.
241 fun ({ lv_dev = dev } as lv) ->
242 match probe_for_filesystem dev with
243 | Some fs -> Some (lv, fs)
249 m_lv_filesystems = filesystems }